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

/** \file

    35

 *

    36

 * EtherCAT Real-Time Interface.

    37

 *

    38

 * \defgroup RealtimeInterface EtherCAT Real-Time Interface

    39

 *

    40

 * EtherCAT interface for realtime modules. This interface is designed for

    41

 * realtime modules that want to use EtherCAT. There are functions to request

    42

 * a master, to map process data, to communicate with slaves via CoE and to

    43

 * configure and activate the bus.

    44

 *

    45

 * Changes in Version 1.4:

    46

 *

    47

 * - Replaced ec_slave_t with ec_slave_config_t, separating the slave objects

    48

 *   from the requested bus configuration. Therefore, renamed

    49

 *   ecrt_master_get_slave() to ecrt_master_slave_config().

    50

 * - Replaced slave address string with alias and position values. See

    51

 *   ecrt_master_slave_config().

    52

 * - Removed ecrt_master_get_slave_by_pos(), because it is no longer

    54

 * - Added ec_slave_config_state_t for the new method

    55

 *   ecrt_slave_config_state().

    56

 * - Process data memory for a domain can now be allocated externally. This

    57

 *   offers the possibility to use a shared-memory-region. Therefore,

    58

 *   added the domain methods ecrt_domain_size() and ecrt_domain_memory().

    59

 * - Replaced the process data pointers in the Pdo entry registration

    60

 *   functions with a process data offset, that is now returned by

    62

 *   domain memory. An additional advantage is, that the returned offset value

    65

 * - Replaced ecrt_slave_pdo_mapping/add/clear() with

    66

 *   ecrt_slave_config_mapping() that is now able to specify Pdo mapping and

    67

 *   Pdo configuration. Pdo entries mapped in this way can now immediately be

    68

 *   registered. The Pdo mapping and the configuration are described with the

    69

 *   new data types ec_pdo_info_t and ec_pdo_entry_info_t.

    70

 * - Renamed ec_bus_status_t, ec_master_status_t to ec_bus_state_t and

    71

 *   ec_master_state_t, respectively. Renamed ecrt_master_get_status() to

    72

 *   ecrt_master_state(), for consistency reasons.

    73

 * - Added ec_domain_state_t and ec_wc_state_t for a new output parameter

    74

 *   of ecrt_domain_state().

    75

 * - Former "Pdo registration" meant Pdo entry registration in fact, therefore

    76

 *   renamed ec_pdo_reg_t to ec_pdo_entry_reg_t and ecrt_domain_register_pdo()

    78

 * - Removed ecrt_domain_register_pdo_range(), because it's functionality can

    79

 *   be reached by specifying an explicit Pdo mapping and registering those

    80

 *   Pdo entries.

    81

 *

    82

 * @{

    83

 */

    84

    85

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

    86

    87

#ifndef __ECRT_H__

    88

#define __ECRT_H__

    89

    90

#include <asm/byteorder.h>

    91

    92

#ifdef __KERNEL__

    93

#include <linux/types.h>

    94

#else

    95

#include <stdint.h>

    96

#endif

    97

    98

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

    99

 * Global definitions

   100

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

   101

   102

/** EtherCAT real-time interface major version number.

   103

 */

   104

#define ECRT_VER_MAJOR 1

   105

   106

/** EtherCAT real-time interface minor version number.

   107

 */

   108

#define ECRT_VER_MINOR 4

   109

   110

/** EtherCAT real-time interface version word generator.

   111

 */

   112

#define ECRT_VERSION(a, b) (((a) << 8) + (b))

   113

   114

/** EtherCAT real-time interface version word.

   115

 */

   116

#define ECRT_VERSION_MAGIC ECRT_VERSION(ECRT_VER_MAJOR, ECRT_VER_MINOR)

   117

   118

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

   119

 * Data types 

   120

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

   121

   122

struct ec_master;

   123

typedef struct ec_master ec_master_t; /**< \see ec_master */

   124

   125

struct ec_slave_config;

   126

typedef struct ec_slave_config ec_slave_config_t; /**< \see ec_slave_config */

   127

   128

struct ec_domain;

   129

typedef struct ec_domain ec_domain_t; /**< \see ec_domain */

   130

   131

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

   132

   133

/** Bus state.

   134

 *

   135

 * This is used in ec_master_state_t.

   136

 */

   137

