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 Real-Time Interface.

    37

 *

    38

 * \defgroup RealtimeInterface EtherCAT Real-Time Interface

    39

 *

    40

 * EtherCAT interface for realtime modules. This interface is designed for

    41

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

    42

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

    43

 * 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_mapping() that is now able to specify Pdo mapping and

    68

 *   Pdo configuration. Pdo entries mapped in this way can now immediately be

    69

 *   registered. The Pdo mapping and the configuration are described with the

    70

 *   new data types ec_pdo_info_t and ec_pdo_entry_info_t.

    71

 * - Renamed ec_bus_status_t, ec_master_status_t to ec_bus_state_t and

    72

 *   ec_master_state_t, respectively. Renamed ecrt_master_get_status() to

    73

 *   ecrt_master_state(), for consistency reasons.

    74

 * - Added ec_domain_state_t and ec_wc_state_t for a new output parameter

    75

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

    76

 *   information, if the process data was exchanged completely.

    77

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

    78

 *   renamed ec_pdo_reg_t to ec_pdo_entry_reg_t and ecrt_domain_register_pdo()

    79

 *   to ecrt_slave_config_reg_pdo_entry().

    80

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

    81

 *   be reached by specifying an explicit Pdo mapping and registering those

    82

 *   Pdo entries.

    83

 *

    84

 * @{

    85

 */

    86

    87

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

    88

    89

#ifndef __ECRT_H__

    90

#define __ECRT_H__

    91

    92

#include <asm/byteorder.h>

    93

    94

#ifdef __KERNEL__

    95

#include <linux/types.h>

    96

#else

    97

#include <stdint.h>

    98

#endif

    99

   100

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

   101

 * Global definitions

   102

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

   103

   104

/** EtherCAT real-time interface major version number.

   105

 */

   106

#define ECRT_VER_MAJOR 1

   107

   108

/** EtherCAT real-time interface minor version number.

   109

 */

   110

#define ECRT_VER_MINOR 4

   111

   112

/** EtherCAT real-time interface version word generator.

   113

 */

   114

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

   115

   116

/** EtherCAT real-time interface version word.

   117

 */

   118

#define ECRT_VERSION_MAGIC ECRT_VERSION(ECRT_VER_MAJOR, ECRT_VER_MINOR)

   119

   120

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

   121

 * Data types 

   122

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

   123

   124

struct ec_master;

   125

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

   126

   127

struct ec_slave_config;

   128

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

   129

   130

struct ec_domain;

   131

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

   132

   133

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

   134

   135

/** Bus state.

   136

 *

   137

 * This is used in ec_master_state_t.

   138

 */

   139

typedef enum {

   140

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

   141

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

   142

} ec_bus_state_t;

   143

   144

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

   145

   146

/** Master state.

   147

 *

   148

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

   149

 */

   150

typedef struct {

   151

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

   152

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

   153

                                the requested configuration. */

   154

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

   155

} ec_master_state_t;

   156

   157

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

   158

   159

/** Slave configuration state.

   160

 *

   161

 * \see ecrt_slave_config_state().

   162

 */

   163

typedef struct  {

   164

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

   165

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

   166

                                   the specified configuration. */

   167

} ec_slave_config_state_t;

   168

   169

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

   170

   171

/** Domain working counter interpretation.

   172

 *

   173

 * This is used in ec_domain_state_t.

   174

 */

   175

typedef enum {

   176

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

   177

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

   178

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

   179

} ec_wc_state_t;

   180

   181

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

   182

   183

/** Domain state.

   184

 *

   185

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

   186

 */

   187

typedef struct {

   188

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

   189

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

   190

} ec_domain_state_t;

   191

   192

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

   193

   194

/** Direction type for Pdo mapping functions.

   195

 */

   196

typedef enum {

   197

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

   198

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

   199

} ec_direction_t;

   200

   201

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

   202

   203

/** Pdo entry mapping.

   204

 *

   205

 * \see ecrt_slave_config_mapping().

   206

 */

   207

typedef struct {

   208

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

   209

                            configuration. */

   210

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

   211

                              Pdo configuration. */

   212

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

   213

} ec_pdo_entry_info_t;

   214

   215

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

   216

   217

/** Pdo information.

   218

 *

   219

 * \see ecrt_slave_config_mapping().

   220

 */

   221

typedef struct {

   222

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

   223

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

   224

    unsigned int n_entries; /**< Number of Pdo entries for the Pdo

   225

                              configuration. Zero means, that the default Pdo

   226

                              configuration shall be used. */

   227

    const ec_pdo_entry_info_t *entries; /**< Pdo configuration array. This

   228

                                          array must contain at least \a

   229

                                          n_entries values. */

   230

} ec_pdo_info_t;

   231

   232

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

   233

   234

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

   235

 *

   236

 * This type is used for the array parameter of the

   237

 * ecrt_domain_reg_pdo_entry_list() convenience function.

   238

 */

   239

typedef struct {

   240

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

   241

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

   242

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

   243

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

   244

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

   245

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

   246

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

   247

                       offset in the process data. */

   248

} ec_pdo_entry_reg_t;

   249

   250

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

   251

 * Global functions

   252

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

   253

   254

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

   255

 *

   256

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

   257

 */

   258

unsigned int ecrt_version_magic(void);

   259

   260

/** Requests an EtherCAT master for realtime operation.

   261

 * 

   262

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

   263

 */

   264

ec_master_t *ecrt_request_master(

   265

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

   266

        );

   267

   268

/** Releases a requested EtherCAT master.

   269

 */

   270

void ecrt_release_master(

   271

        ec_master_t *master /**< EtherCAT master */

   272

        );

   273

   274

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

   275

 * Master methods

   276

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

   277

   278

/** Sets the locking callbacks.

   279

 *

   280

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

   281

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

   282

 * that access is forbidden at this time.

   283

 */

   284

void ecrt_master_callbacks(

   285

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

   286

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

   287

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

   288

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

   289

        );

   290

   291

/** Creates a new domain.

   292

 *

   293

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

   294

 */

   295

ec_domain_t *ecrt_master_create_domain(

   296

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

   297

        );

   298

   299

/** Obtains a slave configuration.

   300

 *

   301

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

   302

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

   303

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

   304

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

   305

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

   306

 *

   307

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

   308

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

   309

 *   ring position.

   310

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

   311

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

   312

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

   313

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

   314

 *

   315

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

   316

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

   317

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

   318

 *

   319

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

   320

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

   321

 * applied.

   322

 *

   323

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

   324

 * \retval NULL in the error case.

   325

 */

   326

ec_slave_config_t *ecrt_master_slave_config(

   327

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

   328

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

   329

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

   330

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

   331

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

   332

        );

   333

   334

/** Applies the bus configuration and switches to realtime mode.

   335

 *

   336

 * Does the complete configuration and activation for all slaves. Sets sync

   337

 * managers and FMMUs, and does the appropriate transitions, until the slave

   338

 * is operational.

   339

 *

   340

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

   341

 */

   342

int ecrt_master_activate(

   343

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

   344

        );

   345

   346

/** Sends all datagrams in the queue.

   347

 *

   348

 * \todo doc

   349

 */

   350

void ecrt_master_send(

   351

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

   352

        );

   353

   354

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

   355

 */

   356

void ecrt_master_receive(

   357

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

   358

        );

   359

   360

/** Reads the current master state.

   361

 *

   362

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

   363

 */

   364

void ecrt_master_state(

   365

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

   366

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

   367

        );

   368

   369

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

   370

 * Slave configuration methods

   371

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

   372

   373

/** Specify the Pdo mapping and (optionally) the Pdo configuration.

   374

 *

   375

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

   376

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

   377

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

   378

 * at configuration time:

   379

 *

   380

 * \code

   381

 * const ec_pdo_info_t complete_mapping[] = {

   382

 *     {EC_DIR_INPUT, 0x1600, 2, { // channel 1

   383

 *         {0x7000, 0, 16}, // value

   384

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

   385

 *     }},

   386

 *     {EC_DIR_INPUT, 0x1601, 2, { // channel 2 

   387

 *         {0x7001, 0, 16}, // value

   388

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

   389

 *     }}

   390

 * };

   391

 * 

   392

 * if (ecrt_slave_config_mapping(slave_config_ana_in, 2, complete_mapping)) {

   393

 *     // error

   394

 * }

   395

 * \endcode

   396

 *

   397

 * The next example shows, how to configure only the Pdo mapping. The entries

   398

 * for each mapped Pdo are taken from the default Pdo configuration. Please

   399

 * note, that Pdo entry registration will fail, if no Pdo configuration is

   400

 * specified and the slave is offline.

   401

 *

   402

 * \code

   403

 * const ec_pdo_info_t pdo_mapping[] = {

   404

 *     {EC_DIR_INPUT, 0x1600}, // Channel 1

   405

 *     {EC_DIR_INPUT, 0x1601}  // Channel 2

   406

 * };

   407

 * 

   408

 * if (ecrt_slave_config_mapping(slave_config_ana_in, 2, pdo_mapping)) {

   409

 *     // error

   410

 * }

   411

 * \endcode

   412

 *

   413

 * \return zero on success, else non-zero

   414

 */

   415

int ecrt_slave_config_mapping(

   416

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

   417

        unsigned int n_entries, /**< Number of Pdos in \a pdos to map. */

   418

        const ec_pdo_info_t pdos[] /**< List with Pdo mapping. */

   419

        );

   420

   421

/** Registers a Pdo entry of the given slave configuration at a domain.

   422

 *

   423

 * Searches the mapping and the Pdo configurations for the given Pdo entry. If

   424

 * found, the curresponding sync manager/FMMU is added to the domain and the

   425

 * offset of the Pdo entry's data in the domain process data is returned.

   426

 *

   427

 * \retval >=0 Offset of the Pdo entry's process data.

   428

 * \retval -1  Pdo entry not found.

   429

 * \retval -2  Failed to register Pdo entry.

   430

 */

   431

int ecrt_slave_config_reg_pdo_entry(

   432

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

   433

        uint16_t entry_index, /**< Index of the Pdo entry to register. */

   434

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

   435

        ec_domain_t *domain /**< Domain. */

   436

        );

   437

   438

/** Add a configuration value for an 8-bit SDO.

   439

 *

   440

 * \todo doc

   441

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

   442

 */

   443

int ecrt_slave_config_sdo8(

   444

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

   445

        uint16_t sdo_index, /**< Index of the SDO to configure. */

   446

        uint8_t sdo_subindex, /**< Subindex of the SDO to configure. */

   447

        uint8_t value /**< Value to set. */

   448

        );

   449

   450

/** Add a configuration value for a 16-bit SDO.

   451

 *

   452

 * \todo doc

   453

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

   454

 */

   455

int ecrt_slave_config_sdo16(

   456

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

   457

        uint16_t sdo_index, /**< Index of the SDO to configure. */

   458

        uint8_t sdo_subindex, /**< Subindex of the SDO to configure. */

   459

        uint16_t value /**< Value to set. */

   460

        );

   461

   462

/** Add a configuration value for a 32-bit SDO.

   463

 *

   464

 * \todo doc

   465

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

   466

 */

   467

int ecrt_slave_config_sdo32(

   468

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

   469

        uint16_t sdo_index, /**< Index of the SDO to configure. */

   470

        uint8_t sdo_subindex, /**< Subindex of the SDO to configure. */

   471

        uint32_t value /**< Value to set. */

   472

        );

   473

   474

/** Outputs the state of the slave configuration.

   475

 *

   476

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

   477

 */

   478

void ecrt_slave_config_state(

   479

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

   480

        ec_slave_config_state_t *state /**< State object to write to. */

   481

        );

   482

   483

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

   484

 * Domain methods

   485

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

   486

   487

/** Registers a bunch of Pdo entries for a domain.

   488

 *

   489

 * \todo doc

   490

 * \attention The registration array has to be terminated with an empty

   491

 *            structure, or one with the \a index field set to zero!

   492

 * \return 0 on success, else non-zero.