123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390 |
- /**************************************************************************
- Etherboot - BOOTP/TFTP Bootstrap Program
- Skeleton NIC driver for Etherboot
- ***************************************************************************/
-
- /*
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
- * published by the Free Software Foundation; either version 2, or (at
- * your option) any later version.
- */
-
- /* to get some global routines like printf */
- #include "etherboot.h"
- /* to get the interface to the body of the program */
- #include "nic.h"
- /* Drag in support for whichever bus(es) we want for this NIC */
- #include "pci.h"
- #include "isa.h"
- #include "eisa.h"
- #include "isapnp.h"
- #include "mca.h"
-
- /* NIC specific static variables go here. Try to avoid using static
- * variables wherever possible. In particular, the I/O address can
- * always be accessed via nic->ioaddr.
- */
-
- /*
- * Don't forget to remove "__unused" from all the function parameters!
- *
- */
-
- /**************************************************************************
- * CONNECT - Connect to the network
- **************************************************************************
- */
- static int skel_connect ( struct nic *nic __unused ) {
- /*
- * Connect to the network. For most NICs, this will probably
- * be a no-op. For wireless NICs, this should be the point at
- * which you attempt to join to an access point.
- *
- * Return 0 if the connection failed (e.g. no cable plugged
- * in), 1 for success.
- *
- */
- return 1;
- }
-
- /**************************************************************************
- * POLL - Wait for a frame
- **************************************************************************
- */
- static int skel_poll ( struct nic *nic __unused, int retrieve __unused ) {
- /* Work out whether or not there's an ethernet packet ready to
- * read. Return 0 if not.
- */
- /*
- if ( ! <packet_ready> ) return 0;
- */
-
- /* retrieve==0 indicates that we are just checking for the
- * presence of a packet but don't want to read it just yet.
- */
- /*
- if ( ! retrieve ) return 1;
- */
-
- /* Copy data to nic->packet. Data should include the
- * link-layer header (dest MAC, source MAC, type).
- * Store length of data in nic->packetlen.
- * Return true to indicate a packet has been read.
- */
- /*
- nic->packetlen = <packet_length>;
- memcpy ( nic->packet, <packet_data>, <packet_length> );
- return 1;
- */
-
- return 0; /* Remove this line once this method is implemented */
- }
-
- /**************************************************************************
- * TRANSMIT - Transmit a frame
- **************************************************************************
- */
- static void skel_transmit ( struct nic *nic __unused,
- const char *dest __unused,
- unsigned int type __unused,
- unsigned int size __unused,
- const char *packet __unused ) {
- /* Transmit packet to dest MAC address. You will need to
- * construct the link-layer header (dest MAC, source MAC,
- * type).
- */
- /*
- unsigned int nstype = htons ( type );
- memcpy ( <tx_buffer>, dest, ETH_ALEN );
- memcpy ( <tx_buffer> + ETH_ALEN, nic->node_addr, ETH_ALEN );
- memcpy ( <tx_buffer> + 2 * ETH_ALEN, &nstype, 2 );
- memcpy ( <tx_buffer> + ETH_HLEN, data, size );
- <transmit_data> ( <tx_buffer>, size + ETH_HLEN );
- */
- }
-
- /**************************************************************************
- * DISABLE - Turn off ethernet interface
- **************************************************************************
- */
- static void skel_disable ( struct nic *nic __unused ) {
- /* put the card in its initial state */
- /* This function serves 3 purposes.
- * This disables DMA and interrupts so we don't receive
- * unexpected packets or interrupts from the card after
- * etherboot has finished.
- * This frees resources so etherboot may use
- * this driver on another interface
- * This allows etherboot to reinitialize the interface
- * if something is something goes wrong.
- */
- }
-
- /**************************************************************************
- * IRQ - handle interrupts
- **************************************************************************
- */
- static void skel_irq ( struct nic *nic __unused, irq_action_t action ) {
- /* This routine is somewhat optional. Etherboot itself
- * doesn't use interrupts, but they are required under some
- * circumstances when we're acting as a PXE stack.
- *
- * If you don't implement this routine, the only effect will
- * be that your driver cannot be used via Etherboot's UNDI
- * API. This won't affect programs that use only the UDP
- * portion of the PXE API, such as pxelinux.
- */
-
- switch ( action ) {
- case DISABLE :
- case ENABLE :
- /* Set receive interrupt enabled/disabled state */
- /*
- outb ( action == ENABLE ? IntrMaskEnabled : IntrMaskDisabled,
- nic->ioaddr + IntrMaskRegister );
- */
- break;
- case FORCE :
- /* Force NIC to generate a receive interrupt */
- /*
- outb ( ForceInterrupt, nic->ioaddr + IntrForceRegister );
- */
- break;
- }
- }
-
- /**************************************************************************
- * OPERATIONS TABLE - Pointers to all the above methods
- **************************************************************************
- */
- static struct nic_operations skel_operations = {
- .connect = skel_connect,
- .poll = skel_poll,
- .transmit = skel_transmit,
- .irq = skel_irq,
- .disable = skel_disable,
- };
-
- /**************************************************************************
- * PROBE - Look for an adapter
- *
- * You need to define a probe routine for each bus type that your
- * driver supports, together with tables that enable Etherboot to
- * identify that your driver should be used for a particular device.
- *
- * Delete whichever of the following sections you don't need. For
- * example, most PCI devices will only need the PCI probing section;
- * ISAPnP, EISA, etc. can all be deleted.
- *
- * Some devices will need custom bus logic. The ISA 3c509 is a good
- * example of this; it has a contention-resolution mechanism that is
- * similar to ISAPnP, but not close enough to use the generic ISAPnP
- * code. Look at 3c509.c to see how it works.
- *
- **************************************************************************
- */
-
- /**************************************************************************
- * PCI PROBE - Look for an adapter
- **************************************************************************
- */
- static int skel_pci_probe ( struct dev *dev, struct pci_device *pci ) {
- struct nic *nic = nic_device ( dev );
-
- nic->ioaddr = pci->ioaddr;
- nic->irqno = pci->irq;
-
- /* Test for physical presence of NIC */
- /*
- if ( ! my_tests ) {
- DBG ( "Could not find NIC: my explanation\n" );
- return 0;
- }
- */
-
- /* point to NIC specific routines */
- nic->nic_op = &skel_operations;
- return 1;
- }
-
- static struct pci_id skel_pci_nics[] = {
- PCI_ROM ( 0x0000, 0x0000, "skel-pci", "Skeleton PCI Adapter" ),
- };
-
- static struct pci_driver skel_pci_driver =
- PCI_DRIVER ( "SKEL/PCI", skel_pci_nics, PCI_NO_CLASS );
-
- BOOT_DRIVER ( "SKEL/PCI", find_pci_boot_device,
- skel_pci_driver, skel_pci_probe );
-
- /**************************************************************************
- * EISA PROBE - Look for an adapter
- **************************************************************************
- */
- static int skel_eisa_probe ( struct dev *dev, struct eisa_device *eisa ) {
- struct nic *nic = nic_device ( dev );
-
- enable_eisa_device ( eisa );
- nic->ioaddr = eisa->ioaddr;
- nic->irqno = 0;
-
- /* Test for physical presence of NIC */
- /*
- if ( ! my_tests ) {
- DBG ( "Could not find NIC: my explanation\n" );
- return 0;
- }
- */
-
- /* point to NIC specific routines */
- nic->nic_op = &skel_operations;
- return 1;
- }
-
- static struct eisa_id skel_eisa_nics[] = {
- { "Skeleton EISA Adapter", EISA_VENDOR('S','K','L'), 0x0000 },
- };
-
- static struct eisa_driver skel_eisa_driver =
- EISA_DRIVER ( "SKEL/EISA", skel_eisa_nics );
-
- BOOT_DRIVER ( "SKEL/EISA", find_eisa_boot_device,
- skel_eisa_driver, skel_eisa_probe );
-
- ISA_ROM ( "skel-eisa", "Skeleton EISA Adapter" );
-
- /**************************************************************************
- * ISAPnP PROBE - Look for an adapter
- **************************************************************************
- */
- static int skel_isapnp_probe ( struct dev *dev,
- struct isapnp_device *isapnp ) {
- struct nic *nic = nic_device ( dev );
-
- nic->ioaddr = isapnp->ioaddr;
- nic->irqno = isapnp->irqno;
- activate_isapnp_device ( isapnp );
-
- /* Test for physical presence of NIC */
- /*
- if ( ! my_tests ) {
- DBG ( "Could not find NIC: my explanation\n" );
- return 0;
- }
- */
-
- /* point to NIC specific routines */
- nic->nic_op = &skel_operations;
- return 1;
- }
-
- static struct isapnp_id skel_isapnp_nics[] = {
- { "Skeleton ISAPnP Adapter", ISAPNP_VENDOR('S','K','L'), 0x0000 },
- };
-
- static struct isapnp_driver skel_isapnp_driver =
- ISAPNP_DRIVER ( "SKEL/ISAPnP", skel_isapnp_nics );
-
- BOOT_DRIVER ( "SKEL/ISAPnP", find_isapnp_boot_device,
- skel_isapnp_driver, skel_isapnp_probe );
-
- ISA_ROM ( "skel-isapnp", "Skeleton ISAPnP Adapter" );
-
- /**************************************************************************
- * MCA PROBE - Look for an adapter
- **************************************************************************
- */
- static int skel_mca_probe ( struct dev *dev,
- struct mca_device *mca __unused ) {
- struct nic *nic = nic_device ( dev );
-
- /* MCA parameters are available in the mca->pos[] array */
- /*
- nic->ioaddr = ( mca->pos[xxx] << 8 ) + mca->pos[yyy];
- nic->irqno = mca->pos[zzz] & 0x0f;
- */
-
- /* Test for physical presence of NIC */
- /*
- if ( ! my_tests ) {
- DBG ( "Could not find NIC: my explanation\n" );
- return 0;
- }
- */
-
- /* point to NIC specific routines */
- nic->nic_op = &skel_operations;
- return 1;
- }
-
- static struct mca_id skel_mca_nics[] = {
- { "Skeleton MCA Adapter", 0x0000 },
- };
-
- static struct mca_driver skel_mca_driver =
- MCA_DRIVER ( "SKEL/MCA", skel_mca_nics );
-
- BOOT_DRIVER ( "SKEL/MCA", find_mca_boot_device,
- skel_mca_driver, skel_mca_probe );
-
- ISA_ROM ( "skel-mca", "Skeleton MCA Adapter" );
-
- /**************************************************************************
- * ISA PROBE - Look for an adapter
- *
- * The "classical" ISA probe is split into two stages: trying a list
- * of I/O addresses to see if there's anything listening, and then
- * using that I/O address to fill in the information in the nic
- * structure.
- *
- * The list of probe addresses defined in skel_isa_probe_addrs[] will
- * be passed to skel_isa_probe_addr(). If skel_isa_probe_addr()
- * returns true, a struct isa_device will be created with isa->ioaddr
- * set to the working I/O address, and skel_isa_probe() will be
- * called.
- *
- * There is a standard mechanism for overriding the probe address list
- * using ISA_PROBE_ADDRS. Do not implement any custom code to
- * override the probe address list.
- *
- **************************************************************************
- */
- static int skel_isa_probe_addr ( isa_probe_addr_t ioaddr __unused ) {
- return 0;
- }
-
- static int skel_isa_probe ( struct dev *dev, struct isa_device *isa ) {
- struct nic *nic = nic_device ( dev );
-
- nic->ioaddr = isa->ioaddr;
- nic->irqno = 0;
-
- /* Test for physical presence of NIC */
- /*
- if ( ! my_tests ) {
- DBG ( "Could not find NIC: my explanation\n" );
- return 0;
- }
- */
-
- /* point to NIC specific routines */
- nic->nic_op = &skel_operations;
- return 1;
- }
-
- static isa_probe_addr_t skel_isa_probe_addrs[] = {
- /*
- 0x200, 0x240,
- */
- };
-
- static struct isa_driver skel_isa_driver =
- ISA_DRIVER ( "SKEL/ISA", skel_isa_probe_addrs, skel_isa_probe_addr,
- ISA_VENDOR('S','K','L'), 0x0000 );
-
- BOOT_DRIVER ( "SKEL/ISA", find_isa_boot_device,
- skel_isa_driver, skel_isa_probe );
-
- ISA_ROM ( "skel-isa", "Skeleton ISA Adapter" );
|