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

    EC_MASTER_DBG(domain->master, 1, "Domain %u:"

   121

            " Added %u bytes, total %zu.\n",

   122

            domain->index, 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_MASTER_ERR(domain->master,

   148

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

   149

        return -ENOMEM;

   150

    }

   151

   152

    ec_datagram_init(datagram);

   153

    snprintf(datagram->name, EC_DATAGRAM_NAME_SIZE,

   154

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

   155

   156

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

   157

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

   158

        if (ret < 0) {

   159

            kfree(datagram);

   160

            return ret;

   161

        }

   162

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

   163

        // while input FMMUs increment it by 1.

   164

        domain->expected_working_counter +=

   165

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

   166

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

   167

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

   168

        if (ret < 0) {

   169

            kfree(datagram);

   170

            return ret;

   171

        }

   172

        domain->expected_working_counter += used[EC_DIR_OUTPUT];

   173

    } else { // inputs only (or nothing)

   174

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

   175

        if (ret < 0) {

   176

            kfree(datagram);

   177

            return ret;

   178

        }

   179

        domain->expected_working_counter += used[EC_DIR_INPUT];

   180

    }

   181

   182

    ec_datagram_zero(datagram);

   183

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

   184

    datagram->domain = domain;

   185

    return 0;

   186

}

   187

   188

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

   189

   190

/** Finishes a domain.

   191

 *

   192

 * This allocates the necessary datagrams and writes the correct logical

   193

 * addresses to every configured FMMU.

   194

 *

   195

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

   196

 *

   197

 * \retval  0 Success

   198

 * \retval <0 Error code.

   199

 */

   200

int ec_domain_finish(

   201

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

   202

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

   203

        )

   204

{

   205

    uint32_t datagram_offset;

   206

    size_t datagram_size;

   207

    unsigned int datagram_count;

   208

    unsigned int datagram_used[EC_DIR_COUNT];

   209

    ec_fmmu_config_t *fmmu;

   210

    ec_fmmu_config_t *fmmu_temp;

   211

    const ec_datagram_t *datagram;

   212

    int ret;

   213

   214

    domain->logical_base_address = base_address;

   215

   216

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

   217

        if (!(domain->data =

   218

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

   219

            EC_MASTER_ERR(domain->master, "Failed to allocate %zu bytes"

   220

                    " internal memory for domain %u!\n",

   221

                    domain->data_size, domain->index);

   222

            return -ENOMEM;

   223

        }

   224

    }

   225

   226

    // Cycle through all domain FMMUS and

   227

    // - correct the logical base addresses

   228

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

   229

    datagram_offset = 0;

   230

    datagram_size = 0;

   231

    datagram_count = 0;

   232

    datagram_used[EC_DIR_OUTPUT] = 0;

   233

    datagram_used[EC_DIR_INPUT] = 0;

   234

   235

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

   236

        // we have to remove the constness, sorry FIXME

   237

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

   238

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

   239

    }

   240

   241

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

   242

        // Correct logical FMMU address

   243

        fmmu->logical_start_address += base_address;

   244

        fmmu->domain_address += base_address;

   245

   246

        // Increment Input/Output counter to determine datagram types

   247

        // and calculate expected working counters

   248

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

   249

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

   250

            datagram_used[fmmu->dir]++;

   251

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

   252

        }

   253

   254

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

   255

        // allocate a new one.

   256

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

   257

            ret = ec_domain_add_datagram(domain,

   258

                    domain->logical_base_address + datagram_offset,

   259

                    datagram_size, domain->data + datagram_offset,

   260

                    datagram_used);

   261

            if (ret < 0)

   262

                return ret;

   263

            datagram_offset += datagram_size;

   264

            datagram_size = 0;

   265

            datagram_count++;

   266

            datagram_used[EC_DIR_OUTPUT] = 0;

   267

            datagram_used[EC_DIR_INPUT] = 0;

   268

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

   269

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

   270

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

   271

            }

   272

        }

   273

   274

        datagram_size += fmmu->tx_size;

   275

    }

   276

   277

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

   278

    // process data fit into a single datagram)

   279

    if (datagram_size) {

   280

        ret = ec_domain_add_datagram(domain,

   281

                domain->logical_base_address + datagram_offset,

   282

                datagram_size, domain->data + datagram_offset,

   283

                datagram_used);

   284

        if (ret < 0)

   285

            return ret;

   286

        datagram_count++;

   287

    }

   288

   289

    EC_MASTER_INFO(domain->master, "Domain%u: Logical address 0x%08x,"

   290

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

   291

            domain->logical_base_address, domain->data_size,

   292

            domain->expected_working_counter);

   293

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

   294

        EC_MASTER_INFO(domain->master, "  Datagram %s: Logical offset 0x%08x,"

   295

                " %zu byte, type %s.\n", datagram->name,

   296

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

   297

                ec_datagram_type_string(datagram));

   298

    }

   299

   300

    return 0;

   301

}

   302

   303

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

   304

   305

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

   306

 */

   307

unsigned int ec_domain_fmmu_count(const ec_domain_t *domain)

   308

