1

/******************************************************************************

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006-2008  Florian Pose, Ingenieurgemeinschaft IgH

     6

 *

     7

 *  This file is part of the IgH EtherCAT Master.

     8

 *

     9

 *  The IgH EtherCAT Master is free software; you can redistribute it and/or

    10

 *  modify it under the terms of the GNU General Public License version 2, as

    11

 *  published by the Free Software Foundation.

    12

 *

    13

 *  The IgH EtherCAT Master is distributed in the hope that it will be useful,

    14

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General

    16

 *  Public License for more details.

    17

 *

    18

 *  You should have received a copy of the GNU General Public License along

    19

 *  with the IgH EtherCAT Master; if not, write to the Free Software

    20

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    21

 *

    22

 *  ---

    23

 *

    24

 *  The license mentioned above concerns the source code only. Using the

    25

 *  EtherCAT technology and brand is only permitted in compliance with the

    26

 *  industrial property and similar rights of Beckhoff Automation GmbH.

    27

 *

    28

 *****************************************************************************/

    29

    30

/**

    31

   \file

    32

   EtherCAT domain methods.

    33

*/

    34

    35

/*****************************************************************************/

    36

    37

#include <linux/module.h>

    38

    39

#include "globals.h"

    40

#include "master.h"

    41

#include "slave_config.h"

    42

    43

#include "domain.h"

    44

#include "datagram_pair.h"

    45

    46

#define DEBUG_REDUNDANCY 0

    47

    48

/*****************************************************************************/

    49

    50

void ec_domain_clear_data(ec_domain_t *);

    51

    52

/*****************************************************************************/

    53

    54

/** Domain constructor.

    55

 */

    56

void ec_domain_init(

    57

        ec_domain_t *domain, /**< EtherCAT domain. */

    58

        ec_master_t *master, /**< Parent master. */

    59

        unsigned int index /**< Index. */

    60

        )

    61

{

    62

    domain->master = master;

    63

    domain->index = index;

    64

    INIT_LIST_HEAD(&domain->fmmu_configs);

    65

    domain->data_size = 0;

    66

    domain->data = NULL;

    67

    domain->data_origin = EC_ORIG_INTERNAL;

    68

    domain->logical_base_address = 0x00000000;

    69

    INIT_LIST_HEAD(&domain->datagram_pairs);

    70

    domain->working_counter[EC_DEVICE_MAIN] = 0x0000;

    71

    domain->working_counter[EC_DEVICE_BACKUP] = 0x0000;

    72

    domain->expected_working_counter = 0x0000;

    73

    domain->working_counter_changes = 0;

    74

    domain->redundancy_active = 0;

    75

    domain->notify_jiffies = 0;

    76

}

    77

    78

/*****************************************************************************/

    79

    80

/** Domain destructor.

    81

 */

    82

void ec_domain_clear(ec_domain_t *domain /**< EtherCAT domain */)

    83

{

    84

    ec_datagram_pair_t *datagram_pair, *next_pair;

    85

    86

    // dequeue and free datagrams

    87

    list_for_each_entry_safe(datagram_pair, next_pair,

    88

            &domain->datagram_pairs, list) {

    89

        ec_datagram_pair_clear(datagram_pair);

    90

        kfree(datagram_pair);

    91

    }

    92

    93

    ec_domain_clear_data(domain);

    94

}

    95

    96

/*****************************************************************************/

    97

    98

/** Frees internally allocated memory.

    99

 */

   100

void ec_domain_clear_data(

   101

        ec_domain_t *domain /**< EtherCAT domain. */

   102

        )

   103

{

   104

    if (domain->data_origin == EC_ORIG_INTERNAL && domain->data) {

   105

        kfree(domain->data);

   106

    }

   107

   108

    domain->data = NULL;

   109

    domain->data_origin = EC_ORIG_INTERNAL;

   110

}

   111

   112

/*****************************************************************************/

   113

   114

/** Adds an FMMU configuration to the domain.

   115

 */

   116

void ec_domain_add_fmmu_config(

   117

        ec_domain_t *domain, /**< EtherCAT domain. */

   118

        ec_fmmu_config_t *fmmu /**< FMMU configuration. */

   119

        )

   120

{

   121

    fmmu->domain = domain;

   122

   123

    domain->data_size += fmmu->data_size;

   124

    list_add_tail(&fmmu->list, &domain->fmmu_configs);

   125

   126

    EC_MASTER_DBG(domain->master, 1, "Domain %u:"

   127

            " Added %u bytes, total %zu.\n",

   128

            domain->index, fmmu->data_size, domain->data_size);

   129

}

   130

   131

/*****************************************************************************/

   132

   133

/** Allocates a domain datagram pair and appends it to the list.

   134

 *

   135

 * The datagrams' types and expected working counters are determined by the

   136

 * number of input and output fmmus that share the datagrams.

   137

 *

   138

 * \retval  0 Success.

   139

 * \retval <0 Error code.

   140

 */

   141

int ec_domain_add_datagram_pair(

   142

        ec_domain_t *domain, /**< EtherCAT domain. */

   143

        uint32_t logical_offset, /**< Logical offset. */

   144

        size_t data_size, /**< Size of the data. */

   145

        uint8_t *data, /**< Process data. */

   146

        const unsigned int used[] /**< Slave config counter for in/out. */

   147

        )

   148

{

   149

    ec_datagram_pair_t *datagram_pair;

   150

    int ret;

   151

   152

    if (!(datagram_pair = kmalloc(sizeof(ec_datagram_pair_t), GFP_KERNEL))) {

   153

        EC_MASTER_ERR(domain->master,

   154

                "Failed to allocate domain datagram pair!\n");

   155

        return -ENOMEM;

   156

    }

   157

   158

    ret = ec_datagram_pair_init(datagram_pair, domain, logical_offset, data,

   159

            data_size, used);

   160

    if (ret) {

   161

        kfree(datagram_pair);

   162

        return ret;

   163

    }

   164

   165

    domain->expected_working_counter +=

   166

        datagram_pair->expected_working_counter;

   167

   168

    EC_MASTER_DBG(domain->master, 1,

   169

            "Adding datagram pair with expected WC %u.\n",

   170

            datagram_pair->expected_working_counter);

   171

   172

   173

    list_add_tail(&datagram_pair->list, &domain->datagram_pairs);

   174

    return 0;

   175

}

   176

   177

/*****************************************************************************/

   178

   179

/** Domain finish helper function.

   180

 *

   181

 * Detects, if a slave configuration has already been taken into account for

   182

 * a datagram's expected working counter calculation.

   183

 *

   184

 * Walks through the list of all FMMU configurations for the current datagram

   185

 * and ends before the current datagram.

   186

 */

   187

int shall_count(

   188

        const ec_fmmu_config_t *cur_fmmu, /**< Current FMMU with direction to

   189

                                            search for. */

   190

        const ec_fmmu_config_t *first_fmmu /**< Datagram's first FMMU. */

   191

        )

   192

{

   193

    for (; first_fmmu != cur_fmmu;

   194

            first_fmmu = list_entry(first_fmmu->list.next,

   195

                ec_fmmu_config_t, list)) {

   196

   197

        if (first_fmmu->sc == cur_fmmu->sc

   198

                && first_fmmu->dir == cur_fmmu->dir) {

   199

            return 0; // was already counted

   200

        }

   201

    }

   202

   203

    return 1;

   204

}

   205

   206

/*****************************************************************************/

   207

   208

/** Finishes a domain.

   209

 *

   210

 * This allocates the necessary datagrams and writes the correct logical

   211

 * addresses to every configured FMMU.

   212

 *

   213

 * \todo Check for FMMUs that do not fit into any datagram.

   214

 *

   215

 * \retval  0 Success

   216

 * \retval <0 Error code.

   217

 */

   218

int ec_domain_finish(

   219

        ec_domain_t *domain, /**< EtherCAT domain. */

   220

        uint32_t base_address /**< Logical base address. */

   221

        )

   222

