Kconfig 33.5 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9
#
# USB Gadget support on a system involves
#    (a) a peripheral controller, and
#    (b) the gadget driver using it.
#
# NOTE:  Gadget support ** DOES NOT ** depend on host-side CONFIG_USB !!
#
#  - Host systems (like PCs) need CONFIG_USB (with "A" jacks).
#  - Peripherals (like PDAs) need CONFIG_USB_GADGET (with "B" jacks).
M
Matt LaPlante 已提交
10
#  - Some systems have both kinds of controllers.
L
Linus Torvalds 已提交
11 12 13 14 15
#
# With help from a special transceiver and a "Mini-AB" jack, systems with
# both kinds of controller can also support "USB On-the-Go" (CONFIG_USB_OTG).
#

D
Denis Cheng 已提交
16 17
menuconfig USB_GADGET
	tristate "USB Gadget Support"
L
Linus Torvalds 已提交
18 19 20 21 22 23 24 25 26 27
	help
	   USB is a master/slave protocol, organized with one master
	   host (such as a PC) controlling up to 127 peripheral devices.
	   The USB hardware is asymmetric, which makes it easier to set up:
	   you can't connect a "to-the-host" connector to a peripheral.

	   Linux can run in the host, or in the peripheral.  In both cases
	   you need a low level bus controller driver, and some software
	   talking to it.  Peripheral controllers are often discrete silicon,
	   or are integrated with the CPU in a microcontroller.  The more
28
	   familiar host side controllers have names like "EHCI", "OHCI",
L
Linus Torvalds 已提交
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
	   or "UHCI", and are usually integrated into southbridges on PC
	   motherboards.

	   Enable this configuration option if you want to run Linux inside
	   a USB peripheral device.  Configure one hardware driver for your
	   peripheral/device side bus controller, and a "gadget driver" for
	   your peripheral protocol.  (If you use modular gadget drivers,
	   you may configure more than one.)

	   If in doubt, say "N" and don't enable these drivers; most people
	   don't have this kind of hardware (except maybe inside Linux PDAs).

	   For more information, see <http://www.linux-usb.org/gadget> and
	   the kernel DocBook documentation for this API.

D
Denis Cheng 已提交
44 45
if USB_GADGET

46
config USB_GADGET_DEBUG
47
	boolean "Debugging messages (DEVELOPMENT)"
48
	depends on DEBUG_KERNEL
49 50 51 52 53 54 55 56 57 58 59
	help
	   Many controller and gadget drivers will print some debugging
	   messages if you use this option to ask for those messages.

	   Avoid enabling these messages, even if you're actively
	   debugging such a driver.  Many drivers will emit so many
	   messages that the driver timings are affected, which will
	   either create new failure modes or remove the one you're
	   trying to track down.  Never enable these messages for a
	   production build.

L
Linus Torvalds 已提交
60
config USB_GADGET_DEBUG_FILES
61
	boolean "Debugging information files (DEVELOPMENT)"
62
	depends on PROC_FS
L
Linus Torvalds 已提交
63 64 65 66 67 68 69 70
	help
	   Some of the drivers in the "gadget" framework can expose
	   debugging information in files such as /proc/driver/udc
	   (for a peripheral controller).  The information in these
	   files may help when you're troubleshooting or bringing up a
	   driver on a new board.   Enable these files by choosing "Y"
	   here.  If in doubt, or to conserve kernel memory, say "N".

71
config USB_GADGET_DEBUG_FS
72
	boolean "Debugging information files in debugfs (DEVELOPMENT)"
73
	depends on DEBUG_FS
74 75 76 77 78 79 80 81
	help
	   Some of the drivers in the "gadget" framework can expose
	   debugging information in files under /sys/kernel/debug/.
	   The information in these files may help when you're
	   troubleshooting or bringing up a driver on a new board.
	   Enable these files by choosing "Y" here.  If in doubt, or
	   to conserve kernel memory, say "N".

82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98
config USB_GADGET_VBUS_DRAW
	int "Maximum VBUS Power usage (2-500 mA)"
	range 2 500
	default 2
	help
	   Some devices need to draw power from USB when they are
	   configured, perhaps to operate circuitry or to recharge
	   batteries.  This is in addition to any local power supply,
	   such as an AC adapter or batteries.

	   Enter the maximum power your device draws through USB, in
	   milliAmperes.  The permitted range of values is 2 - 500 mA;
	   0 mA would be legal, but can make some hosts misbehave.

	   This value will be used except for system-specific gadget
	   drivers that have more specific information.

L
Linus Torvalds 已提交
99 100 101
#
# USB Peripheral Controller Support
#
D
David Brownell 已提交
102 103 104 105 106 107 108
# The order here is alphabetical, except that integrated controllers go
# before discrete ones so they will be the initial/default value:
#   - integrated/SOC controllers first
#   - licensed IP used in both SOC and discrete versions
#   - discrete ones (including all PCI-only controllers)
#   - debug/dummy gadget+hcd is last.
#
L
Linus Torvalds 已提交
109 110 111 112 113 114 115 116 117
choice
	prompt "USB Peripheral Controller"
	depends on USB_GADGET
	help
	   A USB device uses a controller to talk to its host.
	   Systems should have only one such upstream link.
	   Many controller drivers are platform-specific; these
	   often need board-specific hooks.

D
David Brownell 已提交
118 119 120 121
#
# Integrated controllers
#

