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

/**

    35

   \file

    36

   EtherCAT realtime interface.

    37

*/

    38

    39

/**

    40

   \defgroup RealtimeInterface EtherCAT realtime interface

    41

   EtherCAT interface for realtime modules.

    42

   This interface is designed for realtime modules that want to use EtherCAT.

    43

   There are functions to request a master, to map process data, to communicate

    44

   with slaves via CoE and to configure and activate the bus.

    45

*/

    46

    47

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

    48

    49

#ifndef __ECRT_H__

    50

#define __ECRT_H__

    51

    52

#include <asm/byteorder.h>

    53

    54

#ifdef __KERNEL__

    55

#include <linux/types.h>

    56

#else

    57

#include <stdint.h>

    58

#endif

    59

    60

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

    61

    62

#define ECRT_VER_MAJOR 1

    63

#define ECRT_VER_MINOR 3

    64

    65

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

    66

#define ECRT_VERSION_MAGIC ECRT_VERSION(ECRT_VER_MAJOR, ECRT_VER_MINOR)

    67

    68

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

    69

    70

struct ec_master;

    71

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

    72

    73

struct ec_domain;

    74

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

    75

    76

struct ec_slave;

    77

typedef struct ec_slave ec_slave_t; /**< \see ec_slave */

    78

    79

/**

    80

 * Bus status.

    81

 */

    82

    83

typedef enum {

    84

    EC_BUS_FAILURE,    // some slaves offline

    85

    EC_BUS_OK,         // all slaves online

    86

    EC_BUS_REDUNDANCY  // bus interrupted, but redundancy active

    87

}

    88

ec_bus_status_t;

    89

    90

/**

    91

 * Master status.

    92

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

    93

 */

    94

    95

typedef struct {

    96

    ec_bus_status_t bus_status;

    97

    unsigned int bus_tainted;

    98

    unsigned int slaves_responding;

    99

}

   100

ec_master_status_t;

   101

   102

/**

   103

   Initialization type for PDO registrations.

   104

   This type is used as a parameter for the ecrt_domain_register_pdo_list()

   105

   function.

   106

*/

   107

   108

typedef struct

   109

{

   110

    const char *slave_address; /**< slave address string (see

   111

                                  ecrt_master_get_slave()) */

   112

    uint32_t vendor_id; /**< vendor ID */

   113

    uint32_t product_code; /**< product code */

   114

    uint16_t pdo_entry_index; /**< PDO entry index */

   115

    uint8_t pdo_entry_subindex; /**< PDO entry subindex */

   116

    void **data_ptr; /**< address of the process data pointer */

   117

}

   118

ec_pdo_reg_t;

   119

   120

/**

   121

   Direction type for ecrt_domain_register_pdo_range()

   122

*/

   123

   124

typedef enum {

   125

    EC_DIR_OUTPUT,

   126

    EC_DIR_INPUT

   127

}

   128

ec_direction_t;

   129

   130

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

   131

 *  Master request functions

   132

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

   133

   134

ec_master_t *ecrt_request_master(unsigned int master_index);

   135

void ecrt_release_master(ec_master_t *master);

   136

   137

unsigned int ecrt_version_magic(void);

   138

   139

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

   140

 *  Master methods

   141

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

   142

   143

void ecrt_master_callbacks(ec_master_t *master, int (*request_cb)(void *),

   144

                           void (*release_cb)(void *), void *cb_data);

   145

   146

ec_domain_t *ecrt_master_create_domain(ec_master_t *master);

   147

   148

int ecrt_master_activate(ec_master_t *master);

   149

   150

void ecrt_master_send(ec_master_t *master);

   151

void ecrt_master_receive(ec_master_t *master);

   152

   153

ec_slave_t *ecrt_master_get_slave(const ec_master_t *, const char *);

   154

   155

void ecrt_master_get_status(const ec_master_t *master, ec_master_status_t *);

   156

   157

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

   158

 *  Domain Methods

   159

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

   160

   161

ec_slave_t *ecrt_domain_register_pdo(ec_domain_t *domain,

   162

                                     const char *address,

   163

                                     uint32_t vendor_id,

   164

                                     uint32_t product_code,

   165

                                     uint16_t pdo_index,

   166

                                     uint8_t pdo_subindex,

   167

                                     void **data_ptr);

   168

   169

int ecrt_domain_register_pdo_list(ec_domain_t *domain,

   170

                                  const ec_pdo_reg_t *pdos);

   171

   172

ec_slave_t *ecrt_domain_register_pdo_range(ec_domain_t *domain,

   173

                                           const char *address,

   174

                                           uint32_t vendor_id,

   175

                                           uint32_t product_code,

   176

                                           ec_direction_t direction,

   177

                                           uint16_t offset,

   178

                                           uint16_t length,

   179

                                           void **data_ptr);

   180

   181

void ecrt_domain_process(ec_domain_t *domain);

   182

void ecrt_domain_queue(ec_domain_t *domain);

   183

int ecrt_domain_state(const ec_domain_t *domain);

   184

   185

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

   186

 *  Slave Methods

   187

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

   188

   189

int ecrt_slave_conf_sdo8(ec_slave_t *slave, uint16_t sdo_index,

   190

                         uint8_t sdo_subindex, uint8_t value);

   191

int ecrt_slave_conf_sdo16(ec_slave_t *slave, uint16_t sdo_index,

   192

                          uint8_t sdo_subindex, uint16_t value);

   193

int ecrt_slave_conf_sdo32(ec_slave_t *slave, uint16_t sdo_index,

   194

                          uint8_t sdo_subindex, uint32_t value);

   195

   196

