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 # built in ../musb along with host support
 180 config USB_GADGET_MUSB_HDRC
 181         boolean "Inventra HDRC USB Peripheral (TI, ...)"
 182         depends on USB_MUSB_HDRC && (USB_MUSB_PERIPHERAL || USB_MUSB_OTG)
 183         select USB_GADGET_DUALSPEED
 184         select USB_GADGET_SELECTED
 185         help
 186           This OTG-capable silicon IP is used in dual designs including
 187           the TI DaVinci, OMAP 243x, OMAP 343x, and TUSB 6010.
 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 || MACH_OMAP_H3 || MACH_OMAP_H4_OTG
 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         select USB_GADGET_SELECTED
 209
 210 config USB_OTG
 211         boolean "OTG Support"
 212         depends on USB_GADGET_OMAP && ARCH_OMAP_OTG && USB_OHCI_HCD
 213         help
 214            The most notable feature of USB OTG is support for a
 215            "Dual-Role" device, which can act as either a device
 216            or a host.  The initial role choice can be changed
 217            later, when two dual-role devices talk to each other.
 218
 219            Select this only if your OMAP board has a Mini-AB connector.
 220
 221 config USB_GADGET_AT91
 222         boolean "AT91 USB Device Port"
 223         depends on ARCH_AT91 && !ARCH_AT91SAM9RL
 224         select USB_GADGET_SELECTED
 225         help
 226            Many Atmel AT91 processors (such as the AT91RM2000) have a
 227            full speed USB Device Port with support for five configurable
 228            endpoints (plus endpoint zero).
 229
 230            Say "y" to link the driver statically, or "m" to build a
 231            dynamically linked module called "at91_udc" and force all
 232            gadget drivers to also be dynamically linked.
 233
 234 config USB_AT91
 235         tristate
 236         depends on USB_GADGET_AT91
 237         default USB_GADGET
 238
 239 config USB_GADGET_DUMMY_HCD
 240         boolean "Dummy HCD (DEVELOPMENT)"
 241         depends on (USB=y || (USB=m && USB_GADGET=m)) && EXPERIMENTAL
 242         select USB_GADGET_DUALSPEED
 243         help
 244           This host controller driver emulates USB, looping all data transfer
 245           requests back to a USB "gadget driver" in the same host.  The host
 246           side is the master; the gadget side is the slave.  Gadget drivers
 247           can be high, full, or low speed; and they have access to endpoints
 248           like those from NET2280, PXA2xx, or SA1100 hardware.
 249
 250           This may help in some stages of creating a driver to embed in a
 251           Linux device, since it lets you debug several parts of the gadget
 252           driver without its hardware or drivers being involved.
 253
 254           Since such a gadget side driver needs to interoperate with a host
 255           side Linux-USB device driver, this may help to debug both sides
 256           of a USB protocol stack.
 257
 258           Say "y" to link the driver statically, or "m" to build a
 259           dynamically linked module called "dummy_hcd" and force all
 260           gadget drivers to also be dynamically linked.
 261
 262 config USB_DUMMY_HCD
 263         tristate
 264         depends on USB_GADGET_DUMMY_HCD
 265         default USB_GADGET
 266         select USB_GADGET_SELECTED
 267
 268 # NOTE:  Please keep dummy_hcd LAST so that "real hardware" appears
 269 # first and will be selected by default.
 270
 271 endchoice
 272
 273 config USB_GADGET_DUALSPEED
 274         bool
 275         depends on USB_GADGET
 276         default n
 277         help
 278           Means that gadget drivers should include extra descriptors
 279           and code to handle dual-speed controllers.
 280
 281 #
 282 # USB Gadget Drivers
 283 #
 284 choice
 285         tristate "USB Gadget Drivers"
 286         depends on USB_GADGET && USB_GADGET_SELECTED
 287         default USB_ETH
 288         help
 289           A Linux "Gadget Driver" talks to the USB Peripheral Controller
 290           driver through the abstract "gadget" API.  Some other operating
 291           systems call these "client" drivers, of which "class drivers"
 292           are a subset (implementing a USB device class specification).
 293           A gadget driver implements one or more USB functions using
 294           the peripheral hardware.
 295
 296           Gadget drivers are hardware-neutral, or "platform independent",
 297           except that they sometimes must understand quirks or limitations
 298           of the particular controllers they work with.  For example, when
 299           a controller doesn't support alternate configurations or provide
 300           enough of the right types of endpoints, the gadget driver might
 301           not be able work with that controller, or might need to implement
 302           a less common variant of a device class protocol.
 303
 304 # this first set of drivers all depend on bulk-capable hardware.
 305
 306 config USB_ZERO
 307         tristate "Gadget Zero (DEVELOPMENT)"
 308         depends on EXPERIMENTAL
 309         help
 310           Gadget Zero is a two-configuration device.  It either sinks and
 311           sources bulk data; or it loops back a configurable number of
 312           transfers.  It also implements control requests, for "chapter 9"
 313           conformance.  The driver needs only two bulk-capable endpoints, so
 314           it can work on top of most device-side usb controllers.  It's
 315           useful for testing, and is also a working example showing how
 316           USB "gadget drivers" can be written.
 317
 318           Make this be the first driver you try using on top of any new
 319           USB peripheral controller driver.  Then you can use host-side
 320           test software, like the "usbtest" driver, to put your hardware
 321           and its driver through a basic set of functional tests.
 322
 323           Gadget Zero also works with the host-side "usb-skeleton" driver,
 324           and with many kinds of host-side test software.  You may need
 325           to tweak product and vendor IDs before host software knows about
 326           this device, and arrange to select an appropriate configuration.
 327
 328           Say "y" to link the driver statically, or "m" to build a
 329           dynamically linked module called "g_zero".
 330
 331 config USB_ZERO_HNPTEST
 332         boolean "HNP Test Device"
 333         depends on USB_ZERO && USB_OTG
 334         help
 335           You can configure this device to enumerate using the device
 336           identifiers of the USB-OTG test device.  That means that when
 337           this gadget connects to another OTG device, with this one using
 338           the "B-Peripheral" role, that device will use HNP to let this
 339           one serve as the USB host instead (in the "B-Host" role).
 340
 341 config USB_ETH
 342         tristate "Ethernet Gadget (with CDC Ethernet support)"
 343         depends on NET
 344         help
 345           This driver implements Ethernet style communication, in either
 346           of two ways:
 347
 348            - The "Communication Device Class" (CDC) Ethernet Control Model.
 349              That protocol is often avoided with pure Ethernet adapters, in
 350              favor of simpler vendor-specific hardware, but is widely
 351              supported by firmware for smart network devices.
 352
 353            - On hardware can't implement that protocol, a simple CDC subset
 354              is used, placing fewer demands on USB.
 355
 356           RNDIS support is a third option, more demanding than that subset.
 357
 358           Within the USB device, this gadget driver exposes a network device
 359           "usbX", where X depends on what other networking devices you have.
 360           Treat it like a two-node Ethernet link:  host, and gadget.
 361
 362           The Linux-USB host-side "usbnet" driver interoperates with this
 363           driver, so that deep I/O queues can be supported.  On 2.4 kernels,
 364           use "CDCEther" instead, if you're using the CDC option. That CDC
 365           mode should also interoperate with standard CDC Ethernet class
 366           drivers on other host operating systems.
 367
 368           Say "y" to link the driver statically, or "m" to build a
 369           dynamically linked module called "g_ether".
 370
 371 config USB_ETH_RNDIS
 372         bool "RNDIS support (EXPERIMENTAL)"
 373         depends on USB_ETH && EXPERIMENTAL
 374         default y
 375         help
 376            Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
 377            and Microsoft provides redistributable binary RNDIS drivers for
 378            older versions of Windows.
 379
 380            If you say "y" here, the Ethernet gadget driver will try to provide
 381            a second device configuration, supporting RNDIS to talk to such
 382            Microsoft USB hosts.
 383
 384            To make MS-Windows work with this, use Documentation/usb/linux.inf
 385            as the "driver info file".  For versions of MS-Windows older than
 386            XP, you'll need to download drivers from Microsoft's website; a URL
 387            is given in comments found in that info file.
 388
 389 config USB_GADGETFS
 390         tristate "Gadget Filesystem (EXPERIMENTAL)"
 391         depends on EXPERIMENTAL
 392         help
 393           This driver provides a filesystem based API that lets user mode
 394           programs implement a single-configuration USB device, including
 395           endpoint I/O and control requests that don't relate to enumeration.
 396           All endpoints, transfer speeds, and transfer types supported by
 397           the hardware are available, through read() and write() calls.
 398
 399           Say "y" to link the driver statically, or "m" to build a
 400           dynamically linked module called "gadgetfs".
 401
 402 config USB_FILE_STORAGE
 403         tristate "File-backed Storage Gadget"
 404         depends on BLOCK
 405         help
 406           The File-backed Storage Gadget acts as a USB Mass Storage
 407           disk drive.  As its storage repository it can use a regular
 408           file or a block device (in much the same way as the "loop"
 409           device driver), specified as a module parameter.
 410
 411           Say "y" to link the driver statically, or "m" to build a
 412           dynamically linked module called "g_file_storage".
 413
 414 config USB_FILE_STORAGE_TEST
 415         bool "File-backed Storage Gadget testing version"
 416         depends on USB_FILE_STORAGE
 417         default n
 418         help
 419           Say "y" to generate the larger testing version of the
 420           File-backed Storage Gadget, useful for probing the
 421           behavior of USB Mass Storage hosts.  Not needed for
 422           normal operation.
 423
 424 config USB_G_SERIAL
 425         tristate "Serial Gadget (with CDC ACM support)"
 426         help
 427           The Serial Gadget talks to the Linux-USB generic serial driver.
 428           This driver supports a CDC-ACM module option, which can be used
 429           to interoperate with MS-Windows hosts or with the Linux-USB
 430           "cdc-acm" driver.
 431
 432           Say "y" to link the driver statically, or "m" to build a
 433           dynamically linked module called "g_serial".
 434
 435           For more information, see Documentation/usb/gadget_serial.txt
 436           which includes instructions and a "driver info file" needed to
 437           make MS-Windows work with this driver.
 438
 439 config USB_MIDI_GADGET
 440         tristate "MIDI Gadget (EXPERIMENTAL)"
 441         depends on SND && EXPERIMENTAL
 442         select SND_RAWMIDI
 443         help
 444           The MIDI Gadget acts as a USB Audio device, with one MIDI
 445           input and one MIDI output. These MIDI jacks appear as
 446           a sound "card" in the ALSA sound system. Other MIDI
 447           connections can then be made on the gadget system, using
 448           ALSA's aconnect utility etc.
 449
 450           Say "y" to link the driver statically, or "m" to build a
 451           dynamically linked module called "g_midi".
 452
 453
 454 # put drivers that need isochronous transfer support (for audio
 455 # or video class gadget drivers), or specific hardware, here.
 456
 457 # - none yet
 458
 459 endchoice
 460
 461 endmenu