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