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 1790fe6f1d1SYuan-Hsin Chenconfig USB_GADGET_FUSB300 1800fe6f1d1SYuan-Hsin Chen boolean "Faraday FUSB300 USB Peripheral Controller" 1810fe6f1d1SYuan-Hsin Chen select USB_GADGET_DUALSPEED 1820fe6f1d1SYuan-Hsin Chen help 1830fe6f1d1SYuan-Hsin Chen Faraday usb device controller FUSB300 driver 1840fe6f1d1SYuan-Hsin Chen 1850fe6f1d1SYuan-Hsin Chenconfig USB_FUSB300 1860fe6f1d1SYuan-Hsin Chen tristate 1870fe6f1d1SYuan-Hsin Chen depends on USB_GADGET_FUSB300 1880fe6f1d1SYuan-Hsin Chen default USB_GADGET 1890fe6f1d1SYuan-Hsin Chen select USB_GADGET_SELECTED 1900fe6f1d1SYuan-Hsin Chen 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 263*2f98382dSKuninori Morimotoconfig USB_GADGET_RENESAS_USBHS 264*2f98382dSKuninori Morimoto boolean "Renesas USBHS" 265*2f98382dSKuninori Morimoto depends on USB_RENESAS_USBHS 266*2f98382dSKuninori Morimoto select USB_GADGET_DUALSPEED 267*2f98382dSKuninori Morimoto help 268*2f98382dSKuninori Morimoto Renesas USBHS is a discrete USB host and peripheral controller 269*2f98382dSKuninori Morimoto chip that supports both full and high speed USB 2.0 data transfers. 270*2f98382dSKuninori Morimoto platform is able to configure endpoint (pipe) style 271*2f98382dSKuninori Morimoto 272*2f98382dSKuninori Morimoto Say "y" to enable the gadget specific portion of the USBHS driver. 273*2f98382dSKuninori Morimoto 274*2f98382dSKuninori Morimoto 275*2f98382dSKuninori Morimotoconfig USB_RENESAS_USBHS_UDC 276*2f98382dSKuninori Morimoto tristate 277*2f98382dSKuninori Morimoto depends on USB_GADGET_RENESAS_USBHS 278*2f98382dSKuninori Morimoto default USB_GADGET 279*2f98382dSKuninori Morimoto select USB_GADGET_SELECTED 280*2f98382dSKuninori Morimoto 281a7a19facSDavid Brownellconfig USB_GADGET_PXA27X 282a7a19facSDavid Brownell boolean "PXA 27x" 2839f5351b7SRobert Jarzmik depends on ARCH_PXA && (PXA27x || PXA3xx) 2847fec3c25SRobert Jarzmik select USB_OTG_UTILS 285a7a19facSDavid Brownell help 286a7a19facSDavid Brownell Intel's PXA 27x series XScale ARM v5TE processors include 287a7a19facSDavid Brownell an integrated full speed USB 1.1 device controller. 288a7a19facSDavid Brownell 289a7a19facSDavid Brownell It has up to 23 endpoints, as well as endpoint zero (for 290a7a19facSDavid Brownell control transfers). 291a7a19facSDavid Brownell 292a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 293a7a19facSDavid Brownell dynamically linked module called "pxa27x_udc" and force all 294a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 295a7a19facSDavid Brownell 296a7a19facSDavid Brownellconfig USB_PXA27X 297a7a19facSDavid Brownell tristate 298a7a19facSDavid Brownell depends on USB_GADGET_PXA27X 299a7a19facSDavid Brownell default USB_GADGET 300a7a19facSDavid Brownell select USB_GADGET_SELECTED 301a7a19facSDavid Brownell 3025b7d70c6SBen Dooksconfig USB_GADGET_S3C_HSOTG 3035b7d70c6SBen Dooks boolean "S3C HS/OtG USB Device controller" 3045b7d70c6SBen Dooks depends on S3C_DEV_USB_HSOTG 3055b7d70c6SBen Dooks select USB_GADGET_S3C_HSOTG_PIO 3060287e43dSMaurus Cuelenaere select USB_GADGET_DUALSPEED 3075b7d70c6SBen Dooks help 3085b7d70c6SBen Dooks The Samsung S3C64XX USB2.0 high-speed gadget controller 3095b7d70c6SBen Dooks integrated into the S3C64XX series SoC. 3105b7d70c6SBen Dooks 3115b7d70c6SBen Dooksconfig USB_S3C_HSOTG 3125b7d70c6SBen Dooks tristate 3135b7d70c6SBen Dooks depends on USB_GADGET_S3C_HSOTG 3145b7d70c6SBen Dooks default USB_GADGET 3155b7d70c6SBen Dooks select USB_GADGET_SELECTED 3165b7d70c6SBen Dooks 317c03e7d4bSPaulius Zaleckasconfig USB_GADGET_IMX 318c03e7d4bSPaulius Zaleckas boolean "Freescale IMX USB Peripheral Controller" 319c03e7d4bSPaulius Zaleckas depends on ARCH_MX1 320c03e7d4bSPaulius Zaleckas help 321c03e7d4bSPaulius Zaleckas Freescale's IMX series include an integrated full speed 322c03e7d4bSPaulius Zaleckas USB 1.1 device controller. The controller in the IMX series 323c03e7d4bSPaulius Zaleckas is register-compatible. 324c03e7d4bSPaulius Zaleckas 325c03e7d4bSPaulius Zaleckas It has Six fixed-function endpoints, as well as endpoint 326c03e7d4bSPaulius Zaleckas zero (for control transfers). 327c03e7d4bSPaulius Zaleckas 328c03e7d4bSPaulius Zaleckas Say "y" to link the driver statically, or "m" to build a 329c03e7d4bSPaulius Zaleckas dynamically linked module called "imx_udc" and force all 330c03e7d4bSPaulius Zaleckas gadget drivers to also be dynamically linked. 331c03e7d4bSPaulius Zaleckas 332c03e7d4bSPaulius Zaleckasconfig USB_IMX 333c03e7d4bSPaulius Zaleckas tristate 334c03e7d4bSPaulius Zaleckas depends on USB_GADGET_IMX 335c03e7d4bSPaulius Zaleckas default USB_GADGET 336c03e7d4bSPaulius Zaleckas select USB_GADGET_SELECTED 337c03e7d4bSPaulius Zaleckas 3383fc154b6SArnaud Patardconfig USB_GADGET_S3C2410 3393fc154b6SArnaud Patard boolean "S3C2410 USB Device Controller" 3403fc154b6SArnaud Patard depends on ARCH_S3C2410 3413fc154b6SArnaud Patard help 3423fc154b6SArnaud Patard Samsung's S3C2410 is an ARM-4 processor with an integrated 3433fc154b6SArnaud Patard full speed USB 1.1 device controller. It has 4 configurable 3443fc154b6SArnaud Patard endpoints, as well as endpoint zero (for control transfers). 3453fc154b6SArnaud Patard 3463fc154b6SArnaud Patard This driver has been tested on the S3C2410, S3C2412, and 3473fc154b6SArnaud Patard S3C2440 processors. 3483fc154b6SArnaud Patard 3493fc154b6SArnaud Patardconfig USB_S3C2410 3503fc154b6SArnaud Patard tristate 3513fc154b6SArnaud Patard depends on USB_GADGET_S3C2410 3523fc154b6SArnaud Patard default USB_GADGET 3533fc154b6SArnaud Patard select USB_GADGET_SELECTED 3543fc154b6SArnaud Patard 3553fc154b6SArnaud Patardconfig USB_S3C2410_DEBUG 3563fc154b6SArnaud Patard boolean "S3C2410 udc debug messages" 3573fc154b6SArnaud Patard depends on USB_GADGET_S3C2410 3583fc154b6SArnaud Patard 359e7cddda4Scxie4config USB_GADGET_PXA_U2O 360e7cddda4Scxie4 boolean "PXA9xx Processor USB2.0 controller" 361e7cddda4Scxie4 select USB_GADGET_DUALSPEED 362e7cddda4Scxie4 help 363e7cddda4Scxie4 PXA9xx Processor series include a high speed USB2.0 device 364e7cddda4Scxie4 controller, which support high speed and full speed USB peripheral. 365e7cddda4Scxie4 366e7cddda4Scxie4config USB_PXA_U2O 367e7cddda4Scxie4 tristate 368e7cddda4Scxie4 depends on USB_GADGET_PXA_U2O 369e7cddda4Scxie4 default USB_GADGET 370e7cddda4Scxie4 select USB_GADGET_SELECTED 371e7cddda4Scxie4 372a7a19facSDavid Brownell# 373a7a19facSDavid Brownell# Controllers available in both integrated and discrete versions 374a7a19facSDavid Brownell# 375a7a19facSDavid Brownell 376a7a19facSDavid Brownell# musb builds in ../musb along with host support 377a7a19facSDavid Brownellconfig USB_GADGET_MUSB_HDRC 378085ad406SBryan Wu boolean "Inventra HDRC USB Peripheral (TI, ADI, ...)" 379a7a19facSDavid Brownell depends on USB_MUSB_HDRC && (USB_MUSB_PERIPHERAL || USB_MUSB_OTG) 380a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 381bae4bd84SDavid Brownell select USB_GADGET_SELECTED 382bae4bd84SDavid Brownell help 383a7a19facSDavid Brownell This OTG-capable silicon IP is used in dual designs including 384085ad406SBryan Wu the TI DaVinci, OMAP 243x, OMAP 343x, TUSB 6010, and ADI Blackfin 385a7a19facSDavid Brownell 386a7a19facSDavid Brownellconfig USB_GADGET_M66592 387a7a19facSDavid Brownell boolean "Renesas M66592 USB Peripheral Controller" 388a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 389a7a19facSDavid Brownell help 390a7a19facSDavid Brownell M66592 is a discrete USB peripheral controller chip that 391a7a19facSDavid Brownell supports both full and high speed USB 2.0 data transfers. 392a7a19facSDavid Brownell It has seven configurable endpoints, and endpoint zero. 393bae4bd84SDavid Brownell 394bae4bd84SDavid Brownell Say "y" to link the driver statically, or "m" to build a 395a7a19facSDavid Brownell dynamically linked module called "m66592_udc" and force all 396bae4bd84SDavid Brownell gadget drivers to also be dynamically linked. 397bae4bd84SDavid Brownell 398a7a19facSDavid Brownellconfig USB_M66592 399bae4bd84SDavid Brownell tristate 400a7a19facSDavid Brownell depends on USB_GADGET_M66592 401bae4bd84SDavid Brownell default USB_GADGET 402a7a19facSDavid Brownell select USB_GADGET_SELECTED 403a7a19facSDavid Brownell 404a7a19facSDavid Brownell# 405a7a19facSDavid Brownell# Controllers available only in discrete form (and all PCI controllers) 406a7a19facSDavid Brownell# 407a7a19facSDavid Brownell 408a7a19facSDavid Brownellconfig USB_GADGET_AMD5536UDC 409a7a19facSDavid Brownell boolean "AMD5536 UDC" 410a7a19facSDavid Brownell depends on PCI 411a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 412a7a19facSDavid Brownell help 413a7a19facSDavid Brownell The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge. 414a7a19facSDavid Brownell It is a USB Highspeed DMA capable USB device controller. Beside ep0 415a7a19facSDavid Brownell it provides 4 IN and 4 OUT endpoints (bulk or interrupt type). 416a7a19facSDavid Brownell The UDC port supports OTG operation, and may be used as a host port 417a7a19facSDavid Brownell if it's not being used to implement peripheral or OTG roles. 418a7a19facSDavid Brownell 419a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 420a7a19facSDavid Brownell dynamically linked module called "amd5536udc" and force all 421a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 422a7a19facSDavid Brownell 423a7a19facSDavid Brownellconfig USB_AMD5536UDC 424a7a19facSDavid Brownell tristate 425a7a19facSDavid Brownell depends on USB_GADGET_AMD5536UDC 426a7a19facSDavid Brownell default USB_GADGET 427a7a19facSDavid Brownell select USB_GADGET_SELECTED 428a7a19facSDavid Brownell 4293948f0e0SLi Yangconfig USB_GADGET_FSL_QE 4303948f0e0SLi Yang boolean "Freescale QE/CPM USB Device Controller" 4313948f0e0SLi Yang depends on FSL_SOC && (QUICC_ENGINE || CPM) 4323948f0e0SLi Yang help 4333948f0e0SLi Yang Some of Freescale PowerPC processors have a Full Speed 4343948f0e0SLi Yang QE/CPM2 USB controller, which support device mode with 4 4353948f0e0SLi Yang programmable endpoints. This driver supports the 4363948f0e0SLi Yang controller in the MPC8360 and MPC8272, and should work with 4373948f0e0SLi Yang controllers having QE or CPM2, given minor tweaks. 4383948f0e0SLi Yang 4393948f0e0SLi Yang Set CONFIG_USB_GADGET to "m" to build this driver as a 440692105b8SMatt LaPlante dynamically linked module called "fsl_qe_udc". 4413948f0e0SLi Yang 4423948f0e0SLi Yangconfig USB_FSL_QE 4433948f0e0SLi Yang tristate 4443948f0e0SLi Yang depends on USB_GADGET_FSL_QE 4453948f0e0SLi Yang default USB_GADGET 4463948f0e0SLi Yang select USB_GADGET_SELECTED 4473948f0e0SLi Yang 448409a15daSPavankumar Kondeticonfig USB_GADGET_CI13XXX_PCI 449409a15daSPavankumar Kondeti boolean "MIPS USB CI13xxx PCI UDC" 450aa69a809SDavid Lopo depends on PCI 451aa69a809SDavid Lopo select USB_GADGET_DUALSPEED 452aa69a809SDavid Lopo help 453aa69a809SDavid Lopo MIPS USB IP core family device controller 454aa69a809SDavid Lopo Currently it only supports IP part number CI13412 455aa69a809SDavid Lopo 456aa69a809SDavid Lopo Say "y" to link the driver statically, or "m" to build a 457aa69a809SDavid Lopo dynamically linked module called "ci13xxx_udc" and force all 458aa69a809SDavid Lopo gadget drivers to also be dynamically linked. 459aa69a809SDavid Lopo 460409a15daSPavankumar Kondeticonfig USB_CI13XXX_PCI 461aa69a809SDavid Lopo tristate 462409a15daSPavankumar Kondeti depends on USB_GADGET_CI13XXX_PCI 463aa69a809SDavid Lopo default USB_GADGET 464aa69a809SDavid Lopo select USB_GADGET_SELECTED 465aa69a809SDavid Lopo 466a7a19facSDavid Brownellconfig USB_GADGET_NET2280 467a7a19facSDavid Brownell boolean "NetChip 228x" 468a7a19facSDavid Brownell depends on PCI 469a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 470a7a19facSDavid Brownell help 471a7a19facSDavid Brownell NetChip 2280 / 2282 is a PCI based USB peripheral controller which 472a7a19facSDavid Brownell supports both full and high speed USB 2.0 data transfers. 473a7a19facSDavid Brownell 474a7a19facSDavid Brownell It has six configurable endpoints, as well as endpoint zero 475a7a19facSDavid Brownell (for control transfers) and several endpoints with dedicated 476a7a19facSDavid Brownell functions. 477a7a19facSDavid Brownell 478a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 479a7a19facSDavid Brownell dynamically linked module called "net2280" and force all 480a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 481a7a19facSDavid Brownell 482a7a19facSDavid Brownellconfig USB_NET2280 483a7a19facSDavid Brownell tristate 484a7a19facSDavid Brownell depends on USB_GADGET_NET2280 485a7a19facSDavid Brownell default USB_GADGET 486a7a19facSDavid Brownell select USB_GADGET_SELECTED 487a7a19facSDavid Brownell 488a7a19facSDavid Brownellconfig USB_GADGET_GOKU 489a7a19facSDavid Brownell boolean "Toshiba TC86C001 'Goku-S'" 490a7a19facSDavid Brownell depends on PCI 491a7a19facSDavid Brownell help 492a7a19facSDavid Brownell The Toshiba TC86C001 is a PCI device which includes controllers 493a7a19facSDavid Brownell for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI). 494a7a19facSDavid Brownell 495a7a19facSDavid Brownell The device controller has three configurable (bulk or interrupt) 496a7a19facSDavid Brownell endpoints, plus endpoint zero (for control transfers). 497a7a19facSDavid Brownell 498a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 499a7a19facSDavid Brownell dynamically linked module called "goku_udc" and to force all 500a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 501a7a19facSDavid Brownell 502a7a19facSDavid Brownellconfig USB_GOKU 503a7a19facSDavid Brownell tristate 504a7a19facSDavid Brownell depends on USB_GADGET_GOKU 505a7a19facSDavid Brownell default USB_GADGET 506a7a19facSDavid Brownell select USB_GADGET_SELECTED 507a7a19facSDavid Brownell 5085be19a9dSXiaochen Shenconfig USB_GADGET_LANGWELL 5095be19a9dSXiaochen Shen boolean "Intel Langwell USB Device Controller" 5105be19a9dSXiaochen Shen depends on PCI 5115be19a9dSXiaochen Shen select USB_GADGET_DUALSPEED 5125be19a9dSXiaochen Shen help 5135be19a9dSXiaochen Shen Intel Langwell USB Device Controller is a High-Speed USB 5145be19a9dSXiaochen Shen On-The-Go device controller. 5155be19a9dSXiaochen Shen 5165be19a9dSXiaochen Shen The number of programmable endpoints is different through 5175be19a9dSXiaochen Shen controller revision. 5185be19a9dSXiaochen Shen 5195be19a9dSXiaochen Shen Say "y" to link the driver statically, or "m" to build a 5205be19a9dSXiaochen Shen dynamically linked module called "langwell_udc" and force all 5215be19a9dSXiaochen Shen gadget drivers to also be dynamically linked. 5225be19a9dSXiaochen Shen 5235be19a9dSXiaochen Shenconfig USB_LANGWELL 5245be19a9dSXiaochen Shen tristate 5255be19a9dSXiaochen Shen depends on USB_GADGET_LANGWELL 5265be19a9dSXiaochen Shen default USB_GADGET 5275be19a9dSXiaochen Shen select USB_GADGET_SELECTED 5285be19a9dSXiaochen Shen 529f646cf94SToshiharu Okadaconfig USB_GADGET_EG20T 53006f1b971STomoya MORINAGA boolean "Intel EG20T PCH/OKI SEMICONDUCTOR ML7213 IOH UDC" 531f646cf94SToshiharu Okada depends on PCI 532f646cf94SToshiharu Okada select USB_GADGET_DUALSPEED 533f646cf94SToshiharu Okada help 534f646cf94SToshiharu Okada This is a USB device driver for EG20T PCH. 535f646cf94SToshiharu Okada EG20T PCH is the platform controller hub that is used in Intel's 536f646cf94SToshiharu Okada general embedded platform. EG20T PCH has USB device interface. 537f646cf94SToshiharu Okada Using this interface, it is able to access system devices connected 538f646cf94SToshiharu Okada to USB device. 539f646cf94SToshiharu Okada This driver enables USB device function. 540f646cf94SToshiharu Okada USB device is a USB peripheral controller which 541f646cf94SToshiharu Okada supports both full and high speed USB 2.0 data transfers. 542f646cf94SToshiharu Okada This driver supports both control transfer and bulk transfer modes. 543f646cf94SToshiharu Okada This driver dose not support interrupt transfer or isochronous 544f646cf94SToshiharu Okada transfer modes. 545f646cf94SToshiharu Okada 54606f1b971STomoya MORINAGA This driver also can be used for OKI SEMICONDUCTOR's ML7213 which is 54706f1b971STomoya MORINAGA for IVI(In-Vehicle Infotainment) use. 54806f1b971STomoya MORINAGA ML7213 is companion chip for Intel Atom E6xx series. 54906f1b971STomoya MORINAGA ML7213 is completely compatible for Intel EG20T PCH. 55006f1b971STomoya MORINAGA 551f646cf94SToshiharu Okadaconfig USB_EG20T 552f646cf94SToshiharu Okada tristate 553f646cf94SToshiharu Okada depends on USB_GADGET_EG20T 554f646cf94SToshiharu Okada default USB_GADGET 555f646cf94SToshiharu Okada select USB_GADGET_SELECTED 556a7a19facSDavid Brownell 55733f82f38SPavankumar Kondeticonfig USB_GADGET_CI13XXX_MSM 55833f82f38SPavankumar Kondeti boolean "MIPS USB CI13xxx for MSM" 55933f82f38SPavankumar Kondeti depends on ARCH_MSM 56033f82f38SPavankumar Kondeti select USB_GADGET_DUALSPEED 561dfb2130cSPavankumar Kondeti select USB_MSM_OTG 56233f82f38SPavankumar Kondeti help 56333f82f38SPavankumar Kondeti MSM SoC has chipidea USB controller. This driver uses 56433f82f38SPavankumar Kondeti ci13xxx_udc core. 56533f82f38SPavankumar Kondeti This driver depends on OTG driver for PHY initialization, 56633f82f38SPavankumar Kondeti clock management, powering up VBUS, and power management. 5678cf28f1fSPavankumar Kondeti This driver is not supported on boards like trout which 5688cf28f1fSPavankumar Kondeti has an external PHY. 56933f82f38SPavankumar Kondeti 57033f82f38SPavankumar Kondeti Say "y" to link the driver statically, or "m" to build a 57133f82f38SPavankumar Kondeti dynamically linked module called "ci13xxx_msm" and force all 57233f82f38SPavankumar Kondeti gadget drivers to also be dynamically linked. 57333f82f38SPavankumar Kondeti 57433f82f38SPavankumar Kondeticonfig USB_CI13XXX_MSM 57533f82f38SPavankumar Kondeti tristate 57633f82f38SPavankumar Kondeti depends on USB_GADGET_CI13XXX_MSM 57733f82f38SPavankumar Kondeti default USB_GADGET 57833f82f38SPavankumar Kondeti select USB_GADGET_SELECTED 579a7a19facSDavid Brownell 580a7a19facSDavid Brownell# 581a7a19facSDavid Brownell# LAST -- dummy/emulated controller 582a7a19facSDavid Brownell# 5831da177e4SLinus Torvalds 5841da177e4SLinus Torvaldsconfig USB_GADGET_DUMMY_HCD 5851da177e4SLinus Torvalds boolean "Dummy HCD (DEVELOPMENT)" 586afd0e0f2SRobert P. J. Day depends on USB=y || (USB=m && USB_GADGET=m) 5871da177e4SLinus Torvalds select USB_GADGET_DUALSPEED 5881da177e4SLinus Torvalds help 5891da177e4SLinus Torvalds This host controller driver emulates USB, looping all data transfer 5901da177e4SLinus Torvalds requests back to a USB "gadget driver" in the same host. The host 5911da177e4SLinus Torvalds side is the master; the gadget side is the slave. Gadget drivers 5921da177e4SLinus Torvalds can be high, full, or low speed; and they have access to endpoints 5931da177e4SLinus Torvalds like those from NET2280, PXA2xx, or SA1100 hardware. 5941da177e4SLinus Torvalds 5951da177e4SLinus Torvalds This may help in some stages of creating a driver to embed in a 5961da177e4SLinus Torvalds Linux device, since it lets you debug several parts of the gadget 5971da177e4SLinus Torvalds driver without its hardware or drivers being involved. 5981da177e4SLinus Torvalds 5991da177e4SLinus Torvalds Since such a gadget side driver needs to interoperate with a host 6001da177e4SLinus Torvalds side Linux-USB device driver, this may help to debug both sides 6011da177e4SLinus Torvalds of a USB protocol stack. 6021da177e4SLinus Torvalds 6031da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 6041da177e4SLinus Torvalds dynamically linked module called "dummy_hcd" and force all 6051da177e4SLinus Torvalds gadget drivers to also be dynamically linked. 6061da177e4SLinus Torvalds 6071da177e4SLinus Torvaldsconfig USB_DUMMY_HCD 6081da177e4SLinus Torvalds tristate 6091da177e4SLinus Torvalds depends on USB_GADGET_DUMMY_HCD 6101da177e4SLinus Torvalds default USB_GADGET 611028b271bSDavid Brownell select USB_GADGET_SELECTED 6121da177e4SLinus Torvalds 6131da177e4SLinus Torvalds# NOTE: Please keep dummy_hcd LAST so that "real hardware" appears 6141da177e4SLinus Torvalds# first and will be selected by default. 6151da177e4SLinus Torvalds 6161da177e4SLinus Torvaldsendchoice 6171da177e4SLinus Torvalds 6181da177e4SLinus Torvaldsconfig USB_GADGET_DUALSPEED 6191da177e4SLinus Torvalds bool 6201da177e4SLinus Torvalds depends on USB_GADGET 6211da177e4SLinus Torvalds default n 6221da177e4SLinus Torvalds help 6231da177e4SLinus Torvalds Means that gadget drivers should include extra descriptors 6241da177e4SLinus Torvalds and code to handle dual-speed controllers. 6251da177e4SLinus Torvalds 6261da177e4SLinus Torvalds# 6271da177e4SLinus Torvalds# USB Gadget Drivers 6281da177e4SLinus Torvalds# 6291da177e4SLinus Torvaldschoice 6301da177e4SLinus Torvalds tristate "USB Gadget Drivers" 631028b271bSDavid Brownell depends on USB_GADGET && USB_GADGET_SELECTED 6321da177e4SLinus Torvalds default USB_ETH 6331da177e4SLinus Torvalds help 6341da177e4SLinus Torvalds A Linux "Gadget Driver" talks to the USB Peripheral Controller 6351da177e4SLinus Torvalds driver through the abstract "gadget" API. Some other operating 6361da177e4SLinus Torvalds systems call these "client" drivers, of which "class drivers" 6371da177e4SLinus Torvalds are a subset (implementing a USB device class specification). 6381da177e4SLinus Torvalds A gadget driver implements one or more USB functions using 6391da177e4SLinus Torvalds the peripheral hardware. 6401da177e4SLinus Torvalds 6411da177e4SLinus Torvalds Gadget drivers are hardware-neutral, or "platform independent", 6421da177e4SLinus Torvalds except that they sometimes must understand quirks or limitations 6431da177e4SLinus Torvalds of the particular controllers they work with. For example, when 6441da177e4SLinus Torvalds a controller doesn't support alternate configurations or provide 6451da177e4SLinus Torvalds enough of the right types of endpoints, the gadget driver might 6461da177e4SLinus Torvalds not be able work with that controller, or might need to implement 6471da177e4SLinus Torvalds a less common variant of a device class protocol. 6481da177e4SLinus Torvalds 6491da177e4SLinus Torvalds# this first set of drivers all depend on bulk-capable hardware. 6501da177e4SLinus Torvalds 6511da177e4SLinus Torvaldsconfig USB_ZERO 6521da177e4SLinus Torvalds tristate "Gadget Zero (DEVELOPMENT)" 6531da177e4SLinus Torvalds help 6541da177e4SLinus Torvalds Gadget Zero is a two-configuration device. It either sinks and 6551da177e4SLinus Torvalds sources bulk data; or it loops back a configurable number of 6561da177e4SLinus Torvalds transfers. It also implements control requests, for "chapter 9" 6571da177e4SLinus Torvalds conformance. The driver needs only two bulk-capable endpoints, so 6581da177e4SLinus Torvalds it can work on top of most device-side usb controllers. It's 6591da177e4SLinus Torvalds useful for testing, and is also a working example showing how 6601da177e4SLinus Torvalds USB "gadget drivers" can be written. 6611da177e4SLinus Torvalds 6621da177e4SLinus Torvalds Make this be the first driver you try using on top of any new 6631da177e4SLinus Torvalds USB peripheral controller driver. Then you can use host-side 6641da177e4SLinus Torvalds test software, like the "usbtest" driver, to put your hardware 6651da177e4SLinus Torvalds and its driver through a basic set of functional tests. 6661da177e4SLinus Torvalds 6671da177e4SLinus Torvalds Gadget Zero also works with the host-side "usb-skeleton" driver, 6681da177e4SLinus Torvalds and with many kinds of host-side test software. You may need 6691da177e4SLinus Torvalds to tweak product and vendor IDs before host software knows about 6701da177e4SLinus Torvalds this device, and arrange to select an appropriate configuration. 6711da177e4SLinus Torvalds 6721da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 6731da177e4SLinus Torvalds dynamically linked module called "g_zero". 6741da177e4SLinus Torvalds 6751da177e4SLinus Torvaldsconfig USB_ZERO_HNPTEST 6761da177e4SLinus Torvalds boolean "HNP Test Device" 6771da177e4SLinus Torvalds depends on USB_ZERO && USB_OTG 6781da177e4SLinus Torvalds help 6791da177e4SLinus Torvalds You can configure this device to enumerate using the device 6801da177e4SLinus Torvalds identifiers of the USB-OTG test device. That means that when 6811da177e4SLinus Torvalds this gadget connects to another OTG device, with this one using 6821da177e4SLinus Torvalds the "B-Peripheral" role, that device will use HNP to let this 6831da177e4SLinus Torvalds one serve as the USB host instead (in the "B-Host" role). 6841da177e4SLinus Torvalds 685c6994e6fSBryan Wuconfig USB_AUDIO 686c6994e6fSBryan Wu tristate "Audio Gadget (EXPERIMENTAL)" 687c6994e6fSBryan Wu depends on SND 68804950737SRandy Dunlap select SND_PCM 689c6994e6fSBryan Wu help 690c6994e6fSBryan Wu Gadget Audio is compatible with USB Audio Class specification 1.0. 691c6994e6fSBryan Wu It will include at least one AudioControl interface, zero or more 692c6994e6fSBryan Wu AudioStream interface and zero or more MIDIStream interface. 693c6994e6fSBryan Wu 694c6994e6fSBryan Wu Gadget Audio will use on-board ALSA (CONFIG_SND) audio card to 695c6994e6fSBryan Wu playback or capture audio stream. 696c6994e6fSBryan Wu 697c6994e6fSBryan Wu Say "y" to link the driver statically, or "m" to build a 698c6994e6fSBryan Wu dynamically linked module called "g_audio". 699c6994e6fSBryan Wu 7001da177e4SLinus Torvaldsconfig USB_ETH 7011da177e4SLinus Torvalds tristate "Ethernet Gadget (with CDC Ethernet support)" 7021da177e4SLinus Torvalds depends on NET 7039e221be8SRandy Dunlap select CRC32 7041da177e4SLinus Torvalds help 7059b39e9ddSBrian Niebuhr This driver implements Ethernet style communication, in one of 7069b39e9ddSBrian Niebuhr several ways: 7071da177e4SLinus Torvalds 7081da177e4SLinus Torvalds - The "Communication Device Class" (CDC) Ethernet Control Model. 7091da177e4SLinus Torvalds That protocol is often avoided with pure Ethernet adapters, in 7101da177e4SLinus Torvalds favor of simpler vendor-specific hardware, but is widely 7111da177e4SLinus Torvalds supported by firmware for smart network devices. 7121da177e4SLinus Torvalds 7131da177e4SLinus Torvalds - On hardware can't implement that protocol, a simple CDC subset 7141da177e4SLinus Torvalds is used, placing fewer demands on USB. 7151da177e4SLinus Torvalds 7169b39e9ddSBrian Niebuhr - CDC Ethernet Emulation Model (EEM) is a newer standard that has 7179b39e9ddSBrian Niebuhr a simpler interface that can be used by more USB hardware. 7189b39e9ddSBrian Niebuhr 7199b39e9ddSBrian Niebuhr RNDIS support is an additional option, more demanding than than 7209b39e9ddSBrian Niebuhr subset. 7211da177e4SLinus Torvalds 7221da177e4SLinus Torvalds Within the USB device, this gadget driver exposes a network device 7231da177e4SLinus Torvalds "usbX", where X depends on what other networking devices you have. 7241da177e4SLinus Torvalds Treat it like a two-node Ethernet link: host, and gadget. 7251da177e4SLinus Torvalds 7261da177e4SLinus Torvalds The Linux-USB host-side "usbnet" driver interoperates with this 7271da177e4SLinus Torvalds driver, so that deep I/O queues can be supported. On 2.4 kernels, 7281da177e4SLinus Torvalds use "CDCEther" instead, if you're using the CDC option. That CDC 7291da177e4SLinus Torvalds mode should also interoperate with standard CDC Ethernet class 7301da177e4SLinus Torvalds drivers on other host operating systems. 7311da177e4SLinus Torvalds 7321da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 7331da177e4SLinus Torvalds dynamically linked module called "g_ether". 7341da177e4SLinus Torvalds 7351da177e4SLinus Torvaldsconfig USB_ETH_RNDIS 736afd0e0f2SRobert P. J. Day bool "RNDIS support" 737afd0e0f2SRobert P. J. Day depends on USB_ETH 7381da177e4SLinus Torvalds default y 7391da177e4SLinus Torvalds help 7401da177e4SLinus Torvalds Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol, 7411da177e4SLinus Torvalds and Microsoft provides redistributable binary RNDIS drivers for 7421da177e4SLinus Torvalds older versions of Windows. 7431da177e4SLinus Torvalds 7441da177e4SLinus Torvalds If you say "y" here, the Ethernet gadget driver will try to provide 7451da177e4SLinus Torvalds a second device configuration, supporting RNDIS to talk to such 7461da177e4SLinus Torvalds Microsoft USB hosts. 7471da177e4SLinus Torvalds 7481da177e4SLinus Torvalds To make MS-Windows work with this, use Documentation/usb/linux.inf 7491da177e4SLinus Torvalds as the "driver info file". For versions of MS-Windows older than 7501da177e4SLinus Torvalds XP, you'll need to download drivers from Microsoft's website; a URL 7511da177e4SLinus Torvalds is given in comments found in that info file. 7521da177e4SLinus Torvalds 7539b39e9ddSBrian Niebuhrconfig USB_ETH_EEM 7549b39e9ddSBrian Niebuhr bool "Ethernet Emulation Model (EEM) support" 7559b39e9ddSBrian Niebuhr depends on USB_ETH 7569b39e9ddSBrian Niebuhr default n 7579b39e9ddSBrian Niebuhr help 7589b39e9ddSBrian Niebuhr CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM 7599b39e9ddSBrian Niebuhr and therefore can be supported by more hardware. Technically ECM and 7609b39e9ddSBrian Niebuhr EEM are designed for different applications. The ECM model extends 7619b39e9ddSBrian Niebuhr the network interface to the target (e.g. a USB cable modem), and the 7629b39e9ddSBrian Niebuhr EEM model is for mobile devices to communicate with hosts using 7639b39e9ddSBrian Niebuhr ethernet over USB. For Linux gadgets, however, the interface with 7649b39e9ddSBrian Niebuhr the host is the same (a usbX device), so the differences are minimal. 7659b39e9ddSBrian Niebuhr 7669b39e9ddSBrian Niebuhr If you say "y" here, the Ethernet gadget driver will use the EEM 7679b39e9ddSBrian Niebuhr protocol rather than ECM. If unsure, say "n". 7689b39e9ddSBrian Niebuhr 7696c34d288SYauheni Kaliutaconfig USB_G_NCM 7706c34d288SYauheni Kaliuta tristate "Network Control Model (NCM) support" 7716c34d288SYauheni Kaliuta depends on NET 7726c34d288SYauheni Kaliuta select CRC32 7736c34d288SYauheni Kaliuta help 7746c34d288SYauheni Kaliuta This driver implements USB CDC NCM subclass standard. NCM is 7756c34d288SYauheni Kaliuta an advanced protocol for Ethernet encapsulation, allows grouping 7766c34d288SYauheni Kaliuta of several ethernet frames into one USB transfer and diffferent 7776c34d288SYauheni Kaliuta alignment possibilities. 7786c34d288SYauheni Kaliuta 7796c34d288SYauheni Kaliuta Say "y" to link the driver statically, or "m" to build a 7806c34d288SYauheni Kaliuta dynamically linked module called "g_ncm". 7816c34d288SYauheni Kaliuta 7821da177e4SLinus Torvaldsconfig USB_GADGETFS 7831da177e4SLinus Torvalds tristate "Gadget Filesystem (EXPERIMENTAL)" 7841da177e4SLinus Torvalds depends on EXPERIMENTAL 7851da177e4SLinus Torvalds help 7861da177e4SLinus Torvalds This driver provides a filesystem based API that lets user mode 7871da177e4SLinus Torvalds programs implement a single-configuration USB device, including 7881da177e4SLinus Torvalds endpoint I/O and control requests that don't relate to enumeration. 7891da177e4SLinus Torvalds All endpoints, transfer speeds, and transfer types supported by 7901da177e4SLinus Torvalds the hardware are available, through read() and write() calls. 7911da177e4SLinus Torvalds 792afd0e0f2SRobert P. J. Day Currently, this option is still labelled as EXPERIMENTAL because 793afd0e0f2SRobert P. J. Day of existing race conditions in the underlying in-kernel AIO core. 794afd0e0f2SRobert P. J. Day 7951da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 7961da177e4SLinus Torvalds dynamically linked module called "gadgetfs". 7971da177e4SLinus Torvalds 798c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS 799c6c56008SMichal Nazarewicz tristate "Function Filesystem (EXPERIMENTAL)" 800c6c56008SMichal Nazarewicz depends on EXPERIMENTAL 801f8dae531SMichal Nazarewicz select USB_FUNCTIONFS_GENERIC if !(USB_FUNCTIONFS_ETH || USB_FUNCTIONFS_RNDIS) 802c6c56008SMichal Nazarewicz help 803eabf0f5fSMichael Prokop The Function Filesystem (FunctionFS) lets one create USB 804eabf0f5fSMichael Prokop composite functions in user space in the same way GadgetFS 805c6c56008SMichal Nazarewicz lets one create USB gadgets in user space. This allows creation 806c6c56008SMichal Nazarewicz of composite gadgets such that some of the functions are 807c6c56008SMichal Nazarewicz implemented in kernel space (for instance Ethernet, serial or 808c6c56008SMichal Nazarewicz mass storage) and other are implemented in user space. 809c6c56008SMichal Nazarewicz 810f8dae531SMichal Nazarewicz If you say "y" or "m" here you will be able what kind of 811f8dae531SMichal Nazarewicz configurations the gadget will provide. 812f8dae531SMichal Nazarewicz 813c6c56008SMichal Nazarewicz Say "y" to link the driver statically, or "m" to build 814c6c56008SMichal Nazarewicz a dynamically linked module called "g_ffs". 815c6c56008SMichal Nazarewicz 816c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_ETH 817f8dae531SMichal Nazarewicz bool "Include configuration with CDC ECM (Ethernet)" 81817b2765eSRandy Dunlap depends on USB_FUNCTIONFS && NET 819c6c56008SMichal Nazarewicz help 820eabf0f5fSMichael Prokop Include a configuration with CDC ECM function (Ethernet) and the 821eabf0f5fSMichael Prokop Function Filesystem. 822c6c56008SMichal Nazarewicz 823c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_RNDIS 824f8dae531SMichal Nazarewicz bool "Include configuration with RNDIS (Ethernet)" 82517b2765eSRandy Dunlap depends on USB_FUNCTIONFS && NET 826c6c56008SMichal Nazarewicz help 827eabf0f5fSMichael Prokop Include a configuration with RNDIS function (Ethernet) and the Filesystem. 828c6c56008SMichal Nazarewicz 829c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_GENERIC 830c6c56008SMichal Nazarewicz bool "Include 'pure' configuration" 831f8dae531SMichal Nazarewicz depends on USB_FUNCTIONFS 832c6c56008SMichal Nazarewicz help 833f8dae531SMichal Nazarewicz Include a configuration with the Function Filesystem alone with 834f8dae531SMichal Nazarewicz no Ethernet interface. 835c6c56008SMichal Nazarewicz 8361da177e4SLinus Torvaldsconfig USB_FILE_STORAGE 8371da177e4SLinus Torvalds tristate "File-backed Storage Gadget" 83887840289SRandy Dunlap depends on BLOCK 8391da177e4SLinus Torvalds help 8401da177e4SLinus Torvalds The File-backed Storage Gadget acts as a USB Mass Storage 8411da177e4SLinus Torvalds disk drive. As its storage repository it can use a regular 8421da177e4SLinus Torvalds file or a block device (in much the same way as the "loop" 8431da177e4SLinus Torvalds device driver), specified as a module parameter. 8441da177e4SLinus Torvalds 8451da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 8461da177e4SLinus Torvalds dynamically linked module called "g_file_storage". 8471da177e4SLinus Torvalds 8481da177e4SLinus Torvaldsconfig USB_FILE_STORAGE_TEST 8491da177e4SLinus Torvalds bool "File-backed Storage Gadget testing version" 8501da177e4SLinus Torvalds depends on USB_FILE_STORAGE 8511da177e4SLinus Torvalds default n 8521da177e4SLinus Torvalds help 8531da177e4SLinus Torvalds Say "y" to generate the larger testing version of the 8541da177e4SLinus Torvalds File-backed Storage Gadget, useful for probing the 8551da177e4SLinus Torvalds behavior of USB Mass Storage hosts. Not needed for 8561da177e4SLinus Torvalds normal operation. 8571da177e4SLinus Torvalds 858d23b0f08SMichal Nazarewiczconfig USB_MASS_STORAGE 859d23b0f08SMichal Nazarewicz tristate "Mass Storage Gadget" 860d23b0f08SMichal Nazarewicz depends on BLOCK 861d23b0f08SMichal Nazarewicz help 862d23b0f08SMichal Nazarewicz The Mass Storage Gadget acts as a USB Mass Storage disk drive. 863d23b0f08SMichal Nazarewicz As its storage repository it can use a regular file or a block 864d23b0f08SMichal Nazarewicz device (in much the same way as the "loop" device driver), 865d23b0f08SMichal Nazarewicz specified as a module parameter or sysfs option. 866d23b0f08SMichal Nazarewicz 867d23b0f08SMichal Nazarewicz This is heavily based on File-backed Storage Gadget and in most 868d23b0f08SMichal Nazarewicz cases you will want to use FSG instead. This gadget is mostly 869d23b0f08SMichal Nazarewicz here to test the functionality of the Mass Storage Function 870d23b0f08SMichal Nazarewicz which may be used with composite framework. 871d23b0f08SMichal Nazarewicz 872d23b0f08SMichal Nazarewicz Say "y" to link the driver statically, or "m" to build 87311b10d99SMichal Nazarewicz a dynamically linked module called "g_mass_storage". If unsure, 874d23b0f08SMichal Nazarewicz consider File-backed Storage Gadget. 875d23b0f08SMichal Nazarewicz 8761da177e4SLinus Torvaldsconfig USB_G_SERIAL 8773086775aSFelipe Balbi tristate "Serial Gadget (with CDC ACM and CDC OBEX support)" 8781da177e4SLinus Torvalds help 8791da177e4SLinus Torvalds The Serial Gadget talks to the Linux-USB generic serial driver. 8801da177e4SLinus Torvalds This driver supports a CDC-ACM module option, which can be used 8811da177e4SLinus Torvalds to interoperate with MS-Windows hosts or with the Linux-USB 8821da177e4SLinus Torvalds "cdc-acm" driver. 8831da177e4SLinus Torvalds 8843086775aSFelipe Balbi This driver also supports a CDC-OBEX option. You will need a 8853086775aSFelipe Balbi user space OBEX server talking to /dev/ttyGS*, since the kernel 8863086775aSFelipe Balbi itself doesn't implement the OBEX protocol. 8873086775aSFelipe Balbi 8881da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 8891da177e4SLinus Torvalds dynamically linked module called "g_serial". 8901da177e4SLinus Torvalds 8911da177e4SLinus Torvalds For more information, see Documentation/usb/gadget_serial.txt 8921da177e4SLinus Torvalds which includes instructions and a "driver info file" needed to 8933086775aSFelipe Balbi make MS-Windows work with CDC ACM. 8941da177e4SLinus Torvalds 895f2ebf92cSBen Williamsonconfig USB_MIDI_GADGET 896f2ebf92cSBen Williamson tristate "MIDI Gadget (EXPERIMENTAL)" 897f2ebf92cSBen Williamson depends on SND && EXPERIMENTAL 898f2ebf92cSBen Williamson select SND_RAWMIDI 899f2ebf92cSBen Williamson help 900f2ebf92cSBen Williamson The MIDI Gadget acts as a USB Audio device, with one MIDI 901f2ebf92cSBen Williamson input and one MIDI output. These MIDI jacks appear as 902f2ebf92cSBen Williamson a sound "card" in the ALSA sound system. Other MIDI 903f2ebf92cSBen Williamson connections can then be made on the gadget system, using 904f2ebf92cSBen Williamson ALSA's aconnect utility etc. 905f2ebf92cSBen Williamson 906f2ebf92cSBen Williamson Say "y" to link the driver statically, or "m" to build a 907f2ebf92cSBen Williamson dynamically linked module called "g_midi". 908f2ebf92cSBen Williamson 90925a010c8SCraig W. Nadlerconfig USB_G_PRINTER 91025a010c8SCraig W. Nadler tristate "Printer Gadget" 91125a010c8SCraig W. Nadler help 91225a010c8SCraig W. Nadler The Printer Gadget channels data between the USB host and a 91325a010c8SCraig W. Nadler userspace program driving the print engine. The user space 91425a010c8SCraig W. Nadler program reads and writes the device file /dev/g_printer to 91525a010c8SCraig W. Nadler receive or send printer data. It can use ioctl calls to 91625a010c8SCraig W. Nadler the device file to get or set printer status. 91725a010c8SCraig W. Nadler 91825a010c8SCraig W. Nadler Say "y" to link the driver statically, or "m" to build a 91925a010c8SCraig W. Nadler dynamically linked module called "g_printer". 92025a010c8SCraig W. Nadler 92125a010c8SCraig W. Nadler For more information, see Documentation/usb/gadget_printer.txt 92225a010c8SCraig W. Nadler which includes sample code for accessing the device file. 9231da177e4SLinus Torvalds 92419e20680SDavid Brownellconfig USB_CDC_COMPOSITE 92519e20680SDavid Brownell tristate "CDC Composite Device (Ethernet and ACM)" 9264ddd9ec1SRandy Dunlap depends on NET 92719e20680SDavid Brownell help 92819e20680SDavid Brownell This driver provides two functions in one configuration: 92919e20680SDavid Brownell a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link. 93019e20680SDavid Brownell 93119e20680SDavid Brownell This driver requires four bulk and two interrupt endpoints, 93219e20680SDavid Brownell plus the ability to handle altsettings. Not all peripheral 93319e20680SDavid Brownell controllers are that capable. 93419e20680SDavid Brownell 93519e20680SDavid Brownell Say "y" to link the driver statically, or "m" to build a 93619e20680SDavid Brownell dynamically linked module. 93719e20680SDavid Brownell 938f358f5b4SFelipe Balbiconfig USB_G_NOKIA 939f358f5b4SFelipe Balbi tristate "Nokia composite gadget" 940f358f5b4SFelipe Balbi depends on PHONET 941f358f5b4SFelipe Balbi help 942f358f5b4SFelipe Balbi The Nokia composite gadget provides support for acm, obex 943f358f5b4SFelipe Balbi and phonet in only one composite gadget driver. 944f358f5b4SFelipe Balbi 945f358f5b4SFelipe Balbi It's only really useful for N900 hardware. If you're building 946f358f5b4SFelipe Balbi a kernel for N900, say Y or M here. If unsure, say N. 947f358f5b4SFelipe Balbi 948f176a5d8SMichal Nazarewiczconfig USB_G_MULTI 949f176a5d8SMichal Nazarewicz tristate "Multifunction Composite Gadget (EXPERIMENTAL)" 9505791e103SRandy Dunlap depends on BLOCK && NET 951279cc49aSMichal Nazarewicz select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS 952f176a5d8SMichal Nazarewicz help 953f176a5d8SMichal Nazarewicz The Multifunction Composite Gadget provides Ethernet (RNDIS 954f176a5d8SMichal Nazarewicz and/or CDC Ethernet), mass storage and ACM serial link 955f176a5d8SMichal Nazarewicz interfaces. 956f176a5d8SMichal Nazarewicz 9575791e103SRandy Dunlap You will be asked to choose which of the two configurations is 958f176a5d8SMichal Nazarewicz to be available in the gadget. At least one configuration must 9595791e103SRandy Dunlap be chosen to make the gadget usable. Selecting more than one 960f176a5d8SMichal Nazarewicz configuration will prevent Windows from automatically detecting 9615791e103SRandy Dunlap the gadget as a composite gadget, so an INF file will be needed to 962f176a5d8SMichal Nazarewicz use the gadget. 963f176a5d8SMichal Nazarewicz 964f176a5d8SMichal Nazarewicz Say "y" to link the driver statically, or "m" to build a 965f176a5d8SMichal Nazarewicz dynamically linked module called "g_multi". 966f176a5d8SMichal Nazarewicz 967f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_RNDIS 968f176a5d8SMichal Nazarewicz bool "RNDIS + CDC Serial + Storage configuration" 969f176a5d8SMichal Nazarewicz depends on USB_G_MULTI 970f176a5d8SMichal Nazarewicz default y 971f176a5d8SMichal Nazarewicz help 972f176a5d8SMichal Nazarewicz This option enables a configuration with RNDIS, CDC Serial and 973f176a5d8SMichal Nazarewicz Mass Storage functions available in the Multifunction Composite 9745791e103SRandy Dunlap Gadget. This is the configuration dedicated for Windows since RNDIS 9755791e103SRandy Dunlap is Microsoft's protocol. 976f176a5d8SMichal Nazarewicz 977f176a5d8SMichal Nazarewicz If unsure, say "y". 978f176a5d8SMichal Nazarewicz 979f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_CDC 980f176a5d8SMichal Nazarewicz bool "CDC Ethernet + CDC Serial + Storage configuration" 981f176a5d8SMichal Nazarewicz depends on USB_G_MULTI 982f176a5d8SMichal Nazarewicz default n 983f176a5d8SMichal Nazarewicz help 984f176a5d8SMichal Nazarewicz This option enables a configuration with CDC Ethernet (ECM), CDC 985f176a5d8SMichal Nazarewicz Serial and Mass Storage functions available in the Multifunction 9865791e103SRandy Dunlap Composite Gadget. 987f176a5d8SMichal Nazarewicz 988f176a5d8SMichal Nazarewicz If unsure, say "y". 989f176a5d8SMichal Nazarewicz 99071adf118SFabien Chouteauconfig USB_G_HID 99171adf118SFabien Chouteau tristate "HID Gadget" 99271adf118SFabien Chouteau help 99371adf118SFabien Chouteau The HID gadget driver provides generic emulation of USB 99471adf118SFabien Chouteau Human Interface Devices (HID). 99571adf118SFabien Chouteau 99671adf118SFabien Chouteau For more information, see Documentation/usb/gadget_hid.txt which 99771adf118SFabien Chouteau includes sample code for accessing the device files. 99871adf118SFabien Chouteau 99971adf118SFabien Chouteau Say "y" to link the driver statically, or "m" to build a 100071adf118SFabien Chouteau dynamically linked module called "g_hid". 1001f176a5d8SMichal Nazarewicz 1002f6c826a9Sstephane duvergerconfig USB_G_DBGP 1003f6c826a9Sstephane duverger tristate "EHCI Debug Device Gadget" 1004f6c826a9Sstephane duverger help 1005f6c826a9Sstephane duverger This gadget emulates an EHCI Debug device. This is useful when you want 1006f6c826a9Sstephane duverger to interact with an EHCI Debug Port. 1007f6c826a9Sstephane duverger 1008f6c826a9Sstephane duverger Say "y" to link the driver statically, or "m" to build a 1009f6c826a9Sstephane duverger dynamically linked module called "g_dbgp". 1010f6c826a9Sstephane duverger 1011f6c826a9Sstephane duvergerif USB_G_DBGP 1012f6c826a9Sstephane duvergerchoice 1013f6c826a9Sstephane duverger prompt "EHCI Debug Device mode" 1014f6c826a9Sstephane duverger default USB_G_DBGP_SERIAL 1015f6c826a9Sstephane duverger 1016f6c826a9Sstephane duvergerconfig USB_G_DBGP_PRINTK 1017f6c826a9Sstephane duverger depends on USB_G_DBGP 1018f6c826a9Sstephane duverger bool "printk" 1019f6c826a9Sstephane duverger help 1020f6c826a9Sstephane duverger Directly printk() received data. No interaction. 1021f6c826a9Sstephane duverger 1022f6c826a9Sstephane duvergerconfig USB_G_DBGP_SERIAL 1023f6c826a9Sstephane duverger depends on USB_G_DBGP 1024f6c826a9Sstephane duverger bool "serial" 1025f6c826a9Sstephane duverger help 1026f6c826a9Sstephane duverger Userland can interact using /dev/ttyGSxxx. 1027f6c826a9Sstephane duvergerendchoice 1028f6c826a9Sstephane duvergerendif 1029f6c826a9Sstephane duverger 10301da177e4SLinus Torvalds# put drivers that need isochronous transfer support (for audio 10311da177e4SLinus Torvalds# or video class gadget drivers), or specific hardware, here. 1032a9914127SLaurent Pinchartconfig USB_G_WEBCAM 1033a9914127SLaurent Pinchart tristate "USB Webcam Gadget" 103424337c13SRandy Dunlap depends on VIDEO_DEV 1035a9914127SLaurent Pinchart help 1036a9914127SLaurent Pinchart The Webcam Gadget acts as a composite USB Audio and Video Class 1037a9914127SLaurent Pinchart device. It provides a userspace API to process UVC control requests 1038a9914127SLaurent Pinchart and stream video data to the host. 10391da177e4SLinus Torvalds 1040a9914127SLaurent Pinchart Say "y" to link the driver statically, or "m" to build a 1041a9914127SLaurent Pinchart dynamically linked module called "g_webcam". 10421da177e4SLinus Torvalds 10431da177e4SLinus Torvaldsendchoice 10441da177e4SLinus Torvalds 1045b75be4abSDenis Chengendif # USB_GADGET 1046