---

RTL8139C(L) Fast Ethernet Controller
[Device Drivers]

Data Structures
struct	rtl8139
	The RTL8139 device structure. More...
struct	rxpacket
	A receive packet structure. More...
struct	txpacket
	A transmitted packet structure. More...
Typedefs
typedef rxpacket	rxpacket_t
	A receive packet structure.
typedef txpacket	txpacket_t
	A transmitted packet structure.
typedef rtl8139	rtl8139_t
	The RTL8139 device structure.
Functions
uint8_t *	get_eth_mac_addr ()
	Get the MAC hardware address of the RTL8139 ethernet card. Returns: A pointer to the MAC address value. Exceptions: NULL  if a RTL8139 card has not been initialized.
rtl8139_t *	get_rtl8139_device ()
	Get the pointer of the RTL8139 device structure. Returns: a pointer of the RTL8139 structure if it has been initialized; 0 if the RTL8139 card has not been initialized.
int	send_rtl8139_packet (rtl8139_t *rtl, const void *data, size_t len)
	Send an ethernet packet to the physiscal layer. Parameters: rtl  The RTL8139 structure. data  The data to be sent. len  The size of the data to be sent in bytes. Returns: The number of bytes sent, or -1 if an error occurred.
int	rtl8139_init (bool promisc)
	Initialize the RTL8139 driver. Parameters: promisc  TRUE initialize the card and put it in promiscuous mode; FALSE initialize the card and don't put it in promiscuous mode. Returns: 0 if we can successfully enable the RTL8139 ethernet card; -ENXIO if the device if not present on PCI bus; -EIO if we cannot read ethernet card informations;.
void	rtl8139_close (rtl8139_t **rtl)
	Halt the RTL8139 card and free the logical device. Parameters: rtl  An indirect pointer to the RTL8139 structure. Must be passed as an indirect pointer because it will be modified inside this routine!!!
void	rtl8139_promisc (rtl8139_t *rtl, bool on)
	Enable/disable the promiscuous mode for the RTL8139 card. Parameters: rtl  The RTL8139 structure. on  TRUE enable the promiscuous mode; FALSE disable the promiscuous mode.
void	rtl8139_dump_info (rtl8139_t *rtl)
	Print the current RTL8139 card configuration on the console. Parameters: rtl  The RTL8139 structure.
void	rtl8139_handler ()
	The RTL8139 interrupt handler routine. It is invoked every time that an ethernet packet is received or when a packet has been transmitted.

---

Detailed Description

The RTL8139C(L) sinle chip fast ethernt controller driver.

---

Typedef Documentation

typedef struct rtl8139 rtl8139_t

The RTL8139 device structure.

typedef struct rxpacket rxpacket_t

A receive packet structure.

typedef struct txpacket txpacket_t

A transmitted packet structure.

---

Function Documentation

uint8_t* get_eth_mac_addr (    )

Get the MAC hardware address of the RTL8139 ethernet card. Returns: A pointer to the MAC address value. Exceptions: NULL  if a RTL8139 card has not been initialized. Definition at line 455 of file rtl8139.c. { if (rtl) return(rtl->station_address); else return(NULL); }

rtl8139_t* get_rtl8139_device (    )

Get the pointer of the RTL8139 device structure. Returns: a pointer of the RTL8139 structure if it has been initialized; 0 if the RTL8139 card has not been initialized. Definition at line 468 of file rtl8139.c. { return( rtl ); }

void rtl8139_close (  rtl8139_t **    rtl )

