/* rtl8139.c - etherboot driver for the Realtek 8139 chipset ported from the linux driver written by Donald Becker by Rainer Bawidamann (Rainer.Bawidamann@informatik.uni-ulm.de) 1999 This software may be used and distributed according to the terms of the GNU Public License, incorporated herein by reference. changes to the original driver: - removed support for interrupts, switching to polling mode (yuck!) - removed support for the 8129 chip (external MII) */ /*********************************************************************/ /* Revision History */ /*********************************************************************/ /* 27 May 2006 mcb30@users.sourceforge.net (Michael Brown) Rewrote to use the new net driver API, the updated PCI API, and the generic three-wire serial device support for EEPROM access. 28 Dec 2002 ken_yap@users.sourceforge.net (Ken Yap) Put in virt_to_bus calls to allow Etherboot relocation. 06 Apr 2001 ken_yap@users.sourceforge.net (Ken Yap) Following email from Hyun-Joon Cha, added a disable routine, otherwise NIC remains live and can crash the kernel later. 4 Feb 2000 espenlaub@informatik.uni-ulm.de (Klaus Espenlaub) Shuffled things around, removed the leftovers from the 8129 support that was in the Linux driver and added a bit more 8139 definitions. Moved the 8K receive buffer to a fixed, available address outside the 0x98000-0x9ffff range. This is a bit of a hack, but currently the only way to make room for the Etherboot features that need substantial amounts of code like the ANSI console support. Currently the buffer is just below 0x10000, so this even conforms to the tagged boot image specification, which reserves the ranges 0x00000-0x10000 and 0x98000-0xA0000. My interpretation of this "reserved" is that Etherboot may do whatever it likes, as long as its environment is kept intact (like the BIOS variables). Hopefully fixed rtl_poll() once and for all. The symptoms were that if Etherboot was left at the boot menu for several minutes, the first eth_poll failed. Seems like I am the only person who does this. First of all I fixed the debugging code and then set out for a long bug hunting session. It took me about a week full time work - poking around various places in the driver, reading Don Becker's and Jeff Garzik's Linux driver and even the FreeBSD driver (what a piece of crap!) - and eventually spotted the nasty thing: the transmit routine was acknowledging each and every interrupt pending, including the RxOverrun and RxFIFIOver interrupts. This confused the RTL8139 thoroughly. It destroyed the Rx ring contents by dumping the 2K FIFO contents right where we wanted to get the next packet. Oh well, what fun. 18 Jan 2000 mdc@etherboot.org (Marty Connor) Drastically simplified error handling. Basically, if any error in transmission or reception occurs, the card is reset. Also, pointed all transmit descriptors to the same buffer to save buffer space. This should decrease driver size and avoid corruption because of exceeding 32K during runtime. 28 Jul 1999 (Matthias Meixner - meixner@rbg.informatik.tu-darmstadt.de) rtl_poll was quite broken: it used the RxOK interrupt flag instead of the RxBufferEmpty flag which often resulted in very bad transmission performace - below 1kBytes/s. */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #define TX_RING_SIZE 4 struct rtl8139_tx { unsigned int next; struct io_buffer *iobuf[TX_RING_SIZE]; }; struct rtl8139_rx { void *ring; unsigned int offset; }; struct rtl8139_nic { unsigned short ioaddr; struct rtl8139_tx tx; struct rtl8139_rx rx; struct spi_bit_basher spibit; struct spi_device eeprom; struct nvo_block nvo; }; /* Tuning Parameters */ #define TX_FIFO_THRESH 256 /* In bytes, rounded down to 32 byte units. */ #define RX_FIFO_THRESH 4 /* Rx buffer level before first PCI xfer. */ #define RX_DMA_BURST 4 /* Maximum PCI burst, '4' is 256 bytes */ #define TX_DMA_BURST 4 /* Calculate as 16<ioaddr + Cfg9346 ); return ( eereg & mask ); } static void rtl_spi_write_bit ( struct bit_basher *basher, unsigned int bit_id, unsigned long data ) { struct rtl8139_nic *rtl = container_of ( basher, struct rtl8139_nic, spibit.basher ); uint8_t mask = rtl_ee_bits[bit_id]; uint8_t eereg; eereg = inb ( rtl->ioaddr + Cfg9346 ); eereg &= ~mask; eereg |= ( data & mask ); outb ( eereg, rtl->ioaddr + Cfg9346 ); } static struct bit_basher_operations rtl_basher_ops = { .read = rtl_spi_read_bit, .write = rtl_spi_write_bit, }; /** Portion of EEPROM available for non-volatile stored options * * We use offset 0x40 (i.e. address 0x20), length 0x40. This block is * marked as VPD in the rtl8139 datasheets, so we use it only if we * detect that the card is not supporting VPD. */ static struct nvo_fragment rtl_nvo_fragments[] = { { 0x20, 0x40 }, { 0, 0 } }; /** * Set up for EEPROM access * * @v rtl RTL8139 NIC */ void rtl_init_eeprom ( struct rtl8139_nic *rtl ) { int ee9356; int vpd; /* Initialise three-wire bus */ rtl->spibit.basher.op = &rtl_basher_ops; rtl->spibit.bus.mode = SPI_MODE_THREEWIRE; init_spi_bit_basher ( &rtl->spibit ); /* Detect EEPROM type and initialise three-wire device */ ee9356 = ( inw ( rtl->ioaddr + RxConfig ) & Eeprom9356 ); if ( ee9356 ) { DBG ( "EEPROM is an AT93C56\n" ); init_at93c56 ( &rtl->eeprom, 16 ); } else { DBG ( "EEPROM is an AT93C46\n" ); init_at93c46 ( &rtl->eeprom, 16 ); } rtl->eeprom.bus = &rtl->spibit.bus; /* Initialise space for non-volatile options, if available */ vpd = ( inw ( rtl->ioaddr + Config1 ) & VPDEnable ); if ( vpd ) { DBG ( "EEPROM in use for VPD; cannot use for options\n" ); } else { rtl->nvo.nvs = &rtl->eeprom.nvs; rtl->nvo.fragments = rtl_nvo_fragments; } } /** * Reset NIC * * @v rtl RTL8139 NIC * * Issues a hardware reset and waits for the reset to complete. */ static void rtl_reset ( struct rtl8139_nic *rtl ) { /* Reset chip */ outb ( CmdReset, rtl->ioaddr + ChipCmd ); mdelay ( 10 ); memset ( &rtl->tx, 0, sizeof ( rtl->tx ) ); rtl->rx.offset = 0; } /** * Open NIC * * @v netdev Net device * @ret rc Return status code */ static int rtl_open ( struct net_device *netdev ) { struct rtl8139_nic *rtl = netdev->priv; int i; /* Program the MAC address */ for ( i = 0 ; i < ETH_ALEN ; i++ ) outb ( netdev->ll_addr[i], rtl->ioaddr + MAC0 + i ); /* Set up RX ring */ rtl->rx.ring = malloc ( RX_BUF_LEN + RX_BUF_PAD ); if ( ! rtl->rx.ring ) return -ENOMEM; outl ( virt_to_bus ( rtl->rx.ring ), rtl->ioaddr + RxBuf ); DBG ( "RX ring at %lx\n", virt_to_bus ( rtl->rx.ring ) ); /* Enable TX and RX */ outb ( ( CmdRxEnb | CmdTxEnb ), rtl->ioaddr + ChipCmd ); outl ( ( ( RX_FIFO_THRESH << 13 ) | ( RX_BUF_LEN_IDX << 11 ) | ( RX_DMA_BURST << 8 ) | AcceptBroadcast | AcceptMulticast | AcceptMyPhys ), rtl->ioaddr + RxConfig ); outl ( 0xffffffffUL, rtl->ioaddr + MAR0 + 0 ); outl ( 0xffffffffUL, rtl->ioaddr + MAR0 + 4 ); outl ( ( ( TX_DMA_BURST << 8 ) | ( TX_IPG << 24 ) ), rtl->ioaddr + TxConfig ); return 0; } /** * Close NIC * * @v netdev Net device */ static void rtl_close ( struct net_device *netdev ) { struct rtl8139_nic *rtl = netdev->priv; /* Reset the hardware to disable everything in one go */ rtl_reset ( rtl ); /* Free RX ring */ free ( rtl->rx.ring ); rtl->rx.ring = NULL; } /** * Transmit packet * * @v netdev Network device * @v iobuf I/O buffer * @ret rc Return status code */ static int rtl_transmit ( struct net_device *netdev, struct io_buffer *iobuf ) { struct rtl8139_nic *rtl = netdev->priv; /* Check for space in TX ring */ if ( rtl->tx.iobuf[rtl->tx.next] != NULL ) { printf ( "TX overflow\n" ); return -ENOBUFS; } /* Pad and align packet */ iob_pad ( iobuf, ETH_ZLEN ); /* Add to TX ring */ DBG ( "TX id %d at %lx+%x\n", rtl->tx.next, virt_to_bus ( iobuf->data ), iob_len ( iobuf ) ); rtl->tx.iobuf[rtl->tx.next] = iobuf; outl ( virt_to_bus ( iobuf->data ), rtl->ioaddr + TxAddr0 + 4 * rtl->tx.next ); outl ( ( ( ( TX_FIFO_THRESH & 0x7e0 ) << 11 ) | iob_len ( iobuf ) ), rtl->ioaddr + TxStatus0 + 4 * rtl->tx.next ); rtl->tx.next = ( rtl->tx.next + 1 ) % TX_RING_SIZE; return 0; } /** * Poll for received packets * * @v netdev Network device * @v rx_quota Maximum number of packets to receive */ static void rtl_poll ( struct net_device *netdev, unsigned int rx_quota ) { struct rtl8139_nic *rtl = netdev->priv; unsigned int status; unsigned int tsad; unsigned int rx_status; unsigned int rx_len; struct io_buffer *rx_iob; int wrapped_len; int i; /* Acknowledge interrupts */ status = inw ( rtl->ioaddr + IntrStatus ); if ( ! status ) return; outw ( status, rtl->ioaddr + IntrStatus ); /* Handle TX completions */ tsad = inw ( rtl->ioaddr + TxSummary ); for ( i = 0 ; i < TX_RING_SIZE ; i++ ) { if ( ( rtl->tx.iobuf[i] != NULL ) && ( tsad & ( 1 << i ) ) ) { DBG ( "TX id %d complete\n", i ); netdev_tx_complete ( netdev, rtl->tx.iobuf[i] ); rtl->tx.iobuf[i] = NULL; } } /* Handle received packets */ while ( rx_quota && ! ( inw ( rtl->ioaddr + ChipCmd ) & RxBufEmpty ) ){ rx_status = * ( ( uint16_t * ) ( rtl->rx.ring + rtl->rx.offset ) ); rx_len = * ( ( uint16_t * ) ( rtl->rx.ring + rtl->rx.offset + 2 ) ); if ( rx_status & RxOK ) { DBG ( "RX packet at offset %x+%x\n", rtl->rx.offset, rx_len ); rx_iob = alloc_iob ( rx_len ); if ( ! rx_iob ) { /* Leave packet for next call to poll() */ break; } wrapped_len = ( ( rtl->rx.offset + 4 + rx_len ) - RX_BUF_LEN ); if ( wrapped_len < 0 ) wrapped_len = 0; memcpy ( iob_put ( rx_iob, rx_len - wrapped_len ), rtl->rx.ring + rtl->rx.offset + 4, rx_len - wrapped_len ); memcpy ( iob_put ( rx_iob, wrapped_len ), rtl->rx.ring, wrapped_len ); netdev_rx ( netdev, rx_iob ); rx_quota--; } else { DBG ( "RX bad packet (status %#04x len %d)\n", rx_status, rx_len ); } rtl->rx.offset = ( ( ( rtl->rx.offset + 4 + rx_len + 3 ) & ~3 ) % RX_BUF_LEN ); outw ( rtl->rx.offset - 16, rtl->ioaddr + RxBufPtr ); } } #if 0 static void rtl_irq(struct nic *nic, irq_action_t action) { unsigned int mask; /* Bit of a guess as to which interrupts we should allow */ unsigned int interested = ROK | RER | RXOVW | FOVW | SERR; switch ( action ) { case DISABLE : case ENABLE : mask = inw(rtl->ioaddr + IntrMask); mask = mask & ~interested; if ( action == ENABLE ) mask = mask | interested; outw(mask, rtl->ioaddr + IntrMask); break; case FORCE : /* Apparently writing a 1 to this read-only bit of a * read-only and otherwise unrelated register will * force an interrupt. If you ever want to see how * not to write a datasheet, read the one for the * RTL8139... */ outb(EROK, rtl->ioaddr + RxEarlyStatus); break; } } #endif /** * Probe PCI device * * @v pci PCI device * @v id PCI ID * @ret rc Return status code */ static int rtl_probe ( struct pci_device *pci, const struct pci_device_id *id __unused ) { struct net_device *netdev; struct rtl8139_nic *rtl = NULL; int registered_netdev = 0; int rc; /* Fix up PCI device */ adjust_pci_device ( pci ); /* Allocate net device */ netdev = alloc_etherdev ( sizeof ( *rtl ) ); if ( ! netdev ) { rc = -ENOMEM; goto err; } rtl = netdev->priv; pci_set_drvdata ( pci, netdev ); netdev->dev = &pci->dev; memset ( rtl, 0, sizeof ( *rtl ) ); rtl->ioaddr = pci->ioaddr; /* Reset the NIC, set up EEPROM access and read MAC address */ rtl_reset ( rtl ); rtl_init_eeprom ( rtl ); nvs_read ( &rtl->eeprom.nvs, EE_MAC, netdev->ll_addr, ETH_ALEN ); /* Point to NIC specific routines */ netdev->open = rtl_open; netdev->close = rtl_close; netdev->transmit = rtl_transmit; netdev->poll = rtl_poll; /* Register network device */ if ( ( rc = register_netdev ( netdev ) ) != 0 ) goto err; registered_netdev = 1; /* Register non-volatile storage */ if ( rtl->nvo.nvs ) { if ( ( rc = nvo_register ( &rtl->nvo ) ) != 0 ) goto err; } return 0; err: /* Disable NIC */ if ( rtl ) rtl_reset ( rtl ); if ( registered_netdev ) unregister_netdev ( netdev ); /* Free net device */ free_netdev ( netdev ); return rc; } /** * Remove PCI device * * @v pci PCI device */ static void rtl_remove ( struct pci_device *pci ) { struct net_device *netdev = pci_get_drvdata ( pci ); struct rtl8139_nic *rtl = netdev->priv; if ( rtl->nvo.nvs ) nvo_unregister ( &rtl->nvo ); unregister_netdev ( netdev ); rtl_reset ( rtl ); free_netdev ( netdev ); } static struct pci_device_id rtl8139_nics[] = { PCI_ROM(0x10ec, 0x8129, "rtl8129", "Realtek 8129"), PCI_ROM(0x10ec, 0x8139, "rtl8139", "Realtek 8139"), PCI_ROM(0x10ec, 0x8138, "rtl8139b", "Realtek 8139B"), PCI_ROM(0x1186, 0x1300, "dfe538", "DFE530TX+/DFE538TX"), PCI_ROM(0x1113, 0x1211, "smc1211-1", "SMC EZ10/100"), PCI_ROM(0x1112, 0x1211, "smc1211", "SMC EZ10/100"), PCI_ROM(0x1500, 0x1360, "delta8139", "Delta Electronics 8139"), PCI_ROM(0x4033, 0x1360, "addtron8139", "Addtron Technology 8139"), PCI_ROM(0x1186, 0x1340, "dfe690txd", "D-Link DFE690TXD"), PCI_ROM(0x13d1, 0xab06, "fe2000vx", "AboCom FE2000VX"), PCI_ROM(0x1259, 0xa117, "allied8139", "Allied Telesyn 8139"), PCI_ROM(0x14ea, 0xab06, "fnw3603tx", "Planex FNW-3603-TX"), PCI_ROM(0x14ea, 0xab07, "fnw3800tx", "Planex FNW-3800-TX"), PCI_ROM(0xffff, 0x8139, "clone-rtl8139", "Cloned 8139"), }; struct pci_driver rtl8139_driver __pci_driver = { .ids = rtl8139_nics, .id_count = ( sizeof ( rtl8139_nics ) / sizeof ( rtl8139_nics[0] ) ), .probe = rtl_probe, .remove = rtl_remove, };