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

    75

    76

static struct attribute *def_attrs[] = {

    79

    NULL,

    80

};

    81

    82

static struct sysfs_ops sysfs_ops = {

    83

    .show = &ec_show_domain_attribute,

    84

    .store = NULL

    85

};

    86

    87

static struct kobj_type ktype_ec_domain = {

    88

    .release = ec_domain_clear,

    89

    .sysfs_ops = &sysfs_ops,

    90

    .default_attrs = def_attrs

    91

};

    92

    93

/** \endcond */

    94

    95

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

    96

    97

/**

    98

   Domain constructor.

    99

   \return 0 in case of success, else < 0

   100

*/

   101

   102

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

   103

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

   104

                   unsigned int index /**< domain index */

   105

                   )

   106

{

   107

    domain->master = master;

   108

    domain->index = index;

   109

    domain->data_size = 0;

   110

    domain->base_address = 0;

   111

    domain->response_count = 0xFFFFFFFF;

   112

    domain->notify_jiffies = 0;

   113

    domain->working_counter_changes = 0;

   114

   115

    INIT_LIST_HEAD(&domain->data_regs);

   116

    INIT_LIST_HEAD(&domain->datagrams);

   117

   118

    // init kobject and add it to the hierarchy

   119

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

   120

    kobject_init(&domain->kobj);

   121

    domain->kobj.ktype = &ktype_ec_domain;

   122

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

   123

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

   124

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

   125

        kobject_put(&domain->kobj);

   126

        return -1;

   127

    }

   128

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

   129

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

   130

        kobject_put(&domain->kobj);

   131

        return -1;

   132

    }

   133

   134

    return 0;

   135

}

   136

   137

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

   138

   139

/**

   140

   Domain destructor.

   141

   Clears and frees a domain object.

   142

*/

   143

   144

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

   145

{

   146

    ec_datagram_t *datagram;

   147

   148

    // dequeue datagrams

   149

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

   150

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

   151

            list_del_init(&datagram->queue);

   152

    }

   153

   154

    // destroy self

   155

    kobject_del(&domain->kobj);

   156

    kobject_put(&domain->kobj);

   157

}

   158

   159

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

   160

   161

/**

   162

   Clear and free domain.

   163

   This method is called by the kobject,

   164

   once there are no more references to it.

   165

*/

   166

   167

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

   168

{

   169

    ec_datagram_t *datagram, *next;

   170

    ec_domain_t *domain;

   171

   172

    domain = container_of(kobj, ec_domain_t, kobj);

   173

   174

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

   175

        ec_datagram_clear(datagram);

   176

        kfree(datagram);

   177

    }

   178

   179

    ec_domain_clear_data_regs(domain);

   180

   181

    kfree(domain);

   182

}

   183

   184

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

   185

   186

/**

   187

 * Registers a PDO entry.

   188

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

   189

 */

   190

   191

int ec_domain_reg_pdo_entry(

   192

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

   193

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

   194

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

   195

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

   196

        )

   197

{

   198

    ec_data_reg_t *data_reg;

   199

    const ec_pdo_t *other_pdo;

   200

    const ec_pdo_entry_t *other_entry;

   201

    unsigned int bit_offset, byte_offset;

   202

   203

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

   204

    bit_offset = 0;

   205

    byte_offset = 0;

   206

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

   207

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

   208

            if (other_entry == entry) {

   209

                byte_offset = bit_offset / 8;

   210

                break;

   211

            }

   212

            bit_offset += other_entry->bit_length;

   213

        }

   214

    }

   215

   216

    // Allocate memory for data registration object

   217

    if (!(data_reg =

   218

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

   219

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

   220

        return -1;

   221

    }

   222

   223

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

   224

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

   225

        kfree(data_reg);

   226

        return -1;

   227

    }

   228

   229

    data_reg->slave = sync->slave;

   230

    data_reg->sync = sync;

   231

    data_reg->sync_offset = byte_offset;

   232

    data_reg->data_ptr = data_ptr;

   233

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

   234

   235

    return 0;

   236

}

   237

   238

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

   239

   240

/**

   241

   Clears the list of the data registrations.

   242

*/

   243

   244

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

   245

{

   246

    ec_data_reg_t *data_reg, *next;

   247

   248

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

   249

        list_del(&data_reg->list);

   250

        kfree(data_reg);

   251

    }

   252

}

   253

   254

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

   255

   256

/**

   257

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

   258

   \return 0 in case of success, else < 0

   259

*/

   260

   261

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

   262

                           uint32_t offset, /**< logical offset */

   263

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

   264

                           )

   265

{

   266

    ec_datagram_t *datagram;

   267

   268

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

   269

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

   270

        return -1;

   271

    }

   272

   273

    ec_datagram_init(datagram);

   274

    snprintf(datagram->name, EC_DATAGRAM_NAME_SIZE,

   275

            "domain%u-%u", domain->index, offset);

   276

   277

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

   278

        kfree(datagram);

   279

        return -1;

   280

    }

   281

   282

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

   283

    return 0;

   284

}

   285

   286

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

   287

   288

