1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006  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

    10

 *  and/or modify it under the terms of the GNU General Public License

    11

 *  as published by the Free Software Foundation; either version 2 of the

    12

 *  License, or (at your option) any later version.

    13

 *

    14

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

    15

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

    16

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    17

 *  GNU General Public License for more details.

    18

 *

    19

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

    20

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

    21

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

    22

 *

    23

 *  The right to use EtherCAT Technology is granted and comes free of

    24

 *  charge under condition of compatibility of product made by

    25

 *  Licensee. People intending to distribute/sell products based on the

    26

 *  code, have to sign an agreement to guarantee that products using

    27

 *  software based on IgH EtherCAT master stay compatible with the actual

    28

 *  EtherCAT specification (which are released themselves as an open

    29

 *  standard) as the (only) precondition to have the right to use EtherCAT

    30

 *  Technology, IP and trade marks.

    31

 *

    32

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

    33

    34

/**

    35

   \file

    36

   EtherCAT domain methods.

    37

*/

    38

    39

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

    40

    41

#include <linux/module.h>

    42

    43

#include "globals.h"

    44

#include "domain.h"

    45

#include "master.h"

    46

    47

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

    48

    49

/**

    50

   Data registration type.

    51

*/

    52

    53

typedef struct

    54

{

    55

    struct list_head list; /**< list item */

    56

    ec_slave_t *slave; /**< slave */

    57

    const ec_sii_sync_t *sync; /**< sync manager */

    58

    off_t sync_offset; /**< pdo offset */

    59

    void **data_ptr; /**< pointer to process data pointer(s) */

    60

}

    61

ec_data_reg_t;

    62

    63

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

    64

    65

void ec_domain_clear_data_regs(ec_domain_t *);

    66

ssize_t ec_show_domain_attribute(struct kobject *, struct attribute *, char *);

    67

    68

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

    69

    70

/** \cond */

    71

    72

EC_SYSFS_READ_ATTR(image_size);

    73

    74

static struct attribute *def_attrs[] = {

    75

    &attr_image_size,

    76

    NULL,

    77

};

    78

    79

static struct sysfs_ops sysfs_ops = {

    80

    .show = &ec_show_domain_attribute,

    81

    .store = NULL

    82

};

    83

    84

static struct kobj_type ktype_ec_domain = {

    85

    .release = ec_domain_clear,

    86

    .sysfs_ops = &sysfs_ops,

    87

    .default_attrs = def_attrs

    88

};

    89

    90

/** \endcond */

    91

    92

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

    93

    94

/**

    95

   Domain constructor.

    96

   \return 0 in case of success, else < 0

    97

*/

    98

    99

int ec_domain_init(ec_domain_t *domain, /**< EtherCAT domain */

   100

                   ec_master_t *master, /**< owning master */

   101

                   unsigned int index /**< domain index */

   102

                   )

   103

{

   104

    domain->master = master;

   105

    domain->index = index;

   106

    domain->data_size = 0;

   107

    domain->base_address = 0;

   108

    domain->response_count = 0xFFFFFFFF;

   109

    domain->notify_jiffies = 0;

   110

    domain->working_counter_changes = 0;

   111

   112

    INIT_LIST_HEAD(&domain->data_regs);

   113

    INIT_LIST_HEAD(&domain->datagrams);

   114

   115

    // init kobject and add it to the hierarchy

   116

    memset(&domain->kobj, 0x00, sizeof(struct kobject));

   117

    kobject_init(&domain->kobj);

   118

    domain->kobj.ktype = &ktype_ec_domain;

   119

    domain->kobj.parent = &master->kobj;

   120

    if (kobject_set_name(&domain->kobj, "domain%i", index)) {

   121

        EC_ERR("Failed to set kobj name.\n");

   122

        return -1;

   123

    }

   124

   125

    return 0;

   126

}

   127

   128

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

   129

   130

/**

   131

   Domain destructor.

   132

*/

   133

   134

void ec_domain_clear(struct kobject *kobj /**< kobject of the domain */)

   135

