Sync usage with man page.
[netbsd-mini2440.git] / share / man / man4 / pcmcia.4
blobcd1e2deffec48a63a8024510c6a4369d5efe6f77
1 .\" $NetBSD: pcmcia.4,v 1.35 2009/01/03 17:44:20 christos Exp $
2 .\"
3 .\" Copyright (c) 1999, 2002 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
5 .\"
6 .\" This code is derived from software contributed to The NetBSD Foundation
7 .\" by Lennart Augustsson.
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
11 .\" are met:
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\"    notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in the
16 .\"    documentation and/or other materials provided with the distribution.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 .\" POSSIBILITY OF SUCH DAMAGE.
29 .\"
30 .Dd January 3, 2009
31 .Dt PCMCIA 4
32 .Os
33 .Sh NAME
34 .Nm pcmcia
35 .Nd
36 introduction to
37 .Tn PCMCIA
38 .Pq Tn "PC Card"
39 support
40 .Sh SYNOPSIS
41 .Cd "pcmcia* at pcic? controller ? socket ?"
42 .Cd "pcmcia* at tcic? controller ? socket ?"
43 .Cd "pcmcia* at cardslot?"
44 .Pp
45 .Cd options PCMCIAVERBOSE
46 .Ss amiga
47 .Cd "pcmcia* at pccard0"
48 .Ss hpcmips
49 .Cd "pcmcia* at it8368e? controller ? socket ?"
50 .Cd "pcmcia* at plumpcmcia? controller ? socket ?"
51 .Ss hpcsh
52 .Cd "pcmcia* at hd64461pcmcia? controller ? socket ?"
53 .Ss sh3
54 .Cd "pcmcia* at shpcic? controller ? socket ?"
55 .Ss sparc
56 .Cd "pcmcia* at nell?"
57 .Sh DESCRIPTION
58 .Nx
59 provides machine-independent bus support and drivers for
60 .Tn PCMCIA
61 .Pq Personal Computer Memory Card International Association
62 a.k.a.
63 .Tn "PC Card" ,
64 .Tn CardBus
65 devices.
66 .Sh HARDWARE
67 .Nx
68 includes the following machine-independent
69 .Tn PCMCIA
70 drivers, sorted by function and driver name:
71 .Ss Serial interfaces and modems
72 .Bl -tag -width speaker -offset indent
73 .It com
74 8250/16450/16550-compatible PCMCIA serial cards and modems.
75 .El
76 .Ss Network interfaces
77 .Bl -tag -width speaker -offset indent
78 .It an
79 Aironet 4500/4800 and Cisco 340 series 802.11 controller.
80 .It awi
81 802.11 controller based on the AMD PCnetMobile chipset.
82 .It cnw
83 Netwave AirSurfer Wireless LAN interface.
84 .It ep
85 3Com 3c589 EtherLink III Ethernet card.
86 .It mbe
87 Ethernet card based on the Fujitsu MB86960A/MB86965A chipset.
88 .It mhzc
89 Megahertz Ethernet/Modem combo cards
90 .It ne
91 NE2000 compatible cards.
92 .It ray
93 Raytheon Raylink and WebGear Aviator2.4 802.11 controller.
94 .It sm
95 Megahertz Ethernet card.
96 .It wi
97 Lucent WaveLAN/IEEE and PRISM-II based 802.11 controller.
98 .It xi
99 Xircom CreditCard Ethernet
101 .Ss SCSI controllers
102 .Bl -tag -width speaker -offset indent
103 .It aic
104 Adaptec APA-1460
105 .Tn SCSI
106 controller card.
107 .It esp
108 NCR 53C9x, Emulex ESP406, and Qlogic FAS408
109 .Tn SCSI
110 controllers.
111 .It spc
112 Fujitsu MB87030/MB89352
113 .Tn SCSI
114 controllers.
116 .Ss IDE controllers
117 .Bl -tag -width speaker -offset indent
118 .It wdc
119 Digital Hinote Ultra Mobile Media Adapter
121 .Ss Bluetooth devices
122 .Bl -tag -width speaker -offset indent
123 .It bt3c
124 3Com 3CRWB6096 Bluetooth PC Card driver.
125 .It btbc
126 AnyCom Bluetooth BlueCard driver.
128 .Ss USB Controller
129 .Bl -tag -width speaker -offset indent
130 .It slhci
131 Cypress/ScanLogic SL811HS USB Host Controller driver.
133 .Sh SEE ALSO
134 .Xr aic 4 ,
135 .Xr an 4 ,
136 .Xr awi 4 ,
137 .Xr bt3c 4 ,
138 .Xr btbc 4 ,
139 .Xr cardbus 4 ,
140 .Xr cnw 4 ,
141 .Xr com 4 ,
142 .Xr ep 4 ,
143 .Xr esp 4 ,
144 .Xr intro 4 ,
145 .Xr isa 4 ,
146 .Xr mbe 4 ,
147 .Xr mhzc 4 ,
148 .Xr ne 4 ,
149 .Xr options 4 ,
150 .Xr pcic 4 ,
151 .Xr pcmcom 4 ,
152 .Xr ray 4 ,
153 .Xr slhci 4 ,
154 .Xr sm 4 ,
155 .Xr spc 4 ,
156 .Xr tcic 4 ,
157 .Xr wi 4 ,
158 .Xr xi 4
160 .Pa http://www.pcmcia.org/
161 .Sh HISTORY
164 driver appeared in
165 .Nx 1.3 .
166 .Sh BUGS
167 .Ss IO space conflicts
169 probes the
170 .Tn PCMCIA
171 IO bus width and uses that information to decide
172 where to map
173 .Tn PCMCIA
174 IO space.
175 For 10-bit wide cards, 0x300-0x3ff is used.
176 For 12-bit wide cards, 0x400-0x4ff is used.
178 Neither choice is perfect.
179 In the 12-bit case, 0x400 appears to work
180 in substantially more devices than 0x300.
181 In the event that
182 .Tn PCMCIA
183 devices are mapped in 0x400-0x4ff and appear to be nonfunctional,
184 remapping to 0x300-0x3ff may be appropriate; consult
185 .Cd options PCIC_ISA_ALLOC_IOBASE
187 .Cd options PCIC_ISA_ALLOC_IOSIZE
189 .Xr options 4 .
190 Example:
191 .Bd -literal -offset indent
192 # Avoid PCMCIA bus space conflicts with the default IO space
193 # allocation on 12-bit wide busses (base 0x300 size 0xff).
194 options PCIC_ISA_ALLOC_IOBASE=0x300
195 options PCIC_ISA_ALLOC_IOSIZE=0x0ff
197 .Ss Interrupt conflicts
199 attempts to probe for available interrupts to assign to
200 .Tn PCMCIA
201 devices.
202 In some cases, it is not possible to detect
203 all interrupts in use; in such cases, use of
204 .Cd options PCIC_ISA_INTR_ALLOC_MASK
205 may be necessary.
207 .Xr options 4 .
208 .Ss Unconfigured devices
209 During autoconfiguration, if a message is displayed saying that your card
210 is "not configured" it indicates that there isn't support for your card
211 compiled into the kernel.
212 To fix this problem, it may simply be a matter
213 of adding the manufacturer and product IDs to the
214 .Tn PCMCIA
215 database or adding a front-end attachment to an existing driver.
216 In the latter case, it is normally always necessary to get a dump
217 of the CIS table from the card.
218 You can do this by adding
219 .Cd options PCMCIACISDEBUG
221 .Cd options PCMCIADEBUG
222 into your kernel config file.
223 Additionally, you will have to patch the kernel to enable run-time
224 debugging.
225 This can be done in the source by changing the variables
226 .Va pcmcia_debug
228 .Va pcmciacis_debug
229 to 0xff.
230 Alternatively, you can patch the same variables at run-time using
231 .Xr ddb 4 .
232 For most drivers you should also consider enabling any driver-specific
233 debugging options.