include/image-commands.mk

   1 # Build commands that can be called from Device/* templates
   2
   3 IMAGE_KERNEL = $(word 1,$^)
   4 IMAGE_ROOTFS = $(word 2,$^)
   5
   6 define rootfs_align
   7 $(patsubst %-256k,0x40000,$(patsubst %-128k,0x20000,$(patsubst %-64k,0x10000,$(patsubst squashfs%,0x4,$(patsubst root.%,%,$(1))))))
   8 endef
   9
  10
  11 define Build/append-dtb
  12         cat $(KDIR)/image-$(firstword $(DEVICE_DTS)).dtb >> $@
  13 endef
  14
  15 define Build/append-dtb-elf
  16         $(TARGET_CROSS)objcopy \
  17                 --set-section-flags=.appended_dtb=alloc,contents \
  18                 --update-section \
  19                 .appended_dtb=$(KDIR)/image-$(firstword $(DEVICE_DTS)).dtb $@
  20 endef
  21
  22 define Build/append-kernel
  23         dd if=$(IMAGE_KERNEL) >> $@
  24 endef
  25
  26 compat_version=$(if $(DEVICE_COMPAT_VERSION),$(DEVICE_COMPAT_VERSION),1.0)
  27 json_quote=$(subst ','\'',$(subst ",\",$(1)))
  28 #")')
  29
  30 legacy_supported_message=$(SUPPORTED_DEVICES) - Image version mismatch: image $(compat_version), \
  31         device 1.0. Please wipe config during upgrade (force required) or reinstall. \
  32         $(if $(DEVICE_COMPAT_MESSAGE),Reason: $(DEVICE_COMPAT_MESSAGE),Please check documentation ...)
  33
  34 metadata_devices=$(if $(1),$(subst "$(space)","$(comma)",$(strip $(foreach v,$(1),"$(call json_quote,$(v))"))))
  35 metadata_json = \
  36         '{ $(if $(IMAGE_METADATA),$(IMAGE_METADATA)$(comma)) \
  37                 "metadata_version": "1.1", \
  38                 "compat_version": "$(call json_quote,$(compat_version))", \
  39                 $(if $(DEVICE_COMPAT_MESSAGE),"compat_message": "$(call json_quote,$(DEVICE_COMPAT_MESSAGE))"$(comma)) \
  40                 $(if $(filter-out 1.0,$(compat_version)),"new_supported_devices": \
  41                         [$(call metadata_devices,$(SUPPORTED_DEVICES))]$(comma) \
  42                         "supported_devices": ["$(call json_quote,$(legacy_supported_message))"]$(comma)) \
  43                 $(if $(filter 1.0,$(compat_version)),"supported_devices":[$(call metadata_devices,$(SUPPORTED_DEVICES))]$(comma)) \
  44                 "version": { \
  45                         "dist": "$(call json_quote,$(VERSION_DIST))", \
  46                         "version": "$(call json_quote,$(VERSION_NUMBER))", \
  47                         "revision": "$(call json_quote,$(REVISION))", \
  48                         "target": "$(call json_quote,$(TARGETID))", \
  49                         "board": "$(call json_quote,$(if $(BOARD_NAME),$(BOARD_NAME),$(DEVICE_NAME)))" \
  50                 } \
  51         }'
  52
  53 define Build/append-metadata
  54         $(if $(SUPPORTED_DEVICES),-echo $(call metadata_json) | fwtool -I - $@)
  55         [ ! -s "$(BUILD_KEY)" -o ! -s "$(BUILD_KEY).ucert" -o ! -s "$@" ] || { \
  56                 cp "$(BUILD_KEY).ucert" "$@.ucert" ;\
  57                 usign -S -m "$@" -s "$(BUILD_KEY)" -x "$@.sig" ;\
  58                 ucert -A -c "$@.ucert" -x "$@.sig" ;\
  59                 fwtool -S "$@.ucert" "$@" ;\
  60         }
  61 endef
  62
  63 define Build/append-rootfs
  64         dd if=$(IMAGE_ROOTFS) >> $@
  65 endef
  66
  67 define Build/append-squashfs-fakeroot-be
  68         rm -rf $@.fakefs $@.fakesquashfs
  69         mkdir $@.fakefs
  70         $(STAGING_DIR_HOST)/bin/mksquashfs-lzma \
  71                 $@.fakefs $@.fakesquashfs \
  72                 -noappend -root-owned -be -nopad -b 65536 \
  73                 $(if $(SOURCE_DATE_EPOCH),-fixed-time $(SOURCE_DATE_EPOCH))
  74         cat $@.fakesquashfs >> $@
  75 endef
  76
  77 define Build/append-string
  78         echo -n $(1) >> $@
  79 endef
  80
  81 define Build/append-ubi
  82         sh $(TOPDIR)/scripts/ubinize-image.sh \
  83                 $(if $(UBOOTENV_IN_UBI),--uboot-env) \
  84                 $(if $(KERNEL_IN_UBI),--kernel $(IMAGE_KERNEL)) \
  85                 $(foreach part,$(UBINIZE_PARTS),--part $(part)) \
  86                 $(IMAGE_ROOTFS) \
  87                 $@.tmp \
  88                 -p $(BLOCKSIZE:%k=%KiB) -m $(PAGESIZE) \
  89                 $(if $(SUBPAGESIZE),-s $(SUBPAGESIZE)) \
  90                 $(if $(VID_HDR_OFFSET),-O $(VID_HDR_OFFSET)) \
  91                 $(UBINIZE_OPTS)
  92         cat $@.tmp >> $@
  93         rm $@.tmp
  94 endef
  95
  96 define Build/append-uboot
  97         dd if=$(UBOOT_PATH) >> $@
  98 endef
  99
 100 # append a fake/empty uImage header, to fool bootloaders rootfs integrity check
 101 # for example
 102 define Build/append-uImage-fakehdr
 103         $(eval type=$(word 1,$(1)))
 104         $(eval magic=$(word 2,$(1)))
 105         touch $@.fakehdr
 106         $(STAGING_DIR_HOST)/bin/mkimage \
 107                 -A $(LINUX_KARCH) -O linux -T $(type) -C none \
 108                 -n '$(VERSION_DIST) fake $(type)' \
 109                 $(if $(magic),-M $(magic)) \
 110                 -d $@.fakehdr \
 111                 -s \
 112                 $@.fakehdr
 113         cat $@.fakehdr >> $@
 114 endef
 115
 116 define Build/buffalo-dhp-image
 117         $(STAGING_DIR_HOST)/bin/mkdhpimg $@ $@.new
 118         mv $@.new $@
 119 endef
 120
 121 define Build/buffalo-enc
 122         $(eval product=$(word 1,$(1)))
 123         $(eval version=$(word 2,$(1)))
 124         $(eval args=$(wordlist 3,$(words $(1)),$(1)))
 125         $(STAGING_DIR_HOST)/bin/buffalo-enc \
 126                 -p $(product) -v $(version) $(args) \
 127                 -i $@ -o $@.new
 128         mv $@.new $@
 129 endef
 130
 131 define Build/buffalo-enc-tag
 132         $(call Build/buffalo-enc,'' '' -S 152 $(1))
 133 endef
 134
 135 define Build/buffalo-tag-dhp
 136         $(eval product=$(word 1,$(1)))
 137         $(eval region=$(word 2,$(1)))
 138         $(eval language=$(word 3,$(1)))
 139         $(STAGING_DIR_HOST)/bin/buffalo-tag \
 140                 -d 0x01000000 -w 1 \
 141                 -a $(BUFFALO_TAG_PLATFORM) \
 142                 -v $(BUFFALO_TAG_VERSION) -m $(BUFFALO_TAG_MINOR) \
 143                 -b $(product) -p $(product) \
 144                 -r $(region) -r $(region) -l $(language) \
 145                 -I $@ -o $@.new
 146         mv $@.new $@
 147 endef
 148
 149 define Build/check-size
 150         @imagesize="$$(stat -c%s $@)"; \
 151         limitsize="$$(($(subst k,* 1024,$(subst m, * 1024k,$(if $(1),$(1),$(IMAGE_SIZE))))))"; \
 152         [ $$limitsize -ge $$imagesize ] || { \
 153                 echo "WARNING: Image file $@ is too big: $$imagesize > $$limitsize" >&2; \
 154                 rm -f $@; \
 155         }
 156 endef
 157
 158 define Build/eva-image
 159         $(STAGING_DIR_HOST)/bin/lzma2eva $(KERNEL_LOADADDR) $(KERNEL_LOADADDR) $@ $@.new
 160         mv $@.new $@
 161 endef
 162
 163 define Build/fit
 164         $(TOPDIR)/scripts/mkits.sh \
 165                 -D $(DEVICE_NAME) -o $@.its -k $@ \
 166                 $(if $(word 2,$(1)),-d $(word 2,$(1))) -C $(word 1,$(1)) \
 167                 -a $(KERNEL_LOADADDR) -e $(if $(KERNEL_ENTRY),$(KERNEL_ENTRY),$(KERNEL_LOADADDR)) \
 168                 $(if $(DEVICE_FDT_NUM),-n $(DEVICE_FDT_NUM)) \
 169                 -c $(if $(DEVICE_DTS_CONFIG),$(DEVICE_DTS_CONFIG),"config@1") \
 170                 -A $(LINUX_KARCH) -v $(LINUX_VERSION)
 171         PATH=$(LINUX_DIR)/scripts/dtc:$(PATH) mkimage -f $@.its $@.new
 172         @mv $@.new $@
 173 endef
 174
 175 define Build/gzip
 176         gzip -f -9n -c $@ $(1) > $@.new
 177         @mv $@.new $@
 178 endef
 179
 180 define Build/install-dtb
 181         $(call locked, \
 182                 $(foreach dts,$(DEVICE_DTS), \
 183                         $(CP) \
 184                                 $(DTS_DIR)/$(dts).dtb \
 185                                 $(BIN_DIR)/$(IMG_PREFIX)-$(dts).dtb; \
 186                 ), \
 187                 install-dtb-$(IMG_PREFIX) \
 188         )
 189 endef
 190
 191 define Build/jffs2
 192         rm -rf $(KDIR_TMP)/$(DEVICE_NAME)/jffs2 && \
 193                 mkdir -p $(KDIR_TMP)/$(DEVICE_NAME)/jffs2/$$(dirname $(1)) && \
 194                 cp $@ $(KDIR_TMP)/$(DEVICE_NAME)/jffs2/$(1) && \
 195                 $(STAGING_DIR_HOST)/bin/mkfs.jffs2 --pad \
 196                         $(if $(CONFIG_BIG_ENDIAN),--big-endian,--little-endian) \
 197                         --squash-uids -v -e $(patsubst %k,%KiB,$(BLOCKSIZE)) \
 198                         -o $@.new \
 199                         -d $(KDIR_TMP)/$(DEVICE_NAME)/jffs2 \
 200                         2>&1 1>/dev/null | awk '/^.+$$$$/' && \
 201                 $(STAGING_DIR_HOST)/bin/padjffs2 $@.new -J $(patsubst %k,,$(BLOCKSIZE))
 202         -rm -rf $(KDIR_TMP)/$(DEVICE_NAME)/jffs2/
 203         @mv $@.new $@
 204 endef
 205
 206 define Build/kernel2minor
 207         kernel2minor -k $@ -r $@.new $(1)
 208         mv $@.new $@
 209 endef
 210
 211 define Build/kernel-bin
 212         rm -f $@
 213         cp $< $@
 214 endef
 215
 216 define Build/linksys-image
 217         $(TOPDIR)/scripts/linksys-image.sh \
 218                 "$(call param_get_default,type,$(1),$(DEVICE_NAME))" \
 219                 $@ $@.new
 220                 mv $@.new $@
 221 endef
 222
 223 define Build/lzma
 224         $(call Build/lzma-no-dict,-lc1 -lp2 -pb2 $(1))
 225 endef
 226
 227 define Build/lzma-no-dict
 228         $(STAGING_DIR_HOST)/bin/lzma e $@ $(1) $@.new
 229         @mv $@.new $@
 230 endef
 231
 232 define Build/netgear-chk
 233         $(STAGING_DIR_HOST)/bin/mkchkimg \
 234                 -o $@.new \
 235                 -k $@ \
 236                 -b $(NETGEAR_BOARD_ID) \
 237                 $(if $(NETGEAR_REGION),-r $(NETGEAR_REGION),)
 238         mv $@.new $@
 239 endef
 240
 241 define Build/netgear-dni
 242         $(STAGING_DIR_HOST)/bin/mkdniimg \
 243                 -B $(NETGEAR_BOARD_ID) -v $(VERSION_DIST).$(firstword $(subst -, ,$(REVISION))) \
 244                 $(if $(NETGEAR_HW_ID),-H $(NETGEAR_HW_ID)) \
 245                 -r "$(1)" \
 246                 -i $@ -o $@.new
 247         mv $@.new $@
 248 endef
 249
 250 define Build/openmesh-image
 251         $(TOPDIR)/scripts/om-fwupgradecfg-gen.sh \
 252                 "$(call param_get_default,ce_type,$(1),$(DEVICE_NAME))" \
 253                 "$@-fwupgrade.cfg" \
 254                 "$(call param_get_default,kernel,$(1),$(IMAGE_KERNEL))" \
 255                 "$(call param_get_default,rootfs,$(1),$@)"
 256         $(TOPDIR)/scripts/combined-ext-image.sh \
 257                 "$(call param_get_default,ce_type,$(1),$(DEVICE_NAME))" "$@" \
 258                 "$@-fwupgrade.cfg" "fwupgrade.cfg" \
 259                 "$(call param_get_default,kernel,$(1),$(IMAGE_KERNEL))" "kernel" \
 260                 "$(call param_get_default,rootfs,$(1),$@)" "rootfs"
 261 endef
 262
 263 define Build/pad-extra
 264         dd if=/dev/zero bs=$(1) count=1 >> $@
 265 endef
 266
 267 define Build/pad-offset
 268         let \
 269                 size="$$(stat -c%s $@)" \
 270                 pad="$(subst k,* 1024,$(word 1, $(1)))" \
 271                 offset="$(subst k,* 1024,$(word 2, $(1)))" \
 272                 pad="(pad - ((size + offset) % pad)) % pad" \
 273                 newsize='size + pad'; \
 274                 dd if=$@ of=$@.new bs=$$newsize count=1 conv=sync
 275         mv $@.new $@
 276 endef
 277
 278 define Build/pad-rootfs
 279         $(STAGING_DIR_HOST)/bin/padjffs2 $@ $(1) \
 280                 $(if $(BLOCKSIZE),$(BLOCKSIZE:%k=%),4 8 16 64 128 256)
 281 endef
 282
 283 define Build/pad-to
 284         $(call Image/pad-to,$@,$(1))
 285 endef
 286
 287 define Build/patch-cmdline
 288         $(STAGING_DIR_HOST)/bin/patch-cmdline $@ '$(CMDLINE)'
 289 endef
 290
 291 # Convert a raw image into a $1 type image.
 292 # E.g. | qemu-image vdi
 293 define Build/qemu-image
 294         if command -v qemu-img; then \
 295                 qemu-img convert -f raw -O $1 $@ $@.new; \
 296                 mv $@.new $@; \
 297         else \
 298                 echo "WARNING: Install qemu-img to create VDI/VMDK images" >&2; exit 1; \
 299         fi
 300 endef
 301
 302 define Build/qsdk-ipq-factory-nand
 303         $(TOPDIR)/scripts/mkits-qsdk-ipq-image.sh \
 304                 $@.its ubi $@
 305         PATH=$(LINUX_DIR)/scripts/dtc:$(PATH) mkimage -f $@.its $@.new
 306         @mv $@.new $@
 307 endef
 308
 309 define Build/qsdk-ipq-factory-nor
 310         $(TOPDIR)/scripts/mkits-qsdk-ipq-image.sh \
 311                 $@.its hlos $(IMAGE_KERNEL) rootfs $(IMAGE_ROOTFS)
 312         PATH=$(LINUX_DIR)/scripts/dtc:$(PATH) mkimage -f $@.its $@.new
 313         @mv $@.new $@
 314 endef
 315
 316 define Build/seama
 317         $(STAGING_DIR_HOST)/bin/seama -i $@ \
 318                 -m "dev=/dev/mtdblock/$(SEAMA_MTDBLOCK)" -m "type=firmware"
 319         mv $@.seama $@
 320 endef
 321
 322 define Build/seama-seal
 323         $(STAGING_DIR_HOST)/bin/seama -i $@ -s $@.seama \
 324                 -m "signature=$(SEAMA_SIGNATURE)"
 325         mv $@.seama $@
 326 endef
 327
 328 define Build/senao-header
 329         $(STAGING_DIR_HOST)/bin/mksenaofw $(1) -e $@ -o $@.new
 330         mv $@.new $@
 331 endef
 332
 333 define Build/sysupgrade-tar
 334         sh $(TOPDIR)/scripts/sysupgrade-tar.sh \
 335                 --board $(if $(BOARD_NAME),$(BOARD_NAME),$(DEVICE_NAME)) \
 336                 --kernel $(call param_get_default,kernel,$(1),$(IMAGE_KERNEL)) \
 337                 --rootfs $(call param_get_default,rootfs,$(1),$(IMAGE_ROOTFS)) \
 338                 $@
 339 endef
 340
 341 define Build/tplink-safeloader
 342         -$(STAGING_DIR_HOST)/bin/tplink-safeloader \
 343                 -B $(TPLINK_BOARD_ID) \
 344                 -V $(REVISION) \
 345                 -k $(IMAGE_KERNEL) \
 346                 -r $@ \
 347                 -o $@.new \
 348                 -j \
 349                 $(wordlist 2,$(words $(1)),$(1)) \
 350                 $(if $(findstring sysupgrade,$(word 1,$(1))),-S) && mv $@.new $@ || rm -f $@
 351 endef
 352
 353 define Build/tplink-v1-header
 354         $(STAGING_DIR_HOST)/bin/mktplinkfw \
 355                 -c -H $(TPLINK_HWID) -W $(TPLINK_HWREV) -L $(KERNEL_LOADADDR) \
 356                 -E $(if $(KERNEL_ENTRY),$(KERNEL_ENTRY),$(KERNEL_LOADADDR)) \
 357                 -m $(TPLINK_HEADER_VERSION) -N "$(VERSION_DIST)" -V $(REVISION) \
 358                 -k $@ -o $@.new $(1)
 359         @mv $@.new $@
 360 endef
 361
 362 # combine kernel and rootfs into one image
 363 # mktplinkfw <type> <optional extra arguments to mktplinkfw binary>
 364 # <type> is "sysupgrade" or "factory"
 365 #
 366 # -a align the rootfs start on an <align> bytes boundary
 367 # -j add jffs2 end-of-filesystem markers
 368 # -s strip padding from end of the image
 369 # -X reserve <size> bytes in the firmware image (hexval prefixed with 0x)
 370 define Build/tplink-v1-image
 371         -$(STAGING_DIR_HOST)/bin/mktplinkfw \
 372                 -H $(TPLINK_HWID) -W $(TPLINK_HWREV) -F $(TPLINK_FLASHLAYOUT) \
 373                 -N "$(VERSION_DIST)" -V $(REVISION) -m $(TPLINK_HEADER_VERSION) \
 374                 -k $(IMAGE_KERNEL) -r $(IMAGE_ROOTFS) -o $@.new -j -X 0x40000 \
 375                 -a $(call rootfs_align,$(FILESYSTEM)) \
 376                 $(wordlist 2,$(words $(1)),$(1)) \
 377                 $(if $(findstring sysupgrade,$(word 1,$(1))),-s) && mv $@.new $@ || rm -f $@
 378 endef
 379
 380 define Build/tplink-v2-header
 381         $(STAGING_DIR_HOST)/bin/mktplinkfw2 \
 382                 -c -H $(TPLINK_HWID) -W $(TPLINK_HWREV) -L $(KERNEL_LOADADDR) \
 383                 -E $(if $(KERNEL_ENTRY),$(KERNEL_ENTRY),$(KERNEL_LOADADDR))  \
 384                 -w $(TPLINK_HWREVADD) -F "$(TPLINK_FLASHLAYOUT)" \
 385                 -T $(TPLINK_HVERSION) -V "ver. 2.0" \
 386                 -k $@ -o $@.new $(1)
 387         @mv $@.new $@
 388 endef
 389
 390 define Build/tplink-v2-image
 391         $(STAGING_DIR_HOST)/bin/mktplinkfw2 \
 392                 -H $(TPLINK_HWID) -W $(TPLINK_HWREV) \
 393                 -w $(TPLINK_HWREVADD) -F "$(TPLINK_FLASHLAYOUT)" \
 394                 -T $(TPLINK_HVERSION) -V "ver. 2.0" -a 0x4 -j \
 395                 -k $(IMAGE_KERNEL) -r $(IMAGE_ROOTFS) -o $@.new $(1)
 396         cat $@.new >> $@
 397         rm -rf $@.new
 398 endef
 399
 400 define Build/uImage
 401         mkimage \
 402                 -A $(LINUX_KARCH) \
 403                 -O linux \
 404                 -T kernel \
 405                 -C $(word 1,$(1)) \
 406                 -a $(KERNEL_LOADADDR) \
 407                 -e $(if $(KERNEL_ENTRY),$(KERNEL_ENTRY),$(KERNEL_LOADADDR)) \
 408                 -n '$(if $(UIMAGE_NAME),$(UIMAGE_NAME),$(call toupper,$(LINUX_KARCH)) $(VERSION_DIST) Linux-$(LINUX_VERSION))' \
 409                 $(if $(UIMAGE_MAGIC),-M $(UIMAGE_MAGIC)) \
 410                 $(wordlist 2,$(words $(1)),$(1)) \
 411                 -d $@ $@.new
 412         mv $@.new $@
 413 endef
 414
 415 define Build/xor-image
 416         $(STAGING_DIR_HOST)/bin/xorimage -i $@ -o $@.xor $(1)
 417         mv $@.xor $@
 418 endef
 419
 420 define Build/zip
 421         mkdir $@.tmp
 422         mv $@ $@.tmp/$(1)
 423
 424         zip -j -X \
 425                 $(if $(SOURCE_DATE_EPOCH),--mtime="$(SOURCE_DATE_EPOCH)") \
 426                 $@ $@.tmp/$(if $(1),$(1),$@)
 427         rm -rf $@.tmp
 428 endef
 429
 430 define Build/zyxel-ras-image
 431         let \
 432                 newsize="$(subst k,* 1024,$(RAS_ROOTFS_SIZE))"; \
 433                 $(STAGING_DIR_HOST)/bin/mkrasimage \
 434                         -b $(RAS_BOARD) \
 435                         -v $(RAS_VERSION) \
 436                         -r $@ \
 437                         -s $$newsize \
 438                         -o $@.new \
 439                         $(if $(findstring separate-kernel,$(word 1,$(1))),-k $(IMAGE_KERNEL)) \
 440                 && mv $@.new $@
 441 endef