Makefile: add target 'rescue-image'
[opendreambox.git] / Makefile
1 #!/usr/bin/make -f
2 #
3 # Copyright (c) 2010-2014 Dream Property GmbH, Germany
4 #                         http://www.dream-multimedia-tv.de/
5 # Authors:
6 #   Andreas Oberritter <obi@opendreambox.org>
7 #
8 # Permission is hereby granted, free of charge, to any person obtaining a copy
9 # of this software and associated documentation files (the "Software"), to deal
10 # in the Software without restriction, including without limitation the rights
11 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 # copies of the Software, and to permit persons to whom the Software is
13 # furnished to do so, subject to the following conditions:
14 #
15 # The above copyright notice and this permission notice shall be included in
16 # all copies or substantial portions of the Software.
17 #
18 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 # THE SOFTWARE.
25 #
26
27 # Note: You can override all variables by storing them
28 # in an external file called "make.conf".
29 -include conf/make.conf
30
31 # Target platform:
32 # dm500hd, dm500hdv2, dm800se, dm800sev2, dm7020hd, dm7020hdv2, dm7080, dm8000
33 #
34 # This only sets the default value. All platforms now use a shared build
35 # directory. Run "MACHINE=dm800se bitbake dreambox-image" to build an image
36 # for the dm800se, if it is not the default.
37 MACHINE ?= dm7080
38
39 USER_MACHINE := $(MACHINE)
40
41 ifeq ($(MACHINE),dm7020hdv2)
42 override MACHINE := dm7020hd
43 MAKE_IMAGE_BB ?= dreambox-image-dm7020hdv2
44 endif
45
46 MAKE_IMAGE_BB ?= dreambox-image
47
48 # Adjust according to the number CPU cores to use for parallel build.
49 # Default: Number of processors in /proc/cpuinfo, if present, or 1.
50 NR_CPU := $(shell [ -f /proc/cpuinfo ] && grep -c '^processor\s*:' /proc/cpuinfo || echo 1)
51 BB_NUMBER_THREADS ?= $(NR_CPU)
52 PARALLEL_MAKE ?= -j $(NR_CPU)
53
54 XSUM ?= md5sum
55
56 BUILD_DIR = $(CURDIR)/build
57 TOPDIR = $(BUILD_DIR)/$(MACHINE)
58 DL_DIR = $(CURDIR)/sources
59 PERSISTENT_DIR = $(CURDIR)/persist-cache
60 SSTATE_DIR = $(CURDIR)/sstate-cache
61 TMPDIR = $(TOPDIR)/tmp
62 DEPDIR = $(CURDIR)/.deps
63
64 BITBAKE = . $(CURDIR)/bitbake.env && cd $(TOPDIR) && bitbake
65
66 BBLAYERS ?= \
67         $(wildcard $(CURDIR)/meta-bsp/$(MACHINE)) \
68         $(CURDIR)/meta-bsp/common \
69         $(CURDIR)/meta-opendreambox \
70         $(CURDIR)/meta-qt5 \
71         $(CURDIR)/meta-openembedded/meta-oe \
72         $(CURDIR)/meta-openembedded/meta-filesystems \
73         $(CURDIR)/meta-openembedded/meta-initramfs \
74         $(CURDIR)/meta-openembedded/meta-multimedia \
75         $(CURDIR)/meta-openembedded/meta-networking \
76         $(CURDIR)/meta-openembedded/meta-ruby \
77         $(CURDIR)/openembedded-core/meta
78
79 CONFFILES_AUTO = \
80         bitbake.env \
81         conf/opendreambox.conf \
82         $(TOPDIR)/conf/bblayers.conf \
83         $(TOPDIR)/conf/local.conf
84
85 CONFFILES_MANUAL = \
86         .cross-compile-$(MACHINE).env
87
88 CONFDEPS = \
89         $(DEPDIR)/.bitbake.env.$(BITBAKE_ENV_HASH) \
90         $(DEPDIR)/.opendreambox.conf.$(OPENDREAMBOX_CONF_HASH) \
91         $(DEPDIR)/.bblayers.conf.$(MACHINE).$(BBLAYERS_CONF_HASH) \
92         $(DEPDIR)/.local.conf.$(MACHINE).$(LOCAL_CONF_HASH) \
93         $(DEPDIR)/.cross-compile.env.$(MACHINE).$(CROSS_COMPILE_ENV_HASH)
94
95 CONFFILES_BITBAKE = \
96         conf/opendreambox.conf \
97         openembedded-core/meta/conf/bitbake.conf \
98         $(wildcard \
99                 conf/bblayers-ext.conf \
100                 conf/bblayers-$(MACHINE)-ext.conf \
101                 conf/local-ext.conf \
102                 conf/local-$(MACHINE)-ext.conf)
103
104 GIT ?= git
105 GIT_REMOTE := $(shell $(GIT) remote)
106 GIT_USER_NAME := $(shell $(GIT) config user.name)
107 GIT_USER_EMAIL := $(shell $(GIT) config user.email)
108
109 hash = $(shell echo $(1) | $(XSUM) | awk '{print $$1}')
110
111 .DEFAULT_GOAL := all
112 all: init usage
113
114 $(BBLAYERS):
115         [ -d $@ ] || $(MAKE) $(MFLAGS) update
116
117 init: $(BBLAYERS) $(CONFFILES_AUTO)
118
119 help:
120         @echo "Your options:"
121         @echo
122         @echo "  * Update the SDK"
123         @echo "      $$ $(MAKE) update"
124         @echo
125         @echo "  * Build the PDF documentation (doc/opendreambox.pdf, requires pdfTeX):"
126         @echo "      $$ $(MAKE) doc"
127         @echo
128         @echo "  * View the documentation in text format:"
129         @echo "      $$ view doc/opendreambox.txt"
130         @echo
131         @echo "  * Select a new target machine:"
132         @echo "      $$ echo MACHINE=dm800sev2 >> conf/make.conf"
133         @echo "    [Valid values: dm500hd, dm500hdv2, dm800se, dm800sev2, dm7020hd, dm7020hdv2, dm7080, dm8000]"
134         @echo
135         @echo "  * Build a firmware image for the selected target machine:"
136         @echo "      $$ $(MAKE) image"
137         @echo
138         @echo "  * Build a firmware image for a different target machine:"
139         @echo "      $$ $(MAKE) image MACHINE=dm800sev2"
140         @echo "    [Valid values: dm500hd, dm500hdv2, dm800se, dm800sev2, dm7020hd, dm7020hdv2, dm7080, dm8000]"
141         @echo
142         @echo "  * Download all source files at once:"
143         @echo "      $$ $(MAKE) download"
144         @echo
145         @echo "  * Set up the environment to build recipes manually:"
146         @echo "      $$ source bitbake.env"
147         @echo "      $$ cd build/$(MACHINE)"
148         @echo "      $$ bitbake <target>"
149         @echo "    [Replace <target> with a recipe name, e.g. $(MAKE_IMAGE_BB) or enigma2]"
150         @echo
151         @echo "Your current settings:"
152         @echo "  MACHINE = $(USER_MACHINE)"
153         @echo
154         @echo "  BB_NUMBER_THREADS = $(BB_NUMBER_THREADS)"
155         @echo "  PARALLEL_MAKE = $(PARALLEL_MAKE)"
156         @echo
157         @echo "Trouble finding a recipe? Try ./scripts/drepo grep 'search string'"
158         @echo "or ./scripts/drepo find -name \"*recipe*\"."
159         @echo
160         @if [ -z "$(GIT_USER_NAME)" -o -z "$(GIT_USER_EMAIL)" ]; then \
161                 echo "Before doing any commits, please configure your name and email"; \
162                 echo "address using the following commands:"; \
163                 echo; \
164                 echo "  $$ $(GIT) config user.name \"Your Name\""; \
165                 echo "  $$ $(GIT) config user.email \"mail@example.com\""; \
166         else \
167                 echo "Git has been configured for $(GIT_USER_NAME) <$(GIT_USER_EMAIL)>."; \
168                 echo "Please submit patches to <enigma2-devel@lists.elitedvb.net>."; \
169         fi
170
171 usage:
172         @echo "[*] Please run '$(MAKE) help' to display further information!"
173
174 clean:
175         @echo '[*] Deleting generated configuration files'
176         @$(RM) $(CONFFILES_AUTO) $(CONFFILES_MANUAL) $(CONFDEPS)
177         @$(MAKE) $(MFLAGS) -C doc clean
178
179 distclean: clean
180         @echo '[*] Deleting dependencies directory'
181         @$(RM) -r $(DEPDIR)
182         @echo '[*] Deleting download directory'
183         @$(RM) -r $(DL_DIR)
184         @echo '[*] Deleting tmp directory'
185         @$(RM) -r $(TMPDIR)
186         @echo '[*] Deleting sstate directory'
187         @$(RM) -r $(SSTATE_DIR)
188         @echo '[*] Deleting persistent directory'
189         @$(RM) -r $(PERSISTENT_DIR)
190         @echo '[*] Deleting build directory'
191         @$(RM) -r $(BUILD_DIR)
192         @echo '[*] Deleting git submodules'
193         @$(GIT) submodule foreach 'rm -rf .* * 2>/dev/null || true'
194
195 # function to convert simple space separated list to csv
196 space :=
197 space +=
198 comma := ,
199 csv = $(subst $(space),$(comma),$(strip $1))
200
201 sstate-cache-clean: init
202         @echo '[*] Cleaning up sstate-cache'
203         @. $(CURDIR)/bitbake.env && sstate-cache-management.sh --cache-dir=$(SSTATE_DIR) --stamps-dir=$(call csv,$(wildcard $(CURDIR)/build/*/tmp*/stamps)) -v
204
205 doc:
206         @$(MAKE) $(MFLAGS) -C doc
207
208 dreambox-image enigma2 package-index: init
209         @echo '[*] Building $@ for $(USER_MACHINE)'
210         @$(BITBAKE) $@
211
212 image: init
213         @echo '[*] Building $@ for $(USER_MACHINE)'
214         @$(BITBAKE) $(MAKE_IMAGE_BB)
215
216 rescue-image: init
217         @echo '[*] Building $@ for $(USER_MACHINE)'
218         @$(BITBAKE) linux-dreambox-rescue
219
220 download: init
221         @echo '[*] Downloading sources'
222         @$(BITBAKE) -cfetchall -k $(MAKE_IMAGE_BB)
223
224 update:
225         @echo '[*] Updating Git repositories...'
226         @HASH=`$(XSUM) $(MAKEFILE_LIST)`; \
227         if [ -n "$(GIT_REMOTE)" ]; then \
228                 $(GIT) pull --ff-only || $(GIT) pull --rebase; \
229         fi; \
230         if [ "$$HASH" != "`$(XSUM) $(MAKEFILE_LIST)`" ]; then \
231                 echo '[*] Makefile changed. Restarting...'; \
232                 $(MAKE) $(MFLAGS) --no-print-directory $(MAKECMDGOALS); \
233         else \
234                 $(GIT) submodule sync && \
235                 $(GIT) submodule update --init && \
236                 echo "[*] The Dreambox SDK is now up-to-date."; \
237         fi
238
239 .PHONY: all clean doc help image init update usage
240
241 MACHINE_INCLUDE_CONF = $(CURDIR)/conf/$(basename $(@F))-$(MACHINE)-ext.conf
242 DISTRO_INCLUDE_CONF = $(CURDIR)/conf/$(basename $(@F))-ext.conf
243
244 BITBAKE_ENV_HASH := $(call hash, \
245         'BITBAKE_ENV_VERSION = "0"' \
246         'CURDIR = "$(CURDIR)"' \
247         )
248
249 bitbake.env: $(DEPDIR)/.bitbake.env.$(BITBAKE_ENV_HASH)
250         @echo '[*] Generating $@'
251         @echo '# Automatically generated file. Do not edit!' > $@
252         @echo 'export PATH=$(CURDIR)/openembedded-core/scripts:$(CURDIR)/bitbake/bin:$${PATH}' >> $@
253
254 OPENDREAMBOX_CONF_HASH := $(call hash, \
255         'OPENDREAMBOX_CONF_VERSION = "2"' \
256         'CURDIR = "$(CURDIR)"' \
257         'BB_NUMBER_THREADS = "$(BB_NUMBER_THREADS)"' \
258         'PARALLEL_MAKE = "$(PARALLEL_MAKE)"' \
259         'DL_DIR = "$(DL_DIR)"' \
260         'PERSISTENT_DIR = "$(PERSISTENT_DIR)"' \
261         'SSTATE_DIR = "$(SSTATE_DIR)"' \
262         )
263
264 conf/opendreambox.conf: $(DEPDIR)/.opendreambox.conf.$(OPENDREAMBOX_CONF_HASH)
265         @echo '[*] Generating $@'
266         @test -d $(@D) || mkdir -p $(@D)
267         @echo '# Automatically generated file. Do not edit!' > $@
268         @echo 'BB_NUMBER_THREADS = "$(BB_NUMBER_THREADS)"' >> $@
269         @echo 'PARALLEL_MAKE = "$(PARALLEL_MAKE)"' >> $@
270         @echo 'DL_DIR = "$(DL_DIR)"' >> $@
271         @echo 'PERSISTENT_DIR = "$(PERSISTENT_DIR)"' >> $@
272         @echo 'SSTATE_DIR = "$(SSTATE_DIR)"' >> $@
273         @echo 'BB_GENERATE_MIRROR_TARBALLS = "0"' >> $@
274         @echo 'BBINCLUDELOGS = "yes"' >> $@
275         @echo 'CONF_VERSION = "1"' >> $@
276         @echo 'DISTRO = "opendreambox"' >> $@
277         @echo 'EXTRA_IMAGE_FEATURES = "debug-tweaks"' >> $@
278         @echo 'USER_CLASSES = "buildstats"' >> $@
279         @echo 'PATCHRESOLVE = "noop"' >> $@
280         @echo 'PRSERV_HOST = "localhost:0"' >> $@
281
282 LOCAL_CONF_HASH := $(call hash, \
283         'LOCAL_CONF_VERSION = "0"' \
284         'CURDIR = "$(CURDIR)"' \
285         'TOPDIR = "$(TOPDIR)"' \
286         'MACHINE = "$(MACHINE)"' \
287         'TMPDIR = "$(TMPDIR)"' \
288         )
289
290 $(TOPDIR)/conf/local.conf: $(DEPDIR)/.local.conf.$(MACHINE).$(LOCAL_CONF_HASH)
291         @echo '[*] Generating $@'
292         @test -d $(@D) || mkdir -p $(@D)
293         @echo '# Automatically generated file. Do not edit!' > $@
294         @echo 'TOPDIR = "$(TOPDIR)"' >> $@
295         @echo 'MACHINE = "$(MACHINE)"' >> $@
296         @echo 'TMPDIR = "$(TMPDIR)"' >> $@
297         @echo 'require $(CURDIR)/conf/opendreambox.conf' >> $@
298         @echo 'include $(DISTRO_INCLUDE_CONF)' >> $@
299         @echo 'include $(MACHINE_INCLUDE_CONF)' >> $@
300
301 BBLAYERS_CONF_HASH := $(call hash, \
302         'BBLAYERS_CONF_VERSION = "0"' \
303         'CURDIR = "$(CURDIR)"' \
304         'BBLAYERS = "$(BBLAYERS)"' \
305         )
306
307 $(TOPDIR)/conf/bblayers.conf: $(DEPDIR)/.bblayers.conf.$(MACHINE).$(BBLAYERS_CONF_HASH)
308         @echo '[*] Generating $@'
309         @test -d $(@D) || mkdir -p $(@D)
310         @echo '# Automatically generated file. Do not edit!' > $@
311         @echo 'LCONF_VERSION = "4"' >> $@
312         @echo 'BBFILES = ""' >> $@
313         @echo 'BBLAYERS = "$(BBLAYERS)"' >> $@
314         @echo 'include $(DISTRO_INCLUDE_CONF)' >> $@
315         @echo 'include $(MACHINE_INCLUDE_CONF)' >> $@
316
317 CROSS_COMPILE_ENV_BLACKLIST = \
318         HOME LOGNAME PWD SHELL SSH_AGENT_PID SSH_AUTH_SOCK TERM USER
319
320 CROSS_COMPILE_ENV_HASH := $(call hash, \
321         'CROSS_COMPILE_ENV_VERSION = "0"' \
322         'CURDIR = "$(CURDIR)"' \
323         'PARALLEL_MAKE = "$(PARALLEL_MAKE)"' \
324         'TMPDIR = "$(TMPDIR)"' \
325         'TOPDIR = "$(TOPDIR)"' \
326         'CROSS_COMPILE_ENV_BLACKLIST = "$(CROSS_COMPILE_ENV_BLACKLIST)"' \
327         )
328
329 .cross-compile-$(MACHINE).env: $(DEPDIR)/.cross-compile.env.$(MACHINE).$(CROSS_COMPILE_ENV_HASH) $(CONFFILES_BITBAKE)
330         @test -d $(TOPDIR) || (echo 'The directory "$(TOPDIR)" does not exist. Is "$(MACHINE)" a valid machine? Try running "make MACHINE=$(MACHINE)" first.' && exit 1)
331         @echo '[*] Generating $@'
332         @echo '# Automatically generated file. Do not edit!' > $@
333         @($(BITBAKE) -e | grep '^\(export\s\)\?[a-zA-Z0-9_]\+=".*"$$' | sed -e 's,^export\s,,' | grep -v $(foreach v,$(CROSS_COMPILE_ENV_BLACKLIST),-e ^$(v)=) | sed -e 's,^,local ,' | sort) >> $@ || ($(RM) $@ && exit 1)
334
335 $(CONFDEPS):
336         @test -d $(@D) || mkdir -p $(@D)
337         @$(RM) $(basename $@).*
338         @touch $@