1

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

     2

 *

     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

 *  vim: expandtab

    29

 *

    30

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

    31

    32

/**

    33

   \file

    34

   EtherCAT slave configuration methods.

    35

*/

    36

    37

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

    38

    39

#include <linux/module.h>

    40

#include <linux/slab.h>

    41

    42

#include "globals.h"

    43

#include "master.h"

    44

#include "voe_handler.h"

    45

    46

#include "slave_config.h"

    47

    48

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

    49

    50

/** Slave configuration constructor.

    51

 *

    52

 * See ecrt_master_slave_config() for the usage of the \a alias and \a

    53

 * position parameters.

    54

 */

    55

void ec_slave_config_init(

    56

        ec_slave_config_t *sc, /**< Slave configuration. */

    57

        ec_master_t *master, /**< EtherCAT master. */

    58

        uint16_t alias, /**< Slave alias. */

    59

        uint16_t position, /**< Slave position. */

    60

        uint32_t vendor_id, /**< Expected vendor ID. */

    61

        uint32_t product_code /**< Expected product code. */

    62

        )

    63

{

    64

    unsigned int i;

    65

    66

    sc->master = master;

    67

    68

    sc->alias = alias;

    69

    sc->position = position;

    70

    sc->vendor_id = vendor_id;

    71

    sc->product_code = product_code;

    72

    sc->watchdog_divider = 0; // use default

    73

    sc->watchdog_intervals = 0; // use default

    74

    sc->allow_overlapping_pdos = 0; // default not allowed

    75

    sc->slave = NULL;

    76

    77

    for (i = 0; i < EC_MAX_SYNC_MANAGERS; i++)

    78

        ec_sync_config_init(&sc->sync_configs[i]);

    79

    80

    sc->used_fmmus = 0;

    81

    sc->dc_assign_activate = 0x0000;

    82

    sc->dc_sync[0].cycle_time = 0x00000000;

    83

    sc->dc_sync[1].cycle_time = 0x00000000;

    84

    sc->dc_sync[0].shift_time = 0x00000000;

    85

    sc->dc_sync[1].shift_time = 0x00000000;

    86

    87

    INIT_LIST_HEAD(&sc->sdo_configs);

    88

    INIT_LIST_HEAD(&sc->sdo_requests);

    89

    INIT_LIST_HEAD(&sc->voe_handlers);

    90

    INIT_LIST_HEAD(&sc->soe_configs);

    91

}

    92

    93

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

    94

    95

/** Slave configuration destructor.

    96

 *

    97

 * Clears and frees a slave configuration object.

    98

 */

    99

void ec_slave_config_clear(

   100

        ec_slave_config_t *sc /**< Slave configuration. */

   101

        )

   102

{

   103

    unsigned int i;

   104

    ec_sdo_request_t *req, *next_req;

   105

    ec_voe_handler_t *voe, *next_voe;

   106

    ec_soe_request_t *soe, *next_soe;

   107

   108

    ec_slave_config_detach(sc);

   109

   110

    // Free sync managers

   111

    for (i = 0; i < EC_MAX_SYNC_MANAGERS; i++)

   112

        ec_sync_config_clear(&sc->sync_configs[i]);

   113

   114

    // free all SDO configurations

   115

    list_for_each_entry_safe(req, next_req, &sc->sdo_configs, list) {

   116

        list_del(&req->list);

   117

        ec_sdo_request_clear(req);

   118

        kfree(req);

   119

    }

   120

   121

    // free all SDO requests

   122

    list_for_each_entry_safe(req, next_req, &sc->sdo_requests, list) {

   123

        list_del(&req->list);

   124

        ec_sdo_request_clear(req);

   125

        kfree(req);

   126

    }

   127

   128

    // free all VoE handlers

   129

    list_for_each_entry_safe(voe, next_voe, &sc->voe_handlers, list) {

   130

        list_del(&voe->list);

   131

        ec_voe_handler_clear(voe);

   132

        kfree(voe);

   133

    }

   134

   135

    // free all SoE configurations

   136

    list_for_each_entry_safe(soe, next_soe, &sc->soe_configs, list) {

   137

        list_del(&soe->list);

   138

        ec_soe_request_clear(soe);

   139

        kfree(soe);

   140

    }

   141

}

   142

   143

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

   144

   145

