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