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_GLOBALS_

    42

#define _EC_GLOBALS_

    43

    44

#include <linux/types.h>

    45

    48

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

    49

 *  EtherCAT master

    50

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

    51

    52

/** master main version */

    53

#define EC_MASTER_VERSION_MAIN  1

    54

    55

/** master sub version (after the dot) */

    56

#define EC_MASTER_VERSION_SUB   1

    57

    58

/** master extra version (just a string) */

    59

#define EC_MASTER_VERSION_EXTRA "trunk"

    60

    61

/** Compile version info. */

    62

    63

#define EC_MASTER_VERSION EC_STR(EC_MASTER_VERSION_MAIN) \

    64

                          "." EC_STR(EC_MASTER_VERSION_SUB) \

    65

                          " " EC_MASTER_VERSION_EXTRA \

    66

                          " r" EC_STR(SVNREV)

    67

    68

/** maximum number of FMMUs per slave */

    69

#define EC_MAX_FMMUS 16

    70

    71

/** size of the EoE tx queue */

    72

#define EC_EOE_TX_QUEUE_SIZE 100

    73

    74

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

    75

#define EC_EOE_FREQUENCY 1000

    76

    77

/** datagram timeout in microseconds */

    78

#define EC_IO_TIMEOUT 500

    79

    80

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

    81

 *  EtherCAT protocol

    82

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

    83

    84

/** size of an EtherCAT frame header */

    85

#define EC_FRAME_HEADER_SIZE 2

    86

    87

/** size of an EtherCAT datagram header */

    88

#define EC_DATAGRAM_HEADER_SIZE 10

    89

    90

/** size of an EtherCAT datagram footer */

    91

#define EC_DATAGRAM_FOOTER_SIZE 2

    92

    93

/** size of a sync manager configuration page */

    94

#define EC_SYNC_SIZE 8

    95

    96

/** size of an FMMU configuration page */

    97

#define EC_FMMU_SIZE 16

    98

    99

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

   100

#define EC_MAX_DATA_SIZE (ETH_DATA_LEN - EC_FRAME_HEADER_SIZE \

   101

                          - EC_DATAGRAM_HEADER_SIZE - EC_DATAGRAM_FOOTER_SIZE)

   102

   103

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

   104

   105

/**

   106

   Convenience macro for printing EtherCAT-specific information to syslog.

   107

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

   108

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

   109

   \param args arguments (optional)

   110

*/

   111

   112

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

   113

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

   114

   115

/**

   116

   Convenience macro for printing EtherCAT-specific errors to syslog.

   117

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

   118

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

   119

   \param args arguments (optional)

   120

*/

   121

   122

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

   123

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

   124

   125

/**

   126

   Convenience macro for printing EtherCAT-specific warnings to syslog.

   127

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

   128

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

   129

   \param args arguments (optional)

   130

*/

   131

   132

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

   133

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

   134

   135

/**

   136

   Convenience macro for printing EtherCAT debug messages to syslog.

   137

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

   138

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

   139

   \param args arguments (optional)

   140

*/

   141

   142

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

   143

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

   144

   145

/**

   146

   Helper macro for EC_STR(), literates a macro argument.

   147

   \param X argument to literate.

   148

*/

   149

   150

#define EC_LIT(X) #X

   151

   152

/**

   153

   Converts a macro argument to a string.

   154

   \param X argument to stringify.

   155

*/

   156

   157

#define EC_STR(X) EC_LIT(X)

   158

   159

/**

   160

   Convenience macro for defining read-only SysFS attributes.

   161

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

   162

   file will be world-readable.

   163

   \param NAME name of the attribute to create.

   164

*/

   165

   166

#define EC_SYSFS_READ_ATTR(NAME) \

   167

    static struct attribute attr_##NAME = { \

   168

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

   169

    }

   170

   171

/**

   172

   Convenience macro for defining read-write SysFS attributes.

   173

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

   174

   file will be word-readable plus owner-writable.

   175

   \param NAME name of the attribute to create.

   176

*/

   177

   178

#define EC_SYSFS_READ_WRITE_ATTR(NAME) \

   179

    static struct attribute attr_##NAME = { \

   180

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

   181

    }

   182

   183

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

   184

   185

void ec_print_data(const uint8_t *, size_t);

   186

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

   187

size_t ec_state_string(uint8_t, char *);

   188

   189

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

   190

   191

/**

   192

   Code - Message pair.

   193

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

   194

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

   195

*/

   196

   197

typedef struct

   198

{

   199

    uint32_t code; /**< code */

   200

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

   201

}

   202

ec_code_msg_t;

   203

   204

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

   205

   206

#endif