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; version 2 of the License.

    12

 *

    13

 *  The IgH EtherCAT Master is distributed in the hope that it will be

    14

 *  useful, but WITHOUT ANY WARRANTY; without even the implied warranty of

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    16

 *  GNU General Public License for more details.

    17

 *

    18

 *  You should have received a copy of the GNU General Public License

    19

 *  along with the IgH EtherCAT Master; if not, write to the Free Software

    20

 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

    21

 *

    22

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

    23

    24

/**

    25

   \file

    26

   Global definitions and macros.

    27

*/

    28

    29

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

    30

    31

#ifndef _EC_GLOBALS_

    32

#define _EC_GLOBALS_

    33

    34

#include <linux/types.h>

    35

    36

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

    37

 *  EtherCAT master

    38

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

    39

    40

/** master main version */

    41

#define EC_MASTER_VERSION_MAIN  1

    42

    43

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

    44

#define EC_MASTER_VERSION_SUB   0

    45

    46

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

    47

#define EC_MASTER_VERSION_EXTRA "trunk"

    48

    49

/** maximum number of FMMUs per slave */

    50

#define EC_MAX_FMMUS 16

    51

    52

/** size of the EoE tx queue */

    53

#define EC_EOE_TX_QUEUE_SIZE 100

    54

    55

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

    56

#define EC_EOE_FREQUENCY 1000

    57

    58

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

    59

 *  EtherCAT protocol

    60

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

    61

    62

/** size of an EtherCAT frame header */

    63

#define EC_FRAME_HEADER_SIZE 2

    64

    65

/** size of an EtherCAT command header */

    66

#define EC_COMMAND_HEADER_SIZE 10

    67

    68

/** size of an EtherCAT command footer */

    69

#define EC_COMMAND_FOOTER_SIZE 2

    70

    71

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

    72

#define EC_SYNC_SIZE 8

    73

    74

/** size of an FMMU configuration page */

    75

#define EC_FMMU_SIZE 16

    76

    77

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

    78

#define EC_MAX_DATA_SIZE (ETH_DATA_LEN - EC_FRAME_HEADER_SIZE \

    79

                          - EC_COMMAND_HEADER_SIZE - EC_COMMAND_FOOTER_SIZE)

    80

    81

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

    82

    83

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

    84

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

    85

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

    86

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

    87

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

    88

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

    89

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

    90

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

    91

    92

#define EC_LIT(X) #X

    93

#define EC_STR(X) EC_LIT(X)

    94

    95

/**

    96

   Convenience macro for defining SysFS attributes.

    97

*/

    98

    99

#define EC_SYSFS_READ_ATTR(NAME) \

   100

    static struct attribute attr_##NAME = { \

   101

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

   102

    }

   103

   104

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

   105

   106

extern void ec_print_data(const uint8_t *, size_t);

   107

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

   108

   109

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

   110

   111

/**

   112

   Code - Message pair.

   113

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

   114

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

   115

*/

   116

   117

typedef struct

   118

{

   119

    uint32_t code; /**< code */

   120

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

   121

}

   122

ec_code_msg_t;

   123

   124

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

   125

   126

#endif

   127