blob: 7351e4a1fb693c80f0252e91ee9f6039c6515353 [file] [log] [blame]
yuezonghe824eb0c2024-06-27 02:32:26 -07001#
2# USB Gadget support on a system involves
3# (a) a peripheral controller, and
4# (b) the gadget driver using it.
5#
6# NOTE: Gadget support ** DOES NOT ** depend on host-side CONFIG_USB !!
7#
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.
11#
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).
14#
15
16menuconfig USB_GADGET
17 tristate "USB Gadget Support"
18 select NLS
19 help
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.
24
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
31 motherboards.
32
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.)
38
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).
41
42 For more information, see <http://www.linux-usb.org/gadget> and
43 the kernel DocBook documentation for this API.
44
45if USB_GADGET
46
47config USB_GADGET_DEBUG
48 boolean "Debugging messages (DEVELOPMENT)"
49 depends on DEBUG_KERNEL
50 help
51 Many controller and gadget drivers will print some debugging
52 messages if you use this option to ask for those messages.
53
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
59 production build.
60
61config USB_GADGET_DEBUG_FILES
62 boolean "Debugging information files (DEVELOPMENT)"
63 depends on PROC_FS
64 help
65 Some of the drivers in the "gadget" framework can expose
66 debugging information in files such as /proc/driver/udc
67 (for a peripheral controller). The information in these
68 files may help when you're troubleshooting or bringing up a
69 driver on a new board. Enable these files by choosing "Y"
70 here. If in doubt, or to conserve kernel memory, say "N".
71
72config USB_GADGET_DEBUG_FS
73 boolean "Debugging information files in debugfs (DEVELOPMENT)"
74 depends on DEBUG_FS
75 help
76 Some of the drivers in the "gadget" framework can expose
77 debugging information in files under /sys/kernel/debug/.
78 The information in these files may help when you're
79 troubleshooting or bringing up a driver on a new board.
80 Enable these files by choosing "Y" here. If in doubt, or
81 to conserve kernel memory, say "N".
82
83config USB_GADGET_VBUS_DRAW
84 int "Maximum VBUS Power usage (2-500 mA)"
85 range 2 500
86 default 2
87 help
88 Some devices need to draw power from USB when they are
89 configured, perhaps to operate circuitry or to recharge
90 batteries. This is in addition to any local power supply,
91 such as an AC adapter or batteries.
92
93 Enter the maximum power your device draws through USB, in
94 milliAmperes. The permitted range of values is 2 - 500 mA;
95 0 mA would be legal, but can make some hosts misbehave.
96
97 This value will be used except for system-specific gadget
98 drivers that have more specific information.
99
100config USB_GADGET_STORAGE_NUM_BUFFERS
101 int "Number of storage pipeline buffers"
102 range 2 4
103 default 2
104 help
105 Usually 2 buffers are enough to establish a good buffering
106 pipeline. The number may be increased in order to compensate
107 for a bursty VFS behaviour. For instance there may be CPU wake up
108 latencies that makes the VFS to appear bursty in a system with
109 an CPU on-demand governor. Especially if DMA is doing IO to
110 offload the CPU. In this case the CPU will go into power
111 save often and spin up occasionally to move data within VFS.
112 If selecting USB_GADGET_DEBUG_FILES this value may be set by
113 a module parameter as well.
114 If unsure, say 2.
115
116#
117# USB Peripheral Controller Support
118#
119# The order here is alphabetical, except that integrated controllers go
120# before discrete ones so they will be the initial/default value:
121# - integrated/SOC controllers first
122# - licensed IP used in both SOC and discrete versions
123# - discrete ones (including all PCI-only controllers)
124# - debug/dummy gadget+hcd is last.
125#
126choice
127 prompt "USB Peripheral Controller"
128 help
129 A USB device uses a controller to talk to its host.
130 Systems should have only one such upstream link.
131 Many controller drivers are platform-specific; these
132 often need board-specific hooks.
133
134#
135# Integrated controllers
136#
137
138config USB_AT91
139 tristate "Atmel AT91 USB Device Port"
140 depends on ARCH_AT91
141 help
142 Many Atmel AT91 processors (such as the AT91RM2000) have a
143 full speed USB Device Port with support for five configurable
144 endpoints (plus endpoint zero).
145
146 Say "y" to link the driver statically, or "m" to build a
147 dynamically linked module called "at91_udc" and force all
148 gadget drivers to also be dynamically linked.
149
150config USB_ATMEL_USBA
151 tristate "Atmel USBA"
152 select USB_GADGET_DUALSPEED
153 depends on AVR32 || ARCH_AT91SAM9RL || ARCH_AT91SAM9G45
154 help
155 USBA is the integrated high-speed USB Device controller on
156 the AT32AP700x, some AT91SAM9 and AT91CAP9 processors from Atmel.
157
158config USB_FSL_USB2
159 tristate "Freescale Highspeed USB DR Peripheral Controller"
160 depends on FSL_SOC || ARCH_MXC
161 select USB_GADGET_DUALSPEED
162 select USB_FSL_MPH_DR_OF if OF
163 help
164 Some of Freescale PowerPC processors have a High Speed
165 Dual-Role(DR) USB controller, which supports device mode.
166
167 The number of programmable endpoints is different through
168 SOC revisions.
169
170 Say "y" to link the driver statically, or "m" to build a
171 dynamically linked module called "fsl_usb2_udc" and force
172 all gadget drivers to also be dynamically linked.
173
174config USB_NONE
175 tristate "USB Peripheral Controller None"
176 help
177 USB Peripheral Controller None
178
179config USB_FUSB300
180 tristate "Faraday FUSB300 USB Peripheral Controller"
181 depends on !PHYS_ADDR_T_64BIT
182 select USB_GADGET_DUALSPEED
183 help
184 Faraday usb device controller FUSB300 driver
185
186config USB_OMAP
187 tristate "OMAP USB Device Controller"
188 depends on ARCH_OMAP
189 select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3 || MACH_OMAP_H4_OTG
190 select USB_OTG_UTILS if ARCH_OMAP
191 help
192 Many Texas Instruments OMAP processors have flexible full
193 speed USB device controllers, with support for up to 30
194 endpoints (plus endpoint zero). This driver supports the
195 controller in the OMAP 1611, and should work with controllers
196 in other OMAP processors too, given minor tweaks.
197
198 Say "y" to link the driver statically, or "m" to build a
199 dynamically linked module called "omap_udc" and force all
200 gadget drivers to also be dynamically linked.
201
202config USB_PXA25X
203 tristate "PXA 25x or IXP 4xx"
204 depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX
205 select USB_OTG_UTILS
206 help
207 Intel's PXA 25x series XScale ARM-5TE processors include
208 an integrated full speed USB 1.1 device controller. The
209 controller in the IXP 4xx series is register-compatible.
210
211 It has fifteen fixed-function endpoints, as well as endpoint
212 zero (for control transfers).
213
214 Say "y" to link the driver statically, or "m" to build a
215 dynamically linked module called "pxa25x_udc" and force all
216 gadget drivers to also be dynamically linked.
217
218# if there's only one gadget driver, using only two bulk endpoints,
219# don't waste memory for the other endpoints
220config USB_PXA25X_SMALL
221 depends on USB_PXA25X
222 bool
223 default n if USB_ETH_RNDIS
224 default y if USB_ZERO
225 default y if USB_ETH
226 default y if USB_G_SERIAL
227
228config USB_R8A66597
229 tristate "Renesas R8A66597 USB Peripheral Controller"
230 select USB_GADGET_DUALSPEED
231 help
232 R8A66597 is a discrete USB host and peripheral controller chip that
233 supports both full and high speed USB 2.0 data transfers.
234 It has nine configurable endpoints, and endpoint zero.
235
236 Say "y" to link the driver statically, or "m" to build a
237 dynamically linked module called "r8a66597_udc" and force all
238 gadget drivers to also be dynamically linked.
239
240config USB_RENESAS_USBHS_UDC
241 tristate 'Renesas USBHS controller'
242 depends on USB_RENESAS_USBHS
243 select USB_GADGET_DUALSPEED
244 help
245 Renesas USBHS is a discrete USB host and peripheral controller chip
246 that supports both full and high speed USB 2.0 data transfers.
247 It has nine or more configurable endpoints, and endpoint zero.
248
249 Say "y" to link the driver statically, or "m" to build a
250 dynamically linked module called "renesas_usbhs" and force all
251 gadget drivers to also be dynamically linked.
252
253config USB_PXA27X
254 tristate "PXA 27x"
255 depends on ARCH_PXA && (PXA27x || PXA3xx)
256 select USB_OTG_UTILS
257 help
258 Intel's PXA 27x series XScale ARM v5TE processors include
259 an integrated full speed USB 1.1 device controller.
260
261 It has up to 23 endpoints, as well as endpoint zero (for
262 control transfers).
263
264 Say "y" to link the driver statically, or "m" to build a
265 dynamically linked module called "pxa27x_udc" and force all
266 gadget drivers to also be dynamically linked.
267
268config USB_S3C_HSOTG
269 tristate "S3C HS/OtG USB Device controller"
270 depends on S3C_DEV_USB_HSOTG
271 select USB_GADGET_DUALSPEED
272 help
273 The Samsung S3C64XX USB2.0 high-speed gadget controller
274 integrated into the S3C64XX series SoC.
275
276config USB_IMX
277 tristate "Freescale i.MX1 USB Peripheral Controller"
278 depends on ARCH_MXC
279 help
280 Freescale's i.MX1 includes an integrated full speed
281 USB 1.1 device controller.
282
283 It has Six fixed-function endpoints, as well as endpoint
284 zero (for control transfers).
285
286 Say "y" to link the driver statically, or "m" to build a
287 dynamically linked module called "imx_udc" and force all
288 gadget drivers to also be dynamically linked.
289
290config USB_S3C2410
291 tristate "S3C2410 USB Device Controller"
292 depends on ARCH_S3C24XX
293 help
294 Samsung's S3C2410 is an ARM-4 processor with an integrated
295 full speed USB 1.1 device controller. It has 4 configurable
296 endpoints, as well as endpoint zero (for control transfers).
297
298 This driver has been tested on the S3C2410, S3C2412, and
299 S3C2440 processors.
300
301config USB_S3C2410_DEBUG
302 boolean "S3C2410 udc debug messages"
303 depends on USB_S3C2410
304
305config USB_S3C_HSUDC
306 tristate "S3C2416, S3C2443 and S3C2450 USB Device Controller"
307 depends on ARCH_S3C24XX
308 select USB_GADGET_DUALSPEED
309 help
310 Samsung's S3C2416, S3C2443 and S3C2450 is an ARM9 based SoC
311 integrated with dual speed USB 2.0 device controller. It has
312 8 endpoints, as well as endpoint zero.
313
314 This driver has been tested on S3C2416 and S3C2450 processors.
315
316config USB_MV_UDC
317 tristate "Marvell USB2.0 Device Controller"
318 select USB_GADGET_DUALSPEED
319 help
320 Marvell Socs (including PXA and MMP series) include a high speed
321 USB2.0 OTG controller, which can be configured as high speed or
322 full speed USB peripheral.
323
324#
325# Controllers available in both integrated and discrete versions
326#
327
328# musb builds in ../musb along with host support
329config USB_GADGET_MUSB_HDRC
330 tristate "Inventra HDRC USB Peripheral (TI, ADI, ...)"
331 depends on USB_MUSB_HDRC
332 select USB_GADGET_DUALSPEED
333 help
334 This OTG-capable silicon IP is used in dual designs including
335 the TI DaVinci, OMAP 243x, OMAP 343x, TUSB 6010, and ADI Blackfin
336
337config USB_M66592
338 tristate "Renesas M66592 USB Peripheral Controller"
339 select USB_GADGET_DUALSPEED
340 help
341 M66592 is a discrete USB peripheral controller chip that
342 supports both full and high speed USB 2.0 data transfers.
343 It has seven configurable endpoints, and endpoint zero.
344
345 Say "y" to link the driver statically, or "m" to build a
346 dynamically linked module called "m66592_udc" and force all
347 gadget drivers to also be dynamically linked.
348
349#
350# Controllers available only in discrete form (and all PCI controllers)
351#
352
353config USB_AMD5536UDC
354 tristate "AMD5536 UDC"
355 depends on PCI
356 select USB_GADGET_DUALSPEED
357 help
358 The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
359 It is a USB Highspeed DMA capable USB device controller. Beside ep0
360 it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
361 The UDC port supports OTG operation, and may be used as a host port
362 if it's not being used to implement peripheral or OTG roles.
363
364 Say "y" to link the driver statically, or "m" to build a
365 dynamically linked module called "amd5536udc" and force all
366 gadget drivers to also be dynamically linked.
367
368config USB_FSL_QE
369 tristate "Freescale QE/CPM USB Device Controller"
370 depends on FSL_SOC && (QUICC_ENGINE || CPM)
371 help
372 Some of Freescale PowerPC processors have a Full Speed
373 QE/CPM2 USB controller, which support device mode with 4
374 programmable endpoints. This driver supports the
375 controller in the MPC8360 and MPC8272, and should work with
376 controllers having QE or CPM2, given minor tweaks.
377
378 Set CONFIG_USB_GADGET to "m" to build this driver as a
379 dynamically linked module called "fsl_qe_udc".
380
381config USB_CI13XXX_PCI
382 tristate "MIPS USB CI13xxx PCI UDC"
383 depends on PCI
384 select USB_GADGET_DUALSPEED
385 help
386 MIPS USB IP core family device controller
387 Currently it only supports IP part number CI13412
388
389 Say "y" to link the driver statically, or "m" to build a
390 dynamically linked module called "ci13xxx_udc" and force all
391 gadget drivers to also be dynamically linked.
392
393config USB_NET2272
394 tristate "PLX NET2272"
395 select USB_GADGET_DUALSPEED
396 help
397 PLX NET2272 is a USB peripheral controller which supports
398 both full and high speed USB 2.0 data transfers.
399
400 It has three configurable endpoints, as well as endpoint zero
401 (for control transfer).
402 Say "y" to link the driver statically, or "m" to build a
403 dynamically linked module called "net2272" and force all
404 gadget drivers to also be dynamically linked.
405
406config USB_NET2272_DMA
407 boolean "Support external DMA controller"
408 depends on USB_NET2272
409 help
410 The NET2272 part can optionally support an external DMA
411 controller, but your board has to have support in the
412 driver itself.
413
414 If unsure, say "N" here. The driver works fine in PIO mode.
415
416config USB_NET2280
417 tristate "NetChip 228x"
418 depends on PCI
419 select USB_GADGET_DUALSPEED
420 help
421 NetChip 2280 / 2282 is a PCI based USB peripheral controller which
422 supports both full and high speed USB 2.0 data transfers.
423
424 It has six configurable endpoints, as well as endpoint zero
425 (for control transfers) and several endpoints with dedicated
426 functions.
427
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.
431
432config USB_GOKU
433 tristate "Toshiba TC86C001 'Goku-S'"
434 depends on PCI
435 help
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).
438
439 The device controller has three configurable (bulk or interrupt)
440 endpoints, plus endpoint zero (for control transfers).
441
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.
445
446config USB_LANGWELL
447 tristate "Intel Langwell USB Device Controller"
448 depends on PCI
449 depends on !PHYS_ADDR_T_64BIT
450 select USB_GADGET_DUALSPEED
451 help
452 Intel Langwell USB Device Controller is a High-Speed USB
453 On-The-Go device controller.
454
455 The number of programmable endpoints is different through
456 controller revision.
457
458 Say "y" to link the driver statically, or "m" to build a
459 dynamically linked module called "langwell_udc" and force all
460 gadget drivers to also be dynamically linked.
461
462config USB_EG20T
463 tristate "Intel EG20T PCH/LAPIS Semiconductor IOH(ML7213/ML7831) UDC"
464 depends on PCI
465 select USB_GADGET_DUALSPEED
466 help
467 This is a USB device driver for EG20T PCH.
468 EG20T PCH is the platform controller hub that is used in Intel's
469 general embedded platform. EG20T PCH has USB device interface.
470 Using this interface, it is able to access system devices connected
471 to USB device.
472 This driver enables USB device function.
473 USB device is a USB peripheral controller which
474 supports both full and high speed USB 2.0 data transfers.
475 This driver supports both control transfer and bulk transfer modes.
476 This driver dose not support interrupt transfer or isochronous
477 transfer modes.
478
479 This driver also can be used for LAPIS Semiconductor's ML7213 which is
480 for IVI(In-Vehicle Infotainment) use.
481 ML7831 is for general purpose use.
482 ML7213/ML7831 is companion chip for Intel Atom E6xx series.
483 ML7213/ML7831 is completely compatible for Intel EG20T PCH.
484
485config USB_CI13XXX_MSM
486 tristate "MIPS USB CI13xxx for MSM"
487 depends on ARCH_MSM
488 select USB_GADGET_DUALSPEED
489 select USB_MSM_OTG
490 help
491 MSM SoC has chipidea USB controller. This driver uses
492 ci13xxx_udc core.
493 This driver depends on OTG driver for PHY initialization,
494 clock management, powering up VBUS, and power management.
495 This driver is not supported on boards like trout which
496 has an external PHY.
497
498 Say "y" to link the driver statically, or "m" to build a
499 dynamically linked module called "ci13xxx_msm" and force all
500 gadget drivers to also be dynamically linked.
501
502#
503# LAST -- dummy/emulated controller
504#
505
506config USB_DUMMY_HCD
507 tristate "Dummy HCD (DEVELOPMENT)"
508 depends on USB=y || (USB=m && USB_GADGET=m)
509 select USB_GADGET_DUALSPEED
510 select USB_GADGET_SUPERSPEED
511 help
512 This host controller driver emulates USB, looping all data transfer
513 requests back to a USB "gadget driver" in the same host. The host
514 side is the master; the gadget side is the slave. Gadget drivers
515 can be high, full, or low speed; and they have access to endpoints
516 like those from NET2280, PXA2xx, or SA1100 hardware.
517
518 This may help in some stages of creating a driver to embed in a
519 Linux device, since it lets you debug several parts of the gadget
520 driver without its hardware or drivers being involved.
521
522 Since such a gadget side driver needs to interoperate with a host
523 side Linux-USB device driver, this may help to debug both sides
524 of a USB protocol stack.
525
526 Say "y" to link the driver statically, or "m" to build a
527 dynamically linked module called "dummy_hcd" and force all
528 gadget drivers to also be dynamically linked.
529
530# NOTE: Please keep dummy_hcd LAST so that "real hardware" appears
531# first and will be selected by default.
532
533endchoice
534
535# Selected by UDC drivers that support high-speed operation.
536config USB_GADGET_DUALSPEED
537 bool
538
539# Selected by UDC drivers that support super-speed opperation
540config USB_GADGET_SUPERSPEED
541 bool
542 depends on USB_GADGET_DUALSPEED
543
544#
545# USB Gadget Drivers
546#
547choice
548 tristate "USB Gadget Drivers"
549 default USB_GADGET_NONE
550 help
551 A Linux "Gadget Driver" talks to the USB Peripheral Controller
552 driver through the abstract "gadget" API. Some other operating
553 systems call these "client" drivers, of which "class drivers"
554 are a subset (implementing a USB device class specification).
555 A gadget driver implements one or more USB functions using
556 the peripheral hardware.
557
558 Gadget drivers are hardware-neutral, or "platform independent",
559 except that they sometimes must understand quirks or limitations
560 of the particular controllers they work with. For example, when
561 a controller doesn't support alternate configurations or provide
562 enough of the right types of endpoints, the gadget driver might
563 not be able work with that controller, or might need to implement
564 a less common variant of a device class protocol.
565
566# this first set of drivers all depend on bulk-capable hardware.
567
568config USB_GADGET_NONE
569 tristate "USB Gadget None"
570 help
571 USB Gadget None
572
573config USB_ZERO
574 tristate "Gadget Zero (DEVELOPMENT)"
575 help
576 Gadget Zero is a two-configuration device. It either sinks and
577 sources bulk data; or it loops back a configurable number of
578 transfers. It also implements control requests, for "chapter 9"
579 conformance. The driver needs only two bulk-capable endpoints, so
580 it can work on top of most device-side usb controllers. It's
581 useful for testing, and is also a working example showing how
582 USB "gadget drivers" can be written.
583
584 Make this be the first driver you try using on top of any new
585 USB peripheral controller driver. Then you can use host-side
586 test software, like the "usbtest" driver, to put your hardware
587 and its driver through a basic set of functional tests.
588
589 Gadget Zero also works with the host-side "usb-skeleton" driver,
590 and with many kinds of host-side test software. You may need
591 to tweak product and vendor IDs before host software knows about
592 this device, and arrange to select an appropriate configuration.
593
594 Say "y" to link the driver statically, or "m" to build a
595 dynamically linked module called "g_zero".
596
597config USB_ZERO_HNPTEST
598 boolean "HNP Test Device"
599 depends on USB_ZERO && USB_OTG
600 help
601 You can configure this device to enumerate using the device
602 identifiers of the USB-OTG test device. That means that when
603 this gadget connects to another OTG device, with this one using
604 the "B-Peripheral" role, that device will use HNP to let this
605 one serve as the USB host instead (in the "B-Host" role).
606
607config USB_AUDIO
608 tristate "Audio Gadget (EXPERIMENTAL)"
609 depends on SND
610 select SND_PCM
611 help
612 This Gadget Audio driver is compatible with USB Audio Class
613 specification 2.0. It implements 1 AudioControl interface,
614 1 AudioStreaming Interface each for USB-OUT and USB-IN.
615 Number of channels, sample rate and sample size can be
616 specified as module parameters.
617 This driver doesn't expect any real Audio codec to be present
618 on the device - the audio streams are simply sinked to and
619 sourced from a virtual ALSA sound card created. The user-space
620 application may choose to do whatever it wants with the data
621 received from the USB Host and choose to provide whatever it
622 wants as audio data to the USB Host.
623
624 Say "y" to link the driver statically, or "m" to build a
625 dynamically linked module called "g_audio".
626
627config GADGET_UAC1
628 bool "UAC 1.0 (Legacy)"
629 depends on USB_AUDIO
630 help
631 If you instead want older UAC Spec-1.0 driver that also has audio
632 paths hardwired to the Audio codec chip on-board and doesn't work
633 without one.
634
635config USB_ETH
636 tristate "Ethernet Gadget (with CDC Ethernet support)"
637 depends on NET
638 select CRC32
639 help
640 This driver implements Ethernet style communication, in one of
641 several ways:
642
643 - The "Communication Device Class" (CDC) Ethernet Control Model.
644 That protocol is often avoided with pure Ethernet adapters, in
645 favor of simpler vendor-specific hardware, but is widely
646 supported by firmware for smart network devices.
647
648 - On hardware can't implement that protocol, a simple CDC subset
649 is used, placing fewer demands on USB.
650
651 - CDC Ethernet Emulation Model (EEM) is a newer standard that has
652 a simpler interface that can be used by more USB hardware.
653
654 RNDIS support is an additional option, more demanding than than
655 subset.
656
657 Within the USB device, this gadget driver exposes a network device
658 "usbX", where X depends on what other networking devices you have.
659 Treat it like a two-node Ethernet link: host, and gadget.
660
661 The Linux-USB host-side "usbnet" driver interoperates with this
662 driver, so that deep I/O queues can be supported. On 2.4 kernels,
663 use "CDCEther" instead, if you're using the CDC option. That CDC
664 mode should also interoperate with standard CDC Ethernet class
665 drivers on other host operating systems.
666
667 Say "y" to link the driver statically, or "m" to build a
668 dynamically linked module called "g_ether".
669
670config USB_ETH_RNDIS
671 bool "RNDIS support"
672 depends on USB_ETH
673 default y
674 help
675 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
676 and Microsoft provides redistributable binary RNDIS drivers for
677 older versions of Windows.
678
679 If you say "y" here, the Ethernet gadget driver will try to provide
680 a second device configuration, supporting RNDIS to talk to such
681 Microsoft USB hosts.
682
683 To make MS-Windows work with this, use Documentation/usb/linux.inf
684 as the "driver info file". For versions of MS-Windows older than
685 XP, you'll need to download drivers from Microsoft's website; a URL
686 is given in comments found in that info file.
687
688config USB_ETH_EEM
689 bool "Ethernet Emulation Model (EEM) support"
690 depends on USB_ETH
691 default n
692 help
693 CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM
694 and therefore can be supported by more hardware. Technically ECM and
695 EEM are designed for different applications. The ECM model extends
696 the network interface to the target (e.g. a USB cable modem), and the
697 EEM model is for mobile devices to communicate with hosts using
698 ethernet over USB. For Linux gadgets, however, the interface with
699 the host is the same (a usbX device), so the differences are minimal.
700
701 If you say "y" here, the Ethernet gadget driver will use the EEM
702 protocol rather than ECM. If unsure, say "n".
703
704config USB_G_NCM
705 tristate "Network Control Model (NCM) support"
706 depends on NET
707 select CRC32
708 help
709 This driver implements USB CDC NCM subclass standard. NCM is
710 an advanced protocol for Ethernet encapsulation, allows grouping
711 of several ethernet frames into one USB transfer and different
712 alignment possibilities.
713
714 Say "y" to link the driver statically, or "m" to build a
715 dynamically linked module called "g_ncm".
716
717config USB_GADGETFS
718 tristate "Gadget Filesystem (EXPERIMENTAL)"
719 depends on EXPERIMENTAL
720 help
721 This driver provides a filesystem based API that lets user mode
722 programs implement a single-configuration USB device, including
723 endpoint I/O and control requests that don't relate to enumeration.
724 All endpoints, transfer speeds, and transfer types supported by
725 the hardware are available, through read() and write() calls.
726
727 Currently, this option is still labelled as EXPERIMENTAL because
728 of existing race conditions in the underlying in-kernel AIO core.
729
730 Say "y" to link the driver statically, or "m" to build a
731 dynamically linked module called "gadgetfs".
732
733config USB_FUNCTIONFS
734 tristate "Function Filesystem (EXPERIMENTAL)"
735 depends on EXPERIMENTAL
736 select USB_FUNCTIONFS_GENERIC if !(USB_FUNCTIONFS_ETH || USB_FUNCTIONFS_RNDIS)
737 help
738 The Function Filesystem (FunctionFS) lets one create USB
739 composite functions in user space in the same way GadgetFS
740 lets one create USB gadgets in user space. This allows creation
741 of composite gadgets such that some of the functions are
742 implemented in kernel space (for instance Ethernet, serial or
743 mass storage) and other are implemented in user space.
744
745 If you say "y" or "m" here you will be able what kind of
746 configurations the gadget will provide.
747
748 Say "y" to link the driver statically, or "m" to build
749 a dynamically linked module called "g_ffs".
750
751config USB_FUNCTIONFS_ETH
752 bool "Include configuration with CDC ECM (Ethernet)"
753 depends on USB_FUNCTIONFS && NET
754 help
755 Include a configuration with CDC ECM function (Ethernet) and the
756 Function Filesystem.
757
758config USB_FUNCTIONFS_RNDIS
759 bool "Include configuration with RNDIS (Ethernet)"
760 depends on USB_FUNCTIONFS && NET
761 help
762 Include a configuration with RNDIS function (Ethernet) and the Filesystem.
763
764config USB_FUNCTIONFS_GENERIC
765 bool "Include 'pure' configuration"
766 depends on USB_FUNCTIONFS
767 help
768 Include a configuration with the Function Filesystem alone with
769 no Ethernet interface.
770
771config USB_FILE_STORAGE
772 tristate "File-backed Storage Gadget (DEPRECATED)"
773 depends on BLOCK
774 help
775 The File-backed Storage Gadget acts as a USB Mass Storage
776 disk drive. As its storage repository it can use a regular
777 file or a block device (in much the same way as the "loop"
778 device driver), specified as a module parameter.
779
780 Say "y" to link the driver statically, or "m" to build a
781 dynamically linked module called "g_file_storage".
782
783 NOTE: This driver is deprecated. Its replacement is the
784 Mass Storage Gadget.
785
786config USB_FILE_STORAGE_TEST
787 bool "File-backed Storage Gadget testing version"
788 depends on USB_FILE_STORAGE
789 default n
790 help
791 Say "y" to generate the larger testing version of the
792 File-backed Storage Gadget, useful for probing the
793 behavior of USB Mass Storage hosts. Not needed for
794 normal operation.
795
796config USB_MASS_STORAGE
797 tristate "Mass Storage Gadget"
798 depends on BLOCK
799 help
800 The Mass Storage Gadget acts as a USB Mass Storage disk drive.
801 As its storage repository it can use a regular file or a block
802 device (in much the same way as the "loop" device driver),
803 specified as a module parameter or sysfs option.
804
805 This driver is an updated replacement for the deprecated
806 File-backed Storage Gadget (g_file_storage).
807
808 Say "y" to link the driver statically, or "m" to build
809 a dynamically linked module called "g_mass_storage".
810
811config USB_G_SERIAL
812 tristate "Serial Gadget (with CDC ACM and CDC OBEX support)"
813 help
814 The Serial Gadget talks to the Linux-USB generic serial driver.
815 This driver supports a CDC-ACM module option, which can be used
816 to interoperate with MS-Windows hosts or with the Linux-USB
817 "cdc-acm" driver.
818
819 This driver also supports a CDC-OBEX option. You will need a
820 user space OBEX server talking to /dev/ttyGS*, since the kernel
821 itself doesn't implement the OBEX protocol.
822
823 Say "y" to link the driver statically, or "m" to build a
824 dynamically linked module called "g_serial".
825
826 For more information, see Documentation/usb/gadget_serial.txt
827 which includes instructions and a "driver info file" needed to
828 make MS-Windows work with CDC ACM.
829
830config USB_MIDI_GADGET
831 tristate "MIDI Gadget (EXPERIMENTAL)"
832 depends on SND && EXPERIMENTAL
833 select SND_RAWMIDI
834 help
835 The MIDI Gadget acts as a USB Audio device, with one MIDI
836 input and one MIDI output. These MIDI jacks appear as
837 a sound "card" in the ALSA sound system. Other MIDI
838 connections can then be made on the gadget system, using
839 ALSA's aconnect utility etc.
840
841 Say "y" to link the driver statically, or "m" to build a
842 dynamically linked module called "g_midi".
843
844config USB_G_PRINTER
845 tristate "Printer Gadget"
846 help
847 The Printer Gadget channels data between the USB host and a
848 userspace program driving the print engine. The user space
849 program reads and writes the device file /dev/g_printer to
850 receive or send printer data. It can use ioctl calls to
851 the device file to get or set printer status.
852
853 Say "y" to link the driver statically, or "m" to build a
854 dynamically linked module called "g_printer".
855
856 For more information, see Documentation/usb/gadget_printer.txt
857 which includes sample code for accessing the device file.
858
859config USB_G_ANDROID
860 boolean "Android Composite Gadget"
861 help
862 The Android Composite Gadget supports multiple USB
863 functions: adb, acm, mass storage, mtp, accessory
864 and rndis.
865 Each function can be configured and enabled/disabled
866 dynamically from userspace through a sysfs interface.
867
868config USB_CDC_COMPOSITE
869 tristate "CDC Composite Device (Ethernet and ACM)"
870 depends on NET
871 help
872 This driver provides two functions in one configuration:
873 a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link.
874
875 This driver requires four bulk and two interrupt endpoints,
876 plus the ability to handle altsettings. Not all peripheral
877 controllers are that capable.
878
879 Say "y" to link the driver statically, or "m" to build a
880 dynamically linked module.
881
882config USB_G_NOKIA
883 tristate "Nokia composite gadget"
884 depends on PHONET
885 help
886 The Nokia composite gadget provides support for acm, obex
887 and phonet in only one composite gadget driver.
888
889 It's only really useful for N900 hardware. If you're building
890 a kernel for N900, say Y or M here. If unsure, say N.
891
892config USB_G_ACM_MS
893 tristate "CDC Composite Device (ACM and mass storage)"
894 depends on BLOCK
895 help
896 This driver provides two functions in one configuration:
897 a mass storage, and a CDC ACM (serial port) link.
898
899 Say "y" to link the driver statically, or "m" to build a
900 dynamically linked module called "g_acm_ms".
901
902config USB_G_MULTI
903 tristate "Multifunction Composite Gadget (EXPERIMENTAL)"
904 depends on BLOCK && NET
905 select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS
906 help
907 The Multifunction Composite Gadget provides Ethernet (RNDIS
908 and/or CDC Ethernet), mass storage and ACM serial link
909 interfaces.
910
911 You will be asked to choose which of the two configurations is
912 to be available in the gadget. At least one configuration must
913 be chosen to make the gadget usable. Selecting more than one
914 configuration will prevent Windows from automatically detecting
915 the gadget as a composite gadget, so an INF file will be needed to
916 use the gadget.
917
918 Say "y" to link the driver statically, or "m" to build a
919 dynamically linked module called "g_multi".
920
921config USB_G_MULTI_RNDIS
922 bool "RNDIS + CDC Serial + Storage configuration"
923 depends on USB_G_MULTI
924 default y
925 help
926 This option enables a configuration with RNDIS, CDC Serial and
927 Mass Storage functions available in the Multifunction Composite
928 Gadget. This is the configuration dedicated for Windows since RNDIS
929 is Microsoft's protocol.
930
931 If unsure, say "y".
932
933config USB_G_MULTI_CDC
934 bool "CDC Ethernet + CDC Serial + Storage configuration"
935 depends on USB_G_MULTI
936 default n
937 help
938 This option enables a configuration with CDC Ethernet (ECM), CDC
939 Serial and Mass Storage functions available in the Multifunction
940 Composite Gadget.
941
942 If unsure, say "y".
943
944config USB_G_HID
945 tristate "HID Gadget"
946 help
947 The HID gadget driver provides generic emulation of USB
948 Human Interface Devices (HID).
949
950 For more information, see Documentation/usb/gadget_hid.txt which
951 includes sample code for accessing the device files.
952
953 Say "y" to link the driver statically, or "m" to build a
954 dynamically linked module called "g_hid".
955
956config USB_G_DBGP
957 tristate "EHCI Debug Device Gadget"
958 help
959 This gadget emulates an EHCI Debug device. This is useful when you want
960 to interact with an EHCI Debug Port.
961
962 Say "y" to link the driver statically, or "m" to build a
963 dynamically linked module called "g_dbgp".
964
965if USB_G_DBGP
966choice
967 prompt "EHCI Debug Device mode"
968 default USB_G_DBGP_SERIAL
969
970config USB_G_DBGP_PRINTK
971 depends on USB_G_DBGP
972 bool "printk"
973 help
974 Directly printk() received data. No interaction.
975
976config USB_G_DBGP_SERIAL
977 depends on USB_G_DBGP
978 bool "serial"
979 help
980 Userland can interact using /dev/ttyGSxxx.
981endchoice
982endif
983
984# put drivers that need isochronous transfer support (for audio
985# or video class gadget drivers), or specific hardware, here.
986config USB_G_WEBCAM
987 tristate "USB Webcam Gadget"
988 depends on VIDEO_DEV
989 help
990 The Webcam Gadget acts as a composite USB Audio and Video Class
991 device. It provides a userspace API to process UVC control requests
992 and stream video data to the host.
993
994 Say "y" to link the driver statically, or "m" to build a
995 dynamically linked module called "g_webcam".
996
997endchoice
998
999endif # USB_GADGET