usb gadget: function activation/deactivation
[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 USB_GADGET && 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 USB_GADGET && 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 USB_GADGET && 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_SELECTED
83 boolean
84
85 #
86 # USB Peripheral Controller Support
87 #
88 # The order here is alphabetical, except that integrated controllers go
89 # before discrete ones so they will be the initial/default value:
90 # - integrated/SOC controllers first
91 # - licensed IP used in both SOC and discrete versions
92 # - discrete ones (including all PCI-only controllers)
93 # - debug/dummy gadget+hcd is last.
94 #
95 choice
96 prompt "USB Peripheral Controller"
97 depends on USB_GADGET
98 help
99 A USB device uses a controller to talk to its host.
100 Systems should have only one such upstream link.
101 Many controller drivers are platform-specific; these
102 often need board-specific hooks.
103
104 #
105 # Integrated controllers
106 #
107
108 config USB_GADGET_AT91
109 boolean "Atmel AT91 USB Device Port"
110 depends on ARCH_AT91 && !ARCH_AT91SAM9RL && !ARCH_AT91CAP9
111 select USB_GADGET_SELECTED
112 help
113 Many Atmel AT91 processors (such as the AT91RM2000) have a
114 full speed USB Device Port with support for five configurable
115 endpoints (plus endpoint zero).
116
117 Say "y" to link the driver statically, or "m" to build a
118 dynamically linked module called "at91_udc" and force all
119 gadget drivers to also be dynamically linked.
120
121 config USB_AT91
122 tristate
123 depends on USB_GADGET_AT91
124 default USB_GADGET
125
126 config USB_GADGET_ATMEL_USBA
127 boolean "Atmel USBA"
128 select USB_GADGET_DUALSPEED
129 depends on AVR32 || ARCH_AT91CAP9 || ARCH_AT91SAM9RL
130 help
131 USBA is the integrated high-speed USB Device controller on
132 the AT32AP700x, some AT91SAM9 and AT91CAP9 processors from Atmel.
133
134 config USB_ATMEL_USBA
135 tristate
136 depends on USB_GADGET_ATMEL_USBA
137 default USB_GADGET
138 select USB_GADGET_SELECTED
139
140 config USB_GADGET_FSL_USB2
141 boolean "Freescale Highspeed USB DR Peripheral Controller"
142 depends on FSL_SOC
143 select USB_GADGET_DUALSPEED
144 help
145 Some of Freescale PowerPC processors have a High Speed
146 Dual-Role(DR) USB controller, which supports device mode.
147
148 The number of programmable endpoints is different through
149 SOC revisions.
150
151 Say "y" to link the driver statically, or "m" to build a
152 dynamically linked module called "fsl_usb2_udc" and force
153 all gadget drivers to also be dynamically linked.
154
155 config USB_FSL_USB2
156 tristate
157 depends on USB_GADGET_FSL_USB2
158 default USB_GADGET
159 select USB_GADGET_SELECTED
160
161 config USB_GADGET_LH7A40X
162 boolean "LH7A40X"
163 depends on ARCH_LH7A40X
164 help
165 This driver provides USB Device Controller driver for LH7A40x
166
167 config USB_LH7A40X
168 tristate
169 depends on USB_GADGET_LH7A40X
170 default USB_GADGET
171 select USB_GADGET_SELECTED
172
173 config USB_GADGET_OMAP
174 boolean "OMAP USB Device Controller"
175 depends on ARCH_OMAP
176 select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3
177 help
178 Many Texas Instruments OMAP processors have flexible full
179 speed USB device controllers, with support for up to 30
180 endpoints (plus endpoint zero). This driver supports the
181 controller in the OMAP 1611, and should work with controllers
182 in other OMAP processors too, given minor tweaks.
183
184 Say "y" to link the driver statically, or "m" to build a
185 dynamically linked module called "omap_udc" and force all
186 gadget drivers to also be dynamically linked.
187
188 config USB_OMAP
189 tristate
190 depends on USB_GADGET_OMAP
191 default USB_GADGET
192 select USB_GADGET_SELECTED
193
194 config USB_OTG
195 boolean "OTG Support"
196 depends on USB_GADGET_OMAP && ARCH_OMAP_OTG && USB_OHCI_HCD
197 help
198 The most notable feature of USB OTG is support for a
199 "Dual-Role" device, which can act as either a device
200 or a host. The initial role choice can be changed
201 later, when two dual-role devices talk to each other.
202
203 Select this only if your OMAP board has a Mini-AB connector.
204
205 config USB_GADGET_PXA25X
206 boolean "PXA 25x or IXP 4xx"
207 depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX
208 help
209 Intel's PXA 25x series XScale ARM-5TE processors include
210 an integrated full speed USB 1.1 device controller. The
211 controller in the IXP 4xx series is register-compatible.
212
213 It has fifteen fixed-function endpoints, as well as endpoint
214 zero (for control transfers).
215
216 Say "y" to link the driver statically, or "m" to build a
217 dynamically linked module called "pxa25x_udc" and force all
218 gadget drivers to also be dynamically linked.
219
220 config USB_PXA25X
221 tristate
222 depends on USB_GADGET_PXA25X
223 default USB_GADGET
224 select USB_GADGET_SELECTED
225
226 # if there's only one gadget driver, using only two bulk endpoints,
227 # don't waste memory for the other endpoints
228 config USB_PXA25X_SMALL
229 depends on USB_GADGET_PXA25X
230 bool
231 default n if USB_ETH_RNDIS
232 default y if USB_ZERO
233 default y if USB_ETH
234 default y if USB_G_SERIAL
235
236 config USB_GADGET_PXA27X
237 boolean "PXA 27x"
238 depends on ARCH_PXA && PXA27x
239 help
240 Intel's PXA 27x series XScale ARM v5TE processors include
241 an integrated full speed USB 1.1 device controller.
242
243 It has up to 23 endpoints, as well as endpoint zero (for
244 control transfers).
245
246 Say "y" to link the driver statically, or "m" to build a
247 dynamically linked module called "pxa27x_udc" and force all
248 gadget drivers to also be dynamically linked.
249
250 config USB_PXA27X
251 tristate
252 depends on USB_GADGET_PXA27X
253 default USB_GADGET
254 select USB_GADGET_SELECTED
255
256 config USB_GADGET_S3C2410
257 boolean "S3C2410 USB Device Controller"
258 depends on ARCH_S3C2410
259 help
260 Samsung's S3C2410 is an ARM-4 processor with an integrated
261 full speed USB 1.1 device controller. It has 4 configurable
262 endpoints, as well as endpoint zero (for control transfers).
263
264 This driver has been tested on the S3C2410, S3C2412, and
265 S3C2440 processors.
266
267 config USB_S3C2410
268 tristate
269 depends on USB_GADGET_S3C2410
270 default USB_GADGET
271 select USB_GADGET_SELECTED
272
273 config USB_S3C2410_DEBUG
274 boolean "S3C2410 udc debug messages"
275 depends on USB_GADGET_S3C2410
276
277 #
278 # Controllers available in both integrated and discrete versions
279 #
280
281 # musb builds in ../musb along with host support
282 config USB_GADGET_MUSB_HDRC
283 boolean "Inventra HDRC USB Peripheral (TI, ...)"
284 depends on USB_MUSB_HDRC && (USB_MUSB_PERIPHERAL || USB_MUSB_OTG)
285 select USB_GADGET_DUALSPEED
286 select USB_GADGET_SELECTED
287 help
288 This OTG-capable silicon IP is used in dual designs including
289 the TI DaVinci, OMAP 243x, OMAP 343x, and TUSB 6010.
290
291 config USB_GADGET_M66592
292 boolean "Renesas M66592 USB Peripheral Controller"
293 select USB_GADGET_DUALSPEED
294 help
295 M66592 is a discrete USB peripheral controller chip that
296 supports both full and high speed USB 2.0 data transfers.
297 It has seven configurable endpoints, and endpoint zero.
298
299 Say "y" to link the driver statically, or "m" to build a
300 dynamically linked module called "m66592_udc" and force all
301 gadget drivers to also be dynamically linked.
302
303 config USB_M66592
304 tristate
305 depends on USB_GADGET_M66592
306 default USB_GADGET
307 select USB_GADGET_SELECTED
308
309 config SUPERH_BUILT_IN_M66592
310 boolean "Enable SuperH built-in USB like the M66592"
311 depends on USB_GADGET_M66592 && CPU_SUBTYPE_SH7722
312 help
313 SH7722 has USB like the M66592.
314
315 The transfer rate is very slow when use "Ethernet Gadget".
316 However, this problem is improved if change a value of
317 NET_IP_ALIGN to 4.
318
319 #
320 # Controllers available only in discrete form (and all PCI controllers)
321 #
322
323 config USB_GADGET_AMD5536UDC
324 boolean "AMD5536 UDC"
325 depends on PCI
326 select USB_GADGET_DUALSPEED
327 help
328 The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
329 It is a USB Highspeed DMA capable USB device controller. Beside ep0
330 it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
331 The UDC port supports OTG operation, and may be used as a host port
332 if it's not being used to implement peripheral or OTG roles.
333
334 Say "y" to link the driver statically, or "m" to build a
335 dynamically linked module called "amd5536udc" and force all
336 gadget drivers to also be dynamically linked.
337
338 config USB_AMD5536UDC
339 tristate
340 depends on USB_GADGET_AMD5536UDC
341 default USB_GADGET
342 select USB_GADGET_SELECTED
343
344 config USB_GADGET_NET2280
345 boolean "NetChip 228x"
346 depends on PCI
347 select USB_GADGET_DUALSPEED
348 help
349 NetChip 2280 / 2282 is a PCI based USB peripheral controller which
350 supports both full and high speed USB 2.0 data transfers.
351
352 It has six configurable endpoints, as well as endpoint zero
353 (for control transfers) and several endpoints with dedicated
354 functions.
355
356 Say "y" to link the driver statically, or "m" to build a
357 dynamically linked module called "net2280" and force all
358 gadget drivers to also be dynamically linked.
359
360 config USB_NET2280
361 tristate
362 depends on USB_GADGET_NET2280
363 default USB_GADGET
364 select USB_GADGET_SELECTED
365
366 config USB_GADGET_GOKU
367 boolean "Toshiba TC86C001 'Goku-S'"
368 depends on PCI
369 help
370 The Toshiba TC86C001 is a PCI device which includes controllers
371 for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
372
373 The device controller has three configurable (bulk or interrupt)
374 endpoints, plus endpoint zero (for control transfers).
375
376 Say "y" to link the driver statically, or "m" to build a
377 dynamically linked module called "goku_udc" and to force all
378 gadget drivers to also be dynamically linked.
379
380 config USB_GOKU
381 tristate
382 depends on USB_GADGET_GOKU
383 default USB_GADGET
384 select USB_GADGET_SELECTED
385
386
387 #
388 # LAST -- dummy/emulated controller
389 #
390
391 config USB_GADGET_DUMMY_HCD
392 boolean "Dummy HCD (DEVELOPMENT)"
393 depends on USB=y || (USB=m && USB_GADGET=m)
394 select USB_GADGET_DUALSPEED
395 help
396 This host controller driver emulates USB, looping all data transfer
397 requests back to a USB "gadget driver" in the same host. The host
398 side is the master; the gadget side is the slave. Gadget drivers
399 can be high, full, or low speed; and they have access to endpoints
400 like those from NET2280, PXA2xx, or SA1100 hardware.
401
402 This may help in some stages of creating a driver to embed in a
403 Linux device, since it lets you debug several parts of the gadget
404 driver without its hardware or drivers being involved.
405
406 Since such a gadget side driver needs to interoperate with a host
407 side Linux-USB device driver, this may help to debug both sides
408 of a USB protocol stack.
409
410 Say "y" to link the driver statically, or "m" to build a
411 dynamically linked module called "dummy_hcd" and force all
412 gadget drivers to also be dynamically linked.
413
414 config USB_DUMMY_HCD
415 tristate
416 depends on USB_GADGET_DUMMY_HCD
417 default USB_GADGET
418 select USB_GADGET_SELECTED
419
420 # NOTE: Please keep dummy_hcd LAST so that "real hardware" appears
421 # first and will be selected by default.
422
423 endchoice
424
425 config USB_GADGET_DUALSPEED
426 bool
427 depends on USB_GADGET
428 default n
429 help
430 Means that gadget drivers should include extra descriptors
431 and code to handle dual-speed controllers.
432
433 #
434 # USB Gadget Drivers
435 #
436 choice
437 tristate "USB Gadget Drivers"
438 depends on USB_GADGET && USB_GADGET_SELECTED
439 default USB_ETH
440 help
441 A Linux "Gadget Driver" talks to the USB Peripheral Controller
442 driver through the abstract "gadget" API. Some other operating
443 systems call these "client" drivers, of which "class drivers"
444 are a subset (implementing a USB device class specification).
445 A gadget driver implements one or more USB functions using
446 the peripheral hardware.
447
448 Gadget drivers are hardware-neutral, or "platform independent",
449 except that they sometimes must understand quirks or limitations
450 of the particular controllers they work with. For example, when
451 a controller doesn't support alternate configurations or provide
452 enough of the right types of endpoints, the gadget driver might
453 not be able work with that controller, or might need to implement
454 a less common variant of a device class protocol.
455
456 # this first set of drivers all depend on bulk-capable hardware.
457
458 config USB_ZERO
459 tristate "Gadget Zero (DEVELOPMENT)"
460 help
461 Gadget Zero is a two-configuration device. It either sinks and
462 sources bulk data; or it loops back a configurable number of
463 transfers. It also implements control requests, for "chapter 9"
464 conformance. The driver needs only two bulk-capable endpoints, so
465 it can work on top of most device-side usb controllers. It's
466 useful for testing, and is also a working example showing how
467 USB "gadget drivers" can be written.
468
469 Make this be the first driver you try using on top of any new
470 USB peripheral controller driver. Then you can use host-side
471 test software, like the "usbtest" driver, to put your hardware
472 and its driver through a basic set of functional tests.
473
474 Gadget Zero also works with the host-side "usb-skeleton" driver,
475 and with many kinds of host-side test software. You may need
476 to tweak product and vendor IDs before host software knows about
477 this device, and arrange to select an appropriate configuration.
478
479 Say "y" to link the driver statically, or "m" to build a
480 dynamically linked module called "g_zero".
481
482 config USB_ZERO_HNPTEST
483 boolean "HNP Test Device"
484 depends on USB_ZERO && USB_OTG
485 help
486 You can configure this device to enumerate using the device
487 identifiers of the USB-OTG test device. That means that when
488 this gadget connects to another OTG device, with this one using
489 the "B-Peripheral" role, that device will use HNP to let this
490 one serve as the USB host instead (in the "B-Host" role).
491
492 config USB_ETH
493 tristate "Ethernet Gadget (with CDC Ethernet support)"
494 depends on NET
495 help
496 This driver implements Ethernet style communication, in either
497 of two ways:
498
499 - The "Communication Device Class" (CDC) Ethernet Control Model.
500 That protocol is often avoided with pure Ethernet adapters, in
501 favor of simpler vendor-specific hardware, but is widely
502 supported by firmware for smart network devices.
503
504 - On hardware can't implement that protocol, a simple CDC subset
505 is used, placing fewer demands on USB.
506
507 RNDIS support is a third option, more demanding than that subset.
508
509 Within the USB device, this gadget driver exposes a network device
510 "usbX", where X depends on what other networking devices you have.
511 Treat it like a two-node Ethernet link: host, and gadget.
512
513 The Linux-USB host-side "usbnet" driver interoperates with this
514 driver, so that deep I/O queues can be supported. On 2.4 kernels,
515 use "CDCEther" instead, if you're using the CDC option. That CDC
516 mode should also interoperate with standard CDC Ethernet class
517 drivers on other host operating systems.
518
519 Say "y" to link the driver statically, or "m" to build a
520 dynamically linked module called "g_ether".
521
522 config USB_ETH_RNDIS
523 bool "RNDIS support"
524 depends on USB_ETH
525 default y
526 help
527 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
528 and Microsoft provides redistributable binary RNDIS drivers for
529 older versions of Windows.
530
531 If you say "y" here, the Ethernet gadget driver will try to provide
532 a second device configuration, supporting RNDIS to talk to such
533 Microsoft USB hosts.
534
535 To make MS-Windows work with this, use Documentation/usb/linux.inf
536 as the "driver info file". For versions of MS-Windows older than
537 XP, you'll need to download drivers from Microsoft's website; a URL
538 is given in comments found in that info file.
539
540 config USB_GADGETFS
541 tristate "Gadget Filesystem (EXPERIMENTAL)"
542 depends on EXPERIMENTAL
543 help
544 This driver provides a filesystem based API that lets user mode
545 programs implement a single-configuration USB device, including
546 endpoint I/O and control requests that don't relate to enumeration.
547 All endpoints, transfer speeds, and transfer types supported by
548 the hardware are available, through read() and write() calls.
549
550 Currently, this option is still labelled as EXPERIMENTAL because
551 of existing race conditions in the underlying in-kernel AIO core.
552
553 Say "y" to link the driver statically, or "m" to build a
554 dynamically linked module called "gadgetfs".
555
556 config USB_FILE_STORAGE
557 tristate "File-backed Storage Gadget"
558 depends on BLOCK
559 help
560 The File-backed Storage Gadget acts as a USB Mass Storage
561 disk drive. As its storage repository it can use a regular
562 file or a block device (in much the same way as the "loop"
563 device driver), specified as a module parameter.
564
565 Say "y" to link the driver statically, or "m" to build a
566 dynamically linked module called "g_file_storage".
567
568 config USB_FILE_STORAGE_TEST
569 bool "File-backed Storage Gadget testing version"
570 depends on USB_FILE_STORAGE
571 default n
572 help
573 Say "y" to generate the larger testing version of the
574 File-backed Storage Gadget, useful for probing the
575 behavior of USB Mass Storage hosts. Not needed for
576 normal operation.
577
578 config USB_G_SERIAL
579 tristate "Serial Gadget (with CDC ACM support)"
580 help
581 The Serial Gadget talks to the Linux-USB generic serial driver.
582 This driver supports a CDC-ACM module option, which can be used
583 to interoperate with MS-Windows hosts or with the Linux-USB
584 "cdc-acm" driver.
585
586 Say "y" to link the driver statically, or "m" to build a
587 dynamically linked module called "g_serial".
588
589 For more information, see Documentation/usb/gadget_serial.txt
590 which includes instructions and a "driver info file" needed to
591 make MS-Windows work with this driver.
592
593 config USB_MIDI_GADGET
594 tristate "MIDI Gadget (EXPERIMENTAL)"
595 depends on SND && EXPERIMENTAL
596 select SND_RAWMIDI
597 help
598 The MIDI Gadget acts as a USB Audio device, with one MIDI
599 input and one MIDI output. These MIDI jacks appear as
600 a sound "card" in the ALSA sound system. Other MIDI
601 connections can then be made on the gadget system, using
602 ALSA's aconnect utility etc.
603
604 Say "y" to link the driver statically, or "m" to build a
605 dynamically linked module called "g_midi".
606
607 config USB_G_PRINTER
608 tristate "Printer Gadget"
609 help
610 The Printer Gadget channels data between the USB host and a
611 userspace program driving the print engine. The user space
612 program reads and writes the device file /dev/g_printer to
613 receive or send printer data. It can use ioctl calls to
614 the device file to get or set printer status.
615
616 Say "y" to link the driver statically, or "m" to build a
617 dynamically linked module called "g_printer".
618
619 For more information, see Documentation/usb/gadget_printer.txt
620 which includes sample code for accessing the device file.
621
622 config USB_CDC_COMPOSITE
623 tristate "CDC Composite Device (Ethernet and ACM)"
624 depends on NET
625 help
626 This driver provides two functions in one configuration:
627 a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link.
628
629 This driver requires four bulk and two interrupt endpoints,
630 plus the ability to handle altsettings. Not all peripheral
631 controllers are that capable.
632
633 Say "y" to link the driver statically, or "m" to build a
634 dynamically linked module.
635
636 # put drivers that need isochronous transfer support (for audio
637 # or video class gadget drivers), or specific hardware, here.
638
639 # - none yet
640
641 endchoice
642
643 endif # USB_GADGET
This page took 0.043817 seconds and 6 git commands to generate.