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 Realtime Interface.

    37

 *

    38

 * \defgroup RealtimeInterface EtherCAT Realtime 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 slave objects

    48

 *   from the requested bus configuration. 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 the Pdo entry list.

   129

 *

   130

 * This is used in ecrt_slave_config_pdos().

   131

 */

   132

#define EC_END ~0U

   133

   134

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

   135

 * Data types 

   136

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

   137

   138

struct ec_master;

   139

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

   140

   141

struct ec_slave_config;

   142

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

   143

   144

struct ec_domain;

   145

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

   146

   147

struct ec_sdo_request;

   148

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

   149

   150

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

   151

   152

/** Master state.

   153

 *

   154

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

   155

 *

   156

 * \see ecrt_master_state().

   157

 */

   158

typedef struct {

   159

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

   160

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

   161

                                  The states are coded in the lower 4 bits.

   162

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

   163

                                  slave in the bus is in the corresponding

   164

                                  state:

   165

                                  - Bit 0: \a INIT

   166

                                  - Bit 1: \a PREOP

   167

                                  - Bit 2: \a SAFEOP

   168

                                  - Bit 3: \a OP */

   169

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

   170

} ec_master_state_t;

   171

   172

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

   173

   174

/** Slave configuration state.

   175

 *

   176

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

   177

 * 

   178

 * \see ecrt_slave_config_state().

   179

 */

   180

typedef struct  {

   181

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

   182

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

   183

                                    using the specified configuration. */

   184

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

   185

                                 - 1: \a INIT

   186

                                 - 2: \a PREOP

   187

                                 - 4: \a SAFEOP

   188

                                 - 8: \a OP

   189

   190

                                 Note that each state is coded in a different

   191

                                 bit! */

   192

} ec_slave_config_state_t;

   193

   194

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

   195

   196

/** Domain working counter interpretation.

   197

 *

   198

 * This is used in ec_domain_state_t.

   199

 */

   200

typedef enum {

   201

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

   202

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

   203

                        exchanged. */

   204

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

   205

} ec_wc_state_t;

   206

   207

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

   208

   209

/** Domain state.

   210

 *

   211

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

   212

 */

   213

typedef struct {

   214

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

   215

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

   216

} ec_domain_state_t;

   217

   218

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

   219

   220

/** Direction type for Pdo assignment functions.

   221

 */

   222

typedef enum {

   223

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

   224

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

   225

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

   226

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

   227

} ec_direction_t;

   228

   229

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

   230

   231

/** Pdo entry configuration information.

   232

 *

   233

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

   234

 *

   235

 * \see ecrt_slave_config_sync_managers().

   236

 */

   237

typedef struct {

   238

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

   239

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

   240

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

   241

} ec_pdo_entry_info_t;

   242

   243

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

   244

   245

/** Pdo configuration information.

   246

 * 

   247

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

   248

 * 

   249

 * \see ecrt_slave_config_sync_managers().

   250

 */

   251

typedef struct {

   252

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

   253

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

   254

                              Zero means, that the default mapping shall be

   255

                              used (this can only be done if the slave is

   256

                              present at bus configuration time). */

   257

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

   258

                                    be \a NULL, or must contain at

   259

                                    least \a n_entries values. */

   260

} ec_pdo_info_t;

   261

   262

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

   263

   264

/** Sync manager configuration information.

   265

 *

   266

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

   267

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

   268

 * ecrt_slave_config_sync_managers().

   269

 */

   270

typedef struct {

   271

    uint8_t index; /**< Sync manager index. */

   272

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

   273

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

   274

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

   275

                            at least \a n_pdos Pdos. */

   276

} ec_sync_info_t;

   277

   278

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

   279

   280

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

   281

 *

   282

 * This type is used for the array parameter of the

   283

 * ecrt_domain_reg_pdo_entry_list()

   284

 */

   285

typedef struct {

   286

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

   287

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

   288

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

   289

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

   290

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

   291

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

   292

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

   293

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

   294

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

   295

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

   296

                                 NULL, in which case an error is raised if the

   297

                                 Pdo entry does not byte-align. */

   298

} ec_pdo_entry_reg_t;

   299

   300

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

   301

   302

/** Sdo request state.

   303

 *

   304

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

   305

 */

   306

typedef enum {

   307

    EC_SDO_REQUEST_UNUSED, /**< Not requested. */

   308

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

   309

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

   310

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

   311

} ec_sdo_request_state_t;

   312

   313

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

   314

 * Global functions

   315

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

   316

   317

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

   318

 *

   319

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

   320

 */

   321

