]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - drivers/usb/gadget/Kconfig
usb: gadget: f_eem: use usb_gstrings_attach
[mirror_ubuntu-zesty-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
64e98a79 147 depends on USB_PHY
24a28e42
RS
148 select USB_ISP1301
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
c3c683ea 198 depends on USB_PHY
f1c9e151 199 select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3 || MACH_OMAP_H4_OTG
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
LT
213 depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX
214 help
215 Intel's PXA 25x series XScale ARM-5TE processors include
216 an integrated full speed USB 1.1 device controller. The
217 controller in the IXP 4xx series is register-compatible.
218
219 It has fifteen fixed-function endpoints, as well as endpoint
220 zero (for control transfers).
221
222 Say "y" to link the driver statically, or "m" to build a
7a857620 223 dynamically linked module called "pxa25x_udc" and force all
1da177e4
LT
224 gadget drivers to also be dynamically linked.
225
1da177e4
LT
226# if there's only one gadget driver, using only two bulk endpoints,
227# don't waste memory for the other endpoints
7a857620 228config USB_PXA25X_SMALL
193ab2a6 229 depends on USB_PXA25X
1da177e4
LT
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
193ab2a6
FB
236config USB_R8A66597
237 tristate "Renesas R8A66597 USB Peripheral Controller"
c4144247
YS
238 help
239 R8A66597 is a discrete USB host and peripheral controller chip that
240 supports both full and high speed USB 2.0 data transfers.
241 It has nine configurable endpoints, and endpoint zero.
242
243 Say "y" to link the driver statically, or "m" to build a
244 dynamically linked module called "r8a66597_udc" and force all
245 gadget drivers to also be dynamically linked.
246
030ed1fc 247config USB_RENESAS_USBHS_UDC
193ab2a6 248 tristate 'Renesas USBHS controller'
030ed1fc 249 depends on USB_RENESAS_USBHS
2f98382d 250 help
193ab2a6
FB
251 Renesas USBHS is a discrete USB host and peripheral controller chip
252 that supports both full and high speed USB 2.0 data transfers.
253 It has nine or more configurable endpoints, and endpoint zero.
2f98382d 254
193ab2a6
FB
255 Say "y" to link the driver statically, or "m" to build a
256 dynamically linked module called "renesas_usbhs" and force all
257 gadget drivers to also be dynamically linked.
2f98382d 258
193ab2a6
FB
259config USB_PXA27X
260 tristate "PXA 27x"
d75379a5
RJ
261 help
262 Intel's PXA 27x series XScale ARM v5TE processors include
263 an integrated full speed USB 1.1 device controller.
264
265 It has up to 23 endpoints, as well as endpoint zero (for
266 control transfers).
267
268 Say "y" to link the driver statically, or "m" to build a
269 dynamically linked module called "pxa27x_udc" and force all
270 gadget drivers to also be dynamically linked.
271
193ab2a6
FB
272config USB_S3C_HSOTG
273 tristate "S3C HS/OtG USB Device controller"
5b7d70c6 274 depends on S3C_DEV_USB_HSOTG
5b7d70c6
BD
275 help
276 The Samsung S3C64XX USB2.0 high-speed gadget controller
277 integrated into the S3C64XX series SoC.
278
193ab2a6 279config USB_IMX
2e5a08a3
SH
280 tristate "Freescale i.MX1 USB Peripheral Controller"
281 depends on ARCH_MXC
9662ced3 282 depends on BROKEN
c03e7d4b 283 help
2e5a08a3
SH
284 Freescale's i.MX1 includes an integrated full speed
285 USB 1.1 device controller.
c03e7d4b
PZ
286
287 It has Six fixed-function endpoints, as well as endpoint
288 zero (for control transfers).
289
290 Say "y" to link the driver statically, or "m" to build a
291 dynamically linked module called "imx_udc" and force all
292 gadget drivers to also be dynamically linked.
293
193ab2a6
FB
294config USB_S3C2410
295 tristate "S3C2410 USB Device Controller"
b130d5c2 296 depends on ARCH_S3C24XX
1da177e4 297 help
a7a19fac
DB
298 Samsung's S3C2410 is an ARM-4 processor with an integrated
299 full speed USB 1.1 device controller. It has 4 configurable
300 endpoints, as well as endpoint zero (for control transfers).
1da177e4 301
a7a19fac
DB
302 This driver has been tested on the S3C2410, S3C2412, and
303 S3C2440 processors.
1da177e4 304
a7a19fac
DB
305config USB_S3C2410_DEBUG
306 boolean "S3C2410 udc debug messages"
193ab2a6 307 depends on USB_S3C2410
1da177e4 308
193ab2a6
FB
309config USB_S3C_HSUDC
310 tristate "S3C2416, S3C2443 and S3C2450 USB Device Controller"
b130d5c2 311 depends on ARCH_S3C24XX
a9df304c
TA
312 help
313 Samsung's S3C2416, S3C2443 and S3C2450 is an ARM9 based SoC
314 integrated with dual speed USB 2.0 device controller. It has
315 8 endpoints, as well as endpoint zero.
316
317 This driver has been tested on S3C2416 and S3C2450 processors.
318
5e6c86b0
NZ
319config USB_MV_UDC
320 tristate "Marvell USB2.0 Device Controller"
5273afe3 321 depends on GENERIC_HARDIRQS
e7cddda4 322 help
5e6c86b0
NZ
323 Marvell Socs (including PXA and MMP series) include a high speed
324 USB2.0 OTG controller, which can be configured as high speed or
325 full speed USB peripheral.
72246da4 326
3d4eb9df
YX
327config USB_MV_U3D
328 tristate "MARVELL PXA2128 USB 3.0 controller"
3d4eb9df
YX
329 help
330 MARVELL PXA2128 Processor series include a super speed USB3.0 device
331 controller, which support super speed USB peripheral.
332
a7a19fac
DB
333#
334# Controllers available in both integrated and discrete versions
335#
1da177e4 336
193ab2a6
FB
337config USB_M66592
338 tristate "Renesas M66592 USB Peripheral Controller"
1da177e4 339 help
a7a19fac
DB
340 M66592 is a discrete USB peripheral controller chip that
341 supports both full and high speed USB 2.0 data transfers.
342 It has seven configurable endpoints, and endpoint zero.
1da177e4
LT
343
344 Say "y" to link the driver statically, or "m" to build a
a7a19fac 345 dynamically linked module called "m66592_udc" and force all
1da177e4
LT
346 gadget drivers to also be dynamically linked.
347
a7a19fac
DB
348#
349# Controllers available only in discrete form (and all PCI controllers)
350#
351
193ab2a6
FB
352config USB_AMD5536UDC
353 tristate "AMD5536 UDC"
a7a19fac 354 depends on PCI
3fc154b6 355 help
a7a19fac
DB
356 The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
357 It is a USB Highspeed DMA capable USB device controller. Beside ep0
358 it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
359 The UDC port supports OTG operation, and may be used as a host port
360 if it's not being used to implement peripheral or OTG roles.
3fc154b6 361
a7a19fac
DB
362 Say "y" to link the driver statically, or "m" to build a
363 dynamically linked module called "amd5536udc" and force all
364 gadget drivers to also be dynamically linked.
3fc154b6 365
193ab2a6
FB
366config USB_FSL_QE
367 tristate "Freescale QE/CPM USB Device Controller"
3948f0e0
LY
368 depends on FSL_SOC && (QUICC_ENGINE || CPM)
369 help
370 Some of Freescale PowerPC processors have a Full Speed
371 QE/CPM2 USB controller, which support device mode with 4
372 programmable endpoints. This driver supports the
373 controller in the MPC8360 and MPC8272, and should work with
374 controllers having QE or CPM2, given minor tweaks.
375
376 Set CONFIG_USB_GADGET to "m" to build this driver as a
692105b8 377 dynamically linked module called "fsl_qe_udc".
3948f0e0 378
193ab2a6
FB
379config USB_NET2272
380 tristate "PLX NET2272"
ceb80363
SL
381 help
382 PLX NET2272 is a USB peripheral controller which supports
383 both full and high speed USB 2.0 data transfers.
384
385 It has three configurable endpoints, as well as endpoint zero
386 (for control transfer).
387 Say "y" to link the driver statically, or "m" to build a
388 dynamically linked module called "net2272" and force all
389 gadget drivers to also be dynamically linked.
390
193ab2a6 391config USB_NET2272_DMA
ceb80363 392 boolean "Support external DMA controller"
193ab2a6 393 depends on USB_NET2272
ceb80363
SL
394 help
395 The NET2272 part can optionally support an external DMA
396 controller, but your board has to have support in the
397 driver itself.
398
399 If unsure, say "N" here. The driver works fine in PIO mode.
400
193ab2a6
FB
401config USB_NET2280
402 tristate "NetChip 228x"
a7a19fac 403 depends on PCI
a7a19fac
DB
404 help
405 NetChip 2280 / 2282 is a PCI based USB peripheral controller which
406 supports both full and high speed USB 2.0 data transfers.
3fc154b6 407
a7a19fac
DB
408 It has six configurable endpoints, as well as endpoint zero
409 (for control transfers) and several endpoints with dedicated
410 functions.
411
412 Say "y" to link the driver statically, or "m" to build a
413 dynamically linked module called "net2280" and force all
414 gadget drivers to also be dynamically linked.
415
193ab2a6
FB
416config USB_GOKU
417 tristate "Toshiba TC86C001 'Goku-S'"
a7a19fac 418 depends on PCI
bae4bd84 419 help
a7a19fac
DB
420 The Toshiba TC86C001 is a PCI device which includes controllers
421 for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
422
423 The device controller has three configurable (bulk or interrupt)
424 endpoints, plus endpoint zero (for control transfers).
bae4bd84
DB
425
426 Say "y" to link the driver statically, or "m" to build a
a7a19fac 427 dynamically linked module called "goku_udc" and to force all
bae4bd84
DB
428 gadget drivers to also be dynamically linked.
429
193ab2a6 430config USB_EG20T
731ad81e 431 tristate "Intel EG20T PCH/LAPIS Semiconductor IOH(ML7213/ML7831) UDC"
5273afe3 432 depends on PCI && GENERIC_HARDIRQS
f646cf94
TO
433 help
434 This is a USB device driver for EG20T PCH.
435 EG20T PCH is the platform controller hub that is used in Intel's
436 general embedded platform. EG20T PCH has USB device interface.
437 Using this interface, it is able to access system devices connected
438 to USB device.
439 This driver enables USB device function.
440 USB device is a USB peripheral controller which
441 supports both full and high speed USB 2.0 data transfers.
442 This driver supports both control transfer and bulk transfer modes.
443 This driver dose not support interrupt transfer or isochronous
444 transfer modes.
445
731ad81e 446 This driver also can be used for LAPIS Semiconductor's ML7213 which is
06f1b971 447 for IVI(In-Vehicle Infotainment) use.
731ad81e
TM
448 ML7831 is for general purpose use.
449 ML7213/ML7831 is companion chip for Intel Atom E6xx series.
450 ML7213/ML7831 is completely compatible for Intel EG20T PCH.
06f1b971 451
a7a19fac
DB
452#
453# LAST -- dummy/emulated controller
454#
1da177e4 455
193ab2a6
FB
456config USB_DUMMY_HCD
457 tristate "Dummy HCD (DEVELOPMENT)"
afd0e0f2 458 depends on USB=y || (USB=m && USB_GADGET=m)
1da177e4
LT
459 help
460 This host controller driver emulates USB, looping all data transfer
461 requests back to a USB "gadget driver" in the same host. The host
462 side is the master; the gadget side is the slave. Gadget drivers
463 can be high, full, or low speed; and they have access to endpoints
464 like those from NET2280, PXA2xx, or SA1100 hardware.
193ab2a6 465
1da177e4
LT
466 This may help in some stages of creating a driver to embed in a
467 Linux device, since it lets you debug several parts of the gadget
468 driver without its hardware or drivers being involved.
193ab2a6 469
1da177e4
LT
470 Since such a gadget side driver needs to interoperate with a host
471 side Linux-USB device driver, this may help to debug both sides
472 of a USB protocol stack.
473
474 Say "y" to link the driver statically, or "m" to build a
475 dynamically linked module called "dummy_hcd" and force all
476 gadget drivers to also be dynamically linked.
477
1da177e4
LT
478# NOTE: Please keep dummy_hcd LAST so that "real hardware" appears
479# first and will be selected by default.
480
ed6c6f41 481endmenu
1da177e4 482
1da177e4
LT
483#
484# USB Gadget Drivers
485#
a84d9e53
SAS
486
487# composite based drivers
488config USB_LIBCOMPOSITE
489 tristate
88af8bbe 490 select CONFIGFS_FS
a84d9e53
SAS
491 depends on USB_GADGET
492
ff47f594
SAS
493config USB_F_ACM
494 tristate
495
cf9a08ae
SAS
496config USB_F_SS_LB
497 tristate
498
3249ca22
SAS
499config USB_U_SERIAL
500 tristate
501
f1a1823f
AP
502config USB_U_ETHER
503 tristate
504
cbbd14a9
AP
505config USB_U_RNDIS
506 tristate
507
60540ea2 508config USB_F_SERIAL
3249ca22
SAS
509 tristate
510
1d8fc251
AP
511config USB_F_OBEX
512 tristate
513
40d133d7
AP
514config USB_F_NCM
515 tristate
516
fee562a6
AP
517config USB_F_ECM
518 tristate
519
fcbdf12e
AP
520config USB_F_PHONET
521 tristate
522
b29002a1
AP
523config USB_F_EEM
524 tristate
525
1da177e4
LT
526choice
527 tristate "USB Gadget Drivers"
1da177e4
LT
528 default USB_ETH
529 help
530 A Linux "Gadget Driver" talks to the USB Peripheral Controller
531 driver through the abstract "gadget" API. Some other operating
532 systems call these "client" drivers, of which "class drivers"
533 are a subset (implementing a USB device class specification).
534 A gadget driver implements one or more USB functions using
535 the peripheral hardware.
536
537 Gadget drivers are hardware-neutral, or "platform independent",
538 except that they sometimes must understand quirks or limitations
539 of the particular controllers they work with. For example, when
540 a controller doesn't support alternate configurations or provide
541 enough of the right types of endpoints, the gadget driver might
542 not be able work with that controller, or might need to implement
543 a less common variant of a device class protocol.
544
545# this first set of drivers all depend on bulk-capable hardware.
546
83408745
AP
547config USB_CONFIGFS_PHONET
548 boolean "Phonet protocol"
549 depends on USB_CONFIGFS
550 depends on NET
551 depends on PHONET
552 select USB_U_ETHER
553 select USB_F_PHONET
554 help
555 The Phonet protocol implementation for USB device.
556
1da177e4
LT
557config USB_ZERO
558 tristate "Gadget Zero (DEVELOPMENT)"
a84d9e53 559 select USB_LIBCOMPOSITE
cf9a08ae 560 select USB_F_SS_LB
1da177e4
LT
561 help
562 Gadget Zero is a two-configuration device. It either sinks and
563 sources bulk data; or it loops back a configurable number of
564 transfers. It also implements control requests, for "chapter 9"
565 conformance. The driver needs only two bulk-capable endpoints, so
566 it can work on top of most device-side usb controllers. It's
567 useful for testing, and is also a working example showing how
568 USB "gadget drivers" can be written.
569
570 Make this be the first driver you try using on top of any new
571 USB peripheral controller driver. Then you can use host-side
572 test software, like the "usbtest" driver, to put your hardware
573 and its driver through a basic set of functional tests.
574
575 Gadget Zero also works with the host-side "usb-skeleton" driver,
576 and with many kinds of host-side test software. You may need
577 to tweak product and vendor IDs before host software knows about
578 this device, and arrange to select an appropriate configuration.
579
580 Say "y" to link the driver statically, or "m" to build a
581 dynamically linked module called "g_zero".
582
583config USB_ZERO_HNPTEST
584 boolean "HNP Test Device"
585 depends on USB_ZERO && USB_OTG
586 help
587 You can configure this device to enumerate using the device
588 identifiers of the USB-OTG test device. That means that when
589 this gadget connects to another OTG device, with this one using
590 the "B-Peripheral" role, that device will use HNP to let this
591 one serve as the USB host instead (in the "B-Host" role).
592
c6994e6f 593config USB_AUDIO
eb83be98 594 tristate "Audio Gadget"
c6994e6f 595 depends on SND
a84d9e53 596 select USB_LIBCOMPOSITE
04950737 597 select SND_PCM
c6994e6f 598 help
132fcb46
JB
599 This Gadget Audio driver is compatible with USB Audio Class
600 specification 2.0. It implements 1 AudioControl interface,
601 1 AudioStreaming Interface each for USB-OUT and USB-IN.
602 Number of channels, sample rate and sample size can be
603 specified as module parameters.
604 This driver doesn't expect any real Audio codec to be present
605 on the device - the audio streams are simply sinked to and
606 sourced from a virtual ALSA sound card created. The user-space
607 application may choose to do whatever it wants with the data
608 received from the USB Host and choose to provide whatever it
609 wants as audio data to the USB Host.
c6994e6f
BW
610
611 Say "y" to link the driver statically, or "m" to build a
612 dynamically linked module called "g_audio".
613
132fcb46
JB
614config GADGET_UAC1
615 bool "UAC 1.0 (Legacy)"
616 depends on USB_AUDIO
617 help
618 If you instead want older UAC Spec-1.0 driver that also has audio
619 paths hardwired to the Audio codec chip on-board and doesn't work
620 without one.
621
1da177e4
LT
622config USB_ETH
623 tristate "Ethernet Gadget (with CDC Ethernet support)"
624 depends on NET
a84d9e53 625 select USB_LIBCOMPOSITE
f1a1823f 626 select USB_U_ETHER
cbbd14a9 627 select USB_U_RNDIS
9c62ce83 628 select USB_F_ECM
9e221be8 629 select CRC32
1da177e4 630 help
9b39e9dd
BN
631 This driver implements Ethernet style communication, in one of
632 several ways:
1da177e4
LT
633
634 - The "Communication Device Class" (CDC) Ethernet Control Model.
635 That protocol is often avoided with pure Ethernet adapters, in
636 favor of simpler vendor-specific hardware, but is widely
637 supported by firmware for smart network devices.
638
639 - On hardware can't implement that protocol, a simple CDC subset
640 is used, placing fewer demands on USB.
641
9b39e9dd
BN
642 - CDC Ethernet Emulation Model (EEM) is a newer standard that has
643 a simpler interface that can be used by more USB hardware.
644
645 RNDIS support is an additional option, more demanding than than
646 subset.
1da177e4
LT
647
648 Within the USB device, this gadget driver exposes a network device
649 "usbX", where X depends on what other networking devices you have.
650 Treat it like a two-node Ethernet link: host, and gadget.
651
652 The Linux-USB host-side "usbnet" driver interoperates with this
653 driver, so that deep I/O queues can be supported. On 2.4 kernels,
654 use "CDCEther" instead, if you're using the CDC option. That CDC
655 mode should also interoperate with standard CDC Ethernet class
656 drivers on other host operating systems.
657
658 Say "y" to link the driver statically, or "m" to build a
659 dynamically linked module called "g_ether".
660
661config USB_ETH_RNDIS
afd0e0f2
RD
662 bool "RNDIS support"
663 depends on USB_ETH
a84d9e53 664 select USB_LIBCOMPOSITE
1da177e4
LT
665 default y
666 help
667 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
668 and Microsoft provides redistributable binary RNDIS drivers for
669 older versions of Windows.
670
671 If you say "y" here, the Ethernet gadget driver will try to provide
672 a second device configuration, supporting RNDIS to talk to such
673 Microsoft USB hosts.
674
675 To make MS-Windows work with this, use Documentation/usb/linux.inf
676 as the "driver info file". For versions of MS-Windows older than
677 XP, you'll need to download drivers from Microsoft's website; a URL
678 is given in comments found in that info file.
679
9b39e9dd
BN
680config USB_ETH_EEM
681 bool "Ethernet Emulation Model (EEM) support"
682 depends on USB_ETH
a84d9e53 683 select USB_LIBCOMPOSITE
94b5573e 684 select USB_F_EEM
9b39e9dd
BN
685 default n
686 help
687 CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM
688 and therefore can be supported by more hardware. Technically ECM and
689 EEM are designed for different applications. The ECM model extends
690 the network interface to the target (e.g. a USB cable modem), and the
691 EEM model is for mobile devices to communicate with hosts using
692 ethernet over USB. For Linux gadgets, however, the interface with
693 the host is the same (a usbX device), so the differences are minimal.
694
695 If you say "y" here, the Ethernet gadget driver will use the EEM
696 protocol rather than ECM. If unsure, say "n".
697
6c34d288
YK
698config USB_G_NCM
699 tristate "Network Control Model (NCM) support"
700 depends on NET
a84d9e53 701 select USB_LIBCOMPOSITE
f1a1823f 702 select USB_U_ETHER
9575bcf9 703 select USB_F_NCM
6c34d288
YK
704 select CRC32
705 help
706 This driver implements USB CDC NCM subclass standard. NCM is
707 an advanced protocol for Ethernet encapsulation, allows grouping
b55dd320 708 of several ethernet frames into one USB transfer and different
6c34d288
YK
709 alignment possibilities.
710
711 Say "y" to link the driver statically, or "m" to build a
712 dynamically linked module called "g_ncm".
713
1da177e4 714config USB_GADGETFS
eb83be98 715 tristate "Gadget Filesystem"
1da177e4
LT
716 help
717 This driver provides a filesystem based API that lets user mode
718 programs implement a single-configuration USB device, including
719 endpoint I/O and control requests that don't relate to enumeration.
720 All endpoints, transfer speeds, and transfer types supported by
721 the hardware are available, through read() and write() calls.
722
723 Say "y" to link the driver statically, or "m" to build a
724 dynamically linked module called "gadgetfs".
725
c6c56008 726config USB_FUNCTIONFS
eb83be98 727 tristate "Function Filesystem"
a84d9e53 728 select USB_LIBCOMPOSITE
f8dae531 729 select USB_FUNCTIONFS_GENERIC if !(USB_FUNCTIONFS_ETH || USB_FUNCTIONFS_RNDIS)
c6c56008 730 help
eabf0f5f
MP
731 The Function Filesystem (FunctionFS) lets one create USB
732 composite functions in user space in the same way GadgetFS
c6c56008
MN
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
f8dae531
MN
738 If you say "y" or "m" here you will be able what kind of
739 configurations the gadget will provide.
740
c6c56008
MN
741 Say "y" to link the driver statically, or "m" to build
742 a dynamically linked module called "g_ffs".
743
744config USB_FUNCTIONFS_ETH
f8dae531 745 bool "Include configuration with CDC ECM (Ethernet)"
17b2765e 746 depends on USB_FUNCTIONFS && NET
f1a1823f 747 select USB_U_ETHER
c6c56008 748 help
eabf0f5f
MP
749 Include a configuration with CDC ECM function (Ethernet) and the
750 Function Filesystem.
c6c56008
MN
751
752config USB_FUNCTIONFS_RNDIS
f8dae531 753 bool "Include configuration with RNDIS (Ethernet)"
17b2765e 754 depends on USB_FUNCTIONFS && NET
f1a1823f 755 select USB_U_ETHER
cbbd14a9 756 select USB_U_RNDIS
c6c56008 757 help
eabf0f5f 758 Include a configuration with RNDIS function (Ethernet) and the Filesystem.
c6c56008
MN
759
760config USB_FUNCTIONFS_GENERIC
761 bool "Include 'pure' configuration"
f8dae531 762 depends on USB_FUNCTIONFS
c6c56008 763 help
f8dae531
MN
764 Include a configuration with the Function Filesystem alone with
765 no Ethernet interface.
c6c56008 766
d23b0f08
MN
767config USB_MASS_STORAGE
768 tristate "Mass Storage Gadget"
769 depends on BLOCK
a84d9e53 770 select USB_LIBCOMPOSITE
d23b0f08
MN
771 help
772 The Mass Storage Gadget acts as a USB Mass Storage disk drive.
773 As its storage repository it can use a regular file or a block
774 device (in much the same way as the "loop" device driver),
775 specified as a module parameter or sysfs option.
776
fa06920a
MN
777 This driver is a replacement for now removed File-backed
778 Storage Gadget (g_file_storage).
d23b0f08
MN
779
780 Say "y" to link the driver statically, or "m" to build
664a51a8 781 a dynamically linked module called "g_mass_storage".
d23b0f08 782
c52661d6
SAS
783config USB_GADGET_TARGET
784 tristate "USB Gadget Target Fabric Module"
785 depends on TARGET_CORE
a84d9e53 786 select USB_LIBCOMPOSITE
c52661d6
SAS
787 help
788 This fabric is an USB gadget. Two USB protocols are supported that is
789 BBB or BOT (Bulk Only Transport) and UAS (USB Attached SCSI). BOT is
790 advertised on alternative interface 0 (primary) and UAS is on
791 alternative interface 1. Both protocols can work on USB2.0 and USB3.0.
792 UAS utilizes the USB 3.0 feature called streams support.
793
1da177e4 794config USB_G_SERIAL
3086775a 795 tristate "Serial Gadget (with CDC ACM and CDC OBEX support)"
4f73bc4d 796 depends on TTY
3249ca22 797 select USB_U_SERIAL
ff47f594 798 select USB_F_ACM
70cc3c02 799 select USB_F_SERIAL
d1412794 800 select USB_F_OBEX
a84d9e53 801 select USB_LIBCOMPOSITE
1da177e4
LT
802 help
803 The Serial Gadget talks to the Linux-USB generic serial driver.
804 This driver supports a CDC-ACM module option, which can be used
805 to interoperate with MS-Windows hosts or with the Linux-USB
806 "cdc-acm" driver.
807
3086775a
FB
808 This driver also supports a CDC-OBEX option. You will need a
809 user space OBEX server talking to /dev/ttyGS*, since the kernel
810 itself doesn't implement the OBEX protocol.
811
1da177e4
LT
812 Say "y" to link the driver statically, or "m" to build a
813 dynamically linked module called "g_serial".
814
815 For more information, see Documentation/usb/gadget_serial.txt
816 which includes instructions and a "driver info file" needed to
3086775a 817 make MS-Windows work with CDC ACM.
1da177e4 818
f2ebf92c 819config USB_MIDI_GADGET
eb83be98
GKH
820 tristate "MIDI Gadget"
821 depends on SND
a84d9e53 822 select USB_LIBCOMPOSITE
f2ebf92c
BW
823 select SND_RAWMIDI
824 help
825 The MIDI Gadget acts as a USB Audio device, with one MIDI
826 input and one MIDI output. These MIDI jacks appear as
827 a sound "card" in the ALSA sound system. Other MIDI
828 connections can then be made on the gadget system, using
829 ALSA's aconnect utility etc.
830
831 Say "y" to link the driver statically, or "m" to build a
832 dynamically linked module called "g_midi".
833
25a010c8
CN
834config USB_G_PRINTER
835 tristate "Printer Gadget"
a84d9e53 836 select USB_LIBCOMPOSITE
25a010c8
CN
837 help
838 The Printer Gadget channels data between the USB host and a
839 userspace program driving the print engine. The user space
840 program reads and writes the device file /dev/g_printer to
841 receive or send printer data. It can use ioctl calls to
842 the device file to get or set printer status.
843
844 Say "y" to link the driver statically, or "m" to build a
845 dynamically linked module called "g_printer".
846
847 For more information, see Documentation/usb/gadget_printer.txt
848 which includes sample code for accessing the device file.
1da177e4 849
4f73bc4d
JM
850if TTY
851
19e20680
DB
852config USB_CDC_COMPOSITE
853 tristate "CDC Composite Device (Ethernet and ACM)"
4ddd9ec1 854 depends on NET
a84d9e53 855 select USB_LIBCOMPOSITE
3249ca22 856 select USB_U_SERIAL
f1a1823f 857 select USB_U_ETHER
29a6645f 858 select USB_F_ACM
a38a2750 859 select USB_F_ECM
19e20680
DB
860 help
861 This driver provides two functions in one configuration:
862 a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link.
863
864 This driver requires four bulk and two interrupt endpoints,
865 plus the ability to handle altsettings. Not all peripheral
866 controllers are that capable.
867
868 Say "y" to link the driver statically, or "m" to build a
869 dynamically linked module.
870
f358f5b4
FB
871config USB_G_NOKIA
872 tristate "Nokia composite gadget"
873 depends on PHONET
a84d9e53 874 select USB_LIBCOMPOSITE
3249ca22 875 select USB_U_SERIAL
f1a1823f 876 select USB_U_ETHER
15761826 877 select USB_F_ACM
3a343449 878 select USB_F_OBEX
83167f12 879 select USB_F_PHONET
b904d081 880 select USB_F_ECM
f358f5b4
FB
881 help
882 The Nokia composite gadget provides support for acm, obex
883 and phonet in only one composite gadget driver.
884
885 It's only really useful for N900 hardware. If you're building
886 a kernel for N900, say Y or M here. If unsure, say N.
887
fa3ae0c1
KS
888config USB_G_ACM_MS
889 tristate "CDC Composite Device (ACM and mass storage)"
890 depends on BLOCK
a84d9e53 891 select USB_LIBCOMPOSITE
3249ca22 892 select USB_U_SERIAL
5f72bbfd 893 select USB_F_ACM
fa3ae0c1
KS
894 help
895 This driver provides two functions in one configuration:
896 a mass storage, and a CDC ACM (serial port) link.
897
898 Say "y" to link the driver statically, or "m" to build a
899 dynamically linked module called "g_acm_ms".
900
f176a5d8 901config USB_G_MULTI
eb83be98 902 tristate "Multifunction Composite Gadget"
5791e103 903 depends on BLOCK && NET
279cc49a 904 select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS
a84d9e53 905 select USB_LIBCOMPOSITE
3249ca22 906 select USB_U_SERIAL
f1a1823f 907 select USB_U_ETHER
cbbd14a9 908 select USB_U_RNDIS
59835ad7 909 select USB_F_ACM
f176a5d8
MN
910 help
911 The Multifunction Composite Gadget provides Ethernet (RNDIS
912 and/or CDC Ethernet), mass storage and ACM serial link
913 interfaces.
914
5791e103 915 You will be asked to choose which of the two configurations is
f176a5d8 916 to be available in the gadget. At least one configuration must
5791e103 917 be chosen to make the gadget usable. Selecting more than one
f176a5d8 918 configuration will prevent Windows from automatically detecting
5791e103 919 the gadget as a composite gadget, so an INF file will be needed to
f176a5d8
MN
920 use the gadget.
921
922 Say "y" to link the driver statically, or "m" to build a
923 dynamically linked module called "g_multi".
924
925config USB_G_MULTI_RNDIS
926 bool "RNDIS + CDC Serial + Storage configuration"
927 depends on USB_G_MULTI
928 default y
929 help
930 This option enables a configuration with RNDIS, CDC Serial and
931 Mass Storage functions available in the Multifunction Composite
5791e103
RD
932 Gadget. This is the configuration dedicated for Windows since RNDIS
933 is Microsoft's protocol.
f176a5d8
MN
934
935 If unsure, say "y".
936
937config USB_G_MULTI_CDC
938 bool "CDC Ethernet + CDC Serial + Storage configuration"
939 depends on USB_G_MULTI
940 default n
941 help
942 This option enables a configuration with CDC Ethernet (ECM), CDC
943 Serial and Mass Storage functions available in the Multifunction
5791e103 944 Composite Gadget.
f176a5d8
MN
945
946 If unsure, say "y".
947
4f73bc4d
JM
948endif # TTY
949
71adf118
FC
950config USB_G_HID
951 tristate "HID Gadget"
a84d9e53 952 select USB_LIBCOMPOSITE
71adf118
FC
953 help
954 The HID gadget driver provides generic emulation of USB
955 Human Interface Devices (HID).
956
957 For more information, see Documentation/usb/gadget_hid.txt which
958 includes sample code for accessing the device files.
959
960 Say "y" to link the driver statically, or "m" to build a
961 dynamically linked module called "g_hid".
f176a5d8 962
a84d9e53 963# Standalone / single function gadgets
f6c826a9 964config USB_G_DBGP
965 tristate "EHCI Debug Device Gadget"
4f73bc4d 966 depends on TTY
a84d9e53 967 select USB_LIBCOMPOSITE
f6c826a9 968 help
969 This gadget emulates an EHCI Debug device. This is useful when you want
970 to interact with an EHCI Debug Port.
971
972 Say "y" to link the driver statically, or "m" to build a
973 dynamically linked module called "g_dbgp".
974
975if USB_G_DBGP
976choice
977 prompt "EHCI Debug Device mode"
978 default USB_G_DBGP_SERIAL
979
980config USB_G_DBGP_PRINTK
981 depends on USB_G_DBGP
982 bool "printk"
983 help
984 Directly printk() received data. No interaction.
985
986config USB_G_DBGP_SERIAL
987 depends on USB_G_DBGP
3249ca22 988 select USB_U_SERIAL
f6c826a9 989 bool "serial"
990 help
991 Userland can interact using /dev/ttyGSxxx.
992endchoice
993endif
994
1da177e4
LT
995# put drivers that need isochronous transfer support (for audio
996# or video class gadget drivers), or specific hardware, here.
a9914127
LP
997config USB_G_WEBCAM
998 tristate "USB Webcam Gadget"
24337c13 999 depends on VIDEO_DEV
0b2ffb78 1000 select USB_LIBCOMPOSITE
d6925225 1001 select VIDEOBUF2_VMALLOC
a9914127
LP
1002 help
1003 The Webcam Gadget acts as a composite USB Audio and Video Class
1004 device. It provides a userspace API to process UVC control requests
1005 and stream video data to the host.
1da177e4 1006
a9914127
LP
1007 Say "y" to link the driver statically, or "m" to build a
1008 dynamically linked module called "g_webcam".
1da177e4
LT
1009
1010endchoice
1011
b75be4ab 1012endif # USB_GADGET