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

    53

 *   necessary due to alias/position addressing.

    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

    59

 *   ecrt_domain_external_memory().

    60

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

    61

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

    62

 *   ecrt_slave_config_reg_pdo_entry(). This was necessary for the external

    63

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

    64

 *   is directly usable. If the domain's process data is allocated internally,

    65

 *   the start address can be retrieved with ecrt_domain_data().

    66

 * - Replaced ecrt_slave_pdo_mapping/add/clear() with

    67

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

    68

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

    69

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

    70

 *   new data types ec_pdo_info_t and ec_pdo_entry_info_t.

    71

 * - Renamed ec_bus_status_t, ec_master_status_t to ec_bus_state_t and

    72

 *   ec_master_state_t, respectively. Renamed ecrt_master_get_status() to

    73

 *   ecrt_master_state(), for consistency reasons.

    74

 * - Added ec_domain_state_t and ec_wc_state_t for a new output parameter

    75

 *   of ecrt_domain_state().

    76

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

    77

 *   renamed ec_pdo_reg_t to ec_pdo_entry_reg_t and ecrt_domain_register_pdo()

    78

 *   to ecrt_slave_config_reg_pdo_entry().

    79

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

    80

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

    81

 *   Pdo entries.

    82

 *

    83

 * @{

    84

 */

    85

    86

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

    87

    88

#ifndef __ECRT_H__

    89

#define __ECRT_H__

    90

    91

#include <asm/byteorder.h>

    92

    93

#ifdef __KERNEL__

    94

#include <linux/types.h>

    95

#else

    96

#include <stdint.h>

    97

#endif

    98

    99

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

   100

 * Global definitions

   101

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

   102

   103

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

   104

 */

   105

#define ECRT_VER_MAJOR 1

   106

   107

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

   108

 */

   109

#define ECRT_VER_MINOR 4

   110

   111

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

   112

 */

   113

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

   114

   115

/** EtherCAT real-time interface version word.

   116

 */

   117

#define ECRT_VERSION_MAGIC ECRT_VERSION(ECRT_VER_MAJOR, ECRT_VER_MINOR)

   118

   119

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

   120

 * Data types 

   121

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

   122

   123

struct ec_master;

   124

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

   125

   126

struct ec_slave_config;

   127

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

   128

   129

struct ec_domain;

   130

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

   131

   132

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

   133

   134

/** Bus state.

   135

 *

   136

 * This is used in ec_master_state_t.

   137

 */

   138

typedef enum {

   139

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

   140

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

   141

} ec_bus_state_t;

   142

   143

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

   144

   145

/** Master state.

   146

 *

   147

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

   148

 */

   149

typedef struct {

   150

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

   151

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

   152

                                the requested configuration. */

   153

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

   154

} ec_master_state_t;

   155

   156

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

   157

   158

/** Slave configuration state.

   159

 *

   160

 * \see ecrt_slave_config_state().

   161

 */

   162

typedef struct  {

   163

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

   164

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

   165

                                   the specified configuration. */

   166

} ec_slave_config_state_t;

   167

   168

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

   169

   170

/** Domain working counter interpretation.

   171

 *

   172

 * This is used in ec_domain_state_t.

   173

 */

   174

typedef enum {

   175

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

   176

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

   177

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

   178

} ec_wc_state_t;

   179

   180

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

   181

   182

/** Domain state.

   183

 *

   184

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

   185

 */

   186

typedef struct {

   187

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

   188

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

   189

} ec_domain_state_t;

   190

   191

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

   192

   193

/** Direction type for Pdo mapping functions.

   194

 */

   195

typedef enum {

   196

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

   197

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

   198

} ec_direction_t;

   199

   200

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

   201

   202

/** Pdo entry mapping.

   203

 *

   204

 * \see ecrt_slave_config_mapping().

   205

 */

   206

typedef struct {

   207

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

   208

                            configuration. */

   209

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

   210

                              Pdo configuration. */

   211

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

   212

} ec_pdo_entry_info_t;

   213

   214

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

   215

   216

/** Pdo information.

   217

 *

   218

 * \see ecrt_slave_config_mapping().

   219

 */

   220

typedef struct {

   221

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

   222

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

   223

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

   224

                              configuration. Zero means, that the default Pdo

   225

                              configuration shall be used. */

   226

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

   227

                                          array must contain at least \a

   228

                                          n_entries values. */

   229

} ec_pdo_info_t;

   230

   231

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

   232

   233

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

   234

 *

   235

 * This type is used for the array parameter of the

   236

 * ecrt_domain_reg_pdo_entry_list() convenience function.

   237

 */

   238

typedef struct {

   239

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

   240

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

   241

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

   242

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

   243

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

   244

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

   245

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

   246

                       offset in the process data. */

   247

} ec_pdo_entry_reg_t;

   248

   249

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

   250

 * Global functions

   251

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

   252

   253

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

   254

 *

   255

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

   256

 */

   257

unsigned int ecrt_version_magic(void);

   258

   259

/** Requests an EtherCAT master for realtime operation.

   260

 * 

   261

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

   262

 */

   263

ec_master_t *ecrt_request_master(

   264

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

   265

        );

   266

   267

/** Releases a requested EtherCAT master.

   268

 */

   269

void ecrt_release_master(

   270

        ec_master_t *master /**< EtherCAT master */

   271

        );

   272

   273

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

   274

 * Master methods

   275

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

   276

   277

/** Sets the locking callbacks.

   278

 *

   279

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

   280

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

   281

 * that access is forbidden at this time.

   282

 */

   283

void ecrt_master_callbacks(

   284

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

   285

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

   286

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

   287

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

   288

        );

   289

   290

/** Creates a new domain.

   291

 *

   292

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

   293

 */

   294

ec_domain_t *ecrt_master_create_domain(

   295

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

   296

        );

   297

   298

/** Obtains a slave configuration.

   299

 *

   300

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

   301

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

   302

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

   303

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

   304

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

   305

 *

   306

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

   307

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

   308

 *   ring position.

   309

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

   310

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

   311

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

   312

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

   313

 *

   314

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

   315

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

   316

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

   317

 *

   318

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

   319

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

   320

 * applied.

   321

 *

   322

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

   323

 * \retval NULL in the error case.

   324

 */

   325

ec_slave_config_t *ecrt_master_slave_config(

   326

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

   327

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

   328

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

   329

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

   330

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

   331

        );

   332

   333

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

   334

 *

   335

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

   336

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

   337

 * is operational.

   338

 *

   339

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

   340

 */

   341

int ecrt_master_activate(

   342

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

   343

        );

   344

   345

/** Sends all datagrams in the queue.

   346

 *

   347

 * \todo doc

   348

 */

   349

void ecrt_master_send(

   350

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

   351

        );

   352

   353

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

   354

 */

   355

void ecrt_master_receive(

   356

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

   357

        );

   358

   359

/** Reads the current master state.

   360

 *

   361

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

   362

 */

   363

void ecrt_master_state(

   364

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

   365

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

   366

        );

   367

   368

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

   369

 * Slave configuration methods

   370

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

   371

   372

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

   373

 *

   374

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

   375

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

   376

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

   377

 * at configuration time:

   378

 *

   379

 * \code

   380

 * const ec_pdo_info_t complete_mapping[] = {

   381

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

   382

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

   383

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

   384

 *     }},

   385

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

   386

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

   387

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

   388

 *     }}

   389

 * };

   390

 * 

   391

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

   392

 *     // error

   393

 * }

   394

 * \endcode

   395

 *

   396

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

   397

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

   398

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

   399

 * specified and the slave is offline.

   400

 *

   401

 * \code

   402

 * const ec_pdo_info_t pdo_mapping[] = {

   403

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

   404

 *     {EC_DIR_INPUT, 0x1601}  // Channel 2

   405

 * };

   406

 * 

   407

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

   408

 *     // error

   409

 * }

   410

 * \endcode

   411

 *

   412

 * \return zero on success, else non-zero

   413

 */

   414

