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