debos: Generate images for both sector sizes

Update docs and drop workaround script.

Signed-off-by: Loïc Minier <[email protected]>

Author: lool

.github/workflows/debos.yml

@@ -98,7 +98,10 @@ jobs:
               # qemu backend also requires to set scratchsize, otherwise
               # the whole build is done from memory and the out of memory
               # killer gets triggered
-              debos -b qemu --scratchsize 4GiB qualcomm-linux-debian-image.yaml
+              debos -b qemu --scratchsize 4GiB -t sectorsize:4096 \
+                  qualcomm-linux-debian-image.yaml
+              debos -b qemu --scratchsize 4GiB -t sectorsize:512 \
+                  qualcomm-linux-debian-image.yaml
           EOF
           ) | sudo incus exec "${INCUS_NAME}" -- sh
 
@@ -115,7 +118,8 @@ jobs:
           dir="${FILESERVER_DIR}/${id}"
           mkdir -vp "${dir}"
           # copy output files
-          cp -v disk.img "${dir}"
+          cp -v disk-4096.img.gz "${dir}"
+          cp -v disk-512.img.gz "${dir}"
           # instruct fileserver to publish this directory
           url="${FILESERVER_URL}/${id}/"
           curl -X POST -H 'Accept: text/event-stream' "${url}"

README.md

@@ -13,7 +13,7 @@ main: Primary development branch. Contributors should develop submissions based
 ## Requirements
 
 [debos](https://github.com/go-debos/debos) is required to build the debos recipes. Recent debos packages should be available in Debian and Ubuntu repositories; there are 
-[debos installation instructions](https://github.com/go-debos/debos?tab=readme-ov-file#installation-from-source-under-debian) on the project's page, notably for Docker images and to build debos from source.
+[debos installation instructions](https://github.com/go-debos/debos?tab=readme-ov-file#installation-from-source-under-debian) on the project's page, notably for Docker images and to build debos from source. Make sure to use at least version 1.1.5 which supports setting the sector size.
 
 [qdl](https://github.com/linux-msm/qdl) is typically used for flashing. While recent versions are available in Debian and Ubuntu, make sure you have at least version 2.1 as it contains important fixes.
 
@@ -45,7 +45,7 @@ A few options are provided in the debos recipes; for the root filesystem recipe:
 
 For the image recipe:
 - dtb: override the firmware provided device tree with one from the linux kernel, e.g. `qcom/qcs6490-rb3gen2.dtb`; default: don't override
-- image: set the output disk image filename; default: `disk.img`
+- image: set the output disk image filename; default: `disk-4096.img`
 - imagesize: set the output disk image size; default: `4GiB`
 
 These can be passed as follows:
@@ -67,10 +67,6 @@ Depending on the target board and target boot media, it's also necessary to use
 
 The RB3 Gen2 board boots from UFS by default. To flash a disk image to the UFS storage of the RB3 Gen2 board:
 1. provision some known good early boot assets by flashing the Yocto edition of [Qualcomm Linux](https://www.qualcomm.com/developer/software/qualcomm-linux)
-1. unless you've got a recent debos that supports creating images with a 4096B sector size, convert the debos disk image from 512B to 4096B sector sizes; this sample script can be used as a workaround until [debos gains support for setting the sector size](https://github.com/go-debos/debos/issues/537) but it's a britle approach which requires root, the workaround script is also full of hardcoded expectations and might need local tweaks:
-    ```bash
-    sudo scripts/workaround-convert-sector-size disk.img disk-4096.img 4096
-    ```
 1. create a `rawprogram-ufs.xml` file instructing QDL to flash to the first UFS LUN (LUN0):
     ```xml
     <?xml version="1.0" ?>

debos-recipes/qualcomm-linux-debian-image.yaml

@@ -1,8 +1,10 @@
 {{- $dtb := or .dtb "firmware" }}
-{{- $image := or .image "disk.img" }}
 {{- $imagesize := or .imagesize "4GiB" }}
+{{- $sectorsize := or .sectorsize 512 }}
+{{- $image := or .image (printf "disk-%s.img" $sectorsize) }}
 
 architecture: arm64
+sectorsize: {{ $sectorsize }}
 
 actions:
   - action: unpack