meta-balena: bulk rename of RESIN_ variables

This is just a bulk rename of all the RESIN_ yocto variables to BALENA_. Compatible changes are required in balena-yocto-scripts and the device layers. Signed-off-by: Kyle Harding <[email protected]>
balena-os · Mar 10, 2021 · e2f9e63 · e2f9e63
1 parent 057621a
commit e2f9e63
Show file tree

Hide file tree

Showing 69 changed files with 416 additions and 416 deletions.
diff --git a/README.md b/README.md
@@ -234,7 +234,7 @@ The following example contains two custom udev rules that will create `/etc/udev
 ```json
 "os": {
  "udevRules": {
-  "56": "ENV{ID_FS_LABEL_ENC}==\"resin-root*\", IMPORT{program}=\"resin_update_state_probe $devnode\", SYMLINK+=\"disk/by-state/$env{RESIN_UPDATE_STATE}\"",
+  "56": "ENV{ID_FS_LABEL_ENC}==\"resin-root*\", IMPORT{program}=\"resin_update_state_probe $devnode\", SYMLINK+=\"disk/by-state/$env{BALENA_UPDATE_STATE}\"",
   "64" : "ACTION!=\"add|change\", GOTO=\"modeswitch_rules_end\"\nKERNEL==\"ttyACM*\", ATTRS{idVendor}==\"1546\", ATTRS{idProduct}==\"1146\", TAG+=\"systemd\", ENV{SYSTEMD_WANTS}=\"u-blox-switch@'%E{DEVNAME}'.service\"\nLBEL=\"modeswitch_rules_end\"\n"
  }
 }

diff --git a/contributing-device-support.md b/contributing-device-support.md
@@ -116,20 +116,20 @@ Which contains at least a `balena-image.bbappend` file. Depending on the type of
 ***
 - `IMAGE_FSTYPES_<yocto-machine-name>`: this variable is used to declare the type of the produced image. It can be ext3, ext4, balenaos-img etc. The usual type for a board that can boot from SD card, USB, is "balenaos-img".
 
-- `RESIN_BOOT_PARTITION_FILES_<yocto-machine-name>`: this allows adding files from the build's deploy directory into the vfat formatted resin-boot partition (can be used to add bootloader config files, first stage bootloader, initramfs or anything else needed for the booting process to take place for your particular board). If the board uses different bootloader configuration files when booting from either external media (USB thumb drive, SD card etc.) or from internal media (mSATA, eMMC etc) then you would want to make use of this variable to make sure the different bootloader configuration files get copied over and further manipulated as needed (see `INTERNAL_DEVICE_BOOTLOADER_CONFIG_<yocto-machine-name>` and `INTERNAL_DEVICE_BOOTLOADER_CONFIG_PATH_<yocto-machine-name>` below). Please note that you only reference these files here, it is the responsibility of a `.bb` or `.bbappend` to provide and deploy them (for bootloader config files this is done with an append typically in `recipes-bsp/<your board's bootloader>/<your board's bootloader>.bbappend`, see [balena-intel grub bbappend][balena-intel grub append] for an example).
+- `BALENA_BOOT_PARTITION_FILES_<yocto-machine-name>`: this allows adding files from the build's deploy directory into the vfat formatted resin-boot partition (can be used to add bootloader config files, first stage bootloader, initramfs or anything else needed for the booting process to take place for your particular board). If the board uses different bootloader configuration files when booting from either external media (USB thumb drive, SD card etc.) or from internal media (mSATA, eMMC etc) then you would want to make use of this variable to make sure the different bootloader configuration files get copied over and further manipulated as needed (see `INTERNAL_DEVICE_BOOTLOADER_CONFIG_<yocto-machine-name>` and `INTERNAL_DEVICE_BOOTLOADER_CONFIG_PATH_<yocto-machine-name>` below). Please note that you only reference these files here, it is the responsibility of a `.bb` or `.bbappend` to provide and deploy them (for bootloader config files this is done with an append typically in `recipes-bsp/<your board's bootloader>/<your board's bootloader>.bbappend`, see [balena-intel grub bbappend][balena-intel grub append] for an example).
 
  It is a space separated list of items with the following format: *FilenameRelativeToDeployDir:FilenameOnTheTarget*. If *FilenameOnTheTarget* is omitted then the *FilenameRelativeToDeployDir* will be used.
 
   For example to have the Intel NUC `bzImage-intel-corei7-64.bin` copied from deploy directory over to the boot partition, renamed to `vmlinuz`:
 
