[PATCH v2 1/2] Documentation: usb: document bbu fastboot partition name

[PATCH v2 1/2] Documentation: usb: document bbu fastboot partition name

[Bastian Krause]

After looking this up the nth time in the code base, it's really time to
document this.

Also mention that ``fastboot getvar all`` lists the partitions.

Signed-off-by: Bastian Krause <bst@pengutronix.de>
---
Changes since (implicit) v1:
- mention partitions in ``fastboot getvar all`` as suggested by Ahmad
---
 Documentation/user/usb.rst | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/Documentation/user/usb.rst b/Documentation/user/usb.rst
index 95d6dd7e363..dfa53cf199a 100644
--- a/Documentation/user/usb.rst
+++ b/Documentation/user/usb.rst
@@ -168,12 +168,13 @@ The Fastboot gadget supports the following commands:
 ``fastboot flash`` additionally supports image types UBI and Barebox. For UBI
 Images and a MTD device as target, ubiformat is called. For a Barebox image
 with an available barebox update handler for the fastboot exported device, the
-barebox_update is called.
+barebox_update is called (exported as ``bbu-<update_handler_name>`` fastboot
+partition).
 
 The barebox Fastboot gadget supports the following non standard extensions:
 
 - ``fastboot getvar all``
-  Shows a list of all variables
+  Shows a list of all variables, including exported partitions
 - ``fastboot oem getenv <varname>``
   Shows a barebox environment variable
 - ``fastboot oem setenv <varname>=<value>``
-- 
2.39.2

[PATCH v2 2/2] usbgadget: add bbu fastboot partition naming scheme

[Bastian Krause]

Signed-off-by: Bastian Krause <bst@pengutronix.de>
---
New patch, no v1 available.
---
 commands/usbgadget.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/commands/usbgadget.c b/commands/usbgadget.c
index d0dcde69cec..e69660fde54 100644
--- a/commands/usbgadget.c
+++ b/commands/usbgadget.c
@@ -61,7 +61,8 @@ BAREBOX_CMD_HELP_TEXT("Options:")
 BAREBOX_CMD_HELP_OPT ("-a\t", "Create CDC ACM function")
 BAREBOX_CMD_HELP_OPT ("-A <desc>", "Create Android Fastboot function. If 'desc' is not provided, "
 				   "try to use 'global.fastboot.partitions' variable.")
-BAREBOX_CMD_HELP_OPT ("-b\t", "include registered barebox update handlers (fastboot specific)")
+BAREBOX_CMD_HELP_OPT ("-b\t", "include registered barebox update handlers (fastboot specific,"
+			      "exported as 'bbu-<update_handler_name>' partitions)")
 BAREBOX_CMD_HELP_OPT ("-D <desc>", "Create DFU function. If 'desc' is not provided, "
 				   "try to use 'global.usbgadget.dfu_function' variable.")
 BAREBOX_CMD_HELP_OPT ("-S <desc>", "Create USB Mass Storage function. If 'desc' is not provided,"
-- 
2.39.2

Re: [PATCH v2 1/2] Documentation: usb: document bbu fastboot partition name

[Ahmad Fatoum]

On 24.01.24 16:47, Bastian Krause wrote:
> After looking this up the nth time in the code base, it's really time to
> document this.
> 
> Also mention that ``fastboot getvar all`` lists the partitions.

Thank you!

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

> 
> Signed-off-by: Bastian Krause <bst@pengutronix.de>
> ---
> Changes since (implicit) v1:
> - mention partitions in ``fastboot getvar all`` as suggested by Ahmad
> ---
>  Documentation/user/usb.rst | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/user/usb.rst b/Documentation/user/usb.rst
> index 95d6dd7e363..dfa53cf199a 100644
> --- a/Documentation/user/usb.rst
> +++ b/Documentation/user/usb.rst
> @@ -168,12 +168,13 @@ The Fastboot gadget supports the following commands:
>  ``fastboot flash`` additionally supports image types UBI and Barebox. For UBI
>  Images and a MTD device as target, ubiformat is called. For a Barebox image
>  with an available barebox update handler for the fastboot exported device, the
> -barebox_update is called.
> +barebox_update is called (exported as ``bbu-<update_handler_name>`` fastboot
> +partition).
>  
>  The barebox Fastboot gadget supports the following non standard extensions:
>  
>  - ``fastboot getvar all``
> -  Shows a list of all variables
> +  Shows a list of all variables, including exported partitions
>  - ``fastboot oem getenv <varname>``
>    Shows a barebox environment variable
>  - ``fastboot oem setenv <varname>=<value>``

-- 
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 |

Re: [PATCH v2 1/2] Documentation: usb: document bbu fastboot partition name

[Sascha Hauer]

On Wed, 24 Jan 2024 16:47:27 +0100, Bastian Krause wrote:
> After looking this up the nth time in the code base, it's really time to
> document this.
> 
> Also mention that ``fastboot getvar all`` lists the partitions.
> 
> 

Applied, thanks!

[1/2] Documentation: usb: document bbu fastboot partition name
      https://git.pengutronix.de/cgit/barebox/commit/?id=3021e16f1a4a (link may not be stable)
[2/2] usbgadget: add bbu fastboot partition naming scheme
      https://git.pengutronix.de/cgit/barebox/commit/?id=305b65c2f950 (link may not be stable)

Best regards,
-- 
Sascha Hauer <s.hauer@pengutronix.de>