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 "master.h"

    45

#include "slave_config.h"

    46

    47

#include "domain.h"

    48

    49

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

    50

    51

void ec_domain_clear(struct kobject *);

    52

void ec_domain_clear_data(ec_domain_t *);

    53

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

    54

    55

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

    56

    57

/** Working counter increment values for logical read/write operations.

    58

 *

    59

 * \attention This is indexed by ec_direction_t.

    60

 */

    61

static const unsigned int working_counter_increment[] = {2, 1};

    62

    63

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

    64

    65

/** \cond */

    66

    67

EC_SYSFS_READ_ATTR(image_size);

    68

    69

static struct attribute *def_attrs[] = {

    70

    &attr_image_size,

    71

    NULL,

    72

};

    73

    74

static struct sysfs_ops sysfs_ops = {

    75

    .show = &ec_show_domain_attribute,

    76

    .store = NULL

    77

};

    78

    79

static struct kobj_type ktype_ec_domain = {

    80

    .release = ec_domain_clear,

    81

    .sysfs_ops = &sysfs_ops,

    82

    .default_attrs = def_attrs

    83

};

    84

    85

/** \endcond */

    86

    87

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

    88

    89

/** Domain constructor.

    90

 *

    91

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

    92

 */

    93

int ec_domain_init(

    94

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

    95

        ec_master_t *master, /**< Parent master. */

    96

        unsigned int index /**< Index. */

    97

        )

    98

{

    99

    domain->master = master;

   100

    domain->index = index;

   101

    domain->data_size = 0;

   102

    domain->expected_working_counter = 0x0000;

   103

    domain->data = NULL;

   104

    domain->data_origin = EC_ORIG_INTERNAL;

   105

    domain->logical_base_address = 0L;

   106

    domain->working_counter = 0xFFFF;

   107

    domain->working_counter_changes = 0;

   108

    domain->notify_jiffies = 0;

   109

   110

    INIT_LIST_HEAD(&domain->datagrams);

   111

    INIT_LIST_HEAD(&domain->fmmu_configs);

   112

   113

    // init kobject and add it to the hierarchy

   114

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

   115

    kobject_init(&domain->kobj);

   116

    domain->kobj.ktype = &ktype_ec_domain;

   117

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

   118

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

   119

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

   120

        kobject_put(&domain->kobj);

   121

        return -1;

   122

    }

   123

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

   124

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

   125

        kobject_put(&domain->kobj);

   126

        return -1;

   127

    }

   128

   129

    return 0;

   130

}

   131

   132

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

   133

   134

/** Domain destructor.

   135

 *

   136

 * Clears and frees a domain object.

   137

 */

   138

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

   139

{

   140

    ec_datagram_t *datagram;

   141

   142

    // dequeue datagrams

   143

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

   144

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

   145

            list_del_init(&datagram->queue);

   146

    }

   147

   148

    // destroy self

   149

    kobject_del(&domain->kobj);

   150

    kobject_put(&domain->kobj);

   151

}

   152

   153

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

   154

   155

/** Clear and free domain.

   156

 *

   157

 * This method is called by the kobject, once there are no more references

   158

 * to it.

   159

 */

   160

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

   161

{

   162

    ec_domain_t *domain;

   163

    ec_datagram_t *datagram, *next;

   164

   165

    domain = container_of(kobj, ec_domain_t, kobj);

   166

   167

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

   168

        ec_datagram_clear(datagram);

   169

        kfree(datagram);

   170

    }

   171

   172

    ec_domain_clear_data(domain);

   173

   174

    kfree(domain);

   175

}

   176

   177

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

   178

   179

/** Frees internally allocated memory.

   180

 */

   181

void ec_domain_clear_data(

   182

        ec_domain_t *domain /**< EtherCAT domain. */

   183

        )

   184

{

   185

    if (domain->data_origin == EC_ORIG_INTERNAL && domain->data)

   186

        kfree(domain->data);

   187

    domain->data = NULL;

   188

    domain->data_origin = EC_ORIG_INTERNAL;

   189

}

   190

   191

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

   192

   193

/** Adds an FMMU configuration to the domain.

   194

 */

   195

void ec_domain_add_fmmu_config(

   196

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

   197

        ec_fmmu_config_t *fmmu /**< FMMU configuration. */

   198

        )

   199

{

   200

    unsigned int wc_increment;

   201

    fmmu->domain = domain;

   202

   203

    domain->data_size += fmmu->data_size;

   204

    wc_increment = working_counter_increment[fmmu->dir];

   205

    domain->expected_working_counter += wc_increment;

   206

   207

    list_add_tail(&fmmu->list, &domain->fmmu_configs);

   208

   209

    if (domain->master->debug_level)

   210

        EC_DBG("Domain %u: Added %u bytes (now %u) with dir %u -> WC %u"

   211

                " (now %u).\n", domain->index, fmmu->data_size,

   212

                domain->data_size, fmmu->dir, wc_increment,

   213

                domain->expected_working_counter);

   214

}

   215

   216

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

   217

   218

