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