summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorOleksij Rempel <o.rempel@pengutronix.de>2017-05-06 16:02:32 +0200
committerSascha Hauer <s.hauer@pengutronix.de>2017-05-08 13:55:16 +0200
commitb1c9f53acd586d7b611d2406018866d680081c62 (patch)
tree9b8cf10821fc96ef77b3a4ee1495d2e5472ba9c2
parente5f2191e7b6920e67dd45b34d9b1c86d04456ffa (diff)
downloadbarebox-b1c9f53acd586d7b611d2406018866d680081c62.tar.gz
Documentation: usbgadget: provide autostart notes
The usbgadget autostart functionality is already added. It's time to reflect it in the documentation. Signed-off-by: Oleksij Rempel <o.rempel@pengutronix.de> Signed-off-by: Sascha Hauer <s.hauer@pengutronix.de>
-rw-r--r--Documentation/user/usb.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/Documentation/user/usb.rst b/Documentation/user/usb.rst
index bbcb045..ec219cf 100644
--- a/Documentation/user/usb.rst
+++ b/Documentation/user/usb.rst
@@ -216,3 +216,24 @@ mode. Once a specific mode has been selected it can't be changed later anymore.
musb-hdrc: setup fifo_mode 4
musb-hdrc: 28/31 max ep, 16384/16384 memory
barebox:/
+
+USB Gadget autostart Support
+----------------------------
+
+Barebox can be configured to start usbgadget automatically by using global variables,
+instead of creating boot script. This can be useful if autostart policy should be
+chosen at boot time from other driver or script.
+To get usbgadget autostart support barebox has to be compiled with
+CONFIG_USB_GADGET_AUTOSTART enabled.
+
+USB Gadget autostart Options
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+``global.usbgadget.autostart``
+ Boolean flag. If set to 1, usbgadget will be started automatically on boot and
+ enable USB OTG mode. (Default 0).
+``global.usbgadget.acm``
+ Boolean flag. If set to 1, CDC ACM function will be created.
+ See :ref:`command_usbgadget` -a. (Default 0).
+``global.usbgadget.fastboot_function``
+ Function description for fastboot. See :ref:`command_usbgadget` -A [desc].