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 userspace library.

     8

 *  

     9

 *  The IgH EtherCAT master userspace library is free software; you can

    10

 *  redistribute it and/or modify it under the terms of the GNU Lesser General

    11

 *  Public License as published by the Free Software Foundation; version 2.1

    12

 *  of the License.

    13

 *

    14

 *  The IgH EtherCAT master userspace library is distributed in the hope that

    15

 *  it will be useful, but WITHOUT ANY WARRANTY; without even the implied

    16

 *  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    17

 *  GNU Lesser General Public License for more details.

    18

 *

    19

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

    20

 *  along with the IgH EtherCAT master userspace library. If not, see

    21

 *  <http://www.gnu.org/licenses/>.

    22

 *  

    23

 *  ---

    24

 *  

    25

 *  The license mentioned above concerns the source code only. Using the

    26

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

    27

 *  industrial property and similar rights of Beckhoff Automation GmbH.

    28

 *

    29

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

    30

    31

/** \file

    32

 *

    33

 * EtherCAT master application interface.

    34

 *

    35

 * \defgroup ApplicationInterface EtherCAT Application Interface

    36

 *

    37

 * EtherCAT interface for realtime applications. This interface is designed

    38

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

    39

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

    40

 * and to configure and activate the bus.

    41

 *

    42

 * Changes in version 1.5:

    43

 *

    44

 * - Changed the meaning of the negative return values of

    45

 *   ecrt_slave_config_reg_pdo_entry() and ecrt_slave_config_sdo*().

    46

 * - Imlemented the Vendor-specific over EtherCAT mailbox protocol. See

    47

 *   ecrt_slave_config_create_voe_handler().

    48

 * - Renamed ec_sdo_request_state_t to ec_request_state_t, because it is also

    49

 *   used by VoE handlers.

    50

 * - Added ecrt_master_slave() to get information about a certain slave.

    51

 * - Removed 'const' from argument of ecrt_sdo_request_state(), because the

    52

 *   userspace library has to modify object internals.

    53

 * - Added 64-bit data access macros.

    54

 *

    55

 * @{

    56

 */

    57

    58

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

    59

    60

#ifndef __ECRT_H__

    61

#define __ECRT_H__

    62

    63

#ifdef __KERNEL__

    64

#include <asm/byteorder.h>

    65

#include <linux/types.h>

    66

#else

    67

#include <stdlib.h> // for size_t

    68

#include <stdint.h>

    69

#endif

    70

    71

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

    72

 * Global definitions

    73

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

    74

    75

/** EtherCAT realtime interface major version number.

    76

 */

    77

#define ECRT_VER_MAJOR 1

    78

    79

/** EtherCAT realtime interface minor version number.

    80

 */

    81

#define ECRT_VER_MINOR 5

    82

    83

/** EtherCAT realtime interface version word generator.

    84

 */

    85

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

    86

    87

/** EtherCAT realtime interface version word.

    88

 */

    89

#define ECRT_VERSION_MAGIC ECRT_VERSION(ECRT_VER_MAJOR, ECRT_VER_MINOR)

    90

    91

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

    92

    93

/** End of list marker.

    94

 *

    95

 * This can be used with ecrt_slave_config_pdos().

    96

 */

    97

#define EC_END ~0U

    98

    99

/** Maximum number of sync managers per slave.

   100

 */

   101

#define EC_MAX_SYNC_MANAGERS 16

   102

   103

/** Maximum string length.

   104

 *

   105

 * Used in ec_slave_info_t.

   106

 */

   107

#define EC_MAX_STRING_LENGTH 64

   108

   109

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

   110

 * Data types 

   111

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

   112

   113

struct ec_master;

   114

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

   115

   116

struct ec_slave_config;

   117

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

   118

   119

struct ec_domain;

   120

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

   121

   122

struct ec_sdo_request;

   123

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

   124

   125

struct ec_voe_handler;

   126

typedef struct ec_voe_handler ec_voe_handler_t; /**< \see ec_voe_handler. */

   127

   128

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

   129

   130

/** Master state.

   131

 *

   132

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

   133

 *

   134

 * \see ecrt_master_state().

   135

 */

   136

typedef struct {

   137

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

   138

    unsigned int al_states : 4; /**< Application-layer states of all slaves.

   139

                                  The states are coded in the lower 4 bits.

   140

                                  If a bit is set, it means that at least one

   141

                                  slave in the bus is in the corresponding

   142

                                  state:

   143

                                  - Bit 0: \a INIT

   144

                                  - Bit 1: \a PREOP

   145

                                  - Bit 2: \a SAFEOP

   146

                                  - Bit 3: \a OP */

   147

    unsigned int link_up : 1; /**< \a true, if the network link is up. */

   148

} ec_master_state_t;

   149

   150

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

   151

   152

/** Slave configuration state.

   153

 *

   154

 * This is used as an output parameter of ecrt_slave_config_state().

   155

 * 

   156

 * \see ecrt_slave_config_state().

   157

 */

   158

