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

        return -1;

   124

    }

   125

   126

    return 0;

   127

}

   128

   129

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

   130

   131

/**

   132

   Domain destructor.

   133

*/

   134

   135

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

   136

{

   137

    ec_datagram_t *datagram, *next;

   138

    ec_domain_t *domain;

   139

   140

    domain = container_of(kobj, ec_domain_t, kobj);

   141

   142

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

   143

   144

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

   145

        ec_datagram_clear(datagram);

   146

        kfree(datagram);

   147

    }

   148

   149

    ec_domain_clear_data_regs(domain);

   150

   151

    kfree(domain);

   152

}

   153

   154

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

   155

   156

/**

   157

   Registeres a PDO entry.

   158

   \return 0 in case of success, else < 0

   159

*/

   160

   161

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

   162

                            ec_slave_t *slave, /**< slave */

   163

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

   164

                            const ec_sii_pdo_entry_t *entry,

   165

                            /**< PDO registration entry */

   166

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

   167

                                               pointer */

   168

                            )

   169

{

   170

    ec_data_reg_t *data_reg;

   171

    const ec_sii_sync_t *sync;

   172

    const ec_sii_pdo_t *other_pdo;

   173

    const ec_sii_pdo_entry_t *other_entry;

   174

    unsigned int bit_offset, byte_offset, sync_found;

   175

   176

    // Find sync manager for PDO

   177

    sync_found = 0;

   178

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

   179

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

   180

            sync_found = 1;

   181

            break;

   182

        }

   183

    }

   184

   185

    if (!sync_found) {

   186

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

   187

               pdo->index, entry->subindex);

   188

        return -1;

   189

    }

   190

   191

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

   192

    bit_offset = 0;

   193

    byte_offset = 0;

   194

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

   195

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

   196

   197

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

   198

            if (other_entry == entry) {

   199

                byte_offset = bit_offset / 8;

   200

                break;

   201

            }

   202

            bit_offset += other_entry->bit_length;

   203

        }

   204

    }

   205

   206

    // Allocate memory for data registration object

   207

    if (!(data_reg =

   208

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

   209

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

   210

        return -1;

   211

    }

   212

   213

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

   214

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

   215

        kfree(data_reg);

   216

        return -1;

   217

    }

   218

   219

    data_reg->slave = slave;

   220

    data_reg->sync = sync;

   221

    data_reg->sync_offset = byte_offset;

   222

    data_reg->data_ptr = data_ptr;

   223

   224

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

   225

    return 0;

   226

}

   227

   228

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

   229

   230

/**

   231

   Registeres a PDO range.

   232

   \return 0 in case of success, else < 0

   233

*/

   234

   235

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

   236

                            ec_slave_t *slave, /**< slave */

   237

                            ec_direction_t dir, /**< data direction */

   238

                            uint16_t offset, /**< offset */

   239

                            uint16_t length, /**< length */

   240

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

   241

                                               pointer */

   242

                            )

   243

{

   244

    ec_data_reg_t *data_reg;

   245

    ec_sii_sync_t *sync;

   246

    unsigned int sync_found, sync_index;

   247

    uint16_t sync_length;

   248

   249

    switch (dir) {

   250

        case EC_DIR_OUTPUT: sync_index = 2; break;

   251

        case EC_DIR_INPUT:  sync_index = 3; break;

   252

        default:

   253

            EC_ERR("Invalid direction!\n");

   254

            return -1;

   255

    }

   256

   257

    // Find sync manager

   258

    sync_found = 0;

   259

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

   260

        if (sync->index == sync_index) {

   261

            sync_found = 1;

   262

            break;

   263

        }

   264

    }

   265

   266

    if (!sync_found) {

   267

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

   268

        return -1;

   269

    }

   270

   271

     // Allocate memory for data registration object

   272

    if (!(data_reg =

   273

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

   274

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

   275

        return -1;

   276

    }

   277

   278

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

   279

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

   280

        kfree(data_reg);

   281

        return -1;

   282

    }

   283

   284

    data_reg->slave = slave;

   285

    data_reg->sync = sync;

   286

    data_reg->sync_offset = offset;

   287

    data_reg->data_ptr = data_ptr;

   288

   289

    // estimate sync manager length

   290

    sync_length = offset + length;

   291

    if (sync->est_length < sync_length) {

   292

        sync->est_length = sync_length;

   293

        if (domain->master->debug_level) {

   294

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

   295

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

   296

        }

   297

    }

   298

   299

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

   300

    return 0;

   301

}

   302

   303

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

   304

   305

