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; version 2 of the License.

    12

 *

    13

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

    14

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

    15

 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    16

 *  GNU General Public License for more details.

    17

 *

    18

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

    19

 *  along 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

/**

    25

   \file

    26

   Ethernet-over-EtherCAT (EoE)

    27

*/

    28

    29

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

    30

    31

#include <linux/list.h>

    32

#include <linux/netdevice.h>

    33

    34

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

    35

#include "globals.h"

    36

#include "slave.h"

    37

#include "command.h"

    38

    39

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

    40

    41

/**

    42

   State of an EoE object.

    43

*/

    44

    45

typedef enum

    46

{

    47

    EC_EOE_RX_START, /**< start receiving and check for data. */

    48

    EC_EOE_RX_CHECK, /**< checking frame was sent. */

    49

    EC_EOE_RX_FETCH, /**< there is new data; fetching frame was sent. */

    50

    EC_EOE_TX_START, /**< start sending a queued frame. */

    51

    EC_EOE_TX_SENT,  /**< queued frame was sent; start checking. */

    52

    EC_EOE_TX_CHECK, /**< check mailbox for acknowledgement. */

    53

    EC_EOE_TX_FETCH, /**< receive mailbox response */

    54

}

    55

ec_eoe_state_t;

    56

    57

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

    58

    59

/**

    60

   Ethernet-over-EtherCAT (EoE) Object.

    61

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

    62

   EoE protocol.

    63

*/

    64

    65

typedef struct

    66

{

    67

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

    68

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

    69

    ec_eoe_state_t state; /**< state of the state machine */

    70

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

    71

    uint8_t opened; /**< net_device is opened */

    72

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

    73

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

    74

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

    75

    uint8_t expected_fragment; /**< expected fragment */

    76

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

    77

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

    78

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

    79

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

    80

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

    81

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

    82

    size_t last_tx_bytes; /**< number of bytes currently transmitted */

    83

}

    84

ec_eoe_t;

    85

    86

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

    87

    88

int ec_eoe_init(ec_eoe_t *, ec_slave_t *);

    89

void ec_eoe_clear(ec_eoe_t *);

    90

void ec_eoe_run(ec_eoe_t *);

    91

void ec_eoe_print(const ec_eoe_t *);

    92

    93

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