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