IgH EtherCAT Master  1.6.1
ethernet.h
Go to the documentation of this file.
1 /*****************************************************************************
2  *
3  * Copyright (C) 2006-2008 Florian Pose, Ingenieurgemeinschaft IgH
4  *
5  * This file is part of the IgH EtherCAT Master.
6  *
7  * The IgH EtherCAT Master is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License version 2, as
9  * published by the Free Software Foundation.
10  *
11  * The IgH EtherCAT Master is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
14  * Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License along
17  * with the IgH EtherCAT Master; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19  *
20  ****************************************************************************/
21 
27 /****************************************************************************/
28 
29 #ifndef __EC_ETHERNET_H__
30 #define __EC_ETHERNET_H__
31 
32 #include <linux/list.h>
33 #include <linux/netdevice.h>
34 
35 #include "globals.h"
36 #include "slave.h"
37 #include "datagram.h"
38 
39 /****************************************************************************/
40 
43 enum {
44  EC_EOE_FRAMETYPE_INIT_REQ = 0x00,
49 };
50 
51 /*****************************************************************************/
52 
57 typedef struct
58 {
59  struct list_head queue;
60  struct sk_buff *skb;
61 }
63 
64 /****************************************************************************/
65 
66 typedef struct ec_eoe ec_eoe_t;
74 struct ec_eoe
75 {
76  struct list_head list;
79  unsigned int queue_datagram;
80  void (*state)(ec_eoe_t *);
81  struct net_device *dev;
82  struct net_device_stats stats;
83  unsigned int opened;
84  unsigned long rate_jiffies;
86  struct sk_buff *rx_skb;
87  off_t rx_skb_offset;
88  size_t rx_skb_size;
90  uint32_t rx_counter;
91  uint32_t rx_rate;
92  unsigned int rx_idle;
94  struct list_head tx_queue;
95  unsigned int tx_queue_size;
96  unsigned int tx_queue_active;
97  unsigned int tx_queued_frames;
99  uint8_t tx_frame_number;
101  size_t tx_offset;
102  uint32_t tx_counter;
103  uint32_t tx_rate;
104  unsigned int tx_idle;
106  unsigned int tries;
107 };
108 
109 /****************************************************************************/
110 
112 void ec_eoe_clear(ec_eoe_t *);
113 void ec_eoe_run(ec_eoe_t *);
114 void ec_eoe_queue(ec_eoe_t *);
115 int ec_eoe_is_open(const ec_eoe_t *);
116 int ec_eoe_is_idle(const ec_eoe_t *);
117 
118 /****************************************************************************/
119 
120 #endif
121 
122 /****************************************************************************/
Queued frame structure.
Definition: ethernet.h:57
uint32_t tx_counter
octets transmitted during last second
Definition: ethernet.h:102
void ec_eoe_clear(ec_eoe_t *)
EoE destructor.
Definition: ethernet.c:223
struct sk_buff * skb
socket buffer
Definition: ethernet.h:60
struct list_head tx_queue
queue for frames to send
Definition: ethernet.h:94
uint8_t tx_fragment_number
number of the fragment
Definition: ethernet.h:100
ec_slave_t * slave
pointer to the corresponding slave
Definition: ethernet.h:77
unsigned int tx_queue_size
Transmit queue size.
Definition: ethernet.h:95
size_t rx_skb_size
size of the allocated socket buffer memory
Definition: ethernet.h:88
size_t tx_offset
number of octets sent
Definition: ethernet.h:101
EtherCAT slave structure.
EtherCAT datagram.
Definition: datagram.h:79
unsigned int tx_queue_active
kernel netif queue started
Definition: ethernet.h:96
Set Address Filter Request.
Definition: ethernet.h:48
Set IP Parameter Request.
Definition: ethernet.h:46
uint32_t tx_rate
transmit rate (bps)
Definition: ethernet.h:103
Global definitions and macros.
uint8_t rx_expected_fragment
next expected fragment number
Definition: ethernet.h:89
void ec_eoe_run(ec_eoe_t *)
Runs the EoE state machine.
Definition: ethernet.c:343
EtherCAT slave.
Definition: slave.h:168
int ec_eoe_is_open(const ec_eoe_t *)
Returns the state of the device.
Definition: ethernet.c:385
Initiate EoE Request.
Definition: ethernet.h:45
unsigned long rate_jiffies
time of last rate output
Definition: ethernet.h:84
void ec_eoe_queue(ec_eoe_t *)
Queues the datagram, if necessary.
Definition: ethernet.c:371
EtherCAT datagram structure.
unsigned int opened
net_device is opened
Definition: ethernet.h:83
struct list_head list
list item
Definition: ethernet.h:76
int ec_eoe_is_idle(const ec_eoe_t *)
Returns the idle state.
Definition: ethernet.c:397
int ec_eoe_init(ec_eoe_t *, ec_slave_t *)
EoE constructor.
Definition: ethernet.c:111
off_t rx_skb_offset
current write pointer in the socket buffer
Definition: ethernet.h:87
ec_datagram_t datagram
datagram
Definition: ethernet.h:78
struct net_device_stats stats
device statistics
Definition: ethernet.h:82
unsigned int tx_idle
Idle flag.
Definition: ethernet.h:104
uint32_t rx_rate
receive rate (bps)
Definition: ethernet.h:91
struct sk_buff * rx_skb
current rx socket buffer
Definition: ethernet.h:86
Set IP Parameter Response.
Definition: ethernet.h:47
void(* state)(ec_eoe_t *)
state function for the state machine
Definition: ethernet.h:80
uint8_t tx_frame_number
number of the transmitted frame
Definition: ethernet.h:99
uint32_t rx_counter
octets received during last second
Definition: ethernet.h:90
ec_eoe_frame_t * tx_frame
current TX frame
Definition: ethernet.h:98
unsigned int tries
Tries.
Definition: ethernet.h:106
Ethernet over EtherCAT (EoE) handler.
Definition: ethernet.h:74
unsigned int rx_idle
Idle flag.
Definition: ethernet.h:92
struct net_device * dev
net_device for virtual ethernet device
Definition: ethernet.h:81
unsigned int queue_datagram
the datagram is ready for queuing
Definition: ethernet.h:79
unsigned int tx_queued_frames
number of frames in the queue
Definition: ethernet.h:97