2 * Copyright (C) 2007 Michael Brown <mbrown@fensystems.co.uk>.
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.
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.
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.
25 #include <gpxe/pkbuff.h>
26 #include <gpxe/netdevice.h>
27 #include <gpxe/if_ether.h>
28 #include <gpxe/ethernet.h>
35 * UNDI network device driver
43 /** Assigned IRQ number */
45 /** Currently processing ISR */
49 static void undinet_close ( struct net_device *netdev );
51 /*****************************************************************************
55 *****************************************************************************
61 * @v function API call number
62 * @ret name API call name
64 static inline __attribute__ (( always_inline )) const char *
65 undinet_function_name ( unsigned int function ) {
67 case PXENV_START_UNDI:
68 return "PXENV_START_UNDI";
70 return "PXENV_STOP_UNDI";
71 case PXENV_UNDI_STARTUP:
72 return "PXENV_UNDI_STARTUP";
73 case PXENV_UNDI_CLEANUP:
74 return "PXENV_UNDI_CLEANUP";
75 case PXENV_UNDI_INITIALIZE:
76 return "PXENV_UNDI_INITIALIZE";
77 case PXENV_UNDI_RESET_ADAPTER:
78 return "PXENV_UNDI_RESET_ADAPTER";
79 case PXENV_UNDI_SHUTDOWN:
80 return "PXENV_UNDI_SHUTDOWN";
82 return "PXENV_UNDI_OPEN";
83 case PXENV_UNDI_CLOSE:
84 return "PXENV_UNDI_CLOSE";
85 case PXENV_UNDI_TRANSMIT:
86 return "PXENV_UNDI_TRANSMIT";
87 case PXENV_UNDI_SET_MCAST_ADDRESS:
88 return "PXENV_UNDI_SET_MCAST_ADDRESS";
89 case PXENV_UNDI_SET_STATION_ADDRESS:
90 return "PXENV_UNDI_SET_STATION_ADDRESS";
91 case PXENV_UNDI_SET_PACKET_FILTER:
92 return "PXENV_UNDI_SET_PACKET_FILTER";
93 case PXENV_UNDI_GET_INFORMATION:
94 return "PXENV_UNDI_GET_INFORMATION";
95 case PXENV_UNDI_GET_STATISTICS:
96 return "PXENV_UNDI_GET_STATISTICS";
97 case PXENV_UNDI_CLEAR_STATISTICS:
98 return "PXENV_UNDI_CLEAR_STATISTICS";
99 case PXENV_UNDI_INITIATE_DIAGS:
100 return "PXENV_UNDI_INITIATE_DIAGS";
101 case PXENV_UNDI_FORCE_INTERRUPT:
102 return "PXENV_UNDI_FORCE_INTERRUPT";
103 case PXENV_UNDI_GET_MCAST_ADDRESS:
104 return "PXENV_UNDI_GET_MCAST_ADDRESS";
105 case PXENV_UNDI_GET_NIC_TYPE:
106 return "PXENV_UNDI_GET_NIC_TYPE";
107 case PXENV_UNDI_GET_IFACE_INFO:
108 return "PXENV_UNDI_GET_IFACE_INFO";
110 * Duplicate case value; this is a bug in the PXE specification.
112 * case PXENV_UNDI_GET_STATE:
113 * return "PXENV_UNDI_GET_STATE";
116 return "PXENV_UNDI_ISR";
118 return "UNKNOWN API CALL";
123 * UNDI parameter block
125 * Used as the paramter block for all UNDI API calls. Resides in base
128 static union u_PXENV_ANY __data16 ( undinet_params );
129 #define undinet_params __use_data16 ( undinet_params )
133 * Used as the indirection vector for all UNDI API calls. Resides in
136 static SEGOFF16_t __data16 ( undinet_entry_point );
137 #define undinet_entry_point __use_data16 ( undinet_entry_point )
140 * Issue UNDI API call
142 * @v undinic UNDI NIC
143 * @v function API call number
144 * @v params UNDI parameter block
145 * @v params_len Length of UNDI parameter block
146 * @ret rc Return status code
148 static int undinet_call ( struct undi_nic *undinic, unsigned int function,
149 void *params, size_t params_len ) {
150 union u_PXENV_ANY *pxenv_any = params;
152 int discard_b, discard_D;
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;
160 /* Call real-mode entry point. This calling convention will
161 * work with both the !PXE and the PXENV+ entry points.
163 __asm__ __volatile__ ( REAL_CODE ( "pushw %%es\n\t"
167 "addw $6, %%sp\n\t" )
168 : "=a" ( exit ), "=b" ( discard_b ),
170 : "p" ( &__from_data16 ( undinet_entry_point )),
172 "D" ( &__from_data16 ( undinet_params ) )
173 : "ecx", "edx", "esi", "ebp" );
175 /* UNDI API calls may rudely change the status of A20 and not
176 * bother to restore it afterwards. Intel is known to be
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.
185 /* Copy parameter block back */
186 memcpy ( params, &undinet_params, params_len );
188 /* Determine return status code based on PXENV_EXIT and
191 if ( exit == PXENV_EXIT_SUCCESS ) {
194 rc = -pxenv_any->Status;
195 /* Paranoia; don't return success for the combination
196 * of PXENV_EXIT_FAILURE but PXENV_STATUS_SUCCESS
203 DBGC ( undinic, "UNDINIC %p %s failed: %s\n", undinic,
204 undinet_function_name ( function ), strerror ( rc ) );
209 /*****************************************************************************
211 * UNDI interrupt service routine
213 *****************************************************************************
217 * UNDI interrupt service routine
219 * The UNDI ISR simply increments a counter (@c trigger_count) and
222 extern void undinet_isr ( void );
224 /** Dummy chain vector */
225 static struct segoff prev_handler[ IRQ_MAX + 1 ];
227 /** IRQ trigger count */
228 static volatile uint8_t __text16 ( trigger_count ) = 0;
229 #define trigger_count __use_text16 ( trigger_count )
232 * Hook UNDI interrupt service routine
236 * The UNDI ISR specifically does @b not chain to the previous
237 * interrupt handler. BIOSes seem to install somewhat perverse
238 * default interrupt handlers; some do nothing other than an iret (and
239 * so will cause a screaming interrupt if there really is another
240 * interrupting device) and some disable the interrupt at the PIC (and
241 * so will bring our own interrupts to a shuddering halt).
243 static void undinet_hook_isr ( unsigned int irq ) {
245 assert ( irq <= IRQ_MAX );
247 __asm__ __volatile__ ( TEXT16_CODE ( "\nundinet_isr:\n\t"
250 : : "p" ( & __from_text16 ( trigger_count ) ) );
252 hook_bios_interrupt ( IRQ_INT ( irq ),
253 ( ( unsigned int ) undinet_isr ),
254 &prev_handler[irq] );
259 * Unhook UNDI interrupt service routine
263 static void undinet_unhook_isr ( unsigned int irq ) {
265 assert ( irq <= IRQ_MAX );
267 unhook_bios_interrupt ( IRQ_INT ( irq ),
268 ( ( unsigned int ) undinet_isr ),
269 &prev_handler[irq] );
273 * Test to see if UNDI ISR has been triggered
275 * @ret triggered ISR has been triggered since last check
277 static int undinet_isr_triggered ( void ) {
278 static unsigned int last_trigger_count = 0;
279 unsigned int this_trigger_count;
281 /* Read trigger_count. Do this only once; it is volatile */
282 this_trigger_count = trigger_count;
284 if ( this_trigger_count == last_trigger_count ) {
289 last_trigger_count = this_trigger_count;
294 /*****************************************************************************
296 * UNDI network device interface
298 *****************************************************************************
301 /** Maximum length of a packet transmitted via the UNDI API */
302 #define UNDI_PKB_LEN 1514
304 /** A packet transmitted via the UNDI API */
306 uint8_t bytes[UNDI_PKB_LEN];
309 /** UNDI packet buffer */
310 static struct undi_packet __data16 ( undinet_pkb );
311 #define undinet_pkb __use_data16 ( undinet_pkb )
313 /** UNDI transmit buffer descriptor */
314 static struct s_PXENV_UNDI_TBD __data16 ( undinet_tbd );
315 #define undinet_tbd __use_data16 ( undinet_tbd )
320 * @v netdev Network device
321 * @v pkb Packet buffer
322 * @ret rc Return status code
324 static int undinet_transmit ( struct net_device *netdev,
325 struct pk_buff *pkb ) {
326 struct undi_nic *undinic = netdev->priv;
327 struct s_PXENV_UNDI_TRANSMIT undi_transmit;
328 size_t len = pkb_len ( pkb );
331 /* Copy packet to UNDI packet buffer */
332 if ( len > sizeof ( undinet_pkb ) )
333 len = sizeof ( undinet_pkb );
334 memcpy ( &undinet_pkb, pkb->data, len );
336 /* Create PXENV_UNDI_TRANSMIT data structure */
337 memset ( &undi_transmit, 0, sizeof ( undi_transmit ) );
338 undi_transmit.DestAddr.segment = rm_ds;
339 undi_transmit.DestAddr.offset
340 = ( ( unsigned ) & __from_data16 ( undinet_tbd ) );
341 undi_transmit.TBD.segment = rm_ds;
342 undi_transmit.TBD.offset
343 = ( ( unsigned ) & __from_data16 ( undinet_tbd ) );
345 /* Create PXENV_UNDI_TBD data structure */
346 undinet_tbd.ImmedLength = len;
347 undinet_tbd.Xmit.segment = rm_ds;
348 undinet_tbd.Xmit.offset
349 = ( ( unsigned ) & __from_data16 ( undinet_pkb ) );
351 /* Issue PXE API call */
352 if ( ( rc = undinet_call ( undinic, PXENV_UNDI_TRANSMIT,
354 sizeof ( undi_transmit ) ) ) != 0 )
357 /* Free packet buffer */
358 netdev_tx_complete ( netdev, pkb );
365 * Poll for received packets
367 * @v netdev Network device
368 * @v rx_quota Maximum number of packets to receive
370 * Fun, fun, fun. UNDI drivers don't use polling; they use
371 * interrupts. We therefore cheat and pretend that an interrupt has
372 * occurred every time undinet_poll() is called. This isn't too much
373 * of a hack; PCI devices share IRQs and so the first thing that a
374 * proper ISR should do is call PXENV_UNDI_ISR to determine whether or
375 * not the UNDI NIC generated the interrupt; there is no harm done by
376 * spurious calls to PXENV_UNDI_ISR. Similarly, we wouldn't be
377 * handling them any more rapidly than the usual rate of
378 * undinet_poll() being called even if we did implement a full ISR.
379 * So it should work. Ha!
381 * Addendum (21/10/03). Some cards don't play nicely with this trick,
382 * so instead of doing it the easy way we have to go to all the hassle
383 * of installing a genuine interrupt service routine and dealing with
384 * the wonderful 8259 Programmable Interrupt Controller. Joy.
386 static void undinet_poll ( struct net_device *netdev, unsigned int rx_quota ) {
387 struct undi_nic *undinic = netdev->priv;
388 struct s_PXENV_UNDI_ISR undi_isr;
389 struct pk_buff *pkb = NULL;
394 if ( ! undinic->isr_processing ) {
395 /* Do nothing unless ISR has been triggered */
396 if ( ! undinet_isr_triggered() )
399 /* See if this was our interrupt */
400 memset ( &undi_isr, 0, sizeof ( undi_isr ) );
401 undi_isr.FuncFlag = PXENV_UNDI_ISR_IN_START;
402 if ( ( rc = undinet_call ( undinic, PXENV_UNDI_ISR, &undi_isr,
403 sizeof ( undi_isr ) ) ) != 0 )
405 if ( undi_isr.FuncFlag != PXENV_UNDI_ISR_OUT_OURS )
409 send_eoi ( undinic->irq );
411 /* Start ISR processing */
412 undinic->isr_processing = 1;
413 undi_isr.FuncFlag = PXENV_UNDI_ISR_IN_PROCESS;
415 /* Continue ISR processing */
416 undi_isr.FuncFlag = PXENV_UNDI_ISR_IN_GET_NEXT;
419 /* Run through the ISR loop */
421 if ( ( rc = undinet_call ( undinic, PXENV_UNDI_ISR, &undi_isr,
422 sizeof ( undi_isr ) ) ) != 0 )
424 switch ( undi_isr.FuncFlag ) {
425 case PXENV_UNDI_ISR_OUT_TRANSMIT:
426 /* We don't care about transmit completions */
428 case PXENV_UNDI_ISR_OUT_RECEIVE:
429 /* Packet fragment received */
430 len = undi_isr.FrameLength;
431 frag_len = undi_isr.BufferLength;
433 pkb = alloc_pkb ( len );
435 DBGC ( undinic, "UNDINIC %p could not "
436 "allocate %zd bytes for RX buffer\n",
438 /* Fragment will be dropped */
441 if ( frag_len > pkb_tailroom ( pkb ) ) {
442 DBGC ( undinic, "UNDINIC %p fragment too "
443 "large\n", undinic );
444 frag_len = pkb_tailroom ( pkb );
446 copy_from_real ( pkb_put ( pkb, frag_len ),
447 undi_isr.Frame.segment,
448 undi_isr.Frame.offset, frag_len );
449 if ( pkb_len ( pkb ) == len ) {
450 netdev_rx ( netdev, pkb );
455 case PXENV_UNDI_ISR_OUT_DONE:
456 /* Processing complete */
457 undinic->isr_processing = 0;
460 /* Should never happen */
461 DBGC ( undinic, "UNDINIC %p ISR returned invalid "
462 "FuncFlag %04x\n", undinic, undi_isr.FuncFlag );
463 undinic->isr_processing = 0;
466 undi_isr.FuncFlag = PXENV_UNDI_ISR_IN_GET_NEXT;
471 DBGC ( undinic, "UNDINIC %p returned incomplete packet\n",
473 netdev_rx ( netdev, pkb );
480 * @v netdev Net device
481 * @ret rc Return status code
483 static int undinet_open ( struct net_device *netdev ) {
484 struct undi_nic *undinic = netdev->priv;
485 struct s_PXENV_UNDI_SET_STATION_ADDRESS undi_set_address;
486 struct s_PXENV_UNDI_OPEN undi_open;
489 /* Hook interrupt service routine and enable interrupt */
490 undinet_hook_isr ( undinic->irq );
491 enable_irq ( undinic->irq );
492 send_eoi ( undinic->irq );
494 /* Set station address. Required for some PXE stacks; will
495 * spuriously fail on others. Ignore failures. We only ever
496 * use it to set the MAC address to the card's permanent value
499 memcpy ( undi_set_address.StationAddress, netdev->ll_addr,
500 sizeof ( undi_set_address.StationAddress ) );
501 undinet_call ( undinic, PXENV_UNDI_SET_STATION_ADDRESS,
502 &undi_set_address, sizeof ( undi_set_address ) );
505 memset ( &undi_open, 0, sizeof ( undi_open ) );
506 undi_open.PktFilter = ( FLTR_DIRECTED | FLTR_BRDCST );
507 if ( ( rc = undinet_call ( undinic, PXENV_UNDI_OPEN, &undi_open,
508 sizeof ( undi_open ) ) ) != 0 )
514 undinet_close ( netdev );
521 * @v netdev Net device
523 static void undinet_close ( struct net_device *netdev ) {
524 struct undi_nic *undinic = netdev->priv;
525 struct s_PXENV_UNDI_ISR undi_isr;
526 struct s_PXENV_UNDI_CLOSE undi_close;
529 /* Ensure ISR has exited cleanly */
530 while ( undinic->isr_processing ) {
531 undi_isr.FuncFlag = PXENV_UNDI_ISR_IN_GET_NEXT;
532 if ( ( rc = undinet_call ( undinic, PXENV_UNDI_ISR, &undi_isr,
533 sizeof ( undi_isr ) ) ) != 0 )
535 switch ( undi_isr.FuncFlag ) {
536 case PXENV_UNDI_ISR_OUT_TRANSMIT:
537 case PXENV_UNDI_ISR_OUT_RECEIVE:
538 /* Continue draining */
541 /* Stop processing */
542 undinic->isr_processing = 0;
548 undinet_call ( undinic, PXENV_UNDI_CLOSE, &undi_close,
549 sizeof ( undi_close ) );
551 /* Disable interrupt and unhook ISR */
552 disable_irq ( undinic->irq );
553 undinet_unhook_isr ( undinic->irq );
559 * @v undi UNDI device
560 * @ret rc Return status code
562 int undinet_probe ( struct undi_device *undi ) {
563 struct net_device *netdev;
564 struct undi_nic *undinic;
565 struct s_PXENV_START_UNDI start_undi;
566 struct s_PXENV_UNDI_STARTUP undi_startup;
567 struct s_PXENV_UNDI_INITIALIZE undi_initialize;
568 struct s_PXENV_UNDI_GET_INFORMATION undi_info;
569 struct s_PXENV_UNDI_SHUTDOWN undi_shutdown;
570 struct s_PXENV_UNDI_CLEANUP undi_cleanup;
571 struct s_PXENV_STOP_UNDI stop_undi;
574 /* Allocate net device */
575 netdev = alloc_etherdev ( sizeof ( *undinic ) );
578 undinic = netdev->priv;
579 undi_set_drvdata ( undi, netdev );
580 netdev->dev = &undi->dev;
581 memset ( undinic, 0, sizeof ( *undinic ) );
582 undinic->entry = undi->entry;
583 DBGC ( undinic, "UNDINIC %p using UNDI %p\n", undinic, undi );
585 /* Hook in UNDI stack */
586 memset ( &start_undi, 0, sizeof ( start_undi ) );
587 start_undi.AX = undi->pci_busdevfn;
588 start_undi.BX = undi->isapnp_csn;
589 start_undi.DX = undi->isapnp_read_port;
590 start_undi.ES = BIOS_SEG;
591 start_undi.DI = find_pnp_bios();
592 if ( ( rc = undinet_call ( undinic, PXENV_START_UNDI, &start_undi,
593 sizeof ( start_undi ) ) ) != 0 )
596 /* Bring up UNDI stack */
597 memset ( &undi_startup, 0, sizeof ( undi_startup ) );
598 if ( ( rc = undinet_call ( undinic, PXENV_UNDI_STARTUP, &undi_startup,
599 sizeof ( undi_startup ) ) ) != 0 )
600 goto err_undi_startup;
601 memset ( &undi_initialize, 0, sizeof ( undi_initialize ) );
602 if ( ( rc = undinet_call ( undinic, PXENV_UNDI_INITIALIZE,
604 sizeof ( undi_initialize ) ) ) != 0 )
605 goto err_undi_initialize;
607 /* Get device information */
608 memset ( &undi_info, 0, sizeof ( undi_info ) );
609 if ( ( rc = undinet_call ( undinic, PXENV_UNDI_GET_INFORMATION,
610 &undi_info, sizeof ( undi_info ) ) ) != 0 )
611 goto err_undi_get_information;
612 memcpy ( netdev->ll_addr, undi_info.PermNodeAddress, ETH_ALEN );
613 undinic->irq = undi_info.IntNumber;
614 if ( undinic->irq > IRQ_MAX ) {
615 DBGC ( undinic, "UNDINIC %p invalid IRQ %d\n",
616 undinic, undinic->irq );
619 DBGC ( undinic, "UNDINIC %p is %s on IRQ %d\n",
620 undinic, eth_ntoa ( netdev->ll_addr ), undinic->irq );
622 /* Point to NIC specific routines */
623 netdev->open = undinet_open;
624 netdev->close = undinet_close;
625 netdev->transmit = undinet_transmit;
626 netdev->poll = undinet_poll;
628 /* Register network device */
629 if ( ( rc = register_netdev ( netdev ) ) != 0 )
636 err_undi_get_information:
638 /* Shut down UNDI stack */
639 memset ( &undi_shutdown, 0, sizeof ( undi_shutdown ) );
640 undinet_call ( undinic, PXENV_UNDI_SHUTDOWN, &undi_shutdown,
641 sizeof ( undi_shutdown ) );
642 memset ( &undi_cleanup, 0, sizeof ( undi_cleanup ) );
643 undinet_call ( undinic, PXENV_UNDI_CLEANUP, &undi_cleanup,
644 sizeof ( undi_cleanup ) );
646 /* Unhook UNDI stack */
647 memset ( &stop_undi, 0, sizeof ( stop_undi ) );
648 undinet_call ( undinic, PXENV_STOP_UNDI, &stop_undi,
649 sizeof ( stop_undi ) );
651 free_netdev ( netdev );
652 undi_set_drvdata ( undi, NULL );
659 * @v undi UNDI device
661 void undinet_remove ( struct undi_device *undi ) {
662 struct net_device *netdev = undi_get_drvdata ( undi );
663 struct undi_nic *undinic = netdev->priv;
664 struct s_PXENV_UNDI_SHUTDOWN undi_shutdown;
665 struct s_PXENV_UNDI_CLEANUP undi_cleanup;
666 struct s_PXENV_STOP_UNDI stop_undi;
668 /* Unregister net device */
669 unregister_netdev ( netdev );
671 /* Shut down UNDI stack */
672 memset ( &undi_shutdown, 0, sizeof ( undi_shutdown ) );
673 undinet_call ( undinic, PXENV_UNDI_SHUTDOWN, &undi_shutdown,
674 sizeof ( undi_shutdown ) );
675 memset ( &undi_cleanup, 0, sizeof ( undi_cleanup ) );
676 undinet_call ( undinic, PXENV_UNDI_CLEANUP, &undi_cleanup,
677 sizeof ( undi_cleanup ) );
679 /* Unhook UNDI stack */
680 memset ( &stop_undi, 0, sizeof ( stop_undi ) );
681 undinet_call ( undinic, PXENV_STOP_UNDI, &stop_undi,
682 sizeof ( stop_undi ) );
684 /* Free network device */
685 free_netdev ( netdev );