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

 *  vim: expandtab

    29

 *

    30

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

    31

    32

/**

    33

   \file

    34

   EtherCAT slave configuration methods.

    35

*/

    36

    37

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

    38

    39

#include <linux/slab.h>

    40

    41

#include "globals.h"

    42

#include "master.h"

    43

#include "voe_handler.h"

    44

    45

#include "slave_config.h"

    46

    47

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

    48

    49

/** Slave configuration constructor.

    50

 *

    51

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

    52

 * position parameters.

    53

 */

    54

void ec_slave_config_init(

    55

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

    56

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

    57

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

    58

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

    59

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

    60

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

    61

        )

    62

{

    63

    unsigned int i;

    64

    65

    sc->master = master;

    66

    67

    sc->alias = alias;

    68

    sc->position = position;

    69

    sc->vendor_id = vendor_id;

    70

    sc->product_code = product_code;

    71

    sc->watchdog_divider = 0; // use default

    72

    sc->watchdog_intervals = 0; // use default

    73

    74

    sc->slave = NULL;

    75

    76

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

    77

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

    78

    79

    sc->used_fmmus = 0;

    80

    sc->dc_assign_activate = 0x0000;

    81

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

    82

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

    83

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

    84

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

    85

    86

    INIT_LIST_HEAD(&sc->sdo_configs);

    87

    INIT_LIST_HEAD(&sc->sdo_requests);

    88

    INIT_LIST_HEAD(&sc->voe_handlers);

    89

    INIT_LIST_HEAD(&sc->soe_configs);

    90

}

    91

    92

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

    93

    94

/** Slave configuration destructor.

    95

 *

    96

 * Clears and frees a slave configuration object.

    97

 */

    98

void ec_slave_config_clear(

    99

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

   100

        )

   101

{

   102

    unsigned int i;

   103

    ec_sdo_request_t *req, *next_req;

   104

    ec_voe_handler_t *voe, *next_voe;

   105

    ec_soe_request_t *soe, *next_soe;

   106

   107

    ec_slave_config_detach(sc);

   108

   109

    // Free sync managers

   110

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

   111

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

   112

   113

    // free all SDO configurations

   114

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

   115

        list_del(&req->list);

   116

        ec_sdo_request_clear(req);

   117

        kfree(req);

   118

    }

   119

   120

    // free all SDO requests

   121

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

   122

        list_del(&req->list);

   123

        ec_sdo_request_clear(req);

   124

        kfree(req);

   125

    }

   126

   127

    // free all VoE handlers

   128

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

   129

        list_del(&voe->list);

   130

        ec_voe_handler_clear(voe);

   131

        kfree(voe);

   132

    }

   133

   134

    // free all SoE configurations

   135

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

   136

        list_del(&soe->list);

   137

        ec_soe_request_clear(soe);

   138

        kfree(soe);

   139

    }

   140

}

   141

   142

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

   143

   144

/** Prepares an FMMU configuration.

   145

 *

   146

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

   147

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

   148

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

   149

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

   150

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

   151

 * returns with success.

   152

 *

   153

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

   154

 * \retval  <0 Error code.

   155

 */

   156

int ec_slave_config_prepare_fmmu(

   157

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

   158

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

   159

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

   160

        ec_direction_t dir /**< PDO direction. */

   161

        )

   162

{

   163

    unsigned int i;

   164

    ec_fmmu_config_t *fmmu;

   165

   166

    // FMMU configuration already prepared?

   167

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

   168

        fmmu = &sc->fmmu_configs[i];

   169

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

   170

            return fmmu->logical_start_address;

   171

    }

   172

   173

    if (sc->used_fmmus == EC_MAX_FMMUS) {

   174

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

   175

        return -EOVERFLOW;

   176

    }

   177

   178

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

   179

   180

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

   181

    ec_fmmu_config_init(fmmu, sc, domain, sync_index, dir);

   182

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

   183

   184

    return fmmu->logical_start_address;

   185

}

   186

   187

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

   188

   189

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

   190

 *

   191

 * \retval  0 Success.

   192

 * \retval <0 Error code.

   193

 */

   194

int ec_slave_config_attach(

   195

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

   196

        )

   197

{

   198

    ec_slave_t *slave;

   199

   200

    if (sc->slave)

   201

        return 0; // already attached

   202

   203

    if (!(slave = ec_master_find_slave(

   204

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

   205

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

   206

        return -ENOENT;

   207

    }

   208

   209

    if (slave->config) {

   210

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

   211

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

   212

        return -EEXIST;

   213

    }

   214

   215

    if (

   216

#ifdef EC_IDENT_WILDCARDS

   217

            sc->vendor_id != 0xffffffff &&

   218

#endif

   219

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

   220

       ) {

   221

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

   222

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

   223

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

   224

        return -EINVAL;

   225

    }

   226

   227

    if (

   228

#ifdef EC_IDENT_WILDCARDS

   229

            sc->product_code != 0xffffffff &&

   230

#endif

   231

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

   232

       ) {

   233

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

   234

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

   235

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

   236

                sc->product_code);

   237

        return -EINVAL;

   238

    }

   239

   240

    // attach slave

   241

    slave->config = sc;

   242

    sc->slave = slave;

   243

   244

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

   245

    return 0;

   246

}

   247

   248

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

   249

   250

/** Detaches the configuration from a slave object.

   251

 */

   252

void ec_slave_config_detach(

   253

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

   254

        )

   255

{

   256

    if (sc->slave) {

   257

        sc->slave->config = NULL;

   258

        sc->slave = NULL;

   259

    }

   260

}

   261

   262

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

   263

   264

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

   265

 */

   266

void ec_slave_config_load_default_sync_config(ec_slave_config_t *sc)

   267

{

   268

    uint8_t sync_index;

   269

    ec_sync_config_t *sync_config;

   270

    const ec_sync_t *sync;

   271

   272

    if (!sc->slave)

   273

        return;

   274

   275

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

   276

        sync_config = &sc->sync_configs[sync_index];

   277

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

   278

            sync_config->dir = ec_sync_default_direction(sync);

   279

            if (sync_config->dir == EC_DIR_INVALID)

   280

                EC_SLAVE_WARN(sc->slave,

   281

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

   282

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

   283

        }

   284

    }

   285

}

   286

   287

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

   288

   289

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

   290

 */

   291