typedef enum {

   138

    EC_BUS_FAILURE = -1, /**< At least one configured slave is offline. */

   139

    EC_BUS_OK            /**< All configured slaves are online. */

   140

} ec_bus_state_t;

   141

   142

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

   143

   144

/** Master state.

   145

 *

   146

 * This is used for the output parameter of ecrt_master_state().

   147

 */

   148

typedef struct {

   149

    ec_bus_state_t bus_state; /**< \see ec_bus_state_t */

   150

    unsigned int bus_tainted; /**< Non-zero, if the bus topology differs from

   151

                                the requested configuration. */

   152

    unsigned int slaves_responding; /**< Number of slaves in the bus. */

   153

} ec_master_state_t;

   154

   155

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

   156

   157

/** Slave configuration state.

   158

 *

   159

 * \see ecrt_slave_config_state().

   160

 */

   161

typedef struct  {

   162

    unsigned int online : 1; /**< The slave is online. */

   163

    unsigned int configured : 1; /**< The slave was configured according to

   164

                                   the specified configuration. */

   165

} ec_slave_config_state_t;

   166

   167

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

   168

   169

/** Domain working counter interpretation.

   170

 *

   171

 * This is used in ec_domain_state_t.

   172

 */

   173

typedef enum {

   174

    EC_WC_ZERO = 0,   /**< No Pdos were exchanged. */

   175

    EC_WC_INCOMPLETE, /**< Some of the registered Pdos were exchanged. */

   176

    EC_WC_COMPLETE    /**< All registered Pdos were exchanged. */

   177

} ec_wc_state_t;

   178

   179

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

   180

   181

/** Domain state.

   182

 *

   183

 * This is used for the output parameter of ecrt_domain_state().

   184

 */

   185

typedef struct {

   186

    unsigned int working_counter; /**< Value of the last working counter. */

   187

    ec_wc_state_t wc_state; /**< Working counter interpretation. */

   188

} ec_domain_state_t;

   189

   190

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

   191

   192

/** Direction type for Pdo mapping functions.

   193

 */

   194

typedef enum {

   195

    EC_DIR_OUTPUT, /**< Values written by the master. */

   196

    EC_DIR_INPUT   /**< Values read by the master. */

   197

} ec_direction_t;

   198

   199

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

   200

   201

/** Pdo entry mapping.

   202

 *

   203

 * \see ecrt_slave_config_mapping().

   204

 */

   205

typedef struct {

   206

    uint16_t index; /**< Index of the Pdo entry to add to the Pdo

   207

                            configuration. */

   208

    uint8_t subindex; /**< Subindex of the Pdo entry to add to the

   209

                              Pdo configuration. */

   210

    uint8_t bit_length; /**< Size of the Pdo entry in bit. */

   211

} ec_pdo_entry_info_t;

   212

   213

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

   214

   215

/** Pdo information.

   216

 *

   217

 * \see ecrt_slave_config_mapping().

   218

 */

   219

typedef struct {

   220

    ec_direction_t dir; /**< Pdo direction (input/output). */

   221

    uint16_t index; /**< Index of the Pdo to map. */

   222

    unsigned int n_entries; /**< Number of Pdo entries for the Pdo

   223

                              configuration. Zero means, that the default Pdo

   224

                              configuration shall be used. */

   225

    const ec_pdo_entry_info_t *entries; /**< Pdo configuration array. This

   226

                                          array must contain at least \a

   227

                                          n_entries values. */

   228

} ec_pdo_info_t;

   229

   230

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

   231

   232

/** List record type for Pdo entry mass-registration.

   233

 *

   234

 * This type is used for the array parameter of the

   235

 * ecrt_domain_reg_pdo_entry_list() convenience function.

   236

 */

   237

typedef struct {

   238

    uint16_t alias; /**< Slave alias address. */

   239

    uint16_t position; /**< Slave position. */

   240

    uint32_t vendor_id; /**< Slave vendor ID. */

   241

    uint32_t product_code; /**< Slave product code. */

   242

    uint16_t index; /**< Pdo entry index. */

   243

    uint8_t subindex; /**< Pdo entry subindex. */

   244

    uint8_t *offset; /**< Pointer to a variable to store the Pdo's

   245

                       offset in the process data. */

   246

} ec_pdo_entry_reg_t;

   247

   248

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

   249

 * Global functions

   250

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

   251

   252

