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_pdo() to add a Pdo to the mapping and

    68

 *   ecrt_slave_config_pdo_entry() to add a Pdo entry to a Pdo configuration.

    69

 *   ecrt_slave_config_mapping() is a convenience function for

    70

 *   both, that uses the new data types ec_pdo_info_t and ec_pdo_entry_info_t.

    71

 *   Mapped Pdo entries can now immediately be registered.

    72

 * - Renamed ec_bus_status_t, ec_master_status_t to ec_bus_state_t and

    73

 *   ec_master_state_t, respectively. Renamed ecrt_master_get_status() to

    74

 *   ecrt_master_state(), for consistency reasons.

    75

 * - Added ec_domain_state_t and ec_wc_state_t for a new output parameter

    76

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

    77

 *   information, if the process data was exchanged completely.

    78

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

    79

 *   renamed ec_pdo_reg_t to ec_pdo_entry_reg_t and ecrt_domain_register_pdo()

    80

 *   to ecrt_slave_config_reg_pdo_entry().

    81

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

    82

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

    83

 *   Pdo entries.

    84

 *

    85

 * @{

    86

 */

    87

    88

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

    89

    90

#ifndef __ECRT_H__

    91

#define __ECRT_H__

    92

    93

#include <asm/byteorder.h>

    94

    95

#ifdef __KERNEL__

    96

#include <linux/types.h>

    97

#else

    98

#include <stdint.h>

    99

#endif

   100

   101

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

   102

 * Global definitions

   103

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

   104

   105

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

   106

 */

   107

#define ECRT_VER_MAJOR 1

   108

   109

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

   110

 */

   111

#define ECRT_VER_MINOR 4

   112

   113

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

   114

 */

   115

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

   116

   117

/** EtherCAT real-time interface version word.

   118

 */

   119

#define ECRT_VERSION_MAGIC ECRT_VERSION(ECRT_VER_MAJOR, ECRT_VER_MINOR)

   120

   121

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

   122

 * Data types 

   123

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

   124

   125

struct ec_master;

   126

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

   127

   128

struct ec_slave_config;

   129

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

   130

   131

struct ec_domain;

   132

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

   133

   134

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

   135

   136

/** Bus state.

   137

 *

   138

 * This is used in ec_master_state_t.

   139

 */

   140

typedef enum {

   141

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

   142

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

   143

} ec_bus_state_t;

   144

   145

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

   146

   147

/** Master state.

   148

 *

   149

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

   150

 */

   151

typedef struct {

   152

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

   153

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

   154

                                the requested configuration. */

   155

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

   156

} ec_master_state_t;

   157

   158

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

   159

   160

/** Slave configuration state.

   161

 *

   162

 * \see ecrt_slave_config_state().

   163

 */

   164

typedef struct  {

   165

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

   166

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

   167

                                   the specified configuration. */

   168

} ec_slave_config_state_t;

   169

   170

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

   171

   172

/** Domain working counter interpretation.

   173

 *

   174

 * This is used in ec_domain_state_t.

   175

 */

   176

typedef enum {

   177

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

   178

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

   179

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

   180

} ec_wc_state_t;

   181

   182

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

   183

   184

/** Domain state.

   185

 *

   186

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

   187

 */

   188

typedef struct {

   189

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

   190

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

   191

} ec_domain_state_t;

   192

   193

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

   194

   195

/** Direction type for Pdo mapping functions.

   196

 */

   197

typedef enum {

   198

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

   199

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

   200

} ec_direction_t;

   201

   202

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

   203

   204

/** Pdo entry mapping.

   205

 *

   206

 * \see ecrt_slave_config_mapping().

   207

 */

   208

typedef struct {

   209

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

   210

                            configuration. */

   211

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

   212

                              Pdo configuration. */

   213

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

   214

} ec_pdo_entry_info_t;

   215

   216

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

   217

   218

/** Pdo information.

   219

 *

   220

 * \see ecrt_slave_config_mapping().

   221

 */

   222

typedef struct {

   223

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

   224

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

   225

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

   226

                              configuration. Zero means, that the default Pdo

   227

                              configuration shall be used. */

   228

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

   229

                                          array must contain at least \a

   230

                                          n_entries values. */

   231

} ec_pdo_info_t;

   232

   233

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

   234

   235

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

   236

 *

   237

 * This type is used for the array parameter of the

   238

 * ecrt_domain_reg_pdo_entry_list() convenience function.

   239

 */

   240

typedef struct {

   241

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

   242

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

   243

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

   244

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

   245

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

   246

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

   247

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

   248

                       offset in the process data. */

   249

} ec_pdo_entry_reg_t;

   250

   251

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

   252

 * Global functions

   253

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

   254

   255

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

   256

 *

   257

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

   258

 */

   259

unsigned int ecrt_version_magic(void);

   260

   261

/** Requests an EtherCAT master for realtime operation.

   262

 * 

   263

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

   264

 */

   265

ec_master_t *ecrt_request_master(

   266

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

   267

        );

   268

   269

/** Releases a requested EtherCAT master.

   270

 */

   271

void ecrt_release_master(

   272

        ec_master_t *master /**< EtherCAT master */

   273

        );

   274

   275

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

   276

 * Master methods

   277

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

   278

   279

/** Sets the locking callbacks.

   280

 *

   281

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

   282

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

   283

 * that access is forbidden at this time.

   284

 */

   285

void ecrt_master_callbacks(

   286

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

   287

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

   288

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

   289

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

   290

        );

   291

   292

/** Creates a new domain.

   293

 *

   294

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

   295

 */

   296

ec_domain_t *ecrt_master_create_domain(

   297

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

   298

        );

   299

   300

/** Obtains a slave configuration.

   301

 *

   302

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

   303

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

   304

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

   305

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

   306

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

   307

 *

   308

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

   309

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

   310

 *   ring position.

   311

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

   312

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

   313

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

   314

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

   315

 *

   316

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

   317

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

   318

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

   319

 *

   320

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

   321

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

   322

 * applied.

   323

 *

   324

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

   325

 * \retval NULL in the error case.

   326

 */

   327

ec_slave_config_t *ecrt_master_slave_config(

   328

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

   329

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

   330

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

   331

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

   332

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

   333

        );

   334

   335

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

   336

 *

   337

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

   338

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

   339

 * is operational.

   340

 *

   341

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

   342

 */

   343

int ecrt_master_activate(

   344

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

   345

        );

   346

   347

/** Sends all datagrams in the queue.

   348

 *

   349

 * \todo doc

   350

 */

   351

void ecrt_master_send(

   352

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

   353

        );

   354

   355

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

   356

 */

   357

void ecrt_master_receive(

   358

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

   359

        );

   360

   361

/** Reads the current master state.

   362

 *

   363

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

   364

 */

   365

void ecrt_master_state(

   366

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

   367

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

   368

        );

   369

   370

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

   371

 * Slave configuration methods

   372

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

   373

   374

/** Add a Pdo to the slave's Pdo mapping for the given direction.

   375

 *

   376

 * The first call of this function for a given \a dir will clear the default

   377

 * mapping.

   378

 *

   379

 * \see ecrt_slave_config_mapping()

   380

 * \return zero on success, else non-zero

   381

 */

   382

int ecrt_slave_config_pdo(

   383

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

   384

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

   385

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

   386

        );

   387

   388

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

   389

 *

   390

 * The first call of this function for a given \a pdo_index will clear the

   391

 * default Pdo configuration.

   392

 *

   393

 * \see ecrt_slave_config_mapping()

   394

 * \return zero on success, else non-zero

   395

 */

   396

int ecrt_slave_config_pdo_entry(

   397

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

   398

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

   399

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

   400

                                configuration. */

   401

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

   402

                                  Pdo's configuration. */

   403

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

   404

        );

   405

   406

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

   407

 *

   408

 * This function is a convenience function for the ecrt_slave_config_pdo()

   409

 * and ecrt_slave_config_pdo_entry() functions, that are better suitable

   410

 * for automatic code generation.

   411

 *

   412

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

   413

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

   414

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

   415

 * at configuration time:

   416

 *

   417

 * \code

   418

 * const ec_pdo_entry_info_t el3162_channel1[] = {

   419

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

   420

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

   421

 * };

   422

 * 

   423

 * const ec_pdo_entry_info_t el3162_channel2[] = {

   424

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

   425

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

   426

 * };

   427

 * 

   428

 * const ec_pdo_info_t el3162_mapping[] = {

   429

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

   430

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

   431

 * };

   432

 * 

   433

 * if (ecrt_slave_config_mapping(sc, 2, el3162_mapping))

   434

 *     return -1; // error

   435

 * \endcode

   436

 *

   437

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

   438

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

   439

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

   440

 * left empty and the slave is offline.

   441

 *

   442

 * \code

   443

 * const ec_pdo_info_t pdo_mapping[] = {

   444

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

   445

 *     {EC_DIR_INPUT, 0x1601}  // Channel 2

   446

 * };

   447

 * 

   448

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

   449

 *     return -1; // error

   450

 * \endcode

   451

 *

   452

 * \return zero on success, else non-zero

   453

 */

   454

int ecrt_slave_config_mapping(

   455

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

   456

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

   457

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

   458

        );

   459

   460

/** Registers a Pdo entry for process data exchange in a domain.

   461

 *

   462

 * Searches the current mapping and Pdo configurations for the given Pdo

   463

 * entry. An error is raised, if the given entry is not mapped. Otherwise, the

   464

 * corresponding sync manager and FMMU configurations are provided for slave

   465

 * configuration and the respective sync manager's Pdos are appended to the

   466

 * given domain, if not already done. The offset of the requested Pdo entry's

   467

 * data inside the domain's process data is returned.

   468

 *

   469

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

   470

 * \retval -1  Error: Pdo entry not found.

   471

 * \retval -2  Error: Failed to register Pdo entry.

   472

 */

   473

int ecrt_slave_config_reg_pdo_entry(

   474

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

   475

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

   476

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

   477

        ec_domain_t *domain /**< Domain. */

   478

        );

   479

   480

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

   481

 *

   482

 * \todo doc

   483

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

   484

 */

   485

int ecrt_slave_config_sdo8(

   486

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

   487

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

   488

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

   489

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

   490

        );

   491

   492

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