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_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(struct kobject *);

    66

void ec_domain_clear_data_regs(ec_domain_t *);

    67

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

    68

    69

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

    70

    71

/** \cond */

    72

    73

EC_SYSFS_READ_ATTR(image_size);

    74

    75

static struct attribute *def_attrs[] = {

    76

    &attr_image_size,

    77

    NULL,

    78

};

    79

    80

static struct sysfs_ops sysfs_ops = {

    81

    .show = &ec_show_domain_attribute,

    82

    .store = NULL

    83

};

    84

    85

static struct kobj_type ktype_ec_domain = {

    86

    .release = ec_domain_clear,

    87

    .sysfs_ops = &sysfs_ops,

    88

    .default_attrs = def_attrs

    89

};

    90

    91

/** \endcond */

    92

    93

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

    94

    95

/**

    96

   Domain constructor.

    97

   \return 0 in case of success, else < 0

    98

*/

    99

   100

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

   101

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

   102

                   unsigned int index /**< domain index */

   103

                   )

   104

{

   105

    domain->master = master;

   106

    domain->index = index;

   107

    domain->data_size = 0;

   108

    domain->base_address = 0;

   109

    domain->response_count = 0xFFFFFFFF;

   110

    domain->notify_jiffies = 0;

   111

    domain->working_counter_changes = 0;

   112

   113

    INIT_LIST_HEAD(&domain->data_regs);

   114

    INIT_LIST_HEAD(&domain->datagrams);

   115

   116

    // init kobject and add it to the hierarchy

   117

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

   118

    kobject_init(&domain->kobj);

   119

    domain->kobj.ktype = &ktype_ec_domain;

   120

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

   121

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

   122

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

   123

        kobject_put(&domain->kobj);

   124

        return -1;

   125

    }

   126

    if (kobject_add(&domain->kobj)) {

   127

        EC_ERR("Failed to add domain kobject.\n");

   128

        kobject_put(&domain->kobj);

   129

        return -1;

   130

    }

   131

   132

    return 0;

   133

}

   134

   135

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

   136

   137

/**

   138

   Domain destructor.

   139

   Clears and frees a domain object.

   140

*/

   141

   142

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

   143

{

   144

    ec_datagram_t *datagram;

   145

   146

    // dequeue datagrams

   147

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

   148

        if (!list_empty(&datagram->queue)) // datagram queued?

   149

            list_del_init(&datagram->queue);

   150

    }

   151

   152

    // destroy self

   153

    kobject_del(&domain->kobj);

   154

    kobject_put(&domain->kobj);

   155

}

   156

   157

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

   158

   159

/**

   160

   Clear and free domain.

   161

   This method is called by the kobject,

   162

   once there are no more references to it.

   163

*/

   164

   165

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

   166

{

   167

    ec_datagram_t *datagram, *next;

   168

    ec_domain_t *domain;

   169

   170

    domain = container_of(kobj, ec_domain_t, kobj);

   171

   172

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

   173

        ec_datagram_clear(datagram);

   174

        kfree(datagram);

   175

    }

   176

   177

    ec_domain_clear_data_regs(domain);

   178

   179

    kfree(domain);

   180

}

   181

   182

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

   183

   184

/**

   185

 * Registers a PDO entry.

   186

 * \return 0 in case of success, else < 0

   187

 */

   188

   189

int ec_domain_reg_pdo_entry(

   190

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

   191

        ec_sync_t *sync, /**< sync manager */

   192

        const ec_pdo_entry_t *entry, /**< PDO entry to register */

   193

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

   194

        )

   195

