qualcomm-linux-debian-flash.yaml

{{- $build_qcs615 := or .build_qcs615 "true" }}
{{- $build_qcm6490 := or .build_qcm6490 "true" }}
{{- $build_qcs8300 := or .build_qcs8300 "true" }}
{{- $build_qcs9100 := or .build_qcs9100 "true" }}
{{- $build_rb1 := "false" -}}
{{- if .u_boot_rb1 -}}
{{- $build_rb1 = "true" }}
{{- end -}}
{{- $buildid := or .buildid "" }}

{{- $target_boards := or .target_boards "all" }}

architecture: arm64

actions:
  - action: download
    description: Download qcom-ptool
    url: https://github.com/qualcomm-linux/qcom-ptool/archive/2caadb316227dc6cba4c2d5d8276f4b7d951599a.tar.gz
    name: qcom-ptool
    filename: qcom-ptool.tar.gz
    unpack: true

{{- $boards := list }}
{{- $boards = append $boards (dict
    "name" "glymur-crd"
    "silicon_family" "glymur"
    "ptool_platforms" (list "glymur-crd/nvme" "glymur-crd/spinor")
    "boot_binaries_download" (dict
        "description" "Glymur boot binaries"
        "url" "https://softwarecenter.qualcomm.com/nexus/generic/software/chip/qualcomm_linux-spf-0-0/qualcomm-linux-spf-0-0_test_device_public/r0.0_00009.0/glymur-le-0-0/common/build/bin/Glymur_bootbinaries.zip"
        "name" "glymur_boot-binaries"
        "filename" "glymur_boot-binaries.zip"
        "sha256sum" "79df8ab4cc3248472d819098d20829ab129828c19937525cfc16f089d65a7a42"
    )
    "cdt_download" (dict
        "description" "Glymur CRD CDT"
        "url" "https://artifacts.codelinaro.org/artifactory/codelinaro-le/Qualcomm_Linux/SC8480XP/cdt/sc8480xp-crd.zip"
        "name" "glymur-crd_cdt"
        "filename" "glymur-crd_cdt.zip"
        "sha256sum" "d694eedb0addcc5ee588d6993661cd23996fba1d1a43afc3b196dad12534bffc"
    )
    "cdt_filename" "CRD/cdt_glymur_crd_0.1.0.bin"
    "dtb" "qcom/glymur-crd.dtb"
)}}
{{- if eq $build_qcs615 "true" }}
{{- $boards = append $boards (dict
    "name" "qcs615-ride"
    "silicon_family" "qcs615"
    "ptool_platforms" (list "qcs615-ride/ufs")
    "boot_binaries_download" (dict
        "description" "QCS615 boot binaries"
        "url" "https://softwarecenter.qualcomm.com/nexus/generic/product/chip/software-product-family/Qualcomm_Linux.SPF.1.0/qualcomm_linux.spf.1.0-test-device-public/r1.0_00118.0/QCS615.LE.1.0/common/build/common/bin/QCS615_bootbinaries.zip"
        "name" "qcs615_boot-binaries"
        "filename" "qcs615_boot-binaries.zip"
        "sha256sum" "6730c26235880f469075acb62115c9e1e566979d1bf12f4a4c4ecf590c1d357e"
    )
    "cdt_download" (dict
        "description" "QCS615 Ride CDT"
        "url" "https://artifacts.codelinaro.org/artifactory/codelinaro-le/Qualcomm_Linux/QCS615/cdt/ADP_AIR_SA6155P_V2.zip"
        "name" "qcs615-ride_cdt"
        "filename" "qcs615-ride_cdt.zip"
        "sha256sum" "37d99eb113e286400bce0d70aa12a74d05f93d01f045bf67e7a46b3c606c8fd0"
    )
    "cdt_filename" "cdt_adp_air_sa6155p.bin"
    "dtb" "qcom/qcs615-ride.dtb"
)}}
{{- end }}
{{- if eq $build_qcm6490 "true" }}
{{- $boards = append $boards (dict
    "name" "qcs6490-rb3gen2-vision-kit"
    "silicon_family" "qcm6490"
    "ptool_platforms" (list "qcs6490-rb3gen2/ufs")
    "boot_binaries_download" (dict
        "description" "QCM6490 boot binaries"
        "url" "https://softwarecenter.qualcomm.com/nexus/generic/product/chip/software-product-family/Qualcomm_Linux.SPF.1.0/qualcomm_linux.spf.1.0-test-device-public/r1.0_00118.0/QCM6490.LE.1.0/common/build/ufs/bin/QCM6490_bootbinaries.zip"
        "name" "qcm6490_boot-binaries"
        "filename" "qcm6490_boot-binaries.zip"
        "sha256sum" "754598969a7ef6b2df448fb64d4d6b762415e8a8ea3c2a202c9a0e98a930f432"
    )
    "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"
)}}
{{- end }}
{{- if eq $build_qcs8300 "true" }}
{{- $boards = append $boards (dict
    "name" "qcs8300-ride"
    "silicon_family" "qcs8300"
    "ptool_platforms" (list "qcs8300-ride-sx/ufs")
    "boot_binaries_download" (dict
        "description" "QCS8300 boot binaries"
        "url" "https://softwarecenter.qualcomm.com/nexus/generic/product/chip/software-product-family/Qualcomm_Linux.SPF.1.0/qualcomm_linux.spf.1.0-test-device-public/r1.0_00118.0/QCS8300.LE.1.0/common/build/ufs/bin/QCS8300_bootbinaries.zip"
        "name" "qcs8300_boot-binaries"
        "filename" "qcs8300_boot-binaries.zip"
        "sha256sum" "e07ed2b58c639373e22c289873f1059a4ba48cfe41bd9ae2f9651884177b60c9"
    )
    "cdt_download" (dict
        "description" "QCS8300 Ride SX EVK CDT"
        "url" "https://artifacts.codelinaro.org/artifactory/codelinaro-le/Qualcomm_Linux/QCS8300/cdt/ride-sx.zip"
        "name" "qcs8300-ride-sx_cdt"
        "filename" "qcs8300-ride-sx_cdt.zip"
        "sha256sum" "d7fc667372b28383a36d586333097d84b9d9c104f4dd1845d33904e2d6b39f80"
    )
    "cdt_filename" "cdt_ride_sx.bin"
    "dtb" "qcom/qcs8300-ride.dtb"
)}}
{{- $boards = append $boards (dict
    "name" "monaco-evk"
    "silicon_family" "qcs8300"
    "ptool_platforms" (list "iq-8275-evk/emmc" "iq-8275-evk/ufs")
    "boot_binaries_download" (dict
        "description" "QCS8300 boot binaries"
        "url" "https://softwarecenter.qualcomm.com/nexus/generic/product/chip/software-product-family/Qualcomm_Linux.SPF.1.0/qualcomm_linux.spf.1.0-test-device-public/r1.0_00118.0/QCS8300.LE.1.0/common/build/ufs/bin/QCS8300_bootbinaries.zip"
        "name" "qcs8300_boot-binaries"
        "filename" "qcs8300_boot-binaries.zip"
        "sha256sum" "e07ed2b58c639373e22c289873f1059a4ba48cfe41bd9ae2f9651884177b60c9"
    )
    "cdt_download" (dict
        "description" "IQ-8275 EVK CDT"
        "url" "https://artifacts.codelinaro.org/artifactory/codelinaro-le/Qualcomm_Linux/QCS8300/cdt/qcs8275-iq-8275-evk-pro-sku.zip"
        "name" "iq8275-evk-pro_cdt"
        "filename" "qcs8275-iq-8275-evk-pro-sku.zip"
        "sha256sum" "cbe2009c8ef7dbacd716141bf01b8e1b26788c4a4f3145e60fe3b4a6b3aabc04"
    )
    "cdt_filename" "cdt_qcs8275_iq_8275_evk_pro_sku.bin"
    "dtb" "qcom/monaco-evk.dtb"
)}}
{{- $boards = append $boards (dict
    "name" "monaco-arduino-monza"
    "silicon_family" "qcs8300"
    "ptool_platforms" (list "qcs8275-monza/emmc")
    "boot_binaries_download" (dict
        "description" "QCS8300 boot binaries"
        "url" "https://softwarecenter.qualcomm.com/nexus/generic/product/chip/software-product-family/Qualcomm_Linux.SPF.1.0/qualcomm_linux.spf.1.0-test-device-public/r1.0_00118.0/QCS8300.LE.1.0/common/build/ufs/bin/QCS8300_bootbinaries.zip"
        "name" "qcs8300_boot-binaries"
        "filename" "qcs8300_boot-binaries.zip"
        "sha256sum" "e07ed2b58c639373e22c289873f1059a4ba48cfe41bd9ae2f9651884177b60c9"
    )
    "cdt_download" (dict
        "description" "Monza CDT"
        "url" "https://artifacts.codelinaro.org/artifactory/codelinaro-le/Qualcomm_Linux/QCS8300/cdt/qcs8275-Monza_v1.zip"
        "name" "qcs8275-monza_cdt"
        "filename" "qcs8275-monza.zip"
        "sha256sum" "8484beb2ac1ff74a129c586f6d5331536765975dbabfb0600509f11010ec1c41"
    )
    "cdt_filename" "cdt_qcs8275-Monza.bin"
    "dtb" "qcom/monaco-arduino-monza.dtb"
)}}
{{- end }}
{{- if eq $build_qcs9100 "true" }}
{{- $boards = append $boards (dict
    "name" "qcs9100-ride-r3"
    "silicon_family" "qcs9100"
    "ptool_platforms" (list "qcs9100-ride-sx/ufs")
    "boot_binaries_download" (dict
        "description" "QCS9100 boot binaries"
        "url" "https://softwarecenter.qualcomm.com/nexus/generic/product/chip/software-product-family/Qualcomm_Linux.SPF.1.0/qualcomm_linux.spf.1.0-test-device-public/r1.0_00118.0/QCS9100.LE.1.0/common/build/ufs/bin/QCS9100_bootbinaries.zip"
        "name" "qcs9100_boot-binaries"
        "filename" "qcs9100_boot-binaries.zip"
        "sha256sum" "df1b928a25f428f4c76a760be8a094104cec75cd5a6f758d9e3c62ad9be71c0c"
    )
    "cdt_download" (dict
        "description" "QCS9100 Ride Rev3 EVK CDT"
        "url" "https://artifacts.codelinaro.org/artifactory/codelinaro-le/Qualcomm_Linux/QCS9100/cdt/ride-sx_v3.zip"
        "name" "qcs9100-ride-sx-v3_cdt"
        "filename" "qcs9100-ride-sx-v3_cdt.zip"
        "sha256sum" "377a8405899ac82199deaf70bca3648c15b924a3fcef8f109555e661ed70f4b9"
    )
    "cdt_filename" "cdt_ride_sx.bin"
    "dtb" "qcom/qcs9100-ride-r3.dtb"
)}}
{{- $boards = append $boards (dict
    "name" "lemans-evk"
    "silicon_family" "qcs9075"
    "ptool_platforms" (list "iq-9075-evk/ufs")
    "boot_binaries_download" (dict
        "description" "QCS9100 boot binaries"
        "url" "https://softwarecenter.qualcomm.com/nexus/generic/product/chip/software-product-family/Qualcomm_Linux.SPF.1.0/qualcomm_linux.spf.1.0-test-device-public/r1.0_00118.0/QCS9100.LE.1.0/common/build/ufs/bin/QCS9100_bootbinaries.zip"
        "name" "qcs9100_boot-binaries"
        "filename" "qcs9100_boot-binaries.zip"
        "sha256sum" "df1b928a25f428f4c76a760be8a094104cec75cd5a6f758d9e3c62ad9be71c0c"
    )
    "cdt_download" (dict
        "description" "QCS9100 RB8 Core Kit CDT"
        "url" "https://artifacts.codelinaro.org/artifactory/codelinaro-le/Qualcomm_Linux/QCS9100/cdt/rb8_core_kit.zip"
        "name" "qcs9100-rb8-core-kit_cdt"
        "filename" "qcs9100-rb8-core-kit_cdt.zip"
        "sha256sum" "a252244f800d7c9e15883e12935af4113f9f2ecba6490e46cd9b943169f15bfa"
    )
    "cdt_filename" "cdt_rb8_core_kit.bin"
    "dtb" "qcom/lemans-evk.dtb"
)}}
{{- end }}
{{- if eq $build_rb1 "true" }}
{{- $boards = append $boards (dict
    "name" "qrb2210-rb1"
    "silicon_family" "qcm2290"
    "ptool_platforms" (list "qrb2210-rb1/emmc")
    "boot_binaries_download" (dict
        "description" "RB1 rescue image"
        "url" "https://artifacts.codelinaro.org/artifactory/clo-549-96boards-backup/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"
    )
    "u_boot_file" .u_boot_rb1
    "dtb" "qcom/qrb2210-rb1.dtb"
)}}
{{- end }}
{{- $boards = append $boards (dict
    "name" "qrb2210-arduino-imola"
    "silicon_family" "qcm2290"
    "ptool_platforms" (list "qrb2210-unoq/emmc-16GB")
    "boot_binaries_download" (dict
        "description" "UNO Q boot binaries"
        "url" "https://downloads.arduino.cc/debian-im/unoq-bootloader-emmc-linux-251020.zip"
        "name" "qrb2210-arduino-imola_boot-binaries"
        "filename" "qrb2210-arduino-imola_boot-binaries.zip"
        "sha256sum" "c606e95d0107f8c58d0dd9494e00624d1db7c4361cca20513bc78ef02ca28dd1"
    )
    "dtb" "qcom/qrb2210-arduino-imola.dtb"
)}}

