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

   108

    domain->notify_jiffies = 0;

   109

   110

    INIT_LIST_HEAD(&domain->datagrams);

   111

   112

    // init kobject and add it to the hierarchy

   113

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

   114

    kobject_init(&domain->kobj);

   115

    domain->kobj.ktype = &ktype_ec_domain;

   116

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

   117

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

   118

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

   119

        kobject_put(&domain->kobj);

   120

        return -1;

   121

    }

   122

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

   123

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

   124

        kobject_put(&domain->kobj);

   125

        return -1;

   126

    }

   127

   128

    return 0;

   129

}

   130

   131

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

   132

   133

/** Domain destructor.

   134

 *

   135

 * Clears and frees a domain object.

   136

 */

   137

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

   138

{

   139

    ec_datagram_t *datagram;

   140

   141

    // dequeue datagrams

   142

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

   143

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

   144

            list_del_init(&datagram->queue);

   145

    }

   146

   147

    // destroy self

   148

    kobject_del(&domain->kobj);

   149

    kobject_put(&domain->kobj);

   150

}

   151

   152

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

   153

   154

/** Clear and free domain.

   155

 *

   156

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

   157

 * to it.

   158

 */

   159

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

   160

{

   161

    ec_domain_t *domain;

   162

    ec_datagram_t *datagram, *next;

   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(domain);

   172

   173

    kfree(domain);

   174

}

   175

   176

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

   177

   178

/** Frees internally allocated memory.

   179

 */

   180

void ec_domain_clear_data(

   181

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

   182

        )

   183

{

   184

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

   185

        kfree(domain->data);

   186

    domain->data = NULL;

   187

    domain->data_origin = EC_ORIG_INTERNAL;

   188

}

   189

   190

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

   191

   192

/** Adds an FMMU configuration to the domain.

   193

 */

   194

void ec_domain_add_fmmu_config(

   195

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

   196

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

   197

        )

   198

{

   199

    fmmu->domain = domain;

   200

   201

    domain->data_size += fmmu->data_size;

   202

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

   203

}

   204

   205

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

   206

   207

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

   208

 *

   209

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

   210

 */

   211

int ec_domain_add_datagram(

   212

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

   213

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

   214

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

   215

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

   216

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

   217

        )

   218

{

   219

    ec_datagram_t *datagram;

   220

   221

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

   222

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

   223

        return -1;

   224

    }

   225

   226

    ec_datagram_init(datagram);

   227

    snprintf(datagram->name, EC_DATAGRAM_NAME_SIZE,

   228

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

   229

   230

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

   231

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

   232

            kfree(datagram);

   233

            return -1;

   234

        }

   235

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

   236

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

   237

            kfree(datagram);

   238

            return -1;

   239

        }

   240

    } else { // inputs only (or nothing)

   241

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

   242

            kfree(datagram);

   243

            return -1;

   244

        }

   245

    }

   246

   247

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

   248

    return 0;

   249

}

   250

   251

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

   252

   253

/** Finishes a domain.

   254

 *

   255

 * This allocates the necessary datagrams and writes the correct logical

   256

 * addresses to every configured FMMU.

   257

 *

   258

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

   259

 *

   260

 * \retval 0 in case of success

   261

 * \retval <0 on failure.

   262

 */

   263

int ec_domain_finish(

   264

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

   265

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

   266

        )

   267

{

   268

    uint32_t datagram_offset;

   269

    size_t datagram_size;

   270

    unsigned int datagram_count, i;

   271

    unsigned int datagram_used[2];

   272

    ec_slave_config_t *sc;

   273

    ec_fmmu_config_t *fmmu;

   274

    const ec_datagram_t *datagram;

   275

   276

    domain->logical_base_address = base_address;

   277

   278

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

   279

        if (!(domain->data =

   280

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

   281

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

   282

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

   283

            return -1;

   284

        }

   285

    }

   286

   287

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

   288

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

   289

    datagram_offset = 0;

   290

    datagram_size = 0;

   291

    datagram_count = 0;

   292

    datagram_used[EC_DIR_OUTPUT] = 0;

   293

    datagram_used[EC_DIR_INPUT] = 0;

   294

   295

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

   296

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

   297

            fmmu = &sc->fmmu_configs[i];

   298

            if (fmmu->domain != domain)

   299

                continue;

   300

   301

            // Correct logical FMMU address

   302

            fmmu->logical_start_address += base_address;

   303

   304

            // Increment Input/Output counter

   305

            datagram_used[fmmu->dir]++;

   306

   307

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

   308

            // allocate a new one.

   309

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

   310

                if (ec_domain_add_datagram(domain,

   311

                            domain->logical_base_address + datagram_offset,

   312

                            datagram_size, domain->data + datagram_offset,

   313

                            datagram_used))

   314

                    return -1;

   315

                datagram_offset += datagram_size;

   316

                datagram_size = 0;

   317

                datagram_count++;

   318

                datagram_used[EC_DIR_OUTPUT] = 0;

   319

                datagram_used[EC_DIR_INPUT] = 0;

   320

            }

   321

   322

            datagram_size += fmmu->data_size;

   323

        }

   324

    }

   325

   326

    // allocate last datagram, if data are left

   327

    if (datagram_size) {

   328

        if (ec_domain_add_datagram(domain,

   329

                    domain->logical_base_address + datagram_offset,

   330

                    datagram_size, domain->data + datagram_offset,

   331

                    datagram_used))

   332

            return -1;

   333

        datagram_count++;

   334

    }

   335

   336

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

   337

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

   338

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

   339

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

   340

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

   341

                datagram->data_size, ec_datagram_type_string(datagram));

   342

    }

   343

   344

    return 0;

   345

}

   346

   347

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

   348

   349

