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"
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
195 Many Texas Instruments OMAP processors have flexible full
196 speed USB device controllers, with support for up to 30
197 endpoints (plus endpoint zero). This driver supports the
198 controller in the OMAP 1611, and should work with controllers
199 in other OMAP processors too, given minor tweaks.
201 Say "y" to link the driver statically, or "m" to build a
202 dynamically linked module called "omap_udc" and force all
203 gadget drivers to also be dynamically linked.
207 depends on USB_GADGET_OMAP
209 select USB_GADGET_SELECTED
212 boolean "OTG Support"
213 depends on USB_GADGET_OMAP && ARCH_OMAP_OTG && USB_OHCI_HCD
215 The most notable feature of USB OTG is support for a
216 "Dual-Role" device, which can act as either a device
217 or a host. The initial role choice can be changed
218 later, when two dual-role devices talk to each other.
220 Select this only if your OMAP board has a Mini-AB connector.
222 config USB_GADGET_PXA25X
223 boolean "PXA 25x or IXP 4xx"
224 depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX
226 Intel's PXA 25x series XScale ARM-5TE processors include
227 an integrated full speed USB 1.1 device controller. The
228 controller in the IXP 4xx series is register-compatible.
230 It has fifteen fixed-function endpoints, as well as endpoint
231 zero (for control transfers).
233 Say "y" to link the driver statically, or "m" to build a
234 dynamically linked module called "pxa25x_udc" and force all
235 gadget drivers to also be dynamically linked.
239 depends on USB_GADGET_PXA25X
241 select USB_GADGET_SELECTED
243 # if there's only one gadget driver, using only two bulk endpoints,
244 # don't waste memory for the other endpoints
245 config USB_PXA25X_SMALL
246 depends on USB_GADGET_PXA25X
248 default n if USB_ETH_RNDIS
249 default y if USB_ZERO
251 default y if USB_G_SERIAL
253 config USB_GADGET_PXA27X
255 depends on ARCH_PXA && PXA27x
257 Intel's PXA 27x series XScale ARM v5TE processors include
258 an integrated full speed USB 1.1 device controller.
260 It has up to 23 endpoints, as well as endpoint zero (for
263 Say "y" to link the driver statically, or "m" to build a
264 dynamically linked module called "pxa27x_udc" and force all
265 gadget drivers to also be dynamically linked.
269 depends on USB_GADGET_PXA27X
271 select USB_GADGET_SELECTED
273 config USB_GADGET_S3C2410
274 boolean "S3C2410 USB Device Controller"
275 depends on ARCH_S3C2410
277 Samsung's S3C2410 is an ARM-4 processor with an integrated
278 full speed USB 1.1 device controller. It has 4 configurable
279 endpoints, as well as endpoint zero (for control transfers).
281 This driver has been tested on the S3C2410, S3C2412, and
286 depends on USB_GADGET_S3C2410
288 select USB_GADGET_SELECTED
290 config USB_S3C2410_DEBUG
291 boolean "S3C2410 udc debug messages"
292 depends on USB_GADGET_S3C2410
295 # Controllers available in both integrated and discrete versions
298 # musb builds in ../musb along with host support
299 config USB_GADGET_MUSB_HDRC
300 boolean "Inventra HDRC USB Peripheral (TI, ADI, ...)"
301 depends on USB_MUSB_HDRC && (USB_MUSB_PERIPHERAL || USB_MUSB_OTG)
302 select USB_GADGET_DUALSPEED
303 select USB_GADGET_SELECTED
305 This OTG-capable silicon IP is used in dual designs including
306 the TI DaVinci, OMAP 243x, OMAP 343x, TUSB 6010, and ADI Blackfin
308 config USB_GADGET_IMX
309 boolean "Freescale IMX USB Peripheral Controller"
312 Freescale's IMX series include an integrated full speed
313 USB 1.1 device controller. The controller in the IMX series
314 is register-compatible.
316 It has Six fixed-function endpoints, as well as endpoint
317 zero (for control transfers).
319 Say "y" to link the driver statically, or "m" to build a
320 dynamically linked module called "imx_udc" and force all
321 gadget drivers to also be dynamically linked.
325 depends on USB_GADGET_IMX
327 select USB_GADGET_SELECTED
329 config USB_GADGET_M66592
330 boolean "Renesas M66592 USB Peripheral Controller"
331 select USB_GADGET_DUALSPEED
333 M66592 is a discrete USB peripheral controller chip that
334 supports both full and high speed USB 2.0 data transfers.
335 It has seven configurable endpoints, and endpoint zero.
337 Say "y" to link the driver statically, or "m" to build a
338 dynamically linked module called "m66592_udc" and force all
339 gadget drivers to also be dynamically linked.
343 depends on USB_GADGET_M66592
345 select USB_GADGET_SELECTED
347 config SUPERH_BUILT_IN_M66592
348 boolean "Enable SuperH built-in USB like the M66592"
349 depends on USB_GADGET_M66592 && CPU_SUBTYPE_SH7722
351 SH7722 has USB like the M66592.
353 The transfer rate is very slow when use "Ethernet Gadget".
354 However, this problem is improved if change a value of
358 # Controllers available only in discrete form (and all PCI controllers)
361 config USB_GADGET_AMD5536UDC
362 boolean "AMD5536 UDC"
364 select USB_GADGET_DUALSPEED
366 The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
367 It is a USB Highspeed DMA capable USB device controller. Beside ep0
368 it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
369 The UDC port supports OTG operation, and may be used as a host port
370 if it's not being used to implement peripheral or OTG roles.
372 Say "y" to link the driver statically, or "m" to build a
373 dynamically linked module called "amd5536udc" and force all
374 gadget drivers to also be dynamically linked.
376 config USB_AMD5536UDC
378 depends on USB_GADGET_AMD5536UDC
380 select USB_GADGET_SELECTED
382 config USB_GADGET_FSL_QE
383 boolean "Freescale QE/CPM USB Device Controller"
384 depends on FSL_SOC && (QUICC_ENGINE || CPM)
386 Some of Freescale PowerPC processors have a Full Speed
387 QE/CPM2 USB controller, which support device mode with 4
388 programmable endpoints. This driver supports the
389 controller in the MPC8360 and MPC8272, and should work with
390 controllers having QE or CPM2, given minor tweaks.
392 Set CONFIG_USB_GADGET to "m" to build this driver as a
393 dynmically linked module called "fsl_qe_udc".
397 depends on USB_GADGET_FSL_QE
399 select USB_GADGET_SELECTED
401 config USB_GADGET_CI13XXX
402 boolean "MIPS USB CI13xxx"
404 select USB_GADGET_DUALSPEED
406 MIPS USB IP core family device controller
407 Currently it only supports IP part number CI13412
409 Say "y" to link the driver statically, or "m" to build a
410 dynamically linked module called "ci13xxx_udc" and force all
411 gadget drivers to also be dynamically linked.
415 depends on USB_GADGET_CI13XXX
417 select USB_GADGET_SELECTED
419 config USB_GADGET_NET2280
420 boolean "NetChip 228x"
422 select USB_GADGET_DUALSPEED
424 NetChip 2280 / 2282 is a PCI based USB peripheral controller which
425 supports both full and high speed USB 2.0 data transfers.
427 It has six configurable endpoints, as well as endpoint zero
428 (for control transfers) and several endpoints with dedicated
431 Say "y" to link the driver statically, or "m" to build a
432 dynamically linked module called "net2280" and force all
433 gadget drivers to also be dynamically linked.
437 depends on USB_GADGET_NET2280
439 select USB_GADGET_SELECTED
441 config USB_GADGET_GOKU
442 boolean "Toshiba TC86C001 'Goku-S'"
445 The Toshiba TC86C001 is a PCI device which includes controllers
446 for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
448 The device controller has three configurable (bulk or interrupt)
449 endpoints, plus endpoint zero (for control transfers).
451 Say "y" to link the driver statically, or "m" to build a
452 dynamically linked module called "goku_udc" and to force all
453 gadget drivers to also be dynamically linked.
457 depends on USB_GADGET_GOKU
459 select USB_GADGET_SELECTED
463 # LAST -- dummy/emulated controller
466 config USB_GADGET_DUMMY_HCD
467 boolean "Dummy HCD (DEVELOPMENT)"
468 depends on USB=y || (USB=m && USB_GADGET=m)
469 select USB_GADGET_DUALSPEED
471 This host controller driver emulates USB, looping all data transfer
472 requests back to a USB "gadget driver" in the same host. The host
473 side is the master; the gadget side is the slave. Gadget drivers
474 can be high, full, or low speed; and they have access to endpoints
475 like those from NET2280, PXA2xx, or SA1100 hardware.
477 This may help in some stages of creating a driver to embed in a
478 Linux device, since it lets you debug several parts of the gadget
479 driver without its hardware or drivers being involved.
481 Since such a gadget side driver needs to interoperate with a host
482 side Linux-USB device driver, this may help to debug both sides
483 of a USB protocol stack.
485 Say "y" to link the driver statically, or "m" to build a
486 dynamically linked module called "dummy_hcd" and force all
487 gadget drivers to also be dynamically linked.
491 depends on USB_GADGET_DUMMY_HCD
493 select USB_GADGET_SELECTED
495 # NOTE: Please keep dummy_hcd LAST so that "real hardware" appears
496 # first and will be selected by default.
500 config USB_GADGET_DUALSPEED
502 depends on USB_GADGET
505 Means that gadget drivers should include extra descriptors
506 and code to handle dual-speed controllers.
512 tristate "USB Gadget Drivers"
513 depends on USB_GADGET && USB_GADGET_SELECTED
516 A Linux "Gadget Driver" talks to the USB Peripheral Controller
517 driver through the abstract "gadget" API. Some other operating
518 systems call these "client" drivers, of which "class drivers"
519 are a subset (implementing a USB device class specification).
520 A gadget driver implements one or more USB functions using
521 the peripheral hardware.
523 Gadget drivers are hardware-neutral, or "platform independent",
524 except that they sometimes must understand quirks or limitations
525 of the particular controllers they work with. For example, when
526 a controller doesn't support alternate configurations or provide
527 enough of the right types of endpoints, the gadget driver might
528 not be able work with that controller, or might need to implement
529 a less common variant of a device class protocol.
531 # this first set of drivers all depend on bulk-capable hardware.
534 tristate "Gadget Zero (DEVELOPMENT)"
536 Gadget Zero is a two-configuration device. It either sinks and
537 sources bulk data; or it loops back a configurable number of
538 transfers. It also implements control requests, for "chapter 9"
539 conformance. The driver needs only two bulk-capable endpoints, so
540 it can work on top of most device-side usb controllers. It's
541 useful for testing, and is also a working example showing how
542 USB "gadget drivers" can be written.
544 Make this be the first driver you try using on top of any new
545 USB peripheral controller driver. Then you can use host-side
546 test software, like the "usbtest" driver, to put your hardware
547 and its driver through a basic set of functional tests.
549 Gadget Zero also works with the host-side "usb-skeleton" driver,
550 and with many kinds of host-side test software. You may need
551 to tweak product and vendor IDs before host software knows about
552 this device, and arrange to select an appropriate configuration.
554 Say "y" to link the driver statically, or "m" to build a
555 dynamically linked module called "g_zero".
557 config USB_ZERO_HNPTEST
558 boolean "HNP Test Device"
559 depends on USB_ZERO && USB_OTG
561 You can configure this device to enumerate using the device
562 identifiers of the USB-OTG test device. That means that when
563 this gadget connects to another OTG device, with this one using
564 the "B-Peripheral" role, that device will use HNP to let this
565 one serve as the USB host instead (in the "B-Host" role).
568 tristate "Ethernet Gadget (with CDC Ethernet support)"
571 This driver implements Ethernet style communication, in either
574 - The "Communication Device Class" (CDC) Ethernet Control Model.
575 That protocol is often avoided with pure Ethernet adapters, in
576 favor of simpler vendor-specific hardware, but is widely
577 supported by firmware for smart network devices.
579 - On hardware can't implement that protocol, a simple CDC subset
580 is used, placing fewer demands on USB.
582 RNDIS support is a third option, more demanding than that subset.
584 Within the USB device, this gadget driver exposes a network device
585 "usbX", where X depends on what other networking devices you have.
586 Treat it like a two-node Ethernet link: host, and gadget.
588 The Linux-USB host-side "usbnet" driver interoperates with this
589 driver, so that deep I/O queues can be supported. On 2.4 kernels,
590 use "CDCEther" instead, if you're using the CDC option. That CDC
591 mode should also interoperate with standard CDC Ethernet class
592 drivers on other host operating systems.
594 Say "y" to link the driver statically, or "m" to build a
595 dynamically linked module called "g_ether".
602 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
603 and Microsoft provides redistributable binary RNDIS drivers for
604 older versions of Windows.
606 If you say "y" here, the Ethernet gadget driver will try to provide
607 a second device configuration, supporting RNDIS to talk to such
610 To make MS-Windows work with this, use Documentation/usb/linux.inf
611 as the "driver info file". For versions of MS-Windows older than
612 XP, you'll need to download drivers from Microsoft's website; a URL
613 is given in comments found in that info file.
616 tristate "Gadget Filesystem (EXPERIMENTAL)"
617 depends on EXPERIMENTAL
619 This driver provides a filesystem based API that lets user mode
620 programs implement a single-configuration USB device, including
621 endpoint I/O and control requests that don't relate to enumeration.
622 All endpoints, transfer speeds, and transfer types supported by
623 the hardware are available, through read() and write() calls.
625 Currently, this option is still labelled as EXPERIMENTAL because
626 of existing race conditions in the underlying in-kernel AIO core.
628 Say "y" to link the driver statically, or "m" to build a
629 dynamically linked module called "gadgetfs".
631 config USB_FILE_STORAGE
632 tristate "File-backed Storage Gadget"
635 The File-backed Storage Gadget acts as a USB Mass Storage
636 disk drive. As its storage repository it can use a regular
637 file or a block device (in much the same way as the "loop"
638 device driver), specified as a module parameter.
640 Say "y" to link the driver statically, or "m" to build a
641 dynamically linked module called "g_file_storage".
643 config USB_FILE_STORAGE_TEST
644 bool "File-backed Storage Gadget testing version"
645 depends on USB_FILE_STORAGE
648 Say "y" to generate the larger testing version of the
649 File-backed Storage Gadget, useful for probing the
650 behavior of USB Mass Storage hosts. Not needed for
654 tristate "Serial Gadget (with CDC ACM and CDC OBEX support)"
656 The Serial Gadget talks to the Linux-USB generic serial driver.
657 This driver supports a CDC-ACM module option, which can be used
658 to interoperate with MS-Windows hosts or with the Linux-USB
661 This driver also supports a CDC-OBEX option. You will need a
662 user space OBEX server talking to /dev/ttyGS*, since the kernel
663 itself doesn't implement the OBEX protocol.
665 Say "y" to link the driver statically, or "m" to build a
666 dynamically linked module called "g_serial".
668 For more information, see Documentation/usb/gadget_serial.txt
669 which includes instructions and a "driver info file" needed to
670 make MS-Windows work with CDC ACM.
672 config USB_MIDI_GADGET
673 tristate "MIDI Gadget (EXPERIMENTAL)"
674 depends on SND && EXPERIMENTAL
677 The MIDI Gadget acts as a USB Audio device, with one MIDI
678 input and one MIDI output. These MIDI jacks appear as
679 a sound "card" in the ALSA sound system. Other MIDI
680 connections can then be made on the gadget system, using
681 ALSA's aconnect utility etc.
683 Say "y" to link the driver statically, or "m" to build a
684 dynamically linked module called "g_midi".
687 tristate "Printer Gadget"
689 The Printer Gadget channels data between the USB host and a
690 userspace program driving the print engine. The user space
691 program reads and writes the device file /dev/g_printer to
692 receive or send printer data. It can use ioctl calls to
693 the device file to get or set printer status.
695 Say "y" to link the driver statically, or "m" to build a
696 dynamically linked module called "g_printer".
698 For more information, see Documentation/usb/gadget_printer.txt
699 which includes sample code for accessing the device file.
701 config USB_CDC_COMPOSITE
702 tristate "CDC Composite Device (Ethernet and ACM)"
705 This driver provides two functions in one configuration:
706 a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link.
708 This driver requires four bulk and two interrupt endpoints,
709 plus the ability to handle altsettings. Not all peripheral
710 controllers are that capable.
712 Say "y" to link the driver statically, or "m" to build a
713 dynamically linked module.
715 # put drivers that need isochronous transfer support (for audio
716 # or video class gadget drivers), or specific hardware, here.