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 "../globals.h"

    40

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

    41

    42

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

    43

 * EtherCAT master

    44

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

    45

    46

/** Datagram timeout in microseconds. */

    47

#define EC_IO_TIMEOUT 500

    48

    49

/** SDO injection timeout in microseconds. */

    50

#define EC_SDO_INJECTION_TIMEOUT 10000

    51

    52

/** Time to send a byte in nanoseconds.

    53

 *

    54

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

    55

 */

    56

#define EC_BYTE_TRANSMISSION_TIME_NS 80

    57

    58

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

    59

#define EC_FSM_RETRIES 3

    60

    61

/** Seconds to wait before fetching SDO dictionary

    62

    after slave entered PREOP state. */

    63

#define EC_WAIT_SDO_DICT 3

    64

    65

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

    66

#define EC_STATE_STRING_SIZE 32

    67

    68

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

    69

#define EC_MAX_SII_SIZE 4096

    70

    71

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

    72

#define EC_RATE_COUNT 3

    73

    74

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

    75

 * EtherCAT protocol

    76

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

    77

    78

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

    79

#define EC_FRAME_HEADER_SIZE 2

    80

    81

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

    82

#define EC_DATAGRAM_HEADER_SIZE 10

    83

    84

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

    85

#define EC_DATAGRAM_FOOTER_SIZE 2

    86

    87

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

    88

#define EC_ADDR_LEN 4

    89

    90

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

    91

#ifdef DEBUG_DATAGRAM_OVERFLOW

    92

// Define a runt datagram which can be easily overflowed on 

    93

// available hardware for use when testing ec_domain_finish()

    94

#define EC_MAX_DATA_SIZE (128)

    95

#else

    96

#define EC_MAX_DATA_SIZE (ETH_DATA_LEN - EC_FRAME_HEADER_SIZE \

    97

                          - EC_DATAGRAM_HEADER_SIZE - EC_DATAGRAM_FOOTER_SIZE)

    98

#endif // DEBUG_DATAGRAM_OVERFLOW

    99

   100

/** Mailbox header size.  */

   101

#define EC_MBOX_HEADER_SIZE 6

   102

   103

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

   104

#define EC_FIRST_SII_CATEGORY_OFFSET 0x40

   105

   106

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

   107

#define EC_SYNC_PAGE_SIZE 8

   108

   109

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

   110

#define EC_MAX_FMMUS 16

   111

   112

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

   113

#define EC_FMMU_PAGE_SIZE 16

   114

   115

/** Number of DC sync signals. */

   116

#define EC_SYNC_SIGNAL_COUNT 2

   117

   118

/** Size of the datagram description string.

   119

 *

   120

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

   121

 **/

   122

#define EC_DATAGRAM_NAME_SIZE 20

   123

   124

/** Maximum hostname size.

   125

 *

   126

 * Used inside the EoE set IP parameter request.

   127

 */

   128

#define EC_MAX_HOSTNAME_SIZE 32

   129

   130

/** Slave state mask.

   131

 *

   132

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

   133

 * the error flag.

   134

 */

   135

#define EC_SLAVE_STATE_MASK 0x0F

   136

   137

/** State of an EtherCAT slave.

   138

 */

   139

typedef enum {

   140

    EC_SLAVE_STATE_UNKNOWN = 0x00,

   141

    /**< unknown state */

   142

    EC_SLAVE_STATE_INIT = 0x01,

   143

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

   144

    EC_SLAVE_STATE_PREOP = 0x02,

   145

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

   146

    EC_SLAVE_STATE_BOOT = 0x03,

   147

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

   148

    EC_SLAVE_STATE_SAFEOP = 0x04,

   149

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

   150

    EC_SLAVE_STATE_OP = 0x08,

   151

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

   152

    EC_SLAVE_STATE_ACK_ERR = 0x10

   153

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

   154

} ec_slave_state_t;

   155

   156

/** Supported mailbox protocols.

   157

 *

   158

 * Not to mix up with the mailbox type field in the mailbox header defined in

   159

 * master/mailbox.h.

   160

 */

   161

