blob: f363c42ee562a12e2a5fc7fc85dbc3c8290eaeb0 [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
Patrick Williamsc0f7c042017-02-23 20:41:17 -060057XZ_COMPRESSION_LEVEL ?= "-3"
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
Patrick Williamsc0f7c042017-02-23 20:41:17 -060062JFFS2_SUM_EXTRA_ARGS ?= ""
63IMAGE_CMD_jffs2 = "mkfs.jffs2 --root=${IMAGE_ROOTFS} --faketime --output=${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.jffs2 ${EXTRA_IMAGECMD}"
64
65IMAGE_CMD_cramfs = "mkfs.cramfs ${IMAGE_ROOTFS} ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.cramfs ${EXTRA_IMAGECMD}"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050066
67oe_mkext234fs () {
68 fstype=$1
69 extra_imagecmd=""
70
71 if [ $# -gt 1 ]; then
72 shift
73 extra_imagecmd=$@
74 fi
75
76 # If generating an empty image the size of the sparse block should be large
77 # enough to allocate an ext4 filesystem using 4096 bytes per inode, this is
78 # about 60K, so dd needs a minimum count of 60, with bs=1024 (bytes per IO)
79 eval local COUNT=\"0\"
80 eval local MIN_COUNT=\"60\"
81 if [ $ROOTFS_SIZE -lt $MIN_COUNT ]; then
82 eval COUNT=\"$MIN_COUNT\"
83 fi
84 # Create a sparse image block
Brad Bishopd7bf8c12018-02-25 22:55:05 -050085 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 -060086 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 -050087 bbdebug 1 "Actual Rootfs size: `du -s ${IMAGE_ROOTFS}`"
Brad Bishop316dfdd2018-06-25 12:45:53 -040088 bbdebug 1 "Actual Partion size: `stat -c '%s' ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.$fstype`"
Brad Bishopd7bf8c12018-02-25 22:55:05 -050089 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 -060090 mkfs.$fstype -F $extra_imagecmd ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.$fstype -d ${IMAGE_ROOTFS}
Brad Bishop6e60e8b2018-02-01 10:27:11 -050091 # Error codes 0-3 indicate successfull operation of fsck (no errors or errors corrected)
92 fsck.$fstype -pvfD ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.$fstype || [ $? -le 3 ]
Patrick Williamsc124f4f2015-09-15 14:41:29 -050093}
94
95IMAGE_CMD_ext2 = "oe_mkext234fs ext2 ${EXTRA_IMAGECMD}"
96IMAGE_CMD_ext3 = "oe_mkext234fs ext3 ${EXTRA_IMAGECMD}"
97IMAGE_CMD_ext4 = "oe_mkext234fs ext4 ${EXTRA_IMAGECMD}"
98
99MIN_BTRFS_SIZE ?= "16384"
100IMAGE_CMD_btrfs () {
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500101 size=${ROOTFS_SIZE}
102 if [ ${size} -lt ${MIN_BTRFS_SIZE} ] ; then
103 size=${MIN_BTRFS_SIZE}
104 bbwarn "Rootfs size is too small for BTRFS. Filesystem will be extended to ${size}K"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500105 fi
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500106 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 -0500107 mkfs.btrfs ${EXTRA_IMAGECMD} -r ${IMAGE_ROOTFS} ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.btrfs
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500108}
109
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600110IMAGE_CMD_squashfs = "mksquashfs ${IMAGE_ROOTFS} ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.squashfs ${EXTRA_IMAGECMD} -noappend"
111IMAGE_CMD_squashfs-xz = "mksquashfs ${IMAGE_ROOTFS} ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.squashfs-xz ${EXTRA_IMAGECMD} -noappend -comp xz"
112IMAGE_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 -0500113IMAGE_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 -0500114
115# By default, tar from the host is used, which can be quite old. If
116# you need special parameters (like --xattrs) which are only supported
117# by GNU tar upstream >= 1.27, then override that default:
118# IMAGE_CMD_TAR = "tar --xattrs --xattrs-include=*"
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500119# do_image_tar[depends] += "tar-replacement-native:do_populate_sysroot"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500120# EXTRANATIVEPATH += "tar-native"
121#
122# The GNU documentation does not specify whether --xattrs-include is necessary.
123# In practice, it turned out to be not needed when creating archives and
124# required when extracting, but it seems prudent to use it in both cases.
125IMAGE_CMD_TAR ?= "tar"
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500126# 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 -0400127IMAGE_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 -0500128
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500129do_image_cpio[cleandirs] += "${WORKDIR}/cpio_append"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500130IMAGE_CMD_cpio () {
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600131 (cd ${IMAGE_ROOTFS} && find . | cpio -o -H newc >${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.cpio)
132 # We only need the /init symlink if we're building the real
133 # image. The -dbg image doesn't need it! By being clever
134 # about this we also avoid 'touch' below failing, as it
135 # might be trying to touch /sbin/init on the host since both
136 # the normal and the -dbg image share the same WORKDIR
137 if [ "${IMAGE_BUILDING_DEBUGFS}" != "true" ]; then
138 if [ ! -L ${IMAGE_ROOTFS}/init ] && [ ! -e ${IMAGE_ROOTFS}/init ]; then
139 if [ -L ${IMAGE_ROOTFS}/sbin/init ] || [ -e ${IMAGE_ROOTFS}/sbin/init ]; then
140 ln -sf /sbin/init ${WORKDIR}/cpio_append/init
141 else
142 touch ${WORKDIR}/cpio_append/init
143 fi
144 (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 -0500145 fi
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500146 fi
147}
148
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500149UBI_VOLNAME ?= "${MACHINE}-rootfs"
150
151multiubi_mkfs() {
152 local mkubifs_args="$1"
153 local ubinize_args="$2"
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500154
155 # Added prompt error message for ubi and ubifs image creation.
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800156 if [ -z "$mkubifs_args" ] || [ -z "$ubinize_args" ]; then
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500157 bbfatal "MKUBIFS_ARGS and UBINIZE_ARGS have to be set, see http://www.linux-mtd.infradead.org/faq/ubifs.html for details"
158 fi
159
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500160 if [ -z "$3" ]; then
161 local vname=""
162 else
163 local vname="_$3"
164 fi
165
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500166 echo \[ubifs\] > ubinize${vname}-${IMAGE_NAME}.cfg
167 echo mode=ubi >> ubinize${vname}-${IMAGE_NAME}.cfg
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600168 echo image=${IMGDEPLOYDIR}/${IMAGE_NAME}${vname}${IMAGE_NAME_SUFFIX}.ubifs >> ubinize${vname}-${IMAGE_NAME}.cfg
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500169 echo vol_id=0 >> ubinize${vname}-${IMAGE_NAME}.cfg
170 echo vol_type=dynamic >> ubinize${vname}-${IMAGE_NAME}.cfg
171 echo vol_name=${UBI_VOLNAME} >> ubinize${vname}-${IMAGE_NAME}.cfg
172 echo vol_flags=autoresize >> ubinize${vname}-${IMAGE_NAME}.cfg
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600173 mkfs.ubifs -r ${IMAGE_ROOTFS} -o ${IMGDEPLOYDIR}/${IMAGE_NAME}${vname}${IMAGE_NAME_SUFFIX}.ubifs ${mkubifs_args}
174 ubinize -o ${IMGDEPLOYDIR}/${IMAGE_NAME}${vname}${IMAGE_NAME_SUFFIX}.ubi ${ubinize_args} ubinize${vname}-${IMAGE_NAME}.cfg
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500175
176 # Cleanup cfg file
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600177 mv ubinize${vname}-${IMAGE_NAME}.cfg ${IMGDEPLOYDIR}/
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500178
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500179 # Create own symlinks for 'named' volumes
180 if [ -n "$vname" ]; then
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600181 cd ${IMGDEPLOYDIR}
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500182 if [ -e ${IMAGE_NAME}${vname}${IMAGE_NAME_SUFFIX}.ubifs ]; then
183 ln -sf ${IMAGE_NAME}${vname}${IMAGE_NAME_SUFFIX}.ubifs \
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500184 ${IMAGE_LINK_NAME}${vname}.ubifs
185 fi
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500186 if [ -e ${IMAGE_NAME}${vname}${IMAGE_NAME_SUFFIX}.ubi ]; then
187 ln -sf ${IMAGE_NAME}${vname}${IMAGE_NAME_SUFFIX}.ubi \
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500188 ${IMAGE_LINK_NAME}${vname}.ubi
189 fi
190 cd -
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500191 fi
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500192}
193
194IMAGE_CMD_multiubi () {
195 # Split MKUBIFS_ARGS_<name> and UBINIZE_ARGS_<name>
196 for name in ${MULTIUBI_BUILD}; do
197 eval local mkubifs_args=\"\$MKUBIFS_ARGS_${name}\"
198 eval local ubinize_args=\"\$UBINIZE_ARGS_${name}\"
199
200 multiubi_mkfs "${mkubifs_args}" "${ubinize_args}" "${name}"
201 done
202}
203
204IMAGE_CMD_ubi () {
205 multiubi_mkfs "${MKUBIFS_ARGS}" "${UBINIZE_ARGS}"
206}
207
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600208IMAGE_CMD_ubifs = "mkfs.ubifs -r ${IMAGE_ROOTFS} -o ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.ubifs ${MKUBIFS_ARGS}"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500209
Brad Bishop316dfdd2018-06-25 12:45:53 -0400210MIN_F2FS_SIZE ?= "524288"
211IMAGE_CMD_f2fs () {
212 # We need to add additional smarts here form devices smaller than 1.5G
213 # Need to scale appropriately between 40M -> 1.5G as the "overprovision
214 # ratio" goes down as the device gets bigger (70% -> 4.5%), below about
215 # 500M the standard IMAGE_OVERHEAD_FACTOR does not work, so add additional
216 # space here when under 500M
217 size=${ROOTFS_SIZE}
218 if [ ${size} -lt ${MIN_F2FS_SIZE} ] ; then
219 size=${MIN_F2FS_SIZE}
220 bbwarn "Rootfs size is too small for F2FS. Filesystem will be extended to ${size}K"
221 fi
222 dd if=/dev/zero of=${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.f2fs seek=${size} count=0 bs=1024
223 mkfs.f2fs ${EXTRA_IMAGECMD} ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.f2fs
224 sload.f2fs -f ${IMAGE_ROOTFS} ${IMGDEPLOYDIR}/${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.f2fs
225}
226
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500227EXTRA_IMAGECMD = ""
228
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500229inherit siteinfo kernel-arch
Brad Bishop316dfdd2018-06-25 12:45:53 -0400230JFFS2_ENDIANNESS ?= "${@oe.utils.conditional('SITEINFO_ENDIANNESS', 'le', '-l', '-b', d)}"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500231JFFS2_ERASEBLOCK ?= "0x40000"
232EXTRA_IMAGECMD_jffs2 ?= "--pad ${JFFS2_ENDIANNESS} --eraseblock=${JFFS2_ERASEBLOCK} --no-cleanmarkers"
233
234# Change these if you want default mkfs behavior (i.e. create minimal inode number)
235EXTRA_IMAGECMD_ext2 ?= "-i 4096"
236EXTRA_IMAGECMD_ext3 ?= "-i 4096"
237EXTRA_IMAGECMD_ext4 ?= "-i 4096"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500238EXTRA_IMAGECMD_btrfs ?= "-n 4096"
Brad Bishop316dfdd2018-06-25 12:45:53 -0400239EXTRA_IMAGECMD_f2fs ?= ""
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500240
Brad Bishopa5c52ff2018-11-23 10:55:50 +1300241do_image_cpio[depends] += "cpio-native:do_populate_sysroot"
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500242do_image_jffs2[depends] += "mtd-utils-native:do_populate_sysroot"
243do_image_cramfs[depends] += "util-linux-native:do_populate_sysroot"
244do_image_ext2[depends] += "e2fsprogs-native:do_populate_sysroot"
245do_image_ext3[depends] += "e2fsprogs-native:do_populate_sysroot"
246do_image_ext4[depends] += "e2fsprogs-native:do_populate_sysroot"
247do_image_btrfs[depends] += "btrfs-tools-native:do_populate_sysroot"
248do_image_squashfs[depends] += "squashfs-tools-native:do_populate_sysroot"
249do_image_squashfs_xz[depends] += "squashfs-tools-native:do_populate_sysroot"
250do_image_squashfs_lzo[depends] += "squashfs-tools-native:do_populate_sysroot"
251do_image_squashfs_lz4[depends] += "squashfs-tools-native:do_populate_sysroot"
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500252do_image_ubi[depends] += "mtd-utils-native:do_populate_sysroot"
253do_image_ubifs[depends] += "mtd-utils-native:do_populate_sysroot"
254do_image_multiubi[depends] += "mtd-utils-native:do_populate_sysroot"
Brad Bishop316dfdd2018-06-25 12:45:53 -0400255do_image_f2fs[depends] += "f2fs-tools-native:do_populate_sysroot"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500256
257# This variable is available to request which values are suitable for IMAGE_FSTYPES
258IMAGE_TYPES = " \
259 jffs2 jffs2.sum \
260 cramfs \
261 ext2 ext2.gz ext2.bz2 ext2.lzma \
262 ext3 ext3.gz \
263 ext4 ext4.gz \
264 btrfs \
265 iso \
266 hddimg \
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500267 squashfs squashfs-xz squashfs-lzo squashfs-lz4 \
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500268 ubi ubifs multiubi \
269 tar tar.gz tar.bz2 tar.xz tar.lz4 \
270 cpio cpio.gz cpio.xz cpio.lzma cpio.lz4 \
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500271 wic wic.gz wic.bz2 wic.lzma \
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500272 container \
Brad Bishop316dfdd2018-06-25 12:45:53 -0400273 f2fs \
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500274"
275
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600276# Compression is a special case of conversion. The old variable
277# names are still supported for backward-compatibility. When defining
278# new compression or conversion commands, use CONVERSIONTYPES and
279# CONVERSION_CMD/DEPENDS.
280COMPRESSIONTYPES ?= ""
281
Brad Bishop19323692019-04-05 15:28:33 -0400282CONVERSIONTYPES = "gz bz2 lzma xz lz4 lzo zip sum md5sum sha1sum sha224sum sha256sum sha384sum sha512sum bmap u-boot vmdk vdi qcow2 base64 ${COMPRESSIONTYPES}"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600283CONVERSION_CMD_lzma = "lzma -k -f -7 ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}"
Brad Bishop316dfdd2018-06-25 12:45:53 -0400284CONVERSION_CMD_gz = "pigz -f -9 -n -c ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} > ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.gz"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600285CONVERSION_CMD_bz2 = "pbzip2 -f -k ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}"
Brad Bishop19323692019-04-05 15:28:33 -0400286CONVERSION_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 -0400287CONVERSION_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 -0500288CONVERSION_CMD_lzo = "lzop -9 ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600289CONVERSION_CMD_zip = "zip ${ZIP_COMPRESSION_LEVEL} ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.zip ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}"
290CONVERSION_CMD_sum = "sumtool -i ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} -o ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.sum ${JFFS2_SUM_EXTRA_ARGS}"
291CONVERSION_CMD_md5sum = "md5sum ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} > ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.md5sum"
292CONVERSION_CMD_sha1sum = "sha1sum ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} > ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.sha1sum"
293CONVERSION_CMD_sha224sum = "sha224sum ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} > ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.sha224sum"
294CONVERSION_CMD_sha256sum = "sha256sum ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} > ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.sha256sum"
295CONVERSION_CMD_sha384sum = "sha384sum ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} > ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.sha384sum"
296CONVERSION_CMD_sha512sum = "sha512sum ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} > ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.sha512sum"
297CONVERSION_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 -0500298CONVERSION_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 -0500299CONVERSION_CMD_vmdk = "qemu-img convert -O vmdk ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.vmdk"
300CONVERSION_CMD_vdi = "qemu-img convert -O vdi ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.vdi"
301CONVERSION_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 -0400302CONVERSION_CMD_base64 = "base64 ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type} > ${IMAGE_NAME}${IMAGE_NAME_SUFFIX}.${type}.base64"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600303CONVERSION_DEPENDS_lzma = "xz-native"
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500304CONVERSION_DEPENDS_gz = "pigz-native"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600305CONVERSION_DEPENDS_bz2 = "pbzip2-native"
306CONVERSION_DEPENDS_xz = "xz-native"
307CONVERSION_DEPENDS_lz4 = "lz4-native"
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500308CONVERSION_DEPENDS_lzo = "lzop-native"
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600309CONVERSION_DEPENDS_zip = "zip-native"
310CONVERSION_DEPENDS_sum = "mtd-utils-native"
311CONVERSION_DEPENDS_bmap = "bmap-tools-native"
Brad Bishop19323692019-04-05 15:28:33 -0400312CONVERSION_DEPENDS_u-boot = "u-boot-tools-native"
313CONVERSION_DEPENDS_vmdk = "qemu-system-native"
314CONVERSION_DEPENDS_vdi = "qemu-system-native"
315CONVERSION_DEPENDS_qcow2 = "qemu-system-native"
316CONVERSION_DEPENDS_base64 = "coreutils-native"
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500317
318RUNNABLE_IMAGE_TYPES ?= "ext2 ext3 ext4"
319RUNNABLE_MACHINE_PATTERNS ?= "qemu"
320
321DEPLOYABLE_IMAGE_TYPES ?= "hddimg iso"
322
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500323# The IMAGE_TYPES_MASKED variable will be used to mask out from the IMAGE_FSTYPES,
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500324# images that will not be built at do_rootfs time: vmdk, vdi, qcow2, hdddirect, hddimg, iso, etc.
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500325IMAGE_TYPES_MASKED ?= ""
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500326
327# bmap requires python3 to be in the PATH
328EXTRANATIVEPATH += "${@'python3-native' if d.getVar('IMAGE_FSTYPES').find('.bmap') else ''}"