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

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

   119

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

   120

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

   146

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

   147

        return -ENOMEM;

   148

    }

   149

   150

    ec_datagram_init(datagram);

   151

    snprintf(datagram->name, EC_DATAGRAM_NAME_SIZE,

   152

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

   153

   154

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

   155

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

   156

        if (ret < 0) {

   157

            kfree(datagram);

   158

            return ret;

   159

        }

   160

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

   161

        // while input FMMUs increment it by 1.

   162

        domain->expected_working_counter +=

   163

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

   164

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

   165

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

   166

        if (ret < 0) {

   167

            kfree(datagram);

   168

            return ret;

   169

        }

   170

        domain->expected_working_counter += used[EC_DIR_OUTPUT];

   171

    } else { // inputs only (or nothing)

   172

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

   173

        if (ret < 0) {

   174

            kfree(datagram);

   175

            return ret;

   176

        }

   177

        domain->expected_working_counter += used[EC_DIR_INPUT];

   178

    }

   179

   180

    ec_datagram_zero(datagram);

   181

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

   182

    return 0;

   183

}

   184

   185

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

   186

   187

/** Finishes a domain.

   188

 *

   189

 * This allocates the necessary datagrams and writes the correct logical

   190

 * addresses to every configured FMMU.

   191

 *

   192

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

   193

 *

   194

 * \retval  0 Success

   195

 * \retval <0 Error code.

   196

 */

   197

int ec_domain_finish(

   198

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

   199

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

   200

        )

   201

{

   202

    uint32_t datagram_offset;

   203

    size_t datagram_size;

   204

    unsigned int datagram_count;

   205

    unsigned int datagram_used[EC_DIR_COUNT];

   206

    ec_fmmu_config_t *fmmu;

   207

    ec_fmmu_config_t *fmmu_temp;

   208

    const ec_datagram_t *datagram;

   209

    int ret;

   210

   211

    domain->logical_base_address = base_address;

   212

   213

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

   214

        if (!(domain->data =

   215

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

   216

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

   217

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

   218

                    domain->data_size, domain->index);

   219

            return -ENOMEM;

   220

        }

   221

    }

   222

   223

    // Cycle through all domain FMMUS and

   224

    // - correct the logical base addresses

   225

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

   226

    datagram_offset = 0;

   227

    datagram_size = 0;

   228

    datagram_count = 0;

   229

    datagram_used[EC_DIR_OUTPUT] = 0;

   230

    datagram_used[EC_DIR_INPUT] = 0;

   231

   232

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

   233

        // we have to remove the constness, sorry FIXME

   234

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

   235

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

   236

    }

   237

   238

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

   239

        // Correct logical FMMU address

   240

        fmmu->logical_start_address += base_address;

   241

   242

        // Increment Input/Output counter to determine datagram types

   243

        // and calculate expected working counters

   244

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

   245

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

   246

            datagram_used[fmmu->dir]++;

   247

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

   248

        }

   249

   250

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

   251

        // allocate a new one.

   252

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

   253

            ret = ec_domain_add_datagram(domain,

   254

                    domain->logical_base_address + datagram_offset,

   255

                    datagram_size, domain->data + datagram_offset,

   256

                    datagram_used);

   257

            if (ret < 0)

   258

                return ret;

   259

            datagram_offset += datagram_size;

   260

            datagram_size = 0;

   261

            datagram_count++;

   262

            datagram_used[EC_DIR_OUTPUT] = 0;

   263

            datagram_used[EC_DIR_INPUT] = 0;

   264

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

   265

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

   266

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

   267

            }

   268

        }

   269

   270

        datagram_size += fmmu->data_size;

   271

    }

   272

   273

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

   274

    // process data fit into a single datagram)

   275

    if (datagram_size) {

   276

        ret = ec_domain_add_datagram(domain,

   277

                domain->logical_base_address + datagram_offset,

   278

                datagram_size, domain->data + datagram_offset,

   279

                datagram_used);

   280

        if (ret < 0)

   281

            return ret;

   282

        datagram_count++;

   283

    }

   284

   285

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

   286

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

   287

            domain->logical_base_address, domain->data_size,

   288

            domain->expected_working_counter);

   289

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

   290

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

   291

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

   292

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

   293

                ec_datagram_type_string(datagram));

   294

    }

   295

   296

    return 0;

   297

}

   298

   299

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

   300

   301

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

   302

 */

   303

unsigned int ec_domain_fmmu_count(const ec_domain_t *domain)

   304