void ec_slave_config_load_default_mapping(

   292

        const ec_slave_config_t *sc,

   293

        ec_pdo_t *pdo

   294

        )

   295

{

   296

    unsigned int i;

   297

    const ec_sync_t *sync;

   298

    const ec_pdo_t *default_pdo;

   299

   300

    if (!sc->slave)

   301

        return;

   302

   303

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

   304

            pdo->index);

   305

   306

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

   307

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

   308

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

   309

   310

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

   311

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

   312

                continue;

   313

   314

            if (default_pdo->name) {

   315

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

   316

                        default_pdo->name);

   317

   318

                // take PDO name from assigned one

   319

                ec_pdo_set_name(pdo, default_pdo->name);

   320

            }

   321

   322

            // copy entries (= default PDO mapping)

   323

            if (ec_pdo_copy_entries(pdo, default_pdo))

   324

                return;

   325

   326

            if (sc->master->debug_level) {

   327

                const ec_pdo_entry_t *entry;

   328

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

   329

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

   330

                            entry->index, entry->subindex);

   331

                }

   332

            }

   333

   334

            return;

   335

        }

   336

    }

   337

   338

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

   339

}

   340

   341

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

   342

   343

/** Get the number of SDO configurations.

   344

 *

   345

 * \return Number of SDO configurations.

   346

 */

   347

unsigned int ec_slave_config_sdo_count(

   348

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

   349

        )

   350

{

   351

    const ec_sdo_request_t *req;

   352

    unsigned int count = 0;

   353

   354

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

   355

        count++;

   356

    }

   357

   358

    return count;

   359

}

   360

   361

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

   362

   363

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

   364

 *

   365

 * Const version.

   366

 */

   367

const ec_sdo_request_t *ec_slave_config_get_sdo_by_pos_const(

   368

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

   369

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

   370

        )

   371

{

   372

    const ec_sdo_request_t *req;

   373

   374

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

   375

        if (pos--)

   376

            continue;

   377

        return req;

   378

    }

   379

   380

    return NULL;

   381

}

   382

   383

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

   384

   385

/** Get the number of IDN configurations.

   386

 *

   387

 * \return Number of SDO configurations.

   388

 */

   389

unsigned int ec_slave_config_idn_count(

   390

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

   391

        )

   392

{

   393

    const ec_soe_request_t *req;

   394

    unsigned int count = 0;

   395

   396

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

   397

        count++;

   398

    }

   399

   400

    return count;

   401

}

   402

   403

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

   404

   405

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

   406

 *

   407

 * Const version.

   408

 */

   409

const ec_soe_request_t *ec_slave_config_get_idn_by_pos_const(

   410

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

   411

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

   412

        )

   413

{

   414

    const ec_soe_request_t *req;

   415

   416

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

   417

        if (pos--)

   418

            continue;

   419

        return req;

   420

    }

   421

   422

    return NULL;

   423

}

   424

   425

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

   426

   427

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

   428

 */

   429

ec_sdo_request_t *ec_slave_config_find_sdo_request(

   430

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

   431

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

   432

        )

   433

{

   434

    ec_sdo_request_t *req;

   435

   436

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

   437

        if (pos--)

   438

            continue;

   439

        return req;

   440

    }

   441

   442

    return NULL;

   443

}

   444

   445

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

   446

   447

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

   448

 */

   449

ec_voe_handler_t *ec_slave_config_find_voe_handler(

   450

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

   451

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

   452

        )

   453

{

   454

    ec_voe_handler_t *voe;

   455

   456

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

   457

        if (pos--)

   458

            continue;

   459

        return voe;

   460

    }

   461

   462

    return NULL;

   463

}

   464

   465

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

   466

 *  Application interface

   467

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

   468

   469

int ecrt_slave_config_sync_manager(ec_slave_config_t *sc, uint8_t sync_index,

   470

        ec_direction_t dir, ec_watchdog_mode_t watchdog_mode)

   471

{

   472

    ec_sync_config_t *sync_config;

   473

   474

    EC_CONFIG_DBG(sc, 1, "ecrt_slave_config_sync_manager(sc = 0x%p,"

   475

            " sync_index = %u, dir = %i, watchdog_mode = %i)\n",

   476

            sc, sync_index, dir, watchdog_mode);

   477

   478

    if (sync_index >= EC_MAX_SYNC_MANAGERS) {

   479

        EC_CONFIG_ERR(sc, "Invalid sync manager index %u!\n", sync_index);

   480

        return -ENOENT;

   481

    }

   482

   483

    if (dir != EC_DIR_OUTPUT && dir != EC_DIR_INPUT) {

   484

        EC_CONFIG_ERR(sc, "Invalid direction %u!\n", (unsigned int) dir);

   485

        return -EINVAL;

   486

    }

   487

   488

    sync_config = &sc->sync_configs[sync_index];

   489

    sync_config->dir = dir;

   490

    sync_config->watchdog_mode = watchdog_mode;

   491

    return 0;

   492

}

   493

   494

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

   495