[PATCH 1/3] doc: user: rename appendix section and keep it as last entry

[PATCH 1/3] doc: user: rename appendix section and keep it as last entry

[Roland Hieber]

This additional appendix section describes how to set up the development
host. Adjust its title to reflect its contents. An appendix also looks
bad in the middle of a table of contents, so move it to the bottom.
Rename the file accordingly.

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
 .../{system-setup.rst => appendix-development-host-setup.rst} | 4 ++--
 Documentation/user/user-manual.rst                            | 3 ++-
 2 files changed, 4 insertions(+), 3 deletions(-)
 rename Documentation/user/{system-setup.rst => appendix-development-host-setup.rst} (96%)

diff --git a/Documentation/user/system-setup.rst b/Documentation/user/appendix-development-host-setup.rst
similarity index 96%
rename from Documentation/user/system-setup.rst
rename to Documentation/user/appendix-development-host-setup.rst
index 5651569dc2b2..88baf5f3794a 100644
--- a/Documentation/user/system-setup.rst
+++ b/Documentation/user/appendix-development-host-setup.rst
@@ -1,5 +1,5 @@
-Appendix: System Setup
-======================
+Appendix: Development Host Setup
+================================
 
 Serial Console Access
 ---------------------
diff --git a/Documentation/user/user-manual.rst b/Documentation/user/user-manual.rst
index a14f6905f9ee..ce0792000a3c 100644
--- a/Documentation/user/user-manual.rst
+++ b/Documentation/user/user-manual.rst
@@ -29,7 +29,6 @@ Contents:
    bootchooser
    remote-control
    security
-   system-setup
    reset-reason
    system-reset
    state
@@ -42,6 +41,8 @@ Contents:
    virtio
    barebox-tlv
 
+   appendix-development-host-setup
+
 * :ref:`search`
 * :ref:`genindex`
 
-- 
2.39.5

[PATCH 2/3] doc: user: usb: link to syntax when explaining the partition variables

[Roland Hieber]

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
 Documentation/user/usb.rst | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/Documentation/user/usb.rst b/Documentation/user/usb.rst
index 7eb360d629c9..43072be53db7 100644
--- a/Documentation/user/usb.rst
+++ b/Documentation/user/usb.rst
@@ -51,6 +51,8 @@ the :ref:`command_usbgadget` commands supports registering composite gadgets, wh
 exports multiple functions at once. This happens in the "background" without impacting
 use of the shell.
 
+.. _usbgadget_partitions:
+
 Partition description
 ^^^^^^^^^^^^^^^^^^^^^
 
@@ -316,12 +318,16 @@ USB Gadget autostart Options
   See :ref:`command_usbgadget` -a. (Default 0).
 ``global.system.partitions``
   Common function description for all of DFU, fastboot and USB mass storage
-  gadgets. Both Fastboot and DFU partitions also have dedicated override
+  gadgets.
+  See :ref:`usbgadget_partitions` above for the syntax.
+  Both Fastboot and DFU partitions also have dedicated override
   variables for backwards-compatibility:
 
 ``global.usbgadget.dfu_function``
-  Function description for DFU. See :ref:`command_usbgadget` -D [desc].
+  Function description for DFU. See :ref:`command_usbgadget` -D [desc],
+  and :ref:`usbgadget_partitions` above for the syntax.
 ``global.fastboot.partitions``
-  Function description for fastboot. See :ref:`command_usbgadget` -A [desc].
+  Function description for fastboot. See :ref:`command_usbgadget` -A [desc],
+  and :ref:`usbgadget_partitions` above for the syntax.
 ``global.fastboot.bbu``
   Export barebox update handlers. See :ref:`command_usbgadget` -b. (Default 0).
-- 
2.39.5

[PATCH 3/3] doc: user: net: document Fastboot over UDP usage

[Roland Hieber]

Signed-off-by: Roland Hieber <rhi@pengutronix.de>
---
 Documentation/user/networking.rst | 16 ++++++++++++++++
 Documentation/user/usb.rst        |  4 ++++
 2 files changed, 20 insertions(+)

diff --git a/Documentation/user/networking.rst b/Documentation/user/networking.rst
index 6997da10dbea..605936c6a895 100644
--- a/Documentation/user/networking.rst
+++ b/Documentation/user/networking.rst
@@ -203,6 +203,22 @@ The netconsole can be used just like any other console. Note, however, that the
 simple console protocol is UDP based, so there is no guarantee about packet
 loss.
 
