fix(debos/flash): Pack SPI-NOR under respective target-storage directory

- Place platform *_spinor directories under the corresponding
  target storage directory (emmc/ufs/nvme).
- Rename SPI-NOR filenames and paths in spinor/content.xml to
  match the respective images.
- Update the README to mention required build dependencies.
- Centralize the disk-type detection logic into get-rawprogram-filename.

Signed-off-by: Vishwas Udupa <vudupa@qti.qualcomm.com>

Author: vishwasudupa

.github/workflows/debos.yml

@@ -72,7 +72,7 @@ jobs:
 
       # mtools is needed for the flash recipe
       - name: Install debos and dependencies of the recipes and local tests
-        run: apt -y install debian-archive-keyring debos make mmdebstrap mtools python3-pexpect python3-pytest qemu-efi-aarch64 qemu-system-arm
+        run: apt -y install debian-archive-keyring debos make mmdebstrap mtools python3-pexpect python3-pytest qemu-efi-aarch64 qemu-system-arm xmlstarlet python3-defusedxml
 
       - name: Setup local APT repo
         run: |

.github/workflows/static-checks.yml

@@ -39,7 +39,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Install Pylint and dependencies
-        run: sudo apt update && sudo apt -y install file pylint python3-voluptuous
+        run: sudo apt update && sudo apt -y install file pylint python3-voluptuous python3-defusedxml
 
       - uses: actions/checkout@v6
         with:

README.md

@@ -79,6 +79,12 @@ scripts/build-linux-deb.py --linux-next kernel-configs/*.config
 
 ### Build the image
 
+Building the image requires the following build-dependencies:
+
+```bash
+apt -y install debian-archive-keyring make mmdebstrap mtools python3-pexpect python3-pytest qemu-efi-aarch64 qemu-system-arm xmlstarlet python3-defusedxml
+```
+
 To build flashable assets for all supported boards, follow these steps:
 
 1. build tarballs of the root filesystem and DTBs

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

@@ -439,6 +439,35 @@ actions:
       fi
 {{- end }}
 
+      # copy each spinor flash dir into its parent storage flash dirs;
+      # storage types are read from product_info/chipid in contents.xml
+      for spinor_dir in "${ARTIFACTDIR}"/flash_*_spinor; do
+          contents_xml="${spinor_dir}/contents.xml"
+          [ -f "${contents_xml}" ] || continue
+          spinor_dir_name="$(basename "${spinor_dir}")"
+          board="${spinor_dir_name#flash_}"; board="${board%_spinor}"
+          xmlstarlet sel -t -m "//product_info/chipid" -v "@storage_type" -n "${contents_xml}" | \
+              tr '[:upper:]' '[:lower:]' | sort -u | \
+              while read -r storage; do
+                  [ "${storage}" = "spinor" ] && continue
+                  target_dir="${ARTIFACTDIR}/flash_${board}_${storage}"
+                  [ -d "${target_dir}" ] || continue
+                  cp --preserve=all --no-dereference -av "${spinor_dir}/." "${target_dir}/spinor/"
+                  efi_img=$("${RECIPEDIR}/../scripts/get-rawprogram-filename.py" efi "${target_dir}/rawprogram0.xml")
+                  rootfs_img=$("${RECIPEDIR}/../scripts/get-rawprogram-filename.py" rootfs "${target_dir}/rawprogram0.xml")
+                  # fix file_path (../->../../) then rename efi.bin/rootfs.img
+                  copied_contents="${target_dir}/spinor/contents.xml"
+                  if [ -f "${copied_contents}" ]; then
+                      xmlstarlet ed -L \
+                          -u "//*[@storage_type='${storage}'][file_name/text()='efi.bin']/file_path[text()='../']" -v "../../" \
+                          -u "//*[@storage_type='${storage}']/file_name[text()='efi.bin']" -v "${efi_img}" \
+                          -u "//*[@storage_type='${storage}'][file_name/text()='rootfs.img']/file_path[text()='../']" -v "../../" \
+                          -u "//*[@storage_type='${storage}']/file_name[text()='rootfs.img']" -v "${rootfs_img}" \
+                          "${copied_contents}"
+                  fi
+              done
+      done
+
       # cleanup
       rm -rf build
 

scripts/bundle-flash-dirs.sh

@@ -15,11 +15,12 @@ for d in flash_*
 do
     rawprogram0="$d/rawprogram0.xml"
     echo "examining $rawprogram0"
-    if grep disk-sdcard "$rawprogram0"
+    rootfs_img=$("$(dirname "$0")"/get-rawprogram-filename.py rootfs "$rawprogram0")
+    if echo "$rootfs_img" | grep -q disk-sdcard
     then
         echo "choosing emmc"
         target=emmc
-    elif grep disk-ufs "$rawprogram0"
+    elif echo "$rootfs_img" | grep -q disk-ufs
     then
         echo "choosing ufs"
         target=ufs

scripts/get-rawprogram-filename.py

@@ -0,0 +1,34 @@
+#!/usr/bin/env python3
+# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+# SPDX-License-Identifier: BSD-3-Clause
+#
+# Print the filename attribute of a <program> element by label from a
+# rawprogram XML file generated by qcom-ptool.
+#
+# Usage:  get-rawprogram-filename.py <label> <rawprogram0.xml>
+#
+# Example:
+#   $ python3 get-rawprogram-filename.py rootfs rawprogram0.xml
+#   disk-ufs.img2
+
+import sys
+import defusedxml.ElementTree as ET
+
+if len(sys.argv) != 3:
+    print(f"Usage: {sys.argv[0]} <label> <rawprogram0.xml>", file=sys.stderr)
+    sys.exit(1)
+
+label, xml_file = sys.argv[1], sys.argv[2]
+
+root = ET.parse(xml_file).getroot()
+e = root.find(f".//program[@label='{label}']")
+if e is None:
+    print(f"error: no <program label='{label}'> found in {xml_file}",
+          file=sys.stderr)
+    sys.exit(1)
+
+filename = e.get("filename")
+# Strip any leading ../ path components
+while filename.startswith("../"):
+    filename = filename[3:]
+print(filename)