Skip to content

XM: take the split firmware.bin when a board publishes no fixed-slot package #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
widgetii merged 1 commit into from
Oct 30, 2026
Merged

XM: take the split firmware.bin when a board publishes no fixed-slot package #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 37 additions & 4 deletions .github/workflows/_xm2oipc.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,6 @@ SOC="${SOC:-hi3516ev200}"
[[ ${SENSOR} ]] && SENSOR="sensor=${SENSOR}"

FLASH_SIZE="${FLASH_SIZE:-0x800000}"
ROOTFS_DATA="${ROOTFS_DATA:-$(($FLASH_SIZE - $ROOTFS_E ))}"

WORKDIR="workdir"
OUTPUTDIR="${OUTPUTDIR:-..}"
Expand All @@ -118,10 +117,44 @@ IFS=" "
mkdir -p ${WORKDIR}
mkdir -p ${OUTPUTDIR}

tar -xvz -f openipc.${SOC}-nor-${RELEASE:-lite}.tgz -C ${WORKDIR}/ --exclude "*.md5sum" || exit 1
PACKAGE=openipc.${SOC}-nor-${RELEASE:-lite}
if [ -f ${PACKAGE}.tgz ]; then
tar -xvz -f ${PACKAGE}.tgz -C ${WORKDIR}/ --exclude "*.md5sum" || exit 1

# Check if give files exceed partition boundaries
[[ $(stat --printf="%s" ${WORKDIR}/rootfs*) -gt $(($ROOTFS_E - $ROOTFS_A)) ]] || [[ $(stat --printf="%s" ${WORKDIR}/uImage*) -gt $(($KERNEL_E - $KERNEL_A)) ]] && echo "Filesize exceeds boundaries" && exit 1
elif [ -f ${PACKAGE}-split.tgz ]; then
# The split NOR layout (OpenIPC/firmware#2668): firmware.bin is the uImage,
# padded to 64 KiB, then the squashfs, written whole at the kernel's address.
# The kernel finds the squashfs after itself and takes rootfs_data from the
# rest of the chip, whatever mtdparts and root= the env below passes, so a
# board ships this once its rootfs outgrows the fixed slot. It is burned as
# the same two images as the fixed slots, cut at the squashfs, which lands
# firmware.bin on the flash byte for byte; only the boundaries move.
tar -xvz -f ${PACKAGE}-split.tgz -C ${WORKDIR}/ --exclude "*.md5sum" || exit 1
FIRMWARE=$(ls ${WORKDIR}/firmware.bin*)
FIRMWARE_SIZE=$(stat --printf="%s" ${FIRMWARE})
# The uImage header's data size (bytes 12..15, big-endian), plus the 64-byte
# header, in whole 64 KiB blocks: where the squashfs starts.
[ "$(od -An -tx1 -N4 ${FIRMWARE} | tr -d ' \n')" = "27051956" ] || { echo "${FIRMWARE} does not start with a uImage"; exit 1; }
KERNEL_BLOCKS=$(( (64 + 0x$(od -An -tx1 -j12 -N4 ${FIRMWARE} | tr -d ' \n') + 0xFFFF) / 0x10000 ))
# The bootcmd reads 2 MiB from the kernel's address; the firmware build
# checks the uImage against that, and so does this.
[ $((KERNEL_BLOCKS * 0x10000)) -le $(($KERNEL_E - $KERNEL_A)) ] || { echo "Filesize exceeds boundaries"; exit 1; }
ROOTFS_A=$(printf "0x%x" $(($KERNEL_A + KERNEL_BLOCKS * 0x10000)))
KERNEL_E=${ROOTFS_A}
ROOTFS_E=$(printf "0x%x" $(( ($KERNEL_A + FIRMWARE_SIZE + 0xFFFF) / 0x10000 * 0x10000 )))
# The firmware build leaves at least 256 KiB of rootfs_data; so does this.
[ $(($ROOTFS_E + 0x40000)) -le $(($FLASH_SIZE)) ] || { echo "Filesize exceeds boundaries"; exit 1; }
head -c $((KERNEL_BLOCKS * 0x10000)) ${FIRMWARE} > ${WORKDIR}/uImage
tail -c +$((KERNEL_BLOCKS * 0x10000 + 1)) ${FIRMWARE} > ${WORKDIR}/rootfs.squashfs
rm -f ${FIRMWARE}
else
echo "Neither ${PACKAGE}.tgz nor ${PACKAGE}-split.tgz is here"
exit 1
fi

# Check if give files exceed partition boundaries
[[ $(stat --printf="%s" ${WORKDIR}/rootfs*) -gt $(($ROOTFS_E - $ROOTFS_A)) ]] || [[ $(stat --printf="%s" ${WORKDIR}/uImage*) -gt $(($KERNEL_E - $KERNEL_A)) ]] && echo "Filesize exceeds boundaries" && exit 1
ROOTFS_DATA="${ROOTFS_DATA:-$(($FLASH_SIZE - $ROOTFS_E ))}"

# Generate Readme
README=$(cat <<-EOF
Expand Down
51 changes: 29 additions & 22 deletions .github/workflows/xm.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,30 +29,37 @@ jobs:
- name: Checkout
uses: actions/checkout@v2.3.4
- name: Fetch OpenIPC release
# A board whose rootfs outgrows its fixed slot publishes only the
# -split package (OpenIPC/firmware#2666); _xm2oipc.sh takes whichever
# of the two is here, the fixed-slot one first.
run: |
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.hi3516cv100-nor-lite.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.hi3518cv100-nor-lite.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.hi3518ev100-nor-lite.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.hi3516cv200-nor-lite.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.hi3516dv100-nor-lite.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.hi3518ev200-nor-lite.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.hi3516cv300-nor-lite.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.hi3516ev100-nor-lite.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.hi3516ev300-nor-lite.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.hi3518ev300-nor-lite.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.hi3516ev200-nor-lite.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.hi3536cv100-nor-lite.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.hi3536dv100-nor-lite.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.gk7201v200-nor-lite.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.gk7205v200-nor-lite.tgz
for soc in hi3516cv100 \
hi3518cv100 \
hi3518ev100 \
hi3516cv200 \
hi3516dv100 \
hi3518ev200 \
hi3516cv300 \
hi3516ev100 \
hi3516ev300 \
hi3518ev300 \
hi3516ev200 \
hi3536cv100 \
hi3536dv100 \
gk7201v200 \
gk7205v200 \
gk7205v300 \
gk7605v100 \
gk7205v500 \
xm530 \
xm510 \
nt98562 \
nt98566; do
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.$soc-nor-lite.tgz ||
echo "openipc.$soc-nor-lite.tgz is not published"
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.$soc-nor-lite-split.tgz || true
done
# wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.gk7205v200-nor-fpv.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.gk7205v300-nor-lite.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.gk7605v100-nor-lite.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.gk7205v500-nor-lite.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.xm530-nor-lite.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.xm510-nor-lite.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.nt98562-nor-lite.tgz
wget -q https://github.com/OpenIPC/firmware/releases/download/latest/openipc.nt98566-nor-lite.tgz
- name: Create firmwares
run: |
export RUN="$GITHUB_WORKSPACE/.github/workflows/_xm2oipc.sh"
Expand Down