{

   196

    ec_data_reg_t *data_reg;

   197

    const ec_pdo_t *other_pdo;

   198

    const ec_pdo_entry_t *other_entry;

   199

    unsigned int bit_offset, byte_offset;

   200

   201

    // Calculate offset (in sync manager) for process data pointer

   202

    bit_offset = 0;

   203

    byte_offset = 0;

   204

    list_for_each_entry(other_pdo, &sync->pdos, list) {

   205

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

   206

            if (other_entry == entry) {

   207

                byte_offset = bit_offset / 8;

   208

                break;

   209

            }

   210

            bit_offset += other_entry->bit_length;

   211

        }

   212

    }

   213

   214

    // Allocate memory for data registration object

   215

    if (!(data_reg =

   216

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

   217

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

   218

        return -1;

   219

    }

   220

   221

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

   222

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

   223

        kfree(data_reg);

   224

        return -1;

   225

    }

   226

   227

    data_reg->slave = sync->slave;

   228

    data_reg->sync = sync;

   229

    data_reg->sync_offset = byte_offset;

   230

    data_reg->data_ptr = data_ptr;

   231

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

   232

   233

    return 0;

   234

}

   235

   236

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

   237

   238

/**

   239

   Registeres a PDO range.

   240

   \return 0 in case of success, else < 0

   241

*/

   242

   243

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

   244

                            ec_slave_t *slave, /**< slave */

   245

                            ec_direction_t dir, /**< data direction */

   246

                            uint16_t offset, /**< offset */

   247

                            uint16_t length, /**< length */

   248

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

   249

                                               pointer */

   250

                            )

   251

{

   252

    ec_data_reg_t *data_reg;

   253

    ec_sync_t *sync;

   254

    uint16_t sync_length;

   255

   256

    if (!(sync = ec_slave_get_pdo_sync(slave, dir))) {

   257

        EC_ERR("No sync manager found for PDO range.\n");

   258

        return -1;

   259

    }

   260

   261

    // Allocate memory for data registration object

   262

    if (!(data_reg =

   263

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

   264

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

   265

        return -1;

   266

    }

   267

   268

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

   269

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

   270

        kfree(data_reg);

   271

        return -1;

   272

    }

   273

   274

    data_reg->slave = slave;

   275

    data_reg->sync = sync;

   276

    data_reg->sync_offset = offset;

   277

    data_reg->data_ptr = data_ptr;

   278

   279

    // estimate sync manager length

   280

    sync_length = offset + length;

   281

    if (sync->est_length < sync_length) {

   282

        sync->est_length = sync_length;

   283

        if (domain->master->debug_level) {

   284

            EC_DBG("Estimating length of sync manager %i of slave %i to %i.\n",

   285

                   sync->index, slave->ring_position, sync_length);

   286

        }

   287

    }

   288

   289

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

   290

   291

    return 0;

   292

}

   293

   294

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

   295

   296

/**

   297

   Clears the list of the data registrations.

   298

*/

   299

   300

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

   301

{

   302

    ec_data_reg_t *data_reg, *next;

   303

   304

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

   305

        list_del(&data_reg->list);

   306

        kfree(data_reg);

   307

    }

   308

}

   309

   310

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

   311

   312

/**

   313

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

   314

   \return 0 in case of success, else < 0

   315

*/

   316

   317

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

   318

                           uint32_t offset, /**< logical offset */

   319

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

   320

                           )

   321

{

   322

    ec_datagram_t *datagram;

   323

   324

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

   325

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

   326

        return -1;

   327

    }

   328

   329

    ec_datagram_init(datagram);

   330

   331

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

   332

        kfree(datagram);

   333

        return -1;

   334

    }

   335

   336

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

   337

    return 0;

   338

}

   339

   340

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

   341

   342

/**

   343

   Creates a domain.

   344

   Reserves domain memory, calculates the logical addresses of the

   345

   corresponding FMMUs and sets the process data pointer of the registered

   346

   process data.

   347

   \return 0 in case of success, else < 0

   348

*/

   349

   350

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

   351

                    uint32_t base_address /**< logical base address */

   352

                    )

   353

