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 slave configuration methods.

    33

*/

    34

    35

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

    36

    37

#include <linux/slab.h>

    38

    39

#include "globals.h"

    40

#include "master.h"

    41

#include "voe_handler.h"

    42

    43

#include "slave_config.h"

    44

    45

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

    46

    47

/** Slave configuration constructor.

    48

 *

    49

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

    50

 * position parameters.

    51

 */

    52

void ec_slave_config_init(

    53

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

    54

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

    55

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

    56

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

    57

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

    58

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

    59

        )

    60

{

    61

    unsigned int i;

    62

    63

    sc->master = master;

    64

    65

    sc->alias = alias;

    66

    sc->position = position;

    67

    sc->vendor_id = vendor_id;

    68

    sc->product_code = product_code;

    69

    sc->watchdog_divider = 0; // use default

    70

    sc->watchdog_intervals = 0; // use default

    71

    72

    sc->slave = NULL;

    73

    74

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

    75

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

    76

    77

    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

}

    90

    91

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

    92

    93

/** Slave configuration destructor.

    94

 *

    95

 * Clears and frees a slave configuration object.

    96

 */

    97

void ec_slave_config_clear(

    98

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

    99

        )

   100

{

   101

    unsigned int i;

   102

    ec_sdo_request_t *req, *next_req;

   103

    ec_voe_handler_t *voe, *next_voe;

   104

   105

    ec_slave_config_detach(sc);

   106

   107

    // Free sync managers

   108

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

   109

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

   110

   111

    // free all SDO configurations

   112

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

   113

        list_del(&req->list);

   114

        ec_sdo_request_clear(req);

   115

        kfree(req);

   116

    }

   117

   118

    // free all SDO requests

   119

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

   120

        list_del(&req->list);

   121

        ec_sdo_request_clear(req);

   122

        kfree(req);

   123

    }

   124

   125

    // free all VoE handlers

   126

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

   127

        list_del(&voe->list);

   128

        ec_voe_handler_clear(voe);

   129

        kfree(voe);

   130

    }

   131

}

   132

   133

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

   134

   135

/** Prepares an FMMU configuration.

   136

 *

   137

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

   138

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

   139

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

   140

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

   141

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

   142

 * returns with success.

   143

 *

   144

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

   145

 * \retval  <0 Error code.

   146

 */

   147

int ec_slave_config_prepare_fmmu(

   148

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

   149

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

   150

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

   151

        ec_direction_t dir /**< PDO direction. */

   152

        )

   153

{

   154

    unsigned int i;

   155

    ec_fmmu_config_t *fmmu;

   156

   157

    // FMMU configuration already prepared?

   158

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

   159

        fmmu = &sc->fmmu_configs[i];

   160

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

   161

            return fmmu->logical_start_address;

   162

    }

   163

   164

    if (sc->used_fmmus == EC_MAX_FMMUS) {

   165

        EC_ERR("FMMU limit reached for slave configuration %u:%u!\n",

   166

                sc->alias, sc->position);

   167

        return -EOVERFLOW;

   168

    }

   169

   170

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

   171

   172

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

   173

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

   174

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

   175

   176

    return fmmu->logical_start_address;

   177

}

   178

   179

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

   180

   181

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

   182

 *

   183

 * \retval  0 Success.

   184

 * \retval <0 Error code.

   185

 */

   186

int ec_slave_config_attach(

   187

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

   188

        )

   189

