1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006-2008  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 and/or

    10

 *  modify it under the terms of the GNU General Public License version 2, as

    11

 *  published by the Free Software Foundation.

    12

 *

    13

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

    14

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

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General

    16

 *  Public License for more details.

    17

 *

    18

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

    19

 *  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

 *  The license mentioned above concerns the source code only. Using the

    25

 *  EtherCAT technology and brand is only permitted in compliance with the

    26

 *  industrial property and similar rights of Beckhoff Automation GmbH.

    27

 *

    28

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

    29

    30

/** \file

    31

 * Global definitions and macros.

    32

 */

    33

    34

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

    35

    36

#ifndef __EC_MASTER_GLOBALS_H__

    37

#define __EC_MASTER_GLOBALS_H__

    38

    39

#include <linux/types.h>

    40

    41

#include "../globals.h"

    42

#include "../include/ecrt.h"

    43

    44

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

    45

 * EtherCAT master

    46

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

    47

    48

/** Datagram timeout in microseconds. */

    49

#define EC_IO_TIMEOUT 500

    50

    51

/** SDO injection timeout in microseconds. */

    52

#define EC_SDO_INJECTION_TIMEOUT 10000

    53

    54

/** Time to send a byte in nanoseconds.

    55

 *

    56

 * t_ns = 1 / (100 MBit/s / 8 bit/byte) = 80 ns/byte

    57

 */

    58

#define EC_BYTE_TRANSMISSION_TIME_NS 80

    59

    60

/** Number of state machine retries on datagram timeout. */

    61

#define EC_FSM_RETRIES 3

    62

    63

/** Seconds to wait before fetching SDO dictionary

    64

    after slave entered PREOP state. */

    65

#define EC_WAIT_SDO_DICT 3

    66

    67

/** Minimum size of a buffer used with ec_state_string(). */

    68

#define EC_STATE_STRING_SIZE 32

    69

    70

/** Maximum SII size in words, to avoid infinite reading. */

    71

#define EC_MAX_SII_SIZE 4096

    72

    73

/** Number of statistic rate intervals to maintain. */

    74

#define EC_RATE_COUNT 3

    75

    76

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

    77

 * EtherCAT protocol

    78

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

    79

    80

/** Size of an EtherCAT frame header. */

    81

#define EC_FRAME_HEADER_SIZE 2

    82

    83

/** Size of an EtherCAT datagram header. */

    84

#define EC_DATAGRAM_HEADER_SIZE 10

    85

    86

/** Size of an EtherCAT datagram footer. */

    87

#define EC_DATAGRAM_FOOTER_SIZE 2

    88

    89

/** Size of the EtherCAT address field. */

    90

#define EC_ADDR_LEN 4

    91

    92

/** Resulting maximum data size of a single datagram in a frame. */

    93

#define EC_MAX_DATA_SIZE (ETH_DATA_LEN - EC_FRAME_HEADER_SIZE \

    94

                          - EC_DATAGRAM_HEADER_SIZE - EC_DATAGRAM_FOOTER_SIZE)

    95

    96

/** Mailbox header size.  */

    97

#define EC_MBOX_HEADER_SIZE 6

    98

    99

/** Word offset of first SII category. */

   100

#define EC_FIRST_SII_CATEGORY_OFFSET 0x40

   101

   102

/** Maximum number of slave ports. */

   103

#define EC_MAX_PORTS 4

   104

   105

/** Size of a sync manager configuration page. */

   106

#define EC_SYNC_PAGE_SIZE 8

   107

   108

/** Maximum number of FMMUs per slave. */

   109

#define EC_MAX_FMMUS 16

   110

   111

/** Size of an FMMU configuration page. */

   112

#define EC_FMMU_PAGE_SIZE 16

   113

   114

/** Number of DC sync signals. */

   115

#define EC_SYNC_SIGNAL_COUNT 2

   116

   117

/** Size of the datagram description string.

   118

 *

   119

 * This is also used as the maximum lenth of EoE device names.

   120

 **/

   121

#define EC_DATAGRAM_NAME_SIZE 20

   122

   123

/** Slave state mask.

   124

 *

   125

 * Apply this mask to a slave state byte to get the slave state without

   126

 * the error flag.

   127

 */

   128

