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 sending and receiving datagrams.

    53

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

    54

 *   datagrams.

    55

 * - Added watchdog configuration (method ecrt_slave_config_watchdog(),

    56

 *   #ec_watchdog_mode_t, \a watchdog_mode parameter in ec_sync_info_t and

    57

 *   ecrt_slave_config_sync_manager()).

    58

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

    59

 *   configuration via CompleteAccess.

    60

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

    61

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

    62

 *   userspace.

    63

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

    64

 *   ecrt_master_get_slave(), ecrt_master_get_sync_manager(),

    65

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

    66

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

    67

 * - Added ecrt_master_sdo_download(), ecrt_master_sdo_download_complete() and

    68

 *   ecrt_master_sdo_upload() methods to let an application transfer SDOs

    69

 *   before activating the master.

    70

 * - Changed the meaning of the negative return values of

    71

 *   ecrt_slave_config_reg_pdo_entry() and ecrt_slave_config_sdo*().

    72

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

    73

 *   ecrt_slave_config_create_voe_handler().

    74

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

    75

 *   used by VoE handlers.

    76

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

    77

 *   userspace library has to modify object internals.

    78

 * - Added 64-bit data access macros.

    79

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

    80

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

    81

 *   ad-hoc via the user-space library.

    82

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

    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

/** Timeval to nanoseconds conversion.

   141

 *

   142

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

   143

 *

   144

 * \see void ecrt_master_application_time()

   145

 *

   146

 * \param TV struct timeval containing epoch time.

   147

 */

   148

#define EC_TIMEVAL2NANO(TV) \

   149

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

   150

   151

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

   152

 * Data types 

   153

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

   154

   155

struct ec_master;

   156

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

   157

   158

struct ec_slave_config;

   159

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

   160

   161

struct ec_domain;

   162

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

   163

   164

struct ec_sdo_request;

   165

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

   166

   167

struct ec_voe_handler;

   168

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

   169

   170

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

   171

   172

/** Master state.

   173

 *

   174

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

   175

 *

   176

 * \see ecrt_master_state().

   177

 */

   178

typedef struct {

   179

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

   180

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

   181

                                  The states are coded in the lower 4 bits.

   182

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

   183

                                  slave in the bus is in the corresponding

   184

                                  state:

   185

                                  - Bit 0: \a INIT

   186

                                  - Bit 1: \a PREOP

   187

                                  - Bit 2: \a SAFEOP

   188

                                  - Bit 3: \a OP */

   189

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

   190

} ec_master_state_t;

   191

   192

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

   193

   194

/** Slave configuration state.

   195

 *

   196

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

   197

 * 

   198

 * \see ecrt_slave_config_state().

   199

 */

   200

typedef struct  {

   201

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

   202

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

   203

                                    using the specified configuration. */

   204

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

   205

                                 - 1: \a INIT

   206

                                 - 2: \a PREOP

   207

                                 - 4: \a SAFEOP

   208

                                 - 8: \a OP

   209

   210

                                 Note that each state is coded in a different

   211

                                 bit! */

   212

} ec_slave_config_state_t;

   213

   214

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

   215

   216

/** Master information.

   217

 *

   218

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

   219

 *

   220

 * \see ecrt_master().

   221

 */

   222

typedef struct {

   223

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

   224

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

   225

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

   226

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

   227

} ec_master_info_t;

   228

   229

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

   230

   231

/** Slave information.

   232

 *

   233

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

   234

 *

   235

 * \see ecrt_master_get_slave().

   236

 */

   237

typedef struct {

   238

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

   239

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

   240

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

   241

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

   242

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

   243

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

   244

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

   245

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

   246

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

   247

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

   248

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

   249

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

   250

} ec_slave_info_t;

   251

   252

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

   253

   254

/** Domain working counter interpretation.

   255

 *

   256

 * This is used in ec_domain_state_t.

   257

 */

   258

typedef enum {

   259

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

   260

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

   261

                        exchanged. */

   262

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

   263

} ec_wc_state_t;

   264

   265

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

   266

   267

/** Domain state.

   268

 *

   269

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

   270

 */

   271

typedef struct {

   272

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

   273

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

   274

} ec_domain_state_t;

   275

   276

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

   277

   278

/** Direction type for PDO assignment functions.

   279

 */

   280

typedef enum {

   281

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

   282

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

   283

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

   284

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

   285

} ec_direction_t;

   286

   287

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

   288

   289

/** Watchdog mode for sync manager configuration.

   290

 *

   291

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

   292

 */

   293

