[PATCH] Documentation: usb: document bbu fastboot partition name

[PATCH] 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.

Signed-off-by: Bastian Krause <bst@pengutronix.de>
---
 Documentation/user/usb.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/Documentation/user/usb.rst b/Documentation/user/usb.rst
index 95d6dd7e363..92fe1234645 100644
--- a/Documentation/user/usb.rst
+++ b/Documentation/user/usb.rst
@@ -168,7 +168,8 @@ 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:
 
-- 
2.39.2

Re: [PATCH] Documentation: usb: document bbu fastboot partition name

[Marco Felsch]

On 24-01-23, Bastian Krause wrote:
> After looking this up the nth time in the code base, it's really time to
> document this.

:)
> Signed-off-by: Bastian Krause <bst@pengutronix.de>

Reviewed-by: Marco Felsch <m.felsch@pengutronix.de>

> ---
>  Documentation/user/usb.rst | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/user/usb.rst b/Documentation/user/usb.rst
> index 95d6dd7e363..92fe1234645 100644
> --- a/Documentation/user/usb.rst
> +++ b/Documentation/user/usb.rst
> @@ -168,7 +168,8 @@ 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:
>  
> -- 
> 2.39.2
> 
> 
> 

Re: [PATCH] Documentation: usb: document bbu fastboot partition name

[Ahmad Fatoum]

Hello Bastian,


On 23.01.24 14:14, Bastian Krause wrote:
> After looking this up the nth time in the code base, it's really time to
> document this.
> 
> Signed-off-by: Bastian Krause <bst@pengutronix.de>
> ---
>  Documentation/user/usb.rst | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/user/usb.rst b/Documentation/user/usb.rst
> index 95d6dd7e363..92fe1234645 100644
> --- a/Documentation/user/usb.rst
> +++ b/Documentation/user/usb.rst
> @@ -168,7 +168,8 @@ 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).

You can list all exported partitions with


  fastboot devices -l

Maybe include that in your patch too? (Don't give a man a fish...)

Cheers,
Ahmad

>  
>  The barebox Fastboot gadget supports the following non standard extensions:
>  

-- 
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] Documentation: usb: document bbu fastboot partition name

[Ahmad Fatoum]

On 23.01.24 15:37, Ahmad Fatoum wrote:
> Hello Bastian,
> 
> 
> On 23.01.24 14:14, Bastian Krause wrote:
>> After looking this up the nth time in the code base, it's really time to
>> document this.
>>
>> Signed-off-by: Bastian Krause <bst@pengutronix.de>
>> ---
>>  Documentation/user/usb.rst | 3 ++-
>>  1 file changed, 2 insertions(+), 1 deletion(-)
>>
>> diff --git a/Documentation/user/usb.rst b/Documentation/user/usb.rst
>> index 95d6dd7e363..92fe1234645 100644
>> --- a/Documentation/user/usb.rst
>> +++ b/Documentation/user/usb.rst
>> @@ -168,7 +168,8 @@ 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).
> 
> You can list all exported partitions with
> 
> 
>   fastboot devices -l

Sorry, I meant `fastboot getvar all`. Sample output:

  (bootloader) version: 0.4
  (bootloader) bootloader-version: barebox-2023.09.0-myversion
  (bootloader) max-download-size: 8388608
  (bootloader) partition-size:fit: 04000000
  (bootloader) partition-type:fit: basic
  (bootloader) partition-size:bbu-eMMC: e2000000
  (bootloader) partition-type:bbu-eMMC: basic
  all: 
  Finished. Total time: 0.023s

The fastboot partitions that can be used with fastboot flash
are "fit" and "bbu-eMMC".

Cheers,
Ahmad

> 
> Maybe include that in your patch too? (Don't give a man a fish...)
> 
> Cheers,
> Ahmad
> 
>>  
>>  The barebox Fastboot gadget supports the following non standard extensions:
>>  
> 

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