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

   Ethernet-over-EtherCAT (EoE)

    37

*/

    38

    39

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

    40

    41

#include <linux/list.h>

    42

#include <linux/netdevice.h>

    43

    44

#include "globals.h"

    45

#include "slave.h"

    46

#include "datagram.h"

    47

    48

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

    49

    50

/**

    51

   Queued frame structure.

    52

*/

    53

    54

typedef struct

    55

{

    56

    struct list_head queue; /**< list item */

    57

    struct sk_buff *skb; /**< socket buffer */

    58

}

    59

ec_eoe_frame_t;

    60

    61

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

    62

    63

typedef struct ec_eoe ec_eoe_t; /**< \see ec_eoe */

    64

    65

/**

    66

   Ethernet-over-EtherCAT (EoE) handler.

    67

   The master creates one of these objects for each slave that supports the

    68

   EoE protocol.

    69

*/

    70

    71

struct ec_eoe

    72

{

    73

    struct list_head list; /**< list item */

    74

    ec_slave_t *slave; /**< pointer to the corresponding slave */

    75

    ec_datagram_t datagram; /**< datagram */

    76

    unsigned int queue_datagram; /**< the datagram is ready for queuing */

    77

    void (*state)(ec_eoe_t *); /**< state function for the state machine */

    78

    struct net_device *dev; /**< net_device for virtual ethernet device */

    79

    struct net_device_stats stats; /**< device statistics */

    80

    unsigned int opened; /**< net_device is opened */

    81

    unsigned long rate_jiffies; /**< time of last rate output */

    82

    struct sk_buff *rx_skb; /**< current rx socket buffer */

    83

    off_t rx_skb_offset; /**< current write pointer in the socket buffer */

    84

    size_t rx_skb_size; /**< size of the allocated socket buffer memory */

    85

    uint8_t rx_expected_fragment; /**< next expected fragment number */

    86

    uint32_t rx_counter; /**< octets received during last second */

    87

    uint32_t rx_rate; /**< receive rate (bps) */

    88

    struct list_head tx_queue; /**< queue for frames to send */

    89

    unsigned int tx_queue_active; /**< kernel netif queue started */

    90

    unsigned int tx_queued_frames; /**< number of frames in the queue */

    91

    spinlock_t tx_queue_lock; /**< spinlock for the send queue */

    92

    ec_eoe_frame_t *tx_frame; /**< current TX frame */

    93

    uint8_t tx_frame_number; /**< number of the transmitted frame */

    94

    uint8_t tx_fragment_number; /**< number of the fragment */

    95

    size_t tx_offset; /**< number of octets sent */

    96

    uint32_t tx_counter; /**< octets transmitted during last second */

    97

    uint32_t tx_rate; /**< transmit rate (bps) */

    98

};

    99

   100

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

   101

   102

int ec_eoe_init(ec_eoe_t *, ec_slave_t *);

   103

void ec_eoe_clear(ec_eoe_t *);

   104

void ec_eoe_run(ec_eoe_t *);

   105

void ec_eoe_queue(ec_eoe_t *);

   106

int ec_eoe_is_open(const ec_eoe_t *);

   107

   108

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