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