Next round of fixing all kinds of spelling mistakes.
[dragonfly.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 .\" $DragonFly: src/usr.sbin/i4b/man/isic.4,v 1.7 2007/05/17 08:19:03 swildner Exp $
27 .\"
28 .\"     last edit-date: [Fri Jan 26 14:32:33 2001]
29 .\"
30 .Dd January 26, 2001
31 .Dt ISIC 4
32 .Os
33 .Sh NAME
34 .Nm isic
35 .Nd isdn4bsd Siemens ISDN Chipset device driver
36 .Sh SYNOPSIS
37 .Ss FreeBSD (FreeBSD \(>= 4.0)
38 Asuscom ISDNLink 128K (ISA PnP):
39 .Cd options \&"ASUSCOM_IPAC\&"
40 .Cd "device isic0"
41 .Pp
42 AVM A1 or AVM Fritz!Card classic:
43 .Cd options \&"AVM_A1\&"
44 .Cd "device isic0 at isa? port 0x340 irq 5 flags 4"
45 .Pp
46 Dr. Neuhaus Niccy Go@ (PnP):
47 .Cd options \&"DRN_NGO\&"
48 .Cd "device isic0"
49 .Pp
50 ELSA QuickStep 1000pro ISA (PnP):
51 .Cd options \&"ELSA_QS1ISA\&"
52 .Cd "device isic0"
53 .Pp
54 ELSA MicroLink ISDN/PCI (ELSA QuickStep 1000pro PCI):
55 .Cd options \&"ELSA_QS1PCI\&"
56 .Cd "device isic0"
57 .Pp
58 ELSA PCC-16:
59 .Cd options \&"ELSA_PCC16\&"
60 .Cd "device isic0 at isa? port 0x360 irq 10 flags 20"
61 .Pp
62 Sedlbauer Win Speed card (PnP):
63 .Cd options \&"SEDLBAUER\&"
64 .Cd "device isic0"
65 .Pp
66 Siemens I-Surf 2.0 PnP:
67 .Cd options \&"SIEMENS_ISURF2\&"
68 .Cd "device isic0"
69 .Pp
70 Teles S0/8 or Niccy 1008 card:
71 .Cd options \&"TEL_S0_8\&"
72 .Cd "device isic0 at isa? iomem 0xd0000 irq 5 flags 1"
73 .Pp
74 Teles S0/16 or Creatix ISDN-S0 or Niccy 1016 card:
75 .Cd options \&"TEL_S0_16\&"
76 .Cd "device isic0 at isa? port 0xd80 iomem 0xd0000 irq 5 flags 2"
77 .Pp
78 Teles S0/16.3 card:
79 .Cd options \&"TEL_S0_16_3\&"
80 .Cd "device isic0 at isa? port 0xd80 irq 5 flags 3"
81 .Pp
82 Teles S0/16.3 PnP card (PnP) or
83 Creatix ISDN-S0 P&P card (PnP):
84 .Cd options \&"TEL_S0_16_3_P\&"
85 .Cd "device isic0"
86 .Pp
87 USRobotics Sportster ISDN TA internal or Stollmann Tina-pp card:
88 .Cd options \&"USR_STI\&"
89 .Cd "device isic0 at isa? port 0x268 irq 5 flags 7"
90 .Pp
91 Eicon.Diehl DIVA 2.0 and 2.02 ISA PnP card:
92 .Cd options \&"EICON_DIVA\&"
93 .Cd "device isic0"
94 .Ss NetBSD
95 On the ISA bus:
96 .Pp
97 Teles S0/8 or Niccy 1008 card:
98 .Cd options \&"TEL_S0_8\&"
99 .Cd "isic0 at isa? iomem 0xd0000 irq 5"
100 .Pp
101 Teles S0/16 or Creatix ISDN-S0 or Niccy 1016 card:
102 .Cd options \&"TEL_S0_16\&"
103 .Cd "isic0 at isa? port 0xd80 iomem 0xd0000 irq 5"
104 .Pp
105 Teles S0/16.3 card:
106 .Cd options \&"TEL_S0_16_3\&"
107 .Cd "isic0 at isa? port 0xd80 irq 5"
108 .Pp
109 AVM A1 or AVM Fritz card:
110 .Cd options \&"AVM_A1\&"
111 .Cd "isic0 at isa? port 0x340 irq 5"
112 .Pp
113 USRobotics Sportster ISDN TA internal or Stollmann Tina-pp card:
114 .Cd options \&"USR_STI\&"
115 .Cd "isic0 at isa? port 0x268 irq 5"
116 .Pp
117 ITK ix1 micro card:
118 .Cd options \&"ITKIX1\&"
119 .Cd "isic0 at isa? port 0x398 irq 10"
120 .Pp
121 On the ISAPNP bus:
122 .Pp
123 Teles S0/16.3 PnP card
124 .Cd options \&"TEL_S0_16_3_P\&"
125 .Cd "isic* at isapnp?"
126 .Pp
127 Creatix ISDN-S0 P&P card
128 .Cd options \&"CRTX_S0_P\&"
129 .Cd "isic* at isapnp?"
130 .Pp
131 Dr. Neuhaus Niccy GO@
132 .Cd options \&"DRN_NGO\&"
133 .Cd "isic* at isapnp?"
134 .Pp
135 ELSA QuickStep 1000pro (ISA version):
136 .Cd options \&"ELSA_QS1ISA\&"
137 .Cd "isic* at isapnp?"
138 .Pp
139 Sedlbauer WinSpeed:
140 .Cd options \&"SEDLBAUER\&"
141 .Cd "isic* at isapnp?"
142 .Pp
143 Dynalink IS64PH:
144 .Cd options \&"DYNALINK\&"
145 .Cd "isic* at isapnp?"
146 .Pp
147 Cards on the PCI bus:
148 .Pp
149 ELSA QuickStep 1000pro (PCI version)
150 .Cd options \&"ELSA_QS1PCI\&"
151 .Cd "isic* at pci?"
152 .Pp
153 Cards on the PCMCIA or PCCARD bus:
154 .Pp
155 AVM Fritz!Card PCMCIA
156 .Cd options \&"AVM_A1_PCMCIA\&"
157 .Cd "isic* at pcmcia? function ?"
158 .Pp
159 ELSA MicroLink ISDN/MC
160 .Cd options \&"ELSA_ISDNMC\&"
161 .Cd "isic* at pcmcia? function ?"
162 .Pp
163 ELSA MicroLink MC/all
164 .Cd options \&"ELSA_MCALL\&"
165 .Cd "isic* at pcmcia? function ?"
166 .Pp
167 Cards on the Amiga Zorro bus:
168 .Pp
169 BSC/ITH ISDN Master, ITH ISDN MasterII or VMC ISDN Blaster
170 .Cd "aster* at zbus?"
171 .Cd "isic* at aster? port ?"
172 .Sh DESCRIPTION
173 The
174 .Nm
175 driver provides D-channel layer 1 supports as specified in ITU Recommendation
176 I.430 and layer 1 support for the B-channel.
177 .Pp
178 The driver supports several 8 and 16bit passive ISDN cards from various
179 manufacturers which are all based upon the popular Siemens ISDN chipset
180 consisting of the ISDN Subscriber Access Controller ISAC (such as the
181 PEB2085 or PSB 2186) and the High-Level Serial Communications Controller
182 Extended HSCX (such as the SAB82525 or PSB21525). The newer IPAC chip
183 (which integrates an ISAC and a HSCX in one chip, with the added benefit
184 of larger FIFO buffers) is also supported.
185 .Sh SUPPORTED CARDS
186 .Bl -tag -width Ds -compact
187 .It Ar Teles S0/8, Dr. Neuhaus Niccy 1008, Creatix ISDN-S0/8
188 .Pp
189 The required (optional for
190 .Nx )
191 .Em flag
192 value is 1.
193 .Pp
194 Notice that this cards must not have a
195 .Em port
196 value in the config line.
197 .Pp
198 Valid interrupts are 2, 3, 4, 5, 6 and 7.
199 .Pp
200 The i/o ports are memory mapped and the memory start address may
201 be in the range 0xA0000 to 0xDF000 and uses 4kB of memory.
202 .Pp
203 .It Ar Teles S0/16, Creatix ISDN-S0, Dr. Neuhaus Niccy 1016
204 .Pp
205 The required (optional under
206 .Nx )
207 .Em flag
208 value is 2.
209 .Pp
210 These boards have a jumper which specifies an i/o base address of either
211 0xd80, 0xe80 or 0xf80. The remaining necessary configuration values are then
212 programmed at run time by accessing this i/o port.
213 .Pp
214 Valid interrupts are 2, 3, 4, 5, 10, 11, 12 or 15.
215 .Pp
216 Valid memory start
217 addresses are 0xC0000, 0xC2000, 0xC4000, 0xC6000, 0xC8000, 0xCA000, 0xCC000,
218 0xCE000, 0xD0000, 0xD2000, 0xD4000, 0xD6000, 0xD8000, 0xDA000, 0xDC000 and
219 0xDE000.
220 .Pp
221 Notice: Although the Jumpers are labeled 0xd80, 0xe80 or 0xf80, they
222 also require i/o space at addresses 0x180, 0x280 or 0x380.
223 .Pp
224 .It Ar Teles S0/16.3
225 .Pp
226 The required (optional under
227 .Nx )
228 .Em flag
229 value is 3.
230 .Pp
231 This card is completely i/o mapped and must not have an
232 .Em iomem
233 statement in the config line.
234 .Pp
235 Valid interrupts are 2, 5, 9, 10, 12 or 15.
236 .Pp
237 Notice: Although the switch positions are labeled 0x180, 0x280 and 0x380,
238 the card is to be configured at 0xd80, 0xe80 or 0xf80 respectively!
239 .Pp
240 .It Ar AVM A1, AVM Fritz!Card
241 .Pp
242 The required (optional under
243 .Nx )
244 .Em flag
245 value is 4.
246 .Pp
247 These boards have a jumper which specifies an i/o base address of either
248 0x200, 0x240, 0x300 or 0x340.
249 .Pp
250 Valid interrupt configurations are 3, 4, 5, 6, 7, 10, 11, 12 or 15.
251 .Pp
252 Older Versions of the AVM A1 also require setting of an IRQ jumper, newer
253 versions of this and the Fritz!Card only have an i/o base jumper and the
254 interrupt is setup at runtime by reprogramming a register.
255 .Pp
256 This card is completely i/o mapped and must not have an
257 .Em iomem
258 statement in the config line.
259 .Pp
260 .It Ar Teles S0/16.3 PnP
261 .Pp
262 Possible i/o port values are 0x580, 0x500 and 0x680.
263 Possible interrupt configurations are 3, 5, 7, 10, 11 and 12.
264 .Pp
265 The the card is auto-configured by the PnP kernel subsystem.
266 .Pp
267 .It Ar Creatix ISDN-S0 P&P
268 .Pp
269 Valid i/o port values are 0x120, 0x180 and 0x100.
270 .Pp
271 Valid interrupt configurations are 3, 5, 7, 10, 11 and 12.
272 .Pp
273 The card is auto-configured by the PnP kernel subsystem.
274 .Pp
275 .It Ar "3Com USRobotics Sportster ISDN TA intern and Stollmann Tina pp"
276 .Pp
277 The required (optional for
278 .Nx )
279 .Em flag
280 value is 7.
281 .Pp
282 Valid i/o port values are 0x200, 0x208, 0x210, 0x218, 0x220, 0x228, 0x230,
283 0x238, 0x240, 0x248, 0x250, 0x258, 0x260, 0x268, 0x270 and 0x278.
284 .Pp
285 Valid interrupt configurations are 5, 7, 10, 11, 12, 14, 15.
286 .Pp
287 Notice: this card has a strange address decoding scheme resulting in 64
288 windows of some bytes length. Anyway, support for this card is good because
289 the manufacturer gave out technical docs for this card!
290 .Pp
291 .Pp
292 .It Ar "Dr. Neuhaus Niccy Go@"
293 .Pp
294 Valid i/o port values must be in the range 0x200 ... 0x3e0.
295 .Pp
296 Valid interrupt configurations are 3, 4, 5, 9, 10, 11, 12, 15.
297 .Pp
298 The card is auto-configured by the PnP kernel subsystem.
299 .Pp
300 .It Ar "Sedlbauer Win Speed"
301 .Pp
302 Valid i/o port values must be in the range 0x100 ... 0x3f0. (alignment 0x8,
303 len 0x8)
304 .Pp
305 Valid interrupt configurations are 3, 4, 5, 7, 10, 11, 12, 13, 15.
306 .Pp
307 The card is auto-configured by the PnP kernel subsystem.
308 .Pp
309 .It Ar "ELSA QuickStep 1000pro (ISA)"
310 .Pp
311 I/O port in the range 0x160 ... 0x360 (occupies 8 bytes).
312 .Pp
313 Valid interrupt configurations are 3, 4, 5, 7, 10, 11, 12, 15.
314 .Pp
315 The card is auto-configured by the PnP kernel subsystem.
316 .Pp
317 .Pp
318 .It Ar "ELSA QuickStep 1000pro-PCI"
319 .Pp
320 The card is auto-configured by the PCI kernel subsystem.
321 .Pp
322 .Pp
323 .It Ar "ITK ix1 micro"
324 .Pp
325 The required (optional under
326 .Nx )
327 .Em flag
328 value is 18.
329 .Pp
330 Valid i/o port values must be in the range (<unknown>).
331 .Pp
332 Valid interrupt configurations are (<unknown>).
333 .Pp
334 .It Ar "BSC ISDN Master"
335 .It Ar "ITH ISDN MasterII"
336 .It Ar "VMC ISDN Blaster"
337 .Pp
338 The card addresses are auto-configured by the Zorro bus kernel subsystem.
339 The ISDN functions of the boards are at known (to the driver) relative
340 addresses.
341 .Pp
342 Note that currently, you have to jumper the card interrupt for
343 .Em IPL 2
344 instead of IPL 6 (which is used by most AmigaOS software).
345 .Pp
346 Note that the ITH ISDN MasterII doesn't work in the DraCo Zorro bus. This
347 is no
348 .Nx
349 problem, but general.
350 .El
351 .Sh CAVEATS
352 Note that all of the boards with I/O ports actually use several ranges
353 of port addresses; Teles happen to refer to the 0xd80 range in their
354 documentation (the board also uses 0x180 etc.), while AVM happen to refer
355 to the 0x200 range in their documentation (the board also uses 0x600 etc.)
356 The driver matches the manufacturers' description for the purposes of
357 configuration, but of course makes use of all the ports in order to
358 operate the card.
359 .Sh SEE ALSO
360 .Xr i4bq921 4 ,
361 .Xr i4bq931 4
362 .Sh STANDARDS
363 CCITT Recommendation I.430
364 .Sh AUTHORS
365 .An -nosplit
366 The
367 .Nm
368 driver and this manpage were written by
369 .An Hellmuth Michaelis Aq hm@kts.org .
370 It is based on earlier work of
371 .An Arne Helme ,
372 .An Andrew Gordon
373 and
374 .An Gary Jennejohn .
375 .Pp
376 The complete porting to and maintenance of
377 .Nx
378 was done by
379 .An Martin Husemann Aq martin@rumolt.teuto.de .
380 .Pp
381 The
382 .Nx Ns /Amiga
383 ISDN Blaster/Master/MasterII driver was written by
384 .An Ignatios Souvatzis Aq is@netbsd.org .
385 .Sh BUGS
386 Since there is no hardware documentation available from several manufacturers
387 for their boards, it is likely that there are many, many bugs left.