[undi] Fill in ProtType correctly in PXENV_UNDI_ISR
[people/mcb30/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 netdev            Network device
83          * @v net_protocol      Network-layer protocol
84          * @v ll_dest           Link-layer destination address
85          * @ret rc              Return status code
86          *
87          * This method should prepend in the link-layer header
88          * (e.g. the Ethernet DIX header).
89          */
90         int ( * push ) ( struct io_buffer *iobuf, struct net_device *netdev,
91                          struct net_protocol *net_protocol,
92                          const void *ll_dest );
93         /**
94          * Remove link-layer header
95          *
96          * @v iobuf     I/O buffer
97          * @v netdev    Network device
98          * @v net_proto Network-layer protocol, in network-byte order
99          * @v ll_source Source link-layer address
100          * @ret rc      Return status code
101          *
102          * This method should strip off the link-layer header
103          * (e.g. the Ethernet DIX header) and return the protocol and
104          * source link-layer address.  The method must not alter the
105          * packet content, and may return the link-layer address as a
106          * pointer to data within the packet.
107          */
108         int ( * pull ) ( struct io_buffer *iobuf, struct net_device *netdev,
109                          uint16_t *net_proto, const void **ll_source );
110         /**
111          * Transcribe link-layer address
112          *
113          * @v ll_addr   Link-layer address
114          * @ret string  Human-readable transcription of address
115          *
116          * This method should convert the link-layer address into a
117          * human-readable format.
118          *
119          * The buffer used to hold the transcription is statically
120          * allocated.
121          */
122         const char * ( * ntoa ) ( const 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         /** TX packet queue */
245         struct list_head tx_queue;
246         /** RX packet queue */
247         struct list_head rx_queue;
248         /** Device statistics */
249         struct net_device_stats stats;
250
251         /** Configuration settings applicable to this device */
252         struct simple_settings settings;
253
254         /** Driver private data */
255         void *priv;
256 };
257
258 /** Network device is open */
259 #define NETDEV_OPEN 0x0001
260
261 /** Network device has link */
262 #define NETDEV_LINK_UP 0x0002
263
264 /** Declare a link-layer protocol */
265 #define __ll_protocol  __table ( struct ll_protocol, ll_protocols, 01 )
266
267 /** Declare a network-layer protocol */
268 #define __net_protocol __table ( struct net_protocol, net_protocols, 01 )
269
270 extern struct list_head net_devices;
271 extern struct net_device_operations null_netdev_operations;
272
273 /**
274  * Initialise a network device
275  *
276  * @v netdev            Network device
277  * @v op                Network device operations
278  */
279 static inline void netdev_init ( struct net_device *netdev,
280                                  struct net_device_operations *op ) {
281         netdev->op = op;
282 }
283
284 /**
285  * Stop using a network device
286  *
287  * @v netdev            Network device
288  *
289  * Drivers should call this method immediately before the final call
290  * to netdev_put().
291  */
292 static inline void netdev_nullify ( struct net_device *netdev ) {
293         netdev->op = &null_netdev_operations;
294 }
295
296 /**
297  * Get printable network device hardware address
298  *
299  * @v netdev            Network device
300  * @ret name            Hardware address
301  */
302 static inline const char * netdev_hwaddr ( struct net_device *netdev ) {
303         return netdev->ll_protocol->ntoa ( netdev->ll_addr );
304 }
305
306 /** Iterate over all network devices */
307 #define for_each_netdev( netdev ) \
308         list_for_each_entry ( (netdev), &net_devices, list )
309
310 /** There exist some network devices
311  *
312  * @ret existence       Existence of network devices
313  */
314 static inline int have_netdevs ( void ) {
315         return ( ! list_empty ( &net_devices ) );
316 }
317
318 /**
319  * Get reference to network device
320  *
321  * @v netdev            Network device
322  * @ret netdev          Network device
323  */
324 static inline __attribute__ (( always_inline )) struct net_device *
325 netdev_get ( struct net_device *netdev ) {
326         ref_get ( &netdev->refcnt );
327         return netdev;
328 }
329
330 /**
331  * Drop reference to network device
332  *
333  * @v netdev            Network device
334  */
335 static inline __attribute__ (( always_inline )) void
336 netdev_put ( struct net_device *netdev ) {
337         ref_put ( &netdev->refcnt );
338 }
339
340 /**
341  * Get driver private area for this network device
342  *
343  * @v netdev            Network device
344  * @ret priv            Driver private area for this network device
345  */
346 static inline __attribute__ (( always_inline )) void *
347 netdev_priv ( struct net_device *netdev ) {
348         return netdev->priv;
349 }
350
351 /**
352  * Get per-netdevice configuration settings block
353  *
354  * @v netdev            Network device
355  * @ret settings        Settings block
356  */
357 static inline __attribute__ (( always_inline )) struct settings *
358 netdev_settings ( struct net_device *netdev ) {
359         return &netdev->settings.settings;
360 }
361
362 /**
363  * Mark network device as having link up
364  *
365  * @v netdev            Network device
366  */
367 static inline __attribute__ (( always_inline )) void
368 netdev_link_up ( struct net_device *netdev ) {
369         netdev->state |= NETDEV_LINK_UP;
370 }
371
372 /**
373  * Mark network device as having link down
374  *
375  * @v netdev            Network device
376  */
377 static inline __attribute__ (( always_inline )) void
378 netdev_link_down ( struct net_device *netdev ) {
379         netdev->state &= ~NETDEV_LINK_UP;
380 }
381
382 /**
383  * Check link state of network device
384  *
385  * @v netdev            Network device
386  * @ret link_up         Link is up
387  */
388 static inline __attribute__ (( always_inline )) int
389 netdev_link_ok ( struct net_device *netdev ) {
390         return ( netdev->state & NETDEV_LINK_UP );
391 }
392
393 extern int netdev_tx ( struct net_device *netdev, struct io_buffer *iobuf );
394 extern void netdev_tx_complete_err ( struct net_device *netdev,
395                                  struct io_buffer *iobuf, int rc );
396 extern void netdev_tx_complete_next_err ( struct net_device *netdev, int rc );
397 extern void netdev_rx ( struct net_device *netdev, struct io_buffer *iobuf );
398 extern void netdev_rx_err ( struct net_device *netdev,
399                             struct io_buffer *iobuf, int rc );
400 extern void netdev_poll ( struct net_device *netdev );
401 extern struct io_buffer * netdev_rx_dequeue ( struct net_device *netdev );
402 extern struct net_device * alloc_netdev ( size_t priv_size );
403 extern int register_netdev ( struct net_device *netdev );
404 extern int netdev_open ( struct net_device *netdev );
405 extern void netdev_close ( struct net_device *netdev );
406 extern void unregister_netdev ( struct net_device *netdev );
407 extern void netdev_irq ( struct net_device *netdev, int enable );
408 extern struct net_device * find_netdev ( const char *name );
409 extern struct net_device * find_netdev_by_location ( unsigned int bus_type,
410                                                      unsigned int location );
411 extern int net_tx ( struct io_buffer *iobuf, struct net_device *netdev,
412                     struct net_protocol *net_protocol, const void *ll_dest );
413 extern int net_rx ( struct io_buffer *iobuf, struct net_device *netdev,
414                     uint16_t net_proto, const void *ll_source );
415
416 extern struct settings_operations netdev_settings_operations;
417
418 /**
419  * Complete network transmission
420  *
421  * @v netdev            Network device
422  * @v iobuf             I/O buffer
423  *
424  * The packet must currently be in the network device's TX queue.
425  */
426 static inline void netdev_tx_complete ( struct net_device *netdev,
427                                         struct io_buffer *iobuf ) {
428         netdev_tx_complete_err ( netdev, iobuf, 0 );
429 }
430
431 /**
432  * Complete network transmission
433  *
434  * @v netdev            Network device
435  *
436  * Completes the oldest outstanding packet in the TX queue.
437  */
438 static inline void netdev_tx_complete_next ( struct net_device *netdev ) {
439         netdev_tx_complete_next_err ( netdev, 0 );
440 }
441
442 #endif /* _GPXE_NETDEVICE_H */