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