blob: 3219d137340a31009893184301b801068fe7e62a [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"
Li Yang33635ef2008-03-06 18:40:07 +0800159 depends on FSL_SOC
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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 help
195 Many Texas Instruments OMAP processors have flexible full
196 speed USB device controllers, with support for up to 30
197 endpoints (plus endpoint zero). This driver supports the
198 controller in the OMAP 1611, and should work with controllers
199 in other OMAP processors too, given minor tweaks.
200
201 Say "y" to link the driver statically, or "m" to build a
202 dynamically linked module called "omap_udc" and force all
203 gadget drivers to also be dynamically linked.
204
205config USB_OMAP
206 tristate
207 depends on USB_GADGET_OMAP
208 default USB_GADGET
David Brownell028b2712005-05-06 07:02:01 -0700209 select USB_GADGET_SELECTED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210
211config USB_OTG
212 boolean "OTG Support"
213 depends on USB_GADGET_OMAP && ARCH_OMAP_OTG && USB_OHCI_HCD
214 help
215 The most notable feature of USB OTG is support for a
216 "Dual-Role" device, which can act as either a device
217 or a host. The initial role choice can be changed
218 later, when two dual-role devices talk to each other.
219
220 Select this only if your OMAP board has a Mini-AB connector.
221
David Brownella7a19fa2008-08-14 17:04:48 -0700222config USB_GADGET_PXA25X
223 boolean "PXA 25x or IXP 4xx"
224 depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX
225 help
226 Intel's PXA 25x series XScale ARM-5TE processors include
227 an integrated full speed USB 1.1 device controller. The
228 controller in the IXP 4xx series is register-compatible.
229
230 It has fifteen fixed-function endpoints, as well as endpoint
231 zero (for control transfers).
232
233 Say "y" to link the driver statically, or "m" to build a
234 dynamically linked module called "pxa25x_udc" and force all
235 gadget drivers to also be dynamically linked.
236
237config USB_PXA25X
238 tristate
239 depends on USB_GADGET_PXA25X
240 default USB_GADGET
241 select USB_GADGET_SELECTED
242
243# if there's only one gadget driver, using only two bulk endpoints,
244# don't waste memory for the other endpoints
245config USB_PXA25X_SMALL
246 depends on USB_GADGET_PXA25X
247 bool
248 default n if USB_ETH_RNDIS
249 default y if USB_ZERO
250 default y if USB_ETH
251 default y if USB_G_SERIAL
252
253config USB_GADGET_PXA27X
254 boolean "PXA 27x"
255 depends on ARCH_PXA && PXA27x
256 help
257 Intel's PXA 27x series XScale ARM v5TE processors include
258 an integrated full speed USB 1.1 device controller.
259
260 It has up to 23 endpoints, as well as endpoint zero (for
261 control transfers).
262
263 Say "y" to link the driver statically, or "m" to build a
264 dynamically linked module called "pxa27x_udc" and force all
265 gadget drivers to also be dynamically linked.
266
267config USB_PXA27X
268 tristate
269 depends on USB_GADGET_PXA27X
270 default USB_GADGET
271 select USB_GADGET_SELECTED
272
Arnaud Patard3fc154b2007-06-06 21:05:49 -0700273config USB_GADGET_S3C2410
274 boolean "S3C2410 USB Device Controller"
275 depends on ARCH_S3C2410
276 help
277 Samsung's S3C2410 is an ARM-4 processor with an integrated
278 full speed USB 1.1 device controller. It has 4 configurable
279 endpoints, as well as endpoint zero (for control transfers).
280
281 This driver has been tested on the S3C2410, S3C2412, and
282 S3C2440 processors.
283
284config USB_S3C2410
285 tristate
286 depends on USB_GADGET_S3C2410
287 default USB_GADGET
288 select USB_GADGET_SELECTED
289
290config USB_S3C2410_DEBUG
291 boolean "S3C2410 udc debug messages"
292 depends on USB_GADGET_S3C2410
293
David Brownella7a19fa2008-08-14 17:04:48 -0700294#
295# Controllers available in both integrated and discrete versions
296#
297
298# musb builds in ../musb along with host support
299config USB_GADGET_MUSB_HDRC
Bryan Wu085ad402008-12-02 21:33:49 +0200300 boolean "Inventra HDRC USB Peripheral (TI, ADI, ...)"
David Brownella7a19fa2008-08-14 17:04:48 -0700301 depends on USB_MUSB_HDRC && (USB_MUSB_PERIPHERAL || USB_MUSB_OTG)
302 select USB_GADGET_DUALSPEED
David Brownellbae4bd82006-01-22 10:32:37 -0800303 select USB_GADGET_SELECTED
304 help
David Brownella7a19fa2008-08-14 17:04:48 -0700305 This OTG-capable silicon IP is used in dual designs including
Bryan Wu085ad402008-12-02 21:33:49 +0200306 the TI DaVinci, OMAP 243x, OMAP 343x, TUSB 6010, and ADI Blackfin
David Brownella7a19fa2008-08-14 17:04:48 -0700307
Darius Augulis2a4f1362008-11-12 13:38:31 -0800308config USB_GADGET_IMX
309 boolean "Freescale IMX USB Peripheral Controller"
310 depends on ARCH_MX1
311 help
312 Freescale's IMX series include an integrated full speed
313 USB 1.1 device controller. The controller in the IMX series
314 is register-compatible.
315
316 It has Six fixed-function endpoints, as well as endpoint
317 zero (for control transfers).
318
319 Say "y" to link the driver statically, or "m" to build a
320 dynamically linked module called "imx_udc" and force all
321 gadget drivers to also be dynamically linked.
322
323config USB_IMX
324 tristate
325 depends on USB_GADGET_IMX
326 default USB_GADGET
327 select USB_GADGET_SELECTED
328
David Brownella7a19fa2008-08-14 17:04:48 -0700329config USB_GADGET_M66592
330 boolean "Renesas M66592 USB Peripheral Controller"
331 select USB_GADGET_DUALSPEED
332 help
333 M66592 is a discrete USB peripheral controller chip that
334 supports both full and high speed USB 2.0 data transfers.
335 It has seven configurable endpoints, and endpoint zero.
David Brownellbae4bd82006-01-22 10:32:37 -0800336
337 Say "y" to link the driver statically, or "m" to build a
David Brownella7a19fa2008-08-14 17:04:48 -0700338 dynamically linked module called "m66592_udc" and force all
David Brownellbae4bd82006-01-22 10:32:37 -0800339 gadget drivers to also be dynamically linked.
340
David Brownella7a19fa2008-08-14 17:04:48 -0700341config USB_M66592
David Brownellbae4bd82006-01-22 10:32:37 -0800342 tristate
David Brownella7a19fa2008-08-14 17:04:48 -0700343 depends on USB_GADGET_M66592
David Brownellbae4bd82006-01-22 10:32:37 -0800344 default USB_GADGET
David Brownella7a19fa2008-08-14 17:04:48 -0700345 select USB_GADGET_SELECTED
346
347config SUPERH_BUILT_IN_M66592
348 boolean "Enable SuperH built-in USB like the M66592"
349 depends on USB_GADGET_M66592 && CPU_SUBTYPE_SH7722
350 help
351 SH7722 has USB like the M66592.
352
353 The transfer rate is very slow when use "Ethernet Gadget".
354 However, this problem is improved if change a value of
355 NET_IP_ALIGN to 4.
356
357#
358# Controllers available only in discrete form (and all PCI controllers)
359#
360
361config USB_GADGET_AMD5536UDC
362 boolean "AMD5536 UDC"
363 depends on PCI
364 select USB_GADGET_DUALSPEED
365 help
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.
371
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.
375
376config USB_AMD5536UDC
377 tristate
378 depends on USB_GADGET_AMD5536UDC
379 default USB_GADGET
380 select USB_GADGET_SELECTED
381
Li Yang3948f0e2008-09-02 19:58:10 +0800382config USB_GADGET_FSL_QE
383 boolean "Freescale QE/CPM USB Device Controller"
384 depends on FSL_SOC && (QUICC_ENGINE || CPM)
385 help
386 Some of Freescale PowerPC processors have a Full Speed
387 QE/CPM2 USB controller, which support device mode with 4
388 programmable endpoints. This driver supports the
389 controller in the MPC8360 and MPC8272, and should work with
390 controllers having QE or CPM2, given minor tweaks.
391
392 Set CONFIG_USB_GADGET to "m" to build this driver as a
393 dynmically linked module called "fsl_qe_udc".
394
395config USB_FSL_QE
396 tristate
397 depends on USB_GADGET_FSL_QE
398 default USB_GADGET
399 select USB_GADGET_SELECTED
400
David Lopoaa69a802008-11-17 14:14:51 -0800401config USB_GADGET_CI13XXX
402 boolean "MIPS USB CI13xxx"
403 depends on PCI
404 select USB_GADGET_DUALSPEED
405 help
406 MIPS USB IP core family device controller
407 Currently it only supports IP part number CI13412
408
409 Say "y" to link the driver statically, or "m" to build a
410 dynamically linked module called "ci13xxx_udc" and force all
411 gadget drivers to also be dynamically linked.
412
413config USB_CI13XXX
414 tristate
415 depends on USB_GADGET_CI13XXX
416 default USB_GADGET
417 select USB_GADGET_SELECTED
418
David Brownella7a19fa2008-08-14 17:04:48 -0700419config USB_GADGET_NET2280
420 boolean "NetChip 228x"
421 depends on PCI
422 select USB_GADGET_DUALSPEED
423 help
424 NetChip 2280 / 2282 is a PCI based USB peripheral controller which
425 supports both full and high speed USB 2.0 data transfers.
426
427 It has six configurable endpoints, as well as endpoint zero
428 (for control transfers) and several endpoints with dedicated
429 functions.
430
431 Say "y" to link the driver statically, or "m" to build a
432 dynamically linked module called "net2280" and force all
433 gadget drivers to also be dynamically linked.
434
435config USB_NET2280
436 tristate
437 depends on USB_GADGET_NET2280
438 default USB_GADGET
439 select USB_GADGET_SELECTED
440
441config USB_GADGET_GOKU
442 boolean "Toshiba TC86C001 'Goku-S'"
443 depends on PCI
444 help
445 The Toshiba TC86C001 is a PCI device which includes controllers
446 for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
447
448 The device controller has three configurable (bulk or interrupt)
449 endpoints, plus endpoint zero (for control transfers).
450
451 Say "y" to link the driver statically, or "m" to build a
452 dynamically linked module called "goku_udc" and to force all
453 gadget drivers to also be dynamically linked.
454
455config USB_GOKU
456 tristate
457 depends on USB_GADGET_GOKU
458 default USB_GADGET
459 select USB_GADGET_SELECTED
460
461
462#
463# LAST -- dummy/emulated controller
464#
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465
466config USB_GADGET_DUMMY_HCD
467 boolean "Dummy HCD (DEVELOPMENT)"
Robert P. J. Dayafd0e0f2008-03-10 15:09:51 -0400468 depends on USB=y || (USB=m && USB_GADGET=m)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 select USB_GADGET_DUALSPEED
470 help
471 This host controller driver emulates USB, looping all data transfer
472 requests back to a USB "gadget driver" in the same host. The host
473 side is the master; the gadget side is the slave. Gadget drivers
474 can be high, full, or low speed; and they have access to endpoints
475 like those from NET2280, PXA2xx, or SA1100 hardware.
476
477 This may help in some stages of creating a driver to embed in a
478 Linux device, since it lets you debug several parts of the gadget
479 driver without its hardware or drivers being involved.
480
481 Since such a gadget side driver needs to interoperate with a host
482 side Linux-USB device driver, this may help to debug both sides
483 of a USB protocol stack.
484
485 Say "y" to link the driver statically, or "m" to build a
486 dynamically linked module called "dummy_hcd" and force all
487 gadget drivers to also be dynamically linked.
488
489config USB_DUMMY_HCD
490 tristate
491 depends on USB_GADGET_DUMMY_HCD
492 default USB_GADGET
David Brownell028b2712005-05-06 07:02:01 -0700493 select USB_GADGET_SELECTED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494
495# NOTE: Please keep dummy_hcd LAST so that "real hardware" appears
496# first and will be selected by default.
497
498endchoice
499
500config USB_GADGET_DUALSPEED
501 bool
502 depends on USB_GADGET
503 default n
504 help
505 Means that gadget drivers should include extra descriptors
506 and code to handle dual-speed controllers.
507
508#
509# USB Gadget Drivers
510#
511choice
512 tristate "USB Gadget Drivers"
David Brownell028b2712005-05-06 07:02:01 -0700513 depends on USB_GADGET && USB_GADGET_SELECTED
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 default USB_ETH
515 help
516 A Linux "Gadget Driver" talks to the USB Peripheral Controller
517 driver through the abstract "gadget" API. Some other operating
518 systems call these "client" drivers, of which "class drivers"
519 are a subset (implementing a USB device class specification).
520 A gadget driver implements one or more USB functions using
521 the peripheral hardware.
522
523 Gadget drivers are hardware-neutral, or "platform independent",
524 except that they sometimes must understand quirks or limitations
525 of the particular controllers they work with. For example, when
526 a controller doesn't support alternate configurations or provide
527 enough of the right types of endpoints, the gadget driver might
528 not be able work with that controller, or might need to implement
529 a less common variant of a device class protocol.
530
531# this first set of drivers all depend on bulk-capable hardware.
532
533config USB_ZERO
534 tristate "Gadget Zero (DEVELOPMENT)"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 help
536 Gadget Zero is a two-configuration device. It either sinks and
537 sources bulk data; or it loops back a configurable number of
538 transfers. It also implements control requests, for "chapter 9"
539 conformance. The driver needs only two bulk-capable endpoints, so
540 it can work on top of most device-side usb controllers. It's
541 useful for testing, and is also a working example showing how
542 USB "gadget drivers" can be written.
543
544 Make this be the first driver you try using on top of any new
545 USB peripheral controller driver. Then you can use host-side
546 test software, like the "usbtest" driver, to put your hardware
547 and its driver through a basic set of functional tests.
548
549 Gadget Zero also works with the host-side "usb-skeleton" driver,
550 and with many kinds of host-side test software. You may need
551 to tweak product and vendor IDs before host software knows about
552 this device, and arrange to select an appropriate configuration.
553
554 Say "y" to link the driver statically, or "m" to build a
555 dynamically linked module called "g_zero".
556
557config USB_ZERO_HNPTEST
558 boolean "HNP Test Device"
559 depends on USB_ZERO && USB_OTG
560 help
561 You can configure this device to enumerate using the device
562 identifiers of the USB-OTG test device. That means that when
563 this gadget connects to another OTG device, with this one using
564 the "B-Peripheral" role, that device will use HNP to let this
565 one serve as the USB host instead (in the "B-Host" role).
566
567config USB_ETH
568 tristate "Ethernet Gadget (with CDC Ethernet support)"
569 depends on NET
570 help
571 This driver implements Ethernet style communication, in either
572 of two ways:
573
574 - The "Communication Device Class" (CDC) Ethernet Control Model.
575 That protocol is often avoided with pure Ethernet adapters, in
576 favor of simpler vendor-specific hardware, but is widely
577 supported by firmware for smart network devices.
578
579 - On hardware can't implement that protocol, a simple CDC subset
580 is used, placing fewer demands on USB.
581
582 RNDIS support is a third option, more demanding than that subset.
583
584 Within the USB device, this gadget driver exposes a network device
585 "usbX", where X depends on what other networking devices you have.
586 Treat it like a two-node Ethernet link: host, and gadget.
587
588 The Linux-USB host-side "usbnet" driver interoperates with this
589 driver, so that deep I/O queues can be supported. On 2.4 kernels,
590 use "CDCEther" instead, if you're using the CDC option. That CDC
591 mode should also interoperate with standard CDC Ethernet class
592 drivers on other host operating systems.
593
594 Say "y" to link the driver statically, or "m" to build a
595 dynamically linked module called "g_ether".
596
597config USB_ETH_RNDIS
Robert P. J. Dayafd0e0f2008-03-10 15:09:51 -0400598 bool "RNDIS support"
599 depends on USB_ETH
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 default y
601 help
602 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
603 and Microsoft provides redistributable binary RNDIS drivers for
604 older versions of Windows.
605
606 If you say "y" here, the Ethernet gadget driver will try to provide
607 a second device configuration, supporting RNDIS to talk to such
608 Microsoft USB hosts.
609
610 To make MS-Windows work with this, use Documentation/usb/linux.inf
611 as the "driver info file". For versions of MS-Windows older than
612 XP, you'll need to download drivers from Microsoft's website; a URL
613 is given in comments found in that info file.
614
615config USB_GADGETFS
616 tristate "Gadget Filesystem (EXPERIMENTAL)"
617 depends on EXPERIMENTAL
618 help
619 This driver provides a filesystem based API that lets user mode
620 programs implement a single-configuration USB device, including
621 endpoint I/O and control requests that don't relate to enumeration.
622 All endpoints, transfer speeds, and transfer types supported by
623 the hardware are available, through read() and write() calls.
624
Robert P. J. Dayafd0e0f2008-03-10 15:09:51 -0400625 Currently, this option is still labelled as EXPERIMENTAL because
626 of existing race conditions in the underlying in-kernel AIO core.
627
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 Say "y" to link the driver statically, or "m" to build a
629 dynamically linked module called "gadgetfs".
630
631config USB_FILE_STORAGE
632 tristate "File-backed Storage Gadget"
Randy Dunlap87840282007-03-21 13:57:51 -0700633 depends on BLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 help
635 The File-backed Storage Gadget acts as a USB Mass Storage
636 disk drive. As its storage repository it can use a regular
637 file or a block device (in much the same way as the "loop"
638 device driver), specified as a module parameter.
639
640 Say "y" to link the driver statically, or "m" to build a
641 dynamically linked module called "g_file_storage".
642
643config USB_FILE_STORAGE_TEST
644 bool "File-backed Storage Gadget testing version"
645 depends on USB_FILE_STORAGE
646 default n
647 help
648 Say "y" to generate the larger testing version of the
649 File-backed Storage Gadget, useful for probing the
650 behavior of USB Mass Storage hosts. Not needed for
651 normal operation.
652
653config USB_G_SERIAL
Felipe Balbi30867752008-08-18 17:39:30 -0700654 tristate "Serial Gadget (with CDC ACM and CDC OBEX support)"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 help
656 The Serial Gadget talks to the Linux-USB generic serial driver.
657 This driver supports a CDC-ACM module option, which can be used
658 to interoperate with MS-Windows hosts or with the Linux-USB
659 "cdc-acm" driver.
660
Felipe Balbi30867752008-08-18 17:39:30 -0700661 This driver also supports a CDC-OBEX option. You will need a
662 user space OBEX server talking to /dev/ttyGS*, since the kernel
663 itself doesn't implement the OBEX protocol.
664
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 Say "y" to link the driver statically, or "m" to build a
666 dynamically linked module called "g_serial".
667
668 For more information, see Documentation/usb/gadget_serial.txt
669 which includes instructions and a "driver info file" needed to
Felipe Balbi30867752008-08-18 17:39:30 -0700670 make MS-Windows work with CDC ACM.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671
Ben Williamsonf2ebf92c2006-08-01 11:28:16 +1000672config USB_MIDI_GADGET
673 tristate "MIDI Gadget (EXPERIMENTAL)"
674 depends on SND && EXPERIMENTAL
675 select SND_RAWMIDI
676 help
677 The MIDI Gadget acts as a USB Audio device, with one MIDI
678 input and one MIDI output. These MIDI jacks appear as
679 a sound "card" in the ALSA sound system. Other MIDI
680 connections can then be made on the gadget system, using
681 ALSA's aconnect utility etc.
682
683 Say "y" to link the driver statically, or "m" to build a
684 dynamically linked module called "g_midi".
685
Craig W. Nadler25a010c2007-11-11 15:00:15 -0800686config USB_G_PRINTER
687 tristate "Printer Gadget"
688 help
689 The Printer Gadget channels data between the USB host and a
690 userspace program driving the print engine. The user space
691 program reads and writes the device file /dev/g_printer to
692 receive or send printer data. It can use ioctl calls to
693 the device file to get or set printer status.
694
695 Say "y" to link the driver statically, or "m" to build a
696 dynamically linked module called "g_printer".
697
698 For more information, see Documentation/usb/gadget_printer.txt
699 which includes sample code for accessing the device file.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700
David Brownell19e20682008-06-19 18:20:26 -0700701config USB_CDC_COMPOSITE
702 tristate "CDC Composite Device (Ethernet and ACM)"
Randy Dunlap4ddd9ec2008-07-03 14:44:59 -0700703 depends on NET
David Brownell19e20682008-06-19 18:20:26 -0700704 help
705 This driver provides two functions in one configuration:
706 a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link.
707
708 This driver requires four bulk and two interrupt endpoints,
709 plus the ability to handle altsettings. Not all peripheral
710 controllers are that capable.
711
712 Say "y" to link the driver statically, or "m" to build a
713 dynamically linked module.
714
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715# put drivers that need isochronous transfer support (for audio
716# or video class gadget drivers), or specific hardware, here.
717
718# - none yet
719
720endchoice
721
Denis Chengb75be4a2008-01-24 16:36:31 +0800722endif # USB_GADGET