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