xref: /openbmc/u-boot/drivers/usb/gadget/Kconfig (revision a95aee6a)
1f9d0fd8aSSam Protsenko#
2f9d0fd8aSSam Protsenko# USB Gadget support on a system involves
3f9d0fd8aSSam Protsenko#    (a) a peripheral controller, and
4f9d0fd8aSSam Protsenko#    (b) the gadget driver using it.
5f9d0fd8aSSam Protsenko#
6f9d0fd8aSSam Protsenko# NOTE:  Gadget support ** DOES NOT ** depend on host-side CONFIG_USB !!
7f9d0fd8aSSam Protsenko#
8f9d0fd8aSSam Protsenko#  - Host systems (like PCs) need CONFIG_USB (with "A" jacks).
9f9d0fd8aSSam Protsenko#  - Peripherals (like PDAs) need CONFIG_USB_GADGET (with "B" jacks).
10f9d0fd8aSSam Protsenko#  - Some systems have both kinds of controllers.
11f9d0fd8aSSam Protsenko#
12f9d0fd8aSSam Protsenko# With help from a special transceiver and a "Mini-AB" jack, systems with
13f9d0fd8aSSam Protsenko# both kinds of controller can also support "USB On-the-Go" (CONFIG_USB_OTG).
14f9d0fd8aSSam Protsenko#
15f9d0fd8aSSam Protsenko
16f9d0fd8aSSam Protsenkomenuconfig USB_GADGET
17f9d0fd8aSSam Protsenko	bool "USB Gadget Support"
18f9d0fd8aSSam Protsenko	help
19f9d0fd8aSSam Protsenko	   USB is a master/slave protocol, organized with one master
20f9d0fd8aSSam Protsenko	   host (such as a PC) controlling up to 127 peripheral devices.
21f9d0fd8aSSam Protsenko	   The USB hardware is asymmetric, which makes it easier to set up:
22f9d0fd8aSSam Protsenko	   you can't connect a "to-the-host" connector to a peripheral.
23f9d0fd8aSSam Protsenko
24f9d0fd8aSSam Protsenko	   U-Boot can run in the host, or in the peripheral.  In both cases
25f9d0fd8aSSam Protsenko	   you need a low level bus controller driver, and some software
26f9d0fd8aSSam Protsenko	   talking to it.  Peripheral controllers are often discrete silicon,
27f9d0fd8aSSam Protsenko	   or are integrated with the CPU in a microcontroller.  The more
28f9d0fd8aSSam Protsenko	   familiar host side controllers have names like "EHCI", "OHCI",
29f9d0fd8aSSam Protsenko	   or "UHCI", and are usually integrated into southbridges on PC
30f9d0fd8aSSam Protsenko	   motherboards.
31f9d0fd8aSSam Protsenko
32f9d0fd8aSSam Protsenko	   Enable this configuration option if you want to run U-Boot inside
33f9d0fd8aSSam Protsenko	   a USB peripheral device.  Configure one hardware driver for your
34f9d0fd8aSSam Protsenko	   peripheral/device side bus controller, and a "gadget driver" for
35f9d0fd8aSSam Protsenko	   your peripheral protocol.
36a59a77f8SSam Protsenko
37a59a77f8SSam Protsenkoif USB_GADGET
38a59a77f8SSam Protsenko
39*a95aee6aSMaxime Ripardconfig USB_GADGET_MANUFACTURER
40*a95aee6aSMaxime Ripard	string "Vendor name of the USB device"
41*a95aee6aSMaxime Ripard	default "U-Boot"
42*a95aee6aSMaxime Ripard	help
43*a95aee6aSMaxime Ripard	  Vendor name of the USB device emulated, reported to the host device.
44*a95aee6aSMaxime Ripard	  This is usually either the manufacturer of the device or the SoC.
45*a95aee6aSMaxime Ripard
46*a95aee6aSMaxime Ripardconfig USB_GADGET_VENDOR_NUM
47*a95aee6aSMaxime Ripard	hex "Vendor ID of the USB device"
48*a95aee6aSMaxime Ripard	default 0x0
49*a95aee6aSMaxime Ripard	help
50*a95aee6aSMaxime Ripard	  Vendor ID of the USB device emulated, reported to the host device.
51*a95aee6aSMaxime Ripard	  This is usually the board or SoC vendor's, unless you've registered
52*a95aee6aSMaxime Ripard	  for one.
53*a95aee6aSMaxime Ripard
54*a95aee6aSMaxime Ripardconfig USB_GADGET_PRODUCT_NUM
55*a95aee6aSMaxime Ripard	hex "Product ID of the USB device"
56*a95aee6aSMaxime Ripard	default 0x0
57*a95aee6aSMaxime Ripard	help
58*a95aee6aSMaxime Ripard	  Product ID of the USB device emulated, reported to the host device.
59*a95aee6aSMaxime Ripard
603457bbafSSam Protsenkoconfig USB_GADGET_ATMEL_USBA
613457bbafSSam Protsenko	bool "Atmel USBA"
623457bbafSSam Protsenko	select USB_GADGET_DUALSPEED
633457bbafSSam Protsenko	help
643457bbafSSam Protsenko	  USBA is the integrated high-speed USB Device controller on
653457bbafSSam Protsenko	  the AT32AP700x, some AT91SAM9 and AT91CAP9 processors from Atmel.
663457bbafSSam Protsenko
67e016f0b2SSteve Raeconfig USB_GADGET_BCM_UDC_OTG_PHY
68e016f0b2SSteve Rae	bool "Broadcom UDC OTG PHY"
69e016f0b2SSteve Rae	help
70e016f0b2SSteve Rae	  Enable the Broadcom UDC OTG physical device interface.
71e016f0b2SSteve Rae
723457bbafSSam Protsenkoconfig USB_GADGET_DWC2_OTG
733457bbafSSam Protsenko	bool "DesignWare USB2.0 HS OTG controller (gadget mode)"
743457bbafSSam Protsenko	select USB_GADGET_DUALSPEED
753457bbafSSam Protsenko	help
763457bbafSSam Protsenko	  The Designware USB2.0 high-speed gadget controller
773457bbafSSam Protsenko	  integrated into many SoCs. Select this option if you want the
783457bbafSSam Protsenko	  driver to operate in Peripheral mode. This option requires
793457bbafSSam Protsenko	  USB_GADGET to be enabled.
803457bbafSSam Protsenko
81f221db0eSSteve Raeif USB_GADGET_DWC2_OTG
82f221db0eSSteve Rae
83f221db0eSSteve Raeconfig USB_GADGET_DWC2_OTG_PHY_BUS_WIDTH_8
84f221db0eSSteve Rae	bool "DesignWare USB2.0 HS OTG controller 8-bit PHY bus width"
85f221db0eSSteve Rae	help
86f221db0eSSteve Rae	  Set the Designware USB2.0 high-speed OTG controller
87f221db0eSSteve Rae	  PHY interface width to 8 bits, rather than the default (16 bits).
88f221db0eSSteve Rae
89f221db0eSSteve Raeendif # USB_GADGET_DWC2_OTG
90f221db0eSSteve Rae
913457bbafSSam Protsenkoconfig CI_UDC
923457bbafSSam Protsenko	bool "ChipIdea device controller"
933457bbafSSam Protsenko	select USB_GADGET_DUALSPEED
943457bbafSSam Protsenko	help
953457bbafSSam Protsenko	  Say Y here to enable device controller functionality of the
963457bbafSSam Protsenko	  ChipIdea driver.
973457bbafSSam Protsenko
98a59a77f8SSam Protsenkoconfig USB_GADGET_VBUS_DRAW
99a59a77f8SSam Protsenko	int "Maximum VBUS Power usage (2-500 mA)"
100a59a77f8SSam Protsenko	range 2 500
101a59a77f8SSam Protsenko	default 2
102a59a77f8SSam Protsenko	help
103a59a77f8SSam Protsenko	   Some devices need to draw power from USB when they are
104a59a77f8SSam Protsenko	   configured, perhaps to operate circuitry or to recharge
105a59a77f8SSam Protsenko	   batteries.  This is in addition to any local power supply,
106a59a77f8SSam Protsenko	   such as an AC adapter or batteries.
107a59a77f8SSam Protsenko
108a59a77f8SSam Protsenko	   Enter the maximum power your device draws through USB, in
109a59a77f8SSam Protsenko	   milliAmperes.  The permitted range of values is 2 - 500 mA;
110a59a77f8SSam Protsenko	   0 mA would be legal, but can make some hosts misbehave.
111a59a77f8SSam Protsenko
112a59a77f8SSam Protsenko	   This value will be used except for system-specific gadget
113a59a77f8SSam Protsenko	   drivers that have more specific information.
114a59a77f8SSam Protsenko
1153457bbafSSam Protsenko# Selected by UDC drivers that support high-speed operation.
1163457bbafSSam Protsenkoconfig USB_GADGET_DUALSPEED
1173457bbafSSam Protsenko	bool
1183457bbafSSam Protsenko
119aaa4a9e3SSam Protsenkoconfig USB_GADGET_DOWNLOAD
120aaa4a9e3SSam Protsenko	bool "Enable USB download gadget"
121aaa4a9e3SSam Protsenko	help
122aaa4a9e3SSam Protsenko	  Composite USB download gadget support (g_dnl) for download functions.
123aaa4a9e3SSam Protsenko	  This code works on top of composite gadget.
124aaa4a9e3SSam Protsenko
125e6c0bc06SSam Protsenkoif USB_GADGET_DOWNLOAD
126e6c0bc06SSam Protsenko
1275661f08aSStefan Agnerconfig USB_FUNCTION_SDP
1285661f08aSStefan Agner	bool "Enable USB SDP (Serial Download Protocol)"
1295661f08aSStefan Agner	help
1305661f08aSStefan Agner	  Enable Serial Download Protocol (SDP) device support in U-Boot. This
1315661f08aSStefan Agner	  allows to download images into memory and execute (jump to) them
1325661f08aSStefan Agner	  using the same protocol as implemented by the i.MX family's boot ROM.
1335661f08aSStefan Agner
1345506ff14SMaxime Ripardendif # USB_GADGET_DOWNLOAD
1355506ff14SMaxime Ripard
1363f33d3c8SMaxime Ripardconfig USB_ETHER
1373f33d3c8SMaxime Ripard	bool "USB Ethernet Gadget"
1383f33d3c8SMaxime Ripard	help
1393f33d3c8SMaxime Ripard	  Creates an Ethernet network device through a USB peripheral
1403f33d3c8SMaxime Ripard	  controller. This will create a network interface on both the device
1413f33d3c8SMaxime Ripard	  (U-Boot) and the host (remote device) that can be used just like any
1423f33d3c8SMaxime Ripard	  other nework interface.
1433f33d3c8SMaxime Ripard	  It will bind on the peripheral USB controller, ignoring the USB hosts
1443f33d3c8SMaxime Ripard	  controllers in the system.
1453f33d3c8SMaxime Ripard
1463f33d3c8SMaxime Ripardif USB_ETHER
1473f33d3c8SMaxime Ripard
148d2f0f4afSMaxime Ripardchoice
149d2f0f4afSMaxime Ripard	prompt "USB Ethernet Gadget Model"
150d2f0f4afSMaxime Ripard	default USB_ETH_RNDIS
151d2f0f4afSMaxime Ripard	help
152d2f0f4afSMaxime Ripard	  There is several models (protocols) to implement Ethernet over USB
153d2f0f4afSMaxime Ripard	  devices. The main ones are Microsoft's RNDIS and USB's CDC-Ethernet
154d2f0f4afSMaxime Ripard	  (also called CDC-ECM). RNDIS is obviously compatible with Windows,
155d2f0f4afSMaxime Ripard	  while CDC-ECM is not. Most other operating systems support both, so
156d2f0f4afSMaxime Ripard	  if inter-operability is a concern, RNDIS is to be preferred.
157d2f0f4afSMaxime Ripard
158d2f0f4afSMaxime Ripardconfig USB_ETH_CDC
159d2f0f4afSMaxime Ripard	bool "CDC-ECM Protocol"
160d2f0f4afSMaxime Ripard	help
161d2f0f4afSMaxime Ripard	  CDC (Communications Device Class) is the standard for Ethernet over
162d2f0f4afSMaxime Ripard	  USB devices. While there's several alternatives, the most widely used
163d2f0f4afSMaxime Ripard	  protocol is ECM (Ethernet Control Model). However, compatibility with
164d2f0f4afSMaxime Ripard	  Windows is not that great.
165d2f0f4afSMaxime Ripard
166d2f0f4afSMaxime Ripardconfig USB_ETH_RNDIS
167d2f0f4afSMaxime Ripard	bool "RNDIS Protocol"
168d2f0f4afSMaxime Ripard	help
169d2f0f4afSMaxime Ripard	  The RNDIS (Remote Network Driver Interface Specification) is a
170d2f0f4afSMaxime Ripard	  Microsoft proprietary protocol to create an Ethernet device over USB.
171d2f0f4afSMaxime Ripard	  Windows obviously supports it, as well as all the major operating
172d2f0f4afSMaxime Ripard	  systems, so it's the best option for compatibility.
173d2f0f4afSMaxime Ripard
174d2f0f4afSMaxime Ripardendchoice
175d2f0f4afSMaxime Ripard
176d4a37553SMugunthan V Nconfig USBNET_DEVADDR
177d4a37553SMugunthan V N	string "USB Gadget Ethernet device mac address"
178d4a37553SMugunthan V N	default "de:ad:be:ef:00:01"
17974e7997cSMaxime Ripard	help
18074e7997cSMaxime Ripard	  Ethernet MAC address of the device-side (ie. local board's) MAC
18174e7997cSMaxime Ripard	  address of the usb_ether interface
182d4a37553SMugunthan V N
183c163668aSMaxime Ripardconfig USBNET_HOST_ADDR
184c163668aSMaxime Ripard	string "USB Gadget Ethernet host mac address"
185c163668aSMaxime Ripard	default "de:ad:be:ef:00:00"
186c163668aSMaxime Ripard	help
187c163668aSMaxime Ripard	  Ethernet MAC address of the host-side (ie. remote device's) MAC
188c163668aSMaxime Ripard	  address of the usb_ether interface
189c163668aSMaxime Ripard
1903f33d3c8SMaxime Ripardendif # USB_ETHER
1913f33d3c8SMaxime Ripard
192a59a77f8SSam Protsenkoendif # USB_GADGET
193