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