Halt the RTL8139 card and free the logical device. Parameters: rtl  An indirect pointer to the RTL8139 structure. Must be passed as an indirect pointer because it will be modified inside this routine!!! Definition at line 191 of file rtl8139.c. { // Disable interrupts by clearing the interrupt mask // out16((*rtl)->iobase + IntrMask, 0); // Stop the chip's Tx and Rx DMA processes // out((*rtl)->iobase + ChipCmd, 0); // Put the chip in low-power mode // out((*rtl)->iobase + Cfg9346, 0xC0); out((*rtl)->iobase + Config1, 0x03); // 'R' would leave the clock running // out((*rtl)->iobase + HltClk, 'H'); if ( (*rtl) != NULL ) { // Disable the IRQ line // disable_IRQ((*rtl)->irq); // Deallocate the ring buffers // dma_phys_free((*rtl)->rx_phys, RX_BUF_LEN); dma_phys_free((*rtl)->tx_phys, TX_BUF_SIZE*NUM_TX_DESC); // Deallocate the logical structure // kfree((*rtl)); *rtl = NULL; } }

void rtl8139_dump_info (  rtl8139_t *    rtl )

Print the current RTL8139 card configuration on the console. Parameters: rtl  The RTL8139 structure. Definition at line 654 of file rtl8139.c. { in_addr_t ip, netmask, ip_bcast; if ( !rtl ) { // The card is not configured // kprintf("\n\rUsage: ifconfig [up|down]"); kprintf("\n\rRTL8139: ethernet card not configured!\n\r"); return; } // Dump the device informations // kprintf("\n\rRTL8139: card configured @ I/O base=%04X IRQ=%u", rtl->iobase, rtl->irq); // Dump the MAC address // kprintf("\n\rRTL8139: MAC address %02x:%02x:%02x:%02x:%02x:%02x", rtl->station_address[0], rtl->station_address[1], rtl->station_address[2], rtl->station_address[3], rtl->station_address[4], rtl->station_address[5] ); // Dump the media informations // kprintf("\n\rRTL8139: %sMbps %s-duplex", rtl->speed10 ? "10" : "100", rtl->fullduplex ? "full" : "half" ); // Print the promiscuous mode flag // kprintf("\n\rRTL8139: promiscuous mode %s", (rtl->promisc) ? "ENABLED" : "DISABLED"); // Print virtual memory rings pointers // kprintf("\n\rRTL8139: rx_ring=%p<->%p, tx_ring=%p<->%p", rtl->rx_ring, rtl->rx_ring + RX_BUF_LEN, rtl->tx_ring, rtl->tx_ring + PAGE_ALIGN_UP(TX_BUF_SIZE*NUM_TX_DESC) ); // Well done! // kprintf("\n\rRTL8139: OK, ethernet card is ready!"); ip = ntohl( get_host_ip() ); netmask = ntohl( get_host_netmask() ); ip_bcast = (~netmask) | (ip & netmask); kprintf("\n\n\rhost ip=%u.%u.%u.%u netmask=%u.%u.%u.%u broadcast=%u.%u.%u.%u\n\r", IP_A(ip), IP_B(ip), IP_C(ip), IP_D(ip), IP_A(netmask), IP_B(netmask), IP_C(netmask), IP_D(netmask), IP_A(ip_bcast), IP_B(ip_bcast), IP_C(ip_bcast), IP_D(ip_bcast) ); }

void rtl8139_handler (    )

The RTL8139 interrupt handler routine. It is invoked every time that an ethernet packet is received or when a packet has been transmitted. Definition at line 626 of file rtl8139.c. { uint16_t status; out16(rtl->iobase + IntrMask, 0); status = in16(rtl->iobase + IntrStatus); // Acknowledge all known interrupts // out16(rtl->iobase + IntrStatus, status & ~(RxFIFOOver | RxOverflow | RxOK)); if (status & (RxOK | RxErr)) rtl8139_handle_rx(rtl); else if (status & (TxOK | TxErr)) rtl8139_handle_tx(rtl); // #ifdef DEBUG else kprintf("\n\rRTL8139: unknown interrupt: isr = %#010x\n", status); // #endif // Re-enable interrupts from the RTL8139 card // out16(rtl->iobase + IntrStatus, status & (RxFIFOOver | RxOverflow | RxOK)); out16(rtl->iobase + IntrMask, IntrDefault); }

int rtl8139_init (  bool    promisc )

Initialize the RTL8139 driver. Parameters: promisc  TRUE initialize the card and put it in promiscuous mode; FALSE initialize the card and don't put it in promiscuous mode. Returns: 0 if we can successfully enable the RTL8139 ethernet card; -ENXIO if the device if not present on PCI bus; -EIO if we cannot read ethernet card informations;. Definition at line 358 of file rtl8139.c. { pci_cfg_t cfg; unsigned i; dword IF = GET_IF(); // Search an ethernet device on PCI and enable it! // cfg.base_class = 0x02; // Ethernet class // cfg.sub_class = 0x00; // Ethernet sub_class // cfg.interface = 0x00; // Ethernet interface // if ( !pci_find_cfg(&cfg, TRUE) ) { return(-ENXIO); } // Close a previous RTL8139 structure if present // if ( rtl != NULL ) { rtl8139_close(&rtl); } // Allocate the RTL8139 structure // rtl = kmalloc(sizeof(rtl8139_t)); if ( !rtl ) return(-ENOMEM); memset(rtl, 0, sizeof(rtl8139_t)); // Setup the I/O base register // for (i=0; i<6; i++) if ( (rtl->iobase=cfg.base[i]) != 0 ) break; // Check if the device I/O base address is valid // if ( rtl->iobase == 0 ) { kfree(rtl); return(-EIO); } // Setup the IRQ line // disable(); rtl->irq = cfg.irq; install_irq_handler( rtl->irq, (void *)&rtl8139_handler ); // Bring the chip out of low-power mode // out(rtl->iobase + Config1, 0x00); // Read the MAC address // if (rtl8139_read_eeprom(rtl, 0) != 0xFFFF) { // Read from EEPROM // unsigned short *ap = (unsigned short*)rtl->station_address; for (i = 0; i < 3; i++) *ap++ = rtl8139_read_eeprom(rtl, i + 7); } else { // Read from MAC0 register // unsigned char *ap = (unsigned char*)rtl->station_address; for (i = 0; i < 6; i++) *ap++ = in(rtl->iobase + MAC0 + i); } // Read the media informations // rtl->speed10 = (in(rtl->iobase + MediaStatus) & MSRSpeed10) != 0; rtl->fullduplex = (in16(rtl->iobase + MII_BMCR) & BMCRDuplex) != 0; // Setup the promiscuous mode // rtl->promisc = promisc; // Initialize the Rx and Tx rings buffer // if ( !(rtl->rx_ring) ) { rtl->rx_phys = (addr_t)dma_phys_alloc(RX_BUF_LEN); rtl->rx_ring = PHYSICAL( (uint8_t *)(rtl->rx_phys) ); } if ( !(rtl->tx_ring) ) { rtl->tx_phys = (addr_t)dma_phys_alloc(TX_BUF_SIZE*NUM_TX_DESC); rtl->tx_ring = PHYSICAL( (uint8_t *)(rtl->tx_phys) ); } // Initialize the RTL8139 mutex semaphore // INIT_MUTEX(&rtl->mutex); // Hardware reset of the RTL8139 // rtl8139_reset(rtl); // Well done! // SET_IF(IF); return(0); }

void rtl8139_promisc (  rtl8139_t *    rtl, bool    on )

Enable/disable the promiscuous mode for the RTL8139 card. Parameters: rtl  The RTL8139 structure. on  TRUE enable the promiscuous mode; FALSE disable the promiscuous mode. Definition at line 265 of file rtl8139.c. { uint8_t rxc; dword IF = GET_IF(); disable(); rxc = in(rtl->iobase + RxConfig); if ( on ) out(rtl->iobase + RxConfig, rxc | AcceptAllPhys); else out(rtl->iobase + RxConfig, rxc & (~AcceptAllPhys)); rtl->promisc = on; SET_IF(IF); }

int send_rtl8139_packet (  rtl8139_t *    rtl, const void *    data, size_t    len )

Send an ethernet packet to the physiscal layer. Parameters: rtl  The RTL8139 structure. data  The data to be sent. len  The size of the data to be sent in bytes. Returns: The number of bytes sent, or -1 if an error occurred. Todo: Set up a timeout for the transmitted packets. Definition at line 481 of file rtl8139.c. { // Check if the RTL8139 card has been configured // if ( !rtl ) return(-1); // Adapt the packet length to the Tx buffer size // // This should be done by the ethernet layer... // len = MIN(len, TX_BUF_SIZE); // Enter critical region // DOWN(&rtl->mutex); // kprintf("\n\rlooking for buffer %u", desc); if ( in32(rtl->iobase + TxStatus0 + (rtl->cur_tx * 4)) & TxHostOwns ) { // Found a free buffer! // // Copy the raw data to the Tx ring // memcpy(rtl->tx_ring + (TX_BUF_SIZE*rtl->cur_tx), data, len); // NOTE: RTL8139 doesn't auto-pad! Be sure that // // the ethernet layer has done it correctly // while (len < ETH_MIN_LEN) (rtl->tx_ring + (TX_BUF_SIZE*rtl->cur_tx))[len++] = '\0'; // Move the data from the Tx buffer to the // // internal transmit FIFO in PCI bus master // // mode // out32(rtl->iobase + TxAddr0 + rtl->cur_tx * 4, rtl->tx_phys + (TX_BUF_SIZE * rtl->cur_tx)); out32(rtl->iobase + TxStatus0 + rtl->cur_tx * 4, ((TX_FIFO_THRESH<<11) & 0x003F0000) | len); // Select new descriptor for transmition // rtl->cur_tx = (rtl->cur_tx + 1) % NUM_TX_DESC; // End of critical region // UP(&rtl->mutex); // Return the byte transmitted // return(len); } // End of critical region // UP(&rtl->mutex); // Buffer not available! // return(-1); }

---