122 123
config USB_AT91
	tristate "Atmel AT91 USB Device Port"
124
	depends on ARCH_AT91 && !ARCH_AT91SAM9RL && !ARCH_AT91CAP9 && !ARCH_AT91SAM9G45
125
	help
D
David Brownell 已提交
126 127 128
	   Many Atmel AT91 processors (such as the AT91RM2000) have a
	   full speed USB Device Port with support for five configurable
	   endpoints (plus endpoint zero).
129 130

	   Say "y" to link the driver statically, or "m" to build a
D
David Brownell 已提交
131
	   dynamically linked module called "at91_udc" and force all
132 133
	   gadget drivers to also be dynamically linked.

134 135
config USB_ATMEL_USBA
	tristate "Atmel USBA"
136
	select USB_GADGET_DUALSPEED
137
	depends on AVR32 || ARCH_AT91CAP9 || ARCH_AT91SAM9RL || ARCH_AT91SAM9G45
138 139
	help
	  USBA is the integrated high-speed USB Device controller on
140
	  the AT32AP700x, some AT91SAM9 and AT91CAP9 processors from Atmel.
141

142 143
config USB_FSL_USB2
	tristate "Freescale Highspeed USB DR Peripheral Controller"
144
	depends on FSL_SOC || ARCH_MXC
145
	select USB_GADGET_DUALSPEED
146
	select USB_FSL_MPH_DR_OF if OF
147 148 149 150 151 152 153 154 155 156 157
	help
	   Some of Freescale PowerPC processors have a High Speed
	   Dual-Role(DR) USB controller, which supports device mode.

	   The number of programmable endpoints is different through
	   SOC revisions.

	   Say "y" to link the driver statically, or "m" to build a
	   dynamically linked module called "fsl_usb2_udc" and force
	   all gadget drivers to also be dynamically linked.

158 159
config USB_FUSB300
	tristate "Faraday FUSB300 USB Peripheral Controller"
160
	depends on !PHYS_ADDR_T_64BIT
161 162 163 164
	select USB_GADGET_DUALSPEED
	help
	   Faraday usb device controller FUSB300 driver

165 166
config USB_OMAP
	tristate "OMAP USB Device Controller"
D
David Brownell 已提交
167
	depends on ARCH_OMAP
T
Tony Lindgren 已提交
168
	select ISP1301_OMAP if MACH_OMAP_H2 || MACH_OMAP_H3 || MACH_OMAP_H4_OTG
169
	select USB_OTG_UTILS if ARCH_OMAP
D
David Brownell 已提交
170 171 172 173 174 175
	help
	   Many Texas Instruments OMAP processors have flexible full
	   speed USB device controllers, with support for up to 30
	   endpoints (plus endpoint zero).  This driver supports the
	   controller in the OMAP 1611, and should work with controllers
	   in other OMAP processors too, given minor tweaks.
L
Linus Torvalds 已提交
176 177

	   Say "y" to link the driver statically, or "m" to build a
D
David Brownell 已提交
178
	   dynamically linked module called "omap_udc" and force all
L
Linus Torvalds 已提交
179 180
	   gadget drivers to also be dynamically linked.

181 182
config USB_PXA25X
	tristate "PXA 25x or IXP 4xx"
L
Linus Torvalds 已提交
183
	depends on (ARCH_PXA && PXA25x) || ARCH_IXP4XX
R
Russell King 已提交
184
	select USB_OTG_UTILS
L
Linus Torvalds 已提交
185 186 187 188 189 190 191 192 193
	help
	   Intel's PXA 25x series XScale ARM-5TE processors include
	   an integrated full speed USB 1.1 device controller.  The
	   controller in the IXP 4xx series is register-compatible.

	   It has fifteen fixed-function endpoints, as well as endpoint
	   zero (for control transfers).

	   Say "y" to link the driver statically, or "m" to build a
194
	   dynamically linked module called "pxa25x_udc" and force all
L
Linus Torvalds 已提交
195 196 197 198
	   gadget drivers to also be dynamically linked.

# if there's only one gadget driver, using only two bulk endpoints,
# don't waste memory for the other endpoints
199
config USB_PXA25X_SMALL
200
	depends on USB_PXA25X
L
Linus Torvalds 已提交
201 202 203 204 205 206
	bool
	default n if USB_ETH_RNDIS
	default y if USB_ZERO
	default y if USB_ETH
	default y if USB_G_SERIAL

207 208
config USB_R8A66597
	tristate "Renesas R8A66597 USB Peripheral Controller"
209 210 211 212 213 214 215 216 217 218
	select USB_GADGET_DUALSPEED
	help
	   R8A66597 is a discrete USB host and peripheral controller chip that
	   supports both full and high speed USB 2.0 data transfers.
	   It has nine configurable endpoints, and endpoint zero.

	   Say "y" to link the driver statically, or "m" to build a
	   dynamically linked module called "r8a66597_udc" and force all
	   gadget drivers to also be dynamically linked.

219
config USB_RENESAS_USBHS_UDC
220 221
	tristate 'Renesas USBHS controller'
	depends on SUPERH || ARCH_SHMOBILE
222 223
	depends on USB_RENESAS_USBHS
	select USB_GADGET_DUALSPEED
224
	help
225 226 227
	   Renesas USBHS is a discrete USB host and peripheral controller chip
	   that supports both full and high speed USB 2.0 data transfers.
	   It has nine or more configurable endpoints, and endpoint zero.