/** Prepares an FMMU configuration.

   146

 *

   147

 * Configuration data for the FMMU is saved in the slave config structure and

   148

 * is written to the slave during the configuration. The FMMU configuration

   149

 * is done in a way, that the complete data range of the corresponding sync

   150

 * manager is covered. Seperate FMMUs are configured for each domain. If the

   151

 * FMMU configuration is already prepared, the function does nothing and

   152

 * returns with success.

   153

 *

   154

 * \retval >=0 Success, logical offset byte address.

   155

 * \retval  <0 Error code.

   156

 */

   157

int ec_slave_config_prepare_fmmu(

   158

        ec_slave_config_t *sc, /**< Slave configuration. */

   159

        ec_domain_t *domain, /**< Domain. */

   160

        uint8_t sync_index, /**< Sync manager index. */

   161

        ec_direction_t dir /**< PDO direction. */

   162

        )

   163

{

   164

    unsigned int i;

   165

    ec_fmmu_config_t *fmmu, *prev_fmmu;

   166

    uint32_t fmmu_logical_start_address;

   167

    size_t tx_size, old_prev_tx_size;

   168

   169

    // FMMU configuration already prepared?

   170

    for (i = 0; i < sc->used_fmmus; i++) {

   171

        fmmu = &sc->fmmu_configs[i];

   172

        if (fmmu->domain == domain && fmmu->sync_index == sync_index)

   173

            return fmmu->domain_address;

   174

    }

   175

   176

    if (sc->used_fmmus == EC_MAX_FMMUS) {

   177

        EC_CONFIG_ERR(sc, "FMMU limit reached!\n");

   178

        return -EOVERFLOW;

   179

    }

   180

   181

    fmmu = &sc->fmmu_configs[sc->used_fmmus];

   182

   183

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

   184

    ec_fmmu_config_init(fmmu, sc, sync_index, dir);

   185

    fmmu_logical_start_address = domain->tx_size;

   186

    tx_size = fmmu->data_size;

   187

   188

    // FIXME is it enough to take only the *previous* FMMU into account?

   189

   190

    if (sc->allow_overlapping_pdos && sc->used_fmmus > 0) {

   191

        prev_fmmu = &sc->fmmu_configs[sc->used_fmmus - 1];

   192

        if (fmmu->dir != prev_fmmu->dir && prev_fmmu->tx_size != 0) {

   193

            // prev fmmu has opposite direction

   194

            // and is not already paired with prev-prev fmmu

   195

            old_prev_tx_size = prev_fmmu->tx_size;

   196

            prev_fmmu->tx_size = max(fmmu->data_size, prev_fmmu->data_size);

   197

            domain->tx_size += prev_fmmu->tx_size - old_prev_tx_size;

   198

            tx_size = 0;

   199

            fmmu_logical_start_address = prev_fmmu->logical_start_address;

   200

        }

   201

    }

   202

   203

    ec_fmmu_config_domain(fmmu, domain, fmmu_logical_start_address, tx_size);

   204

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

   205

   206

    sc->used_fmmus++;

   207

    return fmmu->domain_address;

   208

}

   209

   210

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

   211

   212

/** Attaches the configuration to the addressed slave object.

   213

 *

   214

 * \retval  0 Success.

   215

 * \retval <0 Error code.

   216

 */

   217

int ec_slave_config_attach(

   218

        ec_slave_config_t *sc /**< Slave configuration. */

   219

        )

   220

