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

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

    23

 *  the industrial property and similar rights of Beckhoff Automation GmbH.

    24

 *

    25

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

    26

    27

/**

    28

   \file

    29

   EtherCAT device structure.

    30

*/

    31

    32

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

    33

    34

#ifndef __EC_DEVICE_H__

    35

#define __EC_DEVICE_H__

    36

    37

#include <linux/interrupt.h>

    38

    39

#include "../include/ecrt.h"

    40

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

    41

#include "globals.h"

    42

    43

/**

    44

 * Size of the transmit ring.

    45

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

    46

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

    47

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

    48

 */

    49

#define EC_TX_RING_SIZE 2

    50

    51

#ifdef EC_DEBUG_IF

    52

#include "debug.h"

    53

#endif

    54

    55

#ifdef EC_DEBUG_RING

    56

#define EC_DEBUG_RING_SIZE 10

    57

    58

typedef enum {

    59

    TX, RX

    60

} ec_debug_frame_dir_t;

    61

    62

typedef struct {

    63

    ec_debug_frame_dir_t dir;

    64

    struct timeval t;

    65

    unsigned int addr;

    66

    uint8_t data[EC_MAX_DATA_SIZE];

    67

    unsigned int data_size;

    68

} ec_debug_frame_t;

    69

    70

#endif

    71

    72

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

    73

    74

/**

    75

   EtherCAT device.

    76

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

    77

   EtherCAT master to send and receive EtherCAT frames with.

    78

*/

    79

    80

struct ec_device

    81

{

    82

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

    83

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

    84

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

    85

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

    86

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

    87

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

    88

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

    89

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

    90

#ifdef EC_HAVE_CYCLES

    91

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

    92

#endif

    93

#ifdef EC_DEBUG_RING

    94

    struct timeval timeval_poll;

    95

#endif

    96

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

    97

    unsigned int tx_count; /**< number of frames sent */

    98

    unsigned int rx_count; /**< number of frames received */

    99

#ifdef EC_DEBUG_IF

   100

    ec_debug_t dbg; /**< debug device */

   101

#endif

   102

#ifdef EC_DEBUG_RING

   103

    ec_debug_frame_t debug_frames[EC_DEBUG_RING_SIZE];

   104

    unsigned int debug_frame_index;

   105

    unsigned int debug_frame_count;

   106

#endif

   107

};

   108

   109

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

   110

   111

int ec_device_init(ec_device_t *, ec_master_t *);

   112

void ec_device_clear(ec_device_t *);

   113

   114

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

   115

        struct module *);

   116

void ec_device_detach(ec_device_t *);

   117

   118

int ec_device_open(ec_device_t *);

   119

int ec_device_close(ec_device_t *);

   120

   121

void ec_device_poll(ec_device_t *);

   122

uint8_t *ec_device_tx_data(ec_device_t *);

   123

void ec_device_send(ec_device_t *, size_t);

   124

   125

#ifdef EC_DEBUG_RING

   126

void ec_device_debug_ring_append(ec_device_t *, ec_debug_frame_dir_t,

   127

        const void *, size_t);

   128

void ec_device_debug_ring_print(const ec_device_t *);

   129

#endif

   130

   131

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

   132

   133

#endif