int ecrt_slave_config_mapping(

   415

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

   416

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

   417

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

   418

        );

   419

   420

/** Registers a Pdo entry of the given slave configuration at a domain.

   421

 *

   422

 * Searches the mapping and the Pdo configurations for the given Pdo entry. If

   423

 * found, the curresponding sync manager/FMMU is added to the domain and the

   424

 * offset of the Pdo entry's data in the domain process data is returned.

   425

 *

   426

 * \retval >=0 Offset of the Pdo entry's process data.

   427

 * \retval -1  Pdo entry not found.

   428

 * \retval -2  Failed to register Pdo entry.

   429

 */

   430

int ecrt_slave_config_reg_pdo_entry(

   431

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

   432

        uint16_t entry_index, /**< Index of the Pdo entry to register. */

   433

        uint8_t entry_subindex, /**< Subindex of the Pdo entry to register. */

   434

        ec_domain_t *domain /**< Domain. */

   435

        );

   436

   437

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

   438

 *

   439

 * \todo doc

   440

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

   441

 */

   442

int ecrt_slave_config_sdo8(

   443

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

   444

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

   445

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

   446

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

   447

        );

   448

   449

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

   450

 *

   451

 * \todo doc

   452

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

   453

 */

   454

int ecrt_slave_config_sdo16(

   455

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

   456

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

   457

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

   458

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

   459

        );

   460

   461

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

   462

 *

   463

 * \todo doc

   464

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

   465

 */

   466

int ecrt_slave_config_sdo32(

   467

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

   468

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

   469

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

   470

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

   471

        );

   472

   473

/** Outputs the state of the slave configuration.

   474

 *

   475

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

   476

 */

   477

void ecrt_slave_config_state(

   478

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

   479

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

   480

        );

   481

   482

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

   483

 * Domain methods

   484

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

   485

   486

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

   487

 *

   488

 * \todo doc

   489

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

   490

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

   491

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

   492

 */

   493