{

   221

    ec_slave_t *slave;

   222

   223

    if (sc->slave)

   224

        return 0; // already attached

   225

   226

    if (!(slave = ec_master_find_slave(

   227

                    sc->master, sc->alias, sc->position))) {

   228

        EC_CONFIG_DBG(sc, 1, "Failed to find slave for configuration.\n");

   229

        return -ENOENT;

   230

    }

   231

   232

    if (slave->config) {

   233

        EC_CONFIG_DBG(sc, 1, "Failed to attach configuration. Slave %u"

   234

                " already has a configuration!\n", slave->ring_position);

   235

        return -EEXIST;

   236

    }

   237

   238

    if (

   239

#ifdef EC_IDENT_WILDCARDS

   240

            sc->vendor_id != 0xffffffff &&

   241

#endif

   242

            slave->sii.vendor_id != sc->vendor_id

   243

       ) {

   244

        EC_CONFIG_DBG(sc, 1, "Slave %u has no matching vendor ID (0x%08X)"

   245

                " for configuration (0x%08X).\n",

   246

                slave->ring_position, slave->sii.vendor_id, sc->vendor_id);

   247

        return -EINVAL;

   248

    }

   249

   250

    if (

   251

#ifdef EC_IDENT_WILDCARDS

   252

            sc->product_code != 0xffffffff &&

   253

#endif

   254

            slave->sii.product_code != sc->product_code

   255

       ) {

   256

        EC_CONFIG_DBG(sc, 1, "Slave %u has no matching product code (0x%08X)"

   257

                " for configuration (0x%08X).\n",

   258

                slave->ring_position, slave->sii.product_code,

   259

                sc->product_code);

   260

        return -EINVAL;

   261

    }

   262

   263

    // attach slave

   264

    slave->config = sc;

   265

    sc->slave = slave;

   266

   267

    EC_CONFIG_DBG(sc, 1, "Attached slave %u.\n", slave->ring_position);

   268

   269

    return 0;

   270

}

   271

   272

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

   273

   274

/** Detaches the configuration from a slave object.

   275

 */

   276

void ec_slave_config_detach(

   277

        ec_slave_config_t *sc /**< Slave configuration. */

   278

        )

   279

{

   280

    if (sc->slave) {

   281

        sc->slave->config = NULL;

   282

        sc->slave = NULL;

   283

    }

   284

}

   285

   286

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

   287

   288

/** Loads the default PDO assignment from the slave object.

   289

 */

   290

void ec_slave_config_load_default_sync_config(ec_slave_config_t *sc)

   291

{

   292

    uint8_t sync_index;

   293

    ec_sync_config_t *sync_config;

   294

    const ec_sync_t *sync;

   295

   296

    if (!sc->slave)

   297

        return;

   298

   299

    for (sync_index = 0; sync_index < EC_MAX_SYNC_MANAGERS; sync_index++) {

   300

        sync_config = &sc->sync_configs[sync_index];

   301

        if ((sync = ec_slave_get_sync(sc->slave, sync_index))) {

   302

            sync_config->dir = ec_sync_default_direction(sync);

   303

            if (sync_config->dir == EC_DIR_INVALID)

   304

                EC_SLAVE_WARN(sc->slave,

   305

                        "SM%u has an invalid direction field!\n", sync_index);

   306

            ec_pdo_list_copy(&sync_config->pdos, &sync->pdos);

   307

        }

   308

    }

   309

}

   310

   311

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

   312

   313

/** Loads the default mapping for a PDO from the slave object.

   314

 */

   315

void ec_slave_config_load_default_mapping(

   316

        const ec_slave_config_t *sc,

   317

        ec_pdo_t *pdo

   318

        )

   319

{

   320

    unsigned int i;

   321

    const ec_sync_t *sync;

   322

    const ec_pdo_t *default_pdo;

   323

   324

    if (!sc->slave)

   325

        return;

   326

   327

    EC_CONFIG_DBG(sc, 1, "Loading default mapping for PDO 0x%04X.\n",

   328

            pdo->index);

   329

   330

    // find PDO in any sync manager (it could be reassigned later)

   331

    for (i = 0; i < sc->slave->sii.sync_count; i++) {

   332

        sync = &sc->slave->sii.syncs[i];

   333

   334

        list_for_each_entry(default_pdo, &sync->pdos.list, list) {

   335

            if (default_pdo->index != pdo->index)

   336

                continue;

   337

   338

            if (default_pdo->name) {

   339

                EC_CONFIG_DBG(sc, 1, "Found PDO name \"%s\".\n",

   340

                        default_pdo->name);

   341

   342

                // take PDO name from assigned one

   343

                ec_pdo_set_name(pdo, default_pdo->name);

   344

            }

   345

   346

            // copy entries (= default PDO mapping)

   347

            if (ec_pdo_copy_entries(pdo, default_pdo))

   348

                return;

   349

   350

            if (sc->master->debug_level) {

   351

                const ec_pdo_entry_t *entry;

   352

                list_for_each_entry(entry, &pdo->entries, list) {

   353

                    EC_CONFIG_DBG(sc, 1, "Entry 0x%04X:%02X.\n",

   354

                            entry->index, entry->subindex);

   355

                }

   356

            }

   357

   358

            return;

   359

        }

   360

    }

   361

   362

    EC_CONFIG_DBG(sc, 1, "No default mapping found.\n");

   363

}

   364

   365

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

   366

   367

