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