/**

   306

   Clears the list of the data registrations.

   307

*/

   308

   309

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

   310

{

   311

    ec_data_reg_t *data_reg, *next;

   312

   313

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

   314

        list_del(&data_reg->list);

   315

        kfree(data_reg);

   316

    }

   317

}

   318

   319

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

   320

   321

/**

   322

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

   323

   \return 0 in case of success, else < 0

   324

*/

   325

   326

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

   327

                           uint32_t offset, /**< logical offset */

   328

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

   329

                           )

   330

{

   331

    ec_datagram_t *datagram;

   332

   333

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

   334

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

   335

        return -1;

   336

    }

   337

   338

    ec_datagram_init(datagram);

   339

   340

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

   341

        kfree(datagram);

   342

        return -1;

   343

    }

   344

   345

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

   346

    return 0;

   347

}

   348

   349

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

   350

   351

/**

   352

   Creates a domain.

   353

   Reserves domain memory, calculates the logical addresses of the

   354

   corresponding FMMUs and sets the process data pointer of the registered

   355

   process data.

   356

   \return 0 in case of success, else < 0

   357

*/

   358

   359

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

   360

                    uint32_t base_address /**< logical base address */

   361

                    )

   362

{

   363

    ec_data_reg_t *data_reg;

   364

    ec_slave_t *slave;

   365

    ec_fmmu_t *fmmu;

   366

    unsigned int i, j, datagram_count;

   367

    uint32_t pdo_off, pdo_off_datagram;

   368

    uint32_t datagram_offset;

   369

    size_t datagram_data_size, sync_size;

   370

    ec_datagram_t *datagram;

   371

   372

    domain->base_address = base_address;

   373

   374

    // calculate size of process data and allocate memory

   375

    domain->data_size = 0;

   376

    datagram_offset = base_address;

   377

    datagram_data_size = 0;

   378

    datagram_count = 0;

   379

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

   380

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

   381

            fmmu = &slave->fmmus[j];

   382

            if (fmmu->domain == domain) {

   383

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

   384

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

   385

                domain->data_size += sync_size;

   386

                if (datagram_data_size + sync_size > EC_MAX_DATA_SIZE) {

   387

                    if (ec_domain_add_datagram(domain, datagram_offset,

   388

                                               datagram_data_size)) return -1;

   389

                    datagram_offset += datagram_data_size;

   390

                    datagram_data_size = 0;

   391

                    datagram_count++;

   392

                }

   393

                datagram_data_size += sync_size;

   394

            }

   395

        }

   396

    }

   397

   398

    // allocate last datagram

   399

    if (datagram_data_size) {

   400

        if (ec_domain_add_datagram(domain, datagram_offset,

   401

                                   datagram_data_size))

   402

            return -1;

   403

        datagram_count++;

   404

    }

   405

   406

    if (!datagram_count) {

   407

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

   408

        ec_domain_clear_data_regs(domain);

   409

        return 0;

   410

    }

   411

   412

    // set all process data pointers

   413

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

   414

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

   415

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

   416

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

   417

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

   418

                // search datagram

   419

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

   420

                    pdo_off_datagram = pdo_off - datagram->address.logical;

   421

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

   422

                        pdo_off_datagram < datagram->mem_size) {

   423

                        *data_reg->data_ptr = datagram->data +

   424

                            pdo_off_datagram;

   425

                    }

   426

                }

   427

                if (!data_reg->data_ptr) {

   428

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

   429

                    return -1;

   430

                }

   431

                break;

   432

            }

   433

        }

   434

    }

   435

   436

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

   437

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

   438

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

   439

   440

    ec_domain_clear_data_regs(domain);

   441

   442

    return 0;

   443

}

   444

   445

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

   446

   447

/**

   448

   Places all process data datagrams in the masters datagram queue.

   449

*/

   450

   451

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

   452

{

   453

    ec_datagram_t *datagram;

   454

   455

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

   456

        ec_master_queue_datagram(domain->master, datagram);

   457

    }

   458

}

   459

   460

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

   461

   462

/**

   463

   Formats attribute data for SysFS reading.

   464

   \return number of bytes to read

   465

*/

   466

   467

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

   468

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

   469

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

   470

                                 )

   471

{

   472

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

   473

   474

    if (attr == &attr_image_size) {

   475

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

   476

    }

   477

   478

    return 0;

   479

}

   480

   481

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

   482

 *  Realtime interface

   483

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

   484

   485

/**

   486

   Registers a PDO in a domain.

   487

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

   488

   \return pointer to the slave on success, else NULL

   489

   \ingroup RealtimeInterface