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 161b504882dSLi Yang help 162b504882dSLi Yang Some of Freescale PowerPC processors have a High Speed 163b504882dSLi Yang Dual-Role(DR) USB controller, which supports device mode. 164b504882dSLi Yang 165b504882dSLi Yang The number of programmable endpoints is different through 166b504882dSLi Yang SOC revisions. 167b504882dSLi Yang 168b504882dSLi Yang Say "y" to link the driver statically, or "m" to build a 169b504882dSLi Yang dynamically linked module called "fsl_usb2_udc" and force 170b504882dSLi Yang all gadget drivers to also be dynamically linked. 171b504882dSLi Yang 172b504882dSLi Yangconfig USB_FSL_USB2 173b504882dSLi Yang tristate 174b504882dSLi Yang depends on USB_GADGET_FSL_USB2 175b504882dSLi Yang default USB_GADGET 176b504882dSLi Yang select USB_GADGET_SELECTED 177b504882dSLi Yang 1781da177e4SLinus Torvaldsconfig USB_GADGET_LH7A40X 1791da177e4SLinus Torvalds boolean "LH7A40X" 1801da177e4SLinus Torvalds depends on ARCH_LH7A40X 1811da177e4SLinus Torvalds help 1821da177e4SLinus Torvalds This driver provides USB Device Controller driver for LH7A40x 1831da177e4SLinus Torvalds 1841da177e4SLinus Torvaldsconfig USB_LH7A40X 1851da177e4SLinus Torvalds tristate 1861da177e4SLinus Torvalds depends on USB_GADGET_LH7A40X 1871da177e4SLinus Torvalds default USB_GADGET 188028b271bSDavid Brownell select USB_GADGET_SELECTED 1891da177e4SLinus Torvalds 1901da177e4SLinus Torvaldsconfig USB_GADGET_OMAP 1911da177e4SLinus Torvalds boolean "OMAP USB Device Controller" 1921da177e4SLinus Torvalds depends on ARCH_OMAP 193f1c9e151STony Lindgren select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3 || MACH_OMAP_H4_OTG 19454b9ed35SDavid Brownell select USB_OTG_UTILS if ARCH_OMAP 1951da177e4SLinus Torvalds help 1961da177e4SLinus Torvalds Many Texas Instruments OMAP processors have flexible full 1971da177e4SLinus Torvalds speed USB device controllers, with support for up to 30 1981da177e4SLinus Torvalds endpoints (plus endpoint zero). This driver supports the 1991da177e4SLinus Torvalds controller in the OMAP 1611, and should work with controllers 2001da177e4SLinus Torvalds in other OMAP processors too, given minor tweaks. 2011da177e4SLinus Torvalds 2021da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 2031da177e4SLinus Torvalds dynamically linked module called "omap_udc" and force all 2041da177e4SLinus Torvalds gadget drivers to also be dynamically linked. 2051da177e4SLinus Torvalds 2061da177e4SLinus Torvaldsconfig USB_OMAP 2071da177e4SLinus Torvalds tristate 2081da177e4SLinus Torvalds depends on USB_GADGET_OMAP 2091da177e4SLinus Torvalds default USB_GADGET 210028b271bSDavid Brownell select USB_GADGET_SELECTED 2111da177e4SLinus Torvalds 2121da177e4SLinus Torvaldsconfig USB_OTG 2131da177e4SLinus Torvalds boolean "OTG Support" 2141da177e4SLinus Torvalds depends on USB_GADGET_OMAP && ARCH_OMAP_OTG && USB_OHCI_HCD 2151da177e4SLinus Torvalds help 2161da177e4SLinus Torvalds The most notable feature of USB OTG is support for a 2171da177e4SLinus Torvalds "Dual-Role" device, which can act as either a device 2181da177e4SLinus Torvalds or a host. The initial role choice can be changed 2191da177e4SLinus Torvalds later, when two dual-role devices talk to each other. 2201da177e4SLinus Torvalds 2211da177e4SLinus Torvalds Select this only if your OMAP board has a Mini-AB connector. 2221da177e4SLinus Torvalds 223a7a19facSDavid Brownellconfig USB_GADGET_PXA25X 224a7a19facSDavid Brownell boolean "PXA 25x or IXP 4xx" 225a7a19facSDavid Brownell depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX 22609963911SRussell King select USB_OTG_UTILS 227a7a19facSDavid Brownell help 228a7a19facSDavid Brownell Intel's PXA 25x series XScale ARM-5TE processors include 229a7a19facSDavid Brownell an integrated full speed USB 1.1 device controller. The 230a7a19facSDavid Brownell controller in the IXP 4xx series is register-compatible. 231a7a19facSDavid Brownell 232a7a19facSDavid Brownell It has fifteen fixed-function endpoints, as well as endpoint 233a7a19facSDavid Brownell zero (for control transfers). 234a7a19facSDavid Brownell 235a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 236a7a19facSDavid Brownell dynamically linked module called "pxa25x_udc" and force all 237a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 238a7a19facSDavid Brownell 239a7a19facSDavid Brownellconfig USB_PXA25X 240a7a19facSDavid Brownell tristate 241a7a19facSDavid Brownell depends on USB_GADGET_PXA25X 242a7a19facSDavid Brownell default USB_GADGET 243a7a19facSDavid Brownell select USB_GADGET_SELECTED 244a7a19facSDavid Brownell 245a7a19facSDavid Brownell# if there's only one gadget driver, using only two bulk endpoints, 246a7a19facSDavid Brownell# don't waste memory for the other endpoints 247a7a19facSDavid Brownellconfig USB_PXA25X_SMALL 248a7a19facSDavid Brownell depends on USB_GADGET_PXA25X 249a7a19facSDavid Brownell bool 250a7a19facSDavid Brownell default n if USB_ETH_RNDIS 251a7a19facSDavid Brownell default y if USB_ZERO 252a7a19facSDavid Brownell default y if USB_ETH 253a7a19facSDavid Brownell default y if USB_G_SERIAL 254a7a19facSDavid Brownell 255c4144247SYoshihiro Shimodaconfig USB_GADGET_R8A66597 256c4144247SYoshihiro Shimoda boolean "Renesas R8A66597 USB Peripheral Controller" 257c4144247SYoshihiro Shimoda select USB_GADGET_DUALSPEED 258c4144247SYoshihiro Shimoda help 259c4144247SYoshihiro Shimoda R8A66597 is a discrete USB host and peripheral controller chip that 260c4144247SYoshihiro Shimoda supports both full and high speed USB 2.0 data transfers. 261c4144247SYoshihiro Shimoda It has nine configurable endpoints, and endpoint zero. 262c4144247SYoshihiro Shimoda 263c4144247SYoshihiro Shimoda Say "y" to link the driver statically, or "m" to build a 264c4144247SYoshihiro Shimoda dynamically linked module called "r8a66597_udc" and force all 265c4144247SYoshihiro Shimoda gadget drivers to also be dynamically linked. 266c4144247SYoshihiro Shimoda 267c4144247SYoshihiro Shimodaconfig USB_R8A66597 268c4144247SYoshihiro Shimoda tristate 269c4144247SYoshihiro Shimoda depends on USB_GADGET_R8A66597 270c4144247SYoshihiro Shimoda default USB_GADGET 271c4144247SYoshihiro Shimoda select USB_GADGET_SELECTED 272c4144247SYoshihiro Shimoda 273a7a19facSDavid Brownellconfig USB_GADGET_PXA27X 274a7a19facSDavid Brownell boolean "PXA 27x" 2759f5351b7SRobert Jarzmik depends on ARCH_PXA && (PXA27x || PXA3xx) 2767fec3c25SRobert Jarzmik select USB_OTG_UTILS 277a7a19facSDavid Brownell help 278a7a19facSDavid Brownell Intel's PXA 27x series XScale ARM v5TE processors include 279a7a19facSDavid Brownell an integrated full speed USB 1.1 device controller. 280a7a19facSDavid Brownell 281a7a19facSDavid Brownell It has up to 23 endpoints, as well as endpoint zero (for 282a7a19facSDavid Brownell control transfers). 283a7a19facSDavid Brownell 284a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 285a7a19facSDavid Brownell dynamically linked module called "pxa27x_udc" and force all 286a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 287a7a19facSDavid Brownell 288a7a19facSDavid Brownellconfig USB_PXA27X 289a7a19facSDavid Brownell tristate 290a7a19facSDavid Brownell depends on USB_GADGET_PXA27X 291a7a19facSDavid Brownell default USB_GADGET 292a7a19facSDavid Brownell select USB_GADGET_SELECTED 293a7a19facSDavid Brownell 2945b7d70c6SBen Dooksconfig USB_GADGET_S3C_HSOTG 2955b7d70c6SBen Dooks boolean "S3C HS/OtG USB Device controller" 2965b7d70c6SBen Dooks depends on S3C_DEV_USB_HSOTG 2975b7d70c6SBen Dooks select USB_GADGET_S3C_HSOTG_PIO 2985b7d70c6SBen Dooks help 2995b7d70c6SBen Dooks The Samsung S3C64XX USB2.0 high-speed gadget controller 3005b7d70c6SBen Dooks integrated into the S3C64XX series SoC. 3015b7d70c6SBen Dooks 3025b7d70c6SBen Dooksconfig USB_S3C_HSOTG 3035b7d70c6SBen Dooks tristate 3045b7d70c6SBen Dooks depends on USB_GADGET_S3C_HSOTG 3055b7d70c6SBen Dooks default USB_GADGET 3065b7d70c6SBen Dooks select USB_GADGET_SELECTED 3075b7d70c6SBen Dooks 308c03e7d4bSPaulius Zaleckasconfig USB_GADGET_IMX 309c03e7d4bSPaulius Zaleckas boolean "Freescale IMX USB Peripheral Controller" 310c03e7d4bSPaulius Zaleckas depends on ARCH_MX1 311c03e7d4bSPaulius Zaleckas help 312c03e7d4bSPaulius Zaleckas Freescale's IMX series include an integrated full speed 313c03e7d4bSPaulius Zaleckas USB 1.1 device controller. The controller in the IMX series 314c03e7d4bSPaulius Zaleckas is register-compatible. 315c03e7d4bSPaulius Zaleckas 316c03e7d4bSPaulius Zaleckas It has Six fixed-function endpoints, as well as endpoint 317c03e7d4bSPaulius Zaleckas zero (for control transfers). 318c03e7d4bSPaulius Zaleckas 319c03e7d4bSPaulius Zaleckas Say "y" to link the driver statically, or "m" to build a 320c03e7d4bSPaulius Zaleckas dynamically linked module called "imx_udc" and force all 321c03e7d4bSPaulius Zaleckas gadget drivers to also be dynamically linked. 322c03e7d4bSPaulius Zaleckas 323c03e7d4bSPaulius Zaleckasconfig USB_IMX 324c03e7d4bSPaulius Zaleckas tristate 325c03e7d4bSPaulius Zaleckas depends on USB_GADGET_IMX 326c03e7d4bSPaulius Zaleckas default USB_GADGET 327c03e7d4bSPaulius Zaleckas select USB_GADGET_SELECTED 328c03e7d4bSPaulius Zaleckas 3293fc154b6SArnaud Patardconfig USB_GADGET_S3C2410 3303fc154b6SArnaud Patard boolean "S3C2410 USB Device Controller" 3313fc154b6SArnaud Patard depends on ARCH_S3C2410 3323fc154b6SArnaud Patard help 3333fc154b6SArnaud Patard Samsung's S3C2410 is an ARM-4 processor with an integrated 3343fc154b6SArnaud Patard full speed USB 1.1 device controller. It has 4 configurable 3353fc154b6SArnaud Patard endpoints, as well as endpoint zero (for control transfers). 3363fc154b6SArnaud Patard 3373fc154b6SArnaud Patard This driver has been tested on the S3C2410, S3C2412, and 3383fc154b6SArnaud Patard S3C2440 processors. 3393fc154b6SArnaud Patard 3403fc154b6SArnaud Patardconfig USB_S3C2410 3413fc154b6SArnaud Patard tristate 3423fc154b6SArnaud Patard depends on USB_GADGET_S3C2410 3433fc154b6SArnaud Patard default USB_GADGET 3443fc154b6SArnaud Patard select USB_GADGET_SELECTED 3453fc154b6SArnaud Patard 3463fc154b6SArnaud Patardconfig USB_S3C2410_DEBUG 3473fc154b6SArnaud Patard boolean "S3C2410 udc debug messages" 3483fc154b6SArnaud Patard depends on USB_GADGET_S3C2410 3493fc154b6SArnaud Patard 350a7a19facSDavid Brownell# 351a7a19facSDavid Brownell# Controllers available in both integrated and discrete versions 352a7a19facSDavid Brownell# 353a7a19facSDavid Brownell 354a7a19facSDavid Brownell# musb builds in ../musb along with host support 355a7a19facSDavid Brownellconfig USB_GADGET_MUSB_HDRC 356085ad406SBryan Wu boolean "Inventra HDRC USB Peripheral (TI, ADI, ...)" 357a7a19facSDavid Brownell depends on USB_MUSB_HDRC && (USB_MUSB_PERIPHERAL || USB_MUSB_OTG) 358a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 359bae4bd84SDavid Brownell select USB_GADGET_SELECTED 360bae4bd84SDavid Brownell help 361a7a19facSDavid Brownell This OTG-capable silicon IP is used in dual designs including 362085ad406SBryan Wu the TI DaVinci, OMAP 243x, OMAP 343x, TUSB 6010, and ADI Blackfin 363a7a19facSDavid Brownell 364a7a19facSDavid Brownellconfig USB_GADGET_M66592 365a7a19facSDavid Brownell boolean "Renesas M66592 USB Peripheral Controller" 366a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 367a7a19facSDavid Brownell help 368a7a19facSDavid Brownell M66592 is a discrete USB peripheral controller chip that 369a7a19facSDavid Brownell supports both full and high speed USB 2.0 data transfers. 370a7a19facSDavid Brownell It has seven configurable endpoints, and endpoint zero. 371bae4bd84SDavid Brownell 372bae4bd84SDavid Brownell Say "y" to link the driver statically, or "m" to build a 373a7a19facSDavid Brownell dynamically linked module called "m66592_udc" and force all 374bae4bd84SDavid Brownell gadget drivers to also be dynamically linked. 375bae4bd84SDavid Brownell 376a7a19facSDavid Brownellconfig USB_M66592 377bae4bd84SDavid Brownell tristate 378a7a19facSDavid Brownell depends on USB_GADGET_M66592 379bae4bd84SDavid Brownell default USB_GADGET 380a7a19facSDavid Brownell select USB_GADGET_SELECTED 381a7a19facSDavid Brownell 382a7a19facSDavid Brownell# 383a7a19facSDavid Brownell# Controllers available only in discrete form (and all PCI controllers) 384a7a19facSDavid Brownell# 385a7a19facSDavid Brownell 386a7a19facSDavid Brownellconfig USB_GADGET_AMD5536UDC 387a7a19facSDavid Brownell boolean "AMD5536 UDC" 388a7a19facSDavid Brownell depends on PCI 389a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 390a7a19facSDavid Brownell help 391a7a19facSDavid Brownell The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge. 392a7a19facSDavid Brownell It is a USB Highspeed DMA capable USB device controller. Beside ep0 393a7a19facSDavid Brownell it provides 4 IN and 4 OUT endpoints (bulk or interrupt type). 394a7a19facSDavid Brownell The UDC port supports OTG operation, and may be used as a host port 395a7a19facSDavid Brownell if it's not being used to implement peripheral or OTG roles. 396a7a19facSDavid Brownell 397a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 398a7a19facSDavid Brownell dynamically linked module called "amd5536udc" and force all 399a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 400a7a19facSDavid Brownell 401a7a19facSDavid Brownellconfig USB_AMD5536UDC 402a7a19facSDavid Brownell tristate 403a7a19facSDavid Brownell depends on USB_GADGET_AMD5536UDC 404a7a19facSDavid Brownell default USB_GADGET 405a7a19facSDavid Brownell select USB_GADGET_SELECTED 406a7a19facSDavid Brownell 4073948f0e0SLi Yangconfig USB_GADGET_FSL_QE 4083948f0e0SLi Yang boolean "Freescale QE/CPM USB Device Controller" 4093948f0e0SLi Yang depends on FSL_SOC && (QUICC_ENGINE || CPM) 4103948f0e0SLi Yang help 4113948f0e0SLi Yang Some of Freescale PowerPC processors have a Full Speed 4123948f0e0SLi Yang QE/CPM2 USB controller, which support device mode with 4 4133948f0e0SLi Yang programmable endpoints. This driver supports the 4143948f0e0SLi Yang controller in the MPC8360 and MPC8272, and should work with 4153948f0e0SLi Yang controllers having QE or CPM2, given minor tweaks. 4163948f0e0SLi Yang 4173948f0e0SLi Yang Set CONFIG_USB_GADGET to "m" to build this driver as a 418692105b8SMatt LaPlante dynamically linked module called "fsl_qe_udc". 4193948f0e0SLi Yang 4203948f0e0SLi Yangconfig USB_FSL_QE 4213948f0e0SLi Yang tristate 4223948f0e0SLi Yang depends on USB_GADGET_FSL_QE 4233948f0e0SLi Yang default USB_GADGET 4243948f0e0SLi Yang select USB_GADGET_SELECTED 4253948f0e0SLi Yang 426aa69a809SDavid Lopoconfig USB_GADGET_CI13XXX 427aa69a809SDavid Lopo boolean "MIPS USB CI13xxx" 428aa69a809SDavid Lopo depends on PCI 429aa69a809SDavid Lopo select USB_GADGET_DUALSPEED 430aa69a809SDavid Lopo help 431aa69a809SDavid Lopo MIPS USB IP core family device controller 432aa69a809SDavid Lopo Currently it only supports IP part number CI13412 433aa69a809SDavid Lopo 434aa69a809SDavid Lopo Say "y" to link the driver statically, or "m" to build a 435aa69a809SDavid Lopo dynamically linked module called "ci13xxx_udc" and force all 436aa69a809SDavid Lopo gadget drivers to also be dynamically linked. 437aa69a809SDavid Lopo 438aa69a809SDavid Lopoconfig USB_CI13XXX 439aa69a809SDavid Lopo tristate 440aa69a809SDavid Lopo depends on USB_GADGET_CI13XXX 441aa69a809SDavid Lopo default USB_GADGET 442aa69a809SDavid Lopo select USB_GADGET_SELECTED 443aa69a809SDavid Lopo 444a7a19facSDavid Brownellconfig USB_GADGET_NET2280 445a7a19facSDavid Brownell boolean "NetChip 228x" 446a7a19facSDavid Brownell depends on PCI 447a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 448a7a19facSDavid Brownell help 449a7a19facSDavid Brownell NetChip 2280 / 2282 is a PCI based USB peripheral controller which 450a7a19facSDavid Brownell supports both full and high speed USB 2.0 data transfers. 451a7a19facSDavid Brownell 452a7a19facSDavid Brownell It has six configurable endpoints, as well as endpoint zero 453a7a19facSDavid Brownell (for control transfers) and several endpoints with dedicated 454a7a19facSDavid Brownell functions. 455a7a19facSDavid Brownell 456a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 457a7a19facSDavid Brownell dynamically linked module called "net2280" and force all 458a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 459a7a19facSDavid Brownell 460a7a19facSDavid Brownellconfig USB_NET2280 461a7a19facSDavid Brownell tristate 462a7a19facSDavid Brownell depends on USB_GADGET_NET2280 463a7a19facSDavid Brownell default USB_GADGET 464a7a19facSDavid Brownell select USB_GADGET_SELECTED 465a7a19facSDavid Brownell 466a7a19facSDavid Brownellconfig USB_GADGET_GOKU 467a7a19facSDavid Brownell boolean "Toshiba TC86C001 'Goku-S'" 468a7a19facSDavid Brownell depends on PCI 469a7a19facSDavid Brownell help 470a7a19facSDavid Brownell The Toshiba TC86C001 is a PCI device which includes controllers 471a7a19facSDavid Brownell for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI). 472a7a19facSDavid Brownell 473a7a19facSDavid Brownell The device controller has three configurable (bulk or interrupt) 474a7a19facSDavid Brownell endpoints, plus endpoint zero (for control transfers). 475a7a19facSDavid Brownell 476a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 477a7a19facSDavid Brownell dynamically linked module called "goku_udc" and to force all 478a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 479a7a19facSDavid Brownell 480a7a19facSDavid Brownellconfig USB_GOKU 481a7a19facSDavid Brownell tristate 482a7a19facSDavid Brownell depends on USB_GADGET_GOKU 483a7a19facSDavid Brownell default USB_GADGET 484a7a19facSDavid Brownell select USB_GADGET_SELECTED 485a7a19facSDavid Brownell 4865be19a9dSXiaochen Shenconfig USB_GADGET_LANGWELL 4875be19a9dSXiaochen Shen boolean "Intel Langwell USB Device Controller" 4885be19a9dSXiaochen Shen depends on PCI 4895be19a9dSXiaochen Shen select USB_GADGET_DUALSPEED 4905be19a9dSXiaochen Shen help 4915be19a9dSXiaochen Shen Intel Langwell USB Device Controller is a High-Speed USB 4925be19a9dSXiaochen Shen On-The-Go device controller. 4935be19a9dSXiaochen Shen 4945be19a9dSXiaochen Shen The number of programmable endpoints is different through 4955be19a9dSXiaochen Shen controller revision. 4965be19a9dSXiaochen Shen 4975be19a9dSXiaochen Shen Say "y" to link the driver statically, or "m" to build a 4985be19a9dSXiaochen Shen dynamically linked module called "langwell_udc" and force all 4995be19a9dSXiaochen Shen gadget drivers to also be dynamically linked. 5005be19a9dSXiaochen Shen 5015be19a9dSXiaochen Shenconfig USB_LANGWELL 5025be19a9dSXiaochen Shen tristate 5035be19a9dSXiaochen Shen depends on USB_GADGET_LANGWELL 5045be19a9dSXiaochen Shen default USB_GADGET 5055be19a9dSXiaochen Shen select USB_GADGET_SELECTED 5065be19a9dSXiaochen Shen 507a7a19facSDavid Brownell 508a7a19facSDavid Brownell# 509a7a19facSDavid Brownell# LAST -- dummy/emulated controller 510a7a19facSDavid Brownell# 5111da177e4SLinus Torvalds 5121da177e4SLinus Torvaldsconfig USB_GADGET_DUMMY_HCD 5131da177e4SLinus Torvalds boolean "Dummy HCD (DEVELOPMENT)" 514afd0e0f2SRobert P. J. Day depends on USB=y || (USB=m && USB_GADGET=m) 5151da177e4SLinus Torvalds select USB_GADGET_DUALSPEED 5161da177e4SLinus Torvalds help 5171da177e4SLinus Torvalds This host controller driver emulates USB, looping all data transfer 5181da177e4SLinus Torvalds requests back to a USB "gadget driver" in the same host. The host 5191da177e4SLinus Torvalds side is the master; the gadget side is the slave. Gadget drivers 5201da177e4SLinus Torvalds can be high, full, or low speed; and they have access to endpoints 5211da177e4SLinus Torvalds like those from NET2280, PXA2xx, or SA1100 hardware. 5221da177e4SLinus Torvalds 5231da177e4SLinus Torvalds This may help in some stages of creating a driver to embed in a 5241da177e4SLinus Torvalds Linux device, since it lets you debug several parts of the gadget 5251da177e4SLinus Torvalds driver without its hardware or drivers being involved. 5261da177e4SLinus Torvalds 5271da177e4SLinus Torvalds Since such a gadget side driver needs to interoperate with a host 5281da177e4SLinus Torvalds side Linux-USB device driver, this may help to debug both sides 5291da177e4SLinus Torvalds of a USB protocol stack. 5301da177e4SLinus Torvalds 5311da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 5321da177e4SLinus Torvalds dynamically linked module called "dummy_hcd" and force all 5331da177e4SLinus Torvalds gadget drivers to also be dynamically linked. 5341da177e4SLinus Torvalds 5351da177e4SLinus Torvaldsconfig USB_DUMMY_HCD 5361da177e4SLinus Torvalds tristate 5371da177e4SLinus Torvalds depends on USB_GADGET_DUMMY_HCD 5381da177e4SLinus Torvalds default USB_GADGET 539028b271bSDavid Brownell select USB_GADGET_SELECTED 5401da177e4SLinus Torvalds 5411da177e4SLinus Torvalds# NOTE: Please keep dummy_hcd LAST so that "real hardware" appears 5421da177e4SLinus Torvalds# first and will be selected by default. 5431da177e4SLinus Torvalds 5441da177e4SLinus Torvaldsendchoice 5451da177e4SLinus Torvalds 5461da177e4SLinus Torvaldsconfig USB_GADGET_DUALSPEED 5471da177e4SLinus Torvalds bool 5481da177e4SLinus Torvalds depends on USB_GADGET 5491da177e4SLinus Torvalds default n 5501da177e4SLinus Torvalds help 5511da177e4SLinus Torvalds Means that gadget drivers should include extra descriptors 5521da177e4SLinus Torvalds and code to handle dual-speed controllers. 5531da177e4SLinus Torvalds 5541da177e4SLinus Torvalds# 5551da177e4SLinus Torvalds# USB Gadget Drivers 5561da177e4SLinus Torvalds# 5571da177e4SLinus Torvaldschoice 5581da177e4SLinus Torvalds tristate "USB Gadget Drivers" 559028b271bSDavid Brownell depends on USB_GADGET && USB_GADGET_SELECTED 5601da177e4SLinus Torvalds default USB_ETH 5611da177e4SLinus Torvalds help 5621da177e4SLinus Torvalds A Linux "Gadget Driver" talks to the USB Peripheral Controller 5631da177e4SLinus Torvalds driver through the abstract "gadget" API. Some other operating 5641da177e4SLinus Torvalds systems call these "client" drivers, of which "class drivers" 5651da177e4SLinus Torvalds are a subset (implementing a USB device class specification). 5661da177e4SLinus Torvalds A gadget driver implements one or more USB functions using 5671da177e4SLinus Torvalds the peripheral hardware. 5681da177e4SLinus Torvalds 5691da177e4SLinus Torvalds Gadget drivers are hardware-neutral, or "platform independent", 5701da177e4SLinus Torvalds except that they sometimes must understand quirks or limitations 5711da177e4SLinus Torvalds of the particular controllers they work with. For example, when 5721da177e4SLinus Torvalds a controller doesn't support alternate configurations or provide 5731da177e4SLinus Torvalds enough of the right types of endpoints, the gadget driver might 5741da177e4SLinus Torvalds not be able work with that controller, or might need to implement 5751da177e4SLinus Torvalds a less common variant of a device class protocol. 5761da177e4SLinus Torvalds 5771da177e4SLinus Torvalds# this first set of drivers all depend on bulk-capable hardware. 5781da177e4SLinus Torvalds 5791da177e4SLinus Torvaldsconfig USB_ZERO 5801da177e4SLinus Torvalds tristate "Gadget Zero (DEVELOPMENT)" 5811da177e4SLinus Torvalds help 5821da177e4SLinus Torvalds Gadget Zero is a two-configuration device. It either sinks and 5831da177e4SLinus Torvalds sources bulk data; or it loops back a configurable number of 5841da177e4SLinus Torvalds transfers. It also implements control requests, for "chapter 9" 5851da177e4SLinus Torvalds conformance. The driver needs only two bulk-capable endpoints, so 5861da177e4SLinus Torvalds it can work on top of most device-side usb controllers. It's 5871da177e4SLinus Torvalds useful for testing, and is also a working example showing how 5881da177e4SLinus Torvalds USB "gadget drivers" can be written. 5891da177e4SLinus Torvalds 5901da177e4SLinus Torvalds Make this be the first driver you try using on top of any new 5911da177e4SLinus Torvalds USB peripheral controller driver. Then you can use host-side 5921da177e4SLinus Torvalds test software, like the "usbtest" driver, to put your hardware 5931da177e4SLinus Torvalds and its driver through a basic set of functional tests. 5941da177e4SLinus Torvalds 5951da177e4SLinus Torvalds Gadget Zero also works with the host-side "usb-skeleton" driver, 5961da177e4SLinus Torvalds and with many kinds of host-side test software. You may need 5971da177e4SLinus Torvalds to tweak product and vendor IDs before host software knows about 5981da177e4SLinus Torvalds this device, and arrange to select an appropriate configuration. 5991da177e4SLinus Torvalds 6001da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 6011da177e4SLinus Torvalds dynamically linked module called "g_zero". 6021da177e4SLinus Torvalds 6031da177e4SLinus Torvaldsconfig USB_ZERO_HNPTEST 6041da177e4SLinus Torvalds boolean "HNP Test Device" 6051da177e4SLinus Torvalds depends on USB_ZERO && USB_OTG 6061da177e4SLinus Torvalds help 6071da177e4SLinus Torvalds You can configure this device to enumerate using the device 6081da177e4SLinus Torvalds identifiers of the USB-OTG test device. That means that when 6091da177e4SLinus Torvalds this gadget connects to another OTG device, with this one using 6101da177e4SLinus Torvalds the "B-Peripheral" role, that device will use HNP to let this 6111da177e4SLinus Torvalds one serve as the USB host instead (in the "B-Host" role). 6121da177e4SLinus Torvalds 613c6994e6fSBryan Wuconfig USB_AUDIO 614c6994e6fSBryan Wu tristate "Audio Gadget (EXPERIMENTAL)" 615c6994e6fSBryan Wu depends on SND 61604950737SRandy Dunlap select SND_PCM 617c6994e6fSBryan Wu help 618c6994e6fSBryan Wu Gadget Audio is compatible with USB Audio Class specification 1.0. 619c6994e6fSBryan Wu It will include at least one AudioControl interface, zero or more 620c6994e6fSBryan Wu AudioStream interface and zero or more MIDIStream interface. 621c6994e6fSBryan Wu 622c6994e6fSBryan Wu Gadget Audio will use on-board ALSA (CONFIG_SND) audio card to 623c6994e6fSBryan Wu playback or capture audio stream. 624c6994e6fSBryan Wu 625c6994e6fSBryan Wu Say "y" to link the driver statically, or "m" to build a 626c6994e6fSBryan Wu dynamically linked module called "g_audio". 627c6994e6fSBryan Wu 6281da177e4SLinus Torvaldsconfig USB_ETH 6291da177e4SLinus Torvalds tristate "Ethernet Gadget (with CDC Ethernet support)" 6301da177e4SLinus Torvalds depends on NET 6319e221be8SRandy Dunlap select CRC32 6321da177e4SLinus Torvalds help 6339b39e9ddSBrian Niebuhr This driver implements Ethernet style communication, in one of 6349b39e9ddSBrian Niebuhr several ways: 6351da177e4SLinus Torvalds 6361da177e4SLinus Torvalds - The "Communication Device Class" (CDC) Ethernet Control Model. 6371da177e4SLinus Torvalds That protocol is often avoided with pure Ethernet adapters, in 6381da177e4SLinus Torvalds favor of simpler vendor-specific hardware, but is widely 6391da177e4SLinus Torvalds supported by firmware for smart network devices. 6401da177e4SLinus Torvalds 6411da177e4SLinus Torvalds - On hardware can't implement that protocol, a simple CDC subset 6421da177e4SLinus Torvalds is used, placing fewer demands on USB. 6431da177e4SLinus Torvalds 6449b39e9ddSBrian Niebuhr - CDC Ethernet Emulation Model (EEM) is a newer standard that has 6459b39e9ddSBrian Niebuhr a simpler interface that can be used by more USB hardware. 6469b39e9ddSBrian Niebuhr 6479b39e9ddSBrian Niebuhr RNDIS support is an additional option, more demanding than than 6489b39e9ddSBrian Niebuhr subset. 6491da177e4SLinus Torvalds 6501da177e4SLinus Torvalds Within the USB device, this gadget driver exposes a network device 6511da177e4SLinus Torvalds "usbX", where X depends on what other networking devices you have. 6521da177e4SLinus Torvalds Treat it like a two-node Ethernet link: host, and gadget. 6531da177e4SLinus Torvalds 6541da177e4SLinus Torvalds The Linux-USB host-side "usbnet" driver interoperates with this 6551da177e4SLinus Torvalds driver, so that deep I/O queues can be supported. On 2.4 kernels, 6561da177e4SLinus Torvalds use "CDCEther" instead, if you're using the CDC option. That CDC 6571da177e4SLinus Torvalds mode should also interoperate with standard CDC Ethernet class 6581da177e4SLinus Torvalds drivers on other host operating systems. 6591da177e4SLinus Torvalds 6601da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 6611da177e4SLinus Torvalds dynamically linked module called "g_ether". 6621da177e4SLinus Torvalds 6631da177e4SLinus Torvaldsconfig USB_ETH_RNDIS 664afd0e0f2SRobert P. J. Day bool "RNDIS support" 665afd0e0f2SRobert P. J. Day depends on USB_ETH 6661da177e4SLinus Torvalds default y 6671da177e4SLinus Torvalds help 6681da177e4SLinus Torvalds Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol, 6691da177e4SLinus Torvalds and Microsoft provides redistributable binary RNDIS drivers for 6701da177e4SLinus Torvalds older versions of Windows. 6711da177e4SLinus Torvalds 6721da177e4SLinus Torvalds If you say "y" here, the Ethernet gadget driver will try to provide 6731da177e4SLinus Torvalds a second device configuration, supporting RNDIS to talk to such 6741da177e4SLinus Torvalds Microsoft USB hosts. 6751da177e4SLinus Torvalds 6761da177e4SLinus Torvalds To make MS-Windows work with this, use Documentation/usb/linux.inf 6771da177e4SLinus Torvalds as the "driver info file". For versions of MS-Windows older than 6781da177e4SLinus Torvalds XP, you'll need to download drivers from Microsoft's website; a URL 6791da177e4SLinus Torvalds is given in comments found in that info file. 6801da177e4SLinus Torvalds 6819b39e9ddSBrian Niebuhrconfig USB_ETH_EEM 6829b39e9ddSBrian Niebuhr bool "Ethernet Emulation Model (EEM) support" 6839b39e9ddSBrian Niebuhr depends on USB_ETH 6849b39e9ddSBrian Niebuhr default n 6859b39e9ddSBrian Niebuhr help 6869b39e9ddSBrian Niebuhr CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM 6879b39e9ddSBrian Niebuhr and therefore can be supported by more hardware. Technically ECM and 6889b39e9ddSBrian Niebuhr EEM are designed for different applications. The ECM model extends 6899b39e9ddSBrian Niebuhr the network interface to the target (e.g. a USB cable modem), and the 6909b39e9ddSBrian Niebuhr EEM model is for mobile devices to communicate with hosts using 6919b39e9ddSBrian Niebuhr ethernet over USB. For Linux gadgets, however, the interface with 6929b39e9ddSBrian Niebuhr the host is the same (a usbX device), so the differences are minimal. 6939b39e9ddSBrian Niebuhr 6949b39e9ddSBrian Niebuhr If you say "y" here, the Ethernet gadget driver will use the EEM 6959b39e9ddSBrian Niebuhr protocol rather than ECM. If unsure, say "n". 6969b39e9ddSBrian Niebuhr 6971da177e4SLinus Torvaldsconfig USB_GADGETFS 6981da177e4SLinus Torvalds tristate "Gadget Filesystem (EXPERIMENTAL)" 6991da177e4SLinus Torvalds depends on EXPERIMENTAL 7001da177e4SLinus Torvalds help 7011da177e4SLinus Torvalds This driver provides a filesystem based API that lets user mode 7021da177e4SLinus Torvalds programs implement a single-configuration USB device, including 7031da177e4SLinus Torvalds endpoint I/O and control requests that don't relate to enumeration. 7041da177e4SLinus Torvalds All endpoints, transfer speeds, and transfer types supported by 7051da177e4SLinus Torvalds the hardware are available, through read() and write() calls. 7061da177e4SLinus Torvalds 707afd0e0f2SRobert P. J. Day Currently, this option is still labelled as EXPERIMENTAL because 708afd0e0f2SRobert P. J. Day of existing race conditions in the underlying in-kernel AIO core. 709afd0e0f2SRobert P. J. Day 7101da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 7111da177e4SLinus Torvalds dynamically linked module called "gadgetfs". 7121da177e4SLinus Torvalds 7131da177e4SLinus Torvaldsconfig USB_FILE_STORAGE 7141da177e4SLinus Torvalds tristate "File-backed Storage Gadget" 71587840289SRandy Dunlap depends on BLOCK 7161da177e4SLinus Torvalds help 7171da177e4SLinus Torvalds The File-backed Storage Gadget acts as a USB Mass Storage 7181da177e4SLinus Torvalds disk drive. As its storage repository it can use a regular 7191da177e4SLinus Torvalds file or a block device (in much the same way as the "loop" 7201da177e4SLinus Torvalds device driver), specified as a module parameter. 7211da177e4SLinus Torvalds 7221da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 7231da177e4SLinus Torvalds dynamically linked module called "g_file_storage". 7241da177e4SLinus Torvalds 7251da177e4SLinus Torvaldsconfig USB_FILE_STORAGE_TEST 7261da177e4SLinus Torvalds bool "File-backed Storage Gadget testing version" 7271da177e4SLinus Torvalds depends on USB_FILE_STORAGE 7281da177e4SLinus Torvalds default n 7291da177e4SLinus Torvalds help 7301da177e4SLinus Torvalds Say "y" to generate the larger testing version of the 7311da177e4SLinus Torvalds File-backed Storage Gadget, useful for probing the 7321da177e4SLinus Torvalds behavior of USB Mass Storage hosts. Not needed for 7331da177e4SLinus Torvalds normal operation. 7341da177e4SLinus Torvalds 735d23b0f08SMichal Nazarewiczconfig USB_MASS_STORAGE 736d23b0f08SMichal Nazarewicz tristate "Mass Storage Gadget" 737d23b0f08SMichal Nazarewicz depends on BLOCK 738d23b0f08SMichal Nazarewicz help 739d23b0f08SMichal Nazarewicz The Mass Storage Gadget acts as a USB Mass Storage disk drive. 740d23b0f08SMichal Nazarewicz As its storage repository it can use a regular file or a block 741d23b0f08SMichal Nazarewicz device (in much the same way as the "loop" device driver), 742d23b0f08SMichal Nazarewicz specified as a module parameter or sysfs option. 743d23b0f08SMichal Nazarewicz 744d23b0f08SMichal Nazarewicz This is heavily based on File-backed Storage Gadget and in most 745d23b0f08SMichal Nazarewicz cases you will want to use FSG instead. This gadget is mostly 746d23b0f08SMichal Nazarewicz here to test the functionality of the Mass Storage Function 747d23b0f08SMichal Nazarewicz which may be used with composite framework. 748d23b0f08SMichal Nazarewicz 749d23b0f08SMichal Nazarewicz Say "y" to link the driver statically, or "m" to build 750d23b0f08SMichal Nazarewicz a dynamically linked module called "g_file_storage". If unsure, 751d23b0f08SMichal Nazarewicz consider File-backed Storage Gadget. 752d23b0f08SMichal Nazarewicz 7531da177e4SLinus Torvaldsconfig USB_G_SERIAL 7543086775aSFelipe Balbi tristate "Serial Gadget (with CDC ACM and CDC OBEX support)" 7551da177e4SLinus Torvalds help 7561da177e4SLinus Torvalds The Serial Gadget talks to the Linux-USB generic serial driver. 7571da177e4SLinus Torvalds This driver supports a CDC-ACM module option, which can be used 7581da177e4SLinus Torvalds to interoperate with MS-Windows hosts or with the Linux-USB 7591da177e4SLinus Torvalds "cdc-acm" driver. 7601da177e4SLinus Torvalds 7613086775aSFelipe Balbi This driver also supports a CDC-OBEX option. You will need a 7623086775aSFelipe Balbi user space OBEX server talking to /dev/ttyGS*, since the kernel 7633086775aSFelipe Balbi itself doesn't implement the OBEX protocol. 7643086775aSFelipe Balbi 7651da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 7661da177e4SLinus Torvalds dynamically linked module called "g_serial". 7671da177e4SLinus Torvalds 7681da177e4SLinus Torvalds For more information, see Documentation/usb/gadget_serial.txt 7691da177e4SLinus Torvalds which includes instructions and a "driver info file" needed to 7703086775aSFelipe Balbi make MS-Windows work with CDC ACM. 7711da177e4SLinus Torvalds 772f2ebf92cSBen Williamsonconfig USB_MIDI_GADGET 773f2ebf92cSBen Williamson tristate "MIDI Gadget (EXPERIMENTAL)" 774f2ebf92cSBen Williamson depends on SND && EXPERIMENTAL 775f2ebf92cSBen Williamson select SND_RAWMIDI 776f2ebf92cSBen Williamson help 777f2ebf92cSBen Williamson The MIDI Gadget acts as a USB Audio device, with one MIDI 778f2ebf92cSBen Williamson input and one MIDI output. These MIDI jacks appear as 779f2ebf92cSBen Williamson a sound "card" in the ALSA sound system. Other MIDI 780f2ebf92cSBen Williamson connections can then be made on the gadget system, using 781f2ebf92cSBen Williamson ALSA's aconnect utility etc. 782f2ebf92cSBen Williamson 783f2ebf92cSBen Williamson Say "y" to link the driver statically, or "m" to build a 784f2ebf92cSBen Williamson dynamically linked module called "g_midi". 785f2ebf92cSBen Williamson 78625a010c8SCraig W. Nadlerconfig USB_G_PRINTER 78725a010c8SCraig W. Nadler tristate "Printer Gadget" 78825a010c8SCraig W. Nadler help 78925a010c8SCraig W. Nadler The Printer Gadget channels data between the USB host and a 79025a010c8SCraig W. Nadler userspace program driving the print engine. The user space 79125a010c8SCraig W. Nadler program reads and writes the device file /dev/g_printer to 79225a010c8SCraig W. Nadler receive or send printer data. It can use ioctl calls to 79325a010c8SCraig W. Nadler the device file to get or set printer status. 79425a010c8SCraig W. Nadler 79525a010c8SCraig W. Nadler Say "y" to link the driver statically, or "m" to build a 79625a010c8SCraig W. Nadler dynamically linked module called "g_printer". 79725a010c8SCraig W. Nadler 79825a010c8SCraig W. Nadler For more information, see Documentation/usb/gadget_printer.txt 79925a010c8SCraig W. Nadler which includes sample code for accessing the device file. 8001da177e4SLinus Torvalds 80119e20680SDavid Brownellconfig USB_CDC_COMPOSITE 80219e20680SDavid Brownell tristate "CDC Composite Device (Ethernet and ACM)" 8034ddd9ec1SRandy Dunlap depends on NET 80419e20680SDavid Brownell help 80519e20680SDavid Brownell This driver provides two functions in one configuration: 80619e20680SDavid Brownell a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link. 80719e20680SDavid Brownell 80819e20680SDavid Brownell This driver requires four bulk and two interrupt endpoints, 80919e20680SDavid Brownell plus the ability to handle altsettings. Not all peripheral 81019e20680SDavid Brownell controllers are that capable. 81119e20680SDavid Brownell 81219e20680SDavid Brownell Say "y" to link the driver statically, or "m" to build a 81319e20680SDavid Brownell dynamically linked module. 81419e20680SDavid Brownell 815f176a5d8SMichal Nazarewiczconfig USB_G_MULTI 816f176a5d8SMichal Nazarewicz tristate "Multifunction Composite Gadget (EXPERIMENTAL)" 8175791e103SRandy Dunlap depends on BLOCK && NET 818f176a5d8SMichal Nazarewicz help 819f176a5d8SMichal Nazarewicz The Multifunction Composite Gadget provides Ethernet (RNDIS 820f176a5d8SMichal Nazarewicz and/or CDC Ethernet), mass storage and ACM serial link 821f176a5d8SMichal Nazarewicz interfaces. 822f176a5d8SMichal Nazarewicz 8235791e103SRandy Dunlap You will be asked to choose which of the two configurations is 824f176a5d8SMichal Nazarewicz to be available in the gadget. At least one configuration must 8255791e103SRandy Dunlap be chosen to make the gadget usable. Selecting more than one 826f176a5d8SMichal Nazarewicz configuration will prevent Windows from automatically detecting 8275791e103SRandy Dunlap the gadget as a composite gadget, so an INF file will be needed to 828f176a5d8SMichal Nazarewicz use the gadget. 829f176a5d8SMichal Nazarewicz 830f176a5d8SMichal Nazarewicz Say "y" to link the driver statically, or "m" to build a 831f176a5d8SMichal Nazarewicz dynamically linked module called "g_multi". 832f176a5d8SMichal Nazarewicz 833f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_RNDIS 834f176a5d8SMichal Nazarewicz bool "RNDIS + CDC Serial + Storage configuration" 835f176a5d8SMichal Nazarewicz depends on USB_G_MULTI 836f176a5d8SMichal Nazarewicz default y 837f176a5d8SMichal Nazarewicz help 838f176a5d8SMichal Nazarewicz This option enables a configuration with RNDIS, CDC Serial and 839f176a5d8SMichal Nazarewicz Mass Storage functions available in the Multifunction Composite 8405791e103SRandy Dunlap Gadget. This is the configuration dedicated for Windows since RNDIS 8415791e103SRandy Dunlap is Microsoft's protocol. 842f176a5d8SMichal Nazarewicz 843f176a5d8SMichal Nazarewicz If unsure, say "y". 844f176a5d8SMichal Nazarewicz 845f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_CDC 846f176a5d8SMichal Nazarewicz bool "CDC Ethernet + CDC Serial + Storage configuration" 847f176a5d8SMichal Nazarewicz depends on USB_G_MULTI 848f176a5d8SMichal Nazarewicz default n 849f176a5d8SMichal Nazarewicz help 850f176a5d8SMichal Nazarewicz This option enables a configuration with CDC Ethernet (ECM), CDC 851f176a5d8SMichal Nazarewicz Serial and Mass Storage functions available in the Multifunction 8525791e103SRandy Dunlap Composite Gadget. 853f176a5d8SMichal Nazarewicz 854f176a5d8SMichal Nazarewicz If unsure, say "y". 855f176a5d8SMichal Nazarewicz 856f176a5d8SMichal Nazarewicz 8571da177e4SLinus Torvalds# put drivers that need isochronous transfer support (for audio 8581da177e4SLinus Torvalds# or video class gadget drivers), or specific hardware, here. 8591da177e4SLinus Torvalds 8601da177e4SLinus Torvalds# - none yet 8611da177e4SLinus Torvalds 8621da177e4SLinus Torvaldsendchoice 8631da177e4SLinus Torvalds 864b75be4abSDenis Chengendif # USB_GADGET 865