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

    unsigned int dev_idx;

    63

    64

    domain->master = master;

    65

    domain->index = index;

    66

    INIT_LIST_HEAD(&domain->fmmu_configs);

    67

    domain->data_size = 0;

    68

    domain->data = NULL;

    69

    domain->data_origin = EC_ORIG_INTERNAL;

    70

    domain->logical_base_address = 0x00000000;

    71

    INIT_LIST_HEAD(&domain->datagram_pairs);

    72

    for (dev_idx = EC_DEVICE_MAIN; dev_idx < ec_master_num_devices(master);

    73

            dev_idx++) {

    74

        domain->working_counter[dev_idx] = 0x0000;

    75

    }

    76

    domain->expected_working_counter = 0x0000;

    77

    domain->working_counter_changes = 0;

    78

    domain->redundancy_active = 0;

    79

    domain->notify_jiffies = 0;

    80

}

    81

    82

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

    83

    84

/** Domain destructor.

    85

 */

    86

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

    87

{

    88

    ec_datagram_pair_t *datagram_pair, *next_pair;

    89

    90

    // dequeue and free datagrams

    91

    list_for_each_entry_safe(datagram_pair, next_pair,

    92

            &domain->datagram_pairs, list) {

    93

        ec_datagram_pair_clear(datagram_pair);

    94

        kfree(datagram_pair);

    95

    }

    96

    97

    ec_domain_clear_data(domain);

    98

}

    99

   100

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

   101

   102

/** Frees internally allocated memory.

   103

 */

   104

void ec_domain_clear_data(

   105

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

   106

        )

   107

{

   108

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

   109

        kfree(domain->data);

   110

    }

   111

   112

    domain->data = NULL;

   113

    domain->data_origin = EC_ORIG_INTERNAL;

   114

}

   115

   116

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

   117

   118

/** Adds an FMMU configuration to the domain.

   119

 */

   120

void ec_domain_add_fmmu_config(

   121

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

   122

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

   123

        )

   124

{

   125

    fmmu->domain = domain;

   126

   127

    domain->data_size += fmmu->data_size;

   128

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

   129

   130

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

   131

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

   132

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

   133

}

   134

   135

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

   136

   137

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

   138

 *

   139

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

   140

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

   141

 *

   142

 * \retval  0 Success.

   143

 * \retval <0 Error code.

   144

 */

   145

int ec_domain_add_datagram_pair(

   146

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

   147

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

   148

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

   149

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

   150

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

   151

        )

   152

{

   153

    ec_datagram_pair_t *datagram_pair;

   154

    int ret;

   155

   156

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

   157

        EC_MASTER_ERR(domain->master,

   158

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

   159

        return -ENOMEM;

   160

    }

   161

   162

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

   163

            data_size, used);

   164

    if (ret) {

   165

        kfree(datagram_pair);

   166

        return ret;

   167

    }

   168

   169

    domain->expected_working_counter +=

   170

        datagram_pair->expected_working_counter;

   171

   172

    EC_MASTER_DBG(domain->master, 1,

   173

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

   174

            datagram_pair->expected_working_counter);

   175

   176

   177

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

   178

    return 0;

   179

}

   180

   181

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

   182

   183

/** Domain finish helper function.

   184

 *

   185

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

   186

 * a datagram's expected working counter calculation.

   187

 *

   188

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

   189

 * and ends before the current datagram.

   190

 */

   191

int shall_count(

   192

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

   193

                                            search for. */

   194

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

   195

        )

   196

{

   197

    for (; first_fmmu != cur_fmmu;

   198

            first_fmmu = list_entry(first_fmmu->list.next,

   199

                ec_fmmu_config_t, list)) {

   200

   201

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

   202

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

   203

            return 0; // was already counted

   204

        }

   205

    }

   206

   207

    return 1;

   208

}

   209

   210

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

   211

   212