typedef enum {

   294

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

   295

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

   296

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

   297

} ec_watchdog_mode_t;

   298

   299

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

   300

   301

/** PDO entry configuration information.

   302

 *

   303

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

   304

 *

   305

 * \see ecrt_slave_config_pdos().

   306

 */

   307

typedef struct {

   308

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

   309

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

   310

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

   311

} ec_pdo_entry_info_t;

   312

   313

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

   314

   315

/** PDO configuration information.

   316

 * 

   317

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

   318

 * 

   319

 * \see ecrt_slave_config_pdos().

   320

 */

   321

typedef struct {

   322

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

   323

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

   324

                              Zero means, that the default mapping shall be

   325

                              used (this can only be done if the slave is

   326

                              present at bus configuration time). */

   327

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

   328

                                    be \a NULL, or must contain at

   329

                                    least \a n_entries values. */

   330

} ec_pdo_info_t;

   331

   332

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

   333

   334

/** Sync manager configuration information.

   335

 *

   336

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

   337

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

   338

 * ecrt_slave_config_pdos().

   339

 */

   340

typedef struct {

   341

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

   342

                     than #EC_MAX_SYNC_MANAGERS for a valid sync manager,

   343

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

   344

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

   345

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

   346

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

   347

                            at least \a n_pdos PDOs. */

   348

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

   349

} ec_sync_info_t;

   350

   351

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

   352

   353

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

   354

 *

   355

 * This type is used for the array parameter of the

   356

 * ecrt_domain_reg_pdo_entry_list()

   357

 */

   358

typedef struct {

   359

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

   360

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

   361

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

   362

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

   363

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

   364

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

   365

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

   366

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

   367

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

   368

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

   369

                                  NULL, in which case an error is raised if the

   370

                                  PDO entry does not byte-align. */

   371

} ec_pdo_entry_reg_t;

   372

   373

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

   374

   375

/** Request state.

   376

 *

   377

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

   378

 * ecrt_voe_handler_state().

   379

 */

   380

typedef enum {

   381

    EC_REQUEST_UNUSED, /**< Not requested. */

   382

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

   383

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

   384

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

   385

} ec_request_state_t;

   386

   387

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

   388

   389

/** Application-layer state.

   390

 */

   391

typedef enum {

   392

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

   393

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

   394

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

   395

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

   396

} ec_al_state_t;

   397

   398

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

   399

 * Global functions

   400

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

   401

   402

#ifdef __cplusplus

   403

extern "C" {

   404

#endif

   405

   406

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

   407

 *

   408

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

   409

 */

   410

unsigned int ecrt_version_magic(void);

   411

   412

/** Requests an EtherCAT master for realtime operation.

   413

 * 

   414

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

   415

 * for exclusive use.

   416

 *

   417

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

   418

 * ecrt_master_reserve().

   419

 *

   420

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

   421

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

   422

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

   423

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

   424

 *

   425

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

   426

 */

   427

ec_master_t *ecrt_request_master(

   428

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

   429

        );

   430

   431

#ifndef __KERNEL__

   432

   433

/** Opens an EtherCAT master for userspace access.

   434

 *

   435

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

   436

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

   437

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

   438

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

   439

 *

   440

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

   441

 *

   442

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

   443

 */

   444

ec_master_t *ecrt_open_master(

   445

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

   446

        );

   447

   448

#endif // #ifndef __KERNEL__

   449

   450

/** Releases a requested EtherCAT master.

   451

 *

   452

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

   453

 * applications.

   454

 */

   455

void ecrt_release_master(

   456

        ec_master_t *master /**< EtherCAT master */

   457

        );

   458

   459

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

   460

 * Master methods

   461

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

   462

   463

#ifndef __KERNEL__

   464

   465

/** Reserves an EtherCAT master for realtime operation.

   466

 *

   467

 * Before an application can use PDO/domain registration functions or SDO

   468

 * request functions on the master, it has to reserve one for exclusive use.

   469

 *

   470

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

   471

 *

   472

 */

   473

int ecrt_master_reserve(

   474

        ec_master_t *master /**< EtherCAT master */

   475

        );

   476

   477

#endif // #ifndef __KERNEL__

   478

   479

#ifdef __KERNEL__

   480

   481

/** Sets the locking callbacks.

   482

 *

   483

 * For concurrent master access, i. e. if other instances than the application

   484

 * want to send and receive datagrams on the bus, the application has to

   485

 * provide a callback mechanism. This method takes two function pointers as