summaryrefslogtreecommitdiffstats
path: root/Documentation/networking
diff options
context:
space:
mode:
authorRalf Baechle <ralf@linux-mips.org>1999-09-28 22:25:29 +0000
committerRalf Baechle <ralf@linux-mips.org>1999-09-28 22:25:29 +0000
commit0ae8dceaebe3659ee0c3352c08125f403e77ebca (patch)
tree5085c389f09da78182b899d19fe1068b619a69dd /Documentation/networking
parent273767781288c35c9d679e908672b9996cda4c34 (diff)
Merge with 2.3.10.
Diffstat (limited to 'Documentation/networking')
-rw-r--r--Documentation/networking/arcnet-hardware.txt54
-rw-r--r--Documentation/networking/arcnet.txt37
-rw-r--r--Documentation/networking/baycom.txt6
-rw-r--r--Documentation/networking/cs89x0.txt18
-rw-r--r--Documentation/networking/olympic.txt75
-rw-r--r--Documentation/networking/policy-routing.txt2
-rw-r--r--Documentation/networking/z8530drv.txt2
7 files changed, 134 insertions, 60 deletions
diff --git a/Documentation/networking/arcnet-hardware.txt b/Documentation/networking/arcnet-hardware.txt
index 0c1dbcea9..638bb8abf 100644
--- a/Documentation/networking/arcnet-hardware.txt
+++ b/Documentation/networking/arcnet-hardware.txt
@@ -20,14 +20,14 @@ INTRODUCTION TO ARCNET
ARCnet is a network type which works in a way similar to popular Ethernet
networks but which is also different in some very important ways.
-First of all, you can get ARCnet cards in at least two speeds: 2.5Mbps
-(slower than Ethernet) and 100Mbps (faster than normal Ethernet). In fact,
+First of all, you can get ARCnet cards in at least two speeds: 2.5 Mbps
+(slower than Ethernet) and 100 Mbps (faster than normal Ethernet). In fact,
there are others as well, but these are less common. The different hardware
types, as far as I'm aware, are not compatible and so you cannot wire a
-100Mbps card to a 2.5Mbps card, and so on. From what I hear, my driver does
-work with 100Mbps cards, but I haven't been able to verify this myself,
-since I only have the 2.5Mbps variety. It is probably not going to saturate
-your 100Mbps card. Stop complaining :)
+100 Mbps card to a 2.5 Mbps card, and so on. From what I hear, my driver does
+work with 100 Mbps cards, but I haven't been able to verify this myself,
+since I only have the 2.5 Mbps variety. It is probably not going to saturate
+your 100 Mbps card. Stop complaining. :)
You also cannot connect an ARCnet card to any kind of Ethernet card and
expect it to work.
@@ -52,17 +52,17 @@ a pass around the "ring" within a maximum length of time. This makes it
useful for realtime networks.
In addition, all known ARCnet cards have an (almost) identical programming
-interface. This means that with one "arcnet" driver you can support any
-card; whereas, with Ethernet, each manufacturer uses what is sometimes a
+interface. This means that with one ARCnet driver you can support any
+card, whereas with Ethernet each manufacturer uses what is sometimes a
completely different programming interface, leading to a lot of different,
sometimes very similar, Ethernet drivers. Of course, always using the same
programming interface also means that when high-performance hardware
-facilities like PCI busmastering DMA appear, it's hard to take advantage of
+facilities like PCI bus mastering DMA appear, it's hard to take advantage of
them. Let's not go into that.
One thing that makes ARCnet cards difficult to program for, however, is the
limit on their packet sizes; standard ARCnet can only send packets that are
-up to 508 bytes in length. This is smaller than the internet "bare minimum"
+up to 508 bytes in length. This is smaller than the Internet "bare minimum"
of 576 bytes, let alone the Ethernet MTU of 1500. To compensate, an extra
level of encapsulation is defined by RFC1201, which I call "packet
splitting," that allows "virtual packets" to grow as large as 64K each,
@@ -1005,9 +1005,9 @@ LCS-8830(-T) (8 and 16-bit cards)
only (the JP0 jumper is hardwired), and BNC only.
This is a LCS-8830-T made by SMC, I think ('SMC' only appears on one PLCC,
-nowhere else, not even on the few xeroxed sheets from the manual).
+nowhere else, not even on the few Xeroxed sheets from the manual).
-SMC Arcnet Board Type LCS-8830-T
+SMC ARCnet Board Type LCS-8830-T
------------------------------------
| |
@@ -1070,7 +1070,7 @@ Switches Base
DIP Switches 1-5 of SW2 encode the RAM and ROM Address Range:
-Switches Ram Rom
+Switches RAM ROM
12345 Address Range Address Range
00000 C:0000-C:07ff C:2000-C:3fff
10000 C:0800-C:0fff
@@ -1170,11 +1170,11 @@ Carl de Billy <CARL@carainfo.com> explains J3 and J4:
DIP Switches:
The DIP switches accessible on the accessible end of the card while
- it is installed, is used to set the arcnet address. There are 8
+ it is installed, is used to set the ARCnet address. There are 8
switches. Use an address from 1 to 254.
Switch No.
- 12345678 Arcnet address
+ 12345678 ARCnet address
-----------------------------------------
00000000 FF (Don't use this!)
00000001 FE
@@ -1222,7 +1222,7 @@ DIP Switches:
from the upper memory regions, and then attempting to load ARCETHER
using these addresses.
- I recommend using an arcnet memory address of 0xD000, and putting
+ I recommend using an ARCnet memory address of 0xD000, and putting
the EMS page frame at 0xC000 while using QEMM stealth mode. That
way, you get contiguous high memory from 0xD100 almost all the way
the end of the megabyte.
@@ -1687,7 +1687,7 @@ parameters. These two jumpers are normally left open.
|____________________________________________| |__|
-UM9065L : Arcnet Controller
+UM9065L : ARCnet Controller
SW 1 : Shared Memory Address and I/O Base
@@ -1800,7 +1800,7 @@ SW2 1-8 Node ID Select (ID0-ID7)
J1-J5 IRQ Select
J6-J21 Unknown (Probably extra timeouts & ROM enable ...)
LED1 Activity LED
-BNC Coax connector (STAR arcnet)
+BNC Coax connector (STAR ARCnet)
RAM 2k of SRAM
ROM Boot ROM socket
UFS Unidentified Flying Sockets
@@ -1905,7 +1905,7 @@ LAN-ARC-8, an 8-bit card
------------------------
- from Vojtech Pavlik <Vojtech.Pavlik@st.mff.cuni.cz>
-This is another SMC 90C65 based arcnet card. I couldn't identify the
+This is another SMC 90C65-based ARCnet card. I couldn't identify the
manufacturer, but it might be DataPoint, because the card has the
original arcNet logo in its upper right corner.
@@ -1942,9 +1942,9 @@ SW1 1-5: Base Memory Address Select
SW2 1-8: Node ID Select
SW3 1-5: IRQ Select
6-7: Extra Timeout
- 8 : Rom Enable
+ 8 : ROM Enable
BNC Coax connector
-XTAL 20MHz Crystal
+XTAL 20 MHz Crystal
Setting the Node ID
@@ -2081,11 +2081,11 @@ SW1 1-5 Base Memory Address Select
6-8 Base I/O Address Select
SW2 1-8 Node ID Select (ID0-ID7)
J1 IRQ Select
-J2 Rom Enable
+J2 ROM Enable
J3 Extra Timeout
LED1 Activity LED
-BNC Coax connector (BUS arcnet)
-RJ Twisted Pair Connector (daisychain)
+BNC Coax connector (BUS ARCnet)
+RJ Twisted Pair Connector (daisy chain)
Setting the Node ID
@@ -2419,7 +2419,7 @@ using information from the Original
Legend:
-COM90C65: Arcnet Probe
+COM90C65: ARCnet Probe
S1 1-8: Node ID Select
S2 1-3: I/O Base Address Select
4-6: Memory Base Address Select
@@ -2791,7 +2791,7 @@ SW1 1-5: Base Memory Address Select
SW2 1-8: Node ID Select (ID0-ID7)
SW3 1-5: IRQ Select
6-7: Extra Timeout
- 8 : Rom Enable
+ 8 : ROM Enable
JP1 Led connector
BNC Coax connector
@@ -3089,7 +3089,7 @@ Tiara LanCard of Tiara Computer Systems.
0 = Jumper Installed
1 = Open
-Top Jumper line Bit 7 = Rom Enable 654=Memory location 321=I/O
+Top Jumper line Bit 7 = ROM Enable 654=Memory location 321=I/O
Settings for Memory Location (Top Jumper Line)
456 Address selected
diff --git a/Documentation/networking/arcnet.txt b/Documentation/networking/arcnet.txt
index 3bb2f6d96..2cdb6db62 100644
--- a/Documentation/networking/arcnet.txt
+++ b/Documentation/networking/arcnet.txt
@@ -1,4 +1,3 @@
-
----------------------------------------------------------------------------
NOTE: See also arcnet-hardware.txt in this directory for jumper-setting
and cabling information if you're like many of us and didn't happen to get a
@@ -92,10 +91,10 @@ ARCnet:
http://www.perftech.com/ or ftp to ftp.perftech.com.
Novell makes a networking stack for DOS which includes ARCnet drivers. Try
-ftp'ing to ftp.novell.com.
+FTPing to ftp.novell.com.
You can get the Crynwr packet driver collection (including arcether.com, the
-one you'll want to use with arcnet cards) from
+one you'll want to use with ARCnet cards) from
oak.oakland.edu:/simtel/msdos/pktdrvr. It won't work perfectly on a 386+
without patches, though, and also doesn't like several cards. Fixed
versions are available on my WWW page, or via e-mail if you don't have WWW
@@ -183,7 +182,7 @@ Loadable Module Support
-----------------------
Configure and rebuild Linux. When asked, answer 'm' to "Generic ARCnet
-support" and to support for your ARcnet chipset if you want to use the
+support" and to support for your ARCnet chipset if you want to use the
loadable module. You can also say 'y' to "Generic ARCnet support" and 'm'
to the chipset support if you wish.
@@ -269,7 +268,7 @@ Windows: See DOS :) Trumpet Winsock works fine with either the Novell or
Arcether client, assuming you remember to load winpkt of course.
LAN Manager and Windows for Workgroups: These programs use protocols that
- are incompatible with the internet standard. They try to pretend
+ are incompatible with the Internet standard. They try to pretend
the cards are Ethernet, and confuse everyone else on the network.
However, v2.00 and higher of the Linux ARCnet driver supports this
@@ -288,7 +287,7 @@ Windows 95: Tools are included with Win95 that let you use either the LANMAN
you're completely insane, and/or you need to build some kind of
hybrid network that uses both encapsulation types.
-OS2: I've been told it works under Warp Connect with an ARCnet driver from
+OS/2: I've been told it works under Warp Connect with an ARCnet driver from
SMC. You need to use the 'arc0e' interface for this. If you get
the SMC driver to work with the TCP/IP stuff included in the
"normal" Warp Bonus Pack, let me know.
@@ -309,7 +308,7 @@ Using Multiprotocol ARCnet
The ARCnet driver v2.10 ALPHA supports three protocols, each on its own
"virtual network device":
- arc0 - RFC1201 protocol, the official internet standard which just
+ arc0 - RFC1201 protocol, the official Internet standard which just
happens to be 100% compatible with Novell's TRXNET driver.
Version 1.00 of the ARCnet driver supported _only_ this
protocol. arc0 is the fastest of the three protocols (for
@@ -331,13 +330,13 @@ The ARCnet driver v2.10 ALPHA supports three protocols, each on its own
reasons yet to be determined. (Probably it's the smaller
MTU that does it.)
- arc0s - The "[s]imple" RFC1051 protocol is the "previous" internet
+ arc0s - The "[s]imple" RFC1051 protocol is the "previous" Internet
standard that is completely incompatible with the new
standard. Some software today, however, continues to
support the old standard (and only the old standard)
including NetBSD and AmiTCP. RFC1051 also does not support
RFC1201's packet splitting, and the MTU of 507 is still
- smaller than the internet "requirement," so it's quite
+ smaller than the Internet "requirement," so it's quite
possible that you may run into problems. It's also slower
than RFC1201 by about 25%, for the same reason as arc0e.
@@ -388,16 +387,16 @@ can set up your network then:
Linux but runs the free Microsoft LANMAN Client instead.
Worse, one of the Linux computers (freedom) also has a modem and acts as
- a router to my internet provider. The other Linux box (insight) also has
+ a router to my Internet provider. The other Linux box (insight) also has
its own IP address and needs to use freedom as its default gateway. The
- XT (patience), however, does not have its own internet IP address and so
+ XT (patience), however, does not have its own Internet IP address and so
I assigned it one on a "private subnet" (as defined by RFC1597).
To start with, take a simple network with just insight and freedom.
Insight needs to:
- talk to freedom via RFC1201 (arc0) protocol, because I like it
more and it's faster.
- - use freedom as its internet gateway.
+ - use freedom as its Internet gateway.
That's pretty easy to do. Set up insight like this:
ifconfig arc0 insight
@@ -417,20 +416,20 @@ can set up your network then:
/* and default gateway is configured by pppd */
Great, now insight talks to freedom directly on arc0, and sends packets
- to the internet through freedom. If you didn't know how to do the above,
+ to the Internet through freedom. If you didn't know how to do the above,
you should probably stop reading this section now because it only gets
worse.
Now, how do I add patience into the network? It will be using LANMAN
Client, which means I need the arc0e device. It needs to be able to talk
to both insight and freedom, and also use freedom as a gateway to the
- internet. (Recall that patience has a "private IP address" which won't
- work on the internet; that's okay, I configured Linux IP masquerading on
+ Internet. (Recall that patience has a "private IP address" which won't
+ work on the Internet; that's okay, I configured Linux IP masquerading on
freedom for this subnet).
So patience (necessarily; I don't have another IP number from my
provider) has an IP address on a different subnet than freedom and
- insight, but needs to use freedom as an internet gateway. Worse, most
+ insight, but needs to use freedom as an Internet gateway. Worse, most
DOS networking programs, including LANMAN, have braindead networking
schemes that rely completely on the netmask and a 'default gateway' to
determine how to route packets. This means that to get to freedom or
@@ -449,7 +448,7 @@ can set up your network then:
This way, freedom will send all packets for patience through arc0e,
giving its IP address as gatekeeper (on the private subnet). When it
- talks to insight or the internet, it will use its "freedom" internet IP
+ talks to insight or the Internet, it will use its "freedom" Internet IP
address.
You will notice that we haven't configured the arc0e device on insight.
@@ -473,7 +472,7 @@ can set up your network then:
[RFC1201 NETWORK] [ETHER-ENCAP NETWORK]
- (registered internet subnet) (RFC1597 private subnet)
+ (registered Internet subnet) (RFC1597 private subnet)
(IP Masquerade)
/---------------\ * /---------------\
@@ -523,7 +522,7 @@ found unless you turn on the D_INIT_REASONS debugging flag.
Once the driver is running, you can run the arcdump shell script (available
from me or in the full ARCnet package, if you have it) as root to list the
contents of the arcnet buffers at any time. To make any sense at all out of
-this, you should grab the pertinent RFC's. (some are listed near the top of
+this, you should grab the pertinent RFCs. (some are listed near the top of
arcnet.c). arcdump assumes your card is at 0xD0000. If it isn't, edit the
script.
diff --git a/Documentation/networking/baycom.txt b/Documentation/networking/baycom.txt
index 8d5bc3566..71e0c76df 100644
--- a/Documentation/networking/baycom.txt
+++ b/Documentation/networking/baycom.txt
@@ -31,7 +31,7 @@ baycom_par:
Its devices are called bcp0 through bcp3.
baycom_epp:
- This driver supports the epp modem.
+ This driver supports the EPP modem.
Its devices are called bce0 through bce3.
This driver is work-in-progress.
@@ -60,10 +60,10 @@ picpar: This is a redesign of the par96 modem by Henning Rech, DF9IC. The modem
an additional power supply. Furthermore, it incorporates a carrier
detect circuitry.
-epp: This is a high speed modem adaptor that connects to an enhanced parallel port.
+EPP: This is a high-speed modem adaptor that connects to an enhanced parallel port.
Its target audience is users working over a high speed hub (76.8kbit/s).
-eppfpga: This is a redesign of the epp adaptor.
+eppfpga: This is a redesign of the EPP adaptor.
diff --git a/Documentation/networking/cs89x0.txt b/Documentation/networking/cs89x0.txt
index 839db8ece..1da37d5ce 100644
--- a/Documentation/networking/cs89x0.txt
+++ b/Documentation/networking/cs89x0.txt
@@ -203,7 +203,7 @@ configuration options are available on the command line:
* io=### - specify IO address (200h-360h)
* irq=## - specify interrupt level
* mmode=##### - specify memory base address
-* dma=# - specify dma channel
+* dma=# - specify DMA channel
* media=rj45 - specify media type
or media=2
or media=aui
@@ -412,33 +412,33 @@ its ability to communicate across the ISA bus based on the system resources
assigned during hardware configuration. The following tests are performed:
* IO Register Read/Write Test
- The IO Register Read/Write test insures that the CS8900/20 can be
+ The IO Register Read/Write test ensures that the CS8900/20 can be
accessed in IO mode, and that the IO base address is correct.
* Shared Memory Test
- The Shared Memory test insures the CS8900/20 can be accessed in memory
+ The Shared Memory test ensures the CS8900/20 can be accessed in memory
mode and that the range of memory addresses assigned does not conflict
with other devices in the system.
* Interrupt Test
- The Interrupt test insures there are no conflicts with the assigned IRQ
+ The Interrupt test ensures there are no conflicts with the assigned IRQ
signal.
* EEPROM Test
- The EEPROM test insures the EEPROM can be read.
+ The EEPROM test ensures the EEPROM can be read.
* Chip RAM Test
- The Chip RAM test insures the 4K of memory internal to the CS8900/20 is
+ The Chip RAM test ensures the 4 K of memory internal to the CS8900/20 is
working properly.
* Internal Loop-back Test
- The Internal Loop Back test insures the adapter's transmitter and
+ The Internal Loop Back test ensures the adapter's transmitter and
receiver are operating properly. If this test fails, make sure the
adapter's cable is connected to the network (check for LED activity for
example).
* Boot PROM Test
- The Boot PROM test insures the Boot PROM is present, and can be read.
+ The Boot PROM test ensures the Boot PROM is present, and can be read.
Failure indicates the Boot PROM was not successfully read due to a
hardware problem or due to a conflicts on the Boot PROM address
assignment. (Test only applies if the adapter is configured to use the
@@ -564,7 +564,7 @@ Crystal's CS89XX Technical Application Support can be reached at:
Telephone :(800) 888-5016 (from inside U.S. and Canada)
:(512) 442-7555 (from outside the U.S. and Canada)
Fax :(512) 912-3871
-Email :ethernet@crystal.cirrus.com
+E-mail :ethernet@crystal.cirrus.com
WWW :http://www.crystal.com
diff --git a/Documentation/networking/olympic.txt b/Documentation/networking/olympic.txt
new file mode 100644
index 000000000..04198aec5
--- /dev/null
+++ b/Documentation/networking/olympic.txt
@@ -0,0 +1,75 @@
+
+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
+
+
+Thanks:
+Erik De Cock, Adrian Bridgett and Frank Fiene for their
+patience and testing.
+Paul Norton without whose tr.c code we would have had
+a lot more work to do.
+
+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 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
+debuging messages on, that must be done by modified the source code.
+
+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 personnally 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 upto 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.
+
+Network Monitor Mode:
+
+By modifying the #define OLYMPIC_NETWORK_MONITOR from 0 to 1 in the
+source code the driver will implement 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. This
+displays low level information about the configuration of the ring and
+the adapter. This feature has been designed for network adiministrators
+to assist in the diagnosis of network / ring problems.
+
+6/8/99 Peter De Schrijver and Mike Phillips
+
diff --git a/Documentation/networking/policy-routing.txt b/Documentation/networking/policy-routing.txt
index 376dd6e80..36f6936d7 100644
--- a/Documentation/networking/policy-routing.txt
+++ b/Documentation/networking/policy-routing.txt
@@ -83,7 +83,7 @@ Applications
2. Opposite case. Just forget all that you know about routing
tables. Every rule is supplied with its own gateway, device
info. record. This approach is not appropriate for automated
- route maintanance, but it is ideal for manual configuration.
+ route maintenance, but it is ideal for manual configuration.
HOWTO: iproute addrule [ from PREFIX ] [ to PREFIX ] [ tos TOS ]
[ dev INPUTDEV] [ pref PREFERENCE ] route [ gw GATEWAY ]
diff --git a/Documentation/networking/z8530drv.txt b/Documentation/networking/z8530drv.txt
index cf7dc609b..c74fb4253 100644
--- a/Documentation/networking/z8530drv.txt
+++ b/Documentation/networking/z8530drv.txt
@@ -252,7 +252,7 @@ device scc0 # the device for the following params
speed 1200 # the default baudrate
clock dpll # clock source:
- # dpll = normal halfduplex operation
+ # dpll = normal half duplex operation
# external = MODEM provides own Rx/Tx clock
# divider = use full duplex divider if
# installed (1)