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 = 0;

   103

    domain->data = NULL;

   104

    domain->data_origin = EC_ORIG_INTERNAL;

   105

    domain->logical_base_address = 0L;

   106

    domain->working_counter = 0xFFFFFFFF;

   107

    domain->state = 0;

   108

    domain->working_counter_changes = 0;

   109

    domain->notify_jiffies = 0;

   110

   111

    INIT_LIST_HEAD(&domain->datagrams);

   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

    fmmu->domain = domain;

   201

   202

    domain->data_size += fmmu->data_size;

   203

    domain->expected_working_counter += working_counter_increment[fmmu->dir];

   204

}

   205

   206

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

   207

   208

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

   209

 *

   210

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

   211

 */

   212

int ec_domain_add_datagram(

   213

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

   214

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

   215

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

   216

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

   217

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

   218

        )

   219

{

   220

    ec_datagram_t *datagram;

   221

   222

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

   223

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

   224

        return -1;

   225

    }

   226

   227

    ec_datagram_init(datagram);

   228

    snprintf(datagram->name, EC_DATAGRAM_NAME_SIZE,

   229

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

   230

   231

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

   232

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

   233

            kfree(datagram);

   234

            return -1;

   235

        }

   236

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

   237

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

   238

            kfree(datagram);

   239

            return -1;

   240

        }

   241

    } else { // inputs only (or nothing)

   242

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

   243

            kfree(datagram);

   244

            return -1;

   245

        }

   246

    }

   247

   248

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

   249

    return 0;

   250

}

   251

   252

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

   253

   254

/** Finishes a domain.

   255

 *

   256

 * This allocates the necessary datagrams and writes the correct logical

   257

 * addresses to every configured FMMU.

   258

 *

   259

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

   260

 *

   261

 * \retval 0 in case of success

   262

 * \retval <0 on failure.

   263

 */

   264

int ec_domain_finish(

   265

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

   266

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

   267

        )

   268

{

   269

    uint32_t datagram_offset;

   270

    size_t datagram_size;

   271

    unsigned int datagram_count, i;

   272

    unsigned int datagram_used[2];

   273

    ec_slave_config_t *sc;

   274

    ec_fmmu_config_t *fmmu;

   275

    const ec_datagram_t *datagram;

   276

   277

    domain->logical_base_address = base_address;

   278

   279

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

   280

        if (!(domain->data =

   281

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

   282

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

   283

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

   284

            return -1;

   285

        }

   286

    }

   287

   288

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

   289

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

   290

    datagram_offset = 0;

   291

    datagram_size = 0;

   292

    datagram_count = 0;

   293

    datagram_used[EC_DIR_OUTPUT] = 0;

   294

    datagram_used[EC_DIR_INPUT] = 0;

   295

   296

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

   297

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

   298

            fmmu = &sc->fmmu_configs[i];

   299

            if (fmmu->domain != domain)

   300

                continue;

   301

   302

            // Correct logical FMMU address

   303

            fmmu->logical_start_address += base_address;

   304

   305

            // Increment Input/Output counter

   306

            datagram_used[fmmu->dir]++;

   307

   308

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

   309

            // allocate a new one.

   310

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

   311

                if (ec_domain_add_datagram(domain,

   312

                            domain->logical_base_address + datagram_offset,

   313

                            datagram_size, domain->data + datagram_offset,

   314

                            datagram_used))

   315

                    return -1;

   316

                datagram_offset += datagram_size;

   317

                datagram_size = 0;

   318

                datagram_count++;

   319

                datagram_used[EC_DIR_OUTPUT] = 0;

   320

                datagram_used[EC_DIR_INPUT] = 0;

   321

            }

   322

   323

            datagram_size += fmmu->data_size;

   324

        }

   325

    }

   326

   327

    // allocate last datagram, if data are left

   328

    if (datagram_size) {

   329

        if (ec_domain_add_datagram(domain,

   330

                    domain->logical_base_address + datagram_offset,

   331

                    datagram_size, domain->data + datagram_offset,

   332

                    datagram_used))

   333

            return -1;

   334

        datagram_count++;

   335

    }

   336

   337

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

   338

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

   339

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

   340

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

   341

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

   342

                datagram->data_size, ec_datagram_type_string(datagram));

   343

    }

   344

   345

    return 0;

   346

}

   347

   348

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

   349

   350

