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