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

    68

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

    69

 * - Changed the meaning of the negative return values of

    70

 *   ecrt_slave_config_reg_pdo_entry() and ecrt_slave_config_sdo*().

    71

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

    72

 *   ecrt_slave_config_create_voe_handler().

    73

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

    74

 *   used by VoE handlers.

    75

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

    76

 *   userspace library has to modify object internals.

    77

 * - Added 64-bit data access macros.

    78

 *

    79

 * @{

    80

 */

    81

    82

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

    83

    84

#ifndef __ECRT_H__

    85

#define __ECRT_H__

    86

    87

#ifdef __KERNEL__

    88

#include <asm/byteorder.h>

    89

#include <linux/types.h>

    90

#include <linux/time.h>

    91

#else

    92

#include <stdlib.h> // for size_t

    93

#include <stdint.h>

    94

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

    95

#endif

    96

    97

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

    98

 * Global definitions

    99

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

   100

   101

/** EtherCAT realtime interface major version number.

   102

 */

   103

#define ECRT_VER_MAJOR 1

   104

   105

/** EtherCAT realtime interface minor version number.

   106

 */

   107

#define ECRT_VER_MINOR 5

   108

   109

/** EtherCAT realtime interface version word generator.

   110

 */

   111

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

   112

   113

/** EtherCAT realtime interface version word.

   114

 */

   115

#define ECRT_VERSION_MAGIC ECRT_VERSION(ECRT_VER_MAJOR, ECRT_VER_MINOR)

   116

   117

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

   118

   119

/** End of list marker.

   120

 *

   121

 * This can be used with ecrt_slave_config_pdos().

   122

 */

   123

#define EC_END ~0U

   124

   125

/** Maximum number of sync managers per slave.

   126

 */

   127

#define EC_MAX_SYNC_MANAGERS 16

   128

   129

/** Maximum string length.

   130

 *

   131

 * Used in ec_slave_info_t.

   132

 */

   133

#define EC_MAX_STRING_LENGTH 64

   134

   135

/** Timeval to nanoseconds conversion.

   136

 *

   137

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

   138

 *

   139

 * \see void ecrt_master_application_time()

   140

 *

   141

 * \param TV struct timeval containing epoch time.

   142

 */

   143

#define EC_TIMEVAL2NANO(TV) \

   144

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

   145

   146

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

   147

 * Data types 

   148

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

   149

   150

struct ec_master;

   151

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

   152

   153

struct ec_slave_config;

   154

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

   155

   156

struct ec_domain;

   157

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

   158

   159

struct ec_sdo_request;

   160

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

   161

   162

struct ec_voe_handler;

   163

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

   164

   165

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

   166

   167

/** Master state.

   168

 *

   169

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

   170

 *

   171

 * \see ecrt_master_state().

   172

 */

   173

typedef struct {

   174

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

   175

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

   176

                                  The states are coded in the lower 4 bits.

   177

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

   178

                                  slave in the bus is in the corresponding

   179

                                  state:

   180

                                  - Bit 0: \a INIT

   181

                                  - Bit 1: \a PREOP

   182

                                  - Bit 2: \a SAFEOP

   183

                                  - Bit 3: \a OP */

   184

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

   185

} ec_master_state_t;

   186

   187

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

   188

   189

/** Slave configuration state.

   190

 *

   191

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

   192

 * 

   193

 * \see ecrt_slave_config_state().

   194

 */

   195

typedef struct  {

   196

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

   197

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

   198

                                    using the specified configuration. */

   199

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

   200

                                 - 1: \a INIT

   201

                                 - 2: \a PREOP

   202

                                 - 4: \a SAFEOP

   203

                                 - 8: \a OP

   204

   205

                                 Note that each state is coded in a different

   206

                                 bit! */

   207

} ec_slave_config_state_t;

   208

   209

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

   210

   211

#ifndef __KERNEL__

   212

   213

/** Master information.

   214

 *

   215

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

   216

 *

   217

 * \see ecrt_master().

   218

 */

   219

typedef struct {

   220

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

   221

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

   222

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

   223

} ec_master_info_t;

   224

   225

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

   226

   227

/** Slave information.

   228

 *

   229

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

   230

 *

   231

 * \see ecrt_master_get_slave().

   232

 */

   233

typedef struct {

   234

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

   235

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

   236

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

   237

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

   238

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

   239

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

   240

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

   241

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

   242

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

   243

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

   244

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

   245

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

   246

} ec_slave_info_t;

   247

   248

#endif // #ifndef __KERNEL__

   249

   250

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

   251

   252

/** Domain working counter interpretation.

   253

 *

   254

 * This is used in ec_domain_state_t.

   255

 */

   256

typedef enum {

   257

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

   258

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

   259

                        exchanged. */

   260

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

   261

} ec_wc_state_t;

   262

   263

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

   264

   265

/** Domain state.

   266

 *

   267

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

   268

 */

   269

typedef struct {

   270

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

   271

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

   272

} ec_domain_state_t;

   273

   274

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

   275

   276

/** Direction type for PDO assignment functions.

   277

 */

   278

typedef enum {

   279

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

   280

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

   281

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

   282

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

   283

} ec_direction_t;

   284

   285

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

   286

   287

/** Watchdog mode for sync manager configuration.

   288

 *

   289

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

   290

 */

   291

typedef enum {

   292

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

   293

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

   294

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

   295

} ec_watchdog_mode_t;

   296

   297

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

   298

   299

/** PDO entry configuration information.

   300

 *

   301

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

   302

 *

   303

 * \see ecrt_slave_config_pdos().

   304

 */

   305

typedef struct {

   306

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

   307

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

   308

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

   309

} ec_pdo_entry_info_t;

   310

   311

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

   312

   313

/** PDO configuration information.

   314

 * 

   315

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

   316

 * 

   317

 * \see ecrt_slave_config_pdos().

   318

 */

   319

typedef struct {

   320

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

   321

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

   322

                              Zero means, that the default mapping shall be

   323

                              used (this can only be done if the slave is

   324

                              present at bus configuration time). */

   325

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

   326

                                    be \a NULL, or must contain at

   327

                                    least \a n_entries values. */

   328

} ec_pdo_info_t;

   329

   330

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

   331

   332

/** Sync manager configuration information.

   333

 *

   334

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

   335

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

   336

 * ecrt_slave_config_pdos().

   337

 */

   338

typedef struct {

   339

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

   340

                     than #EC_MAX_SYNC_MANAGERS for a valid sync manager,

   341

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

   342

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

   343

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

   344

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

   345

                            at least \a n_pdos PDOs. */

   346

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

   347

} ec_sync_info_t;

   348

   349

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

   350

   351

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

   352

 *

   353

 * This type is used for the array parameter of the

   354

 * ecrt_domain_reg_pdo_entry_list()

   355

 */

   356

typedef struct {

   357

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

   358

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

   359

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

   360

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

   361

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

   362

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

   363

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

   364

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

   365

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

   366

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

   367

                                  NULL, in which case an error is raised if the

   368

                                  PDO entry does not byte-align. */

   369

} ec_pdo_entry_reg_t;

   370

   371

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

   372

   373

/** Request state.

   374

 *

   375

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

   376

 * ecrt_voe_handler_state().

   377

 */

   378

typedef enum {

   379

    EC_REQUEST_UNUSED, /**< Not requested. */

   380

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

   381

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

   382

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

   383

} ec_request_state_t;

   384

   385

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

   386

 * Global functions

   387

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

   388

   389

#ifdef __cplusplus

   390

extern "C" {

   391

#endif

   392

   393

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

   394

 *

   395

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

   396

 */

   397

unsigned int ecrt_version_magic(void);

   398

   399

/** Requests an EtherCAT master for realtime operation.

   400

 * 

   401

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

   402

 * for exclusive use.

   403

 *

   404

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

   405

 * ecrt_master_reserve().

   406

 *

   407

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

   408

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

   409

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

   410

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

   411

 *

   412

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

   413

 */

   414

ec_master_t *ecrt_request_master(

   415

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

   416

        );

   417

   418

#ifndef __KERNEL__

   419

   420

/** Opens an EtherCAT master for userspace access.

   421

 *

   422

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

   423

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

   424

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

   425

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

   426

 *

   427

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

   428

 *

   429

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

   430

 */

   431

ec_master_t *ecrt_open_master(

   432

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

   433

		);

   434

   435

#endif // #ifndef __KERNEL__

   436

   437

/** Releases a requested EtherCAT master.

   438

 *

   439

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

   440

 * applications.

   441

 */

   442

void ecrt_release_master(

   443

        ec_master_t *master /**< EtherCAT master */

   444

        );

   445

   446

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

   447

 * Master methods

   448

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

   449

   450

#ifndef __KERNEL__

   451

   452

/** Reserves an EtherCAT master for realtime operation.

   453

 *

   454

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

   455

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

   456

 *

   457

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

   458

 *

   459

 */

   460

int ecrt_master_reserve(

   461

		ec_master_t *master /**< EtherCAT master */

   462

		);

   463

   464

#endif // #ifndef __KERNEL__

   465

   466

#ifdef __KERNEL__

   467

   468

/** Sets the locking callbacks.

   469

 *

   470

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

   471

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

   472

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

   473

 * its parameters. Asynchronous master access (like EoE processing) is only

   474

 * possible if the callbacks have been set.

   475

 *

   476

 * The task of the send callback (\a send_cb) is to decide, if the bus is

   477

 * currently accessible and whether or not to call the ecrt_master_send_ext()

   478

 * method.

   479

 *

   480

 * The task of the receive callback (\a receive_cb) is to decide, if a call to

   481

 * ecrt_master_receive() is allowed and to execute it respectively.

   482

 */

   483

void ecrt_master_callbacks(

   484

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

   485

        void (*send_cb)(void *), /**< Datagram sending callback. */

   486

        void (*receive_cb)(void *), /**< Receive callback. */