diff mbox series

[isar-cip-core,v4,9/9] README.swupdate: Add section about partition selection

Message ID 20240502093240.364093-10-Quirin.Gylstorff@siemens.com (mailing list archive)
State Superseded
Headers show
Series Add option to encrypt the rootfs | expand

Commit Message

Quirin Gylstorff May 2, 2024, 9:31 a.m. UTC
From: Quirin Gylstorff <quirin.gylstorff@siemens.com>

Signed-off-by: Quirin Gylstorff <quirin.gylstorff@siemens.com>
---
 doc/README.swupdate.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

Comments

Felix Moessbauer May 3, 2024, 11:18 a.m. UTC | #1
On Thu, 2024-05-02 at 11:31 +0200, Quirin Gylstorff wrote:
> From: Quirin Gylstorff <quirin.gylstorff@siemens.com>
> 
> Signed-off-by: Quirin Gylstorff <quirin.gylstorff@siemens.com>
> ---
>  doc/README.swupdate.md | 16 ++++++++++++++++
>  1 file changed, 16 insertions(+)
> 
> diff --git a/doc/README.swupdate.md b/doc/README.swupdate.md
> index b7e13f7..fee695e 100644
> --- a/doc/README.swupdate.md
> +++ b/doc/README.swupdate.md
> @@ -7,6 +7,22 @@ Start with cloning the isar-cip-core repository:
>  ```
>  host$ git clone
> https://gitlab.com/cip-project/cip-core/isar-cip-core.git
>  ```
> +
> +## Update Partition selector(swupdate-handler-roundrobin)
> +
> +SWUpdate uses the handler [swupdate-handler-
> roundrobin](https://gitlab.com/cip-project/cip-sw-updates/swupdate-
> handler-roundrobin) to select the update partition.

... the partition to update.

> +The handler uses the label of the 
> by efibootguard selected boot partition.

It that always true? What the handler selects depends on what you put
into the sw-description file. In the CIP reference implementation, this
is indeed a label.

Felix

> +In the cip-core provided images the boot partitions are labeled
> `BOOT0`
> +and `BOOT1`, see [ebg-sysparts.inc](../wic/ebg-sysparts.inc).
> +
> +The [sw-description](recipes-core/images/swu/sw-description.tmpl)
> contains the mapping from boot
> +partition to root file system partition, e.g.:
> +```
> +device = "C:BOOT0:linux.efi-
> >${ABROOTFS_PART_UUID_A},C:BOOT1:linux.efi->${ABROOTFS_PART_UUID_B}";
> +```
> +The variables `ABROOTFS_PART_UUID_A` and `ABROOTFS_PART_UUID_B`
> contain partition uuids. The handler searches
> +for the matching device and SWUpdate writes the image to the
> selected device.
> +
>  ## SWUpdate Efibootguard update
>  
>  :warning: **If the efibootguard binary is corrupted the system can
> no longer boot**
diff mbox series

Patch

diff --git a/doc/README.swupdate.md b/doc/README.swupdate.md
index b7e13f7..fee695e 100644
--- a/doc/README.swupdate.md
+++ b/doc/README.swupdate.md
@@ -7,6 +7,22 @@  Start with cloning the isar-cip-core repository:
 ```
 host$ git clone https://gitlab.com/cip-project/cip-core/isar-cip-core.git
 ```
+
+## Update Partition selector(swupdate-handler-roundrobin)
+
+SWUpdate uses the handler [swupdate-handler-roundrobin](https://gitlab.com/cip-project/cip-sw-updates/swupdate-handler-roundrobin) to select the update partition.
+The handler uses the label of the by efibootguard selected boot partition.
+In the cip-core provided images the boot partitions are labeled `BOOT0`
+and `BOOT1`, see [ebg-sysparts.inc](../wic/ebg-sysparts.inc).
+
+The [sw-description](recipes-core/images/swu/sw-description.tmpl) contains the mapping from boot
+partition to root file system partition, e.g.:
+```
+device = "C:BOOT0:linux.efi->${ABROOTFS_PART_UUID_A},C:BOOT1:linux.efi->${ABROOTFS_PART_UUID_B}";
+```
+The variables `ABROOTFS_PART_UUID_A` and `ABROOTFS_PART_UUID_B` contain partition uuids. The handler searches
+for the matching device and SWUpdate writes the image to the selected device.
+
 ## SWUpdate Efibootguard update
 
 :warning: **If the efibootguard binary is corrupted the system can no longer boot**