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_VERBOSE
62 bool "Verbose debugging Messages (DEVELOPMENT)"
63 depends on USB_GADGET_DEBUG
65 Many controller and gadget drivers will print verbose debugging
66 messages if you use this option to ask for those messages.
68 Avoid enabling these messages, even if you're actively
69 debugging such a driver. Many drivers will emit so many
70 messages that the driver timings are affected, which will
71 either create new failure modes or remove the one you're
72 trying to track down. Never enable these messages for a
75 config USB_GADGET_DEBUG_FILES
76 boolean "Debugging information files (DEVELOPMENT)"
79 Some of the drivers in the "gadget" framework can expose
80 debugging information in files such as /proc/driver/udc
81 (for a peripheral controller). The information in these
82 files may help when you're troubleshooting or bringing up a
83 driver on a new board. Enable these files by choosing "Y"
84 here. If in doubt, or to conserve kernel memory, say "N".
86 config USB_GADGET_DEBUG_FS
87 boolean "Debugging information files in debugfs (DEVELOPMENT)"
90 Some of the drivers in the "gadget" framework can expose
91 debugging information in files under /sys/kernel/debug/.
92 The information in these files may help when you're
93 troubleshooting or bringing up a driver on a new board.
94 Enable these files by choosing "Y" here. If in doubt, or
95 to conserve kernel memory, say "N".
97 config USB_GADGET_VBUS_DRAW
98 int "Maximum VBUS Power usage (2-500 mA)"
102 Some devices need to draw power from USB when they are
103 configured, perhaps to operate circuitry or to recharge
104 batteries. This is in addition to any local power supply,
105 such as an AC adapter or batteries.
107 Enter the maximum power your device draws through USB, in
108 milliAmperes. The permitted range of values is 2 - 500 mA;
109 0 mA would be legal, but can make some hosts misbehave.
111 This value will be used except for system-specific gadget
112 drivers that have more specific information.
114 config USB_GADGET_STORAGE_NUM_BUFFERS
115 int "Number of storage pipeline buffers"
119 Usually 2 buffers are enough to establish a good buffering
120 pipeline. The number may be increased in order to compensate
121 for a bursty VFS behaviour. For instance there may be CPU wake up
122 latencies that makes the VFS to appear bursty in a system with
123 an CPU on-demand governor. Especially if DMA is doing IO to
124 offload the CPU. In this case the CPU will go into power
125 save often and spin up occasionally to move data within VFS.
126 If selecting USB_GADGET_DEBUG_FILES this value may be set by
127 a module parameter as well.
131 # USB Peripheral Controller Support
133 # The order here is alphabetical, except that integrated controllers go
134 # before discrete ones so they will be the initial/default value:
135 # - integrated/SOC controllers first
136 # - licensed IP used in both SOC and discrete versions
137 # - discrete ones (including all PCI-only controllers)
138 # - debug/dummy gadget+hcd is last.
140 menu "USB Peripheral Controller"
143 # Integrated controllers
147 tristate "Atmel AT91 USB Device Port"
150 Many Atmel AT91 processors (such as the AT91RM2000) have a
151 full speed USB Device Port with support for five configurable
152 endpoints (plus endpoint zero).
154 Say "y" to link the driver statically, or "m" to build a
155 dynamically linked module called "at91_udc" and force all
156 gadget drivers to also be dynamically linked.
159 tristate "LPC32XX USB Peripheral Controller"
160 depends on ARCH_LPC32XX
163 This option selects the USB device controller in the LPC32xx SoC.
165 Say "y" to link the driver statically, or "m" to build a
166 dynamically linked module called "lpc32xx_udc" and force all
167 gadget drivers to also be dynamically linked.
169 config USB_ATMEL_USBA
170 tristate "Atmel USBA"
171 depends on AVR32 || ARCH_AT91
173 USBA is the integrated high-speed USB Device controller on
174 the AT32AP700x, some AT91SAM9 and AT91CAP9 processors from Atmel.
176 config USB_BCM63XX_UDC
177 tristate "Broadcom BCM63xx Peripheral Controller"
180 Many Broadcom BCM63xx chipsets (such as the BCM6328) have a
181 high speed USB Device Port with support for four fixed endpoints
182 (plus endpoint zero).
184 Say "y" to link the driver statically, or "m" to build a
185 dynamically linked module called "bcm63xx_udc".
188 tristate "Freescale Highspeed USB DR Peripheral Controller"
189 depends on FSL_SOC || ARCH_MXC
190 select USB_FSL_MPH_DR_OF if OF
192 Some of Freescale PowerPC and i.MX processors have a High Speed
193 Dual-Role(DR) USB controller, which supports device mode.
195 The number of programmable endpoints is different through
198 Say "y" to link the driver statically, or "m" to build a
199 dynamically linked module called "fsl_usb2_udc" and force
200 all gadget drivers to also be dynamically linked.
203 tristate "Faraday FUSB300 USB Peripheral Controller"
204 depends on !PHYS_ADDR_T_64BIT && HAS_DMA
206 Faraday usb device controller FUSB300 driver
208 config USB_FOTG210_UDC
210 tristate "Faraday FOTG210 USB Peripheral Controller"
212 Faraday USB2.0 OTG controller which can be configured as
213 high speed or full speed USB device. This driver supppors
214 Bulk Transfer so far.
216 Say "y" to link the driver statically, or "m" to build a
217 dynamically linked module called "fotg210_udc".
220 tristate "Aeroflex Gaisler GRUSBDC USB Peripheral Controller Driver"
223 Select this to support Aeroflex Gaisler GRUSBDC cores from the GRLIB
224 VHDL IP core library.
227 tristate "OMAP USB Device Controller"
228 depends on ARCH_OMAP1
229 select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3 || MACH_OMAP_H4_OTG
231 Many Texas Instruments OMAP processors have flexible full
232 speed USB device controllers, with support for up to 30
233 endpoints (plus endpoint zero). This driver supports the
234 controller in the OMAP 1611, and should work with controllers
235 in other OMAP processors too, given minor tweaks.
237 Say "y" to link the driver statically, or "m" to build a
238 dynamically linked module called "omap_udc" and force all
239 gadget drivers to also be dynamically linked.
242 tristate "PXA 25x or IXP 4xx"
243 depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX
245 Intel's PXA 25x series XScale ARM-5TE processors include
246 an integrated full speed USB 1.1 device controller. The
247 controller in the IXP 4xx series is register-compatible.
249 It has fifteen fixed-function endpoints, as well as endpoint
250 zero (for control transfers).
252 Say "y" to link the driver statically, or "m" to build a
253 dynamically linked module called "pxa25x_udc" and force all
254 gadget drivers to also be dynamically linked.
256 # if there's only one gadget driver, using only two bulk endpoints,
257 # don't waste memory for the other endpoints
258 config USB_PXA25X_SMALL
259 depends on USB_PXA25X
261 default n if USB_ETH_RNDIS
262 default y if USB_ZERO
264 default y if USB_G_SERIAL
267 tristate "Renesas R8A66597 USB Peripheral Controller"
270 R8A66597 is a discrete USB host and peripheral controller chip that
271 supports both full and high speed USB 2.0 data transfers.
272 It has nine configurable endpoints, and endpoint zero.
274 Say "y" to link the driver statically, or "m" to build a
275 dynamically linked module called "r8a66597_udc" and force all
276 gadget drivers to also be dynamically linked.
278 config USB_RENESAS_USBHS_UDC
279 tristate 'Renesas USBHS controller'
280 depends on USB_RENESAS_USBHS
282 Renesas USBHS is a discrete USB host and peripheral controller chip
283 that supports both full and high speed USB 2.0 data transfers.
284 It has nine or more configurable endpoints, and endpoint zero.
286 Say "y" to link the driver statically, or "m" to build a
287 dynamically linked module called "renesas_usbhs" and force all
288 gadget drivers to also be dynamically linked.
293 Intel's PXA 27x series XScale ARM v5TE processors include
294 an integrated full speed USB 1.1 device controller.
296 It has up to 23 endpoints, as well as endpoint zero (for
299 Say "y" to link the driver statically, or "m" to build a
300 dynamically linked module called "pxa27x_udc" and force all
301 gadget drivers to also be dynamically linked.
305 tristate "Designware/S3C HS/OtG USB Device controller"
307 The Designware USB2.0 high-speed gadget controller
308 integrated into many SoCs.
311 tristate "S3C2410 USB Device Controller"
312 depends on ARCH_S3C24XX
314 Samsung's S3C2410 is an ARM-4 processor with an integrated
315 full speed USB 1.1 device controller. It has 4 configurable
316 endpoints, as well as endpoint zero (for control transfers).
318 This driver has been tested on the S3C2410, S3C2412, and
321 config USB_S3C2410_DEBUG
322 boolean "S3C2410 udc debug messages"
323 depends on USB_S3C2410
326 tristate "S3C2416, S3C2443 and S3C2450 USB Device Controller"
327 depends on ARCH_S3C24XX
329 Samsung's S3C2416, S3C2443 and S3C2450 is an ARM9 based SoC
330 integrated with dual speed USB 2.0 device controller. It has
331 8 endpoints, as well as endpoint zero.
333 This driver has been tested on S3C2416 and S3C2450 processors.
336 tristate "Marvell USB2.0 Device Controller"
339 Marvell Socs (including PXA and MMP series) include a high speed
340 USB2.0 OTG controller, which can be configured as high speed or
341 full speed USB peripheral.
345 tristate "MARVELL PXA2128 USB 3.0 controller"
347 MARVELL PXA2128 Processor series include a super speed USB3.0 device
348 controller, which support super speed USB peripheral.
351 # Controllers available in both integrated and discrete versions
355 tristate "Renesas M66592 USB Peripheral Controller"
357 M66592 is a discrete USB peripheral controller chip that
358 supports both full and high speed USB 2.0 data transfers.
359 It has seven configurable endpoints, and endpoint zero.
361 Say "y" to link the driver statically, or "m" to build a
362 dynamically linked module called "m66592_udc" and force all
363 gadget drivers to also be dynamically linked.
366 # Controllers available only in discrete form (and all PCI controllers)
369 config USB_AMD5536UDC
370 tristate "AMD5536 UDC"
373 The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
374 It is a USB Highspeed DMA capable USB device controller. Beside ep0
375 it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
376 The UDC port supports OTG operation, and may be used as a host port
377 if it's not being used to implement peripheral or OTG roles.
379 Say "y" to link the driver statically, or "m" to build a
380 dynamically linked module called "amd5536udc" and force all
381 gadget drivers to also be dynamically linked.
384 tristate "Freescale QE/CPM USB Device Controller"
385 depends on FSL_SOC && (QUICC_ENGINE || CPM)
387 Some of Freescale PowerPC processors have a Full Speed
388 QE/CPM2 USB controller, which support device mode with 4
389 programmable endpoints. This driver supports the
390 controller in the MPC8360 and MPC8272, and should work with
391 controllers having QE or CPM2, given minor tweaks.
393 Set CONFIG_USB_GADGET to "m" to build this driver as a
394 dynamically linked module called "fsl_qe_udc".
397 tristate "PLX NET2272"
399 PLX NET2272 is a USB peripheral controller which supports
400 both full and high speed USB 2.0 data transfers.
402 It has three configurable endpoints, as well as endpoint zero
403 (for control transfer).
404 Say "y" to link the driver statically, or "m" to build a
405 dynamically linked module called "net2272" and force all
406 gadget drivers to also be dynamically linked.
408 config USB_NET2272_DMA
409 boolean "Support external DMA controller"
410 depends on USB_NET2272 && HAS_DMA
412 The NET2272 part can optionally support an external DMA
413 controller, but your board has to have support in the
416 If unsure, say "N" here. The driver works fine in PIO mode.
419 tristate "NetChip 228x"
422 NetChip 2280 / 2282 is a PCI based USB peripheral controller which
423 supports both full and high speed USB 2.0 data transfers.
425 It has six configurable endpoints, as well as endpoint zero
426 (for control transfers) and several endpoints with dedicated
429 Say "y" to link the driver statically, or "m" to build a
430 dynamically linked module called "net2280" and force all
431 gadget drivers to also be dynamically linked.
434 tristate "Toshiba TC86C001 'Goku-S'"
437 The Toshiba TC86C001 is a PCI device which includes controllers
438 for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
440 The device controller has three configurable (bulk or interrupt)
441 endpoints, plus endpoint zero (for control transfers).
443 Say "y" to link the driver statically, or "m" to build a
444 dynamically linked module called "goku_udc" and to force all
445 gadget drivers to also be dynamically linked.
448 tristate "Intel QUARK X1000/EG20T PCH/LAPIS Semiconductor IOH(ML7213/ML7831) UDC"
451 This is a USB device driver for EG20T PCH.
452 EG20T PCH is the platform controller hub that is used in Intel's
453 general embedded platform. EG20T PCH has USB device interface.
454 Using this interface, it is able to access system devices connected
456 This driver enables USB device function.
457 USB device is a USB peripheral controller which
458 supports both full and high speed USB 2.0 data transfers.
459 This driver supports both control transfer and bulk transfer modes.
460 This driver dose not support interrupt transfer or isochronous
463 This driver also can be used for LAPIS Semiconductor's ML7213 which is
464 for IVI(In-Vehicle Infotainment) use.
465 ML7831 is for general purpose use.
466 ML7213/ML7831 is companion chip for Intel Atom E6xx series.
467 ML7213/ML7831 is completely compatible for Intel EG20T PCH.
469 This driver can be used with Intel's Quark X1000 SOC platform
471 # LAST -- dummy/emulated controller
475 tristate "Dummy HCD (DEVELOPMENT)"
476 depends on USB=y || (USB=m && USB_GADGET=m)
478 This host controller driver emulates USB, looping all data transfer
479 requests back to a USB "gadget driver" in the same host. The host
480 side is the master; the gadget side is the slave. Gadget drivers
481 can be high, full, or low speed; and they have access to endpoints
482 like those from NET2280, PXA2xx, or SA1100 hardware.
484 This may help in some stages of creating a driver to embed in a
485 Linux device, since it lets you debug several parts of the gadget
486 driver without its hardware or drivers being involved.
488 Since such a gadget side driver needs to interoperate with a host
489 side Linux-USB device driver, this may help to debug both sides
490 of a USB protocol stack.
492 Say "y" to link the driver statically, or "m" to build a
493 dynamically linked module called "dummy_hcd" and force all
494 gadget drivers to also be dynamically linked.
496 # NOTE: Please keep dummy_hcd LAST so that "real hardware" appears
497 # first and will be selected by default.
505 # composite based drivers
506 config USB_LIBCOMPOSITE
509 depends on USB_GADGET
547 config USB_F_MASS_STORAGE
554 tristate "USB Gadget Drivers"
557 A Linux "Gadget Driver" talks to the USB Peripheral Controller
558 driver through the abstract "gadget" API. Some other operating
559 systems call these "client" drivers, of which "class drivers"
560 are a subset (implementing a USB device class specification).
561 A gadget driver implements one or more USB functions using
562 the peripheral hardware.
564 Gadget drivers are hardware-neutral, or "platform independent",
565 except that they sometimes must understand quirks or limitations
566 of the particular controllers they work with. For example, when
567 a controller doesn't support alternate configurations or provide
568 enough of the right types of endpoints, the gadget driver might
569 not be able work with that controller, or might need to implement
570 a less common variant of a device class protocol.
572 # this first set of drivers all depend on bulk-capable hardware.
575 tristate "USB functions configurable through configfs"
576 select USB_LIBCOMPOSITE
578 A Linux USB "gadget" can be set up through configfs.
579 If this is the case, the USB functions (which from the host's
580 perspective are seen as interfaces) and configurations are
581 specified simply by creating appropriate directories in configfs.
582 Associating functions with configurations is done by creating
583 appropriate symbolic links.
584 For more information see Documentation/usb/gadget_configfs.txt.
586 config USB_CONFIGFS_SERIAL
587 boolean "Generic serial bulk in/out"
588 depends on USB_CONFIGFS
593 The function talks to the Linux-USB generic serial driver.
595 config USB_CONFIGFS_ACM
596 boolean "Abstract Control Model (CDC ACM)"
597 depends on USB_CONFIGFS
602 ACM serial link. This function can be used to interoperate with
603 MS-Windows hosts or with the Linux-USB "cdc-acm" driver.
605 config USB_CONFIGFS_OBEX
606 boolean "Object Exchange Model (CDC OBEX)"
607 depends on USB_CONFIGFS
612 You will need a user space OBEX server talking to /dev/ttyGS*,
613 since the kernel itself doesn't implement the OBEX protocol.
615 config USB_CONFIGFS_NCM
616 boolean "Network Control Model (CDC NCM)"
617 depends on USB_CONFIGFS
622 NCM is an advanced protocol for Ethernet encapsulation, allows
623 grouping of several ethernet frames into one USB transfer and
624 different alignment possibilities.
626 config USB_CONFIGFS_ECM
627 boolean "Ethernet Control Model (CDC ECM)"
628 depends on USB_CONFIGFS
633 The "Communication Device Class" (CDC) Ethernet Control Model.
634 That protocol is often avoided with pure Ethernet adapters, in
635 favor of simpler vendor-specific hardware, but is widely
636 supported by firmware for smart network devices.
638 config USB_CONFIGFS_ECM_SUBSET
639 boolean "Ethernet Control Model (CDC ECM) subset"
640 depends on USB_CONFIGFS
645 On hardware that can't implement the full protocol,
646 a simple CDC subset is used, placing fewer demands on USB.
648 config USB_CONFIGFS_RNDIS
650 depends on USB_CONFIGFS
655 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
656 and Microsoft provides redistributable binary RNDIS drivers for
657 older versions of Windows.
659 To make MS-Windows work with this, use Documentation/usb/linux.inf
660 as the "driver info file". For versions of MS-Windows older than
661 XP, you'll need to download drivers from Microsoft's website; a URL
662 is given in comments found in that info file.
664 config USB_CONFIGFS_EEM
665 bool "Ethernet Emulation Model (EEM)"
666 depends on USB_CONFIGFS
671 CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM
672 and therefore can be supported by more hardware. Technically ECM and
673 EEM are designed for different applications. The ECM model extends
674 the network interface to the target (e.g. a USB cable modem), and the
675 EEM model is for mobile devices to communicate with hosts using
676 ethernet over USB. For Linux gadgets, however, the interface with
677 the host is the same (a usbX device), so the differences are minimal.
679 config USB_CONFIGFS_PHONET
680 boolean "Phonet protocol"
681 depends on USB_CONFIGFS
687 The Phonet protocol implementation for USB device.
689 config USB_CONFIGFS_MASS_STORAGE
690 boolean "Mass storage"
691 depends on USB_CONFIGFS
693 select USB_F_MASS_STORAGE
695 The Mass Storage Gadget acts as a USB Mass Storage disk drive.
696 As its storage repository it can use a regular file or a block
697 device (in much the same way as the "loop" device driver),
698 specified as a module parameter or sysfs option.
700 config USB_CONFIGFS_F_LB_SS
701 boolean "Loopback and sourcesink function (for testing)"
702 depends on USB_CONFIGFS
705 Loopback function loops back a configurable number of transfers.
706 Sourcesink function either sinks and sources bulk data.
707 It also implements control requests, for "chapter 9" conformance.
708 Make this be the first driver you try using on top of any new
709 USB peripheral controller driver. Then you can use host-side
710 test software, like the "usbtest" driver, to put your hardware
711 and its driver through a basic set of functional tests.
713 config USB_CONFIGFS_F_FS
714 boolean "Function filesystem (FunctionFS)"
715 depends on USB_CONFIGFS
718 The Function Filesystem (FunctionFS) lets one create USB
719 composite functions in user space in the same way GadgetFS
720 lets one create USB gadgets in user space. This allows creation
721 of composite gadgets such that some of the functions are
722 implemented in kernel space (for instance Ethernet, serial or
723 mass storage) and other are implemented in user space.
726 tristate "Gadget Zero (DEVELOPMENT)"
727 select USB_LIBCOMPOSITE
730 Gadget Zero is a two-configuration device. It either sinks and
731 sources bulk data; or it loops back a configurable number of
732 transfers. It also implements control requests, for "chapter 9"
733 conformance. The driver needs only two bulk-capable endpoints, so
734 it can work on top of most device-side usb controllers. It's
735 useful for testing, and is also a working example showing how
736 USB "gadget drivers" can be written.
738 Make this be the first driver you try using on top of any new
739 USB peripheral controller driver. Then you can use host-side
740 test software, like the "usbtest" driver, to put your hardware
741 and its driver through a basic set of functional tests.
743 Gadget Zero also works with the host-side "usb-skeleton" driver,
744 and with many kinds of host-side test software. You may need
745 to tweak product and vendor IDs before host software knows about
746 this device, and arrange to select an appropriate configuration.
748 Say "y" to link the driver statically, or "m" to build a
749 dynamically linked module called "g_zero".
751 config USB_ZERO_HNPTEST
752 boolean "HNP Test Device"
753 depends on USB_ZERO && USB_OTG
755 You can configure this device to enumerate using the device
756 identifiers of the USB-OTG test device. That means that when
757 this gadget connects to another OTG device, with this one using
758 the "B-Peripheral" role, that device will use HNP to let this
759 one serve as the USB host instead (in the "B-Host" role).
762 tristate "Audio Gadget"
764 select USB_LIBCOMPOSITE
767 This Gadget Audio driver is compatible with USB Audio Class
768 specification 2.0. It implements 1 AudioControl interface,
769 1 AudioStreaming Interface each for USB-OUT and USB-IN.
770 Number of channels, sample rate and sample size can be
771 specified as module parameters.
772 This driver doesn't expect any real Audio codec to be present
773 on the device - the audio streams are simply sinked to and
774 sourced from a virtual ALSA sound card created. The user-space
775 application may choose to do whatever it wants with the data
776 received from the USB Host and choose to provide whatever it
777 wants as audio data to the USB Host.
779 Say "y" to link the driver statically, or "m" to build a
780 dynamically linked module called "g_audio".
783 bool "UAC 1.0 (Legacy)"
786 If you instead want older UAC Spec-1.0 driver that also has audio
787 paths hardwired to the Audio codec chip on-board and doesn't work
791 tristate "Ethernet Gadget (with CDC Ethernet support)"
793 select USB_LIBCOMPOSITE
799 This driver implements Ethernet style communication, in one of
802 - The "Communication Device Class" (CDC) Ethernet Control Model.
803 That protocol is often avoided with pure Ethernet adapters, in
804 favor of simpler vendor-specific hardware, but is widely
805 supported by firmware for smart network devices.
807 - On hardware can't implement that protocol, a simple CDC subset
808 is used, placing fewer demands on USB.
810 - CDC Ethernet Emulation Model (EEM) is a newer standard that has
811 a simpler interface that can be used by more USB hardware.
813 RNDIS support is an additional option, more demanding than than
816 Within the USB device, this gadget driver exposes a network device
817 "usbX", where X depends on what other networking devices you have.
818 Treat it like a two-node Ethernet link: host, and gadget.
820 The Linux-USB host-side "usbnet" driver interoperates with this
821 driver, so that deep I/O queues can be supported. On 2.4 kernels,
822 use "CDCEther" instead, if you're using the CDC option. That CDC
823 mode should also interoperate with standard CDC Ethernet class
824 drivers on other host operating systems.
826 Say "y" to link the driver statically, or "m" to build a
827 dynamically linked module called "g_ether".
832 select USB_LIBCOMPOSITE
836 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
837 and Microsoft provides redistributable binary RNDIS drivers for
838 older versions of Windows.
840 If you say "y" here, the Ethernet gadget driver will try to provide
841 a second device configuration, supporting RNDIS to talk to such
844 To make MS-Windows work with this, use Documentation/usb/linux.inf
845 as the "driver info file". For versions of MS-Windows older than
846 XP, you'll need to download drivers from Microsoft's website; a URL
847 is given in comments found in that info file.
850 bool "Ethernet Emulation Model (EEM) support"
852 select USB_LIBCOMPOSITE
856 CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM
857 and therefore can be supported by more hardware. Technically ECM and
858 EEM are designed for different applications. The ECM model extends
859 the network interface to the target (e.g. a USB cable modem), and the
860 EEM model is for mobile devices to communicate with hosts using
861 ethernet over USB. For Linux gadgets, however, the interface with
862 the host is the same (a usbX device), so the differences are minimal.
864 If you say "y" here, the Ethernet gadget driver will use the EEM
865 protocol rather than ECM. If unsure, say "n".
868 tristate "Network Control Model (NCM) support"
870 select USB_LIBCOMPOSITE
875 This driver implements USB CDC NCM subclass standard. NCM is
876 an advanced protocol for Ethernet encapsulation, allows grouping
877 of several ethernet frames into one USB transfer and different
878 alignment possibilities.
880 Say "y" to link the driver statically, or "m" to build a
881 dynamically linked module called "g_ncm".
884 tristate "Gadget Filesystem"
886 This driver provides a filesystem based API that lets user mode
887 programs implement a single-configuration USB device, including
888 endpoint I/O and control requests that don't relate to enumeration.
889 All endpoints, transfer speeds, and transfer types supported by
890 the hardware are available, through read() and write() calls.
892 Say "y" to link the driver statically, or "m" to build a
893 dynamically linked module called "gadgetfs".
895 config USB_FUNCTIONFS
896 tristate "Function Filesystem"
897 select USB_LIBCOMPOSITE
899 select USB_FUNCTIONFS_GENERIC if !(USB_FUNCTIONFS_ETH || USB_FUNCTIONFS_RNDIS)
901 The Function Filesystem (FunctionFS) lets one create USB
902 composite functions in user space in the same way GadgetFS
903 lets one create USB gadgets in user space. This allows creation
904 of composite gadgets such that some of the functions are
905 implemented in kernel space (for instance Ethernet, serial or
906 mass storage) and other are implemented in user space.
908 If you say "y" or "m" here you will be able what kind of
909 configurations the gadget will provide.
911 Say "y" to link the driver statically, or "m" to build
912 a dynamically linked module called "g_ffs".
914 config USB_FUNCTIONFS_ETH
915 bool "Include configuration with CDC ECM (Ethernet)"
916 depends on USB_FUNCTIONFS && NET
921 Include a configuration with CDC ECM function (Ethernet) and the
924 config USB_FUNCTIONFS_RNDIS
925 bool "Include configuration with RNDIS (Ethernet)"
926 depends on USB_FUNCTIONFS && NET
930 Include a configuration with RNDIS function (Ethernet) and the Filesystem.
932 config USB_FUNCTIONFS_GENERIC
933 bool "Include 'pure' configuration"
934 depends on USB_FUNCTIONFS
936 Include a configuration with the Function Filesystem alone with
937 no Ethernet interface.
939 config USB_MASS_STORAGE
940 tristate "Mass Storage Gadget"
942 select USB_LIBCOMPOSITE
943 select USB_F_MASS_STORAGE
945 The Mass Storage Gadget acts as a USB Mass Storage disk drive.
946 As its storage repository it can use a regular file or a block
947 device (in much the same way as the "loop" device driver),
948 specified as a module parameter or sysfs option.
950 This driver is a replacement for now removed File-backed
951 Storage Gadget (g_file_storage).
953 Say "y" to link the driver statically, or "m" to build
954 a dynamically linked module called "g_mass_storage".
956 config USB_GADGET_TARGET
957 tristate "USB Gadget Target Fabric Module"
958 depends on TARGET_CORE
959 select USB_LIBCOMPOSITE
961 This fabric is an USB gadget. Two USB protocols are supported that is
962 BBB or BOT (Bulk Only Transport) and UAS (USB Attached SCSI). BOT is
963 advertised on alternative interface 0 (primary) and UAS is on
964 alternative interface 1. Both protocols can work on USB2.0 and USB3.0.
965 UAS utilizes the USB 3.0 feature called streams support.
968 tristate "Serial Gadget (with CDC ACM and CDC OBEX support)"
974 select USB_LIBCOMPOSITE
976 The Serial Gadget talks to the Linux-USB generic serial driver.
977 This driver supports a CDC-ACM module option, which can be used
978 to interoperate with MS-Windows hosts or with the Linux-USB
981 This driver also supports a CDC-OBEX option. You will need a
982 user space OBEX server talking to /dev/ttyGS*, since the kernel
983 itself doesn't implement the OBEX protocol.
985 Say "y" to link the driver statically, or "m" to build a
986 dynamically linked module called "g_serial".
988 For more information, see Documentation/usb/gadget_serial.txt
989 which includes instructions and a "driver info file" needed to
990 make MS-Windows work with CDC ACM.
992 config USB_MIDI_GADGET
993 tristate "MIDI Gadget"
995 select USB_LIBCOMPOSITE
998 The MIDI Gadget acts as a USB Audio device, with one MIDI
999 input and one MIDI output. These MIDI jacks appear as
1000 a sound "card" in the ALSA sound system. Other MIDI
1001 connections can then be made on the gadget system, using
1002 ALSA's aconnect utility etc.
1004 Say "y" to link the driver statically, or "m" to build a
1005 dynamically linked module called "g_midi".
1007 config USB_G_PRINTER
1008 tristate "Printer Gadget"
1009 select USB_LIBCOMPOSITE
1011 The Printer Gadget channels data between the USB host and a
1012 userspace program driving the print engine. The user space
1013 program reads and writes the device file /dev/g_printer to
1014 receive or send printer data. It can use ioctl calls to
1015 the device file to get or set printer status.
1017 Say "y" to link the driver statically, or "m" to build a
1018 dynamically linked module called "g_printer".
1020 For more information, see Documentation/usb/gadget_printer.txt
1021 which includes sample code for accessing the device file.
1025 config USB_CDC_COMPOSITE
1026 tristate "CDC Composite Device (Ethernet and ACM)"
1028 select USB_LIBCOMPOSITE
1034 This driver provides two functions in one configuration:
1035 a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link.
1037 This driver requires four bulk and two interrupt endpoints,
1038 plus the ability to handle altsettings. Not all peripheral
1039 controllers are that capable.
1041 Say "y" to link the driver statically, or "m" to build a
1042 dynamically linked module.
1045 tristate "Nokia composite gadget"
1047 select USB_LIBCOMPOSITE
1055 The Nokia composite gadget provides support for acm, obex
1056 and phonet in only one composite gadget driver.
1058 It's only really useful for N900 hardware. If you're building
1059 a kernel for N900, say Y or M here. If unsure, say N.
1062 tristate "CDC Composite Device (ACM and mass storage)"
1064 select USB_LIBCOMPOSITE
1067 select USB_F_MASS_STORAGE
1069 This driver provides two functions in one configuration:
1070 a mass storage, and a CDC ACM (serial port) link.
1072 Say "y" to link the driver statically, or "m" to build a
1073 dynamically linked module called "g_acm_ms".
1076 tristate "Multifunction Composite Gadget"
1077 depends on BLOCK && NET
1078 select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS
1079 select USB_LIBCOMPOSITE
1083 select USB_F_MASS_STORAGE
1085 The Multifunction Composite Gadget provides Ethernet (RNDIS
1086 and/or CDC Ethernet), mass storage and ACM serial link
1089 You will be asked to choose which of the two configurations is
1090 to be available in the gadget. At least one configuration must
1091 be chosen to make the gadget usable. Selecting more than one
1092 configuration will prevent Windows from automatically detecting
1093 the gadget as a composite gadget, so an INF file will be needed to
1096 Say "y" to link the driver statically, or "m" to build a
1097 dynamically linked module called "g_multi".
1099 config USB_G_MULTI_RNDIS
1100 bool "RNDIS + CDC Serial + Storage configuration"
1101 depends on USB_G_MULTI
1105 This option enables a configuration with RNDIS, CDC Serial and
1106 Mass Storage functions available in the Multifunction Composite
1107 Gadget. This is the configuration dedicated for Windows since RNDIS
1108 is Microsoft's protocol.
1112 config USB_G_MULTI_CDC
1113 bool "CDC Ethernet + CDC Serial + Storage configuration"
1114 depends on USB_G_MULTI
1118 This option enables a configuration with CDC Ethernet (ECM), CDC
1119 Serial and Mass Storage functions available in the Multifunction
1127 tristate "HID Gadget"
1128 select USB_LIBCOMPOSITE
1130 The HID gadget driver provides generic emulation of USB
1131 Human Interface Devices (HID).
1133 For more information, see Documentation/usb/gadget_hid.txt which
1134 includes sample code for accessing the device files.
1136 Say "y" to link the driver statically, or "m" to build a
1137 dynamically linked module called "g_hid".
1139 # Standalone / single function gadgets
1141 tristate "EHCI Debug Device Gadget"
1143 select USB_LIBCOMPOSITE
1145 This gadget emulates an EHCI Debug device. This is useful when you want
1146 to interact with an EHCI Debug Port.
1148 Say "y" to link the driver statically, or "m" to build a
1149 dynamically linked module called "g_dbgp".
1153 prompt "EHCI Debug Device mode"
1154 default USB_G_DBGP_SERIAL
1156 config USB_G_DBGP_PRINTK
1157 depends on USB_G_DBGP
1160 Directly printk() received data. No interaction.
1162 config USB_G_DBGP_SERIAL
1163 depends on USB_G_DBGP
1167 Userland can interact using /dev/ttyGSxxx.
1171 # put drivers that need isochronous transfer support (for audio
1172 # or video class gadget drivers), or specific hardware, here.
1174 tristate "USB Webcam Gadget"
1175 depends on VIDEO_DEV
1176 select USB_LIBCOMPOSITE
1177 select VIDEOBUF2_VMALLOC
1179 The Webcam Gadget acts as a composite USB Audio and Video Class
1180 device. It provides a userspace API to process UVC control requests
1181 and stream video data to the host.
1183 Say "y" to link the driver statically, or "m" to build a
1184 dynamically linked module called "g_webcam".