/** Get the number of SDO configurations.

   368

 *

   369

 * \return Number of SDO configurations.

   370

 */

   371

unsigned int ec_slave_config_sdo_count(

   372

        const ec_slave_config_t *sc /**< Slave configuration. */

   373

        )

   374

{

   375

    const ec_sdo_request_t *req;

   376

    unsigned int count = 0;

   377

   378

    list_for_each_entry(req, &sc->sdo_configs, list) {

   379

        count++;

   380

    }

   381

   382

    return count;

   383

}

   384

   385

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

   386

   387

/** Finds an SDO configuration via its position in the list.

   388

 *

   389

 * Const version.

   390

 */

   391

const ec_sdo_request_t *ec_slave_config_get_sdo_by_pos_const(

   392

        const ec_slave_config_t *sc, /**< Slave configuration. */

   393

        unsigned int pos /**< Position in the list. */

   394

        )

   395

{

   396

    const ec_sdo_request_t *req;

   397

   398

    list_for_each_entry(req, &sc->sdo_configs, list) {

   399

        if (pos--)

   400

            continue;

   401

        return req;

   402

    }

   403

   404

    return NULL;

   405

}

   406

   407

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

   408

   409

/** Get the number of IDN configurations.

   410

 *

   411

 * \return Number of SDO configurations.

   412

 */

   413

unsigned int ec_slave_config_idn_count(

   414

        const ec_slave_config_t *sc /**< Slave configuration. */

   415

        )

   416

{

   417

    const ec_soe_request_t *req;

   418

    unsigned int count = 0;

   419

   420

    list_for_each_entry(req, &sc->soe_configs, list) {

   421

        count++;

   422

    }

   423

   424

    return count;

   425

}

   426

   427

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

   428

   429

/** Finds an IDN configuration via its position in the list.

   430

 *

   431

 * Const version.

   432

 */

   433

const ec_soe_request_t *ec_slave_config_get_idn_by_pos_const(

   434

        const ec_slave_config_t *sc, /**< Slave configuration. */

   435

        unsigned int pos /**< Position in the list. */

   436

        )

   437

{

   438

    const ec_soe_request_t *req;

   439

   440

    list_for_each_entry(req, &sc->soe_configs, list) {

   441

        if (pos--)

   442

            continue;

   443

        return req;

   444

    }

   445

   446

    return NULL;

   447

}

   448

   449

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

   450

   451

/** Finds a VoE handler via its position in the list.

   452

 */

   453

ec_sdo_request_t *ec_slave_config_find_sdo_request(

   454

        ec_slave_config_t *sc, /**< Slave configuration. */

   455

        unsigned int pos /**< Position in the list. */

   456

        )

   457

{

   458

    ec_sdo_request_t *req;

   459

   460

    list_for_each_entry(req, &sc->sdo_requests, list) {

   461

        if (pos--)

   462

            continue;

   463

        return req;

   464

    }

   465

   466

    return NULL;

   467

}

   468

   469

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

   470

   471

/** Finds a VoE handler via its position in the list.

   472

 */

   473

ec_voe_handler_t *ec_slave_config_find_voe_handler(

   474

        ec_slave_config_t *sc, /**< Slave configuration. */

   475

        unsigned int pos /**< Position in the list. */

   476

        )

   477

{

   478

    ec_voe_handler_t *voe;

   479

   480

    list_for_each_entry(voe, &sc->voe_handlers, list) {

   481

        if (pos--)

   482

            continue;

   483

        return voe;

   484

    }

   485

   486

    return NULL;

   487

}

   488

   489

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

   490

 *  Application interface

   491

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

   492

   493

int ecrt_slave_config_sync_manager(ec_slave_config_t *sc, uint8_t sync_index,

   494

        ec_direction_t dir, ec_watchdog_mode_t watchdog_mode)