[PATCH] Documentation: usbgadget: provide autostart notes

Oleksij Rempel o.rempel at pengutronix.de
Fri May 5 04:42:11 PDT 2017


The usbgadget autostart funktionality is already added. Not it's
time to reflect it in the documentation.

Signed-off-by: Oleksij Rempel <o.rempel at pengutronix.de>
---
 Documentation/user/usb.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/Documentation/user/usb.rst b/Documentation/user/usb.rst
index bbcb045cee..ad7f8ab54f 100644
--- a/Documentation/user/usb.rst
+++ b/Documentation/user/usb.rst
@@ -195,6 +195,25 @@ USB CDC ACM compliant serial device.
 Unlike the :ref:`command_dfu` command the ``usbgadget`` command returns immediately
 after creating the gadget. The gadget can be removed with ``usbgadget -d``.
 
+USB Gadget autostart Support
+----------------------------
+
+Barebox can be configured to start usbgadget automatically by using global variables,
+instead of creating boot script. This can be usefoul 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.
+``global.usbgadget.acm``
+  Boolean flag. If set to 1, CDC ACM function will be created. See :ref:`command_usbgadget` -a.
+``global.usbgadget.acm``
+  Function description for fastboot. See :ref:`command_usbgadget` -A <desc>.
+
 USB OTG support
 ---------------
 
-- 
2.11.0




More information about the barebox mailing list