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

        ec_datagram_clear(datagram);

    84

        kfree(datagram);

    85

    }

    86

    87

    ec_domain_clear_data(domain);

    88

}

    89

    90

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

    91

    92

/** Frees internally allocated memory.

    93

 */

    94

void ec_domain_clear_data(

    95

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

    96

        )

    97

{

    98

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

    99

        kfree(domain->data);

   100

    domain->data = NULL;

   101

    domain->data_origin = EC_ORIG_INTERNAL;

   102

}

   103

   104

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

   105

   106

/** Adds an FMMU configuration to the domain.

   107

 */

   108

void ec_domain_add_fmmu_config(

   109

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

   110

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

   111

        )

   112

{

   113

    fmmu->domain = domain;

   114

   115

    domain->data_size += fmmu->data_size;

   116

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

   117

   118

    if (domain->master->debug_level)

   119

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

   120

                fmmu->data_size, domain->data_size);

   121

}

   122

   123

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

   124

   125

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

   126

 *

   127

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

   128

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

   129

 *

   130

 * \retval  0 Success.

   131

 * \retval <0 Error code.

   132

 */

   133

int ec_domain_add_datagram(

   134

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

   135

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

   136

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

   137

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

   138

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

   139

        )

   140

{

   141

    ec_datagram_t *datagram;

   142

    int ret;

   143

   144

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

   145

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

   146

        return -ENOMEM;

   147

    }

   148

   149

    ec_datagram_init(datagram);

   150

    snprintf(datagram->name, EC_DATAGRAM_NAME_SIZE,

   151

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

   152

   153

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

   154

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

   155

        if (ret < 0) {

   156

            kfree(datagram);

   157

            return ret;

   158

        }

   159

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

   160

        // while input FMMUs increment it by 1.

   161

        domain->expected_working_counter +=

   162

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

   163

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

   164

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

   165

        if (ret < 0) {

   166

            kfree(datagram);

   167

            return ret;

   168

        }

   169

        domain->expected_working_counter += used[EC_DIR_OUTPUT];

   170

    } else { // inputs only (or nothing)

   171

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

   172

        if (ret < 0) {

   173

            kfree(datagram);

   174

            return ret;

   175

        }

   176

        domain->expected_working_counter += used[EC_DIR_INPUT];

   177

    }

   178

   179

    ec_datagram_zero(datagram);

   180

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

   181

    return 0;

   182

}

   183

   184

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

   185

   186

/** Finishes a domain.

   187

 *

   188

 * This allocates the necessary datagrams and writes the correct logical

   189

 * addresses to every configured FMMU.

   190

 *

   191

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

   192

 *

   193

 * \retval  0 Success

   194

 * \retval <0 Error code.

   195

 */

   196

int ec_domain_finish(

   197

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

   198

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

   199

        )

   200

{

   201

    uint32_t datagram_offset;

   202

    size_t datagram_size;

   203

    unsigned int datagram_count;

   204

    unsigned int datagram_used[EC_DIR_COUNT];

   205

    ec_fmmu_config_t *fmmu;

   206

    const ec_datagram_t *datagram;

   207

    int ret;

   208

   209

    domain->logical_base_address = base_address;

   210

   211

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

   212

        if (!(domain->data =

   213

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

   214

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

   215

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

   216

            return -ENOMEM;

   217

        }

   218

    }

   219

   220

    // Cycle through all domain FMMUS and

   221

    // - correct the logical base addresses

   222

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

   223

    datagram_offset = 0;

   224

    datagram_size = 0;

   225

    datagram_count = 0;

   226

    datagram_used[EC_DIR_OUTPUT] = 0;

   227

    datagram_used[EC_DIR_INPUT] = 0;

   228

   229

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

   230

        // Correct logical FMMU address

   231

        fmmu->logical_start_address += base_address;

   232

   233

        // Increment Input/Output counter to determine datagram types

   234

        // and calculate expected working counters

   235

        datagram_used[fmmu->dir]++;

   236

   237

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

   238

        // allocate a new one.

   239

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

   240

            ret = ec_domain_add_datagram(domain,

   241

                    domain->logical_base_address + datagram_offset,

   242

                    datagram_size, domain->data + datagram_offset,

   243

                    datagram_used);

   244

            if (ret < 0)

   245

                return ret;

   246

            datagram_offset += datagram_size;

   247

            datagram_size = 0;

   248

            datagram_count++;

   249

            datagram_used[EC_DIR_OUTPUT] = 0;

   250

            datagram_used[EC_DIR_INPUT] = 0;

   251

        }

   252

   253

        datagram_size += fmmu->data_size;

   254

    }

   255

   256

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

   257

    // process data fit into a single datagram)

   258

    if (datagram_size) {

   259

        ret = ec_domain_add_datagram(domain,

   260

                domain->logical_base_address + datagram_offset,

   261

                datagram_size, domain->data + datagram_offset,

   262

                datagram_used);

   263

        if (ret < 0)

   264

            return ret;

   265

        datagram_count++;

   266

    }

   267

   268

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

   269

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

   270

            domain->logical_base_address, domain->data_size,

   271

            domain->expected_working_counter);

   272

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

   273

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

   274

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

   275

                datagram->data_size, ec_datagram_type_string(datagram));

   276

    }

   277

   278

    return 0;

   279

}

   280

   281

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

   282

   283

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

   284

 */

   285

