[build] Enable building with the Intel C compiler (icc)
[people/mcb30/gpxe.git] / src / arch / i386 / drivers / net / undinet.c
1 /*
2  * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of the
7  * License, or any later version.
8  *
9  * This program is distributed in the hope that it will be useful, but
10  * WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #include <string.h>
20 #include <pxe.h>
21 #include <realmode.h>
22 #include <pic8259.h>
23 #include <biosint.h>
24 #include <pnpbios.h>
25 #include <basemem_packet.h>
26 #include <gpxe/io.h>
27 #include <gpxe/iobuf.h>
28 #include <gpxe/netdevice.h>
29 #include <gpxe/if_ether.h>
30 #include <gpxe/ethernet.h>
31 #include <undi.h>
32 #include <undinet.h>
33
34
35 /** @file
36  *
37  * UNDI network device driver
38  *
39  */
40
41 /** An UNDI NIC */
42 struct undi_nic {
43         /** Assigned IRQ number */
44         unsigned int irq;
45         /** Currently processing ISR */
46         int isr_processing;
47         /** Bug workarounds */
48         int hacks;
49 };
50
51 /**
52  * @defgroup undi_hacks UNDI workarounds
53  * @{
54  */
55
56 /** Work around Etherboot 5.4 bugs */
57 #define UNDI_HACK_EB54          0x0001
58
59 /** @} */
60
61 static void undinet_close ( struct net_device *netdev );
62
63 /*****************************************************************************
64  *
65  * UNDI API call
66  *
67  *****************************************************************************
68  */
69
70 /**
71  * Name UNDI API call
72  *
73  * @v function          API call number
74  * @ret name            API call name
75  */
76 static inline __attribute__ (( always_inline )) const char *
77 undinet_function_name ( unsigned int function ) {
78         switch ( function ) {
79         case PXENV_START_UNDI:
80                 return "PXENV_START_UNDI";
81         case PXENV_STOP_UNDI:
82                 return "PXENV_STOP_UNDI";
83         case PXENV_UNDI_STARTUP:
84                 return "PXENV_UNDI_STARTUP";
85         case PXENV_UNDI_CLEANUP:
86                 return "PXENV_UNDI_CLEANUP";
87         case PXENV_UNDI_INITIALIZE:
88                 return "PXENV_UNDI_INITIALIZE";
89         case PXENV_UNDI_RESET_ADAPTER:
90                 return "PXENV_UNDI_RESET_ADAPTER";
91         case PXENV_UNDI_SHUTDOWN:
92                 return "PXENV_UNDI_SHUTDOWN";
93         case PXENV_UNDI_OPEN:
94                 return "PXENV_UNDI_OPEN";
95         case PXENV_UNDI_CLOSE:
96                 return "PXENV_UNDI_CLOSE";
97         case PXENV_UNDI_TRANSMIT:
98                 return "PXENV_UNDI_TRANSMIT";
99         case PXENV_UNDI_SET_MCAST_ADDRESS:
100                 return "PXENV_UNDI_SET_MCAST_ADDRESS";
101         case PXENV_UNDI_SET_STATION_ADDRESS:
102                 return "PXENV_UNDI_SET_STATION_ADDRESS";
103         case PXENV_UNDI_SET_PACKET_FILTER:
104                 return "PXENV_UNDI_SET_PACKET_FILTER";
105         case PXENV_UNDI_GET_INFORMATION:
106                 return "PXENV_UNDI_GET_INFORMATION";
107         case PXENV_UNDI_GET_STATISTICS:
108                 return "PXENV_UNDI_GET_STATISTICS";
109         case PXENV_UNDI_CLEAR_STATISTICS:
110                 return "PXENV_UNDI_CLEAR_STATISTICS";
111         case PXENV_UNDI_INITIATE_DIAGS:
112                 return "PXENV_UNDI_INITIATE_DIAGS";
113         case PXENV_UNDI_FORCE_INTERRUPT:
114                 return "PXENV_UNDI_FORCE_INTERRUPT";
115         case PXENV_UNDI_GET_MCAST_ADDRESS:
116                 return "PXENV_UNDI_GET_MCAST_ADDRESS";
117         case PXENV_UNDI_GET_NIC_TYPE:
118                 return "PXENV_UNDI_GET_NIC_TYPE";
119         case PXENV_UNDI_GET_IFACE_INFO:
120                 return "PXENV_UNDI_GET_IFACE_INFO";
121         /*
122          * Duplicate case value; this is a bug in the PXE specification.
123          *
124          *      case PXENV_UNDI_GET_STATE:
125          *              return "PXENV_UNDI_GET_STATE";
126          */
127         case PXENV_UNDI_ISR:
128                 return "PXENV_UNDI_ISR";
129         default:
130                 return "UNKNOWN API CALL";
131         }
132 }
133
134 /**
135  * UNDI parameter block
136  *
137  * Used as the paramter block for all UNDI API calls.  Resides in base
138  * memory.
139  */
140 static union u_PXENV_ANY __bss16 ( undinet_params );
141 #define undinet_params __use_data16 ( undinet_params )
142
143 /** UNDI entry point
144  *
145  * Used as the indirection vector for all UNDI API calls.  Resides in
146  * base memory.
147  */
148 SEGOFF16_t __bss16 ( undinet_entry_point );
149 #define undinet_entry_point __use_data16 ( undinet_entry_point )
150
151 /**
152  * Issue UNDI API call
153  *
154  * @v undinic           UNDI NIC
155  * @v function          API call number
156  * @v params            UNDI parameter block
157  * @v params_len        Length of UNDI parameter block
158  * @ret rc              Return status code
159  */
160 static int undinet_call ( struct undi_nic *undinic, unsigned int function,
161                           void *params, size_t params_len ) {
162         PXENV_EXIT_t exit;
163         int discard_b, discard_D;
164         int rc;
165
166         /* Copy parameter block and entry point */
167         assert ( params_len <= sizeof ( undinet_params ) );
168         memcpy ( &undinet_params, params, params_len );
169
170         /* Call real-mode entry point.  This calling convention will
171          * work with both the !PXE and the PXENV+ entry points.
172          */
173         __asm__ __volatile__ ( REAL_CODE ( "pushw %%es\n\t"
174                                            "pushw %%di\n\t"
175                                            "pushw %%bx\n\t"
176                                            "lcall *undinet_entry_point\n\t"
177                                            "addw $6, %%sp\n\t" )
178                                : "=a" ( exit ), "=b" ( discard_b ),
179                                  "=D" ( discard_D )
180                                : "b" ( function ),
181                                  "D" ( __from_data16 ( &undinet_params ) )
182                                : "ecx", "edx", "esi", "ebp" );
183
184         /* UNDI API calls may rudely change the status of A20 and not
185          * bother to restore it afterwards.  Intel is known to be
186          * guilty of this.
187          *
188          * Note that we will return to this point even if A20 gets
189          * screwed up by the UNDI driver, because Etherboot always
190          * resides in an even megabyte of RAM.
191          */     
192         gateA20_set();
193
194         /* Determine return status code based on PXENV_EXIT and
195          * PXENV_STATUS
196          */
197         if ( exit == PXENV_EXIT_SUCCESS ) {
198                 rc = 0;
199         } else {
200                 rc = -undinet_params.Status;
201                 /* Paranoia; don't return success for the combination
202                  * of PXENV_EXIT_FAILURE but PXENV_STATUS_SUCCESS
203                  */
204                 if ( rc == 0 )
205                         rc = -EIO;
206         }
207
208         /* If anything goes wrong, print as much debug information as
209          * it's possible to give.
210          */
211         if ( rc != 0 ) {
212                 SEGOFF16_t rm_params = {
213                         .segment = rm_ds,
214                         .offset = __from_data16 ( &undinet_params ),
215                 };
216
217                 DBGC ( undinic, "UNDINIC %p %s failed: %s\n", undinic,
218                        undinet_function_name ( function ), strerror ( rc ) );
219                 DBGC ( undinic, "UNDINIC %p parameters at %04x:%04x length "
220                        "%#02zx, entry point at %04x:%04x\n", undinic,
221                        rm_params.segment, rm_params.offset, params_len,
222                        undinet_entry_point.segment,
223                        undinet_entry_point.offset );
224                 DBGC ( undinic, "UNDINIC %p parameters provided:\n", undinic );
225                 DBGC_HDA ( undinic, rm_params, params, params_len );
226                 DBGC ( undinic, "UNDINIC %p parameters returned:\n", undinic );
227                 DBGC_HDA ( undinic, rm_params, &undinet_params, params_len );
228         }
229
230         /* Copy parameter block back */
231         memcpy ( params, &undinet_params, params_len );
232
233         return rc;
234 }
235
236 /*****************************************************************************
237  *
238  * UNDI interrupt service routine
239  *
240  *****************************************************************************
241  */
242
243 /**
244  * UNDI interrupt service routine
245  *
246  * The UNDI ISR increments a counter (@c trigger_count) and exits.
247  */
248 extern void undiisr ( void );
249
250 /** IRQ number */
251 uint8_t __data16 ( undiisr_irq );
252 #define undiisr_irq __use_data16 ( undiisr_irq )
253
254 /** IRQ chain vector */
255 struct segoff __data16 ( undiisr_next_handler );
256 #define undiisr_next_handler __use_data16 ( undiisr_next_handler )
257
258 /** IRQ trigger count */
259 volatile uint8_t __data16 ( undiisr_trigger_count ) = 0;
260 #define undiisr_trigger_count __use_data16 ( undiisr_trigger_count )
261
262 /** Last observed trigger count */
263 static unsigned int last_trigger_count = 0;
264
265 /**
266  * Hook UNDI interrupt service routine
267  *
268  * @v irq               IRQ number
269  */
270 static void undinet_hook_isr ( unsigned int irq ) {
271
272         assert ( irq <= IRQ_MAX );
273         assert ( undiisr_irq == 0 );
274
275         undiisr_irq = irq;
276         hook_bios_interrupt ( IRQ_INT ( irq ),
277                               ( ( unsigned int ) undiisr ),
278                               &undiisr_next_handler );
279 }
280
281 /**
282  * Unhook UNDI interrupt service routine
283  *
284  * @v irq               IRQ number
285  */
286 static void undinet_unhook_isr ( unsigned int irq ) {
287
288         assert ( irq <= IRQ_MAX );
289
290         unhook_bios_interrupt ( IRQ_INT ( irq ),
291                                 ( ( unsigned int ) undiisr ),
292                                 &undiisr_next_handler );
293         undiisr_irq = 0;
294 }
295
296 /**
297  * Test to see if UNDI ISR has been triggered
298  *
299  * @ret triggered       ISR has been triggered since last check
300  */
301 static int undinet_isr_triggered ( void ) {
302         unsigned int this_trigger_count;
303
304         /* Read trigger_count.  Do this only once; it is volatile */
305         this_trigger_count = undiisr_trigger_count;
306
307         if ( this_trigger_count == last_trigger_count ) {
308                 /* Not triggered */
309                 return 0;
310         } else {
311                 /* Triggered */
312                 last_trigger_count = this_trigger_count;
313                 return 1;
314         }
315 }
316
317 /*****************************************************************************
318  *
319  * UNDI network device interface
320  *
321  *****************************************************************************
322  */
323
324 /** UNDI transmit buffer descriptor */
325 static struct s_PXENV_UNDI_TBD __data16 ( undinet_tbd );
326 #define undinet_tbd __use_data16 ( undinet_tbd )
327
328 /**
329  * Transmit packet
330  *
331  * @v netdev            Network device
332  * @v iobuf             I/O buffer
333  * @ret rc              Return status code
334  */
335 static int undinet_transmit ( struct net_device *netdev,
336                               struct io_buffer *iobuf ) {
337         struct undi_nic *undinic = netdev->priv;
338         struct s_PXENV_UNDI_TRANSMIT undi_transmit;
339         size_t len = iob_len ( iobuf );
340         int rc;
341
342         /* Technically, we ought to make sure that the previous
343          * transmission has completed before we re-use the buffer.
344          * However, many PXE stacks (including at least some Intel PXE
345          * stacks and Etherboot 5.4) fail to generate TX completions.
346          * In practice this won't be a problem, since our TX datapath
347          * has a very low packet volume and we can get away with
348          * assuming that a TX will be complete by the time we want to
349          * transmit the next packet.
350          */
351
352         /* Copy packet to UNDI I/O buffer */
353         if ( len > sizeof ( basemem_packet ) )
354                 len = sizeof ( basemem_packet );
355         memcpy ( &basemem_packet, iobuf->data, len );
356
357         /* Create PXENV_UNDI_TRANSMIT data structure */
358         memset ( &undi_transmit, 0, sizeof ( undi_transmit ) );
359         undi_transmit.DestAddr.segment = rm_ds;
360         undi_transmit.DestAddr.offset = __from_data16 ( &undinet_tbd );
361         undi_transmit.TBD.segment = rm_ds;
362         undi_transmit.TBD.offset = __from_data16 ( &undinet_tbd );
363
364         /* Create PXENV_UNDI_TBD data structure */
365         undinet_tbd.ImmedLength = len;
366         undinet_tbd.Xmit.segment = rm_ds;
367         undinet_tbd.Xmit.offset = __from_data16 ( basemem_packet );
368
369         /* Issue PXE API call */
370         if ( ( rc = undinet_call ( undinic, PXENV_UNDI_TRANSMIT,
371                                    &undi_transmit,
372                                    sizeof ( undi_transmit ) ) ) != 0 )
373                 goto done;
374
375         /* Free I/O buffer */
376         netdev_tx_complete ( netdev, iobuf );
377
378  done:
379         return rc;
380 }
381
382 /** 
383  * Poll for received packets
384  *
385  * @v netdev            Network device
386  *
387  * Fun, fun, fun.  UNDI drivers don't use polling; they use
388  * interrupts.  We therefore cheat and pretend that an interrupt has
389  * occurred every time undinet_poll() is called.  This isn't too much
390  * of a hack; PCI devices share IRQs and so the first thing that a
391  * proper ISR should do is call PXENV_UNDI_ISR to determine whether or
392  * not the UNDI NIC generated the interrupt; there is no harm done by
393  * spurious calls to PXENV_UNDI_ISR.  Similarly, we wouldn't be
394  * handling them any more rapidly than the usual rate of
395  * undinet_poll() being called even if we did implement a full ISR.
396  * So it should work.  Ha!
397  *
398  * Addendum (21/10/03).  Some cards don't play nicely with this trick,
399  * so instead of doing it the easy way we have to go to all the hassle
400  * of installing a genuine interrupt service routine and dealing with
401  * the wonderful 8259 Programmable Interrupt Controller.  Joy.
402  *
403  * Addendum (10/07/07).  When doing things such as iSCSI boot, in
404  * which we have to co-operate with a running OS, we can't get away
405  * with the "ISR-just-increments-a-counter-and-returns" trick at all,
406  * because it involves tying up the PIC for far too long, and other
407  * interrupt-dependent components (e.g. local disks) start breaking.
408  * We therefore implement a "proper" ISR which calls PXENV_UNDI_ISR
409  * from within interrupt context in order to deassert the device
410  * interrupt, and sends EOI if applicable.
411  */
412 static void undinet_poll ( struct net_device *netdev ) {
413         struct undi_nic *undinic = netdev->priv;
414         struct s_PXENV_UNDI_ISR undi_isr;
415         struct io_buffer *iobuf = NULL;
416         size_t len;
417         size_t frag_len;
418         size_t max_frag_len;
419         int rc;
420
421         if ( ! undinic->isr_processing ) {
422                 /* Do nothing unless ISR has been triggered */
423                 if ( ! undinet_isr_triggered() ) {
424                         /* Allow interrupt to occur */
425                         __asm__ __volatile__ ( REAL_CODE ( "sti\n\t"
426                                                            "nop\n\t"
427                                                            "nop\n\t"
428                                                            "cli\n\t" ) : : );
429                         return;
430                 }
431
432                 /* Start ISR processing */
433                 undinic->isr_processing = 1;
434                 undi_isr.FuncFlag = PXENV_UNDI_ISR_IN_PROCESS;
435         } else {
436                 /* Continue ISR processing */
437                 undi_isr.FuncFlag = PXENV_UNDI_ISR_IN_GET_NEXT;
438         }
439
440         /* Run through the ISR loop */
441         while ( 1 ) {
442                 if ( ( rc = undinet_call ( undinic, PXENV_UNDI_ISR, &undi_isr,
443                                            sizeof ( undi_isr ) ) ) != 0 )
444                         break;
445                 switch ( undi_isr.FuncFlag ) {
446                 case PXENV_UNDI_ISR_OUT_TRANSMIT:
447                         /* We don't care about transmit completions */
448                         break;
449                 case PXENV_UNDI_ISR_OUT_RECEIVE:
450                         /* Packet fragment received */
451                         len = undi_isr.FrameLength;
452                         frag_len = undi_isr.BufferLength;
453                         if ( ( len == 0 ) || ( len < frag_len ) ) {
454                                 /* Don't laugh.  VMWare does it. */
455                                 DBGC ( undinic, "UNDINIC %p reported insane "
456                                        "fragment (%zd of %zd bytes)\n",
457                                        undinic, frag_len, len );
458                                 netdev_rx_err ( netdev, NULL, -EINVAL );
459                                 break;
460                         }
461                         if ( ! iobuf )
462                                 iobuf = alloc_iob ( len );
463                         if ( ! iobuf ) {
464                                 DBGC ( undinic, "UNDINIC %p could not "
465                                        "allocate %zd bytes for RX buffer\n",
466                                        undinic, len );
467                                 /* Fragment will be dropped */
468                                 netdev_rx_err ( netdev, NULL, -ENOMEM );
469                                 goto done;
470                         }
471                         max_frag_len = iob_tailroom ( iobuf );
472                         if ( frag_len > max_frag_len ) {
473                                 DBGC ( undinic, "UNDINIC %p fragment too big "
474                                        "(%zd+%zd does not fit into %zd)\n",
475                                        undinic, iob_len ( iobuf ), frag_len,
476                                        ( iob_len ( iobuf ) + max_frag_len ) );
477                                 frag_len = max_frag_len;
478                         }
479                         copy_from_real ( iob_put ( iobuf, frag_len ),
480                                          undi_isr.Frame.segment,
481                                          undi_isr.Frame.offset, frag_len );
482                         if ( iob_len ( iobuf ) == len ) {
483                                 /* Whole packet received; deliver it */
484                                 netdev_rx ( netdev, iob_disown ( iobuf ) );
485                                 /* Etherboot 5.4 fails to return all packets
486                                  * under mild load; pretend it retriggered.
487                                  */
488                                 if ( undinic->hacks & UNDI_HACK_EB54 )
489                                         --last_trigger_count;
490                         }
491                         break;
492                 case PXENV_UNDI_ISR_OUT_DONE:
493                         /* Processing complete */
494                         undinic->isr_processing = 0;
495                         goto done;
496                 default:
497                         /* Should never happen.  VMWare does it routinely. */
498                         DBGC ( undinic, "UNDINIC %p ISR returned invalid "
499                                "FuncFlag %04x\n", undinic, undi_isr.FuncFlag );
500                         undinic->isr_processing = 0;
501                         goto done;
502                 }
503                 undi_isr.FuncFlag = PXENV_UNDI_ISR_IN_GET_NEXT;
504         }
505
506  done:
507         if ( iobuf ) {
508                 DBGC ( undinic, "UNDINIC %p returned incomplete packet "
509                        "(%zd of %zd)\n", undinic, iob_len ( iobuf ),
510                        ( iob_len ( iobuf ) + iob_tailroom ( iobuf ) ) );
511                 netdev_rx_err ( netdev, iobuf, -EINVAL );
512         }
513 }
514
515 /**
516  * Open NIC
517  *
518  * @v netdev            Net device
519  * @ret rc              Return status code
520  */
521 static int undinet_open ( struct net_device *netdev ) {
522         struct undi_nic *undinic = netdev->priv;
523         struct s_PXENV_UNDI_SET_STATION_ADDRESS undi_set_address;
524         struct s_PXENV_UNDI_OPEN undi_open;
525         int rc;
526
527         /* Hook interrupt service routine and enable interrupt */
528         undinet_hook_isr ( undinic->irq );
529         enable_irq ( undinic->irq );
530         send_eoi ( undinic->irq );
531
532         /* Set station address.  Required for some PXE stacks; will
533          * spuriously fail on others.  Ignore failures.  We only ever
534          * use it to set the MAC address to the card's permanent value
535          * anyway.
536          */
537         memcpy ( undi_set_address.StationAddress, netdev->ll_addr,
538                  sizeof ( undi_set_address.StationAddress ) );
539         undinet_call ( undinic, PXENV_UNDI_SET_STATION_ADDRESS,
540                        &undi_set_address, sizeof ( undi_set_address ) );
541
542         /* Open NIC.  We ask for promiscuous operation, since it's the
543          * only way to ask for all multicast addresses.  On any
544          * switched network, it shouldn't really make a difference to
545          * performance.
546          */
547         memset ( &undi_open, 0, sizeof ( undi_open ) );
548         undi_open.PktFilter = ( FLTR_DIRECTED | FLTR_BRDCST | FLTR_PRMSCS );
549         if ( ( rc = undinet_call ( undinic, PXENV_UNDI_OPEN, &undi_open,
550                                    sizeof ( undi_open ) ) ) != 0 )
551                 goto err;
552
553         DBGC ( undinic, "UNDINIC %p opened\n", undinic );
554         return 0;
555
556  err:
557         undinet_close ( netdev );
558         return rc;
559 }
560
561 /**
562  * Close NIC
563  *
564  * @v netdev            Net device
565  */
566 static void undinet_close ( struct net_device *netdev ) {
567         struct undi_nic *undinic = netdev->priv;
568         struct s_PXENV_UNDI_ISR undi_isr;
569         struct s_PXENV_UNDI_CLOSE undi_close;
570         int rc;
571
572         /* Ensure ISR has exited cleanly */
573         while ( undinic->isr_processing ) {
574                 undi_isr.FuncFlag = PXENV_UNDI_ISR_IN_GET_NEXT;
575                 if ( ( rc = undinet_call ( undinic, PXENV_UNDI_ISR, &undi_isr,
576                                            sizeof ( undi_isr ) ) ) != 0 )
577                         break;
578                 switch ( undi_isr.FuncFlag ) {
579                 case PXENV_UNDI_ISR_OUT_TRANSMIT:
580                 case PXENV_UNDI_ISR_OUT_RECEIVE:
581                         /* Continue draining */
582                         break;
583                 default:
584                         /* Stop processing */
585                         undinic->isr_processing = 0;
586                         break;
587                 }
588         }
589
590         /* Close NIC */
591         undinet_call ( undinic, PXENV_UNDI_CLOSE, &undi_close,
592                        sizeof ( undi_close ) );
593
594         /* Disable interrupt and unhook ISR */
595         disable_irq ( undinic->irq );
596         undinet_unhook_isr ( undinic->irq );
597
598         DBGC ( undinic, "UNDINIC %p closed\n", undinic );
599 }
600
601 /**
602  * Enable/disable interrupts
603  *
604  * @v netdev            Net device
605  * @v enable            Interrupts should be enabled
606  */
607 static void undinet_irq ( struct net_device *netdev, int enable ) {
608         struct undi_nic *undinic = netdev->priv;
609
610         /* Cannot support interrupts yet */
611         DBGC ( undinic, "UNDINIC %p cannot %s interrupts\n",
612                undinic, ( enable ? "enable" : "disable" ) );
613 }
614
615 /** UNDI network device operations */
616 static struct net_device_operations undinet_operations = {
617         .open           = undinet_open,
618         .close          = undinet_close,
619         .transmit       = undinet_transmit,
620         .poll           = undinet_poll,
621         .irq            = undinet_irq,
622 };
623
624 /**
625  * Probe UNDI device
626  *
627  * @v undi              UNDI device
628  * @ret rc              Return status code
629  */
630 int undinet_probe ( struct undi_device *undi ) {
631         struct net_device *netdev;
632         struct undi_nic *undinic;
633         struct s_PXENV_START_UNDI start_undi;
634         struct s_PXENV_UNDI_STARTUP undi_startup;
635         struct s_PXENV_UNDI_INITIALIZE undi_initialize;
636         struct s_PXENV_UNDI_GET_INFORMATION undi_info;
637         struct s_PXENV_UNDI_GET_IFACE_INFO undi_iface;
638         struct s_PXENV_UNDI_SHUTDOWN undi_shutdown;
639         struct s_PXENV_UNDI_CLEANUP undi_cleanup;
640         struct s_PXENV_STOP_UNDI stop_undi;
641         int rc;
642
643         /* Allocate net device */
644         netdev = alloc_etherdev ( sizeof ( *undinic ) );
645         if ( ! netdev )
646                 return -ENOMEM;
647         netdev_init ( netdev, &undinet_operations );
648         undinic = netdev->priv;
649         undi_set_drvdata ( undi, netdev );
650         netdev->dev = &undi->dev;
651         memset ( undinic, 0, sizeof ( *undinic ) );
652         undinet_entry_point = undi->entry;
653         DBGC ( undinic, "UNDINIC %p using UNDI %p\n", undinic, undi );
654
655         /* Hook in UNDI stack */
656         if ( ! ( undi->flags & UNDI_FL_STARTED ) ) {
657                 memset ( &start_undi, 0, sizeof ( start_undi ) );
658                 start_undi.AX = undi->pci_busdevfn;
659                 start_undi.BX = undi->isapnp_csn;
660                 start_undi.DX = undi->isapnp_read_port;
661                 start_undi.ES = BIOS_SEG;
662                 start_undi.DI = find_pnp_bios();
663                 if ( ( rc = undinet_call ( undinic, PXENV_START_UNDI,
664                                            &start_undi,
665                                            sizeof ( start_undi ) ) ) != 0 )
666                         goto err_start_undi;
667         }
668         undi->flags |= UNDI_FL_STARTED;
669
670         /* Bring up UNDI stack */
671         if ( ! ( undi->flags & UNDI_FL_INITIALIZED ) ) {
672                 memset ( &undi_startup, 0, sizeof ( undi_startup ) );
673                 if ( ( rc = undinet_call ( undinic, PXENV_UNDI_STARTUP,
674                                            &undi_startup,
675                                            sizeof ( undi_startup ) ) ) != 0 )
676                         goto err_undi_startup;
677                 memset ( &undi_initialize, 0, sizeof ( undi_initialize ) );
678                 if ( ( rc = undinet_call ( undinic, PXENV_UNDI_INITIALIZE,
679                                            &undi_initialize,
680                                            sizeof ( undi_initialize ))) != 0 )
681                         goto err_undi_initialize;
682         }
683         undi->flags |= UNDI_FL_INITIALIZED;
684
685         /* Get device information */
686         memset ( &undi_info, 0, sizeof ( undi_info ) );
687         if ( ( rc = undinet_call ( undinic, PXENV_UNDI_GET_INFORMATION,
688                                    &undi_info, sizeof ( undi_info ) ) ) != 0 )
689                 goto err_undi_get_information;
690         memcpy ( netdev->ll_addr, undi_info.PermNodeAddress, ETH_ALEN );
691         undinic->irq = undi_info.IntNumber;
692         if ( undinic->irq > IRQ_MAX ) {
693                 DBGC ( undinic, "UNDINIC %p invalid IRQ %d\n",
694                        undinic, undinic->irq );
695                 goto err_bad_irq;
696         }
697         DBGC ( undinic, "UNDINIC %p is %s on IRQ %d\n",
698                undinic, eth_ntoa ( netdev->ll_addr ), undinic->irq );
699
700         /* Get interface information */
701         memset ( &undi_iface, 0, sizeof ( undi_iface ) );
702         if ( ( rc = undinet_call ( undinic, PXENV_UNDI_GET_IFACE_INFO,
703                                    &undi_iface,
704                                    sizeof ( undi_iface ) ) ) != 0 )
705                 goto err_undi_get_iface_info;
706         DBGC ( undinic, "UNDINIC %p has type %s and link speed %d\n",
707                undinic, undi_iface.IfaceType, undi_iface.LinkSpeed );
708         if ( strncmp ( ( ( char * ) undi_iface.IfaceType ), "Etherboot",
709                        sizeof ( undi_iface.IfaceType ) ) == 0 ) {
710                 DBGC ( undinic, "UNDINIC %p Etherboot 5.4 workaround enabled\n",
711                        undinic );
712                 undinic->hacks |= UNDI_HACK_EB54;
713         }
714
715         /* Mark as link up; we don't handle link state */
716         netdev_link_up ( netdev );
717
718         /* Register network device */
719         if ( ( rc = register_netdev ( netdev ) ) != 0 )
720                 goto err_register;
721
722         DBGC ( undinic, "UNDINIC %p added\n", undinic );
723         return 0;
724
725  err_register:
726  err_undi_get_iface_info:
727  err_bad_irq:
728  err_undi_get_information:
729  err_undi_initialize:
730         /* Shut down UNDI stack */
731         memset ( &undi_shutdown, 0, sizeof ( undi_shutdown ) );
732         undinet_call ( undinic, PXENV_UNDI_SHUTDOWN, &undi_shutdown,
733                        sizeof ( undi_shutdown ) );
734         memset ( &undi_cleanup, 0, sizeof ( undi_cleanup ) );
735         undinet_call ( undinic, PXENV_UNDI_CLEANUP, &undi_cleanup,
736                        sizeof ( undi_cleanup ) );
737         undi->flags &= ~UNDI_FL_INITIALIZED;
738  err_undi_startup:
739         /* Unhook UNDI stack */
740         memset ( &stop_undi, 0, sizeof ( stop_undi ) );
741         undinet_call ( undinic, PXENV_STOP_UNDI, &stop_undi,
742                        sizeof ( stop_undi ) );
743         undi->flags &= ~UNDI_FL_STARTED;
744  err_start_undi:
745         netdev_nullify ( netdev );
746         netdev_put ( netdev );
747         undi_set_drvdata ( undi, NULL );
748         return rc;
749 }
750
751 /**
752  * Remove UNDI device
753  *
754  * @v undi              UNDI device
755  */
756 void undinet_remove ( struct undi_device *undi ) {
757         struct net_device *netdev = undi_get_drvdata ( undi );
758         struct undi_nic *undinic = netdev->priv;
759         struct s_PXENV_UNDI_SHUTDOWN undi_shutdown;
760         struct s_PXENV_UNDI_CLEANUP undi_cleanup;
761         struct s_PXENV_STOP_UNDI stop_undi;
762
763         /* Unregister net device */
764         unregister_netdev ( netdev );
765
766         /* If we are preparing for an OS boot, or if we cannot exit
767          * via the PXE stack, then shut down the PXE stack.
768          */
769         if ( ! ( undi->flags & UNDI_FL_KEEP_ALL ) ) {
770
771                 /* Shut down UNDI stack */
772                 memset ( &undi_shutdown, 0, sizeof ( undi_shutdown ) );
773                 undinet_call ( undinic, PXENV_UNDI_SHUTDOWN, &undi_shutdown,
774                                sizeof ( undi_shutdown ) );
775                 memset ( &undi_cleanup, 0, sizeof ( undi_cleanup ) );
776                 undinet_call ( undinic, PXENV_UNDI_CLEANUP, &undi_cleanup,
777                                sizeof ( undi_cleanup ) );
778                 undi->flags &= ~UNDI_FL_INITIALIZED;
779
780                 /* Unhook UNDI stack */
781                 memset ( &stop_undi, 0, sizeof ( stop_undi ) );
782                 undinet_call ( undinic, PXENV_STOP_UNDI, &stop_undi,
783                                sizeof ( stop_undi ) );
784                 undi->flags &= ~UNDI_FL_STARTED;
785         }
786
787         /* Clear entry point */
788         memset ( &undinet_entry_point, 0, sizeof ( undinet_entry_point ) );
789
790         /* Free network device */
791         netdev_nullify ( netdev );
792         netdev_put ( netdev );
793
794         DBGC ( undinic, "UNDINIC %p removed\n", undinic );
795 }