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

    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

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

    49

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

    50

    52

#define EC_EOE_FREQUENCY 1000

    53

    55

#define EC_IO_TIMEOUT 500

    56

    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

    65

#define EC_STATE_STRING_SIZE 32

    66

    68

#define EC_MAX_EEPROM_SIZE 1024

    69

    70

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

    72

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

    73

    75

#define EC_FRAME_HEADER_SIZE 2

    76

    78

#define EC_DATAGRAM_HEADER_SIZE 10

    79

    81

#define EC_DATAGRAM_FOOTER_SIZE 2

    82

    84

#define EC_ADDR_LEN 4

    85

    87

#define EC_MAX_DATA_SIZE (ETH_DATA_LEN - EC_FRAME_HEADER_SIZE \

    88

                          - EC_DATAGRAM_HEADER_SIZE - EC_DATAGRAM_FOOTER_SIZE)

    89

    91

#define EC_FIRST_EEPROM_CATEGORY_OFFSET 0x40

    92

   111

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

   112

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

   113

   121

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

   122

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

   123

   131

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

   132

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

   133

   141

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

   142

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

   143

   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

   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

   190

}

   191

ec_code_msg_t;

   192

   193

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

   194

   198

    EC_REQUEST_QUEUED,

   199

    EC_REQUEST_IN_PROGRESS,

   200

    EC_REQUEST_COMPLETE,

   201

    EC_REQUEST_FAILURE

   202

}

   203

ec_request_state_t;

   204

   205

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

   206

   208

typedef struct ec_sdo ec_sdo_t; /**< \see ec_sdo */

   209

   210

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

   211

   212

#endif