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

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

    79

 *

    80

 * @{

    81

 */

    82

    83

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

    84

    85

#ifndef __ECRT_H__

    86

#define __ECRT_H__

    87

    88

#ifdef __KERNEL__

    89

#include <asm/byteorder.h>

    90

#include <linux/types.h>

    91

#include <linux/time.h>

    92

#else

    93

#include <stdlib.h> // for size_t

    94

#include <stdint.h>

    95

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

    96

#endif

    97

    98

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

    99

 * Global definitions

   100

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

   101

   102

/** EtherCAT realtime interface major version number.

   103

 */

   104

#define ECRT_VER_MAJOR 1

   105

   106

/** EtherCAT realtime interface minor version number.

   107

 */

   108

#define ECRT_VER_MINOR 5

   109

   110

/** EtherCAT realtime interface version word generator.

   111

 */

   112

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

   113

   114

/** EtherCAT realtime interface version word.

   115

 */

   116

#define ECRT_VERSION_MAGIC ECRT_VERSION(ECRT_VER_MAJOR, ECRT_VER_MINOR)

   117

   118

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

   119

   120

/** End of list marker.

   121

 *

   122

 * This can be used with ecrt_slave_config_pdos().

   123

 */

   124

#define EC_END ~0U

   125

   126

/** Maximum number of sync managers per slave.

   127

 */

   128

#define EC_MAX_SYNC_MANAGERS 16

   129

   130

/** Maximum string length.

   131

 *

   132

 * Used in ec_slave_info_t.

   133

 */

   134

#define EC_MAX_STRING_LENGTH 64

   135

   136

/** Timeval to nanoseconds conversion.

   137

 *

   138

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

   139

 *

   140

 * \see void ecrt_master_application_time()

   141

 *

   142

 * \param TV struct timeval containing epoch time.

   143

 */

   144

#define EC_TIMEVAL2NANO(TV) \

   145

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

   146

   147

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

   148

 * Data types 

   149

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

   150

   151

struct ec_master;

   152

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

   153

   154

struct ec_slave_config;

   155

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

   156

   157

struct ec_domain;

   158

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

   159

   160

struct ec_sdo_request;

   161

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

   162

   163

struct ec_voe_handler;

   164

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

   165

   166

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

   167

   168

/** Master state.

   169

 *

   170

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

   171

 *

   172

 * \see ecrt_master_state().

   173

 */

   174

typedef struct {

   175

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

   176

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

   177

                                  The states are coded in the lower 4 bits.

   178

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

   179

                                  slave in the bus is in the corresponding

   180

                                  state:

   181

                                  - Bit 0: \a INIT

   182

                                  - Bit 1: \a PREOP

   183

                                  - Bit 2: \a SAFEOP

   184

                                  - Bit 3: \a OP */

   185

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

   186

} ec_master_state_t;

   187

   188

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

   189

   190

/** Slave configuration state.

   191

 *

   192

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

   193

 * 

   194

 * \see ecrt_slave_config_state().

   195

 */

   196

typedef struct  {

   197

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

   198

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

   199

                                    using the specified configuration. */

   200

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

   201

                                 - 1: \a INIT

   202

                                 - 2: \a PREOP

   203

                                 - 4: \a SAFEOP

   204

                                 - 8: \a OP

   205

   206

                                 Note that each state is coded in a different

   207

                                 bit! */

   208

} ec_slave_config_state_t;

   209

   210

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

   211

   212

/** Master information.

   213

 *

   214

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

   215

 *

   216

 * \see ecrt_master().

   217

 */

   218

typedef struct {

   219

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

   220

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

   221

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

   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

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

   249

   250

/** Domain working counter interpretation.

   251

 *

   252

 * This is used in ec_domain_state_t.

   253

 */

   254

typedef enum {

   255

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

   256

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

   257

                        exchanged. */

   258

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

   259

} ec_wc_state_t;

   260

   261

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

   262

   263

/** Domain state.

   264

 *

   265

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

   266

 */

   267

typedef struct {

   268

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

   269

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

   270

} ec_domain_state_t;

   271

   272

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

   273

   274

/** Direction type for PDO assignment functions.

   275

 */

   276

typedef enum {

   277

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

   278

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

   279

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

   280

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

   281

} ec_direction_t;

   282

   283

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

   284

   285

/** Watchdog mode for sync manager configuration.

   286

 *

   287

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

   288

 */

   289

typedef enum {

   290

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

   291

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

   292

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

   293

} ec_watchdog_mode_t;

   294

   295

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

   296

   297

/** PDO entry configuration information.

   298

 *

   299

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

   300

 *

   301

 * \see ecrt_slave_config_pdos().

   302

 */

   303

typedef struct {

   304

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

   305

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

   306

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

   307

} ec_pdo_entry_info_t;

   308

   309

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

   310

   311

/** PDO configuration information.

   312

 * 

   313

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

   314

 * 

   315

 * \see ecrt_slave_config_pdos().

   316

 */

   317

typedef struct {

   318

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

   319

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

   320

                              Zero means, that the default mapping shall be

   321

                              used (this can only be done if the slave is

   322

                              present at bus configuration time). */

   323

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

   324

                                    be \a NULL, or must contain at

   325

                                    least \a n_entries values. */

   326

} ec_pdo_info_t;

   327

   328

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

   329

   330

/** Sync manager configuration information.

   331

 *

   332

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

   333

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

   334

 * ecrt_slave_config_pdos().

   335

 */

   336

typedef struct {

   337

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

   338

                     than #EC_MAX_SYNC_MANAGERS for a valid sync manager,

   339

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

   340

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

   341

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

   342

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

   343

                            at least \a n_pdos PDOs. */

   344

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

   345

} ec_sync_info_t;

   346

   347

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

   348

   349

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

   350

 *

   351

 * This type is used for the array parameter of the

   352

 * ecrt_domain_reg_pdo_entry_list()

   353

 */

   354

typedef struct {

   355

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

   356

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

   357

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

   358

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

   359

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

   360

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

   361

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

   362

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

   363

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

   364

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

   365

                                  NULL, in which case an error is raised if the

   366

                                  PDO entry does not byte-align. */

   367

} ec_pdo_entry_reg_t;

   368

   369

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

   370

   371

/** Request state.

   372

 *

   373

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

   374

 * ecrt_voe_handler_state().

   375

 */

   376

typedef enum {

   377

    EC_REQUEST_UNUSED, /**< Not requested. */

   378

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

   379

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

   380

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

   381

} ec_request_state_t;

   382

   383

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

   384

 * Global functions

   385

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

   386

   387

#ifdef __cplusplus

   388

extern "C" {

   389

#endif

   390

   391

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

   392

 *

   393

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

   394

 */

   395

unsigned int ecrt_version_magic(void);

   396

   397

/** Requests an EtherCAT master for realtime operation.

   398

 * 

   399

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

   400

 * for exclusive use.

   401

 *

   402

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

   403

 * ecrt_master_reserve().

   404

 *

   405

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

   406

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

   407

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

   408

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

   409

 *

   410

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

   411

 */

   412

ec_master_t *ecrt_request_master(

   413

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

   414

        );

   415

   416

#ifndef __KERNEL__

   417

   418

/** Opens an EtherCAT master for userspace access.

   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

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

   426

 *

   427

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

   428

 */

   429

ec_master_t *ecrt_open_master(

   430

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

   431

        );

   432

   433

#endif // #ifndef __KERNEL__

   434

   435

/** Releases a requested EtherCAT master.

   436

 *

   437

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

   438

 * applications.

   439

 */

   440

void ecrt_release_master(

   441

        ec_master_t *master /**< EtherCAT master */

   442

        );

   443

   444

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

   445

 * Master methods

   446

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

   447

   448

#ifndef __KERNEL__

   449

   450

/** Reserves an EtherCAT master for realtime operation.

   451

 *

   452

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

   453

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

   454

 *

   455

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

   456

 *

   457

 */

   458

int ecrt_master_reserve(

   459

        ec_master_t *master /**< EtherCAT master */

   460

        );

   461

   462

#endif // #ifndef __KERNEL__

   463

   464

#ifdef __KERNEL__

   465

   466

/** Sets the locking callbacks.

   467

 *

   468

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

   469

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

   470

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

   471

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

   472

 * possible if the callbacks have been set.

   473

 *

   474

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

   475

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

   476

 * method.

   477

 *

   478

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

   479

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

   480

 */

   481

void ecrt_master_callbacks(

   482

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

   483

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

   484

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

   485

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