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

 * - Replaced the process data pointers in the Pdo entry registration

    61

 *   functions with a process data offset, that is now returned by

    62

 *   ecrt_slave_config_reg_pdo_entry(). This was necessary for the external

    63

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

    64

 *   is directly usable. 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 mapping and registering those

    84

 *   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

 *

    88

 * @{

    89

 */

    90

    91

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

    92

    93

#ifndef __ECRT_H__

    94

#define __ECRT_H__

    95

    96

#include <asm/byteorder.h>

    97

    98

#ifdef __KERNEL__

    99

#include <linux/types.h>

   100

#else

   101

#include <stdint.h>

   102

#endif

   103

   104

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

   105

 * Global definitions

   106

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

   107

   108

/** EtherCAT realtime interface major version number.

   109

 */

   110

#define ECRT_VER_MAJOR 1

   111

   112

/** EtherCAT realtime interface minor version number.

   113

 */

   114

#define ECRT_VER_MINOR 4

   115

   116

/** EtherCAT realtime interface version word generator.

   117

 */

   118

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

   119

   120

/** EtherCAT realtime interface version word.

   121

 */

   122

#define ECRT_VERSION_MAGIC ECRT_VERSION(ECRT_VER_MAJOR, ECRT_VER_MINOR)

   123

   124

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

   125

   126

/** End of the Pdo list.

   127

 *

   128

 * This is used in ecrt_slave_config_pdos().

   129

 */

   130

#define EC_END ~0U

   131

   132

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

   133

 * Data types 

   134

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

   135

   136

struct ec_master;

   137

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

   138

   139

struct ec_slave_config;

   140

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

   141

   142

struct ec_domain;

   143

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

   144

   145

struct ec_sdo_request;

   146

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

   147

   148

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

   149

   150

/** Bus state.

   151

 *

   152

 * This is used in ec_master_state_t.

   153

 *

   154

 * \deprecated

   155

 * \todo remove

   156

 */

   157

typedef enum {

   158

    EC_BUS_FAILURE = -1, /**< At least one configured slave is offline. */

   159

    EC_BUS_OK            /**< All configured slaves are online. */

   160

} ec_bus_state_t;

   161

   162

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

   163

   164

/** Master state.

   165

 *

   166

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

   167

 */

   168

typedef struct {

   169

    ec_bus_state_t bus_state; /**< \see ec_bus_state_t */

   170

    unsigned int bus_tainted; /**< Non-zero, if the bus topology differs from

   171

                                the requested configuration. */

   172

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

   173

} ec_master_state_t;

   174

   175

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

   176

   177

/** Slave configuration state.

   178

 *

   179

 * \see ecrt_slave_config_state().

   180

 */

   181

typedef struct  {

   182

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

   183

    unsigned int configured : 1; /**< The slave was configured according to

   184

                                   the specified configuration. */

   185

} ec_slave_config_state_t;

   186

   187

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

   188

   189

/** Domain working counter interpretation.

   190

 *

   191

 * This is used in ec_domain_state_t.

   192

 */

   193

typedef enum {

   194

    EC_WC_ZERO = 0,   /**< No Pdos were exchanged. */

   195

    EC_WC_INCOMPLETE, /**< Some of the registered Pdos were exchanged. */

   196

    EC_WC_COMPLETE    /**< All registered Pdos were exchanged. */

   197

} ec_wc_state_t;

   198

   199

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

   200

   201

/** Domain state.

   202

 *

   203

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

   204

 */

   205

typedef struct {

   206

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

   207

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

   208

} ec_domain_state_t;

   209

   210

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

   211

   212

/** Direction type for Pdo mapping functions.

   213

 */

   214

typedef enum {

   215

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

   216

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

   217

} ec_direction_t;

   218

   219

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

   220

   221

/** Pdo entry information.

   222

 *

   223

 * This can be used to map multiple Pdo entries into a given Pdo using

   224

 * ecrt_slave_config_pdos().

   225

 */

   226

typedef struct {

   227

    uint16_t index; /**< Index of the Pdo entry to add to the Pdo

   228

                            configuration. */

   229

    uint8_t subindex; /**< Subindex of the Pdo entry to add to the

   230

                              Pdo configuration. */

   231

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

   232

} ec_pdo_entry_info_t;

   233

   234

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

   235

   236

/** Pdo information.

   237

 *

   238

 * This can be use to assign multiple Pdos to a sync manager using

   239

 * ecrt_slave_config_pdos().

   240

 */

   241

typedef struct {

   242

    ec_direction_t dir; /**< Pdo direction (input/output). */

   243

    uint16_t index; /**< Index of the Pdo to map. */

   244

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

   245

                              Zero means, that the default mapping shall be

   246

                              used. */

   247

    ec_pdo_entry_info_t *entries; /**< Array of Pdo entries to map. This must

   248

                                    contain at least \a n_entries values. */

   249

} ec_pdo_info_t;

   250

   251

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

   252

   253

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

   254

 *

   255

 * This type is used for the array parameter of the

   256

 * ecrt_domain_reg_pdo_entry_list() convenience function.

   257

 */

   258

typedef struct {

   259

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

   260

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

   261

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

   262

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

   263

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

   264

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

   265

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

   266

                       offset in the process data. */

   267

} ec_pdo_entry_reg_t;

   268

   269

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

   270

   271

/** Sdo request state.

   272

 *

   273

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

   274

 */

   275

typedef enum {

   276

    EC_SDO_REQUEST_UNUSED, /**< Not requested. */

   277

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

   278

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

   279

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

   280

} ec_sdo_request_state_t;

   281

   282

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

   283

 * Global functions

   284

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

   285

   286

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

   287

 *

   288

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

   289

 */

   290

unsigned int ecrt_version_magic(void);

   291

   292

/** Requests an EtherCAT master for realtime operation.

   293

 * 

   294

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

   295

 */

   296

ec_master_t *ecrt_request_master(

   297

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

   298

        );

   299

   300

/** Releases a requested EtherCAT master.

   301

 */

   302

void ecrt_release_master(

   303

        ec_master_t *master /**< EtherCAT master */

   304

        );

   305

   306

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

   307

 * Master methods

   308

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

   309

   310

/** Sets the locking callbacks.

   311

 *

   312

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

   313

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

   314

 * that access is forbidden at this time.

   315

 */

   316

void ecrt_master_callbacks(

   317

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

   318

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

   319

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

   320

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

   321

        );

   322

   323

/** Creates a new domain.

   324

 *

   325

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

   326

 */

   327

ec_domain_t *ecrt_master_create_domain(

   328

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

   329

        );

   330

   331

/** Obtains a slave configuration.

   332

 *

   333

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

   334

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

   335

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

   336

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

   337

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

   338

 *

   339

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

   340

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

   341

 *   ring position.

   342

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

   343

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

   344

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

   345

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

   346

 *

   347

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

   348

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

   349

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

   350

 *

   351

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

   352

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

   353

 * applied.

   354

 *

   355

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

   356

 * \retval NULL in the error case.

   357

 */

   358

ec_slave_config_t *ecrt_master_slave_config(

   359

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

   360

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

   361

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

   362

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

   363

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

   364

        );

   365

   366

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

   367

 *

   368

 * This function has to be called after all Pdo entries are registered. It

   369

 * tells the master that the configuration phase is finished and the realtime

   370

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

   371

 * domains and calculates the logical FMMU addresses for domain members. It

   372

 * tells the master state machine that the bus configuration is now to be

   373

 * applied.

   374

 *

   375

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

   376

 * in charge of cyclically calling ecrt_master_send() and

   377

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

   378

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

   379

 * not be called!

   380

 *

   381

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

   382

 */

   383

int ecrt_master_activate( ec_master_t *master /**< EtherCAT master. */);

   384

   385

/** Sends all datagrams in the queue.

   386

 *

   387

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

   388

 * ecrt_master_activate() has returned.

   389

 */

   390

void ecrt_master_send(

   391

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

   392

        );

   393

   394

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

   395

 *

   396

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

   397

 * ecrt_master_activate() has returned.

   398

 */

   399

void ecrt_master_receive(

   400

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

   401

        );

   402

   403

/** Reads the current master state.

   404

 *

   405

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

   406

 */

   407

void ecrt_master_state(

   408

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

   409

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

   410

        );

   411

   412

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

   413

 * Slave configuration methods

   414

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

   415

   416

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

   417

 *

   418

 * \see ecrt_slave_config_pdos()

   419

 * \return zero on success, else non-zero

   420

 */

   421

int ecrt_slave_config_pdo_assign_add(

   422

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

   423

        ec_direction_t dir, /**< Sync manager direction (input/output). */

   424

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

   425

        );

   426

   427

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

   428

 *

   429

 * This can be called before assigning Pdos via

   430

 * ecrt_slave_config_pdo_assign_add(), to clear the default assignment.

   431

 */

   432

void ecrt_slave_config_pdo_assign_clear(

   433

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

   434

        ec_direction_t dir /**< Sync manager direction (input/output). */

   435

        );

   436

   437

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

   438

 *

   439

 * \see ecrt_slave_config_pdos()

   440

 * \return zero on success, else non-zero

   441

 */

   442

int ecrt_slave_config_pdo_mapping_add(

   443

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

   444

        uint16_t pdo_index, /**< Index of the Pdo. */

   445

        uint16_t entry_index, /**< Index of the Pdo entry to add to the Pdo's

   446

                                mapping. */

   447

        uint8_t entry_subindex, /**< Subindex of the Pdo entry to add to the

   448

                                  Pdo's mapping. */

   449

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

   450

        );

   451

   452

/** Clear the mapping of a given Pdo.

   453

 *

   454

 * This can be called before mapping Pdo entries via

   455

 * ecrt_slave_config_pdo_mapping_add(), to clear the default mapping.

   456

 */

   457

void ecrt_slave_config_pdo_mapping_clear(

   458

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

   459

        uint16_t pdo_index /**< Index of the Pdo. */

   460

        );

   461

   462

/** Specify the Pdo assignment and (optionally) the Pdo mappings.

   463

 *

   464

 * This function is a convenience wrapper for the functions

   465

 * ecrt_slave_config_pdo_assign_clear(), ecrt_slave_config_pdo_assign_add(),

   466

 * ecrt_slave_config_pdo_mapping_clear() and

   467

 * ecrt_slave_config_pdo_mapping_add(), that are better suitable for automatic

   468

 * code generation.

   469

 *

   470

 * The following example shows, how to specify a complete Pdo assignment

   471

 * including the Pdo mappings. With this information, the master is able to

   472

 * reserve the complete process data, even if the slave is not present at

   473

 * configuration time:

   474

 *

   475

 * \code

   476

 * const ec_pdo_entry_info_t el3162_channel1[] = {

   477

 *     {0x3101, 1,  8}, // status

   478

 *     {0x3101, 2, 16}  // value

   479

 * };

   480

 * 

   481

 * const ec_pdo_entry_info_t el3162_channel2[] = {

   482

 *     {0x3102, 1,  8}, // status

   483

 *     {0x3102, 2, 16}  // value

   484

 * };

   485

 * 

   486

 * const ec_pdo_info_t el3162_pdos[] = {

   487

 *     {EC_DIR_INPUT, 0x1A00, 2, el3162_channel1},

   488

 *     {EC_DIR_INPUT, 0x1A01, 2, el3162_channel2},

   489

 * };