/** Returns the version magic of the realtime interface.

   253

 *

   254

 * \return Value of ECRT_VERSION_MAGIC() at EtherCAT master compile time.

   255

 */

   256

unsigned int ecrt_version_magic(void);

   257

   258

/** Requests an EtherCAT master for realtime operation.

   259

 * 

   260

 * \return pointer to reserved master, or NULL on error

   261

 */

   262

ec_master_t *ecrt_request_master(

   263

        unsigned int master_index /**< Index of the master to request. */

   264

        );

   265

   266

/** Releases a requested EtherCAT master.

   267

 */

   268

void ecrt_release_master(

   269

        ec_master_t *master /**< EtherCAT master */

   270

        );

   271

   272

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

   273

 * Master methods

   274

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

   275

   276

/** Sets the locking callbacks.

   277

 *

   278

 * The request_cb function must return zero, to allow another instance

   279

 * (the EoE process for example) to access the master. Non-zero means,

   280

 * that access is forbidden at this time.

   281

 */

   282

void ecrt_master_callbacks(

   283

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

   284

        int (*request_cb)(void *), /**< Lock request function. */

   285

        void (*release_cb)(void *), /**< Lock release function. */

   286

        void *cb_data /**< Arbitrary user data. */

   287

        );

   288

   289

/** Creates a new domain.

   290

 *

   291

 * \return Pointer to the new domain on success, else NULL.

   292

 */

   293

ec_domain_t *ecrt_master_create_domain(

   294

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

   295

        );

   296

   297

/** Obtains a slave configuration.

   298

 *

   299

 * Creates a slave configuration object for the given \a alias and \a position

   300

 * tuple and returns it. If a configuration with the same \a alias and \a

   301

 * position already exists, it will be re-used. In the latter case, the given

   302

 * vendor ID and product code are compared to the stored ones. On mismatch, an

   303

 * error message is raised and the function returns \a NULL.

   304

 *

   305

 * Slaves are addressed with the \a alias and \a position parameters.

   306

 * - If \a alias is zero, \a position is interpreted as the desired slave's

   307

 *   ring position.

   308

 * - If \a alias is non-zero, it matches a slave with the given alias. In this

   309

 *   case, \a position is interpreted as ring offset, starting from the

   310

 *   aliased slave, so a position of zero means the aliased slave itself and a

   311

 *   positive value matches the n-th slave behind the aliased one.

   312

 *

   313

 * If the slave with the given address is found during the bus configuration,

   314

 * its vendor ID and product code are matched against the given value. On

   315

 * mismatch, the slave is not configured and an error message is raised.

   316

 *

   317

 * If different slave configurations are pointing to the same slave during bus

   318

 * configuration, a warning is raised and only the first configuration is

   319

 * applied.

   320

 *

   321

 * \retval >0 Pointer to the slave configuration structure.

   322

 * \retval NULL in the error case.

   323

 */

   324

ec_slave_config_t *ecrt_master_slave_config(

   325

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

   326

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

   327

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

   328

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

   329

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

   330

        );

   331

   332

/** Applies the bus configuration and switches to realtime mode.

   333

 *

   334

 * Does the complete configuration and activation for all slaves. Sets sync

   335

 * managers and FMMUs, and does the appropriate transitions, until the slave

   336

 * is operational.

   337

 *

   338

 * \return 0 in case of success, else < 0

   339

 */

   340

int ecrt_master_activate(

   341

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

   342

        );

   343

   344

/** Sends all datagrams in the queue.

   345

 *

   346

 * \todo doc

   347

 */

   348

void ecrt_master_send(

   349

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

   350

        );

   351

   352

/** Fetches received frames from the hardware and processes the datagrams.

   353

 */

   354

void ecrt_master_receive(

   355

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

   356

        );

   357

   358

/** Reads the current master state.

   359

 *

   360

 * Stores the master state information in the given \a state structure.

   361

 */

   362

void ecrt_master_state(

   363

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

   364

        ec_master_state_t *state /**< Structure to store the information. */

   365

        );

   366

   367

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

   368

 * Slave configuration methods

   369

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

   370

   371

