11da177e4SLinus Torvalds# 21da177e4SLinus Torvalds# USB Gadget support on a system involves 31da177e4SLinus Torvalds# (a) a peripheral controller, and 41da177e4SLinus Torvalds# (b) the gadget driver using it. 51da177e4SLinus Torvalds# 61da177e4SLinus Torvalds# NOTE: Gadget support ** DOES NOT ** depend on host-side CONFIG_USB !! 71da177e4SLinus Torvalds# 81da177e4SLinus Torvalds# - Host systems (like PCs) need CONFIG_USB (with "A" jacks). 91da177e4SLinus Torvalds# - Peripherals (like PDAs) need CONFIG_USB_GADGET (with "B" jacks). 10cab00891SMatt LaPlante# - Some systems have both kinds of controllers. 111da177e4SLinus Torvalds# 121da177e4SLinus Torvalds# With help from a special transceiver and a "Mini-AB" jack, systems with 131da177e4SLinus Torvalds# both kinds of controller can also support "USB On-the-Go" (CONFIG_USB_OTG). 141da177e4SLinus Torvalds# 151da177e4SLinus Torvalds 16b75be4abSDenis Chengmenuconfig USB_GADGET 17b75be4abSDenis Cheng tristate "USB Gadget Support" 181da177e4SLinus Torvalds help 191da177e4SLinus Torvalds USB is a master/slave protocol, organized with one master 201da177e4SLinus Torvalds host (such as a PC) controlling up to 127 peripheral devices. 211da177e4SLinus Torvalds The USB hardware is asymmetric, which makes it easier to set up: 221da177e4SLinus Torvalds you can't connect a "to-the-host" connector to a peripheral. 231da177e4SLinus Torvalds 241da177e4SLinus Torvalds Linux can run in the host, or in the peripheral. In both cases 251da177e4SLinus Torvalds you need a low level bus controller driver, and some software 261da177e4SLinus Torvalds talking to it. Peripheral controllers are often discrete silicon, 271da177e4SLinus Torvalds or are integrated with the CPU in a microcontroller. The more 28e113f29cSJules Villard familiar host side controllers have names like "EHCI", "OHCI", 291da177e4SLinus Torvalds or "UHCI", and are usually integrated into southbridges on PC 301da177e4SLinus Torvalds motherboards. 311da177e4SLinus Torvalds 321da177e4SLinus Torvalds Enable this configuration option if you want to run Linux inside 331da177e4SLinus Torvalds a USB peripheral device. Configure one hardware driver for your 341da177e4SLinus Torvalds peripheral/device side bus controller, and a "gadget driver" for 351da177e4SLinus Torvalds your peripheral protocol. (If you use modular gadget drivers, 361da177e4SLinus Torvalds you may configure more than one.) 371da177e4SLinus Torvalds 381da177e4SLinus Torvalds If in doubt, say "N" and don't enable these drivers; most people 391da177e4SLinus Torvalds don't have this kind of hardware (except maybe inside Linux PDAs). 401da177e4SLinus Torvalds 411da177e4SLinus Torvalds For more information, see <http://www.linux-usb.org/gadget> and 421da177e4SLinus Torvalds the kernel DocBook documentation for this API. 431da177e4SLinus Torvalds 44b75be4abSDenis Chengif USB_GADGET 45b75be4abSDenis Cheng 4670790f63SDavid Brownellconfig USB_GADGET_DEBUG 47afd0e0f2SRobert P. J. Day boolean "Debugging messages (DEVELOPMENT)" 4836e893d2SDavid Brownell depends on DEBUG_KERNEL 4970790f63SDavid Brownell help 5070790f63SDavid Brownell Many controller and gadget drivers will print some debugging 5170790f63SDavid Brownell messages if you use this option to ask for those messages. 5270790f63SDavid Brownell 5370790f63SDavid Brownell Avoid enabling these messages, even if you're actively 5470790f63SDavid Brownell debugging such a driver. Many drivers will emit so many 5570790f63SDavid Brownell messages that the driver timings are affected, which will 5670790f63SDavid Brownell either create new failure modes or remove the one you're 5770790f63SDavid Brownell trying to track down. Never enable these messages for a 5870790f63SDavid Brownell production build. 5970790f63SDavid Brownell 601da177e4SLinus Torvaldsconfig USB_GADGET_DEBUG_FILES 61afd0e0f2SRobert P. J. Day boolean "Debugging information files (DEVELOPMENT)" 6236e893d2SDavid Brownell depends on PROC_FS 631da177e4SLinus Torvalds help 641da177e4SLinus Torvalds Some of the drivers in the "gadget" framework can expose 651da177e4SLinus Torvalds debugging information in files such as /proc/driver/udc 661da177e4SLinus Torvalds (for a peripheral controller). The information in these 671da177e4SLinus Torvalds files may help when you're troubleshooting or bringing up a 681da177e4SLinus Torvalds driver on a new board. Enable these files by choosing "Y" 691da177e4SLinus Torvalds here. If in doubt, or to conserve kernel memory, say "N". 701da177e4SLinus Torvalds 71914a3f3bSHaavard Skinnemoenconfig USB_GADGET_DEBUG_FS 72afd0e0f2SRobert P. J. Day boolean "Debugging information files in debugfs (DEVELOPMENT)" 7336e893d2SDavid Brownell depends on DEBUG_FS 74914a3f3bSHaavard Skinnemoen help 75914a3f3bSHaavard Skinnemoen Some of the drivers in the "gadget" framework can expose 76914a3f3bSHaavard Skinnemoen debugging information in files under /sys/kernel/debug/. 77914a3f3bSHaavard Skinnemoen The information in these files may help when you're 78914a3f3bSHaavard Skinnemoen troubleshooting or bringing up a driver on a new board. 79914a3f3bSHaavard Skinnemoen Enable these files by choosing "Y" here. If in doubt, or 80914a3f3bSHaavard Skinnemoen to conserve kernel memory, say "N". 81914a3f3bSHaavard Skinnemoen 8236e893d2SDavid Brownellconfig USB_GADGET_VBUS_DRAW 8336e893d2SDavid Brownell int "Maximum VBUS Power usage (2-500 mA)" 8436e893d2SDavid Brownell range 2 500 8536e893d2SDavid Brownell default 2 8636e893d2SDavid Brownell help 8736e893d2SDavid Brownell Some devices need to draw power from USB when they are 8836e893d2SDavid Brownell configured, perhaps to operate circuitry or to recharge 8936e893d2SDavid Brownell batteries. This is in addition to any local power supply, 9036e893d2SDavid Brownell such as an AC adapter or batteries. 9136e893d2SDavid Brownell 9236e893d2SDavid Brownell Enter the maximum power your device draws through USB, in 9336e893d2SDavid Brownell milliAmperes. The permitted range of values is 2 - 500 mA; 9436e893d2SDavid Brownell 0 mA would be legal, but can make some hosts misbehave. 9536e893d2SDavid Brownell 9636e893d2SDavid Brownell This value will be used except for system-specific gadget 9736e893d2SDavid Brownell drivers that have more specific information. 9836e893d2SDavid Brownell 99028b271bSDavid Brownellconfig USB_GADGET_SELECTED 100028b271bSDavid Brownell boolean 101028b271bSDavid Brownell 1021da177e4SLinus Torvalds# 1031da177e4SLinus Torvalds# USB Peripheral Controller Support 1041da177e4SLinus Torvalds# 105a7a19facSDavid Brownell# The order here is alphabetical, except that integrated controllers go 106a7a19facSDavid Brownell# before discrete ones so they will be the initial/default value: 107a7a19facSDavid Brownell# - integrated/SOC controllers first 108a7a19facSDavid Brownell# - licensed IP used in both SOC and discrete versions 109a7a19facSDavid Brownell# - discrete ones (including all PCI-only controllers) 110a7a19facSDavid Brownell# - debug/dummy gadget+hcd is last. 111a7a19facSDavid Brownell# 1121da177e4SLinus Torvaldschoice 1131da177e4SLinus Torvalds prompt "USB Peripheral Controller" 1141da177e4SLinus Torvalds depends on USB_GADGET 1151da177e4SLinus Torvalds help 1161da177e4SLinus Torvalds A USB device uses a controller to talk to its host. 1171da177e4SLinus Torvalds Systems should have only one such upstream link. 1181da177e4SLinus Torvalds Many controller drivers are platform-specific; these 1191da177e4SLinus Torvalds often need board-specific hooks. 1201da177e4SLinus Torvalds 121a7a19facSDavid Brownell# 122a7a19facSDavid Brownell# Integrated controllers 123a7a19facSDavid Brownell# 124a7a19facSDavid Brownell 125a7a19facSDavid Brownellconfig USB_GADGET_AT91 126a7a19facSDavid Brownell boolean "Atmel AT91 USB Device Port" 127aa781af0SNicolas Ferre depends on ARCH_AT91 && !ARCH_AT91SAM9RL && !ARCH_AT91CAP9 && !ARCH_AT91SAM9G45 128a7a19facSDavid Brownell select USB_GADGET_SELECTED 12955d402d8SThomas Dahlmann help 130a7a19facSDavid Brownell Many Atmel AT91 processors (such as the AT91RM2000) have a 131a7a19facSDavid Brownell full speed USB Device Port with support for five configurable 132a7a19facSDavid Brownell endpoints (plus endpoint zero). 13355d402d8SThomas Dahlmann 13455d402d8SThomas Dahlmann Say "y" to link the driver statically, or "m" to build a 135a7a19facSDavid Brownell dynamically linked module called "at91_udc" and force all 13655d402d8SThomas Dahlmann gadget drivers to also be dynamically linked. 13755d402d8SThomas Dahlmann 138a7a19facSDavid Brownellconfig USB_AT91 13955d402d8SThomas Dahlmann tristate 140a7a19facSDavid Brownell depends on USB_GADGET_AT91 14155d402d8SThomas Dahlmann default USB_GADGET 14255d402d8SThomas Dahlmann 143914a3f3bSHaavard Skinnemoenconfig USB_GADGET_ATMEL_USBA 144914a3f3bSHaavard Skinnemoen boolean "Atmel USBA" 145914a3f3bSHaavard Skinnemoen select USB_GADGET_DUALSPEED 146aa781af0SNicolas Ferre depends on AVR32 || ARCH_AT91CAP9 || ARCH_AT91SAM9RL || ARCH_AT91SAM9G45 147914a3f3bSHaavard Skinnemoen help 148914a3f3bSHaavard Skinnemoen USBA is the integrated high-speed USB Device controller on 149ba45ca43SNicolas Ferre the AT32AP700x, some AT91SAM9 and AT91CAP9 processors from Atmel. 150914a3f3bSHaavard Skinnemoen 151914a3f3bSHaavard Skinnemoenconfig USB_ATMEL_USBA 152914a3f3bSHaavard Skinnemoen tristate 153914a3f3bSHaavard Skinnemoen depends on USB_GADGET_ATMEL_USBA 154914a3f3bSHaavard Skinnemoen default USB_GADGET 155914a3f3bSHaavard Skinnemoen select USB_GADGET_SELECTED 156914a3f3bSHaavard Skinnemoen 157b504882dSLi Yangconfig USB_GADGET_FSL_USB2 158b504882dSLi Yang boolean "Freescale Highspeed USB DR Peripheral Controller" 15954e4026bSGuennadi Liakhovetski depends on FSL_SOC || ARCH_MXC 160b504882dSLi Yang select USB_GADGET_DUALSPEED 161018b97d0SMarc Kleine-Budde select USB_FSL_MPH_DR_OF if OF 162b504882dSLi Yang help 163b504882dSLi Yang Some of Freescale PowerPC processors have a High Speed 164b504882dSLi Yang Dual-Role(DR) USB controller, which supports device mode. 165b504882dSLi Yang 166b504882dSLi Yang The number of programmable endpoints is different through 167b504882dSLi Yang SOC revisions. 168b504882dSLi Yang 169b504882dSLi Yang Say "y" to link the driver statically, or "m" to build a 170b504882dSLi Yang dynamically linked module called "fsl_usb2_udc" and force 171b504882dSLi Yang all gadget drivers to also be dynamically linked. 172b504882dSLi Yang 173b504882dSLi Yangconfig USB_FSL_USB2 174b504882dSLi Yang tristate 175b504882dSLi Yang depends on USB_GADGET_FSL_USB2 176b504882dSLi Yang default USB_GADGET 177b504882dSLi Yang select USB_GADGET_SELECTED 178b504882dSLi Yang 1791da177e4SLinus Torvaldsconfig USB_GADGET_LH7A40X 1801da177e4SLinus Torvalds boolean "LH7A40X" 1811da177e4SLinus Torvalds depends on ARCH_LH7A40X 1821da177e4SLinus Torvalds help 1831da177e4SLinus Torvalds This driver provides USB Device Controller driver for LH7A40x 1841da177e4SLinus Torvalds 1851da177e4SLinus Torvaldsconfig USB_LH7A40X 1861da177e4SLinus Torvalds tristate 1871da177e4SLinus Torvalds depends on USB_GADGET_LH7A40X 1881da177e4SLinus Torvalds default USB_GADGET 189028b271bSDavid Brownell select USB_GADGET_SELECTED 1901da177e4SLinus Torvalds 1911da177e4SLinus Torvaldsconfig USB_GADGET_OMAP 1921da177e4SLinus Torvalds boolean "OMAP USB Device Controller" 1931da177e4SLinus Torvalds depends on ARCH_OMAP 194f1c9e151STony Lindgren select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3 || MACH_OMAP_H4_OTG 19554b9ed35SDavid Brownell select USB_OTG_UTILS if ARCH_OMAP 1961da177e4SLinus Torvalds help 1971da177e4SLinus Torvalds Many Texas Instruments OMAP processors have flexible full 1981da177e4SLinus Torvalds speed USB device controllers, with support for up to 30 1991da177e4SLinus Torvalds endpoints (plus endpoint zero). This driver supports the 2001da177e4SLinus Torvalds controller in the OMAP 1611, and should work with controllers 2011da177e4SLinus Torvalds in other OMAP processors too, given minor tweaks. 2021da177e4SLinus Torvalds 2031da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 2041da177e4SLinus Torvalds dynamically linked module called "omap_udc" and force all 2051da177e4SLinus Torvalds gadget drivers to also be dynamically linked. 2061da177e4SLinus Torvalds 2071da177e4SLinus Torvaldsconfig USB_OMAP 2081da177e4SLinus Torvalds tristate 2091da177e4SLinus Torvalds depends on USB_GADGET_OMAP 2101da177e4SLinus Torvalds default USB_GADGET 211028b271bSDavid Brownell select USB_GADGET_SELECTED 2121da177e4SLinus Torvalds 213a7a19facSDavid Brownellconfig USB_GADGET_PXA25X 214a7a19facSDavid Brownell boolean "PXA 25x or IXP 4xx" 215a7a19facSDavid Brownell depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX 21609963911SRussell King select USB_OTG_UTILS 217a7a19facSDavid Brownell help 218a7a19facSDavid Brownell Intel's PXA 25x series XScale ARM-5TE processors include 219a7a19facSDavid Brownell an integrated full speed USB 1.1 device controller. The 220a7a19facSDavid Brownell controller in the IXP 4xx series is register-compatible. 221a7a19facSDavid Brownell 222a7a19facSDavid Brownell It has fifteen fixed-function endpoints, as well as endpoint 223a7a19facSDavid Brownell zero (for control transfers). 224a7a19facSDavid Brownell 225a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 226a7a19facSDavid Brownell dynamically linked module called "pxa25x_udc" and force all 227a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 228a7a19facSDavid Brownell 229a7a19facSDavid Brownellconfig USB_PXA25X 230a7a19facSDavid Brownell tristate 231a7a19facSDavid Brownell depends on USB_GADGET_PXA25X 232a7a19facSDavid Brownell default USB_GADGET 233a7a19facSDavid Brownell select USB_GADGET_SELECTED 234a7a19facSDavid Brownell 235a7a19facSDavid Brownell# if there's only one gadget driver, using only two bulk endpoints, 236a7a19facSDavid Brownell# don't waste memory for the other endpoints 237a7a19facSDavid Brownellconfig USB_PXA25X_SMALL 238a7a19facSDavid Brownell depends on USB_GADGET_PXA25X 239a7a19facSDavid Brownell bool 240a7a19facSDavid Brownell default n if USB_ETH_RNDIS 241a7a19facSDavid Brownell default y if USB_ZERO 242a7a19facSDavid Brownell default y if USB_ETH 243a7a19facSDavid Brownell default y if USB_G_SERIAL 244a7a19facSDavid Brownell 245c4144247SYoshihiro Shimodaconfig USB_GADGET_R8A66597 246c4144247SYoshihiro Shimoda boolean "Renesas R8A66597 USB Peripheral Controller" 247c4144247SYoshihiro Shimoda select USB_GADGET_DUALSPEED 248c4144247SYoshihiro Shimoda help 249c4144247SYoshihiro Shimoda R8A66597 is a discrete USB host and peripheral controller chip that 250c4144247SYoshihiro Shimoda supports both full and high speed USB 2.0 data transfers. 251c4144247SYoshihiro Shimoda It has nine configurable endpoints, and endpoint zero. 252c4144247SYoshihiro Shimoda 253c4144247SYoshihiro Shimoda Say "y" to link the driver statically, or "m" to build a 254c4144247SYoshihiro Shimoda dynamically linked module called "r8a66597_udc" and force all 255c4144247SYoshihiro Shimoda gadget drivers to also be dynamically linked. 256c4144247SYoshihiro Shimoda 257c4144247SYoshihiro Shimodaconfig USB_R8A66597 258c4144247SYoshihiro Shimoda tristate 259c4144247SYoshihiro Shimoda depends on USB_GADGET_R8A66597 260c4144247SYoshihiro Shimoda default USB_GADGET 261c4144247SYoshihiro Shimoda select USB_GADGET_SELECTED 262c4144247SYoshihiro Shimoda 263a7a19facSDavid Brownellconfig USB_GADGET_PXA27X 264a7a19facSDavid Brownell boolean "PXA 27x" 2659f5351b7SRobert Jarzmik depends on ARCH_PXA && (PXA27x || PXA3xx) 2667fec3c25SRobert Jarzmik select USB_OTG_UTILS 267a7a19facSDavid Brownell help 268a7a19facSDavid Brownell Intel's PXA 27x series XScale ARM v5TE processors include 269a7a19facSDavid Brownell an integrated full speed USB 1.1 device controller. 270a7a19facSDavid Brownell 271a7a19facSDavid Brownell It has up to 23 endpoints, as well as endpoint zero (for 272a7a19facSDavid Brownell control transfers). 273a7a19facSDavid Brownell 274a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 275a7a19facSDavid Brownell dynamically linked module called "pxa27x_udc" and force all 276a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 277a7a19facSDavid Brownell 278a7a19facSDavid Brownellconfig USB_PXA27X 279a7a19facSDavid Brownell tristate 280a7a19facSDavid Brownell depends on USB_GADGET_PXA27X 281a7a19facSDavid Brownell default USB_GADGET 282a7a19facSDavid Brownell select USB_GADGET_SELECTED 283a7a19facSDavid Brownell 2845b7d70c6SBen Dooksconfig USB_GADGET_S3C_HSOTG 2855b7d70c6SBen Dooks boolean "S3C HS/OtG USB Device controller" 2865b7d70c6SBen Dooks depends on S3C_DEV_USB_HSOTG 2875b7d70c6SBen Dooks select USB_GADGET_S3C_HSOTG_PIO 2880287e43dSMaurus Cuelenaere select USB_GADGET_DUALSPEED 2895b7d70c6SBen Dooks help 2905b7d70c6SBen Dooks The Samsung S3C64XX USB2.0 high-speed gadget controller 2915b7d70c6SBen Dooks integrated into the S3C64XX series SoC. 2925b7d70c6SBen Dooks 2935b7d70c6SBen Dooksconfig USB_S3C_HSOTG 2945b7d70c6SBen Dooks tristate 2955b7d70c6SBen Dooks depends on USB_GADGET_S3C_HSOTG 2965b7d70c6SBen Dooks default USB_GADGET 2975b7d70c6SBen Dooks select USB_GADGET_SELECTED 2985b7d70c6SBen Dooks 299c03e7d4bSPaulius Zaleckasconfig USB_GADGET_IMX 300c03e7d4bSPaulius Zaleckas boolean "Freescale IMX USB Peripheral Controller" 301c03e7d4bSPaulius Zaleckas depends on ARCH_MX1 302c03e7d4bSPaulius Zaleckas help 303c03e7d4bSPaulius Zaleckas Freescale's IMX series include an integrated full speed 304c03e7d4bSPaulius Zaleckas USB 1.1 device controller. The controller in the IMX series 305c03e7d4bSPaulius Zaleckas is register-compatible. 306c03e7d4bSPaulius Zaleckas 307c03e7d4bSPaulius Zaleckas It has Six fixed-function endpoints, as well as endpoint 308c03e7d4bSPaulius Zaleckas zero (for control transfers). 309c03e7d4bSPaulius Zaleckas 310c03e7d4bSPaulius Zaleckas Say "y" to link the driver statically, or "m" to build a 311c03e7d4bSPaulius Zaleckas dynamically linked module called "imx_udc" and force all 312c03e7d4bSPaulius Zaleckas gadget drivers to also be dynamically linked. 313c03e7d4bSPaulius Zaleckas 314c03e7d4bSPaulius Zaleckasconfig USB_IMX 315c03e7d4bSPaulius Zaleckas tristate 316c03e7d4bSPaulius Zaleckas depends on USB_GADGET_IMX 317c03e7d4bSPaulius Zaleckas default USB_GADGET 318c03e7d4bSPaulius Zaleckas select USB_GADGET_SELECTED 319c03e7d4bSPaulius Zaleckas 3203fc154b6SArnaud Patardconfig USB_GADGET_S3C2410 3213fc154b6SArnaud Patard boolean "S3C2410 USB Device Controller" 3223fc154b6SArnaud Patard depends on ARCH_S3C2410 3233fc154b6SArnaud Patard help 3243fc154b6SArnaud Patard Samsung's S3C2410 is an ARM-4 processor with an integrated 3253fc154b6SArnaud Patard full speed USB 1.1 device controller. It has 4 configurable 3263fc154b6SArnaud Patard endpoints, as well as endpoint zero (for control transfers). 3273fc154b6SArnaud Patard 3283fc154b6SArnaud Patard This driver has been tested on the S3C2410, S3C2412, and 3293fc154b6SArnaud Patard S3C2440 processors. 3303fc154b6SArnaud Patard 3313fc154b6SArnaud Patardconfig USB_S3C2410 3323fc154b6SArnaud Patard tristate 3333fc154b6SArnaud Patard depends on USB_GADGET_S3C2410 3343fc154b6SArnaud Patard default USB_GADGET 3353fc154b6SArnaud Patard select USB_GADGET_SELECTED 3363fc154b6SArnaud Patard 3373fc154b6SArnaud Patardconfig USB_S3C2410_DEBUG 3383fc154b6SArnaud Patard boolean "S3C2410 udc debug messages" 3393fc154b6SArnaud Patard depends on USB_GADGET_S3C2410 3403fc154b6SArnaud Patard 341e7cddda4Scxie4config USB_GADGET_PXA_U2O 342e7cddda4Scxie4 boolean "PXA9xx Processor USB2.0 controller" 343e7cddda4Scxie4 select USB_GADGET_DUALSPEED 344e7cddda4Scxie4 help 345e7cddda4Scxie4 PXA9xx Processor series include a high speed USB2.0 device 346e7cddda4Scxie4 controller, which support high speed and full speed USB peripheral. 347e7cddda4Scxie4 348e7cddda4Scxie4config USB_PXA_U2O 349e7cddda4Scxie4 tristate 350e7cddda4Scxie4 depends on USB_GADGET_PXA_U2O 351e7cddda4Scxie4 default USB_GADGET 352e7cddda4Scxie4 select USB_GADGET_SELECTED 353e7cddda4Scxie4 354a7a19facSDavid Brownell# 355a7a19facSDavid Brownell# Controllers available in both integrated and discrete versions 356a7a19facSDavid Brownell# 357a7a19facSDavid Brownell 358a7a19facSDavid Brownell# musb builds in ../musb along with host support 359a7a19facSDavid Brownellconfig USB_GADGET_MUSB_HDRC 360085ad406SBryan Wu boolean "Inventra HDRC USB Peripheral (TI, ADI, ...)" 361a7a19facSDavid Brownell depends on USB_MUSB_HDRC && (USB_MUSB_PERIPHERAL || USB_MUSB_OTG) 362a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 363bae4bd84SDavid Brownell select USB_GADGET_SELECTED 364bae4bd84SDavid Brownell help 365a7a19facSDavid Brownell This OTG-capable silicon IP is used in dual designs including 366085ad406SBryan Wu the TI DaVinci, OMAP 243x, OMAP 343x, TUSB 6010, and ADI Blackfin 367a7a19facSDavid Brownell 368a7a19facSDavid Brownellconfig USB_GADGET_M66592 369a7a19facSDavid Brownell boolean "Renesas M66592 USB Peripheral Controller" 370a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 371a7a19facSDavid Brownell help 372a7a19facSDavid Brownell M66592 is a discrete USB peripheral controller chip that 373a7a19facSDavid Brownell supports both full and high speed USB 2.0 data transfers. 374a7a19facSDavid Brownell It has seven configurable endpoints, and endpoint zero. 375bae4bd84SDavid Brownell 376bae4bd84SDavid Brownell Say "y" to link the driver statically, or "m" to build a 377a7a19facSDavid Brownell dynamically linked module called "m66592_udc" and force all 378bae4bd84SDavid Brownell gadget drivers to also be dynamically linked. 379bae4bd84SDavid Brownell 380a7a19facSDavid Brownellconfig USB_M66592 381bae4bd84SDavid Brownell tristate 382a7a19facSDavid Brownell depends on USB_GADGET_M66592 383bae4bd84SDavid Brownell default USB_GADGET 384a7a19facSDavid Brownell select USB_GADGET_SELECTED 385a7a19facSDavid Brownell 386a7a19facSDavid Brownell# 387a7a19facSDavid Brownell# Controllers available only in discrete form (and all PCI controllers) 388a7a19facSDavid Brownell# 389a7a19facSDavid Brownell 390a7a19facSDavid Brownellconfig USB_GADGET_AMD5536UDC 391a7a19facSDavid Brownell boolean "AMD5536 UDC" 392a7a19facSDavid Brownell depends on PCI 393a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 394a7a19facSDavid Brownell help 395a7a19facSDavid Brownell The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge. 396a7a19facSDavid Brownell It is a USB Highspeed DMA capable USB device controller. Beside ep0 397a7a19facSDavid Brownell it provides 4 IN and 4 OUT endpoints (bulk or interrupt type). 398a7a19facSDavid Brownell The UDC port supports OTG operation, and may be used as a host port 399a7a19facSDavid Brownell if it's not being used to implement peripheral or OTG roles. 400a7a19facSDavid Brownell 401a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 402a7a19facSDavid Brownell dynamically linked module called "amd5536udc" and force all 403a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 404a7a19facSDavid Brownell 405a7a19facSDavid Brownellconfig USB_AMD5536UDC 406a7a19facSDavid Brownell tristate 407a7a19facSDavid Brownell depends on USB_GADGET_AMD5536UDC 408a7a19facSDavid Brownell default USB_GADGET 409a7a19facSDavid Brownell select USB_GADGET_SELECTED 410a7a19facSDavid Brownell 4113948f0e0SLi Yangconfig USB_GADGET_FSL_QE 4123948f0e0SLi Yang boolean "Freescale QE/CPM USB Device Controller" 4133948f0e0SLi Yang depends on FSL_SOC && (QUICC_ENGINE || CPM) 4143948f0e0SLi Yang help 4153948f0e0SLi Yang Some of Freescale PowerPC processors have a Full Speed 4163948f0e0SLi Yang QE/CPM2 USB controller, which support device mode with 4 4173948f0e0SLi Yang programmable endpoints. This driver supports the 4183948f0e0SLi Yang controller in the MPC8360 and MPC8272, and should work with 4193948f0e0SLi Yang controllers having QE or CPM2, given minor tweaks. 4203948f0e0SLi Yang 4213948f0e0SLi Yang Set CONFIG_USB_GADGET to "m" to build this driver as a 422692105b8SMatt LaPlante dynamically linked module called "fsl_qe_udc". 4233948f0e0SLi Yang 4243948f0e0SLi Yangconfig USB_FSL_QE 4253948f0e0SLi Yang tristate 4263948f0e0SLi Yang depends on USB_GADGET_FSL_QE 4273948f0e0SLi Yang default USB_GADGET 4283948f0e0SLi Yang select USB_GADGET_SELECTED 4293948f0e0SLi Yang 430409a15daSPavankumar Kondeticonfig USB_GADGET_CI13XXX_PCI 431409a15daSPavankumar Kondeti boolean "MIPS USB CI13xxx PCI UDC" 432aa69a809SDavid Lopo depends on PCI 433aa69a809SDavid Lopo select USB_GADGET_DUALSPEED 434aa69a809SDavid Lopo help 435aa69a809SDavid Lopo MIPS USB IP core family device controller 436aa69a809SDavid Lopo Currently it only supports IP part number CI13412 437aa69a809SDavid Lopo 438aa69a809SDavid Lopo Say "y" to link the driver statically, or "m" to build a 439aa69a809SDavid Lopo dynamically linked module called "ci13xxx_udc" and force all 440aa69a809SDavid Lopo gadget drivers to also be dynamically linked. 441aa69a809SDavid Lopo 442409a15daSPavankumar Kondeticonfig USB_CI13XXX_PCI 443aa69a809SDavid Lopo tristate 444409a15daSPavankumar Kondeti depends on USB_GADGET_CI13XXX_PCI 445aa69a809SDavid Lopo default USB_GADGET 446aa69a809SDavid Lopo select USB_GADGET_SELECTED 447aa69a809SDavid Lopo 448a7a19facSDavid Brownellconfig USB_GADGET_NET2280 449a7a19facSDavid Brownell boolean "NetChip 228x" 450a7a19facSDavid Brownell depends on PCI 451a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 452a7a19facSDavid Brownell help 453a7a19facSDavid Brownell NetChip 2280 / 2282 is a PCI based USB peripheral controller which 454a7a19facSDavid Brownell supports both full and high speed USB 2.0 data transfers. 455a7a19facSDavid Brownell 456a7a19facSDavid Brownell It has six configurable endpoints, as well as endpoint zero 457a7a19facSDavid Brownell (for control transfers) and several endpoints with dedicated 458a7a19facSDavid Brownell functions. 459a7a19facSDavid Brownell 460a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 461a7a19facSDavid Brownell dynamically linked module called "net2280" and force all 462a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 463a7a19facSDavid Brownell 464a7a19facSDavid Brownellconfig USB_NET2280 465a7a19facSDavid Brownell tristate 466a7a19facSDavid Brownell depends on USB_GADGET_NET2280 467a7a19facSDavid Brownell default USB_GADGET 468a7a19facSDavid Brownell select USB_GADGET_SELECTED 469a7a19facSDavid Brownell 470a7a19facSDavid Brownellconfig USB_GADGET_GOKU 471a7a19facSDavid Brownell boolean "Toshiba TC86C001 'Goku-S'" 472a7a19facSDavid Brownell depends on PCI 473a7a19facSDavid Brownell help 474a7a19facSDavid Brownell The Toshiba TC86C001 is a PCI device which includes controllers 475a7a19facSDavid Brownell for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI). 476a7a19facSDavid Brownell 477a7a19facSDavid Brownell The device controller has three configurable (bulk or interrupt) 478a7a19facSDavid Brownell endpoints, plus endpoint zero (for control transfers). 479a7a19facSDavid Brownell 480a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 481a7a19facSDavid Brownell dynamically linked module called "goku_udc" and to force all 482a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 483a7a19facSDavid Brownell 484a7a19facSDavid Brownellconfig USB_GOKU 485a7a19facSDavid Brownell tristate 486a7a19facSDavid Brownell depends on USB_GADGET_GOKU 487a7a19facSDavid Brownell default USB_GADGET 488a7a19facSDavid Brownell select USB_GADGET_SELECTED 489a7a19facSDavid Brownell 4905be19a9dSXiaochen Shenconfig USB_GADGET_LANGWELL 4915be19a9dSXiaochen Shen boolean "Intel Langwell USB Device Controller" 4925be19a9dSXiaochen Shen depends on PCI 4935be19a9dSXiaochen Shen select USB_GADGET_DUALSPEED 4945be19a9dSXiaochen Shen help 4955be19a9dSXiaochen Shen Intel Langwell USB Device Controller is a High-Speed USB 4965be19a9dSXiaochen Shen On-The-Go device controller. 4975be19a9dSXiaochen Shen 4985be19a9dSXiaochen Shen The number of programmable endpoints is different through 4995be19a9dSXiaochen Shen controller revision. 5005be19a9dSXiaochen Shen 5015be19a9dSXiaochen Shen Say "y" to link the driver statically, or "m" to build a 5025be19a9dSXiaochen Shen dynamically linked module called "langwell_udc" and force all 5035be19a9dSXiaochen Shen gadget drivers to also be dynamically linked. 5045be19a9dSXiaochen Shen 5055be19a9dSXiaochen Shenconfig USB_LANGWELL 5065be19a9dSXiaochen Shen tristate 5075be19a9dSXiaochen Shen depends on USB_GADGET_LANGWELL 5085be19a9dSXiaochen Shen default USB_GADGET 5095be19a9dSXiaochen Shen select USB_GADGET_SELECTED 5105be19a9dSXiaochen Shen 511f646cf94SToshiharu Okadaconfig USB_GADGET_EG20T 512*06f1b971STomoya MORINAGA boolean "Intel EG20T PCH/OKI SEMICONDUCTOR ML7213 IOH UDC" 513f646cf94SToshiharu Okada depends on PCI 514f646cf94SToshiharu Okada select USB_GADGET_DUALSPEED 515f646cf94SToshiharu Okada help 516f646cf94SToshiharu Okada This is a USB device driver for EG20T PCH. 517f646cf94SToshiharu Okada EG20T PCH is the platform controller hub that is used in Intel's 518f646cf94SToshiharu Okada general embedded platform. EG20T PCH has USB device interface. 519f646cf94SToshiharu Okada Using this interface, it is able to access system devices connected 520f646cf94SToshiharu Okada to USB device. 521f646cf94SToshiharu Okada This driver enables USB device function. 522f646cf94SToshiharu Okada USB device is a USB peripheral controller which 523f646cf94SToshiharu Okada supports both full and high speed USB 2.0 data transfers. 524f646cf94SToshiharu Okada This driver supports both control transfer and bulk transfer modes. 525f646cf94SToshiharu Okada This driver dose not support interrupt transfer or isochronous 526f646cf94SToshiharu Okada transfer modes. 527f646cf94SToshiharu Okada 528*06f1b971STomoya MORINAGA This driver also can be used for OKI SEMICONDUCTOR's ML7213 which is 529*06f1b971STomoya MORINAGA for IVI(In-Vehicle Infotainment) use. 530*06f1b971STomoya MORINAGA ML7213 is companion chip for Intel Atom E6xx series. 531*06f1b971STomoya MORINAGA ML7213 is completely compatible for Intel EG20T PCH. 532*06f1b971STomoya MORINAGA 533f646cf94SToshiharu Okadaconfig USB_EG20T 534f646cf94SToshiharu Okada tristate 535f646cf94SToshiharu Okada depends on USB_GADGET_EG20T 536f646cf94SToshiharu Okada default USB_GADGET 537f646cf94SToshiharu Okada select USB_GADGET_SELECTED 538a7a19facSDavid Brownell 53933f82f38SPavankumar Kondeticonfig USB_GADGET_CI13XXX_MSM 54033f82f38SPavankumar Kondeti boolean "MIPS USB CI13xxx for MSM" 54133f82f38SPavankumar Kondeti depends on ARCH_MSM 54233f82f38SPavankumar Kondeti select USB_GADGET_DUALSPEED 54333f82f38SPavankumar Kondeti select USB_MSM_OTG_72K 54433f82f38SPavankumar Kondeti help 54533f82f38SPavankumar Kondeti MSM SoC has chipidea USB controller. This driver uses 54633f82f38SPavankumar Kondeti ci13xxx_udc core. 54733f82f38SPavankumar Kondeti This driver depends on OTG driver for PHY initialization, 54833f82f38SPavankumar Kondeti clock management, powering up VBUS, and power management. 54933f82f38SPavankumar Kondeti 55033f82f38SPavankumar Kondeti Say "y" to link the driver statically, or "m" to build a 55133f82f38SPavankumar Kondeti dynamically linked module called "ci13xxx_msm" and force all 55233f82f38SPavankumar Kondeti gadget drivers to also be dynamically linked. 55333f82f38SPavankumar Kondeti 55433f82f38SPavankumar Kondeticonfig USB_CI13XXX_MSM 55533f82f38SPavankumar Kondeti tristate 55633f82f38SPavankumar Kondeti depends on USB_GADGET_CI13XXX_MSM 55733f82f38SPavankumar Kondeti default USB_GADGET 55833f82f38SPavankumar Kondeti select USB_GADGET_SELECTED 559a7a19facSDavid Brownell 560a7a19facSDavid Brownell# 561a7a19facSDavid Brownell# LAST -- dummy/emulated controller 562a7a19facSDavid Brownell# 5631da177e4SLinus Torvalds 5641da177e4SLinus Torvaldsconfig USB_GADGET_DUMMY_HCD 5651da177e4SLinus Torvalds boolean "Dummy HCD (DEVELOPMENT)" 566afd0e0f2SRobert P. J. Day depends on USB=y || (USB=m && USB_GADGET=m) 5671da177e4SLinus Torvalds select USB_GADGET_DUALSPEED 5681da177e4SLinus Torvalds help 5691da177e4SLinus Torvalds This host controller driver emulates USB, looping all data transfer 5701da177e4SLinus Torvalds requests back to a USB "gadget driver" in the same host. The host 5711da177e4SLinus Torvalds side is the master; the gadget side is the slave. Gadget drivers 5721da177e4SLinus Torvalds can be high, full, or low speed; and they have access to endpoints 5731da177e4SLinus Torvalds like those from NET2280, PXA2xx, or SA1100 hardware. 5741da177e4SLinus Torvalds 5751da177e4SLinus Torvalds This may help in some stages of creating a driver to embed in a 5761da177e4SLinus Torvalds Linux device, since it lets you debug several parts of the gadget 5771da177e4SLinus Torvalds driver without its hardware or drivers being involved. 5781da177e4SLinus Torvalds 5791da177e4SLinus Torvalds Since such a gadget side driver needs to interoperate with a host 5801da177e4SLinus Torvalds side Linux-USB device driver, this may help to debug both sides 5811da177e4SLinus Torvalds of a USB protocol stack. 5821da177e4SLinus Torvalds 5831da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 5841da177e4SLinus Torvalds dynamically linked module called "dummy_hcd" and force all 5851da177e4SLinus Torvalds gadget drivers to also be dynamically linked. 5861da177e4SLinus Torvalds 5871da177e4SLinus Torvaldsconfig USB_DUMMY_HCD 5881da177e4SLinus Torvalds tristate 5891da177e4SLinus Torvalds depends on USB_GADGET_DUMMY_HCD 5901da177e4SLinus Torvalds default USB_GADGET 591028b271bSDavid Brownell select USB_GADGET_SELECTED 5921da177e4SLinus Torvalds 5931da177e4SLinus Torvalds# NOTE: Please keep dummy_hcd LAST so that "real hardware" appears 5941da177e4SLinus Torvalds# first and will be selected by default. 5951da177e4SLinus Torvalds 5961da177e4SLinus Torvaldsendchoice 5971da177e4SLinus Torvalds 5981da177e4SLinus Torvaldsconfig USB_GADGET_DUALSPEED 5991da177e4SLinus Torvalds bool 6001da177e4SLinus Torvalds depends on USB_GADGET 6011da177e4SLinus Torvalds default n 6021da177e4SLinus Torvalds help 6031da177e4SLinus Torvalds Means that gadget drivers should include extra descriptors 6041da177e4SLinus Torvalds and code to handle dual-speed controllers. 6051da177e4SLinus Torvalds 6061da177e4SLinus Torvalds# 6071da177e4SLinus Torvalds# USB Gadget Drivers 6081da177e4SLinus Torvalds# 6091da177e4SLinus Torvaldschoice 6101da177e4SLinus Torvalds tristate "USB Gadget Drivers" 611028b271bSDavid Brownell depends on USB_GADGET && USB_GADGET_SELECTED 6121da177e4SLinus Torvalds default USB_ETH 6131da177e4SLinus Torvalds help 6141da177e4SLinus Torvalds A Linux "Gadget Driver" talks to the USB Peripheral Controller 6151da177e4SLinus Torvalds driver through the abstract "gadget" API. Some other operating 6161da177e4SLinus Torvalds systems call these "client" drivers, of which "class drivers" 6171da177e4SLinus Torvalds are a subset (implementing a USB device class specification). 6181da177e4SLinus Torvalds A gadget driver implements one or more USB functions using 6191da177e4SLinus Torvalds the peripheral hardware. 6201da177e4SLinus Torvalds 6211da177e4SLinus Torvalds Gadget drivers are hardware-neutral, or "platform independent", 6221da177e4SLinus Torvalds except that they sometimes must understand quirks or limitations 6231da177e4SLinus Torvalds of the particular controllers they work with. For example, when 6241da177e4SLinus Torvalds a controller doesn't support alternate configurations or provide 6251da177e4SLinus Torvalds enough of the right types of endpoints, the gadget driver might 6261da177e4SLinus Torvalds not be able work with that controller, or might need to implement 6271da177e4SLinus Torvalds a less common variant of a device class protocol. 6281da177e4SLinus Torvalds 6291da177e4SLinus Torvalds# this first set of drivers all depend on bulk-capable hardware. 6301da177e4SLinus Torvalds 6311da177e4SLinus Torvaldsconfig USB_ZERO 6321da177e4SLinus Torvalds tristate "Gadget Zero (DEVELOPMENT)" 6331da177e4SLinus Torvalds help 6341da177e4SLinus Torvalds Gadget Zero is a two-configuration device. It either sinks and 6351da177e4SLinus Torvalds sources bulk data; or it loops back a configurable number of 6361da177e4SLinus Torvalds transfers. It also implements control requests, for "chapter 9" 6371da177e4SLinus Torvalds conformance. The driver needs only two bulk-capable endpoints, so 6381da177e4SLinus Torvalds it can work on top of most device-side usb controllers. It's 6391da177e4SLinus Torvalds useful for testing, and is also a working example showing how 6401da177e4SLinus Torvalds USB "gadget drivers" can be written. 6411da177e4SLinus Torvalds 6421da177e4SLinus Torvalds Make this be the first driver you try using on top of any new 6431da177e4SLinus Torvalds USB peripheral controller driver. Then you can use host-side 6441da177e4SLinus Torvalds test software, like the "usbtest" driver, to put your hardware 6451da177e4SLinus Torvalds and its driver through a basic set of functional tests. 6461da177e4SLinus Torvalds 6471da177e4SLinus Torvalds Gadget Zero also works with the host-side "usb-skeleton" driver, 6481da177e4SLinus Torvalds and with many kinds of host-side test software. You may need 6491da177e4SLinus Torvalds to tweak product and vendor IDs before host software knows about 6501da177e4SLinus Torvalds this device, and arrange to select an appropriate configuration. 6511da177e4SLinus Torvalds 6521da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 6531da177e4SLinus Torvalds dynamically linked module called "g_zero". 6541da177e4SLinus Torvalds 6551da177e4SLinus Torvaldsconfig USB_ZERO_HNPTEST 6561da177e4SLinus Torvalds boolean "HNP Test Device" 6571da177e4SLinus Torvalds depends on USB_ZERO && USB_OTG 6581da177e4SLinus Torvalds help 6591da177e4SLinus Torvalds You can configure this device to enumerate using the device 6601da177e4SLinus Torvalds identifiers of the USB-OTG test device. That means that when 6611da177e4SLinus Torvalds this gadget connects to another OTG device, with this one using 6621da177e4SLinus Torvalds the "B-Peripheral" role, that device will use HNP to let this 6631da177e4SLinus Torvalds one serve as the USB host instead (in the "B-Host" role). 6641da177e4SLinus Torvalds 665c6994e6fSBryan Wuconfig USB_AUDIO 666c6994e6fSBryan Wu tristate "Audio Gadget (EXPERIMENTAL)" 667c6994e6fSBryan Wu depends on SND 66804950737SRandy Dunlap select SND_PCM 669c6994e6fSBryan Wu help 670c6994e6fSBryan Wu Gadget Audio is compatible with USB Audio Class specification 1.0. 671c6994e6fSBryan Wu It will include at least one AudioControl interface, zero or more 672c6994e6fSBryan Wu AudioStream interface and zero or more MIDIStream interface. 673c6994e6fSBryan Wu 674c6994e6fSBryan Wu Gadget Audio will use on-board ALSA (CONFIG_SND) audio card to 675c6994e6fSBryan Wu playback or capture audio stream. 676c6994e6fSBryan Wu 677c6994e6fSBryan Wu Say "y" to link the driver statically, or "m" to build a 678c6994e6fSBryan Wu dynamically linked module called "g_audio". 679c6994e6fSBryan Wu 6801da177e4SLinus Torvaldsconfig USB_ETH 6811da177e4SLinus Torvalds tristate "Ethernet Gadget (with CDC Ethernet support)" 6821da177e4SLinus Torvalds depends on NET 6839e221be8SRandy Dunlap select CRC32 6841da177e4SLinus Torvalds help 6859b39e9ddSBrian Niebuhr This driver implements Ethernet style communication, in one of 6869b39e9ddSBrian Niebuhr several ways: 6871da177e4SLinus Torvalds 6881da177e4SLinus Torvalds - The "Communication Device Class" (CDC) Ethernet Control Model. 6891da177e4SLinus Torvalds That protocol is often avoided with pure Ethernet adapters, in 6901da177e4SLinus Torvalds favor of simpler vendor-specific hardware, but is widely 6911da177e4SLinus Torvalds supported by firmware for smart network devices. 6921da177e4SLinus Torvalds 6931da177e4SLinus Torvalds - On hardware can't implement that protocol, a simple CDC subset 6941da177e4SLinus Torvalds is used, placing fewer demands on USB. 6951da177e4SLinus Torvalds 6969b39e9ddSBrian Niebuhr - CDC Ethernet Emulation Model (EEM) is a newer standard that has 6979b39e9ddSBrian Niebuhr a simpler interface that can be used by more USB hardware. 6989b39e9ddSBrian Niebuhr 6999b39e9ddSBrian Niebuhr RNDIS support is an additional option, more demanding than than 7009b39e9ddSBrian Niebuhr subset. 7011da177e4SLinus Torvalds 7021da177e4SLinus Torvalds Within the USB device, this gadget driver exposes a network device 7031da177e4SLinus Torvalds "usbX", where X depends on what other networking devices you have. 7041da177e4SLinus Torvalds Treat it like a two-node Ethernet link: host, and gadget. 7051da177e4SLinus Torvalds 7061da177e4SLinus Torvalds The Linux-USB host-side "usbnet" driver interoperates with this 7071da177e4SLinus Torvalds driver, so that deep I/O queues can be supported. On 2.4 kernels, 7081da177e4SLinus Torvalds use "CDCEther" instead, if you're using the CDC option. That CDC 7091da177e4SLinus Torvalds mode should also interoperate with standard CDC Ethernet class 7101da177e4SLinus Torvalds drivers on other host operating systems. 7111da177e4SLinus Torvalds 7121da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 7131da177e4SLinus Torvalds dynamically linked module called "g_ether". 7141da177e4SLinus Torvalds 7151da177e4SLinus Torvaldsconfig USB_ETH_RNDIS 716afd0e0f2SRobert P. J. Day bool "RNDIS support" 717afd0e0f2SRobert P. J. Day depends on USB_ETH 7181da177e4SLinus Torvalds default y 7191da177e4SLinus Torvalds help 7201da177e4SLinus Torvalds Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol, 7211da177e4SLinus Torvalds and Microsoft provides redistributable binary RNDIS drivers for 7221da177e4SLinus Torvalds older versions of Windows. 7231da177e4SLinus Torvalds 7241da177e4SLinus Torvalds If you say "y" here, the Ethernet gadget driver will try to provide 7251da177e4SLinus Torvalds a second device configuration, supporting RNDIS to talk to such 7261da177e4SLinus Torvalds Microsoft USB hosts. 7271da177e4SLinus Torvalds 7281da177e4SLinus Torvalds To make MS-Windows work with this, use Documentation/usb/linux.inf 7291da177e4SLinus Torvalds as the "driver info file". For versions of MS-Windows older than 7301da177e4SLinus Torvalds XP, you'll need to download drivers from Microsoft's website; a URL 7311da177e4SLinus Torvalds is given in comments found in that info file. 7321da177e4SLinus Torvalds 7339b39e9ddSBrian Niebuhrconfig USB_ETH_EEM 7349b39e9ddSBrian Niebuhr bool "Ethernet Emulation Model (EEM) support" 7359b39e9ddSBrian Niebuhr depends on USB_ETH 7369b39e9ddSBrian Niebuhr default n 7379b39e9ddSBrian Niebuhr help 7389b39e9ddSBrian Niebuhr CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM 7399b39e9ddSBrian Niebuhr and therefore can be supported by more hardware. Technically ECM and 7409b39e9ddSBrian Niebuhr EEM are designed for different applications. The ECM model extends 7419b39e9ddSBrian Niebuhr the network interface to the target (e.g. a USB cable modem), and the 7429b39e9ddSBrian Niebuhr EEM model is for mobile devices to communicate with hosts using 7439b39e9ddSBrian Niebuhr ethernet over USB. For Linux gadgets, however, the interface with 7449b39e9ddSBrian Niebuhr the host is the same (a usbX device), so the differences are minimal. 7459b39e9ddSBrian Niebuhr 7469b39e9ddSBrian Niebuhr If you say "y" here, the Ethernet gadget driver will use the EEM 7479b39e9ddSBrian Niebuhr protocol rather than ECM. If unsure, say "n". 7489b39e9ddSBrian Niebuhr 7496c34d288SYauheni Kaliutaconfig USB_G_NCM 7506c34d288SYauheni Kaliuta tristate "Network Control Model (NCM) support" 7516c34d288SYauheni Kaliuta depends on NET 7526c34d288SYauheni Kaliuta select CRC32 7536c34d288SYauheni Kaliuta help 7546c34d288SYauheni Kaliuta This driver implements USB CDC NCM subclass standard. NCM is 7556c34d288SYauheni Kaliuta an advanced protocol for Ethernet encapsulation, allows grouping 7566c34d288SYauheni Kaliuta of several ethernet frames into one USB transfer and diffferent 7576c34d288SYauheni Kaliuta alignment possibilities. 7586c34d288SYauheni Kaliuta 7596c34d288SYauheni Kaliuta Say "y" to link the driver statically, or "m" to build a 7606c34d288SYauheni Kaliuta dynamically linked module called "g_ncm". 7616c34d288SYauheni Kaliuta 7621da177e4SLinus Torvaldsconfig USB_GADGETFS 7631da177e4SLinus Torvalds tristate "Gadget Filesystem (EXPERIMENTAL)" 7641da177e4SLinus Torvalds depends on EXPERIMENTAL 7651da177e4SLinus Torvalds help 7661da177e4SLinus Torvalds This driver provides a filesystem based API that lets user mode 7671da177e4SLinus Torvalds programs implement a single-configuration USB device, including 7681da177e4SLinus Torvalds endpoint I/O and control requests that don't relate to enumeration. 7691da177e4SLinus Torvalds All endpoints, transfer speeds, and transfer types supported by 7701da177e4SLinus Torvalds the hardware are available, through read() and write() calls. 7711da177e4SLinus Torvalds 772afd0e0f2SRobert P. J. Day Currently, this option is still labelled as EXPERIMENTAL because 773afd0e0f2SRobert P. J. Day of existing race conditions in the underlying in-kernel AIO core. 774afd0e0f2SRobert P. J. Day 7751da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 7761da177e4SLinus Torvalds dynamically linked module called "gadgetfs". 7771da177e4SLinus Torvalds 778c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS 779c6c56008SMichal Nazarewicz tristate "Function Filesystem (EXPERIMENTAL)" 780c6c56008SMichal Nazarewicz depends on EXPERIMENTAL 781f8dae531SMichal Nazarewicz select USB_FUNCTIONFS_GENERIC if !(USB_FUNCTIONFS_ETH || USB_FUNCTIONFS_RNDIS) 782c6c56008SMichal Nazarewicz help 783eabf0f5fSMichael Prokop The Function Filesystem (FunctionFS) lets one create USB 784eabf0f5fSMichael Prokop composite functions in user space in the same way GadgetFS 785c6c56008SMichal Nazarewicz lets one create USB gadgets in user space. This allows creation 786c6c56008SMichal Nazarewicz of composite gadgets such that some of the functions are 787c6c56008SMichal Nazarewicz implemented in kernel space (for instance Ethernet, serial or 788c6c56008SMichal Nazarewicz mass storage) and other are implemented in user space. 789c6c56008SMichal Nazarewicz 790f8dae531SMichal Nazarewicz If you say "y" or "m" here you will be able what kind of 791f8dae531SMichal Nazarewicz configurations the gadget will provide. 792f8dae531SMichal Nazarewicz 793c6c56008SMichal Nazarewicz Say "y" to link the driver statically, or "m" to build 794c6c56008SMichal Nazarewicz a dynamically linked module called "g_ffs". 795c6c56008SMichal Nazarewicz 796c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_ETH 797f8dae531SMichal Nazarewicz bool "Include configuration with CDC ECM (Ethernet)" 79817b2765eSRandy Dunlap depends on USB_FUNCTIONFS && NET 799c6c56008SMichal Nazarewicz help 800eabf0f5fSMichael Prokop Include a configuration with CDC ECM function (Ethernet) and the 801eabf0f5fSMichael Prokop Function Filesystem. 802c6c56008SMichal Nazarewicz 803c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_RNDIS 804f8dae531SMichal Nazarewicz bool "Include configuration with RNDIS (Ethernet)" 80517b2765eSRandy Dunlap depends on USB_FUNCTIONFS && NET 806c6c56008SMichal Nazarewicz help 807eabf0f5fSMichael Prokop Include a configuration with RNDIS function (Ethernet) and the Filesystem. 808c6c56008SMichal Nazarewicz 809c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_GENERIC 810c6c56008SMichal Nazarewicz bool "Include 'pure' configuration" 811f8dae531SMichal Nazarewicz depends on USB_FUNCTIONFS 812c6c56008SMichal Nazarewicz help 813f8dae531SMichal Nazarewicz Include a configuration with the Function Filesystem alone with 814f8dae531SMichal Nazarewicz no Ethernet interface. 815c6c56008SMichal Nazarewicz 8161da177e4SLinus Torvaldsconfig USB_FILE_STORAGE 8171da177e4SLinus Torvalds tristate "File-backed Storage Gadget" 81887840289SRandy Dunlap depends on BLOCK 8191da177e4SLinus Torvalds help 8201da177e4SLinus Torvalds The File-backed Storage Gadget acts as a USB Mass Storage 8211da177e4SLinus Torvalds disk drive. As its storage repository it can use a regular 8221da177e4SLinus Torvalds file or a block device (in much the same way as the "loop" 8231da177e4SLinus Torvalds device driver), specified as a module parameter. 8241da177e4SLinus Torvalds 8251da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 8261da177e4SLinus Torvalds dynamically linked module called "g_file_storage". 8271da177e4SLinus Torvalds 8281da177e4SLinus Torvaldsconfig USB_FILE_STORAGE_TEST 8291da177e4SLinus Torvalds bool "File-backed Storage Gadget testing version" 8301da177e4SLinus Torvalds depends on USB_FILE_STORAGE 8311da177e4SLinus Torvalds default n 8321da177e4SLinus Torvalds help 8331da177e4SLinus Torvalds Say "y" to generate the larger testing version of the 8341da177e4SLinus Torvalds File-backed Storage Gadget, useful for probing the 8351da177e4SLinus Torvalds behavior of USB Mass Storage hosts. Not needed for 8361da177e4SLinus Torvalds normal operation. 8371da177e4SLinus Torvalds 838d23b0f08SMichal Nazarewiczconfig USB_MASS_STORAGE 839d23b0f08SMichal Nazarewicz tristate "Mass Storage Gadget" 840d23b0f08SMichal Nazarewicz depends on BLOCK 841d23b0f08SMichal Nazarewicz help 842d23b0f08SMichal Nazarewicz The Mass Storage Gadget acts as a USB Mass Storage disk drive. 843d23b0f08SMichal Nazarewicz As its storage repository it can use a regular file or a block 844d23b0f08SMichal Nazarewicz device (in much the same way as the "loop" device driver), 845d23b0f08SMichal Nazarewicz specified as a module parameter or sysfs option. 846d23b0f08SMichal Nazarewicz 847d23b0f08SMichal Nazarewicz This is heavily based on File-backed Storage Gadget and in most 848d23b0f08SMichal Nazarewicz cases you will want to use FSG instead. This gadget is mostly 849d23b0f08SMichal Nazarewicz here to test the functionality of the Mass Storage Function 850d23b0f08SMichal Nazarewicz which may be used with composite framework. 851d23b0f08SMichal Nazarewicz 852d23b0f08SMichal Nazarewicz Say "y" to link the driver statically, or "m" to build 85311b10d99SMichal Nazarewicz a dynamically linked module called "g_mass_storage". If unsure, 854d23b0f08SMichal Nazarewicz consider File-backed Storage Gadget. 855d23b0f08SMichal Nazarewicz 8561da177e4SLinus Torvaldsconfig USB_G_SERIAL 8573086775aSFelipe Balbi tristate "Serial Gadget (with CDC ACM and CDC OBEX support)" 8581da177e4SLinus Torvalds help 8591da177e4SLinus Torvalds The Serial Gadget talks to the Linux-USB generic serial driver. 8601da177e4SLinus Torvalds This driver supports a CDC-ACM module option, which can be used 8611da177e4SLinus Torvalds to interoperate with MS-Windows hosts or with the Linux-USB 8621da177e4SLinus Torvalds "cdc-acm" driver. 8631da177e4SLinus Torvalds 8643086775aSFelipe Balbi This driver also supports a CDC-OBEX option. You will need a 8653086775aSFelipe Balbi user space OBEX server talking to /dev/ttyGS*, since the kernel 8663086775aSFelipe Balbi itself doesn't implement the OBEX protocol. 8673086775aSFelipe Balbi 8681da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 8691da177e4SLinus Torvalds dynamically linked module called "g_serial". 8701da177e4SLinus Torvalds 8711da177e4SLinus Torvalds For more information, see Documentation/usb/gadget_serial.txt 8721da177e4SLinus Torvalds which includes instructions and a "driver info file" needed to 8733086775aSFelipe Balbi make MS-Windows work with CDC ACM. 8741da177e4SLinus Torvalds 875f2ebf92cSBen Williamsonconfig USB_MIDI_GADGET 876f2ebf92cSBen Williamson tristate "MIDI Gadget (EXPERIMENTAL)" 877f2ebf92cSBen Williamson depends on SND && EXPERIMENTAL 878f2ebf92cSBen Williamson select SND_RAWMIDI 879f2ebf92cSBen Williamson help 880f2ebf92cSBen Williamson The MIDI Gadget acts as a USB Audio device, with one MIDI 881f2ebf92cSBen Williamson input and one MIDI output. These MIDI jacks appear as 882f2ebf92cSBen Williamson a sound "card" in the ALSA sound system. Other MIDI 883f2ebf92cSBen Williamson connections can then be made on the gadget system, using 884f2ebf92cSBen Williamson ALSA's aconnect utility etc. 885f2ebf92cSBen Williamson 886f2ebf92cSBen Williamson Say "y" to link the driver statically, or "m" to build a 887f2ebf92cSBen Williamson dynamically linked module called "g_midi". 888f2ebf92cSBen Williamson 88925a010c8SCraig W. Nadlerconfig USB_G_PRINTER 89025a010c8SCraig W. Nadler tristate "Printer Gadget" 89125a010c8SCraig W. Nadler help 89225a010c8SCraig W. Nadler The Printer Gadget channels data between the USB host and a 89325a010c8SCraig W. Nadler userspace program driving the print engine. The user space 89425a010c8SCraig W. Nadler program reads and writes the device file /dev/g_printer to 89525a010c8SCraig W. Nadler receive or send printer data. It can use ioctl calls to 89625a010c8SCraig W. Nadler the device file to get or set printer status. 89725a010c8SCraig W. Nadler 89825a010c8SCraig W. Nadler Say "y" to link the driver statically, or "m" to build a 89925a010c8SCraig W. Nadler dynamically linked module called "g_printer". 90025a010c8SCraig W. Nadler 90125a010c8SCraig W. Nadler For more information, see Documentation/usb/gadget_printer.txt 90225a010c8SCraig W. Nadler which includes sample code for accessing the device file. 9031da177e4SLinus Torvalds 90419e20680SDavid Brownellconfig USB_CDC_COMPOSITE 90519e20680SDavid Brownell tristate "CDC Composite Device (Ethernet and ACM)" 9064ddd9ec1SRandy Dunlap depends on NET 90719e20680SDavid Brownell help 90819e20680SDavid Brownell This driver provides two functions in one configuration: 90919e20680SDavid Brownell a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link. 91019e20680SDavid Brownell 91119e20680SDavid Brownell This driver requires four bulk and two interrupt endpoints, 91219e20680SDavid Brownell plus the ability to handle altsettings. Not all peripheral 91319e20680SDavid Brownell controllers are that capable. 91419e20680SDavid Brownell 91519e20680SDavid Brownell Say "y" to link the driver statically, or "m" to build a 91619e20680SDavid Brownell dynamically linked module. 91719e20680SDavid Brownell 918f358f5b4SFelipe Balbiconfig USB_G_NOKIA 919f358f5b4SFelipe Balbi tristate "Nokia composite gadget" 920f358f5b4SFelipe Balbi depends on PHONET 921f358f5b4SFelipe Balbi help 922f358f5b4SFelipe Balbi The Nokia composite gadget provides support for acm, obex 923f358f5b4SFelipe Balbi and phonet in only one composite gadget driver. 924f358f5b4SFelipe Balbi 925f358f5b4SFelipe Balbi It's only really useful for N900 hardware. If you're building 926f358f5b4SFelipe Balbi a kernel for N900, say Y or M here. If unsure, say N. 927f358f5b4SFelipe Balbi 928f176a5d8SMichal Nazarewiczconfig USB_G_MULTI 929f176a5d8SMichal Nazarewicz tristate "Multifunction Composite Gadget (EXPERIMENTAL)" 9305791e103SRandy Dunlap depends on BLOCK && NET 931279cc49aSMichal Nazarewicz select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS 932f176a5d8SMichal Nazarewicz help 933f176a5d8SMichal Nazarewicz The Multifunction Composite Gadget provides Ethernet (RNDIS 934f176a5d8SMichal Nazarewicz and/or CDC Ethernet), mass storage and ACM serial link 935f176a5d8SMichal Nazarewicz interfaces. 936f176a5d8SMichal Nazarewicz 9375791e103SRandy Dunlap You will be asked to choose which of the two configurations is 938f176a5d8SMichal Nazarewicz to be available in the gadget. At least one configuration must 9395791e103SRandy Dunlap be chosen to make the gadget usable. Selecting more than one 940f176a5d8SMichal Nazarewicz configuration will prevent Windows from automatically detecting 9415791e103SRandy Dunlap the gadget as a composite gadget, so an INF file will be needed to 942f176a5d8SMichal Nazarewicz use the gadget. 943f176a5d8SMichal Nazarewicz 944f176a5d8SMichal Nazarewicz Say "y" to link the driver statically, or "m" to build a 945f176a5d8SMichal Nazarewicz dynamically linked module called "g_multi". 946f176a5d8SMichal Nazarewicz 947f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_RNDIS 948f176a5d8SMichal Nazarewicz bool "RNDIS + CDC Serial + Storage configuration" 949f176a5d8SMichal Nazarewicz depends on USB_G_MULTI 950f176a5d8SMichal Nazarewicz default y 951f176a5d8SMichal Nazarewicz help 952f176a5d8SMichal Nazarewicz This option enables a configuration with RNDIS, CDC Serial and 953f176a5d8SMichal Nazarewicz Mass Storage functions available in the Multifunction Composite 9545791e103SRandy Dunlap Gadget. This is the configuration dedicated for Windows since RNDIS 9555791e103SRandy Dunlap is Microsoft's protocol. 956f176a5d8SMichal Nazarewicz 957f176a5d8SMichal Nazarewicz If unsure, say "y". 958f176a5d8SMichal Nazarewicz 959f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_CDC 960f176a5d8SMichal Nazarewicz bool "CDC Ethernet + CDC Serial + Storage configuration" 961f176a5d8SMichal Nazarewicz depends on USB_G_MULTI 962f176a5d8SMichal Nazarewicz default n 963f176a5d8SMichal Nazarewicz help 964f176a5d8SMichal Nazarewicz This option enables a configuration with CDC Ethernet (ECM), CDC 965f176a5d8SMichal Nazarewicz Serial and Mass Storage functions available in the Multifunction 9665791e103SRandy Dunlap Composite Gadget. 967f176a5d8SMichal Nazarewicz 968f176a5d8SMichal Nazarewicz If unsure, say "y". 969f176a5d8SMichal Nazarewicz 97071adf118SFabien Chouteauconfig USB_G_HID 97171adf118SFabien Chouteau tristate "HID Gadget" 97271adf118SFabien Chouteau help 97371adf118SFabien Chouteau The HID gadget driver provides generic emulation of USB 97471adf118SFabien Chouteau Human Interface Devices (HID). 97571adf118SFabien Chouteau 97671adf118SFabien Chouteau For more information, see Documentation/usb/gadget_hid.txt which 97771adf118SFabien Chouteau includes sample code for accessing the device files. 97871adf118SFabien Chouteau 97971adf118SFabien Chouteau Say "y" to link the driver statically, or "m" to build a 98071adf118SFabien Chouteau dynamically linked module called "g_hid". 981f176a5d8SMichal Nazarewicz 982f6c826a9Sstephane duvergerconfig USB_G_DBGP 983f6c826a9Sstephane duverger tristate "EHCI Debug Device Gadget" 984f6c826a9Sstephane duverger help 985f6c826a9Sstephane duverger This gadget emulates an EHCI Debug device. This is useful when you want 986f6c826a9Sstephane duverger to interact with an EHCI Debug Port. 987f6c826a9Sstephane duverger 988f6c826a9Sstephane duverger Say "y" to link the driver statically, or "m" to build a 989f6c826a9Sstephane duverger dynamically linked module called "g_dbgp". 990f6c826a9Sstephane duverger 991f6c826a9Sstephane duvergerif USB_G_DBGP 992f6c826a9Sstephane duvergerchoice 993f6c826a9Sstephane duverger prompt "EHCI Debug Device mode" 994f6c826a9Sstephane duverger default USB_G_DBGP_SERIAL 995f6c826a9Sstephane duverger 996f6c826a9Sstephane duvergerconfig USB_G_DBGP_PRINTK 997f6c826a9Sstephane duverger depends on USB_G_DBGP 998f6c826a9Sstephane duverger bool "printk" 999f6c826a9Sstephane duverger help 1000f6c826a9Sstephane duverger Directly printk() received data. No interaction. 1001f6c826a9Sstephane duverger 1002f6c826a9Sstephane duvergerconfig USB_G_DBGP_SERIAL 1003f6c826a9Sstephane duverger depends on USB_G_DBGP 1004f6c826a9Sstephane duverger bool "serial" 1005f6c826a9Sstephane duverger help 1006f6c826a9Sstephane duverger Userland can interact using /dev/ttyGSxxx. 1007f6c826a9Sstephane duvergerendchoice 1008f6c826a9Sstephane duvergerendif 1009f6c826a9Sstephane duverger 10101da177e4SLinus Torvalds# put drivers that need isochronous transfer support (for audio 10111da177e4SLinus Torvalds# or video class gadget drivers), or specific hardware, here. 1012a9914127SLaurent Pinchartconfig USB_G_WEBCAM 1013a9914127SLaurent Pinchart tristate "USB Webcam Gadget" 101424337c13SRandy Dunlap depends on VIDEO_DEV 1015a9914127SLaurent Pinchart help 1016a9914127SLaurent Pinchart The Webcam Gadget acts as a composite USB Audio and Video Class 1017a9914127SLaurent Pinchart device. It provides a userspace API to process UVC control requests 1018a9914127SLaurent Pinchart and stream video data to the host. 10191da177e4SLinus Torvalds 1020a9914127SLaurent Pinchart Say "y" to link the driver statically, or "m" to build a 1021a9914127SLaurent Pinchart dynamically linked module called "g_webcam". 10221da177e4SLinus Torvalds 10231da177e4SLinus Torvaldsendchoice 10241da177e4SLinus Torvalds 1025b75be4abSDenis Chengendif # USB_GADGET 1026