{{- range $board := $boards }}
  - action: download
    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 SHA256 sum of {{ $board.boot_binaries_download.description }}
    chroot: false
    command:
      echo "{{ $board.boot_binaries_download.sha256sum }} ${ROOTDIR}/../{{ $board.boot_binaries_download.filename }}" |
          sha256sum --strict -c -
  {{- if $board.cdt_download }}
  - action: download
    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 SHA256 sum of {{ $board.cdt_download.description }}
    chroot: false
    command:
      echo "{{ $board.cdt_download.sha256sum }} ${ROOTDIR}/../{{ $board.cdt_download.filename }}" |
          sha256sum --strict -c -
  {{- end }}
{{- end }}

  - action: run
    description: Generate flash directories for eMMC and UFS boards
    chroot: false
    command: |
      set -eux
      # work dir that will be thrown away
      mkdir -v build

      # path to unpacked qcom-ptool tarball
      QCOM_PTOOL="$(ls -d "${ROOTDIR}/../qcom-ptool.tar.gz.d/qcom-ptool-"*)"

      # build a list of supported dtbs from the dtbs tarball
      dtbs_file="build/dtbs.txt"
      : >"${dtbs_file}"
      if [ -f "${ARTIFACTDIR}/dtbs.tar.gz" ]; then
          tar -tzf "${ARTIFACTDIR}/dtbs.tar.gz" --wildcards '*.dtb' \
              >>"$dtbs_file"
      fi

      # optional list of board names to build
      targets_file="build/targets.txt"
      rm -f "${targets_file}"
      case "{{ $target_boards }}" in
        all)
          # no override; build all possible boards (default)
          touch "${targets_file}"
{{- range $board := $boards }}
          echo "{{ $board.name }}" >>"${targets_file}"
{{- end }}
          ;;
        *)
          echo "{{ $target_boards }}" |
              tr ',' '\n' |
              sed '/^$/d' |
              sort -u >"${targets_file}"
          ;;
      esac