228

229 230 231
	   Say "y" to link the driver statically, or "m" to build a
	   dynamically linked module called "renesas_usbhs" and force all
	   gadget drivers to also be dynamically linked.
232

233 234
config USB_PXA27X
	tristate "PXA 27x"
235
	depends on ARCH_PXA && (PXA27x || PXA3xx)
236
	select USB_OTG_UTILS
R
Robert Jarzmik 已提交
237 238 239 240 241 242 243 244 245 246 247
	help
	   Intel's PXA 27x series XScale ARM v5TE processors include
	   an integrated full speed USB 1.1 device controller.

	   It has up to 23 endpoints, as well as endpoint zero (for
	   control transfers).

	   Say "y" to link the driver statically, or "m" to build a
	   dynamically linked module called "pxa27x_udc" and force all
	   gadget drivers to also be dynamically linked.

248 249
config USB_S3C_HSOTG
	tristate "S3C HS/OtG USB Device controller"
250 251
	depends on S3C_DEV_USB_HSOTG
	select USB_GADGET_S3C_HSOTG_PIO
252
	select USB_GADGET_DUALSPEED
253 254 255 256
	help
	  The Samsung S3C64XX USB2.0 high-speed gadget controller
	  integrated into the S3C64XX series SoC.

257 258
config USB_IMX
	tristate "Freescale IMX USB Peripheral Controller"
259 260 261 262 263 264 265 266 267 268 269 270 271
	depends on ARCH_MX1
	help
	   Freescale's IMX series include an integrated full speed
	   USB 1.1 device controller.  The controller in the IMX series
	   is register-compatible.

	   It has Six fixed-function endpoints, as well as endpoint
	   zero (for control transfers).

	   Say "y" to link the driver statically, or "m" to build a
	   dynamically linked module called "imx_udc" and force all
	   gadget drivers to also be dynamically linked.

272 273
config USB_S3C2410
	tristate "S3C2410 USB Device Controller"
D
David Brownell 已提交
274
	depends on ARCH_S3C2410
L
Linus Torvalds 已提交
275
	help
D
David Brownell 已提交
276 277 278
	  Samsung's S3C2410 is an ARM-4 processor with an integrated
	  full speed USB 1.1 device controller.  It has 4 configurable
	  endpoints, as well as endpoint zero (for control transfers).
L
Linus Torvalds 已提交
279

D
David Brownell 已提交
280 281
	  This driver has been tested on the S3C2410, S3C2412, and
	  S3C2440 processors.
L
Linus Torvalds 已提交
282

D
David Brownell 已提交
283 284
config USB_S3C2410_DEBUG
	boolean "S3C2410 udc debug messages"
285
	depends on USB_S3C2410
L
Linus Torvalds 已提交
286

287 288
config USB_S3C_HSUDC
	tristate "S3C2416, S3C2443 and S3C2450 USB Device Controller"
289 290 291 292 293 294 295 296 297
	depends on ARCH_S3C2410
	select USB_GADGET_DUALSPEED
	help
	  Samsung's S3C2416, S3C2443 and S3C2450 is an ARM9 based SoC
	  integrated with dual speed USB 2.0 device controller. It has
	  8 endpoints, as well as endpoint zero.

	  This driver has been tested on S3C2416 and S3C2450 processors.

298 299 300
config USB_PXA_U2O
	tristate "PXA9xx Processor USB2.0 controller"
	depends on ARCH_MMP
301 302 303 304 305
	select USB_GADGET_DUALSPEED
	help
	  PXA9xx Processor series include a high speed USB2.0 device
	  controller, which support high speed and full speed USB peripheral.

D
David Brownell 已提交
306 307 308
#
# Controllers available in both integrated and discrete versions
#
L
Linus Torvalds 已提交
309

D
David Brownell 已提交
310
# musb builds in ../musb along with host support
F
Felipe Balbi 已提交
311
config USB_GADGET_MUSB_HDRC
312
	tristate "Inventra HDRC USB Peripheral (TI, ADI, ...)"
R
Rabin Vincent 已提交
313
	depends on USB_MUSB_HDRC
F
Felipe Balbi 已提交
314 315 316
	select USB_GADGET_DUALSPEED
	help
	  This OTG-capable silicon IP is used in dual designs including
317
	  the TI DaVinci, OMAP 243x, OMAP 343x, TUSB 6010, and ADI Blackfin
F
Felipe Balbi 已提交
318

319 320
config USB_M66592
	tristate "Renesas M66592 USB Peripheral Controller"
D
David Brownell 已提交
321
	select USB_GADGET_DUALSPEED
L
Linus Torvalds 已提交
322
	help
D
David Brownell 已提交
323 324 325
	   M66592 is a discrete USB peripheral controller chip that
	   supports both full and high speed USB 2.0 data transfers.
	   It has seven configurable endpoints, and endpoint zero.
L
Linus Torvalds 已提交
326 327

	   Say "y" to link the driver statically, or "m" to build a
D
David Brownell 已提交
328
	   dynamically linked module called "m66592_udc" and force all
L
Linus Torvalds 已提交
329 330
	   gadget drivers to also be dynamically linked.

D
David Brownell 已提交
331 332 333 334
#
# Controllers available only in discrete form (and all PCI controllers)
#

335 336
config USB_AMD5536UDC
	tristate "AMD5536 UDC"
