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; version 2 of the License.

    12

 *

    13

 *  The IgH EtherCAT Master is distributed in the hope that it will be

    14

 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    16

 *  GNU General Public License for more details.

    17

 *

    18

 *  You should have received a copy of the GNU General Public License

    19

 *  along with the IgH EtherCAT Master; if not, write to the Free Software

    20

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    21

 *

    22

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

    23

    24

/**

    25

   \file

    26

   EtherCAT realtime interface.

    27

*/

    28

    29

/**

    30

   \defgroup RealtimeInterface EtherCAT realtime interface

    31

   EtherCAT interface for realtime modules.

    32

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

    33

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

    34

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

    35

*/

    36

    37

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

    38

    39

#ifndef __ECRT_H__

    40

#define __ECRT_H__

    41

    42

#include <asm/byteorder.h>

    43

    44

#ifdef __KERNEL__

    45

#include <linux/types.h>

    46

#else

    47

#include <stdint.h>

    48

#endif

    49

    50

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

    51

    52

struct ec_master;

    53

typedef struct ec_master ec_master_t;

    54

    55

struct ec_domain;

    56

typedef struct ec_domain ec_domain_t;

    57

    58

struct ec_slave;

    59

typedef struct ec_slave ec_slave_t;

    60

    61

/**

    62

   Initialization type for field registrations.

    63

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

    64

   function.

    65

*/

    66

    67

typedef struct

    68

{

    69

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

    70

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

    71

                                  ecrt_master_get_slave()) */

    72

    const char *vendor_name; /**< vendor name */

    73

    const char *product_name; /**< product name */

    74

    const char *field_name; /**< data field name */

    75

    unsigned int field_index; /**< index in data fields with same name */

    76

    unsigned int field_count; /**< number of data fields with same name */

    77

}

    78

ec_field_init_t;

    79

    80

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

    81

 *  Master request functions

    82

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

    83

    84

ec_master_t *ecrt_request_master(unsigned int master_index);

    85

void ecrt_release_master(ec_master_t *master);

    86

    87

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

    88

 *  Master methods

    89

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

    90

    91

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

    92

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

    93

    94

ec_domain_t *ecrt_master_create_domain(ec_master_t *master);

    95

    96

int ecrt_master_activate(ec_master_t *master);

    97

void ecrt_master_deactivate(ec_master_t *master);

    98

    99

int ecrt_master_fetch_sdo_lists(ec_master_t *master);

   100

   101

void ecrt_master_sync_io(ec_master_t *master);

   102

void ecrt_master_async_send(ec_master_t *master);

   103

void ecrt_master_async_receive(ec_master_t *master);

   104

void ecrt_master_prepare_async_io(ec_master_t *master);

   105

   106

void ecrt_master_run(ec_master_t *master);

   107

   108

int ecrt_master_start_eoe(ec_master_t *master);

   109

   110

void ecrt_master_debug(ec_master_t *master, int level);

   111

void ecrt_master_print(const ec_master_t *master, unsigned int verbosity);

   112

   113

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

   114

   115

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

   116

 *  Domain Methods

   117

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

   118

   119

ec_slave_t *ecrt_domain_register_field(ec_domain_t *domain,

   120

                                       const char *address,

   121

                                       const char *vendor_name,

   122

                                       const char *product_name,

   123

                                       void **data_ptr, const char *field_name,

   124

                                       unsigned int field_index,

   125

                                       unsigned int field_count);

   126

int ecrt_domain_register_field_list(ec_domain_t *domain,

   127

                                    const ec_field_init_t *fields);

   128

   129

void ecrt_domain_queue(ec_domain_t *domain);

   130

void ecrt_domain_process(ec_domain_t *domain);

   131

   132

int ecrt_domain_state(ec_domain_t *domain);

   133

   134

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

   135

 *  Slave Methods

   136

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

   137

   138

int ecrt_slave_sdo_read_exp8(ec_slave_t *slave, uint16_t sdo_index,

   139

                              uint8_t sdo_subindex, uint8_t *value);

   140

int ecrt_slave_sdo_read_exp16(ec_slave_t *slave, uint16_t sdo_index,

   141

                              uint8_t sdo_subindex, uint16_t *value);

   142

int ecrt_slave_sdo_read_exp32(ec_slave_t *slave, uint16_t sdo_index,

   143

                              uint8_t sdo_subindex, uint32_t *value);

   144

int ecrt_slave_sdo_write_exp8(ec_slave_t *slave, uint16_t sdo_index,

   145

                              uint8_t sdo_subindex, uint8_t value);

   146

