Fix some more the the typos.
[games.git] / usr.sbin / i4b / man / isic.4
1 .\"
2 .\" Copyright (c) 1997, 2001 Hellmuth Michaelis. All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD: src/usr.sbin/i4b/man/isic.4,v 1.8.2.8 2001/08/16 15:55:58 ru Exp $
26 .\"
27 .\"     last edit-date: [Fri Jan 26 14:32:33 2001]
28 .\"
29 .Dd January 26, 2001
30 .Dt ISIC 4
31 .Os
32 .Sh NAME
33 .Nm isic
34 .Nd isdn4bsd Siemens ISDN Chipset device driver
35 .Sh SYNOPSIS
36 Asuscom ISDNLink 128K (ISA PnP):
37 .Cd options \&"ASUSCOM_IPAC\&"
38 .Cd "device isic0"
39 .Pp
40 AVM A1 or AVM Fritz!Card classic:
41 .Cd options \&"AVM_A1\&"
42 .Cd "device isic0 at isa? port 0x340 irq 5 flags 4"
43 .Pp
44 Dr. Neuhaus Niccy Go@ (PnP):
45 .Cd options \&"DRN_NGO\&"
46 .Cd "device isic0"
47 .Pp
48 ELSA QuickStep 1000pro ISA (PnP):
49 .Cd options \&"ELSA_QS1ISA\&"
50 .Cd "device isic0"
51 .Pp
52 ELSA MicroLink ISDN/PCI (ELSA QuickStep 1000pro PCI):
53 .Cd options \&"ELSA_QS1PCI\&"
54 .Cd "device isic0"
55 .Pp
56 ELSA PCC-16:
57 .Cd options \&"ELSA_PCC16\&"
58 .Cd "device isic0 at isa? port 0x360 irq 10 flags 20"
59 .Pp
60 Sedlbauer Win Speed card (PnP):
61 .Cd options \&"SEDLBAUER\&"
62 .Cd "device isic0"
63 .Pp
64 Siemens I-Surf 2.0 PnP:
65 .Cd options \&"SIEMENS_ISURF2\&"
66 .Cd "device isic0"
67 .Pp
68 Teles S0/8 or Niccy 1008 card:
69 .Cd options \&"TEL_S0_8\&"
70 .Cd "device isic0 at isa? iomem 0xd0000 irq 5 flags 1"
71 .Pp
72 Teles S0/16 or Creatix ISDN-S0 or Niccy 1016 card:
73 .Cd options \&"TEL_S0_16\&"
74 .Cd "device isic0 at isa? port 0xd80 iomem 0xd0000 irq 5 flags 2"
75 .Pp
76 Teles S0/16.3 card:
77 .Cd options \&"TEL_S0_16_3\&"
78 .Cd "device isic0 at isa? port 0xd80 irq 5 flags 3"
79 .Pp
80 Teles S0/16.3 PnP card (PnP) or
81 Creatix ISDN-S0 P&P card (PnP):
82 .Cd options \&"TEL_S0_16_3_P\&"
83 .Cd "device isic0"
84 .Pp
85 USRobotics Sportster ISDN TA internal or Stollmann Tina-pp card:
86 .Cd options \&"USR_STI\&"
87 .Cd "device isic0 at isa? port 0x268 irq 5 flags 7"
88 .Pp
89 Eicon.Diehl DIVA 2.0 and 2.02 ISA PnP card:
90 .Cd options \&"EICON_DIVA\&"
91 .Cd "device isic0"
92 .Sh DESCRIPTION
93 The
94 .Nm
95 driver provides D-channel layer 1 supports as specified in ITU Recommendation
96 I.430 and layer 1 support for the B-channel.
97 .Pp
98 The driver supports several 8 and 16bit passive ISDN cards from various
99 manufacturers which are all based upon the popular Siemens ISDN chipset
100 consisting of the ISDN Subscriber Access Controller ISAC (such as the
101 PEB2085 or PSB 2186) and the High-Level Serial Communications Controller
102 Extended HSCX (such as the SAB82525 or PSB21525). The newer IPAC chip
103 (which integrates an ISAC and a HSCX in one chip, with the added benefit
104 of larger FIFO buffers) is also supported.
105 .Sh SUPPORTED CARDS
106 .Bl -tag -width Ds -compact
107 .It Ar Teles S0/8, Dr. Neuhaus Niccy 1008, Creatix ISDN-S0/8
108 .Pp
109 The required (optional for
110 .Nx )
111 .Em flag
112 value is 1.
113 .Pp
114 Notice that this cards must not have a
115 .Em port
116 value in the config line.
117 .Pp
118 Valid interrupts are 2, 3, 4, 5, 6 and 7.
119 .Pp
120 The i/o ports are memory mapped and the memory start address may
121 be in the range 0xA0000 to 0xDF000 and uses 4kB of memory.
122 .Pp
123 .It Ar Teles S0/16, Creatix ISDN-S0, Dr. Neuhaus Niccy 1016
124 .Pp
125 The required (optional under
126 .Nx )
127 .Em flag
128 value is 2.
129 .Pp
130 These boards have a jumper which specifies an i/o base address of either
131 0xd80, 0xe80 or 0xf80. The remaining necessary configuration values are then
132 programmed at run time by accessing this i/o port.
133 .Pp
134 Valid interrupts are 2, 3, 4, 5, 10, 11, 12 or 15.
135 .Pp
136 Valid memory start
137 addresses are 0xC0000, 0xC2000, 0xC4000, 0xC6000, 0xC8000, 0xCA000, 0xCC000,
138 0xCE000, 0xD0000, 0xD2000, 0xD4000, 0xD6000, 0xD8000, 0xDA000, 0xDC000 and
139 0xDE000.
140 .Pp
141 Notice: Although the Jumpers are labeled 0xd80, 0xe80 or 0xf80, they
142 also require i/o space at addresses 0x180, 0x280 or 0x380.
143 .Pp
144 .It Ar Teles S0/16.3
145 .Pp
146 The required (optional under
147 .Nx )
148 .Em flag
149 value is 3.
150 .Pp
151 This card is completely i/o mapped and must not have an
152 .Em iomem
153 statement in the config line.
154 .Pp
155 Valid interrupts are 2, 5, 9, 10, 12 or 15.
156 .Pp
157 Notice: Although the switch positions are labeled 0x180, 0x280 and 0x380,
158 the card is to be configured at 0xd80, 0xe80 or 0xf80 respectively!
159 .Pp
160 .It Ar AVM A1, AVM Fritz!Card
161 .Pp
162 The required (optional under
163 .Nx )
164 .Em flag
165 value is 4.
166 .Pp
167 These boards have a jumper which specifies an i/o base address of either
168 0x200, 0x240, 0x300 or 0x340.
169 .Pp
170 Valid interrupt configurations are 3, 4, 5, 6, 7, 10, 11, 12 or 15.
171 .Pp
172 Older Versions of the AVM A1 also require setting of an IRQ jumper, newer
173 versions of this and the Fritz!Card only have an i/o base jumper and the
174 interrupt is setup at runtime by reprogramming a register.
175 .Pp
176 This card is completely i/o mapped and must not have an
177 .Em iomem
178 statement in the config line.
179 .Pp
180 .It Ar Teles S0/16.3 PnP
181 .Pp
182 Possible i/o port values are 0x580, 0x500 and 0x680.
183 Possible interrupt configurations are 3, 5, 7, 10, 11 and 12.
184 .Pp
185 The card is auto-configured by the PnP kernel subsystem.
186 .Pp
187 .It Ar Creatix ISDN-S0 P&P
188 .Pp
189 Valid i/o port values are 0x120, 0x180 and 0x100.
190 .Pp
191 Valid interrupt configurations are 3, 5, 7, 10, 11 and 12.
192 .Pp
193 The card is auto-configured by the PnP kernel subsystem.
194 .Pp
195 .It Ar "3Com USRobotics Sportster ISDN TA intern and Stollmann Tina pp"
196 .Pp
197 The required (optional for
198 .Nx )
199 .Em flag
200 value is 7.
201 .Pp
202 Valid i/o port values are 0x200, 0x208, 0x210, 0x218, 0x220, 0x228, 0x230,
203 0x238, 0x240, 0x248, 0x250, 0x258, 0x260, 0x268, 0x270 and 0x278.
204 .Pp
205 Valid interrupt configurations are 5, 7, 10, 11, 12, 14, 15.
206 .Pp
207 Notice: this card has a strange address decoding scheme resulting in 64
208 windows of some bytes length. Anyway, support for this card is good because
209 the manufacturer gave out technical docs for this card!
210 .Pp
211 .Pp
212 .It Ar "Dr. Neuhaus Niccy Go@"
213 .Pp
214 Valid i/o port values must be in the range 0x200 ... 0x3e0.
215 .Pp
216 Valid interrupt configurations are 3, 4, 5, 9, 10, 11, 12, 15.
217 .Pp
218 The card is auto-configured by the PnP kernel subsystem.
219 .Pp
220 .It Ar "Sedlbauer Win Speed"
221 .Pp
222 Valid i/o port values must be in the range 0x100 ... 0x3f0. (alignment 0x8,
223 len 0x8)
224 .Pp
225 Valid interrupt configurations are 3, 4, 5, 7, 10, 11, 12, 13, 15.
226 .Pp
227 The card is auto-configured by the PnP kernel subsystem.
228 .Pp
229 .It Ar "ELSA QuickStep 1000pro (ISA)"
230 .Pp
231 I/O port in the range 0x160 ... 0x360 (occupies 8 bytes).
232 .Pp
233 Valid interrupt configurations are 3, 4, 5, 7, 10, 11, 12, 15.
234 .Pp
235 The card is auto-configured by the PnP kernel subsystem.
236 .Pp
237 .Pp
238 .It Ar "ELSA QuickStep 1000pro-PCI"
239 .Pp
240 The card is auto-configured by the PCI kernel subsystem.
241 .Pp
242 .Pp
243 .It Ar "ITK ix1 micro"
244 .Pp
245 The required (optional under
246 .Nx )
247 .Em flag
248 value is 18.
249 .Pp
250 Valid i/o port values must be in the range (<unknown>).
251 .Pp
252 Valid interrupt configurations are (<unknown>).
253 .Pp
254 .It Ar "BSC ISDN Master"
255 .It Ar "ITH ISDN MasterII"
256 .It Ar "VMC ISDN Blaster"
257 .Pp
258 The card addresses are auto-configured by the Zorro bus kernel subsystem.
259 The ISDN functions of the boards are at known (to the driver) relative
260 addresses.
261 .Pp
262 Note that currently, you have to jumper the card interrupt for
263 .Em IPL 2
264 instead of IPL 6 (which is used by most AmigaOS software).
265 .Pp
266 Note that the ITH ISDN MasterII doesn't work in the DraCo Zorro bus. This
267 is no
268 .Nx
269 problem, but general.
270 .El
271 .Sh CAVEATS
272 Note that all of the boards with I/O ports actually use several ranges
273 of port addresses; Teles happen to refer to the 0xd80 range in their
274 documentation (the board also uses 0x180 etc.), while AVM happen to refer
275 to the 0x200 range in their documentation (the board also uses 0x600 etc.)
276 The driver matches the manufacturers' description for the purposes of
277 configuration, but of course makes use of all the ports in order to
278 operate the card.
279 .Sh SEE ALSO
280 .Xr i4bq921 4 ,
281 .Xr i4bq931 4
282 .Sh STANDARDS
283 CCITT Recommendation I.430
284 .Sh AUTHORS
285 .An -nosplit
286 The
287 .Nm
288 driver and this manpage were written by
289 .An Hellmuth Michaelis Aq hm@kts.org .
290 It is based on earlier work of
291 .An Arne Helme ,
292 .An Andrew Gordon
293 and
294 .An Gary Jennejohn .
295 .Pp
296 The complete porting to and maintenance of
297 .Nx
298 was done by
299 .An Martin Husemann Aq martin@rumolt.teuto.de .
300 .Pp
301 The
302 .Nx Ns /Amiga
303 ISDN Blaster/Master/MasterII driver was written by
304 .An Ignatios Souvatzis Aq is@netbsd.org .
305 .Sh BUGS
306 Since there is no hardware documentation available from several manufacturers
307 for their boards, it is likely that there are many, many bugs left.