D
David Brownell 已提交
337 338
	depends on PCI
	select USB_GADGET_DUALSPEED
339
	help
D
David Brownell 已提交
340 341 342 343 344
	   The AMD5536 UDC is part of the AMD Geode CS5536, an x86 southbridge.
	   It is a USB Highspeed DMA capable USB device controller. Beside ep0
	   it provides 4 IN and 4 OUT endpoints (bulk or interrupt type).
	   The UDC port supports OTG operation, and may be used as a host port
	   if it's not being used to implement peripheral or OTG roles.
345

D
David Brownell 已提交
346 347 348
	   Say "y" to link the driver statically, or "m" to build a
	   dynamically linked module called "amd5536udc" and force all
	   gadget drivers to also be dynamically linked.
349

350 351
config USB_FSL_QE
	tristate "Freescale QE/CPM USB Device Controller"
352 353 354 355 356 357 358 359 360
	depends on FSL_SOC && (QUICC_ENGINE || CPM)
	help
	   Some of Freescale PowerPC processors have a Full Speed
	   QE/CPM2 USB controller, which support device mode with 4
	   programmable endpoints. This driver supports the
	   controller in the MPC8360 and MPC8272, and should work with
	   controllers having QE or CPM2, given minor tweaks.

	   Set CONFIG_USB_GADGET to "m" to build this driver as a
361
	   dynamically linked module called "fsl_qe_udc".
362

363 364
config USB_CI13XXX_PCI
	tristate "MIPS USB CI13xxx PCI UDC"
D
David Lopo 已提交
365 366 367 368 369 370 371 372 373 374
	depends on PCI
	select USB_GADGET_DUALSPEED
	help
	  MIPS USB IP core family device controller
	  Currently it only supports IP part number CI13412

	  Say "y" to link the driver statically, or "m" to build a
	  dynamically linked module called "ci13xxx_udc" and force all
	  gadget drivers to also be dynamically linked.

375 376
config USB_NET2272
	tristate "PLX NET2272"
377 378 379 380 381 382 383 384 385 386 387
	select USB_GADGET_DUALSPEED
	help
	  PLX NET2272 is a USB peripheral controller which supports
	  both full and high speed USB 2.0 data transfers.

	  It has three configurable endpoints, as well as endpoint zero
	  (for control transfer).
	  Say "y" to link the driver statically, or "m" to build a
	  dynamically linked module called "net2272" and force all
	  gadget drivers to also be dynamically linked.

388
config USB_NET2272_DMA
389
	boolean "Support external DMA controller"
390
	depends on USB_NET2272
391 392 393 394 395 396 397
	help
	  The NET2272 part can optionally support an external DMA
	  controller, but your board has to have support in the
	  driver itself.

	  If unsure, say "N" here.  The driver works fine in PIO mode.

398 399
config USB_NET2280
	tristate "NetChip 228x"
D
David Brownell 已提交
400 401 402 403 404
	depends on PCI
	select USB_GADGET_DUALSPEED
	help
	   NetChip 2280 / 2282 is a PCI based USB peripheral controller which
	   supports both full and high speed USB 2.0 data transfers.
405

D
David Brownell 已提交
406 407 408 409 410 411 412 413
	   It has six configurable endpoints, as well as endpoint zero
	   (for control transfers) and several endpoints with dedicated
	   functions.

	   Say "y" to link the driver statically, or "m" to build a
	   dynamically linked module called "net2280" and force all
	   gadget drivers to also be dynamically linked.

414 415
config USB_GOKU
	tristate "Toshiba TC86C001 'Goku-S'"
D
David Brownell 已提交
416
	depends on PCI
417
	help
D
David Brownell 已提交
418 419 420 421 422
	   The Toshiba TC86C001 is a PCI device which includes controllers
	   for full speed USB devices, IDE, I2C, SIO, plus a USB host (OHCI).

	   The device controller has three configurable (bulk or interrupt)
	   endpoints, plus endpoint zero (for control transfers).
423 424

	   Say "y" to link the driver statically, or "m" to build a
D
David Brownell 已提交
425
	   dynamically linked module called "goku_udc" and to force all
426 427
	   gadget drivers to also be dynamically linked.

428 429
config USB_LANGWELL
	tristate "Intel Langwell USB Device Controller"
430
	depends on PCI
431
	depends on !PHYS_ADDR_T_64BIT
432 433 434 435 436 437 438 439 440 441 442 443
	select USB_GADGET_DUALSPEED
	help
	   Intel Langwell USB Device Controller is a High-Speed USB
	   On-The-Go device controller.

	   The number of programmable endpoints is different through
	   controller revision.

	   Say "y" to link the driver statically, or "m" to build a
	   dynamically linked module called "langwell_udc" and force all
	   gadget drivers to also be dynamically linked.

444 445
config USB_EG20T
	tristate "Intel EG20T PCH/OKI SEMICONDUCTOR ML7213 IOH UDC"
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
	depends on PCI
	select USB_GADGET_DUALSPEED
	help
	  This is a USB device driver for EG20T PCH.
	  EG20T PCH is the platform controller hub that is used in Intel's
	  general embedded platform. EG20T PCH has USB device interface.
	  Using this interface, it is able to access system devices connected
	  to USB device.
	  This driver enables USB device function.
	  USB device is a USB peripheral controller which
	  supports both full and high speed USB 2.0 data transfers.
	  This driver supports both control transfer and bulk transfer modes.
	  This driver dose not support interrupt transfer or isochronous
	  transfer modes.