#define EC_SLAVE_STATE_MASK 0x0F

   129

   130

/** State of an EtherCAT slave.

   131

 */

   132

typedef enum {

   133

    EC_SLAVE_STATE_UNKNOWN = 0x00,

   134

    /**< unknown state */

   135

    EC_SLAVE_STATE_INIT = 0x01,

   136

    /**< INIT state (no mailbox communication, no IO) */

   137

    EC_SLAVE_STATE_PREOP = 0x02,

   138

    /**< PREOP state (mailbox communication, no IO) */

   139

    EC_SLAVE_STATE_BOOT = 0x03,

   140

    /**< Bootstrap state (mailbox communication, firmware update) */

   141

    EC_SLAVE_STATE_SAFEOP = 0x04,

   142

    /**< SAFEOP (mailbox communication and input update) */

   143

    EC_SLAVE_STATE_OP = 0x08,

   144

    /**< OP (mailbox communication and input/output update) */

   145

    EC_SLAVE_STATE_ACK_ERR = 0x10

   146

    /**< Acknowledge/Error bit (no actual state) */

   147

} ec_slave_state_t;

   148

   149

/** Supported mailbox protocols.

   150

 */

   151

enum {

   152

    EC_MBOX_AOE = 0x01, /**< ADS over EtherCAT */

   153

    EC_MBOX_EOE = 0x02, /**< Ethernet over EtherCAT */

   154

    EC_MBOX_COE = 0x04, /**< CANopen over EtherCAT */

   155

    EC_MBOX_FOE = 0x08, /**< File-Access over EtherCAT */

   156

    EC_MBOX_SOE = 0x10, /**< Servo-Profile over EtherCAT */

   157

    EC_MBOX_VOE = 0x20  /**< Vendor specific */

   158

};

   159

   160

/** Slave information interface CANopen over EtherCAT details flags.

   161

 */

   162

typedef struct {

   163

    uint8_t enable_sdo : 1; /**< Enable SDO access. */

   164

    uint8_t enable_sdo_info : 1; /**< SDO information service available. */

   165

    uint8_t enable_pdo_assign : 1; /**< PDO mapping configurable. */

   166

    uint8_t enable_pdo_configuration : 1; /**< PDO configuration possible. */

   167

    uint8_t enable_upload_at_startup : 1; /**< ?. */

   168

    uint8_t enable_sdo_complete_access : 1; /**< Complete access possible. */

   169

} ec_sii_coe_details_t;

   170

   171

/** Slave information interface general flags.

   172

 */

   173

typedef struct {

   174

    uint8_t enable_safeop : 1; /**< ?. */

   175

    uint8_t enable_not_lrw : 1; /**< Slave does not support LRW. */

   176

} ec_sii_general_flags_t;

   177

   178

/** EtherCAT slave port descriptor.

   179

 */

   180

typedef enum {

   181

    EC_PORT_NOT_IMPLEMENTED,

   182

    EC_PORT_NOT_CONFIGURED,

   183

    EC_PORT_EBUS,

   184

    EC_PORT_MII

   185

} ec_slave_port_desc_t;

   186

   187

/** EtherCAT slave port information.

   188

 */

   189

typedef struct {

   190

    uint8_t link_up; /**< Link detected. */

   191

    uint8_t loop_closed; /**< Loop closed. */

   192

    uint8_t signal_detected; /**< Detected signal on RX port. */

   193

} ec_slave_port_link_t;

   194

   195

/** EtherCAT slave distributed clocks range.

   196

 */

   197

typedef enum {

   198

    EC_DC_32, /**< 32 bit. */

   199

    EC_DC_64 /*< 64 bit for system time, system time offset and

   200

               port 0 receive time. */

   201

} ec_slave_dc_range_t;

   202

   203

/** EtherCAT slave sync signal configuration.

   204

 */

   205

typedef struct {

   206

    uint32_t cycle_time; /**< Cycle time [ns]. */

   207

    uint32_t shift_time; /**< Shift time [ns]. */

   208

} ec_sync_signal_t;

   209

   210

/** Access states for SDO entries.

   211

 *

   212

 * The access rights are managed per AL state.

   213

 */

   214

enum {

   215