{{- range $board := $boards }}
      ### board: {{ $board.name }}
      ### silicon family: {{ $board.silicon_family }}

      # set skip_board if board isn't listed
      skip_board=false
      if ! grep -Fxq "{{ $board.name }}" "${targets_file}"; then
          skip_board=true
          echo "Skipping board {{ $board.name }}: not in target list"
      fi

      # set skip_board if board dtb isn't present
      if ! grep -Fxq "{{ $board.dtb }}" "${dtbs_file}"; then
          skip_board=true
          echo "Skipping board {{ $board.name }}: dtb not available"
      fi


      # unpack boot binaries
      mkdir -v build/{{ $board.name }}_boot-binaries
      unzip "${ROOTDIR}/../{{ $board.boot_binaries_download.filename }}" \
          -d build/{{ $board.name }}_boot-binaries/unpack
      # strip top directories
      mv build/{{ $board.name }}_boot-binaries/unpack/*/* build/{{ $board.name }}_boot-binaries
      rmdir -v build/{{ $board.name }}_boot-binaries/unpack/* build/{{ $board.name }}_boot-binaries/unpack

  {{- if $board.cdt_download }}
      if [ "${skip_board}" = false ]; then
          # unpack board CDT
          unzip "${ROOTDIR}/../{{ $board.cdt_download.filename }}" \
              -d build/{{ $board.name }}_cdt
      fi
  {{- end }}

{{- range $platform := $board.ptool_platforms }}
      ### platform: {{ $platform }}

      # generate ptool files - various XML files for flashing, GPT data etc.
      mkdir -vp build/ptool/{{ $platform }}
      (
          cd build/ptool/{{ $platform }}
          conf="${QCOM_PTOOL}/platforms/{{ $platform }}/partitions.conf"

          {{- if $board.cdt_download }}
          ../override-partition-conf.sh "{{ $board.cdt_filename }}" <"$conf" >partitions.conf
          {{- else }}
          ../override-partition-conf.sh "" <"$conf" >partitions.conf
          {{- end }}

          contents="${QCOM_PTOOL}/platforms/${PLATFORM}/contents.xml.in"
          # generate ptool-partitions.xml from partitions.conf
          "${QCOM_PTOOL}/gen_partition.py" -i partitions.conf \
              -o ptool-partitions.xml
          # generate contents.xml from ptool-partitions.xml and contents.xml.in
          if [ -e "$contents" ]; then
              "${QCOM_PTOOL}/gen_contents.py" -p ptool-partitions.xml \
                  -t "$contents" \
                  -b "{{$buildid}}" \
                  -o contents.xml
          fi
          # generate flashing files from qcom-partitions.xml
          "${QCOM_PTOOL}/ptool.py" -x ptool-partitions.xml
      )

      if [ "${skip_board}" = false ]; then
          disk_type=$(cat build/ptool/{{ $platform }}/disk_type)
          # create board-specific flash directory
          flash_dir="${ARTIFACTDIR}/flash_{{ $board.name }}_${disk_type}"
          rm -rf "${flash_dir}"
          mkdir -v "${flash_dir}"
          # copy platform partition files
          cp --preserve=mode,timestamps -v \
              build/ptool/{{ $platform }}/* "${flash_dir}"
          # adjust paths in contents.xml to use board-specific flash_* subdir
          if [ -e "${flash_dir}/contents.xml" ]; then
              # one set of backslashes for shell quoting, another one for sed
              # parsing
              windows_path=".\\\\flash_{{ $board.name }}_${disk_type}\\\\"
              linux_path="./flash_{{ $board.name }}_${disk_type}/"
              sed -i \
                  -e "s:<windows_root_path>.*:<windows_root_path>${windows_path}</windows_root_path>:" \
                  -e "s:<linux_root_path>.*:<linux_root_path>${linux_path}</linux_root_path>:" \
                  "${flash_dir}/contents.xml"
          fi
          # 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/{{ $board.name }}_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 'boot.img' \
                  -or -name '*.bin' \
                  -or -name '*.elf' \
                  -or -name '*.melf' \
                  -or -name '*.fv' \
                  -or -name '*.mbn' \
              \) \
              -exec cp --preserve=mode,timestamps -v '{}' "${flash_dir}" \;

          # remove the temporary disk_type file from the flash dir
          rm -f "${flash_dir}/disk_type"
      fi
  {{- if $board.u_boot_file }}
      if [ "${skip_board}" = false ]; then
          # 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}/{{ $board.u_boot_file }}" "${flash_dir}/boot.img"
      fi
  {{- end }}

  {{- if $board.cdt_download }}
      if [ "${skip_board}" = false ]; then
          # copy just the CDT data; no partition or flashing files
          cp --preserve=mode,timestamps -v \
              build/{{ $board.name }}_cdt/{{ $board.cdt_filename }} \
              "${flash_dir}"
      fi
  {{- end }}

      if [ "${skip_board}" = false ]; then
          # 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
          dtb_bin="${flash_dir}/dtb.bin"
          rm -f "${dtb_bin}"
          # dtb.bin is only used in UFS based boards at the moment and UFS
          # uses a 4k sector size, so pass -S 4096 in
          # qcom-ptool/platforms/*/partitions.conf, dtb_a and _b partitions
          # are provisioned with 64MiB; create a 4MiB FAT that will
          # comfortably fit 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
          # extract board device tree from the root filesystem provided
          # tarball
          tar -C build -xvf "${ARTIFACTDIR}/dtbs.tar.gz" "{{ $board.dtb }}"
          # copy into the FAT as combined-dtb.dtb
          mcopy -vmp -i "${dtb_bin}" "build/{{ $board.dtb }}" \
              ::/combined-dtb.dtb
      fi
{{- end }}
{{- end }}

      # cleanup
      rm -rf build

# Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
# SPDX-License-Identifier: BSD-3-Clause