1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006-2008  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 and/or

    10

 *  modify it under the terms of the GNU General Public License version 2, as

    11

 *  published by the Free Software Foundation.

    12

 *

    13

 *  The IgH EtherCAT Master is distributed in the hope that it will be useful,

    14

 *  but WITHOUT ANY WARRANTY; without even the implied warranty of

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General

    16

 *  Public License for more details.

    17

 *

    18

 *  You should have received a copy of the GNU General Public License along

    19

 *  with the IgH EtherCAT Master; if not, write to the Free Software

    20

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    21

 *

    22

 *  ---

    23

 *

    24

 *  The license mentioned above concerns the source code only. Using the

    25

 *  EtherCAT technology and brand is only permitted in compliance with the

    26

 *  industrial property and similar rights of Beckhoff Automation GmbH.

    27

 *

    28

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

    29

    30

/**

    31

   \file

    32

   EtherCAT domain methods.

    33

*/

    34

    35

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

    36

    37

#include <linux/module.h>

    38

    39

#include "globals.h"

    40

#include "master.h"

    41

#include "slave_config.h"

    42

    43

#include "domain.h"

    44

    45

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

    46

    47

void ec_domain_clear_data(ec_domain_t *);

    48

    49

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

    50

    51

/** Domain constructor.

    52

 */

    53

void ec_domain_init(

    54

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

    55

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

    56

        unsigned int index /**< Index. */

    57

        )

    58

{

    59

    domain->master = master;

    60

    domain->index = index;

    61

    INIT_LIST_HEAD(&domain->fmmu_configs);

    62

    domain->data_size = 0;

    63

    domain->data = NULL;

    64

    domain->data_origin = EC_ORIG_INTERNAL;

    65

    domain->logical_base_address = 0x00000000;

    66

    INIT_LIST_HEAD(&domain->datagrams);

    67

    domain->working_counter = 0x0000;

    68

    domain->expected_working_counter = 0x0000;

    69

    domain->working_counter_changes = 0;

    70

    domain->notify_jiffies = 0;

    71

}

    72

    73

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

    74

    75

/** Domain destructor.

    76

 */

    77

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

    78

{

    79

    ec_datagram_t *datagram, *next;

    80

    81

    // dequeue and free datagrams

    82

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

    83

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

    84

            list_del(&datagram->queue);

    85

        ec_datagram_clear(datagram);

    86

        kfree(datagram);

    87

    }

    88

    89

    ec_domain_clear_data(domain);

    90

}

    91

    92

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

    93

    94

/** Frees internally allocated memory.

    95

 */

    96

void ec_domain_clear_data(

    97

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

    98

        )

    99

{

   100

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

   101

        kfree(domain->data);

   102

    domain->data = NULL;

   103

    domain->data_origin = EC_ORIG_INTERNAL;

   104

}

   105

   106

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

   107

   108

/** Adds an FMMU configuration to the domain.

   109

 */

   110

void ec_domain_add_fmmu_config(

   111

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

   112

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

   113

        )

   114

{

   115

    fmmu->domain = domain;

   116

   117

    domain->data_size += fmmu->data_size;

   118

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

   119

   120

    if (domain->master->debug_level)

   121

        EC_DBG("Domain %u: Added %u bytes, total %zu.\n", domain->index,

   122

                fmmu->data_size, domain->data_size);

   123

}

   124

   125

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

   126

   127

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

   128

 *

   129

 * The datagram type and expected working counters are determined by the

   130

 * number of input and output fmmus that share the datagram.

   131

 *

   132

 * \retval  0 Success.

   133

 * \retval <0 Error code.

   134

 */

   135

int ec_domain_add_datagram(

   136

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

   137

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

   138

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

   139

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

   140

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

   141

        )

   142

{

   143

    ec_datagram_t *datagram;

   144

    int ret;

   145

   146

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

   147

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

   148

        return -ENOMEM;

   149

    }

   150

   151

    ec_datagram_init(datagram);

   152

    snprintf(datagram->name, EC_DATAGRAM_NAME_SIZE,

   153

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

   154

   155

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

   156

        ret = ec_datagram_lrw(datagram, logical_offset, data_size, data);

   157

        if (ret < 0) {

   158

            kfree(datagram);

   159

            return ret;

   160

        }

   161

        // If LRW is used, output FMMUs increment the working counter by 2,

   162

        // while input FMMUs increment it by 1.

   163

        domain->expected_working_counter +=

   164

            used[EC_DIR_OUTPUT] * 2 + used[EC_DIR_INPUT];

   165

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

   166

        ret = ec_datagram_lwr(datagram, logical_offset, data_size, data);

   167

        if (ret < 0) {

   168

            kfree(datagram);

   169

            return ret;

   170

        }

   171

        domain->expected_working_counter += used[EC_DIR_OUTPUT];

   172

    } else { // inputs only (or nothing)

   173

        ret = ec_datagram_lrd(datagram, logical_offset, data_size, data);

   174

        if (ret < 0) {

   175

            kfree(datagram);

   176

            return ret;

   177

        }

   178

        domain->expected_working_counter += used[EC_DIR_INPUT];

   179

    }

   180

   181

    ec_datagram_zero(datagram);

   182

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

   183

    return 0;

   184

}

   185

   186

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

   187

   188

