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

    64

    domain->data = NULL;

    65

    domain->data_origin = EC_ORIG_INTERNAL;

    66

    domain->logical_base_address = 0x00000000;

    67

    INIT_LIST_HEAD(&domain->datagrams);

    68

    domain->working_counter = 0x0000;

    69

    domain->expected_working_counter = 0x0000;

    70

    domain->working_counter_changes = 0;

    71

    domain->notify_jiffies = 0;

    72

}

    73

    74

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

    75

    76

/** Domain destructor.

    77

 */

    78

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

    79

{

    80

    ec_datagram_t *datagram, *next;

    81

    82

    // dequeue and free datagrams

    83

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

    84

        ec_datagram_clear(datagram);

    85

        kfree(datagram);

    86

    }

    87

    88

    ec_domain_clear_data(domain);

    89

}

    90

    91

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

    92

    93

/** Frees internally allocated memory.

    94

 */

    95

void ec_domain_clear_data(

    96

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

    97

        )

    98

{

    99

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

   100

        kfree(domain->data);

   101

    domain->data = NULL;

   102

    domain->data_origin = EC_ORIG_INTERNAL;

   103

}

   104

   105

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

   106

   107

/** Adds an FMMU configuration to the domain.

   108

 */

   109

void ec_domain_add_fmmu_config(

   110

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

   111

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

   112

        )

   113

{

   114

    fmmu->domain = domain;

   115

   116

    domain->data_size += fmmu->data_size;

   117

    domain->tx_size += fmmu->tx_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

    datagram->domain = domain;

   184

    return 0;

   185

}

   186

   187

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

   188

   189

/** Finishes a domain.

   190

 *

   191

 * This allocates the necessary datagrams and writes the correct logical

   192

 * addresses to every configured FMMU.

   193

 *

   194

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

   195

 *

   196

 * \retval  0 Success

   197

 * \retval <0 Error code.

   198

 */

   199

int ec_domain_finish(

   200

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

   201

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

   202

        )

   203

{

   204

    uint32_t datagram_offset;

   205

    size_t datagram_size;

   206

    unsigned int datagram_count;

   207

    unsigned int datagram_used[EC_DIR_COUNT];

   208

    ec_fmmu_config_t *fmmu;

   209

    ec_fmmu_config_t *fmmu_temp;

   210

    const ec_datagram_t *datagram;

   211

    int ret;

   212

   213

    domain->logical_base_address = base_address;

   214

   215

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

   216

        if (!(domain->data =

   217

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

   218

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

   219

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

   220

            return -ENOMEM;

   221

        }

   222

    }

   223

   224

    // Cycle through all domain FMMUS and

   225

    // - correct the logical base addresses

   226

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

   227

    datagram_offset = 0;

   228

    datagram_size = 0;

   229

    datagram_count = 0;

   230

    datagram_used[EC_DIR_OUTPUT] = 0;

   231

    datagram_used[EC_DIR_INPUT] = 0;

   232

   233

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

   234

        // we have to remove the constness, sorry FIXME

   235

        ec_slave_config_t *sc = (ec_slave_config_t *) fmmu_temp->sc;

   236

        sc->used_for_fmmu_datagram[fmmu_temp->dir] = 0;

   237

    }

   238

   239

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

   240

        // Correct logical FMMU address

   241

        fmmu->logical_start_address += base_address;

   242

        fmmu->domain_address += base_address;

   243

   244

        // Increment Input/Output counter to determine datagram types

   245

        // and calculate expected working counters

   246

        if (fmmu->sc->used_for_fmmu_datagram[fmmu->dir] == 0) {

   247

            ec_slave_config_t *sc = (ec_slave_config_t *)fmmu->sc;

   248

            datagram_used[fmmu->dir]++;

   249

            sc->used_for_fmmu_datagram[fmmu->dir] = 1;

   250

        }

   251

   252

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

   253

        // allocate a new one.

   254

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

   255

            ret = ec_domain_add_datagram(domain,

   256

                    domain->logical_base_address + datagram_offset,

   257

                    datagram_size, domain->data + datagram_offset,

   258

                    datagram_used);

   259

            if (ret < 0)

   260

                return ret;

   261

            datagram_offset += datagram_size;

   262

            datagram_size = 0;

   263

            datagram_count++;

   264

            datagram_used[EC_DIR_OUTPUT] = 0;

   265

            datagram_used[EC_DIR_INPUT] = 0;

   266

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

   267

                ec_slave_config_t *sc = (ec_slave_config_t *)fmmu_temp->sc;

   268

               sc->used_for_fmmu_datagram[fmmu_temp->dir] = 0;

   269

            }

   270

        }

   271

   272

        datagram_size += fmmu->tx_size;

   273

    }

   274

   275

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

   276

    // process data fit into a single datagram)

   277

    if (datagram_size) {

   278

        ret = ec_domain_add_datagram(domain,

   279

                domain->logical_base_address + datagram_offset,

   280

                datagram_size, domain->data + datagram_offset,

   281

                datagram_used);

   282

        if (ret < 0)

   283

            return ret;

   284

        datagram_count++;

   285

    }

   286

   287

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

   288

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

   289

            domain->logical_base_address, domain->data_size,

   290

            domain->expected_working_counter);

   291

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

   292

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

   293

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

   294

                datagram->data_size, ec_datagram_type_string(datagram));

   295

    }

   296

   297

    return 0;

   298

}

   299

   300

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

   301

   302

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

   303

 */

   304