unsigned int ec_domain_fmmu_count(const ec_domain_t *domain)

   286

{

   287

    const ec_fmmu_config_t *fmmu;

   288

    unsigned int num = 0;

   289

   290

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

   291

        num++;

   292

    }

   293

   294

    return num;

   295

}

   296

   297

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

   298

   299

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

   300

 */

   301

const ec_fmmu_config_t *ec_domain_find_fmmu(

   302

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

   303

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

   304

        )

   305

{

   306

    const ec_fmmu_config_t *fmmu;

   307

   308

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

   309

        if (pos--)

   310

            continue;

   311

        return fmmu;

   312

    }

   313

   314

    return NULL;

   315

}

   316

   317

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

   318

 *  Realtime interface

   319

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

   320

   321

int ecrt_domain_reg_pdo_entry_list(ec_domain_t *domain,

   322

        const ec_pdo_entry_reg_t *regs)

   323

{

   324

    const ec_pdo_entry_reg_t *reg;

   325

    ec_slave_config_t *sc;

   326

    int ret;

   327

   328

    if (domain->master->debug_level)

   329

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

   330

                domain, regs);

   331

   332

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

   333

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

   334

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

   335

        if (IS_ERR(sc))

   336

            return PTR_ERR(sc);

   337

   338

        ret = ecrt_slave_config_reg_pdo_entry(sc, reg->index,

   339

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

   340

        if (ret < 0)

   341

            return ret;

   342

   343

        *reg->offset = ret;

   344

    }

   345

   346

    return 0;

   347

}

   348

   349

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

   350

   351

size_t ecrt_domain_size(const ec_domain_t *domain)

   352

{

   353

    return domain->data_size;

   354

}

   355

   356

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

   357

   358

void ecrt_domain_external_memory(ec_domain_t *domain, uint8_t *mem)

   359

{

   360

    if (domain->master->debug_level)

   361

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

   362

                domain, mem);

   363

   364

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

   365

   366

    ec_domain_clear_data(domain);

   367

   368

    domain->data = mem;

   369

    domain->data_origin = EC_ORIG_EXTERNAL;

   370

   371

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

   372

}

   373

   374

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

   375

   376

uint8_t *ecrt_domain_data(ec_domain_t *domain)

   377

{

   378

    return domain->data;

   379

}

   380

   381

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

   382

   383

void ecrt_domain_process(ec_domain_t *domain)

   384

{

   385

    uint16_t working_counter_sum;

   386

    ec_datagram_t *datagram;

   387

   388

    working_counter_sum = 0x0000;

   389

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

   390

        ec_datagram_output_stats(datagram);

   391

        if (datagram->state == EC_DATAGRAM_RECEIVED) {

   392

            working_counter_sum += datagram->working_counter;

   393

        }

   394

    }

   395

   396

    if (working_counter_sum != domain->working_counter) {

   397

        domain->working_counter_changes++;

   398

        domain->working_counter = working_counter_sum;

   399

    }

   400

   401

    if (domain->working_counter_changes &&

   402

        jiffies - domain->notify_jiffies > HZ) {

   403

        domain->notify_jiffies = jiffies;

   404

        if (domain->working_counter_changes == 1) {

   405

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

   406

                    domain->index, domain->working_counter,

   407

                    domain->expected_working_counter);

   408

        } else {

   409

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

   410

                    domain->index, domain->working_counter_changes,

   411

                    domain->working_counter, domain->expected_working_counter);

   412

        }

   413

        domain->working_counter_changes = 0;

   414

    }

   415

}

   416

   417

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

   418

   419

void ecrt_domain_queue(ec_domain_t *domain)

   420

{

   421

    ec_datagram_t *datagram;

   422

   423

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

   424

        ec_master_queue_datagram(domain->master, datagram);

   425

    }

   426

}

   427

   428

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

   429

   430

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

   431

{

   432

    state->working_counter = domain->working_counter;

   433

   434

    if (domain->working_counter) {

   435

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

   436

            state->wc_state = EC_WC_COMPLETE;

   437

        } else {

   438

            state->wc_state = EC_WC_INCOMPLETE;

   439

        }

   440

    } else {

   441

        state->wc_state = EC_WC_ZERO;

   442

    }

   443

}

   444

   445

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

   446

   447

/** \cond */

   448

   449

EXPORT_SYMBOL(ecrt_domain_reg_pdo_entry_list);

   450

EXPORT_SYMBOL(ecrt_domain_size);

   451

EXPORT_SYMBOL(ecrt_domain_external_memory);

   452

EXPORT_SYMBOL(ecrt_domain_data);

   453

EXPORT_SYMBOL(ecrt_domain_process);

   454

EXPORT_SYMBOL(ecrt_domain_queue);

   455

EXPORT_SYMBOL(ecrt_domain_state);

   456

   457

/** \endcond */

   458

   459

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