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

 *  Using the EtherCAT technology and brand is permitted in compliance with

    23

 *  the industrial property and similar rights of Beckhoff Automation GmbH.

    24

 *

    25

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

    26

    27

/**

    28

   \file

    29

   EtherCAT slave configuration methods.

    30

*/

    31

    32

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

    33

    34

#include <linux/slab.h>

    35

    36

#include "globals.h"

    37

#include "master.h"

    38

#include "voe_handler.h"

    39

    40

#include "slave_config.h"

    41

    42

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

    43

    44

/** Slave configuration constructor.

    45

 *

    46

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

    47

 * position parameters.

    48

 */

    49

void ec_slave_config_init(

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

        )

    57

{

    58

    unsigned int i;

    59

    60

    sc->master = master;

    61

    sc->alias = alias;

    62

    sc->position = position;

    63

    sc->vendor_id = vendor_id;

    64

    sc->product_code = product_code;

    65

    sc->slave = NULL;

    66

    67

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

    68

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

    69

    70

    INIT_LIST_HEAD(&sc->sdo_configs);

    71

    INIT_LIST_HEAD(&sc->sdo_requests);

    72

    INIT_LIST_HEAD(&sc->voe_handlers);

    73

    74

    sc->used_fmmus = 0;

    75

}

    76

    77

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

    78

    79

/** Slave configuration destructor.

    80

 *

    81

 * Clears and frees a slave configuration object.

    82

 */

    83

void ec_slave_config_clear(

    84

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

    85

        )

    86

{

    87

    unsigned int i;

    88

    ec_sdo_request_t *req, *next_req;

    89

    ec_voe_handler_t *voe, *next_voe;

    90

    91

    ec_slave_config_detach(sc);

    92

    93

    // Free sync managers

    94

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

    95

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

    96

    97

    // free all SDO configurations

    98

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

    99

        list_del(&req->list);

   100

        ec_sdo_request_clear(req);

   101

        kfree(req);

   102

    }

   103

   104

    // free all SDO requests

   105

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

   106

        list_del(&req->list);

   107

        ec_sdo_request_clear(req);

   108

        kfree(req);

   109

    }

   110

   111

    // free all VoE handlers

   112

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

   113

        list_del(&voe->list);

   114

        ec_voe_handler_clear(voe);

   115

        kfree(voe);

   116

    }

   117

}

   118

   119

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

   120

   121

/** Prepares an FMMU configuration.

   122

 *

   123

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

   124

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

   125

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

   126

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

   127

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

   128

 * returns with success.

   129

 *

   130

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

   131

 * \retval  <0 Error code.

   132

 */

   133

int ec_slave_config_prepare_fmmu(

   134

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

   135

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

   136

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

   137

        ec_direction_t dir /**< PDO direction. */

   138

        )

   139

{

   140

    unsigned int i;

   141

    ec_fmmu_config_t *fmmu;

   142

   143

    // FMMU configuration already prepared?

   144

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

   145

        fmmu = &sc->fmmu_configs[i];

   146

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

   147

            return fmmu->logical_start_address;

   148

    }

   149

   150

    if (sc->used_fmmus == EC_MAX_FMMUS) {

   151

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

   152

                sc->alias, sc->position);

   153

        return -EOVERFLOW;

   154

    }

   155

   156

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

   157

   158

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

   159

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

   160

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

   161

   162

    return fmmu->logical_start_address;

   163

}

   164

   165

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

   166

   167

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

   168

 *

   169

 * \retval  0 Success.

   170

 * \retval <0 Error code.

   171

 */

   172

int ec_slave_config_attach(

   173

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

   174

        )

   175