enum {

   162

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

   163

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

   164

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

   165

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

   166

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

   167

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

   168

};

   169

   170

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

   171

 */

   172

typedef struct {

   173

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

   174

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

   175

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

   176

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

   177

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

   178

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

   179

} ec_sii_coe_details_t;

   180

   181

/** Slave information interface general flags.

   182

 */

   183

typedef struct {

   184

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

   185

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

   186

} ec_sii_general_flags_t;

   187

   188

/** EtherCAT slave distributed clocks range.

   189

 */

   190

typedef enum {

   191

    EC_DC_32, /**< 32 bit. */

   192

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

   193

               port 0 receive time. */

   194

} ec_slave_dc_range_t;

   195

   196

/** EtherCAT slave sync signal configuration.

   197

 */

   198

typedef struct {

   199

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

   200

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

   201

} ec_sync_signal_t;

   202

   203

/** Access states for SDO entries.

   204

 *

   205

 * The access rights are managed per AL state.

   206

 */

   207

enum {

   208

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

   209

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

   210

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

   211

    EC_SDO_ENTRY_ACCESS_COUNT /**< Number of states. */

   212

};

   213

   214

/** Master devices.

   215

 */

   216

typedef enum {

   217

    EC_DEVICE_MAIN, /**< Main device. */

   218

    EC_DEVICE_BACKUP /**< Backup device */

   219

} ec_device_index_t;

   220

   221

extern const char *ec_device_names[2]; // only main and backup!

   222

   223

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

   224

   225

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

   226

 *

   227

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

   228

 *

   229

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

   230

 * \param args arguments (optional)

   231

 */

   232

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

   233

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

   234

   235

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

   236

 *

   237

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

   238

 *

   239

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

   240

 * \param args arguments (optional)

   241

 */

   242

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

   243

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

   244

   245

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

   246

 *

   247

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

   248

 *

   249

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

   250

 * \param args arguments (optional)

   251

 */

   252

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

   253

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

   254

   255

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

   256

 *

   257

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

   258

 *

   259

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

   260

 * \param args arguments (optional)

   261

 */

   262

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

   263

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

   264

   265

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

   266

   267

/** Absolute value.

   268

 */

   269

#define EC_ABS(X) ((X) >= 0 ? (X) : -(X))

   270

   271

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

   272

   273

extern char *ec_master_version_str;

   274

   275

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

   276

   277

unsigned int ec_master_count(void);

   278

void ec_print_data(const uint8_t *, size_t);

   279

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

   280

size_t ec_state_string(uint8_t, char *, uint8_t);

   281

ssize_t ec_mac_print(const uint8_t *, char *);

   282

int ec_mac_is_zero(const uint8_t *);

   283

   284

ec_master_t *ecrt_request_master_err(unsigned int);

   285

   286

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

   287

   288

/** Code/Message pair.

   289

 *

   290

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

   291

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

   292

 */

   293

typedef struct {

   294

    uint32_t code; /**< Code. */

   295

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

   296

} ec_code_msg_t;

   297

   298

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

   299

   300

/** Generic request state.

   301

 *

   302

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

   303

 * state_table in master/sdo_request.c.

   304

 */

   305

typedef enum {

   306

    EC_INT_REQUEST_INIT,

   307

    EC_INT_REQUEST_QUEUED,

   308

    EC_INT_REQUEST_BUSY,

   309

    EC_INT_REQUEST_SUCCESS,

   310

    EC_INT_REQUEST_FAILURE

   311

} ec_internal_request_state_t;

   312

   313

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

   314

   315

extern const ec_request_state_t ec_request_state_translation_table[];

   316

   317

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

   318

   319

/** Origin type.

   320

 */

   321

typedef enum {

   322

    EC_ORIG_INTERNAL, /**< Internal. */

   323

    EC_ORIG_EXTERNAL /**< External. */

   324

} ec_origin_t;

   325

   326

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

   327

   328

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

   329

   330

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

   331

   332

#endif