Use a common base-memory packet buffer for DHCP construction (as used
[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         /* Copy packet to UNDI I/O buffer */
337         if ( len > sizeof ( basemem_packet ) )
338                 len = sizeof ( basemem_packet );
339         memcpy ( &basemem_packet, iobuf->data, len );
340
341         /* Create PXENV_UNDI_TRANSMIT data structure */
342         memset ( &undi_transmit, 0, sizeof ( undi_transmit ) );
343         undi_transmit.DestAddr.segment = rm_ds;
344         undi_transmit.DestAddr.offset
345                 = ( ( unsigned ) & __from_data16 ( undinet_tbd ) );
346         undi_transmit.TBD.segment = rm_ds;
347         undi_transmit.TBD.offset
348                 = ( ( unsigned ) & __from_data16 ( undinet_tbd ) );
349
350         /* Create PXENV_UNDI_TBD data structure */
351         undinet_tbd.ImmedLength = len;
352         undinet_tbd.Xmit.segment = rm_ds;
353         undinet_tbd.Xmit.offset 
354                 = ( ( unsigned ) & __from_data16 ( basemem_packet ) );
355
356         /* Issue PXE API call */
357         if ( ( rc = undinet_call ( undinic, PXENV_UNDI_TRANSMIT,
358                                    &undi_transmit,
359                                    sizeof ( undi_transmit ) ) ) != 0 )
360                 goto done;
361
362         /* Free I/O buffer */
363         netdev_tx_complete ( netdev, iobuf );
364
365  done:
366         return rc;
367 }
368
369 /** 
370  * Poll for received packets
371  *
372  * @v netdev            Network device
373  * @v rx_quota          Maximum number of packets to receive
374  *
375  * Fun, fun, fun.  UNDI drivers don't use polling; they use
376  * interrupts.  We therefore cheat and pretend that an interrupt has
377  * occurred every time undinet_poll() is called.  This isn't too much
378  * of a hack; PCI devices share IRQs and so the first thing that a
379  * proper ISR should do is call PXENV_UNDI_ISR to determine whether or
380  * not the UNDI NIC generated the interrupt; there is no harm done by
381  * spurious calls to PXENV_UNDI_ISR.  Similarly, we wouldn't be
382  * handling them any more rapidly than the usual rate of
383  * undinet_poll() being called even if we did implement a full ISR.
384  * So it should work.  Ha!
385  *
386  * Addendum (21/10/03).  Some cards don't play nicely with this trick,
387  * so instead of doing it the easy way we have to go to all the hassle
388  * of installing a genuine interrupt service routine and dealing with
389  * the wonderful 8259 Programmable Interrupt Controller.  Joy.
390  */
391 static void undinet_poll ( struct net_device *netdev, unsigned int rx_quota ) {
392         struct undi_nic *undinic = netdev->priv;
393         struct s_PXENV_UNDI_ISR undi_isr;
394         struct io_buffer *iobuf = NULL;
395         size_t len;
396         size_t frag_len;
397         int rc;
398
399         if ( ! undinic->isr_processing ) {
400                 /* Do nothing unless ISR has been triggered */
401                 if ( ! undinet_isr_triggered() )
402                         return;
403
404                 /* See if this was our interrupt */
405                 memset ( &undi_isr, 0, sizeof ( undi_isr ) );
406                 undi_isr.FuncFlag = PXENV_UNDI_ISR_IN_START;
407                 if ( ( rc = undinet_call ( undinic, PXENV_UNDI_ISR, &undi_isr,
408                                            sizeof ( undi_isr ) ) ) != 0 )
409                         return;
410
411                 /* Send EOI to the PIC.  In an ideal world, we'd do
412                  * this only for interrupts which the UNDI stack
413                  * reports as "ours".  However, since we don't (can't)
414                  * chain to the previous interrupt handler, we have to
415                  * acknowledge all interrupts.  See undinet_hook_isr()
416                  * for more background.
417                  */
418                 send_eoi ( undinic->irq );
419
420                 /* If this wasn't our interrupt, exit now */
421                 if ( undi_isr.FuncFlag != PXENV_UNDI_ISR_OUT_OURS )
422                         return;
423                 
424                 /* Start ISR processing */
425                 undinic->isr_processing = 1;
426                 undi_isr.FuncFlag = PXENV_UNDI_ISR_IN_PROCESS;
427         } else {
428                 /* Continue ISR processing */
429                 undi_isr.FuncFlag = PXENV_UNDI_ISR_IN_GET_NEXT;
430         }
431
432         /* Run through the ISR loop */
433         while ( rx_quota ) {
434                 if ( ( rc = undinet_call ( undinic, PXENV_UNDI_ISR, &undi_isr,
435                                            sizeof ( undi_isr ) ) ) != 0 )
436                         break;
437                 switch ( undi_isr.FuncFlag ) {
438                 case PXENV_UNDI_ISR_OUT_TRANSMIT:
439                         /* We don't care about transmit completions */
440                         break;
441                 case PXENV_UNDI_ISR_OUT_RECEIVE:
442                         /* Packet fragment received */
443                         len = undi_isr.FrameLength;
444                         frag_len = undi_isr.BufferLength;
445                         if ( ! iobuf )
446                                 iobuf = alloc_iob ( len );
447                         if ( ! iobuf ) {
448                                 DBGC ( undinic, "UNDINIC %p could not "
449                                        "allocate %zd bytes for RX buffer\n",
450                                        undinic, len );
451                                 /* Fragment will be dropped */
452                                 goto done;
453                         }
454                         if ( frag_len > iob_tailroom ( iobuf ) ) {
455                                 DBGC ( undinic, "UNDINIC %p fragment too "
456                                        "large\n", undinic );
457                                 frag_len = iob_tailroom ( iobuf );
458                         }
459                         copy_from_real ( iob_put ( iobuf, frag_len ),
460                                          undi_isr.Frame.segment,
461                                          undi_isr.Frame.offset, frag_len );
462                         if ( iob_len ( iobuf ) == len ) {
463                                 netdev_rx ( netdev, iobuf );
464                                 iobuf = NULL;
465                                 --rx_quota;
466                         }
467                         break;
468                 case PXENV_UNDI_ISR_OUT_DONE:
469                         /* Processing complete */
470                         undinic->isr_processing = 0;
471                         goto done;
472                 default:
473                         /* Should never happen */
474                         DBGC ( undinic, "UNDINIC %p ISR returned invalid "
475                                "FuncFlag %04x\n", undinic, undi_isr.FuncFlag );
476                         undinic->isr_processing = 0;
477                         goto done;
478                 }
479                 undi_isr.FuncFlag = PXENV_UNDI_ISR_IN_GET_NEXT;
480         }
481
482  done:
483         if ( iobuf ) {
484                 DBGC ( undinic, "UNDINIC %p returned incomplete packet\n",
485                        undinic );
486                 netdev_rx ( netdev, iobuf );
487         }
488 }
489
490 /**
491  * Open NIC
492  *
493  * @v netdev            Net device
494  * @ret rc              Return status code
495  */
496 static int undinet_open ( struct net_device *netdev ) {
497         struct undi_nic *undinic = netdev->priv;
498         struct s_PXENV_UNDI_SET_STATION_ADDRESS undi_set_address;
499         struct s_PXENV_UNDI_OPEN undi_open;
500         int rc;
501
502         /* Hook interrupt service routine and enable interrupt */
503         undinet_hook_isr ( undinic->irq );
504         enable_irq ( undinic->irq );
505         send_eoi ( undinic->irq );
506
507         /* Set station address.  Required for some PXE stacks; will
508          * spuriously fail on others.  Ignore failures.  We only ever
509          * use it to set the MAC address to the card's permanent value
510          * anyway.
511          */
512         memcpy ( undi_set_address.StationAddress, netdev->ll_addr,
513                  sizeof ( undi_set_address.StationAddress ) );
514         undinet_call ( undinic, PXENV_UNDI_SET_STATION_ADDRESS,
515                        &undi_set_address, sizeof ( undi_set_address ) );
516
517         /* Open NIC */
518         memset ( &undi_open, 0, sizeof ( undi_open ) );
519         undi_open.PktFilter = ( FLTR_DIRECTED | FLTR_BRDCST );
520         if ( ( rc = undinet_call ( undinic, PXENV_UNDI_OPEN, &undi_open,
521                                    sizeof ( undi_open ) ) ) != 0 )
522                 goto err;
523
524         DBGC ( undinic, "UNDINIC %p opened\n", undinic );
525         return 0;
526
527  err:
528         undinet_close ( netdev );
529         return rc;
530 }
531
532 /**
533  * Close NIC
534  *
535  * @v netdev            Net device
536  */
537 static void undinet_close ( struct net_device *netdev ) {
538         struct undi_nic *undinic = netdev->priv;
539         struct s_PXENV_UNDI_ISR undi_isr;
540         struct s_PXENV_UNDI_CLOSE undi_close;
541         int rc;
542
543         /* Ensure ISR has exited cleanly */
544         while ( undinic->isr_processing ) {
545                 undi_isr.FuncFlag = PXENV_UNDI_ISR_IN_GET_NEXT;
546                 if ( ( rc = undinet_call ( undinic, PXENV_UNDI_ISR, &undi_isr,
547                                            sizeof ( undi_isr ) ) ) != 0 )
548                         break;
549                 switch ( undi_isr.FuncFlag ) {
550                 case PXENV_UNDI_ISR_OUT_TRANSMIT:
551                 case PXENV_UNDI_ISR_OUT_RECEIVE:
552                         /* Continue draining */
553                         break;
554                 default:
555                         /* Stop processing */
556                         undinic->isr_processing = 0;
557                         break;
558                 }
559         }
560
561         /* Close NIC */
562         undinet_call ( undinic, PXENV_UNDI_CLOSE, &undi_close,
563                        sizeof ( undi_close ) );
564
565         /* Disable interrupt and unhook ISR */
566         disable_irq ( undinic->irq );
567         undinet_unhook_isr ( undinic->irq );
568
569         DBGC ( undinic, "UNDINIC %p closed\n", undinic );
570 }
571
572 /**
573  * Probe UNDI device
574  *
575  * @v undi              UNDI device
576  * @ret rc              Return status code
577  */
578 int undinet_probe ( struct undi_device *undi ) {
579         struct net_device *netdev;
580         struct undi_nic *undinic;
581         struct s_PXENV_START_UNDI start_undi;
582         struct s_PXENV_UNDI_STARTUP undi_startup;
583         struct s_PXENV_UNDI_INITIALIZE undi_initialize;
584         struct s_PXENV_UNDI_GET_INFORMATION undi_info;
585         struct s_PXENV_UNDI_SHUTDOWN undi_shutdown;
586         struct s_PXENV_UNDI_CLEANUP undi_cleanup;
587         struct s_PXENV_STOP_UNDI stop_undi;
588         int rc;
589
590         /* Allocate net device */
591         netdev = alloc_etherdev ( sizeof ( *undinic ) );
592         if ( ! netdev )
593                 return -ENOMEM;
594         undinic = netdev->priv;
595         undi_set_drvdata ( undi, netdev );
596         netdev->dev = &undi->dev;
597         memset ( undinic, 0, sizeof ( *undinic ) );
598         undinic->entry = undi->entry;
599         DBGC ( undinic, "UNDINIC %p using UNDI %p\n", undinic, undi );
600
601         /* Hook in UNDI stack */
602         if ( ! ( undi->flags & UNDI_FL_STARTED ) ) {
603                 memset ( &start_undi, 0, sizeof ( start_undi ) );
604                 start_undi.AX = undi->pci_busdevfn;
605                 start_undi.BX = undi->isapnp_csn;
606                 start_undi.DX = undi->isapnp_read_port;
607                 start_undi.ES = BIOS_SEG;
608                 start_undi.DI = find_pnp_bios();
609                 if ( ( rc = undinet_call ( undinic, PXENV_START_UNDI,
610                                            &start_undi,
611                                            sizeof ( start_undi ) ) ) != 0 )
612                         goto err_start_undi;
613         }
614         undi->flags |= UNDI_FL_STARTED;
615
616         /* Bring up UNDI stack */
617         memset ( &undi_startup, 0, sizeof ( undi_startup ) );
618         if ( ( rc = undinet_call ( undinic, PXENV_UNDI_STARTUP, &undi_startup,
619                                    sizeof ( undi_startup ) ) ) != 0 )
620                 goto err_undi_startup;
621         memset ( &undi_initialize, 0, sizeof ( undi_initialize ) );
622         if ( ( rc = undinet_call ( undinic, PXENV_UNDI_INITIALIZE,
623                                    &undi_initialize,
624                                    sizeof ( undi_initialize ) ) ) != 0 )
625                 goto err_undi_initialize;
626
627         /* Get device information */
628         memset ( &undi_info, 0, sizeof ( undi_info ) );
629         if ( ( rc = undinet_call ( undinic, PXENV_UNDI_GET_INFORMATION,
630                                    &undi_info, sizeof ( undi_info ) ) ) != 0 )
631                 goto err_undi_get_information;
632         memcpy ( netdev->ll_addr, undi_info.PermNodeAddress, ETH_ALEN );
633         undinic->irq = undi_info.IntNumber;
634         if ( undinic->irq > IRQ_MAX ) {
635                 DBGC ( undinic, "UNDINIC %p invalid IRQ %d\n",
636                        undinic, undinic->irq );
637                 goto err_bad_irq;
638         }
639         DBGC ( undinic, "UNDINIC %p is %s on IRQ %d\n",
640                undinic, eth_ntoa ( netdev->ll_addr ), undinic->irq );
641
642         /* Point to NIC specific routines */
643         netdev->open     = undinet_open;
644         netdev->close    = undinet_close;
645         netdev->transmit = undinet_transmit;
646         netdev->poll     = undinet_poll;
647
648         /* Register network device */
649         if ( ( rc = register_netdev ( netdev ) ) != 0 )
650                 goto err_register;
651
652         DBGC ( undinic, "UNDINIC %p added\n", undinic );
653         return 0;
654
655  err_register:
656  err_bad_irq:
657  err_undi_get_information:
658  err_undi_initialize:
659         /* Shut down UNDI stack */
660         memset ( &undi_shutdown, 0, sizeof ( undi_shutdown ) );
661         undinet_call ( undinic, PXENV_UNDI_SHUTDOWN, &undi_shutdown,
662                        sizeof ( undi_shutdown ) );
663         memset ( &undi_cleanup, 0, sizeof ( undi_cleanup ) );
664         undinet_call ( undinic, PXENV_UNDI_CLEANUP, &undi_cleanup,
665                        sizeof ( undi_cleanup ) );
666  err_undi_startup:
667         /* Unhook UNDI stack */
668         memset ( &stop_undi, 0, sizeof ( stop_undi ) );
669         undinet_call ( undinic, PXENV_STOP_UNDI, &stop_undi,
670                        sizeof ( stop_undi ) );
671  err_start_undi:
672         netdev_put ( netdev );
673         undi_set_drvdata ( undi, NULL );
674         return rc;
675 }
676
677 /**
678  * Remove UNDI device
679  *
680  * @v undi              UNDI device
681  */
682 void undinet_remove ( struct undi_device *undi ) {
683         struct net_device *netdev = undi_get_drvdata ( undi );
684         struct undi_nic *undinic = netdev->priv;
685         struct s_PXENV_UNDI_SHUTDOWN undi_shutdown;
686         struct s_PXENV_UNDI_CLEANUP undi_cleanup;
687         struct s_PXENV_STOP_UNDI stop_undi;
688
689         /* Unregister net device */
690         unregister_netdev ( netdev );
691
692         /* Shut down UNDI stack */
693         memset ( &undi_shutdown, 0, sizeof ( undi_shutdown ) );
694         undinet_call ( undinic, PXENV_UNDI_SHUTDOWN, &undi_shutdown,
695                        sizeof ( undi_shutdown ) );
696         memset ( &undi_cleanup, 0, sizeof ( undi_cleanup ) );
697         undinet_call ( undinic, PXENV_UNDI_CLEANUP, &undi_cleanup,
698                        sizeof ( undi_cleanup ) );
699
700         /* Unhook UNDI stack */
701         memset ( &stop_undi, 0, sizeof ( stop_undi ) );
702         undinet_call ( undinic, PXENV_STOP_UNDI, &stop_undi,
703                        sizeof ( stop_undi ) );
704         undi->flags &= ~UNDI_FL_STARTED;
705
706         /* Free network device */
707         netdev_put ( netdev );
708
709         DBGC ( undinic, "UNDINIC %p removed\n", undinic );
710 }