{

   305

    const ec_fmmu_config_t *fmmu;

   306

    unsigned int num = 0;

   307

   308

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

   309

        num++;

   310

    }

   311

   312

    return num;

   313

}

   314

   315

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

   316

   317

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

   318

 */

   319

const ec_fmmu_config_t *ec_domain_find_fmmu(

   320

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

   321

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

   322

        )

   323

{

   324

    const ec_fmmu_config_t *fmmu;

   325

   326

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

   327

        if (pos--)

   328

            continue;

   329

        return fmmu;

   330

    }

   331

   332

    return NULL;

   333

}

   334

   335

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

   336

 *  Realtime interface

   337

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

   338

   339

int ecrt_domain_reg_pdo_entry_list(ec_domain_t *domain,

   340

        const ec_pdo_entry_reg_t *regs)

   341

{

   342

    const ec_pdo_entry_reg_t *reg;

   343

    ec_slave_config_t *sc;

   344

    int ret;

   345

   346

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

   347

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

   348

   349

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

   350

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

   351

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

   352

        if (IS_ERR(sc))

   353

            return PTR_ERR(sc);

   354

   355

        ret = ecrt_slave_config_reg_pdo_entry(sc, reg->index,

   356

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

   357

        if (ret < 0)

   358

            return ret;

   359

   360

        *reg->offset = ret;

   361

    }

   362

   363

    return 0;

   364

}

   365

   366

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

   367

   368

size_t ecrt_domain_size(const ec_domain_t *domain)

   369

{

   370

    return domain->data_size;

   371

}

   372

   373

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

   374

   375

void ecrt_domain_external_memory(ec_domain_t *domain, uint8_t *mem)

   376

{

   377

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

   378

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

   379

   380

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

   381

   382

    ec_domain_clear_data(domain);

   383

   384

    domain->data = mem;

   385

    domain->data_origin = EC_ORIG_EXTERNAL;

   386

   387

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

   388

}

   389

   390

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

   391

   392

uint8_t *ecrt_domain_data(ec_domain_t *domain)

   393

{

   394

    return domain->data;

   395

}

   396

   397

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

   398

   399

void ecrt_domain_process(ec_domain_t *domain)

   400

{

   401

    uint16_t working_counter_sum;

   402

    ec_datagram_t *datagram;

   403

   404

    working_counter_sum = 0x0000;

   405

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

   406

        ec_datagram_output_stats(datagram);

   407

        if (datagram->state == EC_DATAGRAM_RECEIVED) {

   408

            working_counter_sum += datagram->working_counter;

   409

        }

   410

    }

   411

   412

    if (working_counter_sum != domain->working_counter) {

   413

        domain->working_counter_changes++;

   414

        domain->working_counter = working_counter_sum;

   415

    }

   416

   417

    if (domain->working_counter_changes &&

   418

        jiffies - domain->notify_jiffies > HZ) {

   419

        domain->notify_jiffies = jiffies;

   420

        if (domain->working_counter_changes == 1) {

   421

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

   422

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

   423

                    domain->working_counter, domain->expected_working_counter);

   424

        } else {

   425

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

   426

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

   427

                    domain->working_counter_changes, domain->working_counter,

   428

                    domain->expected_working_counter);

   429

        }

   430

        domain->working_counter_changes = 0;

   431

    }

   432

}

   433

   434

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

   435

   436

void ecrt_domain_queue(ec_domain_t *domain)

   437

{

   438

    ec_datagram_t *datagram;

   439

   440

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

   441

        ec_master_queue_datagram(domain->master, datagram);

   442

    }

   443

}

   444

   445

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

   446

   447

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

   448

{

   449

    state->working_counter = domain->working_counter;

   450

   451

    if (domain->working_counter) {

   452

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

   453

            state->wc_state = EC_WC_COMPLETE;

   454

        } else {

   455

            state->wc_state = EC_WC_INCOMPLETE;

   456

        }

   457

    } else {

   458

        state->wc_state = EC_WC_ZERO;

   459

    }

   460

}

   461

   462

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

   463

   464

/** \cond */

   465

   466

EXPORT_SYMBOL(ecrt_domain_reg_pdo_entry_list);

   467

EXPORT_SYMBOL(ecrt_domain_size);

   468

EXPORT_SYMBOL(ecrt_domain_external_memory);

   469

EXPORT_SYMBOL(ecrt_domain_data);

   470

EXPORT_SYMBOL(ecrt_domain_process);

   471

EXPORT_SYMBOL(ecrt_domain_queue);

   472

EXPORT_SYMBOL(ecrt_domain_state);

   473

   474

/** \endcond */

   475

   476

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