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