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