{

   176

	ec_slave_t *slave;

   177

   178

	if (sc->slave)

   179

		return 0; // already attached

   180

   181

    if (!(slave = ec_master_find_slave(

   182

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

   183

        if (sc->master->debug_level)

   184

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

   185

                    sc->alias, sc->position);

   186

        return -ENOENT;

   187

    }

   188

   189

	if (slave->config) {

   190

        if (sc->master->debug_level)

   191

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

   192

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

   193

                    sc->position, slave->ring_position);

   194

        return -EEXIST;

   195

    }

   196

   197

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

   198

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

   199

        if (sc->master->debug_level)

   200

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

   201

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

   202

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

   203

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

   204

                    sc->vendor_id, sc->product_code);

   205

        return -EINVAL;

   206

	}

   207

   208

	// attach slave

   209

	slave->config = sc;

   210

	sc->slave = slave;

   211

   212

    ec_slave_request_state(slave, EC_SLAVE_STATE_OP);

   213

   214

    if (sc->master->debug_level)

   215

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

   216

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

   217

   218

	return 0;

   219

}

   220

   221

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

   222

   223

/** Detaches the configuration from a slave object.

   224

 */

   225

void ec_slave_config_detach(

   226

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

   227

        )

   228

{

   229

    if (sc->slave) {

   230

        sc->slave->config = NULL;

   231

        sc->slave = NULL;

   232

    }

   233

}

   234

   235

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

   236

   237

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

   238

 */

   239

void ec_slave_config_load_default_sync_config(ec_slave_config_t *sc)

   240

{

   241

    uint8_t sync_index;

   242

    ec_sync_config_t *sync_config;

   243

    const ec_sync_t *sync;

   244

   245

    if (!sc->slave)

   246

        return;

   247

   248

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

   249

        sync_config = &sc->sync_configs[sync_index];

   250

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

   251

            sync_config->dir = ec_sync_default_direction(sync);

   252

            if (sync_config->dir == EC_DIR_INVALID)

   253

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

   254

                        sync_index, sc->slave->ring_position);

   255

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

   256

        }

   257

    }

   258

}

   259

   260

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

   261

   262

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

   263

 */

   264

void ec_slave_config_load_default_mapping(

   265

        const ec_slave_config_t *sc,

   266

        ec_pdo_t *pdo

   267

        )

   268

{

   269

    unsigned int i;

   270

    const ec_sync_t *sync;

   271

    const ec_pdo_t *default_pdo;

   272

   273

    if (!sc->slave)

   274

        return;

   275

   276

    if (sc->master->debug_level)

   277

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

   278

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

   279

   280

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

   281

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

   282

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

   283

   284

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

   285

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

   286

                continue;

   287

   288

            if (default_pdo->name) {

   289

                if (sc->master->debug_level)

   290

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

   291

   292

                // take PDO name from assigned one

   293

                ec_pdo_set_name(pdo, default_pdo->name);

   294

            }

   295

   296

            // copy entries (= default PDO mapping)

   297

            if (ec_pdo_copy_entries(pdo, default_pdo))

   298

                return;

   299

   300

            if (sc->master->debug_level) {

   301

                const ec_pdo_entry_t *entry;

   302

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

   303

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

   304

                            entry->index, entry->subindex);

   305

                }

   306

            }

   307

   308

            return;

   309

        }

   310

    }

   311

   312

    if (sc->master->debug_level)

   313

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

   314

}

   315

   316

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

   317

   318

/** Get the number of SDO configurations.

   319

 *

   320

 * \return Number of SDO configurations.

   321

 */

   322

unsigned int ec_slave_config_sdo_count(

   323

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

   324

        )

   325

{

   326

	const ec_sdo_request_t *req;

   327

	unsigned int count = 0;

   328

   329

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

   330

		count++;

   331

	}

   332

   333

	return count;

   334

}

   335

   336

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

   337

   338

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

   339

 *

   340

 * Const version.

   341

 */

   342

const ec_sdo_request_t *ec_slave_config_get_sdo_by_pos_const(

   343

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

   344

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

   345

        )

   346

{

   347

    const ec_sdo_request_t *req;

   348

   349

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

   350

        if (pos--)

   351

            continue;

   352

        return req;

   353

    }

   354

   355

    return NULL;

   356

}

   357

   358

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

   359

   360

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

   361

 */

   362

