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