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 991da177e4SLinus Torvalds# 1001da177e4SLinus Torvalds# USB Peripheral Controller Support 1011da177e4SLinus Torvalds# 102a7a19facSDavid Brownell# The order here is alphabetical, except that integrated controllers go 103a7a19facSDavid Brownell# before discrete ones so they will be the initial/default value: 104a7a19facSDavid Brownell# - integrated/SOC controllers first 105a7a19facSDavid Brownell# - licensed IP used in both SOC and discrete versions 106a7a19facSDavid Brownell# - discrete ones (including all PCI-only controllers) 107a7a19facSDavid Brownell# - debug/dummy gadget+hcd is last. 108a7a19facSDavid Brownell# 1091da177e4SLinus Torvaldschoice 1101da177e4SLinus Torvalds prompt "USB Peripheral Controller" 1111da177e4SLinus Torvalds depends on USB_GADGET 1121da177e4SLinus Torvalds help 1131da177e4SLinus Torvalds A USB device uses a controller to talk to its host. 1141da177e4SLinus Torvalds Systems should have only one such upstream link. 1151da177e4SLinus Torvalds Many controller drivers are platform-specific; these 1161da177e4SLinus Torvalds often need board-specific hooks. 1171da177e4SLinus Torvalds 118a7a19facSDavid Brownell# 119a7a19facSDavid Brownell# Integrated controllers 120a7a19facSDavid Brownell# 121a7a19facSDavid Brownell 122193ab2a6SFelipe Balbiconfig USB_AT91 123193ab2a6SFelipe Balbi tristate "Atmel AT91 USB Device Port" 124aa781af0SNicolas Ferre depends on ARCH_AT91 && !ARCH_AT91SAM9RL && !ARCH_AT91CAP9 && !ARCH_AT91SAM9G45 12555d402d8SThomas Dahlmann help 126a7a19facSDavid Brownell Many Atmel AT91 processors (such as the AT91RM2000) have a 127a7a19facSDavid Brownell full speed USB Device Port with support for five configurable 128a7a19facSDavid Brownell endpoints (plus endpoint zero). 12955d402d8SThomas Dahlmann 13055d402d8SThomas Dahlmann Say "y" to link the driver statically, or "m" to build a 131a7a19facSDavid Brownell dynamically linked module called "at91_udc" and force all 13255d402d8SThomas Dahlmann gadget drivers to also be dynamically linked. 13355d402d8SThomas Dahlmann 134193ab2a6SFelipe Balbiconfig USB_ATMEL_USBA 135193ab2a6SFelipe Balbi tristate "Atmel USBA" 136914a3f3bSHaavard Skinnemoen select USB_GADGET_DUALSPEED 137aa781af0SNicolas Ferre depends on AVR32 || ARCH_AT91CAP9 || ARCH_AT91SAM9RL || ARCH_AT91SAM9G45 138914a3f3bSHaavard Skinnemoen help 139914a3f3bSHaavard Skinnemoen USBA is the integrated high-speed USB Device controller on 140ba45ca43SNicolas Ferre the AT32AP700x, some AT91SAM9 and AT91CAP9 processors from Atmel. 141914a3f3bSHaavard Skinnemoen 142193ab2a6SFelipe Balbiconfig USB_FSL_USB2 143193ab2a6SFelipe Balbi tristate "Freescale Highspeed USB DR Peripheral Controller" 14454e4026bSGuennadi Liakhovetski depends on FSL_SOC || ARCH_MXC 145b504882dSLi Yang select USB_GADGET_DUALSPEED 146018b97d0SMarc Kleine-Budde select USB_FSL_MPH_DR_OF if OF 147b504882dSLi Yang help 148b504882dSLi Yang Some of Freescale PowerPC processors have a High Speed 149b504882dSLi Yang Dual-Role(DR) USB controller, which supports device mode. 150b504882dSLi Yang 151b504882dSLi Yang The number of programmable endpoints is different through 152b504882dSLi Yang SOC revisions. 153b504882dSLi Yang 154b504882dSLi Yang Say "y" to link the driver statically, or "m" to build a 155b504882dSLi Yang dynamically linked module called "fsl_usb2_udc" and force 156b504882dSLi Yang all gadget drivers to also be dynamically linked. 157b504882dSLi Yang 158193ab2a6SFelipe Balbiconfig USB_FUSB300 159193ab2a6SFelipe Balbi tristate "Faraday FUSB300 USB Peripheral Controller" 1600fe6f1d1SYuan-Hsin Chen select USB_GADGET_DUALSPEED 1610fe6f1d1SYuan-Hsin Chen help 1620fe6f1d1SYuan-Hsin Chen Faraday usb device controller FUSB300 driver 1630fe6f1d1SYuan-Hsin Chen 164193ab2a6SFelipe Balbiconfig USB_OMAP 165193ab2a6SFelipe Balbi tristate "OMAP USB Device Controller" 1661da177e4SLinus Torvalds depends on ARCH_OMAP 167f1c9e151STony Lindgren select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3 || MACH_OMAP_H4_OTG 16854b9ed35SDavid Brownell select USB_OTG_UTILS if ARCH_OMAP 1691da177e4SLinus Torvalds help 1701da177e4SLinus Torvalds Many Texas Instruments OMAP processors have flexible full 1711da177e4SLinus Torvalds speed USB device controllers, with support for up to 30 1721da177e4SLinus Torvalds endpoints (plus endpoint zero). This driver supports the 1731da177e4SLinus Torvalds controller in the OMAP 1611, and should work with controllers 1741da177e4SLinus Torvalds in other OMAP processors too, given minor tweaks. 1751da177e4SLinus Torvalds 1761da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 1771da177e4SLinus Torvalds dynamically linked module called "omap_udc" and force all 1781da177e4SLinus Torvalds gadget drivers to also be dynamically linked. 1791da177e4SLinus Torvalds 180193ab2a6SFelipe Balbiconfig USB_PXA25X 181193ab2a6SFelipe Balbi tristate "PXA 25x or IXP 4xx" 182a7a19facSDavid Brownell depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX 18309963911SRussell King select USB_OTG_UTILS 184a7a19facSDavid Brownell help 185a7a19facSDavid Brownell Intel's PXA 25x series XScale ARM-5TE processors include 186a7a19facSDavid Brownell an integrated full speed USB 1.1 device controller. The 187a7a19facSDavid Brownell controller in the IXP 4xx series is register-compatible. 188a7a19facSDavid Brownell 189a7a19facSDavid Brownell It has fifteen fixed-function endpoints, as well as endpoint 190a7a19facSDavid Brownell zero (for control transfers). 191a7a19facSDavid Brownell 192a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 193a7a19facSDavid Brownell dynamically linked module called "pxa25x_udc" and force all 194a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 195a7a19facSDavid Brownell 196a7a19facSDavid Brownell# if there's only one gadget driver, using only two bulk endpoints, 197a7a19facSDavid Brownell# don't waste memory for the other endpoints 198a7a19facSDavid Brownellconfig USB_PXA25X_SMALL 199193ab2a6SFelipe Balbi depends on USB_PXA25X 200a7a19facSDavid Brownell bool 201a7a19facSDavid Brownell default n if USB_ETH_RNDIS 202a7a19facSDavid Brownell default y if USB_ZERO 203a7a19facSDavid Brownell default y if USB_ETH 204a7a19facSDavid Brownell default y if USB_G_SERIAL 205a7a19facSDavid Brownell 206193ab2a6SFelipe Balbiconfig USB_R8A66597 207193ab2a6SFelipe Balbi tristate "Renesas R8A66597 USB Peripheral Controller" 208c4144247SYoshihiro Shimoda select USB_GADGET_DUALSPEED 209c4144247SYoshihiro Shimoda help 210c4144247SYoshihiro Shimoda R8A66597 is a discrete USB host and peripheral controller chip that 211c4144247SYoshihiro Shimoda supports both full and high speed USB 2.0 data transfers. 212c4144247SYoshihiro Shimoda It has nine configurable endpoints, and endpoint zero. 213c4144247SYoshihiro Shimoda 214c4144247SYoshihiro Shimoda Say "y" to link the driver statically, or "m" to build a 215c4144247SYoshihiro Shimoda dynamically linked module called "r8a66597_udc" and force all 216c4144247SYoshihiro Shimoda gadget drivers to also be dynamically linked. 217c4144247SYoshihiro Shimoda 218030ed1fcSKuninori Morimotoconfig USB_RENESAS_USBHS_UDC 219193ab2a6SFelipe Balbi tristate 'Renesas USBHS controller' 220193ab2a6SFelipe Balbi depends on SUPERH || ARCH_SHMOBILE 221030ed1fcSKuninori Morimoto depends on USB_RENESAS_USBHS 222030ed1fcSKuninori Morimoto select USB_GADGET_DUALSPEED 2232f98382dSKuninori Morimoto help 224193ab2a6SFelipe Balbi Renesas USBHS is a discrete USB host and peripheral controller chip 225193ab2a6SFelipe Balbi that supports both full and high speed USB 2.0 data transfers. 226193ab2a6SFelipe Balbi It has nine or more configurable endpoints, and endpoint zero. 2272f98382dSKuninori Morimoto 228193ab2a6SFelipe Balbi Say "y" to link the driver statically, or "m" to build a 229193ab2a6SFelipe Balbi dynamically linked module called "renesas_usbhs" and force all 230193ab2a6SFelipe Balbi gadget drivers to also be dynamically linked. 2312f98382dSKuninori Morimoto 232193ab2a6SFelipe Balbiconfig USB_PXA27X 233193ab2a6SFelipe Balbi tristate "PXA 27x" 2349f5351b7SRobert Jarzmik depends on ARCH_PXA && (PXA27x || PXA3xx) 2357fec3c25SRobert Jarzmik select USB_OTG_UTILS 236a7a19facSDavid Brownell help 237a7a19facSDavid Brownell Intel's PXA 27x series XScale ARM v5TE processors include 238a7a19facSDavid Brownell an integrated full speed USB 1.1 device controller. 239a7a19facSDavid Brownell 240a7a19facSDavid Brownell It has up to 23 endpoints, as well as endpoint zero (for 241a7a19facSDavid Brownell control transfers). 242a7a19facSDavid Brownell 243a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 244a7a19facSDavid Brownell dynamically linked module called "pxa27x_udc" and force all 245a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 246a7a19facSDavid Brownell 247193ab2a6SFelipe Balbiconfig USB_S3C_HSOTG 248193ab2a6SFelipe Balbi tristate "S3C HS/OtG USB Device controller" 2495b7d70c6SBen Dooks depends on S3C_DEV_USB_HSOTG 2505b7d70c6SBen Dooks select USB_GADGET_S3C_HSOTG_PIO 2510287e43dSMaurus Cuelenaere select USB_GADGET_DUALSPEED 2525b7d70c6SBen Dooks help 2535b7d70c6SBen Dooks The Samsung S3C64XX USB2.0 high-speed gadget controller 2545b7d70c6SBen Dooks integrated into the S3C64XX series SoC. 2555b7d70c6SBen Dooks 256193ab2a6SFelipe Balbiconfig USB_IMX 257193ab2a6SFelipe Balbi tristate "Freescale IMX USB Peripheral Controller" 258c03e7d4bSPaulius Zaleckas depends on ARCH_MX1 259c03e7d4bSPaulius Zaleckas help 260c03e7d4bSPaulius Zaleckas Freescale's IMX series include an integrated full speed 261c03e7d4bSPaulius Zaleckas USB 1.1 device controller. The controller in the IMX series 262c03e7d4bSPaulius Zaleckas is register-compatible. 263c03e7d4bSPaulius Zaleckas 264c03e7d4bSPaulius Zaleckas It has Six fixed-function endpoints, as well as endpoint 265c03e7d4bSPaulius Zaleckas zero (for control transfers). 266c03e7d4bSPaulius Zaleckas 267c03e7d4bSPaulius Zaleckas Say "y" to link the driver statically, or "m" to build a 268c03e7d4bSPaulius Zaleckas dynamically linked module called "imx_udc" and force all 269c03e7d4bSPaulius Zaleckas gadget drivers to also be dynamically linked. 270c03e7d4bSPaulius Zaleckas 271193ab2a6SFelipe Balbiconfig USB_S3C2410 272193ab2a6SFelipe Balbi tristate "S3C2410 USB Device Controller" 2733fc154b6SArnaud Patard depends on ARCH_S3C2410 2743fc154b6SArnaud Patard help 2753fc154b6SArnaud Patard Samsung's S3C2410 is an ARM-4 processor with an integrated 2763fc154b6SArnaud Patard full speed USB 1.1 device controller. It has 4 configurable 2773fc154b6SArnaud Patard endpoints, as well as endpoint zero (for control transfers). 2783fc154b6SArnaud Patard 2793fc154b6SArnaud Patard This driver has been tested on the S3C2410, S3C2412, and 2803fc154b6SArnaud Patard S3C2440 processors. 2813fc154b6SArnaud Patard 2823fc154b6SArnaud Patardconfig USB_S3C2410_DEBUG 2833fc154b6SArnaud Patard boolean "S3C2410 udc debug messages" 284193ab2a6SFelipe Balbi depends on USB_S3C2410 2853fc154b6SArnaud Patard 286193ab2a6SFelipe Balbiconfig USB_S3C_HSUDC 287193ab2a6SFelipe Balbi tristate "S3C2416, S3C2443 and S3C2450 USB Device Controller" 288a9df304cSThomas Abraham depends on ARCH_S3C2410 289a9df304cSThomas Abraham select USB_GADGET_DUALSPEED 290a9df304cSThomas Abraham help 291a9df304cSThomas Abraham Samsung's S3C2416, S3C2443 and S3C2450 is an ARM9 based SoC 292a9df304cSThomas Abraham integrated with dual speed USB 2.0 device controller. It has 293a9df304cSThomas Abraham 8 endpoints, as well as endpoint zero. 294a9df304cSThomas Abraham 295a9df304cSThomas Abraham This driver has been tested on S3C2416 and S3C2450 processors. 296a9df304cSThomas Abraham 297193ab2a6SFelipe Balbiconfig USB_PXA_U2O 298193ab2a6SFelipe Balbi tristate "PXA9xx Processor USB2.0 controller" 299193ab2a6SFelipe Balbi depends on ARCH_MMP 300e7cddda4Scxie4 select USB_GADGET_DUALSPEED 301e7cddda4Scxie4 help 302e7cddda4Scxie4 PXA9xx Processor series include a high speed USB2.0 device 303e7cddda4Scxie4 controller, which support high speed and full speed USB peripheral. 304e7cddda4Scxie4 305a7a19facSDavid Brownell# 306a7a19facSDavid Brownell# Controllers available in both integrated and discrete versions 307a7a19facSDavid Brownell# 308a7a19facSDavid Brownell 309a7a19facSDavid Brownell# musb builds in ../musb along with host support 310a7a19facSDavid Brownellconfig USB_GADGET_MUSB_HDRC 311193ab2a6SFelipe Balbi tristate "Inventra HDRC USB Peripheral (TI, ADI, ...)" 312a7a19facSDavid Brownell depends on USB_MUSB_HDRC && (USB_MUSB_PERIPHERAL || USB_MUSB_OTG) 313a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 314bae4bd84SDavid Brownell help 315a7a19facSDavid Brownell This OTG-capable silicon IP is used in dual designs including 316085ad406SBryan Wu the TI DaVinci, OMAP 243x, OMAP 343x, TUSB 6010, and ADI Blackfin 317a7a19facSDavid Brownell 318193ab2a6SFelipe Balbiconfig USB_M66592 319193ab2a6SFelipe Balbi tristate "Renesas M66592 USB Peripheral Controller" 320a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 321a7a19facSDavid Brownell help 322a7a19facSDavid Brownell M66592 is a discrete USB peripheral controller chip that 323a7a19facSDavid Brownell supports both full and high speed USB 2.0 data transfers. 324a7a19facSDavid Brownell It has seven configurable endpoints, and endpoint zero. 325bae4bd84SDavid Brownell 326bae4bd84SDavid Brownell Say "y" to link the driver statically, or "m" to build a 327a7a19facSDavid Brownell dynamically linked module called "m66592_udc" and force all 328bae4bd84SDavid Brownell gadget drivers to also be dynamically linked. 329bae4bd84SDavid Brownell 330a7a19facSDavid Brownell# 331a7a19facSDavid Brownell# Controllers available only in discrete form (and all PCI controllers) 332a7a19facSDavid Brownell# 333a7a19facSDavid Brownell 334193ab2a6SFelipe Balbiconfig USB_AMD5536UDC 335193ab2a6SFelipe Balbi tristate "AMD5536 UDC" 336a7a19facSDavid Brownell depends on PCI 337a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 338a7a19facSDavid Brownell help 339a7a19facSDavid Brownell The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge. 340a7a19facSDavid Brownell It is a USB Highspeed DMA capable USB device controller. Beside ep0 341a7a19facSDavid Brownell it provides 4 IN and 4 OUT endpoints (bulk or interrupt type). 342a7a19facSDavid Brownell The UDC port supports OTG operation, and may be used as a host port 343a7a19facSDavid Brownell if it's not being used to implement peripheral or OTG roles. 344a7a19facSDavid Brownell 345a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 346a7a19facSDavid Brownell dynamically linked module called "amd5536udc" and force all 347a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 348a7a19facSDavid Brownell 349193ab2a6SFelipe Balbiconfig USB_FSL_QE 350193ab2a6SFelipe Balbi tristate "Freescale QE/CPM USB Device Controller" 3513948f0e0SLi Yang depends on FSL_SOC && (QUICC_ENGINE || CPM) 3523948f0e0SLi Yang help 3533948f0e0SLi Yang Some of Freescale PowerPC processors have a Full Speed 3543948f0e0SLi Yang QE/CPM2 USB controller, which support device mode with 4 3553948f0e0SLi Yang programmable endpoints. This driver supports the 3563948f0e0SLi Yang controller in the MPC8360 and MPC8272, and should work with 3573948f0e0SLi Yang controllers having QE or CPM2, given minor tweaks. 3583948f0e0SLi Yang 3593948f0e0SLi Yang Set CONFIG_USB_GADGET to "m" to build this driver as a 360692105b8SMatt LaPlante dynamically linked module called "fsl_qe_udc". 3613948f0e0SLi Yang 362193ab2a6SFelipe Balbiconfig USB_CI13XXX_PCI 363193ab2a6SFelipe Balbi tristate "MIPS USB CI13xxx PCI UDC" 364aa69a809SDavid Lopo depends on PCI 365aa69a809SDavid Lopo select USB_GADGET_DUALSPEED 366aa69a809SDavid Lopo help 367aa69a809SDavid Lopo MIPS USB IP core family device controller 368aa69a809SDavid Lopo Currently it only supports IP part number CI13412 369aa69a809SDavid Lopo 370aa69a809SDavid Lopo Say "y" to link the driver statically, or "m" to build a 371aa69a809SDavid Lopo dynamically linked module called "ci13xxx_udc" and force all 372aa69a809SDavid Lopo gadget drivers to also be dynamically linked. 373aa69a809SDavid Lopo 374193ab2a6SFelipe Balbiconfig USB_NET2272 375193ab2a6SFelipe Balbi tristate "PLX NET2272" 376ceb80363SSeth Levy select USB_GADGET_DUALSPEED 377ceb80363SSeth Levy help 378ceb80363SSeth Levy PLX NET2272 is a USB peripheral controller which supports 379ceb80363SSeth Levy both full and high speed USB 2.0 data transfers. 380ceb80363SSeth Levy 381ceb80363SSeth Levy It has three configurable endpoints, as well as endpoint zero 382ceb80363SSeth Levy (for control transfer). 383ceb80363SSeth Levy Say "y" to link the driver statically, or "m" to build a 384ceb80363SSeth Levy dynamically linked module called "net2272" and force all 385ceb80363SSeth Levy gadget drivers to also be dynamically linked. 386ceb80363SSeth Levy 387193ab2a6SFelipe Balbiconfig USB_NET2272_DMA 388ceb80363SSeth Levy boolean "Support external DMA controller" 389193ab2a6SFelipe Balbi depends on USB_NET2272 390ceb80363SSeth Levy help 391ceb80363SSeth Levy The NET2272 part can optionally support an external DMA 392ceb80363SSeth Levy controller, but your board has to have support in the 393ceb80363SSeth Levy driver itself. 394ceb80363SSeth Levy 395ceb80363SSeth Levy If unsure, say "N" here. The driver works fine in PIO mode. 396ceb80363SSeth Levy 397193ab2a6SFelipe Balbiconfig USB_NET2280 398193ab2a6SFelipe Balbi tristate "NetChip 228x" 399a7a19facSDavid Brownell depends on PCI 400a7a19facSDavid Brownell select USB_GADGET_DUALSPEED 401a7a19facSDavid Brownell help 402a7a19facSDavid Brownell NetChip 2280 / 2282 is a PCI based USB peripheral controller which 403a7a19facSDavid Brownell supports both full and high speed USB 2.0 data transfers. 404a7a19facSDavid Brownell 405a7a19facSDavid Brownell It has six configurable endpoints, as well as endpoint zero 406a7a19facSDavid Brownell (for control transfers) and several endpoints with dedicated 407a7a19facSDavid Brownell functions. 408a7a19facSDavid Brownell 409a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 410a7a19facSDavid Brownell dynamically linked module called "net2280" and force all 411a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 412a7a19facSDavid Brownell 413193ab2a6SFelipe Balbiconfig USB_GOKU 414193ab2a6SFelipe Balbi tristate "Toshiba TC86C001 'Goku-S'" 415a7a19facSDavid Brownell depends on PCI 416a7a19facSDavid Brownell help 417a7a19facSDavid Brownell The Toshiba TC86C001 is a PCI device which includes controllers 418a7a19facSDavid Brownell for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI). 419a7a19facSDavid Brownell 420a7a19facSDavid Brownell The device controller has three configurable (bulk or interrupt) 421a7a19facSDavid Brownell endpoints, plus endpoint zero (for control transfers). 422a7a19facSDavid Brownell 423a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 424a7a19facSDavid Brownell dynamically linked module called "goku_udc" and to force all 425a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 426a7a19facSDavid Brownell 427193ab2a6SFelipe Balbiconfig USB_LANGWELL 428193ab2a6SFelipe Balbi tristate "Intel Langwell USB Device Controller" 4295be19a9dSXiaochen Shen depends on PCI 4305be19a9dSXiaochen Shen select USB_GADGET_DUALSPEED 4315be19a9dSXiaochen Shen help 4325be19a9dSXiaochen Shen Intel Langwell USB Device Controller is a High-Speed USB 4335be19a9dSXiaochen Shen On-The-Go device controller. 4345be19a9dSXiaochen Shen 4355be19a9dSXiaochen Shen The number of programmable endpoints is different through 4365be19a9dSXiaochen Shen controller revision. 4375be19a9dSXiaochen Shen 4385be19a9dSXiaochen Shen Say "y" to link the driver statically, or "m" to build a 4395be19a9dSXiaochen Shen dynamically linked module called "langwell_udc" and force all 4405be19a9dSXiaochen Shen gadget drivers to also be dynamically linked. 4415be19a9dSXiaochen Shen 442193ab2a6SFelipe Balbiconfig USB_EG20T 443193ab2a6SFelipe Balbi tristate "Intel EG20T PCH/OKI SEMICONDUCTOR ML7213 IOH UDC" 444f646cf94SToshiharu Okada depends on PCI 445f646cf94SToshiharu Okada select USB_GADGET_DUALSPEED 446f646cf94SToshiharu Okada help 447f646cf94SToshiharu Okada This is a USB device driver for EG20T PCH. 448f646cf94SToshiharu Okada EG20T PCH is the platform controller hub that is used in Intel's 449f646cf94SToshiharu Okada general embedded platform. EG20T PCH has USB device interface. 450f646cf94SToshiharu Okada Using this interface, it is able to access system devices connected 451f646cf94SToshiharu Okada to USB device. 452f646cf94SToshiharu Okada This driver enables USB device function. 453f646cf94SToshiharu Okada USB device is a USB peripheral controller which 454f646cf94SToshiharu Okada supports both full and high speed USB 2.0 data transfers. 455f646cf94SToshiharu Okada This driver supports both control transfer and bulk transfer modes. 456f646cf94SToshiharu Okada This driver dose not support interrupt transfer or isochronous 457f646cf94SToshiharu Okada transfer modes. 458f646cf94SToshiharu Okada 45906f1b971STomoya MORINAGA This driver also can be used for OKI SEMICONDUCTOR's ML7213 which is 46006f1b971STomoya MORINAGA for IVI(In-Vehicle Infotainment) use. 46106f1b971STomoya MORINAGA ML7213 is companion chip for Intel Atom E6xx series. 46206f1b971STomoya MORINAGA ML7213 is completely compatible for Intel EG20T PCH. 46306f1b971STomoya MORINAGA 464193ab2a6SFelipe Balbiconfig USB_CI13XXX_MSM 465193ab2a6SFelipe Balbi tristate "MIPS USB CI13xxx for MSM" 46633f82f38SPavankumar Kondeti depends on ARCH_MSM 46733f82f38SPavankumar Kondeti select USB_GADGET_DUALSPEED 468dfb2130cSPavankumar Kondeti select USB_MSM_OTG 46933f82f38SPavankumar Kondeti help 47033f82f38SPavankumar Kondeti MSM SoC has chipidea USB controller. This driver uses 47133f82f38SPavankumar Kondeti ci13xxx_udc core. 47233f82f38SPavankumar Kondeti This driver depends on OTG driver for PHY initialization, 47333f82f38SPavankumar Kondeti clock management, powering up VBUS, and power management. 4748cf28f1fSPavankumar Kondeti This driver is not supported on boards like trout which 4758cf28f1fSPavankumar Kondeti has an external PHY. 47633f82f38SPavankumar Kondeti 47733f82f38SPavankumar Kondeti Say "y" to link the driver statically, or "m" to build a 47833f82f38SPavankumar Kondeti dynamically linked module called "ci13xxx_msm" and force all 47933f82f38SPavankumar Kondeti gadget drivers to also be dynamically linked. 48033f82f38SPavankumar Kondeti 481a7a19facSDavid Brownell# 482a7a19facSDavid Brownell# LAST -- dummy/emulated controller 483a7a19facSDavid Brownell# 4841da177e4SLinus Torvalds 485193ab2a6SFelipe Balbiconfig USB_DUMMY_HCD 486193ab2a6SFelipe Balbi tristate "Dummy HCD (DEVELOPMENT)" 487afd0e0f2SRobert P. J. Day depends on USB=y || (USB=m && USB_GADGET=m) 4881da177e4SLinus Torvalds select USB_GADGET_DUALSPEED 4891cd8fd28STatyana Brokhman select USB_GADGET_SUPERSPEED 4901da177e4SLinus Torvalds help 4911da177e4SLinus Torvalds This host controller driver emulates USB, looping all data transfer 4921da177e4SLinus Torvalds requests back to a USB "gadget driver" in the same host. The host 4931da177e4SLinus Torvalds side is the master; the gadget side is the slave. Gadget drivers 4941da177e4SLinus Torvalds can be high, full, or low speed; and they have access to endpoints 4951da177e4SLinus Torvalds like those from NET2280, PXA2xx, or SA1100 hardware. 4961da177e4SLinus Torvalds 4971da177e4SLinus Torvalds This may help in some stages of creating a driver to embed in a 4981da177e4SLinus Torvalds Linux device, since it lets you debug several parts of the gadget 4991da177e4SLinus Torvalds driver without its hardware or drivers being involved. 5001da177e4SLinus Torvalds 5011da177e4SLinus Torvalds Since such a gadget side driver needs to interoperate with a host 5021da177e4SLinus Torvalds side Linux-USB device driver, this may help to debug both sides 5031da177e4SLinus Torvalds of a USB protocol stack. 5041da177e4SLinus Torvalds 5051da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 5061da177e4SLinus Torvalds dynamically linked module called "dummy_hcd" and force all 5071da177e4SLinus Torvalds gadget drivers to also be dynamically linked. 5081da177e4SLinus Torvalds 5091da177e4SLinus Torvalds# NOTE: Please keep dummy_hcd LAST so that "real hardware" appears 5101da177e4SLinus Torvalds# first and will be selected by default. 5111da177e4SLinus Torvalds 5121da177e4SLinus Torvaldsendchoice 5131da177e4SLinus Torvalds 51497b2f900SAlan Stern# Selected by UDC drivers that support high-speed operation. 5151da177e4SLinus Torvaldsconfig USB_GADGET_DUALSPEED 5161da177e4SLinus Torvalds bool 5171da177e4SLinus Torvalds depends on USB_GADGET 5181da177e4SLinus Torvalds 519bdb64d72STatyana Brokhman# Selected by UDC drivers that support super-speed opperation 520bdb64d72STatyana Brokhmanconfig USB_GADGET_SUPERSPEED 521bdb64d72STatyana Brokhman bool 522bdb64d72STatyana Brokhman depends on USB_GADGET 523bdb64d72STatyana Brokhman depends on USB_GADGET_DUALSPEED 524bdb64d72STatyana Brokhman 5251da177e4SLinus Torvalds# 5261da177e4SLinus Torvalds# USB Gadget Drivers 5271da177e4SLinus Torvalds# 5281da177e4SLinus Torvaldschoice 5291da177e4SLinus Torvalds tristate "USB Gadget Drivers" 530193ab2a6SFelipe Balbi depends on USB_GADGET 5311da177e4SLinus Torvalds default USB_ETH 5321da177e4SLinus Torvalds help 5331da177e4SLinus Torvalds A Linux "Gadget Driver" talks to the USB Peripheral Controller 5341da177e4SLinus Torvalds driver through the abstract "gadget" API. Some other operating 5351da177e4SLinus Torvalds systems call these "client" drivers, of which "class drivers" 5361da177e4SLinus Torvalds are a subset (implementing a USB device class specification). 5371da177e4SLinus Torvalds A gadget driver implements one or more USB functions using 5381da177e4SLinus Torvalds the peripheral hardware. 5391da177e4SLinus Torvalds 5401da177e4SLinus Torvalds Gadget drivers are hardware-neutral, or "platform independent", 5411da177e4SLinus Torvalds except that they sometimes must understand quirks or limitations 5421da177e4SLinus Torvalds of the particular controllers they work with. For example, when 5431da177e4SLinus Torvalds a controller doesn't support alternate configurations or provide 5441da177e4SLinus Torvalds enough of the right types of endpoints, the gadget driver might 5451da177e4SLinus Torvalds not be able work with that controller, or might need to implement 5461da177e4SLinus Torvalds a less common variant of a device class protocol. 5471da177e4SLinus Torvalds 5481da177e4SLinus Torvalds# this first set of drivers all depend on bulk-capable hardware. 5491da177e4SLinus Torvalds 5501da177e4SLinus Torvaldsconfig USB_ZERO 5511da177e4SLinus Torvalds tristate "Gadget Zero (DEVELOPMENT)" 5521da177e4SLinus Torvalds help 5531da177e4SLinus Torvalds Gadget Zero is a two-configuration device. It either sinks and 5541da177e4SLinus Torvalds sources bulk data; or it loops back a configurable number of 5551da177e4SLinus Torvalds transfers. It also implements control requests, for "chapter 9" 5561da177e4SLinus Torvalds conformance. The driver needs only two bulk-capable endpoints, so 5571da177e4SLinus Torvalds it can work on top of most device-side usb controllers. It's 5581da177e4SLinus Torvalds useful for testing, and is also a working example showing how 5591da177e4SLinus Torvalds USB "gadget drivers" can be written. 5601da177e4SLinus Torvalds 5611da177e4SLinus Torvalds Make this be the first driver you try using on top of any new 5621da177e4SLinus Torvalds USB peripheral controller driver. Then you can use host-side 5631da177e4SLinus Torvalds test software, like the "usbtest" driver, to put your hardware 5641da177e4SLinus Torvalds and its driver through a basic set of functional tests. 5651da177e4SLinus Torvalds 5661da177e4SLinus Torvalds Gadget Zero also works with the host-side "usb-skeleton" driver, 5671da177e4SLinus Torvalds and with many kinds of host-side test software. You may need 5681da177e4SLinus Torvalds to tweak product and vendor IDs before host software knows about 5691da177e4SLinus Torvalds this device, and arrange to select an appropriate configuration. 5701da177e4SLinus Torvalds 5711da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 5721da177e4SLinus Torvalds dynamically linked module called "g_zero". 5731da177e4SLinus Torvalds 5741da177e4SLinus Torvaldsconfig USB_ZERO_HNPTEST 5751da177e4SLinus Torvalds boolean "HNP Test Device" 5761da177e4SLinus Torvalds depends on USB_ZERO && USB_OTG 5771da177e4SLinus Torvalds help 5781da177e4SLinus Torvalds You can configure this device to enumerate using the device 5791da177e4SLinus Torvalds identifiers of the USB-OTG test device. That means that when 5801da177e4SLinus Torvalds this gadget connects to another OTG device, with this one using 5811da177e4SLinus Torvalds the "B-Peripheral" role, that device will use HNP to let this 5821da177e4SLinus Torvalds one serve as the USB host instead (in the "B-Host" role). 5831da177e4SLinus Torvalds 584c6994e6fSBryan Wuconfig USB_AUDIO 585c6994e6fSBryan Wu tristate "Audio Gadget (EXPERIMENTAL)" 586c6994e6fSBryan Wu depends on SND 58704950737SRandy Dunlap select SND_PCM 588c6994e6fSBryan Wu help 589c6994e6fSBryan Wu Gadget Audio is compatible with USB Audio Class specification 1.0. 590c6994e6fSBryan Wu It will include at least one AudioControl interface, zero or more 591c6994e6fSBryan Wu AudioStream interface and zero or more MIDIStream interface. 592c6994e6fSBryan Wu 593c6994e6fSBryan Wu Gadget Audio will use on-board ALSA (CONFIG_SND) audio card to 594c6994e6fSBryan Wu playback or capture audio stream. 595c6994e6fSBryan Wu 596c6994e6fSBryan Wu Say "y" to link the driver statically, or "m" to build a 597c6994e6fSBryan Wu dynamically linked module called "g_audio". 598c6994e6fSBryan Wu 5991da177e4SLinus Torvaldsconfig USB_ETH 6001da177e4SLinus Torvalds tristate "Ethernet Gadget (with CDC Ethernet support)" 6011da177e4SLinus Torvalds depends on NET 6029e221be8SRandy Dunlap select CRC32 6031da177e4SLinus Torvalds help 6049b39e9ddSBrian Niebuhr This driver implements Ethernet style communication, in one of 6059b39e9ddSBrian Niebuhr several ways: 6061da177e4SLinus Torvalds 6071da177e4SLinus Torvalds - The "Communication Device Class" (CDC) Ethernet Control Model. 6081da177e4SLinus Torvalds That protocol is often avoided with pure Ethernet adapters, in 6091da177e4SLinus Torvalds favor of simpler vendor-specific hardware, but is widely 6101da177e4SLinus Torvalds supported by firmware for smart network devices. 6111da177e4SLinus Torvalds 6121da177e4SLinus Torvalds - On hardware can't implement that protocol, a simple CDC subset 6131da177e4SLinus Torvalds is used, placing fewer demands on USB. 6141da177e4SLinus Torvalds 6159b39e9ddSBrian Niebuhr - CDC Ethernet Emulation Model (EEM) is a newer standard that has 6169b39e9ddSBrian Niebuhr a simpler interface that can be used by more USB hardware. 6179b39e9ddSBrian Niebuhr 6189b39e9ddSBrian Niebuhr RNDIS support is an additional option, more demanding than than 6199b39e9ddSBrian Niebuhr subset. 6201da177e4SLinus Torvalds 6211da177e4SLinus Torvalds Within the USB device, this gadget driver exposes a network device 6221da177e4SLinus Torvalds "usbX", where X depends on what other networking devices you have. 6231da177e4SLinus Torvalds Treat it like a two-node Ethernet link: host, and gadget. 6241da177e4SLinus Torvalds 6251da177e4SLinus Torvalds The Linux-USB host-side "usbnet" driver interoperates with this 6261da177e4SLinus Torvalds driver, so that deep I/O queues can be supported. On 2.4 kernels, 6271da177e4SLinus Torvalds use "CDCEther" instead, if you're using the CDC option. That CDC 6281da177e4SLinus Torvalds mode should also interoperate with standard CDC Ethernet class 6291da177e4SLinus Torvalds drivers on other host operating systems. 6301da177e4SLinus Torvalds 6311da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 6321da177e4SLinus Torvalds dynamically linked module called "g_ether". 6331da177e4SLinus Torvalds 6341da177e4SLinus Torvaldsconfig USB_ETH_RNDIS 635afd0e0f2SRobert P. J. Day bool "RNDIS support" 636afd0e0f2SRobert P. J. Day depends on USB_ETH 6371da177e4SLinus Torvalds default y 6381da177e4SLinus Torvalds help 6391da177e4SLinus Torvalds Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol, 6401da177e4SLinus Torvalds and Microsoft provides redistributable binary RNDIS drivers for 6411da177e4SLinus Torvalds older versions of Windows. 6421da177e4SLinus Torvalds 6431da177e4SLinus Torvalds If you say "y" here, the Ethernet gadget driver will try to provide 6441da177e4SLinus Torvalds a second device configuration, supporting RNDIS to talk to such 6451da177e4SLinus Torvalds Microsoft USB hosts. 6461da177e4SLinus Torvalds 6471da177e4SLinus Torvalds To make MS-Windows work with this, use Documentation/usb/linux.inf 6481da177e4SLinus Torvalds as the "driver info file". For versions of MS-Windows older than 6491da177e4SLinus Torvalds XP, you'll need to download drivers from Microsoft's website; a URL 6501da177e4SLinus Torvalds is given in comments found in that info file. 6511da177e4SLinus Torvalds 6529b39e9ddSBrian Niebuhrconfig USB_ETH_EEM 6539b39e9ddSBrian Niebuhr bool "Ethernet Emulation Model (EEM) support" 6549b39e9ddSBrian Niebuhr depends on USB_ETH 6559b39e9ddSBrian Niebuhr default n 6569b39e9ddSBrian Niebuhr help 6579b39e9ddSBrian Niebuhr CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM 6589b39e9ddSBrian Niebuhr and therefore can be supported by more hardware. Technically ECM and 6599b39e9ddSBrian Niebuhr EEM are designed for different applications. The ECM model extends 6609b39e9ddSBrian Niebuhr the network interface to the target (e.g. a USB cable modem), and the 6619b39e9ddSBrian Niebuhr EEM model is for mobile devices to communicate with hosts using 6629b39e9ddSBrian Niebuhr ethernet over USB. For Linux gadgets, however, the interface with 6639b39e9ddSBrian Niebuhr the host is the same (a usbX device), so the differences are minimal. 6649b39e9ddSBrian Niebuhr 6659b39e9ddSBrian Niebuhr If you say "y" here, the Ethernet gadget driver will use the EEM 6669b39e9ddSBrian Niebuhr protocol rather than ECM. If unsure, say "n". 6679b39e9ddSBrian Niebuhr 6686c34d288SYauheni Kaliutaconfig USB_G_NCM 6696c34d288SYauheni Kaliuta tristate "Network Control Model (NCM) support" 6706c34d288SYauheni Kaliuta depends on NET 6716c34d288SYauheni Kaliuta select CRC32 6726c34d288SYauheni Kaliuta help 6736c34d288SYauheni Kaliuta This driver implements USB CDC NCM subclass standard. NCM is 6746c34d288SYauheni Kaliuta an advanced protocol for Ethernet encapsulation, allows grouping 6756c34d288SYauheni Kaliuta of several ethernet frames into one USB transfer and diffferent 6766c34d288SYauheni Kaliuta alignment possibilities. 6776c34d288SYauheni Kaliuta 6786c34d288SYauheni Kaliuta Say "y" to link the driver statically, or "m" to build a 6796c34d288SYauheni Kaliuta dynamically linked module called "g_ncm". 6806c34d288SYauheni Kaliuta 6811da177e4SLinus Torvaldsconfig USB_GADGETFS 6821da177e4SLinus Torvalds tristate "Gadget Filesystem (EXPERIMENTAL)" 6831da177e4SLinus Torvalds depends on EXPERIMENTAL 6841da177e4SLinus Torvalds help 6851da177e4SLinus Torvalds This driver provides a filesystem based API that lets user mode 6861da177e4SLinus Torvalds programs implement a single-configuration USB device, including 6871da177e4SLinus Torvalds endpoint I/O and control requests that don't relate to enumeration. 6881da177e4SLinus Torvalds All endpoints, transfer speeds, and transfer types supported by 6891da177e4SLinus Torvalds the hardware are available, through read() and write() calls. 6901da177e4SLinus Torvalds 691afd0e0f2SRobert P. J. Day Currently, this option is still labelled as EXPERIMENTAL because 692afd0e0f2SRobert P. J. Day of existing race conditions in the underlying in-kernel AIO core. 693afd0e0f2SRobert P. J. Day 6941da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 6951da177e4SLinus Torvalds dynamically linked module called "gadgetfs". 6961da177e4SLinus Torvalds 697c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS 698c6c56008SMichal Nazarewicz tristate "Function Filesystem (EXPERIMENTAL)" 699c6c56008SMichal Nazarewicz depends on EXPERIMENTAL 700f8dae531SMichal Nazarewicz select USB_FUNCTIONFS_GENERIC if !(USB_FUNCTIONFS_ETH || USB_FUNCTIONFS_RNDIS) 701c6c56008SMichal Nazarewicz help 702eabf0f5fSMichael Prokop The Function Filesystem (FunctionFS) lets one create USB 703eabf0f5fSMichael Prokop composite functions in user space in the same way GadgetFS 704c6c56008SMichal Nazarewicz lets one create USB gadgets in user space. This allows creation 705c6c56008SMichal Nazarewicz of composite gadgets such that some of the functions are 706c6c56008SMichal Nazarewicz implemented in kernel space (for instance Ethernet, serial or 707c6c56008SMichal Nazarewicz mass storage) and other are implemented in user space. 708c6c56008SMichal Nazarewicz 709f8dae531SMichal Nazarewicz If you say "y" or "m" here you will be able what kind of 710f8dae531SMichal Nazarewicz configurations the gadget will provide. 711f8dae531SMichal Nazarewicz 712c6c56008SMichal Nazarewicz Say "y" to link the driver statically, or "m" to build 713c6c56008SMichal Nazarewicz a dynamically linked module called "g_ffs". 714c6c56008SMichal Nazarewicz 715c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_ETH 716f8dae531SMichal Nazarewicz bool "Include configuration with CDC ECM (Ethernet)" 71717b2765eSRandy Dunlap depends on USB_FUNCTIONFS && NET 718c6c56008SMichal Nazarewicz help 719eabf0f5fSMichael Prokop Include a configuration with CDC ECM function (Ethernet) and the 720eabf0f5fSMichael Prokop Function Filesystem. 721c6c56008SMichal Nazarewicz 722c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_RNDIS 723f8dae531SMichal Nazarewicz bool "Include configuration with RNDIS (Ethernet)" 72417b2765eSRandy Dunlap depends on USB_FUNCTIONFS && NET 725c6c56008SMichal Nazarewicz help 726eabf0f5fSMichael Prokop Include a configuration with RNDIS function (Ethernet) and the Filesystem. 727c6c56008SMichal Nazarewicz 728c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_GENERIC 729c6c56008SMichal Nazarewicz bool "Include 'pure' configuration" 730f8dae531SMichal Nazarewicz depends on USB_FUNCTIONFS 731c6c56008SMichal Nazarewicz help 732f8dae531SMichal Nazarewicz Include a configuration with the Function Filesystem alone with 733f8dae531SMichal Nazarewicz no Ethernet interface. 734c6c56008SMichal Nazarewicz 7351da177e4SLinus Torvaldsconfig USB_FILE_STORAGE 736664a51a8SAlan Stern tristate "File-backed Storage Gadget (DEPRECATED)" 73787840289SRandy Dunlap depends on BLOCK 7381da177e4SLinus Torvalds help 7391da177e4SLinus Torvalds The File-backed Storage Gadget acts as a USB Mass Storage 7401da177e4SLinus Torvalds disk drive. As its storage repository it can use a regular 7411da177e4SLinus Torvalds file or a block device (in much the same way as the "loop" 7421da177e4SLinus Torvalds device driver), specified as a module parameter. 7431da177e4SLinus Torvalds 7441da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 7451da177e4SLinus Torvalds dynamically linked module called "g_file_storage". 7461da177e4SLinus Torvalds 747664a51a8SAlan Stern NOTE: This driver is deprecated. Its replacement is the 748664a51a8SAlan Stern Mass Storage Gadget. 749664a51a8SAlan Stern 7501da177e4SLinus Torvaldsconfig USB_FILE_STORAGE_TEST 7511da177e4SLinus Torvalds bool "File-backed Storage Gadget testing version" 7521da177e4SLinus Torvalds depends on USB_FILE_STORAGE 7531da177e4SLinus Torvalds default n 7541da177e4SLinus Torvalds help 7551da177e4SLinus Torvalds Say "y" to generate the larger testing version of the 7561da177e4SLinus Torvalds File-backed Storage Gadget, useful for probing the 7571da177e4SLinus Torvalds behavior of USB Mass Storage hosts. Not needed for 7581da177e4SLinus Torvalds normal operation. 7591da177e4SLinus Torvalds 760d23b0f08SMichal Nazarewiczconfig USB_MASS_STORAGE 761d23b0f08SMichal Nazarewicz tristate "Mass Storage Gadget" 762d23b0f08SMichal Nazarewicz depends on BLOCK 763d23b0f08SMichal Nazarewicz help 764d23b0f08SMichal Nazarewicz The Mass Storage Gadget acts as a USB Mass Storage disk drive. 765d23b0f08SMichal Nazarewicz As its storage repository it can use a regular file or a block 766d23b0f08SMichal Nazarewicz device (in much the same way as the "loop" device driver), 767d23b0f08SMichal Nazarewicz specified as a module parameter or sysfs option. 768d23b0f08SMichal Nazarewicz 769664a51a8SAlan Stern This driver is an updated replacement for the deprecated 770664a51a8SAlan Stern File-backed Storage Gadget (g_file_storage). 771d23b0f08SMichal Nazarewicz 772d23b0f08SMichal Nazarewicz Say "y" to link the driver statically, or "m" to build 773664a51a8SAlan Stern a dynamically linked module called "g_mass_storage". 774d23b0f08SMichal Nazarewicz 7751da177e4SLinus Torvaldsconfig USB_G_SERIAL 7763086775aSFelipe Balbi tristate "Serial Gadget (with CDC ACM and CDC OBEX support)" 7771da177e4SLinus Torvalds help 7781da177e4SLinus Torvalds The Serial Gadget talks to the Linux-USB generic serial driver. 7791da177e4SLinus Torvalds This driver supports a CDC-ACM module option, which can be used 7801da177e4SLinus Torvalds to interoperate with MS-Windows hosts or with the Linux-USB 7811da177e4SLinus Torvalds "cdc-acm" driver. 7821da177e4SLinus Torvalds 7833086775aSFelipe Balbi This driver also supports a CDC-OBEX option. You will need a 7843086775aSFelipe Balbi user space OBEX server talking to /dev/ttyGS*, since the kernel 7853086775aSFelipe Balbi itself doesn't implement the OBEX protocol. 7863086775aSFelipe Balbi 7871da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 7881da177e4SLinus Torvalds dynamically linked module called "g_serial". 7891da177e4SLinus Torvalds 7901da177e4SLinus Torvalds For more information, see Documentation/usb/gadget_serial.txt 7911da177e4SLinus Torvalds which includes instructions and a "driver info file" needed to 7923086775aSFelipe Balbi make MS-Windows work with CDC ACM. 7931da177e4SLinus Torvalds 794f2ebf92cSBen Williamsonconfig USB_MIDI_GADGET 795f2ebf92cSBen Williamson tristate "MIDI Gadget (EXPERIMENTAL)" 796f2ebf92cSBen Williamson depends on SND && EXPERIMENTAL 797f2ebf92cSBen Williamson select SND_RAWMIDI 798f2ebf92cSBen Williamson help 799f2ebf92cSBen Williamson The MIDI Gadget acts as a USB Audio device, with one MIDI 800f2ebf92cSBen Williamson input and one MIDI output. These MIDI jacks appear as 801f2ebf92cSBen Williamson a sound "card" in the ALSA sound system. Other MIDI 802f2ebf92cSBen Williamson connections can then be made on the gadget system, using 803f2ebf92cSBen Williamson ALSA's aconnect utility etc. 804f2ebf92cSBen Williamson 805f2ebf92cSBen Williamson Say "y" to link the driver statically, or "m" to build a 806f2ebf92cSBen Williamson dynamically linked module called "g_midi". 807f2ebf92cSBen Williamson 80825a010c8SCraig W. Nadlerconfig USB_G_PRINTER 80925a010c8SCraig W. Nadler tristate "Printer Gadget" 81025a010c8SCraig W. Nadler help 81125a010c8SCraig W. Nadler The Printer Gadget channels data between the USB host and a 81225a010c8SCraig W. Nadler userspace program driving the print engine. The user space 81325a010c8SCraig W. Nadler program reads and writes the device file /dev/g_printer to 81425a010c8SCraig W. Nadler receive or send printer data. It can use ioctl calls to 81525a010c8SCraig W. Nadler the device file to get or set printer status. 81625a010c8SCraig W. Nadler 81725a010c8SCraig W. Nadler Say "y" to link the driver statically, or "m" to build a 81825a010c8SCraig W. Nadler dynamically linked module called "g_printer". 81925a010c8SCraig W. Nadler 82025a010c8SCraig W. Nadler For more information, see Documentation/usb/gadget_printer.txt 82125a010c8SCraig W. Nadler which includes sample code for accessing the device file. 8221da177e4SLinus Torvalds 82319e20680SDavid Brownellconfig USB_CDC_COMPOSITE 82419e20680SDavid Brownell tristate "CDC Composite Device (Ethernet and ACM)" 8254ddd9ec1SRandy Dunlap depends on NET 82619e20680SDavid Brownell help 82719e20680SDavid Brownell This driver provides two functions in one configuration: 82819e20680SDavid Brownell a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link. 82919e20680SDavid Brownell 83019e20680SDavid Brownell This driver requires four bulk and two interrupt endpoints, 83119e20680SDavid Brownell plus the ability to handle altsettings. Not all peripheral 83219e20680SDavid Brownell controllers are that capable. 83319e20680SDavid Brownell 83419e20680SDavid Brownell Say "y" to link the driver statically, or "m" to build a 83519e20680SDavid Brownell dynamically linked module. 83619e20680SDavid Brownell 837f358f5b4SFelipe Balbiconfig USB_G_NOKIA 838f358f5b4SFelipe Balbi tristate "Nokia composite gadget" 839f358f5b4SFelipe Balbi depends on PHONET 840f358f5b4SFelipe Balbi help 841f358f5b4SFelipe Balbi The Nokia composite gadget provides support for acm, obex 842f358f5b4SFelipe Balbi and phonet in only one composite gadget driver. 843f358f5b4SFelipe Balbi 844f358f5b4SFelipe Balbi It's only really useful for N900 hardware. If you're building 845f358f5b4SFelipe Balbi a kernel for N900, say Y or M here. If unsure, say N. 846f358f5b4SFelipe Balbi 847f176a5d8SMichal Nazarewiczconfig USB_G_MULTI 848f176a5d8SMichal Nazarewicz tristate "Multifunction Composite Gadget (EXPERIMENTAL)" 8495791e103SRandy Dunlap depends on BLOCK && NET 850279cc49aSMichal Nazarewicz select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS 851f176a5d8SMichal Nazarewicz help 852f176a5d8SMichal Nazarewicz The Multifunction Composite Gadget provides Ethernet (RNDIS 853f176a5d8SMichal Nazarewicz and/or CDC Ethernet), mass storage and ACM serial link 854f176a5d8SMichal Nazarewicz interfaces. 855f176a5d8SMichal Nazarewicz 8565791e103SRandy Dunlap You will be asked to choose which of the two configurations is 857f176a5d8SMichal Nazarewicz to be available in the gadget. At least one configuration must 8585791e103SRandy Dunlap be chosen to make the gadget usable. Selecting more than one 859f176a5d8SMichal Nazarewicz configuration will prevent Windows from automatically detecting 8605791e103SRandy Dunlap the gadget as a composite gadget, so an INF file will be needed to 861f176a5d8SMichal Nazarewicz use the gadget. 862f176a5d8SMichal Nazarewicz 863f176a5d8SMichal Nazarewicz Say "y" to link the driver statically, or "m" to build a 864f176a5d8SMichal Nazarewicz dynamically linked module called "g_multi". 865f176a5d8SMichal Nazarewicz 866f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_RNDIS 867f176a5d8SMichal Nazarewicz bool "RNDIS + CDC Serial + Storage configuration" 868f176a5d8SMichal Nazarewicz depends on USB_G_MULTI 869f176a5d8SMichal Nazarewicz default y 870f176a5d8SMichal Nazarewicz help 871f176a5d8SMichal Nazarewicz This option enables a configuration with RNDIS, CDC Serial and 872f176a5d8SMichal Nazarewicz Mass Storage functions available in the Multifunction Composite 8735791e103SRandy Dunlap Gadget. This is the configuration dedicated for Windows since RNDIS 8745791e103SRandy Dunlap is Microsoft's protocol. 875f176a5d8SMichal Nazarewicz 876f176a5d8SMichal Nazarewicz If unsure, say "y". 877f176a5d8SMichal Nazarewicz 878f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_CDC 879f176a5d8SMichal Nazarewicz bool "CDC Ethernet + CDC Serial + Storage configuration" 880f176a5d8SMichal Nazarewicz depends on USB_G_MULTI 881f176a5d8SMichal Nazarewicz default n 882f176a5d8SMichal Nazarewicz help 883f176a5d8SMichal Nazarewicz This option enables a configuration with CDC Ethernet (ECM), CDC 884f176a5d8SMichal Nazarewicz Serial and Mass Storage functions available in the Multifunction 8855791e103SRandy Dunlap Composite Gadget. 886f176a5d8SMichal Nazarewicz 887f176a5d8SMichal Nazarewicz If unsure, say "y". 888f176a5d8SMichal Nazarewicz 88971adf118SFabien Chouteauconfig USB_G_HID 89071adf118SFabien Chouteau tristate "HID Gadget" 89171adf118SFabien Chouteau help 89271adf118SFabien Chouteau The HID gadget driver provides generic emulation of USB 89371adf118SFabien Chouteau Human Interface Devices (HID). 89471adf118SFabien Chouteau 89571adf118SFabien Chouteau For more information, see Documentation/usb/gadget_hid.txt which 89671adf118SFabien Chouteau includes sample code for accessing the device files. 89771adf118SFabien Chouteau 89871adf118SFabien Chouteau Say "y" to link the driver statically, or "m" to build a 89971adf118SFabien Chouteau dynamically linked module called "g_hid". 900f176a5d8SMichal Nazarewicz 901f6c826a9Sstephane duvergerconfig USB_G_DBGP 902f6c826a9Sstephane duverger tristate "EHCI Debug Device Gadget" 903f6c826a9Sstephane duverger help 904f6c826a9Sstephane duverger This gadget emulates an EHCI Debug device. This is useful when you want 905f6c826a9Sstephane duverger to interact with an EHCI Debug Port. 906f6c826a9Sstephane duverger 907f6c826a9Sstephane duverger Say "y" to link the driver statically, or "m" to build a 908f6c826a9Sstephane duverger dynamically linked module called "g_dbgp". 909f6c826a9Sstephane duverger 910f6c826a9Sstephane duvergerif USB_G_DBGP 911f6c826a9Sstephane duvergerchoice 912f6c826a9Sstephane duverger prompt "EHCI Debug Device mode" 913f6c826a9Sstephane duverger default USB_G_DBGP_SERIAL 914f6c826a9Sstephane duverger 915f6c826a9Sstephane duvergerconfig USB_G_DBGP_PRINTK 916f6c826a9Sstephane duverger depends on USB_G_DBGP 917f6c826a9Sstephane duverger bool "printk" 918f6c826a9Sstephane duverger help 919f6c826a9Sstephane duverger Directly printk() received data. No interaction. 920f6c826a9Sstephane duverger 921f6c826a9Sstephane duvergerconfig USB_G_DBGP_SERIAL 922f6c826a9Sstephane duverger depends on USB_G_DBGP 923f6c826a9Sstephane duverger bool "serial" 924f6c826a9Sstephane duverger help 925f6c826a9Sstephane duverger Userland can interact using /dev/ttyGSxxx. 926f6c826a9Sstephane duvergerendchoice 927f6c826a9Sstephane duvergerendif 928f6c826a9Sstephane duverger 9291da177e4SLinus Torvalds# put drivers that need isochronous transfer support (for audio 9301da177e4SLinus Torvalds# or video class gadget drivers), or specific hardware, here. 931a9914127SLaurent Pinchartconfig USB_G_WEBCAM 932a9914127SLaurent Pinchart tristate "USB Webcam Gadget" 93324337c13SRandy Dunlap depends on VIDEO_DEV 934a9914127SLaurent Pinchart help 935a9914127SLaurent Pinchart The Webcam Gadget acts as a composite USB Audio and Video Class 936a9914127SLaurent Pinchart device. It provides a userspace API to process UVC control requests 937a9914127SLaurent Pinchart and stream video data to the host. 9381da177e4SLinus Torvalds 939a9914127SLaurent Pinchart Say "y" to link the driver statically, or "m" to build a 940a9914127SLaurent Pinchart dynamically linked module called "g_webcam". 9411da177e4SLinus Torvalds 9421da177e4SLinus Torvaldsendchoice 9431da177e4SLinus Torvalds 944b75be4abSDenis Chengendif # USB_GADGET 945