share/man/man4/pcic.4

   1 .\"
   2 .\" Copyright (c) 2001 M. Warner Losh
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. The name of the author may not be used to endorse or promote products
  11 .\"    derived from this software without specific prior written permission.
  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/share/man/man4/pcic.4,v 1.2.2.2 2001/12/17 11:30:12 ru Exp $
  26 .\"     $DragonFly: src/share/man/man4/Attic/pcic.4,v 1.3 2004/03/11 12:28:55 hmp Exp $
  27 .\"
  28 .Dd August 25, 2001
  29 .Dt PCIC 4
  30 .Os
  31 .Sh NAME
  32 .Nm pcic
  33 .Nd pccard bridge driver
  34 .Sh SYNOPSIS
  35 .Cd device pcic
  36 .Cd device card
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 driver controls the pccard subsystem.
  41 The
  42 .Nm
  43 driver supports most
  44 .Tn ExCA
  45 devices attached to either
  46 .Tn ISA
  47 or
  48 .Tn PCI
  49 bus.
  50 The
  51 .Nm
  52 driver does not support the so-called TCIC controllers made by
  53 Databook.
  54 Nor does it support the MECIA chipset found in some early PC98
  55 NOTE PC machines.
  56 The mecia driver now supports that bridge.
  57 .Pp
  58 The following
  59 .Tn ISA
  60 devices, or true clones, are supported in the current code.
  61 .Pp
  62 .Bl -tag -width "Intel i82365SL Step A" -compact
  63 .It Intel i82365SL Step A
  64 .It Intel i82365SL Step B
  65 .It Intel i82365SL Step C
  66 .Tn Intel Ns 's
  67 original 16-bit pccard controller.
  68 .It Intel i82365SL-DF
  69 .Tn Intel Ns 's
  70 last version of this device.
  71 3.3V support was added.
  72 .It VLSI 82C146
  73 An older VLSI part with some issues on some machines.
  74 .It Cirrus Logic PD-6710
  75 .It Cirrus Logic PD-6720
  76 .It Cirrus Logic PD-6722
  77 Cirrus Logic's pcic controller.
  78 Compatible with the i82365SL Step C with the addition of a different
  79 3.3V control.
  80 .It Ricoh RF5C296
  81 .It Ricoh RF5C396
  82 Ricoh's pccard bridge chips.
  83 These are compatible with the i82365SL Step C, but with yet another
  84 different 3.3V control.
  85 .It Vadem 365
  86 .It Vadem 465
  87 Compatible with i82365SL Step C.
  88 .It Vadem 468
  89 .It Vadem 469
  90 Like the earlier Vadem models, but with Vadem's own, incompatible, 3.3V
  91 control system.
  92 .It IBM PCIC
  93 .Tn IBM
  94 clone of the original i82365SL part, with its own ID register value.
  95 Has no 3.3V ability.
  96 .It IBM KING
  97 A strange clone of i82365SL.
  98 This part has many restrictions not found in the i82365SL, plus some
  99 strange power control.
 100 It has not been tested in ages, but is believed to work.
 101 Its use is believed to be confined to model of ISA card, available
 102 only in Japan.
 103 .El
 104 .Pp
 105 Many other vendors made parts in this arena, but most of them were
 106 compatible with one of the above chipsets.
 107 .Pp
 108 The following PCI cardbus and pcmcia bridges are supported:
 109 .Pp
 110 .Bl -tag -width "Intel i82365SL Step A" -compact
 111 .It Cirrus Logic PD6729
 112 .It Cirrus Logic PD6730
 113 These two might be broken at the moment.
 114 .It Cirrus Logic PD6832
 115 .It Cirrus Logic PD6833
 116 .Pp
 117 .It O2micro OZ6729
 118 .It O2micro OZ6730
 119 .It O2micro OZ6812
 120 .It O2micro OZ6832
 121 .It O2micro OZ6833
 122 .It O2micro OZ6836
 123 .It O2micro OZ6860
 124 .It O2micro OZ6872
 125 O2 Micro chips may be poorly supported because the author does not
 126 have good access to machines with one of these bridges in it.
 127 .Pp
 128 .It Ricoh RL4C475
 129 .It Ricoh RL4C476
 130 .It Ricoh RL4C477
 131 .It Ricoh RL4C478
 132 .Pp
 133 .It TI PCI-1031
 134 .It TI PCI-1130
 135 .It TI PCI-1131
 136 .It TI PCI-1211
 137 .It TI PCI-1220
 138 .It TI PCI-1221
 139 .It TI PCI-1225
 140 .It TI PCI-1250
 141 .It TI PCI-1251
 142 .It TI PCI-1251B
 143 .It TI PCI-1410
 144 .It TI PCI-1420
 145 .It TI PCI-1450
 146 .It TI PCI-1451
 147 .It TI PCI-4451
 148 .Pp
 149 .It Toshiba ToPIC95
 150 .It Toshiba ToPIC97
 151 .It Toshiba ToPIC100
 152 .El
 153 .Sh FILES
 154 .Bl -tag -width ".Pa /dev/card0" -compact
 155 .It Pa /dev/card0
 156 Character device for the
 157 .Nm
 158 driver.
 159 .El
 160 .Sh MODES OF OPERATION
 161 The ISA device supports routing ISA interrupts only.
 162 You cannot share ISA interrupts.
 163 Every interrupt must be unique.
 164 .Pp
 165 The PCI device supports routing ISA or PCI interrupts.
 166 PCI interrupts are sharable.
 167 ISA interrupts are not sharable.
 168 PCI interrupts should be used unless your machine has a specific problem using
 169 them.
 170 .Pp
 171 PCI interrupt routing is the default for PCI devices.
 172 Some older laptops require ISA interrupt routing to work properly.
 173 To enable ISA interrupt routing, you must set the tunable
 174 .Li hw.pcic.intr_path=1
 175 in
 176 .Pa /boot/loader.conf .
 177 For the present, unless you have a one slot machine, you should set
 178 .Li hw.pcic.irq=0
 179 to force polling mode.
 180 Two slot machines have minor issues with using an ISA interrupt for the
 181 CSC interrupt.
 182 .Sh TUNABLES
 183 .Bl -tag -width indent
 184 .It Va hw.pcic.ignore_function_1
 185 Needed for some, improperly manufactured PCI cards made by Orinoco.
 186 It disables function 1 completely.
 187 Set to 0 to enable function 1.
 188 Set to 1 to disable function 1.
 189 This tunable generally should not be needed on laptops.
 190 The default is 0.
 191 .It Va hw.pcic.init_routing
 192 Some machines can tolerate interrupt routing selection at the cardbus
 193 bridge level.
 194 Others fail when you mess with these registers.
 195 Set to 1 to force the chipset to route via parallel PCI interrupts (as
 196 well as a few other little things).
 197 Setting to 0, the default, forces the code to leave these registers as the
 198 code finds them.
 199 Most laptops will not need to set this tunable.
 200 Many PCI cards with cardbus chips on them are believed to need this
 201 tunable set to 1.
 202 The default is 0.
 203 .It Va hw.pcic.intr_path
 204 Should PCI pcic devices route interrupts via ISA or PCI.
 205 A value of 1 means route via ISA.
 206 A value of 2 means route via PCI.
 207 This is ignored for the ISA device.
 208 Many older laptops do not have PCI BIOS implementations that
 209 .Dx
 210 can use to route interrupts properly.
 211 These laptops may need to set this to 1 and
 212 .Va hw.pcic.irq
 213 to a value
 214 (or 0 for polling).
 215 The default is 2.
 216 .It Va hw.pcic.irq
 217 Overrides the IRQ to use for ISA interrupt routing of the CSC or
 218 management interrupt.
 219 If you are using the ISA device, you can set this tunable, or use the
 220 .Cd "irq N"
 221 clause in config file.
 222 If you are using a PCI device in ISA interrupt mode (see
 223 .Va hw.pcic.intr_path ) ,
 224 then you must set the interrupt with this
 225 sysctl, or polling mode will be used.
 226 Due to limitations in the tunable system, only one interrupt can be selected
 227 for all cards.
 228 Systems with multiple PCI bridges that need to use ISA routing are encouraged
 229 to use polling mode on each of the cards.
 230 The default is 0.
 231 .El
 232 .Sh HISTORY
 233 Too long to detail in the man page.
 234 .Sh BUGS
 235 Too many to list.
 236 Some are the fault of the standard.
 237 Some are the fault of bad standard compliance.
 238 Some are Warner's fault.