/** Finishes a domain.

   189

 *

   190

 * This allocates the necessary datagrams and writes the correct logical

   191

 * addresses to every configured FMMU.

   192

 *

   193

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

   194

 *

   195

 * \retval  0 Success

   196

 * \retval <0 Error code.

   197

 */

   198

int ec_domain_finish(

   199

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

   200

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

   201

        )

   202

{

   203

    uint32_t datagram_offset;

   204

    size_t datagram_size;

   205

    unsigned int datagram_count;

   206

    unsigned int datagram_used[EC_DIR_COUNT];

   207

    ec_fmmu_config_t *fmmu;

   208

    const ec_datagram_t *datagram;

   209

    int ret;

   210

   211

    domain->logical_base_address = base_address;

   212

   213

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

   214

        if (!(domain->data =

   215

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

   216

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

   217

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

   218

            return -ENOMEM;

   219

        }

   220

    }

   221

   222

    // Cycle through all domain FMMUS and

   223

    // - correct the logical base addresses

   224

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

   225

    datagram_offset = 0;

   226

    datagram_size = 0;

   227

    datagram_count = 0;

   228

    datagram_used[EC_DIR_OUTPUT] = 0;

   229

    datagram_used[EC_DIR_INPUT] = 0;

   230

   231

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

   232

        // Correct logical FMMU address

   233

        fmmu->logical_start_address += base_address;

   234

   235

        // Increment Input/Output counter to determine datagram types

   236

        // and calculate expected working counters

   237

        datagram_used[fmmu->dir]++;

   238

   239

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

   240

        // allocate a new one.

   241

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

   242

            ret = ec_domain_add_datagram(domain,

   243

                    domain->logical_base_address + datagram_offset,

   244

                    datagram_size, domain->data + datagram_offset,

   245

                    datagram_used);

   246

            if (ret < 0)

   247

                return ret;

   248

            datagram_offset += datagram_size;

   249

            datagram_size = 0;

   250

            datagram_count++;

   251

            datagram_used[EC_DIR_OUTPUT] = 0;

   252

            datagram_used[EC_DIR_INPUT] = 0;

   253

        }

   254

   255

        datagram_size += fmmu->data_size;

   256

    }

   257

   258

    // Allocate last datagram, if data are left (this is also the case if the

   259

    // process data fit into a single datagram)

   260

    if (datagram_size) {

   261

        ret = ec_domain_add_datagram(domain,

   262

                domain->logical_base_address + datagram_offset,

   263

                datagram_size, domain->data + datagram_offset,

   264

                datagram_used);

   265

        if (ret < 0)

   266

            return ret;

   267

        datagram_count++;

   268

    }

   269

   270

    EC_INFO("Domain%u: Logical address 0x%08x, %zu byte, "

   271

            "expected working counter %u.\n", domain->index,

   272

            domain->logical_base_address, domain->data_size,

   273

            domain->expected_working_counter);

   274

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

   275

        EC_INFO("  Datagram %s: Logical offset 0x%08x, %zu byte, type %s.\n",

   276

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

   277

                datagram->data_size, ec_datagram_type_string(datagram));

   278

    }

   279

   280

    return 0;

   281

}

   282

   283

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

   284

   285

/** Get the number of FMMU configurations of the domain.

   286

 */

   287

unsigned int ec_domain_fmmu_count(const ec_domain_t *domain)

   288

{

   289

    const ec_fmmu_config_t *fmmu;

   290

    unsigned int num = 0;

   291

   292

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

   293

        num++;

   294

    }

   295

   296

    return num;

   297

}

   298

   299

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

   300

   301

/** Get a certain FMMU configuration via its position in the list.

   302

 */

   303

const ec_fmmu_config_t *ec_domain_find_fmmu(

   304

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

   305

        unsigned int pos /**< List position. */

   306

        )

   307

{

   308

    const ec_fmmu_config_t *fmmu;

   309

   310

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

   311

        if (pos--)

   312

            continue;

   313

        return fmmu;

   314

    }

   315

   316

    return NULL;

   317

}

   318

   319

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

   320

 *  Realtime interface

   321

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

   322

   323

