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

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

    69

 *  EtherCAT protocol

    70

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

    71

    72

/** size of an EtherCAT frame header */

    73

#define EC_FRAME_HEADER_SIZE 2

    74

    75

/** size of an EtherCAT datagram header */

    76

#define EC_DATAGRAM_HEADER_SIZE 10

    77

    78

/** size of an EtherCAT datagram footer */

    79

#define EC_DATAGRAM_FOOTER_SIZE 2

    80

    81

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

    82

#define EC_MAX_DATA_SIZE (ETH_DATA_LEN - EC_FRAME_HEADER_SIZE \

    83

                          - EC_DATAGRAM_HEADER_SIZE - EC_DATAGRAM_FOOTER_SIZE)

    84

    85

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

    86

    87

/**

    88

   Convenience macro for printing EtherCAT-specific information to syslog.

    89

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

    90

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

    91

   \param args arguments (optional)

    92

*/

    93

    94

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

    95

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

    96

    97

/**

    98

   Convenience macro for printing EtherCAT-specific errors to syslog.

    99

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

   100

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

   101

   \param args arguments (optional)

   102

*/

   103

   104

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

   105

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

   106

   107

/**

   108

   Convenience macro for printing EtherCAT-specific warnings to syslog.

   109

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

   110

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

   111

   \param args arguments (optional)

   112

*/

   113

   114

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

   115

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

   116

   117

/**

   118

   Convenience macro for printing EtherCAT debug messages to syslog.

   119

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

   120

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

   121

   \param args arguments (optional)

   122

*/

   123

   124

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

   125

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

   126

   127

/**

   128

   Convenience macro for defining read-only SysFS attributes.

   129

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

   130

   file will be world-readable.

   131

   \param NAME name of the attribute to create.

   132

*/

   133

   134

#define EC_SYSFS_READ_ATTR(NAME) \

   135

    static struct attribute attr_##NAME = { \

   136

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

   137

    }

   138

   139

/**

   140

   Convenience macro for defining read-write SysFS attributes.

   141

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

   142

   file will be word-readable plus owner-writable.

   143

   \param NAME name of the attribute to create.

   144

*/

   145

   146

#define EC_SYSFS_READ_WRITE_ATTR(NAME) \

   147

    static struct attribute attr_##NAME = { \

   148

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

   149

    }

   150

   151

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

   152

   153

extern char *ec_master_version_str;

   154

   155

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

   156

   157

void ec_print_data(const uint8_t *, size_t);

   158

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

   159

size_t ec_state_string(uint8_t, char *);

   160

ssize_t ec_mac_print(const uint8_t *, char *);

   161

int ec_mac_is_zero(const uint8_t *);

   162

   163

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

   164

   165

/**

   166

   Code - Message pair.

   167

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

   168

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

   169

*/

   170

   171

typedef struct

   172

{

   173

    uint32_t code; /**< code */

   174

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

   175

}

   176

ec_code_msg_t;

   177

   178

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

   179

   180

/**

   181

 * Master request state.

   182

 */

   183

   184

typedef enum

   185

{

   186

    EC_REQUEST_QUEUED,

   187

    EC_REQUEST_IN_PROGRESS,

   188

    EC_REQUEST_COMPLETE,

   189

    EC_REQUEST_FAILURE

   190

}

   191

ec_request_state_t;

   192

   193

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

   194

   195

#endif