/** Specify the Pdo mapping and (optionally) the Pdo configuration.

   372

 *

   373

 * The following example shows, how to specify a complete Pdo mapping

   374

 * including the Pdo configuration. With this information, the master is able

   375

 * to reserve the complete process data, even if the slave is not present

   376

 * at configuration time:

   377

 *

   378

 * \code

   379

 * const ec_pdo_info_t complete_mapping[] = {

   380

 *     {EC_DIR_INPUT, 0x1600, 2, { // channel 1

   381

 *         {0x7000, 0, 16}, // value

   382

 *         {0x7000, 1, 8},  // status

   383

 *     }},

   384

 *     {EC_DIR_INPUT, 0x1601, 2, { // channel 2 

   385

 *         {0x7001, 0, 16}, // value

   386

 *         {0x7001, 1, 8},  // status

   387

 *     }}

   388

 * };

   389

 * 

   390

 * if (ecrt_slave_config_mapping(slave_config_ana_in, 2, complete_mapping)) {

   391

 *     // error

   392

 * }

   393

 * \endcode

   394

 *

   395

 * The next example shows, how to configure only the Pdo mapping. The entries

   396

 * for each mapped Pdo are taken from the default Pdo configuration. Please

   397

 * note, that Pdo entry registration will fail, if no Pdo configuration is

   398

 * specified and the slave is offline.

   399

 *

   400

 * \code

   401

 * const ec_pdo_info_t pdo_mapping[] = {

   402

 *     {EC_DIR_INPUT, 0x1600}, // Channel 1

   403

 *     {EC_DIR_INPUT, 0x1601}  // Channel 2

   404

 * };

   405

 * 

   406

 * if (ecrt_slave_config_mapping(slave_config_ana_in, 2, pdo_mapping)) {

   407

 *     // error

   408

 * }

   409

 * \endcode

   410

 *

   411

 * \return zero on success, else non-zero

   412

 */

   413

int ecrt_slave_config_mapping(

   414

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

   415

        unsigned int n_entries, /**< Number of Pdos in \a pdos to map. */

   416

        const ec_pdo_info_t pdos[] /**< List with Pdo mapping. */

   417

        );

   418

   436

/** Add a configuration value for an 8-bit SDO.

   437

 *

   438

 * \todo doc

   439

 * \return 0 in case of success, else < 0

   440

 */

   441

int ecrt_slave_config_sdo8(

   442

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

   443

        uint16_t sdo_index, /**< Index of the SDO to configure. */

   444

        uint8_t sdo_subindex, /**< Subindex of the SDO to configure. */

   445

        uint8_t value /**< Value to set. */

   446

        );

   447

   448

/** Add a configuration value for a 16-bit SDO.

   449

 *

   450

 * \todo doc

   451

 * \return 0 in case of success, else < 0

   452

 */

   453

int ecrt_slave_config_sdo16(

   454

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

   455

        uint16_t sdo_index, /**< Index of the SDO to configure. */

   456

        uint8_t sdo_subindex, /**< Subindex of the SDO to configure. */

   457

        uint16_t value /**< Value to set. */

   458

        );

   459

   460

/** Add a configuration value for a 32-bit SDO.

   461

 *

   462

 * \todo doc

   463

 * \return 0 in case of success, else < 0

   464

 */

   465

int ecrt_slave_config_sdo32(

   466

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

   467

        uint16_t sdo_index, /**< Index of the SDO to configure. */

   468

        uint8_t sdo_subindex, /**< Subindex of the SDO to configure. */

   469

        uint32_t value /**< Value to set. */

   470

        );

   471

   472

/** Outputs the state of the slave configuration.

   473

 *

   474

 * Stores the state information in the given \a state structure.

   475

 */

   476

void ecrt_slave_config_state(

   477

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

   478

        ec_slave_config_state_t *state /**< State object to write to. */

   479

        );

   480

   481

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

   482

 * Domain methods

   483

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

   484

   485

/** Registers a bunch of Pdo entries for a domain.

   486

 *

   487

 * \todo doc

   488

 * \attention The registration array has to be terminated with an empty

   489

 *            structure, or one with the \a index field set to zero!

   490

 * \return 0 on success, else non-zero.

   491

 */

   492

int ecrt_domain_reg_pdo_entry_list(

   493

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