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 1U

    63

#define ECRT_VER_MINOR 2U

    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

   Initialization type for PDO registrations.

    81

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

    82

   function.

    83

*/

    84

    85

typedef struct

    86

{

    87

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

    88

                                  ecrt_master_get_slave()) */

    89

    uint32_t vendor_id; /**< vendor ID */

    90

    uint32_t product_code; /**< product code */

    91

    uint16_t pdo_index; /**< PDO index */

    92

    uint8_t pdo_subindex; /**< PDO subindex */

    93

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

    94

}

    95

ec_pdo_reg_t;

    96

    97

/**

    98

   Direction type for ec_domain_register_pdo_range()

    99

*/

   100

   101

typedef enum {EC_DIR_INPUT, EC_DIR_OUTPUT} ec_direction_t;

   102

   103

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

   104

 *  Master request functions

   105

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

   106

   107

ec_master_t *ecrt_request_master(unsigned int master_index);

   108

void ecrt_release_master(ec_master_t *master);

   109

   110

unsigned int ecrt_version_magic(void);

   111

   112

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

   113

 *  Master methods

   114

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

   115

   116

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

   117

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

   118

   119

ec_domain_t *ecrt_master_create_domain(ec_master_t *master);

   120

   121

int ecrt_master_activate(ec_master_t *master);

   122

   123

void ecrt_master_send(ec_master_t *master);

   124

void ecrt_master_receive(ec_master_t *master);

   125

   126

void ecrt_master_run(ec_master_t *master);

   127

   128

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

   129

   130

/** \cond */

   131

int ecrt_master_state(const ec_master_t *master);

   132

/** \endcond */

   133

   134

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

   135

 *  Domain Methods

   136

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

   137

   138

ec_slave_t *ecrt_domain_register_pdo(ec_domain_t *domain,

   139

                                     const char *address,

   140

                                     uint32_t vendor_id,

   141

                                     uint32_t product_code,

   142

                                     uint16_t pdo_index,

   143

                                     uint8_t pdo_subindex,

   144

                                     void **data_ptr);

   145

   146

int ecrt_domain_register_pdo_list(ec_domain_t *domain,

   147

                                  const ec_pdo_reg_t *pdos);

   148

   149

ec_slave_t *ecrt_domain_register_pdo_range(ec_domain_t *domain,

   150

                                           const char *address,

   151

                                           uint32_t vendor_id,

   152

                                           uint32_t product_code,

   153

                                           ec_direction_t direction,

   154

                                           uint16_t offset,

   155

                                           uint16_t length,

   156

                                           void **data_ptr);

   157

   158

void ecrt_domain_process(ec_domain_t *domain);

   159

void ecrt_domain_queue(ec_domain_t *domain);

   160

int ecrt_domain_state(const ec_domain_t *domain);

   161

   162

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

   163

 *  Slave Methods

   164

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

   165

   166

int ecrt_slave_conf_sdo8(ec_slave_t *slave, uint16_t sdo_index,

   167

                         uint8_t sdo_subindex, uint8_t value);

   168

int ecrt_slave_conf_sdo16(ec_slave_t *slave, uint16_t sdo_index,

   169

                          uint8_t sdo_subindex, uint16_t value);

   170

int ecrt_slave_conf_sdo32(ec_slave_t *slave, uint16_t sdo_index,

   171

                          uint8_t sdo_subindex, uint32_t value);

   172

   173

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

   174

 *  Bitwise read/write macros

   175

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

   176

   177

/**

   178

   Read a certain bit of an EtherCAT data byte.

   179

   \param DATA EtherCAT data pointer

   180

   \param POS bit position

   181

*/

   182

   183

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

   184

   185

/**

   186

   Write a certain bit of an EtherCAT data byte.

   187

   \param DATA EtherCAT data pointer

   188

   \param POS bit position

   189

   \param VAL new bit value

   190

*/

   191

   192

#define EC_WRITE_BIT(DATA, POS, VAL) \

   193

    do { \

   194

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

   195

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

   196

    } while (0)

   197

   198

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

   199

 *  Read macros

   200

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

   201

   202

/**

   203

   Read an 8-bit unsigned value from EtherCAT data.

   204

   \return EtherCAT data value

   205

*/

   206

   207

#define EC_READ_U8(DATA) \

   208

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

   209

   210

/**

   211

   Read an 8-bit signed value from EtherCAT data.

   212

   \param DATA EtherCAT data pointer

   213

   \return EtherCAT data value

   214

*/

   215

   216

#define EC_READ_S8(DATA) \

   217

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

   218

   219

/**

   220

   Read a 16-bit unsigned value from EtherCAT data.

   221

   \param DATA EtherCAT data pointer

   222

   \return EtherCAT data value

   223

*/

   224

   225

#define EC_READ_U16(DATA) \

   226

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

   227

   228

/**

   229

   Read a 16-bit signed value from EtherCAT data.

   230

   \param DATA EtherCAT data pointer

   231

   \return EtherCAT data value

   232

*/

   233

   234

#define EC_READ_S16(DATA) \

   235

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

   236

   237

/**

   238

   Read a 32-bit unsigned value from EtherCAT data.

   239

   \param DATA EtherCAT data pointer

   240

   \return EtherCAT data value

   241

*/

   242

   243

#define EC_READ_U32(DATA) \

   244

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

   245

   246

/**

   247

   Read a 32-bit signed value from EtherCAT data.

   248

   \param DATA EtherCAT data pointer

   249

   \return EtherCAT data value

   250

*/

   251

   252

#define EC_READ_S32(DATA) \

   253

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

   254

   255

   256

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

   257

 *  Write macros

   258

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

   259

   260

/**

   261

   Write an 8-bit unsigned value to EtherCAT data.

   262

   \param DATA EtherCAT data pointer

   263

   \param VAL new value

   264

*/

   265

   266

#define EC_WRITE_U8(DATA, VAL) \

   267

    do { \

   268

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

   269

    } while (0)

   270

   271

/**

   272

   Write an 8-bit signed value to EtherCAT data.

   273

   \param DATA EtherCAT data pointer

   274

   \param VAL new value

   275

*/

   276

   277

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

   278

   279

/**

   280

   Write a 16-bit unsigned value to EtherCAT data.

   281

   \param DATA EtherCAT data pointer

   282

   \param VAL new value

   283

*/

   284

   285

#define EC_WRITE_U16(DATA, VAL) \

   286

    do { \

   287

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

   288

        cpu_to_le16s(DATA); \

   289

    } while (0)

   290

   291

/**

   292

   Write a 16-bit signed value to EtherCAT data.

   293

   \param DATA EtherCAT data pointer

   294

   \param VAL new value

   295

*/

   296

   297

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

   298

   299

/**

   300

   Write a 32-bit unsigned value to EtherCAT data.

   301

   \param DATA EtherCAT data pointer

   302

   \param VAL new value

   303

*/

   304

   305

#define EC_WRITE_U32(DATA, VAL) \

   306

    do { \

   307

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

   308

        cpu_to_le16s(DATA); \

   309

    } while (0)

   310

   311

/**

   312

   Write a 32-bit signed value to EtherCAT data.

   313

   \param DATA EtherCAT data pointer

   314

   \param VAL new value

   315

*/

   316

   317

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

   318

   319

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

   320

   321

#endif