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"
18 # crashes on titan with:
19 # http://redhat.com/~mingo/misc/config-Tue_Jul_22_13_44_45_CEST_2008.bad
22 USB is a master/slave protocol, organized with one master
23 host (such as a PC) controlling up to 127 peripheral devices.
24 The USB hardware is asymmetric, which makes it easier to set up:
25 you can't connect a "to-the-host" connector to a peripheral.
27 Linux can run in the host, or in the peripheral. In both cases
28 you need a low level bus controller driver, and some software
29 talking to it. Peripheral controllers are often discrete silicon,
30 or are integrated with the CPU in a microcontroller. The more
31 familiar host side controllers have names like "EHCI", "OHCI",
32 or "UHCI", and are usually integrated into southbridges on PC
35 Enable this configuration option if you want to run Linux inside
36 a USB peripheral device. Configure one hardware driver for your
37 peripheral/device side bus controller, and a "gadget driver" for
38 your peripheral protocol. (If you use modular gadget drivers,
39 you may configure more than one.)
41 If in doubt, say "N" and don't enable these drivers; most people
42 don't have this kind of hardware (except maybe inside Linux PDAs).
44 For more information, see <http://www.linux-usb.org/gadget> and
45 the kernel DocBook documentation for this API.
49 config USB_GADGET_DEBUG
50 boolean "Debugging messages (DEVELOPMENT)"
51 depends on DEBUG_KERNEL
53 Many controller and gadget drivers will print some debugging
54 messages if you use this option to ask for those messages.
56 Avoid enabling these messages, even if you're actively
57 debugging such a driver. Many drivers will emit so many
58 messages that the driver timings are affected, which will
59 either create new failure modes or remove the one you're
60 trying to track down. Never enable these messages for a
63 config USB_GADGET_DEBUG_FILES
64 boolean "Debugging information files (DEVELOPMENT)"
67 Some of the drivers in the "gadget" framework can expose
68 debugging information in files such as /proc/driver/udc
69 (for a peripheral controller). The information in these
70 files may help when you're troubleshooting or bringing up a
71 driver on a new board. Enable these files by choosing "Y"
72 here. If in doubt, or to conserve kernel memory, say "N".
74 config USB_GADGET_DEBUG_FS
75 boolean "Debugging information files in debugfs (DEVELOPMENT)"
78 Some of the drivers in the "gadget" framework can expose
79 debugging information in files under /sys/kernel/debug/.
80 The information in these files may help when you're
81 troubleshooting or bringing up a driver on a new board.
82 Enable these files by choosing "Y" here. If in doubt, or
83 to conserve kernel memory, say "N".
85 config USB_GADGET_VBUS_DRAW
86 int "Maximum VBUS Power usage (2-500 mA)"
90 Some devices need to draw power from USB when they are
91 configured, perhaps to operate circuitry or to recharge
92 batteries. This is in addition to any local power supply,
93 such as an AC adapter or batteries.
95 Enter the maximum power your device draws through USB, in
96 milliAmperes. The permitted range of values is 2 - 500 mA;
97 0 mA would be legal, but can make some hosts misbehave.
99 This value will be used except for system-specific gadget
100 drivers that have more specific information.
102 config USB_GADGET_SELECTED
106 # USB Peripheral Controller Support
108 # The order here is alphabetical, except that integrated controllers go
109 # before discrete ones so they will be the initial/default value:
110 # - integrated/SOC controllers first
111 # - licensed IP used in both SOC and discrete versions
112 # - discrete ones (including all PCI-only controllers)
113 # - debug/dummy gadget+hcd is last.
116 prompt "USB Peripheral Controller"
117 depends on USB_GADGET
119 A USB device uses a controller to talk to its host.
120 Systems should have only one such upstream link.
121 Many controller drivers are platform-specific; these
122 often need board-specific hooks.
125 # Integrated controllers
128 config USB_GADGET_AT91
129 boolean "Atmel AT91 USB Device Port"
130 depends on ARCH_AT91 && !ARCH_AT91SAM9RL && !ARCH_AT91CAP9
131 select USB_GADGET_SELECTED
133 Many Atmel AT91 processors (such as the AT91RM2000) have a
134 full speed USB Device Port with support for five configurable
135 endpoints (plus endpoint zero).
137 Say "y" to link the driver statically, or "m" to build a
138 dynamically linked module called "at91_udc" and force all
139 gadget drivers to also be dynamically linked.
143 depends on USB_GADGET_AT91
146 config USB_GADGET_ATMEL_USBA
148 select USB_GADGET_DUALSPEED
149 depends on AVR32 || ARCH_AT91CAP9 || ARCH_AT91SAM9RL
151 USBA is the integrated high-speed USB Device controller on
152 the AT32AP700x, some AT91SAM9 and AT91CAP9 processors from Atmel.
154 config USB_ATMEL_USBA
156 depends on USB_GADGET_ATMEL_USBA
158 select USB_GADGET_SELECTED
160 config USB_GADGET_FSL_USB2
161 boolean "Freescale Highspeed USB DR Peripheral Controller"
163 select USB_GADGET_DUALSPEED
165 Some of Freescale PowerPC processors have a High Speed
166 Dual-Role(DR) USB controller, which supports device mode.
168 The number of programmable endpoints is different through
171 Say "y" to link the driver statically, or "m" to build a
172 dynamically linked module called "fsl_usb2_udc" and force
173 all gadget drivers to also be dynamically linked.
177 depends on USB_GADGET_FSL_USB2
179 select USB_GADGET_SELECTED
181 config USB_GADGET_LH7A40X
183 depends on ARCH_LH7A40X
185 This driver provides USB Device Controller driver for LH7A40x
189 depends on USB_GADGET_LH7A40X
191 select USB_GADGET_SELECTED
193 config USB_GADGET_OMAP
194 boolean "OMAP USB Device Controller"
196 select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3 || MACH_OMAP_H4_OTG
197 select USB_OTG_UTILS if ARCH_OMAP
199 Many Texas Instruments OMAP processors have flexible full
200 speed USB device controllers, with support for up to 30
201 endpoints (plus endpoint zero). This driver supports the
202 controller in the OMAP 1611, and should work with controllers
203 in other OMAP processors too, given minor tweaks.
205 Say "y" to link the driver statically, or "m" to build a
206 dynamically linked module called "omap_udc" and force all
207 gadget drivers to also be dynamically linked.
211 depends on USB_GADGET_OMAP
213 select USB_GADGET_SELECTED
216 boolean "OTG Support"
217 depends on USB_GADGET_OMAP && ARCH_OMAP_OTG && USB_OHCI_HCD
219 The most notable feature of USB OTG is support for a
220 "Dual-Role" device, which can act as either a device
221 or a host. The initial role choice can be changed
222 later, when two dual-role devices talk to each other.
224 Select this only if your OMAP board has a Mini-AB connector.
226 config USB_GADGET_PXA25X
227 boolean "PXA 25x or IXP 4xx"
228 depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX
230 Intel's PXA 25x series XScale ARM-5TE processors include
231 an integrated full speed USB 1.1 device controller. The
232 controller in the IXP 4xx series is register-compatible.
234 It has fifteen fixed-function endpoints, as well as endpoint
235 zero (for control transfers).
237 Say "y" to link the driver statically, or "m" to build a
238 dynamically linked module called "pxa25x_udc" and force all
239 gadget drivers to also be dynamically linked.
243 depends on USB_GADGET_PXA25X
245 select USB_GADGET_SELECTED
247 # if there's only one gadget driver, using only two bulk endpoints,
248 # don't waste memory for the other endpoints
249 config USB_PXA25X_SMALL
250 depends on USB_GADGET_PXA25X
252 default n if USB_ETH_RNDIS
253 default y if USB_ZERO
255 default y if USB_G_SERIAL
257 config USB_GADGET_PXA27X
259 depends on ARCH_PXA && PXA27x
261 Intel's PXA 27x series XScale ARM v5TE processors include
262 an integrated full speed USB 1.1 device controller.
264 It has up to 23 endpoints, as well as endpoint zero (for
267 Say "y" to link the driver statically, or "m" to build a
268 dynamically linked module called "pxa27x_udc" and force all
269 gadget drivers to also be dynamically linked.
273 depends on USB_GADGET_PXA27X
275 select USB_GADGET_SELECTED
277 config USB_GADGET_S3C2410
278 boolean "S3C2410 USB Device Controller"
279 depends on ARCH_S3C2410
281 Samsung's S3C2410 is an ARM-4 processor with an integrated
282 full speed USB 1.1 device controller. It has 4 configurable
283 endpoints, as well as endpoint zero (for control transfers).
285 This driver has been tested on the S3C2410, S3C2412, and
290 depends on USB_GADGET_S3C2410
292 select USB_GADGET_SELECTED
294 config USB_S3C2410_DEBUG
295 boolean "S3C2410 udc debug messages"
296 depends on USB_GADGET_S3C2410
299 # Controllers available in both integrated and discrete versions
302 # musb builds in ../musb along with host support
303 config USB_GADGET_MUSB_HDRC
304 boolean "Inventra HDRC USB Peripheral (TI, ADI, ...)"
305 depends on USB_MUSB_HDRC && (USB_MUSB_PERIPHERAL || USB_MUSB_OTG)
306 select USB_GADGET_DUALSPEED
307 select USB_GADGET_SELECTED
309 This OTG-capable silicon IP is used in dual designs including
310 the TI DaVinci, OMAP 243x, OMAP 343x, TUSB 6010, and ADI Blackfin
312 config USB_GADGET_IMX
313 boolean "Freescale IMX USB Peripheral Controller"
316 Freescale's IMX series include an integrated full speed
317 USB 1.1 device controller. The controller in the IMX series
318 is register-compatible.
320 It has Six fixed-function endpoints, as well as endpoint
321 zero (for control transfers).
323 Say "y" to link the driver statically, or "m" to build a
324 dynamically linked module called "imx_udc" and force all
325 gadget drivers to also be dynamically linked.
329 depends on USB_GADGET_IMX
331 select USB_GADGET_SELECTED
333 config USB_GADGET_M66592
334 boolean "Renesas M66592 USB Peripheral Controller"
335 select USB_GADGET_DUALSPEED
337 M66592 is a discrete USB peripheral controller chip that
338 supports both full and high speed USB 2.0 data transfers.
339 It has seven configurable endpoints, and endpoint zero.
341 Say "y" to link the driver statically, or "m" to build a
342 dynamically linked module called "m66592_udc" and force all
343 gadget drivers to also be dynamically linked.
347 depends on USB_GADGET_M66592
349 select USB_GADGET_SELECTED
351 config SUPERH_BUILT_IN_M66592
352 boolean "Enable SuperH built-in USB like the M66592"
353 depends on USB_GADGET_M66592 && CPU_SUBTYPE_SH7722
355 SH7722 has USB like the M66592.
357 The transfer rate is very slow when use "Ethernet Gadget".
358 However, this problem is improved if change a value of
362 # Controllers available only in discrete form (and all PCI controllers)
365 config USB_GADGET_AMD5536UDC
366 boolean "AMD5536 UDC"
368 select USB_GADGET_DUALSPEED
370 The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
371 It is a USB Highspeed DMA capable USB device controller. Beside ep0
372 it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
373 The UDC port supports OTG operation, and may be used as a host port
374 if it's not being used to implement peripheral or OTG roles.
376 Say "y" to link the driver statically, or "m" to build a
377 dynamically linked module called "amd5536udc" and force all
378 gadget drivers to also be dynamically linked.
380 config USB_AMD5536UDC
382 depends on USB_GADGET_AMD5536UDC
384 select USB_GADGET_SELECTED
386 config USB_GADGET_FSL_QE
387 boolean "Freescale QE/CPM USB Device Controller"
388 depends on FSL_SOC && (QUICC_ENGINE || CPM)
390 Some of Freescale PowerPC processors have a Full Speed
391 QE/CPM2 USB controller, which support device mode with 4
392 programmable endpoints. This driver supports the
393 controller in the MPC8360 and MPC8272, and should work with
394 controllers having QE or CPM2, given minor tweaks.
396 Set CONFIG_USB_GADGET to "m" to build this driver as a
397 dynmically linked module called "fsl_qe_udc".
401 depends on USB_GADGET_FSL_QE
403 select USB_GADGET_SELECTED
405 config USB_GADGET_CI13XXX
406 boolean "MIPS USB CI13xxx"
408 select USB_GADGET_DUALSPEED
410 MIPS USB IP core family device controller
411 Currently it only supports IP part number CI13412
413 Say "y" to link the driver statically, or "m" to build a
414 dynamically linked module called "ci13xxx_udc" and force all
415 gadget drivers to also be dynamically linked.
419 depends on USB_GADGET_CI13XXX
421 select USB_GADGET_SELECTED
423 config USB_GADGET_NET2280
424 boolean "NetChip 228x"
426 select USB_GADGET_DUALSPEED
428 NetChip 2280 / 2282 is a PCI based USB peripheral controller which
429 supports both full and high speed USB 2.0 data transfers.
431 It has six configurable endpoints, as well as endpoint zero
432 (for control transfers) and several endpoints with dedicated
435 Say "y" to link the driver statically, or "m" to build a
436 dynamically linked module called "net2280" and force all
437 gadget drivers to also be dynamically linked.
441 depends on USB_GADGET_NET2280
443 select USB_GADGET_SELECTED
445 config USB_GADGET_GOKU
446 boolean "Toshiba TC86C001 'Goku-S'"
449 The Toshiba TC86C001 is a PCI device which includes controllers
450 for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
452 The device controller has three configurable (bulk or interrupt)
453 endpoints, plus endpoint zero (for control transfers).
455 Say "y" to link the driver statically, or "m" to build a
456 dynamically linked module called "goku_udc" and to force all
457 gadget drivers to also be dynamically linked.
461 depends on USB_GADGET_GOKU
463 select USB_GADGET_SELECTED
467 # LAST -- dummy/emulated controller
470 config USB_GADGET_DUMMY_HCD
471 boolean "Dummy HCD (DEVELOPMENT)"
472 depends on USB=y || (USB=m && USB_GADGET=m)
473 select USB_GADGET_DUALSPEED
475 This host controller driver emulates USB, looping all data transfer
476 requests back to a USB "gadget driver" in the same host. The host
477 side is the master; the gadget side is the slave. Gadget drivers
478 can be high, full, or low speed; and they have access to endpoints
479 like those from NET2280, PXA2xx, or SA1100 hardware.
481 This may help in some stages of creating a driver to embed in a
482 Linux device, since it lets you debug several parts of the gadget
483 driver without its hardware or drivers being involved.
485 Since such a gadget side driver needs to interoperate with a host
486 side Linux-USB device driver, this may help to debug both sides
487 of a USB protocol stack.
489 Say "y" to link the driver statically, or "m" to build a
490 dynamically linked module called "dummy_hcd" and force all
491 gadget drivers to also be dynamically linked.
495 depends on USB_GADGET_DUMMY_HCD
497 select USB_GADGET_SELECTED
499 # NOTE: Please keep dummy_hcd LAST so that "real hardware" appears
500 # first and will be selected by default.
504 config USB_GADGET_DUALSPEED
506 depends on USB_GADGET
509 Means that gadget drivers should include extra descriptors
510 and code to handle dual-speed controllers.
516 tristate "USB Gadget Drivers"
517 depends on USB_GADGET && USB_GADGET_SELECTED
520 A Linux "Gadget Driver" talks to the USB Peripheral Controller
521 driver through the abstract "gadget" API. Some other operating
522 systems call these "client" drivers, of which "class drivers"
523 are a subset (implementing a USB device class specification).
524 A gadget driver implements one or more USB functions using
525 the peripheral hardware.
527 Gadget drivers are hardware-neutral, or "platform independent",
528 except that they sometimes must understand quirks or limitations
529 of the particular controllers they work with. For example, when
530 a controller doesn't support alternate configurations or provide
531 enough of the right types of endpoints, the gadget driver might
532 not be able work with that controller, or might need to implement
533 a less common variant of a device class protocol.
535 # this first set of drivers all depend on bulk-capable hardware.
538 tristate "Gadget Zero (DEVELOPMENT)"
540 Gadget Zero is a two-configuration device. It either sinks and
541 sources bulk data; or it loops back a configurable number of
542 transfers. It also implements control requests, for "chapter 9"
543 conformance. The driver needs only two bulk-capable endpoints, so
544 it can work on top of most device-side usb controllers. It's
545 useful for testing, and is also a working example showing how
546 USB "gadget drivers" can be written.
548 Make this be the first driver you try using on top of any new
549 USB peripheral controller driver. Then you can use host-side
550 test software, like the "usbtest" driver, to put your hardware
551 and its driver through a basic set of functional tests.
553 Gadget Zero also works with the host-side "usb-skeleton" driver,
554 and with many kinds of host-side test software. You may need
555 to tweak product and vendor IDs before host software knows about
556 this device, and arrange to select an appropriate configuration.
558 Say "y" to link the driver statically, or "m" to build a
559 dynamically linked module called "g_zero".
561 config USB_ZERO_HNPTEST
562 boolean "HNP Test Device"
563 depends on USB_ZERO && USB_OTG
565 You can configure this device to enumerate using the device
566 identifiers of the USB-OTG test device. That means that when
567 this gadget connects to another OTG device, with this one using
568 the "B-Peripheral" role, that device will use HNP to let this
569 one serve as the USB host instead (in the "B-Host" role).
572 tristate "Ethernet Gadget (with CDC Ethernet support)"
575 This driver implements Ethernet style communication, in either
578 - The "Communication Device Class" (CDC) Ethernet Control Model.
579 That protocol is often avoided with pure Ethernet adapters, in
580 favor of simpler vendor-specific hardware, but is widely
581 supported by firmware for smart network devices.
583 - On hardware can't implement that protocol, a simple CDC subset
584 is used, placing fewer demands on USB.
586 RNDIS support is a third option, more demanding than that subset.
588 Within the USB device, this gadget driver exposes a network device
589 "usbX", where X depends on what other networking devices you have.
590 Treat it like a two-node Ethernet link: host, and gadget.
592 The Linux-USB host-side "usbnet" driver interoperates with this
593 driver, so that deep I/O queues can be supported. On 2.4 kernels,
594 use "CDCEther" instead, if you're using the CDC option. That CDC
595 mode should also interoperate with standard CDC Ethernet class
596 drivers on other host operating systems.
598 Say "y" to link the driver statically, or "m" to build a
599 dynamically linked module called "g_ether".
606 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
607 and Microsoft provides redistributable binary RNDIS drivers for
608 older versions of Windows.
610 If you say "y" here, the Ethernet gadget driver will try to provide
611 a second device configuration, supporting RNDIS to talk to such
614 To make MS-Windows work with this, use Documentation/usb/linux.inf
615 as the "driver info file". For versions of MS-Windows older than
616 XP, you'll need to download drivers from Microsoft's website; a URL
617 is given in comments found in that info file.
620 tristate "Gadget Filesystem (EXPERIMENTAL)"
621 depends on EXPERIMENTAL
623 This driver provides a filesystem based API that lets user mode
624 programs implement a single-configuration USB device, including
625 endpoint I/O and control requests that don't relate to enumeration.
626 All endpoints, transfer speeds, and transfer types supported by
627 the hardware are available, through read() and write() calls.
629 Currently, this option is still labelled as EXPERIMENTAL because
630 of existing race conditions in the underlying in-kernel AIO core.
632 Say "y" to link the driver statically, or "m" to build a
633 dynamically linked module called "gadgetfs".
635 config USB_FILE_STORAGE
636 tristate "File-backed Storage Gadget"
639 The File-backed Storage Gadget acts as a USB Mass Storage
640 disk drive. As its storage repository it can use a regular
641 file or a block device (in much the same way as the "loop"
642 device driver), specified as a module parameter.
644 Say "y" to link the driver statically, or "m" to build a
645 dynamically linked module called "g_file_storage".
647 config USB_FILE_STORAGE_TEST
648 bool "File-backed Storage Gadget testing version"
649 depends on USB_FILE_STORAGE
652 Say "y" to generate the larger testing version of the
653 File-backed Storage Gadget, useful for probing the
654 behavior of USB Mass Storage hosts. Not needed for
658 tristate "Serial Gadget (with CDC ACM and CDC OBEX support)"
660 The Serial Gadget talks to the Linux-USB generic serial driver.
661 This driver supports a CDC-ACM module option, which can be used
662 to interoperate with MS-Windows hosts or with the Linux-USB
665 This driver also supports a CDC-OBEX option. You will need a
666 user space OBEX server talking to /dev/ttyGS*, since the kernel
667 itself doesn't implement the OBEX protocol.
669 Say "y" to link the driver statically, or "m" to build a
670 dynamically linked module called "g_serial".
672 For more information, see Documentation/usb/gadget_serial.txt
673 which includes instructions and a "driver info file" needed to
674 make MS-Windows work with CDC ACM.
676 config USB_MIDI_GADGET
677 tristate "MIDI Gadget (EXPERIMENTAL)"
678 depends on SND && EXPERIMENTAL
681 The MIDI Gadget acts as a USB Audio device, with one MIDI
682 input and one MIDI output. These MIDI jacks appear as
683 a sound "card" in the ALSA sound system. Other MIDI
684 connections can then be made on the gadget system, using
685 ALSA's aconnect utility etc.
687 Say "y" to link the driver statically, or "m" to build a
688 dynamically linked module called "g_midi".
691 tristate "Printer Gadget"
693 The Printer Gadget channels data between the USB host and a
694 userspace program driving the print engine. The user space
695 program reads and writes the device file /dev/g_printer to
696 receive or send printer data. It can use ioctl calls to
697 the device file to get or set printer status.
699 Say "y" to link the driver statically, or "m" to build a
700 dynamically linked module called "g_printer".
702 For more information, see Documentation/usb/gadget_printer.txt
703 which includes sample code for accessing the device file.
705 config USB_CDC_COMPOSITE
706 tristate "CDC Composite Device (Ethernet and ACM)"
709 This driver provides two functions in one configuration:
710 a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link.
712 This driver requires four bulk and two interrupt endpoints,
713 plus the ability to handle altsettings. Not all peripheral
714 controllers are that capable.
716 Say "y" to link the driver statically, or "m" to build a
717 dynamically linked module.
719 # put drivers that need isochronous transfer support (for audio
720 # or video class gadget drivers), or specific hardware, here.