int ecrt_slave_sdo_write_exp16(ec_slave_t *slave, uint16_t sdo_index,

   147

                               uint8_t sdo_subindex, uint16_t value);

   148

int ecrt_slave_sdo_write_exp32(ec_slave_t *slave, uint16_t sdo_index,

   149

                               uint8_t sdo_subindex, uint32_t value);

   150

int ecrt_slave_sdo_read(ec_slave_t *slave, uint16_t sdo_index,

   151

                        uint8_t sdo_subindex, uint8_t *data, size_t *size);

   152

   153

int ecrt_slave_write_alias(ec_slave_t *slave, uint16_t alias);

   154

   155

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

   156

 *  Bitwise read/write macros

   157

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

   158

   159

/**

   160

   Read a certain bit of an EtherCAT data byte.

   161

   \param DATA EtherCAT data pointer

   162

   \param POS bit position

   163

*/

   164

   165

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

   166

   167

/**

   168

   Write a certain bit of an EtherCAT data byte.

   169

   \param DATA EtherCAT data pointer

   170

   \param POS bit position

   171

   \param VAL new bit value

   172

*/

   173

   174

#define EC_WRITE_BIT(DATA, POS, VAL) \

   175

    do { \

   176

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

   177

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

   178

    } while (0)

   179

   180

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

   181

 *  Read macros

   182

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

   183

   184

/**

   185

   Read an 8-bit unsigned value from EtherCAT data.

   186

   \return EtherCAT data value

   187

*/

   188

   189

#define EC_READ_U8(DATA) \

   190

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

   191

   192

/**

   193

   Read an 8-bit signed value from EtherCAT data.

   194

   \param DATA EtherCAT data pointer

   195

   \return EtherCAT data value

   196

*/

   197

   198

#define EC_READ_S8(DATA) \

   199

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

   200

   201

/**

   202

   Read a 16-bit unsigned value from EtherCAT data.

   203

   \param DATA EtherCAT data pointer

   204

   \return EtherCAT data value

   205

*/

   206

   207

#define EC_READ_U16(DATA) \

   208

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

   209

   210

/**

   211

   Read a 16-bit signed value from EtherCAT data.

   212

   \param DATA EtherCAT data pointer

   213

   \return EtherCAT data value

   214

*/

   215

   216

#define EC_READ_S16(DATA) \

   217

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

   218

   219

/**

   220

   Read a 32-bit unsigned value from EtherCAT data.

   221

   \param DATA EtherCAT data pointer

   222

   \return EtherCAT data value

   223

*/

   224

   225

#define EC_READ_U32(DATA) \

   226

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

   227

   228

/**

   229

   Read a 32-bit signed value from EtherCAT data.

   230

   \param DATA EtherCAT data pointer

   231

   \return EtherCAT data value

   232

*/

   233

   234

#define EC_READ_S32(DATA) \

   235

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

   236

   237

   238

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

   239

 *  Write macros

   240

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

   241

   242

/**

   243

   Write an 8-bit unsigned value to EtherCAT data.

   244

   \param DATA EtherCAT data pointer

   245

   \param VAL new value

   246

*/

   247

   248

#define EC_WRITE_U8(DATA, VAL) \

   249

    do { \

   250

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

   251

    } while (0)

   252

   253

/**

   254

   Write an 8-bit signed value to EtherCAT data.

   255

   \param DATA EtherCAT data pointer

   256

   \param VAL new value

   257

*/

   258

   259

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

   260

   261

/**

   262

   Write a 16-bit unsigned value to EtherCAT data.

   263

   \param DATA EtherCAT data pointer

   264

   \param VAL new value

   265

*/

   266

   267

#define EC_WRITE_U16(DATA, VAL) \

   268

    do { \

   269

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

   270

        cpu_to_le16s(DATA); \

   271

    } while (0)

   272

   273

/**

   274

   Write a 16-bit signed value to EtherCAT data.

   275

   \param DATA EtherCAT data pointer

   276

   \param VAL new value

   277

*/

   278

   279

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

   280

   281

/**

   282

   Write a 32-bit unsigned value to EtherCAT data.

   283

   \param DATA EtherCAT data pointer

   284

   \param VAL new value

   285

*/

   286

   287

#define EC_WRITE_U32(DATA, VAL) \

   288

    do { \

   289

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

   290

        cpu_to_le16s(DATA); \

   291

    } while (0)

   292

   293

/**

   294

   Write a 32-bit signed value to EtherCAT data.

   295

   \param DATA EtherCAT data pointer

   296

   \param VAL new value

   297

*/

   298

   299

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

   300

   301

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

   302

   303

#endif