blob: 1553e9a649cd4c3559275ba8d216823da45d6a6f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#
2# USB Gadget support on a system involves
3# (a) a peripheral controller, and
4# (b) the gadget driver using it.
5#
6# NOTE: Gadget support ** DOES NOT ** depend on host-side CONFIG_USB !!
7#
8# - Host systems (like PCs) need CONFIG_USB (with "A" jacks).
9# - Peripherals (like PDAs) need CONFIG_USB_GADGET (with "B" jacks).
Matt LaPlantecab00892006-10-03 22:36:44 +020010# - Some systems have both kinds of controllers.
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#
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).
14#
15menu "USB Gadget Support"
16
17config USB_GADGET
18 tristate "Support for USB Gadgets"
19 help
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.
24
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
Jules Villarde113f292006-08-22 22:40:15 +020029 familiar host side controllers have names like "EHCI", "OHCI",
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 or "UHCI", and are usually integrated into southbridges on PC
31 motherboards.
32
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.)
38
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).
41
42 For more information, see <http://www.linux-usb.org/gadget> and
43 the kernel DocBook documentation for this API.
44
David Brownell70790f62007-07-01 17:35:28 -070045config USB_GADGET_DEBUG
46 boolean "Debugging messages"
47 depends on USB_GADGET && DEBUG_KERNEL && EXPERIMENTAL
48 help
49 Many controller and gadget drivers will print some debugging
50 messages if you use this option to ask for those messages.
51
52 Avoid enabling these messages, even if you're actively
53 debugging such a driver. Many drivers will emit so many
54 messages that the driver timings are affected, which will
55 either create new failure modes or remove the one you're
56 trying to track down. Never enable these messages for a
57 production build.
58
Linus Torvalds1da177e2005-04-16 15:20:36 -070059config USB_GADGET_DEBUG_FILES
60 boolean "Debugging information files"
61 depends on USB_GADGET && PROC_FS
62 help
63 Some of the drivers in the "gadget" framework can expose
64 debugging information in files such as /proc/driver/udc
65 (for a peripheral controller). The information in these
66 files may help when you're troubleshooting or bringing up a
67 driver on a new board. Enable these files by choosing "Y"
68 here. If in doubt, or to conserve kernel memory, say "N".
69
David Brownell028b2712005-05-06 07:02:01 -070070config USB_GADGET_SELECTED
71 boolean
72
Linus Torvalds1da177e2005-04-16 15:20:36 -070073#
74# USB Peripheral Controller Support
75#
76choice
77 prompt "USB Peripheral Controller"
78 depends on USB_GADGET
79 help
80 A USB device uses a controller to talk to its host.
81 Systems should have only one such upstream link.
82 Many controller drivers are platform-specific; these
83 often need board-specific hooks.
84
Thomas Dahlmann55d402d2007-07-16 21:40:54 -070085config USB_GADGET_AMD5536UDC
86 boolean "AMD5536 UDC"
87 depends on PCI
88 select USB_GADGET_DUALSPEED
89 help
90 The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
91 It is a USB Highspeed DMA capable USB device controller. Beside ep0
92 it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
93 The UDC port supports OTG operation, and may be used as a host port
94 if it's not being used to implement peripheral or OTG roles.
95
96 Say "y" to link the driver statically, or "m" to build a
97 dynamically linked module called "amd5536udc" and force all
98 gadget drivers to also be dynamically linked.
99
100config USB_AMD5536UDC
101 tristate
102 depends on USB_GADGET_AMD5536UDC
103 default USB_GADGET
104 select USB_GADGET_SELECTED
105
Li Yangb5048822007-04-23 10:54:25 -0700106config USB_GADGET_FSL_USB2
107 boolean "Freescale Highspeed USB DR Peripheral Controller"
108 depends on MPC834x || PPC_MPC831x
109 select USB_GADGET_DUALSPEED
110 help
111 Some of Freescale PowerPC processors have a High Speed
112 Dual-Role(DR) USB controller, which supports device mode.
113
114 The number of programmable endpoints is different through
115 SOC revisions.
116
117 Say "y" to link the driver statically, or "m" to build a
118 dynamically linked module called "fsl_usb2_udc" and force
119 all gadget drivers to also be dynamically linked.
120
121config USB_FSL_USB2
122 tristate
123 depends on USB_GADGET_FSL_USB2
124 default USB_GADGET
125 select USB_GADGET_SELECTED
126
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127config USB_GADGET_NET2280
Guennadi Liakhovetski950ee4c2006-03-19 20:49:14 +0100128 boolean "NetChip 228x"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 depends on PCI
130 select USB_GADGET_DUALSPEED
131 help
Guennadi Liakhovetski950ee4c2006-03-19 20:49:14 +0100132 NetChip 2280 / 2282 is a PCI based USB peripheral controller which
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 supports both full and high speed USB 2.0 data transfers.
134
135 It has six configurable endpoints, as well as endpoint zero
136 (for control transfers) and several endpoints with dedicated
137 functions.
138
139 Say "y" to link the driver statically, or "m" to build a
140 dynamically linked module called "net2280" and force all
141 gadget drivers to also be dynamically linked.
142
143config USB_NET2280
144 tristate
145 depends on USB_GADGET_NET2280
146 default USB_GADGET
David Brownell028b2712005-05-06 07:02:01 -0700147 select USB_GADGET_SELECTED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148
149config USB_GADGET_PXA2XX
150 boolean "PXA 25x or IXP 4xx"
151 depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX
152 help
153 Intel's PXA 25x series XScale ARM-5TE processors include
154 an integrated full speed USB 1.1 device controller. The
155 controller in the IXP 4xx series is register-compatible.
156
157 It has fifteen fixed-function endpoints, as well as endpoint
158 zero (for control transfers).
159
160 Say "y" to link the driver statically, or "m" to build a
161 dynamically linked module called "pxa2xx_udc" and force all
162 gadget drivers to also be dynamically linked.
163
164config USB_PXA2XX
165 tristate
166 depends on USB_GADGET_PXA2XX
167 default USB_GADGET
David Brownell028b2712005-05-06 07:02:01 -0700168 select USB_GADGET_SELECTED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169
170# if there's only one gadget driver, using only two bulk endpoints,
171# don't waste memory for the other endpoints
172config USB_PXA2XX_SMALL
173 depends on USB_GADGET_PXA2XX
174 bool
175 default n if USB_ETH_RNDIS
176 default y if USB_ZERO
177 default y if USB_ETH
178 default y if USB_G_SERIAL
179
180config USB_GADGET_GOKU
181 boolean "Toshiba TC86C001 'Goku-S'"
182 depends on PCI
183 help
184 The Toshiba TC86C001 is a PCI device which includes controllers
185 for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
186
187 The device controller has three configurable (bulk or interrupt)
188 endpoints, plus endpoint zero (for control transfers).
189
190 Say "y" to link the driver statically, or "m" to build a
191 dynamically linked module called "goku_udc" and to force all
192 gadget drivers to also be dynamically linked.
193
194config USB_GOKU
195 tristate
196 depends on USB_GADGET_GOKU
197 default USB_GADGET
David Brownell028b2712005-05-06 07:02:01 -0700198 select USB_GADGET_SELECTED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
200
201config USB_GADGET_LH7A40X
202 boolean "LH7A40X"
203 depends on ARCH_LH7A40X
204 help
205 This driver provides USB Device Controller driver for LH7A40x
206
207config USB_LH7A40X
208 tristate
209 depends on USB_GADGET_LH7A40X
210 default USB_GADGET
David Brownell028b2712005-05-06 07:02:01 -0700211 select USB_GADGET_SELECTED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
213
214config USB_GADGET_OMAP
215 boolean "OMAP USB Device Controller"
216 depends on ARCH_OMAP
217 select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3
218 help
219 Many Texas Instruments OMAP processors have flexible full
220 speed USB device controllers, with support for up to 30
221 endpoints (plus endpoint zero). This driver supports the
222 controller in the OMAP 1611, and should work with controllers
223 in other OMAP processors too, given minor tweaks.
224
225 Say "y" to link the driver statically, or "m" to build a
226 dynamically linked module called "omap_udc" and force all
227 gadget drivers to also be dynamically linked.
228
229config USB_OMAP
230 tristate
231 depends on USB_GADGET_OMAP
232 default USB_GADGET
David Brownell028b2712005-05-06 07:02:01 -0700233 select USB_GADGET_SELECTED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
235config USB_OTG
236 boolean "OTG Support"
237 depends on USB_GADGET_OMAP && ARCH_OMAP_OTG && USB_OHCI_HCD
238 help
239 The most notable feature of USB OTG is support for a
240 "Dual-Role" device, which can act as either a device
241 or a host. The initial role choice can be changed
242 later, when two dual-role devices talk to each other.
243
244 Select this only if your OMAP board has a Mini-AB connector.
245
Arnaud Patard3fc154b2007-06-06 21:05:49 -0700246config USB_GADGET_S3C2410
247 boolean "S3C2410 USB Device Controller"
248 depends on ARCH_S3C2410
249 help
250 Samsung's S3C2410 is an ARM-4 processor with an integrated
251 full speed USB 1.1 device controller. It has 4 configurable
252 endpoints, as well as endpoint zero (for control transfers).
253
254 This driver has been tested on the S3C2410, S3C2412, and
255 S3C2440 processors.
256
257config USB_S3C2410
258 tristate
259 depends on USB_GADGET_S3C2410
260 default USB_GADGET
261 select USB_GADGET_SELECTED
262
263config USB_S3C2410_DEBUG
264 boolean "S3C2410 udc debug messages"
265 depends on USB_GADGET_S3C2410
266
David Brownellbae4bd82006-01-22 10:32:37 -0800267config USB_GADGET_AT91
268 boolean "AT91 USB Device Port"
Andrew Victor877d7722007-05-11 20:49:56 +0100269 depends on ARCH_AT91 && !ARCH_AT91SAM9RL
David Brownellbae4bd82006-01-22 10:32:37 -0800270 select USB_GADGET_SELECTED
271 help
272 Many Atmel AT91 processors (such as the AT91RM2000) have a
273 full speed USB Device Port with support for five configurable
274 endpoints (plus endpoint zero).
275
276 Say "y" to link the driver statically, or "m" to build a
277 dynamically linked module called "at91_udc" and force all
278 gadget drivers to also be dynamically linked.
279
280config USB_AT91
281 tristate
282 depends on USB_GADGET_AT91
283 default USB_GADGET
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284
Yoshihiro Shimoda4cf25032007-05-10 13:18:23 +0900285config USB_GADGET_M66592
286 boolean "M66592 driver"
287 select USB_GADGET_DUALSPEED
288 help
289 M66592 is a USB 2.0 peripheral controller.
290
291 It has seven configurable endpoints, and endpoint zero.
292
293 Say "y" to link the driver statically, or "m" to build a
294 dynamically linked module called "m66592_udc" and force all
295 gadget drivers to also be dynamically linked.
296
297config USB_M66592
298 tristate
299 depends on USB_GADGET_M66592
300 default USB_GADGET
301 select USB_GADGET_SELECTED
302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303config USB_GADGET_DUMMY_HCD
304 boolean "Dummy HCD (DEVELOPMENT)"
Adrian Bunkbe0c8012006-07-31 01:43:53 +0200305 depends on (USB=y || (USB=m && USB_GADGET=m)) && EXPERIMENTAL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 select USB_GADGET_DUALSPEED
307 help
308 This host controller driver emulates USB, looping all data transfer
309 requests back to a USB "gadget driver" in the same host. The host
310 side is the master; the gadget side is the slave. Gadget drivers
311 can be high, full, or low speed; and they have access to endpoints
312 like those from NET2280, PXA2xx, or SA1100 hardware.
313
314 This may help in some stages of creating a driver to embed in a
315 Linux device, since it lets you debug several parts of the gadget
316 driver without its hardware or drivers being involved.
317
318 Since such a gadget side driver needs to interoperate with a host
319 side Linux-USB device driver, this may help to debug both sides
320 of a USB protocol stack.
321
322 Say "y" to link the driver statically, or "m" to build a
323 dynamically linked module called "dummy_hcd" and force all
324 gadget drivers to also be dynamically linked.
325
326config USB_DUMMY_HCD
327 tristate
328 depends on USB_GADGET_DUMMY_HCD
329 default USB_GADGET
David Brownell028b2712005-05-06 07:02:01 -0700330 select USB_GADGET_SELECTED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
332# NOTE: Please keep dummy_hcd LAST so that "real hardware" appears
333# first and will be selected by default.
334
335endchoice
336
337config USB_GADGET_DUALSPEED
338 bool
339 depends on USB_GADGET
340 default n
341 help
342 Means that gadget drivers should include extra descriptors
343 and code to handle dual-speed controllers.
344
345#
346# USB Gadget Drivers
347#
348choice
349 tristate "USB Gadget Drivers"
David Brownell028b2712005-05-06 07:02:01 -0700350 depends on USB_GADGET && USB_GADGET_SELECTED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 default USB_ETH
352 help
353 A Linux "Gadget Driver" talks to the USB Peripheral Controller
354 driver through the abstract "gadget" API. Some other operating
355 systems call these "client" drivers, of which "class drivers"
356 are a subset (implementing a USB device class specification).
357 A gadget driver implements one or more USB functions using
358 the peripheral hardware.
359
360 Gadget drivers are hardware-neutral, or "platform independent",
361 except that they sometimes must understand quirks or limitations
362 of the particular controllers they work with. For example, when
363 a controller doesn't support alternate configurations or provide
364 enough of the right types of endpoints, the gadget driver might
365 not be able work with that controller, or might need to implement
366 a less common variant of a device class protocol.
367
368# this first set of drivers all depend on bulk-capable hardware.
369
370config USB_ZERO
371 tristate "Gadget Zero (DEVELOPMENT)"
372 depends on EXPERIMENTAL
373 help
374 Gadget Zero is a two-configuration device. It either sinks and
375 sources bulk data; or it loops back a configurable number of
376 transfers. It also implements control requests, for "chapter 9"
377 conformance. The driver needs only two bulk-capable endpoints, so
378 it can work on top of most device-side usb controllers. It's
379 useful for testing, and is also a working example showing how
380 USB "gadget drivers" can be written.
381
382 Make this be the first driver you try using on top of any new
383 USB peripheral controller driver. Then you can use host-side
384 test software, like the "usbtest" driver, to put your hardware
385 and its driver through a basic set of functional tests.
386
387 Gadget Zero also works with the host-side "usb-skeleton" driver,
388 and with many kinds of host-side test software. You may need
389 to tweak product and vendor IDs before host software knows about
390 this device, and arrange to select an appropriate configuration.
391
392 Say "y" to link the driver statically, or "m" to build a
393 dynamically linked module called "g_zero".
394
395config USB_ZERO_HNPTEST
396 boolean "HNP Test Device"
397 depends on USB_ZERO && USB_OTG
398 help
399 You can configure this device to enumerate using the device
400 identifiers of the USB-OTG test device. That means that when
401 this gadget connects to another OTG device, with this one using
402 the "B-Peripheral" role, that device will use HNP to let this
403 one serve as the USB host instead (in the "B-Host" role).
404
405config USB_ETH
406 tristate "Ethernet Gadget (with CDC Ethernet support)"
407 depends on NET
408 help
409 This driver implements Ethernet style communication, in either
410 of two ways:
411
412 - The "Communication Device Class" (CDC) Ethernet Control Model.
413 That protocol is often avoided with pure Ethernet adapters, in
414 favor of simpler vendor-specific hardware, but is widely
415 supported by firmware for smart network devices.
416
417 - On hardware can't implement that protocol, a simple CDC subset
418 is used, placing fewer demands on USB.
419
420 RNDIS support is a third option, more demanding than that subset.
421
422 Within the USB device, this gadget driver exposes a network device
423 "usbX", where X depends on what other networking devices you have.
424 Treat it like a two-node Ethernet link: host, and gadget.
425
426 The Linux-USB host-side "usbnet" driver interoperates with this
427 driver, so that deep I/O queues can be supported. On 2.4 kernels,
428 use "CDCEther" instead, if you're using the CDC option. That CDC
429 mode should also interoperate with standard CDC Ethernet class
430 drivers on other host operating systems.
431
432 Say "y" to link the driver statically, or "m" to build a
433 dynamically linked module called "g_ether".
434
435config USB_ETH_RNDIS
436 bool "RNDIS support (EXPERIMENTAL)"
437 depends on USB_ETH && EXPERIMENTAL
438 default y
439 help
440 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
441 and Microsoft provides redistributable binary RNDIS drivers for
442 older versions of Windows.
443
444 If you say "y" here, the Ethernet gadget driver will try to provide
445 a second device configuration, supporting RNDIS to talk to such
446 Microsoft USB hosts.
447
448 To make MS-Windows work with this, use Documentation/usb/linux.inf
449 as the "driver info file". For versions of MS-Windows older than
450 XP, you'll need to download drivers from Microsoft's website; a URL
451 is given in comments found in that info file.
452
453config USB_GADGETFS
454 tristate "Gadget Filesystem (EXPERIMENTAL)"
455 depends on EXPERIMENTAL
456 help
457 This driver provides a filesystem based API that lets user mode
458 programs implement a single-configuration USB device, including
459 endpoint I/O and control requests that don't relate to enumeration.
460 All endpoints, transfer speeds, and transfer types supported by
461 the hardware are available, through read() and write() calls.
462
463 Say "y" to link the driver statically, or "m" to build a
464 dynamically linked module called "gadgetfs".
465
466config USB_FILE_STORAGE
467 tristate "File-backed Storage Gadget"
Randy Dunlap87840282007-03-21 13:57:51 -0700468 depends on BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 help
470 The File-backed Storage Gadget acts as a USB Mass Storage
471 disk drive. As its storage repository it can use a regular
472 file or a block device (in much the same way as the "loop"
473 device driver), specified as a module parameter.
474
475 Say "y" to link the driver statically, or "m" to build a
476 dynamically linked module called "g_file_storage".
477
478config USB_FILE_STORAGE_TEST
479 bool "File-backed Storage Gadget testing version"
480 depends on USB_FILE_STORAGE
481 default n
482 help
483 Say "y" to generate the larger testing version of the
484 File-backed Storage Gadget, useful for probing the
485 behavior of USB Mass Storage hosts. Not needed for
486 normal operation.
487
488config USB_G_SERIAL
489 tristate "Serial Gadget (with CDC ACM support)"
490 help
491 The Serial Gadget talks to the Linux-USB generic serial driver.
492 This driver supports a CDC-ACM module option, which can be used
493 to interoperate with MS-Windows hosts or with the Linux-USB
494 "cdc-acm" driver.
495
496 Say "y" to link the driver statically, or "m" to build a
497 dynamically linked module called "g_serial".
498
499 For more information, see Documentation/usb/gadget_serial.txt
500 which includes instructions and a "driver info file" needed to
501 make MS-Windows work with this driver.
502
Ben Williamsonf2ebf92c2006-08-01 11:28:16 +1000503config USB_MIDI_GADGET
504 tristate "MIDI Gadget (EXPERIMENTAL)"
505 depends on SND && EXPERIMENTAL
506 select SND_RAWMIDI
507 help
508 The MIDI Gadget acts as a USB Audio device, with one MIDI
509 input and one MIDI output. These MIDI jacks appear as
510 a sound "card" in the ALSA sound system. Other MIDI
511 connections can then be made on the gadget system, using
512 ALSA's aconnect utility etc.
513
514 Say "y" to link the driver statically, or "m" to build a
515 dynamically linked module called "g_midi".
516
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517
518# put drivers that need isochronous transfer support (for audio
519# or video class gadget drivers), or specific hardware, here.
520
521# - none yet
522
523endchoice
524
525endmenu