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 && I2C
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 depends on ISP1301_OMAP || !(MACH_OMAP_H2 || MACH_OMAP_H3)
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.
304 tristate "S3C2410 USB Device Controller"
305 depends on ARCH_S3C24XX
307 Samsung's S3C2410 is an ARM-4 processor with an integrated
308 full speed USB 1.1 device controller. It has 4 configurable
309 endpoints, as well as endpoint zero (for control transfers).
311 This driver has been tested on the S3C2410, S3C2412, and
314 config USB_S3C2410_DEBUG
315 boolean "S3C2410 udc debug messages"
316 depends on USB_S3C2410
319 tristate "S3C2416, S3C2443 and S3C2450 USB Device Controller"
320 depends on ARCH_S3C24XX
322 Samsung's S3C2416, S3C2443 and S3C2450 is an ARM9 based SoC
323 integrated with dual speed USB 2.0 device controller. It has
324 8 endpoints, as well as endpoint zero.
326 This driver has been tested on S3C2416 and S3C2450 processors.
329 tristate "Marvell USB2.0 Device Controller"
332 Marvell Socs (including PXA and MMP series) include a high speed
333 USB2.0 OTG controller, which can be configured as high speed or
334 full speed USB peripheral.
338 tristate "MARVELL PXA2128 USB 3.0 controller"
340 MARVELL PXA2128 Processor series include a super speed USB3.0 device
341 controller, which support super speed USB peripheral.
344 # Controllers available in both integrated and discrete versions
348 tristate "Renesas M66592 USB Peripheral Controller"
350 M66592 is a discrete USB peripheral controller chip that
351 supports both full and high speed USB 2.0 data transfers.
352 It has seven configurable endpoints, and endpoint zero.
354 Say "y" to link the driver statically, or "m" to build a
355 dynamically linked module called "m66592_udc" and force all
356 gadget drivers to also be dynamically linked.
359 # Controllers available only in discrete form (and all PCI controllers)
362 config USB_AMD5536UDC
363 tristate "AMD5536 UDC"
366 The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
367 It is a USB Highspeed DMA capable USB device controller. Beside ep0
368 it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
369 The UDC port supports OTG operation, and may be used as a host port
370 if it's not being used to implement peripheral or OTG roles.
372 Say "y" to link the driver statically, or "m" to build a
373 dynamically linked module called "amd5536udc" and force all
374 gadget drivers to also be dynamically linked.
377 tristate "Freescale QE/CPM USB Device Controller"
378 depends on FSL_SOC && (QUICC_ENGINE || CPM)
380 Some of Freescale PowerPC processors have a Full Speed
381 QE/CPM2 USB controller, which support device mode with 4
382 programmable endpoints. This driver supports the
383 controller in the MPC8360 and MPC8272, and should work with
384 controllers having QE or CPM2, given minor tweaks.
386 Set CONFIG_USB_GADGET to "m" to build this driver as a
387 dynamically linked module called "fsl_qe_udc".
390 tristate "PLX NET2272"
392 PLX NET2272 is a USB peripheral controller which supports
393 both full and high speed USB 2.0 data transfers.
395 It has three configurable endpoints, as well as endpoint zero
396 (for control transfer).
397 Say "y" to link the driver statically, or "m" to build a
398 dynamically linked module called "net2272" and force all
399 gadget drivers to also be dynamically linked.
401 config USB_NET2272_DMA
402 boolean "Support external DMA controller"
403 depends on USB_NET2272 && HAS_DMA
405 The NET2272 part can optionally support an external DMA
406 controller, but your board has to have support in the
409 If unsure, say "N" here. The driver works fine in PIO mode.
412 tristate "NetChip 228x"
415 NetChip 2280 / 2282 is a PCI based USB peripheral controller which
416 supports both full and high speed USB 2.0 data transfers.
418 It has six configurable endpoints, as well as endpoint zero
419 (for control transfers) and several endpoints with dedicated
422 Say "y" to link the driver statically, or "m" to build a
423 dynamically linked module called "net2280" and force all
424 gadget drivers to also be dynamically linked.
427 tristate "Toshiba TC86C001 'Goku-S'"
430 The Toshiba TC86C001 is a PCI device which includes controllers
431 for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
433 The device controller has three configurable (bulk or interrupt)
434 endpoints, plus endpoint zero (for control transfers).
436 Say "y" to link the driver statically, or "m" to build a
437 dynamically linked module called "goku_udc" and to force all
438 gadget drivers to also be dynamically linked.
441 tristate "Intel EG20T PCH/LAPIS Semiconductor IOH(ML7213/ML7831) UDC"
444 This is a USB device driver for EG20T PCH.
445 EG20T PCH is the platform controller hub that is used in Intel's
446 general embedded platform. EG20T PCH has USB device interface.
447 Using this interface, it is able to access system devices connected
449 This driver enables USB device function.
450 USB device is a USB peripheral controller which
451 supports both full and high speed USB 2.0 data transfers.
452 This driver supports both control transfer and bulk transfer modes.
453 This driver dose not support interrupt transfer or isochronous
456 This driver also can be used for LAPIS Semiconductor's ML7213 which is
457 for IVI(In-Vehicle Infotainment) use.
458 ML7831 is for general purpose use.
459 ML7213/ML7831 is companion chip for Intel Atom E6xx series.
460 ML7213/ML7831 is completely compatible for Intel EG20T PCH.
463 # LAST -- dummy/emulated controller
467 tristate "Dummy HCD (DEVELOPMENT)"
468 depends on USB=y || (USB=m && USB_GADGET=m)
470 This host controller driver emulates USB, looping all data transfer
471 requests back to a USB "gadget driver" in the same host. The host
472 side is the master; the gadget side is the slave. Gadget drivers
473 can be high, full, or low speed; and they have access to endpoints
474 like those from NET2280, PXA2xx, or SA1100 hardware.
476 This may help in some stages of creating a driver to embed in a
477 Linux device, since it lets you debug several parts of the gadget
478 driver without its hardware or drivers being involved.
480 Since such a gadget side driver needs to interoperate with a host
481 side Linux-USB device driver, this may help to debug both sides
482 of a USB protocol stack.
484 Say "y" to link the driver statically, or "m" to build a
485 dynamically linked module called "dummy_hcd" and force all
486 gadget drivers to also be dynamically linked.
488 # NOTE: Please keep dummy_hcd LAST so that "real hardware" appears
489 # first and will be selected by default.
497 # composite based drivers
498 config USB_LIBCOMPOSITE
501 depends on USB_GADGET
539 config USB_F_MASS_STORAGE
546 tristate "USB Gadget Drivers"
549 A Linux "Gadget Driver" talks to the USB Peripheral Controller
550 driver through the abstract "gadget" API. Some other operating
551 systems call these "client" drivers, of which "class drivers"
552 are a subset (implementing a USB device class specification).
553 A gadget driver implements one or more USB functions using
554 the peripheral hardware.
556 Gadget drivers are hardware-neutral, or "platform independent",
557 except that they sometimes must understand quirks or limitations
558 of the particular controllers they work with. For example, when
559 a controller doesn't support alternate configurations or provide
560 enough of the right types of endpoints, the gadget driver might
561 not be able work with that controller, or might need to implement
562 a less common variant of a device class protocol.
564 # this first set of drivers all depend on bulk-capable hardware.
567 tristate "USB functions configurable through configfs"
568 select USB_LIBCOMPOSITE
570 A Linux USB "gadget" can be set up through configfs.
571 If this is the case, the USB functions (which from the host's
572 perspective are seen as interfaces) and configurations are
573 specified simply by creating appropriate directories in configfs.
574 Associating functions with configurations is done by creating
575 appropriate symbolic links.
576 For more information see Documentation/usb/gadget_configfs.txt.
578 config USB_CONFIGFS_SERIAL
579 boolean "Generic serial bulk in/out"
580 depends on USB_CONFIGFS
585 The function talks to the Linux-USB generic serial driver.
587 config USB_CONFIGFS_ACM
588 boolean "Abstract Control Model (CDC ACM)"
589 depends on USB_CONFIGFS
594 ACM serial link. This function can be used to interoperate with
595 MS-Windows hosts or with the Linux-USB "cdc-acm" driver.
597 config USB_CONFIGFS_OBEX
598 boolean "Object Exchange Model (CDC OBEX)"
599 depends on USB_CONFIGFS
604 You will need a user space OBEX server talking to /dev/ttyGS*,
605 since the kernel itself doesn't implement the OBEX protocol.
607 config USB_CONFIGFS_NCM
608 boolean "Network Control Model (CDC NCM)"
609 depends on USB_CONFIGFS
614 NCM is an advanced protocol for Ethernet encapsulation, allows
615 grouping of several ethernet frames into one USB transfer and
616 different alignment possibilities.
618 config USB_CONFIGFS_ECM
619 boolean "Ethernet Control Model (CDC ECM)"
620 depends on USB_CONFIGFS
625 The "Communication Device Class" (CDC) Ethernet Control Model.
626 That protocol is often avoided with pure Ethernet adapters, in
627 favor of simpler vendor-specific hardware, but is widely
628 supported by firmware for smart network devices.
630 config USB_CONFIGFS_ECM_SUBSET
631 boolean "Ethernet Control Model (CDC ECM) subset"
632 depends on USB_CONFIGFS
637 On hardware that can't implement the full protocol,
638 a simple CDC subset is used, placing fewer demands on USB.
640 config USB_CONFIGFS_RNDIS
642 depends on USB_CONFIGFS
647 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
648 and Microsoft provides redistributable binary RNDIS drivers for
649 older versions of Windows.
651 To make MS-Windows work with this, use Documentation/usb/linux.inf
652 as the "driver info file". For versions of MS-Windows older than
653 XP, you'll need to download drivers from Microsoft's website; a URL
654 is given in comments found in that info file.
656 config USB_CONFIGFS_EEM
657 bool "Ethernet Emulation Model (EEM)"
658 depends on USB_CONFIGFS
663 CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM
664 and therefore can be supported by more hardware. Technically ECM and
665 EEM are designed for different applications. The ECM model extends
666 the network interface to the target (e.g. a USB cable modem), and the
667 EEM model is for mobile devices to communicate with hosts using
668 ethernet over USB. For Linux gadgets, however, the interface with
669 the host is the same (a usbX device), so the differences are minimal.
671 config USB_CONFIGFS_PHONET
672 boolean "Phonet protocol"
673 depends on USB_CONFIGFS
679 The Phonet protocol implementation for USB device.
681 config USB_CONFIGFS_MASS_STORAGE
682 boolean "Mass storage"
683 depends on USB_CONFIGFS
685 select USB_F_MASS_STORAGE
687 The Mass Storage Gadget acts as a USB Mass Storage disk drive.
688 As its storage repository it can use a regular file or a block
689 device (in much the same way as the "loop" device driver),
690 specified as a module parameter or sysfs option.
692 config USB_CONFIGFS_F_LB_SS
693 boolean "Loopback and sourcesink function (for testing)"
694 depends on USB_CONFIGFS
697 Loopback function loops back a configurable number of transfers.
698 Sourcesink function either sinks and sources bulk data.
699 It also implements control requests, for "chapter 9" conformance.
700 Make this be the first driver you try using on top of any new
701 USB peripheral controller driver. Then you can use host-side
702 test software, like the "usbtest" driver, to put your hardware
703 and its driver through a basic set of functional tests.
705 config USB_CONFIGFS_F_FS
706 boolean "Function filesystem (FunctionFS)"
707 depends on USB_CONFIGFS
710 The Function Filesystem (FunctionFS) lets one create USB
711 composite functions in user space in the same way GadgetFS
712 lets one create USB gadgets in user space. This allows creation
713 of composite gadgets such that some of the functions are
714 implemented in kernel space (for instance Ethernet, serial or
715 mass storage) and other are implemented in user space.
718 tristate "Gadget Zero (DEVELOPMENT)"
719 select USB_LIBCOMPOSITE
722 Gadget Zero is a two-configuration device. It either sinks and
723 sources bulk data; or it loops back a configurable number of
724 transfers. It also implements control requests, for "chapter 9"
725 conformance. The driver needs only two bulk-capable endpoints, so
726 it can work on top of most device-side usb controllers. It's
727 useful for testing, and is also a working example showing how
728 USB "gadget drivers" can be written.
730 Make this be the first driver you try using on top of any new
731 USB peripheral controller driver. Then you can use host-side
732 test software, like the "usbtest" driver, to put your hardware
733 and its driver through a basic set of functional tests.
735 Gadget Zero also works with the host-side "usb-skeleton" driver,
736 and with many kinds of host-side test software. You may need
737 to tweak product and vendor IDs before host software knows about
738 this device, and arrange to select an appropriate configuration.
740 Say "y" to link the driver statically, or "m" to build a
741 dynamically linked module called "g_zero".
743 config USB_ZERO_HNPTEST
744 boolean "HNP Test Device"
745 depends on USB_ZERO && USB_OTG
747 You can configure this device to enumerate using the device
748 identifiers of the USB-OTG test device. That means that when
749 this gadget connects to another OTG device, with this one using
750 the "B-Peripheral" role, that device will use HNP to let this
751 one serve as the USB host instead (in the "B-Host" role).
754 tristate "Audio Gadget"
756 select USB_LIBCOMPOSITE
759 This Gadget Audio driver is compatible with USB Audio Class
760 specification 2.0. It implements 1 AudioControl interface,
761 1 AudioStreaming Interface each for USB-OUT and USB-IN.
762 Number of channels, sample rate and sample size can be
763 specified as module parameters.
764 This driver doesn't expect any real Audio codec to be present
765 on the device - the audio streams are simply sinked to and
766 sourced from a virtual ALSA sound card created. The user-space
767 application may choose to do whatever it wants with the data
768 received from the USB Host and choose to provide whatever it
769 wants as audio data to the USB Host.
771 Say "y" to link the driver statically, or "m" to build a
772 dynamically linked module called "g_audio".
775 bool "UAC 1.0 (Legacy)"
778 If you instead want older UAC Spec-1.0 driver that also has audio
779 paths hardwired to the Audio codec chip on-board and doesn't work
783 tristate "Ethernet Gadget (with CDC Ethernet support)"
785 select USB_LIBCOMPOSITE
791 This driver implements Ethernet style communication, in one of
794 - The "Communication Device Class" (CDC) Ethernet Control Model.
795 That protocol is often avoided with pure Ethernet adapters, in
796 favor of simpler vendor-specific hardware, but is widely
797 supported by firmware for smart network devices.
799 - On hardware can't implement that protocol, a simple CDC subset
800 is used, placing fewer demands on USB.
802 - CDC Ethernet Emulation Model (EEM) is a newer standard that has
803 a simpler interface that can be used by more USB hardware.
805 RNDIS support is an additional option, more demanding than than
808 Within the USB device, this gadget driver exposes a network device
809 "usbX", where X depends on what other networking devices you have.
810 Treat it like a two-node Ethernet link: host, and gadget.
812 The Linux-USB host-side "usbnet" driver interoperates with this
813 driver, so that deep I/O queues can be supported. On 2.4 kernels,
814 use "CDCEther" instead, if you're using the CDC option. That CDC
815 mode should also interoperate with standard CDC Ethernet class
816 drivers on other host operating systems.
818 Say "y" to link the driver statically, or "m" to build a
819 dynamically linked module called "g_ether".
824 select USB_LIBCOMPOSITE
828 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
829 and Microsoft provides redistributable binary RNDIS drivers for
830 older versions of Windows.
832 If you say "y" here, the Ethernet gadget driver will try to provide
833 a second device configuration, supporting RNDIS to talk to such
836 To make MS-Windows work with this, use Documentation/usb/linux.inf
837 as the "driver info file". For versions of MS-Windows older than
838 XP, you'll need to download drivers from Microsoft's website; a URL
839 is given in comments found in that info file.
842 bool "Ethernet Emulation Model (EEM) support"
844 select USB_LIBCOMPOSITE
848 CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM
849 and therefore can be supported by more hardware. Technically ECM and
850 EEM are designed for different applications. The ECM model extends
851 the network interface to the target (e.g. a USB cable modem), and the
852 EEM model is for mobile devices to communicate with hosts using
853 ethernet over USB. For Linux gadgets, however, the interface with
854 the host is the same (a usbX device), so the differences are minimal.
856 If you say "y" here, the Ethernet gadget driver will use the EEM
857 protocol rather than ECM. If unsure, say "n".
860 tristate "Network Control Model (NCM) support"
862 select USB_LIBCOMPOSITE
867 This driver implements USB CDC NCM subclass standard. NCM is
868 an advanced protocol for Ethernet encapsulation, allows grouping
869 of several ethernet frames into one USB transfer and different
870 alignment possibilities.
872 Say "y" to link the driver statically, or "m" to build a
873 dynamically linked module called "g_ncm".
876 tristate "Gadget Filesystem"
878 This driver provides a filesystem based API that lets user mode
879 programs implement a single-configuration USB device, including
880 endpoint I/O and control requests that don't relate to enumeration.
881 All endpoints, transfer speeds, and transfer types supported by
882 the hardware are available, through read() and write() calls.
884 Say "y" to link the driver statically, or "m" to build a
885 dynamically linked module called "gadgetfs".
887 config USB_FUNCTIONFS
888 tristate "Function Filesystem"
889 select USB_LIBCOMPOSITE
891 select USB_FUNCTIONFS_GENERIC if !(USB_FUNCTIONFS_ETH || USB_FUNCTIONFS_RNDIS)
893 The Function Filesystem (FunctionFS) lets one create USB
894 composite functions in user space in the same way GadgetFS
895 lets one create USB gadgets in user space. This allows creation
896 of composite gadgets such that some of the functions are
897 implemented in kernel space (for instance Ethernet, serial or
898 mass storage) and other are implemented in user space.
900 If you say "y" or "m" here you will be able what kind of
901 configurations the gadget will provide.
903 Say "y" to link the driver statically, or "m" to build
904 a dynamically linked module called "g_ffs".
906 config USB_FUNCTIONFS_ETH
907 bool "Include configuration with CDC ECM (Ethernet)"
908 depends on USB_FUNCTIONFS && NET
913 Include a configuration with CDC ECM function (Ethernet) and the
916 config USB_FUNCTIONFS_RNDIS
917 bool "Include configuration with RNDIS (Ethernet)"
918 depends on USB_FUNCTIONFS && NET
922 Include a configuration with RNDIS function (Ethernet) and the Filesystem.
924 config USB_FUNCTIONFS_GENERIC
925 bool "Include 'pure' configuration"
926 depends on USB_FUNCTIONFS
928 Include a configuration with the Function Filesystem alone with
929 no Ethernet interface.
931 config USB_MASS_STORAGE
932 tristate "Mass Storage Gadget"
934 select USB_LIBCOMPOSITE
935 select USB_F_MASS_STORAGE
937 The Mass Storage Gadget acts as a USB Mass Storage disk drive.
938 As its storage repository it can use a regular file or a block
939 device (in much the same way as the "loop" device driver),
940 specified as a module parameter or sysfs option.
942 This driver is a replacement for now removed File-backed
943 Storage Gadget (g_file_storage).
945 Say "y" to link the driver statically, or "m" to build
946 a dynamically linked module called "g_mass_storage".
948 config USB_GADGET_TARGET
949 tristate "USB Gadget Target Fabric Module"
950 depends on TARGET_CORE
951 select USB_LIBCOMPOSITE
953 This fabric is an USB gadget. Two USB protocols are supported that is
954 BBB or BOT (Bulk Only Transport) and UAS (USB Attached SCSI). BOT is
955 advertised on alternative interface 0 (primary) and UAS is on
956 alternative interface 1. Both protocols can work on USB2.0 and USB3.0.
957 UAS utilizes the USB 3.0 feature called streams support.
960 tristate "Serial Gadget (with CDC ACM and CDC OBEX support)"
966 select USB_LIBCOMPOSITE
968 The Serial Gadget talks to the Linux-USB generic serial driver.
969 This driver supports a CDC-ACM module option, which can be used
970 to interoperate with MS-Windows hosts or with the Linux-USB
973 This driver also supports a CDC-OBEX option. You will need a
974 user space OBEX server talking to /dev/ttyGS*, since the kernel
975 itself doesn't implement the OBEX protocol.
977 Say "y" to link the driver statically, or "m" to build a
978 dynamically linked module called "g_serial".
980 For more information, see Documentation/usb/gadget_serial.txt
981 which includes instructions and a "driver info file" needed to
982 make MS-Windows work with CDC ACM.
984 config USB_MIDI_GADGET
985 tristate "MIDI Gadget"
987 select USB_LIBCOMPOSITE
990 The MIDI Gadget acts as a USB Audio device, with one MIDI
991 input and one MIDI output. These MIDI jacks appear as
992 a sound "card" in the ALSA sound system. Other MIDI
993 connections can then be made on the gadget system, using
994 ALSA's aconnect utility etc.
996 Say "y" to link the driver statically, or "m" to build a
997 dynamically linked module called "g_midi".
1000 tristate "Printer Gadget"
1001 select USB_LIBCOMPOSITE
1003 The Printer Gadget channels data between the USB host and a
1004 userspace program driving the print engine. The user space
1005 program reads and writes the device file /dev/g_printer to
1006 receive or send printer data. It can use ioctl calls to
1007 the device file to get or set printer status.
1009 Say "y" to link the driver statically, or "m" to build a
1010 dynamically linked module called "g_printer".
1012 For more information, see Documentation/usb/gadget_printer.txt
1013 which includes sample code for accessing the device file.
1017 config USB_CDC_COMPOSITE
1018 tristate "CDC Composite Device (Ethernet and ACM)"
1020 select USB_LIBCOMPOSITE
1026 This driver provides two functions in one configuration:
1027 a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link.
1029 This driver requires four bulk and two interrupt endpoints,
1030 plus the ability to handle altsettings. Not all peripheral
1031 controllers are that capable.
1033 Say "y" to link the driver statically, or "m" to build a
1034 dynamically linked module.
1037 tristate "Nokia composite gadget"
1039 select USB_LIBCOMPOSITE
1047 The Nokia composite gadget provides support for acm, obex
1048 and phonet in only one composite gadget driver.
1050 It's only really useful for N900 hardware. If you're building
1051 a kernel for N900, say Y or M here. If unsure, say N.
1054 tristate "CDC Composite Device (ACM and mass storage)"
1056 select USB_LIBCOMPOSITE
1059 select USB_F_MASS_STORAGE
1061 This driver provides two functions in one configuration:
1062 a mass storage, and a CDC ACM (serial port) link.
1064 Say "y" to link the driver statically, or "m" to build a
1065 dynamically linked module called "g_acm_ms".
1068 tristate "Multifunction Composite Gadget"
1069 depends on BLOCK && NET
1070 select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS
1071 select USB_LIBCOMPOSITE
1075 select USB_F_MASS_STORAGE
1077 The Multifunction Composite Gadget provides Ethernet (RNDIS
1078 and/or CDC Ethernet), mass storage and ACM serial link
1081 You will be asked to choose which of the two configurations is
1082 to be available in the gadget. At least one configuration must
1083 be chosen to make the gadget usable. Selecting more than one
1084 configuration will prevent Windows from automatically detecting
1085 the gadget as a composite gadget, so an INF file will be needed to
1088 Say "y" to link the driver statically, or "m" to build a
1089 dynamically linked module called "g_multi".
1091 config USB_G_MULTI_RNDIS
1092 bool "RNDIS + CDC Serial + Storage configuration"
1093 depends on USB_G_MULTI
1097 This option enables a configuration with RNDIS, CDC Serial and
1098 Mass Storage functions available in the Multifunction Composite
1099 Gadget. This is the configuration dedicated for Windows since RNDIS
1100 is Microsoft's protocol.
1104 config USB_G_MULTI_CDC
1105 bool "CDC Ethernet + CDC Serial + Storage configuration"
1106 depends on USB_G_MULTI
1110 This option enables a configuration with CDC Ethernet (ECM), CDC
1111 Serial and Mass Storage functions available in the Multifunction
1119 tristate "HID Gadget"
1120 select USB_LIBCOMPOSITE
1122 The HID gadget driver provides generic emulation of USB
1123 Human Interface Devices (HID).
1125 For more information, see Documentation/usb/gadget_hid.txt which
1126 includes sample code for accessing the device files.
1128 Say "y" to link the driver statically, or "m" to build a
1129 dynamically linked module called "g_hid".
1131 # Standalone / single function gadgets
1133 tristate "EHCI Debug Device Gadget"
1135 select USB_LIBCOMPOSITE
1137 This gadget emulates an EHCI Debug device. This is useful when you want
1138 to interact with an EHCI Debug Port.
1140 Say "y" to link the driver statically, or "m" to build a
1141 dynamically linked module called "g_dbgp".
1145 prompt "EHCI Debug Device mode"
1146 default USB_G_DBGP_SERIAL
1148 config USB_G_DBGP_PRINTK
1149 depends on USB_G_DBGP
1152 Directly printk() received data. No interaction.
1154 config USB_G_DBGP_SERIAL
1155 depends on USB_G_DBGP
1159 Userland can interact using /dev/ttyGSxxx.
1163 # put drivers that need isochronous transfer support (for audio
1164 # or video class gadget drivers), or specific hardware, here.
1166 tristate "USB Webcam Gadget"
1167 depends on VIDEO_DEV
1168 select USB_LIBCOMPOSITE
1169 select VIDEOBUF2_VMALLOC
1171 The Webcam Gadget acts as a composite USB Audio and Video Class
1172 device. It provides a userspace API to process UVC control requests
1173 and stream video data to the host.
1175 Say "y" to link the driver statically, or "m" to build a
1176 dynamically linked module called "g_webcam".