xref: /openbmc/linux/drivers/usb/gadget/Kconfig (revision c52661d6)
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"
1886dc243cSAlan Stern	select NLS
191da177e4SLinus Torvalds	help
201da177e4SLinus Torvalds	   USB is a master/slave protocol, organized with one master
211da177e4SLinus Torvalds	   host (such as a PC) controlling up to 127 peripheral devices.
221da177e4SLinus Torvalds	   The USB hardware is asymmetric, which makes it easier to set up:
231da177e4SLinus Torvalds	   you can't connect a "to-the-host" connector to a peripheral.
241da177e4SLinus Torvalds
251da177e4SLinus Torvalds	   Linux can run in the host, or in the peripheral.  In both cases
261da177e4SLinus Torvalds	   you need a low level bus controller driver, and some software
271da177e4SLinus Torvalds	   talking to it.  Peripheral controllers are often discrete silicon,
281da177e4SLinus Torvalds	   or are integrated with the CPU in a microcontroller.  The more
29e113f29cSJules Villard	   familiar host side controllers have names like "EHCI", "OHCI",
301da177e4SLinus Torvalds	   or "UHCI", and are usually integrated into southbridges on PC
311da177e4SLinus Torvalds	   motherboards.
321da177e4SLinus Torvalds
331da177e4SLinus Torvalds	   Enable this configuration option if you want to run Linux inside
341da177e4SLinus Torvalds	   a USB peripheral device.  Configure one hardware driver for your
351da177e4SLinus Torvalds	   peripheral/device side bus controller, and a "gadget driver" for
361da177e4SLinus Torvalds	   your peripheral protocol.  (If you use modular gadget drivers,
371da177e4SLinus Torvalds	   you may configure more than one.)
381da177e4SLinus Torvalds
391da177e4SLinus Torvalds	   If in doubt, say "N" and don't enable these drivers; most people
401da177e4SLinus Torvalds	   don't have this kind of hardware (except maybe inside Linux PDAs).
411da177e4SLinus Torvalds
421da177e4SLinus Torvalds	   For more information, see <http://www.linux-usb.org/gadget> and
431da177e4SLinus Torvalds	   the kernel DocBook documentation for this API.
441da177e4SLinus Torvalds
45b75be4abSDenis Chengif USB_GADGET
46b75be4abSDenis Cheng
4770790f63SDavid Brownellconfig USB_GADGET_DEBUG
48afd0e0f2SRobert P. J. Day	boolean "Debugging messages (DEVELOPMENT)"
4936e893d2SDavid Brownell	depends on DEBUG_KERNEL
5070790f63SDavid Brownell	help
5170790f63SDavid Brownell	   Many controller and gadget drivers will print some debugging
5270790f63SDavid Brownell	   messages if you use this option to ask for those messages.
5370790f63SDavid Brownell
5470790f63SDavid Brownell	   Avoid enabling these messages, even if you're actively
5570790f63SDavid Brownell	   debugging such a driver.  Many drivers will emit so many
5670790f63SDavid Brownell	   messages that the driver timings are affected, which will
5770790f63SDavid Brownell	   either create new failure modes or remove the one you're
5870790f63SDavid Brownell	   trying to track down.  Never enable these messages for a
5970790f63SDavid Brownell	   production build.
6070790f63SDavid Brownell
611da177e4SLinus Torvaldsconfig USB_GADGET_DEBUG_FILES
62afd0e0f2SRobert P. J. Day	boolean "Debugging information files (DEVELOPMENT)"
6336e893d2SDavid Brownell	depends on PROC_FS
641da177e4SLinus Torvalds	help
651da177e4SLinus Torvalds	   Some of the drivers in the "gadget" framework can expose
661da177e4SLinus Torvalds	   debugging information in files such as /proc/driver/udc
671da177e4SLinus Torvalds	   (for a peripheral controller).  The information in these
681da177e4SLinus Torvalds	   files may help when you're troubleshooting or bringing up a
691da177e4SLinus Torvalds	   driver on a new board.   Enable these files by choosing "Y"
701da177e4SLinus Torvalds	   here.  If in doubt, or to conserve kernel memory, say "N".
711da177e4SLinus Torvalds
72914a3f3bSHaavard Skinnemoenconfig USB_GADGET_DEBUG_FS
73afd0e0f2SRobert P. J. Day	boolean "Debugging information files in debugfs (DEVELOPMENT)"
7436e893d2SDavid Brownell	depends on DEBUG_FS
75914a3f3bSHaavard Skinnemoen	help
76914a3f3bSHaavard Skinnemoen	   Some of the drivers in the "gadget" framework can expose
77914a3f3bSHaavard Skinnemoen	   debugging information in files under /sys/kernel/debug/.
78914a3f3bSHaavard Skinnemoen	   The information in these files may help when you're
79914a3f3bSHaavard Skinnemoen	   troubleshooting or bringing up a driver on a new board.
80914a3f3bSHaavard Skinnemoen	   Enable these files by choosing "Y" here.  If in doubt, or
81914a3f3bSHaavard Skinnemoen	   to conserve kernel memory, say "N".
82914a3f3bSHaavard Skinnemoen
8336e893d2SDavid Brownellconfig USB_GADGET_VBUS_DRAW
8436e893d2SDavid Brownell	int "Maximum VBUS Power usage (2-500 mA)"
8536e893d2SDavid Brownell	range 2 500
8636e893d2SDavid Brownell	default 2
8736e893d2SDavid Brownell	help
8836e893d2SDavid Brownell	   Some devices need to draw power from USB when they are
8936e893d2SDavid Brownell	   configured, perhaps to operate circuitry or to recharge
9036e893d2SDavid Brownell	   batteries.  This is in addition to any local power supply,
9136e893d2SDavid Brownell	   such as an AC adapter or batteries.
9236e893d2SDavid Brownell
9336e893d2SDavid Brownell	   Enter the maximum power your device draws through USB, in
9436e893d2SDavid Brownell	   milliAmperes.  The permitted range of values is 2 - 500 mA;
9536e893d2SDavid Brownell	   0 mA would be legal, but can make some hosts misbehave.
9636e893d2SDavid Brownell
9736e893d2SDavid Brownell	   This value will be used except for system-specific gadget
9836e893d2SDavid Brownell	   drivers that have more specific information.
9936e893d2SDavid Brownell
1006532c7fdSPer Forlinconfig USB_GADGET_STORAGE_NUM_BUFFERS
1016532c7fdSPer Forlin	int "Number of storage pipeline buffers"
1026532c7fdSPer Forlin	range 2 4
1036532c7fdSPer Forlin	default 2
1046532c7fdSPer Forlin	help
1056532c7fdSPer Forlin	   Usually 2 buffers are enough to establish a good buffering
1066532c7fdSPer Forlin	   pipeline. The number may be increased in order to compensate
1076532c7fdSPer Forlin	   for a bursty VFS behaviour. For instance there may be CPU wake up
1086532c7fdSPer Forlin	   latencies that makes the VFS to appear bursty in a system with
1096532c7fdSPer Forlin	   an CPU on-demand governor. Especially if DMA is doing IO to
1106532c7fdSPer Forlin	   offload the CPU. In this case the CPU will go into power
1116532c7fdSPer Forlin	   save often and spin up occasionally to move data within VFS.
1126532c7fdSPer Forlin	   If selecting USB_GADGET_DEBUG_FILES this value may be set by
1136532c7fdSPer Forlin	   a module parameter as well.
1146532c7fdSPer Forlin	   If unsure, say 2.
1156532c7fdSPer Forlin
1161da177e4SLinus Torvalds#
1171da177e4SLinus Torvalds# USB Peripheral Controller Support
1181da177e4SLinus Torvalds#
119a7a19facSDavid Brownell# The order here is alphabetical, except that integrated controllers go
120a7a19facSDavid Brownell# before discrete ones so they will be the initial/default value:
121a7a19facSDavid Brownell#   - integrated/SOC controllers first
122a7a19facSDavid Brownell#   - licensed IP used in both SOC and discrete versions
123a7a19facSDavid Brownell#   - discrete ones (including all PCI-only controllers)
124a7a19facSDavid Brownell#   - debug/dummy gadget+hcd is last.
125a7a19facSDavid Brownell#
1261da177e4SLinus Torvaldschoice
1271da177e4SLinus Torvalds	prompt "USB Peripheral Controller"
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"
140d1494a34SJean-Christophe PLAGNIOL-VILLARD	depends on ARCH_AT91
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
1539918ceafSJean-Christophe PLAGNIOL-VILLARD	depends on AVR32 || 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'
237030ed1fcSKuninori Morimoto	depends on USB_RENESAS_USBHS
238030ed1fcSKuninori Morimoto	select USB_GADGET_DUALSPEED
2392f98382dSKuninori Morimoto	help
240193ab2a6SFelipe Balbi	   Renesas USBHS is a discrete USB host and peripheral controller chip
241193ab2a6SFelipe Balbi	   that supports both full and high speed USB 2.0 data transfers.
242193ab2a6SFelipe Balbi	   It has nine or more configurable endpoints, and endpoint zero.
2432f98382dSKuninori Morimoto
244193ab2a6SFelipe Balbi	   Say "y" to link the driver statically, or "m" to build a
245193ab2a6SFelipe Balbi	   dynamically linked module called "renesas_usbhs" and force all
246193ab2a6SFelipe Balbi	   gadget drivers to also be dynamically linked.
2472f98382dSKuninori Morimoto
248193ab2a6SFelipe Balbiconfig USB_PXA27X
249193ab2a6SFelipe Balbi	tristate "PXA 27x"
2509f5351b7SRobert Jarzmik	depends on ARCH_PXA && (PXA27x || PXA3xx)
2517fec3c25SRobert Jarzmik	select USB_OTG_UTILS
252a7a19facSDavid Brownell	help
253a7a19facSDavid Brownell	   Intel's PXA 27x series XScale ARM v5TE processors include
254a7a19facSDavid Brownell	   an integrated full speed USB 1.1 device controller.
255a7a19facSDavid Brownell
256a7a19facSDavid Brownell	   It has up to 23 endpoints, as well as endpoint zero (for
257a7a19facSDavid Brownell	   control transfers).
258a7a19facSDavid Brownell
259a7a19facSDavid Brownell	   Say "y" to link the driver statically, or "m" to build a
260a7a19facSDavid Brownell	   dynamically linked module called "pxa27x_udc" and force all
261a7a19facSDavid Brownell	   gadget drivers to also be dynamically linked.
262a7a19facSDavid Brownell
263193ab2a6SFelipe Balbiconfig USB_S3C_HSOTG
264193ab2a6SFelipe Balbi	tristate "S3C HS/OtG USB Device controller"
2655b7d70c6SBen Dooks	depends on S3C_DEV_USB_HSOTG
2660287e43dSMaurus Cuelenaere	select USB_GADGET_DUALSPEED
2675b7d70c6SBen Dooks	help
2685b7d70c6SBen Dooks	  The Samsung S3C64XX USB2.0 high-speed gadget controller
2695b7d70c6SBen Dooks	  integrated into the S3C64XX series SoC.
2705b7d70c6SBen Dooks
271193ab2a6SFelipe Balbiconfig USB_IMX
2722e5a08a3SSascha Hauer	tristate "Freescale i.MX1 USB Peripheral Controller"
2732e5a08a3SSascha Hauer	depends on ARCH_MXC
274c03e7d4bSPaulius Zaleckas	help
2752e5a08a3SSascha Hauer	   Freescale's i.MX1 includes an integrated full speed
2762e5a08a3SSascha Hauer	   USB 1.1 device controller.
277c03e7d4bSPaulius Zaleckas
278c03e7d4bSPaulius Zaleckas	   It has Six fixed-function endpoints, as well as endpoint
279c03e7d4bSPaulius Zaleckas	   zero (for control transfers).
280c03e7d4bSPaulius Zaleckas
281c03e7d4bSPaulius Zaleckas	   Say "y" to link the driver statically, or "m" to build a
282c03e7d4bSPaulius Zaleckas	   dynamically linked module called "imx_udc" and force all
283c03e7d4bSPaulius Zaleckas	   gadget drivers to also be dynamically linked.
284c03e7d4bSPaulius Zaleckas
285193ab2a6SFelipe Balbiconfig USB_S3C2410
286193ab2a6SFelipe Balbi	tristate "S3C2410 USB Device Controller"
287b130d5c2SKukjin Kim	depends on ARCH_S3C24XX
2883fc154b6SArnaud Patard	help
2893fc154b6SArnaud Patard	  Samsung's S3C2410 is an ARM-4 processor with an integrated
2903fc154b6SArnaud Patard	  full speed USB 1.1 device controller.  It has 4 configurable
2913fc154b6SArnaud Patard	  endpoints, as well as endpoint zero (for control transfers).
2923fc154b6SArnaud Patard
2933fc154b6SArnaud Patard	  This driver has been tested on the S3C2410, S3C2412, and
2943fc154b6SArnaud Patard	  S3C2440 processors.
2953fc154b6SArnaud Patard
2963fc154b6SArnaud Patardconfig USB_S3C2410_DEBUG
2973fc154b6SArnaud Patard	boolean "S3C2410 udc debug messages"
298193ab2a6SFelipe Balbi	depends on USB_S3C2410
2993fc154b6SArnaud Patard
300193ab2a6SFelipe Balbiconfig USB_S3C_HSUDC
301193ab2a6SFelipe Balbi	tristate "S3C2416, S3C2443 and S3C2450 USB Device Controller"
302b130d5c2SKukjin Kim	depends on ARCH_S3C24XX
303a9df304cSThomas Abraham	select USB_GADGET_DUALSPEED
304a9df304cSThomas Abraham	help
305a9df304cSThomas Abraham	  Samsung's S3C2416, S3C2443 and S3C2450 is an ARM9 based SoC
306a9df304cSThomas Abraham	  integrated with dual speed USB 2.0 device controller. It has
307a9df304cSThomas Abraham	  8 endpoints, as well as endpoint zero.
308a9df304cSThomas Abraham
309a9df304cSThomas Abraham	  This driver has been tested on S3C2416 and S3C2450 processors.
310a9df304cSThomas Abraham
3115e6c86b0SNeil Zhangconfig USB_MV_UDC
3125e6c86b0SNeil Zhang	tristate "Marvell USB2.0 Device Controller"
313e7cddda4Scxie4	select USB_GADGET_DUALSPEED
314e7cddda4Scxie4	help
3155e6c86b0SNeil Zhang	  Marvell Socs (including PXA and MMP series) include a high speed
3165e6c86b0SNeil Zhang	  USB2.0 OTG controller, which can be configured as high speed or
3175e6c86b0SNeil Zhang	  full speed USB peripheral.
31872246da4SFelipe Balbi
319a7a19facSDavid Brownell#
320a7a19facSDavid Brownell# Controllers available in both integrated and discrete versions
321a7a19facSDavid Brownell#
322a7a19facSDavid Brownell
323a7a19facSDavid Brownell# musb builds in ../musb along with host support
324a7a19facSDavid Brownellconfig USB_GADGET_MUSB_HDRC
325193ab2a6SFelipe Balbi	tristate "Inventra HDRC USB Peripheral (TI, ADI, ...)"
326b61ae342SRabin Vincent	depends on USB_MUSB_HDRC
327a7a19facSDavid Brownell	select USB_GADGET_DUALSPEED
328bae4bd84SDavid Brownell	help
329a7a19facSDavid Brownell	  This OTG-capable silicon IP is used in dual designs including
330085ad406SBryan Wu	  the TI DaVinci, OMAP 243x, OMAP 343x, TUSB 6010, and ADI Blackfin
331a7a19facSDavid Brownell
332193ab2a6SFelipe Balbiconfig USB_M66592
333193ab2a6SFelipe Balbi	tristate "Renesas M66592 USB Peripheral Controller"
334a7a19facSDavid Brownell	select USB_GADGET_DUALSPEED
335a7a19facSDavid Brownell	help
336a7a19facSDavid Brownell	   M66592 is a discrete USB peripheral controller chip that
337a7a19facSDavid Brownell	   supports both full and high speed USB 2.0 data transfers.
338a7a19facSDavid Brownell	   It has seven configurable endpoints, and endpoint zero.
339bae4bd84SDavid Brownell
340bae4bd84SDavid Brownell	   Say "y" to link the driver statically, or "m" to build a
341a7a19facSDavid Brownell	   dynamically linked module called "m66592_udc" and force all
342bae4bd84SDavid Brownell	   gadget drivers to also be dynamically linked.
343bae4bd84SDavid Brownell
344a7a19facSDavid Brownell#
345a7a19facSDavid Brownell# Controllers available only in discrete form (and all PCI controllers)
346a7a19facSDavid Brownell#
347a7a19facSDavid Brownell
348193ab2a6SFelipe Balbiconfig USB_AMD5536UDC
349193ab2a6SFelipe Balbi	tristate "AMD5536 UDC"
350a7a19facSDavid Brownell	depends on PCI
351a7a19facSDavid Brownell	select USB_GADGET_DUALSPEED
352a7a19facSDavid Brownell	help
353a7a19facSDavid Brownell	   The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
354a7a19facSDavid Brownell	   It is a USB Highspeed DMA capable USB device controller. Beside ep0
355a7a19facSDavid Brownell	   it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
356a7a19facSDavid Brownell	   The UDC port supports OTG operation, and may be used as a host port
357a7a19facSDavid Brownell	   if it's not being used to implement peripheral or OTG roles.
358a7a19facSDavid Brownell
359a7a19facSDavid Brownell	   Say "y" to link the driver statically, or "m" to build a
360a7a19facSDavid Brownell	   dynamically linked module called "amd5536udc" and force all
361a7a19facSDavid Brownell	   gadget drivers to also be dynamically linked.
362a7a19facSDavid Brownell
363193ab2a6SFelipe Balbiconfig USB_FSL_QE
364193ab2a6SFelipe Balbi	tristate "Freescale QE/CPM USB Device Controller"
3653948f0e0SLi Yang	depends on FSL_SOC && (QUICC_ENGINE || CPM)
3663948f0e0SLi Yang	help
3673948f0e0SLi Yang	   Some of Freescale PowerPC processors have a Full Speed
3683948f0e0SLi Yang	   QE/CPM2 USB controller, which support device mode with 4
3693948f0e0SLi Yang	   programmable endpoints. This driver supports the
3703948f0e0SLi Yang	   controller in the MPC8360 and MPC8272, and should work with
3713948f0e0SLi Yang	   controllers having QE or CPM2, given minor tweaks.
3723948f0e0SLi Yang
3733948f0e0SLi Yang	   Set CONFIG_USB_GADGET to "m" to build this driver as a
374692105b8SMatt LaPlante	   dynamically linked module called "fsl_qe_udc".
3753948f0e0SLi Yang
376193ab2a6SFelipe Balbiconfig USB_CI13XXX_PCI
377193ab2a6SFelipe Balbi	tristate "MIPS USB CI13xxx PCI UDC"
378aa69a809SDavid Lopo	depends on PCI
379aa69a809SDavid Lopo	select USB_GADGET_DUALSPEED
380aa69a809SDavid Lopo	help
381aa69a809SDavid Lopo	  MIPS USB IP core family device controller
382aa69a809SDavid Lopo	  Currently it only supports IP part number CI13412
383aa69a809SDavid Lopo
384aa69a809SDavid Lopo	  Say "y" to link the driver statically, or "m" to build a
385aa69a809SDavid Lopo	  dynamically linked module called "ci13xxx_udc" and force all
386aa69a809SDavid Lopo	  gadget drivers to also be dynamically linked.
387aa69a809SDavid Lopo
388193ab2a6SFelipe Balbiconfig USB_NET2272
389193ab2a6SFelipe Balbi	tristate "PLX NET2272"
390ceb80363SSeth Levy	select USB_GADGET_DUALSPEED
391ceb80363SSeth Levy	help
392ceb80363SSeth Levy	  PLX NET2272 is a USB peripheral controller which supports
393ceb80363SSeth Levy	  both full and high speed USB 2.0 data transfers.
394ceb80363SSeth Levy
395ceb80363SSeth Levy	  It has three configurable endpoints, as well as endpoint zero
396ceb80363SSeth Levy	  (for control transfer).
397ceb80363SSeth Levy	  Say "y" to link the driver statically, or "m" to build a
398ceb80363SSeth Levy	  dynamically linked module called "net2272" and force all
399ceb80363SSeth Levy	  gadget drivers to also be dynamically linked.
400ceb80363SSeth Levy
401193ab2a6SFelipe Balbiconfig USB_NET2272_DMA
402ceb80363SSeth Levy	boolean "Support external DMA controller"
403193ab2a6SFelipe Balbi	depends on USB_NET2272
404ceb80363SSeth Levy	help
405ceb80363SSeth Levy	  The NET2272 part can optionally support an external DMA
406ceb80363SSeth Levy	  controller, but your board has to have support in the
407ceb80363SSeth Levy	  driver itself.
408ceb80363SSeth Levy
409ceb80363SSeth Levy	  If unsure, say "N" here.  The driver works fine in PIO mode.
410ceb80363SSeth Levy
411193ab2a6SFelipe Balbiconfig USB_NET2280
412193ab2a6SFelipe Balbi	tristate "NetChip 228x"
413a7a19facSDavid Brownell	depends on PCI
414a7a19facSDavid Brownell	select USB_GADGET_DUALSPEED
415a7a19facSDavid Brownell	help
416a7a19facSDavid Brownell	   NetChip 2280 / 2282 is a PCI based USB peripheral controller which
417a7a19facSDavid Brownell	   supports both full and high speed USB 2.0 data transfers.
418a7a19facSDavid Brownell
419a7a19facSDavid Brownell	   It has six configurable endpoints, as well as endpoint zero
420a7a19facSDavid Brownell	   (for control transfers) and several endpoints with dedicated
421a7a19facSDavid Brownell	   functions.
422a7a19facSDavid Brownell
423a7a19facSDavid Brownell	   Say "y" to link the driver statically, or "m" to build a
424a7a19facSDavid Brownell	   dynamically linked module called "net2280" and force all
425a7a19facSDavid Brownell	   gadget drivers to also be dynamically linked.
426a7a19facSDavid Brownell
427193ab2a6SFelipe Balbiconfig USB_GOKU
428193ab2a6SFelipe Balbi	tristate "Toshiba TC86C001 'Goku-S'"
429a7a19facSDavid Brownell	depends on PCI
430a7a19facSDavid Brownell	help
431a7a19facSDavid Brownell	   The Toshiba TC86C001 is a PCI device which includes controllers
432a7a19facSDavid Brownell	   for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
433a7a19facSDavid Brownell
434a7a19facSDavid Brownell	   The device controller has three configurable (bulk or interrupt)
435a7a19facSDavid Brownell	   endpoints, plus endpoint zero (for control transfers).
436a7a19facSDavid Brownell
437a7a19facSDavid Brownell	   Say "y" to link the driver statically, or "m" to build a
438a7a19facSDavid Brownell	   dynamically linked module called "goku_udc" and to force all
439a7a19facSDavid Brownell	   gadget drivers to also be dynamically linked.
440a7a19facSDavid Brownell
441193ab2a6SFelipe Balbiconfig USB_LANGWELL
442193ab2a6SFelipe Balbi	tristate "Intel Langwell USB Device Controller"
4435be19a9dSXiaochen Shen	depends on PCI
444ac17317dSSebastian Andrzej Siewior	depends on !PHYS_ADDR_T_64BIT
4455be19a9dSXiaochen Shen	select USB_GADGET_DUALSPEED
4465be19a9dSXiaochen Shen	help
4475be19a9dSXiaochen Shen	   Intel Langwell USB Device Controller is a High-Speed USB
4485be19a9dSXiaochen Shen	   On-The-Go device controller.
4495be19a9dSXiaochen Shen
4505be19a9dSXiaochen Shen	   The number of programmable endpoints is different through
4515be19a9dSXiaochen Shen	   controller revision.
4525be19a9dSXiaochen Shen
4535be19a9dSXiaochen Shen	   Say "y" to link the driver statically, or "m" to build a
4545be19a9dSXiaochen Shen	   dynamically linked module called "langwell_udc" and force all
4555be19a9dSXiaochen Shen	   gadget drivers to also be dynamically linked.
4565be19a9dSXiaochen Shen
457193ab2a6SFelipe Balbiconfig USB_EG20T
458731ad81eSTomoya MORINAGA	tristate "Intel EG20T PCH/LAPIS Semiconductor IOH(ML7213/ML7831) UDC"
459f646cf94SToshiharu Okada	depends on PCI
460f646cf94SToshiharu Okada	select USB_GADGET_DUALSPEED
461f646cf94SToshiharu Okada	help
462f646cf94SToshiharu Okada	  This is a USB device driver for EG20T PCH.
463f646cf94SToshiharu Okada	  EG20T PCH is the platform controller hub that is used in Intel's
464f646cf94SToshiharu Okada	  general embedded platform. EG20T PCH has USB device interface.
465f646cf94SToshiharu Okada	  Using this interface, it is able to access system devices connected
466f646cf94SToshiharu Okada	  to USB device.
467f646cf94SToshiharu Okada	  This driver enables USB device function.
468f646cf94SToshiharu Okada	  USB device is a USB peripheral controller which
469f646cf94SToshiharu Okada	  supports both full and high speed USB 2.0 data transfers.
470f646cf94SToshiharu Okada	  This driver supports both control transfer and bulk transfer modes.
471f646cf94SToshiharu Okada	  This driver dose not support interrupt transfer or isochronous
472f646cf94SToshiharu Okada	  transfer modes.
473f646cf94SToshiharu Okada
474731ad81eSTomoya MORINAGA	  This driver also can be used for LAPIS Semiconductor's ML7213 which is
47506f1b971STomoya MORINAGA	  for IVI(In-Vehicle Infotainment) use.
476731ad81eSTomoya MORINAGA	  ML7831 is for general purpose use.
477731ad81eSTomoya MORINAGA	  ML7213/ML7831 is companion chip for Intel Atom E6xx series.
478731ad81eSTomoya MORINAGA	  ML7213/ML7831 is completely compatible for Intel EG20T PCH.
47906f1b971STomoya MORINAGA
480193ab2a6SFelipe Balbiconfig USB_CI13XXX_MSM
481193ab2a6SFelipe Balbi	tristate "MIPS USB CI13xxx for MSM"
48233f82f38SPavankumar Kondeti	depends on ARCH_MSM
48333f82f38SPavankumar Kondeti	select USB_GADGET_DUALSPEED
484dfb2130cSPavankumar Kondeti	select USB_MSM_OTG
48533f82f38SPavankumar Kondeti	help
48633f82f38SPavankumar Kondeti	  MSM SoC has chipidea USB controller.  This driver uses
48733f82f38SPavankumar Kondeti	  ci13xxx_udc core.
48833f82f38SPavankumar Kondeti	  This driver depends on OTG driver for PHY initialization,
48933f82f38SPavankumar Kondeti	  clock management, powering up VBUS, and power management.
4908cf28f1fSPavankumar Kondeti	  This driver is not supported on boards like trout which
4918cf28f1fSPavankumar Kondeti	  has an external PHY.
49233f82f38SPavankumar Kondeti
49333f82f38SPavankumar Kondeti	  Say "y" to link the driver statically, or "m" to build a
49433f82f38SPavankumar Kondeti	  dynamically linked module called "ci13xxx_msm" and force all
49533f82f38SPavankumar Kondeti	  gadget drivers to also be dynamically linked.
49633f82f38SPavankumar Kondeti
497a7a19facSDavid Brownell#
498a7a19facSDavid Brownell# LAST -- dummy/emulated controller
499a7a19facSDavid Brownell#
5001da177e4SLinus Torvalds
501193ab2a6SFelipe Balbiconfig USB_DUMMY_HCD
502193ab2a6SFelipe Balbi	tristate "Dummy HCD (DEVELOPMENT)"
503afd0e0f2SRobert P. J. Day	depends on USB=y || (USB=m && USB_GADGET=m)
5041da177e4SLinus Torvalds	select USB_GADGET_DUALSPEED
5051cd8fd28STatyana Brokhman	select USB_GADGET_SUPERSPEED
5061da177e4SLinus Torvalds	help
5071da177e4SLinus Torvalds	  This host controller driver emulates USB, looping all data transfer
5081da177e4SLinus Torvalds	  requests back to a USB "gadget driver" in the same host.  The host
5091da177e4SLinus Torvalds	  side is the master; the gadget side is the slave.  Gadget drivers
5101da177e4SLinus Torvalds	  can be high, full, or low speed; and they have access to endpoints
5111da177e4SLinus Torvalds	  like those from NET2280, PXA2xx, or SA1100 hardware.
5121da177e4SLinus Torvalds
5131da177e4SLinus Torvalds	  This may help in some stages of creating a driver to embed in a
5141da177e4SLinus Torvalds	  Linux device, since it lets you debug several parts of the gadget
5151da177e4SLinus Torvalds	  driver without its hardware or drivers being involved.
5161da177e4SLinus Torvalds
5171da177e4SLinus Torvalds	  Since such a gadget side driver needs to interoperate with a host
5181da177e4SLinus Torvalds	  side Linux-USB device driver, this may help to debug both sides
5191da177e4SLinus Torvalds	  of a USB protocol stack.
5201da177e4SLinus Torvalds
5211da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
5221da177e4SLinus Torvalds	  dynamically linked module called "dummy_hcd" and force all
5231da177e4SLinus Torvalds	  gadget drivers to also be dynamically linked.
5241da177e4SLinus Torvalds
5251da177e4SLinus Torvalds# NOTE:  Please keep dummy_hcd LAST so that "real hardware" appears
5261da177e4SLinus Torvalds# first and will be selected by default.
5271da177e4SLinus Torvalds
5281da177e4SLinus Torvaldsendchoice
5291da177e4SLinus Torvalds
53097b2f900SAlan Stern# Selected by UDC drivers that support high-speed operation.
5311da177e4SLinus Torvaldsconfig USB_GADGET_DUALSPEED
5321da177e4SLinus Torvalds	bool
5331da177e4SLinus Torvalds
534bdb64d72STatyana Brokhman# Selected by UDC drivers that support super-speed opperation
535bdb64d72STatyana Brokhmanconfig USB_GADGET_SUPERSPEED
536bdb64d72STatyana Brokhman	bool
537bdb64d72STatyana Brokhman	depends on USB_GADGET_DUALSPEED
538bdb64d72STatyana Brokhman
5391da177e4SLinus Torvalds#
5401da177e4SLinus Torvalds# USB Gadget Drivers
5411da177e4SLinus Torvalds#
5421da177e4SLinus Torvaldschoice
5431da177e4SLinus Torvalds	tristate "USB Gadget Drivers"
5441da177e4SLinus Torvalds	default USB_ETH
5451da177e4SLinus Torvalds	help
5461da177e4SLinus Torvalds	  A Linux "Gadget Driver" talks to the USB Peripheral Controller
5471da177e4SLinus Torvalds	  driver through the abstract "gadget" API.  Some other operating
5481da177e4SLinus Torvalds	  systems call these "client" drivers, of which "class drivers"
5491da177e4SLinus Torvalds	  are a subset (implementing a USB device class specification).
5501da177e4SLinus Torvalds	  A gadget driver implements one or more USB functions using
5511da177e4SLinus Torvalds	  the peripheral hardware.
5521da177e4SLinus Torvalds
5531da177e4SLinus Torvalds	  Gadget drivers are hardware-neutral, or "platform independent",
5541da177e4SLinus Torvalds	  except that they sometimes must understand quirks or limitations
5551da177e4SLinus Torvalds	  of the particular controllers they work with.  For example, when
5561da177e4SLinus Torvalds	  a controller doesn't support alternate configurations or provide
5571da177e4SLinus Torvalds	  enough of the right types of endpoints, the gadget driver might
5581da177e4SLinus Torvalds	  not be able work with that controller, or might need to implement
5591da177e4SLinus Torvalds	  a less common variant of a device class protocol.
5601da177e4SLinus Torvalds
5611da177e4SLinus Torvalds# this first set of drivers all depend on bulk-capable hardware.
5621da177e4SLinus Torvalds
5631da177e4SLinus Torvaldsconfig USB_ZERO
5641da177e4SLinus Torvalds	tristate "Gadget Zero (DEVELOPMENT)"
5651da177e4SLinus Torvalds	help
5661da177e4SLinus Torvalds	  Gadget Zero is a two-configuration device.  It either sinks and
5671da177e4SLinus Torvalds	  sources bulk data; or it loops back a configurable number of
5681da177e4SLinus Torvalds	  transfers.  It also implements control requests, for "chapter 9"
5691da177e4SLinus Torvalds	  conformance.  The driver needs only two bulk-capable endpoints, so
5701da177e4SLinus Torvalds	  it can work on top of most device-side usb controllers.  It's
5711da177e4SLinus Torvalds	  useful for testing, and is also a working example showing how
5721da177e4SLinus Torvalds	  USB "gadget drivers" can be written.
5731da177e4SLinus Torvalds
5741da177e4SLinus Torvalds	  Make this be the first driver you try using on top of any new
5751da177e4SLinus Torvalds	  USB peripheral controller driver.  Then you can use host-side
5761da177e4SLinus Torvalds	  test software, like the "usbtest" driver, to put your hardware
5771da177e4SLinus Torvalds	  and its driver through a basic set of functional tests.
5781da177e4SLinus Torvalds
5791da177e4SLinus Torvalds	  Gadget Zero also works with the host-side "usb-skeleton" driver,
5801da177e4SLinus Torvalds	  and with many kinds of host-side test software.  You may need
5811da177e4SLinus Torvalds	  to tweak product and vendor IDs before host software knows about
5821da177e4SLinus Torvalds	  this device, and arrange to select an appropriate configuration.
5831da177e4SLinus Torvalds
5841da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
5851da177e4SLinus Torvalds	  dynamically linked module called "g_zero".
5861da177e4SLinus Torvalds
5871da177e4SLinus Torvaldsconfig USB_ZERO_HNPTEST
5881da177e4SLinus Torvalds	boolean "HNP Test Device"
5891da177e4SLinus Torvalds	depends on USB_ZERO && USB_OTG
5901da177e4SLinus Torvalds	help
5911da177e4SLinus Torvalds	  You can configure this device to enumerate using the device
5921da177e4SLinus Torvalds	  identifiers of the USB-OTG test device.  That means that when
5931da177e4SLinus Torvalds	  this gadget connects to another OTG device, with this one using
5941da177e4SLinus Torvalds	  the "B-Peripheral" role, that device will use HNP to let this
5951da177e4SLinus Torvalds	  one serve as the USB host instead (in the "B-Host" role).
5961da177e4SLinus Torvalds
597c6994e6fSBryan Wuconfig USB_AUDIO
598c6994e6fSBryan Wu	tristate "Audio Gadget (EXPERIMENTAL)"
599c6994e6fSBryan Wu	depends on SND
60004950737SRandy Dunlap	select SND_PCM
601c6994e6fSBryan Wu	help
602132fcb46SJassi Brar	  This Gadget Audio driver is compatible with USB Audio Class
603132fcb46SJassi Brar	  specification 2.0. It implements 1 AudioControl interface,
604132fcb46SJassi Brar	  1 AudioStreaming Interface each for USB-OUT and USB-IN.
605132fcb46SJassi Brar	  Number of channels, sample rate and sample size can be
606132fcb46SJassi Brar	  specified as module parameters.
607132fcb46SJassi Brar	  This driver doesn't expect any real Audio codec to be present
608132fcb46SJassi Brar	  on the device - the audio streams are simply sinked to and
609132fcb46SJassi Brar	  sourced from a virtual ALSA sound card created. The user-space
610132fcb46SJassi Brar	  application may choose to do whatever it wants with the data
611132fcb46SJassi Brar	  received from the USB Host and choose to provide whatever it
612132fcb46SJassi Brar	  wants as audio data to the USB Host.
613c6994e6fSBryan Wu
614c6994e6fSBryan Wu	  Say "y" to link the driver statically, or "m" to build a
615c6994e6fSBryan Wu	  dynamically linked module called "g_audio".
616c6994e6fSBryan Wu
617132fcb46SJassi Brarconfig GADGET_UAC1
618132fcb46SJassi Brar	bool "UAC 1.0 (Legacy)"
619132fcb46SJassi Brar	depends on USB_AUDIO
620132fcb46SJassi Brar	help
621132fcb46SJassi Brar	  If you instead want older UAC Spec-1.0 driver that also has audio
622132fcb46SJassi Brar	  paths hardwired to the Audio codec chip on-board and doesn't work
623132fcb46SJassi Brar	  without one.
624132fcb46SJassi Brar
6251da177e4SLinus Torvaldsconfig USB_ETH
6261da177e4SLinus Torvalds	tristate "Ethernet Gadget (with CDC Ethernet support)"
6271da177e4SLinus Torvalds	depends on NET
6289e221be8SRandy Dunlap	select CRC32
6291da177e4SLinus Torvalds	help
6309b39e9ddSBrian Niebuhr	  This driver implements Ethernet style communication, in one of
6319b39e9ddSBrian Niebuhr	  several ways:
6321da177e4SLinus Torvalds
6331da177e4SLinus Torvalds	   - The "Communication Device Class" (CDC) Ethernet Control Model.
6341da177e4SLinus Torvalds	     That protocol is often avoided with pure Ethernet adapters, in
6351da177e4SLinus Torvalds	     favor of simpler vendor-specific hardware, but is widely
6361da177e4SLinus Torvalds	     supported by firmware for smart network devices.
6371da177e4SLinus Torvalds
6381da177e4SLinus Torvalds	   - On hardware can't implement that protocol, a simple CDC subset
6391da177e4SLinus Torvalds	     is used, placing fewer demands on USB.
6401da177e4SLinus Torvalds
6419b39e9ddSBrian Niebuhr	   - CDC Ethernet Emulation Model (EEM) is a newer standard that has
6429b39e9ddSBrian Niebuhr	     a simpler interface that can be used by more USB hardware.
6439b39e9ddSBrian Niebuhr
6449b39e9ddSBrian Niebuhr	  RNDIS support is an additional option, more demanding than than
6459b39e9ddSBrian Niebuhr	  subset.
6461da177e4SLinus Torvalds
6471da177e4SLinus Torvalds	  Within the USB device, this gadget driver exposes a network device
6481da177e4SLinus Torvalds	  "usbX", where X depends on what other networking devices you have.
6491da177e4SLinus Torvalds	  Treat it like a two-node Ethernet link:  host, and gadget.
6501da177e4SLinus Torvalds
6511da177e4SLinus Torvalds	  The Linux-USB host-side "usbnet" driver interoperates with this
6521da177e4SLinus Torvalds	  driver, so that deep I/O queues can be supported.  On 2.4 kernels,
6531da177e4SLinus Torvalds	  use "CDCEther" instead, if you're using the CDC option. That CDC
6541da177e4SLinus Torvalds	  mode should also interoperate with standard CDC Ethernet class
6551da177e4SLinus Torvalds	  drivers on other host operating systems.
6561da177e4SLinus Torvalds
6571da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
6581da177e4SLinus Torvalds	  dynamically linked module called "g_ether".
6591da177e4SLinus Torvalds
6601da177e4SLinus Torvaldsconfig USB_ETH_RNDIS
661afd0e0f2SRobert P. J. Day	bool "RNDIS support"
662afd0e0f2SRobert P. J. Day	depends on USB_ETH
6631da177e4SLinus Torvalds	default y
6641da177e4SLinus Torvalds	help
6651da177e4SLinus Torvalds	   Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
6661da177e4SLinus Torvalds	   and Microsoft provides redistributable binary RNDIS drivers for
6671da177e4SLinus Torvalds	   older versions of Windows.
6681da177e4SLinus Torvalds
6691da177e4SLinus Torvalds	   If you say "y" here, the Ethernet gadget driver will try to provide
6701da177e4SLinus Torvalds	   a second device configuration, supporting RNDIS to talk to such
6711da177e4SLinus Torvalds	   Microsoft USB hosts.
6721da177e4SLinus Torvalds
6731da177e4SLinus Torvalds	   To make MS-Windows work with this, use Documentation/usb/linux.inf
6741da177e4SLinus Torvalds	   as the "driver info file".  For versions of MS-Windows older than
6751da177e4SLinus Torvalds	   XP, you'll need to download drivers from Microsoft's website; a URL
6761da177e4SLinus Torvalds	   is given in comments found in that info file.
6771da177e4SLinus Torvalds
6789b39e9ddSBrian Niebuhrconfig USB_ETH_EEM
6799b39e9ddSBrian Niebuhr       bool "Ethernet Emulation Model (EEM) support"
6809b39e9ddSBrian Niebuhr       depends on USB_ETH
6819b39e9ddSBrian Niebuhr       default n
6829b39e9ddSBrian Niebuhr       help
6839b39e9ddSBrian Niebuhr         CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM
6849b39e9ddSBrian Niebuhr         and therefore can be supported by more hardware.  Technically ECM and
6859b39e9ddSBrian Niebuhr         EEM are designed for different applications.  The ECM model extends
6869b39e9ddSBrian Niebuhr         the network interface to the target (e.g. a USB cable modem), and the
6879b39e9ddSBrian Niebuhr         EEM model is for mobile devices to communicate with hosts using
6889b39e9ddSBrian Niebuhr         ethernet over USB.  For Linux gadgets, however, the interface with
6899b39e9ddSBrian Niebuhr         the host is the same (a usbX device), so the differences are minimal.
6909b39e9ddSBrian Niebuhr
6919b39e9ddSBrian Niebuhr         If you say "y" here, the Ethernet gadget driver will use the EEM
6929b39e9ddSBrian Niebuhr         protocol rather than ECM.  If unsure, say "n".
6939b39e9ddSBrian Niebuhr
6946c34d288SYauheni Kaliutaconfig USB_G_NCM
6956c34d288SYauheni Kaliuta	tristate "Network Control Model (NCM) support"
6966c34d288SYauheni Kaliuta	depends on NET
6976c34d288SYauheni Kaliuta	select CRC32
6986c34d288SYauheni Kaliuta	help
6996c34d288SYauheni Kaliuta	  This driver implements USB CDC NCM subclass standard. NCM is
7006c34d288SYauheni Kaliuta	  an advanced protocol for Ethernet encapsulation, allows grouping
701b55dd320SFabio Baltieri	  of several ethernet frames into one USB transfer and different
7026c34d288SYauheni Kaliuta	  alignment possibilities.
7036c34d288SYauheni Kaliuta
7046c34d288SYauheni Kaliuta	  Say "y" to link the driver statically, or "m" to build a
7056c34d288SYauheni Kaliuta	  dynamically linked module called "g_ncm".
7066c34d288SYauheni Kaliuta
7071da177e4SLinus Torvaldsconfig USB_GADGETFS
7081da177e4SLinus Torvalds	tristate "Gadget Filesystem (EXPERIMENTAL)"
7091da177e4SLinus Torvalds	depends on EXPERIMENTAL
7101da177e4SLinus Torvalds	help
7111da177e4SLinus Torvalds	  This driver provides a filesystem based API that lets user mode
7121da177e4SLinus Torvalds	  programs implement a single-configuration USB device, including
7131da177e4SLinus Torvalds	  endpoint I/O and control requests that don't relate to enumeration.
7141da177e4SLinus Torvalds	  All endpoints, transfer speeds, and transfer types supported by
7151da177e4SLinus Torvalds	  the hardware are available, through read() and write() calls.
7161da177e4SLinus Torvalds
717afd0e0f2SRobert P. J. Day	  Currently, this option is still labelled as EXPERIMENTAL because
718afd0e0f2SRobert P. J. Day	  of existing race conditions in the underlying in-kernel AIO core.
719afd0e0f2SRobert P. J. Day
7201da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
7211da177e4SLinus Torvalds	  dynamically linked module called "gadgetfs".
7221da177e4SLinus Torvalds
723c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS
724c6c56008SMichal Nazarewicz	tristate "Function Filesystem (EXPERIMENTAL)"
725c6c56008SMichal Nazarewicz	depends on EXPERIMENTAL
726f8dae531SMichal Nazarewicz	select USB_FUNCTIONFS_GENERIC if !(USB_FUNCTIONFS_ETH || USB_FUNCTIONFS_RNDIS)
727c6c56008SMichal Nazarewicz	help
728eabf0f5fSMichael Prokop	  The Function Filesystem (FunctionFS) lets one create USB
729eabf0f5fSMichael Prokop	  composite functions in user space in the same way GadgetFS
730c6c56008SMichal Nazarewicz	  lets one create USB gadgets in user space.  This allows creation
731c6c56008SMichal Nazarewicz	  of composite gadgets such that some of the functions are
732c6c56008SMichal Nazarewicz	  implemented in kernel space (for instance Ethernet, serial or
733c6c56008SMichal Nazarewicz	  mass storage) and other are implemented in user space.
734c6c56008SMichal Nazarewicz
735f8dae531SMichal Nazarewicz	  If you say "y" or "m" here you will be able what kind of
736f8dae531SMichal Nazarewicz	  configurations the gadget will provide.
737f8dae531SMichal Nazarewicz
738c6c56008SMichal Nazarewicz	  Say "y" to link the driver statically, or "m" to build
739c6c56008SMichal Nazarewicz	  a dynamically linked module called "g_ffs".
740c6c56008SMichal Nazarewicz
741c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_ETH
742f8dae531SMichal Nazarewicz	bool "Include configuration with CDC ECM (Ethernet)"
74317b2765eSRandy Dunlap	depends on USB_FUNCTIONFS && NET
744c6c56008SMichal Nazarewicz	help
745eabf0f5fSMichael Prokop	  Include a configuration with CDC ECM function (Ethernet) and the
746eabf0f5fSMichael Prokop	  Function Filesystem.
747c6c56008SMichal Nazarewicz
748c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_RNDIS
749f8dae531SMichal Nazarewicz	bool "Include configuration with RNDIS (Ethernet)"
75017b2765eSRandy Dunlap	depends on USB_FUNCTIONFS && NET
751c6c56008SMichal Nazarewicz	help
752eabf0f5fSMichael Prokop	  Include a configuration with RNDIS function (Ethernet) and the Filesystem.
753c6c56008SMichal Nazarewicz
754c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_GENERIC
755c6c56008SMichal Nazarewicz	bool "Include 'pure' configuration"
756f8dae531SMichal Nazarewicz	depends on USB_FUNCTIONFS
757c6c56008SMichal Nazarewicz	help
758f8dae531SMichal Nazarewicz	  Include a configuration with the Function Filesystem alone with
759f8dae531SMichal Nazarewicz	  no Ethernet interface.
760c6c56008SMichal Nazarewicz
7611da177e4SLinus Torvaldsconfig USB_FILE_STORAGE
762664a51a8SAlan Stern	tristate "File-backed Storage Gadget (DEPRECATED)"
76387840289SRandy Dunlap	depends on BLOCK
7641da177e4SLinus Torvalds	help
7651da177e4SLinus Torvalds	  The File-backed Storage Gadget acts as a USB Mass Storage
7661da177e4SLinus Torvalds	  disk drive.  As its storage repository it can use a regular
7671da177e4SLinus Torvalds	  file or a block device (in much the same way as the "loop"
7681da177e4SLinus Torvalds	  device driver), specified as a module parameter.
7691da177e4SLinus Torvalds
7701da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
7711da177e4SLinus Torvalds	  dynamically linked module called "g_file_storage".
7721da177e4SLinus Torvalds
773664a51a8SAlan Stern	  NOTE: This driver is deprecated.  Its replacement is the
774664a51a8SAlan Stern	  Mass Storage Gadget.
775664a51a8SAlan Stern
7761da177e4SLinus Torvaldsconfig USB_FILE_STORAGE_TEST
7771da177e4SLinus Torvalds	bool "File-backed Storage Gadget testing version"
7781da177e4SLinus Torvalds	depends on USB_FILE_STORAGE
7791da177e4SLinus Torvalds	default n
7801da177e4SLinus Torvalds	help
7811da177e4SLinus Torvalds	  Say "y" to generate the larger testing version of the
7821da177e4SLinus Torvalds	  File-backed Storage Gadget, useful for probing the
7831da177e4SLinus Torvalds	  behavior of USB Mass Storage hosts.  Not needed for
7841da177e4SLinus Torvalds	  normal operation.
7851da177e4SLinus Torvalds
786d23b0f08SMichal Nazarewiczconfig USB_MASS_STORAGE
787d23b0f08SMichal Nazarewicz	tristate "Mass Storage Gadget"
788d23b0f08SMichal Nazarewicz	depends on BLOCK
789d23b0f08SMichal Nazarewicz	help
790d23b0f08SMichal Nazarewicz	  The Mass Storage Gadget acts as a USB Mass Storage disk drive.
791d23b0f08SMichal Nazarewicz	  As its storage repository it can use a regular file or a block
792d23b0f08SMichal Nazarewicz	  device (in much the same way as the "loop" device driver),
793d23b0f08SMichal Nazarewicz	  specified as a module parameter or sysfs option.
794d23b0f08SMichal Nazarewicz
795664a51a8SAlan Stern	  This driver is an updated replacement for the deprecated
796664a51a8SAlan Stern	  File-backed Storage Gadget (g_file_storage).
797d23b0f08SMichal Nazarewicz
798d23b0f08SMichal Nazarewicz	  Say "y" to link the driver statically, or "m" to build
799664a51a8SAlan Stern	  a dynamically linked module called "g_mass_storage".
800d23b0f08SMichal Nazarewicz
801*c52661d6SSebastian Andrzej Siewiorconfig USB_GADGET_TARGET
802*c52661d6SSebastian Andrzej Siewior	tristate "USB Gadget Target Fabric Module"
803*c52661d6SSebastian Andrzej Siewior	depends on TARGET_CORE
804*c52661d6SSebastian Andrzej Siewior	help
805*c52661d6SSebastian Andrzej Siewior	  This fabric is an USB gadget. Two USB protocols are supported that is
806*c52661d6SSebastian Andrzej Siewior	  BBB or BOT (Bulk Only Transport) and UAS (USB Attached SCSI). BOT is
807*c52661d6SSebastian Andrzej Siewior	  advertised on alternative interface 0 (primary) and UAS is on
808*c52661d6SSebastian Andrzej Siewior	  alternative interface 1. Both protocols can work on USB2.0 and USB3.0.
809*c52661d6SSebastian Andrzej Siewior	  UAS utilizes the USB 3.0 feature called streams support.
810*c52661d6SSebastian Andrzej Siewior
8111da177e4SLinus Torvaldsconfig USB_G_SERIAL
8123086775aSFelipe Balbi	tristate "Serial Gadget (with CDC ACM and CDC OBEX support)"
8131da177e4SLinus Torvalds	help
8141da177e4SLinus Torvalds	  The Serial Gadget talks to the Linux-USB generic serial driver.
8151da177e4SLinus Torvalds	  This driver supports a CDC-ACM module option, which can be used
8161da177e4SLinus Torvalds	  to interoperate with MS-Windows hosts or with the Linux-USB
8171da177e4SLinus Torvalds	  "cdc-acm" driver.
8181da177e4SLinus Torvalds
8193086775aSFelipe Balbi	  This driver also supports a CDC-OBEX option.  You will need a
8203086775aSFelipe Balbi	  user space OBEX server talking to /dev/ttyGS*, since the kernel
8213086775aSFelipe Balbi	  itself doesn't implement the OBEX protocol.
8223086775aSFelipe Balbi
8231da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
8241da177e4SLinus Torvalds	  dynamically linked module called "g_serial".
8251da177e4SLinus Torvalds
8261da177e4SLinus Torvalds	  For more information, see Documentation/usb/gadget_serial.txt
8271da177e4SLinus Torvalds	  which includes instructions and a "driver info file" needed to
8283086775aSFelipe Balbi	  make MS-Windows work with CDC ACM.
8291da177e4SLinus Torvalds
830f2ebf92cSBen Williamsonconfig USB_MIDI_GADGET
831f2ebf92cSBen Williamson	tristate "MIDI Gadget (EXPERIMENTAL)"
832f2ebf92cSBen Williamson	depends on SND && EXPERIMENTAL
833f2ebf92cSBen Williamson	select SND_RAWMIDI
834f2ebf92cSBen Williamson	help
835f2ebf92cSBen Williamson	  The MIDI Gadget acts as a USB Audio device, with one MIDI
836f2ebf92cSBen Williamson	  input and one MIDI output. These MIDI jacks appear as
837f2ebf92cSBen Williamson	  a sound "card" in the ALSA sound system. Other MIDI
838f2ebf92cSBen Williamson	  connections can then be made on the gadget system, using
839f2ebf92cSBen Williamson	  ALSA's aconnect utility etc.
840f2ebf92cSBen Williamson
841f2ebf92cSBen Williamson	  Say "y" to link the driver statically, or "m" to build a
842f2ebf92cSBen Williamson	  dynamically linked module called "g_midi".
843f2ebf92cSBen Williamson
84425a010c8SCraig W. Nadlerconfig USB_G_PRINTER
84525a010c8SCraig W. Nadler	tristate "Printer Gadget"
84625a010c8SCraig W. Nadler	help
84725a010c8SCraig W. Nadler	  The Printer Gadget channels data between the USB host and a
84825a010c8SCraig W. Nadler	  userspace program driving the print engine. The user space
84925a010c8SCraig W. Nadler	  program reads and writes the device file /dev/g_printer to
85025a010c8SCraig W. Nadler	  receive or send printer data. It can use ioctl calls to
85125a010c8SCraig W. Nadler	  the device file to get or set printer status.
85225a010c8SCraig W. Nadler
85325a010c8SCraig W. Nadler	  Say "y" to link the driver statically, or "m" to build a
85425a010c8SCraig W. Nadler	  dynamically linked module called "g_printer".
85525a010c8SCraig W. Nadler
85625a010c8SCraig W. Nadler	  For more information, see Documentation/usb/gadget_printer.txt
85725a010c8SCraig W. Nadler	  which includes sample code for accessing the device file.
8581da177e4SLinus Torvalds
85919e20680SDavid Brownellconfig USB_CDC_COMPOSITE
86019e20680SDavid Brownell	tristate "CDC Composite Device (Ethernet and ACM)"
8614ddd9ec1SRandy Dunlap	depends on NET
86219e20680SDavid Brownell	help
86319e20680SDavid Brownell	  This driver provides two functions in one configuration:
86419e20680SDavid Brownell	  a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link.
86519e20680SDavid Brownell
86619e20680SDavid Brownell	  This driver requires four bulk and two interrupt endpoints,
86719e20680SDavid Brownell	  plus the ability to handle altsettings.  Not all peripheral
86819e20680SDavid Brownell	  controllers are that capable.
86919e20680SDavid Brownell
87019e20680SDavid Brownell	  Say "y" to link the driver statically, or "m" to build a
87119e20680SDavid Brownell	  dynamically linked module.
87219e20680SDavid Brownell
873f358f5b4SFelipe Balbiconfig USB_G_NOKIA
874f358f5b4SFelipe Balbi	tristate "Nokia composite gadget"
875f358f5b4SFelipe Balbi	depends on PHONET
876f358f5b4SFelipe Balbi	help
877f358f5b4SFelipe Balbi	  The Nokia composite gadget provides support for acm, obex
878f358f5b4SFelipe Balbi	  and phonet in only one composite gadget driver.
879f358f5b4SFelipe Balbi
880f358f5b4SFelipe Balbi	  It's only really useful for N900 hardware. If you're building
881f358f5b4SFelipe Balbi	  a kernel for N900, say Y or M here. If unsure, say N.
882f358f5b4SFelipe Balbi
883fa3ae0c1SKlaus Schwarzkopfconfig USB_G_ACM_MS
884fa3ae0c1SKlaus Schwarzkopf	tristate "CDC Composite Device (ACM and mass storage)"
885fa3ae0c1SKlaus Schwarzkopf	depends on BLOCK
886fa3ae0c1SKlaus Schwarzkopf	help
887fa3ae0c1SKlaus Schwarzkopf	  This driver provides two functions in one configuration:
888fa3ae0c1SKlaus Schwarzkopf	  a mass storage, and a CDC ACM (serial port) link.
889fa3ae0c1SKlaus Schwarzkopf
890fa3ae0c1SKlaus Schwarzkopf	  Say "y" to link the driver statically, or "m" to build a
891fa3ae0c1SKlaus Schwarzkopf	  dynamically linked module called "g_acm_ms".
892fa3ae0c1SKlaus Schwarzkopf
893f176a5d8SMichal Nazarewiczconfig USB_G_MULTI
894f176a5d8SMichal Nazarewicz	tristate "Multifunction Composite Gadget (EXPERIMENTAL)"
8955791e103SRandy Dunlap	depends on BLOCK && NET
896279cc49aSMichal Nazarewicz	select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS
897f176a5d8SMichal Nazarewicz	help
898f176a5d8SMichal Nazarewicz	  The Multifunction Composite Gadget provides Ethernet (RNDIS
899f176a5d8SMichal Nazarewicz	  and/or CDC Ethernet), mass storage and ACM serial link
900f176a5d8SMichal Nazarewicz	  interfaces.
901f176a5d8SMichal Nazarewicz
9025791e103SRandy Dunlap	  You will be asked to choose which of the two configurations is
903f176a5d8SMichal Nazarewicz	  to be available in the gadget.  At least one configuration must
9045791e103SRandy Dunlap	  be chosen to make the gadget usable.  Selecting more than one
905f176a5d8SMichal Nazarewicz	  configuration will prevent Windows from automatically detecting
9065791e103SRandy Dunlap	  the gadget as a composite gadget, so an INF file will be needed to
907f176a5d8SMichal Nazarewicz	  use the gadget.
908f176a5d8SMichal Nazarewicz
909f176a5d8SMichal Nazarewicz	  Say "y" to link the driver statically, or "m" to build a
910f176a5d8SMichal Nazarewicz	  dynamically linked module called "g_multi".
911f176a5d8SMichal Nazarewicz
912f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_RNDIS
913f176a5d8SMichal Nazarewicz	bool "RNDIS + CDC Serial + Storage configuration"
914f176a5d8SMichal Nazarewicz	depends on USB_G_MULTI
915f176a5d8SMichal Nazarewicz	default y
916f176a5d8SMichal Nazarewicz	help
917f176a5d8SMichal Nazarewicz	  This option enables a configuration with RNDIS, CDC Serial and
918f176a5d8SMichal Nazarewicz	  Mass Storage functions available in the Multifunction Composite
9195791e103SRandy Dunlap	  Gadget.  This is the configuration dedicated for Windows since RNDIS
9205791e103SRandy Dunlap	  is Microsoft's protocol.
921f176a5d8SMichal Nazarewicz
922f176a5d8SMichal Nazarewicz	  If unsure, say "y".
923f176a5d8SMichal Nazarewicz
924f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_CDC
925f176a5d8SMichal Nazarewicz	bool "CDC Ethernet + CDC Serial + Storage configuration"
926f176a5d8SMichal Nazarewicz	depends on USB_G_MULTI
927f176a5d8SMichal Nazarewicz	default n
928f176a5d8SMichal Nazarewicz	help
929f176a5d8SMichal Nazarewicz	  This option enables a configuration with CDC Ethernet (ECM), CDC
930f176a5d8SMichal Nazarewicz	  Serial and Mass Storage functions available in the Multifunction
9315791e103SRandy Dunlap	  Composite Gadget.
932f176a5d8SMichal Nazarewicz
933f176a5d8SMichal Nazarewicz	  If unsure, say "y".
934f176a5d8SMichal Nazarewicz
93571adf118SFabien Chouteauconfig USB_G_HID
93671adf118SFabien Chouteau	tristate "HID Gadget"
93771adf118SFabien Chouteau	help
93871adf118SFabien Chouteau	  The HID gadget driver provides generic emulation of USB
93971adf118SFabien Chouteau	  Human Interface Devices (HID).
94071adf118SFabien Chouteau
94171adf118SFabien Chouteau	  For more information, see Documentation/usb/gadget_hid.txt which
94271adf118SFabien Chouteau	  includes sample code for accessing the device files.
94371adf118SFabien Chouteau
94471adf118SFabien Chouteau	  Say "y" to link the driver statically, or "m" to build a
94571adf118SFabien Chouteau	  dynamically linked module called "g_hid".
946f176a5d8SMichal Nazarewicz
947f6c826a9Sstephane duvergerconfig USB_G_DBGP
948f6c826a9Sstephane duverger	tristate "EHCI Debug Device Gadget"
949f6c826a9Sstephane duverger	help
950f6c826a9Sstephane duverger	  This gadget emulates an EHCI Debug device. This is useful when you want
951f6c826a9Sstephane duverger	  to interact with an EHCI Debug Port.
952f6c826a9Sstephane duverger
953f6c826a9Sstephane duverger	  Say "y" to link the driver statically, or "m" to build a
954f6c826a9Sstephane duverger	  dynamically linked module called "g_dbgp".
955f6c826a9Sstephane duverger
956f6c826a9Sstephane duvergerif USB_G_DBGP
957f6c826a9Sstephane duvergerchoice
958f6c826a9Sstephane duverger	prompt "EHCI Debug Device mode"
959f6c826a9Sstephane duverger	default USB_G_DBGP_SERIAL
960f6c826a9Sstephane duverger
961f6c826a9Sstephane duvergerconfig USB_G_DBGP_PRINTK
962f6c826a9Sstephane duverger	depends on USB_G_DBGP
963f6c826a9Sstephane duverger	bool "printk"
964f6c826a9Sstephane duverger	help
965f6c826a9Sstephane duverger	  Directly printk() received data. No interaction.
966f6c826a9Sstephane duverger
967f6c826a9Sstephane duvergerconfig USB_G_DBGP_SERIAL
968f6c826a9Sstephane duverger	depends on USB_G_DBGP
969f6c826a9Sstephane duverger	bool "serial"
970f6c826a9Sstephane duverger	help
971f6c826a9Sstephane duverger	  Userland can interact using /dev/ttyGSxxx.
972f6c826a9Sstephane duvergerendchoice
973f6c826a9Sstephane duvergerendif
974f6c826a9Sstephane duverger
9751da177e4SLinus Torvalds# put drivers that need isochronous transfer support (for audio
9761da177e4SLinus Torvalds# or video class gadget drivers), or specific hardware, here.
977a9914127SLaurent Pinchartconfig USB_G_WEBCAM
978a9914127SLaurent Pinchart	tristate "USB Webcam Gadget"
97924337c13SRandy Dunlap	depends on VIDEO_DEV
980a9914127SLaurent Pinchart	help
981a9914127SLaurent Pinchart	  The Webcam Gadget acts as a composite USB Audio and Video Class
982a9914127SLaurent Pinchart	  device. It provides a userspace API to process UVC control requests
983a9914127SLaurent Pinchart	  and stream video data to the host.
9841da177e4SLinus Torvalds
985a9914127SLaurent Pinchart	  Say "y" to link the driver statically, or "m" to build a
986a9914127SLaurent Pinchart	  dynamically linked module called "g_webcam".
9871da177e4SLinus Torvalds
9881da177e4SLinus Torvaldsendchoice
9891da177e4SLinus Torvalds
990b75be4abSDenis Chengendif # USB_GADGET
991