void ecrt_slave_pdo_mapping_clear(ec_slave_t *, ec_direction_t);

   197

int ecrt_slave_pdo_mapping_add(ec_slave_t *, ec_direction_t, uint16_t);

   198

int ecrt_slave_pdo_mapping(ec_slave_t *, ec_direction_t, unsigned int, ...);

   199

   200

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

   201

 *  Bitwise read/write macros

   202

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

   203

   204

/**

   205

   Read a certain bit of an EtherCAT data byte.

   206

   \param DATA EtherCAT data pointer

   207

   \param POS bit position

   208

*/

   209

   210

#define EC_READ_BIT(DATA, POS) ((*((uint8_t *) (DATA)) >> (POS)) & 0x01)

   211

   212

/**

   213

   Write a certain bit of an EtherCAT data byte.

   214

   \param DATA EtherCAT data pointer

   215

   \param POS bit position

   216

   \param VAL new bit value

   217

*/

   218

   219

#define EC_WRITE_BIT(DATA, POS, VAL) \

   220

    do { \

   221

        if (VAL) *((uint8_t *) (DATA)) |=  (1 << (POS)); \

   222

        else     *((uint8_t *) (DATA)) &= ~(1 << (POS)); \

   223

    } while (0)

   224

   225

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

   226

 *  Read macros

   227

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

   228

   229

/**

   230

   Read an 8-bit unsigned value from EtherCAT data.

   231

   \return EtherCAT data value

   232

*/

   233

   234

#define EC_READ_U8(DATA) \

   235

    ((uint8_t) *((uint8_t *) (DATA)))

   236

   237

/**

   238

   Read an 8-bit signed value from EtherCAT data.

   239

   \param DATA EtherCAT data pointer

   240

   \return EtherCAT data value

   241

*/

   242

   243

#define EC_READ_S8(DATA) \

   244

     ((int8_t) *((uint8_t *) (DATA)))

   245

   246

/**

   247

   Read a 16-bit unsigned value from EtherCAT data.

   248

   \param DATA EtherCAT data pointer

   249

   \return EtherCAT data value

   250

*/

   251

   252

#define EC_READ_U16(DATA) \

   253

     ((uint16_t) le16_to_cpup((void *) (DATA)))

   254

   255

/**

   256

   Read a 16-bit signed value from EtherCAT data.

   257

   \param DATA EtherCAT data pointer

   258

   \return EtherCAT data value

   259

*/

   260

   261

#define EC_READ_S16(DATA) \

   262

     ((int16_t) le16_to_cpup((void *) (DATA)))

   263

   264

/**

   265

   Read a 32-bit unsigned value from EtherCAT data.

   266

   \param DATA EtherCAT data pointer

   267

   \return EtherCAT data value

   268

*/

   269

   270

#define EC_READ_U32(DATA) \

   271

     ((uint32_t) le32_to_cpup((void *) (DATA)))

   272

   273

/**

   274

   Read a 32-bit signed value from EtherCAT data.

   275

   \param DATA EtherCAT data pointer

   276

   \return EtherCAT data value

   277

*/

   278

   279

#define EC_READ_S32(DATA) \

   280

     ((int32_t) le32_to_cpup((void *) (DATA)))

   281

   282

   283

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

   284

 *  Write macros

   285

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

   286

   287

/**

   288

   Write an 8-bit unsigned value to EtherCAT data.

   289

   \param DATA EtherCAT data pointer

   290

   \param VAL new value

   291

*/

   292

   293

#define EC_WRITE_U8(DATA, VAL) \

   294

    do { \

   295

        *((uint8_t *)(DATA)) = ((uint8_t) (VAL)); \

   296

    } while (0)

   297

   298

/**

   299

   Write an 8-bit signed value to EtherCAT data.

   300

   \param DATA EtherCAT data pointer

   301

   \param VAL new value

   302

*/

   303

   304

#define EC_WRITE_S8(DATA, VAL) EC_WRITE_U8(DATA, VAL)

   305

   306

/**

   307

   Write a 16-bit unsigned value to EtherCAT data.

   308

   \param DATA EtherCAT data pointer

   309

   \param VAL new value

   310

*/

   311

   312

#define EC_WRITE_U16(DATA, VAL) \

   313

    do { \

   314

        *((uint16_t *) (DATA)) = (uint16_t) (VAL); \

   315

        cpu_to_le16s(DATA); \

   316

    } while (0)

   317

   318

/**

   319

   Write a 16-bit signed value to EtherCAT data.

   320

   \param DATA EtherCAT data pointer

   321

   \param VAL new value

   322

*/

   323

   324

#define EC_WRITE_S16(DATA, VAL) EC_WRITE_U16(DATA, VAL)

   325

   326

/**

   327

   Write a 32-bit unsigned value to EtherCAT data.

   328

   \param DATA EtherCAT data pointer

   329

   \param VAL new value

   330

*/

   331

   332

#define EC_WRITE_U32(DATA, VAL) \

   333

    do { \

   334

        *((uint32_t *) (DATA)) = (uint32_t) (VAL); \

   335

        cpu_to_le16s(DATA); \

   336

    } while (0)

   337

   338

/**

   339

   Write a 32-bit signed value to EtherCAT data.

   340

   \param DATA EtherCAT data pointer

   341

   \param VAL new value

   342

*/

   343

   344

#define EC_WRITE_S32(DATA, VAL) EC_WRITE_U32(DATA, VAL)

   345

   346

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

   347

   348

#endif