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 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)"
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)"
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_VBUS_DRAW
83 int "Maximum VBUS Power usage (2-500 mA)"
87 Some devices need to draw power from USB when they are
88 configured, perhaps to operate circuitry or to recharge
89 batteries. This is in addition to any local power supply,
90 such as an AC adapter or batteries.
92 Enter the maximum power your device draws through USB, in
93 milliAmperes. The permitted range of values is 2 - 500 mA;
94 0 mA would be legal, but can make some hosts misbehave.
96 This value will be used except for system-specific gadget
97 drivers that have more specific information.
99 config USB_GADGET_SELECTED
103 # USB Peripheral Controller Support
105 # The order here is alphabetical, except that integrated controllers go
106 # before discrete ones so they will be the initial/default value:
107 # - integrated/SOC controllers first
108 # - licensed IP used in both SOC and discrete versions
109 # - discrete ones (including all PCI-only controllers)
110 # - debug/dummy gadget+hcd is last.
113 prompt "USB Peripheral Controller"
114 depends on USB_GADGET
116 A USB device uses a controller to talk to its host.
117 Systems should have only one such upstream link.
118 Many controller drivers are platform-specific; these
119 often need board-specific hooks.
122 # Integrated controllers
125 config USB_GADGET_AT91
126 boolean "Atmel AT91 USB Device Port"
127 depends on ARCH_AT91 && !ARCH_AT91SAM9RL && !ARCH_AT91CAP9
128 select USB_GADGET_SELECTED
130 Many Atmel AT91 processors (such as the AT91RM2000) have a
131 full speed USB Device Port with support for five configurable
132 endpoints (plus endpoint zero).
134 Say "y" to link the driver statically, or "m" to build a
135 dynamically linked module called "at91_udc" and force all
136 gadget drivers to also be dynamically linked.
140 depends on USB_GADGET_AT91
143 config USB_GADGET_ATMEL_USBA
145 select USB_GADGET_DUALSPEED
146 depends on AVR32 || ARCH_AT91CAP9 || ARCH_AT91SAM9RL
148 USBA is the integrated high-speed USB Device controller on
149 the AT32AP700x, some AT91SAM9 and AT91CAP9 processors from Atmel.
151 config USB_ATMEL_USBA
153 depends on USB_GADGET_ATMEL_USBA
155 select USB_GADGET_SELECTED
157 config USB_GADGET_FSL_USB2
158 boolean "Freescale Highspeed USB DR Peripheral Controller"
159 depends on FSL_SOC || ARCH_MXC
160 select USB_GADGET_DUALSPEED
162 Some of Freescale PowerPC processors have a High Speed
163 Dual-Role(DR) USB controller, which supports device mode.
165 The number of programmable endpoints is different through
168 Say "y" to link the driver statically, or "m" to build a
169 dynamically linked module called "fsl_usb2_udc" and force
170 all gadget drivers to also be dynamically linked.
174 depends on USB_GADGET_FSL_USB2
176 select USB_GADGET_SELECTED
178 config USB_GADGET_LH7A40X
180 depends on ARCH_LH7A40X
182 This driver provides USB Device Controller driver for LH7A40x
186 depends on USB_GADGET_LH7A40X
188 select USB_GADGET_SELECTED
190 config USB_GADGET_OMAP
191 boolean "OMAP USB Device Controller"
193 select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3 || MACH_OMAP_H4_OTG
194 select USB_OTG_UTILS if ARCH_OMAP
196 Many Texas Instruments OMAP processors have flexible full
197 speed USB device controllers, with support for up to 30
198 endpoints (plus endpoint zero). This driver supports the
199 controller in the OMAP 1611, and should work with controllers
200 in other OMAP processors too, given minor tweaks.
202 Say "y" to link the driver statically, or "m" to build a
203 dynamically linked module called "omap_udc" and force all
204 gadget drivers to also be dynamically linked.
208 depends on USB_GADGET_OMAP
210 select USB_GADGET_SELECTED
213 boolean "OTG Support"
214 depends on USB_GADGET_OMAP && ARCH_OMAP_OTG && USB_OHCI_HCD
216 The most notable feature of USB OTG is support for a
217 "Dual-Role" device, which can act as either a device
218 or a host. The initial role choice can be changed
219 later, when two dual-role devices talk to each other.
221 Select this only if your OMAP board has a Mini-AB connector.
223 config USB_GADGET_PXA25X
224 boolean "PXA 25x or IXP 4xx"
225 depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX
227 Intel's PXA 25x series XScale ARM-5TE processors include
228 an integrated full speed USB 1.1 device controller. The
229 controller in the IXP 4xx series is register-compatible.
231 It has fifteen fixed-function endpoints, as well as endpoint
232 zero (for control transfers).
234 Say "y" to link the driver statically, or "m" to build a
235 dynamically linked module called "pxa25x_udc" and force all
236 gadget drivers to also be dynamically linked.
240 depends on USB_GADGET_PXA25X
242 select USB_GADGET_SELECTED
244 # if there's only one gadget driver, using only two bulk endpoints,
245 # don't waste memory for the other endpoints
246 config USB_PXA25X_SMALL
247 depends on USB_GADGET_PXA25X
249 default n if USB_ETH_RNDIS
250 default y if USB_ZERO
252 default y if USB_G_SERIAL
254 config USB_GADGET_PXA27X
256 depends on ARCH_PXA && (PXA27x || PXA3xx)
259 Intel's PXA 27x series XScale ARM v5TE processors include
260 an integrated full speed USB 1.1 device controller.
262 It has up to 23 endpoints, as well as endpoint zero (for
265 Say "y" to link the driver statically, or "m" to build a
266 dynamically linked module called "pxa27x_udc" and force all
267 gadget drivers to also be dynamically linked.
271 depends on USB_GADGET_PXA27X
273 select USB_GADGET_SELECTED
275 config USB_GADGET_S3C_HSOTG
276 boolean "S3C HS/OtG USB Device controller"
277 depends on S3C_DEV_USB_HSOTG
278 select USB_GADGET_S3C_HSOTG_PIO
280 The Samsung S3C64XX USB2.0 high-speed gadget controller
281 integrated into the S3C64XX series SoC.
285 depends on USB_GADGET_S3C_HSOTG
287 select USB_GADGET_SELECTED
289 config USB_GADGET_S3C2410
290 boolean "S3C2410 USB Device Controller"
291 depends on ARCH_S3C2410
293 Samsung's S3C2410 is an ARM-4 processor with an integrated
294 full speed USB 1.1 device controller. It has 4 configurable
295 endpoints, as well as endpoint zero (for control transfers).
297 This driver has been tested on the S3C2410, S3C2412, and
302 depends on USB_GADGET_S3C2410
304 select USB_GADGET_SELECTED
306 config USB_S3C2410_DEBUG
307 boolean "S3C2410 udc debug messages"
308 depends on USB_GADGET_S3C2410
311 # Controllers available in both integrated and discrete versions
314 # musb builds in ../musb along with host support
315 config USB_GADGET_MUSB_HDRC
316 boolean "Inventra HDRC USB Peripheral (TI, ADI, ...)"
317 depends on USB_MUSB_HDRC && (USB_MUSB_PERIPHERAL || USB_MUSB_OTG)
318 select USB_GADGET_DUALSPEED
319 select USB_GADGET_SELECTED
321 This OTG-capable silicon IP is used in dual designs including
322 the TI DaVinci, OMAP 243x, OMAP 343x, TUSB 6010, and ADI Blackfin
324 config USB_GADGET_IMX
325 boolean "Freescale IMX USB Peripheral Controller"
328 Freescale's IMX series include an integrated full speed
329 USB 1.1 device controller. The controller in the IMX series
330 is register-compatible.
332 It has Six fixed-function endpoints, as well as endpoint
333 zero (for control transfers).
335 Say "y" to link the driver statically, or "m" to build a
336 dynamically linked module called "imx_udc" and force all
337 gadget drivers to also be dynamically linked.
341 depends on USB_GADGET_IMX
343 select USB_GADGET_SELECTED
345 config USB_GADGET_M66592
346 boolean "Renesas M66592 USB Peripheral Controller"
347 select USB_GADGET_DUALSPEED
349 M66592 is a discrete USB peripheral controller chip that
350 supports both full and high speed USB 2.0 data transfers.
351 It has seven configurable endpoints, and endpoint zero.
353 Say "y" to link the driver statically, or "m" to build a
354 dynamically linked module called "m66592_udc" and force all
355 gadget drivers to also be dynamically linked.
359 depends on USB_GADGET_M66592
361 select USB_GADGET_SELECTED
363 config SUPERH_BUILT_IN_M66592
364 boolean "Enable SuperH built-in USB like the M66592"
365 depends on USB_GADGET_M66592 && CPU_SUBTYPE_SH7722
367 SH7722 has USB like the M66592.
369 The transfer rate is very slow when use "Ethernet Gadget".
370 However, this problem is improved if change a value of
374 # Controllers available only in discrete form (and all PCI controllers)
377 config USB_GADGET_AMD5536UDC
378 boolean "AMD5536 UDC"
380 select USB_GADGET_DUALSPEED
382 The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
383 It is a USB Highspeed DMA capable USB device controller. Beside ep0
384 it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
385 The UDC port supports OTG operation, and may be used as a host port
386 if it's not being used to implement peripheral or OTG roles.
388 Say "y" to link the driver statically, or "m" to build a
389 dynamically linked module called "amd5536udc" and force all
390 gadget drivers to also be dynamically linked.
392 config USB_AMD5536UDC
394 depends on USB_GADGET_AMD5536UDC
396 select USB_GADGET_SELECTED
398 config USB_GADGET_FSL_QE
399 boolean "Freescale QE/CPM USB Device Controller"
400 depends on FSL_SOC && (QUICC_ENGINE || CPM)
402 Some of Freescale PowerPC processors have a Full Speed
403 QE/CPM2 USB controller, which support device mode with 4
404 programmable endpoints. This driver supports the
405 controller in the MPC8360 and MPC8272, and should work with
406 controllers having QE or CPM2, given minor tweaks.
408 Set CONFIG_USB_GADGET to "m" to build this driver as a
409 dynamically linked module called "fsl_qe_udc".
413 depends on USB_GADGET_FSL_QE
415 select USB_GADGET_SELECTED
417 config USB_GADGET_CI13XXX
418 boolean "MIPS USB CI13xxx"
420 select USB_GADGET_DUALSPEED
422 MIPS USB IP core family device controller
423 Currently it only supports IP part number CI13412
425 Say "y" to link the driver statically, or "m" to build a
426 dynamically linked module called "ci13xxx_udc" and force all
427 gadget drivers to also be dynamically linked.
431 depends on USB_GADGET_CI13XXX
433 select USB_GADGET_SELECTED
435 config USB_GADGET_NET2280
436 boolean "NetChip 228x"
438 select USB_GADGET_DUALSPEED
440 NetChip 2280 / 2282 is a PCI based USB peripheral controller which
441 supports both full and high speed USB 2.0 data transfers.
443 It has six configurable endpoints, as well as endpoint zero
444 (for control transfers) and several endpoints with dedicated
447 Say "y" to link the driver statically, or "m" to build a
448 dynamically linked module called "net2280" and force all
449 gadget drivers to also be dynamically linked.
453 depends on USB_GADGET_NET2280
455 select USB_GADGET_SELECTED
457 config USB_GADGET_GOKU
458 boolean "Toshiba TC86C001 'Goku-S'"
461 The Toshiba TC86C001 is a PCI device which includes controllers
462 for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
464 The device controller has three configurable (bulk or interrupt)
465 endpoints, plus endpoint zero (for control transfers).
467 Say "y" to link the driver statically, or "m" to build a
468 dynamically linked module called "goku_udc" and to force all
469 gadget drivers to also be dynamically linked.
473 depends on USB_GADGET_GOKU
475 select USB_GADGET_SELECTED
477 config USB_GADGET_LANGWELL
478 boolean "Intel Langwell USB Device Controller"
480 select USB_GADGET_DUALSPEED
482 Intel Langwell USB Device Controller is a High-Speed USB
483 On-The-Go device controller.
485 The number of programmable endpoints is different through
488 Say "y" to link the driver statically, or "m" to build a
489 dynamically linked module called "langwell_udc" and force all
490 gadget drivers to also be dynamically linked.
494 depends on USB_GADGET_LANGWELL
496 select USB_GADGET_SELECTED
500 # LAST -- dummy/emulated controller
503 config USB_GADGET_DUMMY_HCD
504 boolean "Dummy HCD (DEVELOPMENT)"
505 depends on USB=y || (USB=m && USB_GADGET=m)
506 select USB_GADGET_DUALSPEED
508 This host controller driver emulates USB, looping all data transfer
509 requests back to a USB "gadget driver" in the same host. The host
510 side is the master; the gadget side is the slave. Gadget drivers
511 can be high, full, or low speed; and they have access to endpoints
512 like those from NET2280, PXA2xx, or SA1100 hardware.
514 This may help in some stages of creating a driver to embed in a
515 Linux device, since it lets you debug several parts of the gadget
516 driver without its hardware or drivers being involved.
518 Since such a gadget side driver needs to interoperate with a host
519 side Linux-USB device driver, this may help to debug both sides
520 of a USB protocol stack.
522 Say "y" to link the driver statically, or "m" to build a
523 dynamically linked module called "dummy_hcd" and force all
524 gadget drivers to also be dynamically linked.
528 depends on USB_GADGET_DUMMY_HCD
530 select USB_GADGET_SELECTED
532 # NOTE: Please keep dummy_hcd LAST so that "real hardware" appears
533 # first and will be selected by default.
537 config USB_GADGET_DUALSPEED
539 depends on USB_GADGET
542 Means that gadget drivers should include extra descriptors
543 and code to handle dual-speed controllers.
549 tristate "USB Gadget Drivers"
550 depends on USB_GADGET && USB_GADGET_SELECTED
553 A Linux "Gadget Driver" talks to the USB Peripheral Controller
554 driver through the abstract "gadget" API. Some other operating
555 systems call these "client" drivers, of which "class drivers"
556 are a subset (implementing a USB device class specification).
557 A gadget driver implements one or more USB functions using
558 the peripheral hardware.
560 Gadget drivers are hardware-neutral, or "platform independent",
561 except that they sometimes must understand quirks or limitations
562 of the particular controllers they work with. For example, when
563 a controller doesn't support alternate configurations or provide
564 enough of the right types of endpoints, the gadget driver might
565 not be able work with that controller, or might need to implement
566 a less common variant of a device class protocol.
568 # this first set of drivers all depend on bulk-capable hardware.
571 tristate "Gadget Zero (DEVELOPMENT)"
573 Gadget Zero is a two-configuration device. It either sinks and
574 sources bulk data; or it loops back a configurable number of
575 transfers. It also implements control requests, for "chapter 9"
576 conformance. The driver needs only two bulk-capable endpoints, so
577 it can work on top of most device-side usb controllers. It's
578 useful for testing, and is also a working example showing how
579 USB "gadget drivers" can be written.
581 Make this be the first driver you try using on top of any new
582 USB peripheral controller driver. Then you can use host-side
583 test software, like the "usbtest" driver, to put your hardware
584 and its driver through a basic set of functional tests.
586 Gadget Zero also works with the host-side "usb-skeleton" driver,
587 and with many kinds of host-side test software. You may need
588 to tweak product and vendor IDs before host software knows about
589 this device, and arrange to select an appropriate configuration.
591 Say "y" to link the driver statically, or "m" to build a
592 dynamically linked module called "g_zero".
594 config USB_ZERO_HNPTEST
595 boolean "HNP Test Device"
596 depends on USB_ZERO && USB_OTG
598 You can configure this device to enumerate using the device
599 identifiers of the USB-OTG test device. That means that when
600 this gadget connects to another OTG device, with this one using
601 the "B-Peripheral" role, that device will use HNP to let this
602 one serve as the USB host instead (in the "B-Host" role).
605 tristate "Audio Gadget (EXPERIMENTAL)"
608 Gadget Audio is compatible with USB Audio Class specification 1.0.
609 It will include at least one AudioControl interface, zero or more
610 AudioStream interface and zero or more MIDIStream interface.
612 Gadget Audio will use on-board ALSA (CONFIG_SND) audio card to
613 playback or capture audio stream.
615 Say "y" to link the driver statically, or "m" to build a
616 dynamically linked module called "g_audio".
619 tristate "Ethernet Gadget (with CDC Ethernet support)"
622 This driver implements Ethernet style communication, in either
625 - The "Communication Device Class" (CDC) Ethernet Control Model.
626 That protocol is often avoided with pure Ethernet adapters, in
627 favor of simpler vendor-specific hardware, but is widely
628 supported by firmware for smart network devices.
630 - On hardware can't implement that protocol, a simple CDC subset
631 is used, placing fewer demands on USB.
633 RNDIS support is a third option, more demanding than that subset.
635 Within the USB device, this gadget driver exposes a network device
636 "usbX", where X depends on what other networking devices you have.
637 Treat it like a two-node Ethernet link: host, and gadget.
639 The Linux-USB host-side "usbnet" driver interoperates with this
640 driver, so that deep I/O queues can be supported. On 2.4 kernels,
641 use "CDCEther" instead, if you're using the CDC option. That CDC
642 mode should also interoperate with standard CDC Ethernet class
643 drivers on other host operating systems.
645 Say "y" to link the driver statically, or "m" to build a
646 dynamically linked module called "g_ether".
653 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
654 and Microsoft provides redistributable binary RNDIS drivers for
655 older versions of Windows.
657 If you say "y" here, the Ethernet gadget driver will try to provide
658 a second device configuration, supporting RNDIS to talk to such
661 To make MS-Windows work with this, use Documentation/usb/linux.inf
662 as the "driver info file". For versions of MS-Windows older than
663 XP, you'll need to download drivers from Microsoft's website; a URL
664 is given in comments found in that info file.
667 tristate "Gadget Filesystem (EXPERIMENTAL)"
668 depends on EXPERIMENTAL
670 This driver provides a filesystem based API that lets user mode
671 programs implement a single-configuration USB device, including
672 endpoint I/O and control requests that don't relate to enumeration.
673 All endpoints, transfer speeds, and transfer types supported by
674 the hardware are available, through read() and write() calls.
676 Currently, this option is still labelled as EXPERIMENTAL because
677 of existing race conditions in the underlying in-kernel AIO core.
679 Say "y" to link the driver statically, or "m" to build a
680 dynamically linked module called "gadgetfs".
682 config USB_FILE_STORAGE
683 tristate "File-backed Storage Gadget"
686 The File-backed Storage Gadget acts as a USB Mass Storage
687 disk drive. As its storage repository it can use a regular
688 file or a block device (in much the same way as the "loop"
689 device driver), specified as a module parameter.
691 Say "y" to link the driver statically, or "m" to build a
692 dynamically linked module called "g_file_storage".
694 config USB_FILE_STORAGE_TEST
695 bool "File-backed Storage Gadget testing version"
696 depends on USB_FILE_STORAGE
699 Say "y" to generate the larger testing version of the
700 File-backed Storage Gadget, useful for probing the
701 behavior of USB Mass Storage hosts. Not needed for
705 tristate "Serial Gadget (with CDC ACM and CDC OBEX support)"
707 The Serial Gadget talks to the Linux-USB generic serial driver.
708 This driver supports a CDC-ACM module option, which can be used
709 to interoperate with MS-Windows hosts or with the Linux-USB
712 This driver also supports a CDC-OBEX option. You will need a
713 user space OBEX server talking to /dev/ttyGS*, since the kernel
714 itself doesn't implement the OBEX protocol.
716 Say "y" to link the driver statically, or "m" to build a
717 dynamically linked module called "g_serial".
719 For more information, see Documentation/usb/gadget_serial.txt
720 which includes instructions and a "driver info file" needed to
721 make MS-Windows work with CDC ACM.
723 config USB_MIDI_GADGET
724 tristate "MIDI Gadget (EXPERIMENTAL)"
725 depends on SND && EXPERIMENTAL
728 The MIDI Gadget acts as a USB Audio device, with one MIDI
729 input and one MIDI output. These MIDI jacks appear as
730 a sound "card" in the ALSA sound system. Other MIDI
731 connections can then be made on the gadget system, using
732 ALSA's aconnect utility etc.
734 Say "y" to link the driver statically, or "m" to build a
735 dynamically linked module called "g_midi".
738 tristate "Printer Gadget"
740 The Printer Gadget channels data between the USB host and a
741 userspace program driving the print engine. The user space
742 program reads and writes the device file /dev/g_printer to
743 receive or send printer data. It can use ioctl calls to
744 the device file to get or set printer status.
746 Say "y" to link the driver statically, or "m" to build a
747 dynamically linked module called "g_printer".
749 For more information, see Documentation/usb/gadget_printer.txt
750 which includes sample code for accessing the device file.
752 config USB_CDC_COMPOSITE
753 tristate "CDC Composite Device (Ethernet and ACM)"
756 This driver provides two functions in one configuration:
757 a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link.
759 This driver requires four bulk and two interrupt endpoints,
760 plus the ability to handle altsettings. Not all peripheral
761 controllers are that capable.
763 Say "y" to link the driver statically, or "m" to build a
764 dynamically linked module.
766 # put drivers that need isochronous transfer support (for audio
767 # or video class gadget drivers), or specific hardware, here.