461 462 463 464 465
	  This driver also can be used for OKI SEMICONDUCTOR's ML7213 which is
	  for IVI(In-Vehicle Infotainment) use.
	  ML7213 is companion chip for Intel Atom E6xx series.
	  ML7213 is completely compatible for Intel EG20T PCH.

466 467
config USB_CI13XXX_MSM
	tristate "MIPS USB CI13xxx for MSM"
468 469
	depends on ARCH_MSM
	select USB_GADGET_DUALSPEED
470
	select USB_MSM_OTG
471 472 473 474 475
	help
	  MSM SoC has chipidea USB controller.  This driver uses
	  ci13xxx_udc core.
	  This driver depends on OTG driver for PHY initialization,
	  clock management, powering up VBUS, and power management.
476 477
	  This driver is not supported on boards like trout which
	  has an external PHY.
478 479 480 481 482

	  Say "y" to link the driver statically, or "m" to build a
	  dynamically linked module called "ci13xxx_msm" and force all
	  gadget drivers to also be dynamically linked.

D
David Brownell 已提交
483 484 485
#
# LAST -- dummy/emulated controller
#
L
Linus Torvalds 已提交
486

487 488
config USB_DUMMY_HCD
	tristate "Dummy HCD (DEVELOPMENT)"
489
	depends on USB=y || (USB=m && USB_GADGET=m)
L
Linus Torvalds 已提交
490
	select USB_GADGET_DUALSPEED
491
	select USB_GADGET_SUPERSPEED
L
Linus Torvalds 已提交
492 493 494 495 496 497
	help
	  This host controller driver emulates USB, looping all data transfer
	  requests back to a USB "gadget driver" in the same host.  The host
	  side is the master; the gadget side is the slave.  Gadget drivers
	  can be high, full, or low speed; and they have access to endpoints
	  like those from NET2280, PXA2xx, or SA1100 hardware.
498

L
Linus Torvalds 已提交
499 500 501
	  This may help in some stages of creating a driver to embed in a
	  Linux device, since it lets you debug several parts of the gadget
	  driver without its hardware or drivers being involved.
502

L
Linus Torvalds 已提交
503 504 505 506 507 508 509 510 511 512 513 514 515
	  Since such a gadget side driver needs to interoperate with a host
	  side Linux-USB device driver, this may help to debug both sides
	  of a USB protocol stack.

	  Say "y" to link the driver statically, or "m" to build a
	  dynamically linked module called "dummy_hcd" and force all
	  gadget drivers to also be dynamically linked.

# NOTE:  Please keep dummy_hcd LAST so that "real hardware" appears
# first and will be selected by default.

endchoice

516
# Selected by UDC drivers that support high-speed operation.
L
Linus Torvalds 已提交
517 518 519 520
config USB_GADGET_DUALSPEED
	bool
	depends on USB_GADGET

521 522 523 524 525 526
# Selected by UDC drivers that support super-speed opperation
config USB_GADGET_SUPERSPEED
	bool
	depends on USB_GADGET
	depends on USB_GADGET_DUALSPEED

L
Linus Torvalds 已提交
527 528 529 530 531
#
# USB Gadget Drivers
#
choice
	tristate "USB Gadget Drivers"
532
	depends on USB_GADGET
L
Linus Torvalds 已提交
533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
	default USB_ETH
	help
	  A Linux "Gadget Driver" talks to the USB Peripheral Controller
	  driver through the abstract "gadget" API.  Some other operating
	  systems call these "client" drivers, of which "class drivers"
	  are a subset (implementing a USB device class specification).
	  A gadget driver implements one or more USB functions using
	  the peripheral hardware.

	  Gadget drivers are hardware-neutral, or "platform independent",
	  except that they sometimes must understand quirks or limitations
	  of the particular controllers they work with.  For example, when
	  a controller doesn't support alternate configurations or provide
	  enough of the right types of endpoints, the gadget driver might
	  not be able work with that controller, or might need to implement
	  a less common variant of a device class protocol.

# this first set of drivers all depend on bulk-capable hardware.

config USB_ZERO
	tristate "Gadget Zero (DEVELOPMENT)"
	help
	  Gadget Zero is a two-configuration device.  It either sinks and
	  sources bulk data; or it loops back a configurable number of
	  transfers.  It also implements control requests, for "chapter 9"
	  conformance.  The driver needs only two bulk-capable endpoints, so
	  it can work on top of most device-side usb controllers.  It's
	  useful for testing, and is also a working example showing how
	  USB "gadget drivers" can be written.

	  Make this be the first driver you try using on top of any new
	  USB peripheral controller driver.  Then you can use host-side
	  test software, like the "usbtest" driver, to put your hardware
	  and its driver through a basic set of functional tests.

	  Gadget Zero also works with the host-side "usb-skeleton" driver,
	  and with many kinds of host-side test software.  You may need
	  to tweak product and vendor IDs before host software knows about
	  this device, and arrange to select an appropriate configuration.

	  Say "y" to link the driver statically, or "m" to build a
	  dynamically linked module called "g_zero".