/** Allocates a domain datagram and appends it to the list.

   219

 *

   220

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

   221

 */

   222

int ec_domain_add_datagram(

   223

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

   224

        uint32_t logical_offset, /**< Logical offset. */

   225

        size_t data_size, /**< Size of the data. */

   226

        uint8_t *data, /**< Process data. */

   227

        const unsigned int used[] /**< Used by inputs/outputs. */

   228

        )

   229

{

   230

    ec_datagram_t *datagram;

   231

   232

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

   233

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

   234

        return -1;

   235

    }

   236

   237

    ec_datagram_init(datagram);

   238

    snprintf(datagram->name, EC_DATAGRAM_NAME_SIZE,

   239

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

   240

   241

    if (used[EC_DIR_OUTPUT] && used[EC_DIR_INPUT]) { // inputs and outputs

   242

        if (ec_datagram_lrw(datagram, logical_offset, data_size, data)) {

   243

            kfree(datagram);

   244

            return -1;

   245

        }

   246

    } else if (used[EC_DIR_OUTPUT]) { // outputs only

   247

        if (ec_datagram_lwr(datagram, logical_offset, data_size, data)) {

   248

            kfree(datagram);

   249

            return -1;

   250

        }

   251

    } else { // inputs only (or nothing)

   252

        if (ec_datagram_lrd(datagram, logical_offset, data_size, data)) {

   253

            kfree(datagram);

   254

            return -1;

   255

        }

   256

    }

   257

   258

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

   259

    return 0;

   260

}

   261

   262

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

   263

   264

/** Finishes a domain.

   265

 *

   266

 * This allocates the necessary datagrams and writes the correct logical

   267

 * addresses to every configured FMMU.

   268

 *

   269

 * \todo Check for FMMUs that do not fit into any datagram.

   270

 *

   271

 * \retval 0 in case of success

   272

 * \retval <0 on failure.

   273

 */

   274

int ec_domain_finish(

   275

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

   276

        uint32_t base_address /**< Logical base address. */

   277

        )

   278

{

   279

    uint32_t datagram_offset;

   280

    size_t datagram_size;

   281

    unsigned int datagram_count, i;

   282

    unsigned int datagram_used[2];

   283

    ec_slave_config_t *sc;

   284

    ec_fmmu_config_t *fmmu;

   285

    const ec_datagram_t *datagram;

   286

   287

    domain->logical_base_address = base_address;

   288

   289

    if (domain->data_size && domain->data_origin == EC_ORIG_INTERNAL) {

   290

        if (!(domain->data =

   291

                    (uint8_t *) kmalloc(domain->data_size, GFP_KERNEL))) {

   292

            EC_ERR("Failed to allocate %u bytes internal memory for"

   293

                    " domain %u!\n", domain->data_size, domain->index);

   294

            return -1;

   295

        }

   296

    }

   297

   298

    // Cycle through all domain FMMUS, correct the logical base addresses and

   299

    // set up the datagrams to carry the process data.

   300

    datagram_offset = 0;

   301

    datagram_size = 0;

   302

    datagram_count = 0;

   303

    datagram_used[EC_DIR_OUTPUT] = 0;

   304

    datagram_used[EC_DIR_INPUT] = 0;

   305

   306

    list_for_each_entry(sc, &domain->master->configs, list) {

   307

        for (i = 0; i < sc->used_fmmus; i++) {

   308

            fmmu = &sc->fmmu_configs[i];

   309

            if (fmmu->domain != domain)

   310

                continue;

   311

   312

            // Correct logical FMMU address

   313

            fmmu->logical_start_address += base_address;

   314

   315

            // Increment Input/Output counter

   316

            datagram_used[fmmu->dir]++;

   317

   318

            // If the current FMMU's data do not fit in the current datagram,

   319

            // allocate a new one.

   320

            if (datagram_size + fmmu->data_size > EC_MAX_DATA_SIZE) {

   321

                if (ec_domain_add_datagram(domain,

   322

                            domain->logical_base_address + datagram_offset,

   323

                            datagram_size, domain->data + datagram_offset,

   324

                            datagram_used))

   325

                    return -1;

   326

                datagram_offset += datagram_size;

   327

                datagram_size = 0;

   328

                datagram_count++;

   329

                datagram_used[EC_DIR_OUTPUT] = 0;

   330

                datagram_used[EC_DIR_INPUT] = 0;

   331

            }

   332

   333

            datagram_size += fmmu->data_size;

   334

        }

   335

    }

   336

   337

    // allocate last datagram, if data are left

   338

    if (datagram_size) {

   339

        if (ec_domain_add_datagram(domain,

   340

                    domain->logical_base_address + datagram_offset,

   341

                    datagram_size, domain->data + datagram_offset,

   342

                    datagram_used))

   343

            return -1;

   344

        datagram_count++;

   345

    }

   346

   347

    EC_INFO("Domain %u with logical offset %u contains %u bytes.\n",

   348

            domain->index, domain->logical_base_address, domain->data_size);

   349

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

   350

        EC_INFO("  Datagram %s, logical offset %u, size %u, type %s.\n",

   351

                datagram->name, EC_READ_U32(datagram->address),

   352

                datagram->data_size, ec_datagram_type_string(datagram));

   353

    }

   354

   355

    return 0;

   356

}

   357

   358

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

   359

   360

