| Message ID | 20240512022815.39350-1-twoerner@gmail.com |
|---|---|
| State | New |
| Headers | show |
| Series | [meta-rockchip,v6] enable stored U-Boot environment | expand |
Hi Trevor, On 5/12/24 4:28 AM, Trevor Woerner via lists.yoctoproject.org wrote: > U-Boot has the ability to store its environment variables to a permanent > storage device. Whether or not it does so for any one specific device > depends on whatever settings are enabled in that specific device's > defconfig. In order to definitively configure U-Boot to be able to store > its environment into the device from which it boots, for any device > supported in this BSP, simply add the following to MACHINE_FEATURES: > > rk-u-boot-env > > If enabled, there is now a second choice to make: should the build also > include the U-Boot environment in the image or not? The default environment, > as generated by U-Boot, can be included in the generated wic image. If it > is included, then flashing the image will also flash the default U-Boot > environment variables and settings, wiping out anything that might have been > there already. If it is not included then your device will either continue > using whatever environment happens to be there (if valid), or will not use any > stored environment if the stored environment has not been set or is invalid. > The variable which governs this behaviour is: > > RK_IMAGE_INCLUDES_UBOOT_ENV > > By default this is set to "0", meaning that by default the image does not > contain the U-Boot environment. To enable this behaviour, enable this > variable. This variable only takes effect if rk-u-boot-env is listed in > MACHINE_FEATURES, and has no effect otherwise. > > The script: > > scripts/dump-uboot-env-from-yocto-image.sh > > can be used on a rockchip wic image to see the contents of the U-Boot > environment partition at build time. > > Tested by booting the same image on both eMMC and SDcard with the following > devices, verifying the ability to read and write the U-Boot environment in > both U-Boot and Linux user-space, and that changes made in one are seen in the > other: > rock-3a > rock-5a > rock-5b > rock-pi-4b > rock-pi-e > rock64 > > Signed-off-by: Trevor Woerner <twoerner@gmail.com> > --- > v6 changes: > - separate out the MACHINEOVERRIDES handling into its own include so > that it can be included more flexibly into different scenarios; i.e. > rock2-square build was failing because it is not wic-based > > v5 changes: > - fix a bug in v4 to handle RK_IMAGE_INCLUDES_UBOOT_ENV correctly in the > bash test in postfuncs of u-boot bbappend > - add extra check in do_deploy() of u-boot bbappend to only copy the > environment if RK_IMAGE_INCLUDES_UBOOT_ENV is true > > v4 changes: > - sort WICVARS alphabetically > - tweak dump-uboot-env-from-yocto-image.sh script to not just check for > the existence of the user-supplied parameter, but that it is a file > specifically > - u-boot bbappend: > - use a do_compile[postfuncs] for generating the fw_env.config instead of > a do_compile:append > - move the conversion of the U-Boot text-based environment to the > require binary representation from a do_deploy:append to the newly-created > do_compile[postfuncs] created above, this will allow the user to inject > any extra U-Boot environment variables they might wish as part of a > do_compile:append and have that occur before the binary is generated > so that those additional user-supplied values are included > - add a lot of extra checking (instead of assuming various resources exist) > before making use of said resources > > v3 changes: > - switch from using a bbclass so the `rk-u-boot-env` override can be used > directly > - add SPDX header to script > - drop `inherit deploy` in U-Boot bbappend > > v2 changes: > - re-word the commit message and README for clarity > - use bash's built-in math handling instead of depending on `bc` > - in anticipation of the upcoming feature in U-Boot whereby rockchip > devices can automatically select the environment storage device to be > the same as the boot device, use a more recent SRCREV for builds that do > environment handling, instead of hardcoding the environment storage device > by SoC family > - handle RK_IMAGE_INCLUDES_UBOOT_ENV as a boolean > --- > README | 20 ++++++++++ > .../include/rockchip-rk-u-boot-env.inc | 4 ++ > conf/machine/include/rockchip-wic.inc | 7 ++++ > conf/machine/rock2-square.conf | 2 +- > .../rockchip-enable-environment-mmc.cfg | 6 +++ > recipes-bsp/u-boot/u-boot_%.bbappend | 40 +++++++++++++++++++ > scripts/dump-uboot-env-from-yocto-image.sh | 29 ++++++++++++++ > wic/rockchip.wks | 2 +- > 8 files changed, 108 insertions(+), 2 deletions(-) > create mode 100644 conf/machine/include/rockchip-rk-u-boot-env.inc > create mode 100644 recipes-bsp/u-boot/files/rk-u-boot-env/rockchip-enable-environment-mmc.cfg > create mode 100755 scripts/dump-uboot-env-from-yocto-image.sh > > diff --git a/README b/README > index c76fc9131276..605773d4ecd3 100644 > --- a/README > +++ b/README > @@ -67,6 +67,26 @@ Notes: > > in the configuration (e.g. conf/local.conf). > > +U-Boot Environment: > +------------------ > + In order to configure U-Boot to be able to store its environment into the > + device from which it was booted, for any device supported in this BSP, > + simply add the following to MACHINE_FEATURES: > + > + rk-u-boot-env > + > + If enabled, to additionally have the U-Boot environment generated and > + stored in the image, also enable the following variable (default: off): > + > + RK_IMAGE_INCLUDES_UBOOT_ENV > + > + The script: > + > + scripts/dump-uboot-env-from-yocto-image.sh > + > + can be used on a rockchip wic image to see the contents of the U-Boot > + environment partition at build time. > + > Maintenance: > ----------- > Please send pull requests, patches, comments, or questions to the > diff --git a/conf/machine/include/rockchip-rk-u-boot-env.inc b/conf/machine/include/rockchip-rk-u-boot-env.inc > new file mode 100644 > index 000000000000..4eb877f77c48 > --- /dev/null > +++ b/conf/machine/include/rockchip-rk-u-boot-env.inc > @@ -0,0 +1,4 @@ > +# 'rk-u-boot-env' indicates the user wants to be able to save their U-Boot > +# environment back to the drive from which the device was booted > +MACHINEOVERRIDES .= "${@bb.utils.contains('MACHINE_FEATURES', 'rk-u-boot-env', ':rk-u-boot-env', '', d)}" > +IMAGE_INSTALL:append:rk-u-boot-env = " u-boot-fw-utils u-boot-env" > diff --git a/conf/machine/include/rockchip-wic.inc b/conf/machine/include/rockchip-wic.inc > index 147a36685d7d..1f662116d7cf 100644 > --- a/conf/machine/include/rockchip-wic.inc > +++ b/conf/machine/include/rockchip-wic.inc > @@ -1,6 +1,7 @@ > # common meta-rockchip wic/wks items > > require conf/machine/include/rockchip-extlinux.inc > +require conf/machine/include/rockchip-rk-u-boot-env.inc > > SPL_BINARY ?= "idbloader.img" > > @@ -11,7 +12,13 @@ WKS_FILE_DEPENDS ?= " \ > virtual/bootloader \ > " > > +RK_IMAGE_INCLUDES_UBOOT_ENV ?= "no" > +RK_UBOOT_ENV = " " > +RK_UBOOT_ENV:rk-u-boot-env = "${@ '--source rawcopy --sourceparams=file=u-boot.env' if \ > + bb.utils.to_boolean(d.getVar('RK_IMAGE_INCLUDES_UBOOT_ENV'), False) else ' '}" > + > WICVARS:append = " \ > + RK_UBOOT_ENV \ > SPL_BINARY \ > UBOOT_SUFFIX \ > " > diff --git a/conf/machine/rock2-square.conf b/conf/machine/rock2-square.conf > index 9468b9a6b559..bd36b2ecfcc7 100644 > --- a/conf/machine/rock2-square.conf > +++ b/conf/machine/rock2-square.conf > @@ -7,6 +7,7 @@ > #http://radxa.com/Rock2 > > require conf/machine/include/rk3288.inc > +require conf/machine/include/rockchip-rk-u-boot-env.inc If this board isn't using wic, would fw_env.config still be correct? It's defining a partition to use by its label, which we probably haven't set for that board? What about adding the label + u-boot-env partition in classes/rockchip-gpt-img.bbclass? It wouldn't be matching the partitions in http://rockchip.wikidot.com/partitions, (we could reuse some of the reserved2 partition for example) but you could then still use the same thing for both wic and wic-less platforms? Otherwise just not requiring this file for rock2 and specify in the README/machine conf file it doesn't support this mechanism just yet? Maybe we should also migrate it to TPL in upstream U-Boot so you stop having to maintain this part of the code that is specific to the rock2 :) ? BTW, I think you should be able to migrate all (but rock2) rk3288 to use wic instead? since commit 295b58facfb37b84b1e2d871dd4822d8c171dbbd at the very least? It looks very similar to the offsets we have in the current wks file? Cheers, Quentin
diff --git a/README b/README index c76fc9131276..605773d4ecd3 100644 --- a/README +++ b/README @@ -67,6 +67,26 @@ Notes: in the configuration (e.g. conf/local.conf). +U-Boot Environment: +------------------ + In order to configure U-Boot to be able to store its environment into the + device from which it was booted, for any device supported in this BSP, + simply add the following to MACHINE_FEATURES: + + rk-u-boot-env + + If enabled, to additionally have the U-Boot environment generated and + stored in the image, also enable the following variable (default: off): + + RK_IMAGE_INCLUDES_UBOOT_ENV + + The script: + + scripts/dump-uboot-env-from-yocto-image.sh + + can be used on a rockchip wic image to see the contents of the U-Boot + environment partition at build time. + Maintenance: ----------- Please send pull requests, patches, comments, or questions to the diff --git a/conf/machine/include/rockchip-rk-u-boot-env.inc b/conf/machine/include/rockchip-rk-u-boot-env.inc new file mode 100644 index 000000000000..4eb877f77c48 --- /dev/null +++ b/conf/machine/include/rockchip-rk-u-boot-env.inc @@ -0,0 +1,4 @@ +# 'rk-u-boot-env' indicates the user wants to be able to save their U-Boot +# environment back to the drive from which the device was booted +MACHINEOVERRIDES .= "${@bb.utils.contains('MACHINE_FEATURES', 'rk-u-boot-env', ':rk-u-boot-env', '', d)}" +IMAGE_INSTALL:append:rk-u-boot-env = " u-boot-fw-utils u-boot-env" diff --git a/conf/machine/include/rockchip-wic.inc b/conf/machine/include/rockchip-wic.inc index 147a36685d7d..1f662116d7cf 100644 --- a/conf/machine/include/rockchip-wic.inc +++ b/conf/machine/include/rockchip-wic.inc @@ -1,6 +1,7 @@ # common meta-rockchip wic/wks items require conf/machine/include/rockchip-extlinux.inc +require conf/machine/include/rockchip-rk-u-boot-env.inc SPL_BINARY ?= "idbloader.img" @@ -11,7 +12,13 @@ WKS_FILE_DEPENDS ?= " \ virtual/bootloader \ " +RK_IMAGE_INCLUDES_UBOOT_ENV ?= "no" +RK_UBOOT_ENV = " " +RK_UBOOT_ENV:rk-u-boot-env = "${@ '--source rawcopy --sourceparams=file=u-boot.env' if \ + bb.utils.to_boolean(d.getVar('RK_IMAGE_INCLUDES_UBOOT_ENV'), False) else ' '}" + WICVARS:append = " \ + RK_UBOOT_ENV \ SPL_BINARY \ UBOOT_SUFFIX \ " diff --git a/conf/machine/rock2-square.conf b/conf/machine/rock2-square.conf index 9468b9a6b559..bd36b2ecfcc7 100644 --- a/conf/machine/rock2-square.conf +++ b/conf/machine/rock2-square.conf @@ -7,6 +7,7 @@ #http://radxa.com/Rock2 require conf/machine/include/rk3288.inc +require conf/machine/include/rockchip-rk-u-boot-env.inc SPL_BINARY = "u-boot-spl-dtb.bin" KERNEL_DEVICETREE = "rockchip/rk3288-rock2-square.dtb" @@ -16,4 +17,3 @@ UBOOT_MACHINE = "rock2_defconfig" # image class IMAGE_FSTYPES += "rockchip-gpt-img" IMAGE_CLASSES += "rockchip-gpt-img" - diff --git a/recipes-bsp/u-boot/files/rk-u-boot-env/rockchip-enable-environment-mmc.cfg b/recipes-bsp/u-boot/files/rk-u-boot-env/rockchip-enable-environment-mmc.cfg new file mode 100644 index 000000000000..778772d27767 --- /dev/null +++ b/recipes-bsp/u-boot/files/rk-u-boot-env/rockchip-enable-environment-mmc.cfg @@ -0,0 +1,6 @@ +CONFIG_ENV_SIZE=0x8000 +CONFIG_ENV_OFFSET=0x3f8000 +# CONFIG_ENV_IS_NOWHERE is not set +CONFIG_ENV_IS_IN_MMC=y +CONFIG_DM_SEQ_ALIAS=y +CONFIG_SPL_DM_SEQ_ALIAS=y diff --git a/recipes-bsp/u-boot/u-boot_%.bbappend b/recipes-bsp/u-boot/u-boot_%.bbappend index a83179a9f007..32cb11939f77 100644 --- a/recipes-bsp/u-boot/u-boot_%.bbappend +++ b/recipes-bsp/u-boot/u-boot_%.bbappend @@ -1,7 +1,13 @@ +FILESEXTRAPATHS:prepend := "${THISDIR}/files:" + +SRC_URI:append:rk-u-boot-env = " file://rockchip-enable-environment-mmc.cfg" +SRCREV:rk-u-boot-env = "cdfcc37428e06f4730ab9a17cc084eeb7676ea1a" + # various machines require the pyelftools library for parsing dtb files DEPENDS:append = " python3-pyelftools-native" DEPENDS:append:rk3308 = " u-boot-tools-native" DEPENDS:append:rock-pi-4 = " gnutls-native" +DEPENDS:append:rk-u-boot-env = " u-boot-mkenvimage-native" EXTRA_OEMAKE:append:px30 = " BL31=${DEPLOY_DIR_IMAGE}/bl31-px30.elf" EXTRA_OEMAKE:append:rk3308 = " \ @@ -34,3 +40,37 @@ do_compile:append:rock2-square () { cp ${B}/spl/${SPL_BINARY} ${B} fi } + +rk_generate_env() { + if [ ! -f "${B}/.config" ]; then + echo "U-Boot .config not found, can't determine environment size" + return 1 + fi + cat ${B}/.config | grep "^CONFIG_ENV_SIZE=" > /dev/null + if [ $? -ne 0 ]; then + echo "can not find CONFIG_ENV_SIZE value in U-Boot .config" + return 1 + fi + + UBOOT_ENV_SIZE="$(cat ${B}/.config | grep "^CONFIG_ENV_SIZE=" | cut -d'=' -f2)" + + # linux user-space U-Boot env config file + echo "/dev/disk/by-partlabel/uboot_env 0x0000 ${UBOOT_ENV_SIZE}" > ${WORKDIR}/fw_env.config + + # convert text-based environment to binary suitable for image + if [ "${@bb.utils.to_boolean(d.getVar('RK_IMAGE_INCLUDES_UBOOT_ENV'), False)}" = "True" ]; then + if [ ! -f ${B}/u-boot-initial-env ]; then + echo "initial, text-formatted U-Boot environment file \"${B}/u-boot-initial-env\" not found" + return 1 + fi + mkenvimage -s ${UBOOT_ENV_SIZE} ${B}/u-boot-initial-env -o ${WORKDIR}/u-boot.env + fi +} +do_compile[postfuncs] += "${@bb.utils.contains('MACHINE_FEATURES', 'rk-u-boot-env', 'rk_generate_env', '', d)}" + +do_deploy:append:rk-u-boot-env() { + if [ -f ${WORKDIR}/u-boot.env -a "${@bb.utils.to_boolean(d.getVar('RK_IMAGE_INCLUDES_UBOOT_ENV'),False)}" = "True" ]; then + install -d ${DEPLOYDIR} + install -m 0644 ${WORKDIR}/u-boot.env ${DEPLOYDIR} + fi +} diff --git a/scripts/dump-uboot-env-from-yocto-image.sh b/scripts/dump-uboot-env-from-yocto-image.sh new file mode 100755 index 000000000000..05b7048f1734 --- /dev/null +++ b/scripts/dump-uboot-env-from-yocto-image.sh @@ -0,0 +1,29 @@ +#/bin/bash +# SPDX-License-Identifier: OSL-3.0 +# +# a program that can take a wic file and dump out the contents +# of the U-Boot environment in canonical hex+ascii format +# (assuming the "rockchip" layout specified in this layer's wic file) + +# check for programs +check_pgm() { + $1 --help > /dev/null 2>&1 + if [ $? -ne 0 ]; then + echo "required program \"$1\" not found" + exit 1 + fi +} +check_pgm dd +check_pgm hexdump + +if [ $# -ne 1 ]; then + echo "required param missing: yocto wic image" + exit 1 +fi +if [ ! -f "$1" ]; then + echo "specified file \"$1\" not found" + exit 1 +fi + +SKIP=$(( 8128 * 512 )) +dd if="$1" ibs=1 skip=$SKIP count=32k 2> /dev/null | hexdump -C diff --git a/wic/rockchip.wks b/wic/rockchip.wks index 9ba3352b51bb..bc65f73b0cf3 100644 --- a/wic/rockchip.wks +++ b/wic/rockchip.wks @@ -22,7 +22,7 @@ part loader1 --offset 64s --fixed-size 3552K --fstype=none --part-name load part v_storage --offset 7168s --fixed-size 256K --fstype=none --part-name v_storage part reserved --offset 7680s --fixed-size 192K --fstype=none --part-name reserved part reserved1 --offset 8064s --fixed-size 32K --fstype=none --part-name reserved1 -part uboot_env --offset 8128s --fixed-size 32K --fstype=none --part-name uboot_env +part uboot_env --offset 8128s --fixed-size 32K --fstype=none --part-name uboot_env ${RK_UBOOT_ENV} part reserved2 --offset 8192s --fixed-size 4096K --fstype=none --part-name reserved2 part loader2 --offset 16384s --fixed-size 4096K --fstype=none --part-name loader2 --source rawcopy --sourceparams="file=u-boot.${UBOOT_SUFFIX}" part atf --offset 24576s --fixed-size 4096K --fstype=none --part-name atf
U-Boot has the ability to store its environment variables to a permanent storage device. Whether or not it does so for any one specific device depends on whatever settings are enabled in that specific device's defconfig. In order to definitively configure U-Boot to be able to store its environment into the device from which it boots, for any device supported in this BSP, simply add the following to MACHINE_FEATURES: rk-u-boot-env If enabled, there is now a second choice to make: should the build also include the U-Boot environment in the image or not? The default environment, as generated by U-Boot, can be included in the generated wic image. If it is included, then flashing the image will also flash the default U-Boot environment variables and settings, wiping out anything that might have been there already. If it is not included then your device will either continue using whatever environment happens to be there (if valid), or will not use any stored environment if the stored environment has not been set or is invalid. The variable which governs this behaviour is: RK_IMAGE_INCLUDES_UBOOT_ENV By default this is set to "0", meaning that by default the image does not contain the U-Boot environment. To enable this behaviour, enable this variable. This variable only takes effect if rk-u-boot-env is listed in MACHINE_FEATURES, and has no effect otherwise. The script: scripts/dump-uboot-env-from-yocto-image.sh can be used on a rockchip wic image to see the contents of the U-Boot environment partition at build time. Tested by booting the same image on both eMMC and SDcard with the following devices, verifying the ability to read and write the U-Boot environment in both U-Boot and Linux user-space, and that changes made in one are seen in the other: rock-3a rock-5a rock-5b rock-pi-4b rock-pi-e rock64 Signed-off-by: Trevor Woerner <twoerner@gmail.com> --- v6 changes: - separate out the MACHINEOVERRIDES handling into its own include so that it can be included more flexibly into different scenarios; i.e. rock2-square build was failing because it is not wic-based v5 changes: - fix a bug in v4 to handle RK_IMAGE_INCLUDES_UBOOT_ENV correctly in the bash test in postfuncs of u-boot bbappend - add extra check in do_deploy() of u-boot bbappend to only copy the environment if RK_IMAGE_INCLUDES_UBOOT_ENV is true v4 changes: - sort WICVARS alphabetically - tweak dump-uboot-env-from-yocto-image.sh script to not just check for the existence of the user-supplied parameter, but that it is a file specifically - u-boot bbappend: - use a do_compile[postfuncs] for generating the fw_env.config instead of a do_compile:append - move the conversion of the U-Boot text-based environment to the require binary representation from a do_deploy:append to the newly-created do_compile[postfuncs] created above, this will allow the user to inject any extra U-Boot environment variables they might wish as part of a do_compile:append and have that occur before the binary is generated so that those additional user-supplied values are included - add a lot of extra checking (instead of assuming various resources exist) before making use of said resources v3 changes: - switch from using a bbclass so the `rk-u-boot-env` override can be used directly - add SPDX header to script - drop `inherit deploy` in U-Boot bbappend v2 changes: - re-word the commit message and README for clarity - use bash's built-in math handling instead of depending on `bc` - in anticipation of the upcoming feature in U-Boot whereby rockchip devices can automatically select the environment storage device to be the same as the boot device, use a more recent SRCREV for builds that do environment handling, instead of hardcoding the environment storage device by SoC family - handle RK_IMAGE_INCLUDES_UBOOT_ENV as a boolean --- README | 20 ++++++++++ .../include/rockchip-rk-u-boot-env.inc | 4 ++ conf/machine/include/rockchip-wic.inc | 7 ++++ conf/machine/rock2-square.conf | 2 +- .../rockchip-enable-environment-mmc.cfg | 6 +++ recipes-bsp/u-boot/u-boot_%.bbappend | 40 +++++++++++++++++++ scripts/dump-uboot-env-from-yocto-image.sh | 29 ++++++++++++++ wic/rockchip.wks | 2 +- 8 files changed, 108 insertions(+), 2 deletions(-) create mode 100644 conf/machine/include/rockchip-rk-u-boot-env.inc create mode 100644 recipes-bsp/u-boot/files/rk-u-boot-env/rockchip-enable-environment-mmc.cfg create mode 100755 scripts/dump-uboot-env-from-yocto-image.sh