No empty .Rs/.Re
[netbsd-mini2440.git] / share / man / man4 / cardbus.4
blob9c668a74c195806b2ad9e3e6bb0754514b4fe6b1
1 .\"     $NetBSD: cardbus.4,v 1.32 2009/07/19 06:28:08 kiyohara Exp $
2 .\"
3 .\" Copyright (c) 1999-2006 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 July 19, 2009
31 .Dt CARDBUS 4
32 .Os
33 .Sh NAME
34 .Nm cardbus ,
35 .Nm cardslot ,
36 .Nm cbb
37 .Nd CardBus driver
38 .Sh SYNOPSIS
39 .Cd "cbb*      at pci? dev? function ?"
40 .Cd "cardslot* at cbb?"
41 .Cd "cardbus*  at cardslot?"
42 .Cd "pcmcia*   at cardslot?"
43 .Cd "XX*       at cardbus? function ?"
44 .Sh DESCRIPTION
45 .Nx
46 provides machine-independent bus support and
47 drivers for CardBus devices.
48 .Pp
49 The
50 .Cm cbb
51 device represents the CardBus controller.
52 Each controller has a number
53 of slots, represented by the
54 .Cm cardslot
55 devices.
56 A slot can have either a CardBus card or a
57 .Tn PCMCIA
58 card, which are attached with the
59 .Cm cardbus
61 .Cm pcmcia
62 devices, respectively.
63 .Sh SUPPORTED DEVICES
64 .Nx
65 includes the following machine-independent CardBus
66 drivers, sorted by function and driver name:
67 .Ss Network interfaces
68 .Bl -tag -width speaker -offset indent -compact
69 .It ath
70 Atheros 5210/5211/5212 802.11
71 .It atw
72 ADMtek ADM8211 (802.11)
73 .It ex
74 3Com 3c575TX and 3c575BTX
75 .It fxp
76 Intel i8255x
77 .It ral
78 Ralink Technology RT25x0 (802.11)
79 .It rtk
80 Realtek 8129/8139
81 .It rtw
82 Realtek 8180L (802.11)
83 .It tlp
84 DECchip 21143
85 .El
86 .Ss Serial interfaces
87 .Bl -tag -width speaker -offset indent -compact
88 .It com
89 Modems and serial cards
90 .El
91 .Ss SCSI controllers
92 .Bl -tag -width speaker -offset indent -compact
93 .It adv
94 AdvanSys 1200[A,B], 9xx[U,UA]
95 .It ahc
96 Adaptec ADP-1480
97 .It njs
98 Workbit NinjaSCSI-32
99 .El
100 .Ss USB controllers
101 .Bl -tag -width speaker -offset indent -compact
102 .It ehci
103 Enhanced Host Controller (2.0)
104 .It ohci
105 Open Host Controller
106 .It uhci
107 Universal Host Controller
109 .Ss IEEE1394 controllers
110 .Bl -tag -width speaker -offset indent -compact
111 .It fwohci
112 OHCI controller
114 .Ss Disk and tape controllers
115 .Bl -tag -width speaker -offset indent -compact
116 .It siisata
117 Silicon Image SATA-II controllers.
119 .Sh DIAGNOSTICS
120 .Nm cbb
121 devices may not be properly handled by the system BIOS on i386-family
122 systems.
123 If, on an i386-family system, the
124 .Nm cbb
125 driver reports
126 .Dl cbb0: NOT USED because of unconfigured interrupt
127 then enabling
128 .Bl -item -offset indent -compact
130 .Cd options PCI_ADDR_FIXUP
132 .Cd options PCI_BUS_FIXUP
134 .Cd options PCI_INTR_FIXUP
136 or (if ACPI is in use)
137 .Bl -item -offset indent -compact
139 .Cd options PCI_INTR_FIXUP_DISABLED
141 in the kernel configuration might be of use.
142 .Sh SEE ALSO
143 .Xr adv 4 ,
144 .Xr ahc 4 ,
145 .Xr ath 4 ,
146 .Xr atw 4 ,
147 .Xr com 4 ,
148 .Xr ehci 4 ,
149 .Xr ex 4 ,
150 .Xr fxp 4 ,
151 .Xr njs 4 ,
152 .Xr ohci 4 ,
153 .Xr options 4 ,
154 .Xr pci 4 ,
155 .Xr pcmcia 4 ,
156 .Xr ral 4 ,
157 .Xr rtk 4 ,
158 .Xr rtw 4 ,
159 .Xr siisata 4 ,
160 .Xr tlp 4 ,
161 .Xr uhci 4
162 .Sh HISTORY
165 driver appeared in
166 .Nx 1.5 .
167 .Sh BUGS
168 .Ss Memory space conflicts
170 maps memory on Cardbus and PCMCIA cards in order to access the cards
171 (including reading CIS tuples on PCMCIA cards)
172 and access the devices using the
173 .Tn RBUS
174 abstraction.
175 When the mapping does not work, PCMCIA cards are typically ignored on
176 insert, and Cardbus cards are recognized but nonfunctional.
177 On i386, the kernel has a heuristic to choose a memory address for
178 mapping, defaulting to 1 GB, but choosing 0.5 GB on machines with less
179 than 192 MB RAM and 2 GB on machines with more than 1 GB of RAM.
180 The intent is to use an address that is larger than available RAM, but
181 low enough to work; some systems seem to have trouble with
182 addresses requiring more than 20 address lines.
183 On i386, the following kernel configuration line disables the
184 heuristics and forces Cardbus
185 memory space to be mapped at 512M; this value makes Cardbus support
186 (including PCMCIA attachment under a cbb) work on some notebook
187 models, including the IBM Thinkpad 600E (2645-4AU) and the Compaq
188 ARMADA M700:
190 .Cd options RBUS_MIN_START="0x20000000"