dec21x40end.c

Tornado 2.0.2 source code!vxworks的源代码

/* dec21x40End.c - END-style DEC 21x40 PCI Ethernet network interface driver */

/* Copyright 1984-2000 Wind River Systems, Inc. */
#include "copyright_wrs.h"

/*
modification history
--------------------
02q,11jun00,ham  removed reference to etherLib.
02p,08may00,jgn  SPR 31198, Various fixes for use on ARM + Kingston KNE100TX (MII) card
02o,24apr00,dmw  Fixed extended format block type 2 selection.
02n,24apr00,dmw  Added Full Duplex support for adapters with PHY's.
02m,24mar00,dat  fixed string handling, added fix to reset code
02l,01mar00,stv  fixed backward compatibility issues for the alignment fix.Also
                 corrected documentation & updated a debug message. 
02k,24feb00,stv  made a selective merge to add alignment fix.
02j,27jan00,dat  fixed use of NULL
02i,08nov99,cn   integrated with miiLib. Also fixed SPR #21116, #28315.
02h,01oct99,pfl  Fix for spr 22196 was missing, added it again.
02g,16sep99,stv  Fixed errors due to usage of DRV_LOG macro.
02f,01sep99,dat  SPR 28573 and Debug clean up.
02e,17aug99,dmw  Added MII/Phy force modes.
02d,11mar99,tm   Added MII/Phy r/w for 2114x link status check (SPR 22196)
02c,02mar99,tm   txRingClean in ISR to improve small pkt throughput (SPR 23950)
02b,01feb99,scb  Added support for dec21143. (SPR 22887)
02a,30sep98,dbt  Adding missing code in poll receive routine.
01z,22sep98,dat  SPR 22325, system mode transition + lint fixes.
01y,07aug98,cn   updated documentation about user flags.
01w,31jul98,cn   removed setting CSR6_FD in xxxMediaSelect [SPR# 21683].
		 Also moved some indeces setting in xxxStart [SPR#21557].
01v,20apr98,map  preserve CSR6_PS in xxxChipReset [SPR# 21013]
01u,10dec97,kbw  man page fiddlings
01t,08dec97,gnn  END code review fixes.
01s,20nov97,gnn  fixed spr#9555, configurable TDS and RDS.
01r,19oct97,vin	 moved swapping of loaned buffer before END_RCV_RTN_CALL
01q,17oct97,vin  removed extra free.
01p,09oct97,vin  delete unwanted frees in PollSend routine
01o,07oct97,vin  fixed multicasting, MIB MTU size to ETHER_MTU
01n,25sep97,gnn  SENS beta feedback fixes
01m,24sep97,vin  added clBlk related calls
01l,02sep97,gnn  fixed a race condition in the txRestart handling.
01k,25aug97,vin  adjusted cluster mem size.
01j,22aug97,vin  fixed initialization of cluster mem area.
01i,22aug97,gnn  fixed a bug in polled mode.
01h,21aug97,vin  added changes for newBuffering API
01g,12aug97,gnn  changes necessitated by MUX/END update.
01f,08aug97,map  fixed muxBufInit for user-specified bufpool.
                 added ilevel arg to sysLanIntDisable().
                 update collision statistics.
                 added more flags to userFlags.
01e,10jun97,map  renamed funcDec21x40MediaSelect to _func_dec21x40MediaSelect.
01d,28may97,kbw  general text edit
            map  added DEC SROM support for media configuration.
01c,23apr97,map  cleaned up; replaced SWAP_SHORT with PCISWAP_SHORT.
01b,16apr97,map  added support for dec21140.
01a,07apr97,map  modified if_dc.c to END style.
*/

