1# 2# USB Gadget support on a system involves 3# (a) a peripheral controller, and 4# (b) the gadget driver using it. 5# 6# NOTE: Gadget support ** DOES NOT ** depend on host-side CONFIG_USB !! 7# 8# - Host systems (like PCs) need CONFIG_USB (with "A" jacks). 9# - Peripherals (like PDAs) need CONFIG_USB_GADGET (with "B" jacks). 10# - Some systems have both kinds of controllers. 11# 12# With help from a special transceiver and a "Mini-AB" jack, systems with 13# both kinds of controller can also support "USB On-the-Go" (CONFIG_USB_OTG). 14# 15 16menuconfig USB_GADGET 17 tristate "USB Gadget Support" 18 select NLS 19 help 20 USB is a master/slave protocol, organized with one master 21 host (such as a PC) controlling up to 127 peripheral devices. 22 The USB hardware is asymmetric, which makes it easier to set up: 23 you can't connect a "to-the-host" connector to a peripheral. 24 25 Linux can run in the host, or in the peripheral. In both cases 26 you need a low level bus controller driver, and some software 27 talking to it. Peripheral controllers are often discrete silicon, 28 or are integrated with the CPU in a microcontroller. The more 29 familiar host side controllers have names like "EHCI", "OHCI", 30 or "UHCI", and are usually integrated into southbridges on PC 31 motherboards. 32 33 Enable this configuration option if you want to run Linux inside 34 a USB peripheral device. Configure one hardware driver for your 35 peripheral/device side bus controller, and a "gadget driver" for 36 your peripheral protocol. (If you use modular gadget drivers, 37 you may configure more than one.) 38 39 If in doubt, say "N" and don't enable these drivers; most people 40 don't have this kind of hardware (except maybe inside Linux PDAs). 41 42 For more information, see <http://www.linux-usb.org/gadget> and 43 the kernel DocBook documentation for this API. 44 45if USB_GADGET 46 47config USB_GADGET_DEBUG 48 bool "Debugging messages (DEVELOPMENT)" 49 depends on DEBUG_KERNEL 50 help 51 Many controller and gadget drivers will print some debugging 52 messages if you use this option to ask for those messages. 53 54 Avoid enabling these messages, even if you're actively 55 debugging such a driver. Many drivers will emit so many 56 messages that the driver timings are affected, which will 57 either create new failure modes or remove the one you're 58 trying to track down. Never enable these messages for a 59 production build. 60 61config USB_GADGET_VERBOSE 62 bool "Verbose debugging Messages (DEVELOPMENT)" 63 depends on USB_GADGET_DEBUG 64 help 65 Many controller and gadget drivers will print verbose debugging 66 messages if you use this option to ask for those messages. 67 68 Avoid enabling these messages, even if you're actively 69 debugging such a driver. Many drivers will emit so many 70 messages that the driver timings are affected, which will 71 either create new failure modes or remove the one you're 72 trying to track down. Never enable these messages for a 73 production build. 74 75config USB_GADGET_DEBUG_FILES 76 bool "Debugging information files (DEVELOPMENT)" 77 depends on PROC_FS 78 help 79 Some of the drivers in the "gadget" framework can expose 80 debugging information in files such as /proc/driver/udc 81 (for a peripheral controller). The information in these 82 files may help when you're troubleshooting or bringing up a 83 driver on a new board. Enable these files by choosing "Y" 84 here. If in doubt, or to conserve kernel memory, say "N". 85 86config USB_GADGET_DEBUG_FS 87 bool "Debugging information files in debugfs (DEVELOPMENT)" 88 depends on DEBUG_FS 89 help 90 Some of the drivers in the "gadget" framework can expose 91 debugging information in files under /sys/kernel/debug/. 92 The information in these files may help when you're 93 troubleshooting or bringing up a driver on a new board. 94 Enable these files by choosing "Y" here. If in doubt, or 95 to conserve kernel memory, say "N". 96 97config USB_GADGET_VBUS_DRAW 98 int "Maximum VBUS Power usage (2-500 mA)" 99 range 2 500 100 default 2 101 help 102 Some devices need to draw power from USB when they are 103 configured, perhaps to operate circuitry or to recharge 104 batteries. This is in addition to any local power supply, 105 such as an AC adapter or batteries. 106 107 Enter the maximum power your device draws through USB, in 108 milliAmperes. The permitted range of values is 2 - 500 mA; 109 0 mA would be legal, but can make some hosts misbehave. 110 111 This value will be used except for system-specific gadget 112 drivers that have more specific information. 113 114config USB_GADGET_STORAGE_NUM_BUFFERS 115 int "Number of storage pipeline buffers" 116 range 2 32 117 default 2 118 help 119 Usually 2 buffers are enough to establish a good buffering 120 pipeline. The number may be increased in order to compensate 121 for a bursty VFS behaviour. For instance there may be CPU wake up 122 latencies that makes the VFS to appear bursty in a system with 123 an CPU on-demand governor. Especially if DMA is doing IO to 124 offload the CPU. In this case the CPU will go into power 125 save often and spin up occasionally to move data within VFS. 126 If selecting USB_GADGET_DEBUG_FILES this value may be set by 127 a module parameter as well. 128 If unsure, say 2. 129 130source "drivers/usb/gadget/udc/Kconfig" 131 132# 133# USB Gadget Drivers 134# 135 136# composite based drivers 137config USB_LIBCOMPOSITE 138 tristate 139 select CONFIGFS_FS 140 depends on USB_GADGET 141 142config USB_F_ACM 143 tristate 144 145config USB_F_SS_LB 146 tristate 147 148config USB_U_SERIAL 149 tristate 150 151config USB_U_ETHER 152 tristate 153 154config USB_F_SERIAL 155 tristate 156 157config USB_F_OBEX 158 tristate 159 160config USB_F_NCM 161 tristate 162 163config USB_F_ECM 164 tristate 165 166config USB_F_PHONET 167 tristate 168 169config USB_F_EEM 170 tristate 171 172config USB_F_SUBSET 173 tristate 174 175config USB_F_RNDIS 176 tristate 177 178config USB_F_MASS_STORAGE 179 tristate 180 181config USB_F_FS 182 tristate 183 184config USB_F_UAC1 185 tristate 186 187config USB_F_UAC2 188 tristate 189 190config USB_F_UVC 191 tristate 192 193config USB_F_MIDI 194 tristate 195 196config USB_F_HID 197 tristate 198 199config USB_F_PRINTER 200 tristate 201 202config USB_F_TCM 203 tristate 204 205choice 206 tristate "USB Gadget Drivers" 207 default USB_ETH 208 help 209 A Linux "Gadget Driver" talks to the USB Peripheral Controller 210 driver through the abstract "gadget" API. Some other operating 211 systems call these "client" drivers, of which "class drivers" 212 are a subset (implementing a USB device class specification). 213 A gadget driver implements one or more USB functions using 214 the peripheral hardware. 215 216 Gadget drivers are hardware-neutral, or "platform independent", 217 except that they sometimes must understand quirks or limitations 218 of the particular controllers they work with. For example, when 219 a controller doesn't support alternate configurations or provide 220 enough of the right types of endpoints, the gadget driver might 221 not be able work with that controller, or might need to implement 222 a less common variant of a device class protocol. 223 224# this first set of drivers all depend on bulk-capable hardware. 225 226config USB_CONFIGFS 227 tristate "USB functions configurable through configfs" 228 select USB_LIBCOMPOSITE 229 help 230 A Linux USB "gadget" can be set up through configfs. 231 If this is the case, the USB functions (which from the host's 232 perspective are seen as interfaces) and configurations are 233 specified simply by creating appropriate directories in configfs. 234 Associating functions with configurations is done by creating 235 appropriate symbolic links. 236 For more information see Documentation/usb/gadget_configfs.txt. 237 238config USB_CONFIGFS_SERIAL 239 bool "Generic serial bulk in/out" 240 depends on USB_CONFIGFS 241 depends on TTY 242 select USB_U_SERIAL 243 select USB_F_SERIAL 244 help 245 The function talks to the Linux-USB generic serial driver. 246 247config USB_CONFIGFS_ACM 248 bool "Abstract Control Model (CDC ACM)" 249 depends on USB_CONFIGFS 250 depends on TTY 251 select USB_U_SERIAL 252 select USB_F_ACM 253 help 254 ACM serial link. This function can be used to interoperate with 255 MS-Windows hosts or with the Linux-USB "cdc-acm" driver. 256 257config USB_CONFIGFS_OBEX 258 bool "Object Exchange Model (CDC OBEX)" 259 depends on USB_CONFIGFS 260 depends on TTY 261 select USB_U_SERIAL 262 select USB_F_OBEX 263 help 264 You will need a user space OBEX server talking to /dev/ttyGS*, 265 since the kernel itself doesn't implement the OBEX protocol. 266 267config USB_CONFIGFS_NCM 268 bool "Network Control Model (CDC NCM)" 269 depends on USB_CONFIGFS 270 depends on NET 271 select USB_U_ETHER 272 select USB_F_NCM 273 help 274 NCM is an advanced protocol for Ethernet encapsulation, allows 275 grouping of several ethernet frames into one USB transfer and 276 different alignment possibilities. 277 278config USB_CONFIGFS_ECM 279 bool "Ethernet Control Model (CDC ECM)" 280 depends on USB_CONFIGFS 281 depends on NET 282 select USB_U_ETHER 283 select USB_F_ECM 284 help 285 The "Communication Device Class" (CDC) Ethernet Control Model. 286 That protocol is often avoided with pure Ethernet adapters, in 287 favor of simpler vendor-specific hardware, but is widely 288 supported by firmware for smart network devices. 289 290config USB_CONFIGFS_ECM_SUBSET 291 bool "Ethernet Control Model (CDC ECM) subset" 292 depends on USB_CONFIGFS 293 depends on NET 294 select USB_U_ETHER 295 select USB_F_SUBSET 296 help 297 On hardware that can't implement the full protocol, 298 a simple CDC subset is used, placing fewer demands on USB. 299 300config USB_CONFIGFS_RNDIS 301 bool "RNDIS" 302 depends on USB_CONFIGFS 303 depends on NET 304 select USB_U_ETHER 305 select USB_F_RNDIS 306 help 307 Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol, 308 and Microsoft provides redistributable binary RNDIS drivers for 309 older versions of Windows. 310 311 To make MS-Windows work with this, use Documentation/usb/linux.inf 312 as the "driver info file". For versions of MS-Windows older than 313 XP, you'll need to download drivers from Microsoft's website; a URL 314 is given in comments found in that info file. 315 316config USB_CONFIGFS_EEM 317 bool "Ethernet Emulation Model (EEM)" 318 depends on USB_CONFIGFS 319 depends on NET 320 select USB_U_ETHER 321 select USB_F_EEM 322 help 323 CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM 324 and therefore can be supported by more hardware. Technically ECM and 325 EEM are designed for different applications. The ECM model extends 326 the network interface to the target (e.g. a USB cable modem), and the 327 EEM model is for mobile devices to communicate with hosts using 328 ethernet over USB. For Linux gadgets, however, the interface with 329 the host is the same (a usbX device), so the differences are minimal. 330 331config USB_CONFIGFS_PHONET 332 bool "Phonet protocol" 333 depends on USB_CONFIGFS 334 depends on NET 335 depends on PHONET 336 select USB_U_ETHER 337 select USB_F_PHONET 338 help 339 The Phonet protocol implementation for USB device. 340 341config USB_CONFIGFS_MASS_STORAGE 342 bool "Mass storage" 343 depends on USB_CONFIGFS 344 depends on BLOCK 345 select USB_F_MASS_STORAGE 346 help 347 The Mass Storage Gadget acts as a USB Mass Storage disk drive. 348 As its storage repository it can use a regular file or a block 349 device (in much the same way as the "loop" device driver), 350 specified as a module parameter or sysfs option. 351 352config USB_CONFIGFS_F_LB_SS 353 bool "Loopback and sourcesink function (for testing)" 354 depends on USB_CONFIGFS 355 select USB_F_SS_LB 356 help 357 Loopback function loops back a configurable number of transfers. 358 Sourcesink function either sinks and sources bulk data. 359 It also implements control requests, for "chapter 9" conformance. 360 Make this be the first driver you try using on top of any new 361 USB peripheral controller driver. Then you can use host-side 362 test software, like the "usbtest" driver, to put your hardware 363 and its driver through a basic set of functional tests. 364 365config USB_CONFIGFS_F_FS 366 bool "Function filesystem (FunctionFS)" 367 depends on USB_CONFIGFS 368 select USB_F_FS 369 help 370 The Function Filesystem (FunctionFS) lets one create USB 371 composite functions in user space in the same way GadgetFS 372 lets one create USB gadgets in user space. This allows creation 373 of composite gadgets such that some of the functions are 374 implemented in kernel space (for instance Ethernet, serial or 375 mass storage) and other are implemented in user space. 376 377config USB_CONFIGFS_F_UAC1 378 bool "Audio Class 1.0" 379 depends on USB_CONFIGFS 380 depends on SND 381 select USB_LIBCOMPOSITE 382 select SND_PCM 383 select USB_F_UAC1 384 help 385 This Audio function implements 1 AudioControl interface, 386 1 AudioStreaming Interface each for USB-OUT and USB-IN. 387 This driver requires a real Audio codec to be present 388 on the device. 389 390config USB_CONFIGFS_F_UAC2 391 bool "Audio Class 2.0" 392 depends on USB_CONFIGFS 393 depends on SND 394 select USB_LIBCOMPOSITE 395 select SND_PCM 396 select USB_F_UAC2 397 help 398 This Audio function is compatible with USB Audio Class 399 specification 2.0. It implements 1 AudioControl interface, 400 1 AudioStreaming Interface each for USB-OUT and USB-IN. 401 This driver doesn't expect any real Audio codec to be present 402 on the device - the audio streams are simply sinked to and 403 sourced from a virtual ALSA sound card created. The user-space 404 application may choose to do whatever it wants with the data 405 received from the USB Host and choose to provide whatever it 406 wants as audio data to the USB Host. 407 408config USB_CONFIGFS_F_MIDI 409 bool "MIDI function" 410 depends on USB_CONFIGFS 411 depends on SND 412 select USB_LIBCOMPOSITE 413 select SND_RAWMIDI 414 select USB_F_MIDI 415 help 416 The MIDI Function acts as a USB Audio device, with one MIDI 417 input and one MIDI output. These MIDI jacks appear as 418 a sound "card" in the ALSA sound system. Other MIDI 419 connections can then be made on the gadget system, using 420 ALSA's aconnect utility etc. 421 422config USB_CONFIGFS_F_HID 423 bool "HID function" 424 depends on USB_CONFIGFS 425 select USB_F_HID 426 help 427 The HID function driver provides generic emulation of USB 428 Human Interface Devices (HID). 429 430 For more information, see Documentation/usb/gadget_hid.txt. 431 432config USB_CONFIGFS_F_UVC 433 bool "USB Webcam function" 434 depends on USB_CONFIGFS 435 depends on VIDEO_DEV 436 select VIDEOBUF2_VMALLOC 437 select USB_F_UVC 438 help 439 The Webcam function acts as a composite USB Audio and Video Class 440 device. It provides a userspace API to process UVC control requests 441 and stream video data to the host. 442 443config USB_CONFIGFS_F_PRINTER 444 bool "Printer function" 445 select USB_F_PRINTER 446 depends on USB_CONFIGFS 447 help 448 The Printer function channels data between the USB host and a 449 userspace program driving the print engine. The user space 450 program reads and writes the device file /dev/g_printer<X> to 451 receive or send printer data. It can use ioctl calls to 452 the device file to get or set printer status. 453 454 For more information, see Documentation/usb/gadget_printer.txt 455 which includes sample code for accessing the device file. 456 457config USB_CONFIGFS_F_TCM 458 bool "USB Gadget Target Fabric" 459 depends on TARGET_CORE 460 depends on USB_CONFIGFS 461 select USB_LIBCOMPOSITE 462 select USB_F_TCM 463 help 464 This fabric is a USB gadget component. Two USB protocols are 465 supported that is BBB or BOT (Bulk Only Transport) and UAS 466 (USB Attached SCSI). BOT is advertised on alternative 467 interface 0 (primary) and UAS is on alternative interface 1. 468 Both protocols can work on USB2.0 and USB3.0. 469 UAS utilizes the USB 3.0 feature called streams support. 470 471source "drivers/usb/gadget/legacy/Kconfig" 472 473endchoice 474 475endif # USB_GADGET 476