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

    46

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

    47

 *  EtherCAT master

    48

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

    49

    50

/** master main version */

    51

#define EC_MASTER_VERSION_MAIN  1

    52

    53

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

    54

#define EC_MASTER_VERSION_SUB   1

    55

    56

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

    57

#define EC_MASTER_VERSION_EXTRA "trunk"

    58

    59

/** maximum number of FMMUs per slave */

    60

#define EC_MAX_FMMUS 16

    61

    62

/** size of the EoE tx queue */

    63

#define EC_EOE_TX_QUEUE_SIZE 100

    64

    65

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

    66

#define EC_EOE_FREQUENCY 1000

    67

    68

/** datagram timeout in microseconds */

    69

#define EC_IO_TIMEOUT 500

    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 a sync manager configuration page */

    85

#define EC_SYNC_SIZE 8

    86

    87

/** size of an FMMU configuration page */

    88

#define EC_FMMU_SIZE 16

    89

    90

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

    91

#define EC_MAX_DATA_SIZE (ETH_DATA_LEN - EC_FRAME_HEADER_SIZE \

    92

                          - EC_DATAGRAM_HEADER_SIZE - EC_DATAGRAM_FOOTER_SIZE)

    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

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

   138

   \param X argument to literate.

   139

*/

   140

   141

#define EC_LIT(X) #X

   142

   143

/**

   144

   Converts a macro argument to a string.

   145

   \param X argument to stringify.

   146

*/

   147

   148

#define EC_STR(X) EC_LIT(X)

   149

   150

/**

   151

   Convenience macro for defining read-only SysFS attributes.

   152

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

   153

   file will be world-readable.

   154

   \param NAME name of the attribute to create.

   155

*/

   156

   157

#define EC_SYSFS_READ_ATTR(NAME) \

   158

    static struct attribute attr_##NAME = { \

   159

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

   160

    }

   161

   162

/**

   163

   Convenience macro for defining read-write SysFS attributes.

   164

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

   165

   file will be word-readable plus owner-writable.

   166

   \param NAME name of the attribute to create.

   167

*/

   168

   169

#define EC_SYSFS_READ_WRITE_ATTR(NAME) \

   170

    static struct attribute attr_##NAME = { \

   171

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

   172

    }

   173

   174

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

   175

   176

void ec_print_data(const uint8_t *, size_t);

   177

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

   178

size_t ec_state_string(uint8_t, char *);

   179

   180

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

   181

   182

/**

   183

   Code - Message pair.

   184

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

   185

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

   186

*/

   187

   188

typedef struct

   189

{

   190

    uint32_t code; /**< code */

   191

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

   192

}

   193

ec_code_msg_t;

   194

   195

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

   196

   197

#endif