xref: /openbmc/linux/drivers/usb/gadget/Kconfig (revision 5273afe3)
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#
126ed6c6f41SAlexander Shishkinmenu "USB Peripheral Controller"
1271da177e4SLinus Torvalds
128a7a19facSDavid Brownell#
129a7a19facSDavid Brownell# Integrated controllers
130a7a19facSDavid Brownell#
131a7a19facSDavid Brownell
132193ab2a6SFelipe Balbiconfig USB_AT91
133193ab2a6SFelipe Balbi	tristate "Atmel AT91 USB Device Port"
134d1494a34SJean-Christophe PLAGNIOL-VILLARD	depends on ARCH_AT91
13555d402d8SThomas Dahlmann	help
136a7a19facSDavid Brownell	   Many Atmel AT91 processors (such as the AT91RM2000) have a
137a7a19facSDavid Brownell	   full speed USB Device Port with support for five configurable
138a7a19facSDavid Brownell	   endpoints (plus endpoint zero).
13955d402d8SThomas Dahlmann
14055d402d8SThomas Dahlmann	   Say "y" to link the driver statically, or "m" to build a
141a7a19facSDavid Brownell	   dynamically linked module called "at91_udc" and force all
14255d402d8SThomas Dahlmann	   gadget drivers to also be dynamically linked.
14355d402d8SThomas Dahlmann
14424a28e42SRoland Stiggeconfig USB_LPC32XX
14524a28e42SRoland Stigge	tristate "LPC32XX USB Peripheral Controller"
14624a28e42SRoland Stigge	depends on ARCH_LPC32XX
14724a28e42SRoland Stigge	select USB_ISP1301
14824a28e42SRoland Stigge	help
14924a28e42SRoland Stigge	   This option selects the USB device controller in the LPC32xx SoC.
15024a28e42SRoland Stigge
15124a28e42SRoland Stigge	   Say "y" to link the driver statically, or "m" to build a
15224a28e42SRoland Stigge	   dynamically linked module called "lpc32xx_udc" and force all
15324a28e42SRoland Stigge	   gadget drivers to also be dynamically linked.
15424a28e42SRoland Stigge
155193ab2a6SFelipe Balbiconfig USB_ATMEL_USBA
156193ab2a6SFelipe Balbi	tristate "Atmel USBA"
1579918ceafSJean-Christophe PLAGNIOL-VILLARD	depends on AVR32 || ARCH_AT91SAM9RL || ARCH_AT91SAM9G45
158914a3f3bSHaavard Skinnemoen	help
159914a3f3bSHaavard Skinnemoen	  USBA is the integrated high-speed USB Device controller on
160ba45ca43SNicolas Ferre	  the AT32AP700x, some AT91SAM9 and AT91CAP9 processors from Atmel.
161914a3f3bSHaavard Skinnemoen
162613065e5SKevin Cernekeeconfig USB_BCM63XX_UDC
163613065e5SKevin Cernekee	tristate "Broadcom BCM63xx Peripheral Controller"
164613065e5SKevin Cernekee	depends on BCM63XX
165613065e5SKevin Cernekee	help
166613065e5SKevin Cernekee	   Many Broadcom BCM63xx chipsets (such as the BCM6328) have a
167613065e5SKevin Cernekee	   high speed USB Device Port with support for four fixed endpoints
168613065e5SKevin Cernekee	   (plus endpoint zero).
169613065e5SKevin Cernekee
170613065e5SKevin Cernekee	   Say "y" to link the driver statically, or "m" to build a
171613065e5SKevin Cernekee	   dynamically linked module called "bcm63xx_udc".
172613065e5SKevin Cernekee
173193ab2a6SFelipe Balbiconfig USB_FSL_USB2
174193ab2a6SFelipe Balbi	tristate "Freescale Highspeed USB DR Peripheral Controller"
17554e4026bSGuennadi Liakhovetski	depends on FSL_SOC || ARCH_MXC
176018b97d0SMarc Kleine-Budde	select USB_FSL_MPH_DR_OF if OF
177b504882dSLi Yang	help
17800c16f9fSFabio Estevam	   Some of Freescale PowerPC and i.MX processors have a High Speed
179b504882dSLi Yang	   Dual-Role(DR) USB controller, which supports device mode.
180b504882dSLi Yang
181b504882dSLi Yang	   The number of programmable endpoints is different through
182b504882dSLi Yang	   SOC revisions.
183b504882dSLi Yang
184b504882dSLi Yang	   Say "y" to link the driver statically, or "m" to build a
185b504882dSLi Yang	   dynamically linked module called "fsl_usb2_udc" and force
186b504882dSLi Yang	   all gadget drivers to also be dynamically linked.
187b504882dSLi Yang
188193ab2a6SFelipe Balbiconfig USB_FUSB300
189193ab2a6SFelipe Balbi	tristate "Faraday FUSB300 USB Peripheral Controller"
190ac17317dSSebastian Andrzej Siewior	depends on !PHYS_ADDR_T_64BIT
1910fe6f1d1SYuan-Hsin Chen	help
1920fe6f1d1SYuan-Hsin Chen	   Faraday usb device controller FUSB300 driver
1930fe6f1d1SYuan-Hsin Chen
194193ab2a6SFelipe Balbiconfig USB_OMAP
195193ab2a6SFelipe Balbi	tristate "OMAP USB Device Controller"
196b924b204STony Lindgren	depends on ARCH_OMAP1
197f1c9e151STony Lindgren	select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3 || MACH_OMAP_H4_OTG
19854b9ed35SDavid Brownell	select USB_OTG_UTILS if ARCH_OMAP
1991da177e4SLinus Torvalds	help
2001da177e4SLinus Torvalds	   Many Texas Instruments OMAP processors have flexible full
2011da177e4SLinus Torvalds	   speed USB device controllers, with support for up to 30
2021da177e4SLinus Torvalds	   endpoints (plus endpoint zero).  This driver supports the
2031da177e4SLinus Torvalds	   controller in the OMAP 1611, and should work with controllers
2041da177e4SLinus Torvalds	   in other OMAP processors too, given minor tweaks.
2051da177e4SLinus Torvalds
2061da177e4SLinus Torvalds	   Say "y" to link the driver statically, or "m" to build a
2071da177e4SLinus Torvalds	   dynamically linked module called "omap_udc" and force all
2081da177e4SLinus Torvalds	   gadget drivers to also be dynamically linked.
2091da177e4SLinus Torvalds
210193ab2a6SFelipe Balbiconfig USB_PXA25X
211193ab2a6SFelipe Balbi	tristate "PXA 25x or IXP 4xx"
212a7a19facSDavid Brownell	depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX
21309963911SRussell King	select USB_OTG_UTILS
214a7a19facSDavid Brownell	help
215a7a19facSDavid Brownell	   Intel's PXA 25x series XScale ARM-5TE processors include
216a7a19facSDavid Brownell	   an integrated full speed USB 1.1 device controller.  The
217a7a19facSDavid Brownell	   controller in the IXP 4xx series is register-compatible.
218a7a19facSDavid Brownell
219a7a19facSDavid Brownell	   It has fifteen fixed-function endpoints, as well as endpoint
220a7a19facSDavid Brownell	   zero (for control transfers).
221a7a19facSDavid Brownell
222a7a19facSDavid Brownell	   Say "y" to link the driver statically, or "m" to build a
223a7a19facSDavid Brownell	   dynamically linked module called "pxa25x_udc" and force all
224a7a19facSDavid Brownell	   gadget drivers to also be dynamically linked.
225a7a19facSDavid Brownell
226a7a19facSDavid Brownell# if there's only one gadget driver, using only two bulk endpoints,
227a7a19facSDavid Brownell# don't waste memory for the other endpoints
228a7a19facSDavid Brownellconfig USB_PXA25X_SMALL
229193ab2a6SFelipe Balbi	depends on USB_PXA25X
230a7a19facSDavid Brownell	bool
231a7a19facSDavid Brownell	default n if USB_ETH_RNDIS
232a7a19facSDavid Brownell	default y if USB_ZERO
233a7a19facSDavid Brownell	default y if USB_ETH
234a7a19facSDavid Brownell	default y if USB_G_SERIAL
235a7a19facSDavid Brownell
236193ab2a6SFelipe Balbiconfig USB_R8A66597
237193ab2a6SFelipe Balbi	tristate "Renesas R8A66597 USB Peripheral Controller"
238c4144247SYoshihiro Shimoda	help
239c4144247SYoshihiro Shimoda	   R8A66597 is a discrete USB host and peripheral controller chip that
240c4144247SYoshihiro Shimoda	   supports both full and high speed USB 2.0 data transfers.
241c4144247SYoshihiro Shimoda	   It has nine configurable endpoints, and endpoint zero.
242c4144247SYoshihiro Shimoda
243c4144247SYoshihiro Shimoda	   Say "y" to link the driver statically, or "m" to build a
244c4144247SYoshihiro Shimoda	   dynamically linked module called "r8a66597_udc" and force all
245c4144247SYoshihiro Shimoda	   gadget drivers to also be dynamically linked.
246c4144247SYoshihiro Shimoda
247030ed1fcSKuninori Morimotoconfig USB_RENESAS_USBHS_UDC
248193ab2a6SFelipe Balbi	tristate 'Renesas USBHS controller'
249030ed1fcSKuninori Morimoto	depends on USB_RENESAS_USBHS
2502f98382dSKuninori Morimoto	help
251193ab2a6SFelipe Balbi	   Renesas USBHS is a discrete USB host and peripheral controller chip
252193ab2a6SFelipe Balbi	   that supports both full and high speed USB 2.0 data transfers.
253193ab2a6SFelipe Balbi	   It has nine or more configurable endpoints, and endpoint zero.
2542f98382dSKuninori Morimoto
255193ab2a6SFelipe Balbi	   Say "y" to link the driver statically, or "m" to build a
256193ab2a6SFelipe Balbi	   dynamically linked module called "renesas_usbhs" and force all
257193ab2a6SFelipe Balbi	   gadget drivers to also be dynamically linked.
2582f98382dSKuninori Morimoto
259193ab2a6SFelipe Balbiconfig USB_PXA27X
260193ab2a6SFelipe Balbi	tristate "PXA 27x"
2619f5351b7SRobert Jarzmik	depends on ARCH_PXA && (PXA27x || PXA3xx)
2627fec3c25SRobert Jarzmik	select USB_OTG_UTILS
263a7a19facSDavid Brownell	help
264a7a19facSDavid Brownell	   Intel's PXA 27x series XScale ARM v5TE processors include
265a7a19facSDavid Brownell	   an integrated full speed USB 1.1 device controller.
266a7a19facSDavid Brownell
267a7a19facSDavid Brownell	   It has up to 23 endpoints, as well as endpoint zero (for
268a7a19facSDavid Brownell	   control transfers).
269a7a19facSDavid Brownell
270a7a19facSDavid Brownell	   Say "y" to link the driver statically, or "m" to build a
271a7a19facSDavid Brownell	   dynamically linked module called "pxa27x_udc" and force all
272a7a19facSDavid Brownell	   gadget drivers to also be dynamically linked.
273a7a19facSDavid Brownell
274193ab2a6SFelipe Balbiconfig USB_S3C_HSOTG
275193ab2a6SFelipe Balbi	tristate "S3C HS/OtG USB Device controller"
2765b7d70c6SBen Dooks	depends on S3C_DEV_USB_HSOTG
2775b7d70c6SBen Dooks	help
2785b7d70c6SBen Dooks	  The Samsung S3C64XX USB2.0 high-speed gadget controller
2795b7d70c6SBen Dooks	  integrated into the S3C64XX series SoC.
2805b7d70c6SBen Dooks
281193ab2a6SFelipe Balbiconfig USB_IMX
2822e5a08a3SSascha Hauer	tristate "Freescale i.MX1 USB Peripheral Controller"
2832e5a08a3SSascha Hauer	depends on ARCH_MXC
2849662ced3SFelipe Balbi	depends on BROKEN
285c03e7d4bSPaulius Zaleckas	help
2862e5a08a3SSascha Hauer	   Freescale's i.MX1 includes an integrated full speed
2872e5a08a3SSascha Hauer	   USB 1.1 device controller.
288c03e7d4bSPaulius Zaleckas
289c03e7d4bSPaulius Zaleckas	   It has Six fixed-function endpoints, as well as endpoint
290c03e7d4bSPaulius Zaleckas	   zero (for control transfers).
291c03e7d4bSPaulius Zaleckas
292c03e7d4bSPaulius Zaleckas	   Say "y" to link the driver statically, or "m" to build a
293c03e7d4bSPaulius Zaleckas	   dynamically linked module called "imx_udc" and force all
294c03e7d4bSPaulius Zaleckas	   gadget drivers to also be dynamically linked.
295c03e7d4bSPaulius Zaleckas
296193ab2a6SFelipe Balbiconfig USB_S3C2410
297193ab2a6SFelipe Balbi	tristate "S3C2410 USB Device Controller"
298b130d5c2SKukjin Kim	depends on ARCH_S3C24XX
2993fc154b6SArnaud Patard	help
3003fc154b6SArnaud Patard	  Samsung's S3C2410 is an ARM-4 processor with an integrated
3013fc154b6SArnaud Patard	  full speed USB 1.1 device controller.  It has 4 configurable
3023fc154b6SArnaud Patard	  endpoints, as well as endpoint zero (for control transfers).
3033fc154b6SArnaud Patard
3043fc154b6SArnaud Patard	  This driver has been tested on the S3C2410, S3C2412, and
3053fc154b6SArnaud Patard	  S3C2440 processors.
3063fc154b6SArnaud Patard
3073fc154b6SArnaud Patardconfig USB_S3C2410_DEBUG
3083fc154b6SArnaud Patard	boolean "S3C2410 udc debug messages"
309193ab2a6SFelipe Balbi	depends on USB_S3C2410
3103fc154b6SArnaud Patard
311193ab2a6SFelipe Balbiconfig USB_S3C_HSUDC
312193ab2a6SFelipe Balbi	tristate "S3C2416, S3C2443 and S3C2450 USB Device Controller"
313b130d5c2SKukjin Kim	depends on ARCH_S3C24XX
314a9df304cSThomas Abraham	help
315a9df304cSThomas Abraham	  Samsung's S3C2416, S3C2443 and S3C2450 is an ARM9 based SoC
316a9df304cSThomas Abraham	  integrated with dual speed USB 2.0 device controller. It has
317a9df304cSThomas Abraham	  8 endpoints, as well as endpoint zero.
318a9df304cSThomas Abraham
319a9df304cSThomas Abraham	  This driver has been tested on S3C2416 and S3C2450 processors.
320a9df304cSThomas Abraham
3215e6c86b0SNeil Zhangconfig USB_MV_UDC
3225e6c86b0SNeil Zhang	tristate "Marvell USB2.0 Device Controller"
323*5273afe3SHeiko Carstens	depends on GENERIC_HARDIRQS
324e7cddda4Scxie4	help
3255e6c86b0SNeil Zhang	  Marvell Socs (including PXA and MMP series) include a high speed
3265e6c86b0SNeil Zhang	  USB2.0 OTG controller, which can be configured as high speed or
3275e6c86b0SNeil Zhang	  full speed USB peripheral.
32872246da4SFelipe Balbi
3293d4eb9dfSYu Xuconfig USB_MV_U3D
3303d4eb9dfSYu Xu	tristate "MARVELL PXA2128 USB 3.0 controller"
3313d4eb9dfSYu Xu	depends on CPU_MMP3
3323d4eb9dfSYu Xu	select USB_GADGET_DUALSPEED
3333d4eb9dfSYu Xu	select USB_GADGET_SUPERSPEED
3343d4eb9dfSYu Xu	help
3353d4eb9dfSYu Xu	  MARVELL PXA2128 Processor series include a super speed USB3.0 device
3363d4eb9dfSYu Xu	  controller, which support super speed USB peripheral.
3373d4eb9dfSYu Xu
338a7a19facSDavid Brownell#
339a7a19facSDavid Brownell# Controllers available in both integrated and discrete versions
340a7a19facSDavid Brownell#
341a7a19facSDavid Brownell
342a7a19facSDavid Brownell# musb builds in ../musb along with host support
343a7a19facSDavid Brownellconfig USB_GADGET_MUSB_HDRC
344193ab2a6SFelipe Balbi	tristate "Inventra HDRC USB Peripheral (TI, ADI, ...)"
345b61ae342SRabin Vincent	depends on USB_MUSB_HDRC
346bae4bd84SDavid Brownell	help
347a7a19facSDavid Brownell	  This OTG-capable silicon IP is used in dual designs including
348085ad406SBryan Wu	  the TI DaVinci, OMAP 243x, OMAP 343x, TUSB 6010, and ADI Blackfin
349a7a19facSDavid Brownell
350193ab2a6SFelipe Balbiconfig USB_M66592
351193ab2a6SFelipe Balbi	tristate "Renesas M66592 USB Peripheral Controller"
352a7a19facSDavid Brownell	help
353a7a19facSDavid Brownell	   M66592 is a discrete USB peripheral controller chip that
354a7a19facSDavid Brownell	   supports both full and high speed USB 2.0 data transfers.
355a7a19facSDavid Brownell	   It has seven configurable endpoints, and endpoint zero.
356bae4bd84SDavid Brownell
357bae4bd84SDavid Brownell	   Say "y" to link the driver statically, or "m" to build a
358a7a19facSDavid Brownell	   dynamically linked module called "m66592_udc" and force all
359bae4bd84SDavid Brownell	   gadget drivers to also be dynamically linked.
360bae4bd84SDavid Brownell
361a7a19facSDavid Brownell#
362a7a19facSDavid Brownell# Controllers available only in discrete form (and all PCI controllers)
363a7a19facSDavid Brownell#
364a7a19facSDavid Brownell
365193ab2a6SFelipe Balbiconfig USB_AMD5536UDC
366193ab2a6SFelipe Balbi	tristate "AMD5536 UDC"
367a7a19facSDavid Brownell	depends on PCI
368a7a19facSDavid Brownell	help
369a7a19facSDavid Brownell	   The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
370a7a19facSDavid Brownell	   It is a USB Highspeed DMA capable USB device controller. Beside ep0
371a7a19facSDavid Brownell	   it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
372a7a19facSDavid Brownell	   The UDC port supports OTG operation, and may be used as a host port
373a7a19facSDavid Brownell	   if it's not being used to implement peripheral or OTG roles.
374a7a19facSDavid Brownell
375a7a19facSDavid Brownell	   Say "y" to link the driver statically, or "m" to build a
376a7a19facSDavid Brownell	   dynamically linked module called "amd5536udc" and force all
377a7a19facSDavid Brownell	   gadget drivers to also be dynamically linked.
378a7a19facSDavid Brownell
379193ab2a6SFelipe Balbiconfig USB_FSL_QE
380193ab2a6SFelipe Balbi	tristate "Freescale QE/CPM USB Device Controller"
3813948f0e0SLi Yang	depends on FSL_SOC && (QUICC_ENGINE || CPM)
3823948f0e0SLi Yang	help
3833948f0e0SLi Yang	   Some of Freescale PowerPC processors have a Full Speed
3843948f0e0SLi Yang	   QE/CPM2 USB controller, which support device mode with 4
3853948f0e0SLi Yang	   programmable endpoints. This driver supports the
3863948f0e0SLi Yang	   controller in the MPC8360 and MPC8272, and should work with
3873948f0e0SLi Yang	   controllers having QE or CPM2, given minor tweaks.
3883948f0e0SLi Yang
3893948f0e0SLi Yang	   Set CONFIG_USB_GADGET to "m" to build this driver as a
390692105b8SMatt LaPlante	   dynamically linked module called "fsl_qe_udc".
3913948f0e0SLi Yang
392193ab2a6SFelipe Balbiconfig USB_NET2272
393193ab2a6SFelipe Balbi	tristate "PLX NET2272"
394ceb80363SSeth Levy	help
395ceb80363SSeth Levy	  PLX NET2272 is a USB peripheral controller which supports
396ceb80363SSeth Levy	  both full and high speed USB 2.0 data transfers.
397ceb80363SSeth Levy
398ceb80363SSeth Levy	  It has three configurable endpoints, as well as endpoint zero
399ceb80363SSeth Levy	  (for control transfer).
400ceb80363SSeth Levy	  Say "y" to link the driver statically, or "m" to build a
401ceb80363SSeth Levy	  dynamically linked module called "net2272" and force all
402ceb80363SSeth Levy	  gadget drivers to also be dynamically linked.
403ceb80363SSeth Levy
404193ab2a6SFelipe Balbiconfig USB_NET2272_DMA
405ceb80363SSeth Levy	boolean "Support external DMA controller"
406193ab2a6SFelipe Balbi	depends on USB_NET2272
407ceb80363SSeth Levy	help
408ceb80363SSeth Levy	  The NET2272 part can optionally support an external DMA
409ceb80363SSeth Levy	  controller, but your board has to have support in the
410ceb80363SSeth Levy	  driver itself.
411ceb80363SSeth Levy
412ceb80363SSeth Levy	  If unsure, say "N" here.  The driver works fine in PIO mode.
413ceb80363SSeth Levy
414193ab2a6SFelipe Balbiconfig USB_NET2280
415193ab2a6SFelipe Balbi	tristate "NetChip 228x"
416a7a19facSDavid Brownell	depends on PCI
417a7a19facSDavid Brownell	help
418a7a19facSDavid Brownell	   NetChip 2280 / 2282 is a PCI based USB peripheral controller which
419a7a19facSDavid Brownell	   supports both full and high speed USB 2.0 data transfers.
420a7a19facSDavid Brownell
421a7a19facSDavid Brownell	   It has six configurable endpoints, as well as endpoint zero
422a7a19facSDavid Brownell	   (for control transfers) and several endpoints with dedicated
423a7a19facSDavid Brownell	   functions.
424a7a19facSDavid Brownell
425a7a19facSDavid Brownell	   Say "y" to link the driver statically, or "m" to build a
426a7a19facSDavid Brownell	   dynamically linked module called "net2280" and force all
427a7a19facSDavid Brownell	   gadget drivers to also be dynamically linked.
428a7a19facSDavid Brownell
429193ab2a6SFelipe Balbiconfig USB_GOKU
430193ab2a6SFelipe Balbi	tristate "Toshiba TC86C001 'Goku-S'"
431a7a19facSDavid Brownell	depends on PCI
432a7a19facSDavid Brownell	help
433a7a19facSDavid Brownell	   The Toshiba TC86C001 is a PCI device which includes controllers
434a7a19facSDavid Brownell	   for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
435a7a19facSDavid Brownell
436a7a19facSDavid Brownell	   The device controller has three configurable (bulk or interrupt)
437a7a19facSDavid Brownell	   endpoints, plus endpoint zero (for control transfers).
438a7a19facSDavid Brownell
439a7a19facSDavid Brownell	   Say "y" to link the driver statically, or "m" to build a
440a7a19facSDavid Brownell	   dynamically linked module called "goku_udc" and to force all
441a7a19facSDavid Brownell	   gadget drivers to also be dynamically linked.
442a7a19facSDavid Brownell
443193ab2a6SFelipe Balbiconfig USB_EG20T
444731ad81eSTomoya MORINAGA	tristate "Intel EG20T PCH/LAPIS Semiconductor IOH(ML7213/ML7831) UDC"
445*5273afe3SHeiko Carstens	depends on PCI && GENERIC_HARDIRQS
446f646cf94SToshiharu Okada	help
447f646cf94SToshiharu Okada	  This is a USB device driver for EG20T PCH.
448f646cf94SToshiharu Okada	  EG20T PCH is the platform controller hub that is used in Intel's
449f646cf94SToshiharu Okada	  general embedded platform. EG20T PCH has USB device interface.
450f646cf94SToshiharu Okada	  Using this interface, it is able to access system devices connected
451f646cf94SToshiharu Okada	  to USB device.
452f646cf94SToshiharu Okada	  This driver enables USB device function.
453f646cf94SToshiharu Okada	  USB device is a USB peripheral controller which
454f646cf94SToshiharu Okada	  supports both full and high speed USB 2.0 data transfers.
455f646cf94SToshiharu Okada	  This driver supports both control transfer and bulk transfer modes.
456f646cf94SToshiharu Okada	  This driver dose not support interrupt transfer or isochronous
457f646cf94SToshiharu Okada	  transfer modes.
458f646cf94SToshiharu Okada
459731ad81eSTomoya MORINAGA	  This driver also can be used for LAPIS Semiconductor's ML7213 which is
46006f1b971STomoya MORINAGA	  for IVI(In-Vehicle Infotainment) use.
461731ad81eSTomoya MORINAGA	  ML7831 is for general purpose use.
462731ad81eSTomoya MORINAGA	  ML7213/ML7831 is companion chip for Intel Atom E6xx series.
463731ad81eSTomoya MORINAGA	  ML7213/ML7831 is completely compatible for Intel EG20T PCH.
46406f1b971STomoya MORINAGA
465a7a19facSDavid Brownell#
466a7a19facSDavid Brownell# LAST -- dummy/emulated controller
467a7a19facSDavid Brownell#
4681da177e4SLinus Torvalds
469193ab2a6SFelipe Balbiconfig USB_DUMMY_HCD
470193ab2a6SFelipe Balbi	tristate "Dummy HCD (DEVELOPMENT)"
471afd0e0f2SRobert P. J. Day	depends on USB=y || (USB=m && USB_GADGET=m)
4721da177e4SLinus Torvalds	help
4731da177e4SLinus Torvalds	  This host controller driver emulates USB, looping all data transfer
4741da177e4SLinus Torvalds	  requests back to a USB "gadget driver" in the same host.  The host
4751da177e4SLinus Torvalds	  side is the master; the gadget side is the slave.  Gadget drivers
4761da177e4SLinus Torvalds	  can be high, full, or low speed; and they have access to endpoints
4771da177e4SLinus Torvalds	  like those from NET2280, PXA2xx, or SA1100 hardware.
4781da177e4SLinus Torvalds
4791da177e4SLinus Torvalds	  This may help in some stages of creating a driver to embed in a
4801da177e4SLinus Torvalds	  Linux device, since it lets you debug several parts of the gadget
4811da177e4SLinus Torvalds	  driver without its hardware or drivers being involved.
4821da177e4SLinus Torvalds
4831da177e4SLinus Torvalds	  Since such a gadget side driver needs to interoperate with a host
4841da177e4SLinus Torvalds	  side Linux-USB device driver, this may help to debug both sides
4851da177e4SLinus Torvalds	  of a USB protocol stack.
4861da177e4SLinus Torvalds
4871da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
4881da177e4SLinus Torvalds	  dynamically linked module called "dummy_hcd" and force all
4891da177e4SLinus Torvalds	  gadget drivers to also be dynamically linked.
4901da177e4SLinus Torvalds
4911da177e4SLinus Torvalds# NOTE:  Please keep dummy_hcd LAST so that "real hardware" appears
4921da177e4SLinus Torvalds# first and will be selected by default.
4931da177e4SLinus Torvalds
494ed6c6f41SAlexander Shishkinendmenu
4951da177e4SLinus Torvalds
4961da177e4SLinus Torvalds#
4971da177e4SLinus Torvalds# USB Gadget Drivers
4981da177e4SLinus Torvalds#
499a84d9e53SSebastian Andrzej Siewior
500a84d9e53SSebastian Andrzej Siewior# composite based drivers
501a84d9e53SSebastian Andrzej Siewiorconfig USB_LIBCOMPOSITE
502a84d9e53SSebastian Andrzej Siewior	tristate
503a84d9e53SSebastian Andrzej Siewior	depends on USB_GADGET
504a84d9e53SSebastian Andrzej Siewior
505ff47f594SSebastian Andrzej Siewiorconfig USB_F_ACM
506ff47f594SSebastian Andrzej Siewior	tristate
507ff47f594SSebastian Andrzej Siewior
508cf9a08aeSSebastian Andrzej Siewiorconfig USB_F_SS_LB
509cf9a08aeSSebastian Andrzej Siewior	tristate
510cf9a08aeSSebastian Andrzej Siewior
5113249ca22SSebastian Andrzej Siewiorconfig USB_U_SERIAL
5123249ca22SSebastian Andrzej Siewior	tristate
5133249ca22SSebastian Andrzej Siewior
5141da177e4SLinus Torvaldschoice
5151da177e4SLinus Torvalds	tristate "USB Gadget Drivers"
5161da177e4SLinus Torvalds	default USB_ETH
5171da177e4SLinus Torvalds	help
5181da177e4SLinus Torvalds	  A Linux "Gadget Driver" talks to the USB Peripheral Controller
5191da177e4SLinus Torvalds	  driver through the abstract "gadget" API.  Some other operating
5201da177e4SLinus Torvalds	  systems call these "client" drivers, of which "class drivers"
5211da177e4SLinus Torvalds	  are a subset (implementing a USB device class specification).
5221da177e4SLinus Torvalds	  A gadget driver implements one or more USB functions using
5231da177e4SLinus Torvalds	  the peripheral hardware.
5241da177e4SLinus Torvalds
5251da177e4SLinus Torvalds	  Gadget drivers are hardware-neutral, or "platform independent",
5261da177e4SLinus Torvalds	  except that they sometimes must understand quirks or limitations
5271da177e4SLinus Torvalds	  of the particular controllers they work with.  For example, when
5281da177e4SLinus Torvalds	  a controller doesn't support alternate configurations or provide
5291da177e4SLinus Torvalds	  enough of the right types of endpoints, the gadget driver might
5301da177e4SLinus Torvalds	  not be able work with that controller, or might need to implement
5311da177e4SLinus Torvalds	  a less common variant of a device class protocol.
5321da177e4SLinus Torvalds
5331da177e4SLinus Torvalds# this first set of drivers all depend on bulk-capable hardware.
5341da177e4SLinus Torvalds
5351da177e4SLinus Torvaldsconfig USB_ZERO
5361da177e4SLinus Torvalds	tristate "Gadget Zero (DEVELOPMENT)"
537a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
538cf9a08aeSSebastian Andrzej Siewior	select USB_F_SS_LB
5391da177e4SLinus Torvalds	help
5401da177e4SLinus Torvalds	  Gadget Zero is a two-configuration device.  It either sinks and
5411da177e4SLinus Torvalds	  sources bulk data; or it loops back a configurable number of
5421da177e4SLinus Torvalds	  transfers.  It also implements control requests, for "chapter 9"
5431da177e4SLinus Torvalds	  conformance.  The driver needs only two bulk-capable endpoints, so
5441da177e4SLinus Torvalds	  it can work on top of most device-side usb controllers.  It's
5451da177e4SLinus Torvalds	  useful for testing, and is also a working example showing how
5461da177e4SLinus Torvalds	  USB "gadget drivers" can be written.
5471da177e4SLinus Torvalds
5481da177e4SLinus Torvalds	  Make this be the first driver you try using on top of any new
5491da177e4SLinus Torvalds	  USB peripheral controller driver.  Then you can use host-side
5501da177e4SLinus Torvalds	  test software, like the "usbtest" driver, to put your hardware
5511da177e4SLinus Torvalds	  and its driver through a basic set of functional tests.
5521da177e4SLinus Torvalds
5531da177e4SLinus Torvalds	  Gadget Zero also works with the host-side "usb-skeleton" driver,
5541da177e4SLinus Torvalds	  and with many kinds of host-side test software.  You may need
5551da177e4SLinus Torvalds	  to tweak product and vendor IDs before host software knows about
5561da177e4SLinus Torvalds	  this device, and arrange to select an appropriate configuration.
5571da177e4SLinus Torvalds
5581da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
5591da177e4SLinus Torvalds	  dynamically linked module called "g_zero".
5601da177e4SLinus Torvalds
5611da177e4SLinus Torvaldsconfig USB_ZERO_HNPTEST
5621da177e4SLinus Torvalds	boolean "HNP Test Device"
5631da177e4SLinus Torvalds	depends on USB_ZERO && USB_OTG
5641da177e4SLinus Torvalds	help
5651da177e4SLinus Torvalds	  You can configure this device to enumerate using the device
5661da177e4SLinus Torvalds	  identifiers of the USB-OTG test device.  That means that when
5671da177e4SLinus Torvalds	  this gadget connects to another OTG device, with this one using
5681da177e4SLinus Torvalds	  the "B-Peripheral" role, that device will use HNP to let this
5691da177e4SLinus Torvalds	  one serve as the USB host instead (in the "B-Host" role).
5701da177e4SLinus Torvalds
571c6994e6fSBryan Wuconfig USB_AUDIO
572eb83be98SGreg Kroah-Hartman	tristate "Audio Gadget"
573c6994e6fSBryan Wu	depends on SND
574a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
57504950737SRandy Dunlap	select SND_PCM
576c6994e6fSBryan Wu	help
577132fcb46SJassi Brar	  This Gadget Audio driver is compatible with USB Audio Class
578132fcb46SJassi Brar	  specification 2.0. It implements 1 AudioControl interface,
579132fcb46SJassi Brar	  1 AudioStreaming Interface each for USB-OUT and USB-IN.
580132fcb46SJassi Brar	  Number of channels, sample rate and sample size can be
581132fcb46SJassi Brar	  specified as module parameters.
582132fcb46SJassi Brar	  This driver doesn't expect any real Audio codec to be present
583132fcb46SJassi Brar	  on the device - the audio streams are simply sinked to and
584132fcb46SJassi Brar	  sourced from a virtual ALSA sound card created. The user-space
585132fcb46SJassi Brar	  application may choose to do whatever it wants with the data
586132fcb46SJassi Brar	  received from the USB Host and choose to provide whatever it
587132fcb46SJassi Brar	  wants as audio data to the USB Host.
588c6994e6fSBryan Wu
589c6994e6fSBryan Wu	  Say "y" to link the driver statically, or "m" to build a
590c6994e6fSBryan Wu	  dynamically linked module called "g_audio".
591c6994e6fSBryan Wu
592132fcb46SJassi Brarconfig GADGET_UAC1
593132fcb46SJassi Brar	bool "UAC 1.0 (Legacy)"
594132fcb46SJassi Brar	depends on USB_AUDIO
595132fcb46SJassi Brar	help
596132fcb46SJassi Brar	  If you instead want older UAC Spec-1.0 driver that also has audio
597132fcb46SJassi Brar	  paths hardwired to the Audio codec chip on-board and doesn't work
598132fcb46SJassi Brar	  without one.
599132fcb46SJassi Brar
6001da177e4SLinus Torvaldsconfig USB_ETH
6011da177e4SLinus Torvalds	tristate "Ethernet Gadget (with CDC Ethernet support)"
6021da177e4SLinus Torvalds	depends on NET
603a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
6049e221be8SRandy Dunlap	select CRC32
6051da177e4SLinus Torvalds	help
6069b39e9ddSBrian Niebuhr	  This driver implements Ethernet style communication, in one of
6079b39e9ddSBrian Niebuhr	  several ways:
6081da177e4SLinus Torvalds
6091da177e4SLinus Torvalds	   - The "Communication Device Class" (CDC) Ethernet Control Model.
6101da177e4SLinus Torvalds	     That protocol is often avoided with pure Ethernet adapters, in
6111da177e4SLinus Torvalds	     favor of simpler vendor-specific hardware, but is widely
6121da177e4SLinus Torvalds	     supported by firmware for smart network devices.
6131da177e4SLinus Torvalds
6141da177e4SLinus Torvalds	   - On hardware can't implement that protocol, a simple CDC subset
6151da177e4SLinus Torvalds	     is used, placing fewer demands on USB.
6161da177e4SLinus Torvalds
6179b39e9ddSBrian Niebuhr	   - CDC Ethernet Emulation Model (EEM) is a newer standard that has
6189b39e9ddSBrian Niebuhr	     a simpler interface that can be used by more USB hardware.
6199b39e9ddSBrian Niebuhr
6209b39e9ddSBrian Niebuhr	  RNDIS support is an additional option, more demanding than than
6219b39e9ddSBrian Niebuhr	  subset.
6221da177e4SLinus Torvalds
6231da177e4SLinus Torvalds	  Within the USB device, this gadget driver exposes a network device
6241da177e4SLinus Torvalds	  "usbX", where X depends on what other networking devices you have.
6251da177e4SLinus Torvalds	  Treat it like a two-node Ethernet link:  host, and gadget.
6261da177e4SLinus Torvalds
6271da177e4SLinus Torvalds	  The Linux-USB host-side "usbnet" driver interoperates with this
6281da177e4SLinus Torvalds	  driver, so that deep I/O queues can be supported.  On 2.4 kernels,
6291da177e4SLinus Torvalds	  use "CDCEther" instead, if you're using the CDC option. That CDC
6301da177e4SLinus Torvalds	  mode should also interoperate with standard CDC Ethernet class
6311da177e4SLinus Torvalds	  drivers on other host operating systems.
6321da177e4SLinus Torvalds
6331da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
6341da177e4SLinus Torvalds	  dynamically linked module called "g_ether".
6351da177e4SLinus Torvalds
6361da177e4SLinus Torvaldsconfig USB_ETH_RNDIS
637afd0e0f2SRobert P. J. Day	bool "RNDIS support"
638afd0e0f2SRobert P. J. Day	depends on USB_ETH
639a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
6401da177e4SLinus Torvalds	default y
6411da177e4SLinus Torvalds	help
6421da177e4SLinus Torvalds	   Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
6431da177e4SLinus Torvalds	   and Microsoft provides redistributable binary RNDIS drivers for
6441da177e4SLinus Torvalds	   older versions of Windows.
6451da177e4SLinus Torvalds
6461da177e4SLinus Torvalds	   If you say "y" here, the Ethernet gadget driver will try to provide
6471da177e4SLinus Torvalds	   a second device configuration, supporting RNDIS to talk to such
6481da177e4SLinus Torvalds	   Microsoft USB hosts.
6491da177e4SLinus Torvalds
6501da177e4SLinus Torvalds	   To make MS-Windows work with this, use Documentation/usb/linux.inf
6511da177e4SLinus Torvalds	   as the "driver info file".  For versions of MS-Windows older than
6521da177e4SLinus Torvalds	   XP, you'll need to download drivers from Microsoft's website; a URL
6531da177e4SLinus Torvalds	   is given in comments found in that info file.
6541da177e4SLinus Torvalds
6559b39e9ddSBrian Niebuhrconfig USB_ETH_EEM
6569b39e9ddSBrian Niebuhr       bool "Ethernet Emulation Model (EEM) support"
6579b39e9ddSBrian Niebuhr       depends on USB_ETH
658a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
6599b39e9ddSBrian Niebuhr       default n
6609b39e9ddSBrian Niebuhr       help
6619b39e9ddSBrian Niebuhr         CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM
6629b39e9ddSBrian Niebuhr         and therefore can be supported by more hardware.  Technically ECM and
6639b39e9ddSBrian Niebuhr         EEM are designed for different applications.  The ECM model extends
6649b39e9ddSBrian Niebuhr         the network interface to the target (e.g. a USB cable modem), and the
6659b39e9ddSBrian Niebuhr         EEM model is for mobile devices to communicate with hosts using
6669b39e9ddSBrian Niebuhr         ethernet over USB.  For Linux gadgets, however, the interface with
6679b39e9ddSBrian Niebuhr         the host is the same (a usbX device), so the differences are minimal.
6689b39e9ddSBrian Niebuhr
6699b39e9ddSBrian Niebuhr         If you say "y" here, the Ethernet gadget driver will use the EEM
6709b39e9ddSBrian Niebuhr         protocol rather than ECM.  If unsure, say "n".
6719b39e9ddSBrian Niebuhr
6726c34d288SYauheni Kaliutaconfig USB_G_NCM
6736c34d288SYauheni Kaliuta	tristate "Network Control Model (NCM) support"
6746c34d288SYauheni Kaliuta	depends on NET
675a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
6766c34d288SYauheni Kaliuta	select CRC32
6776c34d288SYauheni Kaliuta	help
6786c34d288SYauheni Kaliuta	  This driver implements USB CDC NCM subclass standard. NCM is
6796c34d288SYauheni Kaliuta	  an advanced protocol for Ethernet encapsulation, allows grouping
680b55dd320SFabio Baltieri	  of several ethernet frames into one USB transfer and different
6816c34d288SYauheni Kaliuta	  alignment possibilities.
6826c34d288SYauheni Kaliuta
6836c34d288SYauheni Kaliuta	  Say "y" to link the driver statically, or "m" to build a
6846c34d288SYauheni Kaliuta	  dynamically linked module called "g_ncm".
6856c34d288SYauheni Kaliuta
6861da177e4SLinus Torvaldsconfig USB_GADGETFS
687eb83be98SGreg Kroah-Hartman	tristate "Gadget Filesystem"
6881da177e4SLinus Torvalds	help
6891da177e4SLinus Torvalds	  This driver provides a filesystem based API that lets user mode
6901da177e4SLinus Torvalds	  programs implement a single-configuration USB device, including
6911da177e4SLinus Torvalds	  endpoint I/O and control requests that don't relate to enumeration.
6921da177e4SLinus Torvalds	  All endpoints, transfer speeds, and transfer types supported by
6931da177e4SLinus Torvalds	  the hardware are available, through read() and write() calls.
6941da177e4SLinus Torvalds
6951da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
6961da177e4SLinus Torvalds	  dynamically linked module called "gadgetfs".
6971da177e4SLinus Torvalds
698c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS
699eb83be98SGreg Kroah-Hartman	tristate "Function Filesystem"
700a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
701f8dae531SMichal Nazarewicz	select USB_FUNCTIONFS_GENERIC if !(USB_FUNCTIONFS_ETH || USB_FUNCTIONFS_RNDIS)
702c6c56008SMichal Nazarewicz	help
703eabf0f5fSMichael Prokop	  The Function Filesystem (FunctionFS) lets one create USB
704eabf0f5fSMichael Prokop	  composite functions in user space in the same way GadgetFS
705c6c56008SMichal Nazarewicz	  lets one create USB gadgets in user space.  This allows creation
706c6c56008SMichal Nazarewicz	  of composite gadgets such that some of the functions are
707c6c56008SMichal Nazarewicz	  implemented in kernel space (for instance Ethernet, serial or
708c6c56008SMichal Nazarewicz	  mass storage) and other are implemented in user space.
709c6c56008SMichal Nazarewicz
710f8dae531SMichal Nazarewicz	  If you say "y" or "m" here you will be able what kind of
711f8dae531SMichal Nazarewicz	  configurations the gadget will provide.
712f8dae531SMichal Nazarewicz
713c6c56008SMichal Nazarewicz	  Say "y" to link the driver statically, or "m" to build
714c6c56008SMichal Nazarewicz	  a dynamically linked module called "g_ffs".
715c6c56008SMichal Nazarewicz
716c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_ETH
717f8dae531SMichal Nazarewicz	bool "Include configuration with CDC ECM (Ethernet)"
71817b2765eSRandy Dunlap	depends on USB_FUNCTIONFS && NET
719c6c56008SMichal Nazarewicz	help
720eabf0f5fSMichael Prokop	  Include a configuration with CDC ECM function (Ethernet) and the
721eabf0f5fSMichael Prokop	  Function Filesystem.
722c6c56008SMichal Nazarewicz
723c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_RNDIS
724f8dae531SMichal Nazarewicz	bool "Include configuration with RNDIS (Ethernet)"
72517b2765eSRandy Dunlap	depends on USB_FUNCTIONFS && NET
726c6c56008SMichal Nazarewicz	help
727eabf0f5fSMichael Prokop	  Include a configuration with RNDIS function (Ethernet) and the Filesystem.
728c6c56008SMichal Nazarewicz
729c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_GENERIC
730c6c56008SMichal Nazarewicz	bool "Include 'pure' configuration"
731f8dae531SMichal Nazarewicz	depends on USB_FUNCTIONFS
732c6c56008SMichal Nazarewicz	help
733f8dae531SMichal Nazarewicz	  Include a configuration with the Function Filesystem alone with
734f8dae531SMichal Nazarewicz	  no Ethernet interface.
735c6c56008SMichal Nazarewicz
736d23b0f08SMichal Nazarewiczconfig USB_MASS_STORAGE
737d23b0f08SMichal Nazarewicz	tristate "Mass Storage Gadget"
738d23b0f08SMichal Nazarewicz	depends on BLOCK
739a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
740d23b0f08SMichal Nazarewicz	help
741d23b0f08SMichal Nazarewicz	  The Mass Storage Gadget acts as a USB Mass Storage disk drive.
742d23b0f08SMichal Nazarewicz	  As its storage repository it can use a regular file or a block
743d23b0f08SMichal Nazarewicz	  device (in much the same way as the "loop" device driver),
744d23b0f08SMichal Nazarewicz	  specified as a module parameter or sysfs option.
745d23b0f08SMichal Nazarewicz
746fa06920aSMichal Nazarewicz	  This driver is a replacement for now removed File-backed
747fa06920aSMichal Nazarewicz	  Storage Gadget (g_file_storage).
748d23b0f08SMichal Nazarewicz
749d23b0f08SMichal Nazarewicz	  Say "y" to link the driver statically, or "m" to build
750664a51a8SAlan Stern	  a dynamically linked module called "g_mass_storage".
751d23b0f08SMichal Nazarewicz
752c52661d6SSebastian Andrzej Siewiorconfig USB_GADGET_TARGET
753c52661d6SSebastian Andrzej Siewior	tristate "USB Gadget Target Fabric Module"
754c52661d6SSebastian Andrzej Siewior	depends on TARGET_CORE
755a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
756c52661d6SSebastian Andrzej Siewior	help
757c52661d6SSebastian Andrzej Siewior	  This fabric is an USB gadget. Two USB protocols are supported that is
758c52661d6SSebastian Andrzej Siewior	  BBB or BOT (Bulk Only Transport) and UAS (USB Attached SCSI). BOT is
759c52661d6SSebastian Andrzej Siewior	  advertised on alternative interface 0 (primary) and UAS is on
760c52661d6SSebastian Andrzej Siewior	  alternative interface 1. Both protocols can work on USB2.0 and USB3.0.
761c52661d6SSebastian Andrzej Siewior	  UAS utilizes the USB 3.0 feature called streams support.
762c52661d6SSebastian Andrzej Siewior
7631da177e4SLinus Torvaldsconfig USB_G_SERIAL
7643086775aSFelipe Balbi	tristate "Serial Gadget (with CDC ACM and CDC OBEX support)"
7653249ca22SSebastian Andrzej Siewior	select USB_U_SERIAL
766ff47f594SSebastian Andrzej Siewior	select USB_F_ACM
767a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
7681da177e4SLinus Torvalds	help
7691da177e4SLinus Torvalds	  The Serial Gadget talks to the Linux-USB generic serial driver.
7701da177e4SLinus Torvalds	  This driver supports a CDC-ACM module option, which can be used
7711da177e4SLinus Torvalds	  to interoperate with MS-Windows hosts or with the Linux-USB
7721da177e4SLinus Torvalds	  "cdc-acm" driver.
7731da177e4SLinus Torvalds
7743086775aSFelipe Balbi	  This driver also supports a CDC-OBEX option.  You will need a
7753086775aSFelipe Balbi	  user space OBEX server talking to /dev/ttyGS*, since the kernel
7763086775aSFelipe Balbi	  itself doesn't implement the OBEX protocol.
7773086775aSFelipe Balbi
7781da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
7791da177e4SLinus Torvalds	  dynamically linked module called "g_serial".
7801da177e4SLinus Torvalds
7811da177e4SLinus Torvalds	  For more information, see Documentation/usb/gadget_serial.txt
7821da177e4SLinus Torvalds	  which includes instructions and a "driver info file" needed to
7833086775aSFelipe Balbi	  make MS-Windows work with CDC ACM.
7841da177e4SLinus Torvalds
785f2ebf92cSBen Williamsonconfig USB_MIDI_GADGET
786eb83be98SGreg Kroah-Hartman	tristate "MIDI Gadget"
787eb83be98SGreg Kroah-Hartman	depends on SND
788a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
789f2ebf92cSBen Williamson	select SND_RAWMIDI
790f2ebf92cSBen Williamson	help
791f2ebf92cSBen Williamson	  The MIDI Gadget acts as a USB Audio device, with one MIDI
792f2ebf92cSBen Williamson	  input and one MIDI output. These MIDI jacks appear as
793f2ebf92cSBen Williamson	  a sound "card" in the ALSA sound system. Other MIDI
794f2ebf92cSBen Williamson	  connections can then be made on the gadget system, using
795f2ebf92cSBen Williamson	  ALSA's aconnect utility etc.
796f2ebf92cSBen Williamson
797f2ebf92cSBen Williamson	  Say "y" to link the driver statically, or "m" to build a
798f2ebf92cSBen Williamson	  dynamically linked module called "g_midi".
799f2ebf92cSBen Williamson
80025a010c8SCraig W. Nadlerconfig USB_G_PRINTER
80125a010c8SCraig W. Nadler	tristate "Printer Gadget"
802a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
80325a010c8SCraig W. Nadler	help
80425a010c8SCraig W. Nadler	  The Printer Gadget channels data between the USB host and a
80525a010c8SCraig W. Nadler	  userspace program driving the print engine. The user space
80625a010c8SCraig W. Nadler	  program reads and writes the device file /dev/g_printer to
80725a010c8SCraig W. Nadler	  receive or send printer data. It can use ioctl calls to
80825a010c8SCraig W. Nadler	  the device file to get or set printer status.
80925a010c8SCraig W. Nadler
81025a010c8SCraig W. Nadler	  Say "y" to link the driver statically, or "m" to build a
81125a010c8SCraig W. Nadler	  dynamically linked module called "g_printer".
81225a010c8SCraig W. Nadler
81325a010c8SCraig W. Nadler	  For more information, see Documentation/usb/gadget_printer.txt
81425a010c8SCraig W. Nadler	  which includes sample code for accessing the device file.
8151da177e4SLinus Torvalds
81619e20680SDavid Brownellconfig USB_CDC_COMPOSITE
81719e20680SDavid Brownell	tristate "CDC Composite Device (Ethernet and ACM)"
8184ddd9ec1SRandy Dunlap	depends on NET
819a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
8203249ca22SSebastian Andrzej Siewior	select USB_U_SERIAL
82129a6645fSSebastian Andrzej Siewior	select USB_F_ACM
82219e20680SDavid Brownell	help
82319e20680SDavid Brownell	  This driver provides two functions in one configuration:
82419e20680SDavid Brownell	  a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link.
82519e20680SDavid Brownell
82619e20680SDavid Brownell	  This driver requires four bulk and two interrupt endpoints,
82719e20680SDavid Brownell	  plus the ability to handle altsettings.  Not all peripheral
82819e20680SDavid Brownell	  controllers are that capable.
82919e20680SDavid Brownell
83019e20680SDavid Brownell	  Say "y" to link the driver statically, or "m" to build a
83119e20680SDavid Brownell	  dynamically linked module.
83219e20680SDavid Brownell
833f358f5b4SFelipe Balbiconfig USB_G_NOKIA
834f358f5b4SFelipe Balbi	tristate "Nokia composite gadget"
835f358f5b4SFelipe Balbi	depends on PHONET
836a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
8373249ca22SSebastian Andrzej Siewior	select USB_U_SERIAL
838f358f5b4SFelipe Balbi	help
839f358f5b4SFelipe Balbi	  The Nokia composite gadget provides support for acm, obex
840f358f5b4SFelipe Balbi	  and phonet in only one composite gadget driver.
841f358f5b4SFelipe Balbi
842f358f5b4SFelipe Balbi	  It's only really useful for N900 hardware. If you're building
843f358f5b4SFelipe Balbi	  a kernel for N900, say Y or M here. If unsure, say N.
844f358f5b4SFelipe Balbi
845fa3ae0c1SKlaus Schwarzkopfconfig USB_G_ACM_MS
846fa3ae0c1SKlaus Schwarzkopf	tristate "CDC Composite Device (ACM and mass storage)"
847fa3ae0c1SKlaus Schwarzkopf	depends on BLOCK
848a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
8493249ca22SSebastian Andrzej Siewior	select USB_U_SERIAL
8505f72bbfdSSebastian Andrzej Siewior	select USB_F_ACM
851fa3ae0c1SKlaus Schwarzkopf	help
852fa3ae0c1SKlaus Schwarzkopf	  This driver provides two functions in one configuration:
853fa3ae0c1SKlaus Schwarzkopf	  a mass storage, and a CDC ACM (serial port) link.
854fa3ae0c1SKlaus Schwarzkopf
855fa3ae0c1SKlaus Schwarzkopf	  Say "y" to link the driver statically, or "m" to build a
856fa3ae0c1SKlaus Schwarzkopf	  dynamically linked module called "g_acm_ms".
857fa3ae0c1SKlaus Schwarzkopf
858f176a5d8SMichal Nazarewiczconfig USB_G_MULTI
859eb83be98SGreg Kroah-Hartman	tristate "Multifunction Composite Gadget"
8605791e103SRandy Dunlap	depends on BLOCK && NET
861279cc49aSMichal Nazarewicz	select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS
862a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
8633249ca22SSebastian Andrzej Siewior	select USB_U_SERIAL
86459835ad7SSebastian Andrzej Siewior	select USB_F_ACM
865f176a5d8SMichal Nazarewicz	help
866f176a5d8SMichal Nazarewicz	  The Multifunction Composite Gadget provides Ethernet (RNDIS
867f176a5d8SMichal Nazarewicz	  and/or CDC Ethernet), mass storage and ACM serial link
868f176a5d8SMichal Nazarewicz	  interfaces.
869f176a5d8SMichal Nazarewicz
8705791e103SRandy Dunlap	  You will be asked to choose which of the two configurations is
871f176a5d8SMichal Nazarewicz	  to be available in the gadget.  At least one configuration must
8725791e103SRandy Dunlap	  be chosen to make the gadget usable.  Selecting more than one
873f176a5d8SMichal Nazarewicz	  configuration will prevent Windows from automatically detecting
8745791e103SRandy Dunlap	  the gadget as a composite gadget, so an INF file will be needed to
875f176a5d8SMichal Nazarewicz	  use the gadget.
876f176a5d8SMichal Nazarewicz
877f176a5d8SMichal Nazarewicz	  Say "y" to link the driver statically, or "m" to build a
878f176a5d8SMichal Nazarewicz	  dynamically linked module called "g_multi".
879f176a5d8SMichal Nazarewicz
880f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_RNDIS
881f176a5d8SMichal Nazarewicz	bool "RNDIS + CDC Serial + Storage configuration"
882f176a5d8SMichal Nazarewicz	depends on USB_G_MULTI
883f176a5d8SMichal Nazarewicz	default y
884f176a5d8SMichal Nazarewicz	help
885f176a5d8SMichal Nazarewicz	  This option enables a configuration with RNDIS, CDC Serial and
886f176a5d8SMichal Nazarewicz	  Mass Storage functions available in the Multifunction Composite
8875791e103SRandy Dunlap	  Gadget.  This is the configuration dedicated for Windows since RNDIS
8885791e103SRandy Dunlap	  is Microsoft's protocol.
889f176a5d8SMichal Nazarewicz
890f176a5d8SMichal Nazarewicz	  If unsure, say "y".
891f176a5d8SMichal Nazarewicz
892f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_CDC
893f176a5d8SMichal Nazarewicz	bool "CDC Ethernet + CDC Serial + Storage configuration"
894f176a5d8SMichal Nazarewicz	depends on USB_G_MULTI
895f176a5d8SMichal Nazarewicz	default n
896f176a5d8SMichal Nazarewicz	help
897f176a5d8SMichal Nazarewicz	  This option enables a configuration with CDC Ethernet (ECM), CDC
898f176a5d8SMichal Nazarewicz	  Serial and Mass Storage functions available in the Multifunction
8995791e103SRandy Dunlap	  Composite Gadget.
900f176a5d8SMichal Nazarewicz
901f176a5d8SMichal Nazarewicz	  If unsure, say "y".
902f176a5d8SMichal Nazarewicz
90371adf118SFabien Chouteauconfig USB_G_HID
90471adf118SFabien Chouteau	tristate "HID Gadget"
905a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
90671adf118SFabien Chouteau	help
90771adf118SFabien Chouteau	  The HID gadget driver provides generic emulation of USB
90871adf118SFabien Chouteau	  Human Interface Devices (HID).
90971adf118SFabien Chouteau
91071adf118SFabien Chouteau	  For more information, see Documentation/usb/gadget_hid.txt which
91171adf118SFabien Chouteau	  includes sample code for accessing the device files.
91271adf118SFabien Chouteau
91371adf118SFabien Chouteau	  Say "y" to link the driver statically, or "m" to build a
91471adf118SFabien Chouteau	  dynamically linked module called "g_hid".
915f176a5d8SMichal Nazarewicz
916a84d9e53SSebastian Andrzej Siewior# Standalone / single function gadgets
917f6c826a9Sstephane duvergerconfig USB_G_DBGP
918f6c826a9Sstephane duverger	tristate "EHCI Debug Device Gadget"
919a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
920f6c826a9Sstephane duverger	help
921f6c826a9Sstephane duverger	  This gadget emulates an EHCI Debug device. This is useful when you want
922f6c826a9Sstephane duverger	  to interact with an EHCI Debug Port.
923f6c826a9Sstephane duverger
924f6c826a9Sstephane duverger	  Say "y" to link the driver statically, or "m" to build a
925f6c826a9Sstephane duverger	  dynamically linked module called "g_dbgp".
926f6c826a9Sstephane duverger
927f6c826a9Sstephane duvergerif USB_G_DBGP
928f6c826a9Sstephane duvergerchoice
929f6c826a9Sstephane duverger	prompt "EHCI Debug Device mode"
930f6c826a9Sstephane duverger	default USB_G_DBGP_SERIAL
931f6c826a9Sstephane duverger
932f6c826a9Sstephane duvergerconfig USB_G_DBGP_PRINTK
933f6c826a9Sstephane duverger	depends on USB_G_DBGP
934f6c826a9Sstephane duverger	bool "printk"
935f6c826a9Sstephane duverger	help
936f6c826a9Sstephane duverger	  Directly printk() received data. No interaction.
937f6c826a9Sstephane duverger
938f6c826a9Sstephane duvergerconfig USB_G_DBGP_SERIAL
939f6c826a9Sstephane duverger	depends on USB_G_DBGP
9403249ca22SSebastian Andrzej Siewior	select USB_U_SERIAL
941f6c826a9Sstephane duverger	bool "serial"
942f6c826a9Sstephane duverger	help
943f6c826a9Sstephane duverger	  Userland can interact using /dev/ttyGSxxx.
944f6c826a9Sstephane duvergerendchoice
945f6c826a9Sstephane duvergerendif
946f6c826a9Sstephane duverger
9471da177e4SLinus Torvalds# put drivers that need isochronous transfer support (for audio
9481da177e4SLinus Torvalds# or video class gadget drivers), or specific hardware, here.
949a9914127SLaurent Pinchartconfig USB_G_WEBCAM
950a9914127SLaurent Pinchart	tristate "USB Webcam Gadget"
95124337c13SRandy Dunlap	depends on VIDEO_DEV
9520b2ffb78SLaurent Pinchart	select USB_LIBCOMPOSITE
953a9914127SLaurent Pinchart	help
954a9914127SLaurent Pinchart	  The Webcam Gadget acts as a composite USB Audio and Video Class
955a9914127SLaurent Pinchart	  device. It provides a userspace API to process UVC control requests
956a9914127SLaurent Pinchart	  and stream video data to the host.
9571da177e4SLinus Torvalds
958a9914127SLaurent Pinchart	  Say "y" to link the driver statically, or "m" to build a
959a9914127SLaurent Pinchart	  dynamically linked module called "g_webcam".
9601da177e4SLinus Torvalds
9611da177e4SLinus Torvaldsendchoice
9621da177e4SLinus Torvalds
963b75be4abSDenis Chengendif # USB_GADGET
964