via-rhine.c revision 677833bc953b6cb418c701facbdcf4aa18d6c44e
/* rhine.c:Fast Ethernet driver for Linux. */
/*
Adapted 09-jan-2000 by Paolo Marini (paolom@prisma-eng.it)
originally written by Donald Becker.
This software may be used and distributed according to the terms
of the GNU Public License (GPL), incorporated herein by reference.
Drivers derived from this code also fall under the GPL and must retain
this authorship and copyright notice.
Under no circumstances are the authors responsible for
the proper functioning of this software, nor do the authors assume any
responsibility for damages incurred with its use.
This driver is designed for the VIA VT86C100A Rhine-II PCI Fast Ethernet
controller.
*/
/* A few user-configurable values. */
// max time out delay time
#define W_MAX_TIMEOUT 0x0FFFU
/* Size of the in-memory receive ring. */
/* Size of the Tx bounce buffers -- must be at least (dev->mtu+14+4). */
#define TX_BUF_SIZE 1536
#define RX_BUF_SIZE 1536
/* PCI Tuning Parameters
Threshold is bytes transferred to chip before transmission starts. */
/* The following settings are log_2(bytes)-4: 0 == 16 bytes .. 6==1024. */
#define TX_DMA_BURST 4
/* Operational parameters that usually are not changed. */
/* Time in jiffies before concluding the transmitter is hung. */
#include "etherboot.h"
#include "nic.h"
#include "pci.h"
#include "timer.h"
/* define all ioaddr */
/*--------------------- Exioaddr Definitions -------------------------*/
/*
* Bits in the RCR register
*/
#define RCR_RRFT2 0x80
#define RCR_RRFT1 0x40
#define RCR_RRFT0 0x20
#define RCR_PROM 0x10
#define RCR_AB 0x08
#define RCR_AM 0x04
#define RCR_AR 0x02
#define RCR_SEP 0x01
/*
* Bits in the TCR register
*/
#define TCR_RTSF 0x80
#define TCR_RTFT1 0x40
#define TCR_RTFT0 0x20
#define TCR_OFSET 0x08
/*
* Bits in the CR0 register
*/
#define CR0_TXON 0x10
#define CR0_RXON 0x08
/*
* Bits in the CR1 register
*/
/*
* Bits in the CR register
*/
#define CR_TXON 0x0010
#define CR_RXON 0x0008
/*
* Bits in the IMR0 register
*/
#define IMR0_CNTM 0x80
#define IMR0_BEM 0x40
#define IMR0_RUM 0x20
#define IMR0_TUM 0x10
#define IMR0_TXEM 0x08
#define IMR0_RXEM 0x04
#define IMR0_PTXM 0x02
#define IMR0_PRXM 0x01
/* define imrshadow */
#define IMRShadow 0x5AFF
/*
* Bits in the IMR1 register
*/
#define IMR1_INITM 0x80
#define IMR1_SRCM 0x40
#define IMR1_NBFM 0x10
#define IMR1_PRAIM 0x08
#define IMR1_RES0M 0x04
#define IMR1_ETM 0x02
#define IMR1_ERM 0x01
/*
* Bits in the ISR register
*/
#define ISR_INITI 0x8000
#define ISR_SRCI 0x4000
#define ISR_ABTI 0x2000
#define ISR_NORBF 0x1000
#define ISR_PKTRA 0x0800
#define ISR_RES0 0x0400
#define ISR_ETI 0x0200
#define ISR_ERI 0x0100
#define ISR_CNT 0x0080
#define ISR_BE 0x0040
#define ISR_RU 0x0020
#define ISR_TU 0x0010
#define ISR_TXE 0x0008
#define ISR_RXE 0x0004
#define ISR_PTX 0x0002
#define ISR_PRX 0x0001
/*
* Bits in the ISR0 register
*/
#define ISR0_CNT 0x80
#define ISR0_BE 0x40
#define ISR0_RU 0x20
#define ISR0_TU 0x10
#define ISR0_TXE 0x08
#define ISR0_RXE 0x04
#define ISR0_PTX 0x02
#define ISR0_PRX 0x01
/*
* Bits in the ISR1 register
*/
#define ISR1_INITI 0x80
#define ISR1_SRCI 0x40
#define ISR1_NORBF 0x10
#define ISR1_PKTRA 0x08
#define ISR1_ETI 0x02
#define ISR1_ERI 0x01
/* ISR ABNORMAL CONDITION */
/*
* Bits in the MIISR register
*/
#define MIISR_MIIERR 0x08
#define MIISR_MRERR 0x04
#define MIISR_LNKFL 0x02
#define MIISR_SPEED 0x01
/*
* Bits in the MIICR register
*/
#define MIICR_MAUTO 0x80
#define MIICR_RCMD 0x40
#define MIICR_WCMD 0x20
#define MIICR_MDPM 0x10
#define MIICR_MOUT 0x08
#define MIICR_MDO 0x04
#define MIICR_MDI 0x02
#define MIICR_MDC 0x01
/*
* Bits in the EECSR register
*/
/*
* Bits in the BCR0 register
*/
#define BCR0_CRFT2 0x20
#define BCR0_CRFT1 0x10
#define BCR0_CRFT0 0x08
#define BCR0_DMAL2 0x04
#define BCR0_DMAL1 0x02
#define BCR0_DMAL0 0x01
/*
* Bits in the BCR1 register
*/
#define BCR1_CTSF 0x20
#define BCR1_CTFT1 0x10
#define BCR1_CTFT0 0x08
#define BCR1_POT2 0x04
#define BCR1_POT1 0x02
#define BCR1_POT0 0x01
/*
* Bits in the CFGA register
*/
#define CFGA_JUMPER 0x40
#define CFGA_MTGPIO 0x08
#define CFGA_T10EN 0x02
#define CFGA_AUTO 0x01
/*
* Bits in the CFGB register
*/
#define CFGB_PD 0x80
#define CFGB_POLEN 0x02
#define CFGB_LNKEN 0x01
/*
* Bits in the CFGC register
*/
#define CFGC_M10TIO 0x80
#define CFGC_M10POL 0x40
#define CFGC_PHY1 0x20
#define CFGC_PHY0 0x10
#define CFGC_BTSEL 0x08
/*
* Bits in the CFGD register
*/
#define CFGD_GPIOEN 0x80
#define CFGD_DIAG 0x40
#define CFGD_MAGIC 0x10
#define CFGD_RANDOM 0x08
#define CFGD_CFDX 0x04
#define CFGD_CEREN 0x02
#define CFGD_CETEN 0x01
/* Bits in RSR */
#define RSR_RERR 0x00000001
#define RSR_CRC 0x00000002
#define RSR_FAE 0x00000004
#define RSR_FOV 0x00000008
#define RSR_LONG 0x00000010
#define RSR_RUNT 0x00000020
#define RSR_SERR 0x00000040
#define RSR_BUFF 0x00000080
#define RSR_EDP 0x00000100
#define RSR_STP 0x00000200
#define RSR_CHN 0x00000400
#define RSR_PHY 0x00000800
#define RSR_BAR 0x00001000
#define RSR_MAR 0x00002000
#define RSR_RXOK 0x00008000
/* Bits in TSR */
#define TSR_NCR0 0x00000001
#define TSR_NCR1 0x00000002
#define TSR_NCR2 0x00000004
#define TSR_NCR3 0x00000008
#define TSR_COLS 0x00000010
#define TSR_CDH 0x00000080
#define TSR_ABT 0x00000100
#define TSR_OWC 0x00000200
#define TSR_CRS 0x00000400
#define TSR_UDF 0x00000800
#define TSR_TBUFF 0x00001000
#define TSR_SERR 0x00002000
#define TSR_JAB 0x00004000
#define TSR_TERR 0x00008000
#define TSR_OWN_BIT 0x80000000
/* enabled mask value of irq */
/* Ethernet address filter type */
#define PKT_TYPE_MULTICAST 0x0002
#define PKT_TYPE_ALL_MULTICAST 0x0004
#define PKT_TYPE_BROADCAST 0x0008
#define PKT_TYPE_PROMISCUOUS 0x0020
#define PKT_TYPE_LONG 0x2000
#define PKT_TYPE_RUNT 0x4000
/* Loopback mode */
#define NIC_LB_NONE 0x00
#define NIC_LB_INTERNAL 0x01
#define TX_RING_SIZE 2
#define RX_RING_SIZE 2
#define PCI_REG_MODE3 0x53
enum rhine_revs {
VT86C100A = 0x00,
VTunknown0 = 0x20,
VT6102 = 0x40,
VTunknown1 = 0x7C,
VT6105 = 0x80,
VT6105_B0 = 0x83,
VT6105L = 0x8A,
VT6107 = 0x8C,
VTunknown2 = 0x8E,
VT6105M = 0x90,
};
/* Transmit and receive descriptors definition */
struct rhine_tx_desc
{
union VTC_tx_status_tag
{
struct
{
unsigned long ncro:1;
unsigned long ncr1:1;
unsigned long ncr2:1;
unsigned long ncr3:1;
unsigned long cols:1;
unsigned long reserve_1:2;
unsigned long cdh:1;
unsigned long abt:1;
unsigned long owc:1;
unsigned long crs:1;
unsigned long udf:1;
unsigned long tbuff:1;
unsigned long serr:1;
unsigned long jab:1;
unsigned long terr:1;
unsigned long reserve_2:15;
unsigned long own_bit:1;
}
bits;
unsigned long lw;
}
union VTC_tx_ctrl_tag
{
struct
{
unsigned long tx_buf_size:11;
unsigned long extend_tx_buf_size:4;
unsigned long chn:1;
unsigned long crc:1;
unsigned long reserve_1:4;
unsigned long stp:1;
unsigned long edp:1;
unsigned long ic:1;
unsigned long reserve_2:8;
}
bits;
unsigned long lw;
}
unsigned long buf_addr_1:32;
unsigned long buf_addr_2:32;
};
struct rhine_rx_desc
{
union VTC_rx_status_tag
{
struct
{
unsigned long rerr:1;
unsigned long crc_error:1;
unsigned long fae:1;
unsigned long fov:1;
unsigned long toolong:1;
unsigned long runt:1;
unsigned long serr:1;
unsigned long buff:1;
unsigned long edp:1;
unsigned long stp:1;
unsigned long chn:1;
unsigned long phy:1;
unsigned long bar:1;
unsigned long mar:1;
unsigned long reserve_1:1;
unsigned long rxok:1;
unsigned long frame_length:11;
unsigned long reverve_2:4;
unsigned long own_bit:1;
}
bits;
unsigned long lw;
}
union VTC_rx_ctrl_tag
{
struct
{
unsigned long rx_buf_size:11;
unsigned long extend_rx_buf_size:4;
unsigned long reserved_1:17;
}
bits;
unsigned long lw;
}
unsigned long buf_addr_1:32;
unsigned long buf_addr_2:32;
};
/* The I/O extent. */
#define rhine_TOTAL_SIZE 0x80
#ifdef HAVE_DEVLIST
struct netdev_entry rhine_drv =
#endif
static int rhine_debug = 1;
/*
Theory of Operation
I. Board Compatibility
This driver is designed for the VIA 86c100A Rhine-II PCI Fast Ethernet
controller.
II. Board-specific settings
Boards with this chip are functional only in a bus-master PCI slot.
Many operational settings are loaded from the EEPROM to the Config word at
offset 0x78. This driver assumes that they are correct.
If this driver is compiled to use PCI memory space operations the EEPROM
must be configured to enable memory ops.
III. Driver operation
IIIa. Ring buffers
This driver uses two statically allocated fixed-size descriptor lists
formed into rings by a branch from the final descriptor to the beginning of
the list. The ring sizes are set at compile time by RX/TX_RING_SIZE.
This driver attempts to use a zero-copy receive and transmit scheme.
Alas, all data buffers are required to start on a 32 bit boundary, so
the driver must often copy transmit packets into bounce buffers.
The driver allocates full frame size skbuffs for the Rx ring buffers at
open() time and passes the skb->data field to the chip as receive data
buffers. When an incoming frame is less than RX_COPYBREAK bytes long,
a fresh skbuff is allocated and the frame is copied to the new skbuff.
When the incoming frame is larger, the skbuff is passed directly up the
protocol stack. Buffers consumed this way are replaced by newly allocated
skbuffs in the last phase of netdev_rx().
The RX_COPYBREAK value is chosen to trade-off the memory wasted by
using a full-sized skbuff for small frames vs. the copying costs of larger
frames. New boards are typically used in generously configured machines
and the underfilled buffers have negligible impact compared to the benefit of
a single allocation size, so the default value of zero results in never
copying packets. When copying is done, the cost is usually mitigated by using
most useful with small frames.
Since the VIA chips are only able to transfer data to buffers on 32 bit
boundaries, the the IP header at offset 14 in an ethernet frame isn't
longword aligned for further processing. Copying these unaligned buffers
has the beneficial effect of 16-byte aligning the IP header.
IIId. Synchronization
The driver runs as two independent, single-threaded flows of control. One
is the send-packet routine, which enforces single-threaded use by the
dev->tbusy flag. The other thread is the interrupt handler, which is single
threaded by the hardware and interrupt handling software.
The send packet thread has partial control over the Tx ring and 'dev->tbusy'
flag. It sets the tbusy flag whenever it's queuing a Tx packet. If the next
queue slot is empty, it clears the tbusy flag when finished otherwise it sets
the 'lp->tx_full' flag.
The interrupt handler has exclusive control over the Rx ring and records stats
from the Tx ring. After reaping the stats, it marks the Tx queue entry as
empty by incrementing the dirty_tx mark. Iff the 'lp->tx_full' flag is set, it
clears both the tx_full and tbusy flags.
IV. Notes
IVb. References
Preliminary VT86C100A manual from http://www.via.com.tw/
IVc. Errata
The VT86C100A manual is not reliable information.
The chip does not handle unaligned transmit or receive buffers, resulting
in significant performance degradation for bounce buffer copies on transmit
and unaligned IP headers on receive.
The chip does not pad to minimum transmit length.
*/
/* The rest of these values should never change. */
static struct rhine_private
{
const char *product_name;
struct rhine_rx_desc *rx_ring;
struct rhine_tx_desc *tx_ring;
char *rx_buffs[RX_RING_SIZE];
char *tx_buffs[TX_RING_SIZE];
/* temporary Rx buffers. */
int chip_id;
int chip_revision;
unsigned short ioaddr;
}
static int QueryAuto (int);
static int ReadMII (int byMIIIndex, int);
static void WriteMII (char, char, char, int);
static void MIIDelay (void);
unsigned int s, const char *p);
static void reload_eeprom(int ioaddr);
static void reload_eeprom(int ioaddr)
{
int i;
/* Typically 2 cycles to reload. */
for (i = 0; i < 150; i++)
break;
}
/* Initialize the Rx and Tx rings, along with various 'dev' bits. */
static void
{
int i;
for (i = 0; i < RX_RING_SIZE; i++)
{
/* printf("[%d]buf1=%hX,buf2=%hX",i,tp->rx_ring[i].buf_addr_1,tp->rx_ring[i].buf_addr_2); */
}
/* Mark the last entry as wrapping the ring. */
/* tp->rx_ring[i-1].rx_ctrl.bits.rx_buf_size =1518; */
/*printf("[%d]buf1=%hX,buf2=%hX",i-1,tp->rx_ring[i-1].buf_addr_1,tp->rx_ring[i-1].buf_addr_2); */
/* The Tx buffer descriptor is filled in as needed, but we
do need to clear the ownership bit. */
for (i = 0; i < TX_RING_SIZE; i++)
{
/* printf("[%d]buf1=%hX,buf2=%hX",i,tp->tx_ring[i].buf_addr_1,tp->tx_ring[i].buf_addr_2); */
}
/* printf("[%d]buf1=%hX,buf2=%hX",i,tp->tx_ring[i-1].buf_addr_1,tp->tx_ring[i-1].buf_addr_2); */
}
int
{
int byMIIIndex;
int MIIReturn;
int advertising,mii_reg5;
int negociated;
byMIIIndex = 0x04;
byMIIIndex = 0x05;
return 1;
else
return 0;
}
int
{
int ReturnMII;
char byMIIAdrbak;
char byMIICRbak;
char byMIItemp;
MIIDelay ();
MIIDelay ();
while (byMIItemp != 0 && timer2_running())
{
}
MIIDelay ();
MIIDelay ();
return (ReturnMII);
}
void
{
int ReadMIItmp;
int MIIMask;
char byMIIAdrbak;
char byMIICRbak;
char byMIItemp;
MIIDelay ();
MIIDelay ();
while (byMIItemp != 0 && timer2_running())
{
}
MIIDelay ();
MIIMask = 0x0001;
if (byMIIOP == 0)
{
}
else
{
}
MIIDelay ();
while (byMIItemp != 0 && timer2_running())
{
}
MIIDelay ();
MIIDelay ();
}
void
MIIDelay (void)
{
int i;
for (i = 0; i < 0x7fff; i++)
{
inb (0x61);
inb (0x61);
inb (0x61);
inb (0x61);
}
}
/* Offsets to the device registers. */
enum register_offsets {
PwrcsrClr=0xAC,
};
enum intr_status_bits {
IntrPCIErr=0x0040,
IntrRxWakeUp=0x8000,
IntrTxErrSummary=0x082218,
};
/***************************************************************************
IRQ - PXE IRQ Handler
***************************************************************************/
/* Enable interrupts by setting the interrupt mask. */
unsigned int intr_status;
switch ( action ) {
case DISABLE :
case ENABLE :
/* On Rhine-II, Bit 3 indicates Tx descriptor write-back race. */
/* added comment by guard */
/* For supporting VT6107, please use revision id to recognize different chips in driver */
// if (tp->chip_id == 0x3065)
break;
case FORCE :
break;
}
}
static int
{
return 0;
rhine_reset (nic);
return 1;
}
unsigned char rx_mode;
/* ! IFF_PROMISC */
rx_mode = 0x0C;
}
static void
{
struct rhine_private *tp;
static int did_version = 0; /* Already printed version info. */
int i, ww;
unsigned int timeout;
int FDXFlag;
unsigned char mode3_reg;
if (rhine_debug > 0 && did_version++ == 0)
// get revision id.
/* D-Link provided reset code (with comment additions) */
if (revision_id >= 0x40) {
unsigned char byOrgValue;
if(rhine_debug > 0)
printf("Enabling Sticky Bit Workaround for Chip_id: 0x%hX\n"
, chip_id);
/* clear sticky bit before reset & read ethernet address */
/* (bits written are cleared?) */
/* disable force PME-enable */
/* disable power-event config bit */
/* clear power status (undocumented in vt6102 docs?) */
}
/* Reset the chip to erase previous misconfiguration. */
// if vt3043 delay after reset
if (revision_id <0x40) {
udelay(10000);
}
// polling till software reset complete
// W_MAX_TIMEOUT is the timeout period
break;
}
// issue AUTOLoad in EECSR to reload eeprom
// if vt3065 delay after reset
if (revision_id >=0x40) {
// delay 8ms to let MAC stable
mdelay(8);
/*
* for 3065D, EEPROM reloaded will cause bit 0 in MAC_REG_CFGA
* turned on. it makes MAC receive magic packet
* automatically. So, we turn it off. (D-Link)
*/
}
/* turn on bit2 in PCI configuration register 0x53 , only for 3065*/
if (revision_id >= 0x40) {
}
/* back off algorithm ,disable the right-most 4-bit off CFGD*/
/* reload eeprom */
/* Perhaps this should be read from the EEPROM? */
for (i = 0; i < ETH_ALEN; i++)
/* restart MII auto-negotiation */
printf ("Analyzing Media type,this will take several seconds........");
for (i = 0; i < 5; i++)
{
/* need to wait 1 millisecond - we will round it up to 50-100ms */
/* nothing */;
break;
}
printf ("OK\n");
#if 0
/* JJM : for Debug */
{
}
#endif
/* query MII to know LineSpeed,duplex mode */
if (LineSpeed != 0) //JJM
{
printf ("Linespeed=10Mbs");
}
else
{
printf ("Linespeed=100Mbs");
}
if (FDXFlag == 1)
{
printf (" Fullduplex\n");
}
else
{
printf (" Halfduplex\n");
}
/* set MII 10 FULL ON, only apply in vt3043 */
if(chip_id == 0x3043)
/* turn on MII link change */
MIIDelay ();
MIIDelay ();
/* while((inb(byMIIAD)&0x20)==0) ; */
/* The lower four bits are the media type. */
if (options > 0)
{
if (tp->default_port)
}
return;
}
static void
{
/* merge reset and disable */
printf ("rhine disable\n");
/* Switch to loopback mode to avoid hardware races. */
/* Stop the chip's Tx and Rx processes. */
}
/**************************************************************************
ETH_RESET - Reset adapter
***************************************************************************/
static void
{
int i, j;
int rx_ring_tmp, rx_ring_tmp1;
int tx_ring_tmp, tx_ring_tmp1;
int rx_bufs_tmp, rx_bufs_tmp1;
int tx_bufs_tmp, tx_bufs_tmp1;
/* printf ("rhine_reset\n"); */
/* Soft reset the chip. */
/*outb(CmdReset, ioaddr + ChipCmd); */
tx_bufs_tmp = (int) buf1;
tx_ring_tmp = (int) desc1;
rx_bufs_tmp = (int) buf2;
rx_ring_tmp = (int) desc2;
/* tune RD TD 32 byte alignment */
/* printf ("txring[%d]", j); */
/* printf ("rxring[%X]", j); */
tx_bufs_tmp = (int) bus_to_virt (j);
/* printf ("txb[%X]", j); */
rx_bufs_tmp = (int) bus_to_virt (j);
/* printf ("rxb[%X][%X]", rx_bufs_tmp1, j); */
for (i = 0; i < RX_RING_SIZE; i++)
{
/* printf("r[%X]",tp->rx_buffs[i]); */
rx_bufs_tmp += 1536;
}
for (i = 0; i < TX_RING_SIZE; i++)
{
/* printf("t[%X]",tp->tx_buffs[i]); */
tx_bufs_tmp += 1536;
}
/* software reset */
MIIDelay ();
/* printf ("init ring"); */
/*write TD RD Descriptor to MAC */
/* Setup Multicast */
/* set TCR RCR threshold to store and forward*/
/* Set Fulldupex */
if (FDXFlag == 1)
{
}
/* KICK NIC to WORK */
/* disable all known interrupt */
}
/* Beware of PCI posted writes */
static int
{
{
unsigned int intr_status;
/* There is a packet ready */
if(!retreive)
return 1;
/* On Rhine-II, Bit 3 indicates Tx descriptor write-back race. */
#if 0
#endif
/* Acknowledge all of the current interrupt sources ASAP. */
if (intr_status & IntrTxDescRace)
{
printf("rhine_poll: bad status\n");
}
else if (rxstatus & (RSR_ABNORMAL))
{
}
else
good = 1;
if (good)
{
/* printf ("Packet RXed\n"); */
}
}
/* Acknowledge all of the current interrupt sources ASAP. */
return good;
}
static void
const char *d, unsigned int t, unsigned int s, const char *p)
{
int entry;
unsigned char CR1bak;
unsigned char CR0bak;
unsigned int nstype;
/*printf ("rhine_transmit\n"); */
/* setup ethernet header */
/* Calculate the next Tx descriptor entry. */
s += ETH_HLEN;
while (s < ETH_ZLEN)
/*printf("tdsw=[%X]",tp->tx_ring[entry].tx_status.lw); */
/*printf("tdcw=[%X]",tp->tx_ring[entry].tx_ctrl.lw); */
/*printf("tdbuf1=[%X]",tp->tx_ring[entry].buf_addr_1); */
/*printf("tdbuf2=[%X]",tp->tx_ring[entry].buf_addr_2); */
/*printf("td1=[%X]",inl(dwCurrentTDSE0)); */
/*printf("td2=[%X]",inl(dwCurrentTDSE1)); */
/*printf("td3=[%X]",inl(dwCurrentTDSE2)); */
/*printf("td4=[%X]",inl(dwCurrentTDSE3)); */
do
{
/* Wait until transmit is finished or timeout*/
;
break;
{
// turn on TX
}
}while(0);
/*outw(IMRShadow,byIMR0); */
/*dev_kfree_skb(tp->tx_skbuff[entry], FREE_WRITE); */
/*tp->tx_skbuff[entry] = 0; */
}
static struct pci_id rhine_nics[] = {
};
.type = NIC_DRIVER,
.name = "VIA 86C100",
.probe = rhine_probe,
.ids = rhine_nics,
.class = 0,
};
/* EOF via-rhine.c */