1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006  Florian Pose, Ingenieurgemeinschaft IgH

     6

 *

     7

 *  This file is part of the IgH EtherCAT Master.

     8

 *

     9

 *  The IgH EtherCAT Master is free software; you can redistribute it

    10

 *  and/or modify it under the terms of the GNU General Public License

    11

 *  as published by the Free Software Foundation; either version 2 of the

    12

 *  License, or (at your option) any later version.

    13

 *

    14

 *  The IgH EtherCAT Master is distributed in the hope that it will be

    15

 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of

    16

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    17

 *  GNU General Public License for more details.

    18

 *

    19

 *  You should have received a copy of the GNU General Public License

    20

 *  along with the IgH EtherCAT Master; if not, write to the Free Software

    21

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    22

 *

    23

 *  The right to use EtherCAT Technology is granted and comes free of

    24

 *  charge under condition of compatibility of product made by

    25

 *  Licensee. People intending to distribute/sell products based on the

    26

 *  code, have to sign an agreement to guarantee that products using

    27

 *  software based on IgH EtherCAT master stay compatible with the actual

    28

 *  EtherCAT specification (which are released themselves as an open

    29

 *  standard) as the (only) precondition to have the right to use EtherCAT

    30

 *  Technology, IP and trade marks.

    31

 *

    32

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

    33

    34

/** \file

    35

 *

    36

 * EtherCAT master application interface.

    37

 *

    38

 * \defgroup ApplicationInterface EtherCAT Application Interface

    39

 *

    40

 * EtherCAT interface for realtime applications. This interface is designed

    41

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

    42

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

    43

 * and to configure and activate the bus.

    44

 *

    45

 * Changes in Version 1.4:

    46

 *

    47

 * - Replaced ec_slave_t with ec_slave_config_t, separating the bus

    48

 *   configuration from the actual slaves. Therefore, renamed

    49

 *   ecrt_master_get_slave() to ecrt_master_slave_config().

    50

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

    51

 *   ecrt_master_slave_config().

    52

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

    53

 *   necessary due to alias/position addressing.

    54

 * - Added ec_slave_config_state_t for the new method

    55

 *   ecrt_slave_config_state().

    56

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

    57

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

    58

 *   added the domain methods ecrt_domain_size() and

    59

 *   ecrt_domain_external_memory().

    60

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

    61

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

    62

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

    63

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

    64

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

    65

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

    66

 * - Replaced ecrt_slave_pdo_mapping/add/clear() with

    67

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

    68

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

    69

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

    70

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

    71

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

    72

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

    73

 * - Renamed ec_bus_status_t, ec_master_status_t to ec_bus_state_t and

    74

 *   ec_master_state_t, respectively. Renamed ecrt_master_get_status() to

    75

 *   ecrt_master_state(), for consistency reasons.

    76

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

    77

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

    78

 *   information, if the process data was exchanged completely.

    79

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

    80

 *   renamed ec_pdo_reg_t to ec_pdo_entry_reg_t and ecrt_domain_register_pdo()

    81

 *   to ecrt_slave_config_reg_pdo_entry().

    82

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

    83

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

    84

 *   registering the mapped Pdo entries.

    85

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

    86

 *   scheduled for reading and writing during realtime operation.

    87

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

    88

 * - Removed the bus_state and bus_tainted flags from ec_master_state_t.

    89

 *

    90

 * @{

    91

 */

    92

    93

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

    94

    95

#ifndef __ECRT_H__

    96

#define __ECRT_H__

    97

    98

#include <asm/byteorder.h>

    99

   100

#ifdef __KERNEL__

   101

#include <linux/types.h>

   102

#else

   103

#include <stdint.h>

   104

#endif

   105

   106

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

   107

 * Global definitions

   108

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

   109

   110

/** EtherCAT realtime interface major version number.

   111

 */

   112

#define ECRT_VER_MAJOR 1

   113

   114

/** EtherCAT realtime interface minor version number.

   115

 */

   116

#define ECRT_VER_MINOR 5

   117

   118

/** EtherCAT realtime interface version word generator.

   119

 */

   120

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

   121

   122

/** EtherCAT realtime interface version word.

   123

 */

   124

