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

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

    40

    41

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

    42

 * EtherCAT master

    43

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

    44

    45

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

    46

#define EC_EOE_FREQUENCY 1000

    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 1024

    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

/** Slave state mask.

   103

 *

   104

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

   105

 * the error flag.

   106

 */

   107

#define EC_SLAVE_STATE_MASK 0x0F

   108

   109

/** State of an EtherCAT slave.

   110

 */

   111

typedef enum {

   112

    EC_SLAVE_STATE_UNKNOWN = 0x00,

   113

    /**< unknown state */

   114

    EC_SLAVE_STATE_INIT = 0x01,

   115

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

   116

    EC_SLAVE_STATE_PREOP = 0x02,

   117

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

   118

    EC_SLAVE_STATE_BOOT = 0x03,

   119

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

   120

    EC_SLAVE_STATE_SAFEOP = 0x04,

   121

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

   122

    EC_SLAVE_STATE_OP = 0x08,

   123

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

   124

    EC_SLAVE_STATE_ACK_ERR = 0x10

   125

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

   126

} ec_slave_state_t;

   127

   128

/** Supported mailbox protocols.

   129

 */

   130

enum {

   131

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

   132

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

   133

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

   134

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

   135

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

   136

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

   137

};

   138

   139

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

   140

 */

   141

typedef struct {

   142

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

   143

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

   144

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

   145

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

   146

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

   147

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

   148

} ec_sii_coe_details_t;

   149

   150

/** Slave information interface general flags.

   151

 */

   152

typedef struct {

   153

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

   154

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

   155

} ec_sii_general_flags_t;

   156

   157

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

   158

   159

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

   160

 *

   161

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

   162

 *

   163

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

   164

 * \param args arguments (optional)

   165

 */

   166

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

   167

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

   168

   169

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

   170

 *

   171

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

   172

 *

   173

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

   174

 * \param args arguments (optional)

   175

 */

   176

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

   177

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

   178

   179

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

   180

 *

   181

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

   182

 *

   183

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

   184

 * \param args arguments (optional)

   185

 */

   186

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

   187

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

   188

   189

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

   190

 *

   191

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

   192

 *

   193

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

   194

 * \param args arguments (optional)

   195

 */

   196

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

   197

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

   198

   199

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

   200

 *

   201

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

   202

 * file will be world-readable.

   203

 *

   204

 * \param NAME name of the attribute to create.

   205

 */

   206

#define EC_SYSFS_READ_ATTR(NAME) \

   207

    static struct attribute attr_##NAME = { \

   208

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

   209

    }

   210

   211

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

   212

 *

   213

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

   214

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

   215

 *

   216

 * \param NAME name of the attribute to create.

   217

 */

   218

#define EC_SYSFS_READ_WRITE_ATTR(NAME) \

   219

    static struct attribute attr_##NAME = { \

   220

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

   221

    }

   222

   223

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

   224

   225

extern char *ec_master_version_str;

   226

   227

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

   228

   229

void ec_print_data(const uint8_t *, size_t);

   230

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

   231

size_t ec_state_string(uint8_t, char *, uint8_t);

   232

ssize_t ec_mac_print(const uint8_t *, char *);

   233

int ec_mac_is_zero(const uint8_t *);

   234

   235

ec_master_t *ecrt_request_master_err(unsigned int);

   236

   237

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

   238

   239

/** Code/Message pair.

   240

 *

   241

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

   242

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

   243

 */

   244

typedef struct {

   245

    uint32_t code; /**< Code. */

   246

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

   247

} ec_code_msg_t;

   248

   249

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

   250

   251

/** Generic request state.

   252

 *

   253

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

   254

 * state_table in master/sdo_request.c.

   255

 */

   256

typedef enum {

   257

    EC_INT_REQUEST_INIT,

   258

    EC_INT_REQUEST_QUEUED,

   259

    EC_INT_REQUEST_BUSY,

   260

    EC_INT_REQUEST_SUCCESS,

   261

    EC_INT_REQUEST_FAILURE

   262

} ec_internal_request_state_t;

   263

   264

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

   265

   266

extern const ec_request_state_t ec_request_state_translation_table[];

   267

   268

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

   269

   270

/** Origin type.

   271

 */

   272

typedef enum {

   273

    EC_ORIG_INTERNAL, /**< Internal. */

   274

    EC_ORIG_EXTERNAL /**< External. */

   275

} ec_origin_t;

   276

   277

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

   278

   279

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

   280

   281

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

   282

   283

#endif