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

/** Master information.

   212

 *

   213

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

   214

 *

   215

 * \see ecrt_master().

   216

 */

   217

typedef struct {

   218

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

   219

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

   220

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

   221

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

   222

} ec_master_info_t;

   223

   224

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

   225

   226

/** Slave information.

   227

 *

   228

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

   229

 *

   230

 * \see ecrt_master_get_slave().

   231

 */

   232

typedef struct {

   233

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

   234

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

   235

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

   236

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

   237

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

   238

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

   239

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

   240

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

   241

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

   242

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

   243

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

   244

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

   245

} ec_slave_info_t;

   246

   247

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

   248

   249

/** Domain working counter interpretation.

   250

 *

   251

 * This is used in ec_domain_state_t.

   252

 */

   253

typedef enum {

   254

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

   255

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

   256

                        exchanged. */

   257

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

   258

} ec_wc_state_t;

   259

   260

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

   261

   262

/** Domain state.

   263

 *

   264

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

   265

 */

   266

typedef struct {

   267

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

   268

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

   269

} ec_domain_state_t;

   270

   271

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

   272

   273

/** Direction type for PDO assignment functions.

   274

 */

   275

typedef enum {

   276

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

   277

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

   278

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

   279

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

   280

} ec_direction_t;

   281

   282

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

   283

   284

/** Watchdog mode for sync manager configuration.

   285

 *

   286

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

   287

 */

   288

typedef enum {

   289

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

   290

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

   291

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

   292

} ec_watchdog_mode_t;

   293

   294

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

   295

   296

/** PDO entry configuration information.

   297

 *

   298

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

   299

 *

   300

 * \see ecrt_slave_config_pdos().

   301

 */

   302

typedef struct {

   303

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

   304

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

   305

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

   306

} ec_pdo_entry_info_t;

   307

   308

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

   309

   310

/** PDO configuration information.

   311

 * 

   312

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

   313

 * 

   314

 * \see ecrt_slave_config_pdos().

   315

 */

   316

typedef struct {

   317

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

   318

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

   319

                              Zero means, that the default mapping shall be

   320

                              used (this can only be done if the slave is

   321

                              present at bus configuration time). */

   322

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

   323

                                    be \a NULL, or must contain at

   324

                                    least \a n_entries values. */

   325

} ec_pdo_info_t;

   326

   327

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

   328

   329

/** Sync manager configuration information.

   330

 *

   331

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

   332

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

   333

 * ecrt_slave_config_pdos().

   334

 */

   335

typedef struct {

   336

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

   337

                     than #EC_MAX_SYNC_MANAGERS for a valid sync manager,

   338

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

   339

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

   340

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

   341

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

   342

                            at least \a n_pdos PDOs. */

   343

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

   344

} ec_sync_info_t;

   345

   346

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

   347

   348

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

   349

 *

   350

 * This type is used for the array parameter of the

   351

 * ecrt_domain_reg_pdo_entry_list()

   352

 */

   353

typedef struct {

   354

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

   355

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

   356

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

   357

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

   358

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

   359

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

   360

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

   361

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

   362

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

   363

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

   364

                                  NULL, in which case an error is raised if the

   365

                                  PDO entry does not byte-align. */

   366

} ec_pdo_entry_reg_t;

   367

   368

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

   369

   370

/** Request state.

   371

 *

   372

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

   373

 * ecrt_voe_handler_state().

   374

 */

   375

typedef enum {

   376

    EC_REQUEST_UNUSED, /**< Not requested. */

   377

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

   378

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

   379

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

   380

} ec_request_state_t;

   381

   382

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

   383

 * Global functions

   384

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

   385

   386

#ifdef __cplusplus

   387

extern "C" {

   388

#endif

   389

   390

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

   391

 *

   392

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

   393

 */

   394

unsigned int ecrt_version_magic(void);

   395

   396

/** Requests an EtherCAT master for realtime operation.

   397

 * 

   398

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

   399

 * for exclusive use.

   400

 *

   401

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

   402

 * ecrt_master_reserve().

   403

 *

   404

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

   405

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

   406

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

   407

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

   408

 *

   409

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

   410

 */

   411

ec_master_t *ecrt_request_master(

   412

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

   413

        );

   414

   415

#ifndef __KERNEL__

   416

   417

/** Opens an EtherCAT master for userspace access.

   418

 *

   419

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

   420

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

   421

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

   422

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

   423

 *

   424

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

   425

 *

   426

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

   427

 */

   428

ec_master_t *ecrt_open_master(

   429

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

   430

        );

   431

   432

#endif // #ifndef __KERNEL__

   433

   434

/** Releases a requested EtherCAT master.

   435

 *

   436

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

   437

 * applications.

   438

 */

   439

void ecrt_release_master(

   440

        ec_master_t *master /**< EtherCAT master */

   441

        );

   442

   443

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

   444

 * Master methods

   445

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

   446

   447

#ifndef __KERNEL__

   448

   449

/** Reserves an EtherCAT master for realtime operation.

   450

 *

   451

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

   452

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

   453

 *

   454

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

   455

 *

   456

 */

   457

int ecrt_master_reserve(

   458

        ec_master_t *master /**< EtherCAT master */

   459

        );

   460

   461

#endif // #ifndef __KERNEL__

   462

   463

#ifdef __KERNEL__

   464

   465

/** Sets the locking callbacks.

   466

 *

   467

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

   468

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

   469

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

   470

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

   471

 * possible if the callbacks have been set.

   472

 *

   473

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

   474

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

   475

 * method.

   476

 *

   477

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

   478

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

   479

 */

   480

void ecrt_master_callbacks(

   481

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

   482

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

   483

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

   484

        void *cb_data /**< Arbitraty pointer passed to the callback functions.

   485

                       */