/*
This module implements a DEC 21x40 PCI Ethernet network interface driver and
supports both the 21040, 21140, and 21143 versions of the chip.

The DEC 21x40 PCI Ethernet controller is little endian because it interfaces
with a little-endian PCI bus.  Although PCI configuration for a device is
handled in the BSP, all other device programming and initialization needs 
are handled in this module.

This driver is designed to be moderately generic. Without modification, it can
operate across the full range of architectures and targets supported by VxWorks.
To achieve this, the driver requires a few external support routines as well
as several target-specific parameters.  These parameters, and the mechanisms
used to communicate them to the driver, are detailed below.  If any of the
assumptions stated below are not true for your particular hardware, you need
to modify the driver before it can operate correctly on your hardware.

On the 21040, the driver configures the 10BASE-T interface by default, waits for
two seconds, and checks the status of the link. If the link status indicates
failure, AUI interface is configured.

On other versions of the 21x40 family, the driver reads media information from
a DEC serial ROM and configures the media.  To configure the media on targets 
that do not support a DEC format serial ROM, the driver calls the 
target-specific media-select routine referenced in
the `_func_dec21x40MediaSelect' hook. 

The driver supports big-endian or little-endian architectures (as a 
configurable option).  The driver also and contains error recovery code 
that handles known device errata related to DMA activity.

Big-endian processors can be connected to the PCI bus through some controllers
that take care of hardware byte swapping. In such cases, all the registers
which the chip DMAs to have to be swapped and written to, so that when the
hardware swaps the accesses, the chip would see them correctly. The chip still
has to be programmed to operate in little endian mode as it is on the PCI
bus.  If the cpu board hardware automatically swaps all the accesses to and
from the PCI bus, then input and output byte stream need not be swapped.

BOARD LAYOUT
This device is on-board.  No jumpering diagram is necessary.

EXTERNAL INTERFACE
The driver provides one standard external interface, dec21x40EndLoad().  As 
input, this function expects a string of colon-separated parameters. The 
parameters should be specified as hexadecimal strings (optionally preceded 
by "0x" or a minus sign "-").  Although the parameter string is parsed 
using endTok_r(), each parameter is converted from string to binary by a 
call to:
.CS
    strtoul(parameter, NULL, 16).
.CE

The format of the parameter string is:

 "<deviceAddr>:<pciAddr>:<iVec>:<iLevel>:<numRds>:<numTds>:\
<memBase>:<memSize>:<userFlags>:<phyAddr>:<pPhyTbl>:<phyFlags>:<offset>"

TARGET-SPECIFIC PARAMETERS
.IP <deviceAddr>
This is the base address at which the hardware device registers are located.
.IP <pciAddr>
This parameter defines the main memory address over the PCI bus. It is used to
translate a physical memory address into a PCI-accessible address.
.IP <iVec>
This is the interrupt vector number of the hardware interrupt generated by
this Ethernet device.  The driver uses intConnect() to attach an interrupt
handler for this interrupt.
.IP <iLevel>
This parameter defines the level of the hardware interrupt.
.IP <numRds>
The number of receive descriptors to use.  This controls how much data
the device can absorb under load.  If this is specified as NONE (-1), 
the default of 32 is used.
.IP <numTds>
The number of transmit descriptors to use.  This controls how much data
the device can absorb under load.  If this is specified as NONE (-1) then
the default of 64 is used.
.IP <memBase>
This parameter specifies the base address of a DMA-able cache-free
pre-allocated memory region for use as a memory pool for transmit/receive
descriptors and buffers.
If there is no pre-allocated memory available for the driver, this parameter
should be -1 (NONE). In which case, the driver allocates cache safe memory
for its use using cacheDmaAlloc().
.IP <memSize>
The memory size parameter specifies the size of the pre-allocated memory
region. If memory base is specified as NONE (-1), the driver ignores this
parameter.
.IP <userFlags>
User flags control the run-time characteristics of the Ethernet
chip.  Most flags specify non default CSR0 and CSR6 bit values. Refer to
dec21x40End.h for the bit values of the flags and to the device hardware
reference manual for details about device capabilities, CSR6 and CSR0.
.IP <phyAddr>
This optional parameter specifies the address on the MII (Media Independent
Interface) bus of a MII-compliant PHY (Physical Layer Entity). The module 
that is responsible for optimally configuring the media layer will start 
scanning the MII bus from the address in <phyAddr>. It will retrieve the 
PHY's address regardless of that, but, since the MII management interface, 
through which the PHY is configured, is a very slow one, providing an 
incorrect or invalid address may result in a particularly long boot process.
If the flag <DEC_USR_MII> is not set, this parameter is ignored.
.IP <pPhyTbl>
This optional parameter specifies the address of a auto-negotiation table
for the PHY being used. 
The user only needs to provide a valid value for this parameter
if he wants to affect the order how different technology abilities are 
negotiated.
If the flag <DEC_USR_MII> is not set, this parameter is ignored.
.IP <phyFlags>
This optional parameter allows the user to affect the PHY's configuration
and behaviour. See below, for an explanation of each MII flag.
If the flag <DEC_USR_MII> is not set, this parameter is ignored.
.IP <offset>
This parameter defines the offset which is used to solve alignment problem.

Device Type: Although the default device type is DEC 21040, specifying 
the DEC_USR_21140 flag bit turns on DEC 21140 functionality.

Ethernet Address: The Ethernet address is retrieved from standard serial 
ROM on both DEC 21040, and DEC 21140 devices. If the retrieve from ROM fails, 
the driver calls the sysDec21x40EnetAddrGet() BSP routine. 
Specifying DEC_USR_XEA flag bit tells the driver should, by default, 
retrieve the Ethernet address using the sysDec21x40EnetAddrGet() BSP routine.

Priority RX processing: The driver programs the chip to process the 
transmit and receive queues at the same priority. By specifying DEC_USR_BAR_RX,
the device is programmed to process receives at a higher priority.

TX poll rate: By default, the driver sets the Ethernet chip into a 
non-polling mode. In this mode, if the transmit engine is idle, it is 
kick-started every time a packet needs to be transmitted.  Alternatively, 
the chip can be programmed to poll for the next available transmit 
descriptor if the transmit engine is in idle state. The poll rate is 
specified by one of DEC_USR_TAP_<xxx> flags.

Cache Alignment: The DEC_USR_CAL_<xxx> flags specify the address 
boundaries for data burst transfers.

DMA burst length: The DEC_USR_PBL_<xxx> flags specify the maximum 
number of long words in a DMA burst.

PCI multiple read: The DEC_USR_RML flag specifies that a device 
supports PCI memory-read-multiple.

Full Duplex Mode: When set, the DEC_USR_FD flag allows the device to 
work in full duplex mode, as long as the PHY used has this
capability. It is worth noting here that in this operation mode, 
the dec21x40 chip ignores the Collision and the Carrier Sense signals.

MII interface: some boards feature an MII-compliant Physical Layer Entity
(PHY). In this case, and if the flag <DEC_USR_MII> is set, then the optional
fields <phyAddr>, <pPhyTbl>, and <phyFlags> may be used to affect the
PHY's configuration on the network. 

10Base-T Mode: when the flag <DEC_USR_MII_10MB> is set, then the PHY will
negotiate this technology ability, if present.

100Base-T Mode: when the flag <DEC_USR_MII_100MB> is set, then the PHY will
negotiate this technology ability, if present.

Half duplex Mode: when the flag <DEC_USR_MII_HD> is set, then the PHY will
negotiate this technology ability, if present.

Full duplex Mode: when the flag <DEC_USR_MII_FD> is set, then the PHY will
negotiate this technology ability, if present.

Auto-negotiation: the driver's default behaviour is to enable auto-negotiation, as defined in "IEEE 802.3u Standard". However, the user may disable this
feature by setting the flag <DEC_USR_MII_NO_AN> in the <phyFlags> field of
the load string.

Auto-negotiation table: the driver's default behaviour is to enable the
standard auto-negotiation process, as defined in "IEEE 802.3u Standard". 
However, the user may wish to force the PHY to negotiate its technology
abilities a subset at a time, and according to a particular order. The
flag <DEC_USR_MII_AN_TBL> in the <phyFlags> field may be used to tell the
driver that the PHY should negotiate its abilities as dictated by the
entries in the <pPhyTbl> of the load string.
If the flag <DEC_USR_MII_NO_AN> is set, this parameter is ignored.

Link monitoring: this feature enables the netTask to periodically monitor
the PHY's link status for link down events. If any such event occurs, and
if the flag <DEC_USR_MII_BUS_MON> is set, then a driver's optionally provided
routine is executed, and the link is renegotiated.

MII/Phy Checking: When set, and when a MII interface is being utilized
the DEC_USR_PHY_CHK flag instructs the driver to wait until the PHY link
status has changed to 'up' before continuing. This time period could be
as long as six seconds, but in general is on the order of two seconds.
If clear, the check will not be performed. This option may be selected if
the delay is unacceptable, but it is possible that a fast target may
attempt to send packets before the link is up. This will result in
'no carrier' errors in packet transmission.

A special flag bit DEC_USR_FORCE_MODE can be used to force the PHY interface
to a specified mode.  When active, the DEC_USR_FD and the DEC_USR_100MB
together determine the mode that the PHY will use. (This feature is only
valid when no MII-compliant PHY is being used).

Transmit treshold value: The DEC_USR_THR_XXX flags enable the user to 
choose among different threshold values for the transmit FIFO. 
Transmission starts when the frame size within the transmit FIFO is 
larger than the treshold value. This should be selected taking into 
account the actual operating speed of the PHY.  Again, see the device 
hardware reference manual for details.

EXTERNAL SUPPORT REQUIREMENTS
This driver requires three external support functions and provides a hook
function:

.IP sysLanIntEnable()
.CS
    void sysLanIntEnable (int level)
.CE
This routine provides a target-specific interface for enabling Ethernet device
interrupts at a specified interrupt level.
.IP sysLanIntDisable()
.CS
    void sysLanIntDisable (void)
.CE
This routine provides a target-specific interface for disabling Ethernet device
interrupts.
.IP sysDec21x40EnetAddrGet()
.CS
    STATUS sysDec21x40EnetAddrGet (int unit, char *enetAdrs)
.CE
This routine provides a target-specific interface for accessing a device
Ethernet address.
.IP `_func_dec21x40MediaSelect'
.CS
    FUNCPTR _func_dec21x40MediaSelect
.CE
If `_func_dec21x40MediaSelect' is NULL, this driver provides a default 
media-select routine that reads and sets up physical media using the 
configuration information from a Version 3 DEC Serial ROM. Any other media
configuration can be supported by initializing `_func_dec21x40MediaSelect',
typically in sysHwInit(), to a target-specific media select routine.

A media select routine is typically defined as:
.ne 8
.CS
   STATUS decMediaSelect
       (
       DEC21X40_DRV_CTRL *	pDrvCtrl,   /@ driver control @/
       UINT *			pCsr6Val    /@ CSR6 return value @/
       )
       {
           ...
       }
.CE

The <pDrvCtrl> parameter is a pointer to the driver control structure that this
routine can use to access the Ethenet device. The driver control structure
member 'mediaCount', is initialized to 0xff at startup, while the other media
control members ('mediaDefault', 'mediaCurrent', and 'gprModeVal') are 
initialized to zero. This routine can use these fields in any manner. 
However, all other driver control structure members should be considered 
read-only and should not be modified.

This routine should reset, initialize, and select an appropriate media.  It
should also write necessary the CSR6 bits (port select, PCS, SCR, and full 
duplex) to the memory location pointed to by <pCsr6Val>. The driver uses 
this value to program register CSR6. This routine should return OK or ERROR.

SEE ALSO: ifLib, 
.I "DECchip 21040 Ethernet LAN Controller for PCI,"
.I "Digital Semiconductor 21140A PCI Fast Ethernet LAN Controller,"
.I "Using the Digital Semiconductor 21140A with Boot ROM, Serial ROM, \
and External Register: An Application Note"

*/