{

   309

    const ec_fmmu_config_t *fmmu;

   310

    unsigned int num = 0;

   311

   312

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

   313

        num++;

   314

    }

   315

   316

    return num;

   317

}

   318

   319

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

   320

   321

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

   322

 */

   323

const ec_fmmu_config_t *ec_domain_find_fmmu(

   324

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

   325

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

   326

        )

   327

{

   328

    const ec_fmmu_config_t *fmmu;

   329

   330

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

   331

        if (pos--)

   332

            continue;

   333

        return fmmu;

   334

    }

   335

   336

    return NULL;

   337

}

   338

   339

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

   340

 *  Realtime interface

   341

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

   342

   343

int ecrt_domain_reg_pdo_entry_list(ec_domain_t *domain,

   344

        const ec_pdo_entry_reg_t *regs)

   345

{

   346

    const ec_pdo_entry_reg_t *reg;

   347

    ec_slave_config_t *sc;

   348

    int ret;

   349

   350

    EC_MASTER_DBG(domain->master, 1, "ecrt_domain_reg_pdo_entry_list("

   351

            "domain = 0x%p, regs = 0x%p)\n", domain, regs);

   352

   353

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

   354

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

   355

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

   356

        if (IS_ERR(sc))

   357

            return PTR_ERR(sc);

   358

   359

        ret = ecrt_slave_config_reg_pdo_entry(sc, reg->index,

   360

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

   361

        if (ret < 0)

   362

            return ret;

   363

   364

        *reg->offset = ret;

   365

    }

   366

   367

    return 0;

   368

}

   369

   370

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

   371

   372

size_t ecrt_domain_size(const ec_domain_t *domain)

   373

{

   374

    return domain->data_size;

   375

}

   376

   377

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

   378

   379

void ecrt_domain_external_memory(ec_domain_t *domain, uint8_t *mem)

   380

{

   381

    EC_MASTER_DBG(domain->master, 1, "ecrt_domain_external_memory("

   382

            "domain = 0x%p, mem = 0x%p)\n", domain, mem);

   383

   384

    ec_mutex_lock(&domain->master->master_mutex);

   385

   386

    ec_domain_clear_data(domain);

   387

   388

    domain->data = mem;

   389

    domain->data_origin = EC_ORIG_EXTERNAL;

   390

   391

    ec_mutex_unlock(&domain->master->master_mutex);

   392

}

   393

   394

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

   395

   396

uint8_t *ecrt_domain_data(ec_domain_t *domain)

   397

{

   398

    return domain->data;

   399

}

   400

   401

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

   402

   403

void ecrt_domain_process(ec_domain_t *domain)

   404

{

   405

    uint16_t working_counter_sum;

   406

    ec_datagram_t *datagram;

   407

   408

    working_counter_sum = 0x0000;

   409

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

   410

        ec_datagram_output_stats(datagram);

   411

        if (datagram->state == EC_DATAGRAM_RECEIVED) {

   412

            working_counter_sum += datagram->working_counter;

   413

        }

   414

    }

   415

   416

    if (working_counter_sum != domain->working_counter) {

   417

        domain->working_counter_changes++;

   418

        domain->working_counter = working_counter_sum;

   419

    }

   420

   421

    if (domain->working_counter_changes &&

   422

        jiffies - domain->notify_jiffies > HZ) {

   423

        domain->notify_jiffies = jiffies;

   424

        if (domain->working_counter_changes == 1) {

   425

            EC_MASTER_INFO(domain->master, "Domain %u: Working counter"

   426

                    " changed to %u/%u.\n", domain->index,

   427

                    domain->working_counter, domain->expected_working_counter);

   428

        } else {

   429

            EC_MASTER_INFO(domain->master, "Domain %u: %u working counter"

   430

                    " changes - now %u/%u.\n", domain->index,

   431

                    domain->working_counter_changes, domain->working_counter,

   432

                    domain->expected_working_counter);

   433

        }

   434

        domain->working_counter_changes = 0;

   435

    }

   436

}

   437

   438

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

   439

   440

void ecrt_domain_queue(ec_domain_t *domain)

   441

{

   442

    ec_datagram_t *datagram;

   443

   444

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

   445

        ec_master_queue_datagram(domain->master, datagram);

   446

    }

   447

}

   448

   449

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

   450

   451

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

   452

{

   453

    state->working_counter = domain->working_counter;

   454

   455

    if (domain->working_counter) {

   456

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

   457

            state->wc_state = EC_WC_COMPLETE;

   458

        } else {

   459

            state->wc_state = EC_WC_INCOMPLETE;

   460

        }

   461

    } else {

   462

        state->wc_state = EC_WC_ZERO;

   463

    }

   464

}

   465

   466

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

   467

   468

/** \cond */

   469

   470

EXPORT_SYMBOL(ecrt_domain_reg_pdo_entry_list);

   471

EXPORT_SYMBOL(ecrt_domain_size);

   472

EXPORT_SYMBOL(ecrt_domain_external_memory);

   473

EXPORT_SYMBOL(ecrt_domain_data);

   474

EXPORT_SYMBOL(ecrt_domain_process);

   475

EXPORT_SYMBOL(ecrt_domain_queue);

   476

EXPORT_SYMBOL(ecrt_domain_state);

   477

   478

/** \endcond */

   479

   480

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