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