/** Finishes a domain.

   213

 *

   214

 * This allocates the necessary datagrams and writes the correct logical

   215

 * addresses to every configured FMMU.

   216

 *

   217

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

   218

 *

   219

 * \retval  0 Success

   220

 * \retval <0 Error code.

   221

 */

   222

int ec_domain_finish(

   223

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

   224

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

   225

        )

   226

{

   227

    uint32_t datagram_offset;

   228

    size_t datagram_size;

   229

    unsigned int datagram_count;

   230

    unsigned int datagram_used[EC_DIR_COUNT];

   231

    ec_fmmu_config_t *fmmu;

   232

    const ec_fmmu_config_t *datagram_first_fmmu = NULL;

   233

    const ec_datagram_pair_t *datagram_pair;

   234

    int ret;

   235

   236

    domain->logical_base_address = base_address;

   237

   238

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

   239

        if (!(domain->data =

   240

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

   241

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

   242

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

   243

                    domain->data_size, domain->index);

   244

            return -ENOMEM;

   245

        }

   246

    }

   247

   248

    // Cycle through all domain FMMUs and

   249

    // - correct the logical base addresses

   250

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

   251

    // - calculate the datagrams' expected working counters

   252

    datagram_offset = 0;

   253

    datagram_size = 0;

   254

    datagram_count = 0;

   255

    datagram_used[EC_DIR_OUTPUT] = 0;

   256

    datagram_used[EC_DIR_INPUT] = 0;

   257

   258

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

   259

        datagram_first_fmmu =

   260

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

   261

    }

   262

   263

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

   264

   265

        // Correct logical FMMU address

   266

        fmmu->logical_start_address += base_address;

   267

   268

        // Increment Input/Output counter to determine datagram types

   269

        // and calculate expected working counters

   270

        if (shall_count(fmmu, datagram_first_fmmu)) {

   271

            datagram_used[fmmu->dir]++;

   272

        }

   273

   274

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

   275

        // allocate a new one.

   276

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

   277

            ret = ec_domain_add_datagram_pair(domain,

   278

                    domain->logical_base_address + datagram_offset,

   279

                    datagram_size, domain->data + datagram_offset,

   280

                    datagram_used);

   281

            if (ret < 0)

   282

                return ret;

   283

   284

            datagram_offset += datagram_size;

   285

            datagram_size = 0;

   286

            datagram_count++;

   287

            datagram_used[EC_DIR_OUTPUT] = 0;

   288

            datagram_used[EC_DIR_INPUT] = 0;

   289

            datagram_first_fmmu = fmmu;

   290

        }

   291

   292

        datagram_size += fmmu->data_size;

   293

    }

   294

   295

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

   296

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

   297

    if (datagram_size) {

   298

        ret = ec_domain_add_datagram_pair(domain,

   299

                domain->logical_base_address + datagram_offset,

   300

                datagram_size, domain->data + datagram_offset,

   301

                datagram_used);

   302

        if (ret < 0)

   303

            return ret;

   304

        datagram_count++;

   305

    }

   306

   307

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

   308

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

   309

            domain->logical_base_address, domain->data_size,

   310

            domain->expected_working_counter);

   311

   312

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

   313

        const ec_datagram_t *datagram =

   314

            &datagram_pair->datagrams[EC_DEVICE_MAIN];

   315

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

   316

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

   317

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

   318

                ec_datagram_type_string(datagram));

   319

    }

   320

   321

    return 0;

   322

}

   323

   324

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

   325

   326

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

   327

 */

   328

unsigned int ec_domain_fmmu_count(const ec_domain_t *domain)

   329

{

   330

    const ec_fmmu_config_t *fmmu;

   331

    unsigned int num = 0;

   332

   333

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

   334

        num++;

   335

    }

   336

   337

    return num;

   338

}

   339

   340

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

   341

   342

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

   343

 */

   344

const ec_fmmu_config_t *ec_domain_find_fmmu(

   345

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

   346

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

   347

        )

   348