ec_sdo_request_t *ec_slave_config_find_sdo_request(

   363

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

   364

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

   365

        )

   366

{

   367

    ec_sdo_request_t *req;

   368

   369

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

   370

        if (pos--)

   371

            continue;

   372

        return req;

   373

    }

   374

   375

    return NULL;

   376

}

   377

   378

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

   379

   380

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

   381

 */

   382

ec_voe_handler_t *ec_slave_config_find_voe_handler(

   383

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

   384

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

   385

        )

   386

{

   387

    ec_voe_handler_t *voe;

   388

   389

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

   390

        if (pos--)

   391

            continue;

   392

        return voe;

   393

    }

   394

   395

    return NULL;

   396

}

   397

   398

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

   399

 *  Realtime interface

   400

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

   401

   402

int ecrt_slave_config_sync_manager(ec_slave_config_t *sc, uint8_t sync_index,

   403

        ec_direction_t dir)

   404

{

   405

    ec_sync_config_t *sync_config;

   406

   407

    if (sc->master->debug_level)

   408

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

   409

                "dir = %u)\n", (u32) sc, sync_index, dir);

   410

   411

    if (sync_index >= EC_MAX_SYNC_MANAGERS) {

   412

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

   413

        return -ENOENT;

   414

    }

   415

   416

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

   417

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

   418

        return -EINVAL;

   419

    }

   420

   421

    sync_config = &sc->sync_configs[sync_index];

   422

    sync_config->dir = dir;

   423

    return 0;

   424

}

   425

   426

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

   427

   428

int ecrt_slave_config_pdo_assign_add(ec_slave_config_t *sc,

   429

        uint8_t sync_index, uint16_t pdo_index)

   430

{

   431

    ec_pdo_t *pdo;

   432

   433

    if (sc->master->debug_level)

   434

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

   435

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

   436

   437

    if (sync_index >= EC_MAX_SYNC_MANAGERS) {

   438

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

   439

        return -EINVAL;

   440

    }

   441

   442

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

   443

   444

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

   445

    if (IS_ERR(pdo)) {

   446

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

   447

        return PTR_ERR(pdo);

   448

    }

   449

    pdo->sync_index = sync_index;

   450

   451

    ec_slave_config_load_default_mapping(sc, pdo);

   452

   453

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

   454

    return 0;

   455

}

   456

   457

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

   458

   459

void ecrt_slave_config_pdo_assign_clear(ec_slave_config_t *sc,

   460

        uint8_t sync_index)

   461

{

   462

    if (sc->master->debug_level)

   463

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

   464

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

   465

   466

    if (sync_index >= EC_MAX_SYNC_MANAGERS) {

   467

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

   468

        return;

   469

    }

   470

   471

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

   472

    ec_pdo_list_clear_pdos(&sc->sync_configs[sync_index].pdos);

   473

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

   474

}

   475

   476

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

   477

   478

int ecrt_slave_config_pdo_mapping_add(ec_slave_config_t *sc,

   479

        uint16_t pdo_index, uint16_t entry_index, uint8_t entry_subindex,

   480

        uint8_t entry_bit_length)

   481

{

   482

    uint8_t sync_index;

   483

    ec_pdo_t *pdo = NULL;

   484

    ec_pdo_entry_t *entry;

   485

    int retval = 0;

   486

   487

    if (sc->master->debug_level)

   488

        EC_DBG("ecrt_slave_config_pdo_mapping_add(sc = 0x%x, "

   489

                "pdo_index = 0x%04X, entry_index = 0x%04X, "

   490

                "entry_subindex = 0x%02X, entry_bit_length = %u)\n",

   491

                (u32) sc, pdo_index, entry_index, entry_subindex,

   492

                entry_bit_length);

   493

   494

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

   495

        if ((pdo = ec_pdo_list_find_pdo(

   496

                        &sc->sync_configs[sync_index].pdos, pdo_index)))