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 method

    45

 *   ecrt_slave_config_dc() to configure a slave for cyclic operation, and

    46

 *   ecrt_master_application_time(), ecrt_master_sync_reference_clock() and

    47

 *   ecrt_master_sync_slave_clocks() for offset and drift compensation. The

    48

 *   EC_TIMEVAL2NANO() macro can be used for epoch time conversion, while the

    49

 *   ecrt_master_sync_monitor_queue() and ecrt_master_sync_monitor_process()

    50

 *   methods can be used to monitor the synchrony.

    51

 * - Improved the callback mechanism. ecrt_master_callbacks() now takes two

    52

 *   callback functions for locking and unlocking the fsm datagram queue.

    53

 * - Added watchdog configuration (method ecrt_slave_config_watchdog(),

    54

 *   #ec_watchdog_mode_t, \a watchdog_mode parameter in ec_sync_info_t and

    55

 *   ecrt_slave_config_sync_manager()).

    56

 * - Added ecrt_slave_config_complete_sdo() method to download an SDO during

    57

 *   configuration via CompleteAccess.

    58

 * - Added ecrt_master_deactivate() to remove the bus configuration.

    59

 * - Added ecrt_open_master() and ecrt_master_reserve() separation for

    60

 *   userspace.

    61

 * - Added bus information interface (methods ecrt_master(),

    62

 *   ecrt_master_get_slave(), ecrt_master_get_sync_manager(),

    63

 *   ecrt_master_get_pdo() and ecrt_master_get_pdo_entry()) to get information

    64

 *   about the currently connected slaves and the PDO entries provided.

    65

 * - Added ecrt_master_sdo_download(), ecrt_master_sdo_download_complete() and

    66

 *   ecrt_master_sdo_upload() methods to let an application transfer SDOs

    67

 *   before activating the master.

    68

 * - Changed the meaning of the negative return values of

    69

 *   ecrt_slave_config_reg_pdo_entry() and ecrt_slave_config_sdo*().

    70

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

    71

 *   ecrt_slave_config_create_voe_handler().

    72

 * - Renamed ec_sdo_request_state_t to #ec_request_state_t, because it is also

    73

 *   used by VoE handlers.

    74

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

    75

 *   userspace library has to modify object internals.

    76

 * - Added 64-bit data access macros.

    77

 * - Added ecrt_slave_config_idn() method for storing SoE IDN configurations,

    78

 *   and ecrt_master_read_idn() and ecrt_master_write_idn() to read/write IDNs

    79

 *   ad-hoc via the user-space library.

    80

 * - Added ecrt_master_reset() to initiate retrying to configure slaves.

    81

 * - Added support for overlapping PDOs which allows inputs to use the same

    82

 *   space as outputs on the frame. This reduces the frame length.

    83

 *

    84

 * @{

    85

 */

    86

    87

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

    88

    89

#ifndef __ECRT_H__

    90

#define __ECRT_H__

    91

    92

#ifdef __KERNEL__

    93

#include <asm/byteorder.h>

    94

#include <linux/types.h>

    95

#include <linux/time.h>

    96

#else

    97

#include <stdlib.h> // for size_t

    98

#include <stdint.h>

    99

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

   100

#endif

   101

   102

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

   103

 * Global definitions

   104

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

   105

   106

/** EtherCAT realtime interface major version number.

   107

 */

   108

#define ECRT_VER_MAJOR 1

   109

   110

/** EtherCAT realtime interface minor version number.

   111

 */

   112

#define ECRT_VER_MINOR 5

   113

   114

/** EtherCAT realtime interface version word generator.

   115

 */

   116

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

   117

   118

/** EtherCAT realtime interface version word.

   119

 */

   120

#define ECRT_VERSION_MAGIC ECRT_VERSION(ECRT_VER_MAJOR, ECRT_VER_MINOR)

   121

   122

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

   123

   124

/** End of list marker.

   125

 *

   126

 * This can be used with ecrt_slave_config_pdos().

   127

 */

   128

#define EC_END ~0U

   129

   130

/** Maximum number of sync managers per slave.

   131

 */

   132

#define EC_MAX_SYNC_MANAGERS 16

   133

   134

/** Maximum string length.

   135

 *

   136

 * Used in ec_slave_info_t.

   137

 */

   138

#define EC_MAX_STRING_LENGTH 64

   139

   140

/** Maximum number of slave ports. */

   141

#define EC_MAX_PORTS 4

   142

   143

/** Timeval to nanoseconds conversion.

   144

 *

   145

 * This macro converts a Unix epoch time to EtherCAT DC time.

   146

 *

   147

 * \see void ecrt_master_application_time()

   148

 *

   149

 * \param TV struct timeval containing epoch time.

   150

 */

   151

#define EC_TIMEVAL2NANO(TV) \

   152

    (((TV).tv_sec - 946684800ULL) * 1000000000ULL + (TV).tv_usec * 1000ULL)

   153

   154

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

   155

 * Data types

   156

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

   157

   158

struct ec_master;

   159

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

   160

   161

struct ec_slave_config;

   162

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

   163

   164

struct ec_domain;

   165

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

   166

   167

struct ec_sdo_request;

   168

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

   169

   170

struct ec_voe_handler;

   171

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

   172

   173

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

   174

   175

/** Master state.

   176

 *

   177

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

   178

 * ecrt_master_configured_slaves_state().

   179

 *

   180

 * \see ecrt_master_state().

   181

 * \see ecrt_master_configured_slaves_state().

   182

 */

   183

typedef struct {

   184

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

   185

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

   186

                                  The states are coded in the lower 4 bits.

   187

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

   188

                                  slave in the bus is in the corresponding

   189

                                  state:

   190

                                  - Bit 0: \a INIT

   191

                                  - Bit 1: \a PREOP

   192

                                  - Bit 2: \a SAFEOP

   193

                                  - Bit 3: \a OP */

   194

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

   195

} ec_master_state_t;

   196

   197

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

   198

   199

/** Slave configuration state.

   200

 *

   201

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

   202

 *

   203

 * \see ecrt_slave_config_state().

   204

 */

   205

typedef struct  {

   206

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

   207

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

   208

                                    using the specified configuration. */

   209

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

   210

                                 - 1: \a INIT

   211

                                 - 2: \a PREOP

   212

                                 - 4: \a SAFEOP

   213

                                 - 8: \a OP

   214

   215

                                 Note that each state is coded in a different

   216

                                 bit! */

   217

} ec_slave_config_state_t;

   218

   219

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

   220

   221

/** Master information.

   222

 *

   223

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

   224

 *

   225

 * \see ecrt_master().

   226

 */

   227

typedef struct {

   228

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

   229

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

   230

   uint8_t scan_busy; /**< \a true, while the master is scanning the bus */

   231

   uint64_t app_time; /**< Application time. */

   232

} ec_master_info_t;

   233

   234

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

   235

   236

/** EtherCAT slave port descriptor.

   237

 */

   238

typedef enum {

   239

    EC_PORT_NOT_IMPLEMENTED, /**< Port is not implemented. */

   240

    EC_PORT_NOT_CONFIGURED, /**< Port is not configured. */

   241

    EC_PORT_EBUS, /**< Port is an e-bus. */

   242

    EC_PORT_MII /**< Port is a mii. */

   243

} ec_slave_port_desc_t;

   244

   245

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

   246

   247

/** EtherCAT slave port information.

   248

 */

   249

typedef struct {

   250

    uint8_t link_up; /**< Link detected. */

   251

    uint8_t loop_closed; /**< Loop closed. */

   252

    uint8_t signal_detected; /**< Detected signal on RX port. */

   253

} ec_slave_port_link_t;

   254

   255

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

   256

   257

/** Slave information.

   258

 *

   259

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

   260

 *

   261

 * \see ecrt_master_get_slave().

   262

 */

   263

typedef struct {

   264

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

   265

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

   266

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

   267

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

   268

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

   269

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

   270

    int16_t current_on_ebus; /**< Used current in mA. */

   271

    struct {

   272

        ec_slave_port_desc_t desc; /**< Physical port type. */

   273

        ec_slave_port_link_t link; /**< Port link state. */

   274

        uint32_t receive_time; /**< Receive time on DC transmission delay

   275

                                 measurement. */

   276

        uint16_t next_slave; /**< Ring position of next DC slave on that

   277

                               port.  */

   278

        uint32_t delay_to_next_dc; /**< Delay [ns] to next DC slave. */

   279

    } ports[EC_MAX_PORTS]; /**< Port information. */

   280

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

   281

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

   282

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

   283

    uint16_t sdo_count; /**< Number of SDOs. */

   284

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

   285

} ec_slave_info_t;

   286

   287

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

   288

   289

/** Domain working counter interpretation.

   290

 *

   291

 * This is used in ec_domain_state_t.

   292

 */

   293

typedef enum {

   294

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

   295

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

   296

                        exchanged. */

   297

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

   298

} ec_wc_state_t;

   299

   300

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

   301

   302

/** Domain state.

   303

 *

   304

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

   305

 */

   306

typedef struct {

   307

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

   308

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

   309

} ec_domain_state_t;

   310

   311

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

   312

   313

/** Direction type for PDO assignment functions.

   314

 */

   315

typedef enum {

   316

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

   317

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

   318

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

   319

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

   320

} ec_direction_t;

   321

   322

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

   323

   324

/** Watchdog mode for sync manager configuration.

   325

 *

   326

 * Used to specify, if a sync manager's watchdog is to be enabled.

   327

 */

   328

typedef enum {

   329

    EC_WD_DEFAULT, /**< Use the default setting of the sync manager. */

   330

    EC_WD_ENABLE, /**< Enable the watchdog. */

   331

    EC_WD_DISABLE, /**< Disable the watchdog. */

   332

} ec_watchdog_mode_t;

   333

   334

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

   335

   336

/** PDO entry configuration information.

   337

 *

   338

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

   339

 *

   340

 * \see ecrt_slave_config_pdos().

   341

 */

   342

typedef struct {

   343

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

   344

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

   345

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

   346

} ec_pdo_entry_info_t;

   347

   348

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

   349

   350

/** PDO configuration information.

   351

 *

   352

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

   353

 *

   354

 * \see ecrt_slave_config_pdos().

   355

 */

   356

typedef struct {

   357

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

   358

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

   359

                              Zero means, that the default mapping shall be

   360

                              used (this can only be done if the slave is

   361

                              present at bus configuration time). */

   362

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

   363

                                    be \a NULL, or must contain at

   364

                                    least \a n_entries values. */

   365

} ec_pdo_info_t;

   366

   367

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

   368

   369

/** Sync manager configuration information.

   370

 *

   371

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

   372

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

   373

 * ecrt_slave_config_pdos().

   374

 */

   375

typedef struct {

   376

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

   377

                     than #EC_MAX_SYNC_MANAGERS for a valid sync manager,

   378

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

   379

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

   380

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

   381

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

   382

                            at least \a n_pdos PDOs. */

   383

    ec_watchdog_mode_t watchdog_mode; /**< Watchdog mode. */

   384

} ec_sync_info_t;

   385

   386

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

   387

   388

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

   389

 *

   390

 * This type is used for the array parameter of the

   391

 * ecrt_domain_reg_pdo_entry_list()

   392

 */

   393

typedef struct {

   394

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

   395

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

   396

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

   397

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

   398

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

   399

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

   400

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

   401

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

   402

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

   403

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

   404

                                  NULL, in which case an error is raised if the

   405

                                  PDO entry does not byte-align. */

   406

} ec_pdo_entry_reg_t;

   407

   408

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

   409

   410

/** Request state.

   411

 *

   412

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

   413

 * ecrt_voe_handler_state().

   414

 */

   415

typedef enum {

   416

    EC_REQUEST_UNUSED, /**< Not requested. */

   417

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

   418

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

   419

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

   420

} ec_request_state_t;

   421

   422

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

   423

   424

/** Application-layer state.

   425

 */

   426

typedef enum {

   427

    EC_AL_STATE_INIT = 1, /**< Init. */

   428

    EC_AL_STATE_PREOP = 2, /**< Pre-operational. */

   429

    EC_AL_STATE_SAFEOP = 4, /**< Safe-operational. */

   430

    EC_AL_STATE_OP = 8, /**< Operational. */

   431

} ec_al_state_t;

   432

   433

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

   434

 * Global functions

   435

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

   436

   437

#ifdef __cplusplus

   438

extern "C" {

   439

#endif

   440

   441

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

   442

 *

   443

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

   444

 */

   445

unsigned int ecrt_version_magic(void);

   446

   447

/** Requests an EtherCAT master for realtime operation.

   448

 *

   449

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

   450

 * for exclusive use.

   451

 *

   452

 * In userspace, this is a convenience function for ecrt_open_master() and

   453

 * ecrt_master_reserve().

   454

 *

   455

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

   456

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

   457

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

   458

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

   459

 *

   460

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

   461

 */

   462

ec_master_t *ecrt_request_master(

   463

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

   464

        );

   465

   466

#ifndef __KERNEL__

   467

   468

/** Opens an EtherCAT master for userspace access.

   469

 *

   470

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

   471

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

   472

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

   473

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

   474

 *

   475

 * For convenience, the function ecrt_request_master() can be used.

   476

 *

   477

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

   478

 */

   479

ec_master_t *ecrt_open_master(

   480

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

   481

        );

   482

   483

#endif // #ifndef __KERNEL__

   484

   485

/** Releases a requested EtherCAT master.