-    ```sh   RESIN_BOOT_PARTITION_FILES_nuc =  "bzImage-intel-corei7-64.bin:vmlinuz"    ```
+    ```sh   BALENA_BOOT_PARTITION_FILES_nuc =  "bzImage-intel-corei7-64.bin:vmlinuz"    ```
 ***
 
   The `balena-image-flasher.bbappend` file shall define the following variables:
 
 ***
 - `IMAGE_FSTYPES_<yocto-machine-name>` (see above)
-- `RESIN_BOOT_PARTITION_FILES_<yocto-machine-name>` (see above). For example, if the board uses different bootloader configuration files for booting from SD/USB and internal storage (see below the use of `INTERNAL_DEVICE_BOOTLOADER_CONFIG` variable), then make sure these files end up in the boot partition (i.e. they should be listed in this `RESIN_BOOT_PARTITION_FILES_<yocto-machine-name>` variable)
+- `BALENA_BOOT_PARTITION_FILES_<yocto-machine-name>` (see above). For example, if the board uses different bootloader configuration files for booting from SD/USB and internal storage (see below the use of `INTERNAL_DEVICE_BOOTLOADER_CONFIG` variable), then make sure these files end up in the boot partition (i.e. they should be listed in this `BALENA_BOOT_PARTITION_FILES_<yocto-machine-name>` variable)
 
 ***
 
@@ -147,7 +147,7 @@ Shall contain a `resin-init-flasher.bbappend` file if you intend to install bale
 ***
   - `INTERNAL_DEVICE_KERNEL_<yocto-machine-name>`: used to identify the internal storage where balena.io will be written to.
 
-  - `INTERNAL_DEVICE_BOOTLOADER_CONFIG_<yocto-machine-name>`: used to specify the filename of the bootloader configuration file used by your board when booting from internal media. Must be the same as the *FilenameOnTheTarget* parameter of the bootloader internal config file used in the `RESIN_BOOT_PARTITION_FILES_<yocto-machine-name>` variable from `recipes-core/images/balena-image-flasher.bbappend`.
+  - `INTERNAL_DEVICE_BOOTLOADER_CONFIG_<yocto-machine-name>`: used to specify the filename of the bootloader configuration file used by your board when booting from internal media. Must be the same as the *FilenameOnTheTarget* parameter of the bootloader internal config file used in the `BALENA_BOOT_PARTITION_FILES_<yocto-machine-name>` variable from `recipes-core/images/balena-image-flasher.bbappend`.
 
   - `INTERNAL_DEVICE_BOOTLOADER_CONFIG_PATH_<yocto-machine-name>`: used to specify the relative path, including filename, to the resin-boot partition where `INTERNAL_DEVICE_BOOTLOADER_CONFIG_<yocto-machine-name>` will be copied to.
 