/* includes */

#include "vxWorks.h"

#include "wdLib.h"
#include "iv.h"
#include "vme.h"
#include "net/mbuf.h"
#include "net/unixLib.h"
#include "net/protosw.h"
#include "sys/socket.h"
#include "sys/ioctl.h"
#include "errno.h"
#include "memLib.h"
#include "intLib.h"
#include "net/route.h"

#include "errnoLib.h"

#include "cacheLib.h"
#include "logLib.h"
#include "netLib.h"
#include "stdio.h"
#include "stdlib.h"
#include "sysLib.h"

#include "net/systm.h"
#include "sys/times.h"
#include "net/if_subr.h"
#include "netinet/if_ether.h"

#include "miiLib.h"
#include "drv/end/dec21x40End.h"

#undef	ETHER_MAP_IP_MULTICAST
#include "etherMultiLib.h"
#include "end.h"
#include "endLib.h"

#include "lstLib.h"
#include "semLib.h"

/* defines */

#undef DRV_DEBUG

#ifdef	DRV_DEBUG
#define DRV_DEBUG_OFF		0x0000
#define DRV_DEBUG_RX		0x0001
#define	DRV_DEBUG_TX		0x0002
#define DRV_DEBUG_INT		0x0004
#define	DRV_DEBUG_POLL		(DRV_DEBUG_POLL_RX | DRV_DEBUG_POLL_TX)
#define	DRV_DEBUG_POLL_RX	0x0008
#define	DRV_DEBUG_POLL_TX	0x0010
#define	DRV_DEBUG_LOAD		0x0020
#define	DRV_DEBUG_IOCTL		0x0040