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

   Clears and frees a domain object.

   134

*/

   135

   136

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

   137

{

   138

    ec_datagram_t *datagram;

   139

   140

    // dequeue datagrams

   141

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

   142

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

   143

            list_del_init(&datagram->queue);

   144

    }

   145

   146

    // destroy self

   147

    kobject_del(&domain->kobj);

   148

    kobject_put(&domain->kobj);

   149

}

   150

   151

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

   152

   153

/**

   154

   Clear and free domain.

   155

   This method is called by the kobject,

   156

   once there are no more references to it.

   157

*/

   158

   159

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

   160

{

   161

    ec_datagram_t *datagram, *next;

   162

    ec_domain_t *domain;

   163

   164

    domain = container_of(kobj, ec_domain_t, kobj);

   165

   166

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

   167

        ec_datagram_clear(datagram);

   168

        kfree(datagram);

   169

    }

   170

   171

    ec_domain_clear_data_regs(domain);

   172

   173

    kfree(domain);

   174

}

   175

   176

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

   177

   178

/**

   179

   Registeres a PDO entry.

   180

   \return 0 in case of success, else < 0

   181

*/

   182

   183

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

   184

                            ec_slave_t *slave, /**< slave */

   185

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

   186

                            const ec_sii_pdo_entry_t *entry,

   187

                            /**< PDO registration entry */

   188

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

   189

                                               pointer */

   190

                            )

   191

{

   192

    ec_data_reg_t *data_reg;

   193

    const ec_sii_sync_t *sync;

   194

    const ec_sii_pdo_t *other_pdo;

   195

    const ec_sii_pdo_entry_t *other_entry;

   196

    unsigned int bit_offset, byte_offset, sync_found;

   197

   198

    // Find sync manager for PDO

   199

    sync_found = 0;

   200

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

   201

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

   202

            sync_found = 1;

   203

            break;

   204

        }

   205

    }

   206

   207

    if (!sync_found) {

   208

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

   209

               pdo->index, entry->subindex);

   210

        return -1;

   211

    }

   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

    ec_slave_request_state(slave, EC_SLAVE_STATE_OP);

   249

   250

    return 0;

   251

}

   252

   253

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

   254

   255

/**

   256

   Registeres a PDO range.

   257

   \return 0 in case of success, else < 0

   258

*/

   259

   260

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

   261

                            ec_slave_t *slave, /**< slave */

   262

                            ec_direction_t dir, /**< data direction */

   263

                            uint16_t offset, /**< offset */

   264

                            uint16_t length, /**< length */

   265

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

   266

                                               pointer */

   267

                            )

   268

{

   269

    ec_data_reg_t *data_reg;

   270

    ec_sii_sync_t *sync;

   271

    unsigned int sync_found, sync_index;

   272

    uint16_t sync_length;

   273

   274

    switch (dir) {

   275

        case EC_DIR_OUTPUT: sync_index = 2; break;

   276

        case EC_DIR_INPUT:  sync_index = 3; break;

   277

        default:

   278

            EC_ERR("Invalid direction!\n");

   279

            return -1;

   280

    }

   281

   282

    // Find sync manager

   283

    sync_found = 0;

   284

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

   285

        if (sync->index == sync_index) {

   286

            sync_found = 1;

   287

            break;

   288

        }

   289

    }

   290

   291

    if (!sync_found) {

   292

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

   293

        return -1;

   294

    }

   295

   296

     // Allocate memory for data registration object

   297

    if (!(data_reg =

   298

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

   299

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

   300

        return -1;

   301

    }

   302

   303

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

   304

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

   305

        kfree(data_reg);

   306

        return -1;

   307

    }

   308

   309

    data_reg->slave = slave;

   310

    data_reg->sync = sync;

   311

    data_reg->sync_offset = offset;

   312

    data_reg->data_ptr = data_ptr;

   313

   314

    // estimate sync manager length

   315

    sync_length = offset + length;

   316

    if (sync->est_length < sync_length) {

   317

        sync->est_length = sync_length;

   318

        if (domain->master->debug_level) {

   319

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

   320

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

   321

        }

   322

    }

   323

   324

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

   325

   326

    ec_slave_request_state(slave, EC_SLAVE_STATE_OP);

   327

   328

    return 0;

   329

}

   330

   331

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

   332

   333

