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

 *

    54

 * @{

    55

 */

    56

    57

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

    58

    59

#ifndef __ECRT_H__

    60

#define __ECRT_H__

    61

    62

#ifdef __KERNEL__

    63

#include <asm/byteorder.h>

    64

#include <linux/types.h>

    65

#else

    66

#include <stdlib.h> // for size_t

    67

#include <stdint.h>

    68

#endif

    69

    70

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

    71

 * Global definitions

    72

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

    73

    74

/** EtherCAT realtime interface major version number.

    75

 */

    76

#define ECRT_VER_MAJOR 1

    77

    78

/** EtherCAT realtime interface minor version number.

    79

 */

    80

#define ECRT_VER_MINOR 5

    81

    82

/** EtherCAT realtime interface version word generator.

    83

 */

    84

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

    85

    86

/** EtherCAT realtime interface version word.

    87

 */

    88

#define ECRT_VERSION_MAGIC ECRT_VERSION(ECRT_VER_MAJOR, ECRT_VER_MINOR)

    89

    90

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

    91

    92

/** End of list marker.

    93

 *

    94

 * This can be used with ecrt_slave_config_pdos().

    95

 */

    96

#define EC_END ~0U

    97

    98

/** Maximum number of sync managers per slave.

    99

 */

   100

#define EC_MAX_SYNC_MANAGERS 16

   101

   102

/** Maximum string length.

   103

 *

   104

 * Used in ec_slave_info_t.

   105

 */

   106

#define EC_MAX_STRING_LENGTH 64

   107

   108

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

   109

 * Data types 

   110

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

   111

   112

struct ec_master;

   113

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

   114

   115

struct ec_slave_config;

   116

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

   117

   118

struct ec_domain;

   119

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

   120

   121

struct ec_sdo_request;

   122

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

   123

   124

struct ec_voe_handler;

   125

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

   126

   127

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

   128

   129

/** Master state.

   130

 *

   131

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

   132

 *

   133

 * \see ecrt_master_state().

   134

 */

   135

typedef struct {

   136

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

   137

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

   138

                                  The states are coded in the lower 4 bits.

   139

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

   140

                                  slave in the bus is in the corresponding

   141

                                  state:

   142

                                  - Bit 0: \a INIT

   143

                                  - Bit 1: \a PREOP

   144

                                  - Bit 2: \a SAFEOP

   145

                                  - Bit 3: \a OP */

   146

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

   147

} ec_master_state_t;

   148

   149

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

   150

   151

/** Slave configuration state.

   152

 *

   153

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

   154

 * 

   155

 * \see ecrt_slave_config_state().

   156

 */

   157

typedef struct  {

   158

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

   159

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

   160

                                    using the specified configuration. */

   161

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

   162

                                 - 1: \a INIT

   163

                                 - 2: \a PREOP

   164

                                 - 4: \a SAFEOP

   165

                                 - 8: \a OP

   166

   167

                                 Note that each state is coded in a different

   168

                                 bit! */

   169

} ec_slave_config_state_t;

   170

   171

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

   172

   173

/** Slave information.

   174

 *

   175

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

   176

 *

   177

 * \see ecrt_master_slave().

   178

 */

   179

typedef struct {

   180

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

   181

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

   182

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

   183

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

   184

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

   185

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

   186

    int16_t current_on_ebus;

   187

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

   188

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

   189

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

   190

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

   191

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

   192

} ec_slave_info_t;

   193

   194

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

   195

   196

/** Domain working counter interpretation.

   197

 *

   198

 * This is used in ec_domain_state_t.

   199

 */

   200

typedef enum {

   201

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

   202

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

   203

                        exchanged. */

   204

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

   205

} ec_wc_state_t;

   206

   207

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

   208

   209

/** Domain state.

   210

 *

   211

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

   212

 */

   213

typedef struct {

   214

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

   215

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

   216

} ec_domain_state_t;

   217

   218

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

   219

   220

/** Direction type for PDO assignment functions.

   221

 */

   222

typedef enum {

   223

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

   224

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

   225

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

   226

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

   227

} ec_direction_t;

   228

   229

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

   230

   231

/** PDO entry configuration information.

   232

 *

   233

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

   234

 *

   235

 * \see ecrt_slave_config_pdos().

   236

 */

   237

typedef struct {

   238

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

   239

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

   240

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

   241

} ec_pdo_entry_info_t;

   242

   243

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

   244

   245

/** PDO configuration information.

   246

 * 

   247

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

   248

 * 

   249

 * \see ecrt_slave_config_pdos().

   250

 */

   251

typedef struct {

   252

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

   253

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

   254

                              Zero means, that the default mapping shall be

   255

                              used (this can only be done if the slave is

   256

                              present at bus configuration time). */

   257

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

   258

                                    be \a NULL, or must contain at

   259

                                    least \a n_entries values. */

   260

} ec_pdo_info_t;

   261

   262

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

   263

   264

/** Sync manager configuration information.

   265

 *

   266

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

   267

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

   268

 * ecrt_slave_config_pdos().

   269

 */

   270

typedef struct {

   271

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

   272

                     than #EC_MAX_SYNC_MANAGERS for a valid sync manager,

   273

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

   274

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

   275

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

   276

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

   277

                            at least \a n_pdos PDOs. */

   278

} ec_sync_info_t;

   279

   280

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

   281

   282

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

   283

 *

   284

 * This type is used for the array parameter of the

   285

 * ecrt_domain_reg_pdo_entry_list()

   286

 */

   287

typedef struct {

   288

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

   289

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

   290

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

   291

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

   292

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

   293

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

   294

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

   295

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

   296

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

   297

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

   298

                                  NULL, in which case an error is raised if the

   299

                                  PDO entry does not byte-align. */

   300

} ec_pdo_entry_reg_t;

   301

   302

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

   303

   304

/** Request state.

   305

 *

   306

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

   307

 * ecrt_voe_handler_state().

   308

 */

   309

typedef enum {

   310

    EC_REQUEST_UNUSED, /**< Not requested. */

   311

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

   312

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

   313

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

   314

} ec_request_state_t;

   315

   316

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

   317

 * Global functions

   318

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

   319

   320

#ifdef __cplusplus

   321

extern "C" {

   322

#endif

   323

   324

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

   325

 *

   326

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

   327

 */

   328

unsigned int ecrt_version_magic(void);

   329

   330

/** Requests an EtherCAT master for realtime operation.

   331

 * 

   332

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

   333

 * for exclusive use.

   334

 *

   335

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

   336

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

   337

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

   338

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

   339

 *

   340

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

   341

 */

   342

ec_master_t *ecrt_request_master(

   343

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

   344

        );

   345

   346

/** Releases a requested EtherCAT master.

   347

 *

   348

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

   349

 * applications.

   350

 */

   351

void ecrt_release_master(

   352

        ec_master_t *master /**< EtherCAT master */

   353

        );

   354

   355

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

   356

 * Master methods

   357

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

   358

   359

#ifdef __KERNEL__

   360

   361

/** Sets the locking callbacks.

   362

 *

   363

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

   364

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

   365

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

   366

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

   367

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

   368

 *

   369

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

   370

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

   371

 * that access is currently forbidden.

   372

 */

   373

void ecrt_master_callbacks(

   374

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

   375

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

   376

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

   377

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

   378

        );

   379

   380

#endif /* __KERNEL__ */

   381

   382

/** Creates a new process data domain.

   383

 *

   384

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

   385

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

   386

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

   387

 * exchanging them in cyclic operation.

   388

 *

   389

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

   390

 */

   391

ec_domain_t *ecrt_master_create_domain(

   392

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

   393

        );

   394

   395

/** Obtains a slave configuration.

   396

 *

   397

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

   398

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

   399

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

   400

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

   401

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

   402

 *

   403

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

   404

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

   405

 *   ring position.

   406

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

   407

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

   408

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

   409

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

   410

 *

   411

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

   412

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

   413

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

   414

 *

   415

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

   416

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

   417

 * applied.

   418

 *

   419

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

   420

 * \retval NULL in the error case.

   421

 */

   422

ec_slave_config_t *ecrt_master_slave_config(

   423

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

   424

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

   425

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

   426

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

   427

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

   428

        );

   429

   430

/** Obtains slave information.

   431

 *

   432

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

   433

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

   434

 * this function.

   435

 *

   436

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

   437

 *

   438

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

   439

 */

   440

int ecrt_master_slave(

   441

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

   442

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

   443

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

   444

                                      information */

   445

        );

   446

   447

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

   448

 *

   449

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

   450

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

   451

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

   452

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

   453

 * now to be applied.

   454

 *

   455

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

   456

 * in charge of cyclically calling ecrt_master_send() and

   457

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

   458

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

   459

 * not be called!

   460

 *

   461

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

   462

 */

   463

int ecrt_master_activate(

   464

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

   465

        );

   466

   467

/** Sends all datagrams in the queue.

   468

 *

   469

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

   470

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

   471

 *

   472

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

   473

 * has returned.

   474

 */

   475

void ecrt_master_send(

   476

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

   477

        );

   478

   479

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

   480

 *

   481

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

   482

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

   483

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

   484

 * timed out, will be marked, and dequeued.

   485

 *

   486

 * Has to be called cyclically by the realtime application after

   487

 * ecrt_master_activate() has returned.