{

   223

    uint32_t datagram_offset;

   224

    size_t datagram_size;

   225

    unsigned int datagram_count;

   226

    unsigned int datagram_used[EC_DIR_COUNT];

   227

    ec_fmmu_config_t *fmmu;

   228

    const ec_fmmu_config_t *datagram_first_fmmu = NULL;

   229

    const ec_datagram_pair_t *datagram_pair;

   230

    int ret;

   231

   232

    domain->logical_base_address = base_address;

   233

   234

    if (domain->data_size && domain->data_origin == EC_ORIG_INTERNAL) {

   235

        if (!(domain->data =

   236

                    (uint8_t *) kmalloc(domain->data_size, GFP_KERNEL))) {

   237

            EC_MASTER_ERR(domain->master, "Failed to allocate %zu bytes"

   238

                    " internal memory for domain %u!\n",

   239

                    domain->data_size, domain->index);

   240

            return -ENOMEM;

   241

        }

   242

    }

   243

   244

    // Cycle through all domain FMMUs and

   245

    // - correct the logical base addresses

   246

    // - set up the datagrams to carry the process data

   247

    // - calculate the datagrams' expected working counters

   248

    datagram_offset = 0;

   249

    datagram_size = 0;

   250

    datagram_count = 0;

   251

    datagram_used[EC_DIR_OUTPUT] = 0;

   252

    datagram_used[EC_DIR_INPUT] = 0;

   253

   254

    if (!list_empty(&domain->fmmu_configs)) {

   255

        datagram_first_fmmu =

   256

            list_entry(domain->fmmu_configs.next, ec_fmmu_config_t, list);

   257

    }

   258

   259

    list_for_each_entry(fmmu, &domain->fmmu_configs, list) {

   260

   261

        // Correct logical FMMU address

   262

        fmmu->logical_start_address += base_address;

   263

   264

        // Increment Input/Output counter to determine datagram types

   265

        // and calculate expected working counters

   266

        if (shall_count(fmmu, datagram_first_fmmu)) {

   267

            datagram_used[fmmu->dir]++;

   268

        }

   269

   270

        // If the current FMMU's data do not fit in the current datagram,

   271

        // allocate a new one.

   272

        if (datagram_size + fmmu->data_size > EC_MAX_DATA_SIZE) {

   273

            ret = ec_domain_add_datagram_pair(domain,

   274

                    domain->logical_base_address + datagram_offset,

   275

                    datagram_size, domain->data + datagram_offset,

   276

                    datagram_used);

   277

            if (ret < 0)

   278

                return ret;

   279

   280

            datagram_offset += datagram_size;

   281

            datagram_size = 0;

   282

            datagram_count++;

   283

            datagram_used[EC_DIR_OUTPUT] = 0;

   284

            datagram_used[EC_DIR_INPUT] = 0;

   285

            datagram_first_fmmu = fmmu;

   286

        }

   287

   288

        datagram_size += fmmu->data_size;

   289

    }

   290

   291

    /* Allocate last datagram pair, if data are left (this is also the case if

   292

     * the process data fit into a single datagram) */

   293

    if (datagram_size) {

   294

        ret = ec_domain_add_datagram_pair(domain,

   295

                domain->logical_base_address + datagram_offset,

   296

                datagram_size, domain->data + datagram_offset,

   297

                datagram_used);

   298

        if (ret < 0)

   299

            return ret;

   300

        datagram_count++;

   301

    }

   302

   303

    EC_MASTER_INFO(domain->master, "Domain%u: Logical address 0x%08x,"

   304

            " %zu byte, expected working counter %u.\n", domain->index,

   305

            domain->logical_base_address, domain->data_size,

   306

            domain->expected_working_counter);

   307

   308

    list_for_each_entry(datagram_pair, &domain->datagram_pairs, list) {

   309

        const ec_datagram_t *datagram =

   310

            &datagram_pair->datagrams[EC_DEVICE_MAIN];

   311

        EC_MASTER_INFO(domain->master, "  Datagram %s: Logical offset 0x%08x,"

   312

                " %zu byte, type %s.\n", datagram->name,

   313

                EC_READ_U32(datagram->address), datagram->data_size,

   314

                ec_datagram_type_string(datagram));

   315

    }

   316

   317

    return 0;

   318

}

   319

   320

/*****************************************************************************/

   321

   322

/** Get the number of FMMU configurations of the domain.

   323

 */

   324

unsigned int ec_domain_fmmu_count(const ec_domain_t *domain)

   325

{

   326

    const ec_fmmu_config_t *fmmu;

   327

    unsigned int num = 0;

   328

   329

    list_for_each_entry(fmmu, &domain->fmmu_configs, list) {

   330

        num++;

   331

    }

   332

   333

    return num;

   334

}

   335

   336

/*****************************************************************************/

   337

   338

/** Get a certain FMMU configuration via its position in the list.

   339

 */

   340

const ec_fmmu_config_t *ec_domain_find_fmmu(

   341

        const ec_domain_t *domain, /**< EtherCAT domain. */

   342

        unsigned int pos /**< List position. */

   343

        )

   344

{

   345

    const ec_fmmu_config_t *fmmu;

   346

   347

    list_for_each_entry(fmmu, &domain->fmmu_configs, list) {

   348

        if (pos--)

   349

            continue;

   350

        return fmmu;

   351

    }

   352

   353

    return NULL;

   354

}

   355

   356

/*****************************************************************************/

   357

   358

/** Process received data.

   359

 */

   360

int data_changed(

   361

        uint8_t *send_buffer,

   362

        const ec_datagram_t *datagram,

   363

        size_t offset,

   364

        size_t size

   365

        )

   366

