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