unsigned int ecrt_version_magic(void);

   322

   323

/** Requests an EtherCAT master for realtime operation.

   324

 * 

   325

 * \return pointer to reserved master, or NULL on error

   326

 */

   327

ec_master_t *ecrt_request_master(

   328

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

   329

        );

   330

   331

/** Releases a requested EtherCAT master.

   332

 */

   333

void ecrt_release_master(

   334

        ec_master_t *master /**< EtherCAT master */

   335

        );

   336

   337

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

   338

 * Master methods

   339

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

   340

   341

/** Sets the locking callbacks.

   342

 *

   343

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

   344

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

   345

 * that access is forbidden at this time.

   346

 */

   347

void ecrt_master_callbacks(

   348

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

   349

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

   350

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

   351

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

   352

        );

   353

   354

/** Creates a new domain.

   355

 *

   356

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

   357

 */

   358

ec_domain_t *ecrt_master_create_domain(

   359

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

   360

        );

   361

   362

/** Obtains a slave configuration.

   363

 *

   364

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

   365

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

   366

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

   367

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

   368

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

   369

 *

   370

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

   371

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

   372

 *   ring position.

   373

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

   374

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

   375

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

   376

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

   377

 *

   378

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

   379

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

   380

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

   381

 *

   382

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

   383

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

   384

 * applied.

   385

 *

   386

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

   387

 * \retval NULL in the error case.

   388

 */

   389

ec_slave_config_t *ecrt_master_slave_config(

   390

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

   391

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

   392

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

   393

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

   394

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

   395

        );

   396

   397

/** Finishes the configuration phase and prepares for realtime mode.

   398

 *

   399

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

   400

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

   401

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

   402

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

   403

 * now to be applied.

   404

 *

   405

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

   406

 * in charge of cyclically calling ecrt_master_send() and

   407

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

   408

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

   409

 * not be called!

   410

 *

   411

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

   412

 */

   413

int ecrt_master_activate(

   414

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

   415

        );

   416

   417

/** Sends all datagrams in the queue.

   418

 *

   419

 * This has to be called cyclically by the realtime application after

   420

 * ecrt_master_activate() has returned.

   421

 */

   422

void ecrt_master_send(

   423

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

   424

        );

   425

   426

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

   427

 *

   428

 * This has to be called cyclically by the realtime application after

   429

 * ecrt_master_activate() has returned.

   430

 */

   431

void ecrt_master_receive(

   432

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

   433

        );

   434

   435

/** Reads the current master state.

   436

 *

   437

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

   438

 */

   439

void ecrt_master_state(

   440

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

   441

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

   442

        );

   443

   444

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

   445

 * Slave configuration methods

   446

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

   447

   448

/** Configure a sync manager.

   449

 *

   450

 * Sets the direction of a sync manager. The direction bits from the default

   451

 * control register from SII will be overriden, when this function is called.

   452

 *

   453

 * \return zero on success, else non-zero

   454

 */

   455

int ecrt_slave_config_sync_manager(

   456

        ec_slave_config_t *sc, /**< Slave configuration. */

   457

        uint8_t sync_index, /**< Sync manager index. */

   458

        ec_direction_t dir /**< Input/Output. */

   459

        );

   460

   461

/** Add a Pdo to a sync manager's Pdo assignment.

   462

 *

   463

 * \see ecrt_slave_config_sync_managers()

   464

 * \return zero on success, else non-zero

   465

 */

   466

int ecrt_slave_config_pdo_assign_add(

   467

        ec_slave_config_t *sc, /**< Slave configuration. */

   468

        uint8_t sync_index, /**< Sync manager index. */

   469

        uint16_t index /**< Index of the Pdo to assign. */

   470

        );

   471

   472

/** Clear a sync manager's Pdo assignment.

   473

 *

   474

 * This can be called before assigning Pdos via

   475

 * ecrt_slave_config_pdo_assign_add(), to clear the default assignment of a

   476

 * sync manager.

   477

 * 

   478

 * \see ecrt_slave_config_sync_managers()

   479

 */

   480

void ecrt_slave_config_pdo_assign_clear(

   481

        ec_slave_config_t *sc, /**< Slave configuration. */

   482

        uint8_t sync_index /**< Sync manager index. */

   483

        );

   484

   485

/** Add a Pdo entry to the given Pdo's mapping.

   486

 *

   487

 * \see ecrt_slave_config_sync_managers()

   488

 * \return zero on success, else non-zero