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
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 "Designware/S3C HS/OtG USB Device controller"
306 The Designware USB2.0 high-speed gadget controller
307 integrated into many SoCs.
310 tristate "S3C2410 USB Device Controller"
311 depends on ARCH_S3C24XX
313 Samsung's S3C2410 is an ARM-4 processor with an integrated
314 full speed USB 1.1 device controller. It has 4 configurable
315 endpoints, as well as endpoint zero (for control transfers).
317 This driver has been tested on the S3C2410, S3C2412, and
320 config USB_S3C2410_DEBUG
321 boolean "S3C2410 udc debug messages"
322 depends on USB_S3C2410
325 tristate "S3C2416, S3C2443 and S3C2450 USB Device Controller"
326 depends on ARCH_S3C24XX
328 Samsung's S3C2416, S3C2443 and S3C2450 is an ARM9 based SoC
329 integrated with dual speed USB 2.0 device controller. It has
330 8 endpoints, as well as endpoint zero.
332 This driver has been tested on S3C2416 and S3C2450 processors.
335 tristate "Marvell USB2.0 Device Controller"
338 Marvell Socs (including PXA and MMP series) include a high speed
339 USB2.0 OTG controller, which can be configured as high speed or
340 full speed USB peripheral.
344 tristate "MARVELL PXA2128 USB 3.0 controller"
346 MARVELL PXA2128 Processor series include a super speed USB3.0 device
347 controller, which support super speed USB peripheral.
350 # Controllers available in both integrated and discrete versions
354 tristate "Renesas M66592 USB Peripheral Controller"
356 M66592 is a discrete USB peripheral controller chip that
357 supports both full and high speed USB 2.0 data transfers.
358 It has seven configurable endpoints, and endpoint zero.
360 Say "y" to link the driver statically, or "m" to build a
361 dynamically linked module called "m66592_udc" and force all
362 gadget drivers to also be dynamically linked.
365 # Controllers available only in discrete form (and all PCI controllers)
368 config USB_AMD5536UDC
369 tristate "AMD5536 UDC"
372 The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
373 It is a USB Highspeed DMA capable USB device controller. Beside ep0
374 it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
375 The UDC port supports OTG operation, and may be used as a host port
376 if it's not being used to implement peripheral or OTG roles.
378 Say "y" to link the driver statically, or "m" to build a
379 dynamically linked module called "amd5536udc" and force all
380 gadget drivers to also be dynamically linked.
383 tristate "Freescale QE/CPM USB Device Controller"
384 depends on FSL_SOC && (QUICC_ENGINE || CPM)
386 Some of Freescale PowerPC processors have a Full Speed
387 QE/CPM2 USB controller, which support device mode with 4
388 programmable endpoints. This driver supports the
389 controller in the MPC8360 and MPC8272, and should work with
390 controllers having QE or CPM2, given minor tweaks.
392 Set CONFIG_USB_GADGET to "m" to build this driver as a
393 dynamically linked module called "fsl_qe_udc".
396 tristate "PLX NET2272"
398 PLX NET2272 is a USB peripheral controller which supports
399 both full and high speed USB 2.0 data transfers.
401 It has three configurable endpoints, as well as endpoint zero
402 (for control transfer).
403 Say "y" to link the driver statically, or "m" to build a
404 dynamically linked module called "net2272" and force all
405 gadget drivers to also be dynamically linked.
407 config USB_NET2272_DMA
408 boolean "Support external DMA controller"
409 depends on USB_NET2272 && HAS_DMA
411 The NET2272 part can optionally support an external DMA
412 controller, but your board has to have support in the
415 If unsure, say "N" here. The driver works fine in PIO mode.
418 tristate "NetChip 228x"
421 NetChip 2280 / 2282 is a PCI based USB peripheral controller which
422 supports both full and high speed USB 2.0 data transfers.
424 It has six configurable endpoints, as well as endpoint zero
425 (for control transfers) and several endpoints with dedicated
428 Say "y" to link the driver statically, or "m" to build a
429 dynamically linked module called "net2280" and force all
430 gadget drivers to also be dynamically linked.
433 tristate "Toshiba TC86C001 'Goku-S'"
436 The Toshiba TC86C001 is a PCI device which includes controllers
437 for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
439 The device controller has three configurable (bulk or interrupt)
440 endpoints, plus endpoint zero (for control transfers).
442 Say "y" to link the driver statically, or "m" to build a
443 dynamically linked module called "goku_udc" and to force all
444 gadget drivers to also be dynamically linked.
447 tristate "Intel EG20T PCH/LAPIS Semiconductor IOH(ML7213/ML7831) UDC"
450 This is a USB device driver for EG20T PCH.
451 EG20T PCH is the platform controller hub that is used in Intel's
452 general embedded platform. EG20T PCH has USB device interface.
453 Using this interface, it is able to access system devices connected
455 This driver enables USB device function.
456 USB device is a USB peripheral controller which
457 supports both full and high speed USB 2.0 data transfers.
458 This driver supports both control transfer and bulk transfer modes.
459 This driver dose not support interrupt transfer or isochronous
462 This driver also can be used for LAPIS Semiconductor's ML7213 which is
463 for IVI(In-Vehicle Infotainment) use.
464 ML7831 is for general purpose use.
465 ML7213/ML7831 is companion chip for Intel Atom E6xx series.
466 ML7213/ML7831 is completely compatible for Intel EG20T PCH.
469 # LAST -- dummy/emulated controller
473 tristate "Dummy HCD (DEVELOPMENT)"
474 depends on USB=y || (USB=m && USB_GADGET=m)
476 This host controller driver emulates USB, looping all data transfer
477 requests back to a USB "gadget driver" in the same host. The host
478 side is the master; the gadget side is the slave. Gadget drivers
479 can be high, full, or low speed; and they have access to endpoints
480 like those from NET2280, PXA2xx, or SA1100 hardware.
482 This may help in some stages of creating a driver to embed in a
483 Linux device, since it lets you debug several parts of the gadget
484 driver without its hardware or drivers being involved.
486 Since such a gadget side driver needs to interoperate with a host
487 side Linux-USB device driver, this may help to debug both sides
488 of a USB protocol stack.
490 Say "y" to link the driver statically, or "m" to build a
491 dynamically linked module called "dummy_hcd" and force all
492 gadget drivers to also be dynamically linked.
494 # NOTE: Please keep dummy_hcd LAST so that "real hardware" appears
495 # first and will be selected by default.
503 # composite based drivers
504 config USB_LIBCOMPOSITE
507 depends on USB_GADGET
545 config USB_F_MASS_STORAGE
552 tristate "USB Gadget Drivers"
555 A Linux "Gadget Driver" talks to the USB Peripheral Controller
556 driver through the abstract "gadget" API. Some other operating
557 systems call these "client" drivers, of which "class drivers"
558 are a subset (implementing a USB device class specification).
559 A gadget driver implements one or more USB functions using
560 the peripheral hardware.
562 Gadget drivers are hardware-neutral, or "platform independent",
563 except that they sometimes must understand quirks or limitations
564 of the particular controllers they work with. For example, when
565 a controller doesn't support alternate configurations or provide
566 enough of the right types of endpoints, the gadget driver might
567 not be able work with that controller, or might need to implement
568 a less common variant of a device class protocol.
570 # this first set of drivers all depend on bulk-capable hardware.
573 tristate "USB functions configurable through configfs"
574 select USB_LIBCOMPOSITE
576 A Linux USB "gadget" can be set up through configfs.
577 If this is the case, the USB functions (which from the host's
578 perspective are seen as interfaces) and configurations are
579 specified simply by creating appropriate directories in configfs.
580 Associating functions with configurations is done by creating
581 appropriate symbolic links.
582 For more information see Documentation/usb/gadget_configfs.txt.
584 config USB_CONFIGFS_SERIAL
585 boolean "Generic serial bulk in/out"
586 depends on USB_CONFIGFS
591 The function talks to the Linux-USB generic serial driver.
593 config USB_CONFIGFS_ACM
594 boolean "Abstract Control Model (CDC ACM)"
595 depends on USB_CONFIGFS
600 ACM serial link. This function can be used to interoperate with
601 MS-Windows hosts or with the Linux-USB "cdc-acm" driver.
603 config USB_CONFIGFS_OBEX
604 boolean "Object Exchange Model (CDC OBEX)"
605 depends on USB_CONFIGFS
610 You will need a user space OBEX server talking to /dev/ttyGS*,
611 since the kernel itself doesn't implement the OBEX protocol.
613 config USB_CONFIGFS_NCM
614 boolean "Network Control Model (CDC NCM)"
615 depends on USB_CONFIGFS
620 NCM is an advanced protocol for Ethernet encapsulation, allows
621 grouping of several ethernet frames into one USB transfer and
622 different alignment possibilities.
624 config USB_CONFIGFS_ECM
625 boolean "Ethernet Control Model (CDC ECM)"
626 depends on USB_CONFIGFS
631 The "Communication Device Class" (CDC) Ethernet Control Model.
632 That protocol is often avoided with pure Ethernet adapters, in
633 favor of simpler vendor-specific hardware, but is widely
634 supported by firmware for smart network devices.
636 config USB_CONFIGFS_ECM_SUBSET
637 boolean "Ethernet Control Model (CDC ECM) subset"
638 depends on USB_CONFIGFS
643 On hardware that can't implement the full protocol,
644 a simple CDC subset is used, placing fewer demands on USB.
646 config USB_CONFIGFS_RNDIS
648 depends on USB_CONFIGFS
653 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
654 and Microsoft provides redistributable binary RNDIS drivers for
655 older versions of Windows.
657 To make MS-Windows work with this, use Documentation/usb/linux.inf
658 as the "driver info file". For versions of MS-Windows older than
659 XP, you'll need to download drivers from Microsoft's website; a URL
660 is given in comments found in that info file.
662 config USB_CONFIGFS_EEM
663 bool "Ethernet Emulation Model (EEM)"
664 depends on USB_CONFIGFS
669 CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM
670 and therefore can be supported by more hardware. Technically ECM and
671 EEM are designed for different applications. The ECM model extends
672 the network interface to the target (e.g. a USB cable modem), and the
673 EEM model is for mobile devices to communicate with hosts using
674 ethernet over USB. For Linux gadgets, however, the interface with
675 the host is the same (a usbX device), so the differences are minimal.
677 config USB_CONFIGFS_PHONET
678 boolean "Phonet protocol"
679 depends on USB_CONFIGFS
685 The Phonet protocol implementation for USB device.
687 config USB_CONFIGFS_MASS_STORAGE
688 boolean "Mass storage"
689 depends on USB_CONFIGFS
691 select USB_F_MASS_STORAGE
693 The Mass Storage Gadget acts as a USB Mass Storage disk drive.
694 As its storage repository it can use a regular file or a block
695 device (in much the same way as the "loop" device driver),
696 specified as a module parameter or sysfs option.
698 config USB_CONFIGFS_F_LB_SS
699 boolean "Loopback and sourcesink function (for testing)"
700 depends on USB_CONFIGFS
703 Loopback function loops back a configurable number of transfers.
704 Sourcesink function either sinks and sources bulk data.
705 It also implements control requests, for "chapter 9" conformance.
706 Make this be the first driver you try using on top of any new
707 USB peripheral controller driver. Then you can use host-side
708 test software, like the "usbtest" driver, to put your hardware
709 and its driver through a basic set of functional tests.
711 config USB_CONFIGFS_F_FS
712 boolean "Function filesystem (FunctionFS)"
713 depends on USB_CONFIGFS
716 The Function Filesystem (FunctionFS) lets one create USB
717 composite functions in user space in the same way GadgetFS
718 lets one create USB gadgets in user space. This allows creation
719 of composite gadgets such that some of the functions are
720 implemented in kernel space (for instance Ethernet, serial or
721 mass storage) and other are implemented in user space.
724 tristate "Gadget Zero (DEVELOPMENT)"
725 select USB_LIBCOMPOSITE
728 Gadget Zero is a two-configuration device. It either sinks and
729 sources bulk data; or it loops back a configurable number of
730 transfers. It also implements control requests, for "chapter 9"
731 conformance. The driver needs only two bulk-capable endpoints, so
732 it can work on top of most device-side usb controllers. It's
733 useful for testing, and is also a working example showing how
734 USB "gadget drivers" can be written.
736 Make this be the first driver you try using on top of any new
737 USB peripheral controller driver. Then you can use host-side
738 test software, like the "usbtest" driver, to put your hardware
739 and its driver through a basic set of functional tests.
741 Gadget Zero also works with the host-side "usb-skeleton" driver,
742 and with many kinds of host-side test software. You may need
743 to tweak product and vendor IDs before host software knows about
744 this device, and arrange to select an appropriate configuration.
746 Say "y" to link the driver statically, or "m" to build a
747 dynamically linked module called "g_zero".
749 config USB_ZERO_HNPTEST
750 boolean "HNP Test Device"
751 depends on USB_ZERO && USB_OTG
753 You can configure this device to enumerate using the device
754 identifiers of the USB-OTG test device. That means that when
755 this gadget connects to another OTG device, with this one using
756 the "B-Peripheral" role, that device will use HNP to let this
757 one serve as the USB host instead (in the "B-Host" role).
760 tristate "Audio Gadget"
762 select USB_LIBCOMPOSITE
765 This Gadget Audio driver is compatible with USB Audio Class
766 specification 2.0. It implements 1 AudioControl interface,
767 1 AudioStreaming Interface each for USB-OUT and USB-IN.
768 Number of channels, sample rate and sample size can be
769 specified as module parameters.
770 This driver doesn't expect any real Audio codec to be present
771 on the device - the audio streams are simply sinked to and
772 sourced from a virtual ALSA sound card created. The user-space
773 application may choose to do whatever it wants with the data
774 received from the USB Host and choose to provide whatever it
775 wants as audio data to the USB Host.
777 Say "y" to link the driver statically, or "m" to build a
778 dynamically linked module called "g_audio".
781 bool "UAC 1.0 (Legacy)"
784 If you instead want older UAC Spec-1.0 driver that also has audio
785 paths hardwired to the Audio codec chip on-board and doesn't work
789 tristate "Ethernet Gadget (with CDC Ethernet support)"
791 select USB_LIBCOMPOSITE
797 This driver implements Ethernet style communication, in one of
800 - The "Communication Device Class" (CDC) Ethernet Control Model.
801 That protocol is often avoided with pure Ethernet adapters, in
802 favor of simpler vendor-specific hardware, but is widely
803 supported by firmware for smart network devices.
805 - On hardware can't implement that protocol, a simple CDC subset
806 is used, placing fewer demands on USB.
808 - CDC Ethernet Emulation Model (EEM) is a newer standard that has
809 a simpler interface that can be used by more USB hardware.
811 RNDIS support is an additional option, more demanding than than
814 Within the USB device, this gadget driver exposes a network device
815 "usbX", where X depends on what other networking devices you have.
816 Treat it like a two-node Ethernet link: host, and gadget.
818 The Linux-USB host-side "usbnet" driver interoperates with this
819 driver, so that deep I/O queues can be supported. On 2.4 kernels,
820 use "CDCEther" instead, if you're using the CDC option. That CDC
821 mode should also interoperate with standard CDC Ethernet class
822 drivers on other host operating systems.
824 Say "y" to link the driver statically, or "m" to build a
825 dynamically linked module called "g_ether".
830 select USB_LIBCOMPOSITE
834 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
835 and Microsoft provides redistributable binary RNDIS drivers for
836 older versions of Windows.
838 If you say "y" here, the Ethernet gadget driver will try to provide
839 a second device configuration, supporting RNDIS to talk to such
842 To make MS-Windows work with this, use Documentation/usb/linux.inf
843 as the "driver info file". For versions of MS-Windows older than
844 XP, you'll need to download drivers from Microsoft's website; a URL
845 is given in comments found in that info file.
848 bool "Ethernet Emulation Model (EEM) support"
850 select USB_LIBCOMPOSITE
854 CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM
855 and therefore can be supported by more hardware. Technically ECM and
856 EEM are designed for different applications. The ECM model extends
857 the network interface to the target (e.g. a USB cable modem), and the
858 EEM model is for mobile devices to communicate with hosts using
859 ethernet over USB. For Linux gadgets, however, the interface with
860 the host is the same (a usbX device), so the differences are minimal.
862 If you say "y" here, the Ethernet gadget driver will use the EEM
863 protocol rather than ECM. If unsure, say "n".
866 tristate "Network Control Model (NCM) support"
868 select USB_LIBCOMPOSITE
873 This driver implements USB CDC NCM subclass standard. NCM is
874 an advanced protocol for Ethernet encapsulation, allows grouping
875 of several ethernet frames into one USB transfer and different
876 alignment possibilities.
878 Say "y" to link the driver statically, or "m" to build a
879 dynamically linked module called "g_ncm".
882 tristate "Gadget Filesystem"
884 This driver provides a filesystem based API that lets user mode
885 programs implement a single-configuration USB device, including
886 endpoint I/O and control requests that don't relate to enumeration.
887 All endpoints, transfer speeds, and transfer types supported by
888 the hardware are available, through read() and write() calls.
890 Say "y" to link the driver statically, or "m" to build a
891 dynamically linked module called "gadgetfs".
893 config USB_FUNCTIONFS
894 tristate "Function Filesystem"
895 select USB_LIBCOMPOSITE
897 select USB_FUNCTIONFS_GENERIC if !(USB_FUNCTIONFS_ETH || USB_FUNCTIONFS_RNDIS)
899 The Function Filesystem (FunctionFS) lets one create USB
900 composite functions in user space in the same way GadgetFS
901 lets one create USB gadgets in user space. This allows creation
902 of composite gadgets such that some of the functions are
903 implemented in kernel space (for instance Ethernet, serial or
904 mass storage) and other are implemented in user space.
906 If you say "y" or "m" here you will be able what kind of
907 configurations the gadget will provide.
909 Say "y" to link the driver statically, or "m" to build
910 a dynamically linked module called "g_ffs".
912 config USB_FUNCTIONFS_ETH
913 bool "Include configuration with CDC ECM (Ethernet)"
914 depends on USB_FUNCTIONFS && NET
919 Include a configuration with CDC ECM function (Ethernet) and the
922 config USB_FUNCTIONFS_RNDIS
923 bool "Include configuration with RNDIS (Ethernet)"
924 depends on USB_FUNCTIONFS && NET
928 Include a configuration with RNDIS function (Ethernet) and the Filesystem.
930 config USB_FUNCTIONFS_GENERIC
931 bool "Include 'pure' configuration"
932 depends on USB_FUNCTIONFS
934 Include a configuration with the Function Filesystem alone with
935 no Ethernet interface.
937 config USB_MASS_STORAGE
938 tristate "Mass Storage Gadget"
940 select USB_LIBCOMPOSITE
941 select USB_F_MASS_STORAGE
943 The Mass Storage Gadget acts as a USB Mass Storage disk drive.
944 As its storage repository it can use a regular file or a block
945 device (in much the same way as the "loop" device driver),
946 specified as a module parameter or sysfs option.
948 This driver is a replacement for now removed File-backed
949 Storage Gadget (g_file_storage).
951 Say "y" to link the driver statically, or "m" to build
952 a dynamically linked module called "g_mass_storage".
954 config USB_GADGET_TARGET
955 tristate "USB Gadget Target Fabric Module"
956 depends on TARGET_CORE
957 select USB_LIBCOMPOSITE
959 This fabric is an USB gadget. Two USB protocols are supported that is
960 BBB or BOT (Bulk Only Transport) and UAS (USB Attached SCSI). BOT is
961 advertised on alternative interface 0 (primary) and UAS is on
962 alternative interface 1. Both protocols can work on USB2.0 and USB3.0.
963 UAS utilizes the USB 3.0 feature called streams support.
966 tristate "Serial Gadget (with CDC ACM and CDC OBEX support)"
972 select USB_LIBCOMPOSITE
974 The Serial Gadget talks to the Linux-USB generic serial driver.
975 This driver supports a CDC-ACM module option, which can be used
976 to interoperate with MS-Windows hosts or with the Linux-USB
979 This driver also supports a CDC-OBEX option. You will need a
980 user space OBEX server talking to /dev/ttyGS*, since the kernel
981 itself doesn't implement the OBEX protocol.
983 Say "y" to link the driver statically, or "m" to build a
984 dynamically linked module called "g_serial".
986 For more information, see Documentation/usb/gadget_serial.txt
987 which includes instructions and a "driver info file" needed to
988 make MS-Windows work with CDC ACM.
990 config USB_MIDI_GADGET
991 tristate "MIDI Gadget"
993 select USB_LIBCOMPOSITE
996 The MIDI Gadget acts as a USB Audio device, with one MIDI
997 input and one MIDI output. These MIDI jacks appear as
998 a sound "card" in the ALSA sound system. Other MIDI
999 connections can then be made on the gadget system, using
1000 ALSA's aconnect utility etc.
1002 Say "y" to link the driver statically, or "m" to build a
1003 dynamically linked module called "g_midi".
1005 config USB_G_PRINTER
1006 tristate "Printer Gadget"
1007 select USB_LIBCOMPOSITE
1009 The Printer Gadget channels data between the USB host and a
1010 userspace program driving the print engine. The user space
1011 program reads and writes the device file /dev/g_printer to
1012 receive or send printer data. It can use ioctl calls to
1013 the device file to get or set printer status.
1015 Say "y" to link the driver statically, or "m" to build a
1016 dynamically linked module called "g_printer".
1018 For more information, see Documentation/usb/gadget_printer.txt
1019 which includes sample code for accessing the device file.
1023 config USB_CDC_COMPOSITE
1024 tristate "CDC Composite Device (Ethernet and ACM)"
1026 select USB_LIBCOMPOSITE
1032 This driver provides two functions in one configuration:
1033 a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link.
1035 This driver requires four bulk and two interrupt endpoints,
1036 plus the ability to handle altsettings. Not all peripheral
1037 controllers are that capable.
1039 Say "y" to link the driver statically, or "m" to build a
1040 dynamically linked module.
1043 tristate "Nokia composite gadget"
1045 select USB_LIBCOMPOSITE
1053 The Nokia composite gadget provides support for acm, obex
1054 and phonet in only one composite gadget driver.
1056 It's only really useful for N900 hardware. If you're building
1057 a kernel for N900, say Y or M here. If unsure, say N.
1060 tristate "CDC Composite Device (ACM and mass storage)"
1062 select USB_LIBCOMPOSITE
1065 select USB_F_MASS_STORAGE
1067 This driver provides two functions in one configuration:
1068 a mass storage, and a CDC ACM (serial port) link.
1070 Say "y" to link the driver statically, or "m" to build a
1071 dynamically linked module called "g_acm_ms".
1074 tristate "Multifunction Composite Gadget"
1075 depends on BLOCK && NET
1076 select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS
1077 select USB_LIBCOMPOSITE
1081 select USB_F_MASS_STORAGE
1083 The Multifunction Composite Gadget provides Ethernet (RNDIS
1084 and/or CDC Ethernet), mass storage and ACM serial link
1087 You will be asked to choose which of the two configurations is
1088 to be available in the gadget. At least one configuration must
1089 be chosen to make the gadget usable. Selecting more than one
1090 configuration will prevent Windows from automatically detecting
1091 the gadget as a composite gadget, so an INF file will be needed to
1094 Say "y" to link the driver statically, or "m" to build a
1095 dynamically linked module called "g_multi".
1097 config USB_G_MULTI_RNDIS
1098 bool "RNDIS + CDC Serial + Storage configuration"
1099 depends on USB_G_MULTI
1103 This option enables a configuration with RNDIS, CDC Serial and
1104 Mass Storage functions available in the Multifunction Composite
1105 Gadget. This is the configuration dedicated for Windows since RNDIS
1106 is Microsoft's protocol.
1110 config USB_G_MULTI_CDC
1111 bool "CDC Ethernet + CDC Serial + Storage configuration"
1112 depends on USB_G_MULTI
1116 This option enables a configuration with CDC Ethernet (ECM), CDC
1117 Serial and Mass Storage functions available in the Multifunction
1125 tristate "HID Gadget"
1126 select USB_LIBCOMPOSITE
1128 The HID gadget driver provides generic emulation of USB
1129 Human Interface Devices (HID).
1131 For more information, see Documentation/usb/gadget_hid.txt which
1132 includes sample code for accessing the device files.
1134 Say "y" to link the driver statically, or "m" to build a
1135 dynamically linked module called "g_hid".
1137 # Standalone / single function gadgets
1139 tristate "EHCI Debug Device Gadget"
1141 select USB_LIBCOMPOSITE
1143 This gadget emulates an EHCI Debug device. This is useful when you want
1144 to interact with an EHCI Debug Port.
1146 Say "y" to link the driver statically, or "m" to build a
1147 dynamically linked module called "g_dbgp".
1151 prompt "EHCI Debug Device mode"
1152 default USB_G_DBGP_SERIAL
1154 config USB_G_DBGP_PRINTK
1155 depends on USB_G_DBGP
1158 Directly printk() received data. No interaction.
1160 config USB_G_DBGP_SERIAL
1161 depends on USB_G_DBGP
1165 Userland can interact using /dev/ttyGSxxx.
1169 # put drivers that need isochronous transfer support (for audio
1170 # or video class gadget drivers), or specific hardware, here.
1172 tristate "USB Webcam Gadget"
1173 depends on VIDEO_DEV
1174 select USB_LIBCOMPOSITE
1175 select VIDEOBUF2_VMALLOC
1177 The Webcam Gadget acts as a composite USB Audio and Video Class
1178 device. It provides a userspace API to process UVC control requests
1179 and stream video data to the host.
1181 Say "y" to link the driver statically, or "m" to build a
1182 dynamically linked module called "g_webcam".