xref: /openbmc/linux/drivers/usb/gadget/Kconfig (revision cf9a08ae)
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
284c03e7d4bSPaulius Zaleckas	help
2852e5a08a3SSascha Hauer	   Freescale's i.MX1 includes an integrated full speed
2862e5a08a3SSascha Hauer	   USB 1.1 device controller.
287c03e7d4bSPaulius Zaleckas
288c03e7d4bSPaulius Zaleckas	   It has Six fixed-function endpoints, as well as endpoint
289c03e7d4bSPaulius Zaleckas	   zero (for control transfers).
290c03e7d4bSPaulius Zaleckas
291c03e7d4bSPaulius Zaleckas	   Say "y" to link the driver statically, or "m" to build a
292c03e7d4bSPaulius Zaleckas	   dynamically linked module called "imx_udc" and force all
293c03e7d4bSPaulius Zaleckas	   gadget drivers to also be dynamically linked.
294c03e7d4bSPaulius Zaleckas
295193ab2a6SFelipe Balbiconfig USB_S3C2410
296193ab2a6SFelipe Balbi	tristate "S3C2410 USB Device Controller"
297b130d5c2SKukjin Kim	depends on ARCH_S3C24XX
2983fc154b6SArnaud Patard	help
2993fc154b6SArnaud Patard	  Samsung's S3C2410 is an ARM-4 processor with an integrated
3003fc154b6SArnaud Patard	  full speed USB 1.1 device controller.  It has 4 configurable
3013fc154b6SArnaud Patard	  endpoints, as well as endpoint zero (for control transfers).
3023fc154b6SArnaud Patard
3033fc154b6SArnaud Patard	  This driver has been tested on the S3C2410, S3C2412, and
3043fc154b6SArnaud Patard	  S3C2440 processors.
3053fc154b6SArnaud Patard
3063fc154b6SArnaud Patardconfig USB_S3C2410_DEBUG
3073fc154b6SArnaud Patard	boolean "S3C2410 udc debug messages"
308193ab2a6SFelipe Balbi	depends on USB_S3C2410
3093fc154b6SArnaud Patard
310193ab2a6SFelipe Balbiconfig USB_S3C_HSUDC
311193ab2a6SFelipe Balbi	tristate "S3C2416, S3C2443 and S3C2450 USB Device Controller"
312b130d5c2SKukjin Kim	depends on ARCH_S3C24XX
313a9df304cSThomas Abraham	help
314a9df304cSThomas Abraham	  Samsung's S3C2416, S3C2443 and S3C2450 is an ARM9 based SoC
315a9df304cSThomas Abraham	  integrated with dual speed USB 2.0 device controller. It has
316a9df304cSThomas Abraham	  8 endpoints, as well as endpoint zero.
317a9df304cSThomas Abraham
318a9df304cSThomas Abraham	  This driver has been tested on S3C2416 and S3C2450 processors.
319a9df304cSThomas Abraham
3205e6c86b0SNeil Zhangconfig USB_MV_UDC
3215e6c86b0SNeil Zhang	tristate "Marvell USB2.0 Device Controller"
322e7cddda4Scxie4	help
3235e6c86b0SNeil Zhang	  Marvell Socs (including PXA and MMP series) include a high speed
3245e6c86b0SNeil Zhang	  USB2.0 OTG controller, which can be configured as high speed or
3255e6c86b0SNeil Zhang	  full speed USB peripheral.
32672246da4SFelipe Balbi
3273d4eb9dfSYu Xuconfig USB_MV_U3D
3283d4eb9dfSYu Xu	tristate "MARVELL PXA2128 USB 3.0 controller"
3293d4eb9dfSYu Xu	depends on CPU_MMP3
3303d4eb9dfSYu Xu	select USB_GADGET_DUALSPEED
3313d4eb9dfSYu Xu	select USB_GADGET_SUPERSPEED
3323d4eb9dfSYu Xu	help
3333d4eb9dfSYu Xu	  MARVELL PXA2128 Processor series include a super speed USB3.0 device
3343d4eb9dfSYu Xu	  controller, which support super speed USB peripheral.
3353d4eb9dfSYu Xu
336a7a19facSDavid Brownell#
337a7a19facSDavid Brownell# Controllers available in both integrated and discrete versions
338a7a19facSDavid Brownell#
339a7a19facSDavid Brownell
340a7a19facSDavid Brownell# musb builds in ../musb along with host support
341a7a19facSDavid Brownellconfig USB_GADGET_MUSB_HDRC
342193ab2a6SFelipe Balbi	tristate "Inventra HDRC USB Peripheral (TI, ADI, ...)"
343b61ae342SRabin Vincent	depends on USB_MUSB_HDRC
344bae4bd84SDavid Brownell	help
345a7a19facSDavid Brownell	  This OTG-capable silicon IP is used in dual designs including
346085ad406SBryan Wu	  the TI DaVinci, OMAP 243x, OMAP 343x, TUSB 6010, and ADI Blackfin
347a7a19facSDavid Brownell
348193ab2a6SFelipe Balbiconfig USB_M66592
349193ab2a6SFelipe Balbi	tristate "Renesas M66592 USB Peripheral Controller"
350a7a19facSDavid Brownell	help
351a7a19facSDavid Brownell	   M66592 is a discrete USB peripheral controller chip that
352a7a19facSDavid Brownell	   supports both full and high speed USB 2.0 data transfers.
353a7a19facSDavid Brownell	   It has seven configurable endpoints, and endpoint zero.
354bae4bd84SDavid Brownell
355bae4bd84SDavid Brownell	   Say "y" to link the driver statically, or "m" to build a
356a7a19facSDavid Brownell	   dynamically linked module called "m66592_udc" and force all
357bae4bd84SDavid Brownell	   gadget drivers to also be dynamically linked.
358bae4bd84SDavid Brownell
359a7a19facSDavid Brownell#
360a7a19facSDavid Brownell# Controllers available only in discrete form (and all PCI controllers)
361a7a19facSDavid Brownell#
362a7a19facSDavid Brownell
363193ab2a6SFelipe Balbiconfig USB_AMD5536UDC
364193ab2a6SFelipe Balbi	tristate "AMD5536 UDC"
365a7a19facSDavid Brownell	depends on PCI
366a7a19facSDavid Brownell	help
367a7a19facSDavid Brownell	   The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
368a7a19facSDavid Brownell	   It is a USB Highspeed DMA capable USB device controller. Beside ep0
369a7a19facSDavid Brownell	   it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
370a7a19facSDavid Brownell	   The UDC port supports OTG operation, and may be used as a host port
371a7a19facSDavid Brownell	   if it's not being used to implement peripheral or OTG roles.
372a7a19facSDavid Brownell
373a7a19facSDavid Brownell	   Say "y" to link the driver statically, or "m" to build a
374a7a19facSDavid Brownell	   dynamically linked module called "amd5536udc" and force all
375a7a19facSDavid Brownell	   gadget drivers to also be dynamically linked.
376a7a19facSDavid Brownell
377193ab2a6SFelipe Balbiconfig USB_FSL_QE
378193ab2a6SFelipe Balbi	tristate "Freescale QE/CPM USB Device Controller"
3793948f0e0SLi Yang	depends on FSL_SOC && (QUICC_ENGINE || CPM)
3803948f0e0SLi Yang	help
3813948f0e0SLi Yang	   Some of Freescale PowerPC processors have a Full Speed
3823948f0e0SLi Yang	   QE/CPM2 USB controller, which support device mode with 4
3833948f0e0SLi Yang	   programmable endpoints. This driver supports the
3843948f0e0SLi Yang	   controller in the MPC8360 and MPC8272, and should work with
3853948f0e0SLi Yang	   controllers having QE or CPM2, given minor tweaks.
3863948f0e0SLi Yang
3873948f0e0SLi Yang	   Set CONFIG_USB_GADGET to "m" to build this driver as a
388692105b8SMatt LaPlante	   dynamically linked module called "fsl_qe_udc".
3893948f0e0SLi Yang
390193ab2a6SFelipe Balbiconfig USB_NET2272
391193ab2a6SFelipe Balbi	tristate "PLX NET2272"
392ceb80363SSeth Levy	help
393ceb80363SSeth Levy	  PLX NET2272 is a USB peripheral controller which supports
394ceb80363SSeth Levy	  both full and high speed USB 2.0 data transfers.
395ceb80363SSeth Levy
396ceb80363SSeth Levy	  It has three configurable endpoints, as well as endpoint zero
397ceb80363SSeth Levy	  (for control transfer).
398ceb80363SSeth Levy	  Say "y" to link the driver statically, or "m" to build a
399ceb80363SSeth Levy	  dynamically linked module called "net2272" and force all
400ceb80363SSeth Levy	  gadget drivers to also be dynamically linked.
401ceb80363SSeth Levy
402193ab2a6SFelipe Balbiconfig USB_NET2272_DMA
403ceb80363SSeth Levy	boolean "Support external DMA controller"
404193ab2a6SFelipe Balbi	depends on USB_NET2272
405ceb80363SSeth Levy	help
406ceb80363SSeth Levy	  The NET2272 part can optionally support an external DMA
407ceb80363SSeth Levy	  controller, but your board has to have support in the
408ceb80363SSeth Levy	  driver itself.
409ceb80363SSeth Levy
410ceb80363SSeth Levy	  If unsure, say "N" here.  The driver works fine in PIO mode.
411ceb80363SSeth Levy
412193ab2a6SFelipe Balbiconfig USB_NET2280
413193ab2a6SFelipe Balbi	tristate "NetChip 228x"
414a7a19facSDavid Brownell	depends on PCI
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_EG20T
442731ad81eSTomoya MORINAGA	tristate "Intel EG20T PCH/LAPIS Semiconductor IOH(ML7213/ML7831) UDC"
443f646cf94SToshiharu Okada	depends on PCI
444f646cf94SToshiharu Okada	help
445f646cf94SToshiharu Okada	  This is a USB device driver for EG20T PCH.
446f646cf94SToshiharu Okada	  EG20T PCH is the platform controller hub that is used in Intel's
447f646cf94SToshiharu Okada	  general embedded platform. EG20T PCH has USB device interface.
448f646cf94SToshiharu Okada	  Using this interface, it is able to access system devices connected
449f646cf94SToshiharu Okada	  to USB device.
450f646cf94SToshiharu Okada	  This driver enables USB device function.
451f646cf94SToshiharu Okada	  USB device is a USB peripheral controller which
452f646cf94SToshiharu Okada	  supports both full and high speed USB 2.0 data transfers.
453f646cf94SToshiharu Okada	  This driver supports both control transfer and bulk transfer modes.
454f646cf94SToshiharu Okada	  This driver dose not support interrupt transfer or isochronous
455f646cf94SToshiharu Okada	  transfer modes.
456f646cf94SToshiharu Okada
457731ad81eSTomoya MORINAGA	  This driver also can be used for LAPIS Semiconductor's ML7213 which is
45806f1b971STomoya MORINAGA	  for IVI(In-Vehicle Infotainment) use.
459731ad81eSTomoya MORINAGA	  ML7831 is for general purpose use.
460731ad81eSTomoya MORINAGA	  ML7213/ML7831 is companion chip for Intel Atom E6xx series.
461731ad81eSTomoya MORINAGA	  ML7213/ML7831 is completely compatible for Intel EG20T PCH.
46206f1b971STomoya MORINAGA
463a7a19facSDavid Brownell#
464a7a19facSDavid Brownell# LAST -- dummy/emulated controller
465a7a19facSDavid Brownell#
4661da177e4SLinus Torvalds
467193ab2a6SFelipe Balbiconfig USB_DUMMY_HCD
468193ab2a6SFelipe Balbi	tristate "Dummy HCD (DEVELOPMENT)"
469afd0e0f2SRobert P. J. Day	depends on USB=y || (USB=m && USB_GADGET=m)
4701da177e4SLinus Torvalds	help
4711da177e4SLinus Torvalds	  This host controller driver emulates USB, looping all data transfer
4721da177e4SLinus Torvalds	  requests back to a USB "gadget driver" in the same host.  The host
4731da177e4SLinus Torvalds	  side is the master; the gadget side is the slave.  Gadget drivers
4741da177e4SLinus Torvalds	  can be high, full, or low speed; and they have access to endpoints
4751da177e4SLinus Torvalds	  like those from NET2280, PXA2xx, or SA1100 hardware.
4761da177e4SLinus Torvalds
4771da177e4SLinus Torvalds	  This may help in some stages of creating a driver to embed in a
4781da177e4SLinus Torvalds	  Linux device, since it lets you debug several parts of the gadget
4791da177e4SLinus Torvalds	  driver without its hardware or drivers being involved.
4801da177e4SLinus Torvalds
4811da177e4SLinus Torvalds	  Since such a gadget side driver needs to interoperate with a host
4821da177e4SLinus Torvalds	  side Linux-USB device driver, this may help to debug both sides
4831da177e4SLinus Torvalds	  of a USB protocol stack.
4841da177e4SLinus Torvalds
4851da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
4861da177e4SLinus Torvalds	  dynamically linked module called "dummy_hcd" and force all
4871da177e4SLinus Torvalds	  gadget drivers to also be dynamically linked.
4881da177e4SLinus Torvalds
4891da177e4SLinus Torvalds# NOTE:  Please keep dummy_hcd LAST so that "real hardware" appears
4901da177e4SLinus Torvalds# first and will be selected by default.
4911da177e4SLinus Torvalds
492ed6c6f41SAlexander Shishkinendmenu
4931da177e4SLinus Torvalds
4941da177e4SLinus Torvalds#
4951da177e4SLinus Torvalds# USB Gadget Drivers
4961da177e4SLinus Torvalds#
497a84d9e53SSebastian Andrzej Siewior
498a84d9e53SSebastian Andrzej Siewior# composite based drivers
499a84d9e53SSebastian Andrzej Siewiorconfig USB_LIBCOMPOSITE
500a84d9e53SSebastian Andrzej Siewior	tristate
501a84d9e53SSebastian Andrzej Siewior	depends on USB_GADGET
502a84d9e53SSebastian Andrzej Siewior
503cf9a08aeSSebastian Andrzej Siewiorconfig USB_F_SS_LB
504cf9a08aeSSebastian Andrzej Siewior	tristate
505cf9a08aeSSebastian Andrzej Siewior
5061da177e4SLinus Torvaldschoice
5071da177e4SLinus Torvalds	tristate "USB Gadget Drivers"
5081da177e4SLinus Torvalds	default USB_ETH
5091da177e4SLinus Torvalds	help
5101da177e4SLinus Torvalds	  A Linux "Gadget Driver" talks to the USB Peripheral Controller
5111da177e4SLinus Torvalds	  driver through the abstract "gadget" API.  Some other operating
5121da177e4SLinus Torvalds	  systems call these "client" drivers, of which "class drivers"
5131da177e4SLinus Torvalds	  are a subset (implementing a USB device class specification).
5141da177e4SLinus Torvalds	  A gadget driver implements one or more USB functions using
5151da177e4SLinus Torvalds	  the peripheral hardware.
5161da177e4SLinus Torvalds
5171da177e4SLinus Torvalds	  Gadget drivers are hardware-neutral, or "platform independent",
5181da177e4SLinus Torvalds	  except that they sometimes must understand quirks or limitations
5191da177e4SLinus Torvalds	  of the particular controllers they work with.  For example, when
5201da177e4SLinus Torvalds	  a controller doesn't support alternate configurations or provide
5211da177e4SLinus Torvalds	  enough of the right types of endpoints, the gadget driver might
5221da177e4SLinus Torvalds	  not be able work with that controller, or might need to implement
5231da177e4SLinus Torvalds	  a less common variant of a device class protocol.
5241da177e4SLinus Torvalds
5251da177e4SLinus Torvalds# this first set of drivers all depend on bulk-capable hardware.
5261da177e4SLinus Torvalds
5271da177e4SLinus Torvaldsconfig USB_ZERO
5281da177e4SLinus Torvalds	tristate "Gadget Zero (DEVELOPMENT)"
529a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
530cf9a08aeSSebastian Andrzej Siewior	select USB_F_SS_LB
5311da177e4SLinus Torvalds	help
5321da177e4SLinus Torvalds	  Gadget Zero is a two-configuration device.  It either sinks and
5331da177e4SLinus Torvalds	  sources bulk data; or it loops back a configurable number of
5341da177e4SLinus Torvalds	  transfers.  It also implements control requests, for "chapter 9"
5351da177e4SLinus Torvalds	  conformance.  The driver needs only two bulk-capable endpoints, so
5361da177e4SLinus Torvalds	  it can work on top of most device-side usb controllers.  It's
5371da177e4SLinus Torvalds	  useful for testing, and is also a working example showing how
5381da177e4SLinus Torvalds	  USB "gadget drivers" can be written.
5391da177e4SLinus Torvalds
5401da177e4SLinus Torvalds	  Make this be the first driver you try using on top of any new
5411da177e4SLinus Torvalds	  USB peripheral controller driver.  Then you can use host-side
5421da177e4SLinus Torvalds	  test software, like the "usbtest" driver, to put your hardware
5431da177e4SLinus Torvalds	  and its driver through a basic set of functional tests.
5441da177e4SLinus Torvalds
5451da177e4SLinus Torvalds	  Gadget Zero also works with the host-side "usb-skeleton" driver,
5461da177e4SLinus Torvalds	  and with many kinds of host-side test software.  You may need
5471da177e4SLinus Torvalds	  to tweak product and vendor IDs before host software knows about
5481da177e4SLinus Torvalds	  this device, and arrange to select an appropriate configuration.
5491da177e4SLinus Torvalds
5501da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
5511da177e4SLinus Torvalds	  dynamically linked module called "g_zero".
5521da177e4SLinus Torvalds
5531da177e4SLinus Torvaldsconfig USB_ZERO_HNPTEST
5541da177e4SLinus Torvalds	boolean "HNP Test Device"
5551da177e4SLinus Torvalds	depends on USB_ZERO && USB_OTG
5561da177e4SLinus Torvalds	help
5571da177e4SLinus Torvalds	  You can configure this device to enumerate using the device
5581da177e4SLinus Torvalds	  identifiers of the USB-OTG test device.  That means that when
5591da177e4SLinus Torvalds	  this gadget connects to another OTG device, with this one using
5601da177e4SLinus Torvalds	  the "B-Peripheral" role, that device will use HNP to let this
5611da177e4SLinus Torvalds	  one serve as the USB host instead (in the "B-Host" role).
5621da177e4SLinus Torvalds
563c6994e6fSBryan Wuconfig USB_AUDIO
564eb83be98SGreg Kroah-Hartman	tristate "Audio Gadget"
565c6994e6fSBryan Wu	depends on SND
566a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
56704950737SRandy Dunlap	select SND_PCM
568c6994e6fSBryan Wu	help
569132fcb46SJassi Brar	  This Gadget Audio driver is compatible with USB Audio Class
570132fcb46SJassi Brar	  specification 2.0. It implements 1 AudioControl interface,
571132fcb46SJassi Brar	  1 AudioStreaming Interface each for USB-OUT and USB-IN.
572132fcb46SJassi Brar	  Number of channels, sample rate and sample size can be
573132fcb46SJassi Brar	  specified as module parameters.
574132fcb46SJassi Brar	  This driver doesn't expect any real Audio codec to be present
575132fcb46SJassi Brar	  on the device - the audio streams are simply sinked to and
576132fcb46SJassi Brar	  sourced from a virtual ALSA sound card created. The user-space
577132fcb46SJassi Brar	  application may choose to do whatever it wants with the data
578132fcb46SJassi Brar	  received from the USB Host and choose to provide whatever it
579132fcb46SJassi Brar	  wants as audio data to the USB Host.
580c6994e6fSBryan Wu
581c6994e6fSBryan Wu	  Say "y" to link the driver statically, or "m" to build a
582c6994e6fSBryan Wu	  dynamically linked module called "g_audio".
583c6994e6fSBryan Wu
584132fcb46SJassi Brarconfig GADGET_UAC1
585132fcb46SJassi Brar	bool "UAC 1.0 (Legacy)"
586132fcb46SJassi Brar	depends on USB_AUDIO
587132fcb46SJassi Brar	help
588132fcb46SJassi Brar	  If you instead want older UAC Spec-1.0 driver that also has audio
589132fcb46SJassi Brar	  paths hardwired to the Audio codec chip on-board and doesn't work
590132fcb46SJassi Brar	  without one.
591132fcb46SJassi Brar
5921da177e4SLinus Torvaldsconfig USB_ETH
5931da177e4SLinus Torvalds	tristate "Ethernet Gadget (with CDC Ethernet support)"
5941da177e4SLinus Torvalds	depends on NET
595a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
5969e221be8SRandy Dunlap	select CRC32
5971da177e4SLinus Torvalds	help
5989b39e9ddSBrian Niebuhr	  This driver implements Ethernet style communication, in one of
5999b39e9ddSBrian Niebuhr	  several ways:
6001da177e4SLinus Torvalds
6011da177e4SLinus Torvalds	   - The "Communication Device Class" (CDC) Ethernet Control Model.
6021da177e4SLinus Torvalds	     That protocol is often avoided with pure Ethernet adapters, in
6031da177e4SLinus Torvalds	     favor of simpler vendor-specific hardware, but is widely
6041da177e4SLinus Torvalds	     supported by firmware for smart network devices.
6051da177e4SLinus Torvalds
6061da177e4SLinus Torvalds	   - On hardware can't implement that protocol, a simple CDC subset
6071da177e4SLinus Torvalds	     is used, placing fewer demands on USB.
6081da177e4SLinus Torvalds
6099b39e9ddSBrian Niebuhr	   - CDC Ethernet Emulation Model (EEM) is a newer standard that has
6109b39e9ddSBrian Niebuhr	     a simpler interface that can be used by more USB hardware.
6119b39e9ddSBrian Niebuhr
6129b39e9ddSBrian Niebuhr	  RNDIS support is an additional option, more demanding than than
6139b39e9ddSBrian Niebuhr	  subset.
6141da177e4SLinus Torvalds
6151da177e4SLinus Torvalds	  Within the USB device, this gadget driver exposes a network device
6161da177e4SLinus Torvalds	  "usbX", where X depends on what other networking devices you have.
6171da177e4SLinus Torvalds	  Treat it like a two-node Ethernet link:  host, and gadget.
6181da177e4SLinus Torvalds
6191da177e4SLinus Torvalds	  The Linux-USB host-side "usbnet" driver interoperates with this
6201da177e4SLinus Torvalds	  driver, so that deep I/O queues can be supported.  On 2.4 kernels,
6211da177e4SLinus Torvalds	  use "CDCEther" instead, if you're using the CDC option. That CDC
6221da177e4SLinus Torvalds	  mode should also interoperate with standard CDC Ethernet class
6231da177e4SLinus Torvalds	  drivers on other host operating systems.
6241da177e4SLinus Torvalds
6251da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
6261da177e4SLinus Torvalds	  dynamically linked module called "g_ether".
6271da177e4SLinus Torvalds
6281da177e4SLinus Torvaldsconfig USB_ETH_RNDIS
629afd0e0f2SRobert P. J. Day	bool "RNDIS support"
630afd0e0f2SRobert P. J. Day	depends on USB_ETH
631a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
6321da177e4SLinus Torvalds	default y
6331da177e4SLinus Torvalds	help
6341da177e4SLinus Torvalds	   Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
6351da177e4SLinus Torvalds	   and Microsoft provides redistributable binary RNDIS drivers for
6361da177e4SLinus Torvalds	   older versions of Windows.
6371da177e4SLinus Torvalds
6381da177e4SLinus Torvalds	   If you say "y" here, the Ethernet gadget driver will try to provide
6391da177e4SLinus Torvalds	   a second device configuration, supporting RNDIS to talk to such
6401da177e4SLinus Torvalds	   Microsoft USB hosts.
6411da177e4SLinus Torvalds
6421da177e4SLinus Torvalds	   To make MS-Windows work with this, use Documentation/usb/linux.inf
6431da177e4SLinus Torvalds	   as the "driver info file".  For versions of MS-Windows older than
6441da177e4SLinus Torvalds	   XP, you'll need to download drivers from Microsoft's website; a URL
6451da177e4SLinus Torvalds	   is given in comments found in that info file.
6461da177e4SLinus Torvalds
6479b39e9ddSBrian Niebuhrconfig USB_ETH_EEM
6489b39e9ddSBrian Niebuhr       bool "Ethernet Emulation Model (EEM) support"
6499b39e9ddSBrian Niebuhr       depends on USB_ETH
650a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
6519b39e9ddSBrian Niebuhr       default n
6529b39e9ddSBrian Niebuhr       help
6539b39e9ddSBrian Niebuhr         CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM
6549b39e9ddSBrian Niebuhr         and therefore can be supported by more hardware.  Technically ECM and
6559b39e9ddSBrian Niebuhr         EEM are designed for different applications.  The ECM model extends
6569b39e9ddSBrian Niebuhr         the network interface to the target (e.g. a USB cable modem), and the
6579b39e9ddSBrian Niebuhr         EEM model is for mobile devices to communicate with hosts using
6589b39e9ddSBrian Niebuhr         ethernet over USB.  For Linux gadgets, however, the interface with
6599b39e9ddSBrian Niebuhr         the host is the same (a usbX device), so the differences are minimal.
6609b39e9ddSBrian Niebuhr
6619b39e9ddSBrian Niebuhr         If you say "y" here, the Ethernet gadget driver will use the EEM
6629b39e9ddSBrian Niebuhr         protocol rather than ECM.  If unsure, say "n".
6639b39e9ddSBrian Niebuhr
6646c34d288SYauheni Kaliutaconfig USB_G_NCM
6656c34d288SYauheni Kaliuta	tristate "Network Control Model (NCM) support"
6666c34d288SYauheni Kaliuta	depends on NET
667a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
6686c34d288SYauheni Kaliuta	select CRC32
6696c34d288SYauheni Kaliuta	help
6706c34d288SYauheni Kaliuta	  This driver implements USB CDC NCM subclass standard. NCM is
6716c34d288SYauheni Kaliuta	  an advanced protocol for Ethernet encapsulation, allows grouping
672b55dd320SFabio Baltieri	  of several ethernet frames into one USB transfer and different
6736c34d288SYauheni Kaliuta	  alignment possibilities.
6746c34d288SYauheni Kaliuta
6756c34d288SYauheni Kaliuta	  Say "y" to link the driver statically, or "m" to build a
6766c34d288SYauheni Kaliuta	  dynamically linked module called "g_ncm".
6776c34d288SYauheni Kaliuta
6781da177e4SLinus Torvaldsconfig USB_GADGETFS
679eb83be98SGreg Kroah-Hartman	tristate "Gadget Filesystem"
6801da177e4SLinus Torvalds	help
6811da177e4SLinus Torvalds	  This driver provides a filesystem based API that lets user mode
6821da177e4SLinus Torvalds	  programs implement a single-configuration USB device, including
6831da177e4SLinus Torvalds	  endpoint I/O and control requests that don't relate to enumeration.
6841da177e4SLinus Torvalds	  All endpoints, transfer speeds, and transfer types supported by
6851da177e4SLinus Torvalds	  the hardware are available, through read() and write() calls.
6861da177e4SLinus Torvalds
6871da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
6881da177e4SLinus Torvalds	  dynamically linked module called "gadgetfs".
6891da177e4SLinus Torvalds
690c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS
691eb83be98SGreg Kroah-Hartman	tristate "Function Filesystem"
692a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
693f8dae531SMichal Nazarewicz	select USB_FUNCTIONFS_GENERIC if !(USB_FUNCTIONFS_ETH || USB_FUNCTIONFS_RNDIS)
694c6c56008SMichal Nazarewicz	help
695eabf0f5fSMichael Prokop	  The Function Filesystem (FunctionFS) lets one create USB
696eabf0f5fSMichael Prokop	  composite functions in user space in the same way GadgetFS
697c6c56008SMichal Nazarewicz	  lets one create USB gadgets in user space.  This allows creation
698c6c56008SMichal Nazarewicz	  of composite gadgets such that some of the functions are
699c6c56008SMichal Nazarewicz	  implemented in kernel space (for instance Ethernet, serial or
700c6c56008SMichal Nazarewicz	  mass storage) and other are implemented in user space.
701c6c56008SMichal Nazarewicz
702f8dae531SMichal Nazarewicz	  If you say "y" or "m" here you will be able what kind of
703f8dae531SMichal Nazarewicz	  configurations the gadget will provide.
704f8dae531SMichal Nazarewicz
705c6c56008SMichal Nazarewicz	  Say "y" to link the driver statically, or "m" to build
706c6c56008SMichal Nazarewicz	  a dynamically linked module called "g_ffs".
707c6c56008SMichal Nazarewicz
708c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_ETH
709f8dae531SMichal Nazarewicz	bool "Include configuration with CDC ECM (Ethernet)"
71017b2765eSRandy Dunlap	depends on USB_FUNCTIONFS && NET
711c6c56008SMichal Nazarewicz	help
712eabf0f5fSMichael Prokop	  Include a configuration with CDC ECM function (Ethernet) and the
713eabf0f5fSMichael Prokop	  Function Filesystem.
714c6c56008SMichal Nazarewicz
715c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_RNDIS
716f8dae531SMichal Nazarewicz	bool "Include configuration with RNDIS (Ethernet)"
71717b2765eSRandy Dunlap	depends on USB_FUNCTIONFS && NET
718c6c56008SMichal Nazarewicz	help
719eabf0f5fSMichael Prokop	  Include a configuration with RNDIS function (Ethernet) and the Filesystem.
720c6c56008SMichal Nazarewicz
721c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_GENERIC
722c6c56008SMichal Nazarewicz	bool "Include 'pure' configuration"
723f8dae531SMichal Nazarewicz	depends on USB_FUNCTIONFS
724c6c56008SMichal Nazarewicz	help
725f8dae531SMichal Nazarewicz	  Include a configuration with the Function Filesystem alone with
726f8dae531SMichal Nazarewicz	  no Ethernet interface.
727c6c56008SMichal Nazarewicz
728d23b0f08SMichal Nazarewiczconfig USB_MASS_STORAGE
729d23b0f08SMichal Nazarewicz	tristate "Mass Storage Gadget"
730d23b0f08SMichal Nazarewicz	depends on BLOCK
731a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
732d23b0f08SMichal Nazarewicz	help
733d23b0f08SMichal Nazarewicz	  The Mass Storage Gadget acts as a USB Mass Storage disk drive.
734d23b0f08SMichal Nazarewicz	  As its storage repository it can use a regular file or a block
735d23b0f08SMichal Nazarewicz	  device (in much the same way as the "loop" device driver),
736d23b0f08SMichal Nazarewicz	  specified as a module parameter or sysfs option.
737d23b0f08SMichal Nazarewicz
738fa06920aSMichal Nazarewicz	  This driver is a replacement for now removed File-backed
739fa06920aSMichal Nazarewicz	  Storage Gadget (g_file_storage).
740d23b0f08SMichal Nazarewicz
741d23b0f08SMichal Nazarewicz	  Say "y" to link the driver statically, or "m" to build
742664a51a8SAlan Stern	  a dynamically linked module called "g_mass_storage".
743d23b0f08SMichal Nazarewicz
744c52661d6SSebastian Andrzej Siewiorconfig USB_GADGET_TARGET
745c52661d6SSebastian Andrzej Siewior	tristate "USB Gadget Target Fabric Module"
746c52661d6SSebastian Andrzej Siewior	depends on TARGET_CORE
747a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
748c52661d6SSebastian Andrzej Siewior	help
749c52661d6SSebastian Andrzej Siewior	  This fabric is an USB gadget. Two USB protocols are supported that is
750c52661d6SSebastian Andrzej Siewior	  BBB or BOT (Bulk Only Transport) and UAS (USB Attached SCSI). BOT is
751c52661d6SSebastian Andrzej Siewior	  advertised on alternative interface 0 (primary) and UAS is on
752c52661d6SSebastian Andrzej Siewior	  alternative interface 1. Both protocols can work on USB2.0 and USB3.0.
753c52661d6SSebastian Andrzej Siewior	  UAS utilizes the USB 3.0 feature called streams support.
754c52661d6SSebastian Andrzej Siewior
7551da177e4SLinus Torvaldsconfig USB_G_SERIAL
7563086775aSFelipe Balbi	tristate "Serial Gadget (with CDC ACM and CDC OBEX support)"
757a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
7581da177e4SLinus Torvalds	help
7591da177e4SLinus Torvalds	  The Serial Gadget talks to the Linux-USB generic serial driver.
7601da177e4SLinus Torvalds	  This driver supports a CDC-ACM module option, which can be used
7611da177e4SLinus Torvalds	  to interoperate with MS-Windows hosts or with the Linux-USB
7621da177e4SLinus Torvalds	  "cdc-acm" driver.
7631da177e4SLinus Torvalds
7643086775aSFelipe Balbi	  This driver also supports a CDC-OBEX option.  You will need a
7653086775aSFelipe Balbi	  user space OBEX server talking to /dev/ttyGS*, since the kernel
7663086775aSFelipe Balbi	  itself doesn't implement the OBEX protocol.
7673086775aSFelipe Balbi
7681da177e4SLinus Torvalds	  Say "y" to link the driver statically, or "m" to build a
7691da177e4SLinus Torvalds	  dynamically linked module called "g_serial".
7701da177e4SLinus Torvalds
7711da177e4SLinus Torvalds	  For more information, see Documentation/usb/gadget_serial.txt
7721da177e4SLinus Torvalds	  which includes instructions and a "driver info file" needed to
7733086775aSFelipe Balbi	  make MS-Windows work with CDC ACM.
7741da177e4SLinus Torvalds
775f2ebf92cSBen Williamsonconfig USB_MIDI_GADGET
776eb83be98SGreg Kroah-Hartman	tristate "MIDI Gadget"
777eb83be98SGreg Kroah-Hartman	depends on SND
778a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
779f2ebf92cSBen Williamson	select SND_RAWMIDI
780f2ebf92cSBen Williamson	help
781f2ebf92cSBen Williamson	  The MIDI Gadget acts as a USB Audio device, with one MIDI
782f2ebf92cSBen Williamson	  input and one MIDI output. These MIDI jacks appear as
783f2ebf92cSBen Williamson	  a sound "card" in the ALSA sound system. Other MIDI
784f2ebf92cSBen Williamson	  connections can then be made on the gadget system, using
785f2ebf92cSBen Williamson	  ALSA's aconnect utility etc.
786f2ebf92cSBen Williamson
787f2ebf92cSBen Williamson	  Say "y" to link the driver statically, or "m" to build a
788f2ebf92cSBen Williamson	  dynamically linked module called "g_midi".
789f2ebf92cSBen Williamson
79025a010c8SCraig W. Nadlerconfig USB_G_PRINTER
79125a010c8SCraig W. Nadler	tristate "Printer Gadget"
792a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
79325a010c8SCraig W. Nadler	help
79425a010c8SCraig W. Nadler	  The Printer Gadget channels data between the USB host and a
79525a010c8SCraig W. Nadler	  userspace program driving the print engine. The user space
79625a010c8SCraig W. Nadler	  program reads and writes the device file /dev/g_printer to
79725a010c8SCraig W. Nadler	  receive or send printer data. It can use ioctl calls to
79825a010c8SCraig W. Nadler	  the device file to get or set printer status.
79925a010c8SCraig W. Nadler
80025a010c8SCraig W. Nadler	  Say "y" to link the driver statically, or "m" to build a
80125a010c8SCraig W. Nadler	  dynamically linked module called "g_printer".
80225a010c8SCraig W. Nadler
80325a010c8SCraig W. Nadler	  For more information, see Documentation/usb/gadget_printer.txt
80425a010c8SCraig W. Nadler	  which includes sample code for accessing the device file.
8051da177e4SLinus Torvalds
80619e20680SDavid Brownellconfig USB_CDC_COMPOSITE
80719e20680SDavid Brownell	tristate "CDC Composite Device (Ethernet and ACM)"
8084ddd9ec1SRandy Dunlap	depends on NET
809a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
81019e20680SDavid Brownell	help
81119e20680SDavid Brownell	  This driver provides two functions in one configuration:
81219e20680SDavid Brownell	  a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link.
81319e20680SDavid Brownell
81419e20680SDavid Brownell	  This driver requires four bulk and two interrupt endpoints,
81519e20680SDavid Brownell	  plus the ability to handle altsettings.  Not all peripheral
81619e20680SDavid Brownell	  controllers are that capable.
81719e20680SDavid Brownell
81819e20680SDavid Brownell	  Say "y" to link the driver statically, or "m" to build a
81919e20680SDavid Brownell	  dynamically linked module.
82019e20680SDavid Brownell
821f358f5b4SFelipe Balbiconfig USB_G_NOKIA
822f358f5b4SFelipe Balbi	tristate "Nokia composite gadget"
823f358f5b4SFelipe Balbi	depends on PHONET
824a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
825f358f5b4SFelipe Balbi	help
826f358f5b4SFelipe Balbi	  The Nokia composite gadget provides support for acm, obex
827f358f5b4SFelipe Balbi	  and phonet in only one composite gadget driver.
828f358f5b4SFelipe Balbi
829f358f5b4SFelipe Balbi	  It's only really useful for N900 hardware. If you're building
830f358f5b4SFelipe Balbi	  a kernel for N900, say Y or M here. If unsure, say N.
831f358f5b4SFelipe Balbi
832fa3ae0c1SKlaus Schwarzkopfconfig USB_G_ACM_MS
833fa3ae0c1SKlaus Schwarzkopf	tristate "CDC Composite Device (ACM and mass storage)"
834fa3ae0c1SKlaus Schwarzkopf	depends on BLOCK
835a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
836fa3ae0c1SKlaus Schwarzkopf	help
837fa3ae0c1SKlaus Schwarzkopf	  This driver provides two functions in one configuration:
838fa3ae0c1SKlaus Schwarzkopf	  a mass storage, and a CDC ACM (serial port) link.
839fa3ae0c1SKlaus Schwarzkopf
840fa3ae0c1SKlaus Schwarzkopf	  Say "y" to link the driver statically, or "m" to build a
841fa3ae0c1SKlaus Schwarzkopf	  dynamically linked module called "g_acm_ms".
842fa3ae0c1SKlaus Schwarzkopf
843f176a5d8SMichal Nazarewiczconfig USB_G_MULTI
844eb83be98SGreg Kroah-Hartman	tristate "Multifunction Composite Gadget"
8455791e103SRandy Dunlap	depends on BLOCK && NET
846279cc49aSMichal Nazarewicz	select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS
847a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
848f176a5d8SMichal Nazarewicz	help
849f176a5d8SMichal Nazarewicz	  The Multifunction Composite Gadget provides Ethernet (RNDIS
850f176a5d8SMichal Nazarewicz	  and/or CDC Ethernet), mass storage and ACM serial link
851f176a5d8SMichal Nazarewicz	  interfaces.
852f176a5d8SMichal Nazarewicz
8535791e103SRandy Dunlap	  You will be asked to choose which of the two configurations is
854f176a5d8SMichal Nazarewicz	  to be available in the gadget.  At least one configuration must
8555791e103SRandy Dunlap	  be chosen to make the gadget usable.  Selecting more than one
856f176a5d8SMichal Nazarewicz	  configuration will prevent Windows from automatically detecting
8575791e103SRandy Dunlap	  the gadget as a composite gadget, so an INF file will be needed to
858f176a5d8SMichal Nazarewicz	  use the gadget.
859f176a5d8SMichal Nazarewicz
860f176a5d8SMichal Nazarewicz	  Say "y" to link the driver statically, or "m" to build a
861f176a5d8SMichal Nazarewicz	  dynamically linked module called "g_multi".
862f176a5d8SMichal Nazarewicz
863f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_RNDIS
864f176a5d8SMichal Nazarewicz	bool "RNDIS + CDC Serial + Storage configuration"
865f176a5d8SMichal Nazarewicz	depends on USB_G_MULTI
866f176a5d8SMichal Nazarewicz	default y
867f176a5d8SMichal Nazarewicz	help
868f176a5d8SMichal Nazarewicz	  This option enables a configuration with RNDIS, CDC Serial and
869f176a5d8SMichal Nazarewicz	  Mass Storage functions available in the Multifunction Composite
8705791e103SRandy Dunlap	  Gadget.  This is the configuration dedicated for Windows since RNDIS
8715791e103SRandy Dunlap	  is Microsoft's protocol.
872f176a5d8SMichal Nazarewicz
873f176a5d8SMichal Nazarewicz	  If unsure, say "y".
874f176a5d8SMichal Nazarewicz
875f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_CDC
876f176a5d8SMichal Nazarewicz	bool "CDC Ethernet + CDC Serial + Storage configuration"
877f176a5d8SMichal Nazarewicz	depends on USB_G_MULTI
878f176a5d8SMichal Nazarewicz	default n
879f176a5d8SMichal Nazarewicz	help
880f176a5d8SMichal Nazarewicz	  This option enables a configuration with CDC Ethernet (ECM), CDC
881f176a5d8SMichal Nazarewicz	  Serial and Mass Storage functions available in the Multifunction
8825791e103SRandy Dunlap	  Composite Gadget.
883f176a5d8SMichal Nazarewicz
884f176a5d8SMichal Nazarewicz	  If unsure, say "y".
885f176a5d8SMichal Nazarewicz
88671adf118SFabien Chouteauconfig USB_G_HID
88771adf118SFabien Chouteau	tristate "HID Gadget"
888a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
88971adf118SFabien Chouteau	help
89071adf118SFabien Chouteau	  The HID gadget driver provides generic emulation of USB
89171adf118SFabien Chouteau	  Human Interface Devices (HID).
89271adf118SFabien Chouteau
89371adf118SFabien Chouteau	  For more information, see Documentation/usb/gadget_hid.txt which
89471adf118SFabien Chouteau	  includes sample code for accessing the device files.
89571adf118SFabien Chouteau
89671adf118SFabien Chouteau	  Say "y" to link the driver statically, or "m" to build a
89771adf118SFabien Chouteau	  dynamically linked module called "g_hid".
898f176a5d8SMichal Nazarewicz
899a84d9e53SSebastian Andrzej Siewior# Standalone / single function gadgets
900f6c826a9Sstephane duvergerconfig USB_G_DBGP
901f6c826a9Sstephane duverger	tristate "EHCI Debug Device Gadget"
902a84d9e53SSebastian Andrzej Siewior	select USB_LIBCOMPOSITE
903f6c826a9Sstephane duverger	help
904f6c826a9Sstephane duverger	  This gadget emulates an EHCI Debug device. This is useful when you want
905f6c826a9Sstephane duverger	  to interact with an EHCI Debug Port.
906f6c826a9Sstephane duverger
907f6c826a9Sstephane duverger	  Say "y" to link the driver statically, or "m" to build a
908f6c826a9Sstephane duverger	  dynamically linked module called "g_dbgp".
909f6c826a9Sstephane duverger
910f6c826a9Sstephane duvergerif USB_G_DBGP
911f6c826a9Sstephane duvergerchoice
912f6c826a9Sstephane duverger	prompt "EHCI Debug Device mode"
913f6c826a9Sstephane duverger	default USB_G_DBGP_SERIAL
914f6c826a9Sstephane duverger
915f6c826a9Sstephane duvergerconfig USB_G_DBGP_PRINTK
916f6c826a9Sstephane duverger	depends on USB_G_DBGP
917f6c826a9Sstephane duverger	bool "printk"
918f6c826a9Sstephane duverger	help
919f6c826a9Sstephane duverger	  Directly printk() received data. No interaction.
920f6c826a9Sstephane duverger
921f6c826a9Sstephane duvergerconfig USB_G_DBGP_SERIAL
922f6c826a9Sstephane duverger	depends on USB_G_DBGP
923f6c826a9Sstephane duverger	bool "serial"
924f6c826a9Sstephane duverger	help
925f6c826a9Sstephane duverger	  Userland can interact using /dev/ttyGSxxx.
926f6c826a9Sstephane duvergerendchoice
927f6c826a9Sstephane duvergerendif
928f6c826a9Sstephane duverger
9291da177e4SLinus Torvalds# put drivers that need isochronous transfer support (for audio
9301da177e4SLinus Torvalds# or video class gadget drivers), or specific hardware, here.
931a9914127SLaurent Pinchartconfig USB_G_WEBCAM
932a9914127SLaurent Pinchart	tristate "USB Webcam Gadget"
93324337c13SRandy Dunlap	depends on VIDEO_DEV
9340b2ffb78SLaurent Pinchart	select USB_LIBCOMPOSITE
935a9914127SLaurent Pinchart	help
936a9914127SLaurent Pinchart	  The Webcam Gadget acts as a composite USB Audio and Video Class
937a9914127SLaurent Pinchart	  device. It provides a userspace API to process UVC control requests
938a9914127SLaurent Pinchart	  and stream video data to the host.
9391da177e4SLinus Torvalds
940a9914127SLaurent Pinchart	  Say "y" to link the driver statically, or "m" to build a
941a9914127SLaurent Pinchart	  dynamically linked module called "g_webcam".
9421da177e4SLinus Torvalds
9431da177e4SLinus Torvaldsendchoice
9441da177e4SLinus Torvalds
945b75be4abSDenis Chengendif # USB_GADGET
946