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

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

    23

 *  the industrial property and similar rights of Beckhoff Automation GmbH.

    24

 *

    25

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

    26

    27

/** \file

    28

 * Global definitions and macros.

    29

 */

    30

    31

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

    32

    33

#ifndef __EC_MASTER_GLOBALS_H__

    34

#define __EC_MASTER_GLOBALS_H__

    35

    36

#include <linux/types.h>

    37

    38

#include "../globals.h"

    39

    40

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

    41

 * EtherCAT master

    42

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

    43

    44

/** Clock frequency for the EoE state machines. */

    45

#define EC_EOE_FREQUENCY 1000

    46

    47

/** Datagram timeout in microseconds. */

    48

#define EC_IO_TIMEOUT 500

    49

    50

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

    51

#define EC_FSM_RETRIES 3

    52

    53

/** Seconds to wait before fetching SDO dictionary

    54

    after slave entered PREOP state. */

    55

#define EC_WAIT_SDO_DICT 3

    56

    57

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

    58

#define EC_STATE_STRING_SIZE 32

    59

    60

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

    61

#define EC_MAX_SII_SIZE 1024

    62

    63

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

    64

 * EtherCAT protocol

    65

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

    66

    67

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

    68

#define EC_FRAME_HEADER_SIZE 2

    69

    70

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

    71

#define EC_DATAGRAM_HEADER_SIZE 10

    72

    73

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

    74

#define EC_DATAGRAM_FOOTER_SIZE 2

    75

    76

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

    77

#define EC_ADDR_LEN 4

    78

    79

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

    80

#define EC_MAX_DATA_SIZE (ETH_DATA_LEN - EC_FRAME_HEADER_SIZE \

    81

                          - EC_DATAGRAM_HEADER_SIZE - EC_DATAGRAM_FOOTER_SIZE)

    82

    83

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

    84

#define EC_FIRST_SII_CATEGORY_OFFSET 0x40

    85

    86

/** Maximum number of slave ports. */

    87

#define EC_MAX_PORTS 4

    88

    89

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

    90

#define EC_SYNC_PAGE_SIZE 8

    91

    92

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

    93

#define EC_MAX_FMMUS 16

    94

    95

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

    96

#define EC_FMMU_PAGE_SIZE 16

    97

    98

/** Slave state mask.

    99

 *

   100

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

   101

 * the error flag.

   102

 */

   103

#define EC_SLAVE_STATE_MASK 0x0F

   104

   105

/** State of an EtherCAT slave.

   106

 */

   107

typedef enum {

   108

    EC_SLAVE_STATE_UNKNOWN = 0x00,

   109

    /**< unknown state */

   110

    EC_SLAVE_STATE_INIT = 0x01,

   111

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

   112

    EC_SLAVE_STATE_PREOP = 0x02,

   113

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

   116

    EC_SLAVE_STATE_SAFEOP = 0x04,

   117

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

   118

    EC_SLAVE_STATE_OP = 0x08,

   119

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

   120

    EC_SLAVE_STATE_ACK_ERR = 0x10

   121

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

   122

} ec_slave_state_t;

   123

   124

/** Supported mailbox protocols.

   125

 */

   126

enum {

   127

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

   128

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

   129

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

   130

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

   131

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

   132

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

   133

};

   134

   135

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

   136

 */

   137

typedef struct {

   138

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

   139

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

   140

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

   141

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

   142

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

   143

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

   144

} ec_sii_coe_details_t;

   145

   146

/** Slave information interface general flags.

   147

 */

   148

typedef struct {

   149

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

   150

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

   151

} ec_sii_general_flags_t;

   152

   153

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

   154

   155

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

   156

 *

   157

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

   158

 *

   159

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

   160

 * \param args arguments (optional)

   161

 */

   162

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

   163

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

   164

   165

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

   166

 *

   167

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

   168

 *

   169

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

   170

 * \param args arguments (optional)

   171

 */

   172

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

   173

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

   174

   175

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

   176

 *

   177

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

   178

 *

   179

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

   180

 * \param args arguments (optional)

   181

 */

   182

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

   183

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

   184

   185

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

   186

 *

   187

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

   188

 *

   189

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

   190

 * \param args arguments (optional)

   191

 */

   192

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

   193

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

   194

   195

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

   196

 *

   197

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

   198

 * file will be world-readable.

   199

 *

   200

 * \param NAME name of the attribute to create.

   201

 */

   202

#define EC_SYSFS_READ_ATTR(NAME) \

   203

    static struct attribute attr_##NAME = { \

   204

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

   205

    }

   206

   207

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

   208

 *

   209

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

   210

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

   211

 *

   212

 * \param NAME name of the attribute to create.

   213

 */

   214

#define EC_SYSFS_READ_WRITE_ATTR(NAME) \

   215

    static struct attribute attr_##NAME = { \

   216

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

   217

    }

   218

   219

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

   220

   221

extern char *ec_master_version_str;

   222

   223

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

   224

   225

void ec_print_data(const uint8_t *, size_t);

   226

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

   228

ssize_t ec_mac_print(const uint8_t *, char *);

   229

int ec_mac_is_zero(const uint8_t *);

   230

   231

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

   232

   233

/** Code/Message pair.

   234

 *

   235

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

   236

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

   237

 */

   238

typedef struct {

   239

    uint32_t code; /**< Code. */

   240

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

   241

} ec_code_msg_t;

   242

   243

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

   244

   245

/** Generic request state.

   246

 *

   247

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

   248

 * state_table in master/sdo_request.c.

   249

 */

   250

typedef enum {

   251

    EC_REQUEST_INIT,

   252

    EC_REQUEST_QUEUED,

   253

    EC_REQUEST_BUSY,

   254

    EC_REQUEST_SUCCESS,

   255

    EC_REQUEST_FAILURE

   256

} ec_request_state_t;

   257

   258

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

   259

   260

/** Origin type.

   261

 */

   262

typedef enum {

   263

    EC_ORIG_INTERNAL, /**< Internal. */

   264

    EC_ORIG_EXTERNAL /**< External. */

   265

} ec_origin_t;

   266

   267

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

   268

   269

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

   270

   271

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

   272

   273

#endif