/**

   361

   Formats attribute data for SysFS reading.

   362

   \return number of bytes to read

   363

*/

   364

   365

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

   366

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

   367

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

   368

                                 )

   369

{

   370

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

   371

   372

    if (attr == &attr_image_size) {

   373

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

   374

    }

   375

   376

    return 0;

   377

}

   378

   379

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

   380

   381

unsigned int ec_domain_fmmu_count(const ec_domain_t *domain)

   382

{

   383

    const ec_fmmu_config_t *fmmu;

   384

    unsigned int num = 0;

   385

   386

    list_for_each_entry(fmmu, &domain->fmmu_configs, list) {

   387

        num++;

   388

    }

   389

   390

    return num;

   391

}

   392

   393

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

   394

   395

const ec_fmmu_config_t *ec_domain_find_fmmu(

   396

        const ec_domain_t *domain,

   397

        unsigned int index

   398

        )

   399

{

   400

    const ec_fmmu_config_t *fmmu;

   401

   402

    list_for_each_entry(fmmu, &domain->fmmu_configs, list) {

   403

        if (index--)

   404

            continue;

   405

        return fmmu;

   406

    }

   407

   408

    return NULL;

   409

}

   410

   411

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

   412

 *  Realtime interface

   413

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

   414

   415

int ecrt_domain_reg_pdo_entry_list(ec_domain_t *domain,

   416

        const ec_pdo_entry_reg_t *regs)

   417

{

   418

    const ec_pdo_entry_reg_t *reg;

   419

    ec_slave_config_t *sc;

   420

    int ret;

   421

   422

    for (reg = regs; reg->index; reg++) {

   423

        if (!(sc = ecrt_master_slave_config(domain->master, reg->alias,

   424

                        reg->position, reg->vendor_id, reg->product_code)))

   425

            return -1;

   426

   427

        if ((ret = ecrt_slave_config_reg_pdo_entry(sc, reg->index,

   428

                        reg->subindex, domain, reg->bit_position)) < 0)

   429

            return -1;

   430

   431

        *reg->offset = ret;

   432

    }

   433

   434

    return 0;

   435

}

   436

   437

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

   438

   439

size_t ecrt_domain_size(ec_domain_t *domain)

   440

{

   441

    return domain->data_size;

   442

}

   443

   444

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

   445

   446

void ecrt_domain_external_memory(ec_domain_t *domain, uint8_t *mem)

   447

{

   448

    ec_domain_clear_data(domain);

   449

   450

    domain->data = mem;

   451

    domain->data_origin = EC_ORIG_EXTERNAL;

   452

}

   453

   454

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

   455

   456

uint8_t *ecrt_domain_data(ec_domain_t *domain)

   457

{

   458

    return domain->data;

   459

}

   460

   461

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

   462

   463

void ecrt_domain_process(ec_domain_t *domain)

   464

{

   465

    unsigned int working_counter_sum;

   466

    ec_datagram_t *datagram;

   467

   468

    working_counter_sum = 0;

   469

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

   470

        ec_datagram_output_stats(datagram);

   471

        if (datagram->state == EC_DATAGRAM_RECEIVED) {

   472

            working_counter_sum += datagram->working_counter;

   473

        }

   474

    }

   475

   476

    if (working_counter_sum != domain->working_counter) {

   477

        domain->working_counter_changes++;

   478

        domain->working_counter = working_counter_sum;

   479

    }

   480

   481

    if (domain->working_counter_changes &&

   482

        jiffies - domain->notify_jiffies > HZ) {

   483

        domain->notify_jiffies = jiffies;

   484

        if (domain->working_counter_changes == 1) {

   485

            EC_INFO("Domain %u: Working counter changed to %u/%u.\n",

   486

                    domain->index, domain->working_counter,

   487

                    domain->expected_working_counter);

   488