config USB_ZERO_HNPTEST
	boolean "HNP Test Device"
	depends on USB_ZERO && USB_OTG
	help
	  You can configure this device to enumerate using the device
	  identifiers of the USB-OTG test device.  That means that when
	  this gadget connects to another OTG device, with this one using
	  the "B-Peripheral" role, that device will use HNP to let this
	  one serve as the USB host instead (in the "B-Host" role).

586 587 588
config USB_AUDIO
	tristate "Audio Gadget (EXPERIMENTAL)"
	depends on SND
R
Randy Dunlap 已提交
589
	select SND_PCM
590 591 592 593 594 595 596 597 598 599 600
	help
	  Gadget Audio is compatible with USB Audio Class specification 1.0.
	  It will include at least one AudioControl interface, zero or more
	  AudioStream interface and zero or more MIDIStream interface.

	  Gadget Audio will use on-board ALSA (CONFIG_SND) audio card to
	  playback or capture audio stream.

	  Say "y" to link the driver statically, or "m" to build a
	  dynamically linked module called "g_audio".

L
Linus Torvalds 已提交
601 602 603
config USB_ETH
	tristate "Ethernet Gadget (with CDC Ethernet support)"
	depends on NET
604
	select CRC32
L
Linus Torvalds 已提交
605
	help
606 607
	  This driver implements Ethernet style communication, in one of
	  several ways:
L
Linus Torvalds 已提交
608 609 610 611 612 613 614 615 616
	  
	   - The "Communication Device Class" (CDC) Ethernet Control Model.
	     That protocol is often avoided with pure Ethernet adapters, in
	     favor of simpler vendor-specific hardware, but is widely
	     supported by firmware for smart network devices.

	   - On hardware can't implement that protocol, a simple CDC subset
	     is used, placing fewer demands on USB.

617 618 619 620 621
	   - CDC Ethernet Emulation Model (EEM) is a newer standard that has
	     a simpler interface that can be used by more USB hardware.

	  RNDIS support is an additional option, more demanding than than
	  subset.
L
Linus Torvalds 已提交
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636

	  Within the USB device, this gadget driver exposes a network device
	  "usbX", where X depends on what other networking devices you have.
	  Treat it like a two-node Ethernet link:  host, and gadget.

	  The Linux-USB host-side "usbnet" driver interoperates with this
	  driver, so that deep I/O queues can be supported.  On 2.4 kernels,
	  use "CDCEther" instead, if you're using the CDC option. That CDC
	  mode should also interoperate with standard CDC Ethernet class
	  drivers on other host operating systems.

	  Say "y" to link the driver statically, or "m" to build a
	  dynamically linked module called "g_ether".

config USB_ETH_RNDIS
637 638
	bool "RNDIS support"
	depends on USB_ETH
L
Linus Torvalds 已提交
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
	default y
	help
	   Microsoft Windows XP bundles the "Remote NDIS" (RNDIS) protocol,
	   and Microsoft provides redistributable binary RNDIS drivers for
	   older versions of Windows.

	   If you say "y" here, the Ethernet gadget driver will try to provide
	   a second device configuration, supporting RNDIS to talk to such
	   Microsoft USB hosts.
	   
	   To make MS-Windows work with this, use Documentation/usb/linux.inf
	   as the "driver info file".  For versions of MS-Windows older than
	   XP, you'll need to download drivers from Microsoft's website; a URL
	   is given in comments found in that info file.

654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669
config USB_ETH_EEM
       bool "Ethernet Emulation Model (EEM) support"
       depends on USB_ETH
       default n
       help
         CDC EEM is a newer USB standard that is somewhat simpler than CDC ECM
         and therefore can be supported by more hardware.  Technically ECM and
         EEM are designed for different applications.  The ECM model extends
         the network interface to the target (e.g. a USB cable modem), and the
         EEM model is for mobile devices to communicate with hosts using
         ethernet over USB.  For Linux gadgets, however, the interface with
         the host is the same (a usbX device), so the differences are minimal.

         If you say "y" here, the Ethernet gadget driver will use the EEM
         protocol rather than ECM.  If unsure, say "n".

Y
Yauheni Kaliuta 已提交
670 671 672 673 674 675 676 677 678 679 680 681 682
config USB_G_NCM
	tristate "Network Control Model (NCM) support"
	depends on NET
	select CRC32
	help
	  This driver implements USB CDC NCM subclass standard. NCM is
	  an advanced protocol for Ethernet encapsulation, allows grouping
	  of several ethernet frames into one USB transfer and diffferent
	  alignment possibilities.

	  Say "y" to link the driver statically, or "m" to build a
	  dynamically linked module called "g_ncm".

L
Linus Torvalds 已提交
683 684 685 686 687 688 689 690 691 692
config USB_GADGETFS
	tristate "Gadget Filesystem (EXPERIMENTAL)"
	depends on EXPERIMENTAL
	help
	  This driver provides a filesystem based API that lets user mode
	  programs implement a single-configuration USB device, including
	  endpoint I/O and control requests that don't relate to enumeration.
	  All endpoints, transfer speeds, and transfer types supported by
	  the hardware are available, through read() and write() calls.

693 694 695
	  Currently, this option is still labelled as EXPERIMENTAL because
	  of existing race conditions in the underlying in-kernel AIO core.

L
Linus Torvalds 已提交
696 697 698
	  Say "y" to link the driver statically, or "m" to build a
	  dynamically linked module called "gadgetfs".

699 700 701
config USB_FUNCTIONFS
	tristate "Function Filesystem (EXPERIMENTAL)"
	depends on EXPERIMENTAL