/**

   350

   Formats attribute data for SysFS reading.

   351

   \return number of bytes to read

   352

*/

   353

   354

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

   355

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

   356

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

   357

                                 )

   358

{

   359

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

   360

   361

    if (attr == &attr_image_size) {

   362

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

   363

    }

   364

   365

    return 0;

   366

}

   367

   368

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

   369

 *  Realtime interface

   370

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

   371

   372

int ecrt_domain_reg_pdo_entry_list(ec_domain_t *domain,

   373

        const ec_pdo_entry_reg_t *regs)

   374

{

   375

    const ec_pdo_entry_reg_t *reg;

   376

    ec_slave_config_t *sc;

   377

    int ret;

   378

   379

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

   380

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

   381

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

   382

            return -1;

   383

   384

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

   385

                        reg->subindex, domain)) < 0)

   386

            return -1;

   387

   388

        *reg->offset = ret;

   389

    }

   390

   391

    return 0;

   392

}

   393

   394

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

   395

   396

size_t ecrt_domain_size(ec_domain_t *domain)

   397

{

   398

    return domain->data_size;

   399

}

   400

   401

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

   402

   403

void ecrt_domain_external_memory(ec_domain_t *domain, uint8_t *mem)

   404

{

   405

    ec_domain_clear_data(domain);

   406

   407

    domain->data = mem;

   408

    domain->data_origin = EC_ORIG_EXTERNAL;

   409

}

   410

   411

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

   412

   413

uint8_t *ecrt_domain_data(ec_domain_t *domain)

   414

{

   415

    return domain->data;

   416

}

   417

   418

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

   419

   420

void ecrt_domain_process(ec_domain_t *domain)

   421

{

   422

    unsigned int working_counter_sum;

   423

    ec_datagram_t *datagram;

   424

   425

    working_counter_sum = 0;

   426

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

   427

        ec_datagram_output_stats(datagram);

   428

        if (datagram->state == EC_DATAGRAM_RECEIVED) {

   429

            working_counter_sum += datagram->working_counter;

   430

        }

   431

    }

   432

   433

    if (working_counter_sum != domain->working_counter) {

   434

        domain->working_counter_changes++;

   435

        domain->working_counter = working_counter_sum;

   436

    }

   437

   438

    if (domain->working_counter_changes &&

   439

        jiffies - domain->notify_jiffies > HZ) {

   440

        domain->notify_jiffies = jiffies;

   441

        if (domain->working_counter_changes == 1) {

   442

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

   443

                    domain->working_counter);

   444

        }

   445

        else {

   446

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

   447

                    domain->index, domain->working_counter_changes,

   448

                    domain->working_counter);

   449

        }

   450

        domain->working_counter_changes = 0;

   451

    }

   452

}

   453

   454

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

   455

   456

void ecrt_domain_queue(ec_domain_t *domain)

   457

{

   458

    ec_datagram_t *datagram;

   459

   460

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

   461

        ec_master_queue_datagram(domain->master, datagram);

   462

    }

   463

}

   464

   465

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

   466

   467

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

   468

{

   469

    state->working_counter = domain->working_counter;

   470

   471

    if (domain->working_counter) {

   472

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

   473

            state->wc_state = EC_WC_COMPLETE;

   474

        } else {

   475

            state->wc_state = EC_WC_INCOMPLETE;

   476

        }

   477

    } else {

   478

        state->wc_state = EC_WC_ZERO;

   479

    }

   480

}

   481

   482

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

   483

   484

/** \cond */

   485

   486

EXPORT_SYMBOL(ecrt_domain_reg_pdo_entry_list);

   487

EXPORT_SYMBOL(ecrt_domain_size);