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

   Ethernet over EtherCAT (EoE)

    33

*/

    34

    35

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

    36

    37

#ifndef __EC_ETHERNET_H__

    38

#define __EC_ETHERNET_H__

    39

    40

#include <linux/list.h>

    41

#include <linux/netdevice.h>

    42

#include <linux/semaphore.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

    ec_mailbox_t mbox; /**< mailbox */

    77

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

    78

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

    79

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

    80

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

    81

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

    82

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

    83

    84

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

    85

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

    86

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

    87

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

    88

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

    89

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

    90

    unsigned int rx_idle; /**< Idle flag. */

    91

    92

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

    93

    unsigned int tx_queue_size; /**< Transmit queue size. */

    94

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

    95

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

    96

    struct ec_mutex_t tx_queue_mutex; /**< Mutex for the send queue. */

    97

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

    98

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

    99

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

   100

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

   101

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

   102

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

   103

    unsigned int tx_idle; /**< Idle flag. */

   104

   105

    unsigned int tries; /**< Tries. */

   106

};

   107

   108

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

   109

   110

int ec_eoe_init(ec_eoe_t *, ec_slave_t *);

   111

void ec_eoe_clear(ec_eoe_t *);

   112

void ec_eoe_run(ec_eoe_t *);

   113

void ec_eoe_queue(ec_eoe_t *);

   114

int ec_eoe_is_open(const ec_eoe_t *);

   115

int ec_eoe_is_idle(const ec_eoe_t *);

   116

   117

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

   118

   119

#endif

   120

   121

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