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 161*018b97d0SMarc 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 341a7a19facSDavid Brownell# 342a7a19facSDavid Brownell# Controllers available in both integrated and discrete versions 343a7a19facSDavid Brownell# 344a7a19facSDavid Brownell 345a7a19facSDavid Brownell# musb builds in ../musb along with host support 346a7a19facSDavid Brownellconfig USB_GADGET_MUSB_HDRC 347085ad406SBryan Wu boolean "Inventra HDRC USB Peripheral (TI, ADI, ...)" 348a7a19facSDavid Brownell depends on USB_MUSB_HDRC && (USB_MUSB_PERIPHERAL || USB_MUSB_OTG) 349a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 350bae4bd84SDavid Brownell select USB_GADGET_SELECTED 351bae4bd84SDavid Brownell help 352a7a19facSDavid Brownell This OTG-capable silicon IP is used in dual designs including 353085ad406SBryan Wu the TI DaVinci, OMAP 243x, OMAP 343x, TUSB 6010, and ADI Blackfin 354a7a19facSDavid Brownell 355a7a19facSDavid Brownellconfig USB_GADGET_M66592 356a7a19facSDavid Brownell boolean "Renesas M66592 USB Peripheral Controller" 357a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 358a7a19facSDavid Brownell help 359a7a19facSDavid Brownell M66592 is a discrete USB peripheral controller chip that 360a7a19facSDavid Brownell supports both full and high speed USB 2.0 data transfers. 361a7a19facSDavid Brownell It has seven configurable endpoints, and endpoint zero. 362bae4bd84SDavid Brownell 363bae4bd84SDavid Brownell Say "y" to link the driver statically, or "m" to build a 364a7a19facSDavid Brownell dynamically linked module called "m66592_udc" and force all 365bae4bd84SDavid Brownell gadget drivers to also be dynamically linked. 366bae4bd84SDavid Brownell 367a7a19facSDavid Brownellconfig USB_M66592 368bae4bd84SDavid Brownell tristate 369a7a19facSDavid Brownell depends on USB_GADGET_M66592 370bae4bd84SDavid Brownell default USB_GADGET 371a7a19facSDavid Brownell select USB_GADGET_SELECTED 372a7a19facSDavid Brownell 373a7a19facSDavid Brownell# 374a7a19facSDavid Brownell# Controllers available only in discrete form (and all PCI controllers) 375a7a19facSDavid Brownell# 376a7a19facSDavid Brownell 377a7a19facSDavid Brownellconfig USB_GADGET_AMD5536UDC 378a7a19facSDavid Brownell boolean "AMD5536 UDC" 379a7a19facSDavid Brownell depends on PCI 380a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 381a7a19facSDavid Brownell help 382a7a19facSDavid Brownell The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge. 383a7a19facSDavid Brownell It is a USB Highspeed DMA capable USB device controller. Beside ep0 384a7a19facSDavid Brownell it provides 4 IN and 4 OUT endpoints (bulk or interrupt type). 385a7a19facSDavid Brownell The UDC port supports OTG operation, and may be used as a host port 386a7a19facSDavid Brownell if it's not being used to implement peripheral or OTG roles. 387a7a19facSDavid Brownell 388a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 389a7a19facSDavid Brownell dynamically linked module called "amd5536udc" and force all 390a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 391a7a19facSDavid Brownell 392a7a19facSDavid Brownellconfig USB_AMD5536UDC 393a7a19facSDavid Brownell tristate 394a7a19facSDavid Brownell depends on USB_GADGET_AMD5536UDC 395a7a19facSDavid Brownell default USB_GADGET 396a7a19facSDavid Brownell select USB_GADGET_SELECTED 397a7a19facSDavid Brownell 3983948f0e0SLi Yangconfig USB_GADGET_FSL_QE 3993948f0e0SLi Yang boolean "Freescale QE/CPM USB Device Controller" 4003948f0e0SLi Yang depends on FSL_SOC && (QUICC_ENGINE || CPM) 4013948f0e0SLi Yang help 4023948f0e0SLi Yang Some of Freescale PowerPC processors have a Full Speed 4033948f0e0SLi Yang QE/CPM2 USB controller, which support device mode with 4 4043948f0e0SLi Yang programmable endpoints. This driver supports the 4053948f0e0SLi Yang controller in the MPC8360 and MPC8272, and should work with 4063948f0e0SLi Yang controllers having QE or CPM2, given minor tweaks. 4073948f0e0SLi Yang 4083948f0e0SLi Yang Set CONFIG_USB_GADGET to "m" to build this driver as a 409692105b8SMatt LaPlante dynamically linked module called "fsl_qe_udc". 4103948f0e0SLi Yang 4113948f0e0SLi Yangconfig USB_FSL_QE 4123948f0e0SLi Yang tristate 4133948f0e0SLi Yang depends on USB_GADGET_FSL_QE 4143948f0e0SLi Yang default USB_GADGET 4153948f0e0SLi Yang select USB_GADGET_SELECTED 4163948f0e0SLi Yang 417aa69a809SDavid Lopoconfig USB_GADGET_CI13XXX 418aa69a809SDavid Lopo boolean "MIPS USB CI13xxx" 419aa69a809SDavid Lopo depends on PCI 420aa69a809SDavid Lopo select USB_GADGET_DUALSPEED 421aa69a809SDavid Lopo help 422aa69a809SDavid Lopo MIPS USB IP core family device controller 423aa69a809SDavid Lopo Currently it only supports IP part number CI13412 424aa69a809SDavid Lopo 425aa69a809SDavid Lopo Say "y" to link the driver statically, or "m" to build a 426aa69a809SDavid Lopo dynamically linked module called "ci13xxx_udc" and force all 427aa69a809SDavid Lopo gadget drivers to also be dynamically linked. 428aa69a809SDavid Lopo 429aa69a809SDavid Lopoconfig USB_CI13XXX 430aa69a809SDavid Lopo tristate 431aa69a809SDavid Lopo depends on USB_GADGET_CI13XXX 432aa69a809SDavid Lopo default USB_GADGET 433aa69a809SDavid Lopo select USB_GADGET_SELECTED 434aa69a809SDavid Lopo 435a7a19facSDavid Brownellconfig USB_GADGET_NET2280 436a7a19facSDavid Brownell boolean "NetChip 228x" 437a7a19facSDavid Brownell depends on PCI 438a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 439a7a19facSDavid Brownell help 440a7a19facSDavid Brownell NetChip 2280 / 2282 is a PCI based USB peripheral controller which 441a7a19facSDavid Brownell supports both full and high speed USB 2.0 data transfers. 442a7a19facSDavid Brownell 443a7a19facSDavid Brownell It has six configurable endpoints, as well as endpoint zero 444a7a19facSDavid Brownell (for control transfers) and several endpoints with dedicated 445a7a19facSDavid Brownell functions. 446a7a19facSDavid Brownell 447a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 448a7a19facSDavid Brownell dynamically linked module called "net2280" and force all 449a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 450a7a19facSDavid Brownell 451a7a19facSDavid Brownellconfig USB_NET2280 452a7a19facSDavid Brownell tristate 453a7a19facSDavid Brownell depends on USB_GADGET_NET2280 454a7a19facSDavid Brownell default USB_GADGET 455a7a19facSDavid Brownell select USB_GADGET_SELECTED 456a7a19facSDavid Brownell 457a7a19facSDavid Brownellconfig USB_GADGET_GOKU 458a7a19facSDavid Brownell boolean "Toshiba TC86C001 'Goku-S'" 459a7a19facSDavid Brownell depends on PCI 460a7a19facSDavid Brownell help 461a7a19facSDavid Brownell The Toshiba TC86C001 is a PCI device which includes controllers 462a7a19facSDavid Brownell for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI). 463a7a19facSDavid Brownell 464a7a19facSDavid Brownell The device controller has three configurable (bulk or interrupt) 465a7a19facSDavid Brownell endpoints, plus endpoint zero (for control transfers). 466a7a19facSDavid Brownell 467a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 468a7a19facSDavid Brownell dynamically linked module called "goku_udc" and to force all 469a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 470a7a19facSDavid Brownell 471a7a19facSDavid Brownellconfig USB_GOKU 472a7a19facSDavid Brownell tristate 473a7a19facSDavid Brownell depends on USB_GADGET_GOKU 474a7a19facSDavid Brownell default USB_GADGET 475a7a19facSDavid Brownell select USB_GADGET_SELECTED 476a7a19facSDavid Brownell 4775be19a9dSXiaochen Shenconfig USB_GADGET_LANGWELL 4785be19a9dSXiaochen Shen boolean "Intel Langwell USB Device Controller" 4795be19a9dSXiaochen Shen depends on PCI 4805be19a9dSXiaochen Shen select USB_GADGET_DUALSPEED 4815be19a9dSXiaochen Shen help 4825be19a9dSXiaochen Shen Intel Langwell USB Device Controller is a High-Speed USB 4835be19a9dSXiaochen Shen On-The-Go device controller. 4845be19a9dSXiaochen Shen 4855be19a9dSXiaochen Shen The number of programmable endpoints is different through 4865be19a9dSXiaochen Shen controller revision. 4875be19a9dSXiaochen Shen 4885be19a9dSXiaochen Shen Say "y" to link the driver statically, or "m" to build a 4895be19a9dSXiaochen Shen dynamically linked module called "langwell_udc" and force all 4905be19a9dSXiaochen Shen gadget drivers to also be dynamically linked. 4915be19a9dSXiaochen Shen 4925be19a9dSXiaochen Shenconfig USB_LANGWELL 4935be19a9dSXiaochen Shen tristate 4945be19a9dSXiaochen Shen depends on USB_GADGET_LANGWELL 4955be19a9dSXiaochen Shen default USB_GADGET 4965be19a9dSXiaochen Shen select USB_GADGET_SELECTED 4975be19a9dSXiaochen Shen 498a7a19facSDavid Brownell 499a7a19facSDavid Brownell# 500a7a19facSDavid Brownell# LAST -- dummy/emulated controller 501a7a19facSDavid Brownell# 5021da177e4SLinus Torvalds 5031da177e4SLinus Torvaldsconfig USB_GADGET_DUMMY_HCD 5041da177e4SLinus Torvalds boolean "Dummy HCD (DEVELOPMENT)" 505afd0e0f2SRobert P. J. Day depends on USB=y || (USB=m && USB_GADGET=m) 5061da177e4SLinus Torvalds select USB_GADGET_DUALSPEED 5071da177e4SLinus Torvalds help 5081da177e4SLinus Torvalds This host controller driver emulates USB, looping all data transfer 5091da177e4SLinus Torvalds requests back to a USB "gadget driver" in the same host. The host 5101da177e4SLinus Torvalds side is the master; the gadget side is the slave. Gadget drivers 5111da177e4SLinus Torvalds can be high, full, or low speed; and they have access to endpoints 5121da177e4SLinus Torvalds like those from NET2280, PXA2xx, or SA1100 hardware. 5131da177e4SLinus Torvalds 5141da177e4SLinus Torvalds This may help in some stages of creating a driver to embed in a 5151da177e4SLinus Torvalds Linux device, since it lets you debug several parts of the gadget 5161da177e4SLinus Torvalds driver without its hardware or drivers being involved. 5171da177e4SLinus Torvalds 5181da177e4SLinus Torvalds Since such a gadget side driver needs to interoperate with a host 5191da177e4SLinus Torvalds side Linux-USB device driver, this may help to debug both sides 5201da177e4SLinus Torvalds of a USB protocol stack. 5211da177e4SLinus Torvalds 5221da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 5231da177e4SLinus Torvalds dynamically linked module called "dummy_hcd" and force all 5241da177e4SLinus Torvalds gadget drivers to also be dynamically linked. 5251da177e4SLinus Torvalds 5261da177e4SLinus Torvaldsconfig USB_DUMMY_HCD 5271da177e4SLinus Torvalds tristate 5281da177e4SLinus Torvalds depends on USB_GADGET_DUMMY_HCD 5291da177e4SLinus Torvalds default USB_GADGET 530028b271bSDavid Brownell select USB_GADGET_SELECTED 5311da177e4SLinus Torvalds 5321da177e4SLinus Torvalds# NOTE: Please keep dummy_hcd LAST so that "real hardware" appears 5331da177e4SLinus Torvalds# first and will be selected by default. 5341da177e4SLinus Torvalds 5351da177e4SLinus Torvaldsendchoice 5361da177e4SLinus Torvalds 5371da177e4SLinus Torvaldsconfig USB_GADGET_DUALSPEED 5381da177e4SLinus Torvalds bool 5391da177e4SLinus Torvalds depends on USB_GADGET 5401da177e4SLinus Torvalds default n 5411da177e4SLinus Torvalds help 5421da177e4SLinus Torvalds Means that gadget drivers should include extra descriptors 5431da177e4SLinus Torvalds and code to handle dual-speed controllers. 5441da177e4SLinus Torvalds 5451da177e4SLinus Torvalds# 5461da177e4SLinus Torvalds# USB Gadget Drivers 5471da177e4SLinus Torvalds# 5481da177e4SLinus Torvaldschoice 5491da177e4SLinus Torvalds tristate "USB Gadget Drivers" 550028b271bSDavid Brownell depends on USB_GADGET && USB_GADGET_SELECTED 5511da177e4SLinus Torvalds default USB_ETH 5521da177e4SLinus Torvalds help 5531da177e4SLinus Torvalds A Linux "Gadget Driver" talks to the USB Peripheral Controller 5541da177e4SLinus Torvalds driver through the abstract "gadget" API. Some other operating 5551da177e4SLinus Torvalds systems call these "client" drivers, of which "class drivers" 5561da177e4SLinus Torvalds are a subset (implementing a USB device class specification). 5571da177e4SLinus Torvalds A gadget driver implements one or more USB functions using 5581da177e4SLinus Torvalds the peripheral hardware. 5591da177e4SLinus Torvalds 5601da177e4SLinus Torvalds Gadget drivers are hardware-neutral, or "platform independent", 5611da177e4SLinus Torvalds except that they sometimes must understand quirks or limitations 5621da177e4SLinus Torvalds of the particular controllers they work with. For example, when 5631da177e4SLinus Torvalds a controller doesn't support alternate configurations or provide 5641da177e4SLinus Torvalds enough of the right types of endpoints, the gadget driver might 5651da177e4SLinus Torvalds not be able work with that controller, or might need to implement 5661da177e4SLinus Torvalds a less common variant of a device class protocol. 5671da177e4SLinus Torvalds 5681da177e4SLinus Torvalds# this first set of drivers all depend on bulk-capable hardware. 5691da177e4SLinus Torvalds 5701da177e4SLinus Torvaldsconfig USB_ZERO 5711da177e4SLinus Torvalds tristate "Gadget Zero (DEVELOPMENT)" 5721da177e4SLinus Torvalds help 5731da177e4SLinus Torvalds Gadget Zero is a two-configuration device. It either sinks and 5741da177e4SLinus Torvalds sources bulk data; or it loops back a configurable number of 5751da177e4SLinus Torvalds transfers. It also implements control requests, for "chapter 9" 5761da177e4SLinus Torvalds conformance. The driver needs only two bulk-capable endpoints, so 5771da177e4SLinus Torvalds it can work on top of most device-side usb controllers. It's 5781da177e4SLinus Torvalds useful for testing, and is also a working example showing how 5791da177e4SLinus Torvalds USB "gadget drivers" can be written. 5801da177e4SLinus Torvalds 5811da177e4SLinus Torvalds Make this be the first driver you try using on top of any new 5821da177e4SLinus Torvalds USB peripheral controller driver. Then you can use host-side 5831da177e4SLinus Torvalds test software, like the "usbtest" driver, to put your hardware 5841da177e4SLinus Torvalds and its driver through a basic set of functional tests. 5851da177e4SLinus Torvalds 5861da177e4SLinus Torvalds Gadget Zero also works with the host-side "usb-skeleton" driver, 5871da177e4SLinus Torvalds and with many kinds of host-side test software. You may need 5881da177e4SLinus Torvalds to tweak product and vendor IDs before host software knows about 5891da177e4SLinus Torvalds this device, and arrange to select an appropriate configuration. 5901da177e4SLinus Torvalds 5911da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 5921da177e4SLinus Torvalds dynamically linked module called "g_zero". 5931da177e4SLinus Torvalds 5941da177e4SLinus Torvaldsconfig USB_ZERO_HNPTEST 5951da177e4SLinus Torvalds boolean "HNP Test Device" 5961da177e4SLinus Torvalds depends on USB_ZERO && USB_OTG 5971da177e4SLinus Torvalds help 5981da177e4SLinus Torvalds You can configure this device to enumerate using the device 5991da177e4SLinus Torvalds identifiers of the USB-OTG test device. That means that when 6001da177e4SLinus Torvalds this gadget connects to another OTG device, with this one using 6011da177e4SLinus Torvalds the "B-Peripheral" role, that device will use HNP to let this 6021da177e4SLinus Torvalds one serve as the USB host instead (in the "B-Host" role). 6031da177e4SLinus Torvalds 604c6994e6fSBryan Wuconfig USB_AUDIO 605c6994e6fSBryan Wu tristate "Audio Gadget (EXPERIMENTAL)" 606c6994e6fSBryan Wu depends on SND 60704950737SRandy Dunlap select SND_PCM 608c6994e6fSBryan Wu help 609c6994e6fSBryan Wu Gadget Audio is compatible with USB Audio Class specification 1.0. 610c6994e6fSBryan Wu It will include at least one AudioControl interface, zero or more 611c6994e6fSBryan Wu AudioStream interface and zero or more MIDIStream interface. 612c6994e6fSBryan Wu 613c6994e6fSBryan Wu Gadget Audio will use on-board ALSA (CONFIG_SND) audio card to 614c6994e6fSBryan Wu playback or capture audio stream. 615c6994e6fSBryan Wu 616c6994e6fSBryan Wu Say "y" to link the driver statically, or "m" to build a 617c6994e6fSBryan Wu dynamically linked module called "g_audio". 618c6994e6fSBryan Wu 6191da177e4SLinus Torvaldsconfig USB_ETH 6201da177e4SLinus Torvalds tristate "Ethernet Gadget (with CDC Ethernet support)" 6211da177e4SLinus Torvalds depends on NET 6229e221be8SRandy Dunlap select CRC32 6231da177e4SLinus Torvalds help 6249b39e9ddSBrian Niebuhr This driver implements Ethernet style communication, in one of 6259b39e9ddSBrian Niebuhr several ways: 6261da177e4SLinus Torvalds 6271da177e4SLinus Torvalds - The "Communication Device Class" (CDC) Ethernet Control Model. 6281da177e4SLinus Torvalds That protocol is often avoided with pure Ethernet adapters, in 6291da177e4SLinus Torvalds favor of simpler vendor-specific hardware, but is widely 6301da177e4SLinus Torvalds supported by firmware for smart network devices. 6311da177e4SLinus Torvalds 6321da177e4SLinus Torvalds - On hardware can't implement that protocol, a simple CDC subset 6331da177e4SLinus Torvalds is used, placing fewer demands on USB. 6341da177e4SLinus Torvalds 6359b39e9ddSBrian Niebuhr - CDC Ethernet Emulation Model (EEM) is a newer standard that has 6369b39e9ddSBrian Niebuhr a simpler interface that can be used by more USB hardware. 6379b39e9ddSBrian Niebuhr 6389b39e9ddSBrian Niebuhr RNDIS support is an additional option, more demanding than than 6399b39e9ddSBrian Niebuhr subset. 6401da177e4SLinus Torvalds 6411da177e4SLinus Torvalds Within the USB device, this gadget driver exposes a network device 6421da177e4SLinus Torvalds "usbX", where X depends on what other networking devices you have. 6431da177e4SLinus Torvalds Treat it like a two-node Ethernet link: host, and gadget. 6441da177e4SLinus Torvalds 6451da177e4SLinus Torvalds The Linux-USB host-side "usbnet" driver interoperates with this 6461da177e4SLinus Torvalds driver, so that deep I/O queues can be supported. On 2.4 kernels, 6471da177e4SLinus Torvalds use "CDCEther" instead, if you're using the CDC option. That CDC 6481da177e4SLinus Torvalds mode should also interoperate with standard CDC Ethernet class 6491da177e4SLinus Torvalds drivers on other host operating systems. 6501da177e4SLinus Torvalds 6511da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 6521da177e4SLinus Torvalds dynamically linked module called "g_ether". 6531da177e4SLinus Torvalds 6541da177e4SLinus Torvaldsconfig USB_ETH_RNDIS 655afd0e0f2SRobert P. J. Day bool "RNDIS support" 656afd0e0f2SRobert P. J. Day depends on USB_ETH 6571da177e4SLinus Torvalds default y 6581da177e4SLinus Torvalds help 6591da177e4SLinus Torvalds Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol, 6601da177e4SLinus Torvalds and Microsoft provides redistributable binary RNDIS drivers for 6611da177e4SLinus Torvalds older versions of Windows. 6621da177e4SLinus Torvalds 6631da177e4SLinus Torvalds If you say "y" here, the Ethernet gadget driver will try to provide 6641da177e4SLinus Torvalds a second device configuration, supporting RNDIS to talk to such 6651da177e4SLinus Torvalds Microsoft USB hosts. 6661da177e4SLinus Torvalds 6671da177e4SLinus Torvalds To make MS-Windows work with this, use Documentation/usb/linux.inf 6681da177e4SLinus Torvalds as the "driver info file". For versions of MS-Windows older than 6691da177e4SLinus Torvalds XP, you'll need to download drivers from Microsoft's website; a URL 6701da177e4SLinus Torvalds is given in comments found in that info file. 6711da177e4SLinus Torvalds 6729b39e9ddSBrian Niebuhrconfig USB_ETH_EEM 6739b39e9ddSBrian Niebuhr bool "Ethernet Emulation Model (EEM) support" 6749b39e9ddSBrian Niebuhr depends on USB_ETH 6759b39e9ddSBrian Niebuhr default n 6769b39e9ddSBrian Niebuhr help 6779b39e9ddSBrian Niebuhr CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM 6789b39e9ddSBrian Niebuhr and therefore can be supported by more hardware. Technically ECM and 6799b39e9ddSBrian Niebuhr EEM are designed for different applications. The ECM model extends 6809b39e9ddSBrian Niebuhr the network interface to the target (e.g. a USB cable modem), and the 6819b39e9ddSBrian Niebuhr EEM model is for mobile devices to communicate with hosts using 6829b39e9ddSBrian Niebuhr ethernet over USB. For Linux gadgets, however, the interface with 6839b39e9ddSBrian Niebuhr the host is the same (a usbX device), so the differences are minimal. 6849b39e9ddSBrian Niebuhr 6859b39e9ddSBrian Niebuhr If you say "y" here, the Ethernet gadget driver will use the EEM 6869b39e9ddSBrian Niebuhr protocol rather than ECM. If unsure, say "n". 6879b39e9ddSBrian Niebuhr 6881da177e4SLinus Torvaldsconfig USB_GADGETFS 6891da177e4SLinus Torvalds tristate "Gadget Filesystem (EXPERIMENTAL)" 6901da177e4SLinus Torvalds depends on EXPERIMENTAL 6911da177e4SLinus Torvalds help 6921da177e4SLinus Torvalds This driver provides a filesystem based API that lets user mode 6931da177e4SLinus Torvalds programs implement a single-configuration USB device, including 6941da177e4SLinus Torvalds endpoint I/O and control requests that don't relate to enumeration. 6951da177e4SLinus Torvalds All endpoints, transfer speeds, and transfer types supported by 6961da177e4SLinus Torvalds the hardware are available, through read() and write() calls. 6971da177e4SLinus Torvalds 698afd0e0f2SRobert P. J. Day Currently, this option is still labelled as EXPERIMENTAL because 699afd0e0f2SRobert P. J. Day of existing race conditions in the underlying in-kernel AIO core. 700afd0e0f2SRobert P. J. Day 7011da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 7021da177e4SLinus Torvalds dynamically linked module called "gadgetfs". 7031da177e4SLinus Torvalds 704c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS 705c6c56008SMichal Nazarewicz tristate "Function Filesystem (EXPERIMENTAL)" 706c6c56008SMichal Nazarewicz depends on EXPERIMENTAL 707f8dae531SMichal Nazarewicz select USB_FUNCTIONFS_GENERIC if !(USB_FUNCTIONFS_ETH || USB_FUNCTIONFS_RNDIS) 708c6c56008SMichal Nazarewicz help 709eabf0f5fSMichael Prokop The Function Filesystem (FunctionFS) lets one create USB 710eabf0f5fSMichael Prokop composite functions in user space in the same way GadgetFS 711c6c56008SMichal Nazarewicz lets one create USB gadgets in user space. This allows creation 712c6c56008SMichal Nazarewicz of composite gadgets such that some of the functions are 713c6c56008SMichal Nazarewicz implemented in kernel space (for instance Ethernet, serial or 714c6c56008SMichal Nazarewicz mass storage) and other are implemented in user space. 715c6c56008SMichal Nazarewicz 716f8dae531SMichal Nazarewicz If you say "y" or "m" here you will be able what kind of 717f8dae531SMichal Nazarewicz configurations the gadget will provide. 718f8dae531SMichal Nazarewicz 719c6c56008SMichal Nazarewicz Say "y" to link the driver statically, or "m" to build 720c6c56008SMichal Nazarewicz a dynamically linked module called "g_ffs". 721c6c56008SMichal Nazarewicz 722c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_ETH 723f8dae531SMichal Nazarewicz bool "Include configuration with CDC ECM (Ethernet)" 72417b2765eSRandy Dunlap depends on USB_FUNCTIONFS && NET 725c6c56008SMichal Nazarewicz help 726eabf0f5fSMichael Prokop Include a configuration with CDC ECM function (Ethernet) and the 727eabf0f5fSMichael Prokop Function Filesystem. 728c6c56008SMichal Nazarewicz 729c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_RNDIS 730f8dae531SMichal Nazarewicz bool "Include configuration with RNDIS (Ethernet)" 73117b2765eSRandy Dunlap depends on USB_FUNCTIONFS && NET 732c6c56008SMichal Nazarewicz help 733eabf0f5fSMichael Prokop Include a configuration with RNDIS function (Ethernet) and the Filesystem. 734c6c56008SMichal Nazarewicz 735c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_GENERIC 736c6c56008SMichal Nazarewicz bool "Include 'pure' configuration" 737f8dae531SMichal Nazarewicz depends on USB_FUNCTIONFS 738c6c56008SMichal Nazarewicz help 739f8dae531SMichal Nazarewicz Include a configuration with the Function Filesystem alone with 740f8dae531SMichal Nazarewicz no Ethernet interface. 741c6c56008SMichal Nazarewicz 7421da177e4SLinus Torvaldsconfig USB_FILE_STORAGE 7431da177e4SLinus Torvalds tristate "File-backed Storage Gadget" 74487840289SRandy Dunlap depends on BLOCK 7451da177e4SLinus Torvalds help 7461da177e4SLinus Torvalds The File-backed Storage Gadget acts as a USB Mass Storage 7471da177e4SLinus Torvalds disk drive. As its storage repository it can use a regular 7481da177e4SLinus Torvalds file or a block device (in much the same way as the "loop" 7491da177e4SLinus Torvalds device driver), specified as a module parameter. 7501da177e4SLinus Torvalds 7511da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 7521da177e4SLinus Torvalds dynamically linked module called "g_file_storage". 7531da177e4SLinus Torvalds 7541da177e4SLinus Torvaldsconfig USB_FILE_STORAGE_TEST 7551da177e4SLinus Torvalds bool "File-backed Storage Gadget testing version" 7561da177e4SLinus Torvalds depends on USB_FILE_STORAGE 7571da177e4SLinus Torvalds default n 7581da177e4SLinus Torvalds help 7591da177e4SLinus Torvalds Say "y" to generate the larger testing version of the 7601da177e4SLinus Torvalds File-backed Storage Gadget, useful for probing the 7611da177e4SLinus Torvalds behavior of USB Mass Storage hosts. Not needed for 7621da177e4SLinus Torvalds normal operation. 7631da177e4SLinus Torvalds 764d23b0f08SMichal Nazarewiczconfig USB_MASS_STORAGE 765d23b0f08SMichal Nazarewicz tristate "Mass Storage Gadget" 766d23b0f08SMichal Nazarewicz depends on BLOCK 767d23b0f08SMichal Nazarewicz help 768d23b0f08SMichal Nazarewicz The Mass Storage Gadget acts as a USB Mass Storage disk drive. 769d23b0f08SMichal Nazarewicz As its storage repository it can use a regular file or a block 770d23b0f08SMichal Nazarewicz device (in much the same way as the "loop" device driver), 771d23b0f08SMichal Nazarewicz specified as a module parameter or sysfs option. 772d23b0f08SMichal Nazarewicz 773d23b0f08SMichal Nazarewicz This is heavily based on File-backed Storage Gadget and in most 774d23b0f08SMichal Nazarewicz cases you will want to use FSG instead. This gadget is mostly 775d23b0f08SMichal Nazarewicz here to test the functionality of the Mass Storage Function 776d23b0f08SMichal Nazarewicz which may be used with composite framework. 777d23b0f08SMichal Nazarewicz 778d23b0f08SMichal Nazarewicz Say "y" to link the driver statically, or "m" to build 77911b10d99SMichal Nazarewicz a dynamically linked module called "g_mass_storage". If unsure, 780d23b0f08SMichal Nazarewicz consider File-backed Storage Gadget. 781d23b0f08SMichal Nazarewicz 7821da177e4SLinus Torvaldsconfig USB_G_SERIAL 7833086775aSFelipe Balbi tristate "Serial Gadget (with CDC ACM and CDC OBEX support)" 7841da177e4SLinus Torvalds help 7851da177e4SLinus Torvalds The Serial Gadget talks to the Linux-USB generic serial driver. 7861da177e4SLinus Torvalds This driver supports a CDC-ACM module option, which can be used 7871da177e4SLinus Torvalds to interoperate with MS-Windows hosts or with the Linux-USB 7881da177e4SLinus Torvalds "cdc-acm" driver. 7891da177e4SLinus Torvalds 7903086775aSFelipe Balbi This driver also supports a CDC-OBEX option. You will need a 7913086775aSFelipe Balbi user space OBEX server talking to /dev/ttyGS*, since the kernel 7923086775aSFelipe Balbi itself doesn't implement the OBEX protocol. 7933086775aSFelipe Balbi 7941da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 7951da177e4SLinus Torvalds dynamically linked module called "g_serial". 7961da177e4SLinus Torvalds 7971da177e4SLinus Torvalds For more information, see Documentation/usb/gadget_serial.txt 7981da177e4SLinus Torvalds which includes instructions and a "driver info file" needed to 7993086775aSFelipe Balbi make MS-Windows work with CDC ACM. 8001da177e4SLinus Torvalds 801f2ebf92cSBen Williamsonconfig USB_MIDI_GADGET 802f2ebf92cSBen Williamson tristate "MIDI Gadget (EXPERIMENTAL)" 803f2ebf92cSBen Williamson depends on SND && EXPERIMENTAL 804f2ebf92cSBen Williamson select SND_RAWMIDI 805f2ebf92cSBen Williamson help 806f2ebf92cSBen Williamson The MIDI Gadget acts as a USB Audio device, with one MIDI 807f2ebf92cSBen Williamson input and one MIDI output. These MIDI jacks appear as 808f2ebf92cSBen Williamson a sound "card" in the ALSA sound system. Other MIDI 809f2ebf92cSBen Williamson connections can then be made on the gadget system, using 810f2ebf92cSBen Williamson ALSA's aconnect utility etc. 811f2ebf92cSBen Williamson 812f2ebf92cSBen Williamson Say "y" to link the driver statically, or "m" to build a 813f2ebf92cSBen Williamson dynamically linked module called "g_midi". 814f2ebf92cSBen Williamson 81525a010c8SCraig W. Nadlerconfig USB_G_PRINTER 81625a010c8SCraig W. Nadler tristate "Printer Gadget" 81725a010c8SCraig W. Nadler help 81825a010c8SCraig W. Nadler The Printer Gadget channels data between the USB host and a 81925a010c8SCraig W. Nadler userspace program driving the print engine. The user space 82025a010c8SCraig W. Nadler program reads and writes the device file /dev/g_printer to 82125a010c8SCraig W. Nadler receive or send printer data. It can use ioctl calls to 82225a010c8SCraig W. Nadler the device file to get or set printer status. 82325a010c8SCraig W. Nadler 82425a010c8SCraig W. Nadler Say "y" to link the driver statically, or "m" to build a 82525a010c8SCraig W. Nadler dynamically linked module called "g_printer". 82625a010c8SCraig W. Nadler 82725a010c8SCraig W. Nadler For more information, see Documentation/usb/gadget_printer.txt 82825a010c8SCraig W. Nadler which includes sample code for accessing the device file. 8291da177e4SLinus Torvalds 83019e20680SDavid Brownellconfig USB_CDC_COMPOSITE 83119e20680SDavid Brownell tristate "CDC Composite Device (Ethernet and ACM)" 8324ddd9ec1SRandy Dunlap depends on NET 83319e20680SDavid Brownell help 83419e20680SDavid Brownell This driver provides two functions in one configuration: 83519e20680SDavid Brownell a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link. 83619e20680SDavid Brownell 83719e20680SDavid Brownell This driver requires four bulk and two interrupt endpoints, 83819e20680SDavid Brownell plus the ability to handle altsettings. Not all peripheral 83919e20680SDavid Brownell controllers are that capable. 84019e20680SDavid Brownell 84119e20680SDavid Brownell Say "y" to link the driver statically, or "m" to build a 84219e20680SDavid Brownell dynamically linked module. 84319e20680SDavid Brownell 844f358f5b4SFelipe Balbiconfig USB_G_NOKIA 845f358f5b4SFelipe Balbi tristate "Nokia composite gadget" 846f358f5b4SFelipe Balbi depends on PHONET 847f358f5b4SFelipe Balbi help 848f358f5b4SFelipe Balbi The Nokia composite gadget provides support for acm, obex 849f358f5b4SFelipe Balbi and phonet in only one composite gadget driver. 850f358f5b4SFelipe Balbi 851f358f5b4SFelipe Balbi It's only really useful for N900 hardware. If you're building 852f358f5b4SFelipe Balbi a kernel for N900, say Y or M here. If unsure, say N. 853f358f5b4SFelipe Balbi 854f176a5d8SMichal Nazarewiczconfig USB_G_MULTI 855f176a5d8SMichal Nazarewicz tristate "Multifunction Composite Gadget (EXPERIMENTAL)" 8565791e103SRandy Dunlap depends on BLOCK && NET 857279cc49aSMichal Nazarewicz select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS 858f176a5d8SMichal Nazarewicz help 859f176a5d8SMichal Nazarewicz The Multifunction Composite Gadget provides Ethernet (RNDIS 860f176a5d8SMichal Nazarewicz and/or CDC Ethernet), mass storage and ACM serial link 861f176a5d8SMichal Nazarewicz interfaces. 862f176a5d8SMichal Nazarewicz 8635791e103SRandy Dunlap You will be asked to choose which of the two configurations is 864f176a5d8SMichal Nazarewicz to be available in the gadget. At least one configuration must 8655791e103SRandy Dunlap be chosen to make the gadget usable. Selecting more than one 866f176a5d8SMichal Nazarewicz configuration will prevent Windows from automatically detecting 8675791e103SRandy Dunlap the gadget as a composite gadget, so an INF file will be needed to 868f176a5d8SMichal Nazarewicz use the gadget. 869f176a5d8SMichal Nazarewicz 870f176a5d8SMichal Nazarewicz Say "y" to link the driver statically, or "m" to build a 871f176a5d8SMichal Nazarewicz dynamically linked module called "g_multi". 872f176a5d8SMichal Nazarewicz 873f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_RNDIS 874f176a5d8SMichal Nazarewicz bool "RNDIS + CDC Serial + Storage configuration" 875f176a5d8SMichal Nazarewicz depends on USB_G_MULTI 876f176a5d8SMichal Nazarewicz default y 877f176a5d8SMichal Nazarewicz help 878f176a5d8SMichal Nazarewicz This option enables a configuration with RNDIS, CDC Serial and 879f176a5d8SMichal Nazarewicz Mass Storage functions available in the Multifunction Composite 8805791e103SRandy Dunlap Gadget. This is the configuration dedicated for Windows since RNDIS 8815791e103SRandy Dunlap is Microsoft's protocol. 882f176a5d8SMichal Nazarewicz 883f176a5d8SMichal Nazarewicz If unsure, say "y". 884f176a5d8SMichal Nazarewicz 885f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_CDC 886f176a5d8SMichal Nazarewicz bool "CDC Ethernet + CDC Serial + Storage configuration" 887f176a5d8SMichal Nazarewicz depends on USB_G_MULTI 888f176a5d8SMichal Nazarewicz default n 889f176a5d8SMichal Nazarewicz help 890f176a5d8SMichal Nazarewicz This option enables a configuration with CDC Ethernet (ECM), CDC 891f176a5d8SMichal Nazarewicz Serial and Mass Storage functions available in the Multifunction 8925791e103SRandy Dunlap Composite Gadget. 893f176a5d8SMichal Nazarewicz 894f176a5d8SMichal Nazarewicz If unsure, say "y". 895f176a5d8SMichal Nazarewicz 89671adf118SFabien Chouteauconfig USB_G_HID 89771adf118SFabien Chouteau tristate "HID Gadget" 89871adf118SFabien Chouteau help 89971adf118SFabien Chouteau The HID gadget driver provides generic emulation of USB 90071adf118SFabien Chouteau Human Interface Devices (HID). 90171adf118SFabien Chouteau 90271adf118SFabien Chouteau For more information, see Documentation/usb/gadget_hid.txt which 90371adf118SFabien Chouteau includes sample code for accessing the device files. 90471adf118SFabien Chouteau 90571adf118SFabien Chouteau Say "y" to link the driver statically, or "m" to build a 90671adf118SFabien Chouteau dynamically linked module called "g_hid". 907f176a5d8SMichal Nazarewicz 908f6c826a9Sstephane duvergerconfig USB_G_DBGP 909f6c826a9Sstephane duverger tristate "EHCI Debug Device Gadget" 910f6c826a9Sstephane duverger help 911f6c826a9Sstephane duverger This gadget emulates an EHCI Debug device. This is useful when you want 912f6c826a9Sstephane duverger to interact with an EHCI Debug Port. 913f6c826a9Sstephane duverger 914f6c826a9Sstephane duverger Say "y" to link the driver statically, or "m" to build a 915f6c826a9Sstephane duverger dynamically linked module called "g_dbgp". 916f6c826a9Sstephane duverger 917f6c826a9Sstephane duvergerif USB_G_DBGP 918f6c826a9Sstephane duvergerchoice 919f6c826a9Sstephane duverger prompt "EHCI Debug Device mode" 920f6c826a9Sstephane duverger default USB_G_DBGP_SERIAL 921f6c826a9Sstephane duverger 922f6c826a9Sstephane duvergerconfig USB_G_DBGP_PRINTK 923f6c826a9Sstephane duverger depends on USB_G_DBGP 924f6c826a9Sstephane duverger bool "printk" 925f6c826a9Sstephane duverger help 926f6c826a9Sstephane duverger Directly printk() received data. No interaction. 927f6c826a9Sstephane duverger 928f6c826a9Sstephane duvergerconfig USB_G_DBGP_SERIAL 929f6c826a9Sstephane duverger depends on USB_G_DBGP 930f6c826a9Sstephane duverger bool "serial" 931f6c826a9Sstephane duverger help 932f6c826a9Sstephane duverger Userland can interact using /dev/ttyGSxxx. 933f6c826a9Sstephane duvergerendchoice 934f6c826a9Sstephane duvergerendif 935f6c826a9Sstephane duverger 9361da177e4SLinus Torvalds# put drivers that need isochronous transfer support (for audio 9371da177e4SLinus Torvalds# or video class gadget drivers), or specific hardware, here. 938a9914127SLaurent Pinchartconfig USB_G_WEBCAM 939a9914127SLaurent Pinchart tristate "USB Webcam Gadget" 94024337c13SRandy Dunlap depends on VIDEO_DEV 941a9914127SLaurent Pinchart help 942a9914127SLaurent Pinchart The Webcam Gadget acts as a composite USB Audio and Video Class 943a9914127SLaurent Pinchart device. It provides a userspace API to process UVC control requests 944a9914127SLaurent Pinchart and stream video data to the host. 9451da177e4SLinus Torvalds 946a9914127SLaurent Pinchart Say "y" to link the driver statically, or "m" to build a 947a9914127SLaurent Pinchart dynamically linked module called "g_webcam". 9481da177e4SLinus Torvalds 9491da177e4SLinus Torvaldsendchoice 9501da177e4SLinus Torvalds 951b75be4abSDenis Chengendif # USB_GADGET 952