/**

   334

   Clears the list of the data registrations.

   335

*/

   336

   337

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

   338

{

   339

    ec_data_reg_t *data_reg, *next;

   340

   341

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

   342

        list_del(&data_reg->list);

   343

        kfree(data_reg);

   344

    }

   345

}

   346

   347

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

   348

   349

/**

   350

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

   351

   \return 0 in case of success, else < 0

   352

*/

   353

   354

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

   355

                           uint32_t offset, /**< logical offset */

   356

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

   357

                           )

   358

{

   359

    ec_datagram_t *datagram;

   360

   361

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

   362

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

   363

        return -1;

   364

    }

   365

   366

    ec_datagram_init(datagram);

   367

   368

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

   369

        kfree(datagram);

   370

        return -1;

   371

    }

   372

   373

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

   374

    return 0;

   375

}

   376

   377

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

   378

   379

/**

   380

   Creates a domain.

   381

   Reserves domain memory, calculates the logical addresses of the

   382

   corresponding FMMUs and sets the process data pointer of the registered

   383

   process data.

   384

   \return 0 in case of success, else < 0

   385

*/

   386

   387

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

   388

                    uint32_t base_address /**< logical base address */

   389

                    )

   390

{

   391

    ec_data_reg_t *data_reg;

   392

    ec_slave_t *slave;

   393

    ec_fmmu_t *fmmu;

   394

    unsigned int i, j, datagram_count;

   395

    uint32_t pdo_off, pdo_off_datagram;

   396

    uint32_t datagram_offset;

   397

    size_t datagram_data_size, sync_size;

   398

    ec_datagram_t *datagram;

   399

   400

    domain->base_address = base_address;

   401

   402

    // calculate size of process data and allocate memory

   403

    domain->data_size = 0;

   404

    datagram_offset = base_address;

   405

    datagram_data_size = 0;

   406

    datagram_count = 0;

   407

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

   408

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

   409

            fmmu = &slave->fmmus[j];

   410

            if (fmmu->domain == domain) {

   411

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

   412

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

   413

                domain->data_size += sync_size;

   414

                if (datagram_data_size + sync_size > EC_MAX_DATA_SIZE) {

   415

                    if (ec_domain_add_datagram(domain, datagram_offset,

   416

                                               datagram_data_size)) return -1;

   417

                    datagram_offset += datagram_data_size;

   418

                    datagram_data_size = 0;

   419

                    datagram_count++;

   420

                }

   421

                datagram_data_size += sync_size;

   422

            }

   423

        }

   424

    }

   425

   426

    // allocate last datagram

   427

    if (datagram_data_size) {

   428

        if (ec_domain_add_datagram(domain, datagram_offset,

   429

                                   datagram_data_size))

   430

            return -1;

   431

        datagram_count++;

   432

    }

   433

   434

    if (!datagram_count) {

   435

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

   436

        ec_domain_clear_data_regs(domain);

   437

        return 0;

   438

    }

   439

   440

    // set all process data pointers

   441

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

   442

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

   443

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

   444

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

   445

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

   446

                // search datagram

   447

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

   448

                    pdo_off_datagram = pdo_off - datagram->address.logical;

   449

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

   450

                        pdo_off_datagram < datagram->mem_size) {

   451

                        *data_reg->data_ptr = datagram->data +

   452

                            pdo_off_datagram;

   453

                    }

   454

                }

   455

                if (!data_reg->data_ptr) {

   456

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

   457

                    return -1;

   458

                }

   459

                break;

   460

            }

   461

        }

   462

    }

   463

   464

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

   465

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

   466

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

   467

   468

    ec_domain_clear_data_regs(domain);

   469

   470

    return 0;

   471

}

   472

   473

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

   474

   475

/**

   476

   Places all process data datagrams in the masters datagram queue.

   477

*/

   478

   479

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

   480

{

   481

    ec_datagram_t *datagram;

   482

   483

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

   484

        ec_master_queue_datagram(domain->master, datagram);

   485

    }

   486

}

   487

   488

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

   489