build: image: add SOC device variable
[oweals/openwrt.git] / 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 Build/uImage
7         mkimage -A $(LINUX_KARCH) \
8                 -O linux -T kernel \
9                 -C $(1) -a $(KERNEL_LOADADDR) -e $(if $(KERNEL_ENTRY),$(KERNEL_ENTRY),$(KERNEL_LOADADDR)) \
10                 -n '$(if $(UIMAGE_NAME),$(UIMAGE_NAME),$(call toupper,$(LINUX_KARCH)) $(VERSION_DIST) Linux-$(LINUX_VERSION))' -d $@ $@.new
11         mv $@.new $@
12 endef
13
14 define Build/buffalo-enc
15         $(eval product=$(word 1,$(1)))
16         $(eval version=$(word 2,$(1)))
17         $(eval args=$(wordlist 3,$(words $(1)),$(1)))
18         $(STAGING_DIR_HOST)/bin/buffalo-enc \
19                 -p $(product) -v $(version) $(args) \
20                 -i $@ -o $@.new
21         mv $@.new $@
22 endef
23
24 define Build/buffalo-enc-tag
25         $(call Build/buffalo-enc,'' '' -S 152 $(1))
26 endef
27
28 define Build/buffalo-tag-dhp
29         $(eval product=$(word 1,$(1)))
30         $(eval region=$(word 2,$(1)))
31         $(eval language=$(word 3,$(1)))
32         $(STAGING_DIR_HOST)/bin/buffalo-tag \
33                 -d 0x01000000 -w 1 \
34                 -a $(BUFFALO_TAG_PLATFORM) \
35                 -v $(BUFFALO_TAG_VERSION) -m $(BUFFALO_TAG_MINOR) \
36                 -b $(product) -p $(product) \
37                 -r $(region) -r $(region) -l $(language) \
38                 -I $@ -o $@.new
39         mv $@.new $@
40 endef
41
42 define Build/buffalo-dhp-image
43         $(STAGING_DIR_HOST)/bin/mkdhpimg $@ $@.new
44         mv $@.new $@
45 endef
46
47 define Build/eva-image
48         $(STAGING_DIR_HOST)/bin/lzma2eva $(KERNEL_LOADADDR) $(KERNEL_LOADADDR) $@ $@.new
49         mv $@.new $@
50 endef
51
52 define Build/seama
53         $(STAGING_DIR_HOST)/bin/seama -i $@ \
54                 -m "dev=/dev/mtdblock/$(SEAMA_MTDBLOCK)" -m "type=firmware"
55         mv $@.seama $@
56 endef
57
58 define Build/seama-seal
59         $(STAGING_DIR_HOST)/bin/seama -i $@ -s $@.seama \
60                 -m "signature=$(SEAMA_SIGNATURE)"
61         mv $@.seama $@
62 endef
63
64 define Build/zyxel-ras-image
65         let \
66                 newsize="$(subst k,* 1024,$(RAS_ROOTFS_SIZE))"; \
67                 $(STAGING_DIR_HOST)/bin/mkrasimage \
68                         -b $(RAS_BOARD) \
69                         -v $(RAS_VERSION) \
70                         -r $@ \
71                         -s $$newsize \
72                         -o $@.new \
73                         $(if $(findstring separate-kernel,$(word 1,$(1))),-k $(IMAGE_KERNEL)) \
74                 && mv $@.new $@
75 endef
76
77 define Build/netgear-chk
78         $(STAGING_DIR_HOST)/bin/mkchkimg \
79                 -o $@.new \
80                 -k $@ \
81                 -b $(NETGEAR_BOARD_ID) \
82                 $(if $(NETGEAR_REGION),-r $(NETGEAR_REGION),)
83         mv $@.new $@
84 endef
85
86 define Build/netgear-dni
87         $(STAGING_DIR_HOST)/bin/mkdniimg \
88                 -B $(NETGEAR_BOARD_ID) -v $(VERSION_DIST).$(firstword $(subst -, ,$(REVISION))) \
89                 $(if $(NETGEAR_HW_ID),-H $(NETGEAR_HW_ID)) \
90                 -r "$(1)" \
91                 -i $@ -o $@.new
92         mv $@.new $@
93 endef
94
95 define Build/append-squashfs-fakeroot-be
96         rm -rf $@.fakefs $@.fakesquashfs
97         mkdir $@.fakefs
98         $(STAGING_DIR_HOST)/bin/mksquashfs-lzma \
99                 $@.fakefs $@.fakesquashfs \
100                 -noappend -root-owned -be -nopad -b 65536 \
101                 $(if $(SOURCE_DATE_EPOCH),-fixed-time $(SOURCE_DATE_EPOCH))
102         cat $@.fakesquashfs >> $@
103 endef
104
105 define Build/append-string
106         echo -n $(1) >> $@
107 endef
108
109 # append a fake/empty uImage header, to fool bootloaders rootfs integrity check
110 # for example
111 define Build/append-uImage-fakehdr
112         $(eval type=$(word 1,$(1)))
113         $(eval magic=$(word 2,$(1)))
114         touch $@.fakehdr
115         $(STAGING_DIR_HOST)/bin/mkimage \
116                 -A $(LINUX_KARCH) -O linux -T $(type) -C none \
117                 -n '$(VERSION_DIST) fake $(type)' \
118                 $(if $(magic),-M $(magic)) \
119                 -d $@.fakehdr \
120                 -s \
121                 $@.fakehdr
122         cat $@.fakehdr >> $@
123 endef
124
125 define Build/tplink-safeloader
126         -$(STAGING_DIR_HOST)/bin/tplink-safeloader \
127                 -B $(TPLINK_BOARD_ID) \
128                 -V $(REVISION) \
129                 -k $(IMAGE_KERNEL) \
130                 -r $@ \
131                 -o $@.new \
132                 -j \
133                 $(wordlist 2,$(words $(1)),$(1)) \
134                 $(if $(findstring sysupgrade,$(word 1,$(1))),-S) && mv $@.new $@ || rm -f $@
135 endef
136
137 define Build/append-dtb
138         cat $(KDIR)/image-$(firstword $(DEVICE_DTS)).dtb >> $@
139 endef
140
141 define Build/install-dtb
142         $(call locked, \
143                 $(foreach dts,$(DEVICE_DTS), \
144                         $(CP) \
145                                 $(DTS_DIR)/$(dts).dtb \
146                                 $(BIN_DIR)/$(IMG_PREFIX)-$(dts).dtb; \
147                 ), \
148                 install-dtb-$(IMG_PREFIX) \
149         )
150 endef
151
152 define Build/fit
153         $(TOPDIR)/scripts/mkits.sh \
154                 -D $(DEVICE_NAME) -o $@.its -k $@ \
155                 $(if $(word 2,$(1)),-d $(word 2,$(1))) -C $(word 1,$(1)) \
156                 -a $(KERNEL_LOADADDR) -e $(if $(KERNEL_ENTRY),$(KERNEL_ENTRY),$(KERNEL_LOADADDR)) \
157                 -c $(if $(DEVICE_DTS_CONFIG),$(DEVICE_DTS_CONFIG),"config@1") \
158                 -A $(LINUX_KARCH) -v $(LINUX_VERSION)
159         PATH=$(LINUX_DIR)/scripts/dtc:$(PATH) mkimage -f $@.its $@.new
160         @mv $@.new $@
161 endef
162
163 define Build/lzma
164         $(call Build/lzma-no-dict,-lc1 -lp2 -pb2 $(1))
165 endef
166
167 define Build/lzma-no-dict
168         $(STAGING_DIR_HOST)/bin/lzma e $@ $(1) $@.new
169         @mv $@.new $@
170 endef
171
172 define Build/gzip
173         gzip -f -9n -c $@ $(1) > $@.new
174         @mv $@.new $@
175 endef
176
177 define Build/zip
178         mkdir $@.tmp
179         mv $@ $@.tmp/$(1)
180
181         zip -j -X \
182                 $(if $(SOURCE_DATE_EPOCH),--mtime="$(SOURCE_DATE_EPOCH)") \
183                 $@ $@.tmp/$(if $(1),$(1),$@)
184         rm -rf $@.tmp
185 endef
186
187 define Build/jffs2
188         rm -rf $(KDIR_TMP)/$(DEVICE_NAME)/jffs2 && \
189                 mkdir -p $(KDIR_TMP)/$(DEVICE_NAME)/jffs2/$$(dirname $(1)) && \
190                 cp $@ $(KDIR_TMP)/$(DEVICE_NAME)/jffs2/$(1) && \
191                 $(STAGING_DIR_HOST)/bin/mkfs.jffs2 --pad \
192                         $(if $(CONFIG_BIG_ENDIAN),--big-endian,--little-endian) \
193                         --squash-uids -v -e $(patsubst %k,%KiB,$(BLOCKSIZE)) \
194                         -o $@.new \
195                         -d $(KDIR_TMP)/$(DEVICE_NAME)/jffs2 \
196                         2>&1 1>/dev/null | awk '/^.+$$$$/' && \
197                 $(STAGING_DIR_HOST)/bin/padjffs2 $@.new -J $(patsubst %k,,$(BLOCKSIZE))
198         -rm -rf $(KDIR_TMP)/$(DEVICE_NAME)/jffs2/
199         @mv $@.new $@
200 endef
201
202 define Build/kernel-bin
203         rm -f $@
204         cp $< $@
205 endef
206
207 define Build/patch-cmdline
208         $(STAGING_DIR_HOST)/bin/patch-cmdline $@ '$(CMDLINE)'
209 endef
210
211 define Build/append-kernel
212         dd if=$(IMAGE_KERNEL) >> $@
213 endef
214
215 define Build/append-rootfs
216         dd if=$(IMAGE_ROOTFS) >> $@
217 endef
218
219 define Build/append-ubi
220         sh $(TOPDIR)/scripts/ubinize-image.sh \
221                 $(if $(UBOOTENV_IN_UBI),--uboot-env) \
222                 $(if $(KERNEL_IN_UBI),--kernel $(IMAGE_KERNEL)) \
223                 $(foreach part,$(UBINIZE_PARTS),--part $(part)) \
224                 $(IMAGE_ROOTFS) \
225                 $@.tmp \
226                 -p $(BLOCKSIZE:%k=%KiB) -m $(PAGESIZE) \
227                 $(if $(SUBPAGESIZE),-s $(SUBPAGESIZE)) \
228                 $(if $(VID_HDR_OFFSET),-O $(VID_HDR_OFFSET)) \
229                 $(UBINIZE_OPTS)
230         cat $@.tmp >> $@
231         rm $@.tmp
232 endef
233
234 define Build/append-uboot
235         dd if=$(UBOOT_PATH) >> $@
236 endef
237
238 define Build/pad-to
239         $(call Image/pad-to,$@,$(1))
240 endef
241
242 define Build/pad-extra
243         dd if=/dev/zero bs=$(1) count=1 >> $@
244 endef
245
246 define Build/pad-rootfs
247         $(STAGING_DIR_HOST)/bin/padjffs2 $@ $(1) \
248                 $(if $(BLOCKSIZE),$(BLOCKSIZE:%k=%),4 8 16 64 128 256)
249 endef
250
251 define Build/pad-offset
252         let \
253                 size="$$(stat -c%s $@)" \
254                 pad="$(subst k,* 1024,$(word 1, $(1)))" \
255                 offset="$(subst k,* 1024,$(word 2, $(1)))" \
256                 pad="(pad - ((size + offset) % pad)) % pad" \
257                 newsize='size + pad'; \
258                 dd if=$@ of=$@.new bs=$$newsize count=1 conv=sync
259         mv $@.new $@
260 endef
261
262 define Build/xor-image
263         $(STAGING_DIR_HOST)/bin/xorimage -i $@ -o $@.xor $(1)
264         mv $@.xor $@
265 endef
266
267 define Build/check-size
268         @[ $$(($(subst k,* 1024,$(subst m, * 1024k,$(1))))) -ge "$$(stat -c%s $@)" ] || { \
269                 echo "WARNING: Image file $@ is too big" >&2; \
270                 rm -f $@; \
271         }
272 endef
273
274 define Build/combined-image
275         -sh $(TOPDIR)/scripts/combined-image.sh \
276                 "$(IMAGE_KERNEL)" \
277                 "$@" \
278                 "$@.new"
279         @mv $@.new $@
280 endef
281
282 define Build/linksys-image
283         $(TOPDIR)/scripts/linksys-image.sh \
284                 "$(call param_get_default,type,$(1),$(DEVICE_NAME))" \
285                 $@ $@.new
286                 mv $@.new $@
287 endef
288
289 define Build/openmesh-image
290         $(TOPDIR)/scripts/om-fwupgradecfg-gen.sh \
291                 "$(call param_get_default,ce_type,$(1),$(DEVICE_NAME))" \
292                 "$@-fwupgrade.cfg" \
293                 "$(call param_get_default,kernel,$(1),$(IMAGE_KERNEL))" \
294                 "$(call param_get_default,rootfs,$(1),$@)"
295         $(TOPDIR)/scripts/combined-ext-image.sh \
296                 "$(call param_get_default,ce_type,$(1),$(DEVICE_NAME))" "$@" \
297                 "$@-fwupgrade.cfg" "fwupgrade.cfg" \
298                 "$(call param_get_default,kernel,$(1),$(IMAGE_KERNEL))" "kernel" \
299                 "$(call param_get_default,rootfs,$(1),$@)" "rootfs"
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/senao-header
317         $(STAGING_DIR_HOST)/bin/mksenaofw $(1) -e $@ -o $@.new
318         mv $@.new $@
319 endef
320
321 define Build/sysupgrade-tar
322         sh $(TOPDIR)/scripts/sysupgrade-tar.sh \
323                 --board $(if $(BOARD_NAME),$(BOARD_NAME),$(DEVICE_NAME)) \
324                 --kernel $(call param_get_default,kernel,$(1),$(IMAGE_KERNEL)) \
325                 --rootfs $(call param_get_default,rootfs,$(1),$(IMAGE_ROOTFS)) \
326                 $@
327 endef
328
329 define Build/tplink-v1-header
330         $(STAGING_DIR_HOST)/bin/mktplinkfw \
331                 -c -H $(TPLINK_HWID) -W $(TPLINK_HWREV) -L $(KERNEL_LOADADDR) \
332                 -E $(if $(KERNEL_ENTRY),$(KERNEL_ENTRY),$(KERNEL_LOADADDR)) \
333                 -m $(TPLINK_HEADER_VERSION) -N "$(VERSION_DIST)" -V $(REVISION) \
334                 -k $@ -o $@.new $(1)
335         @mv $@.new $@
336 endef
337
338 define Build/tplink-v2-header
339         $(STAGING_DIR_HOST)/bin/mktplinkfw2 \
340                 -c -H $(TPLINK_HWID) -W $(TPLINK_HWREV) -L $(KERNEL_LOADADDR) \
341                 -E $(if $(KERNEL_ENTRY),$(KERNEL_ENTRY),$(KERNEL_LOADADDR))  \
342                 -w $(TPLINK_HWREVADD) -F "$(TPLINK_FLASHLAYOUT)" \
343                 -T $(TPLINK_HVERSION) -V "ver. 2.0" \
344                 -k $@ -o $@.new $(1)
345         @mv $@.new $@
346 endef
347
348 define Build/tplink-v2-image
349         $(STAGING_DIR_HOST)/bin/mktplinkfw2 \
350                 -H $(TPLINK_HWID) -W $(TPLINK_HWREV) \
351                 -w $(TPLINK_HWREVADD) -F "$(TPLINK_FLASHLAYOUT)" \
352                 -T $(TPLINK_HVERSION) -V "ver. 2.0" -a 0x4 -j \
353                 -k $(IMAGE_KERNEL) -r $(IMAGE_ROOTFS) -o $@.new $(1)
354         cat $@.new >> $@
355         rm -rf $@.new
356 endef
357
358 json_quote=$(subst ','\'',$(subst ",\",$(1)))
359 #")')
360 metadata_devices=$(if $(1),$(subst "$(space)","$(comma)",$(strip $(foreach v,$(1),"$(call json_quote,$(v))"))))
361 metadata_json = \
362         '{ $(if $(IMAGE_METADATA),$(IMAGE_METADATA)$(comma)) \
363                 "metadata_version": "1.0", \
364                 "supported_devices":[$(call metadata_devices,$(1))], \
365                 "version": { \
366                         "dist": "$(call json_quote,$(VERSION_DIST))", \
367                         "version": "$(call json_quote,$(VERSION_NUMBER))", \
368                         "revision": "$(call json_quote,$(REVISION))", \
369                         "target": "$(call json_quote,$(TARGETID))", \
370                         "board": "$(call json_quote,$(if $(BOARD_NAME),$(BOARD_NAME),$(DEVICE_NAME)))" \
371                 } \
372         }'
373
374 define Build/append-metadata
375         $(if $(SUPPORTED_DEVICES),-echo $(call metadata_json,$(SUPPORTED_DEVICES)) | fwtool -I - $@)
376         [ ! -s "$(BUILD_KEY)" -o ! -s "$(BUILD_KEY).ucert" -o ! -s "$@" ] || { \
377                 cp "$(BUILD_KEY).ucert" "$@.ucert" ;\
378                 usign -S -m "$@" -s "$(BUILD_KEY)" -x "$@.sig" ;\
379                 ucert -A -c "$@.ucert" -x "$@.sig" ;\
380                 fwtool -S "$@.ucert" "$@" ;\
381         }
382 endef
383
384 define Build/kernel2minor
385         kernel2minor -k $@ -r $@.new $(1)
386         mv $@.new $@
387 endef