1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006  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

    10

 *  and/or modify it under the terms of the GNU General Public License

    11

 *  as published by the Free Software Foundation; either version 2 of the

    12

 *  License, or (at your option) any later version.

    13

 *

    14

 *  The IgH EtherCAT Master is distributed in the hope that it will be

    15

 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of

    16

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    17

 *  GNU General Public License for more details.

    18

 *

    19

 *  You should have received a copy of the GNU General Public License

    20

 *  along with the IgH EtherCAT Master; if not, write to the Free Software

    21

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    22

 *

    23

 *  The right to use EtherCAT Technology is granted and comes free of

    24

 *  charge under condition of compatibility of product made by

    25

 *  Licensee. People intending to distribute/sell products based on the

    26

 *  code, have to sign an agreement to guarantee that products using

    27

 *  software based on IgH EtherCAT master stay compatible with the actual

    28

 *  EtherCAT specification (which are released themselves as an open

    29

 *  standard) as the (only) precondition to have the right to use EtherCAT

    30

 *  Technology, IP and trade marks.

    31

 *

    32

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

    33

    34

/** \file

    35

 * Global definitions and macros.

    36

 */

    37

    38

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

    39

    40

#ifndef __EC_MASTER_GLOBALS_H__

    41

#define __EC_MASTER_GLOBALS_H__

    42

    43

#include <linux/types.h>

    44

    45

#include "../globals.h"

    46

    47

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

    48

 * EtherCAT master

    49

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

    50

    51

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

    52

#define EC_EOE_FREQUENCY 1000

    53

    54

/** Datagram timeout in microseconds. */

    55

#define EC_IO_TIMEOUT 500

    56

    57

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

    58

#define EC_FSM_RETRIES 3

    59

    60

/** Seconds to wait before fetching Sdo dictionary

    61

    after slave entered PREOP state. */

    62

#define EC_WAIT_SDO_DICT 3

    63

    64

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

    65

#define EC_STATE_STRING_SIZE 32

    66

    67

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

    68

#define EC_MAX_SII_SIZE 1024

    69

    70

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

    71

 * EtherCAT protocol

    72

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

    73

    74

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

    75

#define EC_FRAME_HEADER_SIZE 2

    76

    77

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

    78

#define EC_DATAGRAM_HEADER_SIZE 10

    79

    80

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

    81

#define EC_DATAGRAM_FOOTER_SIZE 2

    82

    83

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

    84

#define EC_ADDR_LEN 4

    85

    86

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

    87

#define EC_MAX_DATA_SIZE (ETH_DATA_LEN - EC_FRAME_HEADER_SIZE \

    88

                          - EC_DATAGRAM_HEADER_SIZE - EC_DATAGRAM_FOOTER_SIZE)

    89

    90

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

    91

#define EC_FIRST_SII_CATEGORY_OFFSET 0x40

    92

    93

/** Maximum number of slave ports. */

    94

#define EC_MAX_PORTS 4

    95

    96

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

    97

#define EC_SYNC_PAGE_SIZE 8

    98

    99

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

   100

#define EC_MAX_FMMUS 16

   101

   102

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

   103

#define EC_FMMU_PAGE_SIZE 16

   104

   105

/** Slave state mask.

   106

 *

   107

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

   108

 * the error flag.

   109

 */

   110

#define EC_SLAVE_STATE_MASK 0x0F

   111

   112

/** State of an EtherCAT slave.

   113

 */

   114

typedef enum {

   115

    EC_SLAVE_STATE_UNKNOWN = 0x00,

   116

    /**< unknown state */

   117

    EC_SLAVE_STATE_INIT = 0x01,

   118

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

   119

    EC_SLAVE_STATE_PREOP = 0x02,

   120

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

   121

    EC_SLAVE_STATE_SAFEOP = 0x04,

   122

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

   123

    EC_SLAVE_STATE_OP = 0x08,

   124

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

   125

    EC_SLAVE_STATE_ACK_ERR = 0x10

   126

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

   127

} ec_slave_state_t;

   128

   129

/** Supported mailbox protocols.

   130

 */

   131

enum {

   132

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

   133

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

   134

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

   135

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

   136

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

   137

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

   138

};

   139

   140

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

   141

 */

   142

typedef struct {

   143

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

   144

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

   145

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

   146

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

   147

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

   148

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

   149

} ec_sii_coe_details_t;

   150

   151

/** Slave information interface general flags.

   152

 */

   153

typedef struct {

   154

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

   155

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

   156

} ec_sii_general_flags_t;

   157

   158

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

   159

   160

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

   161

 *

   162

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

   163

 *

   164

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

   165

 * \param args arguments (optional)

   166

 */

   167

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

   168

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

   169

   170

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

   171

 *

   172

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

   173

 *

   174

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

   175

 * \param args arguments (optional)

   176

 */

   177

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

   178

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

   179

   180

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

   181

 *

   182

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

   183

 *

   184

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

   185

 * \param args arguments (optional)

   186

 */

   187

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

   188

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

   189

   190

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

   191

 *

   192

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

   193

 *

   194

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

   195

 * \param args arguments (optional)

   196

 */

   197

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

   198

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

   199

   200

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

   201

 *

   202

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

   203

 * file will be world-readable.

   204

 *

   205

 * \param NAME name of the attribute to create.

   206

 */

   207

#define EC_SYSFS_READ_ATTR(NAME) \

   208

    static struct attribute attr_##NAME = { \

   209

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

   210

    }

   211

   212

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

   213

 *

   214

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

   215

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

   216

 *

   217

 * \param NAME name of the attribute to create.

   218

 */

   219

#define EC_SYSFS_READ_WRITE_ATTR(NAME) \

   220

    static struct attribute attr_##NAME = { \

   221

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

   222

    }

   223

   224

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

   225

   226

extern char *ec_master_version_str;

   227

   228

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

   229

   230

void ec_print_data(const uint8_t *, size_t);

   231

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

   232

size_t ec_state_string(uint8_t, char *);

   233

ssize_t ec_mac_print(const uint8_t *, char *);

   234

int ec_mac_is_zero(const uint8_t *);

   235

   236

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

   237

   238

/** Code/Message pair.

   239

 *

   240

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

   241

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

   242

 */

   243

typedef struct {

   244

    uint32_t code; /**< Code. */

   245

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

   246

} ec_code_msg_t;

   247

   248

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

   249

   250

/** Generic request state.

   251

 *

   252

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

   253

 * state_table in master/sdo_request.c.

   254

 */

   255

typedef enum {

   256

    EC_REQUEST_INIT,

   257

    EC_REQUEST_QUEUED,

   258

    EC_REQUEST_BUSY,

   259

    EC_REQUEST_SUCCESS,

   260

    EC_REQUEST_FAILURE

   261

} ec_request_state_t;

   262

   263

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

   264

   265

/** Origin type.

   266

 */

   267

typedef enum {

   268

    EC_ORIG_INTERNAL, /**< Internal. */

   269

    EC_ORIG_EXTERNAL /**< External. */

   270

} ec_origin_t;

   271

   272

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

   273

   274

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

   275

   276

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

   277

   278

#endif