    EC_SDO_ENTRY_ACCESS_PREOP, /**< Access rights in PREOP. */

   216

    EC_SDO_ENTRY_ACCESS_SAFEOP, /**< Access rights in SAFEOP. */

   217

    EC_SDO_ENTRY_ACCESS_OP, /**< Access rights in OP. */

   218

    EC_SDO_ENTRY_ACCESS_COUNT /**< Number of states. */

   219

};

   220

   221

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

   222

   223

/** Convenience macro for printing EtherCAT-specific information to syslog.

   224

 *

   225

 * This will print the message in \a fmt with a prefixed "EtherCAT: ".

   226

 *

   227

 * \param fmt format string (like in printf())

   228

 * \param args arguments (optional)

   229

 */

   230

#define EC_INFO(fmt, args...) \

   231

    printk(KERN_INFO "EtherCAT: " fmt, ##args)

   232

   233

/** Convenience macro for printing EtherCAT-specific errors to syslog.

   234

 *

   235

 * This will print the message in \a fmt with a prefixed "EtherCAT ERROR: ".

   236

 *

   237

 * \param fmt format string (like in printf())

   238

 * \param args arguments (optional)

   239

 */

   240

#define EC_ERR(fmt, args...) \

   241

    printk(KERN_ERR "EtherCAT ERROR: " fmt, ##args)

   242

   243

/** Convenience macro for printing EtherCAT-specific warnings to syslog.

   244

 *

   245

 * This will print the message in \a fmt with a prefixed "EtherCAT WARNING: ".

   246

 *

   247

 * \param fmt format string (like in printf())

   248

 * \param args arguments (optional)

   249

 */

   250

#define EC_WARN(fmt, args...) \

   251

    printk(KERN_WARNING "EtherCAT WARNING: " fmt, ##args)

   252

   253

/** Convenience macro for printing EtherCAT debug messages to syslog.

   254

 *

   255

 * This will print the message in \a fmt with a prefixed "EtherCAT DEBUG: ".

   256

 *

   257

 * \param fmt format string (like in printf())

   258

 * \param args arguments (optional)

   259

 */

   260

#define EC_DBG(fmt, args...) \

   261

    printk(KERN_DEBUG "EtherCAT DEBUG: " fmt, ##args)

   262

   263

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

   264

   265

extern char *ec_master_version_str;

   266

   267

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

   268

   269

unsigned int ec_master_count(void);

   270

void ec_print_data(const uint8_t *, size_t);

   271

void ec_print_data_diff(const uint8_t *, const uint8_t *, size_t);

   272

size_t ec_state_string(uint8_t, char *, uint8_t);

   273

ssize_t ec_mac_print(const uint8_t *, char *);

   274

int ec_mac_is_zero(const uint8_t *);

   275

   276

ec_master_t *ecrt_request_master_err(unsigned int);

   277

   278

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

   279

   280

/** Code/Message pair.

   281

 *

   282

 * Some EtherCAT datagrams support reading a status code to display a certain

   283

 * message. This type allows to map a code to a message string.

   284

 */

   285

typedef struct {

   286

    uint32_t code; /**< Code. */

   287

    const char *message; /**< Message belonging to \a code. */

   288

} ec_code_msg_t;

   289

   290

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

   291

   292

/** Generic request state.

   293

 *

   294

 * \attention If ever changing this, please be sure to adjust the \a

   295

 * state_table in master/sdo_request.c.

   296

 */

   297

typedef enum {

   298

    EC_INT_REQUEST_INIT,

   299

    EC_INT_REQUEST_QUEUED,

   300

    EC_INT_REQUEST_BUSY,

   301

    EC_INT_REQUEST_SUCCESS,

   302

    EC_INT_REQUEST_FAILURE

   303

} ec_internal_request_state_t;

   304

   305

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

   306

   307

extern const ec_request_state_t ec_request_state_translation_table[];

   308

   309

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

   310

   311

/** Origin type.

   312

 */

   313

typedef enum {

   314

    EC_ORIG_INTERNAL, /**< Internal. */

   315

    EC_ORIG_EXTERNAL /**< External. */

   316

} ec_origin_t;

   317

   318

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

   319

   320

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

   321

   322

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

   323

   324

#endif