typedef struct  {

   159

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

   160

    unsigned int operational : 1; /**< The slave was brought into \a OP state

   161

                                    using the specified configuration. */

   162

    unsigned int al_state : 4; /**< The application-layer state of the slave.

   163

                                 - 1: \a INIT

   164

                                 - 2: \a PREOP

   165

                                 - 4: \a SAFEOP

   166

                                 - 8: \a OP

   167

   168

                                 Note that each state is coded in a different

   169

                                 bit! */

   170

} ec_slave_config_state_t;

   171

   172

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

   173

   174

/** Slave information.

   175

 *

   176

 * This is used as an output parameter of ecrt_master_slave().

   177

 *

   178

 * \see ecrt_master_slave().

   179

 */

   180

typedef struct {

   181

    uint16_t position; /**< Offset of the slave in the ring. */

   182

    uint32_t vendor_id; /**< Vendor-ID stored on the slave. */

   183

    uint32_t product_code; /**< Product-Code stored on the slave. */

   184

    uint32_t revision_number; /**< Revision-Number stored on the slave. */

   185

    uint32_t serial_number; /**< Serial-Number stored on the slave. */

   186

    uint16_t alias; /**< The slaves alias if not equal to 0. */

   187

    int16_t current_on_ebus;

   188

    uint8_t al_state; /**< Current state of the slave. */

   189

    uint8_t error_flag; /**< Error flag for that slave. */

   190

    uint8_t sync_count; /**< Number of sync managers. */

   191

    uint16_t sdo_count; /**< Number of SDO's. */

   192

    char name[EC_MAX_STRING_LENGTH]; /**< Name of the slave. */

   193

} ec_slave_info_t;

   194

   195

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

   196

   197

/** Domain working counter interpretation.

   198

 *

   199

 * This is used in ec_domain_state_t.

   200

 */

   201

typedef enum {

   202

    EC_WC_ZERO = 0,   /**< No registered process data were exchanged. */

   203

    EC_WC_INCOMPLETE, /**< Some of the registered process data were

   204

                        exchanged. */

   205

    EC_WC_COMPLETE    /**< All registered process data were exchanged. */

   206

} ec_wc_state_t;

   207

   208

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

   209

   210

/** Domain state.

   211

 *

   212

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

   213

 */

   214

typedef struct {

   215

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

   216

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

   217

} ec_domain_state_t;

   218

   219

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

   220

   221

/** Direction type for PDO assignment functions.

   222

 */

   223

typedef enum {

   224

    EC_DIR_INVALID, /**< Invalid direction. Do not use this value. */

   225

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

   226

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

   227

    EC_DIR_COUNT /**< Number of directions. For internal use only. */

   228

} ec_direction_t;

   229

   230

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

   231

   232

/** PDO entry configuration information.

   233

 *

   234

 * This is the data type of the \a entries field in ec_pdo_info_t.

   235

 *

   236

 * \see ecrt_slave_config_pdos().

   237

 */

   238

typedef struct {

   239

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

   240

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

   241

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

   242

} ec_pdo_entry_info_t;

   243

   244

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

   245

   246

/** PDO configuration information.

   247

 * 

   248

 * This is the data type of the \a pdos field in ec_sync_info_t.

   249

 * 

   250

 * \see ecrt_slave_config_pdos().

   251

 */

   252

typedef struct {

   253

    uint16_t index; /**< PDO index. */

   254

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

   255

                              Zero means, that the default mapping shall be

   256

                              used (this can only be done if the slave is

   257

                              present at bus configuration time). */

   258

    ec_pdo_entry_info_t *entries; /**< Array of PDO entries to map. Can either

   259

                                    be \a NULL, or must contain at

   260

                                    least \a n_entries values. */

   261

} ec_pdo_info_t;

   262

   263

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

   264

   265

/** Sync manager configuration information.

   266

 *

   267

 * This can be use to configure multiple sync managers including the PDO

   268

 * assignment and PDO mapping. It is used as an input parameter type in

   269

 * ecrt_slave_config_pdos().

   270

 */

   271

typedef struct {

   272

    uint8_t index; /**< Sync manager index. Must be less

   273

                     than #EC_MAX_SYNC_MANAGERS for a valid sync manager,

   274

                     but can also be \a 0xff to mark the end of the list. */

   275

    ec_direction_t dir; /**< Sync manager direction. */

   276

    unsigned int n_pdos; /**< Number of PDOs in \a pdos. */

   277

    ec_pdo_info_t *pdos; /**< Array with PDOs to assign. This must contain

   278

                            at least \a n_pdos PDOs. */

   279

} ec_sync_info_t;

   280

   281

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

   282

   283

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

   284

 *

   285

 * This type is used for the array parameter of the

   286

 * ecrt_domain_reg_pdo_entry_list()

   287

 */

   288

typedef struct {

   289

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

   290

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

   291

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

   292

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

   293

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

   294

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

   295

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

   296

                       (byte-)offset in the process data. */

   297

    unsigned int *bit_position; /**< Pointer to a variable to store a bit 

   298

                                  position (0-7) within the \a offset. Can be

   299

                                  NULL, in which case an error is raised if the

   300

                                  PDO entry does not byte-align. */

   301

} ec_pdo_entry_reg_t;

   302

   303

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

   304

   305

