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(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

   Registeres a PDO entry.

   186

   \return 0 in case of success, else < 0

   187

*/

   188

   189

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

   190

                            ec_slave_t *slave, /**< slave */

   193

                            /**< PDO registration entry */

   194

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

   195

                                               pointer */

   196

                            )

   197

{

   198

    ec_data_reg_t *data_reg;

   199

    const ec_sii_sync_t *sync;

   202

    unsigned int bit_offset, byte_offset;

   203

   204

    // Find sync manager for PDO

   205

    if (pdo->sync_index >= slave->sii_sync_count) {

   206

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

   207

               pdo->index, entry->subindex);

   208

        return -1;

   209

    }

   210

   211

    sync = &slave->sii_syncs[pdo->sync_index];

   212

   213

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

   214

    bit_offset = 0;

   215

    byte_offset = 0;

   216

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

   217

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

   218

   219

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

   220

            if (other_entry == entry) {

   221

                byte_offset = bit_offset / 8;

   222

                break;

   223

            }

   224

            bit_offset += other_entry->bit_length;

   225

        }

   226

    }

   227

   228

    // Allocate memory for data registration object

   229

    if (!(data_reg =

   230

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

   231

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

   232

        return -1;

   233

    }

   234

   235

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

   236

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

   237

        kfree(data_reg);

   238

        return -1;

   239

    }

   240

   241

    data_reg->slave = slave;

   242

    data_reg->sync = sync;

   243

    data_reg->sync_offset = byte_offset;

   244

    data_reg->data_ptr = data_ptr;

   245

   246

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

   247

   248

    return 0;

   249

}

   250

   251

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

   252

   253

/**

   254

   Registeres a PDO range.

   255

   \return 0 in case of success, else < 0

   256

*/

   257

   258

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

   259

                            ec_slave_t *slave, /**< slave */

   260

                            ec_direction_t dir, /**< data direction */

   261

                            uint16_t offset, /**< offset */

   262

                            uint16_t length, /**< length */

   263

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

   264

                                               pointer */

   265

                            )

   266

{

   267

    ec_data_reg_t *data_reg;

   268

    ec_sii_sync_t *sync;

   269

    uint16_t sync_length;

   270

   271

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

   272

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

   273

        return -1;

   274

    }

   275

   276

    // Allocate memory for data registration object

   277

    if (!(data_reg =

   278

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

   279

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

   280

        return -1;

   281

    }

   282

   283

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

   284

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

   285

        kfree(data_reg);

   286

        return -1;

   287

    }

   288

   289

    data_reg->slave = slave;

   290

    data_reg->sync = sync;

   291

    data_reg->sync_offset = offset;

   292

    data_reg->data_ptr = data_ptr;

   293

   294

    // estimate sync manager length

   295

    sync_length = offset + length;

   296

    if (sync->est_length < sync_length) {

   297

        sync->est_length = sync_length;

   298

        if (domain->master->debug_level) {

   299

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

   300

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

   301

        }

   302

    }

   303

   304

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

   305

   306

    return 0;

   307

}

   308

   309

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

   310

   311

/**

   312

   Clears the list of the data registrations.

   313

*/

   314

   315

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

   316

{

   317

    ec_data_reg_t *data_reg, *next;

   318

   319

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

   320

        list_del(&data_reg->list);

   321

        kfree(data_reg);

   322

    }

   323

}

   324

   325

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

   326

   327

/**

   328

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

   329

   \return 0 in case of success, else < 0

   330

*/

   331

   332

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

   333

                           uint32_t offset, /**< logical offset */

   334

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

   335

                           )

   336

{

   337

    ec_datagram_t *datagram;

   338

   339

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

   340

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

   341

        return -1;

   342

    }

   343

   344

    ec_datagram_init(datagram);

   345

   346

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

   347

        kfree(datagram);

   348

        return -1;

   349

    }

   350

   351

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

   352

    return 0;

   353

}

   354

   355

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

   356

   357

/**

   358

   Creates a domain.

   359

   Reserves domain memory, calculates the logical addresses of the

   360

   corresponding FMMUs and sets the process data pointer of the registered

   361

   process data.

   362

   \return 0 in case of success, else < 0

   363

*/

   364

   365

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

   366

                    uint32_t base_address /**< logical base address */

   367

                    )

   368

{

   369

    ec_data_reg_t *data_reg;

   370

    ec_slave_t *slave;

   371

    ec_fmmu_t *fmmu;

   372

    unsigned int i, j, datagram_count;

   373

    uint32_t pdo_off, pdo_off_datagram;

   374

    uint32_t datagram_offset;

   375

    size_t datagram_data_size, sync_size;

   376

    ec_datagram_t *datagram;

   377

   378

    domain->base_address = base_address;

   379

   380

    // calculate size of process data and allocate memory

   381

    domain->data_size = 0;

   382

    datagram_offset = base_address;

   383

    datagram_data_size = 0;

   384

    datagram_count = 0;

   385

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

   386

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

   387

            fmmu = &slave->fmmus[j];

   388

            if (fmmu->domain == domain) {

   389

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

   390

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

   391

                domain->data_size += sync_size;

   392

                if (datagram_data_size + sync_size > EC_MAX_DATA_SIZE) {

   393

                    if (ec_domain_add_datagram(domain, datagram_offset,

   394

                                               datagram_data_size)) return -1;

   395

                    datagram_offset += datagram_data_size;

   396

                    datagram_data_size = 0;

   397

                    datagram_count++;

   398

                }

   399

                datagram_data_size += sync_size;

   400

            }

   401

        }

   402

    }

   403

   404

    // allocate last datagram

   405

    if (datagram_data_size) {

   406

        if (ec_domain_add_datagram(domain, datagram_offset,

   407

                                   datagram_data_size))

   408

            return -1;

   409

        datagram_count++;

   410

    }

   411

   412

    if (!datagram_count) {

   413

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

   414

        ec_domain_clear_data_regs(domain);

   415

        return 0;

   416

    }

   417

   418

    // set all process data pointers

   419

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

   420

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

   421

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

   422

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

   423

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

   424

                // search datagram

   425

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

   426

                    pdo_off_datagram = pdo_off - datagram->address.logical;

   427

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

   428

                        pdo_off_datagram < datagram->mem_size) {

   429

                        *data_reg->data_ptr = datagram->data +

   430

                            pdo_off_datagram;

   431

                    }

   432

                }

   433

                if (!data_reg->data_ptr) {

   434

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

   435

                    return -1;

   436

                }

   437

                break;

   438

            }

   439

        }

   440

    }

   441

   442

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

   443

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

   444

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

   445

   446

    ec_domain_clear_data_regs(domain);

   447

   448

    return 0;

   449

}

   450

   451

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

   452

   453

/**

   454

   Formats attribute data for SysFS reading.

   455

   \return number of bytes to read

   456

*/

   457

   458

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

   459

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

   460

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

   461

                                 )

   462

{

   463

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

   464

   465

    if (attr == &attr_image_size) {

   466

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

   467

    }

   468

   469

    return 0;

   470

}

   471

   472

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

   473

 *  Realtime interface

   474

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

   475

   476

/**

   477

   Registers a PDO in a domain.

   478

   \return pointer to the slave on success, else NULL

   479

   \ingroup RealtimeInterface

   480

*/

   481

   482

ec_slave_t *ecrt_domain_register_pdo(ec_domain_t *domain,

   483

                                     /**< EtherCAT domain */

   484

                                     const char *address,

   485

                                     /**< ASCII address of the slave,

   486

                                        see ecrt_master_get_slave() */

   487

                                     uint32_t vendor_id,

   488

                                     /**< vendor ID */