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

 * - Added the distributed clocks feature and the respective methods

    45

 *   ecrt_slave_config_dc_assign_activate() and

    46

 *   ecrt_slave_config_dc_sync_cycle_times() to configure a slave for cyclic

    47

 *   operation, and ecrt_master_sync() for drift compensation.

    48

 * - Changed the meaning of the negative return values of

    49

 *   ecrt_slave_config_reg_pdo_entry() and ecrt_slave_config_sdo*().

    50

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

    51

 *   ecrt_slave_config_create_voe_handler().

    52

 * - Renamed ec_sdo_request_state_t to ec_request_state_t, because it is also

    53

 *   used by VoE handlers.

    54

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

    55

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

    56

 *   userspace library has to modify object internals.

    57

 * - Added 64-bit data access macros.

    58

 *

    59

 * @{

    60

 */

    61

    62

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

    63

    64

#ifndef __ECRT_H__

    65

#define __ECRT_H__

    66

    67

#ifdef __KERNEL__

    68

#include <asm/byteorder.h>

    69

#include <linux/types.h>

    70

#include <linux/time.h>

    71

#else

    72

#include <stdlib.h> // for size_t

    73

#include <stdint.h>

    74

#include <sys/time.h> // for struct timeval

    75

#endif

    76

    77

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

    78

 * Global definitions

    79

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

    80

    81

/** EtherCAT realtime interface major version number.

    82

 */

    83

#define ECRT_VER_MAJOR 1

    84

    85

/** EtherCAT realtime interface minor version number.

    86

 */

    87

#define ECRT_VER_MINOR 5

    88

    89

/** EtherCAT realtime interface version word generator.

    90

 */

    91

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

    92

    93

/** EtherCAT realtime interface version word.

    94

 */

    95

#define ECRT_VERSION_MAGIC ECRT_VERSION(ECRT_VER_MAJOR, ECRT_VER_MINOR)

    96

    97

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

    98

    99

/** End of list marker.

   100

 *

   101

 * This can be used with ecrt_slave_config_pdos().

   102

 */

   103

#define EC_END ~0U

   104

   105

/** Maximum number of sync managers per slave.

   106

 */

   107

#define EC_MAX_SYNC_MANAGERS 16

   108

   109

/** Maximum string length.

   110

 *

   111

 * Used in ec_slave_info_t.

   112

 */

   113

#define EC_MAX_STRING_LENGTH 64

   114

   115

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

   116

 * Data types 

   117

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

   118

   119

struct ec_master;

   120

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

   121

   122

struct ec_slave_config;

   123

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

   124

   125

struct ec_domain;

   126

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

   127

   128

struct ec_sdo_request;

   129

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

   130

   131

struct ec_voe_handler;

   132

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

   133

   134

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

   135

   136

/** Master state.

   137

 *

   138

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

   139

 *

   140

 * \see ecrt_master_state().

   141

 */

   142

typedef struct {

   143

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

   144

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

   145

                                  The states are coded in the lower 4 bits.

   146

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

   147

                                  slave in the bus is in the corresponding

   148

                                  state:

   149

                                  - Bit 0: \a INIT

   150

                                  - Bit 1: \a PREOP

   151

                                  - Bit 2: \a SAFEOP

   152

                                  - Bit 3: \a OP */

   153

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

   154

} ec_master_state_t;

   155

   156

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

   157

   158

/** Slave configuration state.

   159

 *

   160

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

   161

 * 

   162

 * \see ecrt_slave_config_state().

   163

 */

   164

typedef struct  {

   165

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

   166

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

   167

                                    using the specified configuration. */

   168

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

   169

                                 - 1: \a INIT

   170

                                 - 2: \a PREOP

   171

                                 - 4: \a SAFEOP

   172

                                 - 8: \a OP

   173

   174

                                 Note that each state is coded in a different

   175

                                 bit! */

   176

} ec_slave_config_state_t;

   177

   178

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

   179

   180

/** Slave information.

   181

 *

   182

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

   183

 *

   184

 * \see ecrt_master_slave().

   185

 */

   186

typedef struct {

   187

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

   188

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

   189

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

   190

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

   191

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

   192

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

   193

    int16_t current_on_ebus;

   194

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

   195

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

   196

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

   197

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

   198

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

   199

} ec_slave_info_t;

   200

   201

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

   202

   203

/** Domain working counter interpretation.

   204

 *

   205

 * This is used in ec_domain_state_t.

   206

 */

   207

typedef enum {

   208

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

   209

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

   210

                        exchanged. */

   211

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

   212

} ec_wc_state_t;

   213

   214

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

   215

   216

/** Domain state.

   217

 *

   218

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

   219

 */

   220

typedef struct {

   221

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

   222

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

   223

} ec_domain_state_t;

   224

   225

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

   226

   227

/** Direction type for PDO assignment functions.

   228

 */

   229

typedef enum {

   230

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

   231

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

   232

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

   233

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

   234

} ec_direction_t;

   235

   236

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

   237

   238

/** PDO entry configuration information.

   239

 *

   240

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

   241

 *

   242

 * \see ecrt_slave_config_pdos().

   243

 */

   244

typedef struct {

   245

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

   246

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

   247

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

   248

} ec_pdo_entry_info_t;

   249

   250

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

   251

   252

/** PDO configuration information.

   253

 * 

   254

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

   255

 * 

   256

 * \see ecrt_slave_config_pdos().

   257

 */

   258

typedef struct {

   259

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

   260

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

   261

                              Zero means, that the default mapping shall be

   262

                              used (this can only be done if the slave is

   263

                              present at bus configuration time). */

   264

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

   265

                                    be \a NULL, or must contain at

   266

                                    least \a n_entries values. */

   267

} ec_pdo_info_t;

   268

   269

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

   270

   271

/** Sync manager configuration information.

   272

 *

   273

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

   274

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

   275

 * ecrt_slave_config_pdos().

   276

 */

   277

typedef struct {

   278

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

   279

                     than #EC_MAX_SYNC_MANAGERS for a valid sync manager,

   280

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

   281

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

   282

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

   283

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

   284

                            at least \a n_pdos PDOs. */

   285

} ec_sync_info_t;

   286

   287

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

   288

   289

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

   290

 *

   291

 * This type is used for the array parameter of the

   292

 * ecrt_domain_reg_pdo_entry_list()

   293

 */

   294

typedef struct {

   295

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

   296

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

   297

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

   298

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

   299

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

   300

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

   301

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

   302

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

   303

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

   304

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

   305

                                  NULL, in which case an error is raised if the

   306

                                  PDO entry does not byte-align. */

   307

} ec_pdo_entry_reg_t;

   308

   309

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

   310

   311

/** Request state.

   312

 *

   313

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

   314

 * ecrt_voe_handler_state().

   315

 */

   316

typedef enum {

   317

    EC_REQUEST_UNUSED, /**< Not requested. */

   318

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

   319

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

   320

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

   321

} ec_request_state_t;

   322

   323

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

   324

 * Global functions

   325

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

   326

   327

#ifdef __cplusplus

   328

extern "C" {

   329

#endif

   330

   331

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

   332

 *

   333

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

   334

 */

   335

unsigned int ecrt_version_magic(void);

   336

   337

/** Requests an EtherCAT master for realtime operation.

   338

 * 

   339

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

   340

 * for exclusive use.

   341

 *

   342

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

   343

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

   344

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

   345

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

   346

 *

   347

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

   348

 */

   349

ec_master_t *ecrt_request_master(

   350

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

   351

        );

   352

   353

/** Releases a requested EtherCAT master.

   354

 *

   355

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

   356

 * applications.

   357

 */

   358

void ecrt_release_master(

   359

        ec_master_t *master /**< EtherCAT master */

   360

        );

   361

   362

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

   363

 * Master methods

   364

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

   365

   366

#ifdef __KERNEL__

   367

   368

/** Sets the locking callbacks.

   369

 *

   370

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

   371

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

   372

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

   373

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

   374

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

   375

 *

   376

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

   377

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

   378

 * that access is currently forbidden.

   379

 */

   380

void ecrt_master_callbacks(

   381

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

   382

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

   383

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

   384

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

   385

        );

   386

   387

#endif /* __KERNEL__ */

   388

   389

/** Creates a new process data domain.

   390

 *

   391

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

   392

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

   393

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

   394

 * exchanging them in cyclic operation.

   395

 *

   396

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

   397

 */

   398

ec_domain_t *ecrt_master_create_domain(

   399

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

   400

        );

   401

   402

/** Obtains a slave configuration.

   403

 *

   404

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

   405

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

   406

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

   407

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

   408

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

   409

 *

   410

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

   411

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

   412

 *   ring position.

   413

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

   414

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

   415

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

   416

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

   417

 *

   418

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

   419

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

   420

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

   421

 *

   422

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

   423

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

   424

 * applied.

   425

 *

   426

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

   427

 * \retval NULL in the error case.

   428

 */

   429

ec_slave_config_t *ecrt_master_slave_config(

   430

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

   431

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

   432

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

   433

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

   434

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

   435

        );

   436

   437

/** Obtains slave information.

   438

 *

   439

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

   440

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

   441

 * this function.

   442

 *

   443

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

   444

 *

   445

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

   446

 */

   447

int ecrt_master_slave(

   448

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

   449

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

   450

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

   451

                                      information */

   452

        );

   453

   454

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

   455

 *

   456

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

   457

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

   458

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

   459

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

   460

 * now to be applied.

   461

 *

   462

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

   463

 * in charge of cyclically calling ecrt_master_send() and

   464

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

   465

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

   466

 * not be called!

   467

 *

   468

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

   469

 */

   470

int ecrt_master_activate(

   471

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

   472

        );

   473

   474

/** Sends all datagrams in the queue.

   475

 *

   476

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

   477

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

   478

 *

   479

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

   480

 * has returned.

   481

 */

   482

void ecrt_master_send(

   483

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

   484

        );

   485

   486

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

   487

 *