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

/**

    35

   \file

    36

   Global definitions and macros.

    37

*/

    38

    39

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

    40

    41

#ifndef _EC_MASTER_GLOBALS_

    42

#define _EC_MASTER_GLOBALS_

    43

    44

#include <linux/types.h>

    45

    46

#include "../globals.h"

    47

    48

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

    49

 *  EtherCAT master

    50

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

    51

    52

/** clock frequency for the EoE state machines */

    53

#define EC_EOE_FREQUENCY 1000

    54

    55

/** datagram timeout in microseconds */

    56

#define EC_IO_TIMEOUT 500

    57

    58

/** number of state machine retries on datagram timeout */

    59

#define EC_FSM_RETRIES 3

    60

    61

/** Seconds to wait before fetching SDO dictionary

    62

    after slave entered PREOP state. */

    63

#define EC_WAIT_SDO_DICT 3

    64

    65

/** minimum size of a buffer used with ec_state_string() */

    66

#define EC_STATE_STRING_SIZE 32

    67

    68

/** maximum EEPROM size in words, to avoid infinite reading. */

    70

    71

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

    72

 *  EtherCAT protocol

    73

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

    74

    75

/** size of an EtherCAT frame header */

    76

#define EC_FRAME_HEADER_SIZE 2

    77

    78

/** size of an EtherCAT datagram header */

    79

#define EC_DATAGRAM_HEADER_SIZE 10

    80

    81

/** size of an EtherCAT datagram footer */

    82

#define EC_DATAGRAM_FOOTER_SIZE 2

    83

    84

/** size of the EtherCAT address field */

    85

#define EC_ADDR_LEN 4

    86

    87

/** resulting maximum data size of a single datagram in a frame */

    88

#define EC_MAX_DATA_SIZE (ETH_DATA_LEN - EC_FRAME_HEADER_SIZE \

    89

                          - EC_DATAGRAM_HEADER_SIZE - EC_DATAGRAM_FOOTER_SIZE)

    90

    91

/** word offset of first EEPROM category. */

    92

#define EC_FIRST_EEPROM_CATEGORY_OFFSET 0x40

    93

    94

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

    95

    96

/**

    97

   Convenience macro for printing EtherCAT-specific information to syslog.

    98

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

    99

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

   100

   \param args arguments (optional)

   101

*/

   102

   103

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

   104

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

   105

   106

/**

   107

   Convenience macro for printing EtherCAT-specific errors to syslog.

   108

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

   109

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

   110

   \param args arguments (optional)

   111

*/

   112

   113

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

   114

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

   115

   116

/**

   117

   Convenience macro for printing EtherCAT-specific warnings to syslog.

   118

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

   119

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

   120

   \param args arguments (optional)

   121

*/

   122

   123

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

   124

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

   125

   126

/**

   127

   Convenience macro for printing EtherCAT debug messages to syslog.

   128

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

   129

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

   130

   \param args arguments (optional)

   131

*/

   132

   133

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

   134

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

   135

   136

/**

   137

   Convenience macro for defining read-only SysFS attributes.

   138

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

   139

   file will be world-readable.

   140

   \param NAME name of the attribute to create.

   141

*/

   142

   143

#define EC_SYSFS_READ_ATTR(NAME) \

   144

    static struct attribute attr_##NAME = { \

   145

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

   146

    }

   147

   148

/**

   149

   Convenience macro for defining read-write SysFS attributes.

   150

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

   151

   file will be word-readable plus owner-writable.

   152

   \param NAME name of the attribute to create.

   153

*/

   154

   155

#define EC_SYSFS_READ_WRITE_ATTR(NAME) \

   156

    static struct attribute attr_##NAME = { \

   157

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

   158

    }

   159

   160

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

   161

   162

extern char *ec_master_version_str;

   163

   164

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

   165

   166

void ec_print_data(const uint8_t *, size_t);

   167

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

   168

size_t ec_state_string(uint8_t, char *);

   169

ssize_t ec_mac_print(const uint8_t *, char *);

   170

int ec_mac_is_zero(const uint8_t *);

   171

   172

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

   173

   174

/**

   175

   Code - Message pair.

   176

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

   177

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

   178

*/

   179

   180

typedef struct

   181

{

   182

    uint32_t code; /**< code */

   183

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

   184

}

   185

ec_code_msg_t;

   186

   187

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

   188

   189

/**

   190

 * Master request state.

   191

 */

   192

   193

typedef enum

   194

{

   195

    EC_REQUEST_QUEUED,

   196

    EC_REQUEST_IN_PROGRESS,

   197

    EC_REQUEST_COMPLETE,

   198

    EC_REQUEST_FAILURE

   199

}

   200

ec_request_state_t;

   201

   202

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

   203

   204

typedef struct ec_sdo ec_sdo_t; /**< \see ec_sdo */

   205

   206

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

   207

   208

#endif