drivers/usb/gadget/Kconfig

   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 menu "USB Gadget Support"
  16
  17 config USB_GADGET
  18         tristate "Support for USB Gadgets"
  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
  45 config USB_GADGET_DEBUG_FILES
  46         boolean "Debugging information files"
  47         depends on USB_GADGET && PROC_FS
  48         help
  49            Some of the drivers in the "gadget" framework can expose
  50            debugging information in files such as /proc/driver/udc
  51            (for a peripheral controller).  The information in these
  52            files may help when you're troubleshooting or bringing up a
  53            driver on a new board.   Enable these files by choosing "Y"
  54            here.  If in doubt, or to conserve kernel memory, say "N".
  55
  56 config  USB_GADGET_SELECTED
  57         boolean
  58
  59 #
  60 # USB Peripheral Controller Support
  61 #
  62 choice
  63         prompt "USB Peripheral Controller"
  64         depends on USB_GADGET
  65         help
  66            A USB device uses a controller to talk to its host.
  67            Systems should have only one such upstream link.
  68            Many controller drivers are platform-specific; these
  69            often need board-specific hooks.
  70
  71 config USB_GADGET_NET2280
  72         boolean "NetChip 228x"
  73         depends on PCI
  74         select USB_GADGET_DUALSPEED
  75         help
  76            NetChip 2280 / 2282 is a PCI based USB peripheral controller which
  77            supports both full and high speed USB 2.0 data transfers.
  78
  79            It has six configurable endpoints, as well as endpoint zero
  80            (for control transfers) and several endpoints with dedicated
  81            functions.
  82
  83            Say "y" to link the driver statically, or "m" to build a
  84            dynamically linked module called "net2280" and force all
  85            gadget drivers to also be dynamically linked.
  86
  87 config USB_NET2280
  88         tristate
  89         depends on USB_GADGET_NET2280
  90         default USB_GADGET
  91         select USB_GADGET_SELECTED
  92
  93 config USB_GADGET_PXA2XX
  94         boolean "PXA 25x or IXP 4xx"
  95         depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX
  96         help
  97            Intel's PXA 25x series XScale ARM-5TE processors include
  98            an integrated full speed USB 1.1 device controller.  The
  99            controller in the IXP 4xx series is register-compatible.
 100
 101            It has fifteen fixed-function endpoints, as well as endpoint
 102            zero (for control transfers).
 103
 104            Say "y" to link the driver statically, or "m" to build a
 105            dynamically linked module called "pxa2xx_udc" and force all
 106            gadget drivers to also be dynamically linked.
 107
 108 config USB_PXA2XX
 109         tristate
 110         depends on USB_GADGET_PXA2XX
 111         default USB_GADGET
 112         select USB_GADGET_SELECTED
 113
 114 # if there's only one gadget driver, using only two bulk endpoints,
 115 # don't waste memory for the other endpoints
 116 config USB_PXA2XX_SMALL
 117         depends on USB_GADGET_PXA2XX
 118         bool
 119         default n if USB_ETH_RNDIS
 120         default y if USB_ZERO
 121         default y if USB_ETH
 122         default y if USB_G_SERIAL
 123
 124 config USB_GADGET_GOKU
 125         boolean "Toshiba TC86C001 'Goku-S'"
 126         depends on PCI
 127         help
 128            The Toshiba TC86C001 is a PCI device which includes controllers
 129            for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
 130
 131            The device controller has three configurable (bulk or interrupt)
 132            endpoints, plus endpoint zero (for control transfers).
 133
 134            Say "y" to link the driver statically, or "m" to build a
 135            dynamically linked module called "goku_udc" and to force all
 136            gadget drivers to also be dynamically linked.
 137
 138 config USB_GOKU
 139         tristate
 140         depends on USB_GADGET_GOKU
 141         default USB_GADGET
 142         select USB_GADGET_SELECTED
 143
 144
 145 config USB_GADGET_LH7A40X
 146         boolean "LH7A40X"
 147         depends on ARCH_LH7A40X
 148         help
 149     This driver provides USB Device Controller driver for LH7A40x
 150
 151 config USB_LH7A40X
 152         tristate
 153         depends on USB_GADGET_LH7A40X
 154         default USB_GADGET
 155         select USB_GADGET_SELECTED
 156
 157
 158 # built in ../musb along with host support
 159 config USB_GADGET_MUSB_HDRC
 160         boolean "Inventra HDRC USB Peripheral (TI, ...)"
 161         depends on USB_MUSB_HDRC && (USB_MUSB_PERIPHERAL || USB_MUSB_OTG)
 162         select USB_GADGET_DUALSPEED
 163         select USB_GADGET_SELECTED
 164         help
 165           This OTG-capable silicon IP is used in dual designs including
 166           the TI DaVinci, OMAP 243x, OMAP 343x, and TUSB 6010.
 167
 168 config USB_GADGET_OMAP
 169         boolean "OMAP USB Device Controller"
 170         depends on ARCH_OMAP
 171         select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3 || MACH_OMAP_H4_OTG
 172         help
 173            Many Texas Instruments OMAP processors have flexible full
 174            speed USB device controllers, with support for up to 30
 175            endpoints (plus endpoint zero).  This driver supports the
 176            controller in the OMAP 1611, and should work with controllers
 177            in other OMAP processors too, given minor tweaks.
 178
 179            Say "y" to link the driver statically, or "m" to build a
 180            dynamically linked module called "omap_udc" and force all
 181            gadget drivers to also be dynamically linked.
 182
 183 config USB_OMAP
 184         tristate
 185         depends on USB_GADGET_OMAP
 186         default USB_GADGET
 187         select USB_GADGET_SELECTED
 188
 189 config USB_OTG
 190         boolean "OTG Support"
 191         depends on USB_GADGET_OMAP && ARCH_OMAP_OTG && USB_OHCI_HCD
 192         help
 193            The most notable feature of USB OTG is support for a
 194            "Dual-Role" device, which can act as either a device
 195            or a host.  The initial role choice can be changed
 196            later, when two dual-role devices talk to each other.
 197
 198            Select this only if your OMAP board has a Mini-AB connector.
 199
 200 config USB_GADGET_AT91
 201         boolean "AT91 USB Device Port"
 202         depends on ARCH_AT91
 203         select USB_GADGET_SELECTED
 204         help
 205            Many Atmel AT91 processors (such as the AT91RM2000) have a
 206            full speed USB Device Port with support for five configurable
 207            endpoints (plus endpoint zero).
 208
 209            Say "y" to link the driver statically, or "m" to build a
 210            dynamically linked module called "at91_udc" and force all
 211            gadget drivers to also be dynamically linked.
 212
 213 config USB_AT91
 214         tristate
 215         depends on USB_GADGET_AT91
 216         default USB_GADGET
 217
 218 config USB_GADGET_DUMMY_HCD
 219         boolean "Dummy HCD (DEVELOPMENT)"
 220         depends on (USB=y || (USB=m && USB_GADGET=m)) && EXPERIMENTAL
 221         select USB_GADGET_DUALSPEED
 222         help
 223           This host controller driver emulates USB, looping all data transfer
 224           requests back to a USB "gadget driver" in the same host.  The host
 225           side is the master; the gadget side is the slave.  Gadget drivers
 226           can be high, full, or low speed; and they have access to endpoints
 227           like those from NET2280, PXA2xx, or SA1100 hardware.
 228
 229           This may help in some stages of creating a driver to embed in a
 230           Linux device, since it lets you debug several parts of the gadget
 231           driver without its hardware or drivers being involved.
 232
 233           Since such a gadget side driver needs to interoperate with a host
 234           side Linux-USB device driver, this may help to debug both sides
 235           of a USB protocol stack.
 236
 237           Say "y" to link the driver statically, or "m" to build a
 238           dynamically linked module called "dummy_hcd" and force all
 239           gadget drivers to also be dynamically linked.
 240
 241 config USB_DUMMY_HCD
 242         tristate
 243         depends on USB_GADGET_DUMMY_HCD
 244         default USB_GADGET
 245         select USB_GADGET_SELECTED
 246
 247 # NOTE:  Please keep dummy_hcd LAST so that "real hardware" appears
 248 # first and will be selected by default.
 249
 250 endchoice
 251
 252 config USB_GADGET_DUALSPEED
 253         bool
 254         depends on USB_GADGET
 255         default n
 256         help
 257           Means that gadget drivers should include extra descriptors
 258           and code to handle dual-speed controllers.
 259
 260 #
 261 # USB Gadget Drivers
 262 #
 263 choice
 264         tristate "USB Gadget Drivers"
 265         depends on USB_GADGET && USB_GADGET_SELECTED
 266         default USB_ETH
 267         help
 268           A Linux "Gadget Driver" talks to the USB Peripheral Controller
 269           driver through the abstract "gadget" API.  Some other operating
 270           systems call these "client" drivers, of which "class drivers"
 271           are a subset (implementing a USB device class specification).
 272           A gadget driver implements one or more USB functions using
 273           the peripheral hardware.
 274
 275           Gadget drivers are hardware-neutral, or "platform independent",
 276           except that they sometimes must understand quirks or limitations
 277           of the particular controllers they work with.  For example, when
 278           a controller doesn't support alternate configurations or provide
 279           enough of the right types of endpoints, the gadget driver might
 280           not be able work with that controller, or might need to implement
 281           a less common variant of a device class protocol.
 282
 283 # this first set of drivers all depend on bulk-capable hardware.
 284
 285 config USB_ZERO
 286         tristate "Gadget Zero (DEVELOPMENT)"
 287         depends on EXPERIMENTAL
 288         help
 289           Gadget Zero is a two-configuration device.  It either sinks and
 290           sources bulk data; or it loops back a configurable number of
 291           transfers.  It also implements control requests, for "chapter 9"
 292           conformance.  The driver needs only two bulk-capable endpoints, so
 293           it can work on top of most device-side usb controllers.  It's
 294           useful for testing, and is also a working example showing how
 295           USB "gadget drivers" can be written.
 296
 297           Make this be the first driver you try using on top of any new
 298           USB peripheral controller driver.  Then you can use host-side
 299           test software, like the "usbtest" driver, to put your hardware
 300           and its driver through a basic set of functional tests.
 301
 302           Gadget Zero also works with the host-side "usb-skeleton" driver,
 303           and with many kinds of host-side test software.  You may need
 304           to tweak product and vendor IDs before host software knows about
 305           this device, and arrange to select an appropriate configuration.
 306
 307           Say "y" to link the driver statically, or "m" to build a
 308           dynamically linked module called "g_zero".
 309
 310 config USB_ZERO_HNPTEST
 311         boolean "HNP Test Device"
 312         depends on USB_ZERO && USB_OTG
 313         help
 314           You can configure this device to enumerate using the device
 315           identifiers of the USB-OTG test device.  That means that when
 316           this gadget connects to another OTG device, with this one using
 317           the "B-Peripheral" role, that device will use HNP to let this
 318           one serve as the USB host instead (in the "B-Host" role).
 319
 320 config USB_ETH
 321         tristate "Ethernet Gadget (with CDC Ethernet support)"
 322         depends on NET
 323         help
 324           This driver implements Ethernet style communication, in either
 325           of two ways:
 326
 327            - The "Communication Device Class" (CDC) Ethernet Control Model.
 328              That protocol is often avoided with pure Ethernet adapters, in
 329              favor of simpler vendor-specific hardware, but is widely
 330              supported by firmware for smart network devices.
 331
 332            - On hardware can't implement that protocol, a simple CDC subset
 333              is used, placing fewer demands on USB.
 334
 335           RNDIS support is a third option, more demanding than that subset.
 336
 337           Within the USB device, this gadget driver exposes a network device
 338           "usbX", where X depends on what other networking devices you have.
 339           Treat it like a two-node Ethernet link:  host, and gadget.
 340
 341           The Linux-USB host-side "usbnet" driver interoperates with this
 342           driver, so that deep I/O queues can be supported.  On 2.4 kernels,
 343           use "CDCEther" instead, if you're using the CDC option. That CDC
 344           mode should also interoperate with standard CDC Ethernet class
 345           drivers on other host operating systems.
 346
 347           Say "y" to link the driver statically, or "m" to build a
 348           dynamically linked module called "g_ether".
 349
 350 config USB_ETH_RNDIS
 351         bool "RNDIS support (EXPERIMENTAL)"
 352         depends on USB_ETH && EXPERIMENTAL
 353         default y
 354         help
 355            Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
 356            and Microsoft provides redistributable binary RNDIS drivers for
 357            older versions of Windows.
 358
 359            If you say "y" here, the Ethernet gadget driver will try to provide
 360            a second device configuration, supporting RNDIS to talk to such
 361            Microsoft USB hosts.
 362
 363            To make MS-Windows work with this, use Documentation/usb/linux.inf
 364            as the "driver info file".  For versions of MS-Windows older than
 365            XP, you'll need to download drivers from Microsoft's website; a URL
 366            is given in comments found in that info file.
 367
 368 config USB_GADGETFS
 369         tristate "Gadget Filesystem (EXPERIMENTAL)"
 370         depends on EXPERIMENTAL
 371         help
 372           This driver provides a filesystem based API that lets user mode
 373           programs implement a single-configuration USB device, including
 374           endpoint I/O and control requests that don't relate to enumeration.
 375           All endpoints, transfer speeds, and transfer types supported by
 376           the hardware are available, through read() and write() calls.
 377
 378           Say "y" to link the driver statically, or "m" to build a
 379           dynamically linked module called "gadgetfs".
 380
 381 config USB_FILE_STORAGE
 382         tristate "File-backed Storage Gadget"
 383         help
 384           The File-backed Storage Gadget acts as a USB Mass Storage
 385           disk drive.  As its storage repository it can use a regular
 386           file or a block device (in much the same way as the "loop"
 387           device driver), specified as a module parameter.
 388
 389           Say "y" to link the driver statically, or "m" to build a
 390           dynamically linked module called "g_file_storage".
 391
 392 config USB_FILE_STORAGE_TEST
 393         bool "File-backed Storage Gadget testing version"
 394         depends on USB_FILE_STORAGE
 395         default n
 396         help
 397           Say "y" to generate the larger testing version of the
 398           File-backed Storage Gadget, useful for probing the
 399           behavior of USB Mass Storage hosts.  Not needed for
 400           normal operation.
 401
 402 config USB_G_SERIAL
 403         tristate "Serial Gadget (with CDC ACM support)"
 404         help
 405           The Serial Gadget talks to the Linux-USB generic serial driver.
 406           This driver supports a CDC-ACM module option, which can be used
 407           to interoperate with MS-Windows hosts or with the Linux-USB
 408           "cdc-acm" driver.
 409
 410           Say "y" to link the driver statically, or "m" to build a
 411           dynamically linked module called "g_serial".
 412
 413           For more information, see Documentation/usb/gadget_serial.txt
 414           which includes instructions and a "driver info file" needed to
 415           make MS-Windows work with this driver.
 416
 417 config USB_MIDI_GADGET
 418         tristate "MIDI Gadget (EXPERIMENTAL)"
 419         depends on SND && EXPERIMENTAL
 420         select SND_RAWMIDI
 421         help
 422           The MIDI Gadget acts as a USB Audio device, with one MIDI
 423           input and one MIDI output. These MIDI jacks appear as
 424           a sound "card" in the ALSA sound system. Other MIDI
 425           connections can then be made on the gadget system, using
 426           ALSA's aconnect utility etc.
 427
 428           Say "y" to link the driver statically, or "m" to build a
 429           dynamically linked module called "g_midi".
 430
 431
 432 # put drivers that need isochronous transfer support (for audio
 433 # or video class gadget drivers), or specific hardware, here.
 434
 435 # - none yet
 436
 437 endchoice
 438
 439 endmenu