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

 * \retval  0 Success.

   130

 * \retval <0 Error code.

   131

 */

   132

int ec_domain_add_datagram(

   133

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

   134

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

   135

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

   136

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

   137

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

   138

        )

   139

{

   140

    ec_datagram_t *datagram;

   141

    int ret;

   142

   143

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

   144

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

   145

        return -ENOMEM;

   146

    }

   147

   148

    ec_datagram_init(datagram);

   149

    snprintf(datagram->name, EC_DATAGRAM_NAME_SIZE,

   150

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

   151

   152

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

   153

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

   154

        if (ret < 0) {

   155

            kfree(datagram);

   156

            return ret;

   157

        }

   158

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

   159

        // while input FMMUs increment it by 1.

   160

        domain->expected_working_counter +=

   161

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

   162

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

   163

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

   164

        if (ret < 0) {

   165

            kfree(datagram);

   166

            return ret;

   167

        }

   168

        domain->expected_working_counter += used[EC_DIR_OUTPUT];

   169

    } else { // inputs only (or nothing)

   170

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

   171

        if (ret < 0) {

   172

            kfree(datagram);

   173

            return ret;

   174

        }

   175

        domain->expected_working_counter += used[EC_DIR_INPUT];

   176

    }

   177

   178

    ec_datagram_zero(datagram);

   179

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

   180

    return 0;

   181

}

   182

   183

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

   184

   185

/** Finishes a domain.

   186

 *

   187

 * This allocates the necessary datagrams and writes the correct logical

   188

 * addresses to every configured FMMU.

   189

 *

   190

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

   191

 *

   192

 * \retval  0 Success

   193

 * \retval <0 Error code.

   194

 */

   195

int ec_domain_finish(

   196

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

   197

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

   198

        )

   199

{

   200

    uint32_t datagram_offset;

   201

    size_t datagram_size;

   202

    unsigned int datagram_count;

   203

    unsigned int datagram_used[EC_DIR_COUNT];

   204

    ec_fmmu_config_t *fmmu;

   205

    const ec_datagram_t *datagram;

   206

    int ret;

   207

   208

    domain->logical_base_address = base_address;

   209

   210

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

   211

        if (!(domain->data =

   212

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

   213

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

   214

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

   215

            return -ENOMEM;

   216

        }

   217

    }

   218

   219

    // Cycle through all domain FMMUS and

   220

    // - correct the logical base addresses

   221

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

   222

    datagram_offset = 0;

   223

    datagram_size = 0;

   224

    datagram_count = 0;

   225

    datagram_used[EC_DIR_OUTPUT] = 0;

   226

    datagram_used[EC_DIR_INPUT] = 0;

   227

   228

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

   229

        // Correct logical FMMU address

   230

        fmmu->logical_start_address += base_address;

   231

   232

        // Increment Input/Output counter to determine datagram types

   233

        // and calculate expected working counters

   234

        datagram_used[fmmu->dir]++;

   235

   236

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

   237

        // allocate a new one.

   238

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

   239

            ret = ec_domain_add_datagram(domain,

   240

                    domain->logical_base_address + datagram_offset,

   241

                    datagram_size, domain->data + datagram_offset,

   242

                    datagram_used);

   243

            if (ret < 0)

   244

                return ret;

   245

            datagram_offset += datagram_size;

   246

            datagram_size = 0;

   247

            datagram_count++;

   248

            datagram_used[EC_DIR_OUTPUT] = 0;

   249

            datagram_used[EC_DIR_INPUT] = 0;

   250

        }

   251

   252

        datagram_size += fmmu->data_size;

   253

    }

   254

   255

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

   256

    // process data fit into a single datagram)

   257

    if (datagram_size) {

   258

        ret = ec_domain_add_datagram(domain,

   259

                domain->logical_base_address + datagram_offset,

   260

                datagram_size, domain->data + datagram_offset,

   261

                datagram_used);

   262

        if (ret < 0)

   263

            return ret;

   264

        datagram_count++;

   265

    }

   266

   267

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

   268

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

   269

            domain->logical_base_address, domain->data_size,

   270

            domain->expected_working_counter);

   271

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

   272

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

   273

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

   274

                datagram->data_size, ec_datagram_type_string(datagram));

   275

    }

   276

   277

    return 0;

   278

}

   279

   280

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

   281

   282

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

   283

 */

   284

unsigned int ec_domain_fmmu_count(const ec_domain_t *domain)

   285

{

   286

    const ec_fmmu_config_t *fmmu;

   287

    unsigned int num = 0;

   288

   289

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

   290

        num++;

   291

    }

   292

   293

    return num;

   294

}

   295

   296

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

   297

   298

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

   299

 */

   300

