1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006  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

    10

 *  and/or modify it under the terms of the GNU General Public License

    11

 *  as published by the Free Software Foundation; either version 2 of the

    12

 *  License, or (at your option) any later version.

    13

 *

    14

 *  The IgH EtherCAT Master is distributed in the hope that it will be

    15

 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of

    16

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    17

 *  GNU General Public License for more details.

    18

 *

    19

 *  You should have received a copy of the GNU General Public License

    20

 *  along with the IgH EtherCAT Master; if not, write to the Free Software

    21

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    22

 *

    23

 *  The right to use EtherCAT Technology is granted and comes free of

    24

 *  charge under condition of compatibility of product made by

    25

 *  Licensee. People intending to distribute/sell products based on the

    26

 *  code, have to sign an agreement to guarantee that products using

    27

 *  software based on IgH EtherCAT master stay compatible with the actual

    28

 *  EtherCAT specification (which are released themselves as an open

    29

 *  standard) as the (only) precondition to have the right to use EtherCAT

    30

 *  Technology, IP and trade marks.

    31

 *

    32

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

    33

    34

/**

    35

   \file

    36

   EtherCAT slave configuration methods.

    37

*/

    38

    39

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

    40

    41

#include <linux/slab.h>

    42

    43

#include "globals.h"

    44

#include "master.h"

    45

#include "voe_handler.h"

    46

    47

#include "slave_config.h"

    48

    49

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

    50

    51

/** Slave configuration constructor.

    52

 *

    53

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

    54

 * position parameters.

    55

 */

    56

void ec_slave_config_init(

    57

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

    58

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

    59

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

    60

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

    61

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

    62

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

    63

        )

    64

{

    65

    unsigned int i;

    66

    67

    sc->master = master;

    68

    sc->alias = alias;

    69

    sc->position = position;

    70

    sc->vendor_id = vendor_id;

    71

    sc->product_code = product_code;

    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

    INIT_LIST_HEAD(&sc->sdo_configs);

    78

    INIT_LIST_HEAD(&sc->sdo_requests);

    79

    INIT_LIST_HEAD(&sc->voe_handlers);

    80

    81

    sc->used_fmmus = 0;

    82

}

    83

    84

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

    85

    86

/** Slave configuration destructor.

    87

 *

    88

 * Clears and frees a slave configuration object.

    89

 */

    90

void ec_slave_config_clear(

    91

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

    92

        )

    93

{

    94

    unsigned int i;

    95

    ec_sdo_request_t *req, *next_req;

    96

    ec_voe_handler_t *voe, *next_voe;

    97

    98

    ec_slave_config_detach(sc);

    99

   100

    // Free sync managers

   101

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

   102

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

   103

   104

    // free all Sdo configurations

   105

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

   106

        list_del(&req->list);

   107

        ec_sdo_request_clear(req);

   108

        kfree(req);

   109

    }

   110

   111

    // free all Sdo requests

   112

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

   113

        list_del(&req->list);

   114

        ec_sdo_request_clear(req);

   115

        kfree(req);

   116

    }

   117

   118

    // free all VoE handlers

   119

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

   120

        list_del(&voe->list);

   121

        ec_voe_handler_clear(voe);

   122

        kfree(voe);

   123

    }

   124

}

   125

   126

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

   127

   128

/** Prepares an FMMU configuration.

   129

 *

   130

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

   131

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

   132

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

   133

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

   134

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

   135

 * returns with success.

   136

 *

   137

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

   138

 * \retval  <0 Error code.

   139

 */

   140

int ec_slave_config_prepare_fmmu(

   141

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

   142

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

   143

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

   144

        ec_direction_t dir /**< Pdo direction. */

   145

        )

   146

{

   147

    unsigned int i;

   148

    ec_fmmu_config_t *fmmu;

   149

   150

    // FMMU configuration already prepared?

   151

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

   152

        fmmu = &sc->fmmu_configs[i];

   153

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

   154

            return fmmu->logical_start_address;

   155

    }

   156

   157

    if (sc->used_fmmus == EC_MAX_FMMUS) {

   158

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

   159

                sc->alias, sc->position);

   160

        return -EOVERFLOW;

   161

    }

   162

   163

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

   164

   165

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

   166

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

   167

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

   168

   169

    return fmmu->logical_start_address;

   170

}

   171

   172

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

   173

   174

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

   175

 *

   176

 * \retval  0 Success.

   177

 * \retval <0 Error code.

   178

 */

   179

