boot: Fix UUU tagging, extend to fslc

Using the UUU-tagged bootloader image directly with UUU can cause UUU to hang. The bootloader image is split on a certain transmit size, and the hang occurs if the tag does not fit with the final bytes of the bootloader image and must be split into a new transmit package. The UUU tag is needed by UUU only in the SD Card image file itself so that UUU can find the end of the boot partition. Rework the design so the default bootloader and the default imx-boot binaries are not tagged. Also, extend the UUU tagging to fslc so it can gain the same benefit. Fixes: Freescale#1762 Fixes: nxp-imx/mfgtools#416 Signed-off-by: Tom Hochstein <[email protected]>
nxp-upstream · Sep 11, 2024 · c56330e · c56330e
1 parent 49709cd
commit c56330e
Show file tree

Hide file tree

Showing 11 changed files with 42 additions and 35 deletions.
diff --git a/classes/uuu_bootloader_tag.bbclass b/classes/uuu_bootloader_tag.bbclass
@@ -1,12 +1,15 @@
-# Append a tag to the bootloader image used in the SD card image. The tag
-# contains the size of the bootloader image so UUU can easily find the end of
-# the bootloader in the SD card image.
+# Create a tagged boot partition file for the SD card image file. The tag
+# contains the size of the boot partition image so UUU can easily find
+# the end of it in the SD card image file.
+# IMPORTANT: The tagged boot partition file should never be used directly with
+# UUU, as it can cause UUU to hang.
+
+IMX_BOOTPART_FILE                 = "imx-boot"
+IMX_BOOTPART_FILE:mx6-generic-bsp = "u-boot.${UBOOT_SUFFIX}"
+IMX_BOOTPART_FILE:mx7-generic-bsp = "u-boot.${UBOOT_SUFFIX}"
+
 do_deploy:append() {
-    if [ "${UUU_BOOTLOADER}" != "" ]; then
-        cp ${DEPLOYDIR}/${UUU_BOOTLOADER}   ${DEPLOYDIR}/${UUU_BOOTLOADER_TAGGED}
-        cp ${DEPLOYDIR}/${UUU_BOOTLOADER}   ${DEPLOYDIR}/${UUU_BOOTLOADER_UNTAGGED}
-        ln -sf ${UUU_BOOTLOADER_TAGGED}     ${DEPLOYDIR}/${UUU_BOOTLOADER}
-        stat -L -cUUUBURNXXOEUZX7+A-XY5601QQWWZ%sEND ${DEPLOYDIR}/${UUU_BOOTLOADER_TAGGED} \
-                                         >> ${DEPLOYDIR}/${UUU_BOOTLOADER_TAGGED}
-    fi
+    cp ${DEPLOYDIR}/${IMX_BOOTPART_FILE}         ${DEPLOYDIR}/${IMX_BOOTPART_FILE}.tagged
+    stat -L -cUUUBURNXXOEUZX7+A-XY5601QQWWZ%sEND ${DEPLOYDIR}/${IMX_BOOTPART_FILE}.tagged \
+                                              >> ${DEPLOYDIR}/${IMX_BOOTPART_FILE}.tagged
 }
diff --git a/conf/machine/include/imx-base.inc b/conf/machine/include/imx-base.inc
@@ -653,9 +653,9 @@ WKS_FILE_DEPENDS:append:imx-generic-bsp:mx9-generic-bsp = " \
     ${@oe.utils.ifelse(d.getVar('UBOOT_PROVIDES_BOOT_CONTAINER') == '0', 'imx-boot', '')} \
 "
 
-SOC_DEFAULT_WKS_FILE ?= "imx-uboot-bootpart.wks.in"
-SOC_DEFAULT_WKS_FILE:mx8-generic-bsp ?= "imx-imx-boot-bootpart.wks.in"
+SOC_DEFAULT_WKS_FILE                 ?= "imx-uboot-bootpart.wks.in"
 SOC_DEFAULT_WKS_FILE:mxs-generic-bsp ?= "imx-uboot-mxs-bootpart.wks.in"
+SOC_DEFAULT_WKS_FILE:mx8-generic-bsp ?= "imx-imx-boot-bootpart.wks.in"
 SOC_DEFAULT_WKS_FILE:mx9-generic-bsp ?= "imx-imx-boot-bootpart.wks.in"
 
 WKS_FILE ?= "${SOC_DEFAULT_WKS_FILE}"

diff --git a/recipes-bsp/imx-mkimage/imx-boot_1.0.bb b/recipes-bsp/imx-mkimage/imx-boot_1.0.bb
@@ -22,10 +22,6 @@ DEPENDS:append:mx93-generic-bsp = " u-boot-mkimage-native dtc-native"
 
 inherit deploy uuu_bootloader_tag
 