{

   136

    ec_datagram_t *datagram, *next;

   137

    ec_domain_t *domain;

   138

   139

    domain = container_of(kobj, ec_domain_t, kobj);

   140

   141

    EC_INFO("Clearing domain %i.\n", domain->index);

   142

   143

    list_for_each_entry_safe(datagram, next, &domain->datagrams, list) {

   144

        ec_datagram_clear(datagram);

   145

        kfree(datagram);

   146

    }

   147

   148

    ec_domain_clear_data_regs(domain);

   149

   150

    kfree(domain);

   151

}

   152

   153

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

   154

   155

/**

   156

   Registeres a PDO entry.

   157

   \return 0 in case of success, else < 0

   158

*/

   159

   160

int ec_domain_reg_pdo_entry(ec_domain_t *domain, /**< EtherCAT domain */

   161

                            ec_slave_t *slave, /**< slave */

   162

                            const ec_sii_pdo_t *pdo, /**< PDO */

   163

                            const ec_sii_pdo_entry_t *entry,

   164

                            /**< PDO registration entry */

   165

                            void **data_ptr /**< pointer to the process data

   166

                                               pointer */

   167

                            )

   168

{

   169

    ec_data_reg_t *data_reg;

   170

    const ec_sii_sync_t *sync;

   171

    const ec_sii_pdo_t *other_pdo;

   172

    const ec_sii_pdo_entry_t *other_entry;

   173

    unsigned int bit_offset, byte_offset, sync_found;

   174

   175

    // Find sync manager for PDO

   176

    sync_found = 0;

   177

    list_for_each_entry(sync, &slave->sii_syncs, list) {

   178

        if (sync->index == pdo->sync_index) {

   179

            sync_found = 1;

   180

            break;

   181

        }

   182

    }

   183

   184

    if (!sync_found) {

   185

        EC_ERR("No sync manager for PDO 0x%04X:%i.",

   186

               pdo->index, entry->subindex);

   187

        return -1;

   188

    }

   189

   190

    // Calculate offset for process data pointer

   191

    bit_offset = 0;

   192

    byte_offset = 0;

   193

    list_for_each_entry(other_pdo, &slave->sii_pdos, list) {

   194

        if (other_pdo->sync_index != sync->index) continue;

   195

   196

        list_for_each_entry(other_entry, &other_pdo->entries, list) {

   197

            if (other_entry == entry) {

   198

                byte_offset = bit_offset / 8;

   199

                break;

   200

            }

   201

            bit_offset += other_entry->bit_length;

   202

        }

   203

    }

   204

   205

    // Allocate memory for data registration object

   206

    if (!(data_reg =

   207

          (ec_data_reg_t *) kmalloc(sizeof(ec_data_reg_t), GFP_KERNEL))) {

   208

        EC_ERR("Failed to allocate data registration.\n");

   209

        return -1;

   210

    }

   211

   212

    if (ec_slave_prepare_fmmu(slave, domain, sync)) {

   213

        EC_ERR("FMMU configuration failed.\n");

   214

        kfree(data_reg);

   215

        return -1;

   216

    }

   217

   218

    data_reg->slave = slave;

   219

    data_reg->sync = sync;

   220

    data_reg->sync_offset = byte_offset;

   221

    data_reg->data_ptr = data_ptr;

   222

   223

    list_add_tail(&data_reg->list, &domain->data_regs);

   224

    return 0;

   225

}

   226

   227

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

   228

   229

/**

   230

   Clears the list of the data registrations.

   231

*/

   232

   233

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

   234

{

   235

    ec_data_reg_t *data_reg, *next;

   236

   237

    list_for_each_entry_safe(data_reg, next, &domain->data_regs, list) {

   238

        list_del(&data_reg->list);

   239

        kfree(data_reg);

   240

    }

   241

}

   242

   243

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

   244

   245

/**

   246

   Allocates a process data datagram and appends it to the list.

   247

   \return 0 in case of success, else < 0

   248

*/

   249

   250

int ec_domain_add_datagram(ec_domain_t *domain, /**< EtherCAT domain */

   251

                           uint32_t offset, /**< logical offset */

   252

                           size_t data_size /**< size of the datagram data */

   253

                           )

   254

