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 "Gadget Zero (DEVELOPMENT)"
18 select USB_LIBCOMPOSITE
21 Gadget Zero is a two-configuration device. It either sinks and
22 sources bulk data; or it loops back a configurable number of
23 transfers. It also implements control requests, for "chapter 9"
24 conformance. The driver needs only two bulk-capable endpoints, so
25 it can work on top of most device-side usb controllers. It's
26 useful for testing, and is also a working example showing how
27 USB "gadget drivers" can be written.
29 Make this be the first driver you try using on top of any new
30 USB peripheral controller driver. Then you can use host-side
31 test software, like the "usbtest" driver, to put your hardware
32 and its driver through a basic set of functional tests.
34 Gadget Zero also works with the host-side "usb-skeleton" driver,
35 and with many kinds of host-side test software. You may need
36 to tweak product and vendor IDs before host software knows about
37 this device, and arrange to select an appropriate configuration.
39 Say "y" to link the driver statically, or "m" to build a
40 dynamically linked module called "g_zero".
42 config USB_ZERO_HNPTEST
43 bool "HNP Test Device"
44 depends on USB_ZERO && USB_OTG
46 You can configure this device to enumerate using the device
47 identifiers of the USB-OTG test device. That means that when
48 this gadget connects to another OTG device, with this one using
49 the "B-Peripheral" role, that device will use HNP to let this
50 one serve as the USB host instead (in the "B-Host" role).
53 tristate "Audio Gadget"
55 select USB_LIBCOMPOSITE
57 select USB_F_UAC1_LEGACY if GADGET_UAC1_LEGACY
58 select USB_F_UAC2 if !GADGET_UAC1_LEGACY
59 select USB_U_AUDIO if USB_F_UAC2
61 This Gadget Audio driver is compatible with USB Audio Class
62 specification 2.0. It implements 1 AudioControl interface,
63 1 AudioStreaming Interface each for USB-OUT and USB-IN.
64 Number of channels, sample rate and sample size can be
65 specified as module parameters.
66 This driver doesn't expect any real Audio codec to be present
67 on the device - the audio streams are simply sinked to and
68 sourced from a virtual ALSA sound card created. The user-space
69 application may choose to do whatever it wants with the data
70 received from the USB Host and choose to provide whatever it
71 wants as audio data to the USB Host.
73 Say "y" to link the driver statically, or "m" to build a
74 dynamically linked module called "g_audio".
76 config GADGET_UAC1_LEGACY
77 bool "UAC 1.0 (Legacy)"
80 If you instead want older UAC Spec-1.0 driver that also has audio
81 paths hardwired to the Audio codec chip on-board and doesn't work
85 tristate "Ethernet Gadget (with CDC Ethernet support)"
87 select USB_LIBCOMPOSITE
93 This driver implements Ethernet style communication, in one of
96 - The "Communication Device Class" (CDC) Ethernet Control Model.
97 That protocol is often avoided with pure Ethernet adapters, in
98 favor of simpler vendor-specific hardware, but is widely
99 supported by firmware for smart network devices.
101 - On hardware can't implement that protocol, a simple CDC subset
102 is used, placing fewer demands on USB.
104 - CDC Ethernet Emulation Model (EEM) is a newer standard that has
105 a simpler interface that can be used by more USB hardware.
107 RNDIS support is an additional option, more demanding than subset.
109 Within the USB device, this gadget driver exposes a network device
110 "usbX", where X depends on what other networking devices you have.
111 Treat it like a two-node Ethernet link: host, and gadget.
113 The Linux-USB host-side "usbnet" driver interoperates with this
114 driver, so that deep I/O queues can be supported. On 2.4 kernels,
115 use "CDCEther" instead, if you're using the CDC option. That CDC
116 mode should also interoperate with standard CDC Ethernet class
117 drivers on other host operating systems.
119 Say "y" to link the driver statically, or "m" to build a
120 dynamically linked module called "g_ether".
125 select USB_LIBCOMPOSITE
129 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
130 and Microsoft provides redistributable binary RNDIS drivers for
131 older versions of Windows.
133 If you say "y" here, the Ethernet gadget driver will try to provide
134 a second device configuration, supporting RNDIS to talk to such
137 To make MS-Windows work with this, use Documentation/usb/linux.inf
138 as the "driver info file". For versions of MS-Windows older than
139 XP, you'll need to download drivers from Microsoft's website; a URL
140 is given in comments found in that info file.
143 bool "Ethernet Emulation Model (EEM) support"
145 select USB_LIBCOMPOSITE
149 CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM
150 and therefore can be supported by more hardware. Technically ECM and
151 EEM are designed for different applications. The ECM model extends
152 the network interface to the target (e.g. a USB cable modem), and the
153 EEM model is for mobile devices to communicate with hosts using
154 ethernet over USB. For Linux gadgets, however, the interface with
155 the host is the same (a usbX device), so the differences are minimal.
157 If you say "y" here, the Ethernet gadget driver will use the EEM
158 protocol rather than ECM. If unsure, say "n".
161 tristate "Network Control Model (NCM) support"
163 select USB_LIBCOMPOSITE
168 This driver implements USB CDC NCM subclass standard. NCM is
169 an advanced protocol for Ethernet encapsulation, allows grouping
170 of several ethernet frames into one USB transfer and different
171 alignment possibilities.
173 Say "y" to link the driver statically, or "m" to build a
174 dynamically linked module called "g_ncm".
177 tristate "Gadget Filesystem"
179 This driver provides a filesystem based API that lets user mode
180 programs implement a single-configuration USB device, including
181 endpoint I/O and control requests that don't relate to enumeration.
182 All endpoints, transfer speeds, and transfer types supported by
183 the hardware are available, through read() and write() calls.
185 Say "y" to link the driver statically, or "m" to build a
186 dynamically linked module called "gadgetfs".
188 config USB_FUNCTIONFS
189 tristate "Function Filesystem"
190 select USB_LIBCOMPOSITE
192 select USB_FUNCTIONFS_GENERIC if !(USB_FUNCTIONFS_ETH || USB_FUNCTIONFS_RNDIS)
194 The Function Filesystem (FunctionFS) lets one create USB
195 composite functions in user space in the same way GadgetFS
196 lets one create USB gadgets in user space. This allows creation
197 of composite gadgets such that some of the functions are
198 implemented in kernel space (for instance Ethernet, serial or
199 mass storage) and other are implemented in user space.
201 If you say "y" or "m" here you will be able what kind of
202 configurations the gadget will provide.
204 Say "y" to link the driver statically, or "m" to build
205 a dynamically linked module called "g_ffs".
207 config USB_FUNCTIONFS_ETH
208 bool "Include configuration with CDC ECM (Ethernet)"
209 depends on USB_FUNCTIONFS && NET
214 Include a configuration with CDC ECM function (Ethernet) and the
217 config USB_FUNCTIONFS_RNDIS
218 bool "Include configuration with RNDIS (Ethernet)"
219 depends on USB_FUNCTIONFS && NET
223 Include a configuration with RNDIS function (Ethernet) and the Filesystem.
225 config USB_FUNCTIONFS_GENERIC
226 bool "Include 'pure' configuration"
227 depends on USB_FUNCTIONFS
229 Include a configuration with the Function Filesystem alone with
230 no Ethernet interface.
232 config USB_MASS_STORAGE
233 tristate "Mass Storage Gadget"
235 select USB_LIBCOMPOSITE
236 select USB_F_MASS_STORAGE
238 The Mass Storage Gadget acts as a USB Mass Storage disk drive.
239 As its storage repository it can use a regular file or a block
240 device (in much the same way as the "loop" device driver),
241 specified as a module parameter or sysfs option.
243 This driver is a replacement for now removed File-backed
244 Storage Gadget (g_file_storage).
246 Say "y" to link the driver statically, or "m" to build
247 a dynamically linked module called "g_mass_storage".
249 config USB_GADGET_TARGET
250 tristate "USB Gadget Target Fabric Module"
251 depends on TARGET_CORE
252 select USB_LIBCOMPOSITE
255 This fabric is an USB gadget. Two USB protocols are supported that is
256 BBB or BOT (Bulk Only Transport) and UAS (USB Attached SCSI). BOT is
257 advertised on alternative interface 0 (primary) and UAS is on
258 alternative interface 1. Both protocols can work on USB2.0 and USB3.0.
259 UAS utilizes the USB 3.0 feature called streams support.
262 tristate "Serial Gadget (with CDC ACM and CDC OBEX support)"
268 select USB_LIBCOMPOSITE
270 The Serial Gadget talks to the Linux-USB generic serial driver.
271 This driver supports a CDC-ACM module option, which can be used
272 to interoperate with MS-Windows hosts or with the Linux-USB
275 This driver also supports a CDC-OBEX option. You will need a
276 user space OBEX server talking to /dev/ttyGS*, since the kernel
277 itself doesn't implement the OBEX protocol.
279 Say "y" to link the driver statically, or "m" to build a
280 dynamically linked module called "g_serial".
282 For more information, see Documentation/usb/gadget_serial.txt
283 which includes instructions and a "driver info file" needed to
284 make MS-Windows work with CDC ACM.
286 config USB_MIDI_GADGET
287 tristate "MIDI Gadget"
289 select USB_LIBCOMPOSITE
293 The MIDI Gadget acts as a USB Audio device, with one MIDI
294 input and one MIDI output. These MIDI jacks appear as
295 a sound "card" in the ALSA sound system. Other MIDI
296 connections can then be made on the gadget system, using
297 ALSA's aconnect utility etc.
299 Say "y" to link the driver statically, or "m" to build a
300 dynamically linked module called "g_midi".
303 tristate "Printer Gadget"
304 select USB_LIBCOMPOSITE
307 The Printer Gadget channels data between the USB host and a
308 userspace program driving the print engine. The user space
309 program reads and writes the device file /dev/g_printer to
310 receive or send printer data. It can use ioctl calls to
311 the device file to get or set printer status.
313 Say "y" to link the driver statically, or "m" to build a
314 dynamically linked module called "g_printer".
316 For more information, see Documentation/usb/gadget_printer.txt
317 which includes sample code for accessing the device file.
321 config USB_CDC_COMPOSITE
322 tristate "CDC Composite Device (Ethernet and ACM)"
324 select USB_LIBCOMPOSITE
330 This driver provides two functions in one configuration:
331 a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link.
333 This driver requires four bulk and two interrupt endpoints,
334 plus the ability to handle altsettings. Not all peripheral
335 controllers are that capable.
337 Say "y" to link the driver statically, or "m" to build a
338 dynamically linked module.
341 tristate "Nokia composite gadget"
344 select USB_LIBCOMPOSITE
351 select USB_F_MASS_STORAGE
353 The Nokia composite gadget provides support for acm, obex
354 and phonet in only one composite gadget driver.
356 It's only really useful for N900 hardware. If you're building
357 a kernel for N900, say Y or M here. If unsure, say N.
360 tristate "CDC Composite Device (ACM and mass storage)"
362 select USB_LIBCOMPOSITE
365 select USB_F_MASS_STORAGE
367 This driver provides two functions in one configuration:
368 a mass storage, and a CDC ACM (serial port) link.
370 Say "y" to link the driver statically, or "m" to build a
371 dynamically linked module called "g_acm_ms".
374 tristate "Multifunction Composite Gadget"
375 depends on BLOCK && NET
376 select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS
377 select USB_LIBCOMPOSITE
381 select USB_F_MASS_STORAGE
383 The Multifunction Composite Gadget provides Ethernet (RNDIS
384 and/or CDC Ethernet), mass storage and ACM serial link
387 You will be asked to choose which of the two configurations is
388 to be available in the gadget. At least one configuration must
389 be chosen to make the gadget usable. Selecting more than one
390 configuration will prevent Windows from automatically detecting
391 the gadget as a composite gadget, so an INF file will be needed to
394 Say "y" to link the driver statically, or "m" to build a
395 dynamically linked module called "g_multi".
397 config USB_G_MULTI_RNDIS
398 bool "RNDIS + CDC Serial + Storage configuration"
399 depends on USB_G_MULTI
403 This option enables a configuration with RNDIS, CDC Serial and
404 Mass Storage functions available in the Multifunction Composite
405 Gadget. This is the configuration dedicated for Windows since RNDIS
406 is Microsoft's protocol.
410 config USB_G_MULTI_CDC
411 bool "CDC Ethernet + CDC Serial + Storage configuration"
412 depends on USB_G_MULTI
416 This option enables a configuration with CDC Ethernet (ECM), CDC
417 Serial and Mass Storage functions available in the Multifunction
425 tristate "HID Gadget"
426 select USB_LIBCOMPOSITE
429 The HID gadget driver provides generic emulation of USB
430 Human Interface Devices (HID).
432 For more information, see Documentation/usb/gadget_hid.txt which
433 includes sample code for accessing the device files.
435 Say "y" to link the driver statically, or "m" to build a
436 dynamically linked module called "g_hid".
438 # Standalone / single function gadgets
440 tristate "EHCI Debug Device Gadget"
442 select USB_LIBCOMPOSITE
444 This gadget emulates an EHCI Debug device. This is useful when you want
445 to interact with an EHCI Debug Port.
447 Say "y" to link the driver statically, or "m" to build a
448 dynamically linked module called "g_dbgp".
452 prompt "EHCI Debug Device mode"
453 default USB_G_DBGP_SERIAL
455 config USB_G_DBGP_PRINTK
456 depends on USB_G_DBGP
459 Directly printk() received data. No interaction.
461 config USB_G_DBGP_SERIAL
462 depends on USB_G_DBGP
466 Userland can interact using /dev/ttyGSxxx.
470 # put drivers that need isochronous transfer support (for audio
471 # or video class gadget drivers), or specific hardware, here.
473 tristate "USB Webcam Gadget"
475 select USB_LIBCOMPOSITE
476 select VIDEOBUF2_VMALLOC
479 The Webcam Gadget acts as a composite USB Audio and Video Class
480 device. It provides a userspace API to process UVC control requests
481 and stream video data to the host.
483 Say "y" to link the driver statically, or "m" to build a
484 dynamically linked module called "g_webcam".