blob: 0ae98cdab3563c63f9a0082cbd36a33eb6e144c4 [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# <--------->
16# 4MiB 40MiB SDIMG_ROOTFS
17# <-----------------------> <----------> <---------------------->
18# ------------------------ ------------ ------------------------
19# | IMAGE_ROOTFS_ALIGNMENT | BOOT_SPACE | ROOTFS_SIZE |
20# ------------------------ ------------ ------------------------
21# ^ ^ ^ ^
22# | | | |
23# 0 4MiB 4MiB + 40MiB 4MiB + 40Mib + SDIMG_ROOTFS
24
25# This image depends on the rootfs image
26IMAGE_TYPEDEP_rpi-sdimg = "${SDIMG_ROOTFS_TYPE}"
27
Patrick Williams8b8bc412016-08-17 15:02:23 -050028# Kernel image name
29SDIMG_KERNELIMAGE_raspberrypi ?= "kernel.img"
30SDIMG_KERNELIMAGE_raspberrypi2 ?= "kernel7.img"
Brad Bishop3a5fbf52017-12-04 02:17:07 -050031SDIMG_KERNELIMAGE_raspberrypi3-64 ?= "kernel8.img"
Patrick Williams8b8bc412016-08-17 15:02:23 -050032
33# Boot partition volume id
34BOOTDD_VOLUME_ID ?= "${MACHINE}"
35
36# Boot partition size [in KiB] (will be rounded up to IMAGE_ROOTFS_ALIGNMENT)
37BOOT_SPACE ?= "40960"
38
39# Set alignment to 4MB [in KiB]
40IMAGE_ROOTFS_ALIGNMENT = "4096"
41
42# Use an uncompressed ext3 by default as rootfs
43SDIMG_ROOTFS_TYPE ?= "ext3"
Brad Bishopd7bf8c12018-02-25 22:55:05 -050044SDIMG_ROOTFS = "${IMGDEPLOYDIR}/${IMAGE_LINK_NAME}.${SDIMG_ROOTFS_TYPE}"
Patrick Williams8b8bc412016-08-17 15:02:23 -050045
Brad Bishop1a4b7ee2018-12-16 17:11:34 -080046# For the names of kernel artifacts
47inherit kernel-artifact-names
48
Andrew Geissler9d7e0aa2020-08-21 15:56:44 -050049RPI_SDIMG_EXTRA_DEPENDS ?= ""
50
Brad Bishopd7bf8c12018-02-25 22:55:05 -050051do_image_rpi_sdimg[depends] = " \
Brad Bishopf27bdd52018-05-07 15:42:31 +020052 parted-native:do_populate_sysroot \
53 mtools-native:do_populate_sysroot \
54 dosfstools-native:do_populate_sysroot \
55 virtual/kernel:do_deploy \
Andrew Geissler26e4bea2020-11-30 19:54:03 -060056 rpi-bootfiles:do_deploy \
Brad Bishop26bdd442019-08-16 17:08:17 -040057 ${@bb.utils.contains('MACHINE_FEATURES', 'armstub', 'armstubs:do_deploy', '' ,d)} \
Brad Bishopf27bdd52018-05-07 15:42:31 +020058 ${@bb.utils.contains('RPI_USE_U_BOOT', '1', 'u-boot:do_deploy', '',d)} \
Andrew Geissler062316f2020-05-15 14:19:14 -050059 ${@bb.utils.contains('RPI_USE_U_BOOT', '1', 'u-boot-default-script:do_deploy', '',d)} \
Andrew Geissler9d7e0aa2020-08-21 15:56:44 -050060 ${RPI_SDIMG_EXTRA_DEPENDS} \
Brad Bishopf27bdd52018-05-07 15:42:31 +020061"
Patrick Williams8b8bc412016-08-17 15:02:23 -050062
Brad Bishop316dfdd2018-06-25 12:45:53 -040063do_image_rpi_sdimg[recrdeps] = "do_build"
64
Patrick Williams8b8bc412016-08-17 15:02:23 -050065# SD card image name
Brad Bishop31121382019-12-06 18:34:07 -050066SDIMG = "${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.rpi-sdimg"
Patrick Williams8b8bc412016-08-17 15:02:23 -050067
Patrick Williams8b8bc412016-08-17 15:02:23 -050068# Additional files and/or directories to be copied into the vfat partition from the IMAGE_ROOTFS.
69FATPAYLOAD ?= ""
70
Brad Bishop6e60e8b2018-02-01 10:27:11 -050071# SD card vfat partition image name
Brad Bishop1a4b7ee2018-12-16 17:11:34 -080072SDIMG_VFAT_DEPLOY ?= "${RPI_USE_U_BOOT}"
Brad Bishop6e60e8b2018-02-01 10:27:11 -050073SDIMG_VFAT = "${IMAGE_NAME}.vfat"
74SDIMG_LINK_VFAT = "${IMGDEPLOYDIR}/${IMAGE_LINK_NAME}.vfat"
75
Brad Bishopd7bf8c12018-02-25 22:55:05 -050076def split_overlays(d, out, ver=None):
77 dts = d.getVar("KERNEL_DEVICETREE")
Brad Bishopf27bdd52018-05-07 15:42:31 +020078 # Device Tree Overlays are assumed to be suffixed by '-overlay.dtb' (4.1.x) or by '.dtbo' (4.4.9+) string and will be put in a dedicated folder
Brad Bishopd7bf8c12018-02-25 22:55:05 -050079 if out:
80 overlays = oe.utils.str_filter_out('\S+\-overlay\.dtb$', dts, d)
81 overlays = oe.utils.str_filter_out('\S+\.dtbo$', overlays, d)
82 else:
83 overlays = oe.utils.str_filter('\S+\-overlay\.dtb$', dts, d) + \
84 " " + oe.utils.str_filter('\S+\.dtbo$', dts, d)
85
86 return overlays
87
Patrick Williams8b8bc412016-08-17 15:02:23 -050088IMAGE_CMD_rpi-sdimg () {
89
Brad Bishopf27bdd52018-05-07 15:42:31 +020090 # Align partitions
91 BOOT_SPACE_ALIGNED=$(expr ${BOOT_SPACE} + ${IMAGE_ROOTFS_ALIGNMENT} - 1)
92 BOOT_SPACE_ALIGNED=$(expr ${BOOT_SPACE_ALIGNED} - ${BOOT_SPACE_ALIGNED} % ${IMAGE_ROOTFS_ALIGNMENT})
93 SDIMG_SIZE=$(expr ${IMAGE_ROOTFS_ALIGNMENT} + ${BOOT_SPACE_ALIGNED} + $ROOTFS_SIZE)
Patrick Williams8b8bc412016-08-17 15:02:23 -050094
Brad Bishopf27bdd52018-05-07 15:42:31 +020095 echo "Creating filesystem with Boot partition ${BOOT_SPACE_ALIGNED} KiB and RootFS $ROOTFS_SIZE KiB"
Patrick Williams8b8bc412016-08-17 15:02:23 -050096
Brad Bishopf27bdd52018-05-07 15:42:31 +020097 # Check if we are building with device tree support
98 DTS="${KERNEL_DEVICETREE}"
Patrick Williams8b8bc412016-08-17 15:02:23 -050099
Brad Bishopf27bdd52018-05-07 15:42:31 +0200100 # Initialize sdcard image file
101 dd if=/dev/zero of=${SDIMG} bs=1024 count=0 seek=${SDIMG_SIZE}
Patrick Williams8b8bc412016-08-17 15:02:23 -0500102
Brad Bishopf27bdd52018-05-07 15:42:31 +0200103 # Create partition table
104 parted -s ${SDIMG} mklabel msdos
105 # Create boot partition and mark it as bootable
106 parted -s ${SDIMG} unit KiB mkpart primary fat32 ${IMAGE_ROOTFS_ALIGNMENT} $(expr ${BOOT_SPACE_ALIGNED} \+ ${IMAGE_ROOTFS_ALIGNMENT})
107 parted -s ${SDIMG} set 1 boot on
108 # Create rootfs partition to the end of disk
109 parted -s ${SDIMG} -- unit KiB mkpart primary ext2 $(expr ${BOOT_SPACE_ALIGNED} \+ ${IMAGE_ROOTFS_ALIGNMENT}) -1s
110 parted ${SDIMG} print
Patrick Williams8b8bc412016-08-17 15:02:23 -0500111
Brad Bishopf27bdd52018-05-07 15:42:31 +0200112 # Create a vfat image with boot files
113 BOOT_BLOCKS=$(LC_ALL=C parted -s ${SDIMG} unit b print | awk '/ 1 / { print substr($4, 1, length($4 -1)) / 512 /2 }')
114 rm -f ${WORKDIR}/boot.img
Andrew Geissler1c349142019-02-19 19:49:56 -0600115 mkfs.vfat -F32 -n "${BOOTDD_VOLUME_ID}" -S 512 -C ${WORKDIR}/boot.img $BOOT_BLOCKS
Andrew Geissler9d7e0aa2020-08-21 15:56:44 -0500116 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 -0400117 if [ "${@bb.utils.contains("MACHINE_FEATURES", "armstub", "1", "0", d)}" = "1" ]; then
118 mcopy -v -i ${WORKDIR}/boot.img -s ${DEPLOY_DIR_IMAGE}/armstubs/${ARMSTUB} ::/ || bbfatal "mcopy cannot copy ${DEPLOY_DIR_IMAGE}/armstubs/${ARMSTUB} into boot.img"
119 fi
Brad Bishopf27bdd52018-05-07 15:42:31 +0200120 if test -n "${DTS}"; then
121 # Copy board device trees to root folder
122 for dtbf in ${@split_overlays(d, True)}; do
123 dtb=`basename $dtbf`
Brad Bishop26bdd442019-08-16 17:08:17 -0400124 mcopy -v -i ${WORKDIR}/boot.img -s ${DEPLOY_DIR_IMAGE}/$dtb ::$dtb || bbfatal "mcopy cannot copy ${DEPLOY_DIR_IMAGE}/$dtb into boot.img"
Brad Bishopf27bdd52018-05-07 15:42:31 +0200125 done
Patrick Williams8b8bc412016-08-17 15:02:23 -0500126
Brad Bishopf27bdd52018-05-07 15:42:31 +0200127 # Copy device tree overlays to dedicated folder
128 mmd -i ${WORKDIR}/boot.img overlays
129 for dtbf in ${@split_overlays(d, False)}; do
130 dtb=`basename $dtbf`
Brad Bishop26bdd442019-08-16 17:08:17 -0400131 mcopy -v -i ${WORKDIR}/boot.img -s ${DEPLOY_DIR_IMAGE}/$dtb ::overlays/$dtb || bbfatal "mcopy cannot copy ${DEPLOY_DIR_IMAGE}/$dtb into boot.img"
Brad Bishopf27bdd52018-05-07 15:42:31 +0200132 done
133 fi
134 if [ "${RPI_USE_U_BOOT}" = "1" ]; then
Brad Bishop26bdd442019-08-16 17:08:17 -0400135 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"
136 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 -0800137 if [ ! -z "${INITRAMFS_IMAGE}" -a "${INITRAMFS_IMAGE_BUNDLE}" = "1" ]; then
Brad Bishop26bdd442019-08-16 17:08:17 -0400138 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 -0800139 else
Brad Bishop26bdd442019-08-16 17:08:17 -0400140 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 -0800141 fi
Brad Bishopf27bdd52018-05-07 15:42:31 +0200142 else
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800143 if [ ! -z "${INITRAMFS_IMAGE}" -a "${INITRAMFS_IMAGE_BUNDLE}" = "1" ]; then
Brad Bishop26bdd442019-08-16 17:08:17 -0400144 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 -0800145 else
Brad Bishop26bdd442019-08-16 17:08:17 -0400146 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 -0800147 fi
Brad Bishopf27bdd52018-05-07 15:42:31 +0200148 fi
Patrick Williams8b8bc412016-08-17 15:02:23 -0500149
Andrew Geissler9d7e0aa2020-08-21 15:56:44 -0500150 # Add files (eg. hypervisor binaries) from the deploy dir
151 if [ -n "${DEPLOYPAYLOAD}" ] ; then
152 echo "Copying deploy file payload into VFAT"
153 for entry in ${DEPLOYPAYLOAD} ; do
154 # Split entry at optional ':' to enable file renaming for the destination
155 if [ $(echo "$entry" | grep -c :) = "0" ] ; then
156 DEPLOY_FILE="$entry"
157 DEST_FILENAME="$entry"
158 else
159 DEPLOY_FILE="$(echo "$entry" | cut -f1 -d:)"
160 DEST_FILENAME="$(echo "$entry" | cut -f2- -d:)"
161 fi
162 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"
163 done
164 fi
165
Brad Bishop15ae2502019-06-18 21:44:24 -0400166 if [ -n "${FATPAYLOAD}" ] ; then
Brad Bishopf27bdd52018-05-07 15:42:31 +0200167 echo "Copying payload into VFAT"
168 for entry in ${FATPAYLOAD} ; do
Brad Bishop26bdd442019-08-16 17:08:17 -0400169 # use bbwarn instead of bbfatal to stop aborting on vfat issues like not supporting .~lock files
170 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 +0200171 done
172 fi
Patrick Williams8b8bc412016-08-17 15:02:23 -0500173
Brad Bishopf27bdd52018-05-07 15:42:31 +0200174 # Add stamp file
175 echo "${IMAGE_NAME}" > ${WORKDIR}/image-version-info
Brad Bishop26bdd442019-08-16 17:08:17 -0400176 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 -0500177
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800178 # Deploy vfat partition
179 if [ "${SDIMG_VFAT_DEPLOY}" = "1" ]; then
Brad Bishopf27bdd52018-05-07 15:42:31 +0200180 cp ${WORKDIR}/boot.img ${IMGDEPLOYDIR}/${SDIMG_VFAT}
181 ln -sf ${SDIMG_VFAT} ${SDIMG_LINK_VFAT}
182 fi
Patrick Williams8b8bc412016-08-17 15:02:23 -0500183
Brad Bishopf27bdd52018-05-07 15:42:31 +0200184 # Burn Partitions
185 dd if=${WORKDIR}/boot.img of=${SDIMG} conv=notrunc seek=1 bs=$(expr ${IMAGE_ROOTFS_ALIGNMENT} \* 1024)
186 # If SDIMG_ROOTFS_TYPE is a .xz file use xzcat
187 if echo "${SDIMG_ROOTFS_TYPE}" | egrep -q "*\.xz"
188 then
189 xzcat ${SDIMG_ROOTFS} | dd of=${SDIMG} conv=notrunc seek=1 bs=$(expr 1024 \* ${BOOT_SPACE_ALIGNED} + ${IMAGE_ROOTFS_ALIGNMENT} \* 1024)
190 else
191 dd if=${SDIMG_ROOTFS} of=${SDIMG} conv=notrunc seek=1 bs=$(expr 1024 \* ${BOOT_SPACE_ALIGNED} + ${IMAGE_ROOTFS_ALIGNMENT} \* 1024)
192 fi
Patrick Williams8b8bc412016-08-17 15:02:23 -0500193}
194
195ROOTFS_POSTPROCESS_COMMAND += " rpi_generate_sysctl_config ; "
196
197rpi_generate_sysctl_config() {
Brad Bishopf27bdd52018-05-07 15:42:31 +0200198 # systemd sysctl config
199 test -d ${IMAGE_ROOTFS}${sysconfdir}/sysctl.d && \
200 echo "vm.min_free_kbytes = 8192" > ${IMAGE_ROOTFS}${sysconfdir}/sysctl.d/rpi-vm.conf
Patrick Williams8b8bc412016-08-17 15:02:23 -0500201
Brad Bishopf27bdd52018-05-07 15:42:31 +0200202 # sysv sysctl config
203 IMAGE_SYSCTL_CONF="${IMAGE_ROOTFS}${sysconfdir}/sysctl.conf"
204 test -e ${IMAGE_ROOTFS}${sysconfdir}/sysctl.conf && \
205 sed -e "/vm.min_free_kbytes/d" -i ${IMAGE_SYSCTL_CONF}
206 echo "" >> ${IMAGE_SYSCTL_CONF} && echo "vm.min_free_kbytes = 8192" >> ${IMAGE_SYSCTL_CONF}
Patrick Williams8b8bc412016-08-17 15:02:23 -0500207}