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