int ecrt_domain_reg_pdo_entry_list(ec_domain_t *domain,

   324

        const ec_pdo_entry_reg_t *regs)

   325

{

   326

    const ec_pdo_entry_reg_t *reg;

   327

    ec_slave_config_t *sc;

   328

    int ret;

   329

   330

    if (domain->master->debug_level)

   331

        EC_DBG("ecrt_domain_reg_pdo_entry_list(domain = 0x%p, regs = 0x%p)\n",

   332

                domain, regs);

   333

   334

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

   335

        sc = ecrt_master_slave_config_err(domain->master, reg->alias,

   336

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

   337

        if (IS_ERR(sc))

   338

            return PTR_ERR(sc);

   339

   340

        ret = ecrt_slave_config_reg_pdo_entry(sc, reg->index,

   341

                        reg->subindex, domain, reg->bit_position);

   342

        if (ret < 0)

   343

            return ret;

   344

   345

        *reg->offset = ret;

   346

    }

   347

   348

    return 0;

   349

}

   350

   351

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

   352

   353

size_t ecrt_domain_size(const ec_domain_t *domain)

   354

{

   355

    return domain->data_size;

   356

}

   357

   358

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

   359

   360

void ecrt_domain_external_memory(ec_domain_t *domain, uint8_t *mem)

   361

{

   362

    if (domain->master->debug_level)

   363

        EC_DBG("ecrt_domain_external_memory(domain = 0x%p, mem = 0x%p)\n",

   364

                domain, mem);

   365

   366

    down(&domain->master->master_sem);

   367

   368

    ec_domain_clear_data(domain);

   369

   370

    domain->data = mem;

   371

    domain->data_origin = EC_ORIG_EXTERNAL;

   372

   373

    up(&domain->master->master_sem);

   374

}

   375

   376

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

   377

   378

uint8_t *ecrt_domain_data(ec_domain_t *domain)

   379

{

   380

    return domain->data;

   381

}

   382

   383

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

   384

   385

void ecrt_domain_process(ec_domain_t *domain)

   386

{

   387

    uint16_t working_counter_sum;

   388

    ec_datagram_t *datagram;

   389

   390

    working_counter_sum = 0x0000;

   391

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

   392

        ec_datagram_output_stats(datagram);

   393

        if (datagram->state == EC_DATAGRAM_RECEIVED) {

   394

            working_counter_sum += datagram->working_counter;

   395

        }

   396

    }

   397

   398

    if (working_counter_sum != domain->working_counter) {

   399

        domain->working_counter_changes++;

   400

        domain->working_counter = working_counter_sum;

   401

    }

   402

   403

    if (domain->working_counter_changes &&

   404

        jiffies - domain->notify_jiffies > HZ) {

   405

        domain->notify_jiffies = jiffies;

   406

        if (domain->working_counter_changes == 1) {

   407

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

   408

                    domain->index, domain->working_counter,

   409

                    domain->expected_working_counter);

   410

        } else {

   411

            EC_INFO("Domain %u: %u working counter changes - now %u/%u.\n",

   412

                    domain->index, domain->working_counter_changes,

   413

                    domain->working_counter, domain->expected_working_counter);

   414

        }

   415

        domain->working_counter_changes = 0;

   416

    }

   417

}

   418

   419

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

   420

   421

void ecrt_domain_queue(ec_domain_t *domain)

   422

{

   423

    ec_datagram_t *datagram;

   424

   425

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

   426

        ec_master_queue_datagram(domain->master, datagram);

   427

    }

   428

}

   429

   430

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

   431

   432

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

   433

{

   434

    state->working_counter = domain->working_counter;

   435

   436

    if (domain->working_counter) {

   437

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

   438

            state->wc_state = EC_WC_COMPLETE;

   439

        } else {

   440

            state->wc_state = EC_WC_INCOMPLETE;

   441

        }

   442

    } else {

   443

        state->wc_state = EC_WC_ZERO;

   444

    }

   445

}

   446

   447

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

   448

   449

/** \cond */

   450

   451

EXPORT_SYMBOL(ecrt_domain_reg_pdo_entry_list);

   452

EXPORT_SYMBOL(ecrt_domain_size);

   453

EXPORT_SYMBOL(ecrt_domain_external_memory);

   454

EXPORT_SYMBOL(ecrt_domain_data);

   455

EXPORT_SYMBOL(ecrt_domain_process);

   456

EXPORT_SYMBOL(ecrt_domain_queue);

   457

EXPORT_SYMBOL(ecrt_domain_state);

   458

   459

/** \endcond */

   460

   461

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