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

 *  Using the EtherCAT technology and brand is permitted in compliance with

    24

 *  the industrial property and similar rights of Beckhoff Automation GmbH.

    25

 *

    26

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

    27

    28

/** \file

    29

 *

    30

 * EtherCAT master application interface.

    31

 *

    32

 * \defgroup ApplicationInterface EtherCAT Application Interface

    33

 *

    34

 * EtherCAT interface for realtime applications. This interface is designed

    35

 * for realtime modules that want to use EtherCAT. There are functions to

    36

 * request a master, to map process data, to communicate with slaves via CoE

    37

 * and to configure and activate the bus.

    38

 *

    39

 * Changes in version 1.5:

    40

 *

    41

 * - Changed the meaning of the negative return values of

    42

 *   ecrt_slave_config_reg_pdo_entry() and ecrt_slave_config_sdo*().

    43

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

    44

 *   ecrt_slave_config_create_voe_handler().

    45

 * - Renamed ec_sdo_request_state_t to ec_request_state_t, because it is also

    46

 *   used by VoE handlers.

    47

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

    48

 *

    49

 * Changes in Version 1.4:

    50

 *

    51

 * - Replaced ec_slave_t with ec_slave_config_t, separating the bus

    52

 *   configuration from the actual slaves. Therefore, renamed

    53

 *   ecrt_master_get_slave() to ecrt_master_slave_config().

    54

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

    55

 *   ecrt_master_slave_config().

    56

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

    57

 *   necessary due to alias/position addressing.

    58

 * - Added ec_slave_config_state_t for the new method

    59

 *   ecrt_slave_config_state().

    60

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

    61

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

    62

 *   added the domain methods ecrt_domain_size() and

    63

 *   ecrt_domain_external_memory().

    64

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

    65

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

    66

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

    67

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

    68

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

    69

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

    70

 * - Replaced ecrt_slave_pdo_mapping/add/clear() with

    71

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

    72

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

    73

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

    74

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

    75

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

    76

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

    77

 * - Renamed ec_bus_status_t, ec_master_status_t to ec_bus_state_t and

    78

 *   ec_master_state_t, respectively. Renamed ecrt_master_get_status() to

    79

 *   ecrt_master_state(), for consistency reasons.

    80

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

    81

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

    82

 *   information, if the process data was exchanged completely.

    83

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

    84

 *   renamed ec_pdo_reg_t to ec_pdo_entry_reg_t and ecrt_domain_register_pdo()

    85

 *   to ecrt_slave_config_reg_pdo_entry().

    86

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

    87

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

    88

 *   registering the mapped PDO entries.

    89

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

    90

 *   scheduled for reading and writing during realtime operation.

    91

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

    92

 * - Removed the bus_state and bus_tainted flags from ec_master_state_t.

    93

 *

    94

 * @{

    95

 */

    96

    97

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

    98

    99

#ifndef __ECRT_H__

   100

#define __ECRT_H__

   101

   102

#ifdef __KERNEL__

   103

#include <asm/byteorder.h>

   104

#include <linux/types.h>

   105

#else

   106

#include <stdlib.h> // for size_t

   107

#include <stdint.h>

   108

#endif

   109

   110

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

   111

 * Global definitions

   112

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

   113

   114

/** EtherCAT realtime interface major version number.

   115

 */

   116

#define ECRT_VER_MAJOR 1

   117

   118

/** EtherCAT realtime interface minor version number.

   119

 */

   120

#define ECRT_VER_MINOR 5

   121

   122

/** EtherCAT realtime interface version word generator.

   123

 */

   124

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

   125

   126

/** EtherCAT realtime interface version word.

   127

 */

   128

#define ECRT_VERSION_MAGIC ECRT_VERSION(ECRT_VER_MAJOR, ECRT_VER_MINOR)

   129

   130

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

   131

   132

/** End of list marker.

   133

 *

   134

 * This can be used with ecrt_slave_config_pdos().

   135

 */

   136

#define EC_END ~0U

   137

   138

/** Maximum number of sync managers per slave.

   139

 */

   140

#define EC_MAX_SYNC_MANAGERS 16

   141

   142

/** Maximum string length.

   143

 *

   144

 * Used in ec_slave_info_t.

   145

 */

   146

#define EC_MAX_STRING_LENGTH 64

   147

   148

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

   149

 * Data types 

   150

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

   151

   152

struct ec_master;

   153

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

   154

   155

struct ec_slave_config;

   156

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

   157

   158

struct ec_domain;

   159

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

   160

   161

struct ec_sdo_request;

   162

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

   163

   164

struct ec_voe_handler;

   165

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

   166

   167

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

   168

   169

/** Master state.

   170

 *

   171

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

   172

 *

   173

 * \see ecrt_master_state().

   174

 */

   175

typedef struct {

   176

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

   177

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

   178

                                  The states are coded in the lower 4 bits.

   179

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

   180

                                  slave in the bus is in the corresponding

   181

                                  state:

   182

                                  - Bit 0: \a INIT

   183

                                  - Bit 1: \a PREOP

   184

                                  - Bit 2: \a SAFEOP

   185

                                  - Bit 3: \a OP */

   186

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

   187

} ec_master_state_t;

   188

   189

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

   190

   191

/** Slave configuration state.

   192

 *

   193

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

   194

 * 

   195

 * \see ecrt_slave_config_state().

   196

 */

   197

typedef struct  {

   198

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

   199

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

   200

                                    using the specified configuration. */

   201

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

   202

                                 - 1: \a INIT

   203

                                 - 2: \a PREOP

   204

                                 - 4: \a SAFEOP

   205

                                 - 8: \a OP

   206

   207

                                 Note that each state is coded in a different

   208

                                 bit! */

   209

} ec_slave_config_state_t;

   210

   211

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

   212

   213

