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 (DEVELOPMENT)"
48 depends on USB_GADGET && DEBUG_KERNEL
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 (DEVELOPMENT)"
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 (DEVELOPMENT)"
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
88 # The order here is alphabetical, except that integrated controllers go
89 # before discrete ones so they will be the initial/default value:
90 # - integrated/SOC controllers first
91 # - licensed IP used in both SOC and discrete versions
92 # - discrete ones (including all PCI-only controllers)
93 # - debug/dummy gadget+hcd is last.
96 prompt "USB Peripheral Controller"
99 A USB device uses a controller to talk to its host.
100 Systems should have only one such upstream link.
101 Many controller drivers are platform-specific; these
102 often need board-specific hooks.
105 # Integrated controllers
108 config USB_GADGET_AT91
109 boolean "Atmel AT91 USB Device Port"
110 depends on ARCH_AT91 && !ARCH_AT91SAM9RL && !ARCH_AT91CAP9
111 select USB_GADGET_SELECTED
113 Many Atmel AT91 processors (such as the AT91RM2000) have a
114 full speed USB Device Port with support for five configurable
115 endpoints (plus endpoint zero).
117 Say "y" to link the driver statically, or "m" to build a
118 dynamically linked module called "at91_udc" and force all
119 gadget drivers to also be dynamically linked.
123 depends on USB_GADGET_AT91
126 config USB_GADGET_ATMEL_USBA
128 select USB_GADGET_DUALSPEED
129 depends on AVR32 || ARCH_AT91CAP9 || ARCH_AT91SAM9RL
131 USBA is the integrated high-speed USB Device controller on
132 the AT32AP700x, some AT91SAM9 and AT91CAP9 processors from Atmel.
134 config USB_ATMEL_USBA
136 depends on USB_GADGET_ATMEL_USBA
138 select USB_GADGET_SELECTED
140 config USB_GADGET_FSL_USB2
141 boolean "Freescale Highspeed USB DR Peripheral Controller"
143 select USB_GADGET_DUALSPEED
145 Some of Freescale PowerPC processors have a High Speed
146 Dual-Role(DR) USB controller, which supports device mode.
148 The number of programmable endpoints is different through
151 Say "y" to link the driver statically, or "m" to build a
152 dynamically linked module called "fsl_usb2_udc" and force
153 all gadget drivers to also be dynamically linked.
157 depends on USB_GADGET_FSL_USB2
159 select USB_GADGET_SELECTED
161 config USB_GADGET_LH7A40X
163 depends on ARCH_LH7A40X
165 This driver provides USB Device Controller driver for LH7A40x
169 depends on USB_GADGET_LH7A40X
171 select USB_GADGET_SELECTED
173 config USB_GADGET_OMAP
174 boolean "OMAP USB Device Controller"
176 select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3
178 Many Texas Instruments OMAP processors have flexible full
179 speed USB device controllers, with support for up to 30
180 endpoints (plus endpoint zero). This driver supports the
181 controller in the OMAP 1611, and should work with controllers
182 in other OMAP processors too, given minor tweaks.
184 Say "y" to link the driver statically, or "m" to build a
185 dynamically linked module called "omap_udc" and force all
186 gadget drivers to also be dynamically linked.
190 depends on USB_GADGET_OMAP
192 select USB_GADGET_SELECTED
195 boolean "OTG Support"
196 depends on USB_GADGET_OMAP && ARCH_OMAP_OTG && USB_OHCI_HCD
198 The most notable feature of USB OTG is support for a
199 "Dual-Role" device, which can act as either a device
200 or a host. The initial role choice can be changed
201 later, when two dual-role devices talk to each other.
203 Select this only if your OMAP board has a Mini-AB connector.
205 config USB_GADGET_PXA25X
206 boolean "PXA 25x or IXP 4xx"
207 depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX
209 Intel's PXA 25x series XScale ARM-5TE processors include
210 an integrated full speed USB 1.1 device controller. The
211 controller in the IXP 4xx series is register-compatible.
213 It has fifteen fixed-function endpoints, as well as endpoint
214 zero (for control transfers).
216 Say "y" to link the driver statically, or "m" to build a
217 dynamically linked module called "pxa25x_udc" and force all
218 gadget drivers to also be dynamically linked.
222 depends on USB_GADGET_PXA25X
224 select USB_GADGET_SELECTED
226 # if there's only one gadget driver, using only two bulk endpoints,
227 # don't waste memory for the other endpoints
228 config USB_PXA25X_SMALL
229 depends on USB_GADGET_PXA25X
231 default n if USB_ETH_RNDIS
232 default y if USB_ZERO
234 default y if USB_G_SERIAL
236 config USB_GADGET_PXA27X
238 depends on ARCH_PXA && PXA27x
240 Intel's PXA 27x series XScale ARM v5TE processors include
241 an integrated full speed USB 1.1 device controller.
243 It has up to 23 endpoints, as well as endpoint zero (for
246 Say "y" to link the driver statically, or "m" to build a
247 dynamically linked module called "pxa27x_udc" and force all
248 gadget drivers to also be dynamically linked.
252 depends on USB_GADGET_PXA27X
254 select USB_GADGET_SELECTED
256 config USB_GADGET_S3C2410
257 boolean "S3C2410 USB Device Controller"
258 depends on ARCH_S3C2410
260 Samsung's S3C2410 is an ARM-4 processor with an integrated
261 full speed USB 1.1 device controller. It has 4 configurable
262 endpoints, as well as endpoint zero (for control transfers).
264 This driver has been tested on the S3C2410, S3C2412, and
269 depends on USB_GADGET_S3C2410
271 select USB_GADGET_SELECTED
273 config USB_S3C2410_DEBUG
274 boolean "S3C2410 udc debug messages"
275 depends on USB_GADGET_S3C2410
278 # Controllers available in both integrated and discrete versions
281 # musb builds in ../musb along with host support
282 config USB_GADGET_MUSB_HDRC
283 boolean "Inventra HDRC USB Peripheral (TI, ...)"
284 depends on USB_MUSB_HDRC && (USB_MUSB_PERIPHERAL || USB_MUSB_OTG)
285 select USB_GADGET_DUALSPEED
286 select USB_GADGET_SELECTED
288 This OTG-capable silicon IP is used in dual designs including
289 the TI DaVinci, OMAP 243x, OMAP 343x, and TUSB 6010.
291 config USB_GADGET_M66592
292 boolean "Renesas M66592 USB Peripheral Controller"
293 select USB_GADGET_DUALSPEED
295 M66592 is a discrete USB peripheral controller chip that
296 supports both full and high speed USB 2.0 data transfers.
297 It has seven configurable endpoints, and endpoint zero.
299 Say "y" to link the driver statically, or "m" to build a
300 dynamically linked module called "m66592_udc" and force all
301 gadget drivers to also be dynamically linked.
305 depends on USB_GADGET_M66592
307 select USB_GADGET_SELECTED
309 config SUPERH_BUILT_IN_M66592
310 boolean "Enable SuperH built-in USB like the M66592"
311 depends on USB_GADGET_M66592 && CPU_SUBTYPE_SH7722
313 SH7722 has USB like the M66592.
315 The transfer rate is very slow when use "Ethernet Gadget".
316 However, this problem is improved if change a value of
320 # Controllers available only in discrete form (and all PCI controllers)
323 config USB_GADGET_AMD5536UDC
324 boolean "AMD5536 UDC"
326 select USB_GADGET_DUALSPEED
328 The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
329 It is a USB Highspeed DMA capable USB device controller. Beside ep0
330 it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
331 The UDC port supports OTG operation, and may be used as a host port
332 if it's not being used to implement peripheral or OTG roles.
334 Say "y" to link the driver statically, or "m" to build a
335 dynamically linked module called "amd5536udc" and force all
336 gadget drivers to also be dynamically linked.
338 config USB_AMD5536UDC
340 depends on USB_GADGET_AMD5536UDC
342 select USB_GADGET_SELECTED
344 config USB_GADGET_FSL_QE
345 boolean "Freescale QE/CPM USB Device Controller"
346 depends on FSL_SOC && (QUICC_ENGINE || CPM)
348 Some of Freescale PowerPC processors have a Full Speed
349 QE/CPM2 USB controller, which support device mode with 4
350 programmable endpoints. This driver supports the
351 controller in the MPC8360 and MPC8272, and should work with
352 controllers having QE or CPM2, given minor tweaks.
354 Set CONFIG_USB_GADGET to "m" to build this driver as a
355 dynmically linked module called "fsl_qe_udc".
359 depends on USB_GADGET_FSL_QE
361 select USB_GADGET_SELECTED
363 config USB_GADGET_NET2280
364 boolean "NetChip 228x"
366 select USB_GADGET_DUALSPEED
368 NetChip 2280 / 2282 is a PCI based USB peripheral controller which
369 supports both full and high speed USB 2.0 data transfers.
371 It has six configurable endpoints, as well as endpoint zero
372 (for control transfers) and several endpoints with dedicated
375 Say "y" to link the driver statically, or "m" to build a
376 dynamically linked module called "net2280" and force all
377 gadget drivers to also be dynamically linked.
381 depends on USB_GADGET_NET2280
383 select USB_GADGET_SELECTED
385 config USB_GADGET_GOKU
386 boolean "Toshiba TC86C001 'Goku-S'"
389 The Toshiba TC86C001 is a PCI device which includes controllers
390 for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
392 The device controller has three configurable (bulk or interrupt)
393 endpoints, plus endpoint zero (for control transfers).
395 Say "y" to link the driver statically, or "m" to build a
396 dynamically linked module called "goku_udc" and to force all
397 gadget drivers to also be dynamically linked.
401 depends on USB_GADGET_GOKU
403 select USB_GADGET_SELECTED
407 # LAST -- dummy/emulated controller
410 config USB_GADGET_DUMMY_HCD
411 boolean "Dummy HCD (DEVELOPMENT)"
412 depends on USB=y || (USB=m && USB_GADGET=m)
413 select USB_GADGET_DUALSPEED
415 This host controller driver emulates USB, looping all data transfer
416 requests back to a USB "gadget driver" in the same host. The host
417 side is the master; the gadget side is the slave. Gadget drivers
418 can be high, full, or low speed; and they have access to endpoints
419 like those from NET2280, PXA2xx, or SA1100 hardware.
421 This may help in some stages of creating a driver to embed in a
422 Linux device, since it lets you debug several parts of the gadget
423 driver without its hardware or drivers being involved.
425 Since such a gadget side driver needs to interoperate with a host
426 side Linux-USB device driver, this may help to debug both sides
427 of a USB protocol stack.
429 Say "y" to link the driver statically, or "m" to build a
430 dynamically linked module called "dummy_hcd" and force all
431 gadget drivers to also be dynamically linked.
435 depends on USB_GADGET_DUMMY_HCD
437 select USB_GADGET_SELECTED
439 # NOTE: Please keep dummy_hcd LAST so that "real hardware" appears
440 # first and will be selected by default.
444 config USB_GADGET_DUALSPEED
446 depends on USB_GADGET
449 Means that gadget drivers should include extra descriptors
450 and code to handle dual-speed controllers.
456 tristate "USB Gadget Drivers"
457 depends on USB_GADGET && USB_GADGET_SELECTED
460 A Linux "Gadget Driver" talks to the USB Peripheral Controller
461 driver through the abstract "gadget" API. Some other operating
462 systems call these "client" drivers, of which "class drivers"
463 are a subset (implementing a USB device class specification).
464 A gadget driver implements one or more USB functions using
465 the peripheral hardware.
467 Gadget drivers are hardware-neutral, or "platform independent",
468 except that they sometimes must understand quirks or limitations
469 of the particular controllers they work with. For example, when
470 a controller doesn't support alternate configurations or provide
471 enough of the right types of endpoints, the gadget driver might
472 not be able work with that controller, or might need to implement
473 a less common variant of a device class protocol.
475 # this first set of drivers all depend on bulk-capable hardware.
478 tristate "Gadget Zero (DEVELOPMENT)"
480 Gadget Zero is a two-configuration device. It either sinks and
481 sources bulk data; or it loops back a configurable number of
482 transfers. It also implements control requests, for "chapter 9"
483 conformance. The driver needs only two bulk-capable endpoints, so
484 it can work on top of most device-side usb controllers. It's
485 useful for testing, and is also a working example showing how
486 USB "gadget drivers" can be written.
488 Make this be the first driver you try using on top of any new
489 USB peripheral controller driver. Then you can use host-side
490 test software, like the "usbtest" driver, to put your hardware
491 and its driver through a basic set of functional tests.
493 Gadget Zero also works with the host-side "usb-skeleton" driver,
494 and with many kinds of host-side test software. You may need
495 to tweak product and vendor IDs before host software knows about
496 this device, and arrange to select an appropriate configuration.
498 Say "y" to link the driver statically, or "m" to build a
499 dynamically linked module called "g_zero".
501 config USB_ZERO_HNPTEST
502 boolean "HNP Test Device"
503 depends on USB_ZERO && USB_OTG
505 You can configure this device to enumerate using the device
506 identifiers of the USB-OTG test device. That means that when
507 this gadget connects to another OTG device, with this one using
508 the "B-Peripheral" role, that device will use HNP to let this
509 one serve as the USB host instead (in the "B-Host" role).
512 tristate "Ethernet Gadget (with CDC Ethernet support)"
515 This driver implements Ethernet style communication, in either
518 - The "Communication Device Class" (CDC) Ethernet Control Model.
519 That protocol is often avoided with pure Ethernet adapters, in
520 favor of simpler vendor-specific hardware, but is widely
521 supported by firmware for smart network devices.
523 - On hardware can't implement that protocol, a simple CDC subset
524 is used, placing fewer demands on USB.
526 RNDIS support is a third option, more demanding than that subset.
528 Within the USB device, this gadget driver exposes a network device
529 "usbX", where X depends on what other networking devices you have.
530 Treat it like a two-node Ethernet link: host, and gadget.
532 The Linux-USB host-side "usbnet" driver interoperates with this
533 driver, so that deep I/O queues can be supported. On 2.4 kernels,
534 use "CDCEther" instead, if you're using the CDC option. That CDC
535 mode should also interoperate with standard CDC Ethernet class
536 drivers on other host operating systems.
538 Say "y" to link the driver statically, or "m" to build a
539 dynamically linked module called "g_ether".
546 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
547 and Microsoft provides redistributable binary RNDIS drivers for
548 older versions of Windows.
550 If you say "y" here, the Ethernet gadget driver will try to provide
551 a second device configuration, supporting RNDIS to talk to such
554 To make MS-Windows work with this, use Documentation/usb/linux.inf
555 as the "driver info file". For versions of MS-Windows older than
556 XP, you'll need to download drivers from Microsoft's website; a URL
557 is given in comments found in that info file.
560 tristate "Gadget Filesystem (EXPERIMENTAL)"
561 depends on EXPERIMENTAL
563 This driver provides a filesystem based API that lets user mode
564 programs implement a single-configuration USB device, including
565 endpoint I/O and control requests that don't relate to enumeration.
566 All endpoints, transfer speeds, and transfer types supported by
567 the hardware are available, through read() and write() calls.
569 Currently, this option is still labelled as EXPERIMENTAL because
570 of existing race conditions in the underlying in-kernel AIO core.
572 Say "y" to link the driver statically, or "m" to build a
573 dynamically linked module called "gadgetfs".
575 config USB_FILE_STORAGE
576 tristate "File-backed Storage Gadget"
579 The File-backed Storage Gadget acts as a USB Mass Storage
580 disk drive. As its storage repository it can use a regular
581 file or a block device (in much the same way as the "loop"
582 device driver), specified as a module parameter.
584 Say "y" to link the driver statically, or "m" to build a
585 dynamically linked module called "g_file_storage".
587 config USB_FILE_STORAGE_TEST
588 bool "File-backed Storage Gadget testing version"
589 depends on USB_FILE_STORAGE
592 Say "y" to generate the larger testing version of the
593 File-backed Storage Gadget, useful for probing the
594 behavior of USB Mass Storage hosts. Not needed for
598 tristate "Serial Gadget (with CDC ACM and CDC OBEX support)"
600 The Serial Gadget talks to the Linux-USB generic serial driver.
601 This driver supports a CDC-ACM module option, which can be used
602 to interoperate with MS-Windows hosts or with the Linux-USB
605 This driver also supports a CDC-OBEX option. You will need a
606 user space OBEX server talking to /dev/ttyGS*, since the kernel
607 itself doesn't implement the OBEX protocol.
609 Say "y" to link the driver statically, or "m" to build a
610 dynamically linked module called "g_serial".
612 For more information, see Documentation/usb/gadget_serial.txt
613 which includes instructions and a "driver info file" needed to
614 make MS-Windows work with CDC ACM.
616 config USB_MIDI_GADGET
617 tristate "MIDI Gadget (EXPERIMENTAL)"
618 depends on SND && EXPERIMENTAL
621 The MIDI Gadget acts as a USB Audio device, with one MIDI
622 input and one MIDI output. These MIDI jacks appear as
623 a sound "card" in the ALSA sound system. Other MIDI
624 connections can then be made on the gadget system, using
625 ALSA's aconnect utility etc.
627 Say "y" to link the driver statically, or "m" to build a
628 dynamically linked module called "g_midi".
631 tristate "Printer Gadget"
633 The Printer Gadget channels data between the USB host and a
634 userspace program driving the print engine. The user space
635 program reads and writes the device file /dev/g_printer to
636 receive or send printer data. It can use ioctl calls to
637 the device file to get or set printer status.
639 Say "y" to link the driver statically, or "m" to build a
640 dynamically linked module called "g_printer".
642 For more information, see Documentation/usb/gadget_printer.txt
643 which includes sample code for accessing the device file.
645 config USB_CDC_COMPOSITE
646 tristate "CDC Composite Device (Ethernet and ACM)"
649 This driver provides two functions in one configuration:
650 a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link.
652 This driver requires four bulk and two interrupt endpoints,
653 plus the ability to handle altsettings. Not all peripheral
654 controllers are that capable.
656 Say "y" to link the driver statically, or "m" to build a
657 dynamically linked module.
659 # put drivers that need isochronous transfer support (for audio
660 # or video class gadget drivers), or specific hardware, here.