1

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

     2

 *

     3

 *  $Id$

     4

 *

     5

 *  Copyright (C) 2006-2008  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 and/or

    10

 *  modify it under the terms of the GNU General Public License version 2, as

    11

 *  published by the Free Software Foundation.

    12

 *

    13

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

    14

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

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General

    16

 *  Public License for more details.

    17

 *

    18

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

    19

 *  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

 *  The license mentioned above concerns the source code only. Using the

    25

 *  EtherCAT technology and brand is only permitted in compliance with the

    26

 *  industrial property and similar rights of Beckhoff Automation GmbH.

    27

 *

    28

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

    29

    30

/**

    31

   \file

    32

   EtherCAT device structure.

    33

*/

    34

    35

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

    36

    37

#ifndef __EC_DEVICE_H__

    38

#define __EC_DEVICE_H__

    39

    40

#include <linux/interrupt.h>

    41

    42

#include "../devices/ecdev.h"

    43

#include "globals.h"

    44

    45

/**

    46

 * Size of the transmit ring.

    47

 * This memory ring is used to transmit frames. It is necessary to use

    48

 * different memory regions, because otherwise the network device DMA could

    49

 * send the same data twice, if it is called twice.

    50

 */

    51

#define EC_TX_RING_SIZE 2

    52

    53

#ifdef EC_DEBUG_IF

    54

#include "debug.h"

    55

#endif

    56

    57

#ifdef EC_DEBUG_RING

    58

#define EC_DEBUG_RING_SIZE 10

    59

    60

typedef enum {

    61

    TX, RX

    62

} ec_debug_frame_dir_t;

    63

    64

typedef struct {

    65

    ec_debug_frame_dir_t dir;

    66

    struct timeval t;

    67

    unsigned int addr;

    68

    uint8_t data[EC_MAX_DATA_SIZE];

    69

    unsigned int data_size;

    70

} ec_debug_frame_t;

    71

    72

#endif

    73

    74

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

    75

    76

/**

    77

   EtherCAT device.

    78

   An EtherCAT device is a network interface card, that is owned by an

    79

   EtherCAT master to send and receive EtherCAT frames with.

    80

*/

    81

    82

struct ec_device

    83

{

    84

    ec_master_t *master; /**< EtherCAT master */

    85

    struct net_device *dev; /**< pointer to the assigned net_device */

    86

    ec_pollfunc_t poll; /**< pointer to the device's poll function */

    87

    struct module *module; /**< pointer to the device's owning module */

    88

    uint8_t open; /**< true, if the net_device has been opened */

    89

    uint8_t link_state; /**< device link state */

    90

    struct sk_buff *tx_skb[EC_TX_RING_SIZE]; /**< transmit skb ring */

    91

    unsigned int tx_ring_index; /**< last ring entry used to transmit */

    92

#ifdef EC_HAVE_CYCLES

    93

    cycles_t cycles_poll; /**< cycles of last poll */

    94

#endif

    95

#ifdef EC_DEBUG_RING

    96

    struct timeval timeval_poll;

    97

#endif

    98

    unsigned long jiffies_poll; /**< jiffies of last poll */

    99

   100

    // Frame statistics

   101

    u64 tx_count; /**< Number of frames sent. */

   102

    u64 last_tx_count; /**< Number of frames sent of last statistics cycle. */

   103

    u64 rx_count; /**< Number of frames received. */

   104

    u64 tx_bytes; /**< Number of frames sent. */

   105

    u64 last_tx_bytes; /**< Number of bytes sent of last statistics cycle. */

   106

    u64 tx_errors; /**< Number of transmit errors. */

   107

    u64 last_loss; /**< Tx/Rx difference of last statistics cycle. */

   108

    unsigned int tx_frame_rates[EC_RATE_COUNT]; /**< Transmit rates in

   109

                                                  frames/s for different

   110

                                                  statistics cycle periods. */

   111

    unsigned int tx_byte_rates[EC_RATE_COUNT]; /**< Transmit rates in byte/s

   112

                                                 for different statistics

   113

                                                 cycle periods. */

   114

    int loss_rates[EC_RATE_COUNT]; /**< Frame loss rates for different

   115

                                     statistics cycle periods. */

   116

    unsigned long stats_jiffies; /**< Jiffies of last statistic cycle. */

   117

   118

#ifdef EC_DEBUG_IF

   119

    ec_debug_t dbg; /**< debug device */

   120

#endif

   121

#ifdef EC_DEBUG_RING

   122

    ec_debug_frame_t debug_frames[EC_DEBUG_RING_SIZE];

   123

    unsigned int debug_frame_index;

   124

    unsigned int debug_frame_count;

   125

#endif

   126

};

   127

   128

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

   129

   130

int ec_device_init(ec_device_t *, ec_master_t *);

   131

void ec_device_clear(ec_device_t *);

   132

   133

void ec_device_attach(ec_device_t *, struct net_device *, ec_pollfunc_t,

   134

        struct module *);

   135

void ec_device_detach(ec_device_t *);

   136

   137

int ec_device_open(ec_device_t *);

   138

int ec_device_close(ec_device_t *);

   139

   140

void ec_device_poll(ec_device_t *);

   141

uint8_t *ec_device_tx_data(ec_device_t *);

   142

void ec_device_send(ec_device_t *, size_t);

   143

void ec_device_clear_stats(ec_device_t *);

   144

   145

#ifdef EC_DEBUG_RING

   146

void ec_device_debug_ring_append(ec_device_t *, ec_debug_frame_dir_t,

   147

        const void *, size_t);

   148

void ec_device_debug_ring_print(const ec_device_t *);

   149

#endif

   150

   151

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

   152

   153

#endif