usr.sbin/i4b/man/isic.4

   1 .\"
   2 .\" Copyright (c) 1997, 2002 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$
  26 .\"
  27 .\"     last edit-date: [Sun Jul 28 20:14:24 2002]
  28 .\"
  29 .Dd July 28, 2002
  30 .Dt ISIC 4
  31 .Os
  32 .Sh NAME
  33 .Nm isic
  34 .Nd isdn4bsd Siemens ISDN Chipset device driver
  35 .Sh SYNOPSIS
  36 .Cd "device isic"
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 driver provides D-channel layer 1 supports as specified in ITU Recommendation
  41 I.430 and layer 1 support for the B-channel.
  42 .Pp
  43 The driver supports several 8 and 16bit passive ISA, ISA PnP and PCI
  44 ISDN cards from various manufacturers which are all based upon the
  45 popular Siemens ISDN chipset consisting of the ISDN Subscriber Access
  46 Controller ISAC (such as the PEB2085 or PSB 2186) and the High-Level
  47 Serial Communications Controller Extended HSCX (such as the SAB82525
  48 or PSB21525).
  49 The newer IPAC chip (which integrates an ISAC and a HSCX in one chip,
  50 with the added benefit of larger FIFO buffers) is also supported.
  51 .Sh SUPPORTED CARDS: ISA bus, NON-PnP
  52 .Bl -tag -width Ds -compact
  53 .It Ar Teles S0/8, Dr. Neuhaus Niccy 1008, Creatix ISDN-S0/8
  54 .Pp
  55 The required entry in the kernel config file is:
  56 .Bd -literal -offset indent
  57 options TEL_S0_8
  58 .Ed
  59 .Pp
  60 The required entry in
  61 .Xr device.hints 5
  62 file is:
  63 .Pp
  64 .Bd -literal -offset indent
  65 hint.isic.0.at="isa"
  66 hint.isic.0.maddr="0xd0000"
  67 hint.isic.0.irq="5"
  68 hint.isic.0.flags="1"
  69 .Ed
  70 .Pp
  71 Notice that this cards must not have a
  72 .Em port
  73 value.
  74 .Pp
  75 Valid values for hint.isic.N.irq are 2, 3, 4, 5, 6 and 7.
  76 .Pp
  77 The i/o ports are memory mapped and the memory start address (hint.isic.N.maddr)
  78 may be in the range 0xA0000 to 0xDF000 and use a region of 4kB of memory.
  79 .Pp
  80 .It Ar Teles S0/16, Creatix ISDN-S0, Dr. Neuhaus Niccy 1016
  81 .Pp
  82 The required entry in the kernel config file is:
  83 .Bd -literal -offset indent
  84 options TEL_S0_16
  85 .Ed
  86 .Pp
  87 The required entry in
  88 .Xr device.hints 5
  89 file is:
  90 .Pp
  91 .Bd -literal -offset indent
  92 hint.isic.0.at="isa"
  93 hint.isic.0.port="0xd80"
  94 hint.isic.0.maddr="0xd0000"
  95 hint.isic.0.irq="5"
  96 hint.isic.0.flags="2"
  97 .Ed
  98 .Pp
  99 These boards have a jumper which specifies an i/o base address
 100 (hint.isic.N.port) of either 0xd80, 0xe80 or 0xf80.
 101 The remaining necessary configuration values are then
 102 programmed at run time by accessing this i/o port.
 103 .Pp
 104 Valid interrupts (hint.isic.N.irq) are 2, 3, 4, 5, 10, 11, 12 or 15.
 105 .Pp
 106 Valid memory start addresses (hint.isic.N.maddr) are
 107 0xC0000, 0xC2000, 0xC4000, 0xC6000, 0xC8000, 0xCA000, 0xCC000, 0xCE000,
 108 0xD0000, 0xD2000, 0xD4000, 0xD6000, 0xD8000, 0xDA000, 0xDC000 and
 109 0xDE000.
 110 .Pp
 111 Notice: Although the jumpers are labeled 0xd80, 0xe80 or 0xf80, they
 112 also require i/o space at addresses 0x180, 0x280 or 0x380.
 113 .Pp
 114 .It Ar Teles S0/16.3
 115 .Pp
 116 The required entry in the kernel config file is:
 117 .Bd -literal -offset indent
 118 options TEL_S0_16_3
 119 .Ed
 120 .Pp
 121 The required entry in
 122 .Xr device.hints 5
 123 file is:
 124 .Pp
 125 .Bd -literal -offset indent
 126 hint.isic.0.at="isa"
 127 hint.isic.0.port="0xd80"
 128 hint.isic.0.irq="5"
 129 hint.isic.0.flags="3"
 130 .Ed
 131 .Pp
 132 This card is completely i/o mapped and must not have an
 133 .Em maddr
 134 statement in the hints file.
 135 .Pp
 136 Valid interrupts (hint.isic.N.irq) are 2, 5, 9, 10, 12 or 15.
 137 .Pp
 138 These boards have a jumper which specifies an i/o base address
 139 (hint.isic.N.port) of either 0xd80, 0xe80 or 0xf80.
 140 .Pp
 141 Notice: Although the switch positions are labeled 0x180, 0x280 and 0x380,
 142 the card is to be configured at 0xd80, 0xe80 or 0xf80 respectively!
 143 .Pp
 144 .It Ar AVM A1 and AVM Fritz!Card
 145 .Pp
 146 The required entry in the kernel config file is:
 147 .Bd -literal -offset indent
 148 options AVM_A1
 149 .Ed
 150 .Pp
 151 The required entry in
 152 .Xr device.hints 5
 153 file is:
 154 .Pp
 155 .Bd -literal -offset indent
 156 hint.isic.0.at="isa"
 157 hint.isic.0.port="0x340"
 158 hint.isic.0.irq="5"
 159 hint.isic.0.flags="4"
 160 .Ed
 161 .Pp
 162 These boards have a jumper which specifies an i/o base address (hint.isic.N.port)
 163 of either 0x200, 0x240, 0x300 or 0x340.
 164 .Pp
 165 Valid interrupt (hint.isic.N.irq) values are 3, 4, 5, 6, 7, 10, 11, 12 or 15.
 166 .Pp
 167 Older Versions of the AVM A1 also require setting of an IRQ jumper, newer
 168 versions of this and the Fritz!Card only have an i/o base jumper and the
 169 interrupt is setup at runtime by reprogramming a register.
 170 .Pp
 171 .It Ar USRobotics Sportster ISDN TA intern and Stollmann Tina pp
 172 .Pp
 173 The required entry in the kernel config file is:
 174 .Bd -literal -offset indent
 175 options USR_STI
 176 .Ed
 177 .Pp
 178 The required entry in
 179 .Xr device.hints 5
 180 file is:
 181 .Pp
 182 .Bd -literal -offset indent
 183 hint.isic.0.at="isa"
 184 hint.isic.0.port="0x268"
 185 hint.isic.0.irq="5"
 186 hint.isic.0.flags="7"
 187 .Ed
 188 .Pp
 189 Valid i/o port values (hint.isic.N.port) are 0x200, 0x208, 0x210, 0x218,
 190 0x220, 0x228, 0x230, 0x238, 0x240, 0x248, 0x250, 0x258, 0x260, 0x268,
 191 0x270 and 0x278.
 192 .Pp
 193 Valid interrupt (hint.isic.N.irq) values are 5, 7, 10, 11, 12, 14, 15.
 194 .Pp
 195 Notice: this card has a strange address decoding scheme resulting in
 196 occupying 64 windows of some bytes length over the whole i/o address
 197 range.
 198 .Pp
 199 .It Ar ITK ix1 Micro ( < V.3, non-PnP version )
 200 .Pp
 201 The required entry in the kernel config file is:
 202 .Bd -literal -offset indent
 203 options ITKIX1
 204 .Ed
 205 .Pp
 206 The required entry in
 207 .Xr device.hints 5
 208 file is:
 209 .Pp
 210 .Bd -literal -offset indent
 211 hint.isic.0.at="isa"
 212 hint.isic.0.port="0x398"
 213 hint.isic.0.irq="10"
 214 hint.isic.0.flags="18"
 215 .Ed
 216 .Pp
 217 Valid i/o port values must be in the range (<unknown>).
 218 .Pp
 219 Valid interrupt configurations are (<unknown>).
 220 .Pp
 221 .It Ar ELSA MicroLink ISDN/PCC-16 and ELSA PCFpro
 222 .Pp
 223 The required entry in the kernel config file is:
 224 .Bd -literal -offset indent
 225 options ELSA_PCC16
 226 .Ed
 227 .Pp
 228 The required entry in
 229 .Xr device.hints 5
 230 file is:
 231 .Pp
 232 .Bd -literal -offset indent
 233 hint.isic.0.at="isa"
 234 hint.isic.0.port="0x360"
 235 hint.isic.0.irq="10"
 236 hint.isic.0.flags="20"
 237 .Ed
 238 .Pp
 239 Valid i/o port (hint.isic.N.port) values are 0x160, 0x170, 0x260 and 0x360.
 240 .Pp
 241 Valid interrupt (hint.isic.N.irq) values are 2, 3, 5, 10, 11 and 15.
 242 .Pp
 243 The LED's are not supported and are off.
 244 .Pp
 245 .El
 246 .Sh SUPPORTED CARDS: ISA bus, PnP (Plug 'n Pray)
 247 .Bl -tag -width Ds -compact
 248 .It Ar Teles S0/16.3 PnP
 249 .Pp
 250 The required entry in the kernel config file is:
 251 .Bd -literal -offset indent
 252 options TEL_S0_16_3_P
 253 .Ed
 254 .Pp
 255 .It Ar Creatix ISDN-S0 P&P
 256 .Pp
 257 The required entry in the kernel config file is:
 258 .Bd -literal -offset indent
 259 options CRTX_S0_P
 260 .Ed
 261 .Pp
 262 .It Ar "Dr. Neuhaus Niccy Go@"
 263 .Pp
 264 The required entry in the kernel config file is:
 265 .Bd -literal -offset indent
 266 options DRN_NGO
 267 .Ed
 268 .Pp
 269 .It Ar "Sedlbauer Win Speed"
 270 .Pp
 271 The required entry in the kernel config file is:
 272 .Bd -literal -offset indent
 273 options SEDLBAUER
 274 .Ed
 275 .Pp
 276 .It Ar "Dynalink IS64PH"
 277 .Pp
 278 The required entry in the kernel config file is:
 279 .Bd -literal -offset indent
 280 options DYNALINK
 281 .Ed
 282 .Pp
 283 .It Ar "ELSA QuickStep 1000pro ISA"
 284 .Pp
 285 The required entry in the kernel config file is:
 286 .Bd -literal -offset indent
 287 options ELSA_QS1ISA
 288 .Ed
 289 .Pp
 290 The LED's are not supported and are off.
 291 .Pp
 292 .It Ar "Siemens I-Surf 2.0"
 293 .Pp
 294 The required entry in the kernel config file is:
 295 .Bd -literal -offset indent
 296 options SIEMENS_ISURF2
 297 .Ed
 298 .Pp
 299 .It Ar "Asuscom ISDNlink 128K ISA"
 300 .Pp
 301 The required entry in the kernel config file is:
 302 .Bd -literal -offset indent
 303 options ASUSCOM_IPAC
 304 .Ed
 305 .Pp
 306 .It Ar "Eicon Diehl DIVA 2.0 and 2.02"
 307 .Pp
 308 The required entry in the kernel config file is:
 309 .Bd -literal -offset indent
 310 options EICON_DIVA
 311 .Ed
 312 .Pp
 313 .It Ar "Compaq Microcom 610 ISDN card (Compaq series PSB2222I)"
 314 .Pp
 315 The required entry in the kernel config file is:
 316 .Bd -literal -offset indent
 317 options COMPAQ_M610
 318 .Ed
 319 .Pp
 320 .El
 321 .Sh SUPPORTED CARDS: PCI bus
 322 .Bl -tag -width Ds -compact
 323 .It Ar "ELSA QuickStep 1000pro-PCI"
 324 .Pp
 325 The required entry in the kernel config file is:
 326 .Bd -literal -offset indent
 327 options ELSA_QS1PCI
 328 .Ed
 329 .Pp
 330 The LED's are not supported and are off.
 331 .Pp
 332 .El
 333 .Sh CAVEATS
 334 Note that all of ISA boards with i/o ports actually use several ranges
 335 of port addresses; Teles happen to refer to the 0xd80 range in their
 336 documentation (the board also uses 0x180 etc.), while AVM happen to refer
 337 to the 0x200 range in their documentation (the board also uses 0x600 etc.)
 338 The driver matches the manufacturers' description for the purposes of
 339 configuration, but of course makes use of all the ports in order to
 340 operate the card.
 341 .Sh SEE ALSO
 342 .Xr i4bq921 4 ,
 343 .Xr i4bq931 4
 344 .Sh STANDARDS
 345 CCITT Recommendation I.430
 346 .Sh AUTHORS
 347 .An -nosplit
 348 The
 349 .Nm
 350 driver and this manpage were written by
 351 .An Hellmuth Michaelis Aq hm@FreeBSD.org .
 352 It is based on earlier work of
 353 .An Arne Helme ,
 354 .An Andrew Gordon
 355 and
 356 .An Gary Jennejohn Aq gj@FreeBSD.org .
 357 .Sh BUGS
 358 Since there is no hardware documentation available from the manufacturers
 359 of several boards, it is likely that there are many bugs left.