#define ECRT_VERSION_MAGIC ECRT_VERSION(ECRT_VER_MAJOR, ECRT_VER_MINOR)

   125

   126

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

   127

   128

/** End of list marker.

   129

 *

   130

 * This can be used with ecrt_slave_config_pdos().

   131

 */

   132

#define EC_END ~0U

   133

   134

/** Maximum number of sync managers per slave.

   135

 */

   136

#define EC_MAX_SYNC_MANAGERS 16

   137

   138

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

   139

 * Data types 

   140

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

   141

   142

struct ec_master;

   143

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

   144

   145

struct ec_slave_config;

   146

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

   147

   148

struct ec_domain;

   149

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

   150

   151

struct ec_sdo_request;

   152

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

   153

   154

struct ec_voe_handler;

   155

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

   156

   157

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

   158

   159

/** Master state.

   160

 *

   161

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

   162

 *

   163

 * \see ecrt_master_state().

   164

 */

   165

typedef struct {

   166

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

   167

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

   168

                                  The states are coded in the lower 4 bits.

   169

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

   170

                                  slave in the bus is in the corresponding

   171

                                  state:

   172

                                  - Bit 0: \a INIT

   173

                                  - Bit 1: \a PREOP

   174

                                  - Bit 2: \a SAFEOP

   175

                                  - Bit 3: \a OP */

   176

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

   177

} ec_master_state_t;

   178

   179

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

   180

   181

/** Slave configuration state.

   182

 *

   183

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

   184

 * 

   185

 * \see ecrt_slave_config_state().

   186

 */

   187

typedef struct  {

   188

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

   189

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

   190

                                    using the specified configuration. */

   191

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

   192

                                 - 1: \a INIT

   193

                                 - 2: \a PREOP

   194

                                 - 4: \a SAFEOP

   195

                                 - 8: \a OP

   196

   197

                                 Note that each state is coded in a different

   198

                                 bit! */

   199

} ec_slave_config_state_t;

   200

   201

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

   202

   203

/** Domain working counter interpretation.

   204

 *

   205

 * This is used in ec_domain_state_t.

   206

 */

   207

typedef enum {

   208

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

   209

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

   210

                        exchanged. */

   211

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

   212

} ec_wc_state_t;

   213

   214

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

   215

   216

/** Domain state.

   217

 *

   218

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

   219

 */

   220

typedef struct {

   221

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

   222

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

   223

} ec_domain_state_t;

   224

   225

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

   226

   227

/** Direction type for Pdo assignment functions.

   228

 */

   229

typedef enum {

   230

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

   231

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

   232

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

   233

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

   234

} ec_direction_t;

   235

   236

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

   237

   238

/** Pdo entry configuration information.

   239

 *

   240

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

   241

 *

   242

 * \see ecrt_slave_config_pdos().

   243

 */

   244

typedef struct {

   245

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

   246

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

   247

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

   248

} ec_pdo_entry_info_t;

   249

   250

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

   251

   252

/** Pdo configuration information.

   253

 * 

   254

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

   255

 * 

   256

 * \see ecrt_slave_config_pdos().

   257

 */

   258

typedef struct {

   259

    uint16_t index; /**< Pdo index. */

   260

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

   261

                              Zero means, that the default mapping shall be

   262

                              used (this can only be done if the slave is

   263

                              present at bus configuration time). */

   264

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

   265

                                    be \a NULL, or must contain at

   266

                                    least \a n_entries values. */

   267

} ec_pdo_info_t;

   268

   269

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

   270

   271

/** Sync manager configuration information.

   272

 *

   273

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

   274

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

   275

 * ecrt_slave_config_pdos().

   276

 */

   277

typedef struct {

   278

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

   279

                     than #EC_MAX_SYNC_MANAGERS for a valid sync manager,

   280

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

   281

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

   282

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

   283

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

   284

                            at least \a n_pdos Pdos. */

   285

} ec_sync_info_t;

   286

   287

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

   288

   289

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

   290

 *

   291

 * This type is used for the array parameter of the

   292

 * ecrt_domain_reg_pdo_entry_list()

   293

 */

   294

