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

 * - Changed the meaning of the negative return values of

    45

 *   ecrt_slave_config_reg_pdo_entry() and ecrt_slave_config_sdo*().

    46

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

    47

 *   ecrt_slave_config_create_voe_handler().

    48

 * - Renamed ec_sdo_request_state_t to ec_request_state_t, because it is also

    49

 *   used by VoE handlers.

    50

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

    51

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

    52

 *   userspace library has to modify object internals.

    53

 *

    54

 * Changes in Version 1.4:

    55

 *

    56

 * - Replaced ec_slave_t with ec_slave_config_t, separating the bus

    57

 *   configuration from the actual slaves. Therefore, renamed

    58

 *   ecrt_master_get_slave() to ecrt_master_slave_config().

    59

 * - Replaced slave address string with alias and position values. See

    60

 *   ecrt_master_slave_config().

    61

 * - Removed ecrt_master_get_slave_by_pos(), because it is no longer

    62

 *   necessary due to alias/position addressing.

    63

 * - Added ec_slave_config_state_t for the new method

    64

 *   ecrt_slave_config_state().

    65

 * - Process data memory for a domain can now be allocated externally. This

    66

 *   offers the possibility to use a shared-memory region. Therefore,

    67

 *   added the domain methods ecrt_domain_size() and

    68

 *   ecrt_domain_external_memory().

    69

 * - PDO entry registration functions do not return a process data pointer,

    70

 *   but an offset in the domain's process data. In addition, an optional bit

    71

 *   position can be requested. This was necessary for the external domain

    72

 *   memory. An additional advantage is, that the returned offset is

    73

 *   immediately valid. If the domain's process data is allocated internally,

    74

 *   the start address can be retrieved with ecrt_domain_data().

    75

 * - Replaced ecrt_slave_pdo_mapping/add/clear() with

    76

 *   ecrt_slave_config_pdo_assign_add() to add a PDO to a sync manager's PDO

    77

 *   assignment and ecrt_slave_config_pdo_mapping_add() to add a PDO entry to a

    78

 *   PDO's mapping. ecrt_slave_config_pdos() is a convenience function

    79

 *   for both, that uses the new data types ec_pdo_info_t and

    80

 *   ec_pdo_entry_info_t. PDO entries, that are mapped with these functions

    81

 *   can now immediately be registered, even if the bus is offline.

    82

 * - Renamed ec_bus_status_t, ec_master_status_t to ec_bus_state_t and

    83

 *   ec_master_state_t, respectively. Renamed ecrt_master_get_status() to

    84

 *   ecrt_master_state(), for consistency reasons.

    85

 * - Added ec_domain_state_t and #ec_wc_state_t for a new output parameter

    86

 *   of ecrt_domain_state(). The domain state object does now contain

    87

 *   information, if the process data was exchanged completely.

    88

 * - Former "PDO registration" meant PDO entry registration in fact, therefore

    89

 *   renamed ec_pdo_reg_t to ec_pdo_entry_reg_t and ecrt_domain_register_pdo()

    90

 *   to ecrt_slave_config_reg_pdo_entry().

    91

 * - Removed ecrt_domain_register_pdo_range(), because it's functionality can

    92

 *   be reached by specifying an explicit PDO assignment/mapping and

    93

 *   registering the mapped PDO entries.

    94

 * - Added an SDO access interface, working with SDO requests. These can be

    95

 *   scheduled for reading and writing during realtime operation.

    96

 * - Exported ecrt_slave_config_sdo(), the generic SDO configuration function.

    97

 * - Removed the bus_state and bus_tainted flags from ec_master_state_t.

    98

 *

    99

 * @{

   100

 */

   101

   102

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

   103

   104

#ifndef __ECRT_H__

   105

#define __ECRT_H__

   106

   107

#ifdef __KERNEL__

   108

#include <asm/byteorder.h>

   109

#include <linux/types.h>

   110

#else

   111

#include <stdlib.h> // for size_t

   112

#include <stdint.h>

   113

#endif

   114

   115

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

   116

 * Global definitions

   117

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

   118

   119

/** EtherCAT realtime interface major version number.

   120

 */

   121

#define ECRT_VER_MAJOR 1

   122

   123

/** EtherCAT realtime interface minor version number.

   124

 */

   125

#define ECRT_VER_MINOR 5

   126

   127

/** EtherCAT realtime interface version word generator.

   128

 */

   129

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

   130

   131

/** EtherCAT realtime interface version word.

   132

 */

   133

#define ECRT_VERSION_MAGIC ECRT_VERSION(ECRT_VER_MAJOR, ECRT_VER_MINOR)

   134

   135

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

   136

   137

/** End of list marker.

   138

 *

   139

 * This can be used with ecrt_slave_config_pdos().

   140

 */

   141

#define EC_END ~0U

   142

   143

/** Maximum number of sync managers per slave.

   144

 */

   145

#define EC_MAX_SYNC_MANAGERS 16

   146

   147

/** Maximum string length.

   148

 *

   149

 * Used in ec_slave_info_t.

   150

 */

   151

#define EC_MAX_STRING_LENGTH 64

   152

   153

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

   154

 * Data types 

   155

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

   156

   157

struct ec_master;

   158

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

   159

   160

struct ec_slave_config;

   161

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

   162

   163

struct ec_domain;

   164

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

   165

   166

struct ec_sdo_request;

   167

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

   168

   169

struct ec_voe_handler;

   170

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

   171

   172

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

   173

   174

/** Master state.

   175

 *

   176

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

   177

 *

   178

 * \see ecrt_master_state().

   179

 */

   180

typedef struct {

   181

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

   182

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

   183

                                  The states are coded in the lower 4 bits.

   184

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

   185

                                  slave in the bus is in the corresponding

   186

                                  state:

   187

                                  - Bit 0: \a INIT

   188

                                  - Bit 1: \a PREOP

   189

                                  - Bit 2: \a SAFEOP

   190

                                  - Bit 3: \a OP */

   191

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

   192

} ec_master_state_t;

   193

   194

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

   195

   196

/** Slave configuration state.

   197

 *

   198

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

   199

 * 

   200

 * \see ecrt_slave_config_state().

   201

 */

   202

typedef struct  {

   203

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

   204

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

   205

                                    using the specified configuration. */

   206

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

   207

                                 - 1: \a INIT

   208

                                 - 2: \a PREOP

   209

                                 - 4: \a SAFEOP

   210

                                 - 8: \a OP

   211

   212

                                 Note that each state is coded in a different

   213

                                 bit! */

   214

} ec_slave_config_state_t;

   215

   216

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

   217

   218

/** Slave information.

   219

 *

   220

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

   221

 *

   222

 * \see ecrt_master_slave().

   223

 */

   224

typedef struct {

   225

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

   226

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

   227

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

   228

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

   229

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

   230

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

   231

    int16_t current_on_ebus;

   232

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

   233

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

   234

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

   235

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

   236

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

   237

} ec_slave_info_t;

   238

   239

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

   240

   241

/** Domain working counter interpretation.

   242

 *

   243

 * This is used in ec_domain_state_t.

   244

 */

   245

typedef enum {

   246

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

   247

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

   248

                        exchanged. */

   249

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

   250

} ec_wc_state_t;

   251

   252

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

   253

   254

/** Domain state.

   255

 *

   256

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

   257

 */

   258

typedef struct {

   259

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

   260

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

   261

} ec_domain_state_t;

   262

   263

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

   264

   265

/** Direction type for PDO assignment functions.

   266

 */

   267

typedef enum {

   268

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

   269

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

   270

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

   271

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

   272

} ec_direction_t;

   273

   274

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

   275

   276

/** PDO entry configuration information.

   277

 *

   278

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

   279

 *

   280

 * \see ecrt_slave_config_pdos().

   281

 */

   282

typedef struct {

   283

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

   284

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

   285

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

   286

} ec_pdo_entry_info_t;

   287

   288

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

   289

   290

/** PDO configuration information.

   291

 * 

   292

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

   293

 * 

   294

 * \see ecrt_slave_config_pdos().

   295

 */

   296

typedef struct {

   297

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

   298

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

   299

                              Zero means, that the default mapping shall be

   300

                              used (this can only be done if the slave is

   301

                              present at bus configuration time). */

   302

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

   303

                                    be \a NULL, or must contain at

   304

                                    least \a n_entries values. */

   305

} ec_pdo_info_t;

   306

   307

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

   308

   309

/** Sync manager configuration information.

   310

 *

   311

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

   312

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

   313

 * ecrt_slave_config_pdos().

   314

 */

   315

typedef struct {

   316

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

   317

                     than #EC_MAX_SYNC_MANAGERS for a valid sync manager,

   318

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

   319

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

   320

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

   321

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

   322

                            at least \a n_pdos PDOs. */

   323

} ec_sync_info_t;

   324

   325

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

   326

   327

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

   328

 *

   329

 * This type is used for the array parameter of the

   330

 * ecrt_domain_reg_pdo_entry_list()

   331

 */

   332

typedef struct {

   333

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

   334

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

   335

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

   336

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

   337

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

   338

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

   339

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

   340

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

   341

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

   342

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

   343

                                  NULL, in which case an error is raised if the

   344

                                  PDO entry does not byte-align. */

   345

} ec_pdo_entry_reg_t;

   346

   347

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

   348

   349

/** Request state.

   350

 *

   351

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

   352

 * ecrt_voe_handler_state().

   353

 */

   354

typedef enum {

   355

    EC_REQUEST_UNUSED, /**< Not requested. */

   356

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

   357

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

   358

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

   359

} ec_request_state_t;

   360

   361

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

   362

 * Global functions

   363

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

   364

   365

#ifdef __cplusplus

   366

extern "C" {

   367

#endif

   368

   369

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

   370

 *

   371

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

   372

 */

   373

unsigned int ecrt_version_magic(void);

   374

   375

/** Requests an EtherCAT master for realtime operation.

   376

 * 

   377

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

   378

 * for exclusive use.

   379

 *

   380

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

   381

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

   382

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

   383

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

   384

 *

   385

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

   386

 */

   387

ec_master_t *ecrt_request_master(

   388

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

   389

        );

   390

   391

/** Releases a requested EtherCAT master.

   392

 *

   393

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

   394

 * applications.

   395

 */

   396

void ecrt_release_master(

   397

        ec_master_t *master /**< EtherCAT master */

   398

        );

   399

   400

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

   401

 * Master methods

   402

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

   403

   404

#ifdef __KERNEL__

   405

   406

/** Sets the locking callbacks.

   407

 *

   408

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

   409

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

   410

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

   411

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

   412

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

   413

 *

   414

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

   415

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

   416

 * that access is currently forbidden.

   417

 */

   418

void ecrt_master_callbacks(

   419

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

   420

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

   421

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

   422

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

   423

        );

   424

   425

#endif /* __KERNEL__ */

   426

   427

/** Creates a new process data domain.

   428

 *

   429

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

   430

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

   431

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

   432

 * exchanging them in cyclic operation.

   433

 *

   434

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

   435

 */

   436

ec_domain_t *ecrt_master_create_domain(

   437

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

   438

        );

   439

   440

/** Obtains a slave configuration.

   441

 *

   442

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

   443

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

   444

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

   445

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

   446

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

   447

 *

   448

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

   449

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

   450

 *   ring position.

   451

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

   452

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

   453

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

   454

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

   455

 *

   456

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

   457

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

   458

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

   459

 *

   460

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

   461

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

   462

 * applied.

   463

 *

   464

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

   465

 * \retval NULL in the error case.

   466

 */

   467

ec_slave_config_t *ecrt_master_slave_config(

   468

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

   469

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

   470

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

   471

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

   472

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

   473

        );

   474

   475

/** Obtains slave information.

   476

 *

   477

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

   478

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

   479

 * this function.

   480

 *

   481

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

   482

 *

   483

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

   484

 */

   485

int ecrt_master_slave(

   486

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