int ec_slave_config_attach(

   180

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

   181

        )

   182

{

   183

	ec_slave_t *slave;

   184

   185

	if (sc->slave)

   186

		return 0; // already attached

   187

   188

    if (!(slave = ec_master_find_slave(

   189

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

   190

        if (sc->master->debug_level)

   191

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

   192

                    sc->alias, sc->position);

   193

        return -ENOENT;

   194

    }

   195

   196

	if (slave->config) {

   197

        if (sc->master->debug_level)

   198

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

   199

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

   200

                    sc->position, slave->ring_position);

   201

        return -EEXIST;

   202

    }

   203

   204

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

   205

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

   206

        if (sc->master->debug_level)

   207

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

   208

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

   209

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

   210

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

   211

                    sc->vendor_id, sc->product_code);

   212

        return -EINVAL;

   213

	}

   214

   215

	// attach slave

   216

	slave->config = sc;

   217

	sc->slave = slave;

   218

   219

    ec_slave_request_state(slave, EC_SLAVE_STATE_OP);

   220

   221

    if (sc->master->debug_level)

   222

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

   223

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

   224

   225

	return 0;

   226

}

   227

   228

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

   229

   230

/** Detaches the configuration from a slave object.

   231

 */

   232

void ec_slave_config_detach(

   233

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

   234

        )

   235

{

   236

    if (sc->slave) {

   237

        sc->slave->config = NULL;

   238

        sc->slave = NULL;

   239

    }

   240

}

   241

   242

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

   243

   244

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

   245

 */

   246

void ec_slave_config_load_default_sync_config(ec_slave_config_t *sc)

   247

{

   248

    uint8_t sync_index;

   249

    ec_sync_config_t *sync_config;

   250

    const ec_sync_t *sync;

   251

   252

    if (!sc->slave)

   253

        return;

   254

   255

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

   256

        sync_config = &sc->sync_configs[sync_index];

   257

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

   258

            sync_config->dir = ec_sync_default_direction(sync);

   259

            if (sync_config->dir == EC_DIR_INVALID)

   260

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

   261

                        sync_index, sc->slave->ring_position);

   262

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

   263

        }

   264

    }

   265

}

   266

   267

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

   268

   269

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

   270

 */

   271

void ec_slave_config_load_default_mapping(

   272

        const ec_slave_config_t *sc,

   273

        ec_pdo_t *pdo

   274

        )

   275

{

   276

    unsigned int i;

   277

    const ec_sync_t *sync;

   278

    const ec_pdo_t *default_pdo;

   279

   280

    if (!sc->slave)

   281

        return;

   282

   283

    if (sc->master->debug_level)

   284

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

   285

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

   286

   287

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

   288

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

   289

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

   290

   291

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

   292

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

   293

                continue;

   294

   295

            if (default_pdo->name) {

   296

                if (sc->master->debug_level)

   297

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

   298

   299

                // take Pdo name from assigned one

   300

                ec_pdo_set_name(pdo, default_pdo->name);

   301

            }

   302

   303

            // copy entries (= default Pdo mapping)

   304

            if (ec_pdo_copy_entries(pdo, default_pdo))

   305

                return;

   306

   307

            if (sc->master->debug_level) {

   308

                const ec_pdo_entry_t *entry;

   309

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

   310

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

   311

                            entry->index, entry->subindex);

   312

                }

   313

            }

   314

   315

            return;

   316

        }

   317

    }

   318

   319

    if (sc->master->debug_level)

   320

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

   321

}

   322

   323

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

   324

   325

/** Get the number of Sdo configurations.

   326

 *

   327

 * \return Number of Sdo configurations.

   328

 */

   329

unsigned int ec_slave_config_sdo_count(

   330

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

   331

        )

   332

