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