refactor: debos: data-driven flash recipe

lool · lool · commit 04419fc4d6ea · 2025-08-27T12:15:29.000Z
Rewrite flash recipe to use a data-driven approach to board definitions
instead of duplicating logic for each board.

Signed-off-by: Loïc Minier &lt;loic.minier@oss.qualcomm.com&gt;
diff --git a/debos-recipes/qualcomm-linux-debian-flash.yaml b/debos-recipes/qualcomm-linux-debian-flash.yaml
@@ -14,41 +14,73 @@ actions:
     filename: qcom-ptool.tar.gz
     unpack: true
 
+{{- $boards := list }}
+{{- if eq $build_qcm6490 "true" }}
+{{- $boards = append $boards (dict
+    "name" "qcs6490-rb3gen2-vision-kit"
+    "silicon_family" "qcm6490"
+    "platform" "qcs6490-rb3gen2"
+    "boot_binaries_download" (dict
+        "description" "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_00095.0/qcm6490-le-1-0/common/build/ufs/bin/QCM6490_bootbinaries.zip"
+        "name" "qcm6490_boot-binaries"
+        "filename" "qcm6490_boot-binaries.zip"
+        "sha256sum" "9c100d7b184ecf0ab9c4be71a8bb7c243fdc79a64380ca3025024dd2b14c5078"
+    )
+    "cdt_download" (dict
+        "description" "RB3 Gen2 Vision Kit CDT"
+        "url" "https://artifacts.codelinaro.org/artifactory/codelinaro-le/Qualcomm_Linux/QCS6490/cdt/rb3gen2-vision-kit.zip"
+        "name" "qcs6490-rb3gen2-vision-kit_cdt"
+        "filename" "qcs6490-rb3gen2-vision-kit_cdt.zip"
+        "sha256sum" "a339e297b454c4dc3805fe8cd11d6d8dcb801aa8f0c2dc691561c2785019fa3c"
+    )
+    "cdt_filename" "cdt_vision_kit.bin"
+    "dtb" "qcom/qcs6490-rb3gen2.dtb"
+    "disk_image_type" "ufs"
+)}}
+{{- end }}
 {{- 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
-  - action: run
-    description: Verify download
-    chroot: false
-    command: echo c75b6c63eb24c8ca36dad08ba4d4e93f3f4cd7dce60cf1b6dfb5790dc181cc3d ${ROOTDIR}/../qrb2210-rb1_rescue-image.zip|sha256sum --strict -c -
+{{- $boards = append $boards (dict
+    "name" "qrb2210-rb1"
+    "silicon_family" "qcm2290"
+    "platform" "qrb2210-rb1"
+    "boot_binaries_download" (dict
+        "description" "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"
+        "filename" "qrb2210-rb1_rescue-image.zip"
+        "sha256sum" "c75b6c63eb24c8ca36dad08ba4d4e93f3f4cd7dce60cf1b6dfb5790dc181cc3d"
+    )
+    "disk_image_type" "sdcard"
+    "u_boot_file" .u_boot_rb1
+)}}
 {{- end }}
 
-{{- if eq $build_qcm6490 "true" }}
+{{- range $board := $boards }}
   - 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_00095.0/qcm6490-le-1-0/common/build/ufs/bin/QCM6490_bootbinaries.zip
-    name: qcm6490_boot-binaries
-    filename: qcm6490_boot-binaries.zip
+    description: Download of {{ $board.boot_binaries_download.description }}
+    url: {{ $board.boot_binaries_download.url }}
+    name: {{ $board.boot_binaries_download.name }}
+    filename: {{ $board.boot_binaries_download.filename }}
   - action: run
-    description: Verify download
+    description: Verify SHA256 sum of {{ $board.boot_binaries_download.description }}
     chroot: false
-    command: echo 9c100d7b184ecf0ab9c4be71a8bb7c243fdc79a64380ca3025024dd2b14c5078 ${ROOTDIR}/../qcm6490_boot-binaries.zip|sha256sum --strict -c -
-{{- end }}
-
-{{- if eq $build_qcm6490 "true" }}
+    command:
+      echo "{{ $board.boot_binaries_download.sha256sum }} ${ROOTDIR}/../{{ $board.boot_binaries_download.filename }}" |
+          sha256sum --strict -c -
+  {{- if $board.cdt_download }}
   - action: download
-    description: Download RB3 Gen2 Vision Kit CDT
-    url: https://artifacts.codelinaro.org/artifactory/codelinaro-le/Qualcomm_Linux/QCS6490/cdt/rb3gen2-vision-kit.zip
-    name: qcs6490-rb3gen2-vision-kit_cdt
-    filename: qcs6490-rb3gen2-vision-kit_cdt.zip
+    description: Download of {{ $board.cdt_download.description }}
+    url: {{ $board.cdt_download.url }}
+    name: {{ $board.cdt_download.name }}
+    filename: {{ $board.cdt_download.filename }}
   - action: run
-    description: Verify download
+    description: Verify SHA256 sum of {{ $board.cdt_download.description }}
     chroot: false
-    command: echo a339e297b454c4dc3805fe8cd11d6d8dcb801aa8f0c2dc691561c2785019fa3c ${ROOTDIR}/../qcs6490-rb3gen2-vision-kit_cdt.zip|sha256sum --strict -c -
+    command:
+      echo "{{ $board.cdt_download.sha256sum }} ${ROOTDIR}/../{{ $board.cdt_download.filename }}" |
+          sha256sum --strict -c -
+  {{- end }}
 {{- end }}
 
   - action: run
@@ -62,18 +94,20 @@ actions:
       # path to unpacked qcom-ptool tarball
       QCOM_PTOOL="${ROOTDIR}/../qcom-ptool.tar.gz.d/qcom-ptool-main"
 
-{{- if eq $build_rb1 "true" }}
-      ## silicon family: qcm2290
-      # use RB1 rescue image as there are no qcm2290 boot binaries published
-      unzip -j "${ROOTDIR}/../qrb2210-rb1_rescue-image.zip" \
-          -d build/qrb2210-rb1_rescue-image
+{{- range $board := $boards }}
+      ### board: {{ $board.name }}
+      ### platform: {{ $board.platform }}
+      ### silicon family: {{ $board.silicon_family }}
+
+      # unpack boot binaries
+      unzip -j "${ROOTDIR}/../{{ $board.boot_binaries_download.filename }}" \
+          -d build/{{ $board.name }}_boot-binaries
 
-      ### platform: qrb2210-rb1
       # generate partition files
-      mkdir -v build/qrb2210-rb1_partitions
+      mkdir -v build/{{ $board.platform }}_partitions
       (
-          cd build/qrb2210-rb1_partitions
-          conf="${QCOM_PTOOL}/platforms/qrb2210-rb1/partitions.conf"
+          cd build/{{ $board.platform }}_partitions
+          conf="${QCOM_PTOOL}/platforms/{{ $board.platform }}/partitions.conf"
           "${QCOM_PTOOL}/gen_partition.py" -i "$conf" \
               -o ptool-partitions.xml
           # partitions.conf sets --type=emmc, nand or ufs
@@ -85,12 +119,12 @@ actions:
           "${QCOM_PTOOL}/ptool.py" -x ptool-partitions.xml
       )
 
-      #### board: qrb2210-rb1
-      flash_dir="${ARTIFACTDIR}/flash_qrb2210-rb1"
+      # create board-specific flash directory
+      flash_dir="${ARTIFACTDIR}/flash_{{ $board.name }}"
       rm -rf "${flash_dir}"
       mkdir -v "${flash_dir}"
       # copy platform partition files
-      cp --preserve=mode,timestamps -v build/qrb2210-rb1_partitions/* \
+      cp --preserve=mode,timestamps -v build/{{ $board.platform }}_partitions/* \
           "${flash_dir}"
       # remove BLANK_GPT and WIPE_PARTITIONS files as it's common for people
       # to run "qdl rawprogram*.xml", mistakingly including these; perhaps
@@ -100,7 +134,7 @@ actions:
       rm -v "${flash_dir}"/rawprogram*_WIPE_PARTITIONS.xml
       # copy silicon family boot binaries; these shouldn't ship partition
       # files, but make sure not to accidentally clobber any such file
-      find build/qrb2210-rb1_rescue-image \
+      find build/{{ $board.name }}_boot-binaries \
           -not -name 'gpt_*' \
           -not -name 'patch*.xml' \
           -not -name 'rawprogram*.xml' \
@@ -116,96 +150,28 @@ actions:
               -or -name '*.mbn' \
           \) \
           -exec cp --preserve=mode,timestamps -v '{}' "${flash_dir}" \;
-      # copy RB1 U-Boot binary to boot.img;
+      {{- if $board.u_boot_file }}
+      # copy U-Boot binary to boot.img;
       # qcom-ptool/platforms/*/partitions.conf uses filename=boot.img
       # boot_a and boot_b partitions
-      cp --preserve=mode,timestamps -v "${ARTIFACTDIR}/{{- .u_boot_rb1 -}}" \
+      cp --preserve=mode,timestamps -v "${ARTIFACTDIR}/{{ $board.u_boot_file }}" \
           "${flash_dir}/boot.img"
+      {{- end }}
 
-      # update flashing files for ESP image;
-      # qcom-ptool/platforms/*/partitions.conf uses filename=efi.bin for the
-      # ESP partition on EFI capable platforms
-      sed -i '/label="efi"/s#filename="[^"]*"#filename="../disk-sdcard.img1"#' \
-          "${flash_dir}"/rawprogram*.xml
-
-      # update flashing files for rootfs image;
-      # qcom-ptool/platforms/*/partitions.conf uses filename=rootfs.img for the
-      # rootfs partition
-      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 }}
-
-{{- if eq $build_qcm6490 "true" }}
-      ## silicon family: qcm6490
-      # unpack boot binaries
-      unzip -j "${ROOTDIR}/../qcm6490_boot-binaries.zip" \
-          -d build/qcm6490_boot-binaries
-
-      ### platform: qcs6490-rb3gen2
-      # generate partition files
-      mkdir -v build/qcs6490-rb3gen2_partitions
-      (
-          cd build/qcs6490-rb3gen2_partitions
-          conf="${QCOM_PTOOL}/platforms/qcs6490-rb3gen2/partitions.conf"
-          "${QCOM_PTOOL}/gen_partition.py" -i "$conf" \
-              -o ptool-partitions.xml
-          # 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
-      )
-      #### board qcs6490-rb3gen2-vision-kit
-      flash_dir="${ARTIFACTDIR}/flash_qcs6490-rb3gen2-vision-kit"
-      rm -rf "${flash_dir}"
-      mkdir -v "${flash_dir}"
-      # copy platform partition files
-      cp --preserve=mode,timestamps -v build/qcs6490-rb3gen2_partitions/* \
-          "${flash_dir}"
-      # remove BLANK_GPT and WIPE_PARTITIONS files as it's common for people
-      # to run "qdl rawprogram*.xml", mistakingly including these; perhaps
-      # ptool should have a flag not to generate these; note that there are
-      # wipe_rawprogram*.xml files still
-      rm -v "${flash_dir}"/rawprogram*_BLANK_GPT.xml
-      rm -v "${flash_dir}"/rawprogram*_WIPE_PARTITIONS.xml
-      # copy silicon family boot binaries; these shouldn't ship partition
-      # files, but make sure not to accidentally clobber any such file
-      find build/qcm6490_boot-binaries \
-          -not -name 'gpt_*' \
-          -not -name 'patch*.xml' \
-          -not -name 'rawprogram*.xml' \
-          -not -name 'wipe*.xml' \
-          -not -name 'zeros_*' \
-          \( \
-              -name LICENSE \
-              -or -name Qualcomm-Technologies-Inc.-Proprietary \
-              -or -name 'prog_*' \
-              -or -name '*.bin' \
-              -or -name '*.elf' \
-              -or -name '*.fv' \
-              -or -name '*.mbn' \
-          \) \
-          -exec cp --preserve=mode,timestamps -v '{}' "${flash_dir}" \;
+      {{- if $board.cdt_download }}
       # unpack board CDT
-      unzip -j "${ROOTDIR}/../qcs6490-rb3gen2-vision-kit_cdt.zip" \
-          -d build/qcs6490-rb3gen2-vision-kit_cdt
+      unzip -j "${ROOTDIR}/../{{ $board.cdt_download.filename }}" \
+          -d build/{{ $board.name }}_cdt
       # copy just the CDT data; no partition or flashing files
-      cp --preserve=mode,timestamps -v build/qcs6490-rb3gen2-vision-kit_cdt/cdt_vision_kit.bin \
+      cp --preserve=mode,timestamps -v build/{{ $board.name }}_cdt/{{ $board.cdt_filename }} \
           "${flash_dir}"
 
       # update flashing files for CDT
-      sed -i '/label="cdt"/s/filename=""/filename="cdt_vision_kit.bin"/' \
+      sed -i '/label="cdt"/s/filename=""/filename="{{ $board.cdt_filename }}"/' \
           "${flash_dir}"/rawprogram*.xml
+      {{- end }}
 
+      {{- if $board.dtb }}
       # generate a dtb.bin FAT partition with just a single dtb for the current
       # board; long-term this should really be a set of dtbs and overlays as to
       # share dtb.bin across boards
@@ -218,28 +184,24 @@ actions:
       # in these and hold the target device tree, which is 4096 KiB sized
       # blocks for mkfs.vfat's last argument
       mkfs.vfat -S 4096 -C "${dtb_bin}" 4096
-      # RB3 Gen2 Vision Kit will probably have a more specific DTB (see
-      # <20241204100003.300123-6-quic_vikramsa@quicinc.com> on lore.kernel.org)
-      # but for now use the core kit one
-      dtb="qcom/qcs6490-rb3gen2.dtb"
       # extract board device tree from the root filesystem provided tarball
-      tar -C build -xvf "${ARTIFACTDIR}/dtbs.tar.gz" "${dtb}"
+      tar -C build -xvf "${ARTIFACTDIR}/dtbs.tar.gz" "{{ $board.dtb }}"
       # copy into the FAT as combined-dtb.dtb
-      mcopy -vmp -i "${dtb_bin}" "build/${dtb}" ::/combined-dtb.dtb
-
+      mcopy -vmp -i "${dtb_bin}" "build/{{ $board.dtb }}" ::/combined-dtb.dtb
       # (NB: flashing files already expect "dtb.bin" as a filename)
+      {{- end }}
 
       # update flashing files for ESP image;
       # qcom-ptool/platforms/*/partitions.conf uses filename=efi.bin for the
       # ESP partition on EFI capable platforms
-      sed -i '/label="efi"/s#filename="[^"]*"#filename="../disk-ufs.img1"#' \
+      sed -i '/label="efi"/s#filename="[^"]*"#filename="../disk-{{ $board.disk_image_type }}.img1"#' \
           "${flash_dir}"/rawprogram*.xml
 
       # update flashing files for rootfs image;
       # qcom-ptool/platforms/*/partitions.conf uses filename=rootfs.img for the
       # rootfs partition
       sed -i \
-          '/label="rootfs"/s#filename="[^"]*"#filename="../disk-ufs.img2"#' \
+          '/label="rootfs"/s#filename="[^"]*"#filename="../disk-{{ $board.disk_image_type }}.img2"#' \
           "${flash_dir}"/rawprogram*.xml
 {{- end }}
 
