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 Realtime Interface.

    37

 *

    38

 * \defgroup RealtimeInterface EtherCAT Realtime Interface

    39

 *

    40

 * EtherCAT interface for realtime applications. This interface is designed

    41

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

    42

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

    43

 * and to 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().

    67

 * - Replaced ecrt_slave_pdo_mapping/add/clear() with

    68

 *   ecrt_slave_config_pdo_assign_add() to add a Pdo to a sync manager's Pdo

    69

 *   assignment and ecrt_slave_config_pdo_mapping_add() to add a Pdo entry to a

    70

 *   Pdo's mapping. ecrt_slave_config_pdos() is a convenience function

    71

 *   for both, that uses the new data types ec_pdo_info_t and

    72

 *   ec_pdo_entry_info_t. Pdo entries, that are mapped with these functions

    73

 *   can now immediately be registered, even if the bus is offline.

    74

 * - Renamed ec_bus_status_t, ec_master_status_t to ec_bus_state_t and

    75

 *   ec_master_state_t, respectively. Renamed ecrt_master_get_status() to

    76

 *   ecrt_master_state(), for consistency reasons.

    77

 * - Added ec_domain_state_t and ec_wc_state_t for a new output parameter

    78

 *   of ecrt_domain_state(). The domain state object does now contain

    79

 *   information, if the process data was exchanged completely.

    80

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

    81

 *   renamed ec_pdo_reg_t to ec_pdo_entry_reg_t and ecrt_domain_register_pdo()

    82

 *   to ecrt_slave_config_reg_pdo_entry().

    83

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

    84

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

    85

 *   Pdo entries.

    86

 * - Added an Sdo access interface, working with Sdo requests. These can be

    87

 *   scheduled for reading and writing during realtime operation.

    88

 * - Exported ecrt_slave_config_sdo(), the generic Sdo configuration function.

    89

 * - Removed the bus_state and bus_tainted flags from ec_master_state_t.

    90

 *

    91

 * @{

    92

 */

    93

    94

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

    95

    96

#ifndef __ECRT_H__

    97

#define __ECRT_H__

    98

    99

#include <asm/byteorder.h>

   100

   101

#ifdef __KERNEL__

   102

#include <linux/types.h>

   103

#else

   104

#include <stdint.h>

   105

#endif

   106

   107

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

   108

 * Global definitions

   109

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

   110

   111

/** EtherCAT realtime interface major version number.

   112

 */

   113

#define ECRT_VER_MAJOR 1

   114

   115

/** EtherCAT realtime interface minor version number.

   116

 */

   117

#define ECRT_VER_MINOR 4

   118

   119

/** EtherCAT realtime interface version word generator.

   120

 */

   121

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

   122

   123

/** EtherCAT realtime interface version word.

   124

 */

   125

#define ECRT_VERSION_MAGIC ECRT_VERSION(ECRT_VER_MAJOR, ECRT_VER_MINOR)

   126

   127

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

   128

   129

/** End of the Pdo list.

   130

 *

   131

 * This is used in ecrt_slave_config_pdos().

   132

 */

   133

#define EC_END ~0U

   134

   135

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

   136

 * Data types 

   137

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

   138

   139

struct ec_master;

   140

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

   141

   142

struct ec_slave_config;

   143

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

   144

   145

struct ec_domain;

   146

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

   147

   148

struct ec_sdo_request;

   149

typedef struct ec_sdo_request ec_sdo_request_t; /**< \see ec_sdo_request. */

   150

   151

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

   152

   153

/** Master state.

   154

 *

   155

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

   156

 */

   157

typedef struct {

   158

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

   159

} ec_master_state_t;

   160

   161

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

   162

   163

/** Slave configuration state.

   164

 *

   165

 * \see ecrt_slave_config_state().

   166

 */

   167

typedef struct  {

   168

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

   169

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

   170

                                   the specified configuration. */

   171

} ec_slave_config_state_t;

   172

   173

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

   174

   175

/** Domain working counter interpretation.

   176

 *

   177

 * This is used in ec_domain_state_t.

   178

 */

   179

typedef enum {

   180

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

   181

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

   182

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

   183

} ec_wc_state_t;

   184

   185

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

   186

   187

/** Domain state.

   188

 *

   189

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

   190

 */

   191

typedef struct {

   192

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

   193

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

   194

} ec_domain_state_t;

   195

   196

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

   197

   198

/** Direction type for Pdo mapping functions.

   199

 */

   200

typedef enum {

   201

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

   202

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

   203

} ec_direction_t;

   204

   205

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

   206

   207

/** Pdo entry information.

   208

 *

   209

 * This can be used to map multiple Pdo entries into a given Pdo using

   210

 * ecrt_slave_config_pdos().

   211

 */

   212

typedef struct {

   213

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

   214

                            configuration. */

   215

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

   216

                              Pdo configuration. */

   217

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

   218

} ec_pdo_entry_info_t;

   219

   220

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

   221

   222

/** Pdo information.

   223

 *

   224

 * This can be use to assign multiple Pdos to a sync manager using

   225

 * ecrt_slave_config_pdos().

   226

 */

   227

typedef struct {

   228

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

   229

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

   230

    unsigned int n_entries; /**< Number of Pdo entries in \a entries to map.

   231

                              Zero means, that the default mapping shall be

   232

                              used. */

   233

    ec_pdo_entry_info_t *entries; /**< Array of Pdo entries to map. This must

   234

                                    contain at least \a n_entries values. */

   235

} ec_pdo_info_t;

   236

   237

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

   238

   239

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

   240

 *

   241

 * This type is used for the array parameter of the

   243

 */

   244

typedef struct {

   245

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

   246

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

   247

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

   248

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

   249

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

   250

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

   251

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

   252

                       offset in the process data. This can either be byte-

   253

                       or bitwise, depending on whether

   259

} ec_pdo_entry_reg_t;

   260

   261

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

   262

   263

/** Sdo request state.

   264

 *

   265

 * This is used as return type of ecrt_sdo_request_state().

   266

 */

   267

typedef enum {

   268

    EC_SDO_REQUEST_UNUSED, /**< Not requested. */

   269

    EC_SDO_REQUEST_BUSY, /**< Request is being processed. */

   270

    EC_SDO_REQUEST_SUCCESS, /**< Request was processed successfully. */

   271

    EC_SDO_REQUEST_ERROR, /**< Request processing failed. */

   272

} ec_sdo_request_state_t;

   273

   274

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

   275

 * Global functions

   276

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

   277

   278

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

   279

 *

   280

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

   281

 */

   282

unsigned int ecrt_version_magic(void);

   283

   284

/** Requests an EtherCAT master for realtime operation.

   285

 * 

   286

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

   287

 */

   288

ec_master_t *ecrt_request_master(

   289

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

   290

        );

   291

   292

/** Releases a requested EtherCAT master.

   293

 */

   294

void ecrt_release_master(

   295

        ec_master_t *master /**< EtherCAT master */

   296

        );

   297

   298

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

   299

 * Master methods

   300

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

   301

   302

/** Sets the locking callbacks.

   303

 *

   304

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

   305

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

   306

 * that access is forbidden at this time.

   307

 */

   308

void ecrt_master_callbacks(

   309

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

   310

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

   311

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

   312

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

   313

        );

   314

   315

/** Creates a new domain.

   316

 *

   317

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

   318

 */

   319

ec_domain_t *ecrt_master_create_domain(

   320

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

   321

        );

   322

   323

/** Obtains a slave configuration.

   324

 *

   325

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

   326

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

   327

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

   328

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

   329

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

   330

 *

   331

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

   332

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

   333

 *   ring position.

   334

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

   335

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

   336

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

   337

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

   338

 *

   339

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

   340

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

   341

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

   342

 *

   343

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

   344

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

   345

 * applied.

   346

 *

   347

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

   348

 * \retval NULL in the error case.

   349

 */

   350

ec_slave_config_t *ecrt_master_slave_config(

   351

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

   352

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

   353

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

   354

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

   355

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

   356

        );

   357

   358

/** Finishes the configuration phase and prepares for realtime mode.

   359

 *

   360

 * This function has to be called after all Pdo entries are registered. It

   361

 * tells the master that the configuration phase is finished and the realtime

   362

 * operation will begin. The function allocates internal memory for the

   363

 * domains and calculates the logical FMMU addresses for domain members. It

   364

 * tells the master state machine that the bus configuration is now to be

   365

 * applied.

   366

 *

   367

 * \attention After this function has been called, the realtime application is

   368

 * in charge of cyclically calling ecrt_master_send() and

   369

 * ecrt_master_receive() to ensure bus communication. Before calling this

   370

 * function, the master thread is responsible for that, so these functions may

   371

 * not be called!

   372

 *

   373

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

   374

 */

   375

int ecrt_master_activate( ec_master_t *master /**< EtherCAT master. */);

   376

   377

/** Sends all datagrams in the queue.

   378

 *

   379

 * This has to be called cyclically by the realtime application after

   380

 * ecrt_master_activate() has returned.

   381

 */

   382

void ecrt_master_send(

   383

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

   384

        );

   385

   386

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

   387

 *

   388

 * This has to be called cyclically by the realtime application after

   389

 * ecrt_master_activate() has returned.

   390

 */

   391

void ecrt_master_receive(

   392

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

   393

        );

   394

   395

/** Reads the current master state.

   396

 *

   397

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

   398

 */

   399

void ecrt_master_state(

   400

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

   401

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

   402

        );

   403

   404

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

   405

 * Slave configuration methods

   406

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

   407

   408

/** Add a Pdo to a sync manager's Pdo assignment.

   409

 *

   410

 * \see ecrt_slave_config_pdos()

   411

 * \return zero on success, else non-zero

   412

 */

   413

int ecrt_slave_config_pdo_assign_add(

   414

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

   415

        ec_direction_t dir, /**< Sync manager direction (input/output). */

   416

        uint16_t index /**< Index of the Pdo to assign. */

   417

        );

   418

   419

/** Clear a sync manager's Pdo assignment.

   420

 *

   421

 * This can be called before assigning Pdos via

   422

 * ecrt_slave_config_pdo_assign_add(), to clear the default assignment.

   423

 */

   424

void ecrt_slave_config_pdo_assign_clear(

   425

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

   426

        ec_direction_t dir /**< Sync manager direction (input/output). */

   427

        );

   428

   429

/** Add a Pdo entry to the given Pdo's mapping.

   430

 *

   431

 * \see ecrt_slave_config_pdos()

   432

 * \return zero on success, else non-zero

   433

 */

   434

int ecrt_slave_config_pdo_mapping_add(

   435

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

   436

        uint16_t pdo_index, /**< Index of the Pdo. */

   437

        uint16_t entry_index, /**< Index of the Pdo entry to add to the Pdo's

   438

                                mapping. */

   439

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

   440

                                  Pdo's mapping. */

   441

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

   442

        );

   443

   444

/** Clear the mapping of a given Pdo.

   445

 *

   446

 * This can be called before mapping Pdo entries via

   447

 * ecrt_slave_config_pdo_mapping_add(), to clear the default mapping.

   448

 */

   449

void ecrt_slave_config_pdo_mapping_clear(

   450

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

   451

        uint16_t pdo_index /**< Index of the Pdo. */

   452

        );

   453

   454

/** Specify the Pdo assignment and (optionally) the Pdo mappings.

   455

 *

   456

 * This function is a convenience wrapper for the functions

   457

 * ecrt_slave_config_pdo_assign_clear(), ecrt_slave_config_pdo_assign_add(),

   458

 * ecrt_slave_config_pdo_mapping_clear() and

   459

 * ecrt_slave_config_pdo_mapping_add(), that are better suitable for automatic

   460

 * code generation.

   461

 *

   462

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

   463

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

   464

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

   465

 * configuration time:

   466

 *

   467

 * \code

   468

 * const ec_pdo_entry_info_t el3162_channel1[] = {

   469

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

   470

 *     {0x3101, 2, 16}  // value

   471

 * };

   472

 * 

   473

 * const ec_pdo_entry_info_t el3162_channel2[] = {

   474

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

   475

 *     {0x3102, 2, 16}  // value

   476

 * };

   477

 * 

   478

 * const ec_pdo_info_t el3162_pdos[] = {

   479

 *     {EC_DIR_INPUT, 0x1A00, 2, el3162_channel1},

   480

 *     {EC_DIR_INPUT, 0x1A01, 2, el3162_channel2},

   481

 * };

   482

 * 

   483

 * if (ecrt_slave_config_pdos(sc, 2, el3162_pdos))

   484

 *     return -1; // error

   485

 * \endcode

   486

 * 

   487

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

   488

 * entries for each assigned Pdo are taken from the Pdo's default mapping.

   489

 * Please note, that Pdo entry registration will fail, if the Pdo