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         select NLS
  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 if USB_GADGET
  46
  47 config USB_GADGET_DEBUG
  48         boolean "Debugging messages (DEVELOPMENT)"
  49         depends on DEBUG_KERNEL
  50         help
  51            Many controller and gadget drivers will print some debugging
  52            messages if you use this option to ask for those messages.
  53
  54            Avoid enabling these messages, even if you're actively
  55            debugging such a driver.  Many drivers will emit so many
  56            messages that the driver timings are affected, which will
  57            either create new failure modes or remove the one you're
  58            trying to track down.  Never enable these messages for a
  59            production build.
  60
  61 config USB_GADGET_DEBUG_FILES
  62         boolean "Debugging information files (DEVELOPMENT)"
  63         depends on PROC_FS
  64         help
  65            Some of the drivers in the "gadget" framework can expose
  66            debugging information in files such as /proc/driver/udc
  67            (for a peripheral controller).  The information in these
  68            files may help when you're troubleshooting or bringing up a
  69            driver on a new board.   Enable these files by choosing "Y"
  70            here.  If in doubt, or to conserve kernel memory, say "N".
  71
  72 config USB_GADGET_DEBUG_FS
  73         boolean "Debugging information files in debugfs (DEVELOPMENT)"
  74         depends on DEBUG_FS
  75         help
  76            Some of the drivers in the "gadget" framework can expose
  77            debugging information in files under /sys/kernel/debug/.
  78            The information in these files may help when you're
  79            troubleshooting or bringing up a driver on a new board.
  80            Enable these files by choosing "Y" here.  If in doubt, or
  81            to conserve kernel memory, say "N".
  82
  83 config USB_GADGET_VBUS_DRAW
  84         int "Maximum VBUS Power usage (2-500 mA)"
  85         range 2 500
  86         default 2
  87         help
  88            Some devices need to draw power from USB when they are
  89            configured, perhaps to operate circuitry or to recharge
  90            batteries.  This is in addition to any local power supply,
  91            such as an AC adapter or batteries.
  92
  93            Enter the maximum power your device draws through USB, in
  94            milliAmperes.  The permitted range of values is 2 - 500 mA;
  95            0 mA would be legal, but can make some hosts misbehave.
  96
  97            This value will be used except for system-specific gadget
  98            drivers that have more specific information.
  99
 100 config USB_GADGET_STORAGE_NUM_BUFFERS
 101         int "Number of storage pipeline buffers"
 102         range 2 4
 103         default 2
 104         help
 105            Usually 2 buffers are enough to establish a good buffering
 106            pipeline. The number may be increased in order to compensate
 107            for a bursty VFS behaviour. For instance there may be CPU wake up
 108            latencies that makes the VFS to appear bursty in a system with
 109            an CPU on-demand governor. Especially if DMA is doing IO to
 110            offload the CPU. In this case the CPU will go into power
 111            save often and spin up occasionally to move data within VFS.
 112            If selecting USB_GADGET_DEBUG_FILES this value may be set by
 113            a module parameter as well.
 114            If unsure, say 2.
 115
 116 #
 117 # USB Peripheral Controller Support
 118 #
 119 # The order here is alphabetical, except that integrated controllers go
 120 # before discrete ones so they will be the initial/default value:
 121 #   - integrated/SOC controllers first
 122 #   - licensed IP used in both SOC and discrete versions
 123 #   - discrete ones (including all PCI-only controllers)
 124 #   - debug/dummy gadget+hcd is last.
 125 #
 126 menu "USB Peripheral Controller"
 127
 128 #
 129 # Integrated controllers
 130 #
 131
 132 config USB_AT91
 133         tristate "Atmel AT91 USB Device Port"
 134         depends on ARCH_AT91
 135         help
 136            Many Atmel AT91 processors (such as the AT91RM2000) have a
 137            full speed USB Device Port with support for five configurable
 138            endpoints (plus endpoint zero).
 139
 140            Say "y" to link the driver statically, or "m" to build a
 141            dynamically linked module called "at91_udc" and force all
 142            gadget drivers to also be dynamically linked.
 143
 144 config USB_LPC32XX
 145         tristate "LPC32XX USB Peripheral Controller"
 146         depends on ARCH_LPC32XX
 147         select USB_ISP1301
 148         help
 149            This option selects the USB device controller in the LPC32xx SoC.
 150
 151            Say "y" to link the driver statically, or "m" to build a
 152            dynamically linked module called "lpc32xx_udc" and force all
 153            gadget drivers to also be dynamically linked.
 154
 155 config USB_ATMEL_USBA
 156         tristate "Atmel USBA"
 157         depends on AVR32 || ARCH_AT91SAM9RL || ARCH_AT91SAM9G45
 158         help
 159           USBA is the integrated high-speed USB Device controller on
 160           the AT32AP700x, some AT91SAM9 and AT91CAP9 processors from Atmel.
 161
 162 config USB_BCM63XX_UDC
 163         tristate "Broadcom BCM63xx Peripheral Controller"
 164         depends on BCM63XX
 165         help
 166            Many Broadcom BCM63xx chipsets (such as the BCM6328) have a
 167            high speed USB Device Port with support for four fixed endpoints
 168            (plus endpoint zero).
 169
 170            Say "y" to link the driver statically, or "m" to build a
 171            dynamically linked module called "bcm63xx_udc".
 172
 173 config USB_FSL_USB2
 174         tristate "Freescale Highspeed USB DR Peripheral Controller"
 175         depends on FSL_SOC || ARCH_MXC
 176         select USB_FSL_MPH_DR_OF if OF
 177         help
 178            Some of Freescale PowerPC and i.MX processors have a High Speed
 179            Dual-Role(DR) USB controller, which supports device mode.
 180
 181            The number of programmable endpoints is different through
 182            SOC revisions.
 183
 184            Say "y" to link the driver statically, or "m" to build a
 185            dynamically linked module called "fsl_usb2_udc" and force
 186            all gadget drivers to also be dynamically linked.
 187
 188 config USB_FUSB300
 189         tristate "Faraday FUSB300 USB Peripheral Controller"
 190         depends on !PHYS_ADDR_T_64BIT
 191         help
 192            Faraday usb device controller FUSB300 driver
 193
 194 config USB_OMAP
 195         tristate "OMAP USB Device Controller"
 196         depends on ARCH_OMAP1
 197         select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3 || MACH_OMAP_H4_OTG
 198         select USB_OTG_UTILS if ARCH_OMAP
 199         help
 200            Many Texas Instruments OMAP processors have flexible full
 201            speed USB device controllers, with support for up to 30
 202            endpoints (plus endpoint zero).  This driver supports the
 203            controller in the OMAP 1611, and should work with controllers
 204            in other OMAP processors too, given minor tweaks.
 205
 206            Say "y" to link the driver statically, or "m" to build a
 207            dynamically linked module called "omap_udc" and force all
 208            gadget drivers to also be dynamically linked.
 209
 210 config USB_PXA25X
 211         tristate "PXA 25x or IXP 4xx"
 212         depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX
 213         select USB_OTG_UTILS
 214         help
 215            Intel's PXA 25x series XScale ARM-5TE processors include
 216            an integrated full speed USB 1.1 device controller.  The
 217            controller in the IXP 4xx series is register-compatible.
 218
 219            It has fifteen fixed-function endpoints, as well as endpoint
 220            zero (for control transfers).
 221
 222            Say "y" to link the driver statically, or "m" to build a
 223            dynamically linked module called "pxa25x_udc" and force all
 224            gadget drivers to also be dynamically linked.
 225
 226 # if there's only one gadget driver, using only two bulk endpoints,
 227 # don't waste memory for the other endpoints
 228 config USB_PXA25X_SMALL
 229         depends on USB_PXA25X
 230         bool
 231         default n if USB_ETH_RNDIS
 232         default y if USB_ZERO
 233         default y if USB_ETH
 234         default y if USB_G_SERIAL
 235
 236 config USB_R8A66597
 237         tristate "Renesas R8A66597 USB Peripheral Controller"
 238         help
 239            R8A66597 is a discrete USB host and peripheral controller chip that
 240            supports both full and high speed USB 2.0 data transfers.
 241            It has nine configurable endpoints, and endpoint zero.
 242
 243            Say "y" to link the driver statically, or "m" to build a
 244            dynamically linked module called "r8a66597_udc" and force all
 245            gadget drivers to also be dynamically linked.
 246
 247 config USB_RENESAS_USBHS_UDC
 248         tristate 'Renesas USBHS controller'
 249         depends on USB_RENESAS_USBHS
 250         help
 251            Renesas USBHS is a discrete USB host and peripheral controller chip
 252            that supports both full and high speed USB 2.0 data transfers.
 253            It has nine or more configurable endpoints, and endpoint zero.
 254
 255            Say "y" to link the driver statically, or "m" to build a
 256            dynamically linked module called "renesas_usbhs" and force all
 257            gadget drivers to also be dynamically linked.
 258
 259 config USB_PXA27X
 260         tristate "PXA 27x"
 261         depends on ARCH_PXA && (PXA27x || PXA3xx)
 262         select USB_OTG_UTILS
 263         help
 264            Intel's PXA 27x series XScale ARM v5TE processors include
 265            an integrated full speed USB 1.1 device controller.
 266
 267            It has up to 23 endpoints, as well as endpoint zero (for
 268            control transfers).
 269
 270            Say "y" to link the driver statically, or "m" to build a
 271            dynamically linked module called "pxa27x_udc" and force all
 272            gadget drivers to also be dynamically linked.
 273
 274 config USB_S3C_HSOTG
 275         tristate "S3C HS/OtG USB Device controller"
 276         depends on S3C_DEV_USB_HSOTG
 277         help
 278           The Samsung S3C64XX USB2.0 high-speed gadget controller
 279           integrated into the S3C64XX series SoC.
 280
 281 config USB_IMX
 282         tristate "Freescale i.MX1 USB Peripheral Controller"
 283         depends on ARCH_MXC
 284         help
 285            Freescale's i.MX1 includes an integrated full speed
 286            USB 1.1 device controller.
 287
 288            It has Six fixed-function endpoints, as well as endpoint
 289            zero (for control transfers).
 290
 291            Say "y" to link the driver statically, or "m" to build a
 292            dynamically linked module called "imx_udc" and force all
 293            gadget drivers to also be dynamically linked.
 294
 295 config USB_S3C2410
 296         tristate "S3C2410 USB Device Controller"
 297         depends on ARCH_S3C24XX
 298         help
 299           Samsung's S3C2410 is an ARM-4 processor with an integrated
 300           full speed USB 1.1 device controller.  It has 4 configurable
 301           endpoints, as well as endpoint zero (for control transfers).
 302
 303           This driver has been tested on the S3C2410, S3C2412, and
 304           S3C2440 processors.
 305
 306 config USB_S3C2410_DEBUG
 307         boolean "S3C2410 udc debug messages"
 308         depends on USB_S3C2410
 309
 310 config USB_S3C_HSUDC
 311         tristate "S3C2416, S3C2443 and S3C2450 USB Device Controller"
 312         depends on ARCH_S3C24XX
 313         help
 314           Samsung's S3C2416, S3C2443 and S3C2450 is an ARM9 based SoC
 315           integrated with dual speed USB 2.0 device controller. It has
 316           8 endpoints, as well as endpoint zero.
 317
 318           This driver has been tested on S3C2416 and S3C2450 processors.
 319
 320 config USB_MV_UDC
 321         tristate "Marvell USB2.0 Device Controller"
 322         help
 323           Marvell Socs (including PXA and MMP series) include a high speed
 324           USB2.0 OTG controller, which can be configured as high speed or
 325           full speed USB peripheral.
 326
 327 config USB_MV_U3D
 328         tristate "MARVELL PXA2128 USB 3.0 controller"
 329         depends on CPU_MMP3
 330         select USB_GADGET_DUALSPEED
 331         select USB_GADGET_SUPERSPEED
 332         help
 333           MARVELL PXA2128 Processor series include a super speed USB3.0 device
 334           controller, which support super speed USB peripheral.
 335
 336 #
 337 # Controllers available in both integrated and discrete versions
 338 #
 339
 340 # musb builds in ../musb along with host support
 341 config USB_GADGET_MUSB_HDRC
 342         tristate "Inventra HDRC USB Peripheral (TI, ADI, ...)"
 343         depends on USB_MUSB_HDRC
 344         help
 345           This OTG-capable silicon IP is used in dual designs including
 346           the TI DaVinci, OMAP 243x, OMAP 343x, TUSB 6010, and ADI Blackfin
 347
 348 config USB_M66592
 349         tristate "Renesas M66592 USB Peripheral Controller"
 350         help
 351            M66592 is a discrete USB peripheral controller chip that
 352            supports both full and high speed USB 2.0 data transfers.
 353            It has seven configurable endpoints, and endpoint zero.
 354
 355            Say "y" to link the driver statically, or "m" to build a
 356            dynamically linked module called "m66592_udc" and force all
 357            gadget drivers to also be dynamically linked.
 358
 359 #
 360 # Controllers available only in discrete form (and all PCI controllers)
 361 #
 362
 363 config USB_AMD5536UDC
 364         tristate "AMD5536 UDC"
 365         depends on PCI
 366         help
 367            The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
 368            It is a USB Highspeed DMA capable USB device controller. Beside ep0
 369            it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
 370            The UDC port supports OTG operation, and may be used as a host port
 371            if it's not being used to implement peripheral or OTG roles.
 372
 373            Say "y" to link the driver statically, or "m" to build a
 374            dynamically linked module called "amd5536udc" and force all
 375            gadget drivers to also be dynamically linked.
 376
 377 config USB_FSL_QE
 378         tristate "Freescale QE/CPM USB Device Controller"
 379         depends on FSL_SOC && (QUICC_ENGINE || CPM)
 380         help
 381            Some of Freescale PowerPC processors have a Full Speed
 382            QE/CPM2 USB controller, which support device mode with 4
 383            programmable endpoints. This driver supports the
 384            controller in the MPC8360 and MPC8272, and should work with
 385            controllers having QE or CPM2, given minor tweaks.
 386
 387            Set CONFIG_USB_GADGET to "m" to build this driver as a
 388            dynamically linked module called "fsl_qe_udc".
 389
 390 config USB_NET2272
 391         tristate "PLX NET2272"
 392         help
 393           PLX NET2272 is a USB peripheral controller which supports
 394           both full and high speed USB 2.0 data transfers.
 395
 396           It has three configurable endpoints, as well as endpoint zero
 397           (for control transfer).
 398           Say "y" to link the driver statically, or "m" to build a
 399           dynamically linked module called "net2272" and force all
 400           gadget drivers to also be dynamically linked.
 401
 402 config USB_NET2272_DMA
 403         boolean "Support external DMA controller"
 404         depends on USB_NET2272
 405         help
 406           The NET2272 part can optionally support an external DMA
 407           controller, but your board has to have support in the
 408           driver itself.
 409
 410           If unsure, say "N" here.  The driver works fine in PIO mode.
 411
 412 config USB_NET2280
 413         tristate "NetChip 228x"
 414         depends on PCI
 415         help
 416            NetChip 2280 / 2282 is a PCI based USB peripheral controller which
 417            supports both full and high speed USB 2.0 data transfers.
 418
 419            It has six configurable endpoints, as well as endpoint zero
 420            (for control transfers) and several endpoints with dedicated
 421            functions.
 422
 423            Say "y" to link the driver statically, or "m" to build a
 424            dynamically linked module called "net2280" and force all
 425            gadget drivers to also be dynamically linked.
 426
 427 config USB_GOKU
 428         tristate "Toshiba TC86C001 'Goku-S'"
 429         depends on PCI
 430         help
 431            The Toshiba TC86C001 is a PCI device which includes controllers
 432            for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).
 433
 434            The device controller has three configurable (bulk or interrupt)
 435            endpoints, plus endpoint zero (for control transfers).
 436
 437            Say "y" to link the driver statically, or "m" to build a
 438            dynamically linked module called "goku_udc" and to force all
 439            gadget drivers to also be dynamically linked.
 440
 441 config USB_EG20T
 442         tristate "Intel EG20T PCH/LAPIS Semiconductor IOH(ML7213/ML7831) UDC"
 443         depends on PCI
 444         help
 445           This is a USB device driver for EG20T PCH.
 446           EG20T PCH is the platform controller hub that is used in Intel's
 447           general embedded platform. EG20T PCH has USB device interface.
 448           Using this interface, it is able to access system devices connected
 449           to USB device.
 450           This driver enables USB device function.
 451           USB device is a USB peripheral controller which
 452           supports both full and high speed USB 2.0 data transfers.
 453           This driver supports both control transfer and bulk transfer modes.
 454           This driver dose not support interrupt transfer or isochronous
 455           transfer modes.
 456
 457           This driver also can be used for LAPIS Semiconductor's ML7213 which is
 458           for IVI(In-Vehicle Infotainment) use.
 459           ML7831 is for general purpose use.
 460           ML7213/ML7831 is companion chip for Intel Atom E6xx series.
 461           ML7213/ML7831 is completely compatible for Intel EG20T PCH.
 462
 463 #
 464 # LAST -- dummy/emulated controller
 465 #
 466
 467 config USB_DUMMY_HCD
 468         tristate "Dummy HCD (DEVELOPMENT)"
 469         depends on USB=y || (USB=m && USB_GADGET=m)
 470         help
 471           This host controller driver emulates USB, looping all data transfer
 472           requests back to a USB "gadget driver" in the same host.  The host
 473           side is the master; the gadget side is the slave.  Gadget drivers
 474           can be high, full, or low speed; and they have access to endpoints
 475           like those from NET2280, PXA2xx, or SA1100 hardware.
 476
 477           This may help in some stages of creating a driver to embed in a
 478           Linux device, since it lets you debug several parts of the gadget
 479           driver without its hardware or drivers being involved.
 480
 481           Since such a gadget side driver needs to interoperate with a host
 482           side Linux-USB device driver, this may help to debug both sides
 483           of a USB protocol stack.
 484
 485           Say "y" to link the driver statically, or "m" to build a
 486           dynamically linked module called "dummy_hcd" and force all
 487           gadget drivers to also be dynamically linked.
 488
 489 # NOTE:  Please keep dummy_hcd LAST so that "real hardware" appears
 490 # first and will be selected by default.
 491
 492 endmenu
 493
 494 #
 495 # USB Gadget Drivers
 496 #
 497
 498 # composite based drivers
 499 config USB_LIBCOMPOSITE
 500         tristate
 501         depends on USB_GADGET
 502
 503 choice
 504         tristate "USB Gadget Drivers"
 505         default USB_ETH
 506         help
 507           A Linux "Gadget Driver" talks to the USB Peripheral Controller
 508           driver through the abstract "gadget" API.  Some other operating
 509           systems call these "client" drivers, of which "class drivers"
 510           are a subset (implementing a USB device class specification).
 511           A gadget driver implements one or more USB functions using
 512           the peripheral hardware.
 513
 514           Gadget drivers are hardware-neutral, or "platform independent",
 515           except that they sometimes must understand quirks or limitations
 516           of the particular controllers they work with.  For example, when
 517           a controller doesn't support alternate configurations or provide
 518           enough of the right types of endpoints, the gadget driver might
 519           not be able work with that controller, or might need to implement
 520           a less common variant of a device class protocol.
 521
 522 # this first set of drivers all depend on bulk-capable hardware.
 523
 524 config USB_ZERO
 525         tristate "Gadget Zero (DEVELOPMENT)"
 526         select USB_LIBCOMPOSITE
 527         help
 528           Gadget Zero is a two-configuration device.  It either sinks and
 529           sources bulk data; or it loops back a configurable number of
 530           transfers.  It also implements control requests, for "chapter 9"
 531           conformance.  The driver needs only two bulk-capable endpoints, so
 532           it can work on top of most device-side usb controllers.  It's
 533           useful for testing, and is also a working example showing how
 534           USB "gadget drivers" can be written.
 535
 536           Make this be the first driver you try using on top of any new
 537           USB peripheral controller driver.  Then you can use host-side
 538           test software, like the "usbtest" driver, to put your hardware
 539           and its driver through a basic set of functional tests.
 540
 541           Gadget Zero also works with the host-side "usb-skeleton" driver,
 542           and with many kinds of host-side test software.  You may need
 543           to tweak product and vendor IDs before host software knows about
 544           this device, and arrange to select an appropriate configuration.
 545
 546           Say "y" to link the driver statically, or "m" to build a
 547           dynamically linked module called "g_zero".
 548
 549 config USB_ZERO_HNPTEST
 550         boolean "HNP Test Device"
 551         depends on USB_ZERO && USB_OTG
 552         help
 553           You can configure this device to enumerate using the device
 554           identifiers of the USB-OTG test device.  That means that when
 555           this gadget connects to another OTG device, with this one using
 556           the "B-Peripheral" role, that device will use HNP to let this
 557           one serve as the USB host instead (in the "B-Host" role).
 558
 559 config USB_AUDIO
 560         tristate "Audio Gadget"
 561         depends on SND
 562         select USB_LIBCOMPOSITE
 563         select SND_PCM
 564         help
 565           This Gadget Audio driver is compatible with USB Audio Class
 566           specification 2.0. It implements 1 AudioControl interface,
 567           1 AudioStreaming Interface each for USB-OUT and USB-IN.
 568           Number of channels, sample rate and sample size can be
 569           specified as module parameters.
 570           This driver doesn't expect any real Audio codec to be present
 571           on the device - the audio streams are simply sinked to and
 572           sourced from a virtual ALSA sound card created. The user-space
 573           application may choose to do whatever it wants with the data
 574           received from the USB Host and choose to provide whatever it
 575           wants as audio data to the USB Host.
 576
 577           Say "y" to link the driver statically, or "m" to build a
 578           dynamically linked module called "g_audio".
 579
 580 config GADGET_UAC1
 581         bool "UAC 1.0 (Legacy)"
 582         depends on USB_AUDIO
 583         help
 584           If you instead want older UAC Spec-1.0 driver that also has audio
 585           paths hardwired to the Audio codec chip on-board and doesn't work
 586           without one.
 587
 588 config USB_ETH
 589         tristate "Ethernet Gadget (with CDC Ethernet support)"
 590         depends on NET
 591         select USB_LIBCOMPOSITE
 592         select CRC32
 593         help
 594           This driver implements Ethernet style communication, in one of
 595           several ways:
 596
 597            - The "Communication Device Class" (CDC) Ethernet Control Model.
 598              That protocol is often avoided with pure Ethernet adapters, in
 599              favor of simpler vendor-specific hardware, but is widely
 600              supported by firmware for smart network devices.
 601
 602            - On hardware can't implement that protocol, a simple CDC subset
 603              is used, placing fewer demands on USB.
 604
 605            - CDC Ethernet Emulation Model (EEM) is a newer standard that has
 606              a simpler interface that can be used by more USB hardware.
 607
 608           RNDIS support is an additional option, more demanding than than
 609           subset.
 610
 611           Within the USB device, this gadget driver exposes a network device
 612           "usbX", where X depends on what other networking devices you have.
 613           Treat it like a two-node Ethernet link:  host, and gadget.
 614
 615           The Linux-USB host-side "usbnet" driver interoperates with this
 616           driver, so that deep I/O queues can be supported.  On 2.4 kernels,
 617           use "CDCEther" instead, if you're using the CDC option. That CDC
 618           mode should also interoperate with standard CDC Ethernet class
 619           drivers on other host operating systems.
 620
 621           Say "y" to link the driver statically, or "m" to build a
 622           dynamically linked module called "g_ether".
 623
 624 config USB_ETH_RNDIS
 625         bool "RNDIS support"
 626         depends on USB_ETH
 627         select USB_LIBCOMPOSITE
 628         default y
 629         help
 630            Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
 631            and Microsoft provides redistributable binary RNDIS drivers for
 632            older versions of Windows.
 633
 634            If you say "y" here, the Ethernet gadget driver will try to provide
 635            a second device configuration, supporting RNDIS to talk to such
 636            Microsoft USB hosts.
 637
 638            To make MS-Windows work with this, use Documentation/usb/linux.inf
 639            as the "driver info file".  For versions of MS-Windows older than
 640            XP, you'll need to download drivers from Microsoft's website; a URL
 641            is given in comments found in that info file.
 642
 643 config USB_ETH_EEM
 644        bool "Ethernet Emulation Model (EEM) support"
 645        depends on USB_ETH
 646         select USB_LIBCOMPOSITE
 647        default n
 648        help
 649          CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM
 650          and therefore can be supported by more hardware.  Technically ECM and
 651          EEM are designed for different applications.  The ECM model extends
 652          the network interface to the target (e.g. a USB cable modem), and the
 653          EEM model is for mobile devices to communicate with hosts using
 654          ethernet over USB.  For Linux gadgets, however, the interface with
 655          the host is the same (a usbX device), so the differences are minimal.
 656
 657          If you say "y" here, the Ethernet gadget driver will use the EEM
 658          protocol rather than ECM.  If unsure, say "n".
 659
 660 config USB_G_NCM
 661         tristate "Network Control Model (NCM) support"
 662         depends on NET
 663         select USB_LIBCOMPOSITE
 664         select CRC32
 665         help
 666           This driver implements USB CDC NCM subclass standard. NCM is
 667           an advanced protocol for Ethernet encapsulation, allows grouping
 668           of several ethernet frames into one USB transfer and different
 669           alignment possibilities.
 670
 671           Say "y" to link the driver statically, or "m" to build a
 672           dynamically linked module called "g_ncm".
 673
 674 config USB_GADGETFS
 675         tristate "Gadget Filesystem"
 676         help
 677           This driver provides a filesystem based API that lets user mode
 678           programs implement a single-configuration USB device, including
 679           endpoint I/O and control requests that don't relate to enumeration.
 680           All endpoints, transfer speeds, and transfer types supported by
 681           the hardware are available, through read() and write() calls.
 682
 683           Say "y" to link the driver statically, or "m" to build a
 684           dynamically linked module called "gadgetfs".
 685
 686 config USB_FUNCTIONFS
 687         tristate "Function Filesystem"
 688         select USB_LIBCOMPOSITE
 689         select USB_FUNCTIONFS_GENERIC if !(USB_FUNCTIONFS_ETH || USB_FUNCTIONFS_RNDIS)
 690         help
 691           The Function Filesystem (FunctionFS) lets one create USB
 692           composite functions in user space in the same way GadgetFS
 693           lets one create USB gadgets in user space.  This allows creation
 694           of composite gadgets such that some of the functions are
 695           implemented in kernel space (for instance Ethernet, serial or
 696           mass storage) and other are implemented in user space.
 697
 698           If you say "y" or "m" here you will be able what kind of
 699           configurations the gadget will provide.
 700
 701           Say "y" to link the driver statically, or "m" to build
 702           a dynamically linked module called "g_ffs".
 703
 704 config USB_FUNCTIONFS_ETH
 705         bool "Include configuration with CDC ECM (Ethernet)"
 706         depends on USB_FUNCTIONFS && NET
 707         help
 708           Include a configuration with CDC ECM function (Ethernet) and the
 709           Function Filesystem.
 710
 711 config USB_FUNCTIONFS_RNDIS
 712         bool "Include configuration with RNDIS (Ethernet)"
 713         depends on USB_FUNCTIONFS && NET
 714         help
 715           Include a configuration with RNDIS function (Ethernet) and the Filesystem.
 716
 717 config USB_FUNCTIONFS_GENERIC
 718         bool "Include 'pure' configuration"
 719         depends on USB_FUNCTIONFS
 720         help
 721           Include a configuration with the Function Filesystem alone with
 722           no Ethernet interface.
 723
 724 config USB_MASS_STORAGE
 725         tristate "Mass Storage Gadget"
 726         depends on BLOCK
 727         select USB_LIBCOMPOSITE
 728         help
 729           The Mass Storage Gadget acts as a USB Mass Storage disk drive.
 730           As its storage repository it can use a regular file or a block
 731           device (in much the same way as the "loop" device driver),
 732           specified as a module parameter or sysfs option.
 733
 734           This driver is a replacement for now removed File-backed
 735           Storage Gadget (g_file_storage).
 736
 737           Say "y" to link the driver statically, or "m" to build
 738           a dynamically linked module called "g_mass_storage".
 739
 740 config USB_GADGET_TARGET
 741         tristate "USB Gadget Target Fabric Module"
 742         depends on TARGET_CORE
 743         select USB_LIBCOMPOSITE
 744         help
 745           This fabric is an USB gadget. Two USB protocols are supported that is
 746           BBB or BOT (Bulk Only Transport) and UAS (USB Attached SCSI). BOT is
 747           advertised on alternative interface 0 (primary) and UAS is on
 748           alternative interface 1. Both protocols can work on USB2.0 and USB3.0.
 749           UAS utilizes the USB 3.0 feature called streams support.
 750
 751 config USB_G_SERIAL
 752         tristate "Serial Gadget (with CDC ACM and CDC OBEX support)"
 753         select USB_LIBCOMPOSITE
 754         help
 755           The Serial Gadget talks to the Linux-USB generic serial driver.
 756           This driver supports a CDC-ACM module option, which can be used
 757           to interoperate with MS-Windows hosts or with the Linux-USB
 758           "cdc-acm" driver.
 759
 760           This driver also supports a CDC-OBEX option.  You will need a
 761           user space OBEX server talking to /dev/ttyGS*, since the kernel
 762           itself doesn't implement the OBEX protocol.
 763
 764           Say "y" to link the driver statically, or "m" to build a
 765           dynamically linked module called "g_serial".
 766
 767           For more information, see Documentation/usb/gadget_serial.txt
 768           which includes instructions and a "driver info file" needed to
 769           make MS-Windows work with CDC ACM.
 770
 771 config USB_MIDI_GADGET
 772         tristate "MIDI Gadget"
 773         depends on SND
 774         select USB_LIBCOMPOSITE
 775         select SND_RAWMIDI
 776         help
 777           The MIDI Gadget acts as a USB Audio device, with one MIDI
 778           input and one MIDI output. These MIDI jacks appear as
 779           a sound "card" in the ALSA sound system. Other MIDI
 780           connections can then be made on the gadget system, using
 781           ALSA's aconnect utility etc.
 782
 783           Say "y" to link the driver statically, or "m" to build a
 784           dynamically linked module called "g_midi".
 785
 786 config USB_G_PRINTER
 787         tristate "Printer Gadget"
 788         select USB_LIBCOMPOSITE
 789         help
 790           The Printer Gadget channels data between the USB host and a
 791           userspace program driving the print engine. The user space
 792           program reads and writes the device file /dev/g_printer to
 793           receive or send printer data. It can use ioctl calls to
 794           the device file to get or set printer status.
 795
 796           Say "y" to link the driver statically, or "m" to build a
 797           dynamically linked module called "g_printer".
 798
 799           For more information, see Documentation/usb/gadget_printer.txt
 800           which includes sample code for accessing the device file.
 801
 802 config USB_CDC_COMPOSITE
 803         tristate "CDC Composite Device (Ethernet and ACM)"
 804         depends on NET
 805         select USB_LIBCOMPOSITE
 806         help
 807           This driver provides two functions in one configuration:
 808           a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link.
 809
 810           This driver requires four bulk and two interrupt endpoints,
 811           plus the ability to handle altsettings.  Not all peripheral
 812           controllers are that capable.
 813
 814           Say "y" to link the driver statically, or "m" to build a
 815           dynamically linked module.
 816
 817 config USB_G_NOKIA
 818         tristate "Nokia composite gadget"
 819         depends on PHONET
 820         select USB_LIBCOMPOSITE
 821         help
 822           The Nokia composite gadget provides support for acm, obex
 823           and phonet in only one composite gadget driver.
 824
 825           It's only really useful for N900 hardware. If you're building
 826           a kernel for N900, say Y or M here. If unsure, say N.
 827
 828 config USB_G_ACM_MS
 829         tristate "CDC Composite Device (ACM and mass storage)"
 830         depends on BLOCK
 831         select USB_LIBCOMPOSITE
 832         help
 833           This driver provides two functions in one configuration:
 834           a mass storage, and a CDC ACM (serial port) link.
 835
 836           Say "y" to link the driver statically, or "m" to build a
 837           dynamically linked module called "g_acm_ms".
 838
 839 config USB_G_MULTI
 840         tristate "Multifunction Composite Gadget"
 841         depends on BLOCK && NET
 842         select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS
 843         select USB_LIBCOMPOSITE
 844         help
 845           The Multifunction Composite Gadget provides Ethernet (RNDIS
 846           and/or CDC Ethernet), mass storage and ACM serial link
 847           interfaces.
 848
 849           You will be asked to choose which of the two configurations is
 850           to be available in the gadget.  At least one configuration must
 851           be chosen to make the gadget usable.  Selecting more than one
 852           configuration will prevent Windows from automatically detecting
 853           the gadget as a composite gadget, so an INF file will be needed to
 854           use the gadget.
 855
 856           Say "y" to link the driver statically, or "m" to build a
 857           dynamically linked module called "g_multi".
 858
 859 config USB_G_MULTI_RNDIS
 860         bool "RNDIS + CDC Serial + Storage configuration"
 861         depends on USB_G_MULTI
 862         default y
 863         help
 864           This option enables a configuration with RNDIS, CDC Serial and
 865           Mass Storage functions available in the Multifunction Composite
 866           Gadget.  This is the configuration dedicated for Windows since RNDIS
 867           is Microsoft's protocol.
 868
 869           If unsure, say "y".
 870
 871 config USB_G_MULTI_CDC
 872         bool "CDC Ethernet + CDC Serial + Storage configuration"
 873         depends on USB_G_MULTI
 874         default n
 875         help
 876           This option enables a configuration with CDC Ethernet (ECM), CDC
 877           Serial and Mass Storage functions available in the Multifunction
 878           Composite Gadget.
 879
 880           If unsure, say "y".
 881
 882 config USB_G_HID
 883         tristate "HID Gadget"
 884         select USB_LIBCOMPOSITE
 885         help
 886           The HID gadget driver provides generic emulation of USB
 887           Human Interface Devices (HID).
 888
 889           For more information, see Documentation/usb/gadget_hid.txt which
 890           includes sample code for accessing the device files.
 891
 892           Say "y" to link the driver statically, or "m" to build a
 893           dynamically linked module called "g_hid".
 894
 895 # Standalone / single function gadgets
 896 config USB_G_DBGP
 897         tristate "EHCI Debug Device Gadget"
 898         select USB_LIBCOMPOSITE
 899         help
 900           This gadget emulates an EHCI Debug device. This is useful when you want
 901           to interact with an EHCI Debug Port.
 902
 903           Say "y" to link the driver statically, or "m" to build a
 904           dynamically linked module called "g_dbgp".
 905
 906 if USB_G_DBGP
 907 choice
 908         prompt "EHCI Debug Device mode"
 909         default USB_G_DBGP_SERIAL
 910
 911 config USB_G_DBGP_PRINTK
 912         depends on USB_G_DBGP
 913         bool "printk"
 914         help
 915           Directly printk() received data. No interaction.
 916
 917 config USB_G_DBGP_SERIAL
 918         depends on USB_G_DBGP
 919         bool "serial"
 920         help
 921           Userland can interact using /dev/ttyGSxxx.
 922 endchoice
 923 endif
 924
 925 # put drivers that need isochronous transfer support (for audio
 926 # or video class gadget drivers), or specific hardware, here.
 927 config USB_G_WEBCAM
 928         tristate "USB Webcam Gadget"
 929         depends on VIDEO_DEV
 930         help
 931           The Webcam Gadget acts as a composite USB Audio and Video Class
 932           device. It provides a userspace API to process UVC control requests
 933           and stream video data to the host.
 934
 935           Say "y" to link the driver statically, or "m" to build a
 936           dynamically linked module called "g_webcam".
 937
 938 endchoice
 939
 940 endif # USB_GADGET