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