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

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

    52

#define EC_FSM_RETRIES 3

    53

    54

/** Seconds to wait before fetching SDO dictionary

    55

    after slave entered PREOP state. */

    56

#define EC_WAIT_SDO_DICT 3

    57

    58

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

    59

#define EC_STATE_STRING_SIZE 32

    60

    61

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

    62

#define EC_MAX_SII_SIZE 4096

    63

    64

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

    65

 * EtherCAT protocol

    66

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

    67

    68

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

    69

#define EC_FRAME_HEADER_SIZE 2

    70

    71

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

    72

#define EC_DATAGRAM_HEADER_SIZE 10

    73

    74

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

    75

#define EC_DATAGRAM_FOOTER_SIZE 2

    76

    77

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

    78

#define EC_ADDR_LEN 4

    79

    80

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

    81

#define EC_MAX_DATA_SIZE (ETH_DATA_LEN - EC_FRAME_HEADER_SIZE \

    82

                          - EC_DATAGRAM_HEADER_SIZE - EC_DATAGRAM_FOOTER_SIZE)

    83

    84

/** Mailbox header size.  */

    85

#define EC_MBOX_HEADER_SIZE 6

    86

    87

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

    88

#define EC_FIRST_SII_CATEGORY_OFFSET 0x40

    89

    90

/** Maximum number of slave ports. */

    91

#define EC_MAX_PORTS 4

    92

    93

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

    94

#define EC_SYNC_PAGE_SIZE 8

    95

    96

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

    97

#define EC_MAX_FMMUS 16

    98

    99

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

   100

#define EC_FMMU_PAGE_SIZE 16

   101

   102

/** Number of DC sync signals. */

   103

#define EC_SYNC_SIGNAL_COUNT 2

   104

   105

/** Size of the datagram description string.

   106

 *

   107

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

   108

 **/

   109

#define EC_DATAGRAM_NAME_SIZE 20

   110

   111

/** Slave state mask.

   112

 *

   113

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

   114

 * the error flag.

   115

 */

   116

#define EC_SLAVE_STATE_MASK 0x0F

   117

   118

/** State of an EtherCAT slave.

   119

 */

   120

typedef enum {

   121

    EC_SLAVE_STATE_UNKNOWN = 0x00,

   122

    /**< unknown state */

   123

    EC_SLAVE_STATE_INIT = 0x01,

   124

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

   125

    EC_SLAVE_STATE_PREOP = 0x02,

   126

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

   127

    EC_SLAVE_STATE_BOOT = 0x03,

   128

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

   129

    EC_SLAVE_STATE_SAFEOP = 0x04,

   130

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

   131

    EC_SLAVE_STATE_OP = 0x08,

   132

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

   133

    EC_SLAVE_STATE_ACK_ERR = 0x10

   134

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

   135

} ec_slave_state_t;

   136

   137

/** Supported mailbox protocols.

   138

 */

   139

enum {

   140

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

   141

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

   142

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

   143

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

   144

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

   145

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

   146

};

   147

   148

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

   149

 */

   150

typedef struct {

   151

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

   152

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

   153

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

   154

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

   155

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

   156

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

   157

} ec_sii_coe_details_t;

   158

   159

/** Slave information interface general flags.

   160

 */

   161

typedef struct {

   162

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

   163

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

   164

} ec_sii_general_flags_t;

   165

   166

/** EtherCAT slave port descriptor.

   167

 */

   168

typedef enum {

   169

    EC_PORT_NOT_IMPLEMENTED,

   170

    EC_PORT_NOT_CONFIGURED,

   171

    EC_PORT_EBUS,

   172

    EC_PORT_MII

   173

} ec_slave_port_desc_t;

   174

   175

/** EtherCAT slave port information.

   176

 */

   177

typedef struct {

   178

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

   179

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

   180

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

   181

} ec_slave_port_link_t;

   182

   183

/** EtherCAT slave distributed clocks range.

   184

 */

   185

