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