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   0

    55

    56

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

    57

#define EC_MASTER_VERSION_EXTRA "stable"

    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

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

    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 command header */

    76

#define EC_COMMAND_HEADER_SIZE 10

    77

    78

/** size of an EtherCAT command footer */

    79

#define EC_COMMAND_FOOTER_SIZE 2

    80

    81

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

    82

#define EC_SYNC_SIZE 8

    83

    84

/** size of an FMMU configuration page */

    85

#define EC_FMMU_SIZE 16

    86

    87

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

    88

#define EC_MAX_DATA_SIZE (ETH_DATA_LEN - EC_FRAME_HEADER_SIZE \

    89

                          - EC_COMMAND_HEADER_SIZE - EC_COMMAND_FOOTER_SIZE)

    90

    91

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

    92

    93

/**

    94

   Convenience macro for printing EtherCAT-specific information to syslog.

    95

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

    96

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

    97

   \param args arguments (optional)

    98

*/

    99

   100

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

   101

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

   102

   103

/**

   104

   Convenience macro for printing EtherCAT-specific errors to syslog.

   105

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

   106

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

   107

   \param args arguments (optional)

   108

*/

   109

   110

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

   111

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

   112

   113

/**

   114

   Convenience macro for printing EtherCAT-specific warnings to syslog.

   115

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

   116

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

   117

   \param args arguments (optional)

   118

*/

   119

   120

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

   121

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

   122

   123

/**

   124

   Convenience macro for printing EtherCAT debug messages to syslog.

   125

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

   126

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

   127

   \param args arguments (optional)

   128

*/

   129

   130

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

   131

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

   132

   133

/**

   134

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

   135

   \param X argument to literate.

   136

*/

   137

   138

#define EC_LIT(X) #X

   139

   140

/**

   141

   Converts a macro argument to a string.

   142

   \param X argument to stringify.

   143

*/

   144

   145

#define EC_STR(X) EC_LIT(X)

   146

   147

/**

   148

   Convenience macro for defining read-only SysFS attributes.

   149

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

   150

   file will be world-readable.

   151

   \param NAME name of the attribute to create.

   152

*/

   153

   154

#define EC_SYSFS_READ_ATTR(NAME) \

   155

    static struct attribute attr_##NAME = { \

   156

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

   157

    }

   158

   159

/**

   160

   Convenience macro for defining read-write SysFS attributes.

   161

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

   162

   file will be word-readable plus owner-writable.

   163

   \param NAME name of the attribute to create.

   164

*/

   165

   166

#define EC_SYSFS_READ_WRITE_ATTR(NAME) \

   167

    static struct attribute attr_##NAME = { \

   168

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

   169

    }

   170

   171

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

   172

   173

extern void ec_print_data(const uint8_t *, size_t);

   174

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

   175

extern void ec_print_states(uint8_t);

   176

   177

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

   178

   179

/**

   180

   Code - Message pair.

   181

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

   182

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

   183

*/

   184

   185

typedef struct

   186

{

   187

    uint32_t code; /**< code */

   188

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

   189

}

   190

ec_code_msg_t;

   191

   192

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

   193

   194

#endif

   195