Merge branch 'delete-tokenring' of git://git.kernel.org/pub/scm/linux/kernel/git/paulg/linux

 snmp          SNMP data                                                       

 sockstat      Socket statistics                                               

 tcp           TCP  sockets                                                    

 tr_rif        Token ring RIF routing table                                    

 udp           UDP sockets                                                     

 unix          UNIX domain sockets                                             

 wireless      Wireless interface data (Wavelan etc)                           

00-INDEX

	- this file

3c359.txt

	- information on the 3Com TokenLink Velocity XL (3c5359) driver.

3c505.txt

	- information on the 3Com EtherLink Plus (3c505) driver.

3c509.txt

	- Design of the network interface message level setting (NETIF_MSG_*).

nfc.txt

	- The Linux Near Field Communication (NFS) subsystem.

olympic.txt

	- IBM PCI Pit/Pit-Phy/Olympic Token Ring driver info.

openvswitch.txt

	- Open vSwitch developer documentation.

operstates.txt

	- SysKonnect FDDI (SK-5xxx, Compaq Netelligent) driver info.

smc9.txt

	- the driver for SMC's 9000 series of Ethernet cards

smctr.txt

	- SMC TokenCard TokenRing Linux driver info.

spider-net.txt

	- README for the Spidernet Driver (as found in PS3 / Cell BE).

stmmac.txt

	- kernel tuning options for low rate 'thin' TCP streams.

tlan.txt

	- ThunderLAN (Compaq Netelligent 10/100, Olicom OC-2xxx) driver info.

tms380tr.txt

	- SysKonnect Token Ring ISA/PCI adapter driver info.

tproxy.txt

	- Transparent proxy support user guide.

tuntap.txt

3COM PCI TOKEN LINK VELOCITY XL TOKEN RING CARDS README

Release 0.9.0 - Release   

	Jul 17th 2000 Mike Phillips 

	1.2.0 - Final

	Feb 17th 2002 Mike Phillips 

	Updated for submission to the 2.4.x kernel.

Thanks:

	Terry Murphy from 3Com for tech docs and support,

	Adam D. Ligas for testing the driver.

Note:

	This driver will NOT work with the 3C339 Token Ring cards, you need

to use the tms380 driver instead.

Options:

The driver accepts three options: ringspeed, pkt_buf_sz and message_level.

These options can be specified differently for each card found. 

ringspeed:  Has one of three settings 0 (default), 4 or 16.  0 will 

make the card autosense the ringspeed and join at the appropriate speed, 

this will be the default option for most people.  4 or 16 allow you to 

explicitly force the card to operate at a certain speed.  The card will fail 

if you try to insert it at the wrong speed. (Although some hubs will allow 

this so be *very* careful).  The main purpose for explicitly setting the ring

speed is for when the card is first on the ring.  In autosense mode, if the card

cannot detect any active monitors on the ring it will open at the same speed as

its last opening. This can be hazardous if this speed does not match the speed

you want the ring to operate at.  

pkt_buf_sz:  This is this initial receive buffer allocation size.  This will

default to 4096 if no value is entered. You may increase performance of the 

driver by setting this to a value larger than the network packet size, although

the driver now re-sizes buffers based on MTU settings as well. 

message_level: Controls level of messages created by the driver. Defaults to 0:

which only displays start-up and critical messages.  Presently any non-zero 

value will display all soft messages as well.  NB This does not turn 

debugging messages on, that must be done by modified the source code.

Variable MTU size:

The driver can handle a MTU size up to either 4500 or 18000 depending upon 

ring speed.  The driver also changes the size of the receive buffers as part

of the mtu re-sizing, so if you set mtu = 18000, you will need to be able

to allocate 16 * (sk_buff with 18000 buffer size) call it 18500 bytes per ring 

position = 296,000 bytes of memory space, plus of course anything 

necessary for the tx sk_buff's.  Remember this is per card, so if you are

building routers, gateway's etc, you could start to use a lot of memory

real fast.

2/17/02 Mike Phillips

IBM PCI Pit/Pit-Phy/Olympic CHIPSET BASED TOKEN RING CARDS README

Release 0.2.0 - Release    

	June 8th 1999 Peter De Schrijver & Mike Phillips

Release 0.9.C - Release

	April 18th 2001 Mike Phillips

Thanks:

Erik De Cock, Adrian Bridgett and Frank Fiene for their 

patience and testing.

Donald Champion for the cardbus support

Kyle Lucke for the dma api changes.   

Jonathon Bitner for hardware support. 

Everybody on linux-tr for their continued support.  

Options:

The driver accepts four options: ringspeed, pkt_buf_sz,  

message_level and network_monitor.

These options can be specified differently for each card found. 

ringspeed:  Has one of three settings 0 (default), 4 or 16.  0 will 

make the card autosense the ringspeed and join at the appropriate speed, 

this will be the default option for most people.  4 or 16 allow you to 

explicitly force the card to operate at a certain speed.  The card will fail 

if you try to insert it at the wrong speed. (Although some hubs will allow 

this so be *very* careful).  The main purpose for explicitly setting the ring

speed is for when the card is first on the ring.  In autosense mode, if the card

