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 y if USB_ZERO
  99         default y if USB_ETH
 100         default y if USB_G_SERIAL
 101
 102 config USB_GADGET_GOKU
 103         boolean "Toshiba TC86C001 'Goku-S'"
 104         depends on PCI
 105         help
 106            The Toshiba TC86C001 is a PCI device which includes controllers
 107            for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
 108
 109            The device controller has three configurable (bulk or interrupt)
 110            endpoints, plus endpoint zero (for control transfers).
 111
 112            Say "y" to link the driver statically, or "m" to build a
 113            dynamically linked module called "goku_udc" and to force all
 114            gadget drivers to also be dynamically linked.
 115
 116 config USB_GOKU
 117         tristate
 118         depends on USB_GADGET_GOKU
 119         default USB_GADGET
 120
 121 # this could be built elsewhere (doesn't yet exist)
 122 config USB_GADGET_SA1100
 123         boolean "SA 1100"
 124         depends on ARCH_SA1100
 125         help
 126            Intel's SA-1100 is an ARM-4 processor with an integrated
 127            full speed USB 1.1 device controller.
 128
 129            It has two fixed-function endpoints, as well as endpoint
 130            zero (for control transfers).
 131
 132 config USB_SA1100
 133         tristate
 134         depends on USB_GADGET_SA1100
 135         default USB_GADGET
 136
 137 config USB_GADGET_DUMMY_HCD
 138         boolean "Dummy HCD (DEVELOPMENT)"
 139         depends on USB && EXPERIMENTAL
 140         select USB_GADGET_DUALSPEED
 141         help
 142           This host controller driver emulates USB, looping all data transfer
 143           requests back to a USB "gadget driver" in the same host.  The host
 144           side is the master; the gadget side is the slave.  Gadget drivers
 145           can be high, full, or low speed; and they have access to endpoints
 146           like those from NET2280, PXA2xx, or SA1100 hardware.
 147
 148           This may help in some stages of creating a driver to embed in a
 149           Linux device, since it lets you debug several parts of the gadget
 150           driver without its hardware or drivers being involved.
 151
 152           Since such a gadget side driver needs to interoperate with a host
 153           side Linux-USB device driver, this may help to debug both sides
 154           of a USB protocol stack.
 155
 156           Say "y" to link the driver statically, or "m" to build a
 157           dynamically linked module called "dummy_hcd" and force all
 158           gadget drivers to also be dynamically linked.
 159
 160 config USB_DUMMY_HCD
 161         tristate
 162         depends on USB_GADGET_DUMMY_HCD
 163         default USB_GADGET
 164
 165 endchoice
 166
 167 config USB_GADGET_DUALSPEED
 168         bool
 169         depends on USB_GADGET
 170         default n
 171         help
 172           Means that gadget drivers should include extra descriptors
 173           and code to handle dual-speed controllers.
 174
 175 #
 176 # USB Gadget Drivers
 177 #
 178 choice
 179         tristate "USB Gadget Drivers"
 180         depends on USB_GADGET
 181         default USB_ETH
 182
 183 # this first set of drivers all depend on bulk-capable hardware.
 184
 185 config USB_ZERO
 186         tristate "Gadget Zero (DEVELOPMENT)"
 187         depends on EXPERIMENTAL
 188         help
 189           Gadget Zero is a two-configuration device.  It either sinks and
 190           sources bulk data; or it loops back a configurable number of
 191           transfers.  It also implements control requests, for "chapter 9"
 192           conformance.  The driver needs only two bulk-capable endpoints, so
 193           it can work on top of most device-side usb controllers.  It's
 194           useful for testing, and is also a working example showing how
 195           USB "gadget drivers" can be written.
 196
 197           Make this be the first driver you try using on top of any new
 198           USB peripheral controller driver.  Then you can use host-side
 199           test software, like the "usbtest" driver, to put your hardware
 200           and its driver through a basic set of functional tests.
 201
 202           Gadget Zero also works with the host-side "usb-skeleton" driver,
 203           and with many kinds of host-side test software.  You may need
 204           to tweak product and vendor IDs before host software knows about
 205           this device, and arrange to select an appropriate configuration.
 206
 207           Say "y" to link the driver statically, or "m" to build a
 208           dynamically linked module called "g_zero".
 209
 210 config USB_ETH
 211         tristate "Ethernet Gadget"
 212         depends on NET
 213         help
 214           This driver implements Ethernet style communication, in either
 215           of two ways:
 216
 217            - The "Communication Device Class" (CDC) Ethernet Control Model.
 218              That protocol is often avoided with pure Ethernet adapters, in
 219              favor of simpler vendor-specific hardware, but is widely
 220              supported by firmware for smart network devices.
 221
 222            - On hardware can't implement that protocol, a simple CDC subset
 223              is used, placing fewer demands on USB.
 224
 225           RNDIS support is a third option, more demanding than that subset.
 226
 227           Within the USB device, this gadget driver exposes a network device
 228           "usbX", where X depends on what other networking devices you have.
 229           Treat it like a two-node Ethernet link:  host, and gadget.
 230
 231           The Linux-USB host-side "usbnet" driver interoperates with this
 232           driver, so that deep I/O queues can be supported.  On 2.4 kernels,
 233           use "CDCEther" instead, if you're using the CDC option. That CDC
 234           mode should also interoperate with standard CDC Ethernet class
 235           drivers on other host operating systems.
 236
 237           Say "y" to link the driver statically, or "m" to build a
 238           dynamically linked module called "g_ether".
 239
 240 config USB_ETH_RNDIS
 241         bool "RNDIS support (EXPERIMENTAL)"
 242         depends on USB_ETH && EXPERIMENTAL
 243         default y
 244         help
 245            Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
 246            and Microsoft provides redistributable binary RNDIS drivers for
 247            older versions of Windows.
 248
 249            If you say "y" here, the Ethernet gadget driver will try to provide
 250            a second device configuration, supporting RNDIS to talk to such
 251            Microsoft USB hosts.
 252
 253 config USB_GADGETFS
 254         tristate "Gadget Filesystem (EXPERIMENTAL)"
 255         depends on EXPERIMENTAL
 256         help
 257           This driver provides a filesystem based API that lets user mode
 258           programs implement a single-configuration USB device, including
 259           endpoint I/O and control requests that don't relate to enumeration.
 260           All endpoints, transfer speeds, and transfer types supported by
 261           the hardware are available, through read() and write() calls.
 262
 263           Say "y" to link the driver statically, or "m" to build a
 264           dynamically linked module called "gadgetfs".
 265
 266 config USB_FILE_STORAGE
 267         tristate "File-backed Storage Gadget (DEVELOPMENT)"
 268         # we don't support the SA1100 because of its limitations
 269         depends on USB_GADGET_SA1100 = n
 270         help
 271           The File-backed Storage Gadget acts as a USB Mass Storage
 272           disk drive.  As its storage repository it can use a regular
 273           file or a block device (in much the same way as the "loop"
 274           device driver), specified as a module parameter.
 275
 276           Say "y" to link the driver statically, or "m" to build a
 277           dynamically linked module called "g_file_storage".
 278
 279 config USB_FILE_STORAGE_TEST
 280         bool "File-backed Storage Gadget test version"
 281         depends on USB_FILE_STORAGE
 282         default n
 283         help
 284           Say "y" to generate the larger testing version of the
 285           File-backed Storage Gadget, useful for probing the
 286           behavior of USB Mass Storage hosts.  Not needed for
 287           normal operation.
 288
 289 config USB_G_SERIAL
 290         tristate "Serial Gadget"
 291         help
 292           The Serial Gadget talks to the Linux-USB generic serial driver.
 293
 294           Say "y" to link the driver statically, or "m" to build a
 295           dynamically linked module called "g_serial".
 296
 297
 298
 299 # put drivers that need isochronous transfer support (for audio
 300 # or video class gadget drivers), or specific hardware, here.
 301
 302 # - none yet
 303
 304 endchoice
 305
 306 endmenu