diff --git a/meta-balena-common/classes/image-balena.bbclass b/meta-balena-common/classes/image-balena.bbclass
@@ -54,7 +54,7 @@ init_config_json() {
    echo "$(cat ${1}/config.json | jq -S ".localMode=true")" > ${1}/config.json
 
    # Find board json and extract slug
-   json_path=${RESIN_COREBASE}/../../../${MACHINE}.json
+   json_path=${BALENA_COREBASE}/../../../${MACHINE}.json
    slug=$(jq .slug $json_path)
 
    # Set deviceType for supervisor
@@ -129,22 +129,22 @@ read_only_rootfs_hook_append () {
 # Generate the boot partition directory and deploy it to rootfs
 resin_boot_dirgen_and_deploy () {
     echo "Generating work directory for resin-boot partition..."
-    rm -rf ${RESIN_BOOT_WORKDIR}
-    for RESIN_BOOT_PARTITION_FILE in ${RESIN_BOOT_PARTITION_FILES}; do
-        echo "Handling $RESIN_BOOT_PARTITION_FILE ."
+    rm -rf ${BALENA_BOOT_WORKDIR}
+    for BALENA_BOOT_PARTITION_FILE in ${BALENA_BOOT_PARTITION_FILES}; do
+        echo "Handling $BALENA_BOOT_PARTITION_FILE ."
 
         # Check for item format
-        case $RESIN_BOOT_PARTITION_FILE in
+        case $BALENA_BOOT_PARTITION_FILE in
             *:*) ;;
-            *) bbfatal "Some items in RESIN_BOOT_PARTITION_FILES ($RESIN_BOOT_PARTITION_FILE) are not in the 'src:dst' format."
+            *) bbfatal "Some items in BALENA_BOOT_PARTITION_FILES ($BALENA_BOOT_PARTITION_FILE) are not in the 'src:dst' format."
         esac
 
         # Compute src and dst
-        src="$(echo ${RESIN_BOOT_PARTITION_FILE} | awk -F: '{print $1}')"
+        src="$(echo ${BALENA_BOOT_PARTITION_FILE} | awk -F: '{print $1}')"
         if [ -z "${src}" ]; then
-            bbfatal "An entry in RESIN_BOOT_PARTITION_FILES has no source. Entries need to be in the \"src:dst\" format where only \"dst\" is optional. Failed entry: \"$RESIN_BOOT_PARTITION_FILE\"."
+            bbfatal "An entry in BALENA_BOOT_PARTITION_FILES has no source. Entries need to be in the \"src:dst\" format where only \"dst\" is optional. Failed entry: \"$BALENA_BOOT_PARTITION_FILE\"."
         fi
-        dst="$(echo ${RESIN_BOOT_PARTITION_FILE} | awk -F: '{print $2}')"
+        dst="$(echo ${BALENA_BOOT_PARTITION_FILE} | awk -F: '{print $2}')"
         if [ -z "${dst}" ]; then
             dst="/${src}" # dst was omitted
         fi
@@ -167,7 +167,7 @@ resin_boot_dirgen_and_deploy () {
                      *) dst_is_dir=false ;;
                 esac
                 ;;
-             *) bbfatal "$dst in RESIN_BOOT_PARTITION_FILES is not an absolute path."
+             *) bbfatal "$dst in BALENA_BOOT_PARTITION_FILES is not an absolute path."
         esac
 
         # Check src type and existence
