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