cannot detect any active monitors on the ring it will not open, so you must 

re-init the card at the appropriate speed.  Unfortunately at present the only

way of doing this is rmmod and insmod which is a bit tough if it is compiled

in the kernel.

pkt_buf_sz:  This is this initial receive buffer allocation size.  This will

default to 4096 if no value is entered. You may increase performance of the 

driver by setting this to a value larger than the network packet size, although

the driver now re-sizes buffers based on MTU settings as well. 

message_level: Controls level of messages created by the driver. Defaults to 0:

which only displays start-up and critical messages.  Presently any non-zero 

value will display all soft messages as well.  NB This does not turn 

debugging messages on, that must be done by modified the source code.

network_monitor: Any non-zero value will provide a quasi network monitoring 

mode.  All unexpected MAC frames (beaconing etc.) will be received

by the driver and the source and destination addresses printed. 

Also an entry will be added in  /proc/net called olympic_tr%d, where tr%d

is the registered device name, i.e tr0, tr1, etc. This displays low

level information about the configuration of the ring and the adapter.

This feature has been designed for network administrators to assist in 

the diagnosis of network / ring problems. (This used to OLYMPIC_NETWORK_MONITOR,

but has now changed to allow each adapter to be configured differently and

to alleviate the necessity to re-compile olympic to turn the option on).

Multi-card:

The driver will detect multiple cards and will work with shared interrupts,

each card is assigned the next token ring device, i.e. tr0 , tr1, tr2.  The 

driver should also happily reside in the system with other drivers.  It has 

been tested with ibmtr.c running, and I personally have had one Olicom PCI 

card and two IBM olympic cards (all on the same interrupt), all running

together. 

Variable MTU size:

The driver can handle a MTU size up to either 4500 or 18000 depending upon 

ring speed.  The driver also changes the size of the receive buffers as part

of the mtu re-sizing, so if you set mtu = 18000, you will need to be able

to allocate 16 * (sk_buff with 18000 buffer size) call it 18500 bytes per ring 

position = 296,000 bytes of memory space, plus of course anything 

necessary for the tx sk_buff's.  Remember this is per card, so if you are

building routers, gateway's etc, you could start to use a lot of memory

real fast.

6/8/99 Peter De Schrijver and Mike Phillips

Text File for the SMC TokenCard TokenRing Linux driver (smctr.c).

        By Jay Schulist <jschlst@samba.org>

The Linux SMC Token Ring driver works with the SMC TokenCard Elite (8115T) 

ISA and SMC TokenCard Elite/A (8115T/A) MCA adapters.

Latest information on this driver can be obtained on the Linux-SNA WWW site.

Please point your browser to: http://www.linux-sna.org

This driver is rather simple to use. Select Y to Token Ring adapter support

in the kernel configuration. A choice for SMC Token Ring adapters will

appear. This drives supports all SMC ISA/MCA adapters. Choose this

option. I personally recommend compiling the driver as a module (M), but if you

you would like to compile it statically answer Y instead.

This driver supports multiple adapters without the need to load multiple copies

of the driver. You should be able to load up to 7 adapters without any kernel

modifications, if you are in need of more please contact the maintainer of this

driver.

Load the driver either by lilo/loadlin or as a module. When a module using the

following command will suffice for most:

# modprobe smctr

smctr.c: v1.00 12/6/99 by jschlst@samba.org

tr0: SMC TokenCard 8115T at Io 0x300, Irq 10, Rom 0xd8000, Ram 0xcc000.

Now just setup the device via ifconfig and set and routes you may have. After

this you are ready to start sending some tokens.

Errata:

1). For anyone wondering where to pick up the SMC adapters please browse

    to http://www.smc.com

2). If you are the first/only Token Ring Client on a Token Ring LAN, please

    specify the ringspeed with the ringspeed=[4/16] module option. If no

    ringspeed is specified the driver will attempt to autodetect the ring

    speed and/or if the adapter is the first/only station on the ring take

    the appropriate actions. 

    NOTE: Default ring speed is 16MB UTP.

3). PnP support for this adapter sucks. I recommend hard setting the 

    IO/MEM/IRQ by the jumpers on the adapter. If this is not possible

    load the module with the following io=[ioaddr] mem=[mem_addr]

    irq=[irq_num].

    The following IRQ, IO, and MEM settings are supported.

    IO ports:

    0x200, 0x220, 0x240, 0x260, 0x280, 0x2A0, 0x2C0, 0x2E0, 0x300,

    0x320, 0x340, 0x360, 0x380.

    IRQs:

    2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 15

    Memory addresses:

    0xA0000, 0xA4000, 0xA8000, 0xAC000, 0xB0000, 0xB4000,

    0xB8000, 0xBC000, 0xC0000, 0xC4000, 0xC8000, 0xCC000,

    0xD0000, 0xD4000, 0xD8000, 0xDC000, 0xE0000, 0xE4000,

    0xE8000, 0xEC000, 0xF0000, 0xF4000, 0xF8000, 0xFC000

This driver is under the GNU General Public License. Its Firmware image is

included as an initialized C-array and is licensed by SMC to the Linux

users of this driver. However no warranty about its fitness is expressed or

implied by SMC.