blob: 178e4ef242bd49a740918fdd07434e47dd1db25e [file] [log] [blame]
Patrick Williams8b8bc412016-08-17 15:02:23 -05001inherit image_types
Patrick Williams8b8bc412016-08-17 15:02:23 -05002
3#
Brad Bishop316dfdd2018-06-25 12:45:53 -04004# Create an image that can be written onto a SD card using dd.
Patrick Williams8b8bc412016-08-17 15:02:23 -05005#
6# The disk layout used is:
7#
8# 0 -> IMAGE_ROOTFS_ALIGNMENT - reserved for other data
9# IMAGE_ROOTFS_ALIGNMENT -> BOOT_SPACE - bootloader and kernel
10# BOOT_SPACE -> SDIMG_SIZE - rootfs
11#
12
13# Default Free space = 1.3x
14# Use IMAGE_OVERHEAD_FACTOR to add more space
15# <--------->
Andrew Geissler3e34fba2021-03-05 15:21:55 -060016# 4MiB 48MiB SDIMG_ROOTFS
Patrick Williams8b8bc412016-08-17 15:02:23 -050017# <-----------------------> <----------> <---------------------->
18# ------------------------ ------------ ------------------------
19# | IMAGE_ROOTFS_ALIGNMENT | BOOT_SPACE | ROOTFS_SIZE |
20# ------------------------ ------------ ------------------------
21# ^ ^ ^ ^
22# | | | |
Andrew Geissler3e34fba2021-03-05 15:21:55 -060023# 0 4MiB 4MiB + 48MiB 4MiB + 48Mib + SDIMG_ROOTFS
Patrick Williams8b8bc412016-08-17 15:02:23 -050024
25# This image depends on the rootfs image
Patrick Williams213cb262021-08-07 19:21:33 -050026IMAGE_TYPEDEP:rpi-sdimg = "${SDIMG_ROOTFS_TYPE}"
Patrick Williams8b8bc412016-08-17 15:02:23 -050027
Patrick Williams8b8bc412016-08-17 15:02:23 -050028# Boot partition volume id
Andrew Geissler3e34fba2021-03-05 15:21:55 -060029# Shorten raspberrypi to just rpi to keep it under 11 characters
30# now enforced by mkfs.vfat from dosfstools-4.2
31BOOTDD_VOLUME_ID ?= "${@d.getVar('MACHINE').replace('raspberrypi', 'rpi')}"
Patrick Williams8b8bc412016-08-17 15:02:23 -050032
33# Boot partition size [in KiB] (will be rounded up to IMAGE_ROOTFS_ALIGNMENT)
Andrew Geissler3e34fba2021-03-05 15:21:55 -060034BOOT_SPACE ?= "49152"
Patrick Williams8b8bc412016-08-17 15:02:23 -050035
36# Set alignment to 4MB [in KiB]
37IMAGE_ROOTFS_ALIGNMENT = "4096"
38
39# Use an uncompressed ext3 by default as rootfs
40SDIMG_ROOTFS_TYPE ?= "ext3"
Brad Bishopd7bf8c12018-02-25 22:55:05 -050041SDIMG_ROOTFS = "${IMGDEPLOYDIR}/${IMAGE_LINK_NAME}.${SDIMG_ROOTFS_TYPE}"
Patrick Williams8b8bc412016-08-17 15:02:23 -050042
Brad Bishop1a4b7ee2018-12-16 17:11:34 -080043# For the names of kernel artifacts
44inherit kernel-artifact-names
45
Andrew Geissler9d7e0aa2020-08-21 15:56:44 -050046RPI_SDIMG_EXTRA_DEPENDS ?= ""
47
Brad Bishopd7bf8c12018-02-25 22:55:05 -050048do_image_rpi_sdimg[depends] = " \
Brad Bishopf27bdd52018-05-07 15:42:31 +020049 parted-native:do_populate_sysroot \
50 mtools-native:do_populate_sysroot \
51 dosfstools-native:do_populate_sysroot \
52 virtual/kernel:do_deploy \
Andrew Geissler26e4bea2020-11-30 19:54:03 -060053 rpi-bootfiles:do_deploy \
Brad Bishop26bdd442019-08-16 17:08:17 -040054 ${@bb.utils.contains('MACHINE_FEATURES', 'armstub', 'armstubs:do_deploy', '' ,d)} \
Brad Bishopf27bdd52018-05-07 15:42:31 +020055 ${@bb.utils.contains('RPI_USE_U_BOOT', '1', 'u-boot:do_deploy', '',d)} \
Andrew Geissler062316f2020-05-15 14:19:14 -050056 ${@bb.utils.contains('RPI_USE_U_BOOT', '1', 'u-boot-default-script:do_deploy', '',d)} \
Andrew Geissler9d7e0aa2020-08-21 15:56:44 -050057 ${RPI_SDIMG_EXTRA_DEPENDS} \
Brad Bishopf27bdd52018-05-07 15:42:31 +020058"
Patrick Williams8b8bc412016-08-17 15:02:23 -050059
Brad Bishop316dfdd2018-06-25 12:45:53 -040060do_image_rpi_sdimg[recrdeps] = "do_build"
61
Patrick Williams8b8bc412016-08-17 15:02:23 -050062# SD card image name
Brad Bishop31121382019-12-06 18:34:07 -050063SDIMG = "${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.rpi-sdimg"
Patrick Williams8b8bc412016-08-17 15:02:23 -050064
Patrick Williams8b8bc412016-08-17 15:02:23 -050065# Additional files and/or directories to be copied into the vfat partition from the IMAGE_ROOTFS.
66FATPAYLOAD ?= ""
67
Brad Bishop6e60e8b2018-02-01 10:27:11 -050068# SD card vfat partition image name
Brad Bishop1a4b7ee2018-12-16 17:11:34 -080069SDIMG_VFAT_DEPLOY ?= "${RPI_USE_U_BOOT}"
Brad Bishop6e60e8b2018-02-01 10:27:11 -050070SDIMG_VFAT = "${IMAGE_NAME}.vfat"
71SDIMG_LINK_VFAT = "${IMGDEPLOYDIR}/${IMAGE_LINK_NAME}.vfat"
72
Patrick Williams213cb262021-08-07 19:21:33 -050073IMAGE_CMD:rpi-sdimg () {
Patrick Williams8b8bc412016-08-17 15:02:23 -050074
Brad Bishopf27bdd52018-05-07 15:42:31 +020075 # Align partitions
76 BOOT_SPACE_ALIGNED=$(expr ${BOOT_SPACE} + ${IMAGE_ROOTFS_ALIGNMENT} - 1)
77 BOOT_SPACE_ALIGNED=$(expr ${BOOT_SPACE_ALIGNED} - ${BOOT_SPACE_ALIGNED} % ${IMAGE_ROOTFS_ALIGNMENT})
78 SDIMG_SIZE=$(expr ${IMAGE_ROOTFS_ALIGNMENT} + ${BOOT_SPACE_ALIGNED} + $ROOTFS_SIZE)
Patrick Williams8b8bc412016-08-17 15:02:23 -050079
Brad Bishopf27bdd52018-05-07 15:42:31 +020080 echo "Creating filesystem with Boot partition ${BOOT_SPACE_ALIGNED} KiB and RootFS $ROOTFS_SIZE KiB"
Patrick Williams8b8bc412016-08-17 15:02:23 -050081
Brad Bishopf27bdd52018-05-07 15:42:31 +020082 # Check if we are building with device tree support
Andrew Geissler9aee5002022-03-30 16:27:02 +000083 DTS="${@make_dtb_boot_files(d)}"
Patrick Williams8b8bc412016-08-17 15:02:23 -050084
Brad Bishopf27bdd52018-05-07 15:42:31 +020085 # Initialize sdcard image file
86 dd if=/dev/zero of=${SDIMG} bs=1024 count=0 seek=${SDIMG_SIZE}
Patrick Williams8b8bc412016-08-17 15:02:23 -050087
Brad Bishopf27bdd52018-05-07 15:42:31 +020088 # Create partition table
89 parted -s ${SDIMG} mklabel msdos
90 # Create boot partition and mark it as bootable
91 parted -s ${SDIMG} unit KiB mkpart primary fat32 ${IMAGE_ROOTFS_ALIGNMENT} $(expr ${BOOT_SPACE_ALIGNED} \+ ${IMAGE_ROOTFS_ALIGNMENT})
92 parted -s ${SDIMG} set 1 boot on
93 # Create rootfs partition to the end of disk
94 parted -s ${SDIMG} -- unit KiB mkpart primary ext2 $(expr ${BOOT_SPACE_ALIGNED} \+ ${IMAGE_ROOTFS_ALIGNMENT}) -1s
95 parted ${SDIMG} print
Patrick Williams8b8bc412016-08-17 15:02:23 -050096
Brad Bishopf27bdd52018-05-07 15:42:31 +020097 # Create a vfat image with boot files
98 BOOT_BLOCKS=$(LC_ALL=C parted -s ${SDIMG} unit b print | awk '/ 1 / { print substr($4, 1, length($4 -1)) / 512 /2 }')
99 rm -f ${WORKDIR}/boot.img
Andrew Geissler1c349142019-02-19 19:49:56 -0600100 mkfs.vfat -F32 -n "${BOOTDD_VOLUME_ID}" -S 512 -C ${WORKDIR}/boot.img $BOOT_BLOCKS
Andrew Geissler9d7e0aa2020-08-21 15:56:44 -0500101 mcopy -v -i ${WORKDIR}/boot.img -s ${DEPLOY_DIR_IMAGE}/${BOOTFILES_DIR_NAME}/* ::/ || bbfatal "mcopy cannot copy ${DEPLOY_DIR_IMAGE}/${BOOTFILES_DIR_NAME}/* into boot.img"
Brad Bishop26bdd442019-08-16 17:08:17 -0400102 if [ "${@bb.utils.contains("MACHINE_FEATURES", "armstub", "1", "0", d)}" = "1" ]; then
103 mcopy -v -i ${WORKDIR}/boot.img -s ${DEPLOY_DIR_IMAGE}/armstubs/${ARMSTUB} ::/ || bbfatal "mcopy cannot copy ${DEPLOY_DIR_IMAGE}/armstubs/${ARMSTUB} into boot.img"
104 fi
Brad Bishopf27bdd52018-05-07 15:42:31 +0200105 if test -n "${DTS}"; then
Andrew Geissler9aee5002022-03-30 16:27:02 +0000106 # Copy board device trees (including overlays)
107 # There is an assumption here - no DTB in other directories than root
108 # and root/overlays. mmd/mcopy are not very flexible tools.
Brad Bishopf27bdd52018-05-07 15:42:31 +0200109 mmd -i ${WORKDIR}/boot.img overlays
Andrew Geissler9aee5002022-03-30 16:27:02 +0000110 for entry in ${DTS} ; do
111 # Split entry at optional ';'
112 if [ $(echo "$entry" | grep -c \;) = "0" ] ; then
113 DEPLOY_FILE="$entry"
114 DEST_FILENAME="$entry"
115 else
116 DEPLOY_FILE="$(echo "$entry" | cut -f1 -d\;)"
117 DEST_FILENAME="$(echo "$entry" | cut -f2- -d\;)"
118 fi
119 mcopy -v -i ${WORKDIR}/boot.img -s ${DEPLOY_DIR_IMAGE}/${DEPLOY_FILE} ::${DEST_FILENAME} || bbfatal "mcopy cannot copy ${DEPLOY_DIR_IMAGE}/${DEPLOY_FILE} into boot.img"
Brad Bishopf27bdd52018-05-07 15:42:31 +0200120 done
121 fi
122 if [ "${RPI_USE_U_BOOT}" = "1" ]; then
Brad Bishop26bdd442019-08-16 17:08:17 -0400123 mcopy -v -i ${WORKDIR}/boot.img -s ${DEPLOY_DIR_IMAGE}/u-boot.bin ::${SDIMG_KERNELIMAGE} || bbfatal "mcopy cannot copy ${DEPLOY_DIR_IMAGE}/u-boot.bin into boot.img"
124 mcopy -v -i ${WORKDIR}/boot.img -s ${DEPLOY_DIR_IMAGE}/boot.scr ::boot.scr || bbfatal "mcopy cannot copy ${DEPLOY_DIR_IMAGE}/boot.scr into boot.img"
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800125 if [ ! -z "${INITRAMFS_IMAGE}" -a "${INITRAMFS_IMAGE_BUNDLE}" = "1" ]; then
Brad Bishop26bdd442019-08-16 17:08:17 -0400126 mcopy -v -i ${WORKDIR}/boot.img -s ${DEPLOY_DIR_IMAGE}/${KERNEL_IMAGETYPE}-${INITRAMFS_LINK_NAME}.bin ::${KERNEL_IMAGETYPE} || bbfatal "mcopy cannot copy ${DEPLOY_DIR_IMAGE}/${KERNEL_IMAGETYPE}-${INITRAMFS_LINK_NAME}.bin into boot.img"
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800127 else
Brad Bishop26bdd442019-08-16 17:08:17 -0400128 mcopy -v -i ${WORKDIR}/boot.img -s ${DEPLOY_DIR_IMAGE}/${KERNEL_IMAGETYPE} ::${KERNEL_IMAGETYPE} || bbfatal "mcopy cannot copy ${DEPLOY_DIR_IMAGE}/${KERNEL_IMAGETYPE} into boot.img"
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800129 fi
Brad Bishopf27bdd52018-05-07 15:42:31 +0200130 else
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800131 if [ ! -z "${INITRAMFS_IMAGE}" -a "${INITRAMFS_IMAGE_BUNDLE}" = "1" ]; then
Brad Bishop26bdd442019-08-16 17:08:17 -0400132 mcopy -v -i ${WORKDIR}/boot.img -s ${DEPLOY_DIR_IMAGE}/${KERNEL_IMAGETYPE}-${INITRAMFS_LINK_NAME}.bin ::${SDIMG_KERNELIMAGE} || bbfatal "mcopy cannot copy ${DEPLOY_DIR_IMAGE}/${KERNEL_IMAGETYPE}-${INITRAMFS_LINK_NAME}.bin into boot.img"
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800133 else
Brad Bishop26bdd442019-08-16 17:08:17 -0400134 mcopy -v -i ${WORKDIR}/boot.img -s ${DEPLOY_DIR_IMAGE}/${KERNEL_IMAGETYPE} ::${SDIMG_KERNELIMAGE} || bbfatal "mcopy cannot copy ${DEPLOY_DIR_IMAGE}/${KERNEL_IMAGETYPE} into boot.img"
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800135 fi
Brad Bishopf27bdd52018-05-07 15:42:31 +0200136 fi
Patrick Williams8b8bc412016-08-17 15:02:23 -0500137
Andrew Geissler9d7e0aa2020-08-21 15:56:44 -0500138 # Add files (eg. hypervisor binaries) from the deploy dir
139 if [ -n "${DEPLOYPAYLOAD}" ] ; then
140 echo "Copying deploy file payload into VFAT"
141 for entry in ${DEPLOYPAYLOAD} ; do
142 # Split entry at optional ':' to enable file renaming for the destination
143 if [ $(echo "$entry" | grep -c :) = "0" ] ; then
144 DEPLOY_FILE="$entry"
145 DEST_FILENAME="$entry"
146 else
147 DEPLOY_FILE="$(echo "$entry" | cut -f1 -d:)"
148 DEST_FILENAME="$(echo "$entry" | cut -f2- -d:)"
149 fi
150 mcopy -v -i ${WORKDIR}/boot.img -s ${DEPLOY_DIR_IMAGE}/${DEPLOY_FILE} ::${DEST_FILENAME} || bbfatal "mcopy cannot copy ${DEPLOY_DIR_IMAGE}/${DEPLOY_FILE} into boot.img"
151 done
152 fi
153
Brad Bishop15ae2502019-06-18 21:44:24 -0400154 if [ -n "${FATPAYLOAD}" ] ; then
Brad Bishopf27bdd52018-05-07 15:42:31 +0200155 echo "Copying payload into VFAT"
156 for entry in ${FATPAYLOAD} ; do
Brad Bishop26bdd442019-08-16 17:08:17 -0400157 # use bbwarn instead of bbfatal to stop aborting on vfat issues like not supporting .~lock files
158 mcopy -v -i ${WORKDIR}/boot.img -s ${IMAGE_ROOTFS}$entry :: || bbwarn "mcopy cannot copy ${IMAGE_ROOTFS}$entry into boot.img"
Brad Bishopf27bdd52018-05-07 15:42:31 +0200159 done
160 fi
Patrick Williams8b8bc412016-08-17 15:02:23 -0500161
Brad Bishopf27bdd52018-05-07 15:42:31 +0200162 # Add stamp file
163 echo "${IMAGE_NAME}" > ${WORKDIR}/image-version-info
Brad Bishop26bdd442019-08-16 17:08:17 -0400164 mcopy -v -i ${WORKDIR}/boot.img ${WORKDIR}/image-version-info :: || bbfatal "mcopy cannot copy ${WORKDIR}/image-version-info into boot.img"
Patrick Williams8b8bc412016-08-17 15:02:23 -0500165
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800166 # Deploy vfat partition
167 if [ "${SDIMG_VFAT_DEPLOY}" = "1" ]; then
Brad Bishopf27bdd52018-05-07 15:42:31 +0200168 cp ${WORKDIR}/boot.img ${IMGDEPLOYDIR}/${SDIMG_VFAT}
169 ln -sf ${SDIMG_VFAT} ${SDIMG_LINK_VFAT}
170 fi
Patrick Williams8b8bc412016-08-17 15:02:23 -0500171
Brad Bishopf27bdd52018-05-07 15:42:31 +0200172 # Burn Partitions
173 dd if=${WORKDIR}/boot.img of=${SDIMG} conv=notrunc seek=1 bs=$(expr ${IMAGE_ROOTFS_ALIGNMENT} \* 1024)
174 # If SDIMG_ROOTFS_TYPE is a .xz file use xzcat
175 if echo "${SDIMG_ROOTFS_TYPE}" | egrep -q "*\.xz"
176 then
177 xzcat ${SDIMG_ROOTFS} | dd of=${SDIMG} conv=notrunc seek=1 bs=$(expr 1024 \* ${BOOT_SPACE_ALIGNED} + ${IMAGE_ROOTFS_ALIGNMENT} \* 1024)
178 else
179 dd if=${SDIMG_ROOTFS} of=${SDIMG} conv=notrunc seek=1 bs=$(expr 1024 \* ${BOOT_SPACE_ALIGNED} + ${IMAGE_ROOTFS_ALIGNMENT} \* 1024)
180 fi
Patrick Williams8b8bc412016-08-17 15:02:23 -0500181}
182
183ROOTFS_POSTPROCESS_COMMAND += " rpi_generate_sysctl_config ; "
184
185rpi_generate_sysctl_config() {
Brad Bishopf27bdd52018-05-07 15:42:31 +0200186 # systemd sysctl config
187 test -d ${IMAGE_ROOTFS}${sysconfdir}/sysctl.d && \
188 echo "vm.min_free_kbytes = 8192" > ${IMAGE_ROOTFS}${sysconfdir}/sysctl.d/rpi-vm.conf
Patrick Williams8b8bc412016-08-17 15:02:23 -0500189
Brad Bishopf27bdd52018-05-07 15:42:31 +0200190 # sysv sysctl config
191 IMAGE_SYSCTL_CONF="${IMAGE_ROOTFS}${sysconfdir}/sysctl.conf"
192 test -e ${IMAGE_ROOTFS}${sysconfdir}/sysctl.conf && \
193 sed -e "/vm.min_free_kbytes/d" -i ${IMAGE_SYSCTL_CONF}
194 echo "" >> ${IMAGE_SYSCTL_CONF} && echo "vm.min_free_kbytes = 8192" >> ${IMAGE_SYSCTL_CONF}
Patrick Williams8b8bc412016-08-17 15:02:23 -0500195}