typedef enum {

   186

    EC_DC_32, /**< 32 bit. */

   187

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

   188

               port 0 receive time. */

   189

} ec_slave_dc_range_t;

   190

   191

/** EtherCAT slave sync signal configuration.

   192

 */

   193

typedef struct {

   194

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

   195

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

   196

} ec_sync_signal_t;

   197

   198

/** Access states for SDO entries.

   199

 *

   200

 * The access rights are managed per AL state.

   201

 */

   202

enum {

   203

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

   204

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

   205

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

   206

    EC_SDO_ENTRY_ACCESS_COUNT /**< Number of states. */

   207

};

   208

   209

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

   210

   211

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

   212

 *

   213

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

   214

 *

   215

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

   216

 * \param args arguments (optional)

   217

 */

   218

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

   219

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

   220

   221

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

   222

 *

   223

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

   224

 *

   225

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

   226

 * \param args arguments (optional)

   227

 */

   228

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

   229

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

   230

   231

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

   232

 *

   233

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

   234

 *

   235

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

   236

 * \param args arguments (optional)

   237

 */

   238

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

   239

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

   240

   241

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

   242

 *

   243

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

   244

 *

   245

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

   246

 * \param args arguments (optional)

   247

 */

   248

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

   249

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

   250

   251

/** Convenience macro for defining read-only SysFS attributes.

   252

 *

   253

 * This results in creating a static variable called attr_\a NAME. The SysFS

   254

 * file will be world-readable.

   255

 *

   256

 * \param NAME name of the attribute to create.

   257

 */

   258

#define EC_SYSFS_READ_ATTR(NAME) \

   259

    static struct attribute attr_##NAME = { \

   260

        .name = EC_STR(NAME), .owner = THIS_MODULE, .mode = S_IRUGO \

   261

    }

   262

   263

/** Convenience macro for defining read-write SysFS attributes.

   264

 *

   265

 * This results in creating a static variable called attr_\a NAME. The SysFS

   266

 * file will be word-readable plus owner-writable.

   267

 *

   268

 * \param NAME name of the attribute to create.

   269

 */

   270

#define EC_SYSFS_READ_WRITE_ATTR(NAME) \

   271

    static struct attribute attr_##NAME = { \

   272

        .name = EC_STR(NAME), .owner = THIS_MODULE, .mode = S_IRUGO | S_IWUSR \

   273

    }

   274

   275

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

   276

   277

extern char *ec_master_version_str;

   278

   279

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

   280

   281

void ec_print_data(const uint8_t *, size_t);

   282

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

   283

size_t ec_state_string(uint8_t, char *, uint8_t);

   284

ssize_t ec_mac_print(const uint8_t *, char *);

   285

int ec_mac_is_zero(const uint8_t *);

   286

   287

ec_master_t *ecrt_request_master_err(unsigned int);

   288

   289

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

   290

   291

/** Code/Message pair.

   292

 *

   293

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

   294

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

   295

 */

   296

typedef struct {

   297

    uint32_t code; /**< Code. */

   298

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

   299

} ec_code_msg_t;

   300

   301

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

   302

   303

/** Generic request state.

   304

 *

   305

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

   306

 * state_table in master/sdo_request.c.

   307

 */

   308

typedef enum {

   309

    EC_INT_REQUEST_INIT,

   310

    EC_INT_REQUEST_QUEUED,

   311

    EC_INT_REQUEST_BUSY,

   312

    EC_INT_REQUEST_SUCCESS,

   313

    EC_INT_REQUEST_FAILURE

   314

} ec_internal_request_state_t;

   315

   316

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

   317

   318

extern const ec_request_state_t ec_request_state_translation_table[];

   319

   320

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

   321

   322

/** Origin type.

   323

 */

   324

typedef enum {

   325

    EC_ORIG_INTERNAL, /**< Internal. */

   326

    EC_ORIG_EXTERNAL /**< External. */

   327

} ec_origin_t;

   328

   329

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

   330

   331

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

   332

   333

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

   334

   335

#endif