unsigned int ec_domain_fmmu_count(const ec_domain_t *domain)

   305

{

   306

    const ec_fmmu_config_t *fmmu;

   307

    unsigned int num = 0;

   308

   309

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

   310

        num++;

   311

    }

   312

   313

    return num;

   314

}

   315

   316

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

   317

   318

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

   319

 */

   320

const ec_fmmu_config_t *ec_domain_find_fmmu(

   321

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

   322

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

   323

        )

   324

{

   325

    const ec_fmmu_config_t *fmmu;

   326

   327

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

   328

        if (pos--)

   329

            continue;

   330

        return fmmu;

   331

    }

   332

   333

    return NULL;

   334

}

   335

   336

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

   337

 *  Realtime interface

   338

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

   339

   340

int ecrt_domain_reg_pdo_entry_list(ec_domain_t *domain,

   341

        const ec_pdo_entry_reg_t *regs)

   342

{

   343

    const ec_pdo_entry_reg_t *reg;

   344

    ec_slave_config_t *sc;

   345

    int ret;

   346

   347

    if (domain->master->debug_level)

   348

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

   349

                domain, regs);

   350

   351

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

   352

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

   353

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

   354

        if (IS_ERR(sc))

   355

            return PTR_ERR(sc);

   356

   357

        ret = ecrt_slave_config_reg_pdo_entry(sc, reg->index,

   358

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

   359

        if (ret < 0)

   360

            return ret;

   361

   362

        *reg->offset = ret;

   363

    }

   364

   365

    return 0;

   366

}

   367

   368

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

   369

   370

size_t ecrt_domain_size(const ec_domain_t *domain)

   371

{

   372

    return domain->data_size;

   373

}

   374

   375

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

   376

   377

void ecrt_domain_external_memory(ec_domain_t *domain, uint8_t *mem)

   378

{

   379

    if (domain->master->debug_level)

   380

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

   381

                domain, mem);

   382

   383

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

   384

   385

    ec_domain_clear_data(domain);

   386

   387

    domain->data = mem;

   388

    domain->data_origin = EC_ORIG_EXTERNAL;

   389

   390

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

   391

}

   392

   393

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

   394

   395

uint8_t *ecrt_domain_data(ec_domain_t *domain)

   396

{

   397

    return domain->data;

   398

}

   399

   400

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

   401

   402

void ecrt_domain_process(ec_domain_t *domain)

   403

{

   404

    uint16_t working_counter_sum;

   405

    ec_datagram_t *datagram;

   406

   407

    working_counter_sum = 0x0000;

   408

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

   409

        ec_datagram_output_stats(datagram);

   410

        if (datagram->state == EC_DATAGRAM_RECEIVED) {

   411

            working_counter_sum += datagram->working_counter;

   412

        }

   413

    }

   414

   415

    if (working_counter_sum != domain->working_counter) {

   416

        domain->working_counter_changes++;

   417

        domain->working_counter = working_counter_sum;

   418

    }

   419

   420

    if (domain->working_counter_changes &&

   421

        jiffies - domain->notify_jiffies > HZ) {

   422

        domain->notify_jiffies = jiffies;

   423

        if (domain->working_counter_changes == 1) {

   424

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

   425

                    domain->index, domain->working_counter,

   426

                    domain->expected_working_counter);

   427

        } else {

   428

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

   429

                    domain->index, domain->working_counter_changes,

   430

                    domain->working_counter, domain->expected_working_counter);

   431

        }

   432

        domain->working_counter_changes = 0;

   433

    }

   434

}

   435

   436

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

   437

   438

void ecrt_domain_queue(ec_domain_t *domain)

   439

{

   440

    ec_datagram_t *datagram;

   441

   442

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

   443

        ec_master_queue_datagram(domain->master, datagram);

   444

    }

   445

}

   446

   447

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

   448

   449

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

   450

{

   451

    state->working_counter = domain->working_counter;

   452

   453

    if (domain->working_counter) {

   454

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

   455

            state->wc_state = EC_WC_COMPLETE;

   456

        } else {

   457

            state->wc_state = EC_WC_INCOMPLETE;

   458

        }

   459

    } else {

   460

        state->wc_state = EC_WC_ZERO;

   461

    }

   462

}

   463

   464

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

   465

   466

/** \cond */

   467

   468

EXPORT_SYMBOL(ecrt_domain_reg_pdo_entry_list);

   469

EXPORT_SYMBOL(ecrt_domain_size);

   470

EXPORT_SYMBOL(ecrt_domain_external_memory);

   471

EXPORT_SYMBOL(ecrt_domain_data);

   472

EXPORT_SYMBOL(ecrt_domain_process);

   473

EXPORT_SYMBOL(ecrt_domain_queue);

   474

EXPORT_SYMBOL(ecrt_domain_state);

   475

   476

/** \endcond */

   477

   478

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