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 61cd108691SAndreas Larssonconfig USB_GADGET_VERBOSE 62cd108691SAndreas Larsson bool "Verbose debugging Messages (DEVELOPMENT)" 63cd108691SAndreas Larsson depends on USB_GADGET_DEBUG 64cd108691SAndreas Larsson help 65cd108691SAndreas Larsson Many controller and gadget drivers will print verbose debugging 66cd108691SAndreas Larsson messages if you use this option to ask for those messages. 67cd108691SAndreas Larsson 68cd108691SAndreas Larsson Avoid enabling these messages, even if you're actively 69cd108691SAndreas Larsson debugging such a driver. Many drivers will emit so many 70cd108691SAndreas Larsson messages that the driver timings are affected, which will 71cd108691SAndreas Larsson either create new failure modes or remove the one you're 72cd108691SAndreas Larsson trying to track down. Never enable these messages for a 73cd108691SAndreas Larsson production build. 74cd108691SAndreas Larsson 751da177e4SLinus Torvaldsconfig USB_GADGET_DEBUG_FILES 76afd0e0f2SRobert P. J. Day boolean "Debugging information files (DEVELOPMENT)" 7736e893d2SDavid Brownell depends on PROC_FS 781da177e4SLinus Torvalds help 791da177e4SLinus Torvalds Some of the drivers in the "gadget" framework can expose 801da177e4SLinus Torvalds debugging information in files such as /proc/driver/udc 811da177e4SLinus Torvalds (for a peripheral controller). The information in these 821da177e4SLinus Torvalds files may help when you're troubleshooting or bringing up a 831da177e4SLinus Torvalds driver on a new board. Enable these files by choosing "Y" 841da177e4SLinus Torvalds here. If in doubt, or to conserve kernel memory, say "N". 851da177e4SLinus Torvalds 86914a3f3bSHaavard Skinnemoenconfig USB_GADGET_DEBUG_FS 87afd0e0f2SRobert P. J. Day boolean "Debugging information files in debugfs (DEVELOPMENT)" 8836e893d2SDavid Brownell depends on DEBUG_FS 89914a3f3bSHaavard Skinnemoen help 90914a3f3bSHaavard Skinnemoen Some of the drivers in the "gadget" framework can expose 91914a3f3bSHaavard Skinnemoen debugging information in files under /sys/kernel/debug/. 92914a3f3bSHaavard Skinnemoen The information in these files may help when you're 93914a3f3bSHaavard Skinnemoen troubleshooting or bringing up a driver on a new board. 94914a3f3bSHaavard Skinnemoen Enable these files by choosing "Y" here. If in doubt, or 95914a3f3bSHaavard Skinnemoen to conserve kernel memory, say "N". 96914a3f3bSHaavard Skinnemoen 9736e893d2SDavid Brownellconfig USB_GADGET_VBUS_DRAW 9836e893d2SDavid Brownell int "Maximum VBUS Power usage (2-500 mA)" 9936e893d2SDavid Brownell range 2 500 10036e893d2SDavid Brownell default 2 10136e893d2SDavid Brownell help 10236e893d2SDavid Brownell Some devices need to draw power from USB when they are 10336e893d2SDavid Brownell configured, perhaps to operate circuitry or to recharge 10436e893d2SDavid Brownell batteries. This is in addition to any local power supply, 10536e893d2SDavid Brownell such as an AC adapter or batteries. 10636e893d2SDavid Brownell 10736e893d2SDavid Brownell Enter the maximum power your device draws through USB, in 10836e893d2SDavid Brownell milliAmperes. The permitted range of values is 2 - 500 mA; 10936e893d2SDavid Brownell 0 mA would be legal, but can make some hosts misbehave. 11036e893d2SDavid Brownell 11136e893d2SDavid Brownell This value will be used except for system-specific gadget 11236e893d2SDavid Brownell drivers that have more specific information. 11336e893d2SDavid Brownell 1146532c7fdSPer Forlinconfig USB_GADGET_STORAGE_NUM_BUFFERS 1156532c7fdSPer Forlin int "Number of storage pipeline buffers" 1166532c7fdSPer Forlin range 2 4 1176532c7fdSPer Forlin default 2 1186532c7fdSPer Forlin help 1196532c7fdSPer Forlin Usually 2 buffers are enough to establish a good buffering 1206532c7fdSPer Forlin pipeline. The number may be increased in order to compensate 1216532c7fdSPer Forlin for a bursty VFS behaviour. For instance there may be CPU wake up 1226532c7fdSPer Forlin latencies that makes the VFS to appear bursty in a system with 1236532c7fdSPer Forlin an CPU on-demand governor. Especially if DMA is doing IO to 1246532c7fdSPer Forlin offload the CPU. In this case the CPU will go into power 1256532c7fdSPer Forlin save often and spin up occasionally to move data within VFS. 1266532c7fdSPer Forlin If selecting USB_GADGET_DEBUG_FILES this value may be set by 1276532c7fdSPer Forlin a module parameter as well. 1286532c7fdSPer Forlin If unsure, say 2. 1296532c7fdSPer Forlin 1301da177e4SLinus Torvalds# 1311da177e4SLinus Torvalds# USB Peripheral Controller Support 1321da177e4SLinus Torvalds# 133a7a19facSDavid Brownell# The order here is alphabetical, except that integrated controllers go 134a7a19facSDavid Brownell# before discrete ones so they will be the initial/default value: 135a7a19facSDavid Brownell# - integrated/SOC controllers first 136a7a19facSDavid Brownell# - licensed IP used in both SOC and discrete versions 137a7a19facSDavid Brownell# - discrete ones (including all PCI-only controllers) 138a7a19facSDavid Brownell# - debug/dummy gadget+hcd is last. 139a7a19facSDavid Brownell# 140ed6c6f41SAlexander Shishkinmenu "USB Peripheral Controller" 1411da177e4SLinus Torvalds 142a7a19facSDavid Brownell# 143a7a19facSDavid Brownell# Integrated controllers 144a7a19facSDavid Brownell# 145a7a19facSDavid Brownell 146193ab2a6SFelipe Balbiconfig USB_AT91 147193ab2a6SFelipe Balbi tristate "Atmel AT91 USB Device Port" 148d1494a34SJean-Christophe PLAGNIOL-VILLARD depends on ARCH_AT91 14955d402d8SThomas Dahlmann help 150a7a19facSDavid Brownell Many Atmel AT91 processors (such as the AT91RM2000) have a 151a7a19facSDavid Brownell full speed USB Device Port with support for five configurable 152a7a19facSDavid Brownell endpoints (plus endpoint zero). 15355d402d8SThomas Dahlmann 15455d402d8SThomas Dahlmann Say "y" to link the driver statically, or "m" to build a 155a7a19facSDavid Brownell dynamically linked module called "at91_udc" and force all 15655d402d8SThomas Dahlmann gadget drivers to also be dynamically linked. 15755d402d8SThomas Dahlmann 15824a28e42SRoland Stiggeconfig USB_LPC32XX 15924a28e42SRoland Stigge tristate "LPC32XX USB Peripheral Controller" 16024a28e42SRoland Stigge depends on ARCH_LPC32XX 16124a28e42SRoland Stigge select USB_ISP1301 16224a28e42SRoland Stigge help 16324a28e42SRoland Stigge This option selects the USB device controller in the LPC32xx SoC. 16424a28e42SRoland Stigge 16524a28e42SRoland Stigge Say "y" to link the driver statically, or "m" to build a 16624a28e42SRoland Stigge dynamically linked module called "lpc32xx_udc" and force all 16724a28e42SRoland Stigge gadget drivers to also be dynamically linked. 16824a28e42SRoland Stigge 169193ab2a6SFelipe Balbiconfig USB_ATMEL_USBA 170193ab2a6SFelipe Balbi tristate "Atmel USBA" 1714a3ae932SJean-Christophe PLAGNIOL-VILLARD depends on AVR32 || ARCH_AT91 172914a3f3bSHaavard Skinnemoen help 173914a3f3bSHaavard Skinnemoen USBA is the integrated high-speed USB Device controller on 174ba45ca43SNicolas Ferre the AT32AP700x, some AT91SAM9 and AT91CAP9 processors from Atmel. 175914a3f3bSHaavard Skinnemoen 176613065e5SKevin Cernekeeconfig USB_BCM63XX_UDC 177613065e5SKevin Cernekee tristate "Broadcom BCM63xx Peripheral Controller" 178613065e5SKevin Cernekee depends on BCM63XX 179613065e5SKevin Cernekee help 180613065e5SKevin Cernekee Many Broadcom BCM63xx chipsets (such as the BCM6328) have a 181613065e5SKevin Cernekee high speed USB Device Port with support for four fixed endpoints 182613065e5SKevin Cernekee (plus endpoint zero). 183613065e5SKevin Cernekee 184613065e5SKevin Cernekee Say "y" to link the driver statically, or "m" to build a 185613065e5SKevin Cernekee dynamically linked module called "bcm63xx_udc". 186613065e5SKevin Cernekee 187193ab2a6SFelipe Balbiconfig USB_FSL_USB2 188193ab2a6SFelipe Balbi tristate "Freescale Highspeed USB DR Peripheral Controller" 18954e4026bSGuennadi Liakhovetski depends on FSL_SOC || ARCH_MXC 190018b97d0SMarc Kleine-Budde select USB_FSL_MPH_DR_OF if OF 191b504882dSLi Yang help 19200c16f9fSFabio Estevam Some of Freescale PowerPC and i.MX processors have a High Speed 193b504882dSLi Yang Dual-Role(DR) USB controller, which supports device mode. 194b504882dSLi Yang 195b504882dSLi Yang The number of programmable endpoints is different through 196b504882dSLi Yang SOC revisions. 197b504882dSLi Yang 198b504882dSLi Yang Say "y" to link the driver statically, or "m" to build a 199b504882dSLi Yang dynamically linked module called "fsl_usb2_udc" and force 200b504882dSLi Yang all gadget drivers to also be dynamically linked. 201b504882dSLi Yang 202193ab2a6SFelipe Balbiconfig USB_FUSB300 203193ab2a6SFelipe Balbi tristate "Faraday FUSB300 USB Peripheral Controller" 204b2fb945dSGeert Uytterhoeven depends on !PHYS_ADDR_T_64BIT && HAS_DMA 2050fe6f1d1SYuan-Hsin Chen help 2060fe6f1d1SYuan-Hsin Chen Faraday usb device controller FUSB300 driver 2070fe6f1d1SYuan-Hsin Chen 208b84a8deeSYuan-Hsin Chenconfig USB_FOTG210_UDC 209bfcbd020SGeert Uytterhoeven depends on HAS_DMA 210b84a8deeSYuan-Hsin Chen tristate "Faraday FOTG210 USB Peripheral Controller" 211b84a8deeSYuan-Hsin Chen help 212b84a8deeSYuan-Hsin Chen Faraday USB2.0 OTG controller which can be configured as 213b84a8deeSYuan-Hsin Chen high speed or full speed USB device. This driver supppors 214b84a8deeSYuan-Hsin Chen Bulk Transfer so far. 215b84a8deeSYuan-Hsin Chen 216b84a8deeSYuan-Hsin Chen Say "y" to link the driver statically, or "m" to build a 217b84a8deeSYuan-Hsin Chen dynamically linked module called "fotg210_udc". 218b84a8deeSYuan-Hsin Chen 219193ab2a6SFelipe Balbiconfig USB_OMAP 220193ab2a6SFelipe Balbi tristate "OMAP USB Device Controller" 221b924b204STony Lindgren depends on ARCH_OMAP1 222f1c9e151STony Lindgren select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3 || MACH_OMAP_H4_OTG 2231da177e4SLinus Torvalds help 2241da177e4SLinus Torvalds Many Texas Instruments OMAP processors have flexible full 2251da177e4SLinus Torvalds speed USB device controllers, with support for up to 30 2261da177e4SLinus Torvalds endpoints (plus endpoint zero). This driver supports the 2271da177e4SLinus Torvalds controller in the OMAP 1611, and should work with controllers 2281da177e4SLinus Torvalds in other OMAP processors too, given minor tweaks. 2291da177e4SLinus Torvalds 2301da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 2311da177e4SLinus Torvalds dynamically linked module called "omap_udc" and force all 2321da177e4SLinus Torvalds gadget drivers to also be dynamically linked. 2331da177e4SLinus Torvalds 234193ab2a6SFelipe Balbiconfig USB_PXA25X 235193ab2a6SFelipe Balbi tristate "PXA 25x or IXP 4xx" 236a7a19facSDavid Brownell depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX 237a7a19facSDavid Brownell help 238a7a19facSDavid Brownell Intel's PXA 25x series XScale ARM-5TE processors include 239a7a19facSDavid Brownell an integrated full speed USB 1.1 device controller. The 240a7a19facSDavid Brownell controller in the IXP 4xx series is register-compatible. 241a7a19facSDavid Brownell 242a7a19facSDavid Brownell It has fifteen fixed-function endpoints, as well as endpoint 243a7a19facSDavid Brownell zero (for control transfers). 244a7a19facSDavid Brownell 245a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 246a7a19facSDavid Brownell dynamically linked module called "pxa25x_udc" and force all 247a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 248a7a19facSDavid Brownell 249a7a19facSDavid Brownell# if there's only one gadget driver, using only two bulk endpoints, 250a7a19facSDavid Brownell# don't waste memory for the other endpoints 251a7a19facSDavid Brownellconfig USB_PXA25X_SMALL 252193ab2a6SFelipe Balbi depends on USB_PXA25X 253a7a19facSDavid Brownell bool 254a7a19facSDavid Brownell default n if USB_ETH_RNDIS 255a7a19facSDavid Brownell default y if USB_ZERO 256a7a19facSDavid Brownell default y if USB_ETH 257a7a19facSDavid Brownell default y if USB_G_SERIAL 258a7a19facSDavid Brownell 259193ab2a6SFelipe Balbiconfig USB_R8A66597 260193ab2a6SFelipe Balbi tristate "Renesas R8A66597 USB Peripheral Controller" 2614ee4f23bSGeert Uytterhoeven depends on HAS_DMA 262c4144247SYoshihiro Shimoda help 263c4144247SYoshihiro Shimoda R8A66597 is a discrete USB host and peripheral controller chip that 264c4144247SYoshihiro Shimoda supports both full and high speed USB 2.0 data transfers. 265c4144247SYoshihiro Shimoda It has nine configurable endpoints, and endpoint zero. 266c4144247SYoshihiro Shimoda 267c4144247SYoshihiro Shimoda Say "y" to link the driver statically, or "m" to build a 268c4144247SYoshihiro Shimoda dynamically linked module called "r8a66597_udc" and force all 269c4144247SYoshihiro Shimoda gadget drivers to also be dynamically linked. 270c4144247SYoshihiro Shimoda 271030ed1fcSKuninori Morimotoconfig USB_RENESAS_USBHS_UDC 272193ab2a6SFelipe Balbi tristate 'Renesas USBHS controller' 273030ed1fcSKuninori Morimoto depends on USB_RENESAS_USBHS 2742f98382dSKuninori Morimoto help 275193ab2a6SFelipe Balbi Renesas USBHS is a discrete USB host and peripheral controller chip 276193ab2a6SFelipe Balbi that supports both full and high speed USB 2.0 data transfers. 277193ab2a6SFelipe Balbi It has nine or more configurable endpoints, and endpoint zero. 2782f98382dSKuninori Morimoto 279193ab2a6SFelipe Balbi Say "y" to link the driver statically, or "m" to build a 280193ab2a6SFelipe Balbi dynamically linked module called "renesas_usbhs" and force all 281193ab2a6SFelipe Balbi gadget drivers to also be dynamically linked. 2822f98382dSKuninori Morimoto 283193ab2a6SFelipe Balbiconfig USB_PXA27X 284193ab2a6SFelipe Balbi tristate "PXA 27x" 285a7a19facSDavid Brownell help 286a7a19facSDavid Brownell Intel's PXA 27x series XScale ARM v5TE processors include 287a7a19facSDavid Brownell an integrated full speed USB 1.1 device controller. 288a7a19facSDavid Brownell 289a7a19facSDavid Brownell It has up to 23 endpoints, as well as endpoint zero (for 290a7a19facSDavid Brownell control transfers). 291a7a19facSDavid Brownell 292a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 293a7a19facSDavid Brownell dynamically linked module called "pxa27x_udc" and force all 294a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 295a7a19facSDavid Brownell 296193ab2a6SFelipe Balbiconfig USB_S3C_HSOTG 297193ab2a6SFelipe Balbi tristate "S3C HS/OtG USB Device controller" 2985b7d70c6SBen Dooks depends on S3C_DEV_USB_HSOTG 2995b7d70c6SBen Dooks help 3005b7d70c6SBen Dooks The Samsung S3C64XX USB2.0 high-speed gadget controller 3015b7d70c6SBen Dooks integrated into the S3C64XX series SoC. 3025b7d70c6SBen Dooks 303193ab2a6SFelipe Balbiconfig USB_S3C2410 304193ab2a6SFelipe Balbi tristate "S3C2410 USB Device Controller" 305b130d5c2SKukjin Kim depends on ARCH_S3C24XX 3063fc154b6SArnaud Patard help 3073fc154b6SArnaud Patard Samsung's S3C2410 is an ARM-4 processor with an integrated 3083fc154b6SArnaud Patard full speed USB 1.1 device controller. It has 4 configurable 3093fc154b6SArnaud Patard endpoints, as well as endpoint zero (for control transfers). 3103fc154b6SArnaud Patard 3113fc154b6SArnaud Patard This driver has been tested on the S3C2410, S3C2412, and 3123fc154b6SArnaud Patard S3C2440 processors. 3133fc154b6SArnaud Patard 3143fc154b6SArnaud Patardconfig USB_S3C2410_DEBUG 3153fc154b6SArnaud Patard boolean "S3C2410 udc debug messages" 316193ab2a6SFelipe Balbi depends on USB_S3C2410 3173fc154b6SArnaud Patard 318193ab2a6SFelipe Balbiconfig USB_S3C_HSUDC 319193ab2a6SFelipe Balbi tristate "S3C2416, S3C2443 and S3C2450 USB Device Controller" 320b130d5c2SKukjin Kim depends on ARCH_S3C24XX 321a9df304cSThomas Abraham help 322a9df304cSThomas Abraham Samsung's S3C2416, S3C2443 and S3C2450 is an ARM9 based SoC 323a9df304cSThomas Abraham integrated with dual speed USB 2.0 device controller. It has 324a9df304cSThomas Abraham 8 endpoints, as well as endpoint zero. 325a9df304cSThomas Abraham 326a9df304cSThomas Abraham This driver has been tested on S3C2416 and S3C2450 processors. 327a9df304cSThomas Abraham 3285e6c86b0SNeil Zhangconfig USB_MV_UDC 3295e6c86b0SNeil Zhang tristate "Marvell USB2.0 Device Controller" 3300244ad00SMartin Schwidefsky depends on HAS_DMA 331e7cddda4Scxie4 help 3325e6c86b0SNeil Zhang Marvell Socs (including PXA and MMP series) include a high speed 3335e6c86b0SNeil Zhang USB2.0 OTG controller, which can be configured as high speed or 3345e6c86b0SNeil Zhang full speed USB peripheral. 33572246da4SFelipe Balbi 3363d4eb9dfSYu Xuconfig USB_MV_U3D 33791f6b847SGeert Uytterhoeven depends on HAS_DMA 3383d4eb9dfSYu Xu tristate "MARVELL PXA2128 USB 3.0 controller" 3393d4eb9dfSYu Xu help 3403d4eb9dfSYu Xu MARVELL PXA2128 Processor series include a super speed USB3.0 device 3413d4eb9dfSYu Xu controller, which support super speed USB peripheral. 3423d4eb9dfSYu Xu 343a7a19facSDavid Brownell# 344a7a19facSDavid Brownell# Controllers available in both integrated and discrete versions 345a7a19facSDavid Brownell# 346a7a19facSDavid Brownell 347193ab2a6SFelipe Balbiconfig USB_M66592 348193ab2a6SFelipe Balbi tristate "Renesas M66592 USB Peripheral Controller" 349a7a19facSDavid Brownell help 350a7a19facSDavid Brownell M66592 is a discrete USB peripheral controller chip that 351a7a19facSDavid Brownell supports both full and high speed USB 2.0 data transfers. 352a7a19facSDavid Brownell It has seven configurable endpoints, and endpoint zero. 353bae4bd84SDavid Brownell 354bae4bd84SDavid Brownell Say "y" to link the driver statically, or "m" to build a 355a7a19facSDavid Brownell dynamically linked module called "m66592_udc" and force all 356bae4bd84SDavid Brownell gadget drivers to also be dynamically linked. 357bae4bd84SDavid Brownell 358a7a19facSDavid Brownell# 359a7a19facSDavid Brownell# Controllers available only in discrete form (and all PCI controllers) 360a7a19facSDavid Brownell# 361a7a19facSDavid Brownell 362193ab2a6SFelipe Balbiconfig USB_AMD5536UDC 363193ab2a6SFelipe Balbi tristate "AMD5536 UDC" 364a7a19facSDavid Brownell depends on PCI 365a7a19facSDavid Brownell help 366a7a19facSDavid Brownell The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge. 367a7a19facSDavid Brownell It is a USB Highspeed DMA capable USB device controller. Beside ep0 368a7a19facSDavid Brownell it provides 4 IN and 4 OUT endpoints (bulk or interrupt type). 369a7a19facSDavid Brownell The UDC port supports OTG operation, and may be used as a host port 370a7a19facSDavid Brownell if it's not being used to implement peripheral or OTG roles. 371a7a19facSDavid Brownell 372a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 373a7a19facSDavid Brownell dynamically linked module called "amd5536udc" and force all 374a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 375a7a19facSDavid Brownell 376193ab2a6SFelipe Balbiconfig USB_FSL_QE 377193ab2a6SFelipe Balbi tristate "Freescale QE/CPM USB Device Controller" 3783948f0e0SLi Yang depends on FSL_SOC && (QUICC_ENGINE || CPM) 3793948f0e0SLi Yang help 3803948f0e0SLi Yang Some of Freescale PowerPC processors have a Full Speed 3813948f0e0SLi Yang QE/CPM2 USB controller, which support device mode with 4 3823948f0e0SLi Yang programmable endpoints. This driver supports the 3833948f0e0SLi Yang controller in the MPC8360 and MPC8272, and should work with 3843948f0e0SLi Yang controllers having QE or CPM2, given minor tweaks. 3853948f0e0SLi Yang 3863948f0e0SLi Yang Set CONFIG_USB_GADGET to "m" to build this driver as a 387692105b8SMatt LaPlante dynamically linked module called "fsl_qe_udc". 3883948f0e0SLi Yang 389193ab2a6SFelipe Balbiconfig USB_NET2272 390193ab2a6SFelipe Balbi tristate "PLX NET2272" 391ceb80363SSeth Levy help 392ceb80363SSeth Levy PLX NET2272 is a USB peripheral controller which supports 393ceb80363SSeth Levy both full and high speed USB 2.0 data transfers. 394ceb80363SSeth Levy 395ceb80363SSeth Levy It has three configurable endpoints, as well as endpoint zero 396ceb80363SSeth Levy (for control transfer). 397ceb80363SSeth Levy Say "y" to link the driver statically, or "m" to build a 398ceb80363SSeth Levy dynamically linked module called "net2272" and force all 399ceb80363SSeth Levy gadget drivers to also be dynamically linked. 400ceb80363SSeth Levy 401193ab2a6SFelipe Balbiconfig USB_NET2272_DMA 402ceb80363SSeth Levy boolean "Support external DMA controller" 403272b05a9SGeert Uytterhoeven depends on USB_NET2272 && HAS_DMA 404ceb80363SSeth Levy help 405ceb80363SSeth Levy The NET2272 part can optionally support an external DMA 406ceb80363SSeth Levy controller, but your board has to have support in the 407ceb80363SSeth Levy driver itself. 408ceb80363SSeth Levy 409ceb80363SSeth Levy If unsure, say "N" here. The driver works fine in PIO mode. 410ceb80363SSeth Levy 411193ab2a6SFelipe Balbiconfig USB_NET2280 412193ab2a6SFelipe Balbi tristate "NetChip 228x" 413a7a19facSDavid Brownell depends on PCI 414a7a19facSDavid Brownell help 415a7a19facSDavid Brownell NetChip 2280 / 2282 is a PCI based USB peripheral controller which 416a7a19facSDavid Brownell supports both full and high speed USB 2.0 data transfers. 417a7a19facSDavid Brownell 418a7a19facSDavid Brownell It has six configurable endpoints, as well as endpoint zero 419a7a19facSDavid Brownell (for control transfers) and several endpoints with dedicated 420a7a19facSDavid Brownell functions. 421a7a19facSDavid Brownell 422a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 423a7a19facSDavid Brownell dynamically linked module called "net2280" and force all 424a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 425a7a19facSDavid Brownell 426193ab2a6SFelipe Balbiconfig USB_GOKU 427193ab2a6SFelipe Balbi tristate "Toshiba TC86C001 'Goku-S'" 428a7a19facSDavid Brownell depends on PCI 429a7a19facSDavid Brownell help 430a7a19facSDavid Brownell The Toshiba TC86C001 is a PCI device which includes controllers 431a7a19facSDavid Brownell for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI). 432a7a19facSDavid Brownell 433a7a19facSDavid Brownell The device controller has three configurable (bulk or interrupt) 434a7a19facSDavid Brownell endpoints, plus endpoint zero (for control transfers). 435a7a19facSDavid Brownell 436a7a19facSDavid Brownell Say "y" to link the driver statically, or "m" to build a 437a7a19facSDavid Brownell dynamically linked module called "goku_udc" and to force all 438a7a19facSDavid Brownell gadget drivers to also be dynamically linked. 439a7a19facSDavid Brownell 440193ab2a6SFelipe Balbiconfig USB_EG20T 441731ad81eSTomoya MORINAGA tristate "Intel EG20T PCH/LAPIS Semiconductor IOH(ML7213/ML7831) UDC" 4420244ad00SMartin Schwidefsky depends on PCI 443f646cf94SToshiharu Okada help 444f646cf94SToshiharu Okada This is a USB device driver for EG20T PCH. 445f646cf94SToshiharu Okada EG20T PCH is the platform controller hub that is used in Intel's 446f646cf94SToshiharu Okada general embedded platform. EG20T PCH has USB device interface. 447f646cf94SToshiharu Okada Using this interface, it is able to access system devices connected 448f646cf94SToshiharu Okada to USB device. 449f646cf94SToshiharu Okada This driver enables USB device function. 450f646cf94SToshiharu Okada USB device is a USB peripheral controller which 451f646cf94SToshiharu Okada supports both full and high speed USB 2.0 data transfers. 452f646cf94SToshiharu Okada This driver supports both control transfer and bulk transfer modes. 453f646cf94SToshiharu Okada This driver dose not support interrupt transfer or isochronous 454f646cf94SToshiharu Okada transfer modes. 455f646cf94SToshiharu Okada 456731ad81eSTomoya MORINAGA This driver also can be used for LAPIS Semiconductor's ML7213 which is 45706f1b971STomoya MORINAGA for IVI(In-Vehicle Infotainment) use. 458731ad81eSTomoya MORINAGA ML7831 is for general purpose use. 459731ad81eSTomoya MORINAGA ML7213/ML7831 is companion chip for Intel Atom E6xx series. 460731ad81eSTomoya MORINAGA ML7213/ML7831 is completely compatible for Intel EG20T PCH. 46106f1b971STomoya MORINAGA 462a7a19facSDavid Brownell# 463a7a19facSDavid Brownell# LAST -- dummy/emulated controller 464a7a19facSDavid Brownell# 4651da177e4SLinus Torvalds 466193ab2a6SFelipe Balbiconfig USB_DUMMY_HCD 467193ab2a6SFelipe Balbi tristate "Dummy HCD (DEVELOPMENT)" 468afd0e0f2SRobert P. J. Day depends on USB=y || (USB=m && USB_GADGET=m) 4691da177e4SLinus Torvalds help 4701da177e4SLinus Torvalds This host controller driver emulates USB, looping all data transfer 4711da177e4SLinus Torvalds requests back to a USB "gadget driver" in the same host. The host 4721da177e4SLinus Torvalds side is the master; the gadget side is the slave. Gadget drivers 4731da177e4SLinus Torvalds can be high, full, or low speed; and they have access to endpoints 4741da177e4SLinus Torvalds like those from NET2280, PXA2xx, or SA1100 hardware. 4751da177e4SLinus Torvalds 4761da177e4SLinus Torvalds This may help in some stages of creating a driver to embed in a 4771da177e4SLinus Torvalds Linux device, since it lets you debug several parts of the gadget 4781da177e4SLinus Torvalds driver without its hardware or drivers being involved. 4791da177e4SLinus Torvalds 4801da177e4SLinus Torvalds Since such a gadget side driver needs to interoperate with a host 4811da177e4SLinus Torvalds side Linux-USB device driver, this may help to debug both sides 4821da177e4SLinus Torvalds of a USB protocol stack. 4831da177e4SLinus Torvalds 4841da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 4851da177e4SLinus Torvalds dynamically linked module called "dummy_hcd" and force all 4861da177e4SLinus Torvalds gadget drivers to also be dynamically linked. 4871da177e4SLinus Torvalds 4881da177e4SLinus Torvalds# NOTE: Please keep dummy_hcd LAST so that "real hardware" appears 4891da177e4SLinus Torvalds# first and will be selected by default. 4901da177e4SLinus Torvalds 491ed6c6f41SAlexander Shishkinendmenu 4921da177e4SLinus Torvalds 4931da177e4SLinus Torvalds# 4941da177e4SLinus Torvalds# USB Gadget Drivers 4951da177e4SLinus Torvalds# 496a84d9e53SSebastian Andrzej Siewior 497a84d9e53SSebastian Andrzej Siewior# composite based drivers 498a84d9e53SSebastian Andrzej Siewiorconfig USB_LIBCOMPOSITE 499a84d9e53SSebastian Andrzej Siewior tristate 50088af8bbeSSebastian Andrzej Siewior select CONFIGFS_FS 501a84d9e53SSebastian Andrzej Siewior depends on USB_GADGET 502a84d9e53SSebastian Andrzej Siewior 503ff47f594SSebastian Andrzej Siewiorconfig USB_F_ACM 504ff47f594SSebastian Andrzej Siewior tristate 505ff47f594SSebastian Andrzej Siewior 506cf9a08aeSSebastian Andrzej Siewiorconfig USB_F_SS_LB 507cf9a08aeSSebastian Andrzej Siewior tristate 508cf9a08aeSSebastian Andrzej Siewior 5093249ca22SSebastian Andrzej Siewiorconfig USB_U_SERIAL 5103249ca22SSebastian Andrzej Siewior tristate 5113249ca22SSebastian Andrzej Siewior 512f1a1823fSAndrzej Pietrasiewiczconfig USB_U_ETHER 513f1a1823fSAndrzej Pietrasiewicz tristate 514f1a1823fSAndrzej Pietrasiewicz 51560540ea2SAndrzej Pietrasiewiczconfig USB_F_SERIAL 51660540ea2SAndrzej Pietrasiewicz tristate 51760540ea2SAndrzej Pietrasiewicz 5181d8fc251SAndrzej Pietrasiewiczconfig USB_F_OBEX 5191d8fc251SAndrzej Pietrasiewicz tristate 5201d8fc251SAndrzej Pietrasiewicz 52140d133d7SAndrzej Pietrasiewiczconfig USB_F_NCM 52240d133d7SAndrzej Pietrasiewicz tristate 52340d133d7SAndrzej Pietrasiewicz 524fee562a6SAndrzej Pietrasiewiczconfig USB_F_ECM 525fee562a6SAndrzej Pietrasiewicz tristate 526fee562a6SAndrzej Pietrasiewicz 527fcbdf12eSAndrzej Pietrasiewiczconfig USB_F_PHONET 528fcbdf12eSAndrzej Pietrasiewicz tristate 529fcbdf12eSAndrzej Pietrasiewicz 530b29002a1SAndrzej Pietrasiewiczconfig USB_F_EEM 531b29002a1SAndrzej Pietrasiewicz tristate 532b29002a1SAndrzej Pietrasiewicz 5338cedba7cSAndrzej Pietrasiewiczconfig USB_F_SUBSET 5348cedba7cSAndrzej Pietrasiewicz tristate 5358cedba7cSAndrzej Pietrasiewicz 536f466c635SAndrzej Pietrasiewiczconfig USB_F_RNDIS 537f466c635SAndrzej Pietrasiewicz tristate 538f466c635SAndrzej Pietrasiewicz 539e5eaa0dcSAndrzej Pietrasiewiczconfig USB_F_MASS_STORAGE 540e5eaa0dcSAndrzej Pietrasiewicz tristate 541e5eaa0dcSAndrzej Pietrasiewicz 5425920cda6SAndrzej Pietrasiewiczconfig USB_F_FS 5435920cda6SAndrzej Pietrasiewicz tristate 5445920cda6SAndrzej Pietrasiewicz 5451da177e4SLinus Torvaldschoice 5461da177e4SLinus Torvalds tristate "USB Gadget Drivers" 5471da177e4SLinus Torvalds default USB_ETH 5481da177e4SLinus Torvalds help 5491da177e4SLinus Torvalds A Linux "Gadget Driver" talks to the USB Peripheral Controller 5501da177e4SLinus Torvalds driver through the abstract "gadget" API. Some other operating 5511da177e4SLinus Torvalds systems call these "client" drivers, of which "class drivers" 5521da177e4SLinus Torvalds are a subset (implementing a USB device class specification). 5531da177e4SLinus Torvalds A gadget driver implements one or more USB functions using 5541da177e4SLinus Torvalds the peripheral hardware. 5551da177e4SLinus Torvalds 5561da177e4SLinus Torvalds Gadget drivers are hardware-neutral, or "platform independent", 5571da177e4SLinus Torvalds except that they sometimes must understand quirks or limitations 5581da177e4SLinus Torvalds of the particular controllers they work with. For example, when 5591da177e4SLinus Torvalds a controller doesn't support alternate configurations or provide 5601da177e4SLinus Torvalds enough of the right types of endpoints, the gadget driver might 5611da177e4SLinus Torvalds not be able work with that controller, or might need to implement 5621da177e4SLinus Torvalds a less common variant of a device class protocol. 5631da177e4SLinus Torvalds 5641da177e4SLinus Torvalds# this first set of drivers all depend on bulk-capable hardware. 5651da177e4SLinus Torvalds 566d1c02452SAndrzej Pietrasiewiczconfig USB_CONFIGFS 567d1c02452SAndrzej Pietrasiewicz tristate "USB functions configurable through configfs" 568d1c02452SAndrzej Pietrasiewicz select USB_LIBCOMPOSITE 569d1c02452SAndrzej Pietrasiewicz help 570d1c02452SAndrzej Pietrasiewicz A Linux USB "gadget" can be set up through configfs. 571d1c02452SAndrzej Pietrasiewicz If this is the case, the USB functions (which from the host's 572d1c02452SAndrzej Pietrasiewicz perspective are seen as interfaces) and configurations are 573d1c02452SAndrzej Pietrasiewicz specified simply by creating appropriate directories in configfs. 574d1c02452SAndrzej Pietrasiewicz Associating functions with configurations is done by creating 575d1c02452SAndrzej Pietrasiewicz appropriate symbolic links. 5769c1d6962SPhilippe De Swert For more information see Documentation/usb/gadget_configfs.txt. 577d1c02452SAndrzej Pietrasiewicz 578d1c02452SAndrzej Pietrasiewiczconfig USB_CONFIGFS_SERIAL 579d1c02452SAndrzej Pietrasiewicz boolean "Generic serial bulk in/out" 580d1c02452SAndrzej Pietrasiewicz depends on USB_CONFIGFS 581d1c02452SAndrzej Pietrasiewicz depends on TTY 582d1c02452SAndrzej Pietrasiewicz select USB_U_SERIAL 583d1c02452SAndrzej Pietrasiewicz select USB_F_SERIAL 584d1c02452SAndrzej Pietrasiewicz help 585d1c02452SAndrzej Pietrasiewicz The function talks to the Linux-USB generic serial driver. 586d1c02452SAndrzej Pietrasiewicz 587d1c02452SAndrzej Pietrasiewiczconfig USB_CONFIGFS_ACM 588d1c02452SAndrzej Pietrasiewicz boolean "Abstract Control Model (CDC ACM)" 589d1c02452SAndrzej Pietrasiewicz depends on USB_CONFIGFS 590d1c02452SAndrzej Pietrasiewicz depends on TTY 591d1c02452SAndrzej Pietrasiewicz select USB_U_SERIAL 592d1c02452SAndrzej Pietrasiewicz select USB_F_ACM 593d1c02452SAndrzej Pietrasiewicz help 594d1c02452SAndrzej Pietrasiewicz ACM serial link. This function can be used to interoperate with 595d1c02452SAndrzej Pietrasiewicz MS-Windows hosts or with the Linux-USB "cdc-acm" driver. 596d1c02452SAndrzej Pietrasiewicz 597d1c02452SAndrzej Pietrasiewiczconfig USB_CONFIGFS_OBEX 598d1c02452SAndrzej Pietrasiewicz boolean "Object Exchange Model (CDC OBEX)" 599d1c02452SAndrzej Pietrasiewicz depends on USB_CONFIGFS 600d1c02452SAndrzej Pietrasiewicz depends on TTY 601d1c02452SAndrzej Pietrasiewicz select USB_U_SERIAL 602d1c02452SAndrzej Pietrasiewicz select USB_F_OBEX 603d1c02452SAndrzej Pietrasiewicz help 604d1c02452SAndrzej Pietrasiewicz You will need a user space OBEX server talking to /dev/ttyGS*, 605d1c02452SAndrzej Pietrasiewicz since the kernel itself doesn't implement the OBEX protocol. 606d1c02452SAndrzej Pietrasiewicz 607d1c02452SAndrzej Pietrasiewiczconfig USB_CONFIGFS_NCM 608d1c02452SAndrzej Pietrasiewicz boolean "Network Control Model (CDC NCM)" 609d1c02452SAndrzej Pietrasiewicz depends on USB_CONFIGFS 610d1c02452SAndrzej Pietrasiewicz depends on NET 611d1c02452SAndrzej Pietrasiewicz select USB_U_ETHER 612d1c02452SAndrzej Pietrasiewicz select USB_F_NCM 613d1c02452SAndrzej Pietrasiewicz help 614d1c02452SAndrzej Pietrasiewicz NCM is an advanced protocol for Ethernet encapsulation, allows 615d1c02452SAndrzej Pietrasiewicz grouping of several ethernet frames into one USB transfer and 616d1c02452SAndrzej Pietrasiewicz different alignment possibilities. 617d1c02452SAndrzej Pietrasiewicz 618d1c02452SAndrzej Pietrasiewiczconfig USB_CONFIGFS_ECM 619d1c02452SAndrzej Pietrasiewicz boolean "Ethernet Control Model (CDC ECM)" 620d1c02452SAndrzej Pietrasiewicz depends on USB_CONFIGFS 621d1c02452SAndrzej Pietrasiewicz depends on NET 622d1c02452SAndrzej Pietrasiewicz select USB_U_ETHER 623d1c02452SAndrzej Pietrasiewicz select USB_F_ECM 624d1c02452SAndrzej Pietrasiewicz help 625d1c02452SAndrzej Pietrasiewicz The "Communication Device Class" (CDC) Ethernet Control Model. 626d1c02452SAndrzej Pietrasiewicz That protocol is often avoided with pure Ethernet adapters, in 627d1c02452SAndrzej Pietrasiewicz favor of simpler vendor-specific hardware, but is widely 628d1c02452SAndrzej Pietrasiewicz supported by firmware for smart network devices. 629d1c02452SAndrzej Pietrasiewicz 63002832e56SAndrzej Pietrasiewiczconfig USB_CONFIGFS_ECM_SUBSET 63102832e56SAndrzej Pietrasiewicz boolean "Ethernet Control Model (CDC ECM) subset" 63202832e56SAndrzej Pietrasiewicz depends on USB_CONFIGFS 63302832e56SAndrzej Pietrasiewicz depends on NET 63402832e56SAndrzej Pietrasiewicz select USB_U_ETHER 63502832e56SAndrzej Pietrasiewicz select USB_F_SUBSET 63602832e56SAndrzej Pietrasiewicz help 63702832e56SAndrzej Pietrasiewicz On hardware that can't implement the full protocol, 63802832e56SAndrzej Pietrasiewicz a simple CDC subset is used, placing fewer demands on USB. 63902832e56SAndrzej Pietrasiewicz 640b3df2faaSAndrzej Pietrasiewiczconfig USB_CONFIGFS_RNDIS 641b3df2faaSAndrzej Pietrasiewicz bool "RNDIS" 642b3df2faaSAndrzej Pietrasiewicz depends on USB_CONFIGFS 643b3df2faaSAndrzej Pietrasiewicz depends on NET 644b3df2faaSAndrzej Pietrasiewicz select USB_U_ETHER 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 681ef0aa4b9SAndrzej Pietrasiewiczconfig USB_CONFIGFS_MASS_STORAGE 682ef0aa4b9SAndrzej Pietrasiewicz boolean "Mass storage" 683ef0aa4b9SAndrzej Pietrasiewicz depends on USB_CONFIGFS 684ef0aa4b9SAndrzej Pietrasiewicz select USB_F_MASS_STORAGE 685ef0aa4b9SAndrzej Pietrasiewicz help 686ef0aa4b9SAndrzej Pietrasiewicz The Mass Storage Gadget acts as a USB Mass Storage disk drive. 687ef0aa4b9SAndrzej Pietrasiewicz As its storage repository it can use a regular file or a block 688ef0aa4b9SAndrzej Pietrasiewicz device (in much the same way as the "loop" device driver), 689ef0aa4b9SAndrzej Pietrasiewicz specified as a module parameter or sysfs option. 690ef0aa4b9SAndrzej Pietrasiewicz 69125d80151SAndrzej Pietrasiewiczconfig USB_CONFIGFS_F_LB_SS 69225d80151SAndrzej Pietrasiewicz boolean "Loopback and sourcesink function (for testing)" 693c0501f47SAndrzej Pietrasiewicz depends on USB_CONFIGFS 694c0501f47SAndrzej Pietrasiewicz select USB_F_SS_LB 695c0501f47SAndrzej Pietrasiewicz help 69625d80151SAndrzej Pietrasiewicz Loopback function loops back a configurable number of transfers. 69725d80151SAndrzej Pietrasiewicz Sourcesink function either sinks and sources bulk data. 698c0501f47SAndrzej Pietrasiewicz It also implements control requests, for "chapter 9" conformance. 699c0501f47SAndrzej Pietrasiewicz Make this be the first driver you try using on top of any new 700c0501f47SAndrzej Pietrasiewicz USB peripheral controller driver. Then you can use host-side 701c0501f47SAndrzej Pietrasiewicz test software, like the "usbtest" driver, to put your hardware 702c0501f47SAndrzej Pietrasiewicz and its driver through a basic set of functional tests. 703c0501f47SAndrzej Pietrasiewicz 7041da177e4SLinus Torvaldsconfig USB_ZERO 7051da177e4SLinus Torvalds tristate "Gadget Zero (DEVELOPMENT)" 706a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 707cf9a08aeSSebastian Andrzej Siewior select USB_F_SS_LB 7081da177e4SLinus Torvalds help 7091da177e4SLinus Torvalds Gadget Zero is a two-configuration device. It either sinks and 7101da177e4SLinus Torvalds sources bulk data; or it loops back a configurable number of 7111da177e4SLinus Torvalds transfers. It also implements control requests, for "chapter 9" 7121da177e4SLinus Torvalds conformance. The driver needs only two bulk-capable endpoints, so 7131da177e4SLinus Torvalds it can work on top of most device-side usb controllers. It's 7141da177e4SLinus Torvalds useful for testing, and is also a working example showing how 7151da177e4SLinus Torvalds USB "gadget drivers" can be written. 7161da177e4SLinus Torvalds 7171da177e4SLinus Torvalds Make this be the first driver you try using on top of any new 7181da177e4SLinus Torvalds USB peripheral controller driver. Then you can use host-side 7191da177e4SLinus Torvalds test software, like the "usbtest" driver, to put your hardware 7201da177e4SLinus Torvalds and its driver through a basic set of functional tests. 7211da177e4SLinus Torvalds 7221da177e4SLinus Torvalds Gadget Zero also works with the host-side "usb-skeleton" driver, 7231da177e4SLinus Torvalds and with many kinds of host-side test software. You may need 7241da177e4SLinus Torvalds to tweak product and vendor IDs before host software knows about 7251da177e4SLinus Torvalds this device, and arrange to select an appropriate configuration. 7261da177e4SLinus Torvalds 7271da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 7281da177e4SLinus Torvalds dynamically linked module called "g_zero". 7291da177e4SLinus Torvalds 7301da177e4SLinus Torvaldsconfig USB_ZERO_HNPTEST 7311da177e4SLinus Torvalds boolean "HNP Test Device" 7321da177e4SLinus Torvalds depends on USB_ZERO && USB_OTG 7331da177e4SLinus Torvalds help 7341da177e4SLinus Torvalds You can configure this device to enumerate using the device 7351da177e4SLinus Torvalds identifiers of the USB-OTG test device. That means that when 7361da177e4SLinus Torvalds this gadget connects to another OTG device, with this one using 7371da177e4SLinus Torvalds the "B-Peripheral" role, that device will use HNP to let this 7381da177e4SLinus Torvalds one serve as the USB host instead (in the "B-Host" role). 7391da177e4SLinus Torvalds 740c6994e6fSBryan Wuconfig USB_AUDIO 741eb83be98SGreg Kroah-Hartman tristate "Audio Gadget" 742c6994e6fSBryan Wu depends on SND 743a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 74404950737SRandy Dunlap select SND_PCM 745c6994e6fSBryan Wu help 746132fcb46SJassi Brar This Gadget Audio driver is compatible with USB Audio Class 747132fcb46SJassi Brar specification 2.0. It implements 1 AudioControl interface, 748132fcb46SJassi Brar 1 AudioStreaming Interface each for USB-OUT and USB-IN. 749132fcb46SJassi Brar Number of channels, sample rate and sample size can be 750132fcb46SJassi Brar specified as module parameters. 751132fcb46SJassi Brar This driver doesn't expect any real Audio codec to be present 752132fcb46SJassi Brar on the device - the audio streams are simply sinked to and 753132fcb46SJassi Brar sourced from a virtual ALSA sound card created. The user-space 754132fcb46SJassi Brar application may choose to do whatever it wants with the data 755132fcb46SJassi Brar received from the USB Host and choose to provide whatever it 756132fcb46SJassi Brar wants as audio data to the USB Host. 757c6994e6fSBryan Wu 758c6994e6fSBryan Wu Say "y" to link the driver statically, or "m" to build a 759c6994e6fSBryan Wu dynamically linked module called "g_audio". 760c6994e6fSBryan Wu 761132fcb46SJassi Brarconfig GADGET_UAC1 762132fcb46SJassi Brar bool "UAC 1.0 (Legacy)" 763132fcb46SJassi Brar depends on USB_AUDIO 764132fcb46SJassi Brar help 765132fcb46SJassi Brar If you instead want older UAC Spec-1.0 driver that also has audio 766132fcb46SJassi Brar paths hardwired to the Audio codec chip on-board and doesn't work 767132fcb46SJassi Brar without one. 768132fcb46SJassi Brar 7691da177e4SLinus Torvaldsconfig USB_ETH 7701da177e4SLinus Torvalds tristate "Ethernet Gadget (with CDC Ethernet support)" 7711da177e4SLinus Torvalds depends on NET 772a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 773f1a1823fSAndrzej Pietrasiewicz select USB_U_ETHER 7749c62ce83SAndrzej Pietrasiewicz select USB_F_ECM 7758af5232dSAndrzej Pietrasiewicz select USB_F_SUBSET 7769e221be8SRandy Dunlap select CRC32 7771da177e4SLinus Torvalds help 7789b39e9ddSBrian Niebuhr This driver implements Ethernet style communication, in one of 7799b39e9ddSBrian Niebuhr several ways: 7801da177e4SLinus Torvalds 7811da177e4SLinus Torvalds - The "Communication Device Class" (CDC) Ethernet Control Model. 7821da177e4SLinus Torvalds That protocol is often avoided with pure Ethernet adapters, in 7831da177e4SLinus Torvalds favor of simpler vendor-specific hardware, but is widely 7841da177e4SLinus Torvalds supported by firmware for smart network devices. 7851da177e4SLinus Torvalds 7861da177e4SLinus Torvalds - On hardware can't implement that protocol, a simple CDC subset 7871da177e4SLinus Torvalds is used, placing fewer demands on USB. 7881da177e4SLinus Torvalds 7899b39e9ddSBrian Niebuhr - CDC Ethernet Emulation Model (EEM) is a newer standard that has 7909b39e9ddSBrian Niebuhr a simpler interface that can be used by more USB hardware. 7919b39e9ddSBrian Niebuhr 7929b39e9ddSBrian Niebuhr RNDIS support is an additional option, more demanding than than 7939b39e9ddSBrian Niebuhr subset. 7941da177e4SLinus Torvalds 7951da177e4SLinus Torvalds Within the USB device, this gadget driver exposes a network device 7961da177e4SLinus Torvalds "usbX", where X depends on what other networking devices you have. 7971da177e4SLinus Torvalds Treat it like a two-node Ethernet link: host, and gadget. 7981da177e4SLinus Torvalds 7991da177e4SLinus Torvalds The Linux-USB host-side "usbnet" driver interoperates with this 8001da177e4SLinus Torvalds driver, so that deep I/O queues can be supported. On 2.4 kernels, 8011da177e4SLinus Torvalds use "CDCEther" instead, if you're using the CDC option. That CDC 8021da177e4SLinus Torvalds mode should also interoperate with standard CDC Ethernet class 8031da177e4SLinus Torvalds drivers on other host operating systems. 8041da177e4SLinus Torvalds 8051da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 8061da177e4SLinus Torvalds dynamically linked module called "g_ether". 8071da177e4SLinus Torvalds 8081da177e4SLinus Torvaldsconfig USB_ETH_RNDIS 809afd0e0f2SRobert P. J. Day bool "RNDIS support" 810afd0e0f2SRobert P. J. Day depends on USB_ETH 811a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 8129bd4a10eSAndrzej Pietrasiewicz select USB_F_RNDIS 8131da177e4SLinus Torvalds default y 8141da177e4SLinus Torvalds help 8151da177e4SLinus Torvalds Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol, 8161da177e4SLinus Torvalds and Microsoft provides redistributable binary RNDIS drivers for 8171da177e4SLinus Torvalds older versions of Windows. 8181da177e4SLinus Torvalds 8191da177e4SLinus Torvalds If you say "y" here, the Ethernet gadget driver will try to provide 8201da177e4SLinus Torvalds a second device configuration, supporting RNDIS to talk to such 8211da177e4SLinus Torvalds Microsoft USB hosts. 8221da177e4SLinus Torvalds 8231da177e4SLinus Torvalds To make MS-Windows work with this, use Documentation/usb/linux.inf 8241da177e4SLinus Torvalds as the "driver info file". For versions of MS-Windows older than 8251da177e4SLinus Torvalds XP, you'll need to download drivers from Microsoft's website; a URL 8261da177e4SLinus Torvalds is given in comments found in that info file. 8271da177e4SLinus Torvalds 8289b39e9ddSBrian Niebuhrconfig USB_ETH_EEM 8299b39e9ddSBrian Niebuhr bool "Ethernet Emulation Model (EEM) support" 8309b39e9ddSBrian Niebuhr depends on USB_ETH 831a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 83294b5573eSAndrzej Pietrasiewicz select USB_F_EEM 8339b39e9ddSBrian Niebuhr default n 8349b39e9ddSBrian Niebuhr help 8359b39e9ddSBrian Niebuhr CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM 8369b39e9ddSBrian Niebuhr and therefore can be supported by more hardware. Technically ECM and 8379b39e9ddSBrian Niebuhr EEM are designed for different applications. The ECM model extends 8389b39e9ddSBrian Niebuhr the network interface to the target (e.g. a USB cable modem), and the 8399b39e9ddSBrian Niebuhr EEM model is for mobile devices to communicate with hosts using 8409b39e9ddSBrian Niebuhr ethernet over USB. For Linux gadgets, however, the interface with 8419b39e9ddSBrian Niebuhr the host is the same (a usbX device), so the differences are minimal. 8429b39e9ddSBrian Niebuhr 8439b39e9ddSBrian Niebuhr If you say "y" here, the Ethernet gadget driver will use the EEM 8449b39e9ddSBrian Niebuhr protocol rather than ECM. If unsure, say "n". 8459b39e9ddSBrian Niebuhr 8466c34d288SYauheni Kaliutaconfig USB_G_NCM 8476c34d288SYauheni Kaliuta tristate "Network Control Model (NCM) support" 8486c34d288SYauheni Kaliuta depends on NET 849a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 850f1a1823fSAndrzej Pietrasiewicz select USB_U_ETHER 8519575bcf9SAndrzej Pietrasiewicz select USB_F_NCM 8526c34d288SYauheni Kaliuta select CRC32 8536c34d288SYauheni Kaliuta help 8546c34d288SYauheni Kaliuta This driver implements USB CDC NCM subclass standard. NCM is 8556c34d288SYauheni Kaliuta an advanced protocol for Ethernet encapsulation, allows grouping 856b55dd320SFabio Baltieri of several ethernet frames into one USB transfer and different 8576c34d288SYauheni Kaliuta alignment possibilities. 8586c34d288SYauheni Kaliuta 8596c34d288SYauheni Kaliuta Say "y" to link the driver statically, or "m" to build a 8606c34d288SYauheni Kaliuta dynamically linked module called "g_ncm". 8616c34d288SYauheni Kaliuta 8621da177e4SLinus Torvaldsconfig USB_GADGETFS 863eb83be98SGreg Kroah-Hartman tristate "Gadget Filesystem" 8641da177e4SLinus Torvalds help 8651da177e4SLinus Torvalds This driver provides a filesystem based API that lets user mode 8661da177e4SLinus Torvalds programs implement a single-configuration USB device, including 8671da177e4SLinus Torvalds endpoint I/O and control requests that don't relate to enumeration. 8681da177e4SLinus Torvalds All endpoints, transfer speeds, and transfer types supported by 8691da177e4SLinus Torvalds the hardware are available, through read() and write() calls. 8701da177e4SLinus Torvalds 8711da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 8721da177e4SLinus Torvalds dynamically linked module called "gadgetfs". 8731da177e4SLinus Torvalds 874c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS 875eb83be98SGreg Kroah-Hartman tristate "Function Filesystem" 876a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 8776f823cd5SAndrzej Pietrasiewicz select USB_F_FS 878f8dae531SMichal Nazarewicz select USB_FUNCTIONFS_GENERIC if !(USB_FUNCTIONFS_ETH || USB_FUNCTIONFS_RNDIS) 879c6c56008SMichal Nazarewicz help 880eabf0f5fSMichael Prokop The Function Filesystem (FunctionFS) lets one create USB 881eabf0f5fSMichael Prokop composite functions in user space in the same way GadgetFS 882c6c56008SMichal Nazarewicz lets one create USB gadgets in user space. This allows creation 883c6c56008SMichal Nazarewicz of composite gadgets such that some of the functions are 884c6c56008SMichal Nazarewicz implemented in kernel space (for instance Ethernet, serial or 885c6c56008SMichal Nazarewicz mass storage) and other are implemented in user space. 886c6c56008SMichal Nazarewicz 887f8dae531SMichal Nazarewicz If you say "y" or "m" here you will be able what kind of 888f8dae531SMichal Nazarewicz configurations the gadget will provide. 889f8dae531SMichal Nazarewicz 890c6c56008SMichal Nazarewicz Say "y" to link the driver statically, or "m" to build 891c6c56008SMichal Nazarewicz a dynamically linked module called "g_ffs". 892c6c56008SMichal Nazarewicz 893c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_ETH 894f8dae531SMichal Nazarewicz bool "Include configuration with CDC ECM (Ethernet)" 89517b2765eSRandy Dunlap depends on USB_FUNCTIONFS && NET 896f1a1823fSAndrzej Pietrasiewicz select USB_U_ETHER 897f212ad4eSAndrzej Pietrasiewicz select USB_F_ECM 89885aec59fSAndrzej Pietrasiewicz select USB_F_SUBSET 899c6c56008SMichal Nazarewicz help 900eabf0f5fSMichael Prokop Include a configuration with CDC ECM function (Ethernet) and the 901eabf0f5fSMichael Prokop Function Filesystem. 902c6c56008SMichal Nazarewicz 903c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_RNDIS 904f8dae531SMichal Nazarewicz bool "Include configuration with RNDIS (Ethernet)" 90517b2765eSRandy Dunlap depends on USB_FUNCTIONFS && NET 906f1a1823fSAndrzej Pietrasiewicz select USB_U_ETHER 9076e257b14SAndrzej Pietrasiewicz select USB_F_RNDIS 908c6c56008SMichal Nazarewicz help 909eabf0f5fSMichael Prokop Include a configuration with RNDIS function (Ethernet) and the Filesystem. 910c6c56008SMichal Nazarewicz 911c6c56008SMichal Nazarewiczconfig USB_FUNCTIONFS_GENERIC 912c6c56008SMichal Nazarewicz bool "Include 'pure' configuration" 913f8dae531SMichal Nazarewicz depends on USB_FUNCTIONFS 914c6c56008SMichal Nazarewicz help 915f8dae531SMichal Nazarewicz Include a configuration with the Function Filesystem alone with 916f8dae531SMichal Nazarewicz no Ethernet interface. 917c6c56008SMichal Nazarewicz 918d23b0f08SMichal Nazarewiczconfig USB_MASS_STORAGE 919d23b0f08SMichal Nazarewicz tristate "Mass Storage Gadget" 920d23b0f08SMichal Nazarewicz depends on BLOCK 921a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 9222412fbf1SAndrzej Pietrasiewicz select USB_F_MASS_STORAGE 923d23b0f08SMichal Nazarewicz help 924d23b0f08SMichal Nazarewicz The Mass Storage Gadget acts as a USB Mass Storage disk drive. 925d23b0f08SMichal Nazarewicz As its storage repository it can use a regular file or a block 926d23b0f08SMichal Nazarewicz device (in much the same way as the "loop" device driver), 927d23b0f08SMichal Nazarewicz specified as a module parameter or sysfs option. 928d23b0f08SMichal Nazarewicz 929fa06920aSMichal Nazarewicz This driver is a replacement for now removed File-backed 930fa06920aSMichal Nazarewicz Storage Gadget (g_file_storage). 931d23b0f08SMichal Nazarewicz 932d23b0f08SMichal Nazarewicz Say "y" to link the driver statically, or "m" to build 933664a51a8SAlan Stern a dynamically linked module called "g_mass_storage". 934d23b0f08SMichal Nazarewicz 935c52661d6SSebastian Andrzej Siewiorconfig USB_GADGET_TARGET 936c52661d6SSebastian Andrzej Siewior tristate "USB Gadget Target Fabric Module" 937c52661d6SSebastian Andrzej Siewior depends on TARGET_CORE 938a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 939c52661d6SSebastian Andrzej Siewior help 940c52661d6SSebastian Andrzej Siewior This fabric is an USB gadget. Two USB protocols are supported that is 941c52661d6SSebastian Andrzej Siewior BBB or BOT (Bulk Only Transport) and UAS (USB Attached SCSI). BOT is 942c52661d6SSebastian Andrzej Siewior advertised on alternative interface 0 (primary) and UAS is on 943c52661d6SSebastian Andrzej Siewior alternative interface 1. Both protocols can work on USB2.0 and USB3.0. 944c52661d6SSebastian Andrzej Siewior UAS utilizes the USB 3.0 feature called streams support. 945c52661d6SSebastian Andrzej Siewior 9461da177e4SLinus Torvaldsconfig USB_G_SERIAL 9473086775aSFelipe Balbi tristate "Serial Gadget (with CDC ACM and CDC OBEX support)" 9484f73bc4dSJoe Millenbach depends on TTY 9493249ca22SSebastian Andrzej Siewior select USB_U_SERIAL 950ff47f594SSebastian Andrzej Siewior select USB_F_ACM 95170cc3c02SAndrzej Pietrasiewicz select USB_F_SERIAL 952d1412794SAndrzej Pietrasiewicz select USB_F_OBEX 953a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 9541da177e4SLinus Torvalds help 9551da177e4SLinus Torvalds The Serial Gadget talks to the Linux-USB generic serial driver. 9561da177e4SLinus Torvalds This driver supports a CDC-ACM module option, which can be used 9571da177e4SLinus Torvalds to interoperate with MS-Windows hosts or with the Linux-USB 9581da177e4SLinus Torvalds "cdc-acm" driver. 9591da177e4SLinus Torvalds 9603086775aSFelipe Balbi This driver also supports a CDC-OBEX option. You will need a 9613086775aSFelipe Balbi user space OBEX server talking to /dev/ttyGS*, since the kernel 9623086775aSFelipe Balbi itself doesn't implement the OBEX protocol. 9633086775aSFelipe Balbi 9641da177e4SLinus Torvalds Say "y" to link the driver statically, or "m" to build a 9651da177e4SLinus Torvalds dynamically linked module called "g_serial". 9661da177e4SLinus Torvalds 9671da177e4SLinus Torvalds For more information, see Documentation/usb/gadget_serial.txt 9681da177e4SLinus Torvalds which includes instructions and a "driver info file" needed to 9693086775aSFelipe Balbi make MS-Windows work with CDC ACM. 9701da177e4SLinus Torvalds 971f2ebf92cSBen Williamsonconfig USB_MIDI_GADGET 972eb83be98SGreg Kroah-Hartman tristate "MIDI Gadget" 973eb83be98SGreg Kroah-Hartman depends on SND 974a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 975f2ebf92cSBen Williamson select SND_RAWMIDI 976f2ebf92cSBen Williamson help 977f2ebf92cSBen Williamson The MIDI Gadget acts as a USB Audio device, with one MIDI 978f2ebf92cSBen Williamson input and one MIDI output. These MIDI jacks appear as 979f2ebf92cSBen Williamson a sound "card" in the ALSA sound system. Other MIDI 980f2ebf92cSBen Williamson connections can then be made on the gadget system, using 981f2ebf92cSBen Williamson ALSA's aconnect utility etc. 982f2ebf92cSBen Williamson 983f2ebf92cSBen Williamson Say "y" to link the driver statically, or "m" to build a 984f2ebf92cSBen Williamson dynamically linked module called "g_midi". 985f2ebf92cSBen Williamson 98625a010c8SCraig W. Nadlerconfig USB_G_PRINTER 98725a010c8SCraig W. Nadler tristate "Printer Gadget" 988a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 98925a010c8SCraig W. Nadler help 99025a010c8SCraig W. Nadler The Printer Gadget channels data between the USB host and a 99125a010c8SCraig W. Nadler userspace program driving the print engine. The user space 99225a010c8SCraig W. Nadler program reads and writes the device file /dev/g_printer to 99325a010c8SCraig W. Nadler receive or send printer data. It can use ioctl calls to 99425a010c8SCraig W. Nadler the device file to get or set printer status. 99525a010c8SCraig W. Nadler 99625a010c8SCraig W. Nadler Say "y" to link the driver statically, or "m" to build a 99725a010c8SCraig W. Nadler dynamically linked module called "g_printer". 99825a010c8SCraig W. Nadler 99925a010c8SCraig W. Nadler For more information, see Documentation/usb/gadget_printer.txt 100025a010c8SCraig W. Nadler which includes sample code for accessing the device file. 10011da177e4SLinus Torvalds 10024f73bc4dSJoe Millenbachif TTY 10034f73bc4dSJoe Millenbach 100419e20680SDavid Brownellconfig USB_CDC_COMPOSITE 100519e20680SDavid Brownell tristate "CDC Composite Device (Ethernet and ACM)" 10064ddd9ec1SRandy Dunlap depends on NET 1007a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 10083249ca22SSebastian Andrzej Siewior select USB_U_SERIAL 1009f1a1823fSAndrzej Pietrasiewicz select USB_U_ETHER 101029a6645fSSebastian Andrzej Siewior select USB_F_ACM 1011a38a2750SAndrzej Pietrasiewicz select USB_F_ECM 101219e20680SDavid Brownell help 101319e20680SDavid Brownell This driver provides two functions in one configuration: 101419e20680SDavid Brownell a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link. 101519e20680SDavid Brownell 101619e20680SDavid Brownell This driver requires four bulk and two interrupt endpoints, 101719e20680SDavid Brownell plus the ability to handle altsettings. Not all peripheral 101819e20680SDavid Brownell controllers are that capable. 101919e20680SDavid Brownell 102019e20680SDavid Brownell Say "y" to link the driver statically, or "m" to build a 102119e20680SDavid Brownell dynamically linked module. 102219e20680SDavid Brownell 1023f358f5b4SFelipe Balbiconfig USB_G_NOKIA 1024f358f5b4SFelipe Balbi tristate "Nokia composite gadget" 1025f358f5b4SFelipe Balbi depends on PHONET 1026a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 10273249ca22SSebastian Andrzej Siewior select USB_U_SERIAL 1028f1a1823fSAndrzej Pietrasiewicz select USB_U_ETHER 102915761826SSebastian Andrzej Siewior select USB_F_ACM 10303a343449SAndrzej Pietrasiewicz select USB_F_OBEX 103183167f12SAndrzej Pietrasiewicz select USB_F_PHONET 1032b904d081SAndrzej Pietrasiewicz select USB_F_ECM 1033f358f5b4SFelipe Balbi help 1034f358f5b4SFelipe Balbi The Nokia composite gadget provides support for acm, obex 1035f358f5b4SFelipe Balbi and phonet in only one composite gadget driver. 1036f358f5b4SFelipe Balbi 1037f358f5b4SFelipe Balbi It's only really useful for N900 hardware. If you're building 1038f358f5b4SFelipe Balbi a kernel for N900, say Y or M here. If unsure, say N. 1039f358f5b4SFelipe Balbi 1040fa3ae0c1SKlaus Schwarzkopfconfig USB_G_ACM_MS 1041fa3ae0c1SKlaus Schwarzkopf tristate "CDC Composite Device (ACM and mass storage)" 1042fa3ae0c1SKlaus Schwarzkopf depends on BLOCK 1043a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 10443249ca22SSebastian Andrzej Siewior select USB_U_SERIAL 10455f72bbfdSSebastian Andrzej Siewior select USB_F_ACM 1046e6c661efSAndrzej Pietrasiewicz select USB_F_MASS_STORAGE 1047fa3ae0c1SKlaus Schwarzkopf help 1048fa3ae0c1SKlaus Schwarzkopf This driver provides two functions in one configuration: 1049fa3ae0c1SKlaus Schwarzkopf a mass storage, and a CDC ACM (serial port) link. 1050fa3ae0c1SKlaus Schwarzkopf 1051fa3ae0c1SKlaus Schwarzkopf Say "y" to link the driver statically, or "m" to build a 1052fa3ae0c1SKlaus Schwarzkopf dynamically linked module called "g_acm_ms". 1053fa3ae0c1SKlaus Schwarzkopf 1054f176a5d8SMichal Nazarewiczconfig USB_G_MULTI 1055eb83be98SGreg Kroah-Hartman tristate "Multifunction Composite Gadget" 10565791e103SRandy Dunlap depends on BLOCK && NET 1057279cc49aSMichal Nazarewicz select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS 1058a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 10593249ca22SSebastian Andrzej Siewior select USB_U_SERIAL 1060f1a1823fSAndrzej Pietrasiewicz select USB_U_ETHER 106159835ad7SSebastian Andrzej Siewior select USB_F_ACM 10621bcce939SAndrzej Pietrasiewicz select USB_F_MASS_STORAGE 1063f176a5d8SMichal Nazarewicz help 1064f176a5d8SMichal Nazarewicz The Multifunction Composite Gadget provides Ethernet (RNDIS 1065f176a5d8SMichal Nazarewicz and/or CDC Ethernet), mass storage and ACM serial link 1066f176a5d8SMichal Nazarewicz interfaces. 1067f176a5d8SMichal Nazarewicz 10685791e103SRandy Dunlap You will be asked to choose which of the two configurations is 1069f176a5d8SMichal Nazarewicz to be available in the gadget. At least one configuration must 10705791e103SRandy Dunlap be chosen to make the gadget usable. Selecting more than one 1071f176a5d8SMichal Nazarewicz configuration will prevent Windows from automatically detecting 10725791e103SRandy Dunlap the gadget as a composite gadget, so an INF file will be needed to 1073f176a5d8SMichal Nazarewicz use the gadget. 1074f176a5d8SMichal Nazarewicz 1075f176a5d8SMichal Nazarewicz Say "y" to link the driver statically, or "m" to build a 1076f176a5d8SMichal Nazarewicz dynamically linked module called "g_multi". 1077f176a5d8SMichal Nazarewicz 1078f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_RNDIS 1079f176a5d8SMichal Nazarewicz bool "RNDIS + CDC Serial + Storage configuration" 1080f176a5d8SMichal Nazarewicz depends on USB_G_MULTI 10814d1a8f68SAndrzej Pietrasiewicz select USB_F_RNDIS 1082f176a5d8SMichal Nazarewicz default y 1083f176a5d8SMichal Nazarewicz help 1084f176a5d8SMichal Nazarewicz This option enables a configuration with RNDIS, CDC Serial and 1085f176a5d8SMichal Nazarewicz Mass Storage functions available in the Multifunction Composite 10865791e103SRandy Dunlap Gadget. This is the configuration dedicated for Windows since RNDIS 10875791e103SRandy Dunlap is Microsoft's protocol. 1088f176a5d8SMichal Nazarewicz 1089f176a5d8SMichal Nazarewicz If unsure, say "y". 1090f176a5d8SMichal Nazarewicz 1091f176a5d8SMichal Nazarewiczconfig USB_G_MULTI_CDC 1092f176a5d8SMichal Nazarewicz bool "CDC Ethernet + CDC Serial + Storage configuration" 1093f176a5d8SMichal Nazarewicz depends on USB_G_MULTI 1094f176a5d8SMichal Nazarewicz default n 109573889015SAndrzej Pietrasiewicz select USB_F_ECM 1096f176a5d8SMichal Nazarewicz help 1097f176a5d8SMichal Nazarewicz This option enables a configuration with CDC Ethernet (ECM), CDC 1098f176a5d8SMichal Nazarewicz Serial and Mass Storage functions available in the Multifunction 10995791e103SRandy Dunlap Composite Gadget. 1100f176a5d8SMichal Nazarewicz 1101f176a5d8SMichal Nazarewicz If unsure, say "y". 1102f176a5d8SMichal Nazarewicz 11034f73bc4dSJoe Millenbachendif # TTY 11044f73bc4dSJoe Millenbach 110571adf118SFabien Chouteauconfig USB_G_HID 110671adf118SFabien Chouteau tristate "HID Gadget" 1107a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 110871adf118SFabien Chouteau help 110971adf118SFabien Chouteau The HID gadget driver provides generic emulation of USB 111071adf118SFabien Chouteau Human Interface Devices (HID). 111171adf118SFabien Chouteau 111271adf118SFabien Chouteau For more information, see Documentation/usb/gadget_hid.txt which 111371adf118SFabien Chouteau includes sample code for accessing the device files. 111471adf118SFabien Chouteau 111571adf118SFabien Chouteau Say "y" to link the driver statically, or "m" to build a 111671adf118SFabien Chouteau dynamically linked module called "g_hid". 1117f176a5d8SMichal Nazarewicz 1118a84d9e53SSebastian Andrzej Siewior# Standalone / single function gadgets 1119f6c826a9Sstephane duvergerconfig USB_G_DBGP 1120f6c826a9Sstephane duverger tristate "EHCI Debug Device Gadget" 11214f73bc4dSJoe Millenbach depends on TTY 1122a84d9e53SSebastian Andrzej Siewior select USB_LIBCOMPOSITE 1123f6c826a9Sstephane duverger help 1124f6c826a9Sstephane duverger This gadget emulates an EHCI Debug device. This is useful when you want 1125f6c826a9Sstephane duverger to interact with an EHCI Debug Port. 1126f6c826a9Sstephane duverger 1127f6c826a9Sstephane duverger Say "y" to link the driver statically, or "m" to build a 1128f6c826a9Sstephane duverger dynamically linked module called "g_dbgp". 1129f6c826a9Sstephane duverger 1130f6c826a9Sstephane duvergerif USB_G_DBGP 1131f6c826a9Sstephane duvergerchoice 1132f6c826a9Sstephane duverger prompt "EHCI Debug Device mode" 1133f6c826a9Sstephane duverger default USB_G_DBGP_SERIAL 1134f6c826a9Sstephane duverger 1135f6c826a9Sstephane duvergerconfig USB_G_DBGP_PRINTK 1136f6c826a9Sstephane duverger depends on USB_G_DBGP 1137f6c826a9Sstephane duverger bool "printk" 1138f6c826a9Sstephane duverger help 1139f6c826a9Sstephane duverger Directly printk() received data. No interaction. 1140f6c826a9Sstephane duverger 1141f6c826a9Sstephane duvergerconfig USB_G_DBGP_SERIAL 1142f6c826a9Sstephane duverger depends on USB_G_DBGP 11433249ca22SSebastian Andrzej Siewior select USB_U_SERIAL 1144f6c826a9Sstephane duverger bool "serial" 1145f6c826a9Sstephane duverger help 1146f6c826a9Sstephane duverger Userland can interact using /dev/ttyGSxxx. 1147f6c826a9Sstephane duvergerendchoice 1148f6c826a9Sstephane duvergerendif 1149f6c826a9Sstephane duverger 11501da177e4SLinus Torvalds# put drivers that need isochronous transfer support (for audio 11511da177e4SLinus Torvalds# or video class gadget drivers), or specific hardware, here. 1152a9914127SLaurent Pinchartconfig USB_G_WEBCAM 1153a9914127SLaurent Pinchart tristate "USB Webcam Gadget" 115424337c13SRandy Dunlap depends on VIDEO_DEV 11550b2ffb78SLaurent Pinchart select USB_LIBCOMPOSITE 1156d6925225SBhupesh Sharma select VIDEOBUF2_VMALLOC 1157a9914127SLaurent Pinchart help 1158a9914127SLaurent Pinchart The Webcam Gadget acts as a composite USB Audio and Video Class 1159a9914127SLaurent Pinchart device. It provides a userspace API to process UVC control requests 1160a9914127SLaurent Pinchart and stream video data to the host. 11611da177e4SLinus Torvalds 1162a9914127SLaurent Pinchart Say "y" to link the driver statically, or "m" to build a 1163a9914127SLaurent Pinchart dynamically linked module called "g_webcam". 11641da177e4SLinus Torvalds 11651da177e4SLinus Torvaldsendchoice 11661da177e4SLinus Torvalds 1167b75be4abSDenis Chengendif # USB_GADGET 1168