{

   333

	const ec_sdo_request_t *req;

   334

	unsigned int count = 0;

   335

   336

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

   337

		count++;

   338

	}

   339

   340

	return count;

   341

}

   342

   343

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

   344

   345

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

   346

 *

   347

 * Const version.

   348

 */

   349

const ec_sdo_request_t *ec_slave_config_get_sdo_by_pos_const(

   350

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

   351

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

   352

        )

   353

{

   354

    const ec_sdo_request_t *req;

   355

   356

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

   357

        if (pos--)

   358

            continue;

   359

        return req;

   360

    }

   361

   362

    return NULL;

   363

}

   364

   365

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

   366

   367

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

   368

 */

   369

ec_voe_handler_t *ec_slave_config_find_voe_handler(

   370

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

   371

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

   372

        )

   373

{

   374

    ec_voe_handler_t *voe;

   375

   376

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

   377

        if (pos--)

   378

            continue;

   379

        return voe;

   380

    }

   381

   382

    return NULL;

   383

}

   384

   385

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

   386

 *  Realtime interface

   387

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

   388

   389

int ecrt_slave_config_sync_manager(ec_slave_config_t *sc, uint8_t sync_index,

   390

        ec_direction_t dir)

   391

{

   392

    ec_sync_config_t *sync_config;

   393

   394

    if (sc->master->debug_level)

   395

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

   396

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

   397

   398

    if (sync_index >= EC_MAX_SYNC_MANAGERS) {

   399

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

   400

        return -ENOENT;

   401

    }

   402

   403

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

   404

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

   405

        return -EINVAL;

   406

    }

   407

   408

    sync_config = &sc->sync_configs[sync_index];

   409

    sync_config->dir = dir;

   410

    return 0;

   411

}

   412

   413

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

   414

   415

int ecrt_slave_config_pdo_assign_add(ec_slave_config_t *sc,

   416

        uint8_t sync_index, uint16_t pdo_index)

   417

{

   418

    ec_pdo_t *pdo;

   419

   420

    if (sc->master->debug_level)

   421

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

   422

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

   423

   424

    if (sync_index >= EC_MAX_SYNC_MANAGERS) {

   425

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

   426

        return -EINVAL;

   427

    }

   428

   429

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

   430

   431

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

   432

    if (IS_ERR(pdo)) {

   433

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

   434

        return PTR_ERR(pdo);

   435

    }

   436

    pdo->sync_index = sync_index;

   437

   438

    ec_slave_config_load_default_mapping(sc, pdo);

   439

   440

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

   441

    return 0;

   442

}

   443

   444

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

   445

   446

void ecrt_slave_config_pdo_assign_clear(ec_slave_config_t *sc,

   447

        uint8_t sync_index)

   448

{

   449

    if (sc->master->debug_level)

   450

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

   451

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

   452

   453

    if (sync_index >= EC_MAX_SYNC_MANAGERS) {

   454

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

   455

        return;

   456

    }

   457

   458

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

   459

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

   460

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

   461

}

   462

   463

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

   464

   465

int ecrt_slave_config_pdo_mapping_add(ec_slave_config_t *sc,

   466

        uint16_t pdo_index, uint16_t entry_index, uint8_t entry_subindex,

   467

        uint8_t entry_bit_length)

   468

{

   469

    uint8_t sync_index;

   470

    ec_pdo_t *pdo = NULL;

   471

    ec_pdo_entry_t *entry;

   472

    int retval = 0;

   473

   474

    if (sc->master->debug_level)

   475

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

   476

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

   477

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

   478

                (u32) sc, pdo_index, entry_index, entry_subindex,

   479

                entry_bit_length);

   480

   481

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

   482

        if ((pdo = ec_pdo_list_find_pdo(

   483

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

   484

            break;

   485

   486

    if (pdo) {

   487

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

   488

        entry = ec_pdo_add_entry(pdo, entry_index, entry_subindex,

   489

                entry_bit_length);

   490

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

   491

        if (IS_ERR(entry))

   492

            retval = PTR_ERR(entry);

   493

    } else {

   494

        EC_ERR("Pdo 0x%04X is not assigned in config %u:%u.\n",

   495

                pdo_index, sc->alias, sc->position);

   496

        retval = -ENOENT; 

   497

    }

   498