2 # USB Gadget support on a system involves
3 # (a) a peripheral controller, and
4 # (b) the gadget driver using it.
6 # NOTE: Gadget support ** DOES NOT ** depend on host-side CONFIG_USB !!
8 # - Host systems (like PCs) need CONFIG_USB (with "A" jacks).
9 # - Peripherals (like PDAs) need CONFIG_USB_GADGET (with "B" jacks).
10 # - Some systems have both kinds of of controller.
12 # With help from a special transceiver and a "Mini-AB" jack, systems with
13 # both kinds of controller can also support "USB On-the-Go" (CONFIG_USB_OTG).
15 menu "USB Gadget Support"
18 tristate "Support for USB Gadgets"
20 USB is a master/slave protocol, organized with one master
21 host (such as a PC) controlling up to 127 peripheral devices.
22 The USB hardware is asymmetric, which makes it easier to set up:
23 you can't connect a "to-the-host" connector to a peripheral.
25 Linux can run in the host, or in the peripheral. In both cases
26 you need a low level bus controller driver, and some software
27 talking to it. Peripheral controllers are often discrete silicon,
28 or are integrated with the CPU in a microcontroller. The more
29 familiar host side controllers have names like like "EHCI", "OHCI",
30 or "UHCI", and are usually integrated into southbridges on PC
33 Enable this configuration option if you want to run Linux inside
34 a USB peripheral device. Configure one hardware driver for your
35 peripheral/device side bus controller, and a "gadget driver" for
36 your peripheral protocol. (If you use modular gadget drivers,
37 you may configure more than one.)
39 If in doubt, say "N" and don't enable these drivers; most people
40 don't have this kind of hardware (except maybe inside Linux PDAs).
43 # USB Peripheral Controller Support
46 prompt "USB Peripheral Controller"
49 A USB device uses a controller to talk to its host.
50 Systems should have only one such upstream link.
52 config USB_GADGET_NET2280
53 boolean "NetChip 2280"
55 select USB_GADGET_DUALSPEED
57 NetChip 2280 is a PCI based USB peripheral controller which
58 supports both full and high speed USB 2.0 data transfers.
60 It has six configurable endpoints, as well as endpoint zero
61 (for control transfers) and several endpoints with dedicated
64 Say "y" to link the driver statically, or "m" to build a
65 dynamically linked module called "net2280" and force all
66 gadget drivers to also be dynamically linked.
70 depends on USB_GADGET_NET2280
73 config USB_GADGET_PXA2XX
74 boolean "PXA 2xx or IXP 4xx"
75 depends on ARCH_PXA || ARCH_IXP4XX
77 Intel's PXA 2xx series XScale ARM-5TE processors include
78 an integrated full speed USB 1.1 device controller. The
79 controller in the IXP 4xx series is register-compatible.
81 It has fifteen fixed-function endpoints, as well as endpoint
82 zero (for control transfers).
84 Say "y" to link the driver statically, or "m" to build a
85 dynamically linked module called "pxa2xx_udc" and force all
86 gadget drivers to also be dynamically linked.
90 depends on USB_GADGET_PXA2XX
93 # if there's only one gadget driver, using only two bulk endpoints,
94 # don't waste memory for the other endpoints
95 config USB_PXA2XX_SMALL
96 depends on USB_GADGET_PXA2XX
98 default n if USB_ETH_RNDIS
101 default y if USB_G_SERIAL
103 config USB_GADGET_GOKU
104 boolean "Toshiba TC86C001 'Goku-S'"
107 The Toshiba TC86C001 is a PCI device which includes controllers
108 for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
110 The device controller has three configurable (bulk or interrupt)
111 endpoints, plus endpoint zero (for control transfers).
113 Say "y" to link the driver statically, or "m" to build a
114 dynamically linked module called "goku_udc" and to force all
115 gadget drivers to also be dynamically linked.
119 depends on USB_GADGET_GOKU
122 # this could be built elsewhere (doesn't yet exist)
123 config USB_GADGET_SA1100
125 depends on ARCH_SA1100
127 Intel's SA-1100 is an ARM-4 processor with an integrated
128 full speed USB 1.1 device controller.
130 It has two fixed-function endpoints, as well as endpoint
131 zero (for control transfers).
135 depends on USB_GADGET_SA1100
138 config USB_GADGET_DUMMY_HCD
139 boolean "Dummy HCD (DEVELOPMENT)"
140 depends on USB && EXPERIMENTAL
141 select USB_GADGET_DUALSPEED
143 This host controller driver emulates USB, looping all data transfer
144 requests back to a USB "gadget driver" in the same host. The host
145 side is the master; the gadget side is the slave. Gadget drivers
146 can be high, full, or low speed; and they have access to endpoints
147 like those from NET2280, PXA2xx, or SA1100 hardware.
149 This may help in some stages of creating a driver to embed in a
150 Linux device, since it lets you debug several parts of the gadget
151 driver without its hardware or drivers being involved.
153 Since such a gadget side driver needs to interoperate with a host
154 side Linux-USB device driver, this may help to debug both sides
155 of a USB protocol stack.
157 Say "y" to link the driver statically, or "m" to build a
158 dynamically linked module called "dummy_hcd" and force all
159 gadget drivers to also be dynamically linked.
163 depends on USB_GADGET_DUMMY_HCD
168 config USB_GADGET_DUALSPEED
170 depends on USB_GADGET
173 Means that gadget drivers should include extra descriptors
174 and code to handle dual-speed controllers.
180 tristate "USB Gadget Drivers"
181 depends on USB_GADGET
184 # this first set of drivers all depend on bulk-capable hardware.
187 tristate "Gadget Zero (DEVELOPMENT)"
188 depends on EXPERIMENTAL
190 Gadget Zero is a two-configuration device. It either sinks and
191 sources bulk data; or it loops back a configurable number of
192 transfers. It also implements control requests, for "chapter 9"
193 conformance. The driver needs only two bulk-capable endpoints, so
194 it can work on top of most device-side usb controllers. It's
195 useful for testing, and is also a working example showing how
196 USB "gadget drivers" can be written.
198 Make this be the first driver you try using on top of any new
199 USB peripheral controller driver. Then you can use host-side
200 test software, like the "usbtest" driver, to put your hardware
201 and its driver through a basic set of functional tests.
203 Gadget Zero also works with the host-side "usb-skeleton" driver,
204 and with many kinds of host-side test software. You may need
205 to tweak product and vendor IDs before host software knows about
206 this device, and arrange to select an appropriate configuration.
208 Say "y" to link the driver statically, or "m" to build a
209 dynamically linked module called "g_zero".
211 config USB_ZERO_HNPTEST
212 boolean "HNP Test Device"
213 depends on USB_ZERO && USB_OTG
215 You can configure this device to enumerate using the device
216 identifiers of the USB-OTG test device. That means that when
217 this gadget connects to another OTG device, with this one using
218 the "B-Peripheral" role, that device will use HNP to let this
219 one serve as the USB host instead (in the "B-Host" role).
222 tristate "Ethernet Gadget"
225 This driver implements Ethernet style communication, in either
228 - The "Communication Device Class" (CDC) Ethernet Control Model.
229 That protocol is often avoided with pure Ethernet adapters, in
230 favor of simpler vendor-specific hardware, but is widely
231 supported by firmware for smart network devices.
233 - On hardware can't implement that protocol, a simple CDC subset
234 is used, placing fewer demands on USB.
236 RNDIS support is a third option, more demanding than that subset.
238 Within the USB device, this gadget driver exposes a network device
239 "usbX", where X depends on what other networking devices you have.
240 Treat it like a two-node Ethernet link: host, and gadget.
242 The Linux-USB host-side "usbnet" driver interoperates with this
243 driver, so that deep I/O queues can be supported. On 2.4 kernels,
244 use "CDCEther" instead, if you're using the CDC option. That CDC
245 mode should also interoperate with standard CDC Ethernet class
246 drivers on other host operating systems.
248 Say "y" to link the driver statically, or "m" to build a
249 dynamically linked module called "g_ether".
252 bool "RNDIS support (EXPERIMENTAL)"
253 depends on USB_ETH && EXPERIMENTAL
256 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
257 and Microsoft provides redistributable binary RNDIS drivers for
258 older versions of Windows.
260 If you say "y" here, the Ethernet gadget driver will try to provide
261 a second device configuration, supporting RNDIS to talk to such
265 tristate "Gadget Filesystem (EXPERIMENTAL)"
266 depends on EXPERIMENTAL
268 This driver provides a filesystem based API that lets user mode
269 programs implement a single-configuration USB device, including
270 endpoint I/O and control requests that don't relate to enumeration.
271 All endpoints, transfer speeds, and transfer types supported by
272 the hardware are available, through read() and write() calls.
274 Say "y" to link the driver statically, or "m" to build a
275 dynamically linked module called "gadgetfs".
277 config USB_FILE_STORAGE
278 tristate "File-backed Storage Gadget (DEVELOPMENT)"
279 # we don't support the SA1100 because of its limitations
280 depends on USB_GADGET_SA1100 = n
282 The File-backed Storage Gadget acts as a USB Mass Storage
283 disk drive. As its storage repository it can use a regular
284 file or a block device (in much the same way as the "loop"
285 device driver), specified as a module parameter.
287 Say "y" to link the driver statically, or "m" to build a
288 dynamically linked module called "g_file_storage".
290 config USB_FILE_STORAGE_TEST
291 bool "File-backed Storage Gadget test version"
292 depends on USB_FILE_STORAGE
295 Say "y" to generate the larger testing version of the
296 File-backed Storage Gadget, useful for probing the
297 behavior of USB Mass Storage hosts. Not needed for
301 tristate "Serial Gadget"
303 The Serial Gadget talks to the Linux-USB generic serial driver.
305 Say "y" to link the driver statically, or "m" to build a
306 dynamically linked module called "g_serial".
310 # put drivers that need isochronous transfer support (for audio
311 # or video class gadget drivers), or specific hardware, here.