1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006-2012  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

 * Changed since 1.5:

    43

 *

    44

 * - Added redundancy_active flag to ec_domain_state_t.

    45

 * - Added ecrt_master_link_state() method and ec_master_link_state_t to query

    46

 *   the state of a redundant link.

    47

 * - Added the EC_HAVE_REDUNDANCY define, to check, if the interface contains

    48

 *   redundancy features.

    49

 * - Added ecrt_sdo_request_index() to change SDO index and subindex after

    50

 *   handler creation.

    51

 * - Added interface for retrieving CoE emergency messages, i. e.

    52

 *   ecrt_slave_config_emerg_size(), ecrt_slave_config_emerg_pop(),

    53

 *   ecrt_slave_config_emerg_clear(), ecrt_slave_config_emerg_overruns() and

    54

 *   the defines EC_HAVE_EMERGENCY and EC_COE_EMERGENCY_MSG_SIZE.

    55

 * - Added interface for direct EtherCAT register access: Added data type

    56

 *   ec_reg_request_t and methods ecrt_slave_config_create_reg_request(),

    57

 *   ecrt_reg_request_data(), ecrt_reg_request_state(),

    58

 *   ecrt_reg_request_write(), ecrt_reg_request_read() and the feature flag

    59

 *   EC_HAVE_REG_ACCESS.

    60

 * - Added method to select the reference clock,

    61

 *   ecrt_master_select_reference_clock() and the feature flag

    62

 *   EC_HAVE_SELECT_REF_CLOCK to check, if the method is available.

    63

 * - Added method to get the reference clock time,

    64

 *   ecrt_master_reference_clock_time() and the feature flag

    65

 *   EC_HAVE_REF_CLOCK_TIME to have the possibility to synchronize the master

    66

 *   clock to the reference clock.

    67

 * - Changed the datatypes of the shift times in ecrt_slave_config_dc() to

    68

 *   int32_t to correctly display negative shift times.

    69

 *

    70

 * Changes in version 1.5:

    71

 *

    72

 * - Added the distributed clocks feature and the respective method

    73

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

    74

 *   ecrt_master_application_time(), ecrt_master_sync_reference_clock() and

    75

 *   ecrt_master_sync_slave_clocks() for offset and drift compensation. The

    76

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

    77

 *   ecrt_master_sync_monitor_queue() and ecrt_master_sync_monitor_process()

    78

 *   methods can be used to monitor the synchrony.

    79

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

    80

 *   callback functions for sending and receiving datagrams.

    81

 *   ecrt_master_send_ext() is used to execute the sending of non-application

    82

 *   datagrams.

    83

 * - Added watchdog configuration (method ecrt_slave_config_watchdog(),

    84

 *   #ec_watchdog_mode_t, \a watchdog_mode parameter in ec_sync_info_t and

    85

 *   ecrt_slave_config_sync_manager()).

    86

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

    87

 *   configuration via CompleteAccess.

    88

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

    89

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

    90

 *   userspace.

    91

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

    92

 *   ecrt_master_get_slave(), ecrt_master_get_sync_manager(),

    93

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

    94

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

    95

 * - Added ecrt_master_sdo_download(), ecrt_master_sdo_download_complete() and

    96

 *   ecrt_master_sdo_upload() methods to let an application transfer SDOs

    97

 *   before activating the master.

    98

 * - Changed the meaning of the negative return values of

    99

 *   ecrt_slave_config_reg_pdo_entry() and ecrt_slave_config_sdo*().

   100

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

   101

 *   ecrt_slave_config_create_voe_handler().

   102

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

   103

 *   used by VoE handlers.

   104

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

   105

 *   userspace library has to modify object internals.

   106

 * - Added 64-bit data access macros.

   107

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

   108

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

   109

 *   ad-hoc via the user-space library.

   110

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

   111

 *

   112

 * @{

   113

 */

   114

   115

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

   116

   117

#ifndef __ECRT_H__

   118

#define __ECRT_H__

   119

   120

#ifdef __KERNEL__

   121

#include <asm/byteorder.h>

   122

#include <linux/types.h>

   123

#include <linux/time.h>

   124

#else

   125

#include <stdlib.h> // for size_t

   126

#include <stdint.h>

   127

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

   128

#endif

   129

   130

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

   131

 * Global definitions

   132

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

   133

   134

/** EtherCAT realtime interface major version number.

   135

 */

   136

#define ECRT_VER_MAJOR 1

   137

   138

/** EtherCAT realtime interface minor version number.

   139

 */

   140

#define ECRT_VER_MINOR 5

   141

   142

/** EtherCAT realtime interface version word generator.

   143

 */

   144

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

   145

   146

/** EtherCAT realtime interface version word.

   147

 */

   148

#define ECRT_VERSION_MAGIC ECRT_VERSION(ECRT_VER_MAJOR, ECRT_VER_MINOR)

   149

   150

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

   151

 * Feature flags

   152

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

   153

   154

/** Defined, if the redundancy features are available.

   155

 *

   156

 * I. e. if the \a redundancy_active flag in ec_domain_state_t and the

   157

 * ecrt_master_link_state() method are available.

   158

 */

   159

#define EC_HAVE_REDUNDANCY

   160

   161

/** Defined, if the CoE emergency ring feature is available.

   162

 *

   163

 * I. e. if the ecrt_slave_config_emerg_*() methods are available.

   164

 */

   165

#define EC_HAVE_EMERGENCY

   166

   167

/** Defined, if the register access interface is available.

   168

 *

   169

 * I. e. if the methods ecrt_slave_config_create_reg_request(),

   170

 * ecrt_reg_request_data(), ecrt_reg_request_state(), ecrt_reg_request_write()

   171

 * and ecrt_reg_request_read() are available.

   172

 */

   173

#define EC_HAVE_REG_ACCESS

   174

   175

/* Defined if the method ecrt_master_select_reference_clock() is available.

   176

 */

   177

#define EC_HAVE_SELECT_REF_CLOCK

   178

   179

/* Defined if the method ecrt_master_reference_clock_time() is available.

   180

 */

   181

#define EC_HAVE_REF_CLOCK_TIME

   182

   183

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

   184

   185

/** End of list marker.

   186

 *

   187

 * This can be used with ecrt_slave_config_pdos().

   188

 */

   189

#define EC_END ~0U

   190

   191

/** Maximum number of sync managers per slave.

   192

 */

   193

#define EC_MAX_SYNC_MANAGERS 16

   194

   195

/** Maximum string length.

   196

 *

   197

 * Used in ec_slave_info_t.

   198

 */

   199

#define EC_MAX_STRING_LENGTH 64

   200

   201

/** Maximum number of slave ports. */

   202

#define EC_MAX_PORTS 4

   203

   204

/** Timeval to nanoseconds conversion.

   205

 *

   206

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

   207

 *

   208

 * \see void ecrt_master_application_time()

   209

 *

   210

 * \param TV struct timeval containing epoch time.

   211

 */

   212

#define EC_TIMEVAL2NANO(TV) \

   213

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

   214

   215

/** Size of a CoE emergency message in byte.

   216

 *

   217

 * \see ecrt_slave_config_emerg_pop().

   218

 */

   219

#define EC_COE_EMERGENCY_MSG_SIZE 8

   220

   221

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

   222

 * Data types

   223

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

   224

   225

struct ec_master;

   226

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

   227

   228

struct ec_slave_config;

   229

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

   230

   231

struct ec_domain;

   232

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

   233

   234

struct ec_sdo_request;

   235

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

   236

   237

struct ec_voe_handler;

   238

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

   239

   240

struct ec_reg_request;

   241

typedef struct ec_reg_request ec_reg_request_t; /**< \see ec_sdo_request. */

   242

   243

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

   244

   245

/** Master state.

   246

 *

   247

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

   248

 *

   249

 * \see ecrt_master_state().

   250

 */

   251

typedef struct {

   252

    unsigned int slaves_responding; /**< Sum of responding slaves on all

   253

                                      Ethernet devices. */

   254

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

   255

                                  The states are coded in the lower 4 bits.

   256

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

   257

                                  slave in the bus is in the corresponding

   258

                                  state:

   259

                                  - Bit 0: \a INIT

   260

                                  - Bit 1: \a PREOP

   261

                                  - Bit 2: \a SAFEOP

   262

                                  - Bit 3: \a OP */

   263

    unsigned int link_up : 1; /**< \a true, if at least one Ethernet link is

   264

                                up. */

   265

} ec_master_state_t;

   266

   267

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

   268

   269

/** Redundant link state.

   270

 *

   271

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

   272

 *

   273

 * \see ecrt_master_link_state().

   274

 */

   275

typedef struct {

   276

    unsigned int slaves_responding; /**< Sum of responding slaves on the given

   277

                                      link. */

   278

    unsigned int al_states : 4; /**< Application-layer states of the slaves on

   279

                                  the given link.  The states are coded in the

   280

                                  lower 4 bits.  If a bit is set, it means

   281

                                  that at least one slave in the bus is in the

   282

                                  corresponding state:

   283

                                  - Bit 0: \a INIT

   284

                                  - Bit 1: \a PREOP

   285

                                  - Bit 2: \a SAFEOP

   286

                                  - Bit 3: \a OP */

   287

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

   288

                               */

   289

} ec_master_link_state_t;

   290

   291

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

   292

   293

/** Slave configuration state.

   294

 *

   295

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

   296

 *

   297

 * \see ecrt_slave_config_state().

   298

 */

   299

typedef struct  {

   300

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

   301

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

   302

                                    using the specified configuration. */

   303

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

   304

                                 - 1: \a INIT

   305

                                 - 2: \a PREOP

   306

                                 - 4: \a SAFEOP

   307

                                 - 8: \a OP

   308

   309

                                 Note that each state is coded in a different

   310

                                 bit! */

   311

} ec_slave_config_state_t;

   312

   313

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

   314

   315

/** Master information.

   316

 *

   317

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

   318

 *

   319

 * \see ecrt_master().

   320

 */

   321

typedef struct {

   322

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

   323

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

   324

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

   325

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

   326

} ec_master_info_t;

   327

   328

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

   329

   330

/** EtherCAT slave port descriptor.

   331

 */

   332

typedef enum {

   333

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

   334

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

   335

    EC_PORT_EBUS, /**< Port is an E-Bus. */

   336

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

   337

} ec_slave_port_desc_t;

   338

   339

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

   340

   341

/** EtherCAT slave port information.

   342

 */

   343

typedef struct {

   344

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

   345

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

   346

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

   347

} ec_slave_port_link_t;

   348

   349

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

   350

   351

/** Slave information.

   352

 *

   353

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

   354

 *

   355

 * \see ecrt_master_get_slave().

   356

 */

   357

typedef struct {

   358

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

   359

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

   360

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

   361

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

   362

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

   363

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

   364

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

   365

    struct {

   366

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

   367

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

   368

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

   369

                                 measurement. */

   370

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

   371

                               port.  */

   372

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

   373

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

   374

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

   375

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

   376

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

   377

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

   378

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

   379

} ec_slave_info_t;

   380

   381

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

   382

   383

/** Domain working counter interpretation.

   384

 *

   385

 * This is used in ec_domain_state_t.

   386

 */

   387

typedef enum {

   388

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

   389

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

   390

                        exchanged. */

   391

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

   392

} ec_wc_state_t;

   393

   394

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

   395

   396

/** Domain state.

   397

 *

   398

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

   399

 */

   400

typedef struct {

   401

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

   402

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

   403

    unsigned int redundancy_active; /**< Redundant link is in use. */

   404

} ec_domain_state_t;

   405

   406

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

   407

   408

/** Direction type for PDO assignment functions.

   409

 */

   410

typedef enum {

   411

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

   412

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

   413

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

   414

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

   415

} ec_direction_t;

   416

   417

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

   418

   419

/** Watchdog mode for sync manager configuration.

   420

 *

   421

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

   422

 */

   423

typedef enum {

   424

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

   425

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

   426

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

   427

} ec_watchdog_mode_t;

   428

   429

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

   430

   431

/** PDO entry configuration information.

   432

 *

   433

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

   434

 *

   435

 * \see ecrt_slave_config_pdos().

   436

 */

   437

typedef struct {

   438

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

   439

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

   440

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

   441

} ec_pdo_entry_info_t;

   442

   443

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

   444

   445

/** PDO configuration information.

   446

 *

   447

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

   448

 *

   449

 * \see ecrt_slave_config_pdos().

   450

 */

   451

typedef struct {

   452

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

   453

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

   454

                              Zero means, that the default mapping shall be

   455

                              used (this can only be done if the slave is

   456

                              present at bus configuration time). */

   457

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

   458

                                    be \a NULL, or must contain at

   459

                                    least \a n_entries values. */

   460

} ec_pdo_info_t;

   461

   462

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

   463

   464

/** Sync manager configuration information.

   465

 *

   466

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

   467

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

   468

 * ecrt_slave_config_pdos().

   469

 */

   470

typedef struct {

   471

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

   472

                     than #EC_MAX_SYNC_MANAGERS for a valid sync manager,

   473

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

   474

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

   475

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

   476

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

   477

                            at least \a n_pdos PDOs. */

   478

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

   479

} ec_sync_info_t;

   480

   481

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

   482

   483

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

   484

 *

   485

 * This type is used for the array parameter of the