/**

   289

   Creates a domain.

   290

   Reserves domain memory, calculates the logical addresses of the

   291

   corresponding FMMUs and sets the process data pointer of the registered

   292

   process data.

   293

   \return 0 in case of success, else < 0

   294

*/

   295

   296

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

   297

                    uint32_t base_address /**< logical base address */

   298

                    )

   299

{

   300

    ec_data_reg_t *data_reg;

   301

    ec_slave_t *slave;

   302

    ec_fmmu_t *fmmu;

   303

    unsigned int i, j, datagram_count;

   304

    uint32_t pdo_off, pdo_off_datagram;

   305

    uint32_t datagram_offset, log_addr;

   306

    size_t datagram_data_size, sync_size;

   307

    ec_datagram_t *datagram;

   308

   309

    domain->base_address = base_address;

   310

   311

    // calculate size of process data and allocate memory

   312

    domain->data_size = 0;

   313

    datagram_offset = base_address;

   314

    datagram_data_size = 0;

   315

    datagram_count = 0;

   316

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

   317

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

   318

            fmmu = &slave->fmmus[j];

   319

            if (fmmu->domain == domain) {

   320

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

   321

                sync_size = ec_sync_size(fmmu->sync);

   322

                domain->data_size += sync_size;

   323

                if (datagram_data_size + sync_size > EC_MAX_DATA_SIZE) {

   324

                    if (ec_domain_add_datagram(domain, datagram_offset,

   325

                                               datagram_data_size)) return -1;

   326

                    datagram_offset += datagram_data_size;

   327

                    datagram_data_size = 0;

   328

                    datagram_count++;

   329

                }

   330

                datagram_data_size += sync_size;

   331

            }

   332

        }

   333

    }

   334

   335

    // allocate last datagram

   336

    if (datagram_data_size) {

   337

        if (ec_domain_add_datagram(domain, datagram_offset,

   338

                                   datagram_data_size))

   339

            return -1;

   340

        datagram_count++;

   341

    }

   342

   343

    if (!datagram_count) {

   344

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

   345

        ec_domain_clear_data_regs(domain);

   346

        return 0;

   347

    }

   348

   349

    // set all process data pointers

   350

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

   351

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

   352

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

   353

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

   354

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

   355

                // search datagram

   356

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

   357

                    log_addr = EC_READ_U32(datagram->address);

   358

                    pdo_off_datagram = pdo_off - log_addr;

   359

                    if (pdo_off >= log_addr &&

   360

                        pdo_off_datagram < datagram->mem_size) {

   361

                        *data_reg->data_ptr = datagram->data +

   362

                            pdo_off_datagram;

   363

                    }

   364

                }

   365

                if (!data_reg->data_ptr) {

   366

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

   367

                    return -1;

   368

                }

   369

                break;

   370

            }

   371

        }

   372

    }

   373

   374

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

   375

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

   376

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

   377

   378

    ec_domain_clear_data_regs(domain);

   379

   380

    return 0;

   381

}

   382

   383

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

   384

   407

/**

   408

   Formats attribute data for SysFS reading.

   409

   \return number of bytes to read

   410

*/

   411

   412

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

   413

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

   414

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

   415

                                 )

   416

{

   417

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

   418

   423

    }

   424

   425

    return 0;

   426

}

   427

   428

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

   429

 *  Realtime interface

   430

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

   431

   432

/**

   433

 * Registers a PDO for a domain.

   434

 * \return 0 on success, else non-zero

   435

 * \ingroup RealtimeInterface

   436

 */

   437

   438

int ecrt_domain_register_pdo(

   439

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

   440

        ec_slave_t *slave, /**< EtherCAT slave */

   441

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

   442

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

   443

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

   444

        )

   445

{

   446

    ec_sync_t *sync;

   447

    const ec_pdo_t *pdo;

   448

    const ec_pdo_entry_t *entry;

   449

    unsigned int i;

   450

   451

    // search for PDO entry

   452

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

   453

        sync = &slave->sii_syncs[i];

   454

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

   455

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

   456

                if (entry->index != pdo_entry_index ||

   457

                        entry->subindex != pdo_entry_subindex) continue;

   458

   459

                // PDO entry found

   460

                if (ec_domain_reg_pdo_entry(domain, sync, entry, data_ptr)) {

   461

                    return -1;

   462

                }

   463

   464

                return 0;

   465

            }

   466

        }

   467

    }

   468

   469

    EC_ERR("PDO entry 0x%04X:%u is not mapped in slave %u.\n",

   470

           pdo_entry_index, pdo_entry_subindex, slave->ring_position);

   471

    return -1;

   472

}

   473

   474

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

   475

   476

/**

   477

 * Registers a bunch of data fields.

   478

 * \attention The list has to be terminated with a NULL structure ({})!

   479

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

   480

 * \ingroup RealtimeInterface

   481

 */

   482

   483

int ecrt_domain_register_pdo_list(

   484

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

   485

        const ec_pdo_reg_t *pdo_regs /**< array of PDO registrations */

   486

        )

   487

{

   488

    const ec_pdo_reg_t *reg;