Merge branch 'master' of /pub/scm/linux/kernel/git/torvalds/linux-2.6
[linux-2.6] / drivers / usb / gadget / Kconfig
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).
10 #  - Some systems have both kinds of controllers.
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 #
15 menu "USB Gadget Support"
16
17 config USB_GADGET
18         tristate "Support for USB Gadgets"
19         help
20            USB is a master/slave protocol, organized with one master
21            host (such as a PC) controlling up to 127 peripheral devices.
22            The USB hardware is asymmetric, which makes it easier to set up:
23            you can't connect a "to-the-host" connector to a peripheral.
24
25            Linux can run in the host, or in the peripheral.  In both cases
26            you need a low level bus controller driver, and some software
27            talking to it.  Peripheral controllers are often discrete silicon,
28            or are integrated with the CPU in a microcontroller.  The more
29            familiar host side controllers have names like "EHCI", "OHCI",
30            or "UHCI", and are usually integrated into southbridges on PC
31            motherboards.
32
33            Enable this configuration option if you want to run Linux inside
34            a USB peripheral device.  Configure one hardware driver for your
35            peripheral/device side bus controller, and a "gadget driver" for
36            your peripheral protocol.  (If you use modular gadget drivers,
37            you may configure more than one.)
38
39            If in doubt, say "N" and don't enable these drivers; most people
40            don't have this kind of hardware (except maybe inside Linux PDAs).
41
42            For more information, see <http://www.linux-usb.org/gadget> and
43            the kernel DocBook documentation for this API.
44
45 config USB_GADGET_DEBUG
46         boolean "Debugging messages"
47         depends on USB_GADGET && DEBUG_KERNEL && EXPERIMENTAL
48         help
49            Many controller and gadget drivers will print some debugging
50            messages if you use this option to ask for those messages.
51
52            Avoid enabling these messages, even if you're actively
53            debugging such a driver.  Many drivers will emit so many
54            messages that the driver timings are affected, which will
55            either create new failure modes or remove the one you're
56            trying to track down.  Never enable these messages for a
57            production build.
58
59 config USB_GADGET_DEBUG_FILES
60         boolean "Debugging information files"
61         depends on USB_GADGET && PROC_FS
62         help
63            Some of the drivers in the "gadget" framework can expose
64            debugging information in files such as /proc/driver/udc
65            (for a peripheral controller).  The information in these
66            files may help when you're troubleshooting or bringing up a
67            driver on a new board.   Enable these files by choosing "Y"
68            here.  If in doubt, or to conserve kernel memory, say "N".
69
70 config USB_GADGET_DEBUG_FS
71         boolean "Debugging information files in debugfs"
72         depends on USB_GADGET && DEBUG_FS
73         help
74            Some of the drivers in the "gadget" framework can expose
75            debugging information in files under /sys/kernel/debug/.
76            The information in these files may help when you're
77            troubleshooting or bringing up a driver on a new board.
78            Enable these files by choosing "Y" here.  If in doubt, or
79            to conserve kernel memory, say "N".
80
81 config  USB_GADGET_SELECTED
82         boolean
83
84 #
85 # USB Peripheral Controller Support
86 #
87 choice
88         prompt "USB Peripheral Controller"
89         depends on USB_GADGET
90         help
91            A USB device uses a controller to talk to its host.
92            Systems should have only one such upstream link.
93            Many controller drivers are platform-specific; these
94            often need board-specific hooks.
95
96 config USB_GADGET_AMD5536UDC
97         boolean "AMD5536 UDC"
98         depends on PCI
99         select USB_GADGET_DUALSPEED
100         help
101            The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
102            It is a USB Highspeed DMA capable USB device controller. Beside ep0
103            it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
104            The UDC port supports OTG operation, and may be used as a host port
105            if it's not being used to implement peripheral or OTG roles.
106
107            Say "y" to link the driver statically, or "m" to build a
108            dynamically linked module called "amd5536udc" and force all
109            gadget drivers to also be dynamically linked.
110
111 config USB_AMD5536UDC
112         tristate
113         depends on USB_GADGET_AMD5536UDC
114         default USB_GADGET
115         select USB_GADGET_SELECTED
116
117 config USB_GADGET_ATMEL_USBA
118         boolean "Atmel USBA"
119         select USB_GADGET_DUALSPEED
120         depends on AVR32
121         help
122           USBA is the integrated high-speed USB Device controller on
123           the AT32AP700x processors from Atmel.
124
125 config USB_ATMEL_USBA
126         tristate
127         depends on USB_GADGET_ATMEL_USBA
128         default USB_GADGET
129         select USB_GADGET_SELECTED
130
131 config USB_GADGET_FSL_USB2
132         boolean "Freescale Highspeed USB DR Peripheral Controller"
133         depends on MPC834x || PPC_MPC831x
134         select USB_GADGET_DUALSPEED
135         help
136            Some of Freescale PowerPC processors have a High Speed
137            Dual-Role(DR) USB controller, which supports device mode.
138
139            The number of programmable endpoints is different through
140            SOC revisions.
141
142            Say "y" to link the driver statically, or "m" to build a
143            dynamically linked module called "fsl_usb2_udc" and force
144            all gadget drivers to also be dynamically linked.
145
146 config USB_FSL_USB2
147         tristate
148         depends on USB_GADGET_FSL_USB2
149         default USB_GADGET
150         select USB_GADGET_SELECTED
151
152 config USB_GADGET_NET2280
153         boolean "NetChip 228x"
154         depends on PCI
155         select USB_GADGET_DUALSPEED
156         help
157            NetChip 2280 / 2282 is a PCI based USB peripheral controller which
158            supports both full and high speed USB 2.0 data transfers.  
159            
160            It has six configurable endpoints, as well as endpoint zero
161            (for control transfers) and several endpoints with dedicated
162            functions.
163
164            Say "y" to link the driver statically, or "m" to build a
165            dynamically linked module called "net2280" and force all
166            gadget drivers to also be dynamically linked.
167
168 config USB_NET2280
169         tristate
170         depends on USB_GADGET_NET2280
171         default USB_GADGET
172         select USB_GADGET_SELECTED
173
174 config USB_GADGET_PXA2XX
175         boolean "PXA 25x or IXP 4xx"
176         depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX
177         help
178            Intel's PXA 25x series XScale ARM-5TE processors include
179            an integrated full speed USB 1.1 device controller.  The
180            controller in the IXP 4xx series is register-compatible.
181
182            It has fifteen fixed-function endpoints, as well as endpoint
183            zero (for control transfers).
184
185            Say "y" to link the driver statically, or "m" to build a
186            dynamically linked module called "pxa2xx_udc" and force all
187            gadget drivers to also be dynamically linked.
188
189 config USB_PXA2XX
190         tristate
191         depends on USB_GADGET_PXA2XX
192         default USB_GADGET
193         select USB_GADGET_SELECTED
194
195 # if there's only one gadget driver, using only two bulk endpoints,
196 # don't waste memory for the other endpoints
197 config USB_PXA2XX_SMALL
198         depends on USB_GADGET_PXA2XX
199         bool
200         default n if USB_ETH_RNDIS
201         default y if USB_ZERO
202         default y if USB_ETH
203         default y if USB_G_SERIAL
204
205 config USB_GADGET_M66592
206         boolean "Renesas M66592 USB Peripheral Controller"
207         select USB_GADGET_DUALSPEED
208         help
209            M66592 is a discrete USB peripheral controller chip that
210            supports both full and high speed USB 2.0 data transfers.
211            It has seven configurable endpoints, and endpoint zero.
212
213            Say "y" to link the driver statically, or "m" to build a
214            dynamically linked module called "m66592_udc" and force all
215            gadget drivers to also be dynamically linked.
216
217 config USB_M66592
218         tristate
219         depends on USB_GADGET_M66592
220         default USB_GADGET
221         select USB_GADGET_SELECTED
222
223 config USB_GADGET_GOKU
224         boolean "Toshiba TC86C001 'Goku-S'"
225         depends on PCI
226         help
227            The Toshiba TC86C001 is a PCI device which includes controllers
228            for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
229            
230            The device controller has three configurable (bulk or interrupt)
231            endpoints, plus endpoint zero (for control transfers).
232
233            Say "y" to link the driver statically, or "m" to build a
234            dynamically linked module called "goku_udc" and to force all
235            gadget drivers to also be dynamically linked.
236
237 config USB_GOKU
238         tristate
239         depends on USB_GADGET_GOKU
240         default USB_GADGET
241         select USB_GADGET_SELECTED
242
243
244 config USB_GADGET_LH7A40X
245         boolean "LH7A40X"
246         depends on ARCH_LH7A40X
247         help
248     This driver provides USB Device Controller driver for LH7A40x
249
250 config USB_LH7A40X
251         tristate
252         depends on USB_GADGET_LH7A40X
253         default USB_GADGET
254         select USB_GADGET_SELECTED
255
256 config USB_GADGET_OMAP
257         boolean "OMAP USB Device Controller"
258         depends on ARCH_OMAP
259         select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3
260         help
261            Many Texas Instruments OMAP processors have flexible full
262            speed USB device controllers, with support for up to 30
263            endpoints (plus endpoint zero).  This driver supports the
264            controller in the OMAP 1611, and should work with controllers
265            in other OMAP processors too, given minor tweaks.
266
267            Say "y" to link the driver statically, or "m" to build a
268            dynamically linked module called "omap_udc" and force all
269            gadget drivers to also be dynamically linked.
270
271 config USB_OMAP
272         tristate
273         depends on USB_GADGET_OMAP
274         default USB_GADGET
275         select USB_GADGET_SELECTED
276
277 config USB_OTG
278         boolean "OTG Support"
279         depends on USB_GADGET_OMAP && ARCH_OMAP_OTG && USB_OHCI_HCD
280         help
281            The most notable feature of USB OTG is support for a
282            "Dual-Role" device, which can act as either a device
283            or a host.  The initial role choice can be changed
284            later, when two dual-role devices talk to each other.
285
286            Select this only if your OMAP board has a Mini-AB connector.
287
288 config USB_GADGET_S3C2410
289         boolean "S3C2410 USB Device Controller"
290         depends on ARCH_S3C2410
291         help
292           Samsung's S3C2410 is an ARM-4 processor with an integrated
293           full speed USB 1.1 device controller.  It has 4 configurable
294           endpoints, as well as endpoint zero (for control transfers).
295
296           This driver has been tested on the S3C2410, S3C2412, and
297           S3C2440 processors.
298
299 config USB_S3C2410
300         tristate
301         depends on USB_GADGET_S3C2410
302         default USB_GADGET
303         select USB_GADGET_SELECTED
304
305 config USB_S3C2410_DEBUG
306         boolean "S3C2410 udc debug messages"
307         depends on USB_GADGET_S3C2410
308
309 config USB_GADGET_AT91
310         boolean "AT91 USB Device Port"
311         depends on ARCH_AT91 && !ARCH_AT91SAM9RL
312         select USB_GADGET_SELECTED
313         help
314            Many Atmel AT91 processors (such as the AT91RM2000) have a
315            full speed USB Device Port with support for five configurable
316            endpoints (plus endpoint zero).
317
318            Say "y" to link the driver statically, or "m" to build a
319            dynamically linked module called "at91_udc" and force all
320            gadget drivers to also be dynamically linked.
321
322 config USB_AT91
323         tristate
324         depends on USB_GADGET_AT91
325         default USB_GADGET
326
327 config USB_GADGET_DUMMY_HCD
328         boolean "Dummy HCD (DEVELOPMENT)"
329         depends on (USB=y || (USB=m && USB_GADGET=m)) && EXPERIMENTAL
330         select USB_GADGET_DUALSPEED
331         help
332           This host controller driver emulates USB, looping all data transfer
333           requests back to a USB "gadget driver" in the same host.  The host
334           side is the master; the gadget side is the slave.  Gadget drivers
335           can be high, full, or low speed; and they have access to endpoints
336           like those from NET2280, PXA2xx, or SA1100 hardware.
337           
338           This may help in some stages of creating a driver to embed in a
339           Linux device, since it lets you debug several parts of the gadget
340           driver without its hardware or drivers being involved.
341           
342           Since such a gadget side driver needs to interoperate with a host
343           side Linux-USB device driver, this may help to debug both sides
344           of a USB protocol stack.
345
346           Say "y" to link the driver statically, or "m" to build a
347           dynamically linked module called "dummy_hcd" and force all
348           gadget drivers to also be dynamically linked.
349
350 config USB_DUMMY_HCD
351         tristate
352         depends on USB_GADGET_DUMMY_HCD
353         default USB_GADGET
354         select USB_GADGET_SELECTED
355
356 # NOTE:  Please keep dummy_hcd LAST so that "real hardware" appears
357 # first and will be selected by default.
358
359 endchoice
360
361 config USB_GADGET_DUALSPEED
362         bool
363         depends on USB_GADGET
364         default n
365         help
366           Means that gadget drivers should include extra descriptors
367           and code to handle dual-speed controllers.
368
369 #
370 # USB Gadget Drivers
371 #
372 choice
373         tristate "USB Gadget Drivers"
374         depends on USB_GADGET && USB_GADGET_SELECTED
375         default USB_ETH
376         help
377           A Linux "Gadget Driver" talks to the USB Peripheral Controller
378           driver through the abstract "gadget" API.  Some other operating
379           systems call these "client" drivers, of which "class drivers"
380           are a subset (implementing a USB device class specification).
381           A gadget driver implements one or more USB functions using
382           the peripheral hardware.
383
384           Gadget drivers are hardware-neutral, or "platform independent",
385           except that they sometimes must understand quirks or limitations
386           of the particular controllers they work with.  For example, when
387           a controller doesn't support alternate configurations or provide
388           enough of the right types of endpoints, the gadget driver might
389           not be able work with that controller, or might need to implement
390           a less common variant of a device class protocol.
391
392 # this first set of drivers all depend on bulk-capable hardware.
393
394 config USB_ZERO
395         tristate "Gadget Zero (DEVELOPMENT)"
396         depends on EXPERIMENTAL
397         help
398           Gadget Zero is a two-configuration device.  It either sinks and
399           sources bulk data; or it loops back a configurable number of
400           transfers.  It also implements control requests, for "chapter 9"
401           conformance.  The driver needs only two bulk-capable endpoints, so
402           it can work on top of most device-side usb controllers.  It's
403           useful for testing, and is also a working example showing how
404           USB "gadget drivers" can be written.
405
406           Make this be the first driver you try using on top of any new
407           USB peripheral controller driver.  Then you can use host-side
408           test software, like the "usbtest" driver, to put your hardware
409           and its driver through a basic set of functional tests.
410
411           Gadget Zero also works with the host-side "usb-skeleton" driver,
412           and with many kinds of host-side test software.  You may need
413           to tweak product and vendor IDs before host software knows about
414           this device, and arrange to select an appropriate configuration.
415
416           Say "y" to link the driver statically, or "m" to build a
417           dynamically linked module called "g_zero".
418
419 config USB_ZERO_HNPTEST
420         boolean "HNP Test Device"
421         depends on USB_ZERO && USB_OTG
422         help
423           You can configure this device to enumerate using the device
424           identifiers of the USB-OTG test device.  That means that when
425           this gadget connects to another OTG device, with this one using
426           the "B-Peripheral" role, that device will use HNP to let this
427           one serve as the USB host instead (in the "B-Host" role).
428
429 config USB_ETH
430         tristate "Ethernet Gadget (with CDC Ethernet support)"
431         depends on NET
432         help
433           This driver implements Ethernet style communication, in either
434           of two ways:
435           
436            - The "Communication Device Class" (CDC) Ethernet Control Model.
437              That protocol is often avoided with pure Ethernet adapters, in
438              favor of simpler vendor-specific hardware, but is widely
439              supported by firmware for smart network devices.
440
441            - On hardware can't implement that protocol, a simple CDC subset
442              is used, placing fewer demands on USB.
443
444           RNDIS support is a third option, more demanding than that subset.
445
446           Within the USB device, this gadget driver exposes a network device
447           "usbX", where X depends on what other networking devices you have.
448           Treat it like a two-node Ethernet link:  host, and gadget.
449
450           The Linux-USB host-side "usbnet" driver interoperates with this
451           driver, so that deep I/O queues can be supported.  On 2.4 kernels,
452           use "CDCEther" instead, if you're using the CDC option. That CDC
453           mode should also interoperate with standard CDC Ethernet class
454           drivers on other host operating systems.
455
456           Say "y" to link the driver statically, or "m" to build a
457           dynamically linked module called "g_ether".
458
459 config USB_ETH_RNDIS
460         bool "RNDIS support (EXPERIMENTAL)"
461         depends on USB_ETH && EXPERIMENTAL
462         default y
463         help
464            Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
465            and Microsoft provides redistributable binary RNDIS drivers for
466            older versions of Windows.
467
468            If you say "y" here, the Ethernet gadget driver will try to provide
469            a second device configuration, supporting RNDIS to talk to such
470            Microsoft USB hosts.
471            
472            To make MS-Windows work with this, use Documentation/usb/linux.inf
473            as the "driver info file".  For versions of MS-Windows older than
474            XP, you'll need to download drivers from Microsoft's website; a URL
475            is given in comments found in that info file.
476
477 config USB_GADGETFS
478         tristate "Gadget Filesystem (EXPERIMENTAL)"
479         depends on EXPERIMENTAL
480         help
481           This driver provides a filesystem based API that lets user mode
482           programs implement a single-configuration USB device, including
483           endpoint I/O and control requests that don't relate to enumeration.
484           All endpoints, transfer speeds, and transfer types supported by
485           the hardware are available, through read() and write() calls.
486
487           Say "y" to link the driver statically, or "m" to build a
488           dynamically linked module called "gadgetfs".
489
490 config USB_FILE_STORAGE
491         tristate "File-backed Storage Gadget"
492         depends on BLOCK
493         help
494           The File-backed Storage Gadget acts as a USB Mass Storage
495           disk drive.  As its storage repository it can use a regular
496           file or a block device (in much the same way as the "loop"
497           device driver), specified as a module parameter.
498
499           Say "y" to link the driver statically, or "m" to build a
500           dynamically linked module called "g_file_storage".
501
502 config USB_FILE_STORAGE_TEST
503         bool "File-backed Storage Gadget testing version"
504         depends on USB_FILE_STORAGE
505         default n
506         help
507           Say "y" to generate the larger testing version of the
508           File-backed Storage Gadget, useful for probing the
509           behavior of USB Mass Storage hosts.  Not needed for
510           normal operation.
511
512 config USB_G_SERIAL
513         tristate "Serial Gadget (with CDC ACM support)"
514         help
515           The Serial Gadget talks to the Linux-USB generic serial driver.
516           This driver supports a CDC-ACM module option, which can be used
517           to interoperate with MS-Windows hosts or with the Linux-USB
518           "cdc-acm" driver.
519
520           Say "y" to link the driver statically, or "m" to build a
521           dynamically linked module called "g_serial".
522
523           For more information, see Documentation/usb/gadget_serial.txt
524           which includes instructions and a "driver info file" needed to
525           make MS-Windows work with this driver.
526
527 config USB_MIDI_GADGET
528         tristate "MIDI Gadget (EXPERIMENTAL)"
529         depends on SND && EXPERIMENTAL
530         select SND_RAWMIDI
531         help
532           The MIDI Gadget acts as a USB Audio device, with one MIDI
533           input and one MIDI output. These MIDI jacks appear as
534           a sound "card" in the ALSA sound system. Other MIDI
535           connections can then be made on the gadget system, using
536           ALSA's aconnect utility etc.
537
538           Say "y" to link the driver statically, or "m" to build a
539           dynamically linked module called "g_midi".
540
541
542 # put drivers that need isochronous transfer support (for audio
543 # or video class gadget drivers), or specific hardware, here.
544
545 # - none yet
546
547 endchoice
548
549 endmenu