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

/** \file

    35

 * Global definitions and macros.

    36

 */

    37

    38

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

    39

    40

#ifndef _EC_MASTER_GLOBALS_

    41

#define _EC_MASTER_GLOBALS_

    42

    43

#include <linux/types.h>

    44

    45

#include "../globals.h"

    46

    47

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

    48

 * EtherCAT master

    49

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

    50

    51

/** Clock frequency for the EoE state machines. */

    52

#define EC_EOE_FREQUENCY 1000

    53

    54

/** Datagram timeout in microseconds. */

    55

#define EC_IO_TIMEOUT 500

    56

    57

/** Number of state machine retries on datagram timeout. */

    58

#define EC_FSM_RETRIES 3

    59

    60

/** Seconds to wait before fetching Sdo dictionary

    61

    after slave entered PREOP state. */

    62

#define EC_WAIT_SDO_DICT 3

    63

    64

/** Minimum size of a buffer used with ec_state_string(). */

    65

#define EC_STATE_STRING_SIZE 32

    66

    67

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

    68

#define EC_MAX_EEPROM_SIZE 1024

    69

    70

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

    71

 * EtherCAT protocol

    72

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

    73

    74

/** Size of an EtherCAT frame header. */

    75

#define EC_FRAME_HEADER_SIZE 2

    76

    77

/** Size of an EtherCAT datagram header. */

    78

#define EC_DATAGRAM_HEADER_SIZE 10

    79

    80

/** Size of an EtherCAT datagram footer. */

    81

#define EC_DATAGRAM_FOOTER_SIZE 2

    82

    83

/** Size of the EtherCAT address field. */

    84

#define EC_ADDR_LEN 4

    85

    86

/** Resulting maximum data size of a single datagram in a frame. */

    87

#define EC_MAX_DATA_SIZE (ETH_DATA_LEN - EC_FRAME_HEADER_SIZE \

    88

                          - EC_DATAGRAM_HEADER_SIZE - EC_DATAGRAM_FOOTER_SIZE)

    89

    90

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

    91

#define EC_FIRST_EEPROM_CATEGORY_OFFSET 0x40

    92

    93

/** Size of a sync manager configuration page. */

    94

#define EC_SYNC_PAGE_SIZE 8

    95

    96

/** Maximum number of FMMUs per slave. */

    97

#define EC_MAX_FMMUS 16

    98

    99

/** Size of an FMMU configuration page. */

   100

#define EC_FMMU_PAGE_SIZE 16

   101

   102

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

   103

   104

/** Convenience macro for printing EtherCAT-specific information to syslog.

   105

 *

   106

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

   107

 *

   108

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

   109

 * \param args arguments (optional)

   110

 */

   111

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

   112

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

   113

   114

/** Convenience macro for printing EtherCAT-specific errors to syslog.

   115

 *

   116

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

   117

 *

   118

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

   119

 * \param args arguments (optional)

   120

 */

   121

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

   122

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

   123

   124

/** Convenience macro for printing EtherCAT-specific warnings to syslog.

   125

 *

   126

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

   127

 *

   128

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

   129

 * \param args arguments (optional)

   130

 */

   131

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

   132

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

   133

   134

/** Convenience macro for printing EtherCAT debug messages to syslog.

   135

 *

   136

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

   137

 *

   138

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

   139

 * \param args arguments (optional)

   140

 */

   141

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

   142

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

   143

   144

/** Convenience macro for defining read-only SysFS attributes.

   145

 *

   146

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

   147

 * file will be world-readable.

   148

 *

   149

 * \param NAME name of the attribute to create.

   150

 */

   151

#define EC_SYSFS_READ_ATTR(NAME) \

   152

    static struct attribute attr_##NAME = { \

   153

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

   154

    }

   155

   156

/** Convenience macro for defining read-write SysFS attributes.

   157

 *

   158

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

   159

 * file will be word-readable plus owner-writable.

   160

 *

   161

 * \param NAME name of the attribute to create.

   162

 */

   163

#define EC_SYSFS_READ_WRITE_ATTR(NAME) \

   164

    static struct attribute attr_##NAME = { \

   165

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

   166

    }

   167

   168

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

   169

   170

extern char *ec_master_version_str;

   171

   172

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

   173

   174

void ec_print_data(const uint8_t *, size_t);

   175

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

   176

size_t ec_state_string(uint8_t, char *);

   177

ssize_t ec_mac_print(const uint8_t *, char *);

   178

int ec_mac_is_zero(const uint8_t *);

   179

   180

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

   181

   182

/** Code/Message pair.

   183

 *

   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

typedef struct {

   188

    uint32_t code; /**< Code. */

   189

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

   190

} ec_code_msg_t;

   191

   192

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

   193

   194

/** Master request state.

   195

 */

   196

typedef enum {

   197

    EC_REQUEST_QUEUED,

   198

    EC_REQUEST_IN_PROGRESS,

   199

    EC_REQUEST_COMPLETE,

   200

    EC_REQUEST_FAILURE

   201

} ec_request_state_t;

   202

   203

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

   204

   205

/** Origin type.

   206

 */

   207

typedef enum {

   208

    EC_ORIG_INTERNAL, /**< Internal. */

   209

    EC_ORIG_EXTERNAL /**< External. */

   210

} ec_origin_t;

   211

   212

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

   213

   214

typedef struct ec_slave ec_slave_t; /**< \see ec_slave. */

   215

   216

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

   217

   218

#endif