flash: Add support for RB1

README: document new u_boot_rb1 option

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

Author: lool

README.md

@@ -45,14 +45,17 @@ debos --fakemachine-backend qemu --memory 1GiB --scratchsize 4GiB debos-recipes/
 ### Build options
 
 A few options are provided in the debos recipes; for the root filesystem recipe:
-- experimentalkernel: update the linux kernel to the version from experimental; default: don't update the kernel
-- localdebs: install this space separte list of local deb packages (NB: debos expects relative pathnames)
-- xfcedesktop: install a Xfce desktop environment; default: console only environment
+- `experimentalkernel`: update the linux kernel to the version from experimental; default: don't update the kernel
+- `localdebs`: install this space separte list of local deb packages (NB: debos expects relative pathnames)
+- `xfcedesktop`: install a Xfce desktop environment; default: console only environment
 
 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
-- imagetype: either `ufs` (the default) or (`sdcard`); UFS images are named disk-ufs.img and use 4096 bytes sectors and SD card images are named disk-sdcard.img and use 512 bytes sectors
-- imagesize: set the output disk image size; default: `4GiB`
+- `dtb`: override the firmware provided device tree with one from the linux kernel, e.g. `qcom/qcs6490-rb3gen2.dtb`; default: don't override
+- `imagetype`: either `ufs` (the default) or (`sdcard`); UFS images are named disk-ufs.img and use 4096 bytes sectors and SD card images are named disk-sdcard.img and use 512 bytes sectors
+- `imagesize`: set the output disk image size; default: `4GiB`
+
+For the flash recipe:
+- `u_boot_rb1`: prebuilt U-Boot binary for RB1 in Android boot image format -- see below (NB: debos expects relative pathnames)
 
 Here are some example invocations:
 ```bash

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

@@ -1,3 +1,8 @@
+{{- $build_rb1 := "false" -}}
+{{- if .u_boot_rb1 -}}
+{{- $build_rb1 := "true" }}
+{{- end -}}
+
 architecture: arm64
 
 actions:
@@ -8,6 +13,15 @@ actions:
     filename: qcom-ptool.tar.gz
     unpack: true
 
+{{- if eq $build_rb1 "true" }}
+  # TODO: consider switching to https://releases.linaro.org/96boards/rb1/qualcomm/firmware/RB1_firmware_20231124-v4.zip instead
+  - action: download
+    description: Download RB1 rescue image
+    url: https://releases.linaro.org/96boards/rb1/linaro/rescue/23.12/rb1-bootloader-emmc-linux-47528.zip
+    name: qrb2210-rb1_rescue-image.zip
+    filename: qrb2210-rb1_rescue-image.zip
+{{- end -}}
+
   - action: download
     description: Download QCM6490 boot binaries
     url: https://softwarecenter.qualcomm.com/download/software/chip/qualcomm_linux-spf-1-0/qualcomm-linux-spf-1-0_test_device_public/r1.0_00058.0/qcm6490-le-1-0/common/build/ufs/bin/QCM6490_bootbinaries.zip
@@ -21,7 +35,7 @@ actions:
     filename: rb3gen2-vision-kit_cdt.zip
 
   - action: run
-    description: Generate flash directories for UFS boards
+    description: Generate flash directories for eMMC and UFS boards
     chroot: false
     command: |
       set -eux
@@ -31,6 +45,43 @@ actions:
       # path to unpacked qcom-ptool tarball
       QCOM_PTOOL="${ROOTDIR}/../qcom-ptool.tar.gz.d/qcom-ptool-main"
 
+{{- if eq $build_rb1 "true" }}
+      ### board: qrb2210-rb1
+      # unpack rescue image
+      unzip -j "${ROOTDIR}/../qrb2210-rb1_rescue-image.zip" \
+          -d build/qrb2210-rb1_rescue-image
+      # TODO: on RB1, we don't generate partition files with ptool since its
+      # partitions.conf does not have entries for data files from the rescue
+      # image, while the rescue image defines useful partitions such as the ESP
+      flash_dir="${ARTIFACTDIR}/flash_rb1"
+      rm -rf "${flash_dir}"
+      mkdir -v "${flash_dir}"
+      # copy rescue image files
+      cp --preserve=mode,timestamps -v build/qrb2210-rb1_rescue-image/* \
+          "${flash_dir}"
+      # copy RB1 U-Boot binary to u-boot-abootimg.img
+      cp --preserve=mode,timestamps -v "${ARTIFACTDIR}/{{- .u_boot_rb1 -}}" \
+          "${flash_dir}/u-boot-abootimg.img"
+
+      # update flashing file for RB1 U-Boot; in the rescue image, this
+      # partition is blanked with boot-erase.img
+      sed -i '/label="boot_a"/s/filename="[^"]*"/filename="u-boot-abootimg.img"/' "${flash_dir}"/rawprogram*.xml
+
+      # update flashing files for ESP image; in the rescue image, this
+      # partition is blanked with boot-erase.img
+      sed -i '/label="esp"/s#filename="[^"]*"#filename="../disk-sdcard.img1"#' "${flash_dir}"/rawprogram*.xml
+
+      # update flashing files for rootfs image;; in the rescue image, this
+      # partition is not provisioned
+      sed -i '/label="rootfs"/s#filename="[^"]*"#filename="../disk-sdcard.img2"#' "${flash_dir}"/rawprogram*.xml
+
+      # TODO: there is currently no dtb.bin alike system with the RB1 firmware
+
+      # TODO: currently not providing CDT; it's present in
+      # RB1_firmware_20231124-v4.zip but not in
+      # rb1-bootloader-emmc-linux-47528.zip
+{{- end -}}
+
       ## platform: QCM6490
       # unpack boot binaries
       unzip -j "${ROOTDIR}/../qcm6490_boot-binaries.zip" \
@@ -45,6 +96,8 @@ actions:
           # partitions.conf sets --type=emmc, nand or ufs
           if grep -F '^--disk --type=ufs ' "${conf}"; then
               touch flash-ufs
+          elif grep -F '^--disk --type=emmc ' "${conf}"; then
+              touch flash-emmc
           fi
           "${QCOM_PTOOL}/ptool.py" -x ptool-partitions.xml
       )