mail archive of the barebox mailing list
 help / color / mirror / Atom feed
* [PATCH] Documentation: usbgadget: provide autostart notes
@ 2017-05-05 11:42 Oleksij Rempel
  2017-05-05 12:22 ` Yegor Yefremov
  0 siblings, 1 reply; 2+ messages in thread
From: Oleksij Rempel @ 2017-05-05 11:42 UTC (permalink / raw)
  To: barebox; +Cc: Oleksij Rempel

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

Signed-off-by: Oleksij Rempel <o.rempel@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


_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2017-05-05 12:22 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-05-05 11:42 [PATCH] Documentation: usbgadget: provide autostart notes Oleksij Rempel
2017-05-05 12:22 ` Yegor Yefremov

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox