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" 127a7a19facSDavid Brownell depends on ARCH_AT91 && !ARCH_AT91SAM9RL && !ARCH_AT91CAP9 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 146ba45ca43SNicolas Ferre depends on AVR32 || ARCH_AT91CAP9 || ARCH_AT91SAM9RL 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" 15933635efaSLi Yang depends on FSL_SOC 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 226a7a19facSDavid Brownell help 227a7a19facSDavid Brownell Intel's PXA 25x series XScale ARM-5TE processors include 228a7a19facSDavid Brownell an integrated full speed USB 1.1 device controller. The 229a7a19facSDavid Brownell controller in the IXP 4xx series is register-compatible. 230a7a19facSDavid Brownell 231a7a19facSDavid Brownell It has fifteen fixed-function endpoints, as well as endpoint 232a7a19facSDavid Brownell zero (for control transfers). 233a7a19facSDavid Brownell 234a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 235a7a19facSDavid Brownell dynamically linked module called "pxa25x_udc" and force all 236a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 237a7a19facSDavid Brownell 238a7a19facSDavid Brownellconfig USB_PXA25X 239a7a19facSDavid Brownell tristate 240a7a19facSDavid Brownell depends on USB_GADGET_PXA25X 241a7a19facSDavid Brownell default USB_GADGET 242a7a19facSDavid Brownell select USB_GADGET_SELECTED 243a7a19facSDavid Brownell 244a7a19facSDavid Brownell# if there's only one gadget driver, using only two bulk endpoints, 245a7a19facSDavid Brownell# don't waste memory for the other endpoints 246a7a19facSDavid Brownellconfig USB_PXA25X_SMALL 247a7a19facSDavid Brownell depends on USB_GADGET_PXA25X 248a7a19facSDavid Brownell bool 249a7a19facSDavid Brownell default n if USB_ETH_RNDIS 250a7a19facSDavid Brownell default y if USB_ZERO 251a7a19facSDavid Brownell default y if USB_ETH 252a7a19facSDavid Brownell default y if USB_G_SERIAL 253a7a19facSDavid Brownell 254a7a19facSDavid Brownellconfig USB_GADGET_PXA27X 255a7a19facSDavid Brownell boolean "PXA 27x" 256*9f5351b7SRobert Jarzmik depends on ARCH_PXA && (PXA27x || PXA3xx) 2577fec3c25SRobert Jarzmik select USB_OTG_UTILS 258a7a19facSDavid Brownell help 259a7a19facSDavid Brownell Intel's PXA 27x series XScale ARM v5TE processors include 260a7a19facSDavid Brownell an integrated full speed USB 1.1 device controller. 261a7a19facSDavid Brownell 262a7a19facSDavid Brownell It has up to 23 endpoints, as well as endpoint zero (for 263a7a19facSDavid Brownell control transfers). 264a7a19facSDavid Brownell 265a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 266a7a19facSDavid Brownell dynamically linked module called "pxa27x_udc" and force all 267a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 268a7a19facSDavid Brownell 269a7a19facSDavid Brownellconfig USB_PXA27X 270a7a19facSDavid Brownell tristate 271a7a19facSDavid Brownell depends on USB_GADGET_PXA27X 272a7a19facSDavid Brownell default USB_GADGET 273a7a19facSDavid Brownell select USB_GADGET_SELECTED 274a7a19facSDavid Brownell 2753fc154b6SArnaud Patardconfig USB_GADGET_S3C2410 2763fc154b6SArnaud Patard boolean "S3C2410 USB Device Controller" 2773fc154b6SArnaud Patard depends on ARCH_S3C2410 2783fc154b6SArnaud Patard help 2793fc154b6SArnaud Patard Samsung's S3C2410 is an ARM-4 processor with an integrated 2803fc154b6SArnaud Patard full speed USB 1.1 device controller. It has 4 configurable 2813fc154b6SArnaud Patard endpoints, as well as endpoint zero (for control transfers). 2823fc154b6SArnaud Patard 2833fc154b6SArnaud Patard This driver has been tested on the S3C2410, S3C2412, and 2843fc154b6SArnaud Patard S3C2440 processors. 2853fc154b6SArnaud Patard 2863fc154b6SArnaud Patardconfig USB_S3C2410 2873fc154b6SArnaud Patard tristate 2883fc154b6SArnaud Patard depends on USB_GADGET_S3C2410 2893fc154b6SArnaud Patard default USB_GADGET 2903fc154b6SArnaud Patard select USB_GADGET_SELECTED 2913fc154b6SArnaud Patard 2923fc154b6SArnaud Patardconfig USB_S3C2410_DEBUG 2933fc154b6SArnaud Patard boolean "S3C2410 udc debug messages" 2943fc154b6SArnaud Patard depends on USB_GADGET_S3C2410 2953fc154b6SArnaud Patard 296a7a19facSDavid Brownell# 297a7a19facSDavid Brownell# Controllers available in both integrated and discrete versions 298a7a19facSDavid Brownell# 299a7a19facSDavid Brownell 300a7a19facSDavid Brownell# musb builds in ../musb along with host support 301a7a19facSDavid Brownellconfig USB_GADGET_MUSB_HDRC 302085ad406SBryan Wu boolean "Inventra HDRC USB Peripheral (TI, ADI, ...)" 303a7a19facSDavid Brownell depends on USB_MUSB_HDRC && (USB_MUSB_PERIPHERAL || USB_MUSB_OTG) 304a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 305bae4bd84SDavid Brownell select USB_GADGET_SELECTED 306bae4bd84SDavid Brownell help 307a7a19facSDavid Brownell This OTG-capable silicon IP is used in dual designs including 308085ad406SBryan Wu the TI DaVinci, OMAP 243x, OMAP 343x, TUSB 6010, and ADI Blackfin 309a7a19facSDavid Brownell 3102a4f136fSDarius Augulisconfig USB_GADGET_IMX 3112a4f136fSDarius Augulis boolean "Freescale IMX USB Peripheral Controller" 3122a4f136fSDarius Augulis depends on ARCH_MX1 3132a4f136fSDarius Augulis help 3142a4f136fSDarius Augulis Freescale's IMX series include an integrated full speed 3152a4f136fSDarius Augulis USB 1.1 device controller. The controller in the IMX series 3162a4f136fSDarius Augulis is register-compatible. 3172a4f136fSDarius Augulis 3182a4f136fSDarius Augulis It has Six fixed-function endpoints, as well as endpoint 3192a4f136fSDarius Augulis zero (for control transfers). 3202a4f136fSDarius Augulis 3212a4f136fSDarius Augulis Say "y" to link the driver statically, or "m" to build a 3222a4f136fSDarius Augulis dynamically linked module called "imx_udc" and force all 3232a4f136fSDarius Augulis gadget drivers to also be dynamically linked. 3242a4f136fSDarius Augulis 3252a4f136fSDarius Augulisconfig USB_IMX 3262a4f136fSDarius Augulis tristate 3272a4f136fSDarius Augulis depends on USB_GADGET_IMX 3282a4f136fSDarius Augulis default USB_GADGET 3292a4f136fSDarius Augulis select USB_GADGET_SELECTED 3302a4f136fSDarius Augulis 331a7a19facSDavid Brownellconfig USB_GADGET_M66592 332a7a19facSDavid Brownell boolean "Renesas M66592 USB Peripheral Controller" 333a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 334a7a19facSDavid Brownell help 335a7a19facSDavid Brownell M66592 is a discrete USB peripheral controller chip that 336a7a19facSDavid Brownell supports both full and high speed USB 2.0 data transfers. 337a7a19facSDavid Brownell It has seven configurable endpoints, and endpoint zero. 338bae4bd84SDavid Brownell 339bae4bd84SDavid Brownell Say "y" to link the driver statically, or "m" to build a 340a7a19facSDavid Brownell dynamically linked module called "m66592_udc" and force all 341bae4bd84SDavid Brownell gadget drivers to also be dynamically linked. 342bae4bd84SDavid Brownell 343a7a19facSDavid Brownellconfig USB_M66592 344bae4bd84SDavid Brownell tristate 345a7a19facSDavid Brownell depends on USB_GADGET_M66592 346bae4bd84SDavid Brownell default USB_GADGET 347a7a19facSDavid Brownell select USB_GADGET_SELECTED 348a7a19facSDavid Brownell 349a7a19facSDavid Brownellconfig SUPERH_BUILT_IN_M66592 350a7a19facSDavid Brownell boolean "Enable SuperH built-in USB like the M66592" 351a7a19facSDavid Brownell depends on USB_GADGET_M66592 && CPU_SUBTYPE_SH7722 352a7a19facSDavid Brownell help 353a7a19facSDavid Brownell SH7722 has USB like the M66592. 354a7a19facSDavid Brownell 355a7a19facSDavid Brownell The transfer rate is very slow when use "Ethernet Gadget". 356a7a19facSDavid Brownell However, this problem is improved if change a value of 357a7a19facSDavid Brownell NET_IP_ALIGN to 4. 358a7a19facSDavid Brownell 359a7a19facSDavid Brownell# 360a7a19facSDavid Brownell# Controllers available only in discrete form (and all PCI controllers) 361a7a19facSDavid Brownell# 362a7a19facSDavid Brownell 363a7a19facSDavid Brownellconfig USB_GADGET_AMD5536UDC 364a7a19facSDavid Brownell boolean "AMD5536 UDC" 365a7a19facSDavid Brownell depends on PCI 366a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 367a7a19facSDavid Brownell help 368a7a19facSDavid Brownell The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge. 369a7a19facSDavid Brownell It is a USB Highspeed DMA capable USB device controller. Beside ep0 370a7a19facSDavid Brownell it provides 4 IN and 4 OUT endpoints (bulk or interrupt type). 371a7a19facSDavid Brownell The UDC port supports OTG operation, and may be used as a host port 372a7a19facSDavid Brownell if it's not being used to implement peripheral or OTG roles. 373a7a19facSDavid Brownell 374a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 375a7a19facSDavid Brownell dynamically linked module called "amd5536udc" and force all 376a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 377a7a19facSDavid Brownell 378a7a19facSDavid Brownellconfig USB_AMD5536UDC 379a7a19facSDavid Brownell tristate 380a7a19facSDavid Brownell depends on USB_GADGET_AMD5536UDC 381a7a19facSDavid Brownell default USB_GADGET 382a7a19facSDavid Brownell select USB_GADGET_SELECTED 383a7a19facSDavid Brownell 3843948f0e0SLi Yangconfig USB_GADGET_FSL_QE 3853948f0e0SLi Yang boolean "Freescale QE/CPM USB Device Controller" 3863948f0e0SLi Yang depends on FSL_SOC && (QUICC_ENGINE || CPM) 3873948f0e0SLi Yang help 3883948f0e0SLi Yang Some of Freescale PowerPC processors have a Full Speed 3893948f0e0SLi Yang QE/CPM2 USB controller, which support device mode with 4 3903948f0e0SLi Yang programmable endpoints. This driver supports the 3913948f0e0SLi Yang controller in the MPC8360 and MPC8272, and should work with 3923948f0e0SLi Yang controllers having QE or CPM2, given minor tweaks. 3933948f0e0SLi Yang 3943948f0e0SLi Yang Set CONFIG_USB_GADGET to "m" to build this driver as a 395692105b8SMatt LaPlante dynamically linked module called "fsl_qe_udc". 3963948f0e0SLi Yang 3973948f0e0SLi Yangconfig USB_FSL_QE 3983948f0e0SLi Yang tristate 3993948f0e0SLi Yang depends on USB_GADGET_FSL_QE 4003948f0e0SLi Yang default USB_GADGET 4013948f0e0SLi Yang select USB_GADGET_SELECTED 4023948f0e0SLi Yang 403aa69a809SDavid Lopoconfig USB_GADGET_CI13XXX 404aa69a809SDavid Lopo boolean "MIPS USB CI13xxx" 405aa69a809SDavid Lopo depends on PCI 406aa69a809SDavid Lopo select USB_GADGET_DUALSPEED 407aa69a809SDavid Lopo help 408aa69a809SDavid Lopo MIPS USB IP core family device controller 409aa69a809SDavid Lopo Currently it only supports IP part number CI13412 410aa69a809SDavid Lopo 411aa69a809SDavid Lopo Say "y" to link the driver statically, or "m" to build a 412aa69a809SDavid Lopo dynamically linked module called "ci13xxx_udc" and force all 413aa69a809SDavid Lopo gadget drivers to also be dynamically linked. 414aa69a809SDavid Lopo 415aa69a809SDavid Lopoconfig USB_CI13XXX 416aa69a809SDavid Lopo tristate 417aa69a809SDavid Lopo depends on USB_GADGET_CI13XXX 418aa69a809SDavid Lopo default USB_GADGET 419aa69a809SDavid Lopo select USB_GADGET_SELECTED 420aa69a809SDavid Lopo 421a7a19facSDavid Brownellconfig USB_GADGET_NET2280 422a7a19facSDavid Brownell boolean "NetChip 228x" 423a7a19facSDavid Brownell depends on PCI 424a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 425a7a19facSDavid Brownell help 426a7a19facSDavid Brownell NetChip 2280 / 2282 is a PCI based USB peripheral controller which 427a7a19facSDavid Brownell supports both full and high speed USB 2.0 data transfers. 428a7a19facSDavid Brownell 429a7a19facSDavid Brownell It has six configurable endpoints, as well as endpoint zero 430a7a19facSDavid Brownell (for control transfers) and several endpoints with dedicated 431a7a19facSDavid Brownell functions. 432a7a19facSDavid Brownell 433a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 434a7a19facSDavid Brownell dynamically linked module called "net2280" and force all 435a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 436a7a19facSDavid Brownell 437a7a19facSDavid Brownellconfig USB_NET2280 438a7a19facSDavid Brownell tristate 439a7a19facSDavid Brownell depends on USB_GADGET_NET2280 440a7a19facSDavid Brownell default USB_GADGET 441a7a19facSDavid Brownell select USB_GADGET_SELECTED 442a7a19facSDavid Brownell 443a7a19facSDavid Brownellconfig USB_GADGET_GOKU 444a7a19facSDavid Brownell boolean "Toshiba TC86C001 'Goku-S'" 445a7a19facSDavid Brownell depends on PCI 446a7a19facSDavid Brownell help 447a7a19facSDavid Brownell The Toshiba TC86C001 is a PCI device which includes controllers 448a7a19facSDavid Brownell for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI). 449a7a19facSDavid Brownell 450a7a19facSDavid Brownell The device controller has three configurable (bulk or interrupt) 451a7a19facSDavid Brownell endpoints, plus endpoint zero (for control transfers). 452a7a19facSDavid Brownell 453a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 454a7a19facSDavid Brownell dynamically linked module called "goku_udc" and to force all 455a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 456a7a19facSDavid Brownell 457a7a19facSDavid Brownellconfig USB_GOKU 458a7a19facSDavid Brownell tristate 459a7a19facSDavid Brownell depends on USB_GADGET_GOKU 460a7a19facSDavid Brownell default USB_GADGET 461a7a19facSDavid Brownell select USB_GADGET_SELECTED 462a7a19facSDavid Brownell 463a7a19facSDavid Brownell 464a7a19facSDavid Brownell# 465a7a19facSDavid Brownell# LAST -- dummy/emulated controller 466a7a19facSDavid Brownell# 4671da177e4SLinus Torvalds 4681da177e4SLinus Torvaldsconfig USB_GADGET_DUMMY_HCD 4691da177e4SLinus Torvalds boolean "Dummy HCD (DEVELOPMENT)" 470afd0e0f2SRobert P. J. Day depends on USB=y || (USB=m && USB_GADGET=m) 4711da177e4SLinus Torvalds select USB_GADGET_DUALSPEED 4721da177e4SLinus Torvalds help 4731da177e4SLinus Torvalds This host controller driver emulates USB, looping all data transfer 4741da177e4SLinus Torvalds requests back to a USB "gadget driver" in the same host. The host 4751da177e4SLinus Torvalds side is the master; the gadget side is the slave. Gadget drivers 4761da177e4SLinus Torvalds can be high, full, or low speed; and they have access to endpoints 4771da177e4SLinus Torvalds like those from NET2280, PXA2xx, or SA1100 hardware. 4781da177e4SLinus Torvalds 4791da177e4SLinus Torvalds This may help in some stages of creating a driver to embed in a 4801da177e4SLinus Torvalds Linux device, since it lets you debug several parts of the gadget 4811da177e4SLinus Torvalds driver without its hardware or drivers being involved. 4821da177e4SLinus Torvalds 4831da177e4SLinus Torvalds Since such a gadget side driver needs to interoperate with a host 4841da177e4SLinus Torvalds side Linux-USB device driver, this may help to debug both sides 4851da177e4SLinus Torvalds of a USB protocol stack. 4861da177e4SLinus Torvalds 4871da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 4881da177e4SLinus Torvalds dynamically linked module called "dummy_hcd" and force all 4891da177e4SLinus Torvalds gadget drivers to also be dynamically linked. 4901da177e4SLinus Torvalds 4911da177e4SLinus Torvaldsconfig USB_DUMMY_HCD 4921da177e4SLinus Torvalds tristate 4931da177e4SLinus Torvalds depends on USB_GADGET_DUMMY_HCD 4941da177e4SLinus Torvalds default USB_GADGET 495028b271bSDavid Brownell select USB_GADGET_SELECTED 4961da177e4SLinus Torvalds 4971da177e4SLinus Torvalds# NOTE: Please keep dummy_hcd LAST so that "real hardware" appears 4981da177e4SLinus Torvalds# first and will be selected by default. 4991da177e4SLinus Torvalds 5001da177e4SLinus Torvaldsendchoice 5011da177e4SLinus Torvalds 5021da177e4SLinus Torvaldsconfig USB_GADGET_DUALSPEED 5031da177e4SLinus Torvalds bool 5041da177e4SLinus Torvalds depends on USB_GADGET 5051da177e4SLinus Torvalds default n 5061da177e4SLinus Torvalds help 5071da177e4SLinus Torvalds Means that gadget drivers should include extra descriptors 5081da177e4SLinus Torvalds and code to handle dual-speed controllers. 5091da177e4SLinus Torvalds 5101da177e4SLinus Torvalds# 5111da177e4SLinus Torvalds# USB Gadget Drivers 5121da177e4SLinus Torvalds# 5131da177e4SLinus Torvaldschoice 5141da177e4SLinus Torvalds tristate "USB Gadget Drivers" 515028b271bSDavid Brownell depends on USB_GADGET && USB_GADGET_SELECTED 5161da177e4SLinus Torvalds default USB_ETH 5171da177e4SLinus Torvalds help 5181da177e4SLinus Torvalds A Linux "Gadget Driver" talks to the USB Peripheral Controller 5191da177e4SLinus Torvalds driver through the abstract "gadget" API. Some other operating 5201da177e4SLinus Torvalds systems call these "client" drivers, of which "class drivers" 5211da177e4SLinus Torvalds are a subset (implementing a USB device class specification). 5221da177e4SLinus Torvalds A gadget driver implements one or more USB functions using 5231da177e4SLinus Torvalds the peripheral hardware. 5241da177e4SLinus Torvalds 5251da177e4SLinus Torvalds Gadget drivers are hardware-neutral, or "platform independent", 5261da177e4SLinus Torvalds except that they sometimes must understand quirks or limitations 5271da177e4SLinus Torvalds of the particular controllers they work with. For example, when 5281da177e4SLinus Torvalds a controller doesn't support alternate configurations or provide 5291da177e4SLinus Torvalds enough of the right types of endpoints, the gadget driver might 5301da177e4SLinus Torvalds not be able work with that controller, or might need to implement 5311da177e4SLinus Torvalds a less common variant of a device class protocol. 5321da177e4SLinus Torvalds 5331da177e4SLinus Torvalds# this first set of drivers all depend on bulk-capable hardware. 5341da177e4SLinus Torvalds 5351da177e4SLinus Torvaldsconfig USB_ZERO 5361da177e4SLinus Torvalds tristate "Gadget Zero (DEVELOPMENT)" 5371da177e4SLinus Torvalds help 5381da177e4SLinus Torvalds Gadget Zero is a two-configuration device. It either sinks and 5391da177e4SLinus Torvalds sources bulk data; or it loops back a configurable number of 5401da177e4SLinus Torvalds transfers. It also implements control requests, for "chapter 9" 5411da177e4SLinus Torvalds conformance. The driver needs only two bulk-capable endpoints, so 5421da177e4SLinus Torvalds it can work on top of most device-side usb controllers. It's 5431da177e4SLinus Torvalds useful for testing, and is also a working example showing how 5441da177e4SLinus Torvalds USB "gadget drivers" can be written. 5451da177e4SLinus Torvalds 5461da177e4SLinus Torvalds Make this be the first driver you try using on top of any new 5471da177e4SLinus Torvalds USB peripheral controller driver. Then you can use host-side 5481da177e4SLinus Torvalds test software, like the "usbtest" driver, to put your hardware 5491da177e4SLinus Torvalds and its driver through a basic set of functional tests. 5501da177e4SLinus Torvalds 5511da177e4SLinus Torvalds Gadget Zero also works with the host-side "usb-skeleton" driver, 5521da177e4SLinus Torvalds and with many kinds of host-side test software. You may need 5531da177e4SLinus Torvalds to tweak product and vendor IDs before host software knows about 5541da177e4SLinus Torvalds this device, and arrange to select an appropriate configuration. 5551da177e4SLinus Torvalds 5561da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 5571da177e4SLinus Torvalds dynamically linked module called "g_zero". 5581da177e4SLinus Torvalds 5591da177e4SLinus Torvaldsconfig USB_ZERO_HNPTEST 5601da177e4SLinus Torvalds boolean "HNP Test Device" 5611da177e4SLinus Torvalds depends on USB_ZERO && USB_OTG 5621da177e4SLinus Torvalds help 5631da177e4SLinus Torvalds You can configure this device to enumerate using the device 5641da177e4SLinus Torvalds identifiers of the USB-OTG test device. That means that when 5651da177e4SLinus Torvalds this gadget connects to another OTG device, with this one using 5661da177e4SLinus Torvalds the "B-Peripheral" role, that device will use HNP to let this 5671da177e4SLinus Torvalds one serve as the USB host instead (in the "B-Host" role). 5681da177e4SLinus Torvalds 5691da177e4SLinus Torvaldsconfig USB_ETH 5701da177e4SLinus Torvalds tristate "Ethernet Gadget (with CDC Ethernet support)" 5711da177e4SLinus Torvalds depends on NET 5721da177e4SLinus Torvalds help 5731da177e4SLinus Torvalds This driver implements Ethernet style communication, in either 5741da177e4SLinus Torvalds of two ways: 5751da177e4SLinus Torvalds 5761da177e4SLinus Torvalds - The "Communication Device Class" (CDC) Ethernet Control Model. 5771da177e4SLinus Torvalds That protocol is often avoided with pure Ethernet adapters, in 5781da177e4SLinus Torvalds favor of simpler vendor-specific hardware, but is widely 5791da177e4SLinus Torvalds supported by firmware for smart network devices. 5801da177e4SLinus Torvalds 5811da177e4SLinus Torvalds - On hardware can't implement that protocol, a simple CDC subset 5821da177e4SLinus Torvalds is used, placing fewer demands on USB. 5831da177e4SLinus Torvalds 5841da177e4SLinus Torvalds RNDIS support is a third option, more demanding than that subset. 5851da177e4SLinus Torvalds 5861da177e4SLinus Torvalds Within the USB device, this gadget driver exposes a network device 5871da177e4SLinus Torvalds "usbX", where X depends on what other networking devices you have. 5881da177e4SLinus Torvalds Treat it like a two-node Ethernet link: host, and gadget. 5891da177e4SLinus Torvalds 5901da177e4SLinus Torvalds The Linux-USB host-side "usbnet" driver interoperates with this 5911da177e4SLinus Torvalds driver, so that deep I/O queues can be supported. On 2.4 kernels, 5921da177e4SLinus Torvalds use "CDCEther" instead, if you're using the CDC option. That CDC 5931da177e4SLinus Torvalds mode should also interoperate with standard CDC Ethernet class 5941da177e4SLinus Torvalds drivers on other host operating systems. 5951da177e4SLinus Torvalds 5961da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 5971da177e4SLinus Torvalds dynamically linked module called "g_ether". 5981da177e4SLinus Torvalds 5991da177e4SLinus Torvaldsconfig USB_ETH_RNDIS 600afd0e0f2SRobert P. J. Day bool "RNDIS support" 601afd0e0f2SRobert P. J. Day depends on USB_ETH 6021da177e4SLinus Torvalds default y 6031da177e4SLinus Torvalds help 6041da177e4SLinus Torvalds Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol, 6051da177e4SLinus Torvalds and Microsoft provides redistributable binary RNDIS drivers for 6061da177e4SLinus Torvalds older versions of Windows. 6071da177e4SLinus Torvalds 6081da177e4SLinus Torvalds If you say "y" here, the Ethernet gadget driver will try to provide 6091da177e4SLinus Torvalds a second device configuration, supporting RNDIS to talk to such 6101da177e4SLinus Torvalds Microsoft USB hosts. 6111da177e4SLinus Torvalds 6121da177e4SLinus Torvalds To make MS-Windows work with this, use Documentation/usb/linux.inf 6131da177e4SLinus Torvalds as the "driver info file". For versions of MS-Windows older than 6141da177e4SLinus Torvalds XP, you'll need to download drivers from Microsoft's website; a URL 6151da177e4SLinus Torvalds is given in comments found in that info file. 6161da177e4SLinus Torvalds 6171da177e4SLinus Torvaldsconfig USB_GADGETFS 6181da177e4SLinus Torvalds tristate "Gadget Filesystem (EXPERIMENTAL)" 6191da177e4SLinus Torvalds depends on EXPERIMENTAL 6201da177e4SLinus Torvalds help 6211da177e4SLinus Torvalds This driver provides a filesystem based API that lets user mode 6221da177e4SLinus Torvalds programs implement a single-configuration USB device, including 6231da177e4SLinus Torvalds endpoint I/O and control requests that don't relate to enumeration. 6241da177e4SLinus Torvalds All endpoints, transfer speeds, and transfer types supported by 6251da177e4SLinus Torvalds the hardware are available, through read() and write() calls. 6261da177e4SLinus Torvalds 627afd0e0f2SRobert P. J. Day Currently, this option is still labelled as EXPERIMENTAL because 628afd0e0f2SRobert P. J. Day of existing race conditions in the underlying in-kernel AIO core. 629afd0e0f2SRobert P. J. Day 6301da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 6311da177e4SLinus Torvalds dynamically linked module called "gadgetfs". 6321da177e4SLinus Torvalds 6331da177e4SLinus Torvaldsconfig USB_FILE_STORAGE 6341da177e4SLinus Torvalds tristate "File-backed Storage Gadget" 63587840289SRandy Dunlap depends on BLOCK 6361da177e4SLinus Torvalds help 6371da177e4SLinus Torvalds The File-backed Storage Gadget acts as a USB Mass Storage 6381da177e4SLinus Torvalds disk drive. As its storage repository it can use a regular 6391da177e4SLinus Torvalds file or a block device (in much the same way as the "loop" 6401da177e4SLinus Torvalds device driver), specified as a module parameter. 6411da177e4SLinus Torvalds 6421da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 6431da177e4SLinus Torvalds dynamically linked module called "g_file_storage". 6441da177e4SLinus Torvalds 6451da177e4SLinus Torvaldsconfig USB_FILE_STORAGE_TEST 6461da177e4SLinus Torvalds bool "File-backed Storage Gadget testing version" 6471da177e4SLinus Torvalds depends on USB_FILE_STORAGE 6481da177e4SLinus Torvalds default n 6491da177e4SLinus Torvalds help 6501da177e4SLinus Torvalds Say "y" to generate the larger testing version of the 6511da177e4SLinus Torvalds File-backed Storage Gadget, useful for probing the 6521da177e4SLinus Torvalds behavior of USB Mass Storage hosts. Not needed for 6531da177e4SLinus Torvalds normal operation. 6541da177e4SLinus Torvalds 6551da177e4SLinus Torvaldsconfig USB_G_SERIAL 6563086775aSFelipe Balbi tristate "Serial Gadget (with CDC ACM and CDC OBEX support)" 6571da177e4SLinus Torvalds help 6581da177e4SLinus Torvalds The Serial Gadget talks to the Linux-USB generic serial driver. 6591da177e4SLinus Torvalds This driver supports a CDC-ACM module option, which can be used 6601da177e4SLinus Torvalds to interoperate with MS-Windows hosts or with the Linux-USB 6611da177e4SLinus Torvalds "cdc-acm" driver. 6621da177e4SLinus Torvalds 6633086775aSFelipe Balbi This driver also supports a CDC-OBEX option. You will need a 6643086775aSFelipe Balbi user space OBEX server talking to /dev/ttyGS*, since the kernel 6653086775aSFelipe Balbi itself doesn't implement the OBEX protocol. 6663086775aSFelipe Balbi 6671da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 6681da177e4SLinus Torvalds dynamically linked module called "g_serial". 6691da177e4SLinus Torvalds 6701da177e4SLinus Torvalds For more information, see Documentation/usb/gadget_serial.txt 6711da177e4SLinus Torvalds which includes instructions and a "driver info file" needed to 6723086775aSFelipe Balbi make MS-Windows work with CDC ACM. 6731da177e4SLinus Torvalds 674f2ebf92cSBen Williamsonconfig USB_MIDI_GADGET 675f2ebf92cSBen Williamson tristate "MIDI Gadget (EXPERIMENTAL)" 676f2ebf92cSBen Williamson depends on SND && EXPERIMENTAL 677f2ebf92cSBen Williamson select SND_RAWMIDI 678f2ebf92cSBen Williamson help 679f2ebf92cSBen Williamson The MIDI Gadget acts as a USB Audio device, with one MIDI 680f2ebf92cSBen Williamson input and one MIDI output. These MIDI jacks appear as 681f2ebf92cSBen Williamson a sound "card" in the ALSA sound system. Other MIDI 682f2ebf92cSBen Williamson connections can then be made on the gadget system, using 683f2ebf92cSBen Williamson ALSA's aconnect utility etc. 684f2ebf92cSBen Williamson 685f2ebf92cSBen Williamson Say "y" to link the driver statically, or "m" to build a 686f2ebf92cSBen Williamson dynamically linked module called "g_midi". 687f2ebf92cSBen Williamson 68825a010c8SCraig W. Nadlerconfig USB_G_PRINTER 68925a010c8SCraig W. Nadler tristate "Printer Gadget" 69025a010c8SCraig W. Nadler help 69125a010c8SCraig W. Nadler The Printer Gadget channels data between the USB host and a 69225a010c8SCraig W. Nadler userspace program driving the print engine. The user space 69325a010c8SCraig W. Nadler program reads and writes the device file /dev/g_printer to 69425a010c8SCraig W. Nadler receive or send printer data. It can use ioctl calls to 69525a010c8SCraig W. Nadler the device file to get or set printer status. 69625a010c8SCraig W. Nadler 69725a010c8SCraig W. Nadler Say "y" to link the driver statically, or "m" to build a 69825a010c8SCraig W. Nadler dynamically linked module called "g_printer". 69925a010c8SCraig W. Nadler 70025a010c8SCraig W. Nadler For more information, see Documentation/usb/gadget_printer.txt 70125a010c8SCraig W. Nadler which includes sample code for accessing the device file. 7021da177e4SLinus Torvalds 70319e20680SDavid Brownellconfig USB_CDC_COMPOSITE 70419e20680SDavid Brownell tristate "CDC Composite Device (Ethernet and ACM)" 7054ddd9ec1SRandy Dunlap depends on NET 70619e20680SDavid Brownell help 70719e20680SDavid Brownell This driver provides two functions in one configuration: 70819e20680SDavid Brownell a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link. 70919e20680SDavid Brownell 71019e20680SDavid Brownell This driver requires four bulk and two interrupt endpoints, 71119e20680SDavid Brownell plus the ability to handle altsettings. Not all peripheral 71219e20680SDavid Brownell controllers are that capable. 71319e20680SDavid Brownell 71419e20680SDavid Brownell Say "y" to link the driver statically, or "m" to build a 71519e20680SDavid Brownell dynamically linked module. 71619e20680SDavid Brownell 7171da177e4SLinus Torvalds# put drivers that need isochronous transfer support (for audio 7181da177e4SLinus Torvalds# or video class gadget drivers), or specific hardware, here. 7191da177e4SLinus Torvalds 7201da177e4SLinus Torvalds# - none yet 7211da177e4SLinus Torvalds 7221da177e4SLinus Torvaldsendchoice 7231da177e4SLinus Torvalds 724b75be4abSDenis Chengendif # USB_GADGET 725