{

   354

    ec_data_reg_t *data_reg;

   355

    ec_slave_t *slave;

   356

    ec_fmmu_t *fmmu;

   357

    unsigned int i, j, datagram_count;

   358

    uint32_t pdo_off, pdo_off_datagram;

   359

    uint32_t datagram_offset;

   360

    size_t datagram_data_size, sync_size;

   361

    ec_datagram_t *datagram;

   362

   363

    domain->base_address = base_address;

   364

   365

    // calculate size of process data and allocate memory

   366

    domain->data_size = 0;

   367

    datagram_offset = base_address;

   368

    datagram_data_size = 0;

   369

    datagram_count = 0;

   370

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

   371

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

   372

            fmmu = &slave->fmmus[j];

   373

            if (fmmu->domain == domain) {

   374

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

   375

                sync_size = ec_sync_size(fmmu->sync);

   376

                domain->data_size += sync_size;

   377

                if (datagram_data_size + sync_size > EC_MAX_DATA_SIZE) {

   378

                    if (ec_domain_add_datagram(domain, datagram_offset,

   379

                                               datagram_data_size)) return -1;

   380

                    datagram_offset += datagram_data_size;

   381

                    datagram_data_size = 0;

   382

                    datagram_count++;

   383

                }

   384

                datagram_data_size += sync_size;

   385

            }

   386

        }

   387

    }

   388

   389

    // allocate last datagram

   390

    if (datagram_data_size) {

   391

        if (ec_domain_add_datagram(domain, datagram_offset,

   392

                                   datagram_data_size))

   393

            return -1;

   394

        datagram_count++;

   395

    }

   396

   397

    if (!datagram_count) {

   398

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

   399

        ec_domain_clear_data_regs(domain);

   400

        return 0;

   401

    }

   402

   403

    // set all process data pointers

   404

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

   405

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

   406

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

   407

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

   408

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

   409

                // search datagram

   410

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

   411

                    pdo_off_datagram = pdo_off - datagram->address.logical;

   412

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

   413

                        pdo_off_datagram < datagram->mem_size) {

   414

                        *data_reg->data_ptr = datagram->data +

   415

                            pdo_off_datagram;

   416

                    }

   417

                }

   418

                if (!data_reg->data_ptr) {

   419

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

   420

                    return -1;

   421

                }

   422

                break;

   423

            }

   424

        }

   425

    }

   426

   427

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

   428

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

   429

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

   430

   431

    ec_domain_clear_data_regs(domain);

   432

   433

    return 0;

   434

}

   435

   436

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

   437

   438

/**

   439

   Formats attribute data for SysFS reading.

   440

   \return number of bytes to read

   441

*/

   442

   443

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

   444

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

   445

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

   446

                                 )

   447

{

   448

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

   449

   450

    if (attr == &attr_image_size) {

   451

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

   452

    }

   453

   454

    return 0;

   455

}

   456

   457

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

   458

 *  Realtime interface

   459

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

   460

   461

/**

   462

 * Registers a PDO for a domain.

   463

 * \return pointer to the slave on success, else NULL

   464

 * \ingroup RealtimeInterface

   465

 */

   466

   467

ec_slave_t *ecrt_domain_register_pdo(

   468

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

   469

        const char *address, /**< ASCII address of the slave,

   470

                               see ecrt_master_get_slave() */

   471

        uint32_t vendor_id, /**< vendor ID */

   472

        uint32_t product_code, /**< product code */

   473

        uint16_t entry_index, /**< PDO entry index */

   474

        uint8_t entry_subindex, /**< PDO entry subindex */

   475

        void **data_ptr /**< address of the process data pointer */

   476

        )

   477

{

   478

    ec_slave_t *slave;

   479

    ec_master_t *master;

   480

    ec_sync_t *sync;

   481

    const ec_pdo_t *pdo;

   482

    const ec_pdo_entry_t *entry;

   483

    unsigned int i;

   484

   485

    master = domain->master;

   486

   487

    // translate address and validate slave

   488