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