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"
20 USB is a master/slave protocol, organized with one master
21 host (such as a PC) controlling up to 127 peripheral devices.
22 The USB hardware is asymmetric, which makes it easier to set up:
23 you can't connect a "to-the-host" connector to a peripheral.
25 Linux can run in the host, or in the peripheral. In both cases
26 you need a low level bus controller driver, and some software
27 talking to it. Peripheral controllers are often discrete silicon,
28 or are integrated with the CPU in a microcontroller. The more
29 familiar host side controllers have names like "EHCI", "OHCI",
30 or "UHCI", and are usually integrated into southbridges on PC
33 Enable this configuration option if you want to run Linux inside
34 a USB peripheral device. Configure one hardware driver for your
35 peripheral/device side bus controller, and a "gadget driver" for
36 your peripheral protocol. (If you use modular gadget drivers,
37 you may configure more than one.)
39 If in doubt, say "N" and don't enable these drivers; most people
40 don't have this kind of hardware (except maybe inside Linux PDAs).
42 For more information, see <http://www.linux-usb.org/gadget> and
43 the kernel DocBook documentation for this API.
47 config USB_GADGET_DEBUG
48 boolean "Debugging messages (DEVELOPMENT)"
49 depends on DEBUG_KERNEL
51 Many controller and gadget drivers will print some debugging
52 messages if you use this option to ask for those messages.
54 Avoid enabling these messages, even if you're actively
55 debugging such a driver. Many drivers will emit so many
56 messages that the driver timings are affected, which will
57 either create new failure modes or remove the one you're
58 trying to track down. Never enable these messages for a
61 config USB_GADGET_DEBUG_FILES
62 boolean "Debugging information files (DEVELOPMENT)"
65 Some of the drivers in the "gadget" framework can expose
66 debugging information in files such as /proc/driver/udc
67 (for a peripheral controller). The information in these
68 files may help when you're troubleshooting or bringing up a
69 driver on a new board. Enable these files by choosing "Y"
70 here. If in doubt, or to conserve kernel memory, say "N".
72 config USB_GADGET_DEBUG_FS
73 boolean "Debugging information files in debugfs (DEVELOPMENT)"
76 Some of the drivers in the "gadget" framework can expose
77 debugging information in files under /sys/kernel/debug/.
78 The information in these files may help when you're
79 troubleshooting or bringing up a driver on a new board.
80 Enable these files by choosing "Y" here. If in doubt, or
81 to conserve kernel memory, say "N".
83 config USB_GADGET_VBUS_DRAW
84 int "Maximum VBUS Power usage (2-500 mA)"
88 Some devices need to draw power from USB when they are
89 configured, perhaps to operate circuitry or to recharge
90 batteries. This is in addition to any local power supply,
91 such as an AC adapter or batteries.
93 Enter the maximum power your device draws through USB, in
94 milliAmperes. The permitted range of values is 2 - 500 mA;
95 0 mA would be legal, but can make some hosts misbehave.
97 This value will be used except for system-specific gadget
98 drivers that have more specific information.
100 config USB_GADGET_STORAGE_NUM_BUFFERS
101 int "Number of storage pipeline buffers"
105 Usually 2 buffers are enough to establish a good buffering
106 pipeline. The number may be increased in order to compensate
107 for a bursty VFS behaviour. For instance there may be CPU wake up
108 latencies that makes the VFS to appear bursty in a system with
109 an CPU on-demand governor. Especially if DMA is doing IO to
110 offload the CPU. In this case the CPU will go into power
111 save often and spin up occasionally to move data within VFS.
112 If selecting USB_GADGET_DEBUG_FILES this value may be set by
113 a module parameter as well.
117 # USB Peripheral Controller Support
119 # The order here is alphabetical, except that integrated controllers go
120 # before discrete ones so they will be the initial/default value:
121 # - integrated/SOC controllers first
122 # - licensed IP used in both SOC and discrete versions
123 # - discrete ones (including all PCI-only controllers)
124 # - debug/dummy gadget+hcd is last.
126 menu "USB Peripheral Controller"
129 # Integrated controllers
133 tristate "Atmel AT91 USB Device Port"
136 Many Atmel AT91 processors (such as the AT91RM2000) have a
137 full speed USB Device Port with support for five configurable
138 endpoints (plus endpoint zero).
140 Say "y" to link the driver statically, or "m" to build a
141 dynamically linked module called "at91_udc" and force all
142 gadget drivers to also be dynamically linked.
145 tristate "LPC32XX USB Peripheral Controller"
146 depends on ARCH_LPC32XX
149 This option selects the USB device controller in the LPC32xx SoC.
151 Say "y" to link the driver statically, or "m" to build a
152 dynamically linked module called "lpc32xx_udc" and force all
153 gadget drivers to also be dynamically linked.
155 config USB_ATMEL_USBA
156 tristate "Atmel USBA"
157 depends on AVR32 || ARCH_AT91
159 USBA is the integrated high-speed USB Device controller on
160 the AT32AP700x, some AT91SAM9 and AT91CAP9 processors from Atmel.
162 config USB_BCM63XX_UDC
163 tristate "Broadcom BCM63xx Peripheral Controller"
166 Many Broadcom BCM63xx chipsets (such as the BCM6328) have a
167 high speed USB Device Port with support for four fixed endpoints
168 (plus endpoint zero).
170 Say "y" to link the driver statically, or "m" to build a
171 dynamically linked module called "bcm63xx_udc".
174 tristate "Freescale Highspeed USB DR Peripheral Controller"
175 depends on FSL_SOC || ARCH_MXC
176 select USB_FSL_MPH_DR_OF if OF
178 Some of Freescale PowerPC and i.MX processors have a High Speed
179 Dual-Role(DR) USB controller, which supports device mode.
181 The number of programmable endpoints is different through
184 Say "y" to link the driver statically, or "m" to build a
185 dynamically linked module called "fsl_usb2_udc" and force
186 all gadget drivers to also be dynamically linked.
189 tristate "Faraday FUSB300 USB Peripheral Controller"
190 depends on !PHYS_ADDR_T_64BIT && HAS_DMA
192 Faraday usb device controller FUSB300 driver
194 config USB_FOTG210_UDC
196 tristate "Faraday FOTG210 USB Peripheral Controller"
198 Faraday USB2.0 OTG controller which can be configured as
199 high speed or full speed USB device. This driver supppors
200 Bulk Transfer so far.
202 Say "y" to link the driver statically, or "m" to build a
203 dynamically linked module called "fotg210_udc".
206 tristate "OMAP USB Device Controller"
207 depends on ARCH_OMAP1
208 select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3 || MACH_OMAP_H4_OTG
210 Many Texas Instruments OMAP processors have flexible full
211 speed USB device controllers, with support for up to 30
212 endpoints (plus endpoint zero). This driver supports the
213 controller in the OMAP 1611, and should work with controllers
214 in other OMAP processors too, given minor tweaks.
216 Say "y" to link the driver statically, or "m" to build a
217 dynamically linked module called "omap_udc" and force all
218 gadget drivers to also be dynamically linked.
221 tristate "PXA 25x or IXP 4xx"
222 depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX
224 Intel's PXA 25x series XScale ARM-5TE processors include
225 an integrated full speed USB 1.1 device controller. The
226 controller in the IXP 4xx series is register-compatible.
228 It has fifteen fixed-function endpoints, as well as endpoint
229 zero (for control transfers).
231 Say "y" to link the driver statically, or "m" to build a
232 dynamically linked module called "pxa25x_udc" and force all
233 gadget drivers to also be dynamically linked.
235 # if there's only one gadget driver, using only two bulk endpoints,
236 # don't waste memory for the other endpoints
237 config USB_PXA25X_SMALL
238 depends on USB_PXA25X
240 default n if USB_ETH_RNDIS
241 default y if USB_ZERO
243 default y if USB_G_SERIAL
246 tristate "Renesas R8A66597 USB Peripheral Controller"
249 R8A66597 is a discrete USB host and peripheral controller chip that
250 supports both full and high speed USB 2.0 data transfers.
251 It has nine configurable endpoints, and endpoint zero.
253 Say "y" to link the driver statically, or "m" to build a
254 dynamically linked module called "r8a66597_udc" and force all
255 gadget drivers to also be dynamically linked.
257 config USB_RENESAS_USBHS_UDC
258 tristate 'Renesas USBHS controller'
259 depends on USB_RENESAS_USBHS
261 Renesas USBHS is a discrete USB host and peripheral controller chip
262 that supports both full and high speed USB 2.0 data transfers.
263 It has nine or more configurable endpoints, and endpoint zero.
265 Say "y" to link the driver statically, or "m" to build a
266 dynamically linked module called "renesas_usbhs" and force all
267 gadget drivers to also be dynamically linked.
272 Intel's PXA 27x series XScale ARM v5TE processors include
273 an integrated full speed USB 1.1 device controller.
275 It has up to 23 endpoints, as well as endpoint zero (for
278 Say "y" to link the driver statically, or "m" to build a
279 dynamically linked module called "pxa27x_udc" and force all
280 gadget drivers to also be dynamically linked.
283 tristate "S3C HS/OtG USB Device controller"
284 depends on S3C_DEV_USB_HSOTG
286 The Samsung S3C64XX USB2.0 high-speed gadget controller
287 integrated into the S3C64XX series SoC.
290 tristate "S3C2410 USB Device Controller"
291 depends on ARCH_S3C24XX
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
300 config USB_S3C2410_DEBUG
301 boolean "S3C2410 udc debug messages"
302 depends on USB_S3C2410
305 tristate "S3C2416, S3C2443 and S3C2450 USB Device Controller"
306 depends on ARCH_S3C24XX
308 Samsung's S3C2416, S3C2443 and S3C2450 is an ARM9 based SoC
309 integrated with dual speed USB 2.0 device controller. It has
310 8 endpoints, as well as endpoint zero.
312 This driver has been tested on S3C2416 and S3C2450 processors.
315 tristate "Marvell USB2.0 Device Controller"
318 Marvell Socs (including PXA and MMP series) include a high speed
319 USB2.0 OTG controller, which can be configured as high speed or
320 full speed USB peripheral.
324 tristate "MARVELL PXA2128 USB 3.0 controller"
326 MARVELL PXA2128 Processor series include a super speed USB3.0 device
327 controller, which support super speed USB peripheral.
330 # Controllers available in both integrated and discrete versions
334 tristate "Renesas M66592 USB Peripheral Controller"
336 M66592 is a discrete USB peripheral controller chip that
337 supports both full and high speed USB 2.0 data transfers.
338 It has seven configurable endpoints, and endpoint zero.
340 Say "y" to link the driver statically, or "m" to build a
341 dynamically linked module called "m66592_udc" and force all
342 gadget drivers to also be dynamically linked.
345 # Controllers available only in discrete form (and all PCI controllers)
348 config USB_AMD5536UDC
349 tristate "AMD5536 UDC"
352 The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
353 It is a USB Highspeed DMA capable USB device controller. Beside ep0
354 it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
355 The UDC port supports OTG operation, and may be used as a host port
356 if it's not being used to implement peripheral or OTG roles.
358 Say "y" to link the driver statically, or "m" to build a
359 dynamically linked module called "amd5536udc" and force all
360 gadget drivers to also be dynamically linked.
363 tristate "Freescale QE/CPM USB Device Controller"
364 depends on FSL_SOC && (QUICC_ENGINE || CPM)
366 Some of Freescale PowerPC processors have a Full Speed
367 QE/CPM2 USB controller, which support device mode with 4
368 programmable endpoints. This driver supports the
369 controller in the MPC8360 and MPC8272, and should work with
370 controllers having QE or CPM2, given minor tweaks.
372 Set CONFIG_USB_GADGET to "m" to build this driver as a
373 dynamically linked module called "fsl_qe_udc".
376 tristate "PLX NET2272"
378 PLX NET2272 is a USB peripheral controller which supports
379 both full and high speed USB 2.0 data transfers.
381 It has three configurable endpoints, as well as endpoint zero
382 (for control transfer).
383 Say "y" to link the driver statically, or "m" to build a
384 dynamically linked module called "net2272" and force all
385 gadget drivers to also be dynamically linked.
387 config USB_NET2272_DMA
388 boolean "Support external DMA controller"
389 depends on USB_NET2272 && HAS_DMA
391 The NET2272 part can optionally support an external DMA
392 controller, but your board has to have support in the
395 If unsure, say "N" here. The driver works fine in PIO mode.
398 tristate "NetChip 228x"
401 NetChip 2280 / 2282 is a PCI based USB peripheral controller which
402 supports both full and high speed USB 2.0 data transfers.
404 It has six configurable endpoints, as well as endpoint zero
405 (for control transfers) and several endpoints with dedicated
408 Say "y" to link the driver statically, or "m" to build a
409 dynamically linked module called "net2280" and force all
410 gadget drivers to also be dynamically linked.
413 tristate "Toshiba TC86C001 'Goku-S'"
416 The Toshiba TC86C001 is a PCI device which includes controllers
417 for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
419 The device controller has three configurable (bulk or interrupt)
420 endpoints, plus endpoint zero (for control transfers).
422 Say "y" to link the driver statically, or "m" to build a
423 dynamically linked module called "goku_udc" and to force all
424 gadget drivers to also be dynamically linked.
427 tristate "Intel EG20T PCH/LAPIS Semiconductor IOH(ML7213/ML7831) UDC"
430 This is a USB device driver for EG20T PCH.
431 EG20T PCH is the platform controller hub that is used in Intel's
432 general embedded platform. EG20T PCH has USB device interface.
433 Using this interface, it is able to access system devices connected
435 This driver enables USB device function.
436 USB device is a USB peripheral controller which
437 supports both full and high speed USB 2.0 data transfers.
438 This driver supports both control transfer and bulk transfer modes.
439 This driver dose not support interrupt transfer or isochronous
442 This driver also can be used for LAPIS Semiconductor's ML7213 which is
443 for IVI(In-Vehicle Infotainment) use.
444 ML7831 is for general purpose use.
445 ML7213/ML7831 is companion chip for Intel Atom E6xx series.
446 ML7213/ML7831 is completely compatible for Intel EG20T PCH.
449 # LAST -- dummy/emulated controller
453 tristate "Dummy HCD (DEVELOPMENT)"
454 depends on USB=y || (USB=m && USB_GADGET=m)
456 This host controller driver emulates USB, looping all data transfer
457 requests back to a USB "gadget driver" in the same host. The host
458 side is the master; the gadget side is the slave. Gadget drivers
459 can be high, full, or low speed; and they have access to endpoints
460 like those from NET2280, PXA2xx, or SA1100 hardware.
462 This may help in some stages of creating a driver to embed in a
463 Linux device, since it lets you debug several parts of the gadget
464 driver without its hardware or drivers being involved.
466 Since such a gadget side driver needs to interoperate with a host
467 side Linux-USB device driver, this may help to debug both sides
468 of a USB protocol stack.
470 Say "y" to link the driver statically, or "m" to build a
471 dynamically linked module called "dummy_hcd" and force all
472 gadget drivers to also be dynamically linked.
474 # NOTE: Please keep dummy_hcd LAST so that "real hardware" appears
475 # first and will be selected by default.
483 # composite based drivers
484 config USB_LIBCOMPOSITE
487 depends on USB_GADGET
532 tristate "USB Gadget Drivers"
535 A Linux "Gadget Driver" talks to the USB Peripheral Controller
536 driver through the abstract "gadget" API. Some other operating
537 systems call these "client" drivers, of which "class drivers"
538 are a subset (implementing a USB device class specification).
539 A gadget driver implements one or more USB functions using
540 the peripheral hardware.
542 Gadget drivers are hardware-neutral, or "platform independent",
543 except that they sometimes must understand quirks or limitations
544 of the particular controllers they work with. For example, when
545 a controller doesn't support alternate configurations or provide
546 enough of the right types of endpoints, the gadget driver might
547 not be able work with that controller, or might need to implement
548 a less common variant of a device class protocol.
550 # this first set of drivers all depend on bulk-capable hardware.
553 tristate "USB functions configurable through configfs"
554 select USB_LIBCOMPOSITE
556 A Linux USB "gadget" can be set up through configfs.
557 If this is the case, the USB functions (which from the host's
558 perspective are seen as interfaces) and configurations are
559 specified simply by creating appropriate directories in configfs.
560 Associating functions with configurations is done by creating
561 appropriate symbolic links.
562 For more information see Documentation/usb/gadget_configfs.txt.
564 config USB_CONFIGFS_SERIAL
565 boolean "Generic serial bulk in/out"
566 depends on USB_CONFIGFS
571 The function talks to the Linux-USB generic serial driver.
573 config USB_CONFIGFS_ACM
574 boolean "Abstract Control Model (CDC ACM)"
575 depends on USB_CONFIGFS
580 ACM serial link. This function can be used to interoperate with
581 MS-Windows hosts or with the Linux-USB "cdc-acm" driver.
583 config USB_CONFIGFS_OBEX
584 boolean "Object Exchange Model (CDC OBEX)"
585 depends on USB_CONFIGFS
590 You will need a user space OBEX server talking to /dev/ttyGS*,
591 since the kernel itself doesn't implement the OBEX protocol.
593 config USB_CONFIGFS_NCM
594 boolean "Network Control Model (CDC NCM)"
595 depends on USB_CONFIGFS
600 NCM is an advanced protocol for Ethernet encapsulation, allows
601 grouping of several ethernet frames into one USB transfer and
602 different alignment possibilities.
604 config USB_CONFIGFS_ECM
605 boolean "Ethernet Control Model (CDC ECM)"
606 depends on USB_CONFIGFS
611 The "Communication Device Class" (CDC) Ethernet Control Model.
612 That protocol is often avoided with pure Ethernet adapters, in
613 favor of simpler vendor-specific hardware, but is widely
614 supported by firmware for smart network devices.
616 config USB_CONFIGFS_ECM_SUBSET
617 boolean "Ethernet Control Model (CDC ECM) subset"
618 depends on USB_CONFIGFS
623 On hardware that can't implement the full protocol,
624 a simple CDC subset is used, placing fewer demands on USB.
626 config USB_CONFIGFS_RNDIS
628 depends on USB_CONFIGFS
634 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
635 and Microsoft provides redistributable binary RNDIS drivers for
636 older versions of Windows.
638 To make MS-Windows work with this, use Documentation/usb/linux.inf
639 as the "driver info file". For versions of MS-Windows older than
640 XP, you'll need to download drivers from Microsoft's website; a URL
641 is given in comments found in that info file.
643 config USB_CONFIGFS_EEM
644 bool "Ethernet Emulation Model (EEM)"
645 depends on USB_CONFIGFS
650 CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM
651 and therefore can be supported by more hardware. Technically ECM and
652 EEM are designed for different applications. The ECM model extends
653 the network interface to the target (e.g. a USB cable modem), and the
654 EEM model is for mobile devices to communicate with hosts using
655 ethernet over USB. For Linux gadgets, however, the interface with
656 the host is the same (a usbX device), so the differences are minimal.
658 config USB_CONFIGFS_PHONET
659 boolean "Phonet protocol"
660 depends on USB_CONFIGFS
666 The Phonet protocol implementation for USB device.
669 tristate "Gadget Zero (DEVELOPMENT)"
670 select USB_LIBCOMPOSITE
673 Gadget Zero is a two-configuration device. It either sinks and
674 sources bulk data; or it loops back a configurable number of
675 transfers. It also implements control requests, for "chapter 9"
676 conformance. The driver needs only two bulk-capable endpoints, so
677 it can work on top of most device-side usb controllers. It's
678 useful for testing, and is also a working example showing how
679 USB "gadget drivers" can be written.
681 Make this be the first driver you try using on top of any new
682 USB peripheral controller driver. Then you can use host-side
683 test software, like the "usbtest" driver, to put your hardware
684 and its driver through a basic set of functional tests.
686 Gadget Zero also works with the host-side "usb-skeleton" driver,
687 and with many kinds of host-side test software. You may need
688 to tweak product and vendor IDs before host software knows about
689 this device, and arrange to select an appropriate configuration.
691 Say "y" to link the driver statically, or "m" to build a
692 dynamically linked module called "g_zero".
694 config USB_ZERO_HNPTEST
695 boolean "HNP Test Device"
696 depends on USB_ZERO && USB_OTG
698 You can configure this device to enumerate using the device
699 identifiers of the USB-OTG test device. That means that when
700 this gadget connects to another OTG device, with this one using
701 the "B-Peripheral" role, that device will use HNP to let this
702 one serve as the USB host instead (in the "B-Host" role).
705 tristate "Audio Gadget"
707 select USB_LIBCOMPOSITE
710 This Gadget Audio driver is compatible with USB Audio Class
711 specification 2.0. It implements 1 AudioControl interface,
712 1 AudioStreaming Interface each for USB-OUT and USB-IN.
713 Number of channels, sample rate and sample size can be
714 specified as module parameters.
715 This driver doesn't expect any real Audio codec to be present
716 on the device - the audio streams are simply sinked to and
717 sourced from a virtual ALSA sound card created. The user-space
718 application may choose to do whatever it wants with the data
719 received from the USB Host and choose to provide whatever it
720 wants as audio data to the USB Host.
722 Say "y" to link the driver statically, or "m" to build a
723 dynamically linked module called "g_audio".
726 bool "UAC 1.0 (Legacy)"
729 If you instead want older UAC Spec-1.0 driver that also has audio
730 paths hardwired to the Audio codec chip on-board and doesn't work
734 tristate "Ethernet Gadget (with CDC Ethernet support)"
736 select USB_LIBCOMPOSITE
743 This driver implements Ethernet style communication, in one of
746 - The "Communication Device Class" (CDC) Ethernet Control Model.
747 That protocol is often avoided with pure Ethernet adapters, in
748 favor of simpler vendor-specific hardware, but is widely
749 supported by firmware for smart network devices.
751 - On hardware can't implement that protocol, a simple CDC subset
752 is used, placing fewer demands on USB.
754 - CDC Ethernet Emulation Model (EEM) is a newer standard that has
755 a simpler interface that can be used by more USB hardware.
757 RNDIS support is an additional option, more demanding than than
760 Within the USB device, this gadget driver exposes a network device
761 "usbX", where X depends on what other networking devices you have.
762 Treat it like a two-node Ethernet link: host, and gadget.
764 The Linux-USB host-side "usbnet" driver interoperates with this
765 driver, so that deep I/O queues can be supported. On 2.4 kernels,
766 use "CDCEther" instead, if you're using the CDC option. That CDC
767 mode should also interoperate with standard CDC Ethernet class
768 drivers on other host operating systems.
770 Say "y" to link the driver statically, or "m" to build a
771 dynamically linked module called "g_ether".
776 select USB_LIBCOMPOSITE
780 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
781 and Microsoft provides redistributable binary RNDIS drivers for
782 older versions of Windows.
784 If you say "y" here, the Ethernet gadget driver will try to provide
785 a second device configuration, supporting RNDIS to talk to such
788 To make MS-Windows work with this, use Documentation/usb/linux.inf
789 as the "driver info file". For versions of MS-Windows older than
790 XP, you'll need to download drivers from Microsoft's website; a URL
791 is given in comments found in that info file.
794 bool "Ethernet Emulation Model (EEM) support"
796 select USB_LIBCOMPOSITE
800 CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM
801 and therefore can be supported by more hardware. Technically ECM and
802 EEM are designed for different applications. The ECM model extends
803 the network interface to the target (e.g. a USB cable modem), and the
804 EEM model is for mobile devices to communicate with hosts using
805 ethernet over USB. For Linux gadgets, however, the interface with
806 the host is the same (a usbX device), so the differences are minimal.
808 If you say "y" here, the Ethernet gadget driver will use the EEM
809 protocol rather than ECM. If unsure, say "n".
812 tristate "Network Control Model (NCM) support"
814 select USB_LIBCOMPOSITE
819 This driver implements USB CDC NCM subclass standard. NCM is
820 an advanced protocol for Ethernet encapsulation, allows grouping
821 of several ethernet frames into one USB transfer and different
822 alignment possibilities.
824 Say "y" to link the driver statically, or "m" to build a
825 dynamically linked module called "g_ncm".
828 tristate "Gadget Filesystem"
830 This driver provides a filesystem based API that lets user mode
831 programs implement a single-configuration USB device, including
832 endpoint I/O and control requests that don't relate to enumeration.
833 All endpoints, transfer speeds, and transfer types supported by
834 the hardware are available, through read() and write() calls.
836 Say "y" to link the driver statically, or "m" to build a
837 dynamically linked module called "gadgetfs".
839 config USB_FUNCTIONFS
840 tristate "Function Filesystem"
841 select USB_LIBCOMPOSITE
842 select USB_FUNCTIONFS_GENERIC if !(USB_FUNCTIONFS_ETH || USB_FUNCTIONFS_RNDIS)
844 The Function Filesystem (FunctionFS) lets one create USB
845 composite functions in user space in the same way GadgetFS
846 lets one create USB gadgets in user space. This allows creation
847 of composite gadgets such that some of the functions are
848 implemented in kernel space (for instance Ethernet, serial or
849 mass storage) and other are implemented in user space.
851 If you say "y" or "m" here you will be able what kind of
852 configurations the gadget will provide.
854 Say "y" to link the driver statically, or "m" to build
855 a dynamically linked module called "g_ffs".
857 config USB_FUNCTIONFS_ETH
858 bool "Include configuration with CDC ECM (Ethernet)"
859 depends on USB_FUNCTIONFS && NET
862 Include a configuration with CDC ECM function (Ethernet) and the
865 config USB_FUNCTIONFS_RNDIS
866 bool "Include configuration with RNDIS (Ethernet)"
867 depends on USB_FUNCTIONFS && NET
871 Include a configuration with RNDIS function (Ethernet) and the Filesystem.
873 config USB_FUNCTIONFS_GENERIC
874 bool "Include 'pure' configuration"
875 depends on USB_FUNCTIONFS
877 Include a configuration with the Function Filesystem alone with
878 no Ethernet interface.
880 config USB_MASS_STORAGE
881 tristate "Mass Storage Gadget"
883 select USB_LIBCOMPOSITE
886 The Mass Storage Gadget acts as a USB Mass Storage disk drive.
887 As its storage repository it can use a regular file or a block
888 device (in much the same way as the "loop" device driver),
889 specified as a module parameter or sysfs option.
891 This driver is a replacement for now removed File-backed
892 Storage Gadget (g_file_storage).
894 Say "y" to link the driver statically, or "m" to build
895 a dynamically linked module called "g_mass_storage".
897 config USB_GADGET_TARGET
898 tristate "USB Gadget Target Fabric Module"
899 depends on TARGET_CORE
900 select USB_LIBCOMPOSITE
902 This fabric is an USB gadget. Two USB protocols are supported that is
903 BBB or BOT (Bulk Only Transport) and UAS (USB Attached SCSI). BOT is
904 advertised on alternative interface 0 (primary) and UAS is on
905 alternative interface 1. Both protocols can work on USB2.0 and USB3.0.
906 UAS utilizes the USB 3.0 feature called streams support.
909 tristate "Serial Gadget (with CDC ACM and CDC OBEX support)"
915 select USB_LIBCOMPOSITE
917 The Serial Gadget talks to the Linux-USB generic serial driver.
918 This driver supports a CDC-ACM module option, which can be used
919 to interoperate with MS-Windows hosts or with the Linux-USB
922 This driver also supports a CDC-OBEX option. You will need a
923 user space OBEX server talking to /dev/ttyGS*, since the kernel
924 itself doesn't implement the OBEX protocol.
926 Say "y" to link the driver statically, or "m" to build a
927 dynamically linked module called "g_serial".
929 For more information, see Documentation/usb/gadget_serial.txt
930 which includes instructions and a "driver info file" needed to
931 make MS-Windows work with CDC ACM.
933 config USB_MIDI_GADGET
934 tristate "MIDI Gadget"
936 select USB_LIBCOMPOSITE
939 The MIDI Gadget acts as a USB Audio device, with one MIDI
940 input and one MIDI output. These MIDI jacks appear as
941 a sound "card" in the ALSA sound system. Other MIDI
942 connections can then be made on the gadget system, using
943 ALSA's aconnect utility etc.
945 Say "y" to link the driver statically, or "m" to build a
946 dynamically linked module called "g_midi".
949 tristate "Printer Gadget"
950 select USB_LIBCOMPOSITE
952 The Printer Gadget channels data between the USB host and a
953 userspace program driving the print engine. The user space
954 program reads and writes the device file /dev/g_printer to
955 receive or send printer data. It can use ioctl calls to
956 the device file to get or set printer status.
958 Say "y" to link the driver statically, or "m" to build a
959 dynamically linked module called "g_printer".
961 For more information, see Documentation/usb/gadget_printer.txt
962 which includes sample code for accessing the device file.
966 config USB_CDC_COMPOSITE
967 tristate "CDC Composite Device (Ethernet and ACM)"
969 select USB_LIBCOMPOSITE
975 This driver provides two functions in one configuration:
976 a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link.
978 This driver requires four bulk and two interrupt endpoints,
979 plus the ability to handle altsettings. Not all peripheral
980 controllers are that capable.
982 Say "y" to link the driver statically, or "m" to build a
983 dynamically linked module.
986 tristate "Nokia composite gadget"
988 select USB_LIBCOMPOSITE
996 The Nokia composite gadget provides support for acm, obex
997 and phonet in only one composite gadget driver.
999 It's only really useful for N900 hardware. If you're building
1000 a kernel for N900, say Y or M here. If unsure, say N.
1003 tristate "CDC Composite Device (ACM and mass storage)"
1005 select USB_LIBCOMPOSITE
1010 This driver provides two functions in one configuration:
1011 a mass storage, and a CDC ACM (serial port) link.
1013 Say "y" to link the driver statically, or "m" to build a
1014 dynamically linked module called "g_acm_ms".
1017 tristate "Multifunction Composite Gadget"
1018 depends on BLOCK && NET
1019 select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS
1020 select USB_LIBCOMPOSITE
1027 The Multifunction Composite Gadget provides Ethernet (RNDIS
1028 and/or CDC Ethernet), mass storage and ACM serial link
1031 You will be asked to choose which of the two configurations is
1032 to be available in the gadget. At least one configuration must
1033 be chosen to make the gadget usable. Selecting more than one
1034 configuration will prevent Windows from automatically detecting
1035 the gadget as a composite gadget, so an INF file will be needed to
1038 Say "y" to link the driver statically, or "m" to build a
1039 dynamically linked module called "g_multi".
1041 config USB_G_MULTI_RNDIS
1042 bool "RNDIS + CDC Serial + Storage configuration"
1043 depends on USB_G_MULTI
1046 This option enables a configuration with RNDIS, CDC Serial and
1047 Mass Storage functions available in the Multifunction Composite
1048 Gadget. This is the configuration dedicated for Windows since RNDIS
1049 is Microsoft's protocol.
1053 config USB_G_MULTI_CDC
1054 bool "CDC Ethernet + CDC Serial + Storage configuration"
1055 depends on USB_G_MULTI
1058 This option enables a configuration with CDC Ethernet (ECM), CDC
1059 Serial and Mass Storage functions available in the Multifunction
1067 tristate "HID Gadget"
1068 select USB_LIBCOMPOSITE
1070 The HID gadget driver provides generic emulation of USB
1071 Human Interface Devices (HID).
1073 For more information, see Documentation/usb/gadget_hid.txt which
1074 includes sample code for accessing the device files.
1076 Say "y" to link the driver statically, or "m" to build a
1077 dynamically linked module called "g_hid".
1079 # Standalone / single function gadgets
1081 tristate "EHCI Debug Device Gadget"
1083 select USB_LIBCOMPOSITE
1085 This gadget emulates an EHCI Debug device. This is useful when you want
1086 to interact with an EHCI Debug Port.
1088 Say "y" to link the driver statically, or "m" to build a
1089 dynamically linked module called "g_dbgp".
1093 prompt "EHCI Debug Device mode"
1094 default USB_G_DBGP_SERIAL
1096 config USB_G_DBGP_PRINTK
1097 depends on USB_G_DBGP
1100 Directly printk() received data. No interaction.
1102 config USB_G_DBGP_SERIAL
1103 depends on USB_G_DBGP
1107 Userland can interact using /dev/ttyGSxxx.
1111 # put drivers that need isochronous transfer support (for audio
1112 # or video class gadget drivers), or specific hardware, here.
1114 tristate "USB Webcam Gadget"
1115 depends on VIDEO_DEV
1116 select USB_LIBCOMPOSITE
1117 select VIDEOBUF2_VMALLOC
1119 The Webcam Gadget acts as a composite USB Audio and Video Class
1120 device. It provides a userspace API to process UVC control requests
1121 and stream video data to the host.
1123 Say "y" to link the driver statically, or "m" to build a
1124 dynamically linked module called "g_webcam".