+Fastboot over UDP
+-----------------
+
+When built with ``CONFIG_NET_FASTBOOT=y`` and the environment variable
+``fastboot.net.autostart`` is set to any non-empty value, barebox will
+listen for fastboot commands on UDP port 5554.
+You might need to configure a IP address first in order to use fastboot (e.g.
+via DHCP or statically; see above).
+
+Additionally, you have to configure at least the ``fastboot.partitions``
+variable, see :ref:`usbgadget_variables`.
+
+On your development host, use fastboot with the ``-s udp:<IP-address>``
+parameter, specifying the IP address of your board.
+See :ref:`fastboot` for more information about Fastboot usage.
+
 DSA (Distributed Switch Architecture) Support in Barebox
 --------------------------------------------------------
 
diff --git a/Documentation/user/usb.rst b/Documentation/user/usb.rst
index 43072be53db7..f233927656bc 100644
--- a/Documentation/user/usb.rst
+++ b/Documentation/user/usb.rst
@@ -153,6 +153,8 @@ barebox can provide a serial console over USB. This can be initialized with the
 :ref:`command_usbserial` command. Once the host is plugged in it should show a
 new serial device, on Linux for example ``/dev/ttyACM0``.
 
+.. _fastboot:
+
 Android Fastboot support
 ^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -307,6 +309,8 @@ 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.
 
+.. _usbgadget_variables:
+
 USB Gadget autostart Options
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-- 
2.39.5

Re: [PATCH 3/3] doc: user: net: document Fastboot over UDP usage

[Ahmad Fatoum]

Hello Roland,

On 6/25/25 12:51, Roland Hieber wrote:
> Signed-off-by: Roland Hieber <rhi@pengutronix.de>

Reviewed-by: Ahmad Fatoum <a.fatoum@pengutronix.de>

Thanks a lot for the documentation,
Ahmad

> ---
>  Documentation/user/networking.rst | 16 ++++++++++++++++
>  Documentation/user/usb.rst        |  4 ++++
>  2 files changed, 20 insertions(+)
> 
> diff --git a/Documentation/user/networking.rst b/Documentation/user/networking.rst
> index 6997da10dbea..605936c6a895 100644
> --- a/Documentation/user/networking.rst
> +++ b/Documentation/user/networking.rst
> @@ -203,6 +203,22 @@ The netconsole can be used just like any other console. Note, however, that the
>  simple console protocol is UDP based, so there is no guarantee about packet
>  loss.
>  
> +Fastboot over UDP
> +-----------------
> +
> +When built with ``CONFIG_NET_FASTBOOT=y`` and the environment variable
> +``fastboot.net.autostart`` is set to any non-empty value, barebox will
> +listen for fastboot commands on UDP port 5554.
> +You might need to configure a IP address first in order to use fastboot (e.g.
> +via DHCP or statically; see above).
> +
> +Additionally, you have to configure at least the ``fastboot.partitions``
> +variable, see :ref:`usbgadget_variables`.
> +
> +On your development host, use fastboot with the ``-s udp:<IP-address>``
> +parameter, specifying the IP address of your board.
> +See :ref:`fastboot` for more information about Fastboot usage.
> +
>  DSA (Distributed Switch Architecture) Support in Barebox
>  --------------------------------------------------------
>  
> diff --git a/Documentation/user/usb.rst b/Documentation/user/usb.rst
> index 43072be53db7..f233927656bc 100644
> --- a/Documentation/user/usb.rst
> +++ b/Documentation/user/usb.rst
> @@ -153,6 +153,8 @@ barebox can provide a serial console over USB. This can be initialized with the
>  :ref:`command_usbserial` command. Once the host is plugged in it should show a
>  new serial device, on Linux for example ``/dev/ttyACM0``.
>  
> +.. _fastboot:
> +
>  Android Fastboot support
>  ^^^^^^^^^^^^^^^^^^^^^^^^
>  
> @@ -307,6 +309,8 @@ 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.
>  
> +.. _usbgadget_variables:
> +
>  USB Gadget autostart Options
>  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>  

-- 
Pengutronix e.K.                  |                             |
Steuerwalder Str. 21              | http://www.pengutronix.de/  |
31137 Hildesheim, Germany         | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686  | Fax:   +49-5121-206917-5555 |