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

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

    74

 * EtherCAT protocol

    75

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

    76

    77

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

    78

#define EC_FRAME_HEADER_SIZE 2

    79

    80

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

    81

#define EC_DATAGRAM_HEADER_SIZE 10

    82

    83

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

    84

#define EC_DATAGRAM_FOOTER_SIZE 2

    85

    86

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

    87

#define EC_ADDR_LEN 4

    88

    89

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

    90

#define EC_MAX_DATA_SIZE (ETH_DATA_LEN - EC_FRAME_HEADER_SIZE \

    91

                          - EC_DATAGRAM_HEADER_SIZE - EC_DATAGRAM_FOOTER_SIZE)

    92

    93

/** Mailbox header size.  */

    94

#define EC_MBOX_HEADER_SIZE 6

    95

    96

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

    97

#define EC_FIRST_SII_CATEGORY_OFFSET 0x40

    98

    99

/** Maximum number of slave ports. */

   100

#define EC_MAX_PORTS 4

   101

   102

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

   103

#define EC_SYNC_PAGE_SIZE 8

   104

   105

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

   106

#define EC_MAX_FMMUS 16

   107

   108

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

   109

#define EC_FMMU_PAGE_SIZE 16

   110

   111

/** Number of DC sync signals. */

   112

#define EC_SYNC_SIGNAL_COUNT 2

   113

   114

/** Size of the datagram description string.

   115

 *

   116

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

   117

 **/

   118

#define EC_DATAGRAM_NAME_SIZE 20

   119

   120

/** Slave state mask.

   121

 *

   122

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

   123

 * the error flag.

   124

 */

   125

#define EC_SLAVE_STATE_MASK 0x0F

   126

   127

/** State of an EtherCAT slave.

   128

 */

   129

typedef enum {

   130

    EC_SLAVE_STATE_UNKNOWN = 0x00,

   131

    /**< unknown state */

   132

    EC_SLAVE_STATE_INIT = 0x01,

   133

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

   134

    EC_SLAVE_STATE_PREOP = 0x02,

   135

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

   136

    EC_SLAVE_STATE_BOOT = 0x03,

   137

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

   138

    EC_SLAVE_STATE_SAFEOP = 0x04,

   139

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

   140

    EC_SLAVE_STATE_OP = 0x08,

   141

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

   142

    EC_SLAVE_STATE_ACK_ERR = 0x10

   143

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

   144

} ec_slave_state_t;

   145

   146

/** Supported mailbox protocols.

   147

 */

   148

enum {

   149

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

   150

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

   151

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

   152

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

   153

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

   154

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

   155

};

   156

   157

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

   158

 */

   159

typedef struct {

   160

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

   161

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

   162

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

   163

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

   164

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

   165

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

   166

} ec_sii_coe_details_t;

   167

   168

/** Slave information interface general flags.

   169

 */

   170

typedef struct {

   171

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

   172

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

   173

} ec_sii_general_flags_t;

   174

   175

/** EtherCAT slave port descriptor.

   176

 */

   177

typedef enum {

   178

    EC_PORT_NOT_IMPLEMENTED,

   179

    EC_PORT_NOT_CONFIGURED,

   180

    EC_PORT_EBUS,

   181

    EC_PORT_MII

   182

} ec_slave_port_desc_t;

   183

   184

/** EtherCAT slave port information.

   185

 */

   186

typedef struct {

   187

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

   188

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

   189

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

   190

} ec_slave_port_link_t;

   191

   192

/** EtherCAT slave distributed clocks range.

   193

 */

   194

typedef enum {

   195

    EC_DC_32, /**< 32 bit. */

   196

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

   197

               port 0 receive time. */

   198

} ec_slave_dc_range_t;

   199

   200

/** EtherCAT slave sync signal configuration.

   201

 */

   202

typedef struct {

   203

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

   204

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

   205

} ec_sync_signal_t;

   206

   207

/** Access states for SDO entries.

   208

 *

   209

 * The access rights are managed per AL state.

   210

 */

   211

enum {

   212

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

   213

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

   214

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

   215

    EC_SDO_ENTRY_ACCESS_COUNT /**< Number of states. */

   216

};

   217

   218

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

   219

   220

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

   221

 *

   222

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

   223

 *

   224

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

   225

 * \param args arguments (optional)

   226

 */

   227

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

   228

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

   229

   230

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

   231

 *

   232

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

   233

 *

   234

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

   235

 * \param args arguments (optional)

   236

 */

   237

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

   238

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

   239

   240

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

   241

 *

   242

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

   243

 *

   244

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

   245

 * \param args arguments (optional)

   246

 */

   247

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

   248

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

   249

   250

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

   251

 *

   252

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

   253

 *

   254

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

   255

 * \param args arguments (optional)

   256

 */

   257

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

   258

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

   259

   260

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

   261

   262

extern char *ec_master_version_str;

   263

   264

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

   265

   266

void ec_print_data(const uint8_t *, size_t);

   267

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

   268

size_t ec_state_string(uint8_t, char *, uint8_t);

   269

ssize_t ec_mac_print(const uint8_t *, char *);

   270

int ec_mac_is_zero(const uint8_t *);

   271

   272

ec_master_t *ecrt_request_master_err(unsigned int);

   273

   274

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

   275

   276

/** Code/Message pair.

   277

 *

   278

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

   279

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

   280

 */

   281

typedef struct {

   282

    uint32_t code; /**< Code. */

   283

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

   284

} ec_code_msg_t;

   285

   286

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

   287

   288

/** Generic request state.

   289

 *

   290

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

   291

 * state_table in master/sdo_request.c.

   292

 */

   293

typedef enum {

   294

    EC_INT_REQUEST_INIT,

   295

    EC_INT_REQUEST_QUEUED,

   296

    EC_INT_REQUEST_BUSY,

   297

    EC_INT_REQUEST_SUCCESS,

   298

    EC_INT_REQUEST_FAILURE

   299

} ec_internal_request_state_t;

   300

   301

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

   302

   303

extern const ec_request_state_t ec_request_state_translation_table[];

   304

   305

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

   306

   307

/** Origin type.

   308

 */

   309

typedef enum {

   310

    EC_ORIG_INTERNAL, /**< Internal. */

   311

    EC_ORIG_EXTERNAL /**< External. */

   312

} ec_origin_t;

   313

   314

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

   315

   316

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

   317

   318

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

   319

   320

#endif