/** Request state.

   306

 *

   307

 * This is used as return type for ecrt_sdo_request_state() and

   308

 * ecrt_voe_handler_state().

   309

 */

   310

typedef enum {

   311

    EC_REQUEST_UNUSED, /**< Not requested. */

   312

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

   313

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

   314

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

   315

} ec_request_state_t;

   316

   317

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

   318

 * Global functions

   319

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

   320

   321

#ifdef __cplusplus

   322

extern "C" {

   323

#endif

   324

   325

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

   326

 *

   327

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

   328

 */

   329

unsigned int ecrt_version_magic(void);

   330

   331

/** Requests an EtherCAT master for realtime operation.

   332

 * 

   333

 * Before an application can access an EtherCAT master, it has to reserve one

   334

 * for exclusive use.

   335

 *

   336

 * This function has to be the first function an application has to call to

   337

 * use EtherCAT. The function takes the index of the master as its argument.

   338

 * The first master has index 0, the n-th master has index n - 1. The number

   339

 * of masters has to be specified when loading the master module.

   340

 *

   341

 * \return Pointer to the reserved master, otherwise \a NULL.

   342

 */

   343

ec_master_t *ecrt_request_master(

   344

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

   345

        );

   346

   347

/** Releases a requested EtherCAT master.

   348

 *

   349

 * After use, a master it has to be released to make it available for other

   350

 * applications.

   351

 */

   352

void ecrt_release_master(

   353

        ec_master_t *master /**< EtherCAT master */

   354

        );

   355

   356

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

   357

 * Master methods

   358

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

   359

   360

#ifdef __KERNEL__

   361

   362

/** Sets the locking callbacks.

   363

 *

   364

 * For concurrent master access, the application has to provide a locking

   365

 * mechanism (see section FIXME in the docs). The method takes two function

   366

 * pointers and a data value as its parameters. The arbitrary \a cb_data value

   367

 * will be passed as argument on every callback. Asynchronous master access

   368

 * (like EoE processing) is only possible if the callbacks have been set.

   369

 *

   370

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

   371

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

   372

 * that access is currently forbidden.

   373

 */

   374

void ecrt_master_callbacks(

   375

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

   376

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

   377

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

   378

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

   379

        );

   380

   381

#endif /* __KERNEL__ */

   382

   383

/** Creates a new process data domain.

   384

 *

   385

 * For process data exchange, at least one process data domain is needed.

   386

 * This method creates a new process data domain and returns a pointer to the

   387

 * new domain object. This object can be used for registering PDOs and

   388

 * exchanging them in cyclic operation.

   389

 *

   390

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

   391

 */

   392

ec_domain_t *ecrt_master_create_domain(

   393

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

   394

        );

   395

   396

/** Obtains a slave configuration.

   397

 *

   398

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

   399

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

   400

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

   401

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

   402

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

   403

 *

   404

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

   405

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

   406

 *   ring position.

   407

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

   408

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

   409

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

   410

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

   411

 *

   412

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

   413

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

   414

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

   415

 *

   416

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

   417

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

   418

 * applied.

   419

 *

   420

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

   421

 * \retval NULL in the error case.

   422

 */

   423

ec_slave_config_t *ecrt_master_slave_config(

   424

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

   425

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

   426

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

   427

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

   428

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

   429

        );

   430

   431

/** Obtains slave information.

   432

 *

   433

 * Tries to find the slave with the given ring position. The obtained

   434

 * information is stored in a structure. No memory is allocated on the heap in

   435

 * this function.

   436

 *

   437

 * \attention The pointer to this structure must point to a valid variable.

   438

 *

   439

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

   440

 */

   441

int ecrt_master_slave(

   442

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

   443

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

   444

        ec_slave_info_t *slave_info /**< Structure that will output the

   445

                                      information */

   446

        );

   447

   448

/** Finishes the configuration phase and prepares for cyclic operation.

   449

 *

   450

 * This function tells the master that the configuration phase is finished and

   451

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

   452

 * for the domains and calculates the logical FMMU addresses for domain

   453

 * members. It tells the master state machine that the bus configuration is

   454

 * now to be applied.

   455

 *

   456

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

   457

 * in charge of cyclically calling ecrt_master_send() and

   458

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

   459

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

   460

 * not be called!

   461

 *

   462

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

   463

 */

   464

int ecrt_master_activate(

   465

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

   466

        );

   467

   468

/** Sends all datagrams in the queue.

   469

 *

   470

 * This method takes all datagrams, that have been queued for transmission,

   471

 * puts them into frames, and passes them to the Ethernet device for sending.

   472

 *

   473

 * Has to be called cyclically by the application after ecrt_master_activate()

   474

 * has returned.

   475

 */

   476

void ecrt_master_send(

   477

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

   478

        );

   479

   480

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

   481

 *

   482

 * Queries the network device for received frames by calling the interrupt

   483

 * service routine. Extracts received datagrams and dispatches the results to

   484

 * the datagram objects in the queue. Received datagrams, and the ones that

   485

 * timed out, will be marked, and dequeued.

   486

 *

   487

 * Has to be called cyclically by the realtime application after