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() and ecrt_master_sdo_upload()

    66

 *   methods to let an application transfer SDOs before activating the master.

    67

 * - Changed the meaning of the negative return values of

    68

 *   ecrt_slave_config_reg_pdo_entry() and ecrt_slave_config_sdo*().

    69

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

    70

 *   ecrt_slave_config_create_voe_handler().

    71

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

    72

 *   used by VoE handlers.

    73

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

    74

 *   userspace library has to modify object internals.

    75

 * - Added 64-bit data access macros.

    76

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

    77

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

    78

 *   ad-hoc via the user-space library.

    79

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

    80

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

    81

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

    82

 *

    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().

   178

 *

   179

 * \see ecrt_master_state().

   180

 */

   181

typedef struct {

   182

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

   183

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

   184

                                  The states are coded in the lower 4 bits.

   185

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

   186

                                  slave in the bus is in the corresponding

   187

                                  state:

   188

                                  - Bit 0: \a INIT

   189

                                  - Bit 1: \a PREOP

   190

                                  - Bit 2: \a SAFEOP

   191

                                  - Bit 3: \a OP */

   192

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

   193

} ec_master_state_t;

   194

   195

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

   196

   197

/** Slave configuration state.

   198

 *

   199

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

   200

 *

   201

 * \see ecrt_slave_config_state().

   202

 */

   203

typedef struct  {

   204

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

   205

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

   206

                                    using the specified configuration. */

   207

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

   208

                                 - 1: \a INIT

   209

                                 - 2: \a PREOP

   210

                                 - 4: \a SAFEOP

   211

                                 - 8: \a OP

   212

   213

                                 Note that each state is coded in a different

   214

                                 bit! */

   215

} ec_slave_config_state_t;

   216

   217

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

   218

   219

/** Master information.

   220

 *

   221

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

   222

 *

   223

 * \see ecrt_master().

   224

 */

   225

typedef struct {

   226

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

   227

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

   228

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

   229

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

   230

} ec_master_info_t;

   231

   232

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

   233

   234

/** EtherCAT slave port descriptor.

   235

 */

   236

typedef enum {

   237

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

   238

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

   239

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

   240

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

   241

} ec_slave_port_desc_t;

   242

   243

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

   244

   245

/** EtherCAT slave port information.

   246

 */

   247

typedef struct {

   248

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

   249

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

   250

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

   251

} ec_slave_port_link_t;

   252

   253

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

   254

   255

/** Slave information.

   256

 *

   257

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

   258

 *

   259

 * \see ecrt_master_get_slave().

   260

 */

   261

typedef struct {

   262

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

   263

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

   264

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

   265

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

   266

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

   267

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

   268

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

   269

    struct {

   270

        ec_slave_port_desc_t desc;

   271

        ec_slave_port_link_t link;

   272

        uint32_t receive_time;

   273

        uint16_t next_slave;

   274

        uint32_t delay_to_next_dc;

   275

    } ports[EC_MAX_PORTS];

   276

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

   277

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

   278

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

   279

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

   280

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

   281

} ec_slave_info_t;

   282

   283

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

   284

   285

/** Domain working counter interpretation.

   286

 *

   287

 * This is used in ec_domain_state_t.

   288

 */

   289

typedef enum {

   290

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

   291

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

   292

                        exchanged. */

   293

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

   294

} ec_wc_state_t;

   295

   296

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

   297

   298

/** Domain state.

   299

 *

   300

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

   301

 */

   302

typedef struct {

   303

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

   304

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

   305

} ec_domain_state_t;

   306

   307

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

   308

   309

/** Direction type for PDO assignment functions.

   310

 */

   311

typedef enum {

   312

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

   313

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

   314

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

   315

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

   316

} ec_direction_t;

   317

   318

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

   319

   320

/** Watchdog mode for sync manager configuration.

   321

 *

   322

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

   323

 */

   324

typedef enum {

   325

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

   326

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

   327

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

   328

} ec_watchdog_mode_t;

   329

   330

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

   331

   332

/** PDO entry configuration information.

   333

 *

   334

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

   335

 *

   336

 * \see ecrt_slave_config_pdos().

   337

 */

   338

typedef struct {

   339

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

   340

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

   341

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

   342

} ec_pdo_entry_info_t;

   343

   344

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

   345

   346

/** PDO configuration information.

   347

 *

   348

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

   349

 *

   350

 * \see ecrt_slave_config_pdos().

   351

 */

   352

typedef struct {

   353

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

   354

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

   355

                              Zero means, that the default mapping shall be

   356

                              used (this can only be done if the slave is

   357

                              present at bus configuration time). */

   358

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

   359

                                    be \a NULL, or must contain at

   360

                                    least \a n_entries values. */

   361

} ec_pdo_info_t;

   362

   363

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

   364

   365

/** Sync manager configuration information.

   366

 *

   367

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

   368

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

   369

 * ecrt_slave_config_pdos().

   370

 */

   371

typedef struct {

   372

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

   373

                     than #EC_MAX_SYNC_MANAGERS for a valid sync manager,

   374

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

   375

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

   376

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

   377

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

   378

                            at least \a n_pdos PDOs. */

   379

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

   380

} ec_sync_info_t;

   381

   382

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

   383

   384

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

   385

 *

   386

 * This type is used for the array parameter of the

   387

 * ecrt_domain_reg_pdo_entry_list()

   388

 */

   389

typedef struct {

   390

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

   391

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

   392

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

   393

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

   394

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

   395

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

   396

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

   397

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

   398

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

   399

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

   400

                                  NULL, in which case an error is raised if the

   401

                                  PDO entry does not byte-align. */

   402

} ec_pdo_entry_reg_t;

   403

   404

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

   405

   406

/** Request state.

   407

 *

   408

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

   409

 * ecrt_voe_handler_state().

   410

 */

   411

typedef enum {

   412

    EC_REQUEST_UNUSED, /**< Not requested. */

   413

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

   414

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

   415

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

   416

} ec_request_state_t;

   417

   418

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

   419

   420

/** Application-layer state.

   421

 */

   422

typedef enum {

   423

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

   424

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

   425

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

   426

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

   427

} ec_al_state_t;

   428

   429

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

   430

 * Global functions

   431

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

   432

   433

#ifdef __cplusplus

   434

extern "C" {

   435

#endif

   436

   437

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

   438

 *

   439

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

   440

 */

   441

unsigned int ecrt_version_magic(void);

   442

   443

/** Requests an EtherCAT master for realtime operation.

   444

 *

   445

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

   446

 * for exclusive use.

   447

 *

   448

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

   449

 * ecrt_master_reserve().

   450

 *

   451

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

   452

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

   453

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

   454

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

   455

 *

   456

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

   457

 */

   458

ec_master_t *ecrt_request_master(

   459

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

   460

        );

   461

   462

#ifndef __KERNEL__

   463

   464

/** Opens an EtherCAT master for userspace access.

   465

 *

   466

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

   467

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

   468

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

   469

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

   470

 *

   471

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

   472

 *

   473

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

   474

 */

   475

ec_master_t *ecrt_open_master(

   476

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

   477

        );

   478

   479

#endif // #ifndef __KERNEL__

   480

   481

/** Releases a requested EtherCAT master.

   482

 *

   483

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

   484

 * applications.

   485

 */