{

   255

    ec_datagram_t *datagram;

   256

   257

    if (!(datagram = kmalloc(sizeof(ec_datagram_t), GFP_KERNEL))) {

   258

        EC_ERR("Failed to allocate domain datagram!\n");

   259

        return -1;

   260

    }

   261

   262

    ec_datagram_init(datagram);

   263

   264

    if (ec_datagram_lrw(datagram, offset, data_size)) {

   265

        kfree(datagram);

   266

        return -1;

   267

    }

   268

   269

    list_add_tail(&datagram->list, &domain->datagrams);

   270

    return 0;

   271

}

   272

   273

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

   274

   275

/**

   276

   Creates a domain.

   277

   Reserves domain memory, calculates the logical addresses of the

   278

   corresponding FMMUs and sets the process data pointer of the registered

   279

   process data.

   280

   \return 0 in case of success, else < 0

   281

*/

   282

   283

int ec_domain_alloc(ec_domain_t *domain, /**< EtherCAT domain */

   284

                    uint32_t base_address /**< logical base address */

   285

                    )

   286

{

   287

    ec_data_reg_t *data_reg;

   288

    ec_slave_t *slave;

   289

    ec_fmmu_t *fmmu;

   290

    unsigned int i, j, datagram_count;

   291

    uint32_t pdo_off, pdo_off_datagram;

   292

    uint32_t datagram_offset;

   293

    size_t datagram_data_size, sync_size;

   294

    ec_datagram_t *datagram;

   295

   296

    domain->base_address = base_address;

   297

   298

    // calculate size of process data and allocate memory

   299

    domain->data_size = 0;

   300

    datagram_offset = base_address;

   301

    datagram_data_size = 0;

   302

    datagram_count = 0;

   303

    list_for_each_entry(slave, &domain->master->slaves, list) {

   304

        for (j = 0; j < slave->fmmu_count; j++) {

   305

            fmmu = &slave->fmmus[j];

   306

            if (fmmu->domain == domain) {

   307

                fmmu->logical_start_address = base_address + domain->data_size;

   308

                sync_size = ec_slave_calc_sync_size(slave, fmmu->sync);

   309

                domain->data_size += sync_size;

   310

                if (datagram_data_size + sync_size > EC_MAX_DATA_SIZE) {

   311

                    if (ec_domain_add_datagram(domain, datagram_offset,

   312

                                               datagram_data_size)) return -1;

   313

                    datagram_offset += datagram_data_size;

   314

                    datagram_data_size = 0;

   315

                    datagram_count++;

   316

                }

   317

                datagram_data_size += sync_size;

   318

            }

   319

        }

   320

    }

   321

   322

    // allocate last datagram

   323

    if (datagram_data_size) {

   324

        if (ec_domain_add_datagram(domain, datagram_offset,

   325

                                   datagram_data_size))

   326

            return -1;

   327

        datagram_count++;

   328

    }

   329

   330

    if (!datagram_count) {

   331

        EC_WARN("Domain %i contains no data!\n", domain->index);

   332

        ec_domain_clear_data_regs(domain);

   333

        return 0;

   334

    }

   335

   336

    // set all process data pointers

   337

    list_for_each_entry(data_reg, &domain->data_regs, list) {

   338

        for (i = 0; i < data_reg->slave->fmmu_count; i++) {

   339

            fmmu = &data_reg->slave->fmmus[i];

   340

            if (fmmu->domain == domain && fmmu->sync == data_reg->sync) {

   341

                pdo_off = fmmu->logical_start_address + data_reg->sync_offset;

   342

                // search datagram

   343

                list_for_each_entry(datagram, &domain->datagrams, list) {

   344

                    pdo_off_datagram = pdo_off - datagram->address.logical;

   345

                    if (pdo_off >= datagram->address.logical &&

   346

                        pdo_off_datagram < datagram->mem_size) {

   347

                        *data_reg->data_ptr = datagram->data +

   348

                            pdo_off_datagram;

   349

                    }

   350

                }

   351

                if (!data_reg->data_ptr) {

   352

                    EC_ERR("Failed to assign data pointer!\n");

   353

                    return -1;

   354

                }

   355

                break;

   356

            }

   357

        }

   358

    }

   359

   360

    EC_INFO("Domain %i - Allocated %i bytes in %i datagram%s\n",

   361

            domain->index, domain->data_size, datagram_count,

   362

            datagram_count == 1 ? "" : "s");

   363

   364

    ec_domain_clear_data_regs(domain);

   365

   366

    return 0;

   367

}

   368

   369

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

   370

   371