const ec_fmmu_config_t *ec_domain_find_fmmu(

   301

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

   302

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

   303

        )

   304

{

   305

    const ec_fmmu_config_t *fmmu;

   306

   307

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

   308

        if (pos--)

   309

            continue;

   310

        return fmmu;

   311

    }

   312

   313

    return NULL;

   314

}

   315

   316

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

   317

 *  Realtime interface

   318

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

   319

   320

int ecrt_domain_reg_pdo_entry_list(ec_domain_t *domain,

   321

        const ec_pdo_entry_reg_t *regs)

   322

{

   323

    const ec_pdo_entry_reg_t *reg;

   324

    ec_slave_config_t *sc;

   325

    int ret;

   326

   327

    if (domain->master->debug_level)

   328

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

   329

                (u32) domain, (u32) regs);

   330

   331

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

   332

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

   333

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

   334

        if (IS_ERR(sc))

   335

            return PTR_ERR(sc);

   336

   337

        ret = ecrt_slave_config_reg_pdo_entry(sc, reg->index,

   338

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

   339

        if (ret < 0)

   340

            return ret;

   341

   342

        *reg->offset = ret;

   343

    }

   344

   345

    return 0;

   346

}

   347

   348

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

   349

   350

size_t ecrt_domain_size(const ec_domain_t *domain)

   351

{

   352

    return domain->data_size;

   353

}

   354

   355

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

   356

   357

void ecrt_domain_external_memory(ec_domain_t *domain, uint8_t *mem)

   358

{

   359

    if (domain->master->debug_level)

   360

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

   361

                (u32) domain, (u32) mem);

   362

   363

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

   364

   365

    ec_domain_clear_data(domain);

   366

   367

    domain->data = mem;

   368

    domain->data_origin = EC_ORIG_EXTERNAL;

   369

   370

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

   371

}

   372

   373

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

   374

   375

uint8_t *ecrt_domain_data(ec_domain_t *domain)

   376

{

   377

    return domain->data;

   378

}

   379

   380

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

   381

   382

void ecrt_domain_process(ec_domain_t *domain)

   383

{

   384

    uint16_t working_counter_sum;

   385

    ec_datagram_t *datagram;

   386

   387

    working_counter_sum = 0x0000;

   388

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

   389

        ec_datagram_output_stats(datagram);

   390

        if (datagram->state == EC_DATAGRAM_RECEIVED) {

   391

            working_counter_sum += datagram->working_counter;

   392

        }

   393

    }

   394

   395

    if (working_counter_sum != domain->working_counter) {

   396

        domain->working_counter_changes++;

   397

        domain->working_counter = working_counter_sum;

   398

    }

   399

   400

    if (domain->working_counter_changes &&

   401

        jiffies - domain->notify_jiffies > HZ) {

   402

        domain->notify_jiffies = jiffies;

   403

        if (domain->working_counter_changes == 1) {

   404

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

   405

                    domain->index, domain->working_counter,

   406

                    domain->expected_working_counter);

   407

        } else {

   408

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

   409

                    domain->index, domain->working_counter_changes,

   410

                    domain->working_counter, domain->expected_working_counter);

   411

        }

   412

        domain->working_counter_changes = 0;

   413

    }

   414

}

   415

   416

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

   417

   418

void ecrt_domain_queue(ec_domain_t *domain)

   419

{

   420

    ec_datagram_t *datagram;

   421

   422

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

   423

        ec_master_queue_datagram(domain->master, datagram);

   424

    }

   425

}

   426

   427

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

   428

   429

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

   430

{

   431

    state->working_counter = domain->working_counter;

   432

   433

    if (domain->working_counter) {

   434

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

   435

            state->wc_state = EC_WC_COMPLETE;

   436

        } else {

   437

            state->wc_state = EC_WC_INCOMPLETE;

   438

        }

   439

    } else {

   440

        state->wc_state = EC_WC_ZERO;

   441

    }

   442

}

   443

   444

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

   445

   446

/** \cond */

   447

   448

EXPORT_SYMBOL(ecrt_domain_reg_pdo_entry_list);

   449

EXPORT_SYMBOL(ecrt_domain_size);

   450

EXPORT_SYMBOL(ecrt_domain_external_memory);

   451

EXPORT_SYMBOL(ecrt_domain_data);

   452

EXPORT_SYMBOL(ecrt_domain_process);

   453

EXPORT_SYMBOL(ecrt_domain_queue);

   454

EXPORT_SYMBOL(ecrt_domain_state);

   455

   456

/** \endcond */

   457

   458

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