{

   367

    uint8_t *sent = send_buffer + offset;

   368

    uint8_t *recv = datagram->data + offset;

   369

    size_t i;

   370

   371

    for (i = 0; i < size; i++) {

   372

        if (recv[i] != sent[i]) {

   373

            return 1;

   374

        }

   375

    }

   376

   377

    return 0;

   378

}

   379

   380

/******************************************************************************

   381

 *  Application interface

   382

 *****************************************************************************/

   383

   384

int ecrt_domain_reg_pdo_entry_list(ec_domain_t *domain,

   385

        const ec_pdo_entry_reg_t *regs)

   386

{

   387

    const ec_pdo_entry_reg_t *reg;

   388

    ec_slave_config_t *sc;

   389

    int ret;

   390

   391

    EC_MASTER_DBG(domain->master, 1, "ecrt_domain_reg_pdo_entry_list("

   392

            "domain = 0x%p, regs = 0x%p)\n", domain, regs);

   393

   394

    for (reg = regs; reg->index; reg++) {

   395

        sc = ecrt_master_slave_config_err(domain->master, reg->alias,

   396

                reg->position, reg->vendor_id, reg->product_code);

   397

        if (IS_ERR(sc))

   398

            return PTR_ERR(sc);

   399

   400

        ret = ecrt_slave_config_reg_pdo_entry(sc, reg->index,

   401

                        reg->subindex, domain, reg->bit_position);

   402

        if (ret < 0)

   403

            return ret;

   404

   405

        *reg->offset = ret;

   406

    }

   407

   408

    return 0;

   409

}

   410

   411

/*****************************************************************************/

   412

   413

size_t ecrt_domain_size(const ec_domain_t *domain)

   414

{

   415

    return domain->data_size;

   416

}

   417

   418

/*****************************************************************************/

   419

   420

void ecrt_domain_external_memory(ec_domain_t *domain, uint8_t *mem)

   421

{

   422

    EC_MASTER_DBG(domain->master, 1, "ecrt_domain_external_memory("

   423

            "domain = 0x%p, mem = 0x%p)\n", domain, mem);

   424

   425

    down(&domain->master->master_sem);

   426

   427

    ec_domain_clear_data(domain);

   428

   429

    domain->data = mem;

   430

    domain->data_origin = EC_ORIG_EXTERNAL;

   431

   432

    up(&domain->master->master_sem);

   433

}

   434

   435

/*****************************************************************************/

   436

   437

uint8_t *ecrt_domain_data(ec_domain_t *domain)

   438

{

   439

    return domain->data;

   440

}

   441

   442

/*****************************************************************************/

   443

   444

void ecrt_domain_process(ec_domain_t *domain)

   445

{

   446

    uint16_t wc_sum[EC_NUM_DEVICES] = {};

   447

    ec_datagram_pair_t *pair;

   448

    ec_datagram_t *main_datagram, *backup_datagram;

   449

    uint32_t logical_datagram_address;

   450

    size_t datagram_size;

   451

    uint16_t datagram_pair_wc;

   452

    unsigned int datagram_offset;

   453

    ec_fmmu_config_t *fmmu =

   454

        list_first_entry(&domain->fmmu_configs, ec_fmmu_config_t, list);

   455

    unsigned int redundancy;

   456

   457

#if DEBUG_REDUNDANCY

   458

    EC_MASTER_DBG(domain->master, 1, "domain %u process\n", domain->index);

   459

#endif

   460

   461

    list_for_each_entry(pair, &domain->datagram_pairs, list) {

   462

   463

        main_datagram = &pair->datagrams[EC_DEVICE_MAIN];

   464

        backup_datagram = &pair->datagrams[EC_DEVICE_BACKUP];

   465

        logical_datagram_address = EC_READ_U32(main_datagram->address);

   466

        datagram_size = main_datagram->data_size;

   467

   468

#if DEBUG_REDUNDANCY

   469

        EC_MASTER_DBG(domain->master, 1, "dgram %s log=%u\n",

   470

                main_datagram->name, logical_datagram_address);

   471

#endif

   472

   473

        datagram_pair_wc = ec_datagram_pair_process(pair, wc_sum);

   474

   475

        /* Go through all FMMU configs to detect data changes. */

   476

        list_for_each_entry_from(fmmu, &domain->fmmu_configs, list) {

   477

   478

            if (fmmu->dir != EC_DIR_INPUT) {

   479

                continue;

   480

            }

   481

   482

            if (fmmu->logical_start_address >=

   483

                    logical_datagram_address + datagram_size) {

   484

                // fmmu data contained in next datagram pair

   485

                break;

   486

            }