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

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

    23

 *  the industrial property and similar rights of Beckhoff Automation GmbH.

    24

 *

    25

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

    26

    27

/**

    28

   \file

    29

   EtherCAT domain methods.

    30

*/

    31

    32

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

    33

    34

#include <linux/module.h>

    35

    36

#include "globals.h"

    37

#include "master.h"

    38

#include "slave_config.h"

    39

    40

#include "domain.h"

    41

    42

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

    43

    44

void ec_domain_clear_data(ec_domain_t *);

    45

    46

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

    47

    48

/** Domain constructor.

    49

 */

    50

void ec_domain_init(

    51

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

    52

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

    53

        unsigned int index /**< Index. */

    54

        )

    55

{

    56

    domain->master = master;

    57

    domain->index = index;

    58

    INIT_LIST_HEAD(&domain->fmmu_configs);

    59

    domain->data_size = 0;

    60

    domain->data = NULL;

    61

    domain->data_origin = EC_ORIG_INTERNAL;

    62

    domain->logical_base_address = 0x00000000;

    63

    INIT_LIST_HEAD(&domain->datagrams);

    64

    domain->working_counter = 0x0000;

    65

    domain->expected_working_counter = 0x0000;

    66

    domain->working_counter_changes = 0;

    67

    domain->notify_jiffies = 0;

    68

}

    69

    70

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

    71

    72

/** Domain destructor.

    73

 */

    74

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

    75

{

    76

    ec_datagram_t *datagram, *next;

    77

    78

    // dequeue and free datagrams

    79

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

    80

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

    81

            list_del(&datagram->queue);

    82

        ec_datagram_clear(datagram);

    83

        kfree(datagram);

    84

    }

    85

    86

    ec_domain_clear_data(domain);

    87

}

    88

    89

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

    90

    91

/** Frees internally allocated memory.

    92

 */

    93

void ec_domain_clear_data(

    94

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

    95

        )

    96

{

    97

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

    98

        kfree(domain->data);

    99

    domain->data = NULL;

   100

    domain->data_origin = EC_ORIG_INTERNAL;

   101

}

   102

   103

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

   104

   105

/** Adds an FMMU configuration to the domain.

   106

 */

   107

void ec_domain_add_fmmu_config(

   108

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

   109

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

   110

        )

   111

{

   112

    fmmu->domain = domain;

   113

   114

    domain->data_size += fmmu->data_size;

   115

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

   116

   117

    if (domain->master->debug_level)

   118

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

   119

                fmmu->data_size, domain->data_size);

   120

}

   121

   122

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

   123

   124

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

   125

 *

   126

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

   127

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

   128

 *

   129

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

   130

 */

   131

int ec_domain_add_datagram(

   132

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

   133

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

   134

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

   135

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

   136

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

   137

        )

   138

{

   139

    ec_datagram_t *datagram;

   140

   141

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

   142

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

   143

        return -1;

   144

    }

   145

   146

    ec_datagram_init(datagram);

   147

    snprintf(datagram->name, EC_DATAGRAM_NAME_SIZE,

   148

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

   149

   150

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

   151

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

   152

            kfree(datagram);

   153

            return -1;

   154

        }

   155

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

   156

        // while input FMMUs increment it by 1.

   157

        domain->expected_working_counter +=

   158

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

   159

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

   160

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

   161

            kfree(datagram);

   162

            return -1;

   163

        }

   164

        domain->expected_working_counter += used[EC_DIR_OUTPUT];

   165

    } else { // inputs only (or nothing)

   166

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

   167

            kfree(datagram);

   168

            return -1;

   169

        }

   170

        domain->expected_working_counter += used[EC_DIR_INPUT];

   171

    }

   172

   173

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

   174

    return 0;

   175

}

   176

   177

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

   178

   179

/** Finishes a domain.

   180

 *

   181

 * This allocates the necessary datagrams and writes the correct logical

   182

 * addresses to every configured FMMU.

   183

 *

   184

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

   185

 *

   186

 * \retval 0 in case of success

   187

 * \retval <0 on failure.

   188

 */

   189

int ec_domain_finish(

   190

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

   191

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

   192

        )

   193

{

   194

    uint32_t datagram_offset;

   195

    size_t datagram_size;

   196

    unsigned int datagram_count;

   197

    unsigned int datagram_used[EC_DIR_COUNT];

   198

    ec_fmmu_config_t *fmmu;

   199

    const ec_datagram_t *datagram;

   200

   201

    domain->logical_base_address = base_address;

   202

   203

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

   204

        if (!(domain->data =

   205

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

   206

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

   207

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

   208

            return -1;

   209

        }

   210

    }

   211

   212

    // Cycle through all domain FMMUS and

   213

    // - correct the logical base addresses

   214

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

   215

    datagram_offset = 0;

   216

    datagram_size = 0;

   217

    datagram_count = 0;

   218

    datagram_used[EC_DIR_OUTPUT] = 0;

   219

    datagram_used[EC_DIR_INPUT] = 0;

   220

   221

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

   222

        // Correct logical FMMU address

   223

        fmmu->logical_start_address += base_address;

   224

   225

        // Increment Input/Output counter to determine datagram types

   226

        // and calculate expected working counters

   227

        datagram_used[fmmu->dir]++;

   228

   229

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

   230

        // allocate a new one.

   231

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

   232

            if (ec_domain_add_datagram(domain,

   233

                        domain->logical_base_address + datagram_offset,

   234

                        datagram_size, domain->data + datagram_offset,

   235

                        datagram_used))

   236

                return -1;

   237

            datagram_offset += datagram_size;

   238

            datagram_size = 0;

   239

            datagram_count++;

   240

            datagram_used[EC_DIR_OUTPUT] = 0;

   241

            datagram_used[EC_DIR_INPUT] = 0;

   242

        }

   243

   244

        datagram_size += fmmu->data_size;

   245

    }

   246

   247

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

   248

    // process data fit into a single datagram)

   249

    if (datagram_size) {

   250

        if (ec_domain_add_datagram(domain,

   251

                    domain->logical_base_address + datagram_offset,

   252

                    datagram_size, domain->data + datagram_offset,

   253

                    datagram_used))

   254

            return -1;

   255

        datagram_count++;

   256

    }

   257

   258

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

   259

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

   260

            domain->logical_base_address, domain->data_size,

   261

            domain->expected_working_counter);

   262

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

   263

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

   264

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

   265

                datagram->data_size, ec_datagram_type_string(datagram));

   266

    }

   267

   268

    return 0;

   269

}

   270

   271

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

   272

   273

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

   274

 */

   275