702
	select USB_FUNCTIONFS_GENERIC if !(USB_FUNCTIONFS_ETH || USB_FUNCTIONFS_RNDIS)
703
	help
704 705
	  The Function Filesystem (FunctionFS) lets one create USB
	  composite functions in user space in the same way GadgetFS
706 707 708 709 710
	  lets one create USB gadgets in user space.  This allows creation
	  of composite gadgets such that some of the functions are
	  implemented in kernel space (for instance Ethernet, serial or
	  mass storage) and other are implemented in user space.

711 712 713
	  If you say "y" or "m" here you will be able what kind of
	  configurations the gadget will provide.

714 715 716 717
	  Say "y" to link the driver statically, or "m" to build
	  a dynamically linked module called "g_ffs".

config USB_FUNCTIONFS_ETH
718
	bool "Include configuration with CDC ECM (Ethernet)"
719
	depends on USB_FUNCTIONFS && NET
720
	help
721 722
	  Include a configuration with CDC ECM function (Ethernet) and the
	  Function Filesystem.
723 724

config USB_FUNCTIONFS_RNDIS
725
	bool "Include configuration with RNDIS (Ethernet)"
726
	depends on USB_FUNCTIONFS && NET
727
	help
728
	  Include a configuration with RNDIS function (Ethernet) and the Filesystem.
729 730 731

config USB_FUNCTIONFS_GENERIC
	bool "Include 'pure' configuration"
732
	depends on USB_FUNCTIONFS
733
	help
734 735
	  Include a configuration with the Function Filesystem alone with
	  no Ethernet interface.
736

L
Linus Torvalds 已提交
737
config USB_FILE_STORAGE
A
Alan Stern 已提交
738
	tristate "File-backed Storage Gadget (DEPRECATED)"
R
Randy Dunlap 已提交
739
	depends on BLOCK
L
Linus Torvalds 已提交
740 741 742 743 744 745 746 747 748
	help
	  The File-backed Storage Gadget acts as a USB Mass Storage
	  disk drive.  As its storage repository it can use a regular
	  file or a block device (in much the same way as the "loop"
	  device driver), specified as a module parameter.

	  Say "y" to link the driver statically, or "m" to build a
	  dynamically linked module called "g_file_storage".

A
Alan Stern 已提交
749 750 751
	  NOTE: This driver is deprecated.  Its replacement is the
	  Mass Storage Gadget.

L
Linus Torvalds 已提交
752 753 754 755 756 757 758 759 760 761
config USB_FILE_STORAGE_TEST
	bool "File-backed Storage Gadget testing version"
	depends on USB_FILE_STORAGE
	default n
	help
	  Say "y" to generate the larger testing version of the
	  File-backed Storage Gadget, useful for probing the
	  behavior of USB Mass Storage hosts.  Not needed for
	  normal operation.

762 763 764 765 766 767 768 769 770
config USB_MASS_STORAGE
	tristate "Mass Storage Gadget"
	depends on BLOCK
	help
	  The Mass Storage Gadget acts as a USB Mass Storage disk drive.
	  As its storage repository it can use a regular file or a block
	  device (in much the same way as the "loop" device driver),
	  specified as a module parameter or sysfs option.

A
Alan Stern 已提交
771 772
	  This driver is an updated replacement for the deprecated
	  File-backed Storage Gadget (g_file_storage).
773 774

	  Say "y" to link the driver statically, or "m" to build
A
Alan Stern 已提交
775
	  a dynamically linked module called "g_mass_storage".
776

L
Linus Torvalds 已提交
777
config USB_G_SERIAL
F
Felipe Balbi 已提交
778
	tristate "Serial Gadget (with CDC ACM and CDC OBEX support)"
L
Linus Torvalds 已提交
779 780 781 782 783 784
	help
	  The Serial Gadget talks to the Linux-USB generic serial driver.
	  This driver supports a CDC-ACM module option, which can be used
	  to interoperate with MS-Windows hosts or with the Linux-USB
	  "cdc-acm" driver.

F
Felipe Balbi 已提交
785 786 787 788
	  This driver also supports a CDC-OBEX option.  You will need a
	  user space OBEX server talking to /dev/ttyGS*, since the kernel
	  itself doesn't implement the OBEX protocol.

L
Linus Torvalds 已提交
789 790 791 792 793
	  Say "y" to link the driver statically, or "m" to build a
	  dynamically linked module called "g_serial".

	  For more information, see Documentation/usb/gadget_serial.txt
	  which includes instructions and a "driver info file" needed to
F
Felipe Balbi 已提交
794
	  make MS-Windows work with CDC ACM.
L
Linus Torvalds 已提交
795

796 797 798 799 800 801 802 803 804 805 806 807 808 809
config USB_MIDI_GADGET
	tristate "MIDI Gadget (EXPERIMENTAL)"
	depends on SND && EXPERIMENTAL
	select SND_RAWMIDI
	help
	  The MIDI Gadget acts as a USB Audio device, with one MIDI
	  input and one MIDI output. These MIDI jacks appear as
	  a sound "card" in the ALSA sound system. Other MIDI
	  connections can then be made on the gadget system, using
	  ALSA's aconnect utility etc.

	  Say "y" to link the driver statically, or "m" to build a
	  dynamically linked module called "g_midi".

