readme.txt

CS8900A网络芯片驱动

	       This example specifies operation in memory mode and to ignore 
	       configuration data in EEPROM.

	       Valid configuration flag values:
	       
	       CFGFLG_NOT_EEPROM    
	       Override configuration flags in EEPROM (if present)
	       
	       CFGFLG_MEM_MODE      
	       Use memory mode to access the chip

	       CFGFLG_USE_SA        
	       Use System Address lines to qualify MEMCS16 signal (ISA only)

	       CFGFLG_IOCHRDY       
	       Extend time for IO access to CS8900 (ISA only) 

	       CFGFLG_DCDC_POL      
	       Specifies the signal level of the DC/DC converter's enable pin
	       is active high (DC/DC converter used by 10Base-2 transceiver)
	       
	       CFGFLG_FDX           
	       Configures the CS8900 to use full duplex for the 10Base-T 
	       transmission mode.

           CFGFLG_PROMISC_MODE 
           Configures the CS8900 to the Promiscuous Mode.  The CS8900 will
	   	   accepts all good network frames in the mode.


IF_USR_ARG8    Unused
               Define as NULL


Parameters in "if_cs.c"
------------------------

ALIGMENT_32BIT

This definition needs to be defined for the processors that perform 32-bit
read/write, such as ARM, Strong ARM, SH3, SH4, and MIPS.

If the data buffer for transmission starts on an odd address boundary, copy it
to a temporary buffer that starts on an even address boundary, and write the
temporary buffer to the CS8900 Chip. 




Parameters in "sysEnet.c"
------------------------

CS_MAX_NUM_UNITS  

This definition represents the number of CS8900s in the same system supported
by this driver.  This value is always one (i.e. the current driver supports
only one CS8900).



CS_NUM_RX_BUFFERS       

This value specifies the number of 1500-byte receive buffers allocated by the 
driver for local storage of received frames.  Receive frames are copied 
from the chip into these local receive buffers at the ISR level and passed to
the protocol stack for processing at the task level.  Also, by using the
OS's "build_cluster" routine, these receive buffers can be loaned to the
protocol stack during processing, thus preventing an extra copy of the receive
data (from the local receive buffer into a protocol mbuf chain).  For best
ethernet throughput, set this value to largest number feasible based on your 
system's memory constraints.



CS_MAX_QUEUE   

This value is the maximum number of elements in the local TX and RX queue.
The RX queue holds pointers to local RX buffers to be passed to the protocol
stack for processing at task level.  The TX queue holds pointers to mbuf
chains to be freed at the task level (frames that have been transmitted).
Typically, this value is set to the maximum number of mbufs specified for the
system (MAX_MBUFS -- defined in mbuf.h).



STRESS_TESTING 		

This boolean value controls the output of debug messages for RX frames that
are not processed by the CS8900 when on-chip buffer space is not available.  
If driver debug messages are enabled, a message is output to the display device
for each RX frame that is missed.  During extremely heavy traffic, such as 
during stress testing, these messages can become numerous, adding to the 
systems processing overhead and therby adding to the number of RX frames 
missed.  Setting this value to TRUE suppresses output of messages for missed
RX frames. However, statistics for RX misses are still updated and can be 
output using the csShow() routine.  



CS_INITIAL_START_CMD	

The CS8900 is capable of starting the TX operation before the full frame is
copied to the on-chip TX buffer.  However, this operation mode creates the
possibility of a "TX underrun", i.e. the transmitter may run out of data
before the full frame is buffered if the TX frame copy to chip is delayed or
slower than one byte per 0.8ms (wire data rate).  

Part of the TX command to the CS8900 specifies the number of bytes to be 
buffered before the transmission on the wire begins.  If excessive TX 
underruns occur, the driver automatically adjusts the TX command to start 
the next TX after additional bytes are buffered.  The possible values for 
the number of bytes buffered before the TX starts are: 5, 381, 1021, or a
full frame.

CS_INIITIAL_START_CMD specifes which TX start command to use initially before
the driver makes any required automtic adjustments.  Valid definitions for 
CS_INITIAL_START_CMD are:

   TX_CMD_START_5    (start after 5 bytes buffered) 
   TX_CMD_START_381  (start after 381 bytes buffered)
   TX_CMD_START_1021 (start after 1021 bytes buffered)
   TX_CMD_START_ALL  (start after the full frame is buffered)

Refer to the CS8900 Datasheet for more information on transmit operation.



#define CS_TX_UNDRUN_TRHSHOLD   3 

This value specifies the number of TX underruns allowed while using the 
current TX start comand before the driver automatically adjusts the command 
to start the next transmission after additional bytes are buffered.