{

   190

    ec_slave_t *slave;

   191

   192

    if (sc->slave)

   193

        return 0; // already attached

   194

   195

    if (!(slave = ec_master_find_slave(

   196

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

   197

        if (sc->master->debug_level)

   198

            EC_DBG("Failed to find slave for configuration %u:%u.\n",

   199

                    sc->alias, sc->position);

   200

        return -ENOENT;

   201

    }

   202

   203

    if (slave->config) {

   204

        if (sc->master->debug_level)

   205

            EC_DBG("Failed to attach slave configuration %u:%u. Slave %u"

   206

                    " already has a configuration!\n", sc->alias,

   207

                    sc->position, slave->ring_position);

   208

        return -EEXIST;

   209

    }

   210

   211

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

   212

            || slave->sii.product_code != sc->product_code) {

   213

        if (sc->master->debug_level)

   214

            EC_DBG("Slave %u has an invalid type (0x%08X/0x%08X) for"

   215

                    " configuration %u:%u (0x%08X/0x%08X).\n",

   216

                    slave->ring_position, slave->sii.vendor_id,

   217

                    slave->sii.product_code, sc->alias, sc->position,

   218

                    sc->vendor_id, sc->product_code);

   219

        return -EINVAL;

   220

    }

   221

   222

    // attach slave

   223

    slave->config = sc;

   224

    sc->slave = slave;

   225

   226

    ec_slave_request_state(slave, EC_SLAVE_STATE_OP);

   227

   228

    if (sc->master->debug_level)

   229

        EC_DBG("Attached slave %u to config %u:%u.\n",

   230

                slave->ring_position, sc->alias, sc->position);

   231

   232

    return 0;

   233

}

   234

   235

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

   236

   237

/** Detaches the configuration from a slave object.

   238

 */

   239

void ec_slave_config_detach(

   240

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

   241

        )

   242

{

   243

    if (sc->slave) {

   244

        sc->slave->config = NULL;

   245

        sc->slave = NULL;

   246

    }

   247

}

   248

   249

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

   250

   251

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

   252

 */

   253

void ec_slave_config_load_default_sync_config(ec_slave_config_t *sc)

   254

{

   255

    uint8_t sync_index;

   256

    ec_sync_config_t *sync_config;

   257

    const ec_sync_t *sync;

   258

   259

    if (!sc->slave)

   260

        return;

   261

   262

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

   263

        sync_config = &sc->sync_configs[sync_index];

   264

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

   265

            sync_config->dir = ec_sync_default_direction(sync);

   266

            if (sync_config->dir == EC_DIR_INVALID)

   267

                EC_WARN("SM%u of slave %u has an invalid direction field!\n",

   268

                        sync_index, sc->slave->ring_position);

   269

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

   270

        }

   271

    }

   272

}

   273

   274

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

   275

   276

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

   277

 */

   278

void ec_slave_config_load_default_mapping(

   279

        const ec_slave_config_t *sc,

   280

        ec_pdo_t *pdo

   281

        )

   282

{

   283

    unsigned int i;

   284

    const ec_sync_t *sync;

   285

    const ec_pdo_t *default_pdo;

   286

   287

    if (!sc->slave)

   288

        return;

   289

   290

    if (sc->master->debug_level)

   291

        EC_DBG("Loading default mapping for PDO 0x%04X in config %u:%u.\n",

   292

                pdo->index, sc->alias, sc->position);

   293

   294

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

   295

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

   296

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

   297

   298

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

   299

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

   300

                continue;

   301

   302

            if (default_pdo->name) {

   303

                if (sc->master->debug_level)

   304

                    EC_DBG("Found PDO name \"%s\".\n", default_pdo->name);

   305

   306

                // take PDO name from assigned one

   307

                ec_pdo_set_name(pdo, default_pdo->name);

   308

            }

   309

   310

            // copy entries (= default PDO mapping)

   311

            if (ec_pdo_copy_entries(pdo, default_pdo))

   312

                return;

   313

   314

            if (sc->master->debug_level) {

   315

                const ec_pdo_entry_t *entry;

   316

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

   317

                    EC_DBG("Entry 0x%04X:%02X.\n",

   318

                            entry->index, entry->subindex);

   319

                }

   320

            }

   321

   322

            return;

   323

        }

   324

    }

   325

   326

    if (sc->master->debug_level)

   327

        EC_DBG("No default mapping found.\n");

   328

}

   329

   330

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

   331

   332

/** Get the number of SDO configurations.

   333

 *

   334

 * \return Number of SDO configurations.

   335

 */

   336

unsigned int ec_slave_config_sdo_count(

   337

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

   338

        )

   339

{

   340

    const ec_sdo_request_t *req;

   341

    unsigned int count = 0;

   342

   343

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

   344

        count++;

   345

    }

   346

   347

    return count;

   348

}

   349

   350

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

   351

   352

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

   353

 *

   354

 * Const version.

   355

 */

   356

