]> git.ipfire.org Git - thirdparty/u-boot.git/blob - scripts/Kbuild.include
Merge branch '2023-10-30-assorted-general-updates'
[thirdparty/u-boot.git] / scripts / Kbuild.include
1 ####
2 # kbuild: Generic definitions
3
4 # Convenient variables
5 comma := ,
6 quote := "
7 squote := '
8 empty :=
9 space := $(empty) $(empty)
10 space_escape := _-_SPACE_-_
11 pound := \#
12
13 ###
14 # Name of target with a '.' as filename prefix. foo/bar.o => foo/.bar.o
15 dot-target = $(dir $@).$(notdir $@)
16
17 ###
18 # The temporary file to save gcc -MD generated dependencies must not
19 # contain a comma
20 depfile = $(subst $(comma),_,$(dot-target).d)
21
22 ###
23 # filename of target with directory and extension stripped
24 basetarget = $(basename $(notdir $@))
25
26 ###
27 # filename of first prerequisite with directory and extension stripped
28 baseprereq = $(basename $(notdir $<))
29
30 ###
31 # Escape single quote for use in echo statements
32 escsq = $(subst $(squote),'\$(squote)',$1)
33
34 ###
35 # Easy method for doing a status message
36 kecho := :
37 quiet_kecho := echo
38 silent_kecho := :
39 kecho := $($(quiet)kecho)
40
41 ###
42 # filechk is used to check if the content of a generated file is updated.
43 # Sample usage:
44 # define filechk_sample
45 # echo $KERNELRELEASE
46 # endef
47 # version.h : Makefile
48 # $(call filechk,sample)
49 # The rule defined shall write to stdout the content of the new file.
50 # The existing file will be compared with the new one.
51 # - If no file exist it is created
52 # - If the content differ the new file is used
53 # - If they are equal no change, and no timestamp update
54 # - stdin is piped in from the first prerequisite ($<) so one has
55 # to specify a valid file as first prerequisite (often the kbuild file)
56 define filechk
57 $(Q)set -e; \
58 mkdir -p $(dir $@); \
59 $(filechk_$(1)) < $< > $@.tmp; \
60 if [ -r $@ ] && cmp -s $@ $@.tmp; then \
61 rm -f $@.tmp; \
62 else \
63 $(kecho) ' UPD $@'; \
64 mv -f $@.tmp $@; \
65 fi
66 endef
67
68 ######
69 # gcc support functions
70 # See documentation in Documentation/kbuild/makefiles.txt
71
72 # cc-cross-prefix
73 # Usage: CROSS_COMPILE := $(call cc-cross-prefix, m68k-linux-gnu- m68k-linux-)
74 # Return first prefix where a prefix$(CC) is found in PATH.
75 # If no $(CC) found in PATH with listed prefixes return nothing
76 cc-cross-prefix = \
77 $(word 1, $(foreach c,$(1), \
78 $(shell set -e; \
79 if (which $(strip $(c))$(CC)) > /dev/null 2>&1 ; then \
80 echo $(c); \
81 fi)))
82
83 # output directory for tests below
84 TMPOUT := $(if $(KBUILD_EXTMOD),$(firstword $(KBUILD_EXTMOD))/)
85
86 # try-run
87 # Usage: option = $(call try-run, $(CC)...-o "$$TMP",option-ok,otherwise)
88 # Exit code chooses option. "$$TMP" is can be used as temporary file and
89 # is automatically cleaned up.
90 # modifed for U-Boot: prevent cc-option from leaving .*.su files
91 try-run = $(shell set -e; \
92 TMP="$(TMPOUT).$$$$.tmp"; \
93 TMPO="$(TMPOUT).$$$$.o"; \
94 TMPSU="$(TMPOUT).$$$$.su"; \
95 if ($(1)) >/dev/null 2>&1; \
96 then echo "$(2)"; \
97 else echo "$(3)"; \
98 fi; \
99 rm -f "$$TMP" "$$TMPO" "$$TMPSU")
100
101 # as-option
102 # Usage: cflags-y += $(call as-option,-Wa$(comma)-isa=foo,)
103
104 as-option = $(call try-run,\
105 $(CC) $(KBUILD_CFLAGS) $(1) -c -x assembler /dev/null -o "$$TMP",$(1),$(2))
106
107 # as-instr
108 # Usage: cflags-y += $(call as-instr,instr,option1,option2)
109
110 as-instr = $(call try-run,\
111 printf "%b\n" "$(1)" | $(CC) $(KBUILD_AFLAGS) -c -x assembler -o "$$TMP" -,$(2),$(3))
112
113 # __cc-option
114 # Usage: MY_CFLAGS += $(call __cc-option,$(CC),$(MY_CFLAGS),-march=winchip-c6,-march=i586)
115 __cc-option = $(call try-run,\
116 $(1) -Werror $(2) $(3) -c -x c /dev/null -o "$$TMP",$(3),$(4))
117
118 # cc-option
119 # Usage: cflags-y += $(call cc-option,-march=winchip-c6,-march=i586)
120 cc-option = $(call __cc-option, $(CC),\
121 $(KBUILD_CPPFLAGS) $(KBUILD_CFLAGS),$(1),$(2))
122
123 # hostcc-option
124 # Usage: cflags-y += $(call hostcc-option,-march=winchip-c6,-march=i586)
125 hostcc-option = $(call __cc-option, $(HOSTCC),\
126 $(HOSTCFLAGS) $(HOST_EXTRACFLAGS),$(1),$(2))
127
128 # cc-option-yn
129 # Usage: flag := $(call cc-option-yn,-march=winchip-c6)
130 cc-option-yn = $(call try-run,\
131 $(CC) -Werror $(KBUILD_CPPFLAGS) $(KBUILD_CFLAGS) $(1) -c -x c /dev/null -o "$$TMP",y,n)
132
133 # cc-disable-warning
134 # Usage: cflags-y += $(call cc-disable-warning,unused-but-set-variable)
135 cc-disable-warning = $(call try-run,\
136 $(CC) -Werror $(KBUILD_CPPFLAGS) $(KBUILD_CFLAGS) -W$(strip $(1)) -c -x c /dev/null -o "$$TMP",-Wno-$(strip $(1)))
137
138 # cc-name
139 # Expands to either gcc or clang
140 cc-name = $(shell $(CC) -v 2>&1 | grep -q "clang version" && echo clang || echo gcc)
141
142 # cc-version
143 cc-version = $(shell $(CONFIG_SHELL) $(srctree)/scripts/gcc-version.sh $(CC))
144
145 # cc-ifversion
146 # Usage: EXTRA_CFLAGS += $(call cc-ifversion, -lt, 0402, -O1)
147 cc-ifversion = $(shell [ $(cc-version) $(1) $(2) ] && echo $(3) || echo $(4))
148
149 # added for U-Boot
150 binutils-version = $(shell $(CONFIG_SHELL) $(srctree)/scripts/binutils-version.sh $(AS))
151 dtc-version = $(shell $(CONFIG_SHELL) $(srctree)/scripts/dtc-version.sh $(DTC))
152
153 # cc-ldoption
154 # Usage: ldflags += $(call cc-ldoption, -Wl$(comma)--hash-style=both)
155 cc-ldoption = $(call try-run,\
156 $(CC) $(1) $(KBUILD_CPPFLAGS) $(CC_OPTION_CFLAGS) -nostdlib -x c /dev/null -o "$$TMP",$(1),$(2))
157
158 # ld-option
159 # Usage: KBUILD_LDFLAGS += $(call ld-option, -X, -Y)
160 ld-option = $(call try-run, $(LD) $(KBUILD_LDFLAGS) $(1) -v,$(1),$(2),$(3))
161
162 # ar-option
163 # Usage: KBUILD_ARFLAGS := $(call ar-option,D)
164 # Important: no spaces around options
165 ar-option = $(call try-run, $(AR) rc$(1) "$$TMP",$(1),$(2))
166
167 # ld-version
168 # Note this is mainly for HJ Lu's 3 number binutil versions
169 ld-version = $(shell $(LD) --version | $(srctree)/scripts/ld-version.sh)
170
171 # ld-ifversion
172 # Usage: $(call ld-ifversion, -ge, 22252, y)
173 ld-ifversion = $(shell [ $(ld-version) $(1) $(2) ] && echo $(3) || echo $(4))
174
175 ######
176
177 ###
178 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.build obj=
179 # Usage:
180 # $(Q)$(MAKE) $(build)=dir
181 build := -f $(srctree)/scripts/Makefile.build obj
182
183 ###
184 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.modbuiltin obj=
185 # Usage:
186 # $(Q)$(MAKE) $(modbuiltin)=dir
187 modbuiltin := -f $(srctree)/scripts/Makefile.modbuiltin obj
188
189 ###
190 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.dtbinst obj=
191 # Usage:
192 # $(Q)$(MAKE) $(dtbinst)=dir
193 dtbinst := -f $(srctree)/scripts/Makefile.dtbinst obj
194
195 ###
196 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.clean obj=
197 # Usage:
198 # $(Q)$(MAKE) $(clean)=dir
199 clean := -f $(srctree)/scripts/Makefile.clean obj
200
201 ###
202 # Shorthand for $(Q)$(MAKE) -f scripts/Makefile.headersinst obj=
203 # Usage:
204 # $(Q)$(MAKE) $(hdr-inst)=dir
205 hdr-inst := -f $(srctree)/scripts/Makefile.headersinst obj
206
207 # Prefix -I with $(srctree) if it is not an absolute path.
208 # skip if -I has no parameter
209 addtree = $(if $(patsubst -I%,%,$(1)), \
210 $(if $(filter-out -I/% -I./% -I../%,$(1)),$(patsubst -I%,-I$(srctree)/%,$(1)),$(1)),$(1))
211
212 # Find all -I options and call addtree
213 flags = $(foreach o,$($(1)),$(if $(filter -I%,$(o)),$(call addtree,$(o)),$(o)))
214
215 # echo command.
216 # Short version is used, if $(quiet) equals `quiet_', otherwise full one.
217 echo-cmd = $(if $($(quiet)cmd_$(1)),\
218 echo ' $(call escsq,$($(quiet)cmd_$(1)))$(echo-why)';)
219
220 # printing commands
221 cmd = @$(echo-cmd) $(cmd_$(1))
222
223 # Add $(obj)/ for paths that are not absolute
224 objectify = $(foreach o,$(1),$(if $(filter /%,$(o)),$(o),$(obj)/$(o)))
225
226 ###
227 # if_changed - execute command if any prerequisite is newer than
228 # target, or command line has changed
229 # if_changed_dep - as if_changed, but uses fixdep to reveal dependencies
230 # including used config symbols
231 # if_changed_rule - as if_changed but execute rule instead
232 # See doc/develop/makefiles.rst for more info
233
234 ifneq ($(KBUILD_NOCMDDEP),1)
235 # Check if both arguments are the same including their order. Result is empty
236 # string if equal. User may override this check using make KBUILD_NOCMDDEP=1
237 arg-check = $(filter-out $(subst $(space),$(space_escape),$(strip $(cmd_$@))), \
238 $(subst $(space),$(space_escape),$(strip $(cmd_$1))))
239 else
240 arg-check = $(if $(strip $(cmd_$@)),,1)
241 endif
242
243 # Replace >$< with >$$< to preserve $ when reloading the .cmd file
244 # (needed for make)
245 # Replace >#< with >$(pound)< to avoid starting a comment in the .cmd file
246 # (needed for make)
247 # Replace >'< with >'\''< to be able to enclose the whole string in '...'
248 # (needed for the shell)
249 make-cmd = $(call escsq,$(subst $(pound),$$(pound),$(subst $$,$$$$,$(cmd_$(1)))))
250
251 # Find any prerequisites that is newer than target or that does not exist.
252 # PHONY targets skipped in both cases.
253 any-prereq = $(filter-out $(PHONY),$?) $(filter-out $(PHONY) $(wildcard $^),$^)
254
255 # Execute command if command has changed or prerequisite(s) are updated.
256 #
257 if_changed = $(if $(strip $(any-prereq) $(arg-check)), \
258 @set -e; \
259 $(echo-cmd) $(cmd_$(1)); \
260 printf '%s\n' 'cmd_$@ := $(make-cmd)' > $(dot-target).cmd, @:)
261
262 # Execute the command and also postprocess generated .d dependencies file.
263 if_changed_dep = $(if $(strip $(any-prereq) $(arg-check) ), \
264 @set -e; \
265 $(echo-cmd) $(cmd_$(1)); \
266 scripts/basic/fixdep $(depfile) $@ '$(make-cmd)' > $(dot-target).tmp;\
267 rm -f $(depfile); \
268 mv -f $(dot-target).tmp $(dot-target).cmd, @:)
269
270 # Usage: $(call if_changed_rule,foo)
271 # Will check if $(cmd_foo) or any of the prerequisites changed,
272 # and if so will execute $(rule_foo).
273 if_changed_rule = $(if $(strip $(any-prereq) $(arg-check) ), \
274 @set -e; \
275 $(rule_$(1)), @:)
276
277 ###
278 # why - tell why a a target got build
279 # enabled by make V=2
280 # Output (listed in the order they are checked):
281 # (1) - due to target is PHONY
282 # (2) - due to target missing
283 # (3) - due to: file1.h file2.h
284 # (4) - due to command line change
285 # (5) - due to missing .cmd file
286 # (6) - due to target not in $(targets)
287 # (1) PHONY targets are always build
288 # (2) No target, so we better build it
289 # (3) Prerequisite is newer than target
290 # (4) The command line stored in the file named dir/.target.cmd
291 # differed from actual command line. This happens when compiler
292 # options changes
293 # (5) No dir/.target.cmd file (used to store command line)
294 # (6) No dir/.target.cmd file and target not listed in $(targets)
295 # This is a good hint that there is a bug in the kbuild file
296 ifeq ($(KBUILD_VERBOSE),2)
297 why = \
298 $(if $(filter $@, $(PHONY)),- due to target is PHONY, \
299 $(if $(wildcard $@), \
300 $(if $(strip $(any-prereq)),- due to: $(any-prereq), \
301 $(if $(arg-check), \
302 $(if $(cmd_$@),- due to command line change, \
303 $(if $(filter $@, $(targets)), \
304 - due to missing .cmd file, \
305 - due to $(notdir $@) not in $$(targets) \
306 ) \
307 ) \
308 ) \
309 ), \
310 - due to target missing \
311 ) \
312 )
313
314 echo-why = $(call escsq, $(strip $(why)))
315 endif
316
317 # delete partially updated (i.e. corrupted) files on error
318 .DELETE_ON_ERROR:
319
320 # do not delete intermediate files automatically
321 .SECONDARY:
322
323 ifdef CONFIG_SPL_BUILD
324 SPL_ := SPL_
325 ifeq ($(CONFIG_VPL_BUILD),y)
326 SPL_TPL_ := VPL_
327 else
328 ifeq ($(CONFIG_TPL_BUILD),y)
329 SPL_TPL_ := TPL_
330 else
331 SPL_TPL_ := SPL_
332 endif
333 endif
334 else
335 SPL_ :=
336 SPL_TPL_ :=
337 endif