blob: ab05cc90ff2eb17bd7364e1b9c18570fd945b138 [file] [log] [blame]
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05001# IMAGE_NAME is the base name for everything produced when building images.
2# The actual image that contains the rootfs has an additional suffix (.rootfs
3# by default) followed by additional suffices which describe the format (.ext4,
4# .ext4.xz, etc.).
5IMAGE_NAME_SUFFIX ??= ".rootfs"
Patrick Williamsc124f4f2015-09-15 14:41:29 -05006
7# The default aligment of the size of the rootfs is set to 1KiB. In case
8# you're using the SD card emulation of a QEMU system simulator you may
9# set this value to 2048 (2MiB alignment).
10IMAGE_ROOTFS_ALIGNMENT ?= "1"
11
12def imagetypes_getdepends(d):
13 def adddep(depstr, deps):
Patrick Williamsc0f7c042017-02-23 20:41:17 -060014 for d in (depstr or "").split():
15 # Add task dependency if not already present
16 if ":" not in d:
17 d += ":do_populate_sysroot"
18 deps.add(d)
Patrick Williamsc124f4f2015-09-15 14:41:29 -050019
Brad Bishop37a0e4d2017-12-04 01:01:44 -050020 # Take a type in the form of foo.bar.car and split it into the items
21 # needed for the image deps "foo", and the conversion deps ["bar", "car"]
22 def split_types(typestring):
23 types = typestring.split(".")
24 return types[0], types[1:]
25
Brad Bishop6e60e8b2018-02-01 10:27:11 -050026 fstypes = set((d.getVar('IMAGE_FSTYPES') or "").split())
27 fstypes |= set((d.getVar('IMAGE_FSTYPES_DEBUGFS') or "").split())
Patrick Williamsc0f7c042017-02-23 20:41:17 -060028
Brad Bishopd7bf8c12018-02-25 22:55:05 -050029 deprecated = set()
Patrick Williamsc0f7c042017-02-23 20:41:17 -060030 deps = set()
31 for typestring in fstypes:
Brad Bishop37a0e4d2017-12-04 01:01:44 -050032 basetype, resttypes = split_types(typestring)
Brad Bishopd7bf8c12018-02-25 22:55:05 -050033
34 var = "IMAGE_DEPENDS_%s" % basetype
35 if d.getVar(var) is not None:
36 deprecated.add(var)
Brad Bishop37a0e4d2017-12-04 01:01:44 -050037
Brad Bishop6e60e8b2018-02-01 10:27:11 -050038 for typedepends in (d.getVar("IMAGE_TYPEDEP_%s" % basetype) or "").split():
Brad Bishop37a0e4d2017-12-04 01:01:44 -050039 base, rest = split_types(typedepends)
Brad Bishop37a0e4d2017-12-04 01:01:44 -050040 resttypes += rest
41
Brad Bishopd7bf8c12018-02-25 22:55:05 -050042 var = "IMAGE_DEPENDS_%s" % base
43 if d.getVar(var) is not None:
44 deprecated.add(var)
45
Patrick Williamsc0f7c042017-02-23 20:41:17 -060046 for ctype in resttypes:
Brad Bishop6e60e8b2018-02-01 10:27:11 -050047 adddep(d.getVar("CONVERSION_DEPENDS_%s" % ctype), deps)
48 adddep(d.getVar("COMPRESS_DEPENDS_%s" % ctype), deps)
Patrick Williamsc124f4f2015-09-15 14:41:29 -050049
Brad Bishopd7bf8c12018-02-25 22:55:05 -050050 if deprecated:
51 bb.fatal('Deprecated variable(s) found: "%s". '
52 'Use do_image_<type>[depends] += "<recipe>:<task>" instead' % ', '.join(deprecated))
53
Patrick Williamsc0f7c042017-02-23 20:41:17 -060054 # Sort the set so that ordering is consistant
55 return " ".join(sorted(deps))
Patrick Williamsc124f4f2015-09-15 14:41:29 -050056
Brad Bishopc342db32019-05-15 21:57:59 -040057XZ_COMPRESSION_LEVEL ?= "-9"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050058XZ_INTEGRITY_CHECK ?= "crc32"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050059
Patrick Williamsc0f7c042017-02-23 20:41:17 -060060ZIP_COMPRESSION_LEVEL ?= "-9"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050061
Andrew Geissler82c905d2020-04-13 13:39:40 -050062ZSTD_COMPRESSION_LEVEL ?= "-3"
63
Patrick Williamsc0f7c042017-02-23 20:41:17 -060064JFFS2_SUM_EXTRA_ARGS ?= ""
65IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} --faketime --output=${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.jffs2 ${EXTRA_IMAGECMD}"
66
67IMAGE_CMD_cramfs = "mkfs.cramfs ${IMAGE_ROOTFS} ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.cramfs ${EXTRA_IMAGECMD}"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050068
69oe_mkext234fs () {
70 fstype=$1
71 extra_imagecmd=""
72
73 if [ $# -gt 1 ]; then
74 shift
75 extra_imagecmd=$@
76 fi
77
78 # If generating an empty image the size of the sparse block should be large
79 # enough to allocate an ext4 filesystem using 4096 bytes per inode, this is
80 # about 60K, so dd needs a minimum count of 60, with bs=1024 (bytes per IO)
81 eval local COUNT=\"0\"
82 eval local MIN_COUNT=\"60\"
83 if [ $ROOTFS_SIZE -lt $MIN_COUNT ]; then
84 eval COUNT=\"$MIN_COUNT\"
85 fi
86 # Create a sparse image block
Brad Bishopd7bf8c12018-02-25 22:55:05 -050087 bbdebug 1 Executing "dd if=/dev/zero of=${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.$fstype seek=$ROOTFS_SIZE count=$COUNT bs=1024"
Patrick Williamsc0f7c042017-02-23 20:41:17 -060088 dd if=/dev/zero of=${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.$fstype seek=$ROOTFS_SIZE count=$COUNT bs=1024
Brad Bishopd7bf8c12018-02-25 22:55:05 -050089 bbdebug 1 "Actual Rootfs size: `du -s ${IMAGE_ROOTFS}`"
Brad Bishop316dfdd2018-06-25 12:45:53 -040090 bbdebug 1 "Actual Partion size: `stat -c '%s' ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.$fstype`"
Brad Bishopd7bf8c12018-02-25 22:55:05 -050091 bbdebug 1 Executing "mkfs.$fstype -F $extra_imagecmd ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.$fstype -d ${IMAGE_ROOTFS}"
Patrick Williamsc0f7c042017-02-23 20:41:17 -060092 mkfs.$fstype -F $extra_imagecmd ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.$fstype -d ${IMAGE_ROOTFS}
Brad Bishop6e60e8b2018-02-01 10:27:11 -050093 # Error codes 0-3 indicate successfull operation of fsck (no errors or errors corrected)
94 fsck.$fstype -pvfD ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.$fstype || [ $? -le 3 ]
Patrick Williamsc124f4f2015-09-15 14:41:29 -050095}
96
97IMAGE_CMD_ext2 = "oe_mkext234fs ext2 ${EXTRA_IMAGECMD}"
98IMAGE_CMD_ext3 = "oe_mkext234fs ext3 ${EXTRA_IMAGECMD}"
99IMAGE_CMD_ext4 = "oe_mkext234fs ext4 ${EXTRA_IMAGECMD}"
100
101MIN_BTRFS_SIZE ?= "16384"
102IMAGE_CMD_btrfs () {
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500103 size=${ROOTFS_SIZE}
104 if [ ${size} -lt ${MIN_BTRFS_SIZE} ] ; then
105 size=${MIN_BTRFS_SIZE}
106 bbwarn "Rootfs size is too small for BTRFS. Filesystem will be extended to ${size}K"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500107 fi
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500108 dd if=/dev/zero of=${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.btrfs seek=${size} count=0 bs=1024
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500109 mkfs.btrfs ${EXTRA_IMAGECMD} -r ${IMAGE_ROOTFS} ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.btrfs
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500110}
111
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600112IMAGE_CMD_squashfs = "mksquashfs ${IMAGE_ROOTFS} ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.squashfs ${EXTRA_IMAGECMD} -noappend"
113IMAGE_CMD_squashfs-xz = "mksquashfs ${IMAGE_ROOTFS} ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.squashfs-xz ${EXTRA_IMAGECMD} -noappend -comp xz"
114IMAGE_CMD_squashfs-lzo = "mksquashfs ${IMAGE_ROOTFS} ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.squashfs-lzo ${EXTRA_IMAGECMD} -noappend -comp lzo"
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500115IMAGE_CMD_squashfs-lz4 = "mksquashfs ${IMAGE_ROOTFS} ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.squashfs-lz4 ${EXTRA_IMAGECMD} -noappend -comp lz4"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500116
117# By default, tar from the host is used, which can be quite old. If
118# you need special parameters (like --xattrs) which are only supported
119# by GNU tar upstream >= 1.27, then override that default:
120# IMAGE_CMD_TAR = "tar --xattrs --xattrs-include=*"
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500121# do_image_tar[depends] += "tar-replacement-native:do_populate_sysroot"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500122# EXTRANATIVEPATH += "tar-native"
123#
124# The GNU documentation does not specify whether --xattrs-include is necessary.
125# In practice, it turned out to be not needed when creating archives and
126# required when extracting, but it seems prudent to use it in both cases.
127IMAGE_CMD_TAR ?= "tar"
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500128# ignore return code 1 "file changed as we read it" as other tasks(e.g. do_image_wic) may be hardlinking rootfs
Brad Bishop316dfdd2018-06-25 12:45:53 -0400129IMAGE_CMD_tar = "${IMAGE_CMD_TAR} --numeric-owner -cf ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.tar -C ${IMAGE_ROOTFS} . || [ $? -eq 1 ]"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500130
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500131do_image_cpio[cleandirs] += "${WORKDIR}/cpio_append"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500132IMAGE_CMD_cpio () {
Andrew Geissler82c905d2020-04-13 13:39:40 -0500133 (cd ${IMAGE_ROOTFS} && find . | sort | cpio --reproducible -o -H newc >${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.cpio)
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600134 # We only need the /init symlink if we're building the real
135 # image. The -dbg image doesn't need it! By being clever
136 # about this we also avoid 'touch' below failing, as it
137 # might be trying to touch /sbin/init on the host since both
138 # the normal and the -dbg image share the same WORKDIR
139 if [ "${IMAGE_BUILDING_DEBUGFS}" != "true" ]; then
140 if [ ! -L ${IMAGE_ROOTFS}/init ] && [ ! -e ${IMAGE_ROOTFS}/init ]; then
141 if [ -L ${IMAGE_ROOTFS}/sbin/init ] || [ -e ${IMAGE_ROOTFS}/sbin/init ]; then
142 ln -sf /sbin/init ${WORKDIR}/cpio_append/init
143 else
144 touch ${WORKDIR}/cpio_append/init
145 fi
146 (cd ${WORKDIR}/cpio_append && echo ./init | cpio -oA -H newc -F ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.cpio)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500147 fi
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500148 fi
149}
150
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500151UBI_VOLNAME ?= "${MACHINE}-rootfs"
152
153multiubi_mkfs() {
154 local mkubifs_args="$1"
155 local ubinize_args="$2"
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500156
157 # Added prompt error message for ubi and ubifs image creation.
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800158 if [ -z "$mkubifs_args" ] || [ -z "$ubinize_args" ]; then
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500159 bbfatal "MKUBIFS_ARGS and UBINIZE_ARGS have to be set, see http://www.linux-mtd.infradead.org/faq/ubifs.html for details"
160 fi
161
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500162 if [ -z "$3" ]; then
163 local vname=""
164 else
165 local vname="_$3"
166 fi
167
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500168 echo \[ubifs\] > ubinize${vname}-${IMAGE_NAME}.cfg
169 echo mode=ubi >> ubinize${vname}-${IMAGE_NAME}.cfg
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600170 echo image=${IMGDEPLOYDIR}/${IMAGE_NAME}${vname}${IMAGE_NAME_SUFFIX}.ubifs >> ubinize${vname}-${IMAGE_NAME}.cfg
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500171 echo vol_id=0 >> ubinize${vname}-${IMAGE_NAME}.cfg
172 echo vol_type=dynamic >> ubinize${vname}-${IMAGE_NAME}.cfg
173 echo vol_name=${UBI_VOLNAME} >> ubinize${vname}-${IMAGE_NAME}.cfg
174 echo vol_flags=autoresize >> ubinize${vname}-${IMAGE_NAME}.cfg
Brad Bishopc342db32019-05-15 21:57:59 -0400175 if [ -n "$vname" ]; then
176 mkfs.ubifs -r ${IMAGE_ROOTFS} -o ${IMGDEPLOYDIR}/${IMAGE_NAME}${vname}${IMAGE_NAME_SUFFIX}.ubifs ${mkubifs_args}
177 fi
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600178 ubinize -o ${IMGDEPLOYDIR}/${IMAGE_NAME}${vname}${IMAGE_NAME_SUFFIX}.ubi ${ubinize_args} ubinize${vname}-${IMAGE_NAME}.cfg
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500179
180 # Cleanup cfg file
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600181 mv ubinize${vname}-${IMAGE_NAME}.cfg ${IMGDEPLOYDIR}/
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500182
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500183 # Create own symlinks for 'named' volumes
184 if [ -n "$vname" ]; then
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600185 cd ${IMGDEPLOYDIR}
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500186 if [ -e ${IMAGE_NAME}${vname}${IMAGE_NAME_SUFFIX}.ubifs ]; then
187 ln -sf ${IMAGE_NAME}${vname}${IMAGE_NAME_SUFFIX}.ubifs \
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500188 ${IMAGE_LINK_NAME}${vname}.ubifs
189 fi
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500190 if [ -e ${IMAGE_NAME}${vname}${IMAGE_NAME_SUFFIX}.ubi ]; then
191 ln -sf ${IMAGE_NAME}${vname}${IMAGE_NAME_SUFFIX}.ubi \
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500192 ${IMAGE_LINK_NAME}${vname}.ubi
193 fi
194 cd -
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500195 fi
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500196}
197
198IMAGE_CMD_multiubi () {
199 # Split MKUBIFS_ARGS_<name> and UBINIZE_ARGS_<name>
200 for name in ${MULTIUBI_BUILD}; do
201 eval local mkubifs_args=\"\$MKUBIFS_ARGS_${name}\"
202 eval local ubinize_args=\"\$UBINIZE_ARGS_${name}\"
203
204 multiubi_mkfs "${mkubifs_args}" "${ubinize_args}" "${name}"
205 done
206}
207
208IMAGE_CMD_ubi () {
209 multiubi_mkfs "${MKUBIFS_ARGS}" "${UBINIZE_ARGS}"
210}
Brad Bishopc342db32019-05-15 21:57:59 -0400211IMAGE_TYPEDEP_ubi = "ubifs"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500212
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600213IMAGE_CMD_ubifs = "mkfs.ubifs -r ${IMAGE_ROOTFS} -o ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.ubifs ${MKUBIFS_ARGS}"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500214
Brad Bishop316dfdd2018-06-25 12:45:53 -0400215MIN_F2FS_SIZE ?= "524288"
216IMAGE_CMD_f2fs () {
217 # We need to add additional smarts here form devices smaller than 1.5G
218 # Need to scale appropriately between 40M -> 1.5G as the "overprovision
219 # ratio" goes down as the device gets bigger (70% -> 4.5%), below about
220 # 500M the standard IMAGE_OVERHEAD_FACTOR does not work, so add additional
221 # space here when under 500M
222 size=${ROOTFS_SIZE}
223 if [ ${size} -lt ${MIN_F2FS_SIZE} ] ; then
224 size=${MIN_F2FS_SIZE}
225 bbwarn "Rootfs size is too small for F2FS. Filesystem will be extended to ${size}K"
226 fi
227 dd if=/dev/zero of=${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.f2fs seek=${size} count=0 bs=1024
228 mkfs.f2fs ${EXTRA_IMAGECMD} ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.f2fs
229 sload.f2fs -f ${IMAGE_ROOTFS} ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.f2fs
230}
231
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500232EXTRA_IMAGECMD = ""
233
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500234inherit siteinfo kernel-arch
Brad Bishop316dfdd2018-06-25 12:45:53 -0400235JFFS2_ENDIANNESS ?= "${@oe.utils.conditional('SITEINFO_ENDIANNESS', 'le', '-l', '-b', d)}"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500236JFFS2_ERASEBLOCK ?= "0x40000"
237EXTRA_IMAGECMD_jffs2 ?= "--pad ${JFFS2_ENDIANNESS} --eraseblock=${JFFS2_ERASEBLOCK} --no-cleanmarkers"
238
239# Change these if you want default mkfs behavior (i.e. create minimal inode number)
240EXTRA_IMAGECMD_ext2 ?= "-i 4096"
241EXTRA_IMAGECMD_ext3 ?= "-i 4096"
242EXTRA_IMAGECMD_ext4 ?= "-i 4096"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500243EXTRA_IMAGECMD_btrfs ?= "-n 4096"
Brad Bishop316dfdd2018-06-25 12:45:53 -0400244EXTRA_IMAGECMD_f2fs ?= ""
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500245
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300246do_image_cpio[depends] += "cpio-native:do_populate_sysroot"
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500247do_image_jffs2[depends] += "mtd-utils-native:do_populate_sysroot"
248do_image_cramfs[depends] += "util-linux-native:do_populate_sysroot"
249do_image_ext2[depends] += "e2fsprogs-native:do_populate_sysroot"
250do_image_ext3[depends] += "e2fsprogs-native:do_populate_sysroot"
251do_image_ext4[depends] += "e2fsprogs-native:do_populate_sysroot"
252do_image_btrfs[depends] += "btrfs-tools-native:do_populate_sysroot"
253do_image_squashfs[depends] += "squashfs-tools-native:do_populate_sysroot"
254do_image_squashfs_xz[depends] += "squashfs-tools-native:do_populate_sysroot"
255do_image_squashfs_lzo[depends] += "squashfs-tools-native:do_populate_sysroot"
256do_image_squashfs_lz4[depends] += "squashfs-tools-native:do_populate_sysroot"
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500257do_image_ubi[depends] += "mtd-utils-native:do_populate_sysroot"
258do_image_ubifs[depends] += "mtd-utils-native:do_populate_sysroot"
259do_image_multiubi[depends] += "mtd-utils-native:do_populate_sysroot"
Brad Bishop316dfdd2018-06-25 12:45:53 -0400260do_image_f2fs[depends] += "f2fs-tools-native:do_populate_sysroot"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500261
262# This variable is available to request which values are suitable for IMAGE_FSTYPES
263IMAGE_TYPES = " \
264 jffs2 jffs2.sum \
265 cramfs \
266 ext2 ext2.gz ext2.bz2 ext2.lzma \
267 ext3 ext3.gz \
268 ext4 ext4.gz \
269 btrfs \
270 iso \
271 hddimg \
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500272 squashfs squashfs-xz squashfs-lzo squashfs-lz4 \
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500273 ubi ubifs multiubi \
Andrew Geissler82c905d2020-04-13 13:39:40 -0500274 tar tar.gz tar.bz2 tar.xz tar.lz4 tar.zst \
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500275 cpio cpio.gz cpio.xz cpio.lzma cpio.lz4 \
Andrew Geissler1e34c2d2020-05-29 16:02:59 -0500276 wic wic.gz wic.bz2 wic.lzma wic.zst \
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500277 container \
Brad Bishop316dfdd2018-06-25 12:45:53 -0400278 f2fs \
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500279"
280
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600281# Compression is a special case of conversion. The old variable
282# names are still supported for backward-compatibility. When defining
283# new compression or conversion commands, use CONVERSIONTYPES and
284# CONVERSION_CMD/DEPENDS.
285COMPRESSIONTYPES ?= ""
286
Andrew Geissler82c905d2020-04-13 13:39:40 -0500287CONVERSIONTYPES = "gz bz2 lzma xz lz4 lzo zip zst sum md5sum sha1sum sha224sum sha256sum sha384sum sha512sum bmap u-boot vmdk vdi qcow2 base64 ${COMPRESSIONTYPES}"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600288CONVERSION_CMD_lzma = "lzma -k -f -7 ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}"
Brad Bishop08902b02019-08-20 09:16:51 -0400289CONVERSION_CMD_gz = "gzip -f -9 -n -c --rsyncable ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} > ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.gz"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600290CONVERSION_CMD_bz2 = "pbzip2 -f -k ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}"
Brad Bishop19323692019-04-05 15:28:33 -0400291CONVERSION_CMD_xz = "xz -f -k -c ${XZ_COMPRESSION_LEVEL} ${XZ_DEFAULTS} --check=${XZ_INTEGRITY_CHECK} ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} > ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.xz"
Brad Bishop316dfdd2018-06-25 12:45:53 -0400292CONVERSION_CMD_lz4 = "lz4 -9 -z -l ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.lz4"
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500293CONVERSION_CMD_lzo = "lzop -9 ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600294CONVERSION_CMD_zip = "zip ${ZIP_COMPRESSION_LEVEL} ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.zip ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}"
Andrew Geissler82c905d2020-04-13 13:39:40 -0500295CONVERSION_CMD_zst = "zstd -f -k -T0 -c ${ZSTD_COMPRESSION_LEVEL} ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} > ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.zst"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600296CONVERSION_CMD_sum = "sumtool -i ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} -o ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.sum ${JFFS2_SUM_EXTRA_ARGS}"
297CONVERSION_CMD_md5sum = "md5sum ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} > ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.md5sum"
298CONVERSION_CMD_sha1sum = "sha1sum ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} > ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.sha1sum"
299CONVERSION_CMD_sha224sum = "sha224sum ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} > ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.sha224sum"
300CONVERSION_CMD_sha256sum = "sha256sum ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} > ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.sha256sum"
301CONVERSION_CMD_sha384sum = "sha384sum ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} > ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.sha384sum"
302CONVERSION_CMD_sha512sum = "sha512sum ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} > ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.sha512sum"
303CONVERSION_CMD_bmap = "bmaptool create ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} -o ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.bmap"
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500304CONVERSION_CMD_u-boot = "mkimage -A ${UBOOT_ARCH} -O linux -T ramdisk -C none -n ${IMAGE_NAME} -d ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.u-boot"
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500305CONVERSION_CMD_vmdk = "qemu-img convert -O vmdk ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.vmdk"
306CONVERSION_CMD_vdi = "qemu-img convert -O vdi ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.vdi"
307CONVERSION_CMD_qcow2 = "qemu-img convert -O qcow2 ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.qcow2"
Brad Bishop19323692019-04-05 15:28:33 -0400308CONVERSION_CMD_base64 = "base64 ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} > ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.base64"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600309CONVERSION_DEPENDS_lzma = "xz-native"
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500310CONVERSION_DEPENDS_gz = "pigz-native"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600311CONVERSION_DEPENDS_bz2 = "pbzip2-native"
312CONVERSION_DEPENDS_xz = "xz-native"
313CONVERSION_DEPENDS_lz4 = "lz4-native"
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500314CONVERSION_DEPENDS_lzo = "lzop-native"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600315CONVERSION_DEPENDS_zip = "zip-native"
Andrew Geissler82c905d2020-04-13 13:39:40 -0500316CONVERSION_DEPENDS_zst = "zstd-native"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600317CONVERSION_DEPENDS_sum = "mtd-utils-native"
318CONVERSION_DEPENDS_bmap = "bmap-tools-native"
Brad Bishop19323692019-04-05 15:28:33 -0400319CONVERSION_DEPENDS_u-boot = "u-boot-tools-native"
320CONVERSION_DEPENDS_vmdk = "qemu-system-native"
321CONVERSION_DEPENDS_vdi = "qemu-system-native"
322CONVERSION_DEPENDS_qcow2 = "qemu-system-native"
323CONVERSION_DEPENDS_base64 = "coreutils-native"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500324
325RUNNABLE_IMAGE_TYPES ?= "ext2 ext3 ext4"
326RUNNABLE_MACHINE_PATTERNS ?= "qemu"
327
328DEPLOYABLE_IMAGE_TYPES ?= "hddimg iso"
329
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500330# The IMAGE_TYPES_MASKED variable will be used to mask out from the IMAGE_FSTYPES,
Brad Bishop08902b02019-08-20 09:16:51 -0400331# images that will not be built at do_rootfs time: vmdk, vdi, qcow2, hddimg, iso, etc.
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500332IMAGE_TYPES_MASKED ?= ""
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500333
334# bmap requires python3 to be in the PATH
335EXTRANATIVEPATH += "${@'python3-native' if d.getVar('IMAGE_FSTYPES').find('.bmap') else ''}"