const ec_sdo_request_t *ec_slave_config_get_sdo_by_pos_const(

   357

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

   358

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

   359

        )

   360

{

   361

    const ec_sdo_request_t *req;

   362

   363

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

   364

        if (pos--)

   365

            continue;

   366

        return req;

   367

    }

   368

   369

    return NULL;

   370

}

   371

   372

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

   373

   374

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

   375

 */

   376

ec_sdo_request_t *ec_slave_config_find_sdo_request(

   377

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

   378

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

   379

        )

   380

{

   381

    ec_sdo_request_t *req;

   382

   383

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

   384

        if (pos--)

   385

            continue;

   386

        return req;

   387

    }

   388

   389

    return NULL;

   390

}

   391

   392

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

   393

   394

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

   395

 */

   396

ec_voe_handler_t *ec_slave_config_find_voe_handler(

   397

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

   398

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

   399

        )

   400

{

   401

    ec_voe_handler_t *voe;

   402

   403

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

   404

        if (pos--)

   405

            continue;

   406

        return voe;

   407

    }

   408

   409

    return NULL;

   410

}

   411

   412

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

   413

 *  Application interface

   414

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

   415

   416

int ecrt_slave_config_sync_manager(ec_slave_config_t *sc, uint8_t sync_index,

   417

        ec_direction_t dir, ec_watchdog_mode_t watchdog_mode)

   418

{

   419

    ec_sync_config_t *sync_config;

   420

   421

    if (sc->master->debug_level)

   422

        EC_DBG("ecrt_slave_config_sync_manager(sc = 0x%p, sync_index = %u, "

   423

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

   424

                 sc, sync_index, dir, watchdog_mode);

   425

   426

    if (sync_index >= EC_MAX_SYNC_MANAGERS) {

   427

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

   428

        return -ENOENT;

   429

    }

   430

   431

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

   432

        EC_ERR("Invalid direction %u!\n", (u32) dir);

   433

        return -EINVAL;

   434

    }

   435

   436

    sync_config = &sc->sync_configs[sync_index];

   437

    sync_config->dir = dir;

   438

    sync_config->watchdog_mode = watchdog_mode;

   439

    return 0;

   440

}

   441

   442

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

   443

   444

void ecrt_slave_config_watchdog(ec_slave_config_t *sc,

   445

        uint16_t divider, uint16_t intervals)

   446

{

   447

    if (sc->master->debug_level)

   448

        EC_DBG("%s(sc = 0x%p, divider = %u, intervals = %u)\n",

   449

                __func__, sc, divider, intervals);

   450

   451

    sc->watchdog_divider = divider;

   452

    sc->watchdog_intervals = intervals;

   453

}

   454

   455

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

   456

   457

int ecrt_slave_config_pdo_assign_add(ec_slave_config_t *sc,

   458

        uint8_t sync_index, uint16_t pdo_index)

   459

{

   460

    ec_pdo_t *pdo;

   461

   462

    if (sc->master->debug_level)

   463

        EC_DBG("ecrt_slave_config_pdo_assign_add(sc = 0x%p, sync_index = %u, "

   464

                "pdo_index = 0x%04X)\n", sc, sync_index, pdo_index);

   465

   466

    if (sync_index >= EC_MAX_SYNC_MANAGERS) {

   467

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

   468

        return -EINVAL;

   469

    }

   470

   471

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

   472

   473

    pdo = ec_pdo_list_add_pdo(&sc->sync_configs[sync_index].pdos, pdo_index);

   474

    if (IS_ERR(pdo)) {

   475

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

   476

        return PTR_ERR(pdo);

   477

    }

   478

    pdo->sync_index = sync_index;

   479

   480

    ec_slave_config_load_default_mapping(sc, pdo);

   481

   482

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

   483

    return 0;

   484

}

   485

   486

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

   487

   488

void ecrt_slave_config_pdo_assign_clear(ec_slave_config_t *sc,

   489

        uint8_t sync_index)

   490

{

   491

    if (sc->master->debug_level)

   492

        EC_DBG("ecrt_slave_config_pdo_assign_clear(sc = 0x%p, "

   493

                "sync_index = %u)\n", sc, sync_index);

   494