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" 1886dc243cSAlan Stern select NLS 191da177e4SLinus Torvalds help 201da177e4SLinus Torvalds USB is a master/slave protocol, organized with one master 211da177e4SLinus Torvalds host (such as a PC) controlling up to 127 peripheral devices. 221da177e4SLinus Torvalds The USB hardware is asymmetric, which makes it easier to set up: 231da177e4SLinus Torvalds you can't connect a "to-the-host" connector to a peripheral. 241da177e4SLinus Torvalds 251da177e4SLinus Torvalds Linux can run in the host, or in the peripheral. In both cases 261da177e4SLinus Torvalds you need a low level bus controller driver, and some software 271da177e4SLinus Torvalds talking to it. Peripheral controllers are often discrete silicon, 281da177e4SLinus Torvalds or are integrated with the CPU in a microcontroller. The more 29e113f29cSJules Villard familiar host side controllers have names like "EHCI", "OHCI", 301da177e4SLinus Torvalds or "UHCI", and are usually integrated into southbridges on PC 311da177e4SLinus Torvalds motherboards. 321da177e4SLinus Torvalds 331da177e4SLinus Torvalds Enable this configuration option if you want to run Linux inside 341da177e4SLinus Torvalds a USB peripheral device. Configure one hardware driver for your 351da177e4SLinus Torvalds peripheral/device side bus controller, and a "gadget driver" for 361da177e4SLinus Torvalds your peripheral protocol. (If you use modular gadget drivers, 371da177e4SLinus Torvalds you may configure more than one.) 381da177e4SLinus Torvalds 391da177e4SLinus Torvalds If in doubt, say "N" and don't enable these drivers; most people 401da177e4SLinus Torvalds don't have this kind of hardware (except maybe inside Linux PDAs). 411da177e4SLinus Torvalds 421da177e4SLinus Torvalds For more information, see <http://www.linux-usb.org/gadget> and 431da177e4SLinus Torvalds the kernel DocBook documentation for this API. 441da177e4SLinus Torvalds 45b75be4abSDenis Chengif USB_GADGET 46b75be4abSDenis Cheng 4770790f63SDavid Brownellconfig USB_GADGET_DEBUG 48afd0e0f2SRobert P. J. Day boolean "Debugging messages (DEVELOPMENT)" 4936e893d2SDavid Brownell depends on DEBUG_KERNEL 5070790f63SDavid Brownell help 5170790f63SDavid Brownell Many controller and gadget drivers will print some debugging 5270790f63SDavid Brownell messages if you use this option to ask for those messages. 5370790f63SDavid Brownell 5470790f63SDavid Brownell Avoid enabling these messages, even if you're actively 5570790f63SDavid Brownell debugging such a driver. Many drivers will emit so many 5670790f63SDavid Brownell messages that the driver timings are affected, which will 5770790f63SDavid Brownell either create new failure modes or remove the one you're 5870790f63SDavid Brownell trying to track down. Never enable these messages for a 5970790f63SDavid Brownell production build. 6070790f63SDavid Brownell 611da177e4SLinus Torvaldsconfig USB_GADGET_DEBUG_FILES 62afd0e0f2SRobert P. J. Day boolean "Debugging information files (DEVELOPMENT)" 6336e893d2SDavid Brownell depends on PROC_FS 641da177e4SLinus Torvalds help 651da177e4SLinus Torvalds Some of the drivers in the "gadget" framework can expose 661da177e4SLinus Torvalds debugging information in files such as /proc/driver/udc 671da177e4SLinus Torvalds (for a peripheral controller). The information in these 681da177e4SLinus Torvalds files may help when you're troubleshooting or bringing up a 691da177e4SLinus Torvalds driver on a new board. Enable these files by choosing "Y" 701da177e4SLinus Torvalds here. If in doubt, or to conserve kernel memory, say "N". 711da177e4SLinus Torvalds 72914a3f3bSHaavard Skinnemoenconfig USB_GADGET_DEBUG_FS 73afd0e0f2SRobert P. J. Day boolean "Debugging information files in debugfs (DEVELOPMENT)" 7436e893d2SDavid Brownell depends on DEBUG_FS 75914a3f3bSHaavard Skinnemoen help 76914a3f3bSHaavard Skinnemoen Some of the drivers in the "gadget" framework can expose 77914a3f3bSHaavard Skinnemoen debugging information in files under /sys/kernel/debug/. 78914a3f3bSHaavard Skinnemoen The information in these files may help when you're 79914a3f3bSHaavard Skinnemoen troubleshooting or bringing up a driver on a new board. 80914a3f3bSHaavard Skinnemoen Enable these files by choosing "Y" here. If in doubt, or 81914a3f3bSHaavard Skinnemoen to conserve kernel memory, say "N". 82914a3f3bSHaavard Skinnemoen 8336e893d2SDavid Brownellconfig USB_GADGET_VBUS_DRAW 8436e893d2SDavid Brownell int "Maximum VBUS Power usage (2-500 mA)" 8536e893d2SDavid Brownell range 2 500 8636e893d2SDavid Brownell default 2 8736e893d2SDavid Brownell help 8836e893d2SDavid Brownell Some devices need to draw power from USB when they are 8936e893d2SDavid Brownell configured, perhaps to operate circuitry or to recharge 9036e893d2SDavid Brownell batteries. This is in addition to any local power supply, 9136e893d2SDavid Brownell such as an AC adapter or batteries. 9236e893d2SDavid Brownell 9336e893d2SDavid Brownell Enter the maximum power your device draws through USB, in 9436e893d2SDavid Brownell milliAmperes. The permitted range of values is 2 - 500 mA; 9536e893d2SDavid Brownell 0 mA would be legal, but can make some hosts misbehave. 9636e893d2SDavid Brownell 9736e893d2SDavid Brownell This value will be used except for system-specific gadget 9836e893d2SDavid Brownell drivers that have more specific information. 9936e893d2SDavid Brownell 1006532c7fdSPer Forlinconfig USB_GADGET_STORAGE_NUM_BUFFERS 1016532c7fdSPer Forlin int "Number of storage pipeline buffers" 1026532c7fdSPer Forlin range 2 4 1036532c7fdSPer Forlin default 2 1046532c7fdSPer Forlin help 1056532c7fdSPer Forlin Usually 2 buffers are enough to establish a good buffering 1066532c7fdSPer Forlin pipeline. The number may be increased in order to compensate 1076532c7fdSPer Forlin for a bursty VFS behaviour. For instance there may be CPU wake up 1086532c7fdSPer Forlin latencies that makes the VFS to appear bursty in a system with 1096532c7fdSPer Forlin an CPU on-demand governor. Especially if DMA is doing IO to 1106532c7fdSPer Forlin offload the CPU. In this case the CPU will go into power 1116532c7fdSPer Forlin save often and spin up occasionally to move data within VFS. 1126532c7fdSPer Forlin If selecting USB_GADGET_DEBUG_FILES this value may be set by 1136532c7fdSPer Forlin a module parameter as well. 1146532c7fdSPer Forlin If unsure, say 2. 1156532c7fdSPer Forlin 1161da177e4SLinus Torvalds# 1171da177e4SLinus Torvalds# USB Peripheral Controller Support 1181da177e4SLinus Torvalds# 119a7a19facSDavid Brownell# The order here is alphabetical, except that integrated controllers go 120a7a19facSDavid Brownell# before discrete ones so they will be the initial/default value: 121a7a19facSDavid Brownell# - integrated/SOC controllers first 122a7a19facSDavid Brownell# - licensed IP used in both SOC and discrete versions 123a7a19facSDavid Brownell# - discrete ones (including all PCI-only controllers) 124a7a19facSDavid Brownell# - debug/dummy gadget+hcd is last. 125a7a19facSDavid Brownell# 126ed6c6f41SAlexander Shishkinmenu "USB Peripheral Controller" 1271da177e4SLinus Torvalds 128a7a19facSDavid Brownell# 129a7a19facSDavid Brownell# Integrated controllers 130a7a19facSDavid Brownell# 131a7a19facSDavid Brownell 132193ab2a6SFelipe Balbiconfig USB_AT91 133193ab2a6SFelipe Balbi tristate "Atmel AT91 USB Device Port" 134d1494a34SJean-Christophe PLAGNIOL-VILLARD depends on ARCH_AT91 13555d402d8SThomas Dahlmann help 136a7a19facSDavid Brownell Many Atmel AT91 processors (such as the AT91RM2000) have a 137a7a19facSDavid Brownell full speed USB Device Port with support for five configurable 138a7a19facSDavid Brownell endpoints (plus endpoint zero). 13955d402d8SThomas Dahlmann 14055d402d8SThomas Dahlmann Say "y" to link the driver statically, or "m" to build a 141a7a19facSDavid Brownell dynamically linked module called "at91_udc" and force all 14255d402d8SThomas Dahlmann gadget drivers to also be dynamically linked. 14355d402d8SThomas Dahlmann 14424a28e42SRoland Stiggeconfig USB_LPC32XX 14524a28e42SRoland Stigge tristate "LPC32XX USB Peripheral Controller" 14624a28e42SRoland Stigge depends on ARCH_LPC32XX 14764e98a79SArnd Bergmann depends on USB_PHY 14824a28e42SRoland Stigge select USB_ISP1301 14924a28e42SRoland Stigge help 15024a28e42SRoland Stigge This option selects the USB device controller in the LPC32xx SoC. 15124a28e42SRoland Stigge 15224a28e42SRoland Stigge Say "y" to link the driver statically, or "m" to build a 15324a28e42SRoland Stigge dynamically linked module called "lpc32xx_udc" and force all 15424a28e42SRoland Stigge gadget drivers to also be dynamically linked. 15524a28e42SRoland Stigge 156193ab2a6SFelipe Balbiconfig USB_ATMEL_USBA 157193ab2a6SFelipe Balbi tristate "Atmel USBA" 1584a3ae932SJean-Christophe PLAGNIOL-VILLARD depends on AVR32 || ARCH_AT91 159914a3f3bSHaavard Skinnemoen help 160914a3f3bSHaavard Skinnemoen USBA is the integrated high-speed USB Device controller on 161ba45ca43SNicolas Ferre the AT32AP700x, some AT91SAM9 and AT91CAP9 processors from Atmel. 162914a3f3bSHaavard Skinnemoen 163613065e5SKevin Cernekeeconfig USB_BCM63XX_UDC 164613065e5SKevin Cernekee tristate "Broadcom BCM63xx Peripheral Controller" 165613065e5SKevin Cernekee depends on BCM63XX 166613065e5SKevin Cernekee help 167613065e5SKevin Cernekee Many Broadcom BCM63xx chipsets (such as the BCM6328) have a 168613065e5SKevin Cernekee high speed USB Device Port with support for four fixed endpoints 169613065e5SKevin Cernekee (plus endpoint zero). 170613065e5SKevin Cernekee 171613065e5SKevin Cernekee Say "y" to link the driver statically, or "m" to build a 172613065e5SKevin Cernekee dynamically linked module called "bcm63xx_udc". 173613065e5SKevin Cernekee 174193ab2a6SFelipe Balbiconfig USB_FSL_USB2 175193ab2a6SFelipe Balbi tristate "Freescale Highspeed USB DR Peripheral Controller" 17654e4026bSGuennadi Liakhovetski depends on FSL_SOC || ARCH_MXC 177018b97d0SMarc Kleine-Budde select USB_FSL_MPH_DR_OF if OF 178b504882dSLi Yang help 17900c16f9fSFabio Estevam Some of Freescale PowerPC and i.MX processors have a High Speed 180b504882dSLi Yang Dual-Role(DR) USB controller, which supports device mode. 181b504882dSLi Yang 182b504882dSLi Yang The number of programmable endpoints is different through 183b504882dSLi Yang SOC revisions. 184b504882dSLi Yang 185b504882dSLi Yang Say "y" to link the driver statically, or "m" to build a 186b504882dSLi Yang dynamically linked module called "fsl_usb2_udc" and force 187b504882dSLi Yang all gadget drivers to also be dynamically linked. 188b504882dSLi Yang 189193ab2a6SFelipe Balbiconfig USB_FUSB300 190193ab2a6SFelipe Balbi tristate "Faraday FUSB300 USB Peripheral Controller" 191ac17317dSSebastian Andrzej Siewior depends on !PHYS_ADDR_T_64BIT 1920fe6f1d1SYuan-Hsin Chen help 1930fe6f1d1SYuan-Hsin Chen Faraday usb device controller FUSB300 driver 1940fe6f1d1SYuan-Hsin Chen 195b84a8deeSYuan-Hsin Chenconfig USB_FOTG210_UDC 196bfcbd020SGeert Uytterhoeven depends on HAS_DMA 197b84a8deeSYuan-Hsin Chen tristate "Faraday FOTG210 USB Peripheral Controller" 198b84a8deeSYuan-Hsin Chen help 199b84a8deeSYuan-Hsin Chen Faraday USB2.0 OTG controller which can be configured as 200b84a8deeSYuan-Hsin Chen high speed or full speed USB device. This driver supppors 201b84a8deeSYuan-Hsin Chen Bulk Transfer so far. 202b84a8deeSYuan-Hsin Chen 203b84a8deeSYuan-Hsin Chen Say "y" to link the driver statically, or "m" to build a 204b84a8deeSYuan-Hsin Chen dynamically linked module called "fotg210_udc". 205b84a8deeSYuan-Hsin Chen 206193ab2a6SFelipe Balbiconfig USB_OMAP 207193ab2a6SFelipe Balbi tristate "OMAP USB Device Controller" 208b924b204STony Lindgren depends on ARCH_OMAP1 209c3c683eaSArnd Bergmann depends on USB_PHY 210f1c9e151STony Lindgren select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3 || MACH_OMAP_H4_OTG 2111da177e4SLinus Torvalds help 2121da177e4SLinus Torvalds Many Texas Instruments OMAP processors have flexible full 2131da177e4SLinus Torvalds speed USB device controllers, with support for up to 30 2141da177e4SLinus Torvalds endpoints (plus endpoint zero). This driver supports the 2151da177e4SLinus Torvalds controller in the OMAP 1611, and should work with controllers 2161da177e4SLinus Torvalds in other OMAP processors too, given minor tweaks. 2171da177e4SLinus Torvalds 2181da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 2191da177e4SLinus Torvalds dynamically linked module called "omap_udc" and force all 2201da177e4SLinus Torvalds gadget drivers to also be dynamically linked. 2211da177e4SLinus Torvalds 222193ab2a6SFelipe Balbiconfig USB_PXA25X 223193ab2a6SFelipe Balbi tristate "PXA 25x or IXP 4xx" 224a7a19facSDavid Brownell depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX 225a7a19facSDavid Brownell help 226a7a19facSDavid Brownell Intel's PXA 25x series XScale ARM-5TE processors include 227a7a19facSDavid Brownell an integrated full speed USB 1.1 device controller. The 228a7a19facSDavid Brownell controller in the IXP 4xx series is register-compatible. 229a7a19facSDavid Brownell 230a7a19facSDavid Brownell It has fifteen fixed-function endpoints, as well as endpoint 231a7a19facSDavid Brownell zero (for control transfers). 232a7a19facSDavid Brownell 233a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 234a7a19facSDavid Brownell dynamically linked module called "pxa25x_udc" and force all 235a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 236a7a19facSDavid Brownell 237a7a19facSDavid Brownell# if there's only one gadget driver, using only two bulk endpoints, 238a7a19facSDavid Brownell# don't waste memory for the other endpoints 239a7a19facSDavid Brownellconfig USB_PXA25X_SMALL 240193ab2a6SFelipe Balbi depends on USB_PXA25X 241a7a19facSDavid Brownell bool 242a7a19facSDavid Brownell default n if USB_ETH_RNDIS 243a7a19facSDavid Brownell default y if USB_ZERO 244a7a19facSDavid Brownell default y if USB_ETH 245a7a19facSDavid Brownell default y if USB_G_SERIAL 246a7a19facSDavid Brownell 247193ab2a6SFelipe Balbiconfig USB_R8A66597 248193ab2a6SFelipe Balbi tristate "Renesas R8A66597 USB Peripheral Controller" 249c4144247SYoshihiro Shimoda help 250c4144247SYoshihiro Shimoda R8A66597 is a discrete USB host and peripheral controller chip that 251c4144247SYoshihiro Shimoda supports both full and high speed USB 2.0 data transfers. 252c4144247SYoshihiro Shimoda It has nine configurable endpoints, and endpoint zero. 253c4144247SYoshihiro Shimoda 254c4144247SYoshihiro Shimoda Say "y" to link the driver statically, or "m" to build a 255c4144247SYoshihiro Shimoda dynamically linked module called "r8a66597_udc" and force all 256c4144247SYoshihiro Shimoda gadget drivers to also be dynamically linked. 257c4144247SYoshihiro Shimoda 258030ed1fcSKuninori Morimotoconfig USB_RENESAS_USBHS_UDC 259193ab2a6SFelipe Balbi tristate 'Renesas USBHS controller' 260030ed1fcSKuninori Morimoto depends on USB_RENESAS_USBHS 2612f98382dSKuninori Morimoto help 262193ab2a6SFelipe Balbi Renesas USBHS is a discrete USB host and peripheral controller chip 263193ab2a6SFelipe Balbi that supports both full and high speed USB 2.0 data transfers. 264193ab2a6SFelipe Balbi It has nine or more configurable endpoints, and endpoint zero. 2652f98382dSKuninori Morimoto 266193ab2a6SFelipe Balbi Say "y" to link the driver statically, or "m" to build a 267193ab2a6SFelipe Balbi dynamically linked module called "renesas_usbhs" and force all 268193ab2a6SFelipe Balbi gadget drivers to also be dynamically linked. 2692f98382dSKuninori Morimoto 270193ab2a6SFelipe Balbiconfig USB_PXA27X 271193ab2a6SFelipe Balbi tristate "PXA 27x" 272a7a19facSDavid Brownell help 273a7a19facSDavid Brownell Intel's PXA 27x series XScale ARM v5TE processors include 274a7a19facSDavid Brownell an integrated full speed USB 1.1 device controller. 275a7a19facSDavid Brownell 276a7a19facSDavid Brownell It has up to 23 endpoints, as well as endpoint zero (for 277a7a19facSDavid Brownell control transfers). 278a7a19facSDavid Brownell 279a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 280a7a19facSDavid Brownell dynamically linked module called "pxa27x_udc" and force all 281a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 282a7a19facSDavid Brownell 283193ab2a6SFelipe Balbiconfig USB_S3C_HSOTG 284193ab2a6SFelipe Balbi tristate "S3C HS/OtG USB Device controller" 2855b7d70c6SBen Dooks depends on S3C_DEV_USB_HSOTG 2865b7d70c6SBen Dooks help 2875b7d70c6SBen Dooks The Samsung S3C64XX USB2.0 high-speed gadget controller 2885b7d70c6SBen Dooks integrated into the S3C64XX series SoC. 2895b7d70c6SBen Dooks 290193ab2a6SFelipe Balbiconfig USB_IMX 2912e5a08a3SSascha Hauer tristate "Freescale i.MX1 USB Peripheral Controller" 2922e5a08a3SSascha Hauer depends on ARCH_MXC 2939662ced3SFelipe Balbi depends on BROKEN 294c03e7d4bSPaulius Zaleckas help 2952e5a08a3SSascha Hauer Freescale's i.MX1 includes an integrated full speed 2962e5a08a3SSascha Hauer USB 1.1 device controller. 297c03e7d4bSPaulius Zaleckas 298c03e7d4bSPaulius Zaleckas It has Six fixed-function endpoints, as well as endpoint 299c03e7d4bSPaulius Zaleckas zero (for control transfers). 300c03e7d4bSPaulius Zaleckas 301c03e7d4bSPaulius Zaleckas Say "y" to link the driver statically, or "m" to build a 302c03e7d4bSPaulius Zaleckas dynamically linked module called "imx_udc" and force all 303c03e7d4bSPaulius Zaleckas gadget drivers to also be dynamically linked. 304c03e7d4bSPaulius Zaleckas 305193ab2a6SFelipe Balbiconfig USB_S3C2410 306193ab2a6SFelipe Balbi tristate "S3C2410 USB Device Controller" 307b130d5c2SKukjin Kim depends on ARCH_S3C24XX 3083fc154b6SArnaud Patard help 3093fc154b6SArnaud Patard Samsung's S3C2410 is an ARM-4 processor with an integrated 3103fc154b6SArnaud Patard full speed USB 1.1 device controller. It has 4 configurable 3113fc154b6SArnaud Patard endpoints, as well as endpoint zero (for control transfers). 3123fc154b6SArnaud Patard 3133fc154b6SArnaud Patard This driver has been tested on the S3C2410, S3C2412, and 3143fc154b6SArnaud Patard S3C2440 processors. 3153fc154b6SArnaud Patard 3163fc154b6SArnaud Patardconfig USB_S3C2410_DEBUG 3173fc154b6SArnaud Patard boolean "S3C2410 udc debug messages" 318193ab2a6SFelipe Balbi depends on USB_S3C2410 3193fc154b6SArnaud Patard 320193ab2a6SFelipe Balbiconfig USB_S3C_HSUDC 321193ab2a6SFelipe Balbi tristate "S3C2416, S3C2443 and S3C2450 USB Device Controller" 322b130d5c2SKukjin Kim depends on ARCH_S3C24XX 323a9df304cSThomas Abraham help 324a9df304cSThomas Abraham Samsung's S3C2416, S3C2443 and S3C2450 is an ARM9 based SoC 325a9df304cSThomas Abraham integrated with dual speed USB 2.0 device controller. It has 326a9df304cSThomas Abraham 8 endpoints, as well as endpoint zero. 327a9df304cSThomas Abraham 328a9df304cSThomas Abraham This driver has been tested on S3C2416 and S3C2450 processors. 329a9df304cSThomas Abraham 3305e6c86b0SNeil Zhangconfig USB_MV_UDC 3315e6c86b0SNeil Zhang tristate "Marvell USB2.0 Device Controller" 3324713aec1SGeert Uytterhoeven depends on GENERIC_HARDIRQS && HAS_DMA 333e7cddda4Scxie4 help 3345e6c86b0SNeil Zhang Marvell Socs (including PXA and MMP series) include a high speed 3355e6c86b0SNeil Zhang USB2.0 OTG controller, which can be configured as high speed or 3365e6c86b0SNeil Zhang full speed USB peripheral. 33772246da4SFelipe Balbi 3383d4eb9dfSYu Xuconfig USB_MV_U3D 339*91f6b847SGeert Uytterhoeven depends on HAS_DMA 3403d4eb9dfSYu Xu tristate "MARVELL PXA2128 USB 3.0 controller" 3413d4eb9dfSYu Xu help 3423d4eb9dfSYu Xu MARVELL PXA2128 Processor series include a super speed USB3.0 device 3433d4eb9dfSYu Xu controller, which support super speed USB peripheral. 3443d4eb9dfSYu Xu 345a7a19facSDavid Brownell# 346a7a19facSDavid Brownell# Controllers available in both integrated and discrete versions 347a7a19facSDavid Brownell# 348a7a19facSDavid Brownell 349193ab2a6SFelipe Balbiconfig USB_M66592 350193ab2a6SFelipe Balbi tristate "Renesas M66592 USB Peripheral Controller" 351a7a19facSDavid Brownell help 352a7a19facSDavid Brownell M66592 is a discrete USB peripheral controller chip that 353a7a19facSDavid Brownell supports both full and high speed USB 2.0 data transfers. 354a7a19facSDavid Brownell It has seven configurable endpoints, and endpoint zero. 355bae4bd84SDavid Brownell 356bae4bd84SDavid Brownell Say "y" to link the driver statically, or "m" to build a 357a7a19facSDavid Brownell dynamically linked module called "m66592_udc" and force all 358bae4bd84SDavid Brownell gadget drivers to also be dynamically linked. 359bae4bd84SDavid Brownell 360a7a19facSDavid Brownell# 361a7a19facSDavid Brownell# Controllers available only in discrete form (and all PCI controllers) 362a7a19facSDavid Brownell# 363a7a19facSDavid Brownell 364193ab2a6SFelipe Balbiconfig USB_AMD5536UDC 365193ab2a6SFelipe Balbi tristate "AMD5536 UDC" 366a7a19facSDavid Brownell depends on PCI 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 378193ab2a6SFelipe Balbiconfig USB_FSL_QE 379193ab2a6SFelipe Balbi tristate "Freescale QE/CPM USB Device Controller" 3803948f0e0SLi Yang depends on FSL_SOC && (QUICC_ENGINE || CPM) 3813948f0e0SLi Yang help 3823948f0e0SLi Yang Some of Freescale PowerPC processors have a Full Speed 3833948f0e0SLi Yang QE/CPM2 USB controller, which support device mode with 4 3843948f0e0SLi Yang programmable endpoints. This driver supports the 3853948f0e0SLi Yang controller in the MPC8360 and MPC8272, and should work with 3863948f0e0SLi Yang controllers having QE or CPM2, given minor tweaks. 3873948f0e0SLi Yang 3883948f0e0SLi Yang Set CONFIG_USB_GADGET to "m" to build this driver as a 389692105b8SMatt LaPlante dynamically linked module called "fsl_qe_udc". 3903948f0e0SLi Yang 391193ab2a6SFelipe Balbiconfig USB_NET2272 392193ab2a6SFelipe Balbi tristate "PLX NET2272" 393ceb80363SSeth Levy help 394ceb80363SSeth Levy PLX NET2272 is a USB peripheral controller which supports 395ceb80363SSeth Levy both full and high speed USB 2.0 data transfers. 396ceb80363SSeth Levy 397ceb80363SSeth Levy It has three configurable endpoints, as well as endpoint zero 398ceb80363SSeth Levy (for control transfer). 399ceb80363SSeth Levy Say "y" to link the driver statically, or "m" to build a 400ceb80363SSeth Levy dynamically linked module called "net2272" and force all 401ceb80363SSeth Levy gadget drivers to also be dynamically linked. 402ceb80363SSeth Levy 403193ab2a6SFelipe Balbiconfig USB_NET2272_DMA 404ceb80363SSeth Levy boolean "Support external DMA controller" 405193ab2a6SFelipe Balbi depends on USB_NET2272 406ceb80363SSeth Levy help 407ceb80363SSeth Levy The NET2272 part can optionally support an external DMA 408ceb80363SSeth Levy controller, but your board has to have support in the 409ceb80363SSeth Levy driver itself. 410ceb80363SSeth Levy 411ceb80363SSeth Levy If unsure, say "N" here. The driver works fine in PIO mode. 412ceb80363SSeth Levy 413193ab2a6SFelipe Balbiconfig USB_NET2280 414193ab2a6SFelipe Balbi tristate "NetChip 228x" 415a7a19facSDavid Brownell depends on PCI 416a7a19facSDavid Brownell help 417a7a19facSDavid Brownell NetChip 2280 / 2282 is a PCI based USB peripheral controller which 418a7a19facSDavid Brownell supports both full and high speed USB 2.0 data transfers. 419a7a19facSDavid Brownell 420a7a19facSDavid Brownell It has six configurable endpoints, as well as endpoint zero 421a7a19facSDavid Brownell (for control transfers) and several endpoints with dedicated 422a7a19facSDavid Brownell functions. 423a7a19facSDavid Brownell 424a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 425a7a19facSDavid Brownell dynamically linked module called "net2280" and force all 426a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 427a7a19facSDavid Brownell 428193ab2a6SFelipe Balbiconfig USB_GOKU 429193ab2a6SFelipe Balbi tristate "Toshiba TC86C001 'Goku-S'" 430a7a19facSDavid Brownell depends on PCI 431a7a19facSDavid Brownell help 432a7a19facSDavid Brownell The Toshiba TC86C001 is a PCI device which includes controllers 433a7a19facSDavid Brownell for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI). 434a7a19facSDavid Brownell 435a7a19facSDavid Brownell The device controller has three configurable (bulk or interrupt) 436a7a19facSDavid Brownell endpoints, plus endpoint zero (for control transfers). 437a7a19facSDavid Brownell 438a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 439a7a19facSDavid Brownell dynamically linked module called "goku_udc" and to force all 440a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 441a7a19facSDavid Brownell 442193ab2a6SFelipe Balbiconfig USB_EG20T 443731ad81eSTomoya MORINAGA tristate "Intel EG20T PCH/LAPIS Semiconductor IOH(ML7213/ML7831) UDC" 4445273afe3SHeiko Carstens depends on PCI && GENERIC_HARDIRQS 445f646cf94SToshiharu Okada help 446f646cf94SToshiharu Okada This is a USB device driver for EG20T PCH. 447f646cf94SToshiharu Okada EG20T PCH is the platform controller hub that is used in Intel's 448f646cf94SToshiharu Okada general embedded platform. EG20T PCH has USB device interface. 449f646cf94SToshiharu Okada Using this interface, it is able to access system devices connected 450f646cf94SToshiharu Okada to USB device. 451f646cf94SToshiharu Okada This driver enables USB device function. 452f646cf94SToshiharu Okada USB device is a USB peripheral controller which 453f646cf94SToshiharu Okada supports both full and high speed USB 2.0 data transfers. 454f646cf94SToshiharu Okada This driver supports both control transfer and bulk transfer modes. 455f646cf94SToshiharu Okada This driver dose not support interrupt transfer or isochronous 456f646cf94SToshiharu Okada transfer modes. 457f646cf94SToshiharu Okada 458731ad81eSTomoya MORINAGA This driver also can be used for LAPIS Semiconductor's ML7213 which is 45906f1b971STomoya MORINAGA for IVI(In-Vehicle Infotainment) use. 460731ad81eSTomoya MORINAGA ML7831 is for general purpose use. 461731ad81eSTomoya MORINAGA ML7213/ML7831 is companion chip for Intel Atom E6xx series. 462731ad81eSTomoya MORINAGA ML7213/ML7831 is completely compatible for Intel EG20T PCH. 46306f1b971STomoya MORINAGA 464a7a19facSDavid Brownell# 465a7a19facSDavid Brownell# LAST -- dummy/emulated controller 466a7a19facSDavid Brownell# 4671da177e4SLinus Torvalds 468193ab2a6SFelipe Balbiconfig USB_DUMMY_HCD 469193ab2a6SFelipe Balbi tristate "Dummy HCD (DEVELOPMENT)" 470afd0e0f2SRobert P. J. Day depends on USB=y || (USB=m && USB_GADGET=m) 4711da177e4SLinus Torvalds help 4721da177e4SLinus Torvalds This host controller driver emulates USB, looping all data transfer 4731da177e4SLinus Torvalds requests back to a USB "gadget driver" in the same host. The host 4741da177e4SLinus Torvalds side is the master; the gadget side is the slave. Gadget drivers 4751da177e4SLinus Torvalds can be high, full, or low speed; and they have access to endpoints 4761da177e4SLinus Torvalds like those from NET2280, PXA2xx, or SA1100 hardware. 4771da177e4SLinus Torvalds 4781da177e4SLinus Torvalds This may help in some stages of creating a driver to embed in a 4791da177e4SLinus Torvalds Linux device, since it lets you debug several parts of the gadget 4801da177e4SLinus Torvalds driver without its hardware or drivers being involved. 4811da177e4SLinus Torvalds 4821da177e4SLinus Torvalds Since such a gadget side driver needs to interoperate with a host 4831da177e4SLinus Torvalds side Linux-USB device driver, this may help to debug both sides 4841da177e4SLinus Torvalds of a USB protocol stack. 4851da177e4SLinus Torvalds 4861da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 4871da177e4SLinus Torvalds dynamically linked module called "dummy_hcd" and force all 4881da177e4SLinus Torvalds gadget drivers to also be dynamically linked. 4891da177e4SLinus Torvalds 4901da177e4SLinus Torvalds# NOTE: Please keep dummy_hcd LAST so that "real hardware" appears 4911da177e4SLinus Torvalds# first and will be selected by default. 4921da177e4SLinus Torvalds 493ed6c6f41SAlexander Shishkinendmenu 4941da177e4SLinus Torvalds 4951da177e4SLinus Torvalds# 4961da177e4SLinus Torvalds# USB Gadget Drivers 4971da177e4SLinus Torvalds# 498a84d9e53SSebastian Andrzej Siewior 499a84d9e53SSebastian Andrzej Siewior# composite based drivers 500a84d9e53SSebastian Andrzej Siewiorconfig USB_LIBCOMPOSITE 501a84d9e53SSebastian Andrzej Siewior tristate 50288af8bbeSSebastian Andrzej Siewior select CONFIGFS_FS 503a84d9e53SSebastian Andrzej Siewior depends on USB_GADGET 504a84d9e53SSebastian Andrzej Siewior 505ff47f594SSebastian Andrzej Siewiorconfig USB_F_ACM 506ff47f594SSebastian Andrzej Siewior tristate 507ff47f594SSebastian Andrzej Siewior 508cf9a08aeSSebastian Andrzej Siewiorconfig USB_F_SS_LB 509cf9a08aeSSebastian Andrzej Siewior tristate 510cf9a08aeSSebastian Andrzej Siewior 5113249ca22SSebastian Andrzej Siewiorconfig USB_U_SERIAL 5123249ca22SSebastian Andrzej Siewior tristate 5133249ca22SSebastian Andrzej Siewior 514f1a1823fSAndrzej Pietrasiewiczconfig USB_U_ETHER 515f1a1823fSAndrzej Pietrasiewicz tristate 516f1a1823fSAndrzej Pietrasiewicz 517cbbd14a9SAndrzej Pietrasiewiczconfig USB_U_RNDIS 518cbbd14a9SAndrzej Pietrasiewicz tristate 519cbbd14a9SAndrzej Pietrasiewicz 52060540ea2SAndrzej Pietrasiewiczconfig USB_F_SERIAL 52160540ea2SAndrzej Pietrasiewicz tristate 52260540ea2SAndrzej Pietrasiewicz 5231d8fc251SAndrzej Pietrasiewiczconfig USB_F_OBEX 5241d8fc251SAndrzej Pietrasiewicz tristate 5251d8fc251SAndrzej Pietrasiewicz 52640d133d7SAndrzej Pietrasiewiczconfig USB_F_NCM 52740d133d7SAndrzej Pietrasiewicz tristate 52840d133d7SAndrzej Pietrasiewicz 529fee562a6SAndrzej Pietrasiewiczconfig USB_F_ECM 530fee562a6SAndrzej Pietrasiewicz tristate 531fee562a6SAndrzej Pietrasiewicz 532fcbdf12eSAndrzej Pietrasiewiczconfig USB_F_PHONET 533fcbdf12eSAndrzej Pietrasiewicz tristate 534fcbdf12eSAndrzej Pietrasiewicz 535b29002a1SAndrzej Pietrasiewiczconfig USB_F_EEM 536b29002a1SAndrzej Pietrasiewicz tristate 537b29002a1SAndrzej Pietrasiewicz 5388cedba7cSAndrzej Pietrasiewiczconfig USB_F_SUBSET 5398cedba7cSAndrzej Pietrasiewicz tristate 5408cedba7cSAndrzej Pietrasiewicz 541f466c635SAndrzej Pietrasiewiczconfig USB_F_RNDIS 542f466c635SAndrzej Pietrasiewicz tristate 543f466c635SAndrzej Pietrasiewicz 5441da177e4SLinus Torvaldschoice 5451da177e4SLinus Torvalds tristate "USB Gadget Drivers" 5461da177e4SLinus Torvalds default USB_ETH 5471da177e4SLinus Torvalds help 5481da177e4SLinus Torvalds A Linux "Gadget Driver" talks to the USB Peripheral Controller 5491da177e4SLinus Torvalds driver through the abstract "gadget" API. Some other operating 5501da177e4SLinus Torvalds systems call these "client" drivers, of which "class drivers" 5511da177e4SLinus Torvalds are a subset (implementing a USB device class specification). 5521da177e4SLinus Torvalds A gadget driver implements one or more USB functions using 5531da177e4SLinus Torvalds the peripheral hardware. 5541da177e4SLinus Torvalds 5551da177e4SLinus Torvalds Gadget drivers are hardware-neutral, or "platform independent", 5561da177e4SLinus Torvalds except that they sometimes must understand quirks or limitations 5571da177e4SLinus Torvalds of the particular controllers they work with. For example, when 5581da177e4SLinus Torvalds a controller doesn't support alternate configurations or provide 5591da177e4SLinus Torvalds enough of the right types of endpoints, the gadget driver might 5601da177e4SLinus Torvalds not be able work with that controller, or might need to implement 5611da177e4SLinus Torvalds a less common variant of a device class protocol. 5621da177e4SLinus Torvalds 5631da177e4SLinus Torvalds# this first set of drivers all depend on bulk-capable hardware. 5641da177e4SLinus Torvalds 565d1c02452SAndrzej Pietrasiewiczconfig USB_CONFIGFS 566d1c02452SAndrzej Pietrasiewicz tristate "USB functions configurable through configfs" 567d1c02452SAndrzej Pietrasiewicz select USB_LIBCOMPOSITE 568d1c02452SAndrzej Pietrasiewicz help 569d1c02452SAndrzej Pietrasiewicz A Linux USB "gadget" can be set up through configfs. 570d1c02452SAndrzej Pietrasiewicz If this is the case, the USB functions (which from the host's 571d1c02452SAndrzej Pietrasiewicz perspective are seen as interfaces) and configurations are 572d1c02452SAndrzej Pietrasiewicz specified simply by creating appropriate directories in configfs. 573d1c02452SAndrzej Pietrasiewicz Associating functions with configurations is done by creating 574d1c02452SAndrzej Pietrasiewicz appropriate symbolic links. 575d1c02452SAndrzej Pietrasiewicz For more information see Documentation/usb/gadget-configfs.txt. 576d1c02452SAndrzej Pietrasiewicz 577d1c02452SAndrzej Pietrasiewiczconfig USB_CONFIGFS_SERIAL 578d1c02452SAndrzej Pietrasiewicz boolean "Generic serial bulk in/out" 579d1c02452SAndrzej Pietrasiewicz depends on USB_CONFIGFS 580d1c02452SAndrzej Pietrasiewicz depends on TTY 581d1c02452SAndrzej Pietrasiewicz select USB_U_SERIAL 582d1c02452SAndrzej Pietrasiewicz select USB_F_SERIAL 583d1c02452SAndrzej Pietrasiewicz help 584d1c02452SAndrzej Pietrasiewicz The function talks to the Linux-USB generic serial driver. 585d1c02452SAndrzej Pietrasiewicz 586d1c02452SAndrzej Pietrasiewiczconfig USB_CONFIGFS_ACM 587d1c02452SAndrzej Pietrasiewicz boolean "Abstract Control Model (CDC ACM)" 588d1c02452SAndrzej Pietrasiewicz depends on USB_CONFIGFS 589d1c02452SAndrzej Pietrasiewicz depends on TTY 590d1c02452SAndrzej Pietrasiewicz select USB_U_SERIAL 591d1c02452SAndrzej Pietrasiewicz select USB_F_ACM 592d1c02452SAndrzej Pietrasiewicz help 593d1c02452SAndrzej Pietrasiewicz ACM serial link. This function can be used to interoperate with 594d1c02452SAndrzej Pietrasiewicz MS-Windows hosts or with the Linux-USB "cdc-acm" driver. 595d1c02452SAndrzej Pietrasiewicz 596d1c02452SAndrzej Pietrasiewiczconfig USB_CONFIGFS_OBEX 597d1c02452SAndrzej Pietrasiewicz boolean "Object Exchange Model (CDC OBEX)" 598d1c02452SAndrzej Pietrasiewicz depends on USB_CONFIGFS 599d1c02452SAndrzej Pietrasiewicz depends on TTY 600d1c02452SAndrzej Pietrasiewicz select USB_U_SERIAL 601d1c02452SAndrzej Pietrasiewicz select USB_F_OBEX 602d1c02452SAndrzej Pietrasiewicz help 603d1c02452SAndrzej Pietrasiewicz You will need a user space OBEX server talking to /dev/ttyGS*, 604d1c02452SAndrzej Pietrasiewicz since the kernel itself doesn't implement the OBEX protocol. 605d1c02452SAndrzej Pietrasiewicz 606d1c02452SAndrzej Pietrasiewiczconfig USB_CONFIGFS_NCM 607d1c02452SAndrzej Pietrasiewicz boolean "Network Control Model (CDC NCM)" 608d1c02452SAndrzej Pietrasiewicz depends on USB_CONFIGFS 609d1c02452SAndrzej Pietrasiewicz depends on NET 610d1c02452SAndrzej Pietrasiewicz select USB_U_ETHER 611d1c02452SAndrzej Pietrasiewicz select USB_F_NCM 612d1c02452SAndrzej Pietrasiewicz help 613d1c02452SAndrzej Pietrasiewicz NCM is an advanced protocol for Ethernet encapsulation, allows 614d1c02452SAndrzej Pietrasiewicz grouping of several ethernet frames into one USB transfer and 615d1c02452SAndrzej Pietrasiewicz different alignment possibilities. 616d1c02452SAndrzej Pietrasiewicz 617d1c02452SAndrzej Pietrasiewiczconfig USB_CONFIGFS_ECM 618d1c02452SAndrzej Pietrasiewicz boolean "Ethernet Control Model (CDC ECM)" 619d1c02452SAndrzej Pietrasiewicz depends on USB_CONFIGFS 620d1c02452SAndrzej Pietrasiewicz depends on NET 621d1c02452SAndrzej Pietrasiewicz select USB_U_ETHER 622d1c02452SAndrzej Pietrasiewicz select USB_F_ECM 623d1c02452SAndrzej Pietrasiewicz help 624d1c02452SAndrzej Pietrasiewicz The "Communication Device Class" (CDC) Ethernet Control Model. 625d1c02452SAndrzej Pietrasiewicz That protocol is often avoided with pure Ethernet adapters, in 626d1c02452SAndrzej Pietrasiewicz favor of simpler vendor-specific hardware, but is widely 627d1c02452SAndrzej Pietrasiewicz supported by firmware for smart network devices. 628d1c02452SAndrzej Pietrasiewicz 62902832e56SAndrzej Pietrasiewiczconfig USB_CONFIGFS_ECM_SUBSET 63002832e56SAndrzej Pietrasiewicz boolean "Ethernet Control Model (CDC ECM) subset" 63102832e56SAndrzej Pietrasiewicz depends on USB_CONFIGFS 63202832e56SAndrzej Pietrasiewicz depends on NET 63302832e56SAndrzej Pietrasiewicz select USB_U_ETHER 63402832e56SAndrzej Pietrasiewicz select USB_F_SUBSET 63502832e56SAndrzej Pietrasiewicz help 63602832e56SAndrzej Pietrasiewicz On hardware that can't implement the full protocol, 63702832e56SAndrzej Pietrasiewicz a simple CDC subset is used, placing fewer demands on USB. 63802832e56SAndrzej Pietrasiewicz 639b3df2faaSAndrzej Pietrasiewiczconfig USB_CONFIGFS_RNDIS 640b3df2faaSAndrzej Pietrasiewicz bool "RNDIS" 641b3df2faaSAndrzej Pietrasiewicz depends on USB_CONFIGFS 642b3df2faaSAndrzej Pietrasiewicz depends on NET 643b3df2faaSAndrzej Pietrasiewicz select USB_U_ETHER 6449d140f79SAndrzej Pietrasiewicz select USB_U_RNDIS 645b3df2faaSAndrzej Pietrasiewicz select USB_F_RNDIS 646b3df2faaSAndrzej Pietrasiewicz help 647b3df2faaSAndrzej Pietrasiewicz Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol, 648b3df2faaSAndrzej Pietrasiewicz and Microsoft provides redistributable binary RNDIS drivers for 649b3df2faaSAndrzej Pietrasiewicz older versions of Windows. 650b3df2faaSAndrzej Pietrasiewicz 651b3df2faaSAndrzej Pietrasiewicz To make MS-Windows work with this, use Documentation/usb/linux.inf 652b3df2faaSAndrzej Pietrasiewicz as the "driver info file". For versions of MS-Windows older than 653b3df2faaSAndrzej Pietrasiewicz XP, you'll need to download drivers from Microsoft's website; a URL 654b3df2faaSAndrzej Pietrasiewicz is given in comments found in that info file. 655b3df2faaSAndrzej Pietrasiewicz 65617b80976SAndrzej Pietrasiewiczconfig USB_CONFIGFS_EEM 65717b80976SAndrzej Pietrasiewicz bool "Ethernet Emulation Model (EEM)" 65817b80976SAndrzej Pietrasiewicz depends on USB_CONFIGFS 65917b80976SAndrzej Pietrasiewicz depends on NET 66017b80976SAndrzej Pietrasiewicz select USB_U_ETHER 66117b80976SAndrzej Pietrasiewicz select USB_F_EEM 66217b80976SAndrzej Pietrasiewicz help 66317b80976SAndrzej Pietrasiewicz CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM 66417b80976SAndrzej Pietrasiewicz and therefore can be supported by more hardware. Technically ECM and 66517b80976SAndrzej Pietrasiewicz EEM are designed for different applications. The ECM model extends 66617b80976SAndrzej Pietrasiewicz the network interface to the target (e.g. a USB cable modem), and the 66717b80976SAndrzej Pietrasiewicz EEM model is for mobile devices to communicate with hosts using 66817b80976SAndrzej Pietrasiewicz ethernet over USB. For Linux gadgets, however, the interface with 66917b80976SAndrzej Pietrasiewicz the host is the same (a usbX device), so the differences are minimal. 67017b80976SAndrzej Pietrasiewicz 67183408745SAndrzej Pietrasiewiczconfig USB_CONFIGFS_PHONET 67283408745SAndrzej Pietrasiewicz boolean "Phonet protocol" 67383408745SAndrzej Pietrasiewicz depends on USB_CONFIGFS 67483408745SAndrzej Pietrasiewicz depends on NET 67583408745SAndrzej Pietrasiewicz depends on PHONET 67683408745SAndrzej Pietrasiewicz select USB_U_ETHER 67783408745SAndrzej Pietrasiewicz select USB_F_PHONET 67883408745SAndrzej Pietrasiewicz help 67983408745SAndrzej Pietrasiewicz The Phonet protocol implementation for USB device. 68083408745SAndrzej Pietrasiewicz 6811da177e4SLinus Torvaldsconfig USB_ZERO 6821da177e4SLinus Torvalds tristate "Gadget Zero (DEVELOPMENT)" 683a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 684cf9a08aeSSebastian Andrzej Siewior select USB_F_SS_LB 6851da177e4SLinus Torvalds help 6861da177e4SLinus Torvalds Gadget Zero is a two-configuration device. It either sinks and 6871da177e4SLinus Torvalds sources bulk data; or it loops back a configurable number of 6881da177e4SLinus Torvalds transfers. It also implements control requests, for "chapter 9" 6891da177e4SLinus Torvalds conformance. The driver needs only two bulk-capable endpoints, so 6901da177e4SLinus Torvalds it can work on top of most device-side usb controllers. It's 6911da177e4SLinus Torvalds useful for testing, and is also a working example showing how 6921da177e4SLinus Torvalds USB "gadget drivers" can be written. 6931da177e4SLinus Torvalds 6941da177e4SLinus Torvalds Make this be the first driver you try using on top of any new 6951da177e4SLinus Torvalds USB peripheral controller driver. Then you can use host-side 6961da177e4SLinus Torvalds test software, like the "usbtest" driver, to put your hardware 6971da177e4SLinus Torvalds and its driver through a basic set of functional tests. 6981da177e4SLinus Torvalds 6991da177e4SLinus Torvalds Gadget Zero also works with the host-side "usb-skeleton" driver, 7001da177e4SLinus Torvalds and with many kinds of host-side test software. You may need 7011da177e4SLinus Torvalds to tweak product and vendor IDs before host software knows about 7021da177e4SLinus Torvalds this device, and arrange to select an appropriate configuration. 7031da177e4SLinus Torvalds 7041da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 7051da177e4SLinus Torvalds dynamically linked module called "g_zero". 7061da177e4SLinus Torvalds 7071da177e4SLinus Torvaldsconfig USB_ZERO_HNPTEST 7081da177e4SLinus Torvalds boolean "HNP Test Device" 7091da177e4SLinus Torvalds depends on USB_ZERO && USB_OTG 7101da177e4SLinus Torvalds help 7111da177e4SLinus Torvalds You can configure this device to enumerate using the device 7121da177e4SLinus Torvalds identifiers of the USB-OTG test device. That means that when 7131da177e4SLinus Torvalds this gadget connects to another OTG device, with this one using 7141da177e4SLinus Torvalds the "B-Peripheral" role, that device will use HNP to let this 7151da177e4SLinus Torvalds one serve as the USB host instead (in the "B-Host" role). 7161da177e4SLinus Torvalds 717c6994e6fSBryan Wuconfig USB_AUDIO 718eb83be98SGreg Kroah-Hartman tristate "Audio Gadget" 719c6994e6fSBryan Wu depends on SND 720a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 72104950737SRandy Dunlap select SND_PCM 722c6994e6fSBryan Wu help 723132fcb46SJassi Brar This Gadget Audio driver is compatible with USB Audio Class 724132fcb46SJassi Brar specification 2.0. It implements 1 AudioControl interface, 725132fcb46SJassi Brar 1 AudioStreaming Interface each for USB-OUT and USB-IN. 726132fcb46SJassi Brar Number of channels, sample rate and sample size can be 727132fcb46SJassi Brar specified as module parameters. 728132fcb46SJassi Brar This driver doesn't expect any real Audio codec to be present 729132fcb46SJassi Brar on the device - the audio streams are simply sinked to and 730132fcb46SJassi Brar sourced from a virtual ALSA sound card created. The user-space 731132fcb46SJassi Brar application may choose to do whatever it wants with the data 732132fcb46SJassi Brar received from the USB Host and choose to provide whatever it 733132fcb46SJassi Brar wants as audio data to the USB Host. 734c6994e6fSBryan Wu 735c6994e6fSBryan Wu Say "y" to link the driver statically, or "m" to build a 736c6994e6fSBryan Wu dynamically linked module called "g_audio". 737c6994e6fSBryan Wu 738132fcb46SJassi Brarconfig GADGET_UAC1 739132fcb46SJassi Brar bool "UAC 1.0 (Legacy)" 740132fcb46SJassi Brar depends on USB_AUDIO 741132fcb46SJassi Brar help 742132fcb46SJassi Brar If you instead want older UAC Spec-1.0 driver that also has audio 743132fcb46SJassi Brar paths hardwired to the Audio codec chip on-board and doesn't work 744132fcb46SJassi Brar without one. 745132fcb46SJassi Brar 7461da177e4SLinus Torvaldsconfig USB_ETH 7471da177e4SLinus Torvalds tristate "Ethernet Gadget (with CDC Ethernet support)" 7481da177e4SLinus Torvalds depends on NET 749a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 750f1a1823fSAndrzej Pietrasiewicz select USB_U_ETHER 751cbbd14a9SAndrzej Pietrasiewicz select USB_U_RNDIS 7529c62ce83SAndrzej Pietrasiewicz select USB_F_ECM 7538af5232dSAndrzej Pietrasiewicz select USB_F_SUBSET 7549e221be8SRandy Dunlap select CRC32 7551da177e4SLinus Torvalds help 7569b39e9ddSBrian Niebuhr This driver implements Ethernet style communication, in one of 7579b39e9ddSBrian Niebuhr several ways: 7581da177e4SLinus Torvalds 7591da177e4SLinus Torvalds - The "Communication Device Class" (CDC) Ethernet Control Model. 7601da177e4SLinus Torvalds That protocol is often avoided with pure Ethernet adapters, in 7611da177e4SLinus Torvalds favor of simpler vendor-specific hardware, but is widely 7621da177e4SLinus Torvalds supported by firmware for smart network devices. 7631da177e4SLinus Torvalds 7641da177e4SLinus Torvalds - On hardware can't implement that protocol, a simple CDC subset 7651da177e4SLinus Torvalds is used, placing fewer demands on USB. 7661da177e4SLinus Torvalds 7679b39e9ddSBrian Niebuhr - CDC Ethernet Emulation Model (EEM) is a newer standard that has 7689b39e9ddSBrian Niebuhr a simpler interface that can be used by more USB hardware. 7699b39e9ddSBrian Niebuhr 7709b39e9ddSBrian Niebuhr RNDIS support is an additional option, more demanding than than 7719b39e9ddSBrian Niebuhr subset. 7721da177e4SLinus Torvalds 7731da177e4SLinus Torvalds Within the USB device, this gadget driver exposes a network device 7741da177e4SLinus Torvalds "usbX", where X depends on what other networking devices you have. 7751da177e4SLinus Torvalds Treat it like a two-node Ethernet link: host, and gadget. 7761da177e4SLinus Torvalds 7771da177e4SLinus Torvalds The Linux-USB host-side "usbnet" driver interoperates with this 7781da177e4SLinus Torvalds driver, so that deep I/O queues can be supported. On 2.4 kernels, 7791da177e4SLinus Torvalds use "CDCEther" instead, if you're using the CDC option. That CDC 7801da177e4SLinus Torvalds mode should also interoperate with standard CDC Ethernet class 7811da177e4SLinus Torvalds drivers on other host operating systems. 7821da177e4SLinus Torvalds 7831da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 7841da177e4SLinus Torvalds dynamically linked module called "g_ether". 7851da177e4SLinus Torvalds 7861da177e4SLinus Torvaldsconfig USB_ETH_RNDIS 787afd0e0f2SRobert P. J. Day bool "RNDIS support" 788afd0e0f2SRobert P. J. Day depends on USB_ETH 789a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 7909bd4a10eSAndrzej Pietrasiewicz select USB_F_RNDIS 7911da177e4SLinus Torvalds default y 7921da177e4SLinus Torvalds help 7931da177e4SLinus Torvalds Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol, 7941da177e4SLinus Torvalds and Microsoft provides redistributable binary RNDIS drivers for 7951da177e4SLinus Torvalds older versions of Windows. 7961da177e4SLinus Torvalds 7971da177e4SLinus Torvalds If you say "y" here, the Ethernet gadget driver will try to provide 7981da177e4SLinus Torvalds a second device configuration, supporting RNDIS to talk to such 7991da177e4SLinus Torvalds Microsoft USB hosts. 8001da177e4SLinus Torvalds 8011da177e4SLinus Torvalds To make MS-Windows work with this, use Documentation/usb/linux.inf 8021da177e4SLinus Torvalds as the "driver info file". For versions of MS-Windows older than 8031da177e4SLinus Torvalds XP, you'll need to download drivers from Microsoft's website; a URL 8041da177e4SLinus Torvalds is given in comments found in that info file. 8051da177e4SLinus Torvalds 8069b39e9ddSBrian Niebuhrconfig USB_ETH_EEM 8079b39e9ddSBrian Niebuhr bool "Ethernet Emulation Model (EEM) support" 8089b39e9ddSBrian Niebuhr depends on USB_ETH 809a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 81094b5573eSAndrzej Pietrasiewicz select USB_F_EEM 8119b39e9ddSBrian Niebuhr default n 8129b39e9ddSBrian Niebuhr help 8139b39e9ddSBrian Niebuhr CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM 8149b39e9ddSBrian Niebuhr and therefore can be supported by more hardware. Technically ECM and 8159b39e9ddSBrian Niebuhr EEM are designed for different applications. The ECM model extends 8169b39e9ddSBrian Niebuhr the network interface to the target (e.g. a USB cable modem), and the 8179b39e9ddSBrian Niebuhr EEM model is for mobile devices to communicate with hosts using 8189b39e9ddSBrian Niebuhr ethernet over USB. For Linux gadgets, however, the interface with 8199b39e9ddSBrian Niebuhr the host is the same (a usbX device), so the differences are minimal. 8209b39e9ddSBrian Niebuhr 8219b39e9ddSBrian Niebuhr If you say "y" here, the Ethernet gadget driver will use the EEM 8229b39e9ddSBrian Niebuhr protocol rather than ECM. If unsure, say "n". 8239b39e9ddSBrian Niebuhr 8246c34d288SYauheni Kaliutaconfig USB_G_NCM 8256c34d288SYauheni Kaliuta tristate "Network Control Model (NCM) support" 8266c34d288SYauheni Kaliuta depends on NET 827a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 828f1a1823fSAndrzej Pietrasiewicz select USB_U_ETHER 8299575bcf9SAndrzej Pietrasiewicz select USB_F_NCM 8306c34d288SYauheni Kaliuta select CRC32 8316c34d288SYauheni Kaliuta help 8326c34d288SYauheni Kaliuta This driver implements USB CDC NCM subclass standard. NCM is 8336c34d288SYauheni Kaliuta an advanced protocol for Ethernet encapsulation, allows grouping 834b55dd320SFabio Baltieri of several ethernet frames into one USB transfer and different 8356c34d288SYauheni Kaliuta alignment possibilities. 8366c34d288SYauheni Kaliuta 8376c34d288SYauheni Kaliuta Say "y" to link the driver statically, or "m" to build a 8386c34d288SYauheni Kaliuta dynamically linked module called "g_ncm". 8396c34d288SYauheni Kaliuta 8401da177e4SLinus Torvaldsconfig USB_GADGETFS 841eb83be98SGreg Kroah-Hartman tristate "Gadget Filesystem" 8421da177e4SLinus Torvalds help 8431da177e4SLinus Torvalds This driver provides a filesystem based API that lets user mode 8441da177e4SLinus Torvalds programs implement a single-configuration USB device, including 8451da177e4SLinus Torvalds endpoint I/O and control requests that don't relate to enumeration. 8461da177e4SLinus Torvalds All endpoints, transfer speeds, and transfer types supported by 8471da177e4SLinus Torvalds the hardware are available, through read() and write() calls. 8481da177e4SLinus Torvalds 8491da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 8501da177e4SLinus Torvalds dynamically linked module called "gadgetfs". 8511da177e4SLinus Torvalds 852c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS 853eb83be98SGreg Kroah-Hartman tristate "Function Filesystem" 854a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 855f8dae531SMichal Nazarewicz select USB_FUNCTIONFS_GENERIC if !(USB_FUNCTIONFS_ETH || USB_FUNCTIONFS_RNDIS) 856c6c56008SMichal Nazarewicz help 857eabf0f5fSMichael Prokop The Function Filesystem (FunctionFS) lets one create USB 858eabf0f5fSMichael Prokop composite functions in user space in the same way GadgetFS 859c6c56008SMichal Nazarewicz lets one create USB gadgets in user space. This allows creation 860c6c56008SMichal Nazarewicz of composite gadgets such that some of the functions are 861c6c56008SMichal Nazarewicz implemented in kernel space (for instance Ethernet, serial or 862c6c56008SMichal Nazarewicz mass storage) and other are implemented in user space. 863c6c56008SMichal Nazarewicz 864f8dae531SMichal Nazarewicz If you say "y" or "m" here you will be able what kind of 865f8dae531SMichal Nazarewicz configurations the gadget will provide. 866f8dae531SMichal Nazarewicz 867c6c56008SMichal Nazarewicz Say "y" to link the driver statically, or "m" to build 868c6c56008SMichal Nazarewicz a dynamically linked module called "g_ffs". 869c6c56008SMichal Nazarewicz 870c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_ETH 871f8dae531SMichal Nazarewicz bool "Include configuration with CDC ECM (Ethernet)" 87217b2765eSRandy Dunlap depends on USB_FUNCTIONFS && NET 873f1a1823fSAndrzej Pietrasiewicz select USB_U_ETHER 874c6c56008SMichal Nazarewicz help 875eabf0f5fSMichael Prokop Include a configuration with CDC ECM function (Ethernet) and the 876eabf0f5fSMichael Prokop Function Filesystem. 877c6c56008SMichal Nazarewicz 878c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_RNDIS 879f8dae531SMichal Nazarewicz bool "Include configuration with RNDIS (Ethernet)" 88017b2765eSRandy Dunlap depends on USB_FUNCTIONFS && NET 881f1a1823fSAndrzej Pietrasiewicz select USB_U_ETHER 882cbbd14a9SAndrzej Pietrasiewicz select USB_U_RNDIS 883c6c56008SMichal Nazarewicz help 884eabf0f5fSMichael Prokop Include a configuration with RNDIS function (Ethernet) and the Filesystem. 885c6c56008SMichal Nazarewicz 886c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_GENERIC 887c6c56008SMichal Nazarewicz bool "Include 'pure' configuration" 888f8dae531SMichal Nazarewicz depends on USB_FUNCTIONFS 889c6c56008SMichal Nazarewicz help 890f8dae531SMichal Nazarewicz Include a configuration with the Function Filesystem alone with 891f8dae531SMichal Nazarewicz no Ethernet interface. 892c6c56008SMichal Nazarewicz 893d23b0f08SMichal Nazarewiczconfig USB_MASS_STORAGE 894d23b0f08SMichal Nazarewicz tristate "Mass Storage Gadget" 895d23b0f08SMichal Nazarewicz depends on BLOCK 896a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 897d23b0f08SMichal Nazarewicz help 898d23b0f08SMichal Nazarewicz The Mass Storage Gadget acts as a USB Mass Storage disk drive. 899d23b0f08SMichal Nazarewicz As its storage repository it can use a regular file or a block 900d23b0f08SMichal Nazarewicz device (in much the same way as the "loop" device driver), 901d23b0f08SMichal Nazarewicz specified as a module parameter or sysfs option. 902d23b0f08SMichal Nazarewicz 903fa06920aSMichal Nazarewicz This driver is a replacement for now removed File-backed 904fa06920aSMichal Nazarewicz Storage Gadget (g_file_storage). 905d23b0f08SMichal Nazarewicz 906d23b0f08SMichal Nazarewicz Say "y" to link the driver statically, or "m" to build 907664a51a8SAlan Stern a dynamically linked module called "g_mass_storage". 908d23b0f08SMichal Nazarewicz 909c52661d6SSebastian Andrzej Siewiorconfig USB_GADGET_TARGET 910c52661d6SSebastian Andrzej Siewior tristate "USB Gadget Target Fabric Module" 911c52661d6SSebastian Andrzej Siewior depends on TARGET_CORE 912a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 913c52661d6SSebastian Andrzej Siewior help 914c52661d6SSebastian Andrzej Siewior This fabric is an USB gadget. Two USB protocols are supported that is 915c52661d6SSebastian Andrzej Siewior BBB or BOT (Bulk Only Transport) and UAS (USB Attached SCSI). BOT is 916c52661d6SSebastian Andrzej Siewior advertised on alternative interface 0 (primary) and UAS is on 917c52661d6SSebastian Andrzej Siewior alternative interface 1. Both protocols can work on USB2.0 and USB3.0. 918c52661d6SSebastian Andrzej Siewior UAS utilizes the USB 3.0 feature called streams support. 919c52661d6SSebastian Andrzej Siewior 9201da177e4SLinus Torvaldsconfig USB_G_SERIAL 9213086775aSFelipe Balbi tristate "Serial Gadget (with CDC ACM and CDC OBEX support)" 9224f73bc4dSJoe Millenbach depends on TTY 9233249ca22SSebastian Andrzej Siewior select USB_U_SERIAL 924ff47f594SSebastian Andrzej Siewior select USB_F_ACM 92570cc3c02SAndrzej Pietrasiewicz select USB_F_SERIAL 926d1412794SAndrzej Pietrasiewicz select USB_F_OBEX 927a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 9281da177e4SLinus Torvalds help 9291da177e4SLinus Torvalds The Serial Gadget talks to the Linux-USB generic serial driver. 9301da177e4SLinus Torvalds This driver supports a CDC-ACM module option, which can be used 9311da177e4SLinus Torvalds to interoperate with MS-Windows hosts or with the Linux-USB 9321da177e4SLinus Torvalds "cdc-acm" driver. 9331da177e4SLinus Torvalds 9343086775aSFelipe Balbi This driver also supports a CDC-OBEX option. You will need a 9353086775aSFelipe Balbi user space OBEX server talking to /dev/ttyGS*, since the kernel 9363086775aSFelipe Balbi itself doesn't implement the OBEX protocol. 9373086775aSFelipe Balbi 9381da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 9391da177e4SLinus Torvalds dynamically linked module called "g_serial". 9401da177e4SLinus Torvalds 9411da177e4SLinus Torvalds For more information, see Documentation/usb/gadget_serial.txt 9421da177e4SLinus Torvalds which includes instructions and a "driver info file" needed to 9433086775aSFelipe Balbi make MS-Windows work with CDC ACM. 9441da177e4SLinus Torvalds 945f2ebf92cSBen Williamsonconfig USB_MIDI_GADGET 946eb83be98SGreg Kroah-Hartman tristate "MIDI Gadget" 947eb83be98SGreg Kroah-Hartman depends on SND 948a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 949f2ebf92cSBen Williamson select SND_RAWMIDI 950f2ebf92cSBen Williamson help 951f2ebf92cSBen Williamson The MIDI Gadget acts as a USB Audio device, with one MIDI 952f2ebf92cSBen Williamson input and one MIDI output. These MIDI jacks appear as 953f2ebf92cSBen Williamson a sound "card" in the ALSA sound system. Other MIDI 954f2ebf92cSBen Williamson connections can then be made on the gadget system, using 955f2ebf92cSBen Williamson ALSA's aconnect utility etc. 956f2ebf92cSBen Williamson 957f2ebf92cSBen Williamson Say "y" to link the driver statically, or "m" to build a 958f2ebf92cSBen Williamson dynamically linked module called "g_midi". 959f2ebf92cSBen Williamson 96025a010c8SCraig W. Nadlerconfig USB_G_PRINTER 96125a010c8SCraig W. Nadler tristate "Printer Gadget" 962a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 96325a010c8SCraig W. Nadler help 96425a010c8SCraig W. Nadler The Printer Gadget channels data between the USB host and a 96525a010c8SCraig W. Nadler userspace program driving the print engine. The user space 96625a010c8SCraig W. Nadler program reads and writes the device file /dev/g_printer to 96725a010c8SCraig W. Nadler receive or send printer data. It can use ioctl calls to 96825a010c8SCraig W. Nadler the device file to get or set printer status. 96925a010c8SCraig W. Nadler 97025a010c8SCraig W. Nadler Say "y" to link the driver statically, or "m" to build a 97125a010c8SCraig W. Nadler dynamically linked module called "g_printer". 97225a010c8SCraig W. Nadler 97325a010c8SCraig W. Nadler For more information, see Documentation/usb/gadget_printer.txt 97425a010c8SCraig W. Nadler which includes sample code for accessing the device file. 9751da177e4SLinus Torvalds 9764f73bc4dSJoe Millenbachif TTY 9774f73bc4dSJoe Millenbach 97819e20680SDavid Brownellconfig USB_CDC_COMPOSITE 97919e20680SDavid Brownell tristate "CDC Composite Device (Ethernet and ACM)" 9804ddd9ec1SRandy Dunlap depends on NET 981a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 9823249ca22SSebastian Andrzej Siewior select USB_U_SERIAL 983f1a1823fSAndrzej Pietrasiewicz select USB_U_ETHER 98429a6645fSSebastian Andrzej Siewior select USB_F_ACM 985a38a2750SAndrzej Pietrasiewicz select USB_F_ECM 98619e20680SDavid Brownell help 98719e20680SDavid Brownell This driver provides two functions in one configuration: 98819e20680SDavid Brownell a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link. 98919e20680SDavid Brownell 99019e20680SDavid Brownell This driver requires four bulk and two interrupt endpoints, 99119e20680SDavid Brownell plus the ability to handle altsettings. Not all peripheral 99219e20680SDavid Brownell controllers are that capable. 99319e20680SDavid Brownell 99419e20680SDavid Brownell Say "y" to link the driver statically, or "m" to build a 99519e20680SDavid Brownell dynamically linked module. 99619e20680SDavid Brownell 997f358f5b4SFelipe Balbiconfig USB_G_NOKIA 998f358f5b4SFelipe Balbi tristate "Nokia composite gadget" 999f358f5b4SFelipe Balbi depends on PHONET 1000a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 10013249ca22SSebastian Andrzej Siewior select USB_U_SERIAL 1002f1a1823fSAndrzej Pietrasiewicz select USB_U_ETHER 100315761826SSebastian Andrzej Siewior select USB_F_ACM 10043a343449SAndrzej Pietrasiewicz select USB_F_OBEX 100583167f12SAndrzej Pietrasiewicz select USB_F_PHONET 1006b904d081SAndrzej Pietrasiewicz select USB_F_ECM 1007f358f5b4SFelipe Balbi help 1008f358f5b4SFelipe Balbi The Nokia composite gadget provides support for acm, obex 1009f358f5b4SFelipe Balbi and phonet in only one composite gadget driver. 1010f358f5b4SFelipe Balbi 1011f358f5b4SFelipe Balbi It's only really useful for N900 hardware. If you're building 1012f358f5b4SFelipe Balbi a kernel for N900, say Y or M here. If unsure, say N. 1013f358f5b4SFelipe Balbi 1014fa3ae0c1SKlaus Schwarzkopfconfig USB_G_ACM_MS 1015fa3ae0c1SKlaus Schwarzkopf tristate "CDC Composite Device (ACM and mass storage)" 1016fa3ae0c1SKlaus Schwarzkopf depends on BLOCK 1017a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 10183249ca22SSebastian Andrzej Siewior select USB_U_SERIAL 10195f72bbfdSSebastian Andrzej Siewior select USB_F_ACM 1020fa3ae0c1SKlaus Schwarzkopf help 1021fa3ae0c1SKlaus Schwarzkopf This driver provides two functions in one configuration: 1022fa3ae0c1SKlaus Schwarzkopf a mass storage, and a CDC ACM (serial port) link. 1023fa3ae0c1SKlaus Schwarzkopf 1024fa3ae0c1SKlaus Schwarzkopf Say "y" to link the driver statically, or "m" to build a 1025fa3ae0c1SKlaus Schwarzkopf dynamically linked module called "g_acm_ms". 1026fa3ae0c1SKlaus Schwarzkopf 1027f176a5d8SMichal Nazarewiczconfig USB_G_MULTI 1028eb83be98SGreg Kroah-Hartman tristate "Multifunction Composite Gadget" 10295791e103SRandy Dunlap depends on BLOCK && NET 1030279cc49aSMichal Nazarewicz select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS 1031a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 10323249ca22SSebastian Andrzej Siewior select USB_U_SERIAL 1033f1a1823fSAndrzej Pietrasiewicz select USB_U_ETHER 1034cbbd14a9SAndrzej Pietrasiewicz select USB_U_RNDIS 103559835ad7SSebastian Andrzej Siewior select USB_F_ACM 1036f176a5d8SMichal Nazarewicz help 1037f176a5d8SMichal Nazarewicz The Multifunction Composite Gadget provides Ethernet (RNDIS 1038f176a5d8SMichal Nazarewicz and/or CDC Ethernet), mass storage and ACM serial link 1039f176a5d8SMichal Nazarewicz interfaces. 1040f176a5d8SMichal Nazarewicz 10415791e103SRandy Dunlap You will be asked to choose which of the two configurations is 1042f176a5d8SMichal Nazarewicz to be available in the gadget. At least one configuration must 10435791e103SRandy Dunlap be chosen to make the gadget usable. Selecting more than one 1044f176a5d8SMichal Nazarewicz configuration will prevent Windows from automatically detecting 10455791e103SRandy Dunlap the gadget as a composite gadget, so an INF file will be needed to 1046f176a5d8SMichal Nazarewicz use the gadget. 1047f176a5d8SMichal Nazarewicz 1048f176a5d8SMichal Nazarewicz Say "y" to link the driver statically, or "m" to build a 1049f176a5d8SMichal Nazarewicz dynamically linked module called "g_multi". 1050f176a5d8SMichal Nazarewicz 1051f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_RNDIS 1052f176a5d8SMichal Nazarewicz bool "RNDIS + CDC Serial + Storage configuration" 1053f176a5d8SMichal Nazarewicz depends on USB_G_MULTI 1054f176a5d8SMichal Nazarewicz default y 1055f176a5d8SMichal Nazarewicz help 1056f176a5d8SMichal Nazarewicz This option enables a configuration with RNDIS, CDC Serial and 1057f176a5d8SMichal Nazarewicz Mass Storage functions available in the Multifunction Composite 10585791e103SRandy Dunlap Gadget. This is the configuration dedicated for Windows since RNDIS 10595791e103SRandy Dunlap is Microsoft's protocol. 1060f176a5d8SMichal Nazarewicz 1061f176a5d8SMichal Nazarewicz If unsure, say "y". 1062f176a5d8SMichal Nazarewicz 1063f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_CDC 1064f176a5d8SMichal Nazarewicz bool "CDC Ethernet + CDC Serial + Storage configuration" 1065f176a5d8SMichal Nazarewicz depends on USB_G_MULTI 1066f176a5d8SMichal Nazarewicz default n 1067f176a5d8SMichal Nazarewicz help 1068f176a5d8SMichal Nazarewicz This option enables a configuration with CDC Ethernet (ECM), CDC 1069f176a5d8SMichal Nazarewicz Serial and Mass Storage functions available in the Multifunction 10705791e103SRandy Dunlap Composite Gadget. 1071f176a5d8SMichal Nazarewicz 1072f176a5d8SMichal Nazarewicz If unsure, say "y". 1073f176a5d8SMichal Nazarewicz 10744f73bc4dSJoe Millenbachendif # TTY 10754f73bc4dSJoe Millenbach 107671adf118SFabien Chouteauconfig USB_G_HID 107771adf118SFabien Chouteau tristate "HID Gadget" 1078a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 107971adf118SFabien Chouteau help 108071adf118SFabien Chouteau The HID gadget driver provides generic emulation of USB 108171adf118SFabien Chouteau Human Interface Devices (HID). 108271adf118SFabien Chouteau 108371adf118SFabien Chouteau For more information, see Documentation/usb/gadget_hid.txt which 108471adf118SFabien Chouteau includes sample code for accessing the device files. 108571adf118SFabien Chouteau 108671adf118SFabien Chouteau Say "y" to link the driver statically, or "m" to build a 108771adf118SFabien Chouteau dynamically linked module called "g_hid". 1088f176a5d8SMichal Nazarewicz 1089a84d9e53SSebastian Andrzej Siewior# Standalone / single function gadgets 1090f6c826a9Sstephane duvergerconfig USB_G_DBGP 1091f6c826a9Sstephane duverger tristate "EHCI Debug Device Gadget" 10924f73bc4dSJoe Millenbach depends on TTY 1093a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 1094f6c826a9Sstephane duverger help 1095f6c826a9Sstephane duverger This gadget emulates an EHCI Debug device. This is useful when you want 1096f6c826a9Sstephane duverger to interact with an EHCI Debug Port. 1097f6c826a9Sstephane duverger 1098f6c826a9Sstephane duverger Say "y" to link the driver statically, or "m" to build a 1099f6c826a9Sstephane duverger dynamically linked module called "g_dbgp". 1100f6c826a9Sstephane duverger 1101f6c826a9Sstephane duvergerif USB_G_DBGP 1102f6c826a9Sstephane duvergerchoice 1103f6c826a9Sstephane duverger prompt "EHCI Debug Device mode" 1104f6c826a9Sstephane duverger default USB_G_DBGP_SERIAL 1105f6c826a9Sstephane duverger 1106f6c826a9Sstephane duvergerconfig USB_G_DBGP_PRINTK 1107f6c826a9Sstephane duverger depends on USB_G_DBGP 1108f6c826a9Sstephane duverger bool "printk" 1109f6c826a9Sstephane duverger help 1110f6c826a9Sstephane duverger Directly printk() received data. No interaction. 1111f6c826a9Sstephane duverger 1112f6c826a9Sstephane duvergerconfig USB_G_DBGP_SERIAL 1113f6c826a9Sstephane duverger depends on USB_G_DBGP 11143249ca22SSebastian Andrzej Siewior select USB_U_SERIAL 1115f6c826a9Sstephane duverger bool "serial" 1116f6c826a9Sstephane duverger help 1117f6c826a9Sstephane duverger Userland can interact using /dev/ttyGSxxx. 1118f6c826a9Sstephane duvergerendchoice 1119f6c826a9Sstephane duvergerendif 1120f6c826a9Sstephane duverger 11211da177e4SLinus Torvalds# put drivers that need isochronous transfer support (for audio 11221da177e4SLinus Torvalds# or video class gadget drivers), or specific hardware, here. 1123a9914127SLaurent Pinchartconfig USB_G_WEBCAM 1124a9914127SLaurent Pinchart tristate "USB Webcam Gadget" 112524337c13SRandy Dunlap depends on VIDEO_DEV 11260b2ffb78SLaurent Pinchart select USB_LIBCOMPOSITE 1127d6925225SBhupesh Sharma select VIDEOBUF2_VMALLOC 1128a9914127SLaurent Pinchart help 1129a9914127SLaurent Pinchart The Webcam Gadget acts as a composite USB Audio and Video Class 1130a9914127SLaurent Pinchart device. It provides a userspace API to process UVC control requests 1131a9914127SLaurent Pinchart and stream video data to the host. 11321da177e4SLinus Torvalds 1133a9914127SLaurent Pinchart Say "y" to link the driver statically, or "m" to build a 1134a9914127SLaurent Pinchart dynamically linked module called "g_webcam". 11351da177e4SLinus Torvalds 11361da177e4SLinus Torvaldsendchoice 11371da177e4SLinus Torvalds 1138b75be4abSDenis Chengendif # USB_GADGET 1139