-UUU_BOOTLOADER        = "imx-boot"
-UUU_BOOTLOADER_TAGGED = "imx-boot-tagged"
-UUU_BOOTLOADER_UNTAGGED = "imx-boot-untagged"
-
 # Add CFLAGS with native INCDIR & LIBDIR for imx-mkimage build
 CFLAGS = "-O2 -Wall -std=c99 -I ${STAGING_INCDIR_NATIVE} -L ${STAGING_LIBDIR_NATIVE}"
 
@@ -398,7 +394,7 @@ do_deploy() {
         done
 
         # The first UBOOT_CONFIG listed will be the imx-boot binary
-        if [ ! -f "${DEPLOYDIR}/${UUU_BOOTLOADER}" ]; then
+        if [ ! -f "${DEPLOYDIR}/imx-boot" ]; then
             ln -sf ${BOOT_CONFIG_MACHINE_EXTRA}-${IMAGE_IMXBOOT_TARGET} ${DEPLOYDIR}/imx-boot
         else
             bbwarn "Use custom wks.in for $UBOOT_CONFIG = $type"

diff --git a/recipes-bsp/u-boot/u-boot-fslc_2024.07.bb b/recipes-bsp/u-boot/u-boot-fslc_2024.07.bb
@@ -6,7 +6,18 @@ order to provide support for some backported features and fixes, or because it \
 was submitted for revision and it takes some time to become part of a stable \
 version, or because it is not applicable for upstreaming."
 
-inherit ${@oe.utils.ifelse(d.getVar('UBOOT_PROVIDES_BOOT_CONTAINER') == '1', 'imx-boot-container', '')}
+# The UUU tag goes on the boot partition.
+# - If imx-boot-container.bbclass is used, then the boot partition image is uboot,
+#   and UUU-tagging is enabled
+# - Otherwise, for 6 and 7, the boot partition image is uboot, and UUU-tagging is
+#   enabled
+# - Otherwise, for 8+, the boot partition image is imx-boot, and UUU-tagging is
+#   disabled
+UUU_BOOTLOADER_TAG                 = ""
+UUU_BOOTLOADER_TAG:mx6-generic-bsp = "uuu_bootloader_tag"
+UUU_BOOTLOADER_TAG:mx7-generic-bsp = "uuu_bootloader_tag"
+inherit ${@oe.utils.ifelse(d.getVar('UBOOT_PROVIDES_BOOT_CONTAINER') == '1', \
+    'imx-boot-container uuu_bootloader_tag', '${UUU_BOOTLOADER_TAG}')}
 
 DEPENDS += "bc-native dtc-native python3-setuptools-native gnutls-native"
 

diff --git a/recipes-bsp/u-boot/u-boot-imx_2024.04.bb b/recipes-bsp/u-boot/u-boot-imx_2024.04.bb
@@ -7,17 +7,14 @@ require u-boot-imx-common_${PV}.inc
 
 PROVIDES += "u-boot u-boot-mfgtool"
 
-inherit uuu_bootloader_tag
-
-UUU_BOOTLOADER                          = ""
-UUU_BOOTLOADER:mx6-generic-bsp          = "${UBOOT_BINARY}"
-UUU_BOOTLOADER:mx7-generic-bsp          = "${UBOOT_BINARY}"
-UUU_BOOTLOADER_TAGGED                   = ""
-UUU_BOOTLOADER_TAGGED:mx6-generic-bsp   = "u-boot-tagged.${UBOOT_SUFFIX}"
-UUU_BOOTLOADER_TAGGED:mx7-generic-bsp   = "u-boot-tagged.${UBOOT_SUFFIX}"
-UUU_BOOTLOADER_UNTAGGED                 = ""
-UUU_BOOTLOADER_UNTAGGED:mx6-generic-bsp = "u-boot-untagged.${UBOOT_SUFFIX}"
-UUU_BOOTLOADER_UNTAGGED:mx7-generic-bsp = "u-boot-untagged.${UBOOT_SUFFIX}"
+# The UUU tag goes on the boot partition.
+# - For 6 and 7, the boot partition image is uboot, and UUU-tagging is enabled
+# - Otherwise, for 8+, the boot partition image is imx-boot, and UUU-tagging is
+#   disabled
+UUU_BOOTLOADER_TAG                 = ""
+UUU_BOOTLOADER_TAG:mx6-generic-bsp = "uuu_bootloader_tag"
+UUU_BOOTLOADER_TAG:mx7-generic-bsp = "uuu_bootloader_tag"
+inherit ${UUU_BOOTLOADER_TAG}
 
 do_deploy:append:mx8m-generic-bsp() {
     # Deploy u-boot-nodtb.bin and fsl-imx8m*-XX.dtb for mkimage to generate boot binary

diff --git a/wic/imx-imx-boot-bootpart.wks.in b/wic/imx-imx-boot-bootpart.wks.in
@@ -13,7 +13,7 @@
 # 0 |        8MiB          72MiB          72MiB + rootfs + IMAGE_EXTRA_SPACE (default 10MiB)
 #   ${IMX_BOOT_SEEK} 32 or 33kiB, see reference manual
 #
-part u-boot --source rawcopy --sourceparams="file=imx-boot" --ondisk mmcblk --no-table --align ${IMX_BOOT_SEEK}
+part u-boot --source rawcopy --sourceparams="file=${IMX_BOOTPART_FILE}.tagged" --ondisk mmcblk --no-table --align ${IMX_BOOT_SEEK}
 part /boot --source bootimg-partition --ondisk mmcblk --fstype=vfat --label boot --active --align 8192 --size 64
 part / --source rootfs --ondisk mmcblk --fstype=ext4 --label root --align 8192
 

diff --git a/wic/imx-imx-boot.wks.in b/wic/imx-imx-boot.wks.in
@@ -13,7 +13,7 @@
 # 0 |        8MiB            8MiB + rootfs + IMAGE_EXTRA_SPACE (default 10MiB)
 #   ${IMX_BOOT_SEEK} 32 or 33kiB, see reference manual
 #
-part u-boot --source rawcopy --sourceparams="file=imx-boot" --ondisk mmcblk --no-table --align ${IMX_BOOT_SEEK}
+part u-boot --source rawcopy --sourceparams="file=${IMX_BOOTPART_FILE}.tagged" --ondisk mmcblk --no-table --align ${IMX_BOOT_SEEK}
 part / --source rootfs --ondisk mmcblk --fstype=ext4 --label root --align 8192
 
 bootloader --ptable msdos
diff --git a/wic/imx-uboot-bootpart.wks.in b/wic/imx-uboot-bootpart.wks.in
@@ -12,7 +12,7 @@
 # | |         |              |
 # 0 1kiB    4MiB          16MiB + rootfs + IMAGE_EXTRA_SPACE (default 10MiB)
 #
-part u-boot --source rawcopy --sourceparams="file=${UBOOT_BINARY}" --ondisk mmcblk --no-table --align 1
+part u-boot --source rawcopy --sourceparams="file=${IMX_BOOTPART_FILE}.tagged" --ondisk mmcblk --no-table --align 1
 part /boot --source bootimg-partition --ondisk mmcblk --fstype=vfat --label boot --active --align 4096 --size 16
 part / --source rootfs --ondisk mmcblk --fstype=ext4 --label root --align 4096
 

diff --git a/wic/imx-uboot-spl-bootpart.wks.in b/wic/imx-uboot-spl-bootpart.wks.in
@@ -13,7 +13,7 @@
 # 0 1kiB  69kiB   4MiB          16MiB + rootfs + IMAGE_EXTRA_SPACE (default 10MiB)
 #
 part SPL --source rawcopy --sourceparams="file=SPL" --ondisk mmcblk --no-table --align 1
-part u-boot --source rawcopy --sourceparams="file=${UBOOT_BINARY}" --ondisk mmcblk --no-table --align 69
+part u-boot --source rawcopy --sourceparams="file=${IMX_BOOTPART_FILE}.tagged" --ondisk mmcblk --no-table --align 69
 part /boot --source bootimg-partition --ondisk mmcblk --fstype=vfat --label boot --active --align 4096 --size 16
 part / --source rootfs --ondisk mmcblk --fstype=ext4 --label root --align 4096
 

diff --git a/wic/imx-uboot-spl.wks.in b/wic/imx-uboot-spl.wks.in
@@ -13,7 +13,7 @@
 # 0 1kiB  69kiB   4MiB + rootfs + IMAGE_EXTRA_SPACE (default 10MiB)
 #
 part SPL --source rawcopy --sourceparams="file=SPL" --ondisk mmcblk --no-table --align 1
-part u-boot --source rawcopy --sourceparams="file=${UBOOT_BINARY}" --ondisk mmcblk --no-table --align 69
+part u-boot --source rawcopy --sourceparams="file=${IMX_BOOTPART_FILE}.tagged" --ondisk mmcblk --no-table --align 69
 part / --source rootfs --ondisk mmcblk --fstype=ext4 --label root --align 4096
 
 bootloader --ptable msdos
diff --git a/wic/imx-uboot.wks b/wic/imx-uboot.wks
@@ -12,7 +12,7 @@
 # | |         |              |
 # 0 1kiB    4MiB + rootfs + IMAGE_EXTRA_SPACE (default 10MiB)
 #
-part u-boot --source rawcopy --sourceparams="file=u-boot.imx" --ondisk mmcblk --no-table --align 1
+part u-boot --source rawcopy --sourceparams="file=${IMX_BOOTPART_FILE}.tagged" --ondisk mmcblk --no-table --align 1
 part / --source rootfs --ondisk mmcblk --fstype=ext4 --label root --align 4096
 
 bootloader --ptable msdos