[netdevice] Change link-layer push() and pull() methods to take raw types
[people/sha0/gpxe.git] / src / include / gpxe / netdevice.h
1 #ifndef _GPXE_NETDEVICE_H
2 #define _GPXE_NETDEVICE_H
3
4 /** @file
5  *
6  * Network device management
7  *
8  */
9
10 #include <stdint.h>
11 #include <gpxe/list.h>
12 #include <gpxe/tables.h>
13 #include <gpxe/refcnt.h>
14 #include <gpxe/settings.h>
15
16 struct io_buffer;
17 struct net_device;
18 struct net_protocol;
19 struct ll_protocol;
20 struct device;
21
22 /** Maximum length of a link-layer address */
23 #define MAX_LL_ADDR_LEN 20
24
25 /** Maximum length of a link-layer header */
26 #define MAX_LL_HEADER_LEN 32
27
28 /** Maximum length of a network-layer address */
29 #define MAX_NET_ADDR_LEN 4
30
31 /**
32  * A network-layer protocol
33  *
34  */
35 struct net_protocol {
36         /** Protocol name */
37         const char *name;
38         /**
39          * Process received packet
40          *
41          * @v iobuf     I/O buffer
42          * @v netdev    Network device
43          * @v ll_source Link-layer source address
44          *
45          * This method takes ownership of the I/O buffer.
46          */
47         int ( * rx ) ( struct io_buffer *iobuf, struct net_device *netdev,
48                        const void *ll_source );
49         /**
50          * Transcribe network-layer address
51          *
52          * @v net_addr  Network-layer address
53          * @ret string  Human-readable transcription of address
54          *
55          * This method should convert the network-layer address into a
56          * human-readable format (e.g. dotted quad notation for IPv4).
57          *
58          * The buffer used to hold the transcription is statically
59          * allocated.
60          */
61         const char * ( *ntoa ) ( const void * net_addr );
62         /** Network-layer protocol
63          *
64          * This is an ETH_P_XXX constant, in network-byte order
65          */
66         uint16_t net_proto;
67         /** Network-layer address length */
68         uint8_t net_addr_len;
69 };
70
71 /**
72  * A link-layer protocol
73  *
74  */
75 struct ll_protocol {
76         /** Protocol name */
77         const char *name;
78         /**
79          * Add link-layer header
80          *
81          * @v iobuf             I/O buffer
82          * @v ll_dest           Link-layer destination address
83          * @v ll_source         Source link-layer address
84          * @v net_proto         Network-layer protocol, in network-byte order
85          * @ret rc              Return status code
86          */
87         int ( * push ) ( struct io_buffer *iobuf, const void *ll_dest,
88                          const void *ll_source, uint16_t net_proto );
89         /**
90          * Remove link-layer header
91          *
92          * @v iobuf             I/O buffer
93          * @ret ll_dest         Link-layer destination address
94          * @ret ll_source       Source link-layer address
95          * @ret net_proto       Network-layer protocol, in network-byte order
96          * @ret rc              Return status code
97          */
98         int ( * pull ) ( struct io_buffer *iobuf, const void **ll_dest,
99                          const void **ll_source, uint16_t *net_proto );
100         /**
101          * Transcribe link-layer address
102          *
103          * @v ll_addr   Link-layer address
104          * @ret string  Human-readable transcription of address
105          *
106          * This method should convert the link-layer address into a
107          * human-readable format.
108          *
109          * The buffer used to hold the transcription is statically
110          * allocated.
111          */
112         const char * ( * ntoa ) ( const void * ll_addr );
113         /**
114          * Hash multicast address
115          *
116          * @v af        Address family
117          * @v net_addr  Network-layer address
118          * @v ll_addr   Link-layer address to fill in
119          * @ret rc      Return status code
120          */
121         int ( * mc_hash ) ( unsigned int af, const void *net_addr,
122                             void *ll_addr );
123         /** Link-layer protocol
124          *
125          * This is an ARPHRD_XXX constant, in network byte order.
126          */
127         uint16_t ll_proto;
128         /** Link-layer address length */
129         uint8_t ll_addr_len;
130         /** Link-layer header length */
131         uint8_t ll_header_len;
132         /** Link-layer broadcast address */
133         const uint8_t *ll_broadcast;
134 };
135
136 /** Network device operations */
137 struct net_device_operations {
138         /** Open network device
139          *
140          * @v netdev    Network device
141          * @ret rc      Return status code
142          *
143          * This method should allocate RX I/O buffers and enable
144          * the hardware to start transmitting and receiving packets.
145          */
146         int ( * open ) ( struct net_device *netdev );
147         /** Close network device
148          *
149          * @v netdev    Network device
150          *
151          * This method should stop the flow of packets, and free up
152          * any packets that are currently in the device's TX queue.
153          */
154         void ( * close ) ( struct net_device *netdev );
155         /** Transmit packet
156          *
157          * @v netdev    Network device
158          * @v iobuf     I/O buffer
159          * @ret rc      Return status code
160          *
161          * This method should cause the hardware to initiate
162          * transmission of the I/O buffer.
163          *
164          * If this method returns success, the I/O buffer remains
165          * owned by the net device's TX queue, and the net device must
166          * eventually call netdev_tx_complete() to free the buffer.
167          * If this method returns failure, the I/O buffer is
168          * immediately released; the failure is interpreted as
169          * "failure to enqueue buffer".
170          *
171          * This method is guaranteed to be called only when the device
172          * is open.
173          */
174         int ( * transmit ) ( struct net_device *netdev,
175                              struct io_buffer *iobuf );
176         /** Poll for completed and received packets
177          *
178          * @v netdev    Network device
179          *
180          * This method should cause the hardware to check for
181          * completed transmissions and received packets.  Any received
182          * packets should be delivered via netdev_rx().
183          *
184          * This method is guaranteed to be called only when the device
185          * is open.
186          */
187         void ( * poll ) ( struct net_device *netdev );
188         /** Enable or disable interrupts
189          *
190          * @v netdev    Network device
191          * @v enable    Interrupts should be enabled
192          */
193         void ( * irq ) ( struct net_device *netdev, int enable );
194 };
195
196 /** Network device statistics */
197 struct net_device_stats {
198         /** Count of successfully completed transmissions */
199         unsigned int tx_ok;
200         /** Count of transmission errors */
201         unsigned int tx_err;
202         /** Count of successfully received packets */
203         unsigned int rx_ok;
204         /** Count of reception errors */
205         unsigned int rx_err;
206 };
207
208 /**
209  * A network device
210  *
211  * This structure represents a piece of networking hardware.  It has
212  * properties such as a link-layer address and methods for
213  * transmitting and receiving raw packets.
214  *
215  * Note that this structure must represent a generic network device,
216  * not just an Ethernet device.
217  */
218 struct net_device {
219         /** Reference counter */
220         struct refcnt refcnt;
221         /** List of network devices */
222         struct list_head list;
223         /** Name of this network device */
224         char name[8];
225         /** Underlying hardware device */
226         struct device *dev;
227
228         /** Network device operations */
229         struct net_device_operations *op;
230
231         /** Link-layer protocol */
232         struct ll_protocol *ll_protocol;
233         /** Link-layer address
234          *
235          * For Ethernet, this is the MAC address.
236          */
237         uint8_t ll_addr[MAX_LL_ADDR_LEN];
238
239         /** Current device state
240          *
241          * This is the bitwise-OR of zero or more NETDEV_XXX constants.
242          */
243         unsigned int state;
244         /** Maximum packet length
245          *
246          * This length includes any link-layer headers.
247          */
248         size_t max_pkt_len;
249         /** TX packet queue */
250         struct list_head tx_queue;
251         /** RX packet queue */
252         struct list_head rx_queue;
253         /** Device statistics */
254         struct net_device_stats stats;
255
256         /** Configuration settings applicable to this device */
257         struct simple_settings settings;
258
259         /** Driver private data */
260         void *priv;
261 };
262
263 /** Network device is open */
264 #define NETDEV_OPEN 0x0001
265
266 /** Network device has link */
267 #define NETDEV_LINK_UP 0x0002
268
269 /** Declare a link-layer protocol */
270 #define __ll_protocol  __table ( struct ll_protocol, ll_protocols, 01 )
271
272 /** Declare a network-layer protocol */
273 #define __net_protocol __table ( struct net_protocol, net_protocols, 01 )
274
275 extern struct list_head net_devices;
276 extern struct net_device_operations null_netdev_operations;
277
278 /**
279  * Initialise a network device
280  *
281  * @v netdev            Network device
282  * @v op                Network device operations
283  */
284 static inline void netdev_init ( struct net_device *netdev,
285                                  struct net_device_operations *op ) {
286         netdev->op = op;
287 }
288
289 /**
290  * Stop using a network device
291  *
292  * @v netdev            Network device
293  *
294  * Drivers should call this method immediately before the final call
295  * to netdev_put().
296  */
297 static inline void netdev_nullify ( struct net_device *netdev ) {
298         netdev->op = &null_netdev_operations;
299 }
300
301 /**
302  * Get printable network device hardware address
303  *
304  * @v netdev            Network device
305  * @ret name            Hardware address
306  */
307 static inline const char * netdev_hwaddr ( struct net_device *netdev ) {
308         return netdev->ll_protocol->ntoa ( netdev->ll_addr );
309 }
310
311 /** Iterate over all network devices */
312 #define for_each_netdev( netdev ) \
313         list_for_each_entry ( (netdev), &net_devices, list )
314
315 /** There exist some network devices
316  *
317  * @ret existence       Existence of network devices
318  */
319 static inline int have_netdevs ( void ) {
320         return ( ! list_empty ( &net_devices ) );
321 }
322
323 /**
324  * Get reference to network device
325  *
326  * @v netdev            Network device
327  * @ret netdev          Network device
328  */
329 static inline __attribute__ (( always_inline )) struct net_device *
330 netdev_get ( struct net_device *netdev ) {
331         ref_get ( &netdev->refcnt );
332         return netdev;
333 }
334
335 /**
336  * Drop reference to network device
337  *
338  * @v netdev            Network device
339  */
340 static inline __attribute__ (( always_inline )) void
341 netdev_put ( struct net_device *netdev ) {
342         ref_put ( &netdev->refcnt );
343 }
344
345 /**
346  * Get driver private area for this network device
347  *
348  * @v netdev            Network device
349  * @ret priv            Driver private area for this network device
350  */
351 static inline __attribute__ (( always_inline )) void *
352 netdev_priv ( struct net_device *netdev ) {
353         return netdev->priv;
354 }
355
356 /**
357  * Get per-netdevice configuration settings block
358  *
359  * @v netdev            Network device
360  * @ret settings        Settings block
361  */
362 static inline __attribute__ (( always_inline )) struct settings *
363 netdev_settings ( struct net_device *netdev ) {
364         return &netdev->settings.settings;
365 }
366
367 /**
368  * Mark network device as having link up
369  *
370  * @v netdev            Network device
371  */
372 static inline __attribute__ (( always_inline )) void
373 netdev_link_up ( struct net_device *netdev ) {
374         netdev->state |= NETDEV_LINK_UP;
375 }
376
377 /**
378  * Mark network device as having link down
379  *
380  * @v netdev            Network device
381  */
382 static inline __attribute__ (( always_inline )) void
383 netdev_link_down ( struct net_device *netdev ) {
384         netdev->state &= ~NETDEV_LINK_UP;
385 }
386
387 /**
388  * Check link state of network device
389  *
390  * @v netdev            Network device
391  * @ret link_up         Link is up
392  */
393 static inline __attribute__ (( always_inline )) int
394 netdev_link_ok ( struct net_device *netdev ) {
395         return ( netdev->state & NETDEV_LINK_UP );
396 }
397
398 extern int netdev_tx ( struct net_device *netdev, struct io_buffer *iobuf );
399 extern void netdev_tx_complete_err ( struct net_device *netdev,
400                                  struct io_buffer *iobuf, int rc );
401 extern void netdev_tx_complete_next_err ( struct net_device *netdev, int rc );
402 extern void netdev_rx ( struct net_device *netdev, struct io_buffer *iobuf );
403 extern void netdev_rx_err ( struct net_device *netdev,
404                             struct io_buffer *iobuf, int rc );
405 extern void netdev_poll ( struct net_device *netdev );
406 extern struct io_buffer * netdev_rx_dequeue ( struct net_device *netdev );
407 extern struct net_device * alloc_netdev ( size_t priv_size );
408 extern int register_netdev ( struct net_device *netdev );
409 extern int netdev_open ( struct net_device *netdev );
410 extern void netdev_close ( struct net_device *netdev );
411 extern void unregister_netdev ( struct net_device *netdev );
412 extern void netdev_irq ( struct net_device *netdev, int enable );
413 extern struct net_device * find_netdev ( const char *name );
414 extern struct net_device * find_netdev_by_location ( unsigned int bus_type,
415                                                      unsigned int location );
416 extern int net_tx ( struct io_buffer *iobuf, struct net_device *netdev,
417                     struct net_protocol *net_protocol, const void *ll_dest );
418 extern int net_rx ( struct io_buffer *iobuf, struct net_device *netdev,
419                     uint16_t net_proto, const void *ll_source );
420
421 extern struct settings_operations netdev_settings_operations;
422
423 /**
424  * Complete network transmission
425  *
426  * @v netdev            Network device
427  * @v iobuf             I/O buffer
428  *
429  * The packet must currently be in the network device's TX queue.
430  */
431 static inline void netdev_tx_complete ( struct net_device *netdev,
432                                         struct io_buffer *iobuf ) {
433         netdev_tx_complete_err ( netdev, iobuf, 0 );
434 }
435
436 /**
437  * Complete network transmission
438  *
439  * @v netdev            Network device
440  *
441  * Completes the oldest outstanding packet in the TX queue.
442  */
443 static inline void netdev_tx_complete_next ( struct net_device *netdev ) {
444         netdev_tx_complete_next_err ( netdev, 0 );
445 }
446
447 #endif /* _GPXE_NETDEVICE_H */