diff mbox series

[1/1] doc: handlers: document the eMMC handler

Message ID 20260308000833.3502752-1-dario.binacchi@amarulasolutions.com
State New
Headers
Series [1/1] doc: handlers: document the eMMC handler |

Commit Message

Dario Binacchi March 8, 2026, 12:08 a.m. UTC 
Document the emmc_boot and emmc_boot_toggle script handlers and
provide usage examples.

Signed-off-by: Dario Binacchi <dario.binacchi@amarulasolutions.com>
---
 doc/source/handlers.rst | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)

Comments

Stefano Babic March 8, 2026, 11:14 a.m. UTC | #1 
Hi Dario,

On 3/8/26 01:08, Dario Binacchi wrote:
> Document the emmc_boot and emmc_boot_toggle script handlers and
> provide usage examples.
> 

In fact, documentation was missing, thanks for this.

Applied to -master, thanks!

Best regards,
Stefano Babic

> Signed-off-by: Dario Binacchi <dario.binacchi@amarulasolutions.com>
> ---
>   doc/source/handlers.rst | 36 ++++++++++++++++++++++++++++++++++++
>   1 file changed, 36 insertions(+)
> 
> diff --git a/doc/source/handlers.rst b/doc/source/handlers.rst
> index f3ca094c1141..d9ac6c7ef44d 100644
> --- a/doc/source/handlers.rst
> +++ b/doc/source/handlers.rst
> @@ -1036,6 +1036,42 @@ not set, variables set in bootenv are overwritten.
>   
>   In the example above, bootenv01key is not overwritten by a value in uEnv.txt because the flag "nooverride" is set.
>   
> +eMMC handler
> +------------
> +
> +This is a script handler used to manage the eMMC boot partitions.
> +
> +The ``emmc_boot`` selects the eMMC hardware boot partition based
> +on the device name. The number following ``boot`` in the device path
> +is used to determine the boot partition to be selected:
> +
> +- ``/dev/mmcblkXboot0`` selects boot partition 0
> +- ``/dev/mmcblkXboot1`` selects boot partition 1
> +
> +The ``emmc_boot_toggle`` toggles the active eMMC hardware boot
> +partition for the specified device.
> +
> +Example selecting boot partition 1:
> +
> +::
> +
> +	scripts: (
> +	{
> +	   type = "emmc_boot";
> +	   device = "/dev/mmcblk1boot1";
> +        }
> +
> +Example toggling the active boot partition:
> +
> +::
> +
> +	scripts: (
> +	{
> +	   type = "emmc_boot_toggle";
> +	   device = "/dev/mmcblk1";
> +        }
> +
> +
>   Archive handler
>   ---------------
>   

To unsubscribe from this group and stop receiving emails from it, send an email to linux-amarula+unsubscribe@amarulasolutions.com.
diff mbox series

Patch

diff --git a/doc/source/handlers.rst b/doc/source/handlers.rst
index f3ca094c1141..d9ac6c7ef44d 100644
--- a/doc/source/handlers.rst
+++ b/doc/source/handlers.rst
@@ -1036,6 +1036,42 @@  not set, variables set in bootenv are overwritten.
 
 In the example above, bootenv01key is not overwritten by a value in uEnv.txt because the flag "nooverride" is set.
 
+eMMC handler
+------------
+
+This is a script handler used to manage the eMMC boot partitions.
+
+The ``emmc_boot`` selects the eMMC hardware boot partition based
+on the device name. The number following ``boot`` in the device path
+is used to determine the boot partition to be selected:
+
+- ``/dev/mmcblkXboot0`` selects boot partition 0
+- ``/dev/mmcblkXboot1`` selects boot partition 1
+
+The ``emmc_boot_toggle`` toggles the active eMMC hardware boot
+partition for the specified device.
+
+Example selecting boot partition 1:
+
+::
+
+	scripts: (
+	{
+	   type = "emmc_boot";
+	   device = "/dev/mmcblk1boot1";
+        }
+
+Example toggling the active boot partition:
+
+::
+
+	scripts: (
+	{
+	   type = "emmc_boot_toggle";
+	   device = "/dev/mmcblk1";
+        }
+
+
 Archive handler
 ---------------