4.0 DISPLAYING DRIVER STATISTICS AND CONFIGURATION
==================================================

The network interface driver includes a display routine, called csshow(), which
displays driver configuration and statistics information.  To invoke the
display routine, at the shell prompt, type:

        -> csshow

To reset the statistics to zero, type at the shell prompt:

        -> csshow 0, 1

Another routine that you may find useful is:

        -> ifshow "cs0"


Message Logging
---------------

If the network interface debug flag is set, then the network interface driver
logs significant events and error messages to the logging task.  The default
behavior of the logging task is to display logging messages on the console.
To set the debug flag, issue the following command at the shell prompt:

        -> ifflagchange "cs0", 4, 1

To clear the debug flag, issue the following command at the shell prompt:

        -> ifflagchange "cs0", 4, 0

You can use the csshow() routine to view the current state of the debug flag.



5.0 PORTING TO A NEW BSP
========================

Starting with the version 2.01 driver, the driver has been divided into two
moduels: a BSP-independent module "if_cs.c" and a BSP-specific module
"sysenet.c".  In order to port the driver to a new BSP, only the "sysenet.c"
file should need to be modifed.  You should not modify the "if_cs.c" file.
This will ensure your port is compatible with any future releases of the driver from Crystal Semiconductor.

A "sysenet.c" module written for a 386 BSP is provided with this driver as an
example.


Big Endian and Little Endian Architectures
------------------------------------------

A macro for byte-swapping is defined based on the _byte_order definition in the
vxworks header file "arch.h".  For "big endian" CPUs, the macro is defined to
swap the order of bytes for access to CS8900 registers.  For "little endian"
CPUs, the macro does nothing.

Note: The use of this macro assumes that the hardware data lines to the CS8900
have been "byte swapped" in big endian systems.  That is, CPU D0 connected to
CS8900 D8, CPU D1 connected to CS8900 D9, etc.  Using this technique, only
counter-register values must be byte swapped in real time.  All other values
are byte swapped at compile time using definitions in the header file.  Network
data is never byte swapped in software.  This is handled by the CS8900
hardware.


Macros
------

Three macros are used to communicate with the CS8900 in IO mode.  For the
pc386/pc486 BSPs, they call system routines provided by VxWorks/PCX86 for
IO space access.  For non x86-based BSPs, they need to be redefined as
appropriate for your BSP's architecture (e.g. a memory dereference if IO
space is not supported).

/* X86 BSP macro definitions used to provide IO mode accesses */
#define SYS_ENET_OUT_WORD(port, value)	        sysOutWord((port), (value))
#define SYS_ENET_IN_WORD(port)			sysInWord(port)
#define SYS_ENET_IN_BYTE(port)			sysInByte(port)

/* Example macros used to "emulate" io space access for non-Intel CPUs */
#define SYS_ENET_OUT_WORD(port, value)    (*(volatile USHORT*)(port)) = (value)
#define SYS_ENET_IN_WORD(port)            (*(volatile USHORT*)(port))
#define SYS_ENET_IN_BYTE(port)            (*(volatile UCHAR*)(port))



BSP-specific Routines
---------------------

The following five BSP-specific routines are called from the main driver
module "if_cs.c" and must be replaced with routines appropriate for your
hardware configuration.

* sysEnetGetConfig( )
This routine takes configuration parameters not specifed to csAttach() through
the IF_USR definitions from non-volatile storage (e.g. an attached EEPROM) and 
puts them in the cs_softc structure. 

* sysEnetAddrGet( )
This routine obtains the Ethernet MAC address from non-volatile storage or from 
the "csEnetAddr" array defined in sysEnet.c and saves it in the interface's 
arpcom structure.

* sysEnetHWInit( )
This routine uses global variables in the cs_softc structure to configure the 
adapter for the board-specific IO circuitry and supported media types.

* sysEnetIntEnable( )
This routine enables the interrupt used by the CS8900 at the system level.  It 
may not be required by your BSP.  If not, implement as a stub (empty routine).
 
* sysEnetIntDisable( )
This routine disables the interrupt used by the CS8900 at the system level.  It 
may not be required by your BSP.  If not, implement as a stub (empty routine).


You may add any support routines to be called by the above required routines
as you wish.



6.0 CONTACTING CRYSTAL'S TECHNICAL SUPPORT
==========================================

Crystal's CS8900 Technical Support can be reached at:

Telephone  :[phone] (from inside U.S. and Canada)
           :[phone] (from outside the U.S. and Canada)
Fax	       :[phone]
Email	   :[e-mail]
Web        :www.crystal.com