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 methods

    45

 *   ecrt_slave_config_dc_assign_activate(),

    46

 *   ecrt_slave_config_dc_sync_cycle_times() and

    47

 *   ecrt_slave_config_dc_sync_shift_times() to configure a slave for cyclic

    48

 *   operation, and ecrt_master_sync_reference_clock() and

    49

 *   ecrt_master_sync_slave_clocks() for drift compensation. The

    50

 *   EC_TIMEVAL2NANO() macro can be used for epoch time conversion.

    51

 * - Changed the meaning of the negative return values of

    52

 *   ecrt_slave_config_reg_pdo_entry() and ecrt_slave_config_sdo*().

    53

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

    54

 *   ecrt_slave_config_create_voe_handler().

    55

 * - Renamed ec_sdo_request_state_t to ec_request_state_t, because it is also

    56

 *   used by VoE handlers.

    57

 * - Added ecrt_master_slave() to get information about a certain slave.

    58

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

    59

 *   userspace library has to modify object internals.

    60

 * - Added 64-bit data access macros.

    61

 *

    62

 * @{

    63

 */

    64

    65

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

    66

    67

#ifndef __ECRT_H__

    68

#define __ECRT_H__

    69

    70

#ifdef __KERNEL__

    71

#include <asm/byteorder.h>

    72

#include <linux/types.h>

    73

#include <linux/time.h>

    74

#else

    75

#include <stdlib.h> // for size_t

    76

#include <stdint.h>

    77

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

    78

#endif

    79

    80

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

    81

 * Global definitions

    82

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

    83

    84

/** EtherCAT realtime interface major version number.

    85

 */

    86

#define ECRT_VER_MAJOR 1

    87

    88

/** EtherCAT realtime interface minor version number.

    89

 */

    90

#define ECRT_VER_MINOR 5

    91

    92

/** EtherCAT realtime interface version word generator.

    93

 */

    94

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

    95

    96

/** EtherCAT realtime interface version word.

    97

 */

    98

#define ECRT_VERSION_MAGIC ECRT_VERSION(ECRT_VER_MAJOR, ECRT_VER_MINOR)

    99

   100

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

   101

   102

/** End of list marker.

   103

 *

   104

 * This can be used with ecrt_slave_config_pdos().

   105

 */

   106

#define EC_END ~0U

   107

   108

/** Maximum number of sync managers per slave.

   109

 */

   110

#define EC_MAX_SYNC_MANAGERS 16

   111

   112

/** Maximum string length.

   113

 *

   114

 * Used in ec_slave_info_t.

   115

 */

   116

#define EC_MAX_STRING_LENGTH 64

   117

   118

/** Timeval to nanoseconds conversion.

   119

 *

   120

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

   121

 *

   122

 * \see ecrt_master_sync_reference_clock()

   123

 *

   124

 * \param TV Pointer to struct timeval.

   125

 */

   126

#define EC_TIMEVAL2NANO(TV) \

   127

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

   128

   129

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

   130

 * Data types 

   131

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

   132

   133

struct ec_master;

   134

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

   135

   136

struct ec_slave_config;

   137

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

   138

   139

struct ec_domain;

   140

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

   141

   142

struct ec_sdo_request;

   143

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

   144

   145

struct ec_voe_handler;

   146

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

   147

   148

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

   149

   150

/** Master state.

   151

 *

   152

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

   153

 *

   154

 * \see ecrt_master_state().

   155

 */

   156

typedef struct {

   157

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

   158

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

   159

                                  The states are coded in the lower 4 bits.

   160

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

   161

                                  slave in the bus is in the corresponding

   162

                                  state:

   163

                                  - Bit 0: \a INIT

   164

                                  - Bit 1: \a PREOP

   165

                                  - Bit 2: \a SAFEOP

   166

                                  - Bit 3: \a OP */

   167

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

   168

} ec_master_state_t;

   169

   170

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

   171

   172

/** Slave configuration state.

   173

 *

   174

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

   175

 * 

   176

 * \see ecrt_slave_config_state().

   177

 */

   178

typedef struct  {

   179

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

   180

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

   181

                                    using the specified configuration. */

   182

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

   183

                                 - 1: \a INIT

   184

                                 - 2: \a PREOP

   185

                                 - 4: \a SAFEOP

   186

                                 - 8: \a OP

   187

   188

                                 Note that each state is coded in a different

   189

                                 bit! */

   190

} ec_slave_config_state_t;

   191

   192

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

   193

   194

/** Slave information.

   195

 *

   196

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

   197

 *

   198

 * \see ecrt_master_slave().

   199

 */

   200

typedef struct {

   201

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

   202

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

   203

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

   204

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

   205

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

   206

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

   207

    int16_t current_on_ebus;

   208

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

   209

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

   210

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

   211

    uint16_t sdo_count; /**< Number of SDO's. */

   212

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

   213

} ec_slave_info_t;

   214

   215

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

   216

   217

/** Domain working counter interpretation.

   218

 *

   219

 * This is used in ec_domain_state_t.

   220

 */

   221

typedef enum {

   222

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

   223

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

   224

                        exchanged. */

   225

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

   226

} ec_wc_state_t;

   227

   228

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

   229

   230

/** Domain state.

   231

 *

   232

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

   233

 */

   234

typedef struct {

   235

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

   236

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

   237

} ec_domain_state_t;

   238

   239

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

   240

   241

/** Direction type for PDO assignment functions.

   242

 */

   243

typedef enum {

   244

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

   245

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

   246

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

   247

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

   248

} ec_direction_t;

   249

   250

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

   251

   252

/** PDO entry configuration information.

   253

 *

   254

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

   255

 *

   256

 * \see ecrt_slave_config_pdos().

   257

 */

   258

typedef struct {

   259

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

   260

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

   261

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

   262

} ec_pdo_entry_info_t;

   263

   264

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

   265

   266

/** PDO configuration information.

   267

 * 

   268

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

   269

 * 

   270

 * \see ecrt_slave_config_pdos().

   271

 */

   272

typedef struct {

   273

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

   274

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

   275

                              Zero means, that the default mapping shall be

   276

                              used (this can only be done if the slave is

   277

                              present at bus configuration time). */

   278

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

   279

                                    be \a NULL, or must contain at

   280

                                    least \a n_entries values. */

   281

} ec_pdo_info_t;

   282

   283

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

   284

   285

/** Sync manager configuration information.

   286

 *

   287

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

   288

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

   289

 * ecrt_slave_config_pdos().

   290

 */

   291

typedef struct {

   292

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

   293

                     than #EC_MAX_SYNC_MANAGERS for a valid sync manager,

   294

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

   295

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

   296

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

   297

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

   298

                            at least \a n_pdos PDOs. */

   299

} ec_sync_info_t;

   300

   301

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

   302

   303

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

   304

 *

   305

 * This type is used for the array parameter of the

   306

 * ecrt_domain_reg_pdo_entry_list()

   307

 */

   308

typedef struct {

   309

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

   310

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

   311

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

   312

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

   313

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

   314

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

   315

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

   316

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

   317

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

   318

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

   319

                                  NULL, in which case an error is raised if the

   320

                                  PDO entry does not byte-align. */

   321

} ec_pdo_entry_reg_t;

   322

   323

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

   324

   325

/** Request state.

   326

 *

   327

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

   328

 * ecrt_voe_handler_state().

   329

 */

   330

typedef enum {

   331

    EC_REQUEST_UNUSED, /**< Not requested. */

   332

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

   333

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

   334

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

   335

} ec_request_state_t;

   336

   337

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

   338

 * Global functions

   339

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

   340

   341

#ifdef __cplusplus

   342

extern "C" {

   343

#endif

   344

   345

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

   346

 *

   347

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

   348

 */

   349

unsigned int ecrt_version_magic(void);

   350

   351

/** Requests an EtherCAT master for realtime operation.

   352

 * 

   353

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

   354

 * for exclusive use.

   355

 *

   356

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

   357

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

   358

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

   359

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

   360

 *

   361

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

   362

 */

   363

ec_master_t *ecrt_request_master(

   364

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

   365

        );

   366

   367

/** Releases a requested EtherCAT master.

   368

 *

   369

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

   370

 * applications.

   371

 */

   372

void ecrt_release_master(

   373

        ec_master_t *master /**< EtherCAT master */

   374

        );

   375

   376

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

   377

 * Master methods

   378

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

   379

   380

#ifdef __KERNEL__

   381

   382

/** Sets the locking callbacks.

   383

 *

   384

 * For concurrent master access, the application has to provide a locking

   385

 * mechanism (see section FIXME in the docs). The method takes two function

   386

 * pointers and a data value as its parameters. The arbitrary \a cb_data value

   387

 * will be passed as argument on every callback. Asynchronous master access

   388

 * (like EoE processing) is only possible if the callbacks have been set.

   389

 *

   390

 * The request_cb function must return zero, to allow another instance

   391

 * (an EoE process for example) to access the master. Non-zero means,

   392

 * that access is currently forbidden.

   393

 */

   394

void ecrt_master_callbacks(

   395

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

   396

        int (*request_cb)(void *), /**< Lock request function. */

   397

        void (*release_cb)(void *), /**< Lock release function. */

   398

        void *cb_data /**< Arbitrary user data. */

   399

        );

   400

   401

#endif /* __KERNEL__ */

   402

   403

/** Creates a new process data domain.

   404

 *

   405

 * For process data exchange, at least one process data domain is needed.

   406

 * This method creates a new process data domain and returns a pointer to the

   407

 * new domain object. This object can be used for registering PDOs and

   408

 * exchanging them in cyclic operation.

   409

 *

   410

 * \return Pointer to the new domain on success, else NULL.

   411

 */

   412

ec_domain_t *ecrt_master_create_domain(

   413

        ec_master_t *master /**< EtherCAT master. */

   414

        );

   415

   416

/** Obtains a slave configuration.

   417

 *

   418

 * Creates a slave configuration object for the given \a alias and \a position

   419

 * tuple and returns it. If a configuration with the same \a alias and \a

   420

 * position already exists, it will be re-used. In the latter case, the given

   421

 * vendor ID and product code are compared to the stored ones. On mismatch, an

   422

 * error message is raised and the function returns \a NULL.

   423

 *

   424

 * Slaves are addressed with the \a alias and \a position parameters.

   425

 * - If \a alias is zero, \a position is interpreted as the desired slave's

   426

 *   ring position.

   427

 * - If \a alias is non-zero, it matches a slave with the given alias. In this

   428

 *   case, \a position is interpreted as ring offset, starting from the

   429

 *   aliased slave, so a position of zero means the aliased slave itself and a

   430

 *   positive value matches the n-th slave behind the aliased one.

   431

 *

   432

 * If the slave with the given address is found during the bus configuration,

   433

 * its vendor ID and product code are matched against the given value. On

   434

 * mismatch, the slave is not configured and an error message is raised.

   435

 *

   436

 * If different slave configurations are pointing to the same slave during bus

   437

 * configuration, a warning is raised and only the first configuration is

   438

 * applied.

   439

 *

   440

 * \retval >0 Pointer to the slave configuration structure.

   441

 * \retval NULL in the error case.

   442

 */

   443

ec_slave_config_t *ecrt_master_slave_config(

   444

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

   445

        uint16_t alias, /**< Slave alias. */

   446

        uint16_t position, /**< Slave position. */

   447

        uint32_t vendor_id, /**< Expected vendor ID. */

   448

        uint32_t product_code /**< Expected product code. */

   449

        );

   450

   451

/** Obtains slave information.

   452

 *

   453

 * Tries to find the slave with the given ring position. The obtained

   454

 * information is stored in a structure. No memory is allocated on the heap in

   455

 * this function.

   456

 *

   457

 * \attention The pointer to this structure must point to a valid variable.

   458

 *

   459

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

   460

 */

   461

int ecrt_master_slave(

   462

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

   463

        uint16_t position, /**< Slave position. */

   464

        ec_slave_info_t *slave_info /**< Structure that will output the

   465

                                      information */

   466

        );

   467

   468

/** Finishes the configuration phase and prepares for cyclic operation.

   469

 *

   470

 * This function tells the master that the configuration phase is finished and

   471

 * the realtime operation will begin. The function allocates internal memory

   472

 * for the domains and calculates the logical FMMU addresses for domain

   473

 * members. It tells the master state machine that the bus configuration is

   474

 * now to be applied.

   475

 *

   476

 * \attention After this function has been called, the realtime application is

   477

 * in charge of cyclically calling ecrt_master_send() and

   478

 * ecrt_master_receive() to ensure bus communication. Before calling this

   479

 * function, the master thread is responsible for that, so these functions may

   480

 * not be called!

   481

 *

   482

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

   483

 */

   484

int ecrt_master_activate(

   485

        ec_master_t *master /**< EtherCAT master. */

   486

        );

   487