xref: /openbmc/linux/drivers/usb/gadget/Kconfig (revision 731ad81e)
11da177e4SLinus Torvalds#
21da177e4SLinus Torvalds# USB Gadget support on a system involves
31da177e4SLinus Torvalds#    (a) a peripheral controller, and
41da177e4SLinus Torvalds#    (b) the gadget driver using it.
51da177e4SLinus Torvalds#
61da177e4SLinus Torvalds# NOTE:  Gadget support ** DOES NOT ** depend on host-side CONFIG_USB !!
71da177e4SLinus Torvalds#
81da177e4SLinus Torvalds#  - Host systems (like PCs) need CONFIG_USB (with "A" jacks).
91da177e4SLinus Torvalds#  - Peripherals (like PDAs) need CONFIG_USB_GADGET (with "B" jacks).
10cab00891SMatt LaPlante#  - Some systems have both kinds of controllers.
111da177e4SLinus Torvalds#
121da177e4SLinus Torvalds# With help from a special transceiver and a "Mini-AB" jack, systems with
131da177e4SLinus Torvalds# both kinds of controller can also support "USB On-the-Go" (CONFIG_USB_OTG).
141da177e4SLinus Torvalds#
151da177e4SLinus Torvalds
16b75be4abSDenis Chengmenuconfig USB_GADGET
17b75be4abSDenis Cheng	tristate "USB Gadget Support"
181da177e4SLinus Torvalds	help
191da177e4SLinus Torvalds	   USB is a master/slave protocol, organized with one master
201da177e4SLinus Torvalds	   host (such as a PC) controlling up to 127 peripheral devices.
211da177e4SLinus Torvalds	   The USB hardware is asymmetric, which makes it easier to set up:
221da177e4SLinus Torvalds	   you can't connect a "to-the-host" connector to a peripheral.
231da177e4SLinus Torvalds
241da177e4SLinus Torvalds	   Linux can run in the host, or in the peripheral.  In both cases
251da177e4SLinus Torvalds	   you need a low level bus controller driver, and some software
261da177e4SLinus Torvalds	   talking to it.  Peripheral controllers are often discrete silicon,
271da177e4SLinus Torvalds	   or are integrated with the CPU in a microcontroller.  The more
28e113f29cSJules Villard	   familiar host side controllers have names like "EHCI", "OHCI",
291da177e4SLinus Torvalds	   or "UHCI", and are usually integrated into southbridges on PC
301da177e4SLinus Torvalds	   motherboards.
311da177e4SLinus Torvalds
321da177e4SLinus Torvalds	   Enable this configuration option if you want to run Linux inside
331da177e4SLinus Torvalds	   a USB peripheral device.  Configure one hardware driver for your
341da177e4SLinus Torvalds	   peripheral/device side bus controller, and a "gadget driver" for
351da177e4SLinus Torvalds	   your peripheral protocol.  (If you use modular gadget drivers,
361da177e4SLinus Torvalds	   you may configure more than one.)
371da177e4SLinus Torvalds
381da177e4SLinus Torvalds	   If in doubt, say "N" and don't enable these drivers; most people
391da177e4SLinus Torvalds	   don't have this kind of hardware (except maybe inside Linux PDAs).
401da177e4SLinus Torvalds
411da177e4SLinus Torvalds	   For more information, see <http://www.linux-usb.org/gadget> and
421da177e4SLinus Torvalds	   the kernel DocBook documentation for this API.
431da177e4SLinus Torvalds
44b75be4abSDenis Chengif USB_GADGET
45b75be4abSDenis Cheng
4670790f63SDavid Brownellconfig USB_GADGET_DEBUG
47afd0e0f2SRobert P. J. Day	boolean "Debugging messages (DEVELOPMENT)"
4836e893d2SDavid Brownell	depends on DEBUG_KERNEL
4970790f63SDavid Brownell	help
5070790f63SDavid Brownell	   Many controller and gadget drivers will print some debugging
5170790f63SDavid Brownell	   messages if you use this option to ask for those messages.
5270790f63SDavid Brownell
5370790f63SDavid Brownell	   Avoid enabling these messages, even if you're actively
5470790f63SDavid Brownell	   debugging such a driver.  Many drivers will emit so many
5570790f63SDavid Brownell	   messages that the driver timings are affected, which will
5670790f63SDavid Brownell	   either create new failure modes or remove the one you're
5770790f63SDavid Brownell	   trying to track down.  Never enable these messages for a
5870790f63SDavid Brownell	   production build.
5970790f63SDavid Brownell
601da177e4SLinus Torvaldsconfig USB_GADGET_DEBUG_FILES
61afd0e0f2SRobert P. J. Day	boolean "Debugging information files (DEVELOPMENT)"
6236e893d2SDavid Brownell	depends on PROC_FS
631da177e4SLinus Torvalds	help
641da177e4SLinus Torvalds	   Some of the drivers in the "gadget" framework can expose
651da177e4SLinus Torvalds	   debugging information in files such as /proc/driver/udc
661da177e4SLinus Torvalds	   (for a peripheral controller).  The information in these
671da177e4SLinus Torvalds	   files may help when you're troubleshooting or bringing up a
681da177e4SLinus Torvalds	   driver on a new board.   Enable these files by choosing "Y"
691da177e4SLinus Torvalds	   here.  If in doubt, or to conserve kernel memory, say "N".
701da177e4SLinus Torvalds
71914a3f3bSHaavard Skinnemoenconfig USB_GADGET_DEBUG_FS
72afd0e0f2SRobert P. J. Day	boolean "Debugging information files in debugfs (DEVELOPMENT)"
7336e893d2SDavid Brownell	depends on DEBUG_FS
74914a3f3bSHaavard Skinnemoen	help
75914a3f3bSHaavard Skinnemoen	   Some of the drivers in the "gadget" framework can expose
76914a3f3bSHaavard Skinnemoen	   debugging information in files under /sys/kernel/debug/.
77914a3f3bSHaavard Skinnemoen	   The information in these files may help when you're
78914a3f3bSHaavard Skinnemoen	   troubleshooting or bringing up a driver on a new board.
79914a3f3bSHaavard Skinnemoen	   Enable these files by choosing "Y" here.  If in doubt, or
80914a3f3bSHaavard Skinnemoen	   to conserve kernel memory, say "N".
81914a3f3bSHaavard Skinnemoen
8236e893d2SDavid Brownellconfig USB_GADGET_VBUS_DRAW
8336e893d2SDavid Brownell	int "Maximum VBUS Power usage (2-500 mA)"
8436e893d2SDavid Brownell	range 2 500
8536e893d2SDavid Brownell	default 2
8636e893d2SDavid Brownell	help
8736e893d2SDavid Brownell	   Some devices need to draw power from USB when they are
8836e893d2SDavid Brownell	   configured, perhaps to operate circuitry or to recharge
8936e893d2SDavid Brownell	   batteries.  This is in addition to any local power supply,
9036e893d2SDavid Brownell	   such as an AC adapter or batteries.
9136e893d2SDavid Brownell
9236e893d2SDavid Brownell	   Enter the maximum power your device draws through USB, in
9336e893d2SDavid Brownell	   milliAmperes.  The permitted range of values is 2 - 500 mA;
9436e893d2SDavid Brownell	   0 mA would be legal, but can make some hosts misbehave.
9536e893d2SDavid Brownell
9636e893d2SDavid Brownell	   This value will be used except for system-specific gadget
9736e893d2SDavid Brownell	   drivers that have more specific information.
9836e893d2SDavid Brownell
996532c7fdSPer Forlinconfig USB_GADGET_STORAGE_NUM_BUFFERS
1006532c7fdSPer Forlin	int "Number of storage pipeline buffers"
1016532c7fdSPer Forlin	range 2 4
1026532c7fdSPer Forlin	default 2
1036532c7fdSPer Forlin	help
1046532c7fdSPer Forlin	   Usually 2 buffers are enough to establish a good buffering
1056532c7fdSPer Forlin	   pipeline. The number may be increased in order to compensate
1066532c7fdSPer Forlin	   for a bursty VFS behaviour. For instance there may be CPU wake up
1076532c7fdSPer Forlin	   latencies that makes the VFS to appear bursty in a system with
1086532c7fdSPer Forlin	   an CPU on-demand governor. Especially if DMA is doing IO to
1096532c7fdSPer Forlin	   offload the CPU. In this case the CPU will go into power
1106532c7fdSPer Forlin	   save often and spin up occasionally to move data within VFS.
1116532c7fdSPer Forlin	   If selecting USB_GADGET_DEBUG_FILES this value may be set by
1126532c7fdSPer Forlin	   a module parameter as well.
1136532c7fdSPer Forlin	   If unsure, say 2.
1146532c7fdSPer Forlin
1151da177e4SLinus Torvalds#
1161da177e4SLinus Torvalds# USB Peripheral Controller Support
1171da177e4SLinus Torvalds#
118a7a19facSDavid Brownell# The order here is alphabetical, except that integrated controllers go
119a7a19facSDavid Brownell# before discrete ones so they will be the initial/default value:
120a7a19facSDavid Brownell#   - integrated/SOC controllers first
121a7a19facSDavid Brownell#   - licensed IP used in both SOC and discrete versions
122a7a19facSDavid Brownell#   - discrete ones (including all PCI-only controllers)
123a7a19facSDavid Brownell#   - debug/dummy gadget+hcd is last.
124a7a19facSDavid Brownell#
1251da177e4SLinus Torvaldschoice
1261da177e4SLinus Torvalds	prompt "USB Peripheral Controller"
1271da177e4SLinus Torvalds	depends on USB_GADGET
1281da177e4SLinus Torvalds	help
1291da177e4SLinus Torvalds	   A USB device uses a controller to talk to its host.
1301da177e4SLinus Torvalds	   Systems should have only one such upstream link.
1311da177e4SLinus Torvalds	   Many controller drivers are platform-specific; these
1321da177e4SLinus Torvalds	   often need board-specific hooks.
1331da177e4SLinus Torvalds
134a7a19facSDavid Brownell#
135a7a19facSDavid Brownell# Integrated controllers
136a7a19facSDavid Brownell#
137a7a19facSDavid Brownell
138193ab2a6SFelipe Balbiconfig USB_AT91
139193ab2a6SFelipe Balbi	tristate "Atmel AT91 USB Device Port"
140aa781af0SNicolas Ferre	depends on ARCH_AT91 && !ARCH_AT91SAM9RL && !ARCH_AT91CAP9 && !ARCH_AT91SAM9G45
14155d402d8SThomas Dahlmann	help
142a7a19facSDavid Brownell	   Many Atmel AT91 processors (such as the AT91RM2000) have a
143a7a19facSDavid Brownell	   full speed USB Device Port with support for five configurable
144a7a19facSDavid Brownell	   endpoints (plus endpoint zero).
14555d402d8SThomas Dahlmann
14655d402d8SThomas Dahlmann	   Say "y" to link the driver statically, or "m" to build a
147a7a19facSDavid Brownell	   dynamically linked module called "at91_udc" and force all
14855d402d8SThomas Dahlmann	   gadget drivers to also be dynamically linked.
14955d402d8SThomas Dahlmann
150193ab2a6SFelipe Balbiconfig USB_ATMEL_USBA
151193ab2a6SFelipe Balbi	tristate "Atmel USBA"
152914a3f3bSHaavard Skinnemoen	select USB_GADGET_DUALSPEED
153aa781af0SNicolas Ferre	depends on AVR32 || ARCH_AT91CAP9 || ARCH_AT91SAM9RL || ARCH_AT91SAM9G45
154914a3f3bSHaavard Skinnemoen	help
155914a3f3bSHaavard Skinnemoen	  USBA is the integrated high-speed USB Device controller on
156ba45ca43SNicolas Ferre	  the AT32AP700x, some AT91SAM9 and AT91CAP9 processors from Atmel.
157914a3f3bSHaavard Skinnemoen
158193ab2a6SFelipe Balbiconfig USB_FSL_USB2
159193ab2a6SFelipe Balbi	tristate "Freescale Highspeed USB DR Peripheral Controller"
16054e4026bSGuennadi Liakhovetski	depends on FSL_SOC || ARCH_MXC
161b504882dSLi Yang	select USB_GADGET_DUALSPEED
162018b97d0SMarc Kleine-Budde	select USB_FSL_MPH_DR_OF if OF
163b504882dSLi Yang	help
164b504882dSLi Yang	   Some of Freescale PowerPC processors have a High Speed
165b504882dSLi Yang	   Dual-Role(DR) USB controller, which supports device mode.
166b504882dSLi Yang
167b504882dSLi Yang	   The number of programmable endpoints is different through
168b504882dSLi Yang	   SOC revisions.
169b504882dSLi Yang
170b504882dSLi Yang	   Say "y" to link the driver statically, or "m" to build a
171b504882dSLi Yang	   dynamically linked module called "fsl_usb2_udc" and force
172b504882dSLi Yang	   all gadget drivers to also be dynamically linked.
173b504882dSLi Yang
174193ab2a6SFelipe Balbiconfig USB_FUSB300
175193ab2a6SFelipe Balbi	tristate "Faraday FUSB300 USB Peripheral Controller"
176ac17317dSSebastian Andrzej Siewior	depends on !PHYS_ADDR_T_64BIT
1770fe6f1d1SYuan-Hsin Chen	select USB_GADGET_DUALSPEED
1780fe6f1d1SYuan-Hsin Chen	help
1790fe6f1d1SYuan-Hsin Chen	   Faraday usb device controller FUSB300 driver
1800fe6f1d1SYuan-Hsin Chen
181193ab2a6SFelipe Balbiconfig USB_OMAP
182193ab2a6SFelipe Balbi	tristate "OMAP USB Device Controller"
1831da177e4SLinus Torvalds	depends on ARCH_OMAP
184f1c9e151STony Lindgren	select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3 || MACH_OMAP_H4_OTG
18554b9ed35SDavid Brownell	select USB_OTG_UTILS if ARCH_OMAP
1861da177e4SLinus Torvalds	help
1871da177e4SLinus Torvalds	   Many Texas Instruments OMAP processors have flexible full
1881da177e4SLinus Torvalds	   speed USB device controllers, with support for up to 30
1891da177e4SLinus Torvalds	   endpoints (plus endpoint zero).  This driver supports the
1901da177e4SLinus Torvalds	   controller in the OMAP 1611, and should work with controllers
1911da177e4SLinus Torvalds	   in other OMAP processors too, given minor tweaks.
1921da177e4SLinus Torvalds
1931da177e4SLinus Torvalds	   Say "y" to link the driver statically, or "m" to build a
1941da177e4SLinus Torvalds	   dynamically linked module called "omap_udc" and force all
1951da177e4SLinus Torvalds	   gadget drivers to also be dynamically linked.
1961da177e4SLinus Torvalds
197193ab2a6SFelipe Balbiconfig USB_PXA25X
198193ab2a6SFelipe Balbi	tristate "PXA 25x or IXP 4xx"
199a7a19facSDavid Brownell	depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX
20009963911SRussell King	select USB_OTG_UTILS
201a7a19facSDavid Brownell	help
202a7a19facSDavid Brownell	   Intel's PXA 25x series XScale ARM-5TE processors include
203a7a19facSDavid Brownell	   an integrated full speed USB 1.1 device controller.  The
204a7a19facSDavid Brownell	   controller in the IXP 4xx series is register-compatible.
205a7a19facSDavid Brownell
206a7a19facSDavid Brownell	   It has fifteen fixed-function endpoints, as well as endpoint
207a7a19facSDavid Brownell	   zero (for control transfers).
208a7a19facSDavid Brownell
209a7a19facSDavid Brownell	   Say "y" to link the driver statically, or "m" to build a
210a7a19facSDavid Brownell	   dynamically linked module called "pxa25x_udc" and force all
211a7a19facSDavid Brownell	   gadget drivers to also be dynamically linked.
212a7a19facSDavid Brownell
213a7a19facSDavid Brownell# if there's only one gadget driver, using only two bulk endpoints,
214a7a19facSDavid Brownell# don't waste memory for the other endpoints
215a7a19facSDavid Brownellconfig USB_PXA25X_SMALL
216193ab2a6SFelipe Balbi	depends on USB_PXA25X
217a7a19facSDavid Brownell	bool
218a7a19facSDavid Brownell	default n if USB_ETH_RNDIS
219a7a19facSDavid Brownell	default y if USB_ZERO
220a7a19facSDavid Brownell	default y if USB_ETH
221a7a19facSDavid Brownell	default y if USB_G_SERIAL
222a7a19facSDavid Brownell
223193ab2a6SFelipe Balbiconfig USB_R8A66597
224193ab2a6SFelipe Balbi	tristate "Renesas R8A66597 USB Peripheral Controller"
225c4144247SYoshihiro Shimoda	select USB_GADGET_DUALSPEED
226c4144247SYoshihiro Shimoda	help
227c4144247SYoshihiro Shimoda	   R8A66597 is a discrete USB host and peripheral controller chip that
228c4144247SYoshihiro Shimoda	   supports both full and high speed USB 2.0 data transfers.
229c4144247SYoshihiro Shimoda	   It has nine configurable endpoints, and endpoint zero.
230c4144247SYoshihiro Shimoda
231c4144247SYoshihiro Shimoda	   Say "y" to link the driver statically, or "m" to build a
232c4144247SYoshihiro Shimoda	   dynamically linked module called "r8a66597_udc" and force all
233c4144247SYoshihiro Shimoda	   gadget drivers to also be dynamically linked.
234c4144247SYoshihiro Shimoda
235030ed1fcSKuninori Morimotoconfig USB_RENESAS_USBHS_UDC
236193ab2a6SFelipe Balbi	tristate 'Renesas USBHS controller'
237193ab2a6SFelipe Balbi	depends on SUPERH || ARCH_SHMOBILE
238030ed1fcSKuninori Morimoto	depends on USB_RENESAS_USBHS
239030ed1fcSKuninori Morimoto	select USB_GADGET_DUALSPEED
2402f98382dSKuninori Morimoto	help
241193ab2a6SFelipe Balbi	   Renesas USBHS is a discrete USB host and peripheral controller chip
242193ab2a6SFelipe Balbi	   that supports both full and high speed USB 2.0 data transfers.
243193ab2a6SFelipe Balbi	   It has nine or more configurable endpoints, and endpoint zero.
2442f98382dSKuninori Morimoto
245193ab2a6SFelipe Balbi	   Say "y" to link the driver statically, or "m" to build a
246193ab2a6SFelipe Balbi	   dynamically linked module called "renesas_usbhs" and force all
247193ab2a6SFelipe Balbi	   gadget drivers to also be dynamically linked.
2482f98382dSKuninori Morimoto
249193ab2a6SFelipe Balbiconfig USB_PXA27X
250193ab2a6SFelipe Balbi	tristate "PXA 27x"
2519f5351b7SRobert Jarzmik	depends on ARCH_PXA && (PXA27x || PXA3xx)
2527fec3c25SRobert Jarzmik	select USB_OTG_UTILS
253a7a19facSDavid Brownell	help
254a7a19facSDavid Brownell	   Intel's PXA 27x series XScale ARM v5TE processors include
255a7a19facSDavid Brownell	   an integrated full speed USB 1.1 device controller.
256a7a19facSDavid Brownell
257a7a19facSDavid Brownell	   It has up to 23 endpoints, as well as endpoint zero (for
258a7a19facSDavid Brownell	   control transfers).
259a7a19facSDavid Brownell
260a7a19facSDavid Brownell	   Say "y" to link the driver statically, or "m" to build a
261a7a19facSDavid Brownell	   dynamically linked module called "pxa27x_udc" and force all
262a7a19facSDavid Brownell	   gadget drivers to also be dynamically linked.
263a7a19facSDavid Brownell
264193ab2a6SFelipe Balbiconfig USB_S3C_HSOTG
265193ab2a6SFelipe Balbi	tristate "S3C HS/OtG USB Device controller"
2665b7d70c6SBen Dooks	depends on S3C_DEV_USB_HSOTG
2675b7d70c6SBen Dooks	select USB_GADGET_S3C_HSOTG_PIO
2680287e43dSMaurus Cuelenaere	select USB_GADGET_DUALSPEED
2695b7d70c6SBen Dooks	help
2705b7d70c6SBen Dooks	  The Samsung S3C64XX USB2.0 high-speed gadget controller
2715b7d70c6SBen Dooks	  integrated into the S3C64XX series SoC.
2725b7d70c6SBen Dooks
273193ab2a6SFelipe Balbiconfig USB_IMX
2742e5a08a3SSascha Hauer	tristate "Freescale i.MX1 USB Peripheral Controller"
2752e5a08a3SSascha Hauer	depends on ARCH_MXC
276c03e7d4bSPaulius Zaleckas	help
2772e5a08a3SSascha Hauer	   Freescale's i.MX1 includes an integrated full speed
2782e5a08a3SSascha Hauer	   USB 1.1 device controller.
279c03e7d4bSPaulius Zaleckas
280c03e7d4bSPaulius Zaleckas	   It has Six fixed-function endpoints, as well as endpoint
281c03e7d4bSPaulius Zaleckas	   zero (for control transfers).
282c03e7d4bSPaulius Zaleckas
283c03e7d4bSPaulius Zaleckas	   Say "y" to link the driver statically, or "m" to build a
284c03e7d4bSPaulius Zaleckas	   dynamically linked module called "imx_udc" and force all
285c03e7d4bSPaulius Zaleckas	   gadget drivers to also be dynamically linked.
286c03e7d4bSPaulius Zaleckas
287193ab2a6SFelipe Balbiconfig USB_S3C2410
288193ab2a6SFelipe Balbi	tristate "S3C2410 USB Device Controller"
2893fc154b6SArnaud Patard	depends on ARCH_S3C2410
2903fc154b6SArnaud Patard	help
2913fc154b6SArnaud Patard	  Samsung's S3C2410 is an ARM-4 processor with an integrated
2923fc154b6SArnaud Patard	  full speed USB 1.1 device controller.  It has 4 configurable
2933fc154b6SArnaud Patard	  endpoints, as well as endpoint zero (for control transfers).
2943fc154b6SArnaud Patard
2953fc154b6SArnaud Patard	  This driver has been tested on the S3C2410, S3C2412, and
2963fc154b6SArnaud Patard	  S3C2440 processors.
2973fc154b6SArnaud Patard
2983fc154b6SArnaud Patardconfig USB_S3C2410_DEBUG
2993fc154b6SArnaud Patard	boolean "S3C2410 udc debug messages"
300193ab2a6SFelipe Balbi	depends on USB_S3C2410
3013fc154b6SArnaud Patard
302193ab2a6SFelipe Balbiconfig USB_S3C_HSUDC
303193ab2a6SFelipe Balbi	tristate "S3C2416, S3C2443 and S3C2450 USB Device Controller"
304a9df304cSThomas Abraham	depends on ARCH_S3C2410
305a9df304cSThomas Abraham	select USB_GADGET_DUALSPEED
306a9df304cSThomas Abraham	help
307a9df304cSThomas Abraham	  Samsung's S3C2416, S3C2443 and S3C2450 is an ARM9 based SoC
308a9df304cSThomas Abraham	  integrated with dual speed USB 2.0 device controller. It has
309a9df304cSThomas Abraham	  8 endpoints, as well as endpoint zero.
310a9df304cSThomas Abraham
311a9df304cSThomas Abraham	  This driver has been tested on S3C2416 and S3C2450 processors.
312a9df304cSThomas Abraham
313193ab2a6SFelipe Balbiconfig USB_PXA_U2O
314193ab2a6SFelipe Balbi	tristate "PXA9xx Processor USB2.0 controller"
315193ab2a6SFelipe Balbi	depends on ARCH_MMP
316e7cddda4Scxie4	select USB_GADGET_DUALSPEED
317e7cddda4Scxie4	help
318e7cddda4Scxie4	  PXA9xx Processor series include a high speed USB2.0 device
319e7cddda4Scxie4	  controller, which support high speed and full speed USB peripheral.
320e7cddda4Scxie4
32172246da4SFelipe Balbiconfig USB_GADGET_DWC3
32272246da4SFelipe Balbi	tristate "DesignWare USB3.0 (DRD) Controller"
32372246da4SFelipe Balbi	depends on USB_DWC3
32472246da4SFelipe Balbi	select USB_GADGET_DUALSPEED
32572246da4SFelipe Balbi	select USB_GADGET_SUPERSPEED
32672246da4SFelipe Balbi	help
32772246da4SFelipe Balbi	  DesignWare USB3.0 controller is a SuperSpeed USB3.0 Controller
32872246da4SFelipe Balbi	  which can be configured for peripheral-only, host-only, hub-only
32972246da4SFelipe Balbi	  and Dual-Role operation. This Controller was first integrated into
33072246da4SFelipe Balbi	  the OMAP5 series of processors. More information about the OMAP5
33172246da4SFelipe Balbi	  version of this controller, refer to http://www.ti.com/omap5.
33272246da4SFelipe Balbi
333a7a19facSDavid Brownell#
334a7a19facSDavid Brownell# Controllers available in both integrated and discrete versions
335a7a19facSDavid Brownell#
336a7a19facSDavid Brownell
337a7a19facSDavid Brownell# musb builds in ../musb along with host support
338a7a19facSDavid Brownellconfig USB_GADGET_MUSB_HDRC
339193ab2a6SFelipe Balbi	tristate "Inventra HDRC USB Peripheral (TI, ADI, ...)"
340b61ae342SRabin Vincent	depends on USB_MUSB_HDRC
341a7a19facSDavid Brownell	select USB_GADGET_DUALSPEED
342bae4bd84SDavid Brownell	help
343a7a19facSDavid Brownell	  This OTG-capable silicon IP is used in dual designs including
344085ad406SBryan Wu	  the TI DaVinci, OMAP 243x, OMAP 343x, TUSB 6010, and ADI Blackfin
345a7a19facSDavid Brownell
346193ab2a6SFelipe Balbiconfig USB_M66592
347193ab2a6SFelipe Balbi	tristate "Renesas M66592 USB Peripheral Controller"
348a7a19facSDavid Brownell	select USB_GADGET_DUALSPEED
349a7a19facSDavid Brownell	help
350a7a19facSDavid Brownell	   M66592 is a discrete USB peripheral controller chip that
351a7a19facSDavid Brownell	   supports both full and high speed USB 2.0 data transfers.
352a7a19facSDavid Brownell	   It has seven configurable endpoints, and endpoint zero.
353bae4bd84SDavid Brownell
354bae4bd84SDavid Brownell	   Say "y" to link the driver statically, or "m" to build a
355a7a19facSDavid Brownell	   dynamically linked module called "m66592_udc" and force all
356bae4bd84SDavid Brownell	   gadget drivers to also be dynamically linked.
357bae4bd84SDavid Brownell
358a7a19facSDavid Brownell#
359a7a19facSDavid Brownell# Controllers available only in discrete form (and all PCI controllers)
360a7a19facSDavid Brownell#
361a7a19facSDavid Brownell
362193ab2a6SFelipe Balbiconfig USB_AMD5536UDC
363193ab2a6SFelipe Balbi	tristate "AMD5536 UDC"
364a7a19facSDavid Brownell	depends on PCI
365a7a19facSDavid Brownell	select USB_GADGET_DUALSPEED
366a7a19facSDavid Brownell	help
367a7a19facSDavid Brownell	   The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
368a7a19facSDavid Brownell	   It is a USB Highspeed DMA capable USB device controller. Beside ep0
369a7a19facSDavid Brownell	   it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
370a7a19facSDavid Brownell	   The UDC port supports OTG operation, and may be used as a host port
371a7a19facSDavid Brownell	   if it's not being used to implement peripheral or OTG roles.
372a7a19facSDavid Brownell
373a7a19facSDavid Brownell	   Say "y" to link the driver statically, or "m" to build a
374a7a19facSDavid Brownell	   dynamically linked module called "amd5536udc" and force all
375a7a19facSDavid Brownell	   gadget drivers to also be dynamically linked.
376a7a19facSDavid Brownell
377193ab2a6SFelipe Balbiconfig USB_FSL_QE
378193ab2a6SFelipe Balbi	tristate "Freescale QE/CPM USB Device Controller"
3793948f0e0SLi Yang	depends on FSL_SOC && (QUICC_ENGINE || CPM)
3803948f0e0SLi Yang	help
3813948f0e0SLi Yang	   Some of Freescale PowerPC processors have a Full Speed
3823948f0e0SLi Yang	   QE/CPM2 USB controller, which support device mode with 4
3833948f0e0SLi Yang	   programmable endpoints. This driver supports the
3843948f0e0SLi Yang	   controller in the MPC8360 and MPC8272, and should work with
3853948f0e0SLi Yang	   controllers having QE or CPM2, given minor tweaks.
3863948f0e0SLi Yang
3873948f0e0SLi Yang	   Set CONFIG_USB_GADGET to "m" to build this driver as a
388692105b8SMatt LaPlante	   dynamically linked module called "fsl_qe_udc".
3893948f0e0SLi Yang
390193ab2a6SFelipe Balbiconfig USB_CI13XXX_PCI
391193ab2a6SFelipe Balbi	tristate "MIPS USB CI13xxx PCI UDC"
392aa69a809SDavid Lopo	depends on PCI
393aa69a809SDavid Lopo	select USB_GADGET_DUALSPEED
394aa69a809SDavid Lopo	help
395aa69a809SDavid Lopo	  MIPS USB IP core family device controller
396aa69a809SDavid Lopo	  Currently it only supports IP part number CI13412
397aa69a809SDavid Lopo
398aa69a809SDavid Lopo	  Say "y" to link the driver statically, or "m" to build a
399aa69a809SDavid Lopo	  dynamically linked module called "ci13xxx_udc" and force all
400aa69a809SDavid Lopo	  gadget drivers to also be dynamically linked.
401aa69a809SDavid Lopo
402193ab2a6SFelipe Balbiconfig USB_NET2272
403193ab2a6SFelipe Balbi	tristate "PLX NET2272"
404ceb80363SSeth Levy	select USB_GADGET_DUALSPEED
405ceb80363SSeth Levy	help
406ceb80363SSeth Levy	  PLX NET2272 is a USB peripheral controller which supports
407ceb80363SSeth Levy	  both full and high speed USB 2.0 data transfers.
408ceb80363SSeth Levy
409ceb80363SSeth Levy	  It has three configurable endpoints, as well as endpoint zero
410ceb80363SSeth Levy	  (for control transfer).
411ceb80363SSeth Levy	  Say "y" to link the driver statically, or "m" to build a
412ceb80363SSeth Levy	  dynamically linked module called "net2272" and force all
413ceb80363SSeth Levy	  gadget drivers to also be dynamically linked.
414ceb80363SSeth Levy
415193ab2a6SFelipe Balbiconfig USB_NET2272_DMA
416ceb80363SSeth Levy	boolean "Support external DMA controller"
417193ab2a6SFelipe Balbi	depends on USB_NET2272
418ceb80363SSeth Levy	help
419ceb80363SSeth Levy	  The NET2272 part can optionally support an external DMA
420ceb80363SSeth Levy	  controller, but your board has to have support in the
421ceb80363SSeth Levy	  driver itself.
422ceb80363SSeth Levy
423ceb80363SSeth Levy	  If unsure, say "N" here.  The driver works fine in PIO mode.
424ceb80363SSeth Levy
425193ab2a6SFelipe Balbiconfig USB_NET2280
426193ab2a6SFelipe Balbi	tristate "NetChip 228x"
427a7a19facSDavid Brownell	depends on PCI
428a7a19facSDavid Brownell	select USB_GADGET_DUALSPEED
429a7a19facSDavid Brownell	help
430a7a19facSDavid Brownell	   NetChip 2280 / 2282 is a PCI based USB peripheral controller which
431a7a19facSDavid Brownell	   supports both full and high speed USB 2.0 data transfers.
432a7a19facSDavid Brownell
433a7a19facSDavid Brownell	   It has six configurable endpoints, as well as endpoint zero
434a7a19facSDavid Brownell	   (for control transfers) and several endpoints with dedicated
435a7a19facSDavid Brownell	   functions.
436a7a19facSDavid Brownell
437a7a19facSDavid Brownell	   Say "y" to link the driver statically, or "m" to build a
438a7a19facSDavid Brownell	   dynamically linked module called "net2280" and force all
439a7a19facSDavid Brownell	   gadget drivers to also be dynamically linked.
440a7a19facSDavid Brownell
441193ab2a6SFelipe Balbiconfig USB_GOKU
442193ab2a6SFelipe Balbi	tristate "Toshiba TC86C001 'Goku-S'"
443a7a19facSDavid Brownell	depends on PCI
444a7a19facSDavid Brownell	help
445a7a19facSDavid Brownell	   The Toshiba TC86C001 is a PCI device which includes controllers
446a7a19facSDavid Brownell	   for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
447a7a19facSDavid Brownell
448a7a19facSDavid Brownell	   The device controller has three configurable (bulk or interrupt)
449a7a19facSDavid Brownell	   endpoints, plus endpoint zero (for control transfers).
450a7a19facSDavid Brownell
451a7a19facSDavid Brownell	   Say "y" to link the driver statically, or "m" to build a
452a7a19facSDavid Brownell	   dynamically linked module called "goku_udc" and to force all
453a7a19facSDavid Brownell	   gadget drivers to also be dynamically linked.
454a7a19facSDavid Brownell
455193ab2a6SFelipe Balbiconfig USB_LANGWELL
456193ab2a6SFelipe Balbi	tristate "Intel Langwell USB Device Controller"
4575be19a9dSXiaochen Shen	depends on PCI
458ac17317dSSebastian Andrzej Siewior	depends on !PHYS_ADDR_T_64BIT
4595be19a9dSXiaochen Shen	select USB_GADGET_DUALSPEED
4605be19a9dSXiaochen Shen	help
4615be19a9dSXiaochen Shen	   Intel Langwell USB Device Controller is a High-Speed USB
4625be19a9dSXiaochen Shen	   On-The-Go device controller.
4635be19a9dSXiaochen Shen
4645be19a9dSXiaochen Shen	   The number of programmable endpoints is different through
4655be19a9dSXiaochen Shen	   controller revision.
4665be19a9dSXiaochen Shen
4675be19a9dSXiaochen Shen	   Say "y" to link the driver statically, or "m" to build a
4685be19a9dSXiaochen Shen	   dynamically linked module called "langwell_udc" and force all
4695be19a9dSXiaochen Shen	   gadget drivers to also be dynamically linked.
4705be19a9dSXiaochen Shen
471193ab2a6SFelipe Balbiconfig USB_EG20T
472731ad81eSTomoya MORINAGA	tristate "Intel EG20T PCH/LAPIS Semiconductor IOH(ML7213/ML7831) UDC"
473f646cf94SToshiharu Okada	depends on PCI
474f646cf94SToshiharu Okada	select USB_GADGET_DUALSPEED
475f646cf94SToshiharu Okada	help
476f646cf94SToshiharu Okada	  This is a USB device driver for EG20T PCH.
477f646cf94SToshiharu Okada	  EG20T PCH is the platform controller hub that is used in Intel's
478f646cf94SToshiharu Okada	  general embedded platform. EG20T PCH has USB device interface.
479f646cf94SToshiharu Okada	  Using this interface, it is able to access system devices connected
480f646cf94SToshiharu Okada	  to USB device.
481f646cf94SToshiharu Okada	  This driver enables USB device function.
482f646cf94SToshiharu Okada	  USB device is a USB peripheral controller which
483f646cf94SToshiharu Okada	  supports both full and high speed USB 2.0 data transfers.
484f646cf94SToshiharu Okada	  This driver supports both control transfer and bulk transfer modes.
485f646cf94SToshiharu Okada	  This driver dose not support interrupt transfer or isochronous
486f646cf94SToshiharu Okada	  transfer modes.
487f646cf94SToshiharu Okada
488731ad81eSTomoya MORINAGA	  This driver also can be used for LAPIS Semiconductor's ML7213 which is
48906f1b971STomoya MORINAGA	  for IVI(In-Vehicle Infotainment) use.
490731ad81eSTomoya MORINAGA	  ML7831 is for general purpose use.
491731ad81eSTomoya MORINAGA	  ML7213/ML7831 is companion chip for Intel Atom E6xx series.
492731ad81eSTomoya MORINAGA	  ML7213/ML7831 is completely compatible for Intel EG20T PCH.
49306f1b971STomoya MORINAGA
494193ab2a6SFelipe Balbiconfig USB_CI13XXX_MSM
495193ab2a6SFelipe Balbi	tristate "MIPS USB CI13xxx for MSM"
49633f82f38SPavankumar Kondeti	depends on ARCH_MSM
49733f82f38SPavankumar Kondeti	select USB_GADGET_DUALSPEED
498dfb2130cSPavankumar Kondeti	select USB_MSM_OTG
49933f82f38SPavankumar Kondeti	help
50033f82f38SPavankumar Kondeti	  MSM SoC has chipidea USB controller.  This driver uses
50133f82f38SPavankumar Kondeti	  ci13xxx_udc core.
50233f82f38SPavankumar Kondeti	  This driver depends on OTG driver for PHY initialization,
50333f82f38SPavankumar Kondeti	  clock management, powering up VBUS, and power management.
5048cf28f1fSPavankumar Kondeti	  This driver is not supported on boards like trout which
5058cf28f1fSPavankumar Kondeti	  has an external PHY.
50633f82f38SPavankumar Kondeti
50733f82f38SPavankumar Kondeti	  Say "y" to link the driver statically, or "m" to build a
50833f82f38SPavankumar Kondeti	  dynamically linked module called "ci13xxx_msm" and force all
50933f82f38SPavankumar Kondeti	  gadget drivers to also be dynamically linked.
51033f82f38SPavankumar Kondeti
511a7a19facSDavid Brownell#
512a7a19facSDavid Brownell# LAST -- dummy/emulated controller
513a7a19facSDavid Brownell#
5141da177e4SLinus Torvalds
515193ab2a6SFelipe Balbiconfig USB_DUMMY_HCD
516193ab2a6SFelipe Balbi	tristate "Dummy HCD (DEVELOPMENT)"
517afd0e0f2SRobert P. J. Day	depends on USB=y || (USB=m && USB_GADGET=m)
5181da177e4SLinus Torvalds	select USB_GADGET_DUALSPEED
5191cd8fd28STatyana Brokhman	select USB_GADGET_SUPERSPEED
5201da177e4SLinus Torvalds	help
5211da177e4SLinus Torvalds	  This host controller driver emulates USB, looping all data transfer
5221da177e4SLinus Torvalds	  requests back to a USB "gadget driver" in the same host.  The host
5231da177e4SLinus Torvalds	  side is the master; the gadget side is the slave.  Gadget drivers
5241da177e4SLinus Torvalds	  can be high, full, or low speed; and they have access to endpoints
5251da177e4SLinus Torvalds	  like those from NET2280, PXA2xx, or SA1100 hardware.
5261da177e4SLinus Torvalds
5271da177e4SLinus Torvalds	  This may help in some stages of creating a driver to embed in a
5281da177e4SLinus Torvalds	  Linux device, since it lets you debug several parts of the gadget
5291da177e4SLinus Torvalds	  driver without its hardware or drivers being involved.
5301da177e4SLinus Torvalds
5311da177e4SLinus Torvalds	  Since such a gadget side driver needs to interoperate with a host
5321da177e4SLinus Torvalds	  side Linux-USB device driver, this may help to debug both sides
5331da177e4SLinus Torvalds	  of a USB protocol stack.
5341da177e4SLinus Torvalds
5351da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
5361da177e4SLinus Torvalds	  dynamically linked module called "dummy_hcd" and force all
5371da177e4SLinus Torvalds	  gadget drivers to also be dynamically linked.
5381da177e4SLinus Torvalds
5391da177e4SLinus Torvalds# NOTE:  Please keep dummy_hcd LAST so that "real hardware" appears
5401da177e4SLinus Torvalds# first and will be selected by default.
5411da177e4SLinus Torvalds
5421da177e4SLinus Torvaldsendchoice
5431da177e4SLinus Torvalds
54497b2f900SAlan Stern# Selected by UDC drivers that support high-speed operation.
5451da177e4SLinus Torvaldsconfig USB_GADGET_DUALSPEED
5461da177e4SLinus Torvalds	bool
5471da177e4SLinus Torvalds	depends on USB_GADGET
5481da177e4SLinus Torvalds
549bdb64d72STatyana Brokhman# Selected by UDC drivers that support super-speed opperation
550bdb64d72STatyana Brokhmanconfig USB_GADGET_SUPERSPEED
551bdb64d72STatyana Brokhman	bool
552bdb64d72STatyana Brokhman	depends on USB_GADGET
553bdb64d72STatyana Brokhman	depends on USB_GADGET_DUALSPEED
554bdb64d72STatyana Brokhman
5551da177e4SLinus Torvalds#
5561da177e4SLinus Torvalds# USB Gadget Drivers
5571da177e4SLinus Torvalds#
5581da177e4SLinus Torvaldschoice
5591da177e4SLinus Torvalds	tristate "USB Gadget Drivers"
560193ab2a6SFelipe Balbi	depends on USB_GADGET
5611da177e4SLinus Torvalds	default USB_ETH
5621da177e4SLinus Torvalds	help
5631da177e4SLinus Torvalds	  A Linux "Gadget Driver" talks to the USB Peripheral Controller
5641da177e4SLinus Torvalds	  driver through the abstract "gadget" API.  Some other operating
5651da177e4SLinus Torvalds	  systems call these "client" drivers, of which "class drivers"
5661da177e4SLinus Torvalds	  are a subset (implementing a USB device class specification).
5671da177e4SLinus Torvalds	  A gadget driver implements one or more USB functions using
5681da177e4SLinus Torvalds	  the peripheral hardware.
5691da177e4SLinus Torvalds
5701da177e4SLinus Torvalds	  Gadget drivers are hardware-neutral, or "platform independent",
5711da177e4SLinus Torvalds	  except that they sometimes must understand quirks or limitations
5721da177e4SLinus Torvalds	  of the particular controllers they work with.  For example, when
5731da177e4SLinus Torvalds	  a controller doesn't support alternate configurations or provide
5741da177e4SLinus Torvalds	  enough of the right types of endpoints, the gadget driver might
5751da177e4SLinus Torvalds	  not be able work with that controller, or might need to implement
5761da177e4SLinus Torvalds	  a less common variant of a device class protocol.
5771da177e4SLinus Torvalds
5781da177e4SLinus Torvalds# this first set of drivers all depend on bulk-capable hardware.
5791da177e4SLinus Torvalds
5801da177e4SLinus Torvaldsconfig USB_ZERO
5811da177e4SLinus Torvalds	tristate "Gadget Zero (DEVELOPMENT)"
5821da177e4SLinus Torvalds	help
5831da177e4SLinus Torvalds	  Gadget Zero is a two-configuration device.  It either sinks and
5841da177e4SLinus Torvalds	  sources bulk data; or it loops back a configurable number of
5851da177e4SLinus Torvalds	  transfers.  It also implements control requests, for "chapter 9"
5861da177e4SLinus Torvalds	  conformance.  The driver needs only two bulk-capable endpoints, so
5871da177e4SLinus Torvalds	  it can work on top of most device-side usb controllers.  It's
5881da177e4SLinus Torvalds	  useful for testing, and is also a working example showing how
5891da177e4SLinus Torvalds	  USB "gadget drivers" can be written.
5901da177e4SLinus Torvalds
5911da177e4SLinus Torvalds	  Make this be the first driver you try using on top of any new
5921da177e4SLinus Torvalds	  USB peripheral controller driver.  Then you can use host-side
5931da177e4SLinus Torvalds	  test software, like the "usbtest" driver, to put your hardware
5941da177e4SLinus Torvalds	  and its driver through a basic set of functional tests.
5951da177e4SLinus Torvalds
5961da177e4SLinus Torvalds	  Gadget Zero also works with the host-side "usb-skeleton" driver,
5971da177e4SLinus Torvalds	  and with many kinds of host-side test software.  You may need
5981da177e4SLinus Torvalds	  to tweak product and vendor IDs before host software knows about
5991da177e4SLinus Torvalds	  this device, and arrange to select an appropriate configuration.
6001da177e4SLinus Torvalds
6011da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
6021da177e4SLinus Torvalds	  dynamically linked module called "g_zero".
6031da177e4SLinus Torvalds
6041da177e4SLinus Torvaldsconfig USB_ZERO_HNPTEST
6051da177e4SLinus Torvalds	boolean "HNP Test Device"
6061da177e4SLinus Torvalds	depends on USB_ZERO && USB_OTG
6071da177e4SLinus Torvalds	help
6081da177e4SLinus Torvalds	  You can configure this device to enumerate using the device
6091da177e4SLinus Torvalds	  identifiers of the USB-OTG test device.  That means that when
6101da177e4SLinus Torvalds	  this gadget connects to another OTG device, with this one using
6111da177e4SLinus Torvalds	  the "B-Peripheral" role, that device will use HNP to let this
6121da177e4SLinus Torvalds	  one serve as the USB host instead (in the "B-Host" role).
6131da177e4SLinus Torvalds
614c6994e6fSBryan Wuconfig USB_AUDIO
615c6994e6fSBryan Wu	tristate "Audio Gadget (EXPERIMENTAL)"
616c6994e6fSBryan Wu	depends on SND
61704950737SRandy Dunlap	select SND_PCM
618c6994e6fSBryan Wu	help
619c6994e6fSBryan Wu	  Gadget Audio is compatible with USB Audio Class specification 1.0.
620c6994e6fSBryan Wu	  It will include at least one AudioControl interface, zero or more
621c6994e6fSBryan Wu	  AudioStream interface and zero or more MIDIStream interface.
622c6994e6fSBryan Wu
623c6994e6fSBryan Wu	  Gadget Audio will use on-board ALSA (CONFIG_SND) audio card to
624c6994e6fSBryan Wu	  playback or capture audio stream.
625c6994e6fSBryan Wu
626c6994e6fSBryan Wu	  Say "y" to link the driver statically, or "m" to build a
627c6994e6fSBryan Wu	  dynamically linked module called "g_audio".
628c6994e6fSBryan Wu
6291da177e4SLinus Torvaldsconfig USB_ETH
6301da177e4SLinus Torvalds	tristate "Ethernet Gadget (with CDC Ethernet support)"
6311da177e4SLinus Torvalds	depends on NET
6329e221be8SRandy Dunlap	select CRC32
6331da177e4SLinus Torvalds	help
6349b39e9ddSBrian Niebuhr	  This driver implements Ethernet style communication, in one of
6359b39e9ddSBrian Niebuhr	  several ways:
6361da177e4SLinus Torvalds
6371da177e4SLinus Torvalds	   - The "Communication Device Class" (CDC) Ethernet Control Model.
6381da177e4SLinus Torvalds	     That protocol is often avoided with pure Ethernet adapters, in
6391da177e4SLinus Torvalds	     favor of simpler vendor-specific hardware, but is widely
6401da177e4SLinus Torvalds	     supported by firmware for smart network devices.
6411da177e4SLinus Torvalds
6421da177e4SLinus Torvalds	   - On hardware can't implement that protocol, a simple CDC subset
6431da177e4SLinus Torvalds	     is used, placing fewer demands on USB.
6441da177e4SLinus Torvalds
6459b39e9ddSBrian Niebuhr	   - CDC Ethernet Emulation Model (EEM) is a newer standard that has
6469b39e9ddSBrian Niebuhr	     a simpler interface that can be used by more USB hardware.
6479b39e9ddSBrian Niebuhr
6489b39e9ddSBrian Niebuhr	  RNDIS support is an additional option, more demanding than than
6499b39e9ddSBrian Niebuhr	  subset.
6501da177e4SLinus Torvalds
6511da177e4SLinus Torvalds	  Within the USB device, this gadget driver exposes a network device
6521da177e4SLinus Torvalds	  "usbX", where X depends on what other networking devices you have.
6531da177e4SLinus Torvalds	  Treat it like a two-node Ethernet link:  host, and gadget.
6541da177e4SLinus Torvalds
6551da177e4SLinus Torvalds	  The Linux-USB host-side "usbnet" driver interoperates with this
6561da177e4SLinus Torvalds	  driver, so that deep I/O queues can be supported.  On 2.4 kernels,
6571da177e4SLinus Torvalds	  use "CDCEther" instead, if you're using the CDC option. That CDC
6581da177e4SLinus Torvalds	  mode should also interoperate with standard CDC Ethernet class
6591da177e4SLinus Torvalds	  drivers on other host operating systems.
6601da177e4SLinus Torvalds
6611da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
6621da177e4SLinus Torvalds	  dynamically linked module called "g_ether".
6631da177e4SLinus Torvalds
6641da177e4SLinus Torvaldsconfig USB_ETH_RNDIS
665afd0e0f2SRobert P. J. Day	bool "RNDIS support"
666afd0e0f2SRobert P. J. Day	depends on USB_ETH
6671da177e4SLinus Torvalds	default y
6681da177e4SLinus Torvalds	help
6691da177e4SLinus Torvalds	   Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
6701da177e4SLinus Torvalds	   and Microsoft provides redistributable binary RNDIS drivers for
6711da177e4SLinus Torvalds	   older versions of Windows.
6721da177e4SLinus Torvalds
6731da177e4SLinus Torvalds	   If you say "y" here, the Ethernet gadget driver will try to provide
6741da177e4SLinus Torvalds	   a second device configuration, supporting RNDIS to talk to such
6751da177e4SLinus Torvalds	   Microsoft USB hosts.
6761da177e4SLinus Torvalds
6771da177e4SLinus Torvalds	   To make MS-Windows work with this, use Documentation/usb/linux.inf
6781da177e4SLinus Torvalds	   as the "driver info file".  For versions of MS-Windows older than
6791da177e4SLinus Torvalds	   XP, you'll need to download drivers from Microsoft's website; a URL
6801da177e4SLinus Torvalds	   is given in comments found in that info file.
6811da177e4SLinus Torvalds
6829b39e9ddSBrian Niebuhrconfig USB_ETH_EEM
6839b39e9ddSBrian Niebuhr       bool "Ethernet Emulation Model (EEM) support"
6849b39e9ddSBrian Niebuhr       depends on USB_ETH
6859b39e9ddSBrian Niebuhr       default n
6869b39e9ddSBrian Niebuhr       help
6879b39e9ddSBrian Niebuhr         CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM
6889b39e9ddSBrian Niebuhr         and therefore can be supported by more hardware.  Technically ECM and
6899b39e9ddSBrian Niebuhr         EEM are designed for different applications.  The ECM model extends
6909b39e9ddSBrian Niebuhr         the network interface to the target (e.g. a USB cable modem), and the
6919b39e9ddSBrian Niebuhr         EEM model is for mobile devices to communicate with hosts using
6929b39e9ddSBrian Niebuhr         ethernet over USB.  For Linux gadgets, however, the interface with
6939b39e9ddSBrian Niebuhr         the host is the same (a usbX device), so the differences are minimal.
6949b39e9ddSBrian Niebuhr
6959b39e9ddSBrian Niebuhr         If you say "y" here, the Ethernet gadget driver will use the EEM
6969b39e9ddSBrian Niebuhr         protocol rather than ECM.  If unsure, say "n".
6979b39e9ddSBrian Niebuhr
6986c34d288SYauheni Kaliutaconfig USB_G_NCM
6996c34d288SYauheni Kaliuta	tristate "Network Control Model (NCM) support"
7006c34d288SYauheni Kaliuta	depends on NET
7016c34d288SYauheni Kaliuta	select CRC32
7026c34d288SYauheni Kaliuta	help
7036c34d288SYauheni Kaliuta	  This driver implements USB CDC NCM subclass standard. NCM is
7046c34d288SYauheni Kaliuta	  an advanced protocol for Ethernet encapsulation, allows grouping
7056c34d288SYauheni Kaliuta	  of several ethernet frames into one USB transfer and diffferent
7066c34d288SYauheni Kaliuta	  alignment possibilities.
7076c34d288SYauheni Kaliuta
7086c34d288SYauheni Kaliuta	  Say "y" to link the driver statically, or "m" to build a
7096c34d288SYauheni Kaliuta	  dynamically linked module called "g_ncm".
7106c34d288SYauheni Kaliuta
7111da177e4SLinus Torvaldsconfig USB_GADGETFS
7121da177e4SLinus Torvalds	tristate "Gadget Filesystem (EXPERIMENTAL)"
7131da177e4SLinus Torvalds	depends on EXPERIMENTAL
7141da177e4SLinus Torvalds	help
7151da177e4SLinus Torvalds	  This driver provides a filesystem based API that lets user mode
7161da177e4SLinus Torvalds	  programs implement a single-configuration USB device, including
7171da177e4SLinus Torvalds	  endpoint I/O and control requests that don't relate to enumeration.
7181da177e4SLinus Torvalds	  All endpoints, transfer speeds, and transfer types supported by
7191da177e4SLinus Torvalds	  the hardware are available, through read() and write() calls.
7201da177e4SLinus Torvalds
721afd0e0f2SRobert P. J. Day	  Currently, this option is still labelled as EXPERIMENTAL because
722afd0e0f2SRobert P. J. Day	  of existing race conditions in the underlying in-kernel AIO core.
723afd0e0f2SRobert P. J. Day
7241da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
7251da177e4SLinus Torvalds	  dynamically linked module called "gadgetfs".
7261da177e4SLinus Torvalds
727c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS
728c6c56008SMichal Nazarewicz	tristate "Function Filesystem (EXPERIMENTAL)"
729c6c56008SMichal Nazarewicz	depends on EXPERIMENTAL
730f8dae531SMichal Nazarewicz	select USB_FUNCTIONFS_GENERIC if !(USB_FUNCTIONFS_ETH || USB_FUNCTIONFS_RNDIS)
731c6c56008SMichal Nazarewicz	help
732eabf0f5fSMichael Prokop	  The Function Filesystem (FunctionFS) lets one create USB
733eabf0f5fSMichael Prokop	  composite functions in user space in the same way GadgetFS
734c6c56008SMichal Nazarewicz	  lets one create USB gadgets in user space.  This allows creation
735c6c56008SMichal Nazarewicz	  of composite gadgets such that some of the functions are
736c6c56008SMichal Nazarewicz	  implemented in kernel space (for instance Ethernet, serial or
737c6c56008SMichal Nazarewicz	  mass storage) and other are implemented in user space.
738c6c56008SMichal Nazarewicz
739f8dae531SMichal Nazarewicz	  If you say "y" or "m" here you will be able what kind of
740f8dae531SMichal Nazarewicz	  configurations the gadget will provide.
741f8dae531SMichal Nazarewicz
742c6c56008SMichal Nazarewicz	  Say "y" to link the driver statically, or "m" to build
743c6c56008SMichal Nazarewicz	  a dynamically linked module called "g_ffs".
744c6c56008SMichal Nazarewicz
745c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_ETH
746f8dae531SMichal Nazarewicz	bool "Include configuration with CDC ECM (Ethernet)"
74717b2765eSRandy Dunlap	depends on USB_FUNCTIONFS && NET
748c6c56008SMichal Nazarewicz	help
749eabf0f5fSMichael Prokop	  Include a configuration with CDC ECM function (Ethernet) and the
750eabf0f5fSMichael Prokop	  Function Filesystem.
751c6c56008SMichal Nazarewicz
752c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_RNDIS
753f8dae531SMichal Nazarewicz	bool "Include configuration with RNDIS (Ethernet)"
75417b2765eSRandy Dunlap	depends on USB_FUNCTIONFS && NET
755c6c56008SMichal Nazarewicz	help
756eabf0f5fSMichael Prokop	  Include a configuration with RNDIS function (Ethernet) and the Filesystem.
757c6c56008SMichal Nazarewicz
758c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_GENERIC
759c6c56008SMichal Nazarewicz	bool "Include 'pure' configuration"
760f8dae531SMichal Nazarewicz	depends on USB_FUNCTIONFS
761c6c56008SMichal Nazarewicz	help
762f8dae531SMichal Nazarewicz	  Include a configuration with the Function Filesystem alone with
763f8dae531SMichal Nazarewicz	  no Ethernet interface.
764c6c56008SMichal Nazarewicz
7651da177e4SLinus Torvaldsconfig USB_FILE_STORAGE
766664a51a8SAlan Stern	tristate "File-backed Storage Gadget (DEPRECATED)"
76787840289SRandy Dunlap	depends on BLOCK
7681da177e4SLinus Torvalds	help
7691da177e4SLinus Torvalds	  The File-backed Storage Gadget acts as a USB Mass Storage
7701da177e4SLinus Torvalds	  disk drive.  As its storage repository it can use a regular
7711da177e4SLinus Torvalds	  file or a block device (in much the same way as the "loop"
7721da177e4SLinus Torvalds	  device driver), specified as a module parameter.
7731da177e4SLinus Torvalds
7741da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
7751da177e4SLinus Torvalds	  dynamically linked module called "g_file_storage".
7761da177e4SLinus Torvalds
777664a51a8SAlan Stern	  NOTE: This driver is deprecated.  Its replacement is the
778664a51a8SAlan Stern	  Mass Storage Gadget.
779664a51a8SAlan Stern
7801da177e4SLinus Torvaldsconfig USB_FILE_STORAGE_TEST
7811da177e4SLinus Torvalds	bool "File-backed Storage Gadget testing version"
7821da177e4SLinus Torvalds	depends on USB_FILE_STORAGE
7831da177e4SLinus Torvalds	default n
7841da177e4SLinus Torvalds	help
7851da177e4SLinus Torvalds	  Say "y" to generate the larger testing version of the
7861da177e4SLinus Torvalds	  File-backed Storage Gadget, useful for probing the
7871da177e4SLinus Torvalds	  behavior of USB Mass Storage hosts.  Not needed for
7881da177e4SLinus Torvalds	  normal operation.
7891da177e4SLinus Torvalds
790d23b0f08SMichal Nazarewiczconfig USB_MASS_STORAGE
791d23b0f08SMichal Nazarewicz	tristate "Mass Storage Gadget"
792d23b0f08SMichal Nazarewicz	depends on BLOCK
793d23b0f08SMichal Nazarewicz	help
794d23b0f08SMichal Nazarewicz	  The Mass Storage Gadget acts as a USB Mass Storage disk drive.
795d23b0f08SMichal Nazarewicz	  As its storage repository it can use a regular file or a block
796d23b0f08SMichal Nazarewicz	  device (in much the same way as the "loop" device driver),
797d23b0f08SMichal Nazarewicz	  specified as a module parameter or sysfs option.
798d23b0f08SMichal Nazarewicz
799664a51a8SAlan Stern	  This driver is an updated replacement for the deprecated
800664a51a8SAlan Stern	  File-backed Storage Gadget (g_file_storage).
801d23b0f08SMichal Nazarewicz
802d23b0f08SMichal Nazarewicz	  Say "y" to link the driver statically, or "m" to build
803664a51a8SAlan Stern	  a dynamically linked module called "g_mass_storage".
804d23b0f08SMichal Nazarewicz
8051da177e4SLinus Torvaldsconfig USB_G_SERIAL
8063086775aSFelipe Balbi	tristate "Serial Gadget (with CDC ACM and CDC OBEX support)"
8071da177e4SLinus Torvalds	help
8081da177e4SLinus Torvalds	  The Serial Gadget talks to the Linux-USB generic serial driver.
8091da177e4SLinus Torvalds	  This driver supports a CDC-ACM module option, which can be used
8101da177e4SLinus Torvalds	  to interoperate with MS-Windows hosts or with the Linux-USB
8111da177e4SLinus Torvalds	  "cdc-acm" driver.
8121da177e4SLinus Torvalds
8133086775aSFelipe Balbi	  This driver also supports a CDC-OBEX option.  You will need a
8143086775aSFelipe Balbi	  user space OBEX server talking to /dev/ttyGS*, since the kernel
8153086775aSFelipe Balbi	  itself doesn't implement the OBEX protocol.
8163086775aSFelipe Balbi
8171da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
8181da177e4SLinus Torvalds	  dynamically linked module called "g_serial".
8191da177e4SLinus Torvalds
8201da177e4SLinus Torvalds	  For more information, see Documentation/usb/gadget_serial.txt
8211da177e4SLinus Torvalds	  which includes instructions and a "driver info file" needed to
8223086775aSFelipe Balbi	  make MS-Windows work with CDC ACM.
8231da177e4SLinus Torvalds
824f2ebf92cSBen Williamsonconfig USB_MIDI_GADGET
825f2ebf92cSBen Williamson	tristate "MIDI Gadget (EXPERIMENTAL)"
826f2ebf92cSBen Williamson	depends on SND && EXPERIMENTAL
827f2ebf92cSBen Williamson	select SND_RAWMIDI
828f2ebf92cSBen Williamson	help
829f2ebf92cSBen Williamson	  The MIDI Gadget acts as a USB Audio device, with one MIDI
830f2ebf92cSBen Williamson	  input and one MIDI output. These MIDI jacks appear as
831f2ebf92cSBen Williamson	  a sound "card" in the ALSA sound system. Other MIDI
832f2ebf92cSBen Williamson	  connections can then be made on the gadget system, using
833f2ebf92cSBen Williamson	  ALSA's aconnect utility etc.
834f2ebf92cSBen Williamson
835f2ebf92cSBen Williamson	  Say "y" to link the driver statically, or "m" to build a
836f2ebf92cSBen Williamson	  dynamically linked module called "g_midi".
837f2ebf92cSBen Williamson
83825a010c8SCraig W. Nadlerconfig USB_G_PRINTER
83925a010c8SCraig W. Nadler	tristate "Printer Gadget"
84025a010c8SCraig W. Nadler	help
84125a010c8SCraig W. Nadler	  The Printer Gadget channels data between the USB host and a
84225a010c8SCraig W. Nadler	  userspace program driving the print engine. The user space
84325a010c8SCraig W. Nadler	  program reads and writes the device file /dev/g_printer to
84425a010c8SCraig W. Nadler	  receive or send printer data. It can use ioctl calls to
84525a010c8SCraig W. Nadler	  the device file to get or set printer status.
84625a010c8SCraig W. Nadler
84725a010c8SCraig W. Nadler	  Say "y" to link the driver statically, or "m" to build a
84825a010c8SCraig W. Nadler	  dynamically linked module called "g_printer".
84925a010c8SCraig W. Nadler
85025a010c8SCraig W. Nadler	  For more information, see Documentation/usb/gadget_printer.txt
85125a010c8SCraig W. Nadler	  which includes sample code for accessing the device file.
8521da177e4SLinus Torvalds
85319e20680SDavid Brownellconfig USB_CDC_COMPOSITE
85419e20680SDavid Brownell	tristate "CDC Composite Device (Ethernet and ACM)"
8554ddd9ec1SRandy Dunlap	depends on NET
85619e20680SDavid Brownell	help
85719e20680SDavid Brownell	  This driver provides two functions in one configuration:
85819e20680SDavid Brownell	  a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link.
85919e20680SDavid Brownell
86019e20680SDavid Brownell	  This driver requires four bulk and two interrupt endpoints,
86119e20680SDavid Brownell	  plus the ability to handle altsettings.  Not all peripheral
86219e20680SDavid Brownell	  controllers are that capable.
86319e20680SDavid Brownell
86419e20680SDavid Brownell	  Say "y" to link the driver statically, or "m" to build a
86519e20680SDavid Brownell	  dynamically linked module.
86619e20680SDavid Brownell
867f358f5b4SFelipe Balbiconfig USB_G_NOKIA
868f358f5b4SFelipe Balbi	tristate "Nokia composite gadget"
869f358f5b4SFelipe Balbi	depends on PHONET
870f358f5b4SFelipe Balbi	help
871f358f5b4SFelipe Balbi	  The Nokia composite gadget provides support for acm, obex
872f358f5b4SFelipe Balbi	  and phonet in only one composite gadget driver.
873f358f5b4SFelipe Balbi
874f358f5b4SFelipe Balbi	  It's only really useful for N900 hardware. If you're building
875f358f5b4SFelipe Balbi	  a kernel for N900, say Y or M here. If unsure, say N.
876f358f5b4SFelipe Balbi
877fa3ae0c1SKlaus Schwarzkopfconfig USB_G_ACM_MS
878fa3ae0c1SKlaus Schwarzkopf	tristate "CDC Composite Device (ACM and mass storage)"
879fa3ae0c1SKlaus Schwarzkopf	depends on BLOCK
880fa3ae0c1SKlaus Schwarzkopf	help
881fa3ae0c1SKlaus Schwarzkopf	  This driver provides two functions in one configuration:
882fa3ae0c1SKlaus Schwarzkopf	  a mass storage, and a CDC ACM (serial port) link.
883fa3ae0c1SKlaus Schwarzkopf
884fa3ae0c1SKlaus Schwarzkopf	  Say "y" to link the driver statically, or "m" to build a
885fa3ae0c1SKlaus Schwarzkopf	  dynamically linked module called "g_acm_ms".
886fa3ae0c1SKlaus Schwarzkopf
887f176a5d8SMichal Nazarewiczconfig USB_G_MULTI
888f176a5d8SMichal Nazarewicz	tristate "Multifunction Composite Gadget (EXPERIMENTAL)"
8895791e103SRandy Dunlap	depends on BLOCK && NET
890279cc49aSMichal Nazarewicz	select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS
891f176a5d8SMichal Nazarewicz	help
892f176a5d8SMichal Nazarewicz	  The Multifunction Composite Gadget provides Ethernet (RNDIS
893f176a5d8SMichal Nazarewicz	  and/or CDC Ethernet), mass storage and ACM serial link
894f176a5d8SMichal Nazarewicz	  interfaces.
895f176a5d8SMichal Nazarewicz
8965791e103SRandy Dunlap	  You will be asked to choose which of the two configurations is
897f176a5d8SMichal Nazarewicz	  to be available in the gadget.  At least one configuration must
8985791e103SRandy Dunlap	  be chosen to make the gadget usable.  Selecting more than one
899f176a5d8SMichal Nazarewicz	  configuration will prevent Windows from automatically detecting
9005791e103SRandy Dunlap	  the gadget as a composite gadget, so an INF file will be needed to
901f176a5d8SMichal Nazarewicz	  use the gadget.
902f176a5d8SMichal Nazarewicz
903f176a5d8SMichal Nazarewicz	  Say "y" to link the driver statically, or "m" to build a
904f176a5d8SMichal Nazarewicz	  dynamically linked module called "g_multi".
905f176a5d8SMichal Nazarewicz
906f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_RNDIS
907f176a5d8SMichal Nazarewicz	bool "RNDIS + CDC Serial + Storage configuration"
908f176a5d8SMichal Nazarewicz	depends on USB_G_MULTI
909f176a5d8SMichal Nazarewicz	default y
910f176a5d8SMichal Nazarewicz	help
911f176a5d8SMichal Nazarewicz	  This option enables a configuration with RNDIS, CDC Serial and
912f176a5d8SMichal Nazarewicz	  Mass Storage functions available in the Multifunction Composite
9135791e103SRandy Dunlap	  Gadget.  This is the configuration dedicated for Windows since RNDIS
9145791e103SRandy Dunlap	  is Microsoft's protocol.
915f176a5d8SMichal Nazarewicz
916f176a5d8SMichal Nazarewicz	  If unsure, say "y".
917f176a5d8SMichal Nazarewicz
918f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_CDC
919f176a5d8SMichal Nazarewicz	bool "CDC Ethernet + CDC Serial + Storage configuration"
920f176a5d8SMichal Nazarewicz	depends on USB_G_MULTI
921f176a5d8SMichal Nazarewicz	default n
922f176a5d8SMichal Nazarewicz	help
923f176a5d8SMichal Nazarewicz	  This option enables a configuration with CDC Ethernet (ECM), CDC
924f176a5d8SMichal Nazarewicz	  Serial and Mass Storage functions available in the Multifunction
9255791e103SRandy Dunlap	  Composite Gadget.
926f176a5d8SMichal Nazarewicz
927f176a5d8SMichal Nazarewicz	  If unsure, say "y".
928f176a5d8SMichal Nazarewicz
92971adf118SFabien Chouteauconfig USB_G_HID
93071adf118SFabien Chouteau	tristate "HID Gadget"
93171adf118SFabien Chouteau	help
93271adf118SFabien Chouteau	  The HID gadget driver provides generic emulation of USB
93371adf118SFabien Chouteau	  Human Interface Devices (HID).
93471adf118SFabien Chouteau
93571adf118SFabien Chouteau	  For more information, see Documentation/usb/gadget_hid.txt which
93671adf118SFabien Chouteau	  includes sample code for accessing the device files.
93771adf118SFabien Chouteau
93871adf118SFabien Chouteau	  Say "y" to link the driver statically, or "m" to build a
93971adf118SFabien Chouteau	  dynamically linked module called "g_hid".
940f176a5d8SMichal Nazarewicz
941f6c826a9Sstephane duvergerconfig USB_G_DBGP
942f6c826a9Sstephane duverger	tristate "EHCI Debug Device Gadget"
943f6c826a9Sstephane duverger	help
944f6c826a9Sstephane duverger	  This gadget emulates an EHCI Debug device. This is useful when you want
945f6c826a9Sstephane duverger	  to interact with an EHCI Debug Port.
946f6c826a9Sstephane duverger
947f6c826a9Sstephane duverger	  Say "y" to link the driver statically, or "m" to build a
948f6c826a9Sstephane duverger	  dynamically linked module called "g_dbgp".
949f6c826a9Sstephane duverger
950f6c826a9Sstephane duvergerif USB_G_DBGP
951f6c826a9Sstephane duvergerchoice
952f6c826a9Sstephane duverger	prompt "EHCI Debug Device mode"
953f6c826a9Sstephane duverger	default USB_G_DBGP_SERIAL
954f6c826a9Sstephane duverger
955f6c826a9Sstephane duvergerconfig USB_G_DBGP_PRINTK
956f6c826a9Sstephane duverger	depends on USB_G_DBGP
957f6c826a9Sstephane duverger	bool "printk"
958f6c826a9Sstephane duverger	help
959f6c826a9Sstephane duverger	  Directly printk() received data. No interaction.
960f6c826a9Sstephane duverger
961f6c826a9Sstephane duvergerconfig USB_G_DBGP_SERIAL
962f6c826a9Sstephane duverger	depends on USB_G_DBGP
963f6c826a9Sstephane duverger	bool "serial"
964f6c826a9Sstephane duverger	help
965f6c826a9Sstephane duverger	  Userland can interact using /dev/ttyGSxxx.
966f6c826a9Sstephane duvergerendchoice
967f6c826a9Sstephane duvergerendif
968f6c826a9Sstephane duverger
9691da177e4SLinus Torvalds# put drivers that need isochronous transfer support (for audio
9701da177e4SLinus Torvalds# or video class gadget drivers), or specific hardware, here.
971a9914127SLaurent Pinchartconfig USB_G_WEBCAM
972a9914127SLaurent Pinchart	tristate "USB Webcam Gadget"
97324337c13SRandy Dunlap	depends on VIDEO_DEV
974a9914127SLaurent Pinchart	help
975a9914127SLaurent Pinchart	  The Webcam Gadget acts as a composite USB Audio and Video Class
976a9914127SLaurent Pinchart	  device. It provides a userspace API to process UVC control requests
977a9914127SLaurent Pinchart	  and stream video data to the host.
9781da177e4SLinus Torvalds
979a9914127SLaurent Pinchart	  Say "y" to link the driver statically, or "m" to build a
980a9914127SLaurent Pinchart	  dynamically linked module called "g_webcam".
9811da177e4SLinus Torvalds
9821da177e4SLinus Torvaldsendchoice
9831da177e4SLinus Torvalds
984b75be4abSDenis Chengendif # USB_GADGET
985