blob: ef9d9086cddc3c7fdb065469fc42f296650e895f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#
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).
Matt LaPlantecab00892006-10-03 22:36:44 +020010# - Some systems have both kinds of controllers.
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#
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#
Linus Torvalds1da177e2005-04-16 15:20:36 -070015
Denis Chengb75be4a2008-01-24 16:36:31 +080016menuconfig USB_GADGET
17 tristate "USB Gadget Support"
Linus Torvalds1da177e2005-04-16 15:20:36 -070018 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
Jules Villarde113f292006-08-22 22:40:15 +020028 familiar host side controllers have names like "EHCI", "OHCI",
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 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
Denis Chengb75be4a2008-01-24 16:36:31 +080044if USB_GADGET
45
David Brownell70790f62007-07-01 17:35:28 -070046config USB_GADGET_DEBUG
Robert P. J. Dayafd0e0f2008-03-10 15:09:51 -040047 boolean "Debugging messages (DEVELOPMENT)"
David Brownell36e893d2008-09-12 09:39:06 -070048 depends on DEBUG_KERNEL
David Brownell70790f62007-07-01 17:35:28 -070049 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070060config USB_GADGET_DEBUG_FILES
Robert P. J. Dayafd0e0f2008-03-10 15:09:51 -040061 boolean "Debugging information files (DEVELOPMENT)"
David Brownell36e893d2008-09-12 09:39:06 -070062 depends on PROC_FS
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 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
Haavard Skinnemoen914a3f32007-10-10 02:29:43 -070071config USB_GADGET_DEBUG_FS
Robert P. J. Dayafd0e0f2008-03-10 15:09:51 -040072 boolean "Debugging information files in debugfs (DEVELOPMENT)"
David Brownell36e893d2008-09-12 09:39:06 -070073 depends on DEBUG_FS
Haavard Skinnemoen914a3f32007-10-10 02:29:43 -070074 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
David Brownell36e893d2008-09-12 09:39:06 -070082config 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
David Brownell028b2712005-05-06 07:02:01 -070099config USB_GADGET_SELECTED
100 boolean
101
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102#
103# USB Peripheral Controller Support
104#
David Brownella7a19fa2008-08-14 17:04:48 -0700105# The order here is alphabetical, except that integrated controllers go
106# before discrete ones so they will be the initial/default value:
107# - integrated/SOC controllers first
108# - licensed IP used in both SOC and discrete versions
109# - discrete ones (including all PCI-only controllers)
110# - debug/dummy gadget+hcd is last.
111#
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112choice
113 prompt "USB Peripheral Controller"
114 depends on USB_GADGET
115 help
116 A USB device uses a controller to talk to its host.
117 Systems should have only one such upstream link.
118 Many controller drivers are platform-specific; these
119 often need board-specific hooks.
120
David Brownella7a19fa2008-08-14 17:04:48 -0700121#
122# Integrated controllers
123#
124
125config USB_GADGET_AT91
126 boolean "Atmel AT91 USB Device Port"
127 depends on ARCH_AT91 && !ARCH_AT91SAM9RL && !ARCH_AT91CAP9
128 select USB_GADGET_SELECTED
Thomas Dahlmann55d402d2007-07-16 21:40:54 -0700129 help
David Brownella7a19fa2008-08-14 17:04:48 -0700130 Many Atmel AT91 processors (such as the AT91RM2000) have a
131 full speed USB Device Port with support for five configurable
132 endpoints (plus endpoint zero).
Thomas Dahlmann55d402d2007-07-16 21:40:54 -0700133
134 Say "y" to link the driver statically, or "m" to build a
David Brownella7a19fa2008-08-14 17:04:48 -0700135 dynamically linked module called "at91_udc" and force all
Thomas Dahlmann55d402d2007-07-16 21:40:54 -0700136 gadget drivers to also be dynamically linked.
137
David Brownella7a19fa2008-08-14 17:04:48 -0700138config USB_AT91
Thomas Dahlmann55d402d2007-07-16 21:40:54 -0700139 tristate
David Brownella7a19fa2008-08-14 17:04:48 -0700140 depends on USB_GADGET_AT91
Thomas Dahlmann55d402d2007-07-16 21:40:54 -0700141 default USB_GADGET
Thomas Dahlmann55d402d2007-07-16 21:40:54 -0700142
Haavard Skinnemoen914a3f32007-10-10 02:29:43 -0700143config USB_GADGET_ATMEL_USBA
144 boolean "Atmel USBA"
145 select USB_GADGET_DUALSPEED
Nicolas Ferreba45ca42008-04-08 13:59:18 +0100146 depends on AVR32 || ARCH_AT91CAP9 || ARCH_AT91SAM9RL
Haavard Skinnemoen914a3f32007-10-10 02:29:43 -0700147 help
148 USBA is the integrated high-speed USB Device controller on
Nicolas Ferreba45ca42008-04-08 13:59:18 +0100149 the AT32AP700x, some AT91SAM9 and AT91CAP9 processors from Atmel.
Haavard Skinnemoen914a3f32007-10-10 02:29:43 -0700150
151config USB_ATMEL_USBA
152 tristate
153 depends on USB_GADGET_ATMEL_USBA
154 default USB_GADGET
155 select USB_GADGET_SELECTED
156
Li Yangb5048822007-04-23 10:54:25 -0700157config USB_GADGET_FSL_USB2
158 boolean "Freescale Highspeed USB DR Peripheral Controller"
Guennadi Liakhovetski54e4026b2009-04-15 14:25:33 +0200159 depends on FSL_SOC || ARCH_MXC
Li Yangb5048822007-04-23 10:54:25 -0700160 select USB_GADGET_DUALSPEED
161 help
162 Some of Freescale PowerPC processors have a High Speed
163 Dual-Role(DR) USB controller, which supports device mode.
164
165 The number of programmable endpoints is different through
166 SOC revisions.
167
168 Say "y" to link the driver statically, or "m" to build a
169 dynamically linked module called "fsl_usb2_udc" and force
170 all gadget drivers to also be dynamically linked.
171
172config USB_FSL_USB2
173 tristate
174 depends on USB_GADGET_FSL_USB2
175 default USB_GADGET
176 select USB_GADGET_SELECTED
177
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178config USB_GADGET_LH7A40X
179 boolean "LH7A40X"
180 depends on ARCH_LH7A40X
181 help
David Brownella7a19fa2008-08-14 17:04:48 -0700182 This driver provides USB Device Controller driver for LH7A40x
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
184config USB_LH7A40X
185 tristate
186 depends on USB_GADGET_LH7A40X
187 default USB_GADGET
David Brownell028b2712005-05-06 07:02:01 -0700188 select USB_GADGET_SELECTED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190config USB_GADGET_OMAP
191 boolean "OMAP USB Device Controller"
192 depends on ARCH_OMAP
Tony Lindgrenf1c9e152008-09-04 16:25:14 -0700193 select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3 || MACH_OMAP_H4_OTG
David Brownell54b9ed32009-02-11 22:31:12 -0800194 select USB_OTG_UTILS if ARCH_OMAP
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 help
196 Many Texas Instruments OMAP processors have flexible full
197 speed USB device controllers, with support for up to 30
198 endpoints (plus endpoint zero). This driver supports the
199 controller in the OMAP 1611, and should work with controllers
200 in other OMAP processors too, given minor tweaks.
201
202 Say "y" to link the driver statically, or "m" to build a
203 dynamically linked module called "omap_udc" and force all
204 gadget drivers to also be dynamically linked.
205
206config USB_OMAP
207 tristate
208 depends on USB_GADGET_OMAP
209 default USB_GADGET
David Brownell028b2712005-05-06 07:02:01 -0700210 select USB_GADGET_SELECTED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
212config USB_OTG
213 boolean "OTG Support"
214 depends on USB_GADGET_OMAP && ARCH_OMAP_OTG && USB_OHCI_HCD
215 help
216 The most notable feature of USB OTG is support for a
217 "Dual-Role" device, which can act as either a device
218 or a host. The initial role choice can be changed
219 later, when two dual-role devices talk to each other.
220
221 Select this only if your OMAP board has a Mini-AB connector.
222
David Brownella7a19fa2008-08-14 17:04:48 -0700223config USB_GADGET_PXA25X
224 boolean "PXA 25x or IXP 4xx"
225 depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX
226 help
227 Intel's PXA 25x series XScale ARM-5TE processors include
228 an integrated full speed USB 1.1 device controller. The
229 controller in the IXP 4xx series is register-compatible.
230
231 It has fifteen fixed-function endpoints, as well as endpoint
232 zero (for control transfers).
233
234 Say "y" to link the driver statically, or "m" to build a
235 dynamically linked module called "pxa25x_udc" and force all
236 gadget drivers to also be dynamically linked.
237
238config USB_PXA25X
239 tristate
240 depends on USB_GADGET_PXA25X
241 default USB_GADGET
242 select USB_GADGET_SELECTED
243
244# if there's only one gadget driver, using only two bulk endpoints,
245# don't waste memory for the other endpoints
246config USB_PXA25X_SMALL
247 depends on USB_GADGET_PXA25X
248 bool
249 default n if USB_ETH_RNDIS
250 default y if USB_ZERO
251 default y if USB_ETH
252 default y if USB_G_SERIAL
253
254config USB_GADGET_PXA27X
255 boolean "PXA 27x"
Robert Jarzmik9f5351b2009-04-21 20:34:44 -0700256 depends on ARCH_PXA && (PXA27x || PXA3xx)
Robert Jarzmik7fec3c22009-01-24 23:57:30 -0800257 select USB_OTG_UTILS
David Brownella7a19fa2008-08-14 17:04:48 -0700258 help
259 Intel's PXA 27x series XScale ARM v5TE processors include
260 an integrated full speed USB 1.1 device controller.
261
262 It has up to 23 endpoints, as well as endpoint zero (for
263 control transfers).
264
265 Say "y" to link the driver statically, or "m" to build a
266 dynamically linked module called "pxa27x_udc" and force all
267 gadget drivers to also be dynamically linked.
268
269config USB_PXA27X
270 tristate
271 depends on USB_GADGET_PXA27X
272 default USB_GADGET
273 select USB_GADGET_SELECTED
274
Ben Dooks5b7d70c2009-06-02 14:58:06 +0100275config USB_GADGET_S3C_HSOTG
276 boolean "S3C HS/OtG USB Device controller"
277 depends on S3C_DEV_USB_HSOTG
278 select USB_GADGET_S3C_HSOTG_PIO
279 help
280 The Samsung S3C64XX USB2.0 high-speed gadget controller
281 integrated into the S3C64XX series SoC.
282
283config USB_S3C_HSOTG
284 tristate
285 depends on USB_GADGET_S3C_HSOTG
286 default USB_GADGET
287 select USB_GADGET_SELECTED
288
Arnaud Patard3fc154b2007-06-06 21:05:49 -0700289config USB_GADGET_S3C2410
290 boolean "S3C2410 USB Device Controller"
291 depends on ARCH_S3C2410
292 help
293 Samsung's S3C2410 is an ARM-4 processor with an integrated
294 full speed USB 1.1 device controller. It has 4 configurable
295 endpoints, as well as endpoint zero (for control transfers).
296
297 This driver has been tested on the S3C2410, S3C2412, and
298 S3C2440 processors.
299
300config USB_S3C2410
301 tristate
302 depends on USB_GADGET_S3C2410
303 default USB_GADGET
304 select USB_GADGET_SELECTED
305
306config USB_S3C2410_DEBUG
307 boolean "S3C2410 udc debug messages"
308 depends on USB_GADGET_S3C2410
309
David Brownella7a19fa2008-08-14 17:04:48 -0700310#
311# Controllers available in both integrated and discrete versions
312#
313
314# musb builds in ../musb along with host support
315config USB_GADGET_MUSB_HDRC
Bryan Wu085ad402008-12-02 21:33:49 +0200316 boolean "Inventra HDRC USB Peripheral (TI, ADI, ...)"
David Brownella7a19fa2008-08-14 17:04:48 -0700317 depends on USB_MUSB_HDRC && (USB_MUSB_PERIPHERAL || USB_MUSB_OTG)
318 select USB_GADGET_DUALSPEED
David Brownellbae4bd82006-01-22 10:32:37 -0800319 select USB_GADGET_SELECTED
320 help
David Brownella7a19fa2008-08-14 17:04:48 -0700321 This OTG-capable silicon IP is used in dual designs including
Bryan Wu085ad402008-12-02 21:33:49 +0200322 the TI DaVinci, OMAP 243x, OMAP 343x, TUSB 6010, and ADI Blackfin
David Brownella7a19fa2008-08-14 17:04:48 -0700323
Darius Augulis2a4f1362008-11-12 13:38:31 -0800324config USB_GADGET_IMX
325 boolean "Freescale IMX USB Peripheral Controller"
326 depends on ARCH_MX1
327 help
328 Freescale's IMX series include an integrated full speed
329 USB 1.1 device controller. The controller in the IMX series
330 is register-compatible.
331
332 It has Six fixed-function endpoints, as well as endpoint
333 zero (for control transfers).
334
335 Say "y" to link the driver statically, or "m" to build a
336 dynamically linked module called "imx_udc" and force all
337 gadget drivers to also be dynamically linked.
338
339config USB_IMX
340 tristate
341 depends on USB_GADGET_IMX
342 default USB_GADGET
343 select USB_GADGET_SELECTED
344
David Brownella7a19fa2008-08-14 17:04:48 -0700345config USB_GADGET_M66592
346 boolean "Renesas M66592 USB Peripheral Controller"
347 select USB_GADGET_DUALSPEED
348 help
349 M66592 is a discrete USB peripheral controller chip that
350 supports both full and high speed USB 2.0 data transfers.
351 It has seven configurable endpoints, and endpoint zero.
David Brownellbae4bd82006-01-22 10:32:37 -0800352
353 Say "y" to link the driver statically, or "m" to build a
David Brownella7a19fa2008-08-14 17:04:48 -0700354 dynamically linked module called "m66592_udc" and force all
David Brownellbae4bd82006-01-22 10:32:37 -0800355 gadget drivers to also be dynamically linked.
356
David Brownella7a19fa2008-08-14 17:04:48 -0700357config USB_M66592
David Brownellbae4bd82006-01-22 10:32:37 -0800358 tristate
David Brownella7a19fa2008-08-14 17:04:48 -0700359 depends on USB_GADGET_M66592
David Brownellbae4bd82006-01-22 10:32:37 -0800360 default USB_GADGET
David Brownella7a19fa2008-08-14 17:04:48 -0700361 select USB_GADGET_SELECTED
362
363config SUPERH_BUILT_IN_M66592
364 boolean "Enable SuperH built-in USB like the M66592"
365 depends on USB_GADGET_M66592 && CPU_SUBTYPE_SH7722
366 help
367 SH7722 has USB like the M66592.
368
369 The transfer rate is very slow when use "Ethernet Gadget".
370 However, this problem is improved if change a value of
371 NET_IP_ALIGN to 4.
372
373#
374# Controllers available only in discrete form (and all PCI controllers)
375#
376
377config USB_GADGET_AMD5536UDC
378 boolean "AMD5536 UDC"
379 depends on PCI
380 select USB_GADGET_DUALSPEED
381 help
382 The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
383 It is a USB Highspeed DMA capable USB device controller. Beside ep0
384 it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
385 The UDC port supports OTG operation, and may be used as a host port
386 if it's not being used to implement peripheral or OTG roles.
387
388 Say "y" to link the driver statically, or "m" to build a
389 dynamically linked module called "amd5536udc" and force all
390 gadget drivers to also be dynamically linked.
391
392config USB_AMD5536UDC
393 tristate
394 depends on USB_GADGET_AMD5536UDC
395 default USB_GADGET
396 select USB_GADGET_SELECTED
397
Li Yang3948f0e2008-09-02 19:58:10 +0800398config USB_GADGET_FSL_QE
399 boolean "Freescale QE/CPM USB Device Controller"
400 depends on FSL_SOC && (QUICC_ENGINE || CPM)
401 help
402 Some of Freescale PowerPC processors have a Full Speed
403 QE/CPM2 USB controller, which support device mode with 4
404 programmable endpoints. This driver supports the
405 controller in the MPC8360 and MPC8272, and should work with
406 controllers having QE or CPM2, given minor tweaks.
407
408 Set CONFIG_USB_GADGET to "m" to build this driver as a
Matt LaPlante692105b2009-01-26 11:12:25 +0100409 dynamically linked module called "fsl_qe_udc".
Li Yang3948f0e2008-09-02 19:58:10 +0800410
411config USB_FSL_QE
412 tristate
413 depends on USB_GADGET_FSL_QE
414 default USB_GADGET
415 select USB_GADGET_SELECTED
416
David Lopoaa69a802008-11-17 14:14:51 -0800417config USB_GADGET_CI13XXX
418 boolean "MIPS USB CI13xxx"
419 depends on PCI
420 select USB_GADGET_DUALSPEED
421 help
422 MIPS USB IP core family device controller
423 Currently it only supports IP part number CI13412
424
425 Say "y" to link the driver statically, or "m" to build a
426 dynamically linked module called "ci13xxx_udc" and force all
427 gadget drivers to also be dynamically linked.
428
429config USB_CI13XXX
430 tristate
431 depends on USB_GADGET_CI13XXX
432 default USB_GADGET
433 select USB_GADGET_SELECTED
434
David Brownella7a19fa2008-08-14 17:04:48 -0700435config USB_GADGET_NET2280
436 boolean "NetChip 228x"
437 depends on PCI
438 select USB_GADGET_DUALSPEED
439 help
440 NetChip 2280 / 2282 is a PCI based USB peripheral controller which
441 supports both full and high speed USB 2.0 data transfers.
442
443 It has six configurable endpoints, as well as endpoint zero
444 (for control transfers) and several endpoints with dedicated
445 functions.
446
447 Say "y" to link the driver statically, or "m" to build a
448 dynamically linked module called "net2280" and force all
449 gadget drivers to also be dynamically linked.
450
451config USB_NET2280
452 tristate
453 depends on USB_GADGET_NET2280
454 default USB_GADGET
455 select USB_GADGET_SELECTED
456
457config USB_GADGET_GOKU
458 boolean "Toshiba TC86C001 'Goku-S'"
459 depends on PCI
460 help
461 The Toshiba TC86C001 is a PCI device which includes controllers
462 for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
463
464 The device controller has three configurable (bulk or interrupt)
465 endpoints, plus endpoint zero (for control transfers).
466
467 Say "y" to link the driver statically, or "m" to build a
468 dynamically linked module called "goku_udc" and to force all
469 gadget drivers to also be dynamically linked.
470
471config USB_GOKU
472 tristate
473 depends on USB_GADGET_GOKU
474 default USB_GADGET
475 select USB_GADGET_SELECTED
476
477
478#
479# LAST -- dummy/emulated controller
480#
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481
482config USB_GADGET_DUMMY_HCD
483 boolean "Dummy HCD (DEVELOPMENT)"
Robert P. J. Dayafd0e0f2008-03-10 15:09:51 -0400484 depends on USB=y || (USB=m && USB_GADGET=m)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485 select USB_GADGET_DUALSPEED
486 help
487 This host controller driver emulates USB, looping all data transfer
488 requests back to a USB "gadget driver" in the same host. The host
489 side is the master; the gadget side is the slave. Gadget drivers
490 can be high, full, or low speed; and they have access to endpoints
491 like those from NET2280, PXA2xx, or SA1100 hardware.
492
493 This may help in some stages of creating a driver to embed in a
494 Linux device, since it lets you debug several parts of the gadget
495 driver without its hardware or drivers being involved.
496
497 Since such a gadget side driver needs to interoperate with a host
498 side Linux-USB device driver, this may help to debug both sides
499 of a USB protocol stack.
500
501 Say "y" to link the driver statically, or "m" to build a
502 dynamically linked module called "dummy_hcd" and force all
503 gadget drivers to also be dynamically linked.
504
505config USB_DUMMY_HCD
506 tristate
507 depends on USB_GADGET_DUMMY_HCD
508 default USB_GADGET
David Brownell028b2712005-05-06 07:02:01 -0700509 select USB_GADGET_SELECTED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
511# NOTE: Please keep dummy_hcd LAST so that "real hardware" appears
512# first and will be selected by default.
513
514endchoice
515
516config USB_GADGET_DUALSPEED
517 bool
518 depends on USB_GADGET
519 default n
520 help
521 Means that gadget drivers should include extra descriptors
522 and code to handle dual-speed controllers.
523
524#
525# USB Gadget Drivers
526#
527choice
528 tristate "USB Gadget Drivers"
David Brownell028b2712005-05-06 07:02:01 -0700529 depends on USB_GADGET && USB_GADGET_SELECTED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530 default USB_ETH
531 help
532 A Linux "Gadget Driver" talks to the USB Peripheral Controller
533 driver through the abstract "gadget" API. Some other operating
534 systems call these "client" drivers, of which "class drivers"
535 are a subset (implementing a USB device class specification).
536 A gadget driver implements one or more USB functions using
537 the peripheral hardware.
538
539 Gadget drivers are hardware-neutral, or "platform independent",
540 except that they sometimes must understand quirks or limitations
541 of the particular controllers they work with. For example, when
542 a controller doesn't support alternate configurations or provide
543 enough of the right types of endpoints, the gadget driver might
544 not be able work with that controller, or might need to implement
545 a less common variant of a device class protocol.
546
547# this first set of drivers all depend on bulk-capable hardware.
548
549config USB_ZERO
550 tristate "Gadget Zero (DEVELOPMENT)"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 help
552 Gadget Zero is a two-configuration device. It either sinks and
553 sources bulk data; or it loops back a configurable number of
554 transfers. It also implements control requests, for "chapter 9"
555 conformance. The driver needs only two bulk-capable endpoints, so
556 it can work on top of most device-side usb controllers. It's
557 useful for testing, and is also a working example showing how
558 USB "gadget drivers" can be written.
559
560 Make this be the first driver you try using on top of any new
561 USB peripheral controller driver. Then you can use host-side
562 test software, like the "usbtest" driver, to put your hardware
563 and its driver through a basic set of functional tests.
564
565 Gadget Zero also works with the host-side "usb-skeleton" driver,
566 and with many kinds of host-side test software. You may need
567 to tweak product and vendor IDs before host software knows about
568 this device, and arrange to select an appropriate configuration.
569
570 Say "y" to link the driver statically, or "m" to build a
571 dynamically linked module called "g_zero".
572
573config USB_ZERO_HNPTEST
574 boolean "HNP Test Device"
575 depends on USB_ZERO && USB_OTG
576 help
577 You can configure this device to enumerate using the device
578 identifiers of the USB-OTG test device. That means that when
579 this gadget connects to another OTG device, with this one using
580 the "B-Peripheral" role, that device will use HNP to let this
581 one serve as the USB host instead (in the "B-Host" role).
582
Bryan Wuc6994e62009-06-03 09:17:58 -0400583config USB_AUDIO
584 tristate "Audio Gadget (EXPERIMENTAL)"
585 depends on SND
586 help
587 Gadget Audio is compatible with USB Audio Class specification 1.0.
588 It will include at least one AudioControl interface, zero or more
589 AudioStream interface and zero or more MIDIStream interface.
590
591 Gadget Audio will use on-board ALSA (CONFIG_SND) audio card to
592 playback or capture audio stream.
593
594 Say "y" to link the driver statically, or "m" to build a
595 dynamically linked module called "g_audio".
596
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597config USB_ETH
598 tristate "Ethernet Gadget (with CDC Ethernet support)"
599 depends on NET
600 help
601 This driver implements Ethernet style communication, in either
602 of two ways:
603
604 - The "Communication Device Class" (CDC) Ethernet Control Model.
605 That protocol is often avoided with pure Ethernet adapters, in
606 favor of simpler vendor-specific hardware, but is widely
607 supported by firmware for smart network devices.
608
609 - On hardware can't implement that protocol, a simple CDC subset
610 is used, placing fewer demands on USB.
611
612 RNDIS support is a third option, more demanding than that subset.
613
614 Within the USB device, this gadget driver exposes a network device
615 "usbX", where X depends on what other networking devices you have.
616 Treat it like a two-node Ethernet link: host, and gadget.
617
618 The Linux-USB host-side "usbnet" driver interoperates with this
619 driver, so that deep I/O queues can be supported. On 2.4 kernels,
620 use "CDCEther" instead, if you're using the CDC option. That CDC
621 mode should also interoperate with standard CDC Ethernet class
622 drivers on other host operating systems.
623
624 Say "y" to link the driver statically, or "m" to build a
625 dynamically linked module called "g_ether".
626
627config USB_ETH_RNDIS
Robert P. J. Dayafd0e0f2008-03-10 15:09:51 -0400628 bool "RNDIS support"
629 depends on USB_ETH
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 default y
631 help
632 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
633 and Microsoft provides redistributable binary RNDIS drivers for
634 older versions of Windows.
635
636 If you say "y" here, the Ethernet gadget driver will try to provide
637 a second device configuration, supporting RNDIS to talk to such
638 Microsoft USB hosts.
639
640 To make MS-Windows work with this, use Documentation/usb/linux.inf
641 as the "driver info file". For versions of MS-Windows older than
642 XP, you'll need to download drivers from Microsoft's website; a URL
643 is given in comments found in that info file.
644
645config USB_GADGETFS
646 tristate "Gadget Filesystem (EXPERIMENTAL)"
647 depends on EXPERIMENTAL
648 help
649 This driver provides a filesystem based API that lets user mode
650 programs implement a single-configuration USB device, including
651 endpoint I/O and control requests that don't relate to enumeration.
652 All endpoints, transfer speeds, and transfer types supported by
653 the hardware are available, through read() and write() calls.
654
Robert P. J. Dayafd0e0f2008-03-10 15:09:51 -0400655 Currently, this option is still labelled as EXPERIMENTAL because
656 of existing race conditions in the underlying in-kernel AIO core.
657
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 Say "y" to link the driver statically, or "m" to build a
659 dynamically linked module called "gadgetfs".
660
661config USB_FILE_STORAGE
662 tristate "File-backed Storage Gadget"
Randy Dunlap87840282007-03-21 13:57:51 -0700663 depends on BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 help
665 The File-backed Storage Gadget acts as a USB Mass Storage
666 disk drive. As its storage repository it can use a regular
667 file or a block device (in much the same way as the "loop"
668 device driver), specified as a module parameter.
669
670 Say "y" to link the driver statically, or "m" to build a
671 dynamically linked module called "g_file_storage".
672
673config USB_FILE_STORAGE_TEST
674 bool "File-backed Storage Gadget testing version"
675 depends on USB_FILE_STORAGE
676 default n
677 help
678 Say "y" to generate the larger testing version of the
679 File-backed Storage Gadget, useful for probing the
680 behavior of USB Mass Storage hosts. Not needed for
681 normal operation.
682
683config USB_G_SERIAL
Felipe Balbi30867752008-08-18 17:39:30 -0700684 tristate "Serial Gadget (with CDC ACM and CDC OBEX support)"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 help
686 The Serial Gadget talks to the Linux-USB generic serial driver.
687 This driver supports a CDC-ACM module option, which can be used
688 to interoperate with MS-Windows hosts or with the Linux-USB
689 "cdc-acm" driver.
690
Felipe Balbi30867752008-08-18 17:39:30 -0700691 This driver also supports a CDC-OBEX option. You will need a
692 user space OBEX server talking to /dev/ttyGS*, since the kernel
693 itself doesn't implement the OBEX protocol.
694
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 Say "y" to link the driver statically, or "m" to build a
696 dynamically linked module called "g_serial".
697
698 For more information, see Documentation/usb/gadget_serial.txt
699 which includes instructions and a "driver info file" needed to
Felipe Balbi30867752008-08-18 17:39:30 -0700700 make MS-Windows work with CDC ACM.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701
Ben Williamsonf2ebf92c2006-08-01 11:28:16 +1000702config USB_MIDI_GADGET
703 tristate "MIDI Gadget (EXPERIMENTAL)"
704 depends on SND && EXPERIMENTAL
705 select SND_RAWMIDI
706 help
707 The MIDI Gadget acts as a USB Audio device, with one MIDI
708 input and one MIDI output. These MIDI jacks appear as
709 a sound "card" in the ALSA sound system. Other MIDI
710 connections can then be made on the gadget system, using
711 ALSA's aconnect utility etc.
712
713 Say "y" to link the driver statically, or "m" to build a
714 dynamically linked module called "g_midi".
715
Craig W. Nadler25a010c2007-11-11 15:00:15 -0800716config USB_G_PRINTER
717 tristate "Printer Gadget"
718 help
719 The Printer Gadget channels data between the USB host and a
720 userspace program driving the print engine. The user space
721 program reads and writes the device file /dev/g_printer to
722 receive or send printer data. It can use ioctl calls to
723 the device file to get or set printer status.
724
725 Say "y" to link the driver statically, or "m" to build a
726 dynamically linked module called "g_printer".
727
728 For more information, see Documentation/usb/gadget_printer.txt
729 which includes sample code for accessing the device file.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730
David Brownell19e20682008-06-19 18:20:26 -0700731config USB_CDC_COMPOSITE
732 tristate "CDC Composite Device (Ethernet and ACM)"
Randy Dunlap4ddd9ec2008-07-03 14:44:59 -0700733 depends on NET
David Brownell19e20682008-06-19 18:20:26 -0700734 help
735 This driver provides two functions in one configuration:
736 a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link.
737
738 This driver requires four bulk and two interrupt endpoints,
739 plus the ability to handle altsettings. Not all peripheral
740 controllers are that capable.
741
742 Say "y" to link the driver statically, or "m" to build a
743 dynamically linked module.
744
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745# put drivers that need isochronous transfer support (for audio
746# or video class gadget drivers), or specific hardware, here.
747
748# - none yet
749
750endchoice
751
Denis Chengb75be4a2008-01-24 16:36:31 +0800752endif # USB_GADGET