It's not just Etherboot that fails to generate TX completions.
[people/holger/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/iobuf.h>
27 #include <gpxe/netdevice.h>
28 #include <gpxe/if_ether.h>
29 #include <gpxe/ethernet.h>
30 #include <undi.h>
31 #include <undinet.h>
32
33
34 /** @file
35  *
36  * UNDI network device driver
37  *
38  */
39
40 /** An UNDI NIC */
41 struct undi_nic {
42         /** Entry point */
43         SEGOFF16_t entry;
44         /** Assigned IRQ number */
45         unsigned int irq;
46         /** Currently processing ISR */
47         int isr_processing;
48 };
49
50 static void undinet_close ( struct net_device *netdev );
51
52 /*****************************************************************************
53  *
54  * UNDI API call
55  *
56  *****************************************************************************
57  */
58
59 /**
60  * Name UNDI API call
61  *
62  * @v function          API call number
63  * @ret name            API call name
64  */
65 static inline __attribute__ (( always_inline )) const char *
66 undinet_function_name ( unsigned int function ) {
67         switch ( function ) {
68         case PXENV_START_UNDI:
69                 return "PXENV_START_UNDI";
70         case PXENV_STOP_UNDI:
71                 return "PXENV_STOP_UNDI";
72         case PXENV_UNDI_STARTUP:
73                 return "PXENV_UNDI_STARTUP";
74         case PXENV_UNDI_CLEANUP:
75                 return "PXENV_UNDI_CLEANUP";
76         case PXENV_UNDI_INITIALIZE:
77                 return "PXENV_UNDI_INITIALIZE";
78         case PXENV_UNDI_RESET_ADAPTER:
79                 return "PXENV_UNDI_RESET_ADAPTER";
80         case PXENV_UNDI_SHUTDOWN:
81                 return "PXENV_UNDI_SHUTDOWN";
82         case PXENV_UNDI_OPEN:
83                 return "PXENV_UNDI_OPEN";
84         case PXENV_UNDI_CLOSE:
85                 return "PXENV_UNDI_CLOSE";
86         case PXENV_UNDI_TRANSMIT:
87                 return "PXENV_UNDI_TRANSMIT";
88         case PXENV_UNDI_SET_MCAST_ADDRESS:
89                 return "PXENV_UNDI_SET_MCAST_ADDRESS";
90         case PXENV_UNDI_SET_STATION_ADDRESS:
91                 return "PXENV_UNDI_SET_STATION_ADDRESS";
92         case PXENV_UNDI_SET_PACKET_FILTER:
93                 return "PXENV_UNDI_SET_PACKET_FILTER";
94         case PXENV_UNDI_GET_INFORMATION:
95                 return "PXENV_UNDI_GET_INFORMATION";
96         case PXENV_UNDI_GET_STATISTICS:
97                 return "PXENV_UNDI_GET_STATISTICS";
98         case PXENV_UNDI_CLEAR_STATISTICS:
99                 return "PXENV_UNDI_CLEAR_STATISTICS";
100         case PXENV_UNDI_INITIATE_DIAGS:
101                 return "PXENV_UNDI_INITIATE_DIAGS";
102         case PXENV_UNDI_FORCE_INTERRUPT:
103                 return "PXENV_UNDI_FORCE_INTERRUPT";
104         case PXENV_UNDI_GET_MCAST_ADDRESS:
105                 return "PXENV_UNDI_GET_MCAST_ADDRESS";
106         case PXENV_UNDI_GET_NIC_TYPE:
107                 return "PXENV_UNDI_GET_NIC_TYPE";
108         case PXENV_UNDI_GET_IFACE_INFO:
109                 return "PXENV_UNDI_GET_IFACE_INFO";
110         /*
111          * Duplicate case value; this is a bug in the PXE specification.
112          *
113          *      case PXENV_UNDI_GET_STATE:
114          *              return "PXENV_UNDI_GET_STATE";
115          */
116         case PXENV_UNDI_ISR:
117                 return "PXENV_UNDI_ISR";
118         default:
119                 return "UNKNOWN API CALL";
120         }
121 }
122
123 /**
124  * UNDI parameter block
125  *
126  * Used as the paramter block for all UNDI API calls.  Resides in base
127  * memory.
128  */
129 static union u_PXENV_ANY __data16 ( undinet_params );
130 #define undinet_params __use_data16 ( undinet_params )
131
132 /** UNDI entry point
133  *
134  * Used as the indirection vector for all UNDI API calls.  Resides in
135  * base memory.
136  */
137 static SEGOFF16_t __data16 ( undinet_entry_point );
138 #define undinet_entry_point __use_data16 ( undinet_entry_point )
139
140 /**
141  * Issue UNDI API call
142  *
143  * @v undinic           UNDI NIC
144  * @v function          API call number
145  * @v params            UNDI parameter block
146  * @v params_len        Length of UNDI parameter block
147  * @ret rc              Return status code
148  */
149 static int undinet_call ( struct undi_nic *undinic, unsigned int function,
150                           void *params, size_t params_len ) {
151         PXENV_EXIT_t exit;
152         int discard_b, discard_D;
153         int rc;
154
155         /* Copy parameter block and entry point */
156         assert ( params_len <= sizeof ( undinet_params ) );
157         memcpy ( &undinet_params, params, params_len );
158         undinet_entry_point = undinic->entry;
159
160         /* Call real-mode entry point.  This calling convention will
161          * work with both the !PXE and the PXENV+ entry points.
162          */
163         __asm__ __volatile__ ( REAL_CODE ( "pushw %%es\n\t"
164                                            "pushw %%di\n\t"
165                                            "pushw %%bx\n\t"
166                                            "lcall *%c3\n\t"
167                                            "addw $6, %%sp\n\t" )
168                                : "=a" ( exit ), "=b" ( discard_b ),
169                                  "=D" ( discard_D )
170                                : "p" ( &__from_data16 ( undinet_entry_point )),
171                                  "b" ( function ),
172                                  "D" ( &__from_data16 ( undinet_params ) )
173                                : "ecx", "edx", "esi", "ebp" );
174
175         /* UNDI API calls may rudely change the status of A20 and not
176          * bother to restore it afterwards.  Intel is known to be
177          * guilty of this.
178          *
179          * Note that we will return to this point even if A20 gets
180          * screwed up by the UNDI driver, because Etherboot always
181          * resides in an even megabyte of RAM.
182          */     
183         gateA20_set();
184
185         /* Determine return status code based on PXENV_EXIT and
186          * PXENV_STATUS
187          */
188         if ( exit == PXENV_EXIT_SUCCESS ) {
189                 rc = 0;
190         } else {
191                 rc = -undinet_params.Status;
192                 /* Paranoia; don't return success for the combination
193                  * of PXENV_EXIT_FAILURE but PXENV_STATUS_SUCCESS
194                  */
195                 if ( rc == 0 )
196                         rc = -EIO;
197         }
198
199         /* If anything goes wrong, print as much debug information as
200          * it's possible to give.
201          */
202         if ( rc != 0 ) {
203                 SEGOFF16_t rm_params = {
204                         .segment = rm_ds,
205                         .offset = (intptr_t) &__from_data16 ( undinet_params ),
206                 };
207
208                 DBGC ( undinic, "UNDINIC %p %s failed: %s\n", undinic,
209                        undinet_function_name ( function ), strerror ( rc ) );
210                 DBGC ( undinic, "UNDINIC %p parameters at %04x:%04x length "
211                        "%#02x, entry point at %04x:%04x\n", undinic,
212                        rm_params.segment, rm_params.offset, params_len,
213                        undinic->entry.segment, undinic->entry.offset );
214                 DBGC ( undinic, "UNDINIC %p parameters provided:\n", undinic );
215                 DBGC_HDA ( undinic, rm_params, params, params_len );
216                 DBGC ( undinic, "UNDINIC %p parameters returned:\n", undinic );
217                 DBGC_HDA ( undinic, rm_params, &undinet_params, params_len );
218         }
219
220         /* Copy parameter block back */
221         memcpy ( params, &undinet_params, params_len );
222
223         return rc;
224 }
225
226 /*****************************************************************************
227  *
228  * UNDI interrupt service routine
229  *
230  *****************************************************************************
231  */
232
233 /**
234  * UNDI interrupt service routine
235  *
236  * The UNDI ISR simply increments a counter (@c trigger_count) and
237  * exits.
238  */
239 extern void undinet_isr ( void );
240
241 /** Dummy chain vector */
242 static struct segoff prev_handler[ IRQ_MAX + 1 ];
243
244 /** IRQ trigger count */
245 static volatile uint8_t __text16 ( trigger_count ) = 0;
246 #define trigger_count __use_text16 ( trigger_count )
247
248 /**
249  * Hook UNDI interrupt service routine
250  *
251  * @v irq               IRQ number
252  *
253  * The UNDI ISR specifically does @b not chain to the previous
254  * interrupt handler.  BIOSes seem to install somewhat perverse
255  * default interrupt handlers; some do nothing other than an iret (and
256  * so will cause a screaming interrupt if there really is another
257  * interrupting device) and some disable the interrupt at the PIC (and
258  * so will bring our own interrupts to a shuddering halt).
259  */
260 static void undinet_hook_isr ( unsigned int irq ) {
261
262         assert ( irq <= IRQ_MAX );
263
264         __asm__ __volatile__ ( TEXT16_CODE ( "\nundinet_isr:\n\t"
265                                              "incb %%cs:%c0\n\t"
266                                              "iret\n\t" )
267                                : : "p" ( & __from_text16 ( trigger_count ) ) );
268
269         hook_bios_interrupt ( IRQ_INT ( irq ),
270                               ( ( unsigned int ) undinet_isr ),
271                               &prev_handler[irq] );
272
273 }
274
275 /**
276  * Unhook UNDI interrupt service routine
277  *
278  * @v irq               IRQ number
279  */
280 static void undinet_unhook_isr ( unsigned int irq ) {
281
282         assert ( irq <= IRQ_MAX );
283
284         unhook_bios_interrupt ( IRQ_INT ( irq ),
285                                 ( ( unsigned int ) undinet_isr ),
286                                 &prev_handler[irq] );
287 }
288
289 /**
290  * Test to see if UNDI ISR has been triggered
291  *
292  * @ret triggered       ISR has been triggered since last check
293  */
294 static int undinet_isr_triggered ( void ) {
295         static unsigned int last_trigger_count = 0;
296         unsigned int this_trigger_count;
297
298         /* Read trigger_count.  Do this only once; it is volatile */
299         this_trigger_count = trigger_count;
300
301         if ( this_trigger_count == last_trigger_count ) {
302                 /* Not triggered */
303                 return 0;
304         } else {
305                 /* Triggered */
306                 last_trigger_count = this_trigger_count;
307                 return 1;
308         }
309 }
310
311 /*****************************************************************************
312  *
313  * UNDI network device interface
314  *
315  *****************************************************************************
316  */
317
318 /** UNDI transmit buffer descriptor */
319 static struct s_PXENV_UNDI_TBD __data16 ( undinet_tbd );
320 #define undinet_tbd __use_data16 ( undinet_tbd )
321
322 /**
323  * Transmit packet
324  *
325  * @v netdev            Network device
326  * @v iobuf             I/O buffer
327  * @ret rc              Return status code
328  */
329 static int undinet_transmit ( struct net_device *netdev,
330                               struct io_buffer *iobuf ) {
331         struct undi_nic *undinic = netdev->priv;
332         struct s_PXENV_UNDI_TRANSMIT undi_transmit;
333         size_t len = iob_len ( iobuf );
334         int rc;
335
336         /* Technically, we ought to make sure that the previous
337          * transmission has completed before we re-use the buffer.
338          * However, many PXE stacks (including at least some Intel PXE
339          * stacks and Etherboot 5.4) fail to generate TX completions.
340          * In practice this won't be a problem, since our TX datapath
341          * has a very low packet volume and we can get away with
342          * assuming that a TX will be complete by the time we want to
343          * transmit the next packet.
344          */
345
346         /* Copy packet to UNDI I/O buffer */
347         if ( len > sizeof ( basemem_packet ) )
348                 len = sizeof ( basemem_packet );
349         memcpy ( &basemem_packet, iobuf->data, len );
350
351         /* Create PXENV_UNDI_TRANSMIT data structure */
352         memset ( &undi_transmit, 0, sizeof ( undi_transmit ) );
353         undi_transmit.DestAddr.segment = rm_ds;
354         undi_transmit.DestAddr.offset
355                 = ( ( unsigned ) & __from_data16 ( undinet_tbd ) );
356         undi_transmit.TBD.segment = rm_ds;
357         undi_transmit.TBD.offset
358                 = ( ( unsigned ) & __from_data16 ( undinet_tbd ) );
359
360         /* Create PXENV_UNDI_TBD data structure */
361         undinet_tbd.ImmedLength = len;
362         undinet_tbd.Xmit.segment = rm_ds;
363         undinet_tbd.Xmit.offset 
364                 = ( ( unsigned ) & __from_data16 ( basemem_packet ) );
365
366         /* Issue PXE API call */
367         if ( ( rc = undinet_call ( undinic, PXENV_UNDI_TRANSMIT,
368                                    &undi_transmit,
369                                    sizeof ( undi_transmit ) ) ) != 0 )
370                 goto done;
371
372         /* Free I/O buffer */
373         netdev_tx_complete ( netdev, iobuf );
374
375  done:
376         return rc;
377 }
378
379 /** 
380  * Poll for received packets
381  *
382  * @v netdev            Network device
383  * @v rx_quota          Maximum number of packets to receive
384  *
385  * Fun, fun, fun.  UNDI drivers don't use polling; they use
386  * interrupts.  We therefore cheat and pretend that an interrupt has
387  * occurred every time undinet_poll() is called.  This isn't too much
388  * of a hack; PCI devices share IRQs and so the first thing that a
389  * proper ISR should do is call PXENV_UNDI_ISR to determine whether or
390  * not the UNDI NIC generated the interrupt; there is no harm done by
391  * spurious calls to PXENV_UNDI_ISR.  Similarly, we wouldn't be
392  * handling them any more rapidly than the usual rate of
393  * undinet_poll() being called even if we did implement a full ISR.
394  * So it should work.  Ha!
395  *
396  * Addendum (21/10/03).  Some cards don't play nicely with this trick,
397  * so instead of doing it the easy way we have to go to all the hassle
398  * of installing a genuine interrupt service routine and dealing with
399  * the wonderful 8259 Programmable Interrupt Controller.  Joy.
400  */
401 static void undinet_poll ( struct net_device *netdev, unsigned int rx_quota ) {
402         struct undi_nic *undinic = netdev->priv;
403         struct s_PXENV_UNDI_ISR undi_isr;
404         struct io_buffer *iobuf = NULL;
405         size_t len;
406         size_t frag_len;
407         int rc;
408
409         if ( ! undinic->isr_processing ) {
410                 /* Do nothing unless ISR has been triggered */
411                 if ( ! undinet_isr_triggered() )
412                         return;
413
414                 /* See if this was our interrupt */
415                 memset ( &undi_isr, 0, sizeof ( undi_isr ) );
416                 undi_isr.FuncFlag = PXENV_UNDI_ISR_IN_START;
417                 if ( ( rc = undinet_call ( undinic, PXENV_UNDI_ISR, &undi_isr,
418                                            sizeof ( undi_isr ) ) ) != 0 )
419                         return;
420
421                 /* Send EOI to the PIC.  In an ideal world, we'd do
422                  * this only for interrupts which the UNDI stack
423                  * reports as "ours".  However, since we don't (can't)
424                  * chain to the previous interrupt handler, we have to
425                  * acknowledge all interrupts.  See undinet_hook_isr()
426                  * for more background.
427                  */
428                 send_eoi ( undinic->irq );
429
430                 /* If this wasn't our interrupt, exit now */
431                 if ( undi_isr.FuncFlag != PXENV_UNDI_ISR_OUT_OURS )
432                         return;
433                 
434                 /* Start ISR processing */
435                 undinic->isr_processing = 1;
436                 undi_isr.FuncFlag = PXENV_UNDI_ISR_IN_PROCESS;
437         } else {
438                 /* Continue ISR processing */
439                 undi_isr.FuncFlag = PXENV_UNDI_ISR_IN_GET_NEXT;
440         }
441
442         /* Run through the ISR loop */
443         while ( rx_quota ) {
444                 if ( ( rc = undinet_call ( undinic, PXENV_UNDI_ISR, &undi_isr,
445                                            sizeof ( undi_isr ) ) ) != 0 )
446                         break;
447                 switch ( undi_isr.FuncFlag ) {
448                 case PXENV_UNDI_ISR_OUT_TRANSMIT:
449                         /* We don't care about transmit completions */
450                         break;
451                 case PXENV_UNDI_ISR_OUT_RECEIVE:
452                         /* Packet fragment received */
453                         len = undi_isr.FrameLength;
454                         frag_len = undi_isr.BufferLength;
455                         if ( ! iobuf )
456                                 iobuf = alloc_iob ( len );
457                         if ( ! iobuf ) {
458                                 DBGC ( undinic, "UNDINIC %p could not "
459                                        "allocate %zd bytes for RX buffer\n",
460                                        undinic, len );
461                                 /* Fragment will be dropped */
462                                 goto done;
463                         }
464                         if ( frag_len > iob_tailroom ( iobuf ) ) {
465                                 DBGC ( undinic, "UNDINIC %p fragment too "
466                                        "large\n", undinic );
467                                 frag_len = iob_tailroom ( iobuf );
468                         }
469                         copy_from_real ( iob_put ( iobuf, frag_len ),
470                                          undi_isr.Frame.segment,
471                                          undi_isr.Frame.offset, frag_len );
472                         if ( iob_len ( iobuf ) == len ) {
473                                 netdev_rx ( netdev, iobuf );
474                                 iobuf = NULL;
475                                 --rx_quota;
476                         }
477                         break;
478                 case PXENV_UNDI_ISR_OUT_DONE:
479                         /* Processing complete */
480                         undinic->isr_processing = 0;
481                         goto done;
482                 default:
483                         /* Should never happen */
484                         DBGC ( undinic, "UNDINIC %p ISR returned invalid "
485                                "FuncFlag %04x\n", undinic, undi_isr.FuncFlag );
486                         undinic->isr_processing = 0;
487                         goto done;
488                 }
489                 undi_isr.FuncFlag = PXENV_UNDI_ISR_IN_GET_NEXT;
490         }
491
492  done:
493         if ( iobuf ) {
494                 DBGC ( undinic, "UNDINIC %p returned incomplete packet\n",
495                        undinic );
496                 netdev_rx ( netdev, iobuf );
497         }
498 }
499
500 /**
501  * Open NIC
502  *
503  * @v netdev            Net device
504  * @ret rc              Return status code
505  */
506 static int undinet_open ( struct net_device *netdev ) {
507         struct undi_nic *undinic = netdev->priv;
508         struct s_PXENV_UNDI_SET_STATION_ADDRESS undi_set_address;
509         struct s_PXENV_UNDI_OPEN undi_open;
510         int rc;
511
512         /* Hook interrupt service routine and enable interrupt */
513         undinet_hook_isr ( undinic->irq );
514         enable_irq ( undinic->irq );
515         send_eoi ( undinic->irq );
516
517         /* Set station address.  Required for some PXE stacks; will
518          * spuriously fail on others.  Ignore failures.  We only ever
519          * use it to set the MAC address to the card's permanent value
520          * anyway.
521          */
522         memcpy ( undi_set_address.StationAddress, netdev->ll_addr,
523                  sizeof ( undi_set_address.StationAddress ) );
524         undinet_call ( undinic, PXENV_UNDI_SET_STATION_ADDRESS,
525                        &undi_set_address, sizeof ( undi_set_address ) );
526
527         /* Open NIC */
528         memset ( &undi_open, 0, sizeof ( undi_open ) );
529         undi_open.PktFilter = ( FLTR_DIRECTED | FLTR_BRDCST );
530         if ( ( rc = undinet_call ( undinic, PXENV_UNDI_OPEN, &undi_open,
531                                    sizeof ( undi_open ) ) ) != 0 )
532                 goto err;
533
534         DBGC ( undinic, "UNDINIC %p opened\n", undinic );
535         return 0;
536
537  err:
538         undinet_close ( netdev );
539         return rc;
540 }
541
542 /**
543  * Close NIC
544  *
545  * @v netdev            Net device
546  */
547 static void undinet_close ( struct net_device *netdev ) {
548         struct undi_nic *undinic = netdev->priv;
549         struct s_PXENV_UNDI_ISR undi_isr;
550         struct s_PXENV_UNDI_CLOSE undi_close;
551         int rc;
552
553         /* Ensure ISR has exited cleanly */
554         while ( undinic->isr_processing ) {
555                 undi_isr.FuncFlag = PXENV_UNDI_ISR_IN_GET_NEXT;
556                 if ( ( rc = undinet_call ( undinic, PXENV_UNDI_ISR, &undi_isr,
557                                            sizeof ( undi_isr ) ) ) != 0 )
558                         break;
559                 switch ( undi_isr.FuncFlag ) {
560                 case PXENV_UNDI_ISR_OUT_TRANSMIT:
561                 case PXENV_UNDI_ISR_OUT_RECEIVE:
562                         /* Continue draining */
563                         break;
564                 default:
565                         /* Stop processing */
566                         undinic->isr_processing = 0;
567                         break;
568                 }
569         }
570
571         /* Close NIC */
572         undinet_call ( undinic, PXENV_UNDI_CLOSE, &undi_close,
573                        sizeof ( undi_close ) );
574
575         /* Disable interrupt and unhook ISR */
576         disable_irq ( undinic->irq );
577         undinet_unhook_isr ( undinic->irq );
578
579         DBGC ( undinic, "UNDINIC %p closed\n", undinic );
580 }
581
582 /**
583  * Probe UNDI device
584  *
585  * @v undi              UNDI device
586  * @ret rc              Return status code
587  */
588 int undinet_probe ( struct undi_device *undi ) {
589         struct net_device *netdev;
590         struct undi_nic *undinic;
591         struct s_PXENV_START_UNDI start_undi;
592         struct s_PXENV_UNDI_STARTUP undi_startup;
593         struct s_PXENV_UNDI_INITIALIZE undi_initialize;
594         struct s_PXENV_UNDI_GET_INFORMATION undi_info;
595         struct s_PXENV_UNDI_SHUTDOWN undi_shutdown;
596         struct s_PXENV_UNDI_CLEANUP undi_cleanup;
597         struct s_PXENV_STOP_UNDI stop_undi;
598         int rc;
599
600         /* Allocate net device */
601         netdev = alloc_etherdev ( sizeof ( *undinic ) );
602         if ( ! netdev )
603                 return -ENOMEM;
604         undinic = netdev->priv;
605         undi_set_drvdata ( undi, netdev );
606         netdev->dev = &undi->dev;
607         memset ( undinic, 0, sizeof ( *undinic ) );
608         undinic->entry = undi->entry;
609         DBGC ( undinic, "UNDINIC %p using UNDI %p\n", undinic, undi );
610
611         /* Hook in UNDI stack */
612         if ( ! ( undi->flags & UNDI_FL_STARTED ) ) {
613                 memset ( &start_undi, 0, sizeof ( start_undi ) );
614                 start_undi.AX = undi->pci_busdevfn;
615                 start_undi.BX = undi->isapnp_csn;
616                 start_undi.DX = undi->isapnp_read_port;
617                 start_undi.ES = BIOS_SEG;
618                 start_undi.DI = find_pnp_bios();
619                 if ( ( rc = undinet_call ( undinic, PXENV_START_UNDI,
620                                            &start_undi,
621                                            sizeof ( start_undi ) ) ) != 0 )
622                         goto err_start_undi;
623         }
624         undi->flags |= UNDI_FL_STARTED;
625
626         /* Bring up UNDI stack */
627         memset ( &undi_startup, 0, sizeof ( undi_startup ) );
628         if ( ( rc = undinet_call ( undinic, PXENV_UNDI_STARTUP, &undi_startup,
629                                    sizeof ( undi_startup ) ) ) != 0 )
630                 goto err_undi_startup;
631         memset ( &undi_initialize, 0, sizeof ( undi_initialize ) );
632         if ( ( rc = undinet_call ( undinic, PXENV_UNDI_INITIALIZE,
633                                    &undi_initialize,
634                                    sizeof ( undi_initialize ) ) ) != 0 )
635                 goto err_undi_initialize;
636
637         /* Get device information */
638         memset ( &undi_info, 0, sizeof ( undi_info ) );
639         if ( ( rc = undinet_call ( undinic, PXENV_UNDI_GET_INFORMATION,
640                                    &undi_info, sizeof ( undi_info ) ) ) != 0 )
641                 goto err_undi_get_information;
642         memcpy ( netdev->ll_addr, undi_info.PermNodeAddress, ETH_ALEN );
643         undinic->irq = undi_info.IntNumber;
644         if ( undinic->irq > IRQ_MAX ) {
645                 DBGC ( undinic, "UNDINIC %p invalid IRQ %d\n",
646                        undinic, undinic->irq );
647                 goto err_bad_irq;
648         }
649         DBGC ( undinic, "UNDINIC %p is %s on IRQ %d\n",
650                undinic, eth_ntoa ( netdev->ll_addr ), undinic->irq );
651
652         /* Point to NIC specific routines */
653         netdev->open     = undinet_open;
654         netdev->close    = undinet_close;
655         netdev->transmit = undinet_transmit;
656         netdev->poll     = undinet_poll;
657
658         /* Register network device */
659         if ( ( rc = register_netdev ( netdev ) ) != 0 )
660                 goto err_register;
661
662         DBGC ( undinic, "UNDINIC %p added\n", undinic );
663         return 0;
664
665  err_register:
666  err_bad_irq:
667  err_undi_get_information:
668  err_undi_initialize:
669         /* Shut down UNDI stack */
670         memset ( &undi_shutdown, 0, sizeof ( undi_shutdown ) );
671         undinet_call ( undinic, PXENV_UNDI_SHUTDOWN, &undi_shutdown,
672                        sizeof ( undi_shutdown ) );
673         memset ( &undi_cleanup, 0, sizeof ( undi_cleanup ) );
674         undinet_call ( undinic, PXENV_UNDI_CLEANUP, &undi_cleanup,
675                        sizeof ( undi_cleanup ) );
676  err_undi_startup:
677         /* Unhook UNDI stack */
678         memset ( &stop_undi, 0, sizeof ( stop_undi ) );
679         undinet_call ( undinic, PXENV_STOP_UNDI, &stop_undi,
680                        sizeof ( stop_undi ) );
681  err_start_undi:
682         netdev_put ( netdev );
683         undi_set_drvdata ( undi, NULL );
684         return rc;
685 }
686
687 /**
688  * Remove UNDI device
689  *
690  * @v undi              UNDI device
691  */
692 void undinet_remove ( struct undi_device *undi ) {
693         struct net_device *netdev = undi_get_drvdata ( undi );
694         struct undi_nic *undinic = netdev->priv;
695         struct s_PXENV_UNDI_SHUTDOWN undi_shutdown;
696         struct s_PXENV_UNDI_CLEANUP undi_cleanup;
697         struct s_PXENV_STOP_UNDI stop_undi;
698
699         /* Unregister net device */
700         unregister_netdev ( netdev );
701
702         /* Shut down UNDI stack */
703         memset ( &undi_shutdown, 0, sizeof ( undi_shutdown ) );
704         undinet_call ( undinic, PXENV_UNDI_SHUTDOWN, &undi_shutdown,
705                        sizeof ( undi_shutdown ) );
706         memset ( &undi_cleanup, 0, sizeof ( undi_cleanup ) );
707         undinet_call ( undinic, PXENV_UNDI_CLEANUP, &undi_cleanup,
708                        sizeof ( undi_cleanup ) );
709
710         /* Unhook UNDI stack */
711         memset ( &stop_undi, 0, sizeof ( stop_undi ) );
712         undinet_call ( undinic, PXENV_STOP_UNDI, &stop_undi,
713                        sizeof ( stop_undi ) );
714         undi->flags &= ~UNDI_FL_STARTED;
715
716         /* Free network device */
717         netdev_put ( netdev );
718
719         DBGC ( undinic, "UNDINIC %p removed\n", undinic );
720 }