image.mk: call mkfs/prepare for the image builder
[openwrt.git] / include / image.mk
1 #
2 # Copyright (C) 2006-2010 OpenWrt.org
3 #
4 # This is free software, licensed under the GNU General Public License v2.
5 # See /LICENSE for more information.
6 #
7
8 override TARGET_BUILD=
9 include $(INCLUDE_DIR)/prereq.mk
10 include $(INCLUDE_DIR)/kernel.mk
11 include $(INCLUDE_DIR)/host.mk
12
13 override MAKEFLAGS=
14 override MAKE:=$(SUBMAKE)
15 KDIR=$(KERNEL_BUILD_DIR)
16 DTS_DIR:=$(LINUX_DIR)/arch/$(ARCH)/boot/dts/
17
18 IMG_PREFIX:=openwrt-$(BOARD)$(if $(SUBTARGET),-$(SUBTARGET))
19
20 MKFS_DEVTABLE_OPT := -D $(INCLUDE_DIR)/device_table.txt
21
22 ifneq ($(CONFIG_BIG_ENDIAN),)
23   JFFS2OPTS     :=  --big-endian --squash-uids -v
24 else
25   JFFS2OPTS     :=  --little-endian --squash-uids -v
26 endif
27
28 ifeq ($(CONFIG_JFFS2_RTIME),y)
29   JFFS2OPTS += -X rtime
30 endif
31 ifeq ($(CONFIG_JFFS2_ZLIB),y)
32   JFFS2OPTS += -X zlib
33 endif
34 ifeq ($(CONFIG_JFFS2_LZMA),y)
35   JFFS2OPTS += -X lzma --compression-mode=size
36 endif
37 ifneq ($(CONFIG_JFFS2_RTIME),y)
38   JFFS2OPTS += -x rtime
39 endif
40 ifneq ($(CONFIG_JFFS2_ZLIB),y)
41   JFFS2OPTS += -x zlib
42 endif
43 ifneq ($(CONFIG_JFFS2_LZMA),y)
44   JFFS2OPTS += -x lzma
45 endif
46
47 JFFS2OPTS += $(MKFS_DEVTABLE_OPT)
48
49 SQUASHFS_BLOCKSIZE := $(CONFIG_TARGET_SQUASHFS_BLOCK_SIZE)k
50 SQUASHFSOPT := -b $(SQUASHFS_BLOCKSIZE)
51 SQUASHFSOPT += -p '/dev d 755 0 0' -p '/dev/console c 600 0 0 5 1'
52 SQUASHFSCOMP := gzip
53 LZMA_XZ_OPTIONS := -Xpreset 9 -Xe -Xlc 0 -Xlp 2 -Xpb 2
54 ifeq ($(CONFIG_SQUASHFS_LZMA),y)
55   SQUASHFSCOMP := lzma $(LZMA_XZ_OPTIONS)
56 endif
57 ifeq ($(CONFIG_SQUASHFS_XZ),y)
58   ifneq ($(filter arm x86 powerpc sparc,$(LINUX_KARCH)),)
59     BCJ_FILTER:=-Xbcj $(LINUX_KARCH)
60   endif
61   SQUASHFSCOMP := xz $(LZMA_XZ_OPTIONS) $(BCJ_FILTER)
62 endif
63
64 JFFS2_BLOCKSIZE ?= 64k 128k
65
66 define add_jffs2_mark
67         echo -ne '\xde\xad\xc0\xde' >> $(1)
68 endef
69
70 define toupper
71 $(shell echo $(1) | tr '[:lower:]' '[:upper:]')
72 endef
73
74 # pad to 4k, 8k, 16k, 64k, 128k, 256k and add jffs2 end-of-filesystem mark
75 define prepare_generic_squashfs
76         $(STAGING_DIR_HOST)/bin/padjffs2 $(1) 4 8 16 64 128 256
77 endef
78
79 define Image/BuildKernel/Initramfs
80         cp $(KDIR)/vmlinux-initramfs.elf $(BIN_DIR)/$(IMG_PREFIX)-vmlinux-initramfs.elf
81         $(call Image/Build/Initramfs)
82 endef
83
84 define Image/BuildKernel/MkuImage
85         mkimage -A $(ARCH) -O linux -T kernel -C $(1) -a $(2) -e $(3) \
86                 -n '$(call toupper,$(ARCH)) OpenWrt Linux-$(LINUX_VERSION)' -d $(4) $(5)
87 endef
88
89 define Image/BuildKernel/MkFIT
90         $(TOPDIR)/scripts/mkits.sh \
91                 -D $(1) -o $(KDIR)/fit-$(1).its -k $(2) -d $(3) -C $(4) -a $(5) -e $(6) \
92                 -A $(ARCH) -v $(LINUX_VERSION)
93         PATH=$(LINUX_DIR)/scripts/dtc:$(PATH) mkimage -f $(KDIR)/fit-$(1).its $(KDIR)/fit-$(1)$(7).itb
94 endef
95
96 define Image/mkfs/jffs2/sub
97                 # FIXME: removing this line will cause strange behaviour in the foreach loop below
98                 $(STAGING_DIR_HOST)/bin/mkfs.jffs2 $(3) --pad -e $(patsubst %k,%KiB,$(1)) -o $(KDIR)/root.jffs2-$(2) -d $(TARGET_DIR) -v 2>&1 1>/dev/null | awk '/^.+$$$$/'
99                 $(STAGING_DIR_HOST)/bin/mkfs.jffs2 $(3) -e $(patsubst %k,%KiB,$(1)) -o $(KDIR)/root.jffs2-$(2)-raw -d $(TARGET_DIR) -v 2>&1 1>/dev/null | awk '/^.+$$$$/'
100                 $(call add_jffs2_mark,$(KDIR)/root.jffs2-$(2))
101                 $(call Image/Build,jffs2-$(2))
102 endef
103
104 ifneq ($(CONFIG_TARGET_ROOTFS_JFFS2),)
105     define Image/mkfs/jffs2
106                 $(foreach SZ,$(JFFS2_BLOCKSIZE),$(call Image/mkfs/jffs2/sub,$(SZ),$(SZ),$(JFFS2OPTS)))
107     endef
108 endif
109
110 ifneq ($(CONFIG_TARGET_ROOTFS_JFFS2_NAND),)
111     define Image/mkfs/jffs2_nand
112                 $(foreach SZ,$(NAND_BLOCKSIZE), $(call Image/mkfs/jffs2/sub, \
113                         $(word 2,$(subst :, ,$(SZ))),nand-$(subst :,-,$(SZ)), \
114                         $(JFFS2OPTS) --no-cleanmarkers --pagesize=$(word 1,$(subst :, ,$(SZ)))) \
115                 )
116     endef
117 endif
118
119 ifneq ($(CONFIG_TARGET_ROOTFS_SQUASHFS),)
120     define Image/mkfs/squashfs
121                 @mkdir -p $(TARGET_DIR)/overlay
122                 $(STAGING_DIR_HOST)/bin/mksquashfs4 $(TARGET_DIR) $(KDIR)/root.squashfs -nopad -noappend -root-owned -comp $(SQUASHFSCOMP) $(SQUASHFSOPT) -processors $(if $(CONFIG_PKG_BUILD_JOBS),$(CONFIG_PKG_BUILD_JOBS),1)
123                 $(call Image/Build,squashfs)
124     endef
125 endif
126
127 # $(1): board name
128 # $(2): rootfs type
129 # $(3): kernel image
130 ifneq ($(CONFIG_NAND_SUPPORT),)
131    define Image/Build/SysupgradeNAND
132         mkdir -p "$(KDIR_TMP)/sysupgrade-$(1)/"
133         echo "BOARD=$(1)" > "$(KDIR_TMP)/sysupgrade-$(1)/CONTROL"
134         [ -z "$(2)" ] || $(CP) "$(KDIR)/root.$(2)" "$(KDIR_TMP)/sysupgrade-$(1)/root"
135         [ -z "$(3)" ] || $(CP) "$(3)" "$(KDIR_TMP)/sysupgrade-$(1)/kernel"
136         (cd "$(KDIR_TMP)"; $(TAR) cvf \
137                 "$(BIN_DIR)/$(IMG_PREFIX)-$(1)-$(2)-sysupgrade.tar" sysupgrade-$(1))
138    endef
139 # $(1) board name
140 # $(2) ubinize-image options (e.g. --uboot-env and/or --kernel kernelimage)
141 # $(3) rootfstype (e.g. squashfs or ubifs)
142 # $(4) options to pass-through to ubinize (i.e. $($(PROFILE)_UBI_OPTS)))
143    define Image/Build/UbinizeImage
144         sh $(TOPDIR)/scripts/ubinize-image.sh $(2) \
145                 "$(KDIR)/root.$(3)" \
146                 "$(BIN_DIR)/$(IMG_PREFIX)-$(1)-$(3)-ubinized.bin" \
147                 $(4)
148    endef
149
150 endif
151
152 ifneq ($(CONFIG_TARGET_ROOTFS_UBIFS),)
153     define Image/mkfs/ubifs/generate
154         $(CP) ./ubinize$(1).cfg $(KDIR)
155         ( cd $(KDIR); \
156                 $(STAGING_DIR_HOST)/bin/ubinize \
157                 $(if $($(PROFILE)_UBI_OPTS), \
158                         $(shell echo $($(PROFILE)_UBI_OPTS)), \
159                         $(shell echo $(UBI_OPTS)) \
160                 ) \
161                 -o $(KDIR)/root$(1).ubi \
162                 ubinize$(1).cfg \
163         )
164     endef
165
166     define Image/mkfs/ubifs
167
168         ifneq ($($(PROFILE)_UBIFS_OPTS)$(UBIFS_OPTS),)
169                 $(STAGING_DIR_HOST)/bin/mkfs.ubifs \
170                         $(if $($(PROFILE)_UBIFS_OPTS), \
171                                 $(shell echo $($(PROFILE)_UBIFS_OPTS)), \
172                                 $(shell echo $(UBIFS_OPTS)) \
173                         ) \
174                         $(if $(CONFIG_TARGET_UBIFS_FREE_SPACE_FIXUP),--space-fixup) \
175                         $(if $(CONFIG_TARGET_UBIFS_COMPRESSION_NONE),--force-compr=none) \
176                         $(if $(CONFIG_TARGET_UBIFS_COMPRESSION_LZO),--force-compr=lzo) \
177                         $(if $(CONFIG_TARGET_UBIFS_COMPRESSION_ZLIB),--force-compr=zlib) \
178                         $(if $(shell echo $(CONFIG_TARGET_UBIFS_JOURNAL_SIZE)),--jrn-size=$(CONFIG_TARGET_UBIFS_JOURNAL_SIZE)) \
179                         --squash-uids \
180                         -o $(KDIR)/root.ubifs \
181                         -d $(TARGET_DIR)
182         endif
183         $(call Image/Build,ubifs)
184
185         ifneq ($($(PROFILE)_UBI_OPTS)$(UBI_OPTS),)
186                 $(call Image/mkfs/ubifs/generate,)
187                 $(if $(wildcard ./ubinize-overlay.cfg),$(call Image/mkfs/ubifs/generate,-overlay))
188         endif
189         $(call Image/Build,ubi)
190     endef
191 endif
192
193 ifneq ($(CONFIG_TARGET_ROOTFS_CPIOGZ),)
194   define Image/mkfs/cpiogz
195                 ( cd $(TARGET_DIR); find . | cpio -o -H newc | gzip -9 >$(BIN_DIR)/$(IMG_PREFIX)-rootfs.cpio.gz )
196   endef
197 endif
198
199 ifneq ($(CONFIG_TARGET_ROOTFS_TARGZ),)
200   define Image/mkfs/targz
201                 # Preserve permissions (-p) when building as non-root user
202                 $(TAR) -czpf $(BIN_DIR)/$(IMG_PREFIX)$(if $(PROFILE),-$(PROFILE))-rootfs.tar.gz --numeric-owner --owner=0 --group=0 -C $(TARGET_DIR)/ .
203   endef
204 endif
205
206 ifneq ($(CONFIG_TARGET_ROOTFS_EXT4FS),)
207   E2SIZE=$(shell echo $$(($(CONFIG_TARGET_ROOTFS_PARTSIZE)*1024*1024/$(CONFIG_TARGET_EXT4_BLOCKSIZE))))
208
209   define Image/mkfs/ext4
210 # generate an ext2 fs
211         $(STAGING_DIR_HOST)/bin/genext2fs -U -B $(CONFIG_TARGET_EXT4_BLOCKSIZE) -b $(E2SIZE) -N $(CONFIG_TARGET_EXT4_MAXINODE) -d $(TARGET_DIR)/ $(KDIR)/root.ext4 -m $(CONFIG_TARGET_EXT4_RESERVED_PCT) $(MKFS_DEVTABLE_OPT)
212 # convert it to ext4
213         $(STAGING_DIR_HOST)/bin/tune2fs $(if $(CONFIG_TARGET_EXT4_JOURNAL),-j) -O extents,uninit_bg,dir_index $(KDIR)/root.ext4
214 # fix it up
215         $(STAGING_DIR_HOST)/bin/e2fsck -fy $(KDIR)/root.ext4
216         $(call Image/Build,ext4)
217   endef
218 endif
219
220 ifneq ($(CONFIG_TARGET_ROOTFS_ISO),)
221   define Image/mkfs/iso
222                 $(call Image/Build,iso)
223   endef
224 endif
225
226
227 define Image/mkfs/prepare/default
228         # Use symbolic permissions to avoid clobbering SUID/SGID/sticky bits
229         - $(FIND) $(TARGET_DIR) -type f -not -perm +0100 -not -name 'ssh_host*' -not -name 'shadow' -print0 | $(XARGS) -0 chmod u+rw,g+r,o+r
230         - $(FIND) $(TARGET_DIR) -type f -perm +0100 -print0 | $(XARGS) -0 chmod u+rwx,g+rx,o+rx
231         - $(FIND) $(TARGET_DIR) -type d -print0 | $(XARGS) -0 chmod u+rwx,g+rx,o+rx
232         $(INSTALL_DIR) $(TARGET_DIR)/tmp
233         chmod 1777 $(TARGET_DIR)/tmp
234 endef
235
236 define Image/mkfs/prepare
237         $(call Image/mkfs/prepare/default)
238 endef
239
240
241 define Image/Checksum
242         ( cd ${BIN_DIR} ; \
243                 $(FIND) -maxdepth 1 -type f \! -name 'md5sums'  -printf "%P\n" | sort | xargs \
244                 md5sum --binary > md5sums \
245         )
246 endef
247
248
249 define BuildImage
250
251   download:
252   prepare:
253   compile:
254   clean:
255   image_prepare:
256
257   ifeq ($(IB),)
258     compile: compile-targets FORCE
259                 $(call Build/Compile)
260
261     clean: clean-targets
262                 $(call Build/Clean)
263
264     image_prepare: compile FORCE
265                 $(call Image/Prepare)
266   endif
267
268   mkfs_prepare: image_prepare
269         $(call Image/mkfs/prepare)
270
271   install: mkfs_prepare install-targets FORCE
272         $(call Image/BuildKernel)
273         $(if $(CONFIG_TARGET_ROOTFS_INITRAMFS),$(call Image/BuildKernel/Initramfs))
274         $(call Image/InstallKernel)
275         $(call Image/mkfs/cpiogz)
276         $(call Image/mkfs/targz)
277         $(call Image/mkfs/ext4)
278         $(call Image/mkfs/iso)
279         $(call Image/mkfs/jffs2)
280         $(call Image/mkfs/jffs2_nand)
281         $(call Image/mkfs/squashfs)
282         $(call Image/mkfs/ubifs)
283         $(call Image/Checksum)
284
285   compile-targets:
286   install-targets:
287   clean-targets:
288
289 endef