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