@@ -179,7 +179,7 @@ resin_boot_dirgen_and_deploy () {
         elif [ -f "$src" ]; then
             sources="$src"
         else
-            bbfatal "$src is an invalid path referenced in RESIN_BOOT_PARTITION_FILES."
+            bbfatal "$src is an invalid path referenced in BALENA_BOOT_PARTITION_FILES."
         fi
 
         # Normalize paths
@@ -193,49 +193,49 @@ resin_boot_dirgen_and_deploy () {
             echo "Copying $src -> $dst ..."
             # Create the directories parent directories in dst
             directory=""
-            for path_segment in $(echo ${RESIN_BOOT_WORKDIR}/${dst} | sed 's|/|\n|g' | head -n -1); do
+            for path_segment in $(echo ${BALENA_BOOT_WORKDIR}/${dst} | sed 's|/|\n|g' | head -n -1); do
                 if [ -z "$path_segment" ]; then
                     continue
                 fi
                 directory=$directory/$path_segment
                 mkdir -p $directory
             done
-            cp -rvfL $src ${RESIN_BOOT_WORKDIR}/$dst
+            cp -rvfL $src ${BALENA_BOOT_WORKDIR}/$dst
         done
     done
-    echo "${IMAGE_NAME}" > ${RESIN_BOOT_WORKDIR}/image-version-info
-    init_config_json ${RESIN_BOOT_WORKDIR}
+    echo "${IMAGE_NAME}" > ${BALENA_BOOT_WORKDIR}/image-version-info
+    init_config_json ${BALENA_BOOT_WORKDIR}
 
     # Keep this after everything is ready in the resin-boot directory
-    find ${RESIN_BOOT_WORKDIR} -xdev -type f \
-        ! -name ${RESIN_FINGERPRINT_FILENAME}.${RESIN_FINGERPRINT_EXT} \
+    find ${BALENA_BOOT_WORKDIR} -xdev -type f \
+        ! -name ${BALENA_FINGERPRINT_FILENAME}.${BALENA_FINGERPRINT_EXT} \
         ! -name config.json \
-        -exec md5sum {} \; | sed "s#${RESIN_BOOT_WORKDIR}##g" | \
-        sort -k2 > ${RESIN_BOOT_WORKDIR}/${RESIN_FINGERPRINT_FILENAME}.${RESIN_FINGERPRINT_EXT}
+        -exec md5sum {} \; | sed "s#${BALENA_BOOT_WORKDIR}##g" | \
+        sort -k2 > ${BALENA_BOOT_WORKDIR}/${BALENA_FINGERPRINT_FILENAME}.${BALENA_FINGERPRINT_EXT}
 
     echo "Install resin-boot in the rootfs..."
-    cp -rvf ${RESIN_BOOT_WORKDIR} ${IMAGE_ROOTFS}/${RESIN_BOOT_FS_LABEL}
+    cp -rvf ${BALENA_BOOT_WORKDIR} ${IMAGE_ROOTFS}/${BALENA_BOOT_FS_LABEL}
 
 	# This is a sanity check
 	# When updating the hostOS we are using atomic operations for copying new
 	# files in the boot partition. This requires twice the size of a file with
 	# every copy operation. This means that the boot partition needs to have
 	# available at least free space as much as the largest file deployed.
 	# First Calculate size of the data
-	DATA_SECTORS=$(expr $(du --apparent-size -ks ${RESIN_BOOT_WORKDIR} | cut -f 1) \* 2)
+	DATA_SECTORS=$(expr $(du --apparent-size -ks ${BALENA_BOOT_WORKDIR} | cut -f 1) \* 2)
 	# Calculate fs overhead
-	DIR_BYTES=$(expr $(find ${RESIN_BOOT_WORKDIR} | tail -n +2 | wc -l) \* 32)
-	DIR_BYTES=$(expr $DIR_BYTES + $(expr $(find ${RESIN_BOOT_WORKDIR} -type d | tail -n +2 | wc -l) \* 32))
+	DIR_BYTES=$(expr $(find ${BALENA_BOOT_WORKDIR} | tail -n +2 | wc -l) \* 32)
+	DIR_BYTES=$(expr $DIR_BYTES + $(expr $(find ${BALENA_BOOT_WORKDIR} -type d | tail -n +2 | wc -l) \* 32))
 	FAT_BYTES=$(expr $DATA_SECTORS \* 4)
-	FAT_BYTES=$(expr $FAT_BYTES + $(expr $(find ${RESIN_BOOT_WORKDIR} -type d | tail -n +2 | wc -l) \* 4))
+	FAT_BYTES=$(expr $FAT_BYTES + $(expr $(find ${BALENA_BOOT_WORKDIR} -type d | tail -n +2 | wc -l) \* 4))
 	DIR_SECTORS=$(expr $(expr $DIR_BYTES + 511) / 512)
 	FAT_SECTORS=$(expr $(expr $FAT_BYTES + 511) / 512 \* 2)
 	FAT_OVERHEAD_SECTORS=$(expr $DIR_SECTORS + $FAT_SECTORS)
 	# Find the largest file and calculate the size in sectors
-	LARGEST_FILE_SECTORS=$(expr $(find ${RESIN_BOOT_WORKDIR} -type f -exec du --apparent-size -k {} + | sort -n -r | head -n1 | cut -f1) \* 2)
+	LARGEST_FILE_SECTORS=$(expr $(find ${BALENA_BOOT_WORKDIR} -type f -exec du --apparent-size -k {} + | sort -n -r | head -n1 | cut -f1) \* 2)
 	if [ -n "$LARGEST_FILE_SECTORS" ]; then
 		TOTAL_SECTORS=$(expr $DATA_SECTORS \+ $FAT_OVERHEAD_SECTORS \+ $LARGEST_FILE_SECTORS)
-		BOOT_SIZE_SECTORS=$(expr ${RESIN_BOOT_SIZE} \* 2)
+		BOOT_SIZE_SECTORS=$(expr ${BALENA_BOOT_SIZE} \* 2)
 		bbnote "resin-boot: FAT overhead $FAT_OVERHEAD_SECTORS sectors, data $DATA_SECTORS sectors, largest file $LARGEST_FILE_SECTORS sectors, boot size $BOOT_SIZE_SECTORS sectors."
 		if [ $TOTAL_SECTORS -gt $BOOT_SIZE_SECTORS ]; then
 			bbfatal "resin-boot: Not enough space for atomic copy operations."
@@ -272,25 +272,25 @@ resinhup_backwards_compatible_link () {
         # Check if we are running on a poky version which deploys to IMGDEPLOYDIR instead
         # of DEPLOY_DIR_IMAGE (poky morty introduced this change)
         DEPLOY_IMAGE_TAR="${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.tar"
-        RESIN_HUP_BUNDLE="${IMGDEPLOYDIR}/${IMAGE_LINK_NAME}.resinhup-tar"
+        BALENA_HUP_BUNDLE="${IMGDEPLOYDIR}/${IMAGE_LINK_NAME}.resinhup-tar"
     else
         IMAGE_NAME_SUFFIX=".rootfs"
         DEPLOY_IMAGE_TAR="${DEPLOY_DIR_IMAGE}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.tar"
-        RESIN_HUP_BUNDLE="${DEPLOY_DIR_IMAGE}/${IMAGE_LINK_NAME}.resinhup-tar"
+        BALENA_HUP_BUNDLE="${DEPLOY_DIR_IMAGE}/${IMAGE_LINK_NAME}.resinhup-tar"
     fi
     if [ -f ${DEPLOY_IMAGE_TAR} ]; then
-        ln -fsv ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.tar ${RESIN_HUP_BUNDLE}
+        ln -fsv ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.tar ${BALENA_HUP_BUNDLE}
     fi
 }
 
 add_image_flag_file () {
-    echo "DO NOT REMOVE THIS FILE" > ${DEPLOY_DIR_IMAGE}/${RESIN_FLAG_FILE}
+    echo "DO NOT REMOVE THIS FILE" > ${DEPLOY_DIR_IMAGE}/${BALENA_FLAG_FILE}
 }
 
 python resin_boot_sanity_handler() {
   kernel_file = d.getVar('KERNEL_IMAGETYPE', True) + d.getVar('KERNEL_INITRAMFS', True) + d.getVar('MACHINE', True) + '.bin'
-  if kernel_file in d.getVar('RESIN_BOOT_PARTITION_FILES', True):
-    bb.warn("BalenaOS only supports having the kernel in the root partition in rootfs/boot/KERNEL_IMAGETYPE. Please remove it from RESIN_BOOT_PARTITION_FILES. This will become a fatal warning in a few releases.")
+  if kernel_file in d.getVar('BALENA_BOOT_PARTITION_FILES', True):
+    bb.warn("BalenaOS only supports having the kernel in the root partition in rootfs/boot/KERNEL_IMAGETYPE. Please remove it from BALENA_BOOT_PARTITION_FILES. This will become a fatal warning in a few releases.")
 }
 
 python balena_udev_rules_sanity_handler() {
@@ -356,8 +356,8 @@ python os_release_extra_data() {
     if slug == "unknown":
         bb.warn("Can't detect the slug. This information will not be available in os-release.")
     extra_data = [
-        'RESIN_BOARD_REV="{0}"\n'.format(resin_board_rev),
-        'META_RESIN_REV="{0}"\n'.format(meta_resin_rev),
+        'BALENA_BOARD_REV="{0}"\n'.format(resin_board_rev),
+        'META_BALENA_REV="{0}"\n'.format(meta_resin_rev),
         'SLUG="{0}"\n'.format(slug),
     ]
     os_release_file = os.path.join(d.getVar('IMAGE_ROOTFS', True), "etc/os-release")