/**

   372

   Places all process data datagrams in the masters datagram queue.

   373

*/

   374

   375

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

   376

{

   377

    ec_datagram_t *datagram;

   378

   379

    list_for_each_entry(datagram, &domain->datagrams, list) {

   380

        ec_master_queue_datagram(domain->master, datagram);

   381

    }

   382

}

   383

   384

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

   385

   386

/**

   387

   Formats attribute data for SysFS reading.

   388

   \return number of bytes to read

   389

*/

   390

   391

ssize_t ec_show_domain_attribute(struct kobject *kobj, /**< kobject */

   392

                                 struct attribute *attr, /**< attribute */

   393

                                 char *buffer /**< memory to store data in */

   394

                                 )

   395

{

   396

    ec_domain_t *domain = container_of(kobj, ec_domain_t, kobj);

   397

   398

    if (attr == &attr_image_size) {

   399

        return sprintf(buffer, "%i\n", domain->data_size);

   400

    }

   401

   402

    return 0;

   403

}

   404

   405

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

   406

 *  Realtime interface

   407

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

   408

   409

/**

   410

   Registers a PDO in a domain.

   411

   - If \a data_ptr is NULL, the slave is only validated.

   412

   \return pointer to the slave on success, else NULL

   413

   \ingroup RealtimeInterface

   414

*/

   415

   416

ec_slave_t *ecrt_domain_register_pdo(ec_domain_t *domain,

   417

                                     /**< EtherCAT domain */

   418

                                     const char *address,

   419

                                     /**< ASCII address of the slave,

   420

                                        see ecrt_master_get_slave() */

   421

                                     uint32_t vendor_id,

   422

                                     /**< vendor ID */

   423

                                     uint32_t product_code,

   424

                                     /**< product code */

   425

                                     uint16_t pdo_index,

   426

                                     /**< PDO index */

   427

                                     uint8_t pdo_subindex,

   428

                                     /**< PDO subindex */

   429

                                     void **data_ptr

   430

                                     /**< address of the process data

   431

                                        pointer */

   432

                                     )

   433

{

   434

    ec_slave_t *slave;

   435

    ec_master_t *master;

   436

    const ec_sii_pdo_t *pdo;

   437

    const ec_sii_pdo_entry_t *entry;

   438

   439

    master = domain->master;

   440

   441

    // translate address

   442

    if (!(slave = ecrt_master_get_slave(master, address))) return NULL;

   443

   444

    if (vendor_id != slave->sii_vendor_id ||

   445

        product_code != slave->sii_product_code) {

   446

        EC_ERR("Invalid slave type at position %i - Requested: 0x%08X 0x%08X,"

   447

               " found: 0x%08X 0x%08X\".\n", slave->ring_position, vendor_id,

   448

               product_code, slave->sii_vendor_id, slave->sii_product_code);

   449

        return NULL;

   450

    }

   451

   452

    if (!data_ptr) {

   453

        // data_ptr is NULL => mark slave as "registered" (do not warn)

   454

        slave->registered = 1;

   455

    }

   456

   457

    list_for_each_entry(pdo, &slave->sii_pdos, list) {

   458

        list_for_each_entry(entry, &pdo->entries, list) {

   459

            if (entry->index != pdo_index

   460

                || entry->subindex != pdo_subindex) continue;

   461

   462

            if (data_ptr) {

   463

                ec_domain_reg_pdo_entry(domain, slave, pdo, entry, data_ptr);

   464

            }

   465

   466

            return slave;

   467

        }

   468

    }

   469

   470

    EC_ERR("Slave %i does not provide PDO 0x%04X:%i.\n",

   471

           slave->ring_position, pdo_index, pdo_subindex);

   472

    slave->registered = 0;

   473

    return NULL;

   474

}

   475

   476

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

   477

   478

/**

   479

   Registeres a bunch of data fields.

   480

   Caution! The list has to be terminated with a NULL structure ({})!

   481

   \return 0 in case of success, else < 0

   482

   \ingroup RealtimeInterface

   483

*/

   484

   485

int ecrt_domain_register_pdo_list(ec_domain_t *domain,

   486

                                  /**< EtherCAT domain */

   487

                                  const ec_pdo_reg_t *pdos

   488

                                  /**< array of PDO registrations */