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 controllers.
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).
17 tristate "USB Gadget Support"
19 USB is a master/slave protocol, organized with one master
20 host (such as a PC) controlling up to 127 peripheral devices.
21 The USB hardware is asymmetric, which makes it easier to set up:
22 you can't connect a "to-the-host" connector to a peripheral.
24 Linux can run in the host, or in the peripheral. In both cases
25 you need a low level bus controller driver, and some software
26 talking to it. Peripheral controllers are often discrete silicon,
27 or are integrated with the CPU in a microcontroller. The more
28 familiar host side controllers have names like "EHCI", "OHCI",
29 or "UHCI", and are usually integrated into southbridges on PC
32 Enable this configuration option if you want to run Linux inside
33 a USB peripheral device. Configure one hardware driver for your
34 peripheral/device side bus controller, and a "gadget driver" for
35 your peripheral protocol. (If you use modular gadget drivers,
36 you may configure more than one.)
38 If in doubt, say "N" and don't enable these drivers; most people
39 don't have this kind of hardware (except maybe inside Linux PDAs).
41 For more information, see <http://www.linux-usb.org/gadget> and
42 the kernel DocBook documentation for this API.
46 config USB_GADGET_DEBUG
47 boolean "Debugging messages"
48 depends on USB_GADGET && DEBUG_KERNEL && EXPERIMENTAL
50 Many controller and gadget drivers will print some debugging
51 messages if you use this option to ask for those messages.
53 Avoid enabling these messages, even if you're actively
54 debugging such a driver. Many drivers will emit so many
55 messages that the driver timings are affected, which will
56 either create new failure modes or remove the one you're
57 trying to track down. Never enable these messages for a
60 config USB_GADGET_DEBUG_FILES
61 boolean "Debugging information files"
62 depends on USB_GADGET && PROC_FS
64 Some of the drivers in the "gadget" framework can expose
65 debugging information in files such as /proc/driver/udc
66 (for a peripheral controller). The information in these
67 files may help when you're troubleshooting or bringing up a
68 driver on a new board. Enable these files by choosing "Y"
69 here. If in doubt, or to conserve kernel memory, say "N".
71 config USB_GADGET_DEBUG_FS
72 boolean "Debugging information files in debugfs"
73 depends on USB_GADGET && DEBUG_FS
75 Some of the drivers in the "gadget" framework can expose
76 debugging information in files under /sys/kernel/debug/.
77 The information in these files may help when you're
78 troubleshooting or bringing up a driver on a new board.
79 Enable these files by choosing "Y" here. If in doubt, or
80 to conserve kernel memory, say "N".
82 config USB_GADGET_SELECTED
86 # USB Peripheral Controller Support
89 prompt "USB Peripheral Controller"
92 A USB device uses a controller to talk to its host.
93 Systems should have only one such upstream link.
94 Many controller drivers are platform-specific; these
95 often need board-specific hooks.
97 config USB_GADGET_AMD5536UDC
100 select USB_GADGET_DUALSPEED
102 The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
103 It is a USB Highspeed DMA capable USB device controller. Beside ep0
104 it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
105 The UDC port supports OTG operation, and may be used as a host port
106 if it's not being used to implement peripheral or OTG roles.
108 Say "y" to link the driver statically, or "m" to build a
109 dynamically linked module called "amd5536udc" and force all
110 gadget drivers to also be dynamically linked.
112 config USB_AMD5536UDC
114 depends on USB_GADGET_AMD5536UDC
116 select USB_GADGET_SELECTED
118 config USB_GADGET_ATMEL_USBA
120 select USB_GADGET_DUALSPEED
123 USBA is the integrated high-speed USB Device controller on
124 the AT32AP700x processors from Atmel.
126 config USB_ATMEL_USBA
128 depends on USB_GADGET_ATMEL_USBA
130 select USB_GADGET_SELECTED
132 config USB_GADGET_FSL_USB2
133 boolean "Freescale Highspeed USB DR Peripheral Controller"
134 depends on MPC834x || PPC_MPC831x
135 select USB_GADGET_DUALSPEED
137 Some of Freescale PowerPC processors have a High Speed
138 Dual-Role(DR) USB controller, which supports device mode.
140 The number of programmable endpoints is different through
143 Say "y" to link the driver statically, or "m" to build a
144 dynamically linked module called "fsl_usb2_udc" and force
145 all gadget drivers to also be dynamically linked.
149 depends on USB_GADGET_FSL_USB2
151 select USB_GADGET_SELECTED
153 config USB_GADGET_NET2280
154 boolean "NetChip 228x"
156 select USB_GADGET_DUALSPEED
158 NetChip 2280 / 2282 is a PCI based USB peripheral controller which
159 supports both full and high speed USB 2.0 data transfers.
161 It has six configurable endpoints, as well as endpoint zero
162 (for control transfers) and several endpoints with dedicated
165 Say "y" to link the driver statically, or "m" to build a
166 dynamically linked module called "net2280" and force all
167 gadget drivers to also be dynamically linked.
171 depends on USB_GADGET_NET2280
173 select USB_GADGET_SELECTED
175 config USB_GADGET_PXA2XX
176 boolean "PXA 25x or IXP 4xx"
177 depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX
179 Intel's PXA 25x series XScale ARM-5TE processors include
180 an integrated full speed USB 1.1 device controller. The
181 controller in the IXP 4xx series is register-compatible.
183 It has fifteen fixed-function endpoints, as well as endpoint
184 zero (for control transfers).
186 Say "y" to link the driver statically, or "m" to build a
187 dynamically linked module called "pxa2xx_udc" and force all
188 gadget drivers to also be dynamically linked.
192 depends on USB_GADGET_PXA2XX
194 select USB_GADGET_SELECTED
196 # if there's only one gadget driver, using only two bulk endpoints,
197 # don't waste memory for the other endpoints
198 config USB_PXA2XX_SMALL
199 depends on USB_GADGET_PXA2XX
201 default n if USB_ETH_RNDIS
202 default y if USB_ZERO
204 default y if USB_G_SERIAL
206 config USB_GADGET_M66592
207 boolean "Renesas M66592 USB Peripheral Controller"
208 select USB_GADGET_DUALSPEED
210 M66592 is a discrete USB peripheral controller chip that
211 supports both full and high speed USB 2.0 data transfers.
212 It has seven configurable endpoints, and endpoint zero.
214 Say "y" to link the driver statically, or "m" to build a
215 dynamically linked module called "m66592_udc" and force all
216 gadget drivers to also be dynamically linked.
220 depends on USB_GADGET_M66592
222 select USB_GADGET_SELECTED
224 config SUPERH_BUILT_IN_M66592
225 boolean "Enable SuperH built-in USB like the M66592"
226 depends on USB_GADGET_M66592 && CPU_SUBTYPE_SH7722
228 SH7722 has USB like the M66592.
230 The transfer rate is very slow when use "Ethernet Gadget".
231 However, this problem is improved if change a value of
234 config USB_GADGET_GOKU
235 boolean "Toshiba TC86C001 'Goku-S'"
238 The Toshiba TC86C001 is a PCI device which includes controllers
239 for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
241 The device controller has three configurable (bulk or interrupt)
242 endpoints, plus endpoint zero (for control transfers).
244 Say "y" to link the driver statically, or "m" to build a
245 dynamically linked module called "goku_udc" and to force all
246 gadget drivers to also be dynamically linked.
250 depends on USB_GADGET_GOKU
252 select USB_GADGET_SELECTED
255 config USB_GADGET_LH7A40X
257 depends on ARCH_LH7A40X
259 This driver provides USB Device Controller driver for LH7A40x
263 depends on USB_GADGET_LH7A40X
265 select USB_GADGET_SELECTED
267 # built in ../musb along with host support
268 config USB_GADGET_MUSB_HDRC
269 boolean "Inventra HDRC USB Peripheral (TI, ...)"
270 depends on USB_MUSB_HDRC && (USB_MUSB_PERIPHERAL || USB_MUSB_OTG)
271 select USB_GADGET_DUALSPEED
272 select USB_GADGET_SELECTED
274 This OTG-capable silicon IP is used in dual designs including
275 the TI DaVinci, OMAP 243x, OMAP 343x, and TUSB 6010.
277 config USB_GADGET_OMAP
278 boolean "OMAP USB Device Controller"
280 select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3 || MACH_OMAP_H4_OTG
282 Many Texas Instruments OMAP processors have flexible full
283 speed USB device controllers, with support for up to 30
284 endpoints (plus endpoint zero). This driver supports the
285 controller in the OMAP 1611, and should work with controllers
286 in other OMAP processors too, given minor tweaks.
288 Say "y" to link the driver statically, or "m" to build a
289 dynamically linked module called "omap_udc" and force all
290 gadget drivers to also be dynamically linked.
294 depends on USB_GADGET_OMAP
296 select USB_GADGET_SELECTED
299 boolean "OTG Support"
300 depends on USB_GADGET_OMAP && ARCH_OMAP_OTG && USB_OHCI_HCD
302 The most notable feature of USB OTG is support for a
303 "Dual-Role" device, which can act as either a device
304 or a host. The initial role choice can be changed
305 later, when two dual-role devices talk to each other.
307 Select this only if your OMAP board has a Mini-AB connector.
309 config USB_GADGET_S3C2410
310 boolean "S3C2410 USB Device Controller"
311 depends on ARCH_S3C2410
313 Samsung's S3C2410 is an ARM-4 processor with an integrated
314 full speed USB 1.1 device controller. It has 4 configurable
315 endpoints, as well as endpoint zero (for control transfers).
317 This driver has been tested on the S3C2410, S3C2412, and
322 depends on USB_GADGET_S3C2410
324 select USB_GADGET_SELECTED
326 config USB_S3C2410_DEBUG
327 boolean "S3C2410 udc debug messages"
328 depends on USB_GADGET_S3C2410
330 config USB_GADGET_AT91
331 boolean "AT91 USB Device Port"
332 depends on ARCH_AT91 && !ARCH_AT91SAM9RL && !ARCH_AT91CAP9
333 select USB_GADGET_SELECTED
335 Many Atmel AT91 processors (such as the AT91RM2000) have a
336 full speed USB Device Port with support for five configurable
337 endpoints (plus endpoint zero).
339 Say "y" to link the driver statically, or "m" to build a
340 dynamically linked module called "at91_udc" and force all
341 gadget drivers to also be dynamically linked.
345 depends on USB_GADGET_AT91
348 config USB_GADGET_DUMMY_HCD
349 boolean "Dummy HCD (DEVELOPMENT)"
350 depends on (USB=y || (USB=m && USB_GADGET=m)) && EXPERIMENTAL
351 select USB_GADGET_DUALSPEED
353 This host controller driver emulates USB, looping all data transfer
354 requests back to a USB "gadget driver" in the same host. The host
355 side is the master; the gadget side is the slave. Gadget drivers
356 can be high, full, or low speed; and they have access to endpoints
357 like those from NET2280, PXA2xx, or SA1100 hardware.
359 This may help in some stages of creating a driver to embed in a
360 Linux device, since it lets you debug several parts of the gadget
361 driver without its hardware or drivers being involved.
363 Since such a gadget side driver needs to interoperate with a host
364 side Linux-USB device driver, this may help to debug both sides
365 of a USB protocol stack.
367 Say "y" to link the driver statically, or "m" to build a
368 dynamically linked module called "dummy_hcd" and force all
369 gadget drivers to also be dynamically linked.
373 depends on USB_GADGET_DUMMY_HCD
375 select USB_GADGET_SELECTED
377 # NOTE: Please keep dummy_hcd LAST so that "real hardware" appears
378 # first and will be selected by default.
382 config USB_GADGET_DUALSPEED
384 depends on USB_GADGET
387 Means that gadget drivers should include extra descriptors
388 and code to handle dual-speed controllers.
394 tristate "USB Gadget Drivers"
395 depends on USB_GADGET && USB_GADGET_SELECTED
398 A Linux "Gadget Driver" talks to the USB Peripheral Controller
399 driver through the abstract "gadget" API. Some other operating
400 systems call these "client" drivers, of which "class drivers"
401 are a subset (implementing a USB device class specification).
402 A gadget driver implements one or more USB functions using
403 the peripheral hardware.
405 Gadget drivers are hardware-neutral, or "platform independent",
406 except that they sometimes must understand quirks or limitations
407 of the particular controllers they work with. For example, when
408 a controller doesn't support alternate configurations or provide
409 enough of the right types of endpoints, the gadget driver might
410 not be able work with that controller, or might need to implement
411 a less common variant of a device class protocol.
413 # this first set of drivers all depend on bulk-capable hardware.
416 tristate "Gadget Zero (DEVELOPMENT)"
417 depends on EXPERIMENTAL
419 Gadget Zero is a two-configuration device. It either sinks and
420 sources bulk data; or it loops back a configurable number of
421 transfers. It also implements control requests, for "chapter 9"
422 conformance. The driver needs only two bulk-capable endpoints, so
423 it can work on top of most device-side usb controllers. It's
424 useful for testing, and is also a working example showing how
425 USB "gadget drivers" can be written.
427 Make this be the first driver you try using on top of any new
428 USB peripheral controller driver. Then you can use host-side
429 test software, like the "usbtest" driver, to put your hardware
430 and its driver through a basic set of functional tests.
432 Gadget Zero also works with the host-side "usb-skeleton" driver,
433 and with many kinds of host-side test software. You may need
434 to tweak product and vendor IDs before host software knows about
435 this device, and arrange to select an appropriate configuration.
437 Say "y" to link the driver statically, or "m" to build a
438 dynamically linked module called "g_zero".
440 config USB_ZERO_HNPTEST
441 boolean "HNP Test Device"
442 depends on USB_ZERO && USB_OTG
444 You can configure this device to enumerate using the device
445 identifiers of the USB-OTG test device. That means that when
446 this gadget connects to another OTG device, with this one using
447 the "B-Peripheral" role, that device will use HNP to let this
448 one serve as the USB host instead (in the "B-Host" role).
451 tristate "Ethernet Gadget (with CDC Ethernet support)"
454 This driver implements Ethernet style communication, in either
457 - The "Communication Device Class" (CDC) Ethernet Control Model.
458 That protocol is often avoided with pure Ethernet adapters, in
459 favor of simpler vendor-specific hardware, but is widely
460 supported by firmware for smart network devices.
462 - On hardware can't implement that protocol, a simple CDC subset
463 is used, placing fewer demands on USB.
465 RNDIS support is a third option, more demanding than that subset.
467 Within the USB device, this gadget driver exposes a network device
468 "usbX", where X depends on what other networking devices you have.
469 Treat it like a two-node Ethernet link: host, and gadget.
471 The Linux-USB host-side "usbnet" driver interoperates with this
472 driver, so that deep I/O queues can be supported. On 2.4 kernels,
473 use "CDCEther" instead, if you're using the CDC option. That CDC
474 mode should also interoperate with standard CDC Ethernet class
475 drivers on other host operating systems.
477 Say "y" to link the driver statically, or "m" to build a
478 dynamically linked module called "g_ether".
481 bool "RNDIS support (EXPERIMENTAL)"
482 depends on USB_ETH && EXPERIMENTAL
485 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
486 and Microsoft provides redistributable binary RNDIS drivers for
487 older versions of Windows.
489 If you say "y" here, the Ethernet gadget driver will try to provide
490 a second device configuration, supporting RNDIS to talk to such
493 To make MS-Windows work with this, use Documentation/usb/linux.inf
494 as the "driver info file". For versions of MS-Windows older than
495 XP, you'll need to download drivers from Microsoft's website; a URL
496 is given in comments found in that info file.
499 tristate "Gadget Filesystem (EXPERIMENTAL)"
500 depends on EXPERIMENTAL
502 This driver provides a filesystem based API that lets user mode
503 programs implement a single-configuration USB device, including
504 endpoint I/O and control requests that don't relate to enumeration.
505 All endpoints, transfer speeds, and transfer types supported by
506 the hardware are available, through read() and write() calls.
508 Say "y" to link the driver statically, or "m" to build a
509 dynamically linked module called "gadgetfs".
511 config USB_FILE_STORAGE
512 tristate "File-backed Storage Gadget"
515 The File-backed Storage Gadget acts as a USB Mass Storage
516 disk drive. As its storage repository it can use a regular
517 file or a block device (in much the same way as the "loop"
518 device driver), specified as a module parameter.
520 Say "y" to link the driver statically, or "m" to build a
521 dynamically linked module called "g_file_storage".
523 config USB_FILE_STORAGE_TEST
524 bool "File-backed Storage Gadget testing version"
525 depends on USB_FILE_STORAGE
528 Say "y" to generate the larger testing version of the
529 File-backed Storage Gadget, useful for probing the
530 behavior of USB Mass Storage hosts. Not needed for
534 tristate "Serial Gadget (with CDC ACM support)"
536 The Serial Gadget talks to the Linux-USB generic serial driver.
537 This driver supports a CDC-ACM module option, which can be used
538 to interoperate with MS-Windows hosts or with the Linux-USB
541 Say "y" to link the driver statically, or "m" to build a
542 dynamically linked module called "g_serial".
544 For more information, see Documentation/usb/gadget_serial.txt
545 which includes instructions and a "driver info file" needed to
546 make MS-Windows work with this driver.
548 config USB_MIDI_GADGET
549 tristate "MIDI Gadget (EXPERIMENTAL)"
550 depends on SND && EXPERIMENTAL
553 The MIDI Gadget acts as a USB Audio device, with one MIDI
554 input and one MIDI output. These MIDI jacks appear as
555 a sound "card" in the ALSA sound system. Other MIDI
556 connections can then be made on the gadget system, using
557 ALSA's aconnect utility etc.
559 Say "y" to link the driver statically, or "m" to build a
560 dynamically linked module called "g_midi".
563 tristate "Printer Gadget"
565 The Printer Gadget channels data between the USB host and a
566 userspace program driving the print engine. The user space
567 program reads and writes the device file /dev/g_printer to
568 receive or send printer data. It can use ioctl calls to
569 the device file to get or set printer status.
571 Say "y" to link the driver statically, or "m" to build a
572 dynamically linked module called "g_printer".
574 For more information, see Documentation/usb/gadget_printer.txt
575 which includes sample code for accessing the device file.
577 # put drivers that need isochronous transfer support (for audio
578 # or video class gadget drivers), or specific hardware, here.