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 4

   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

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

   155

   156

/** Master state.

   157

 *

   158

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

   159

 *

   160

 * \see ecrt_master_state().

   161

 */

   162

typedef struct {

   163

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

   164

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

   165

                                  The states are coded in the lower 4 bits.

   166

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

   167

                                  slave in the bus is in the corresponding

   168

                                  state:

   169

                                  - Bit 0: \a INIT

   170

                                  - Bit 1: \a PREOP

   171

                                  - Bit 2: \a SAFEOP

   172

                                  - Bit 3: \a OP */

   173

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

   174

} ec_master_state_t;

   175

   176

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

   177

   178

/** Slave configuration state.

   179

 *

   180

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

   181

 * 

   182

 * \see ecrt_slave_config_state().

   183

 */

   184

typedef struct  {

   185

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

   186

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

   187

                                    using the specified configuration. */

   188

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

   189

                                 - 1: \a INIT

   190

                                 - 2: \a PREOP

   191

                                 - 4: \a SAFEOP

   192

                                 - 8: \a OP

   193

   194

                                 Note that each state is coded in a different

   195

                                 bit! */

   196

} ec_slave_config_state_t;

   197

   198

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

   199

   200

/** Domain working counter interpretation.

   201

 *

   202

 * This is used in ec_domain_state_t.

   203

 */

   204

typedef enum {

   205

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

   206

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

   207

                        exchanged. */

   208

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

   209

} ec_wc_state_t;

   210

   211

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

   212

   213

/** Domain state.

   214

 *

   215

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

   216

 */

   217

typedef struct {

   218

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

   219

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

   220

} ec_domain_state_t;

   221

   222

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

   223

   224

/** Direction type for Pdo assignment functions.

   225

 */

   226

typedef enum {

   227

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

   228

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

   229

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

   230

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

   231

} ec_direction_t;

   232

   233

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

   234

   235

/** Pdo entry configuration information.

   236

 *

   237

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

   238

 *

   239

 * \see ecrt_slave_config_pdos().

   240

 */

   241

typedef struct {

   242

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

   243

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

   244

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

   245

} ec_pdo_entry_info_t;

   246

   247

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

   248

   249

/** Pdo configuration information.

   250

 * 

   251

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

   252

 * 

   253

 * \see ecrt_slave_config_pdos().

   254

 */

   255

typedef struct {

   256

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

   257

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

   258

                              Zero means, that the default mapping shall be

   259

                              used (this can only be done if the slave is

   260

                              present at bus configuration time). */

   261

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

   262

                                    be \a NULL, or must contain at

   263

                                    least \a n_entries values. */

   264

} ec_pdo_info_t;

   265

   266

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

   267

   268

/** Sync manager configuration information.

   269

 *

   270

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

   271

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

   272

 * ecrt_slave_config_pdos().

   273

 */

   274

typedef struct {

   275

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

   276

                     than #EC_MAX_SYNC_MANAGERS for a valid sync manager,

   277

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

   278

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

   279

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

   280

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

   281

                            at least \a n_pdos Pdos. */

   282

} ec_sync_info_t;

   283

   284

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

   285

   286

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

   287

 *

   288

 * This type is used for the array parameter of the

   289

 * ecrt_domain_reg_pdo_entry_list()

   290

 */

   291

typedef struct {

   292

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

   293

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

   294

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

   295

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

   296

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

   297

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

   298

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

   299

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

   300

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

   301

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

   302

                                  NULL, in which case an error is raised if the

   303

                                  Pdo entry does not byte-align. */

   304

} ec_pdo_entry_reg_t;

   305

   306

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

   307

   308

/** Sdo request state.

   309

 *

   310

 * This is used as return type of ecrt_sdo_request_state().

   311

 */

   312

typedef enum {

   313

    EC_SDO_REQUEST_UNUSED, /**< Not requested. */

   314

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

   315

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

   316

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

   317

} ec_sdo_request_state_t;

   318

   319

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

   320

 * Global functions

   321

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

   322

   323

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

   324

 *

   325

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

   326

 */

   327

unsigned int ecrt_version_magic(void);

   328

   329

/** Requests an EtherCAT master for realtime operation.

   330

 * 

   331

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

   332

 * for exclusive use.

   333

 *

   334

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

   335

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

   336

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

   337

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

   338

 *

   339

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

   340

 */

   341

ec_master_t *ecrt_request_master(

   342

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

   343

        );

   344

   345

/** Releases a requested EtherCAT master.

   346

 *

   347

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

   348

 * applications.

   349

 */

   350

void ecrt_release_master(

   351

        ec_master_t *master /**< EtherCAT master */

   352

        );

   353

   354

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

   355

 * Master methods

   356

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

   357

   358

/** Sets the locking callbacks.

   359

 *

   360

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

   361

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

   362

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

   363

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

   364

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

   365

 *

   366

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

   367

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

   368

 * that access is currently forbidden.

   369

 */

   370

void ecrt_master_callbacks(

   371

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

   372

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

   373

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

   374

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

   375

        );

   376

   377

/** Creates a new process data domain.

   378

 *

   379

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

   380

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

   381

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

   382

 * exchanging them in cyclic operation.

   383

 *

   384

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

   385

 */

   386

ec_domain_t *ecrt_master_create_domain(

   387

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

   388

        );

   389

   390

/** Obtains a slave configuration.

   391

 *

   392

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

   393

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

   394

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

   395

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

   396

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

   397

 *

   398

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

   399

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

   400

 *   ring position.

   401

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

   402

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

   403

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

   404

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

   405

 *

   406

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

   407

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

   408

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

   409

 *

   410

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

   411

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

   412

 * applied.

   413

 *

   414

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

   415

 * \retval NULL in the error case.

   416

 */

   417

ec_slave_config_t *ecrt_master_slave_config(

   418

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

   419

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

   420

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

   421

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

   422

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

   423

        );

   424

   425

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

   426

 *

   427

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

   428

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

   429

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

   430

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

   431

 * now to be applied.

   432

 *

   433

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

   434

 * in charge of cyclically calling ecrt_master_send() and

   435

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

   436

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

   437

 * not be called!

   438

 *

   439

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

   440

 */

   441

int ecrt_master_activate(

   442

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

   443

        );

   444

   445

/** Sends all datagrams in the queue.

   446

 *

   447

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

   448

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

   449

 *

   450

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

   451

 * has returned.

   452

 */

   453

void ecrt_master_send(

   454

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

   455

        );

   456

   457

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

   458

 *

   459

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

   460

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

   461

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

   462

 * timed out, will be marked, and dequeued.

   463

 *

   464

 * Has to be called cyclically by the realtime application after

   465

 * ecrt_master_activate() has returned.

   466

 */

   467

void ecrt_master_receive(

   468

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

   469

        );

   470

   471

/** Reads the current master state.

   472

 *

   473

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

   474

 */

   475

void ecrt_master_state(

   476

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

   477

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

   478

        );

   479

   480

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

   481

 * Slave configuration methods

   482

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

   483

   484

/** Configure a sync manager.

   485

 *

   486

 * Sets the direction of a sync manager. This overrides the direction bits

   487

 * from the default control register from SII.