typedef struct {

   295

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

   296

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

   297

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

   298

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

   299

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

   300

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

   301

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

   302

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

   303

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

   304

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

   305

                                  NULL, in which case an error is raised if the

   306

                                  Pdo entry does not byte-align. */

   307

} ec_pdo_entry_reg_t;

   308

   309

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

   310

   311

/** Request state.

   312

 *

   313

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

   314

 * ecrt_voe_handler_state().

   315

 */

   316

typedef enum {

   317

    EC_REQUEST_UNUSED, /**< Not requested. */

   318

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

   319

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

   320

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

   321

} ec_request_state_t;

   322

   323

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

   324

 * Global functions

   325

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

   326

   327

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

   328

 *

   329

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

   330

 */

   331

unsigned int ecrt_version_magic(void);

   332

   333

/** Requests an EtherCAT master for realtime operation.

   334

 * 

   335

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

   336

 * for exclusive use.

   337

 *

   338

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

   339

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

   340

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

   341

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

   342

 *

   343

 * \return Pointer to reserved master, or \a NULL on error.

   344

 */

   345

ec_master_t *ecrt_request_master(

   346

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

   347

        );

   348

   349

/** Releases a requested EtherCAT master.

   350

 *

   351

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

   352

 * applications.

   353

 */

   354

void ecrt_release_master(

   355

        ec_master_t *master /**< EtherCAT master */

   356

        );

   357

   358

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

   359

 * Master methods

   360

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

   361

   362

/** Sets the locking callbacks.

   363

 *

   364

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

   365

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

   366

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

   367

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

   368

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

   369

 *

   370

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

   371

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

   372

 * that access is currently forbidden.

   373

 */

   374

void ecrt_master_callbacks(

   375

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

   376

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

   377

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

   378

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

   379

        );

   380

   381

/** Creates a new process data domain.

   382

 *

   383

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

   384

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

   385

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

   386

 * exchanging them in cyclic operation.

   387

 *

   388

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

   389

 */

   390

ec_domain_t *ecrt_master_create_domain(

   391

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

   392

        );

   393

   394

/** Obtains a slave configuration.

   395

 *

   396

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

   397

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

   398

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

   399

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

   400

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

   401

 *

   402

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

   403

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

   404

 *   ring position.

   405

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

   406

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

   407

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

   408

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

   409

 *

   410

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

   411

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

   412

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

   413

 *

   414

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

   415

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

   416

 * applied.

   417

 *

   418

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

   419

 * \retval NULL in the error case.

   420

 */

   421

ec_slave_config_t *ecrt_master_slave_config(

   422

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

   423

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

   424

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

   425

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

   426

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

   427

        );

   428

   429

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

   430

 *

   431

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

   432

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

   433

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

   434

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

   435

 * now to be applied.

   436

 *

   437

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

   438

 * in charge of cyclically calling ecrt_master_send() and

   439

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

   440

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

   441

 * not be called!

   442

 *

   443

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

   444

 */

   445

int ecrt_master_activate(

   446

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

   447

        );

   448

   449

/** Sends all datagrams in the queue.

   450

 *

   451

 * This method takes all datagrams, that have been queued for transmission,

   452

 * puts them into frames, and passes them to the Ethernet device for sending.

   453

 *

   454

 * Has to be called cyclically by the application after ecrt_master_activate()

   455

 * has returned.

   456

 */

   457

void ecrt_master_send(

   458

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

   459

        );

   460

   461

/** Fetches received frames from the hardware and processes the datagrams.

   462

 *

   463

 * Queries the network device for received frames by calling the interrupt

   464

 * service routine. Extracts received datagrams and dispatches the results to

   465

 * the datagram objects in the queue. Received datagrams, and the ones that

   466

 * timed out, will be marked, and dequeued.

   467

 *

   468

 * Has to be called cyclically by the realtime application after

   469

 * ecrt_master_activate() has returned.

   470

 */

   471

void ecrt_master_receive(

   472

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

   473

        );

   474

   475

/** Reads the current master state.

   476

 *

   477

 * Stores the master state information in the given \a state structure.

   478

 */

   479

void ecrt_master_state(

   480

        const ec_master_t *master, /**< EtherCAT master. */

   481

        ec_master_state_t *state /**< Structure to store the information. */

   482

        );

   483

   484

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

   485

 * Slave configuration methods

   486

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

   487