[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 at pengutronix.de>

Reviewed-by: Ahmad Fatoum <a.fatoum at 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 |