{

   349

    const ec_fmmu_config_t *fmmu;

   350

   351

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

   352

        if (pos--)

   353

            continue;

   354

        return fmmu;

   355

    }

   356

   357

    return NULL;

   358

}

   359

   360

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

   361

   362

#if EC_MAX_NUM_DEVICES > 1

   363

   364

/** Process received data.

   365

 */

   366

int data_changed(

   367

        uint8_t *send_buffer,

   368

        const ec_datagram_t *datagram,

   369

        size_t offset,

   370

        size_t size

   371

        )

   372

{

   373

    uint8_t *sent = send_buffer + offset;

   374

    uint8_t *recv = datagram->data + offset;

   375

    size_t i;

   376

   377

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

   378

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

   379

            return 1;

   380

        }

   381

    }

   382

   383

    return 0;

   384

}

   385

   386

#endif

   387

   388

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

   389

 *  Application interface

   390

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

   391

   392

int ecrt_domain_reg_pdo_entry_list(ec_domain_t *domain,

   393

        const ec_pdo_entry_reg_t *regs)

   394

{

   395

    const ec_pdo_entry_reg_t *reg;

   396

    ec_slave_config_t *sc;

   397

    int ret;

   398

   399

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

   400

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

   401

   402

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

   403

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

   404

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

   405

        if (IS_ERR(sc))

   406

            return PTR_ERR(sc);

   407

   408

        ret = ecrt_slave_config_reg_pdo_entry(sc, reg->index,

   409

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

   410

        if (ret < 0)

   411

            return ret;

   412

   413

        *reg->offset = ret;

   414

    }

   415

   416

    return 0;

   417

}

   418

   419

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

   420

   421

size_t ecrt_domain_size(const ec_domain_t *domain)

   422

{

   423

    return domain->data_size;

   424

}

   425

   426

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

   427

   428

void ecrt_domain_external_memory(ec_domain_t *domain, uint8_t *mem)

   429

{

   430

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

   431

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

   432

   433

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

   434

   435

    ec_domain_clear_data(domain);

   436

   437

    domain->data = mem;

   438

    domain->data_origin = EC_ORIG_EXTERNAL;

   439

   440

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

   441

}

   442

   443

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

   444

   445

uint8_t *ecrt_domain_data(ec_domain_t *domain)

   446

{

   447

    return domain->data;

   448

}

   449

   450

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

   451

   452

void ecrt_domain_process(ec_domain_t *domain)

   453

{

   454

    uint16_t wc_sum[EC_MAX_NUM_DEVICES] = {}, wc_total;

   455

    ec_datagram_pair_t *pair;

   456

#if EC_MAX_NUM_DEVICES > 1

   457

    uint16_t datagram_pair_wc, redundant_wc;

   458

    unsigned int datagram_offset;

   459

    ec_fmmu_config_t *fmmu = list_first_entry(&domain->fmmu_configs,

   460

            ec_fmmu_config_t, list);

   461

    unsigned int redundancy;

   462

#endif

   463

    unsigned int dev_idx, wc_change;

   464

   465

#if DEBUG_REDUNDANCY

   466

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

   467

#endif

   468

   469

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

   470

#if EC_MAX_NUM_DEVICES > 1

   471

        datagram_pair_wc = ec_datagram_pair_process(pair, wc_sum);

   472

#else

   473

        ec_datagram_pair_process(pair, wc_sum);

   474

#endif

   475

   476

#if EC_MAX_NUM_DEVICES > 1

   477

        if (ec_master_num_devices(domain->master) > 1) {

   478

            ec_datagram_t *main_datagram = &pair->datagrams[EC_DEVICE_MAIN];

   479

            uint32_t logical_datagram_address =

   480

                EC_READ_U32(main_datagram->address);

   481

            size_t datagram_size = main_datagram->data_size;

   482

   483

#if DEBUG_REDUNDANCY

   484

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

   485

                    main_datagram->name, logical_datagram_address);

   486

#endif