/** Slave information.

   214

 *

   215

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

   216

 *

   217

 * \see ecrt_master_slave().

   218

 */

   219

typedef struct {

   220

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

   221

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

   222

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

   223

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

   224

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

   225

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

   226

    int16_t current_on_ebus;

   227

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

   228

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

   229

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

   230

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

   231

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

   232

} ec_slave_info_t;

   233

   234

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

   235

   236

/** Domain working counter interpretation.

   237

 *

   238

 * This is used in ec_domain_state_t.

   239

 */

   240

typedef enum {

   241

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

   242

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

   243

                        exchanged. */

   244

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

   245

} ec_wc_state_t;

   246

   247

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

   248

   249

/** Domain state.

   250

 *

   251

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

   252

 */

   253

typedef struct {

   254

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

   255

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

   256

} ec_domain_state_t;

   257

   258

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

   259

   260

/** Direction type for PDO assignment functions.

   261

 */

   262

typedef enum {

   263

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

   264

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

   265

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

   266

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

   267

} ec_direction_t;

   268

   269

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

   270

   271

/** PDO entry configuration information.

   272

 *

   273

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

   274

 *

   275

 * \see ecrt_slave_config_pdos().

   276

 */

   277

typedef struct {

   278

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

   279

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

   280

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

   281

} ec_pdo_entry_info_t;

   282

   283

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

   284

   285

/** PDO configuration information.

   286

 * 

   287

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

   288

 * 

   289

 * \see ecrt_slave_config_pdos().

   290

 */

   291

typedef struct {

   292

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

   293

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

   294

                              Zero means, that the default mapping shall be

   295

                              used (this can only be done if the slave is

   296

                              present at bus configuration time). */

   297

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

   298

                                    be \a NULL, or must contain at

   299

                                    least \a n_entries values. */

   300

} ec_pdo_info_t;

   301

   302

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

   303

   304

/** Sync manager configuration information.

   305

 *

   306

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

   307

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

   308

 * ecrt_slave_config_pdos().

   309

 */

   310

typedef struct {

   311

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

   312

                     than #EC_MAX_SYNC_MANAGERS for a valid sync manager,

   313

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

   314

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

   315

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

   316

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

   317

                            at least \a n_pdos PDOs. */

   318

} ec_sync_info_t;

   319

   320

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

   321

   322

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

   323

 *

   324

 * This type is used for the array parameter of the

   325

 * ecrt_domain_reg_pdo_entry_list()

   326

 */

   327

typedef struct {

   328

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

   329

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

   330

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

   331

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

   332

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

   333

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

   334

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

   335

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

   336

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

   337

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

   338

                                  NULL, in which case an error is raised if the

   339

                                  PDO entry does not byte-align. */

   340

} ec_pdo_entry_reg_t;

   341

   342

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

   343

   344

/** Request state.

   345

 *

   346

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

   347

 * ecrt_voe_handler_state().

   348

 */

   349

typedef enum {

   350

    EC_REQUEST_UNUSED, /**< Not requested. */

   351

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

   352

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

   353

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

   354

} ec_request_state_t;

   355

   356

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

   357

 * Global functions

   358

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

   359

   360

#ifdef __cplusplus

   361

extern "C" {

   362

#endif

   363

   364

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

   365

 *

   366

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

   367

 */

   368

unsigned int ecrt_version_magic(void);

   369

   370

/** Requests an EtherCAT master for realtime operation.

   371

 * 

   372

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

   373

 * for exclusive use.

   374

 *

   375

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

   376

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

   377

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

   378

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

   379

 *

   380

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

   381

 */

   382

ec_master_t *ecrt_request_master(

   383

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

   384

        );

   385

   386

/** Releases a requested EtherCAT master.

   387

 *

   388

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

   389

 * applications.

   390

 */

   391

void ecrt_release_master(

   392

        ec_master_t *master /**< EtherCAT master */

   393

        );

   394

   395

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

   396

 * Master methods

   397

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

   398

   399

#ifdef __KERNEL__

   400

   401

/** Sets the locking callbacks.

   402

 *

   403

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

   404

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

   405

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

   406

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

   407

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

   408

 *

   409

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

   410

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

   411

 * that access is currently forbidden.

   412

 */

   413

void ecrt_master_callbacks(

   414

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

   415

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

   416

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

   417

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

   418

        );

   419

   420

#endif /* __KERNEL__ */

   421

   422

/** Creates a new process data domain.

   423

 *

   424

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

   425

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

   426

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

   427

 * exchanging them in cyclic operation.

   428

 *

   429

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

   430

 */

   431

ec_domain_t *ecrt_master_create_domain(

   432

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

   433

        );

   434

   435

/** Obtains a slave configuration.

   436

 *

   437

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

   438

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

   439

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

   440

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

   441

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

   442

 *

   443

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

   444

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

   445

 *   ring position.

   446

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

   447

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

   448

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

   449

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

   450

 *

   451

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

   452

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

   453

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

   454

 *

   455

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

   456

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

   457

 * applied.

   458

 *

   459

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

   460

 * \retval NULL in the error case.

   461

 */

   462

ec_slave_config_t *ecrt_master_slave_config(

   463

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

   464

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

   465

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

   466

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

   467

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

   468

        );

   469

   470

/** Obtains slave information.

   471

 *

   472

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

   473

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

   474

 * this function.

   475

 *

   476

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

   477

 *

   478

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

   479

 */

   480

int ecrt_master_slave(

   481

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

   482

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

   483

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

   484

                                      information */

   485

        );

   486