[kernel-doc] fix various DocBook build problems/warnings
[linux-2.6] / Documentation / networking / tms380tr.txt
1 Text file for the Linux SysKonnect Token Ring ISA/PCI Adapter Driver.
2         Text file by: Jay Schulist <jschlst@samba.org>
3
4 The Linux SysKonnect Token Ring driver works with the SysKonnect TR4/16(+) ISA,
5 SysKonnect TR4/16(+) PCI, SysKonnect TR4/16 PCI, and older revisions of the
6 SK NET TR4/16 ISA card.
7
8 Latest information on this driver can be obtained on the Linux-SNA WWW site.
9 Please point your browser to: 
10 http://www.linux-sna.org
11
12 Many thanks to Christoph Goos for his excellent work on this driver and
13 SysKonnect for donating the adapters to Linux-SNA for the testing and 
14 maintenance of this device driver.
15
16 Important information to be noted:
17 1. Adapters can be slow to open (~20 secs) and close (~5 secs), please be 
18    patient.
19 2. This driver works very well when autoprobing for adapters. Why even 
20    think about those nasty io/int/dma settings of modprobe when the driver 
21    will do it all for you!
22
23 This driver is rather simple to use. Select Y to Token Ring adapter support
24 in the kernel configuration. A choice for SysKonnect Token Ring adapters will
25 appear. This drives supports all SysKonnect ISA and PCI adapters. Choose this
26 option. I personally recommend compiling the driver as a module (M), but if you
27 you would like to compile it staticly answer Y instead.
28
29 This driver supports multiple adapters without the need to load multiple copies
30 of the driver. You should be able to load up to 7 adapters without any kernel
31 modifications, if you are in need of more please contact the maintainer of this
32 driver.
33
34 Load the driver either by lilo/loadlin or as a module. When a module using the
35 following command will suffice for most:
36
37 # modprobe sktr
38
39 This will produce output similar to the following: (Output is user specific)
40
41 sktr.c: v1.01 08/29/97 by Christoph Goos
42 tr0: SK NET TR 4/16 PCI found at 0x6100, using IRQ 17.
43 tr1: SK NET TR 4/16 PCI found at 0x6200, using IRQ 16.
44 tr2: SK NET TR 4/16 ISA found at 0xa20, using IRQ 10 and DMA 5.
45
46 Now just setup the device via ifconfig and set and routes you may have. After
47 this you are ready to start sending some tokens.
48
49 Errata:
50 For anyone wondering where to pick up the SysKonnect adapters please browse
51 to http://www.syskonnect.com
52
53 This driver is under the GNU General Public License. Its Firmware image is 
54 included as an initialized C-array and is licensed by SysKonnect to the Linux 
55 users of this driver. However no warranty about its fitness is expressed or 
56 implied by SysKonnect.
57
58 Below find attached the setting for the SK NET TR 4/16 ISA adapters
59 -------------------------------------------------------------------
60
61                     ***************************
62                     ***   C O N T E N T S   ***
63                     ***************************
64
65                 1) Location of DIP-Switch W1
66                 2) Default settings
67                 3) DIP-Switch W1 description
68
69
70   ==============================================================
71   CHAPTER 1     LOCATION OF DIP-SWITCH
72   ==============================================================
73
74 UÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄ¿
75 þUÄÄÄÄÄÄ¿                         UÄÄÄÄÄ¿            UÄÄÄ¿         þ
76 þAÄÄÄÄÄÄU                      W1 AÄÄÄÄÄU     UÄÄÄÄ¿ þ   þ         þ
77 þUÄÄÄÄÄÄ¿                                     þ    þ þ   þ      UÄÄÅ¿
78 þAÄÄÄÄÄÄU              UÄÄÄÄÄÄÄÄÄÄÄ¿          AÄÄÄÄU þ   þ      þ  þþ
79 þUÄÄÄÄÄÄ¿              þ           þ          UÄÄÄ¿  AÄÄÄU      AÄÄÅU
80 þAÄÄÄÄÄÄU              þ TMS380C26 þ          þ   þ                þ
81 þUÄÄÄÄÄÄ¿              þ           þ          AÄÄÄU                AÄ¿
82 þAÄÄÄÄÄÄU              þ           þ                               þ þ
83 þ                      AÄÄÄÄÄÄÄÄÄÄÄU                               þ þ
84 þ                                                                  þ þ
85 þ                                                                  AÄU
86 þ                                                                  þ
87 þ                                                                  þ
88 þ                                                                  þ
89 þ                                                                  þ
90 AÄÄÄÄÄÄÄÄÄÄÄÄAÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄAÄÄAÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄAÄÄÄÄÄÄÄÄÄU
91              AÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄU  AÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄÄU
92
93   ==============================================================
94   CHAPTER 2     DEFAULT SETTINGS
95   ==============================================================
96
97           W1    1  2  3  4  5  6  7  8
98         +------------------------------+
99         | ON    X                      |
100         | OFF      X  X  X  X  X  X  X |
101         +------------------------------+
102
103         W1.1 = ON               Adapter drives address lines SA17..19
104         W1.2 - 1.5 = OFF        BootROM disabled
105         W1.6 - 1.8 = OFF        I/O address 0A20h
106
107   ==============================================================
108   CHAPTER 3     DIP SWITCH W1 DESCRIPTION
109   ==============================================================
110
111       UÄÄÄAÄÄÄAÄÄÄAÄÄÄAÄÄÄAÄÄÄAÄÄÄAÄÄÄ¿  ON
112       þ 1 þ 2 þ 3 þ 4 þ 5 þ 6 þ 7 þ 8 þ
113       AÄÄÄAÄÄÄAÄÄÄAÄÄÄAÄÄÄAÄÄÄAÄÄÄAÄÄÄU  OFF
114       |AD | BootROM Addr. |  I/O      |
115       +-+-+-------+-------+-----+-----+
116         |         |             |
117         |         |             +------ 6     7     8
118         |         |                     ON    ON    ON       1900h
119         |         |                     ON    ON    OFF      0900h
120         |         |                     ON    OFF   ON       1980h
121         |         |                     ON    OFF   OFF      0980h
122         |         |                     OFF   ON    ON       1b20h
123         |         |                     OFF   ON    OFF      0b20h
124         |         |                     OFF   OFF   ON       1a20h
125         |         |                     OFF   OFF   OFF      0a20h    (+)
126         |         |
127         |         |
128         |         +-------- 2     3     4     5
129         |                   OFF   x     x     x       disabled  (+)
130         |                   ON    ON    ON    ON      C0000
131         |                   ON    ON    ON    OFF     C4000
132         |                   ON    ON    OFF   ON      C8000
133         |                   ON    ON    OFF   OFF     CC000
134         |                   ON    OFF   ON    ON      D0000
135         |                   ON    OFF   ON    OFF     D4000
136         |                   ON    OFF   OFF   ON      D8000
137         |                   ON    OFF   OFF   OFF     DC000
138         |
139         |
140         +----- 1
141                OFF    adapter does NOT drive SA<17..19>
142                ON     adapter drives SA<17..19>  (+)
143
144
145         (+) means default setting
146
147                        ********************************