/**

   351

   Formats attribute data for SysFS reading.

   352

   \return number of bytes to read

   353

*/

   354

   355

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

   356

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

   357

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

   358

                                 )

   359

{

   360

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

   361

   362

    if (attr == &attr_image_size) {

   363

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

   364

    }

   365

   366

    return 0;

   367

}

   368

   369

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

   370

 *  Realtime interface

   371

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

   372

   373

int ecrt_domain_reg_pdo_entry_list(ec_domain_t *domain,

   374

        const ec_pdo_entry_reg_t *regs)

   375

{

   376

    const ec_pdo_entry_reg_t *reg;

   377

    ec_slave_config_t *sc;

   378

    int ret;

   379

   380

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

   381

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

   382

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

   383

            return -1;

   384

   385

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

   386

                        reg->subindex, domain)) < 0)

   387

            return -1;

   388

   389

        *reg->offset = ret;

   390

    }

   391

   392

    return 0;

   393

}

   394

   395

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

   396

   397

size_t ecrt_domain_size(ec_domain_t *domain)

   398

{

   399

    return domain->data_size;

   400

}

   401

   402

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

   403

   404

void ecrt_domain_external_memory(ec_domain_t *domain, uint8_t *mem)

   405

{

   406

    ec_domain_clear_data(domain);

   407

   408

    domain->data = mem;

   409

    domain->data_origin = EC_ORIG_EXTERNAL;

   410

}

   411

   412

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

   413

   414

uint8_t *ecrt_domain_data(ec_domain_t *domain)

   415

{

   416

    return domain->data;

   417

}

   418

   419

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

   420

   421

void ecrt_domain_process(ec_domain_t *domain)

   422

{

   423

    unsigned int working_counter_sum;

   424

    ec_datagram_t *datagram;

   425

   426

    working_counter_sum = 0;

   427

    domain->state = 0;

   428

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

   429

        ec_datagram_output_stats(datagram);

   430

        if (datagram->state == EC_DATAGRAM_RECEIVED) {

   431

            working_counter_sum += datagram->working_counter;

   432

        }

   433

        else {

   434

            domain->state = -1;

   435

        }

   436

    }

   437

   438

    if (working_counter_sum != domain->working_counter) {

   439

        domain->working_counter_changes++;

   440

        domain->working_counter = working_counter_sum;

   441

    }

   442

   443

    if (domain->working_counter_changes &&

   444

        jiffies - domain->notify_jiffies > HZ) {

   445

        domain->notify_jiffies = jiffies;

   446

        if (domain->working_counter_changes == 1) {

   447

            EC_INFO("Domain %u working counter change: %u\n", domain->index,

   448

                    domain->working_counter);

   449

        }

   450

        else {

   451

            EC_INFO("Domain %u: %u working counter changes. Currently %u\n",

   452

                    domain->index, domain->working_counter_changes,

   453

                    domain->working_counter);

   454

        }

   455

        domain->working_counter_changes = 0;

   456

    }

   457

}

   458

   459

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

   460

   461

void ecrt_domain_queue(ec_domain_t *domain)

   462

{

   463

    ec_datagram_t *datagram;

   464

   465

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

   466

        ec_master_queue_datagram(domain->master, datagram);

   467

    }

   468

}

   469

   470

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

   471

   472

void ecrt_domain_state(const ec_domain_t *domain, ec_domain_state_t *state)

   473

{

   474

    state->working_counter = domain->working_counter;

   475

   476

    if (domain->working_counter) {

   477

        if (domain->working_counter == domain->expected_working_counter) {

   478

            state->wc_state = EC_WC_COMPLETE;

   479

        } else {

   480

            state->wc_state = EC_WC_INCOMPLETE;

   481

        }

   482

    } else {

   483

        state->wc_state = EC_WC_ZERO;

   484

    }

   485

}

   486

   487

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