unsigned int ec_domain_fmmu_count(const ec_domain_t *domain)

   276

{

   277

    const ec_fmmu_config_t *fmmu;

   278

    unsigned int num = 0;

   279

   280

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

   281

        num++;

   282

    }

   283

   284

    return num;

   285

}

   286

   287

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

   288

   289

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

   290

 */

   291

const ec_fmmu_config_t *ec_domain_find_fmmu(

   292

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

   293

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

   294

        )

   295

{

   296

    const ec_fmmu_config_t *fmmu;

   297

   298

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

   299

        if (pos--)

   300

            continue;

   301

        return fmmu;

   302

    }

   303

   304

    return NULL;

   305

}

   306

   307

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

   308

 *  Realtime interface

   309

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

   310

   311

int ecrt_domain_reg_pdo_entry_list(ec_domain_t *domain,

   312

        const ec_pdo_entry_reg_t *regs)

   313

{

   314

    const ec_pdo_entry_reg_t *reg;

   315

    ec_slave_config_t *sc;

   316

    int ret;

   317

   318

    if (domain->master->debug_level)

   319

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

   320

                (u32) domain, (u32) regs);

   321

   322

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

   323

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

   324

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

   325

            return -1;

   326

   327

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

   328

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

   329

            return -1;

   330

   331

        *reg->offset = ret;

   332

    }

   333

   334

    return 0;

   335

}

   336

   337

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

   338

   340

{

   341

    return domain->data_size;

   342

}

   343

   344

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

   345

   346

void ecrt_domain_external_memory(ec_domain_t *domain, uint8_t *mem)

   347

{

   348

    if (domain->master->debug_level)

   349

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

   350

                (u32) domain, (u32) mem);

   351

   352

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

   353

   354

    ec_domain_clear_data(domain);

   355

   356

    domain->data = mem;

   357

    domain->data_origin = EC_ORIG_EXTERNAL;

   358

   359

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

   360

}

   361

   362

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

   363

   364

uint8_t *ecrt_domain_data(ec_domain_t *domain)

   365

{

   366

    return domain->data;

   367

}

   368

   369

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

   370

   371

void ecrt_domain_process(ec_domain_t *domain)

   372

{

   373

    uint16_t working_counter_sum;

   374

    ec_datagram_t *datagram;

   375

   376

    working_counter_sum = 0x0000;

   377

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

   378

        ec_datagram_output_stats(datagram);

   379

        if (datagram->state == EC_DATAGRAM_RECEIVED) {

   380

            working_counter_sum += datagram->working_counter;

   381

        }

   382

    }

   383

   384

    if (working_counter_sum != domain->working_counter) {

   385

        domain->working_counter_changes++;

   386

        domain->working_counter = working_counter_sum;

   387

    }

   388

   389

    if (domain->working_counter_changes &&

   390

        jiffies - domain->notify_jiffies > HZ) {

   391

        domain->notify_jiffies = jiffies;

   392

        if (domain->working_counter_changes == 1) {

   393

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

   394

                    domain->index, domain->working_counter,

   395

                    domain->expected_working_counter);

   396

        } else {

   397

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

   398

                    domain->index, domain->working_counter_changes,

   399

                    domain->working_counter, domain->expected_working_counter);

   400

        }

   401

        domain->working_counter_changes = 0;

   402

    }

   403

}

   404

   405

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

   406

   407

void ecrt_domain_queue(ec_domain_t *domain)

   408

{

   409

    ec_datagram_t *datagram;

   410

   411

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

   412

        ec_master_queue_datagram(domain->master, datagram);

   413

    }

   414

}

   415

   416

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

   417

   418

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

   419

{

   420

    state->working_counter = domain->working_counter;

   421

   422

    if (domain->working_counter) {

   423

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

   424

            state->wc_state = EC_WC_COMPLETE;

   425

        } else {

   426

            state->wc_state = EC_WC_INCOMPLETE;

   427

        }

   428

    } else {

   429

        state->wc_state = EC_WC_ZERO;

   430

    }

   431

}

   432

   433

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

   434

   435

/** \cond */

   436

   437

EXPORT_SYMBOL(ecrt_domain_reg_pdo_entry_list);

   438

EXPORT_SYMBOL(ecrt_domain_size);

   439

EXPORT_SYMBOL(ecrt_domain_external_memory);

   440

EXPORT_SYMBOL(ecrt_domain_data);

   441

EXPORT_SYMBOL(ecrt_domain_process);

   442

EXPORT_SYMBOL(ecrt_domain_queue);

   443

EXPORT_SYMBOL(ecrt_domain_state);

   444

   445

/** \endcond */

   446

   447

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