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

/**

    35

   \file

    36

   EtherCAT device structure.

    37

*/

    38

    39

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

    40

    41

#ifndef __EC_DEVICE_H__

    42

#define __EC_DEVICE_H__

    43

    44

#include <linux/interrupt.h>

    45

    46

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

    47

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

    48

#include "globals.h"

    49

    50

/**

    51

 * Size of the transmit ring.

    52

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

    53

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

    54

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

    55

 */

    56

#define EC_TX_RING_SIZE 2

    57

    58

#ifdef EC_DEBUG_IF

    59

#include "debug.h"

    60

#endif

    61

    62

#ifdef EC_DEBUG_RING

    63

#define EC_DEBUG_RING_SIZE 10

    64

    65

typedef enum {

    66

    TX, RX

    67

} ec_debug_frame_dir_t;

    68

    69

typedef struct {

    70

    ec_debug_frame_dir_t dir;

    71

    struct timeval t;

    72

    unsigned int addr;

    73

    uint8_t data[EC_MAX_DATA_SIZE];

    74

    unsigned int data_size;

    75

} ec_debug_frame_t;

    76

    77

#endif

    78

    79

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

    80

    81

/**

    82

   EtherCAT device.

    83

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

    84

   EtherCAT master to send and receive EtherCAT frames with.

    85

*/

    86

    87

struct ec_device

    88

{

    89

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

    90

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

    91

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

    92

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

    93

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

    94

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

    95

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

    96

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

    97

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

    98

#ifdef EC_DEBUG_RING

    99

    struct timeval timeval_poll;

   100

#endif

   101

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

   102

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

   103

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

   104

#ifdef EC_DEBUG_IF

   105

    ec_debug_t dbg; /**< debug device */

   106

#endif

   107

#ifdef EC_DEBUG_RING

   108

    ec_debug_frame_t debug_frames[EC_DEBUG_RING_SIZE];

   109

    unsigned int debug_frame_index;

   110

    unsigned int debug_frame_count;

   111

#endif

   112

};

   113

   114

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

   115

   116

int ec_device_init(ec_device_t *, ec_master_t *);

   117

void ec_device_clear(ec_device_t *);

   118

   119

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

   120

        struct module *);

   121

void ec_device_detach(ec_device_t *);

   122

   123

int ec_device_open(ec_device_t *);

   124

int ec_device_close(ec_device_t *);

   125

   126

void ec_device_poll(ec_device_t *);

   127

uint8_t *ec_device_tx_data(ec_device_t *);

   128

void ec_device_send(ec_device_t *, size_t);

   129

   130

#ifdef EC_DEBUG_RING

   131

void ec_device_debug_ring_append(ec_device_t *, ec_debug_frame_dir_t,

   132

        const void *, size_t);

   133

void ec_device_debug_ring_print(const ec_device_t *);

   134

#endif

   135

   136

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

   137

   138

#endif