manual/pcmcia-cs/original/man4/i82365.4

   1 .\" Copyright (C) 1998 David A. Hinds -- dahinds@users.sourceforge.net
   2 .\" i82365.4 1.36 2000/06/12 21:24:47
   3 .\"
   4 .TH I82365 4 "2000/06/12 21:24:47" "pcmcia-cs"
   5 .SH NAME
   6 i82365 \- Intel i82365sl PCMCIA controller driver
   7
   8 .SH SYNOPSIS
   9 .B insmod i82365.o
  10 .RB [ pc_debug=\c
  11 .IR n ]
  12 .RB [ i365_base=\c
  13 .IR n ]
  14 .RB [ ignore=\c
  15 .IR n ]
  16 .RB [ extra_sockets=\c
  17 .IR n ]
  18 .RB [ do_scan=\c
  19 .IR n ]
  20 .RB [ irq_list=\c
  21 .IR i,j,... ]
  22 .RB [ cs_irq=\c
  23 .IR n ]
  24 .RB [ poll_interval=\c
  25 .IR n ]
  26 .RB [ cycle_time=\c
  27 .IR n ]
  28 .RB [ do_pci_probe=\c
  29 .IR n ]
  30 .RB [ cb_write_post=\c
  31 .IR n ]
  32 .RB [ pci_csc=\c
  33 .IR n ]
  34 .RB [ pci_int=\c
  35 .IR n ]
  36 .RB [ pci_irq_list=\c
  37 .IR i,j,... ]
  38 .RB [ has_dma=\c
  39 .IR n ]
  40 .RB [ has_led=\c
  41 .IR n ]
  42 .RB [ has_ring=\c
  43 .IR n ]
  44 .RB [ freq_bypass=\c
  45 .IR n ]
  46 .RB [ setup_time=\c
  47 .IR n ]
  48 .RB [ cmd_time=\c
  49 .IR n ]
  50 .RB [ recov_time=\c
  51 .IR n ]
  52 .RB [ wakeup=\c
  53 .IR n ]
  54 .RB [ fast_pci=\c
  55 .IR n ]
  56 .RB [ async_clock=\c
  57 .IR n ]
  58 .RB [ cable_mode=\c
  59 .IR n ]
  60 .RB [ irq_mode=\c
  61 .IR n ]
  62 .RB [ p2cclk=\c
  63 .IR n ]
  64
  65 .SH DESCRIPTION
  66 This is the low-level driver for the Intel i82365sl PCMCIA host
  67 controller, and many derivative controllers.  It also implements the
  68 Intel "Yenta" register specification for CardBus bridges.  Common
  69 clones of the i82365sl include controllers made by Cirrus Logic, IBM,
  70 O2Micro, Omega Micro, Ricoh, SMC, Texas Instruments, Toshiba, Vadem,
  71 and VLSI.  The overwhelming majority of current PCMCIA controllers,
  72 and all CardBus bridges, are register compatible with the i82365sl.
  73 This driver is used by Card Services for configuring the host
  74 controller, and for monitoring card status change events.
  75 .PP
  76 An ISA i82365-compatible controller normally sits at the IO addresses
  77 0x3e0-0x3e1.  Two ISA controllers can cooperate to share the same IO
  78 ports, supporting a total of four sockets.  A second pair of
  79 controllers can be located at 0x3e2-0x3e3.  Probing at this position
  80 is controlled by the \fBextra_sockets\fR parameter.  This only affects
  81 ISA bridges: the PCI bridge probe handles multiple controllers
  82 automatically.  The driver will support a maximum of eight sockets.
  83
  84 .SH CardBus interrupt delivery
  85 CardBus bridges generally support both PCI and ISA interrupt signals,
  86 and multiple methods of deliving interrupt events to the host system.
  87 The system BIOS is partly responsible for correctly configuring the
  88 bridge to match the implemented interrupt hardware at boot time.  This
  89 module provides several parameters for overriding this default
  90 interrupt configuration.  The \fBpci_int\fR and \fBpci_csc\fR settings
  91 can be used to control use of PCI interrupts for card interrupts or
  92 card status changes.  The \fBirq_mode\fR setting, for bridges that
  93 support it, can be used to select an interrupt delivery method.
  94 .PP
  95 When the \fBi82365\fR module is loaded, it performs a scan of free
  96 ISA interrupts to determine which ones appear to be usable for PCMCIA
  97 events.  The interrupt scan results are reported in the system log.  A
  98 successful scan will report a list of interrupts as ``scanned''; if no
  99 interrupts appear to work, then a ``default'' list is reported.  Some
 100 bridges (Cirrus non-CardBus bridges, some Toshiba bridges) do not
 101 support the software interrupt test and will always report a
 102 ``default'' list.  In other cases, this may be a sign of an incorrect
 103 \fBirq_mode\fR.
 104
 105 .SH PARAMETERS
 106 .TP
 107 .BI pc_debug= n
 108 Selects the PCMCIA debugging level.  This parameter is only available
 109 if the module is compiled with debugging enabled.  A non-zero value
 110 enables debugging.
 111 .TP
 112 .BI i365_base= n
 113 Sets the base I/O port address of the i82365sl chip.  The default is
 114 0x3e0.  Applies only to ISA-to-PCMCIA bridges.
 115 .TP
 116 .BI ignore= n
 117 Causes the driver to ignore a single socket.  Sockets are numbered
 118 starting at 0.  The socket will be left in whatever state it was
 119 already in, so it can be used for cards with point enablers that do
 120 not cooperate with Card Services.
 121 .TP
 122 .BI extra_sockets= n
 123 A flag indicating if the driver should probe for as many as eight ISA
 124 sockets, or stop after checking for four sockets.  The default is
 125 0 (stop at four sockets).  Systems with two independent ISA-to-PCMCIA
 126 controllers (say, one internal and one in a docking station) may
 127 require this flag to be set, even though they have a total of only
 128 four sockets.  If this flag is set, then
 129 .BR poll_interval
 130 will automatically be enabled.
 131 .TP
 132 .BI do_scan= n
 133 This flag specifies that all free ISA interrupts should be tested to
 134 see if they can be triggered by the PCMCIA controller.  The default is
 135 1 (true).
 136 .TP
 137 .BI irq_list= i,j,...
 138 Specifies the set of interrupts that may be allocated by this driver,
 139 if they are otherwise available.
 140 The default list is 3, 4, 5, 7, 9, 10, 11, 12, 14, and 15.
 141 .TP
 142 .BI cs_irq= n
 143 Sets the interrupt line to use for monitoring card status changes.
 144 The default is 0, which means pick the highest-numbered legal
 145 interrupt not already in use.  Legal values are 15, 14, 12, 11,
 146 10, 9, 7, 5, 4, and 3.
 147 .TP
 148 .BI poll_interval= n
 149 Sets the card status polling delay, in 1/100 second increments.  If
 150 this parameter is set, card status interrupts will be disabled.  A
 151 reasonable value is 100.  Polling only affects detection of card
 152 insert and eject events.
 153 .TP
 154 .BI cycle_time= n
 155 Sets the length of a host bus cycle, in nanoseconds.  The default is
 156 210 ns, corresponding to a standard 4.77 MHz clock.
 157
 158 .SH Options for CardBus controllers
 159 .TP
 160 .BI do_pci_probe= n
 161 This flag indicates if the PCI bus should be probed for PCI-to-PCMCIA
 162 and/or PCI-to-CardBus bridges.  The default is 1 (true).
 163 .TP
 164 .BI cb_write_post= n
 165 A flag indicating if write posting (a performance feature) should be
 166 enabled.  The default is 1 (true), except on certain TI 1130 bridges.
 167 .TP
 168 .BI pci_csc= n
 169 Specifies that card status change interrupts should be routed to PCI
 170 interrupts, for CardBus controllers.  The default is 1 (true).
 171 .TP
 172 .BI pci_int= n
 173 Specifies that functional interrupts for IO cards should be routed to
 174 PCI interrupts, for CardBus controllers.  The default is 1 (true),
 175 except on systems that require use of PCI interrupts.
 176 .TP
 177 .BI pci_irq_list = i,j,...
 178 The Linux kernel sometimes cannot deduce the PCI interrupt assignments
 179 for CardBus sockets.  If this information can be determined some other
 180 way, it can be entered here.  The Nth socket will get the Nth
 181 interrupt number from the list.
 182
 183 .SH Options specific for Cirrus controllers
 184 When the
 185 .B i82365
 186 driver is loaded, it will try to determine what interrupts can safely
 187 be allocated for use by PCMCIA devices.  Cirrus controllers support
 188 some optional features that interfere with the use of certain
 189 interrupt lines.  Cirrus chips also lack the functionality needed to
 190 detect whether or not an interrupt can be used.  The
 191 .BR has_dma ,
 192 .BR has_ring ,
 193 and
 194 .B has_led
 195 options are used to specify if these features are implemented.
 196 .TP
 197 .BI has_dma= n
 198 A flag indicating if the controller has DMA support.
 199 .TP
 200 .BI has_led= n
 201 A flag indicating if the controller is wired for a disk status LED.
 202 This is set by default.
 203 .TP
 204 .BI has_ring= n
 205 A flag indicating if the controller's "ring indicate" signal is
 206 implemented.  This is set by default.
 207 .TP
 208 .BI freq_bypass= n
 209 A flag indicating that the controller should be set up in "frequency
 210 bypass" mode.  This disables the normal 7/4 clock multiplier, and
 211 slows down all PCMCIA bus access, for systems with fast system clocks.
 212 .TP
 213 .BI setup_time= n
 214 Sets the bus setup time, in internal clock cycles. The default is 1.
 215 .TP
 216 .BI cmd_time= n
 217 Sets the bus command time, in internal clock cycles. The default is 6.
 218 .TP
 219 .BI recov_time= n
 220 Sets the bus recovery time, in internal clock cycles. The default is 0.
 221 .TP
 222 .BI wakeup= n
 223 A flag indicating if the probe function should attempt to wake up a
 224 suspended controller chip.  The default is 0.
 225 .TP
 226 .BI fast_pci= n
 227 A flag for the PD6729 PCI controller, indicating that the PCI bus
 228 speed exceeds 25 MHz.
 229 .TP
 230 .BI irq_mode= n
 231 For the PD6729 PCI controller, specifies the interrupt delivery mode.
 232 The default is to use ISA bus interrupts; a value of 1 selects PCI
 233 interrupts.  This must be set for correct operation of some PCI card
 234 readers.
 235
 236 .SH Options specific for Ricoh CardBus controllers
 237 .TP
 238 .BI irq_mode= n
 239 Selects the interrupt routing method.  A value of 0 selects only PCI
 240 interrupts; 1 selects ISA interrupt routing, and 2 selects ISA
 241 interrupt routing via an external serial interrupt controller.  The
 242 default is to use whatever ISA routing method is already enabled.
 243 .TP
 244 .BI setup_time= n
 245 Sets the bus setup time, in internal clock cycles. The default is 3.
 246 .TP
 247 .BI cmd_time= n
 248 Sets the bus command time, in internal clock cycles. The default is 6.
 249 .TP
 250 .BI hold_time= n
 251 Sets the bus hold time, in internal clock cycles. The default is 1.
 252
 253 .SH Options specific for Vadem ISA controllers
 254 .TP
 255 .BI async_clock= n
 256 This flag specifies that PCMCIA bus cycles should be clocked
 257 asynchronously from host bus cycles.  It effectively adds a wait state
 258 to some operations.
 259 .TP
 260 .BI cable_mode= n
 261 For the VG469, this flag adjusts certain socket signals for driving a
 262 socket connected via a cable.
 263
 264 .SH Options specific for TI CardBus controllers
 265 Normally, a system's BIOS will configure these options appropriately,
 266 so all these options default to leaving these features configured the
 267 way the driver finds them.
 268 .TP
 269 .BI has_ring= n
 270 A flag indicating if the controller is wired for "ring indicate".
 271 The default is to read the current setting from the controller.
 272 .TP
 273 .BI irq_mode= n
 274 Selects the interrupt routing method.  A value of 0 selects only PCI
 275 interrupts; 1 selects ISA interrupt routing; 2 selects ISA interrupt
 276 routing via an external serial interrupt controller; and 3 selects
 277 serial routing for both PCI and ISA interrupts.  The default is to use
 278 whatever routing  method is already active, or ISA routing if no
 279 method is enabled.
 280 .TP
 281 .BI p2cclk= n
 282 A flag, indicating if the P2CCLK pin should be configured as an input
 283 (0) or an output (1).  This signal is used for communicating with a
 284 socket power controller; if set incorrectly, the bridge will be unable
 285 to power up cards.  The default is to use the BIOS setting.
 286
 287 .SH AUTHOR
 288 David Hinds \- dahinds@users.sourceforge.net
 289 .SH "SEE ALSO"
 290 cardmgr(8), pcmcia(5).