C
Craig W. Nadler 已提交
810 811 812 813 814 815 816 817 818 819 820 821 822 823
config USB_G_PRINTER
	tristate "Printer Gadget"
	help
	  The Printer Gadget channels data between the USB host and a
	  userspace program driving the print engine. The user space
	  program reads and writes the device file /dev/g_printer to
	  receive or send printer data. It can use ioctl calls to
	  the device file to get or set printer status.

	  Say "y" to link the driver statically, or "m" to build a
	  dynamically linked module called "g_printer".

	  For more information, see Documentation/usb/gadget_printer.txt
	  which includes sample code for accessing the device file.
L
Linus Torvalds 已提交
824

825 826
config USB_CDC_COMPOSITE
	tristate "CDC Composite Device (Ethernet and ACM)"
R
Randy Dunlap 已提交
827
	depends on NET
828 829 830 831 832 833 834 835 836 837 838
	help
	  This driver provides two functions in one configuration:
	  a CDC Ethernet (ECM) link, and a CDC ACM (serial port) link.

	  This driver requires four bulk and two interrupt endpoints,
	  plus the ability to handle altsettings.  Not all peripheral
	  controllers are that capable.

	  Say "y" to link the driver statically, or "m" to build a
	  dynamically linked module.

839 840 841 842 843 844 845 846 847 848
config USB_G_NOKIA
	tristate "Nokia composite gadget"
	depends on PHONET
	help
	  The Nokia composite gadget provides support for acm, obex
	  and phonet in only one composite gadget driver.

	  It's only really useful for N900 hardware. If you're building
	  a kernel for N900, say Y or M here. If unsure, say N.

849 850
config USB_G_MULTI
	tristate "Multifunction Composite Gadget (EXPERIMENTAL)"
851
	depends on BLOCK && NET
852
	select USB_G_MULTI_CDC if !USB_G_MULTI_RNDIS
853 854 855 856 857
	help
	  The Multifunction Composite Gadget provides Ethernet (RNDIS
	  and/or CDC Ethernet), mass storage and ACM serial link
	  interfaces.

858
	  You will be asked to choose which of the two configurations is
859
	  to be available in the gadget.  At least one configuration must
860
	  be chosen to make the gadget usable.  Selecting more than one
861
	  configuration will prevent Windows from automatically detecting
862
	  the gadget as a composite gadget, so an INF file will be needed to
863 864 865 866 867 868 869 870 871 872 873 874
	  use the gadget.

	  Say "y" to link the driver statically, or "m" to build a
	  dynamically linked module called "g_multi".

config USB_G_MULTI_RNDIS
	bool "RNDIS + CDC Serial + Storage configuration"
	depends on USB_G_MULTI
	default y
	help
	  This option enables a configuration with RNDIS, CDC Serial and
	  Mass Storage functions available in the Multifunction Composite
875 876
	  Gadget.  This is the configuration dedicated for Windows since RNDIS
	  is Microsoft's protocol.
877 878 879 880 881 882 883 884 885 886

	  If unsure, say "y".

config USB_G_MULTI_CDC
	bool "CDC Ethernet + CDC Serial + Storage configuration"
	depends on USB_G_MULTI
	default n
	help
	  This option enables a configuration with CDC Ethernet (ECM), CDC
	  Serial and Mass Storage functions available in the Multifunction
887
	  Composite Gadget.
888 889 890

	  If unsure, say "y".

891 892 893 894 895 896 897 898 899 900 901
config USB_G_HID
	tristate "HID Gadget"
	help
	  The HID gadget driver provides generic emulation of USB
	  Human Interface Devices (HID).

	  For more information, see Documentation/usb/gadget_hid.txt which
	  includes sample code for accessing the device files.

	  Say "y" to link the driver statically, or "m" to build a
	  dynamically linked module called "g_hid".
902

903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
config USB_G_DBGP
	tristate "EHCI Debug Device Gadget"
	help
	  This gadget emulates an EHCI Debug device. This is useful when you want
	  to interact with an EHCI Debug Port.

	  Say "y" to link the driver statically, or "m" to build a
	  dynamically linked module called "g_dbgp".

if USB_G_DBGP
choice
	prompt "EHCI Debug Device mode"
	default USB_G_DBGP_SERIAL

config USB_G_DBGP_PRINTK
	depends on USB_G_DBGP
	bool "printk"
	help
	  Directly printk() received data. No interaction.

config USB_G_DBGP_SERIAL
	depends on USB_G_DBGP
	bool "serial"
	help
	  Userland can interact using /dev/ttyGSxxx.
endchoice
endif

L
Linus Torvalds 已提交
931 932
# put drivers that need isochronous transfer support (for audio
# or video class gadget drivers), or specific hardware, here.
L
Laurent Pinchart 已提交
933 934
config USB_G_WEBCAM
	tristate "USB Webcam Gadget"
935
	depends on VIDEO_DEV
L
Laurent Pinchart 已提交
936 937 938 939
	help
	  The Webcam Gadget acts as a composite USB Audio and Video Class
	  device. It provides a userspace API to process UVC control requests
	  and stream video data to the host.
L
Linus Torvalds 已提交
940

L
Laurent Pinchart 已提交
941 942
	  Say "y" to link the driver statically, or "m" to build a
	  dynamically linked module called "g_webcam".
L
Linus Torvalds 已提交
943 944 945

endchoice

D
Denis Cheng 已提交
946
endif # USB_GADGET