# SPDX-License-Identifier: GPL-2.0
#
# [31mCONFIG_USB[0m 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).
# - Some systems have both kinds of controllers.
#
# 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).
#
config [31mCONFIG_USB_ZERO[0m
tristate "Gadget Zero (DEVELOPMENT)"
select [31mCONFIG_USB_LIBCOMPOSITE[0m
select [31mCONFIG_USB_F_SS_LB[0m
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
[31mCONFIG_USB[0m "gadget drivers" can be written.
Make this be the first driver you try using on top of any new
[31mCONFIG_USB[0m 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 [31mCONFIG_USB_ZERO_HNPTEST[0m
bool "HNP Test Device"
depends on [31mCONFIG_USB_ZERO[0m && [31mCONFIG_USB_OTG[0m
help
You can configure this device to enumerate using the device
identifiers of the [31mCONFIG_USB[0m-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 [31mCONFIG_USB[0m host instead (in the "B-Host" role).
config [31mCONFIG_USB_AUDIO[0m
tristate "Audio Gadget"
depends on [31mCONFIG_SND[0m
select [31mCONFIG_USB_LIBCOMPOSITE[0m
select [31mCONFIG_SND_PCM[0m
select [31mCONFIG_USB_F_UAC1[0m if ([31mCONFIG_GADGET_UAC1[0m && ![31mCONFIG_GADGET_UAC1_LEGACY[0m)
select [31mCONFIG_USB_F_UAC1_LEGACY[0m if ([31mCONFIG_GADGET_UAC1[0m && [31mCONFIG_GADGET_UAC1_LEGACY[0m)
select [31mCONFIG_USB_F_UAC2[0m if ![31mCONFIG_GADGET_UAC1[0m
select [31mCONFIG_USB_U_AUDIO[0m if ([31mCONFIG_USB_F_UAC2[0m || [31mCONFIG_USB_F_UAC1[0m)
help
This Gadget Audio driver is compatible with [31mCONFIG_USB[0m Audio Class
specification 2.0. It implements 1 AudioControl interface,
1 AudioStreaming Interface each for [31mCONFIG_USB[0m-OUT and [31mCONFIG_USB[0m-IN.
Number of channels, sample rate and sample size can be
specified as module parameters.
This driver doesn't expect any real Audio codec to be present
on the device - the audio streams are simply sinked to and
sourced from a virtual ALSA sound card created. The user-space
application may choose to do whatever it wants with the data
received from the [31mCONFIG_USB[0m Host and choose to provide whatever it
wants as audio data to the [31mCONFIG_USB[0m Host.
Say "y" to link the driver statically, or "m" to build a
dynamically linked module called "g_audio".
config [31mCONFIG_GADGET_UAC1[0m
bool "UAC 1.0"
depends on [31mCONFIG_USB_AUDIO[0m
help
If you instead want older [31mCONFIG_USB[0m Audio Class specification 1.0 support
with similar driver capabilities.
config [31mCONFIG_GADGET_UAC1_LEGACY[0m
bool "UAC 1.0 (Legacy)"
depends on [31mCONFIG_GADGET_UAC1[0m
help
If you instead want legacy UAC Spec-1.0 driver that also has audio
paths hardwired to the Audio codec chip on-board and doesn't work
without one.
config [31mCONFIG_USB_ETH[0m
tristate "Ethernet Gadget (with CDC Ethernet support)"
depends on [31mCONFIG_NET[0m
select [31mCONFIG_USB_LIBCOMPOSITE[0m
select [31mCONFIG_USB_U_ETHER[0m
select [31mCONFIG_USB_F_ECM[0m
select [31mCONFIG_USB_F_SUBSET[0m
select [31mCONFIG_CRC32[0m
help
This driver implements Ethernet style communication, in one of
several ways:
- 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 [31mCONFIG_USB[0m.
- CDC Ethernet Emulation Model (EEM) is a newer standard that has
a simpler interface that can be used by more [31mCONFIG_USB[0m hardware.
RNDIS support is an additional option, more demanding than subset.
Within the [31mCONFIG_USB[0m 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-[31mCONFIG_USB[0m 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 [31mCONFIG_USB_ETH_RNDIS[0m
bool "RNDIS support"
depends on [31mCONFIG_USB_ETH[0m
select [31mCONFIG_USB_LIBCOMPOSITE[0m
select [31mCONFIG_USB_F_RNDIS[0m
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 [31mCONFIG_USB[0m 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.
config [31mCONFIG_USB_ETH_EEM[0m
bool "Ethernet Emulation Model (EEM) support"
depends on [31mCONFIG_USB_ETH[0m
select [31mCONFIG_USB_LIBCOMPOSITE[0m
select [31mCONFIG_USB_F_EEM[0m
help
CDC EEM is a newer [31mCONFIG_USB[0m 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 [31mCONFIG_USB[0m cable modem), and the
EEM model is for mobile devices to communicate with hosts using
ethernet over [31mCONFIG_USB[0m. 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".
config [31mCONFIG_USB_G_NCM[0m
tristate "Network Control Model (NCM) support"
depends on [31mCONFIG_NET[0m
select [31mCONFIG_USB_LIBCOMPOSITE[0m
select [31mCONFIG_USB_U_ETHER[0m
select [31mCONFIG_USB_F_NCM[0m
select [31mCONFIG_CRC32[0m
help
This driver implements [31mCONFIG_USB[0m CDC NCM subclass standard. NCM is
an advanced protocol for Ethernet encapsulation, allows grouping
of several ethernet frames into one [31mCONFIG_USB[0m transfer and different
alignment possibilities.
Say "y" to link the driver statically, or "m" to build a
dynamically linked module called "g_ncm".
config [31mCONFIG_USB_GADGETFS[0m
tristate "Gadget Filesystem"
help
This driver provides a filesystem based API that lets user mode
programs implement a single-configuration [31mCONFIG_USB[0m 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.
Say "y" to link the driver statically, or "m" to build a
dynamically linked module called "gadgetfs".
config [31mCONFIG_USB_FUNCTIONFS[0m
tristate "Function Filesystem"
select [31mCONFIG_USB_LIBCOMPOSITE[0m
select [31mCONFIG_USB_F_FS[0m
select [31mCONFIG_USB_FUNCTIONFS_GENERIC[0m if !([31mCONFIG_USB_FUNCTIONFS_ETH[0m || [31mCONFIG_USB_FUNCTIONFS_RNDIS[0m)
help
The Function Filesystem (FunctionFS) lets one create [31mCONFIG_USB[0m
composite functions in user space in the same way GadgetFS
lets one create [31mCONFIG_USB[0m 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.
If you say "y" or "m" here you will be able what kind of
configurations the gadget will provide.
Say "y" to link the driver statically, or "m" to build
a dynamically linked module called "g_ffs".
config [31mCONFIG_USB_FUNCTIONFS_ETH[0m
bool "Include configuration with CDC ECM (Ethernet)"
depends on [31mCONFIG_USB_FUNCTIONFS[0m && [31mCONFIG_NET[0m
select [31mCONFIG_USB_U_ETHER[0m
select [31mCONFIG_USB_F_ECM[0m
select [31mCONFIG_USB_F_SUBSET[0m
help
Include a configuration with CDC ECM function (Ethernet) and the
Function Filesystem.
config [31mCONFIG_USB_FUNCTIONFS_RNDIS[0m
bool "Include configuration with RNDIS (Ethernet)"
depends on [31mCONFIG_USB_FUNCTIONFS[0m && [31mCONFIG_NET[0m
select [31mCONFIG_USB_U_ETHER[0m
select [31mCONFIG_USB_F_RNDIS[0m
help
Include a configuration with RNDIS function (Ethernet) and the Filesystem.
config [31mCONFIG_USB_FUNCTIONFS_GENERIC[0m
bool "Include 'pure' configuration"
depends on [31mCONFIG_USB_FUNCTIONFS[0m
help
Include a configuration with the Function Filesystem alone with
no Ethernet interface.
config [31mCONFIG_USB_MASS_STORAGE[0m
tristate "Mass Storage Gadget"
depends on [31mCONFIG_BLOCK[0m
select [31mCONFIG_USB_LIBCOMPOSITE[0m
select [31mCONFIG_USB_F_MASS_STORAGE[0m
help
The Mass Storage Gadget acts as a [31mCONFIG_USB[0m 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.
This driver is a replacement for now removed File-backed
Storage Gadget (g_file_storage).
Say "y" to link the driver statically, or "m" to build
a dynamically linked module called "g_mass_storage".
config [31mCONFIG_USB_GADGET_TARGET[0m
tristate "USB Gadget Target Fabric Module"
depends on [31mCONFIG_TARGET_CORE[0m
select [31mCONFIG_USB_LIBCOMPOSITE[0m
select [31mCONFIG_USB_F_TCM[0m
help
This fabric is an [31mCONFIG_USB[0m gadget. Two [31mCONFIG_USB[0m protocols are supported that is
BBB or BOT (Bulk Only Transport) and UAS ([31mCONFIG_USB[0m Attached [31mCONFIG_SCSI[0m). BOT is
advertised on alternative interface 0 (primary) and UAS is on
alternative interface 1. Both protocols can work on USB2.0 and USB3.0.
UAS utilizes the [31mCONFIG_USB[0m 3.0 feature called streams support.
config [31mCONFIG_USB_G_SERIAL[0m
tristate "Serial Gadget (with CDC ACM and CDC OBEX support)"
depends on [31mCONFIG_TTY[0m
select [31mCONFIG_USB_U_SERIAL[0m
select [31mCONFIG_USB_F_ACM[0m
select [31mCONFIG_USB_F_SERIAL[0m
select [31mCONFIG_USB_F_OBEX[0m
select [31mCONFIG_USB_LIBCOMPOSITE[0m
help
The Serial Gadget talks to the Linux-[31mCONFIG_USB[0m 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-[31mCONFIG_USB[0m
"cdc-acm" driver.
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.
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.rst
which includes instructions and a "driver info file" needed to
make MS-Windows work with CDC ACM.
config [31mCONFIG_USB_MIDI_GADGET[0m
tristate "MIDI Gadget"
depends on [31mCONFIG_SND[0m
select [31mCONFIG_USB_LIBCOMPOSITE[0m
select [31mCONFIG_SND_RAWMIDI[0m
select [31mCONFIG_USB_F_MIDI[0m
help
The MIDI Gadget acts as a [31mCONFIG_USB[0m 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".
config [31mCONFIG_USB_G_PRINTER[0m
tristate "Printer Gadget"
select [31mCONFIG_USB_LIBCOMPOSITE[0m
select [31mCONFIG_USB_F_PRINTER[0m
help
The Printer Gadget channels data between the [31mCONFIG_USB[0m 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.rst
which includes sample code for accessing the device file.
if [31mCONFIG_TTY[0m
config [31mCONFIG_USB_CDC_COMPOSITE[0m
tristate "CDC Composite Device (Ethernet and ACM)"
depends on [31mCONFIG_NET[0m
select [31mCONFIG_USB_LIBCOMPOSITE[0m
select [31mCONFIG_USB_U_SERIAL[0m
select [31mCONFIG_USB_U_ETHER[0m
select [31mCONFIG_USB_F_ACM[0m
select [31mCONFIG_USB_F_ECM[0m
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.
config [31mCONFIG_USB_G_NOKIA[0m
tristate "Nokia composite gadget"
depends on [31mCONFIG_PHONET[0m
depends on [31mCONFIG_BLOCK[0m
select [31mCONFIG_USB_LIBCOMPOSITE[0m
select [31mCONFIG_USB_U_SERIAL[0m
select [31mCONFIG_USB_U_ETHER[0m
select [31mCONFIG_USB_F_ACM[0m
select [31mCONFIG_USB_F_OBEX[0m
select [31mCONFIG_USB_F_PHONET[0m
select [31mCONFIG_USB_F_ECM[0m
select [31mCONFIG_USB_F_MASS_STORAGE[0m
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 [31mCONFIG_M[0m here. If unsure, say N.
config [31mCONFIG_USB_G_ACM_MS[0m
tristate "CDC Composite Device (ACM and mass storage)"
depends on [31mCONFIG_BLOCK[0m
select [31mCONFIG_USB_LIBCOMPOSITE[0m
select [31mCONFIG_USB_U_SERIAL[0m
select [31mCONFIG_USB_F_ACM[0m
select [31mCONFIG_USB_F_MASS_STORAGE[0m
help
This driver provides two functions in one configuration:
a mass storage, and a CDC ACM (serial port) link.
Say "y" to link the driver statically, or "m" to build a
dynamically linked module called "g_acm_ms".
config [31mCONFIG_USB_G_MULTI[0m
tristate "Multifunction Composite Gadget"
depends on [31mCONFIG_BLOCK[0m && [31mCONFIG_NET[0m
select [31mCONFIG_USB_G_MULTI_CDC[0m if ![31mCONFIG_USB_G_MULTI_RNDIS[0m
select [31mCONFIG_USB_LIBCOMPOSITE[0m
select [31mCONFIG_USB_U_SERIAL[0m
select [31mCONFIG_USB_U_ETHER[0m
select [31mCONFIG_USB_F_ACM[0m
select [31mCONFIG_USB_F_MASS_STORAGE[0m
help
The Multifunction Composite Gadget provides Ethernet (RNDIS
and/or CDC Ethernet), mass storage and ACM serial link
interfaces.
You will be asked to choose which of the two configurations is
to be available in the gadget. At least one configuration must
be chosen to make the gadget usable. Selecting more than one
configuration will prevent Windows from automatically detecting
the gadget as a composite gadget, so an INF file will be needed to
use the gadget.
Say "y" to link the driver statically, or "m" to build a
dynamically linked module called "g_multi".
config [31mCONFIG_USB_G_MULTI_RNDIS[0m
bool "RNDIS + CDC Serial + Storage configuration"
depends on [31mCONFIG_USB_G_MULTI[0m
select [31mCONFIG_USB_F_RNDIS[0m
default y
help
This option enables a configuration with RNDIS, CDC Serial and
Mass Storage functions available in the Multifunction Composite
Gadget. This is the configuration dedicated for Windows since RNDIS
is Microsoft's protocol.
If unsure, say "y".
config [31mCONFIG_USB_G_MULTI_CDC[0m
bool "CDC Ethernet + CDC Serial + Storage configuration"
depends on [31mCONFIG_USB_G_MULTI[0m
select [31mCONFIG_USB_F_ECM[0m
help
This option enables a configuration with CDC Ethernet (ECM), CDC
Serial and Mass Storage functions available in the Multifunction
Composite Gadget.
If unsure, say "y".
endif # [31mCONFIG_TTY[0m
config [31mCONFIG_USB_G_HID[0m
tristate "HID Gadget"
select [31mCONFIG_USB_LIBCOMPOSITE[0m
select [31mCONFIG_USB_F_HID[0m
help
The [31mCONFIG_HID[0m gadget driver provides generic emulation of [31mCONFIG_USB[0m
Human Interface Devices ([31mCONFIG_HID[0m).
For more information, see Documentation/usb/gadget_hid.rst 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".
# Standalone / single function gadgets
config [31mCONFIG_USB_G_DBGP[0m
tristate "EHCI Debug Device Gadget"
depends on [31mCONFIG_TTY[0m
select [31mCONFIG_USB_LIBCOMPOSITE[0m
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 [31mCONFIG_USB_G_DBGP[0m
choice
prompt "EHCI Debug Device mode"
default [31mCONFIG_USB_G_DBGP_SERIAL[0m
config [31mCONFIG_USB_G_DBGP_PRINTK[0m
depends on [31mCONFIG_USB_G_DBGP[0m
bool "printk"
help
Directly printk() received data. No interaction.
config [31mCONFIG_USB_G_DBGP_SERIAL[0m
depends on [31mCONFIG_USB_G_DBGP[0m
select [31mCONFIG_USB_U_SERIAL[0m
bool "serial"
help
Userland can interact using /dev/ttyGSxxx.
endchoice
endif
# put drivers that need isochronous transfer support (for audio
# or video class gadget drivers), or specific hardware, here.
config [31mCONFIG_USB_G_WEBCAM[0m
tristate "USB Webcam Gadget"
depends on [31mCONFIG_VIDEO_V4L2[0m
select [31mCONFIG_USB_LIBCOMPOSITE[0m
select [31mCONFIG_VIDEOBUF2_VMALLOC[0m
select [31mCONFIG_USB_F_UVC[0m
help
The Webcam Gadget acts as a composite [31mCONFIG_USB[0m Audio and Video Class
device. It provides a userspace API to process UVC control requests
and stream video data to the host.
Say "y" to link the driver statically, or "m" to build a
dynamically linked module called "g_webcam".