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