342618a2bccb4c7aa4a0003c250f39aa78eb89dd
[platform/kernel/linux-rpi.git] / scripts / Makefile.lib
1 # SPDX-License-Identifier: GPL-2.0
2 # Backward compatibility
3 asflags-y  += $(EXTRA_AFLAGS)
4 ccflags-y  += $(EXTRA_CFLAGS)
5 cppflags-y += $(EXTRA_CPPFLAGS)
6 ldflags-y  += $(EXTRA_LDFLAGS)
7
8 # flags that take effect in current and sub directories
9 KBUILD_AFLAGS += $(subdir-asflags-y)
10 KBUILD_CFLAGS += $(subdir-ccflags-y)
11
12 # Figure out what we need to build from the various variables
13 # ===========================================================================
14
15 # When an object is listed to be built compiled-in and modular,
16 # only build the compiled-in version
17 obj-m := $(filter-out $(obj-y),$(obj-m))
18
19 # Libraries are always collected in one lib file.
20 # Filter out objects already built-in
21 lib-y := $(filter-out $(obj-y), $(sort $(lib-y) $(lib-m)))
22
23 # Determine modorder.
24 # Unfortunately, we don't have information about ordering between -y
25 # and -m subdirs.  Just put -y's first.
26 modorder        := $(patsubst %/,%/modules.order, $(filter %/, $(obj-y)) $(obj-m:.o=.ko))
27
28 # Handle objects in subdirs
29 # ---------------------------------------------------------------------------
30 # o if we encounter foo/ in $(obj-y), replace it by foo/built-in.a
31 #   and add the directory to the list of dirs to descend into: $(subdir-y)
32 # o if we encounter foo/ in $(obj-m), remove it from $(obj-m)
33 #   and add the directory to the list of dirs to descend into: $(subdir-m)
34 __subdir-y      := $(patsubst %/,%,$(filter %/, $(obj-y)))
35 subdir-y        += $(__subdir-y)
36 __subdir-m      := $(patsubst %/,%,$(filter %/, $(obj-m)))
37 subdir-m        += $(__subdir-m)
38 obj-y           := $(patsubst %/, %/built-in.a, $(obj-y))
39 obj-m           := $(filter-out %/, $(obj-m))
40
41 # Subdirectories we need to descend into
42 subdir-ym       := $(sort $(subdir-y) $(subdir-m))
43
44 # If $(foo-objs), $(foo-y), $(foo-m), or $(foo-) exists, foo.o is a composite object
45 multi-used-y := $(sort $(foreach m,$(obj-y), $(if $(strip $($(m:.o=-objs)) $($(m:.o=-y)) $($(m:.o=-))), $(m))))
46 multi-used-m := $(sort $(foreach m,$(obj-m), $(if $(strip $($(m:.o=-objs)) $($(m:.o=-y)) $($(m:.o=-m)) $($(m:.o=-))), $(m))))
47 multi-used   := $(multi-used-y) $(multi-used-m)
48
49 # $(subdir-obj-y) is the list of objects in $(obj-y) which uses dir/ to
50 # tell kbuild to descend
51 subdir-obj-y := $(filter %/built-in.a, $(obj-y))
52
53 # Replace multi-part objects by their individual parts,
54 # including built-in.a from subdirectories
55 real-obj-y := $(foreach m, $(obj-y), $(if $(strip $($(m:.o=-objs)) $($(m:.o=-y)) $($(m:.o=-))),$($(m:.o=-objs)) $($(m:.o=-y)),$(m)))
56 real-obj-m := $(foreach m, $(obj-m), $(if $(strip $($(m:.o=-objs)) $($(m:.o=-y)) $($(m:.o=-m)) $($(m:.o=-))),$($(m:.o=-objs)) $($(m:.o=-y)) $($(m:.o=-m)),$(m)))
57
58 # DTB
59 # If CONFIG_OF_ALL_DTBS is enabled, all DT blobs are built
60 extra-y                         += $(dtb-y)
61 extra-$(CONFIG_OF_ALL_DTBS)     += $(dtb-)
62
63 ifneq ($(CHECK_DTBS),)
64 extra-y += $(patsubst %.dtb,%.dt.yaml, $(dtb-y))
65 extra-$(CONFIG_OF_ALL_DTBS) += $(patsubst %.dtb,%.dt.yaml, $(dtb-))
66 endif
67
68 # Add subdir path
69
70 extra-y         := $(addprefix $(obj)/,$(extra-y))
71 always          := $(addprefix $(obj)/,$(always))
72 targets         := $(addprefix $(obj)/,$(targets))
73 modorder        := $(addprefix $(obj)/,$(modorder))
74 obj-m           := $(addprefix $(obj)/,$(obj-m))
75 lib-y           := $(addprefix $(obj)/,$(lib-y))
76 subdir-obj-y    := $(addprefix $(obj)/,$(subdir-obj-y))
77 real-obj-y      := $(addprefix $(obj)/,$(real-obj-y))
78 real-obj-m      := $(addprefix $(obj)/,$(real-obj-m))
79 multi-used-m    := $(addprefix $(obj)/,$(multi-used-m))
80 subdir-ym       := $(addprefix $(obj)/,$(subdir-ym))
81
82 # Finds the multi-part object the current object will be linked into.
83 # If the object belongs to two or more multi-part objects, all of them are
84 # concatenated with a colon separator.
85 modname-multi = $(subst $(space),:,$(sort $(foreach m,$(multi-used),\
86                 $(if $(filter $*.o, $($(m:.o=-objs)) $($(m:.o=-y)) $($(m:.o=-m))),$(m:.o=)))))
87
88 modname = $(if $(modname-multi),$(modname-multi),$(basetarget))
89
90 # target with $(obj)/ and its suffix stripped
91 target-stem = $(basename $(patsubst $(obj)/%,%,$@))
92
93 # These flags are needed for modversions and compiling, so we define them here
94 # $(modname_flags) defines KBUILD_MODNAME as the name of the module it will
95 # end up in (or would, if it gets compiled in)
96 name-fix = $(squote)$(quote)$(subst $(comma),_,$(subst -,_,$1))$(quote)$(squote)
97 basename_flags = -DKBUILD_BASENAME=$(call name-fix,$(basetarget))
98 modname_flags  = -DKBUILD_MODNAME=$(call name-fix,$(modname))
99
100 orig_c_flags   = $(KBUILD_CPPFLAGS) $(KBUILD_CFLAGS) \
101                  $(ccflags-y) $(CFLAGS_$(target-stem).o)
102 _c_flags       = $(filter-out $(CFLAGS_REMOVE_$(target-stem).o), $(orig_c_flags))
103 orig_a_flags   = $(KBUILD_CPPFLAGS) $(KBUILD_AFLAGS) \
104                  $(asflags-y) $(AFLAGS_$(target-stem).o)
105 _a_flags       = $(filter-out $(AFLAGS_REMOVE_$(target-stem).o), $(orig_a_flags))
106 _cpp_flags     = $(KBUILD_CPPFLAGS) $(cppflags-y) $(CPPFLAGS_$(target-stem).lds)
107
108 #
109 # Enable gcov profiling flags for a file, directory or for all files depending
110 # on variables GCOV_PROFILE_obj.o, GCOV_PROFILE and CONFIG_GCOV_PROFILE_ALL
111 # (in this order)
112 #
113 ifeq ($(CONFIG_GCOV_KERNEL),y)
114 _c_flags += $(if $(patsubst n%,, \
115                 $(GCOV_PROFILE_$(basetarget).o)$(GCOV_PROFILE)$(CONFIG_GCOV_PROFILE_ALL)), \
116                 $(CFLAGS_GCOV))
117 endif
118
119 #
120 # Enable address sanitizer flags for kernel except some files or directories
121 # we don't want to check (depends on variables KASAN_SANITIZE_obj.o, KASAN_SANITIZE)
122 #
123 ifeq ($(CONFIG_KASAN),y)
124 _c_flags += $(if $(patsubst n%,, \
125                 $(KASAN_SANITIZE_$(basetarget).o)$(KASAN_SANITIZE)y), \
126                 $(CFLAGS_KASAN), $(CFLAGS_KASAN_NOSANITIZE))
127 endif
128
129 ifeq ($(CONFIG_UBSAN),y)
130 _c_flags += $(if $(patsubst n%,, \
131                 $(UBSAN_SANITIZE_$(basetarget).o)$(UBSAN_SANITIZE)$(CONFIG_UBSAN_SANITIZE_ALL)), \
132                 $(CFLAGS_UBSAN))
133 endif
134
135 ifeq ($(CONFIG_KCOV),y)
136 _c_flags += $(if $(patsubst n%,, \
137         $(KCOV_INSTRUMENT_$(basetarget).o)$(KCOV_INSTRUMENT)$(CONFIG_KCOV_INSTRUMENT_ALL)), \
138         $(CFLAGS_KCOV))
139 endif
140
141 # $(srctree)/$(src) for including checkin headers from generated source files
142 # $(objtree)/$(obj) for including generated headers from checkin source files
143 ifeq ($(KBUILD_EXTMOD),)
144 ifdef building_out_of_srctree
145 _c_flags   += -I $(srctree)/$(src) -I $(objtree)/$(obj)
146 _a_flags   += -I $(srctree)/$(src) -I $(objtree)/$(obj)
147 _cpp_flags += -I $(srctree)/$(src) -I $(objtree)/$(obj)
148 endif
149 endif
150
151 part-of-module = $(if $(filter $(basename $@).o, $(real-obj-m)),y)
152 quiet_modtag = $(if $(part-of-module),[M],   )
153
154 modkern_cflags =                                          \
155         $(if $(part-of-module),                           \
156                 $(KBUILD_CFLAGS_MODULE) $(CFLAGS_MODULE), \
157                 $(KBUILD_CFLAGS_KERNEL) $(CFLAGS_KERNEL))
158
159 modkern_aflags = $(if $(part-of-module),                                \
160                         $(KBUILD_AFLAGS_MODULE) $(AFLAGS_MODULE),       \
161                         $(KBUILD_AFLAGS_KERNEL) $(AFLAGS_KERNEL))
162
163 c_flags        = -Wp,-MD,$(depfile) $(NOSTDINC_FLAGS) $(LINUXINCLUDE)     \
164                  -include $(srctree)/include/linux/compiler_types.h       \
165                  $(_c_flags) $(modkern_cflags)                           \
166                  $(basename_flags) $(modname_flags)
167
168 a_flags        = -Wp,-MD,$(depfile) $(NOSTDINC_FLAGS) $(LINUXINCLUDE)     \
169                  $(_a_flags) $(modkern_aflags)
170
171 cpp_flags      = -Wp,-MD,$(depfile) $(NOSTDINC_FLAGS) $(LINUXINCLUDE)     \
172                  $(_cpp_flags)
173
174 ld_flags       = $(KBUILD_LDFLAGS) $(ldflags-y) $(LDFLAGS_$(@F))
175
176 DTC_INCLUDE    := $(srctree)/scripts/dtc/include-prefixes
177
178 dtc_cpp_flags  = -Wp,-MD,$(depfile).pre.tmp -nostdinc                    \
179                  $(addprefix -I,$(DTC_INCLUDE))                          \
180                  -undef -D__DTS__
181
182 # Useful for describing the dependency of composite objects
183 # Usage:
184 #   $(call multi_depend, multi_used_targets, suffix_to_remove, suffix_to_add)
185 define multi_depend
186 $(foreach m, $(notdir $1), \
187         $(eval $(obj)/$m: \
188         $(addprefix $(obj)/, $(foreach s, $3, $($(m:%$(strip $2)=%$(s)))))))
189 endef
190
191 # Shipped files
192 # ===========================================================================
193
194 quiet_cmd_shipped = SHIPPED $@
195 cmd_shipped = cat $< > $@
196
197 $(obj)/%: $(src)/%_shipped
198         $(call cmd,shipped)
199
200 # Commands useful for building a boot image
201 # ===========================================================================
202 #
203 #       Use as following:
204 #
205 #       target: source(s) FORCE
206 #               $(if_changed,ld/objcopy/gzip)
207 #
208 #       and add target to extra-y so that we know we have to
209 #       read in the saved command line
210
211 # Linking
212 # ---------------------------------------------------------------------------
213
214 quiet_cmd_ld = LD      $@
215       cmd_ld = $(LD) $(ld_flags) $(real-prereqs) -o $@
216
217 # Archive
218 # ---------------------------------------------------------------------------
219
220 quiet_cmd_ar = AR      $@
221       cmd_ar = rm -f $@; $(AR) cDPrsT $@ $(real-prereqs)
222
223 # Objcopy
224 # ---------------------------------------------------------------------------
225
226 quiet_cmd_objcopy = OBJCOPY $@
227 cmd_objcopy = $(OBJCOPY) $(OBJCOPYFLAGS) $(OBJCOPYFLAGS_$(@F)) $< $@
228
229 # Gzip
230 # ---------------------------------------------------------------------------
231
232 quiet_cmd_gzip = GZIP    $@
233       cmd_gzip = cat $(real-prereqs) | gzip -n -f -9 > $@
234
235 # DTC
236 # ---------------------------------------------------------------------------
237 DTC ?= $(objtree)/scripts/dtc/dtc
238
239 # Disable noisy checks by default
240 ifeq ($(findstring 1,$(KBUILD_EXTRA_WARN)),)
241 DTC_FLAGS += -Wno-unit_address_vs_reg \
242         -Wno-unit_address_format \
243         -Wno-avoid_unnecessary_addr_size \
244         -Wno-alias_paths \
245         -Wno-graph_child_address \
246         -Wno-simple_bus_reg \
247         -Wno-unique_unit_address \
248         -Wno-pci_device_reg
249 endif
250
251 ifneq ($(findstring 2,$(KBUILD_EXTRA_WARN)),)
252 DTC_FLAGS += -Wnode_name_chars_strict \
253         -Wproperty_name_chars_strict
254 endif
255
256 DTC_FLAGS += $(DTC_FLAGS_$(basetarget))
257
258 # Generate an assembly file to wrap the output of the device tree compiler
259 quiet_cmd_dt_S_dtb= DTB     $@
260 cmd_dt_S_dtb=                                           \
261 {                                                       \
262         echo '\#include <asm-generic/vmlinux.lds.h>';   \
263         echo '.section .dtb.init.rodata,"a"';           \
264         echo '.balign STRUCT_ALIGNMENT';                \
265         echo '.global __dtb_$(subst -,_,$(*F))_begin';  \
266         echo '__dtb_$(subst -,_,$(*F))_begin:';         \
267         echo '.incbin "$<" ';                           \
268         echo '__dtb_$(subst -,_,$(*F))_end:';           \
269         echo '.global __dtb_$(subst -,_,$(*F))_end';    \
270         echo '.balign STRUCT_ALIGNMENT';                \
271 } > $@
272
273 $(obj)/%.dtb.S: $(obj)/%.dtb FORCE
274         $(call if_changed,dt_S_dtb)
275
276 quiet_cmd_dtc = DTC     $@
277 cmd_dtc = mkdir -p $(dir ${dtc-tmp}) ; \
278         $(HOSTCC) -E $(dtc_cpp_flags) -x assembler-with-cpp -o $(dtc-tmp) $< ; \
279         $(DTC) -O $(2) -o $@ -b 0 \
280                 $(addprefix -i,$(dir $<) $(DTC_INCLUDE)) $(DTC_FLAGS) \
281                 -d $(depfile).dtc.tmp $(dtc-tmp) ; \
282         cat $(depfile).pre.tmp $(depfile).dtc.tmp > $(depfile)
283
284 $(obj)/%.dtb: $(src)/%.dts $(DTC) FORCE
285         $(call if_changed_dep,dtc,dtb)
286
287 DT_CHECKER ?= dt-validate
288 DT_BINDING_DIR := Documentation/devicetree/bindings
289 DT_TMP_SCHEMA := $(objtree)/$(DT_BINDING_DIR)/processed-schema.yaml
290
291 quiet_cmd_dtb_check =   CHECK   $@
292       cmd_dtb_check =   $(DT_CHECKER) -u $(srctree)/$(DT_BINDING_DIR) -p $(DT_TMP_SCHEMA) $@ ;
293
294 define rule_dtc
295         $(call cmd_and_fixdep,dtc,yaml)
296         $(call cmd,dtb_check)
297 endef
298
299 $(obj)/%.dt.yaml: $(src)/%.dts $(DTC) $(DT_TMP_SCHEMA) FORCE
300         $(call if_changed_rule,dtc,yaml)
301
302 dtc-tmp = $(subst $(comma),_,$(dot-target).dts.tmp)
303
304 # Bzip2
305 # ---------------------------------------------------------------------------
306
307 # Bzip2 and LZMA do not include size in file... so we have to fake that;
308 # append the size as a 32-bit littleendian number as gzip does.
309 size_append = printf $(shell                                            \
310 dec_size=0;                                                             \
311 for F in $(real-prereqs); do                                    \
312         fsize=$$($(CONFIG_SHELL) $(srctree)/scripts/file-size.sh $$F);  \
313         dec_size=$$(expr $$dec_size + $$fsize);                         \
314 done;                                                                   \
315 printf "%08x\n" $$dec_size |                                            \
316         sed 's/\(..\)/\1 /g' | {                                        \
317                 read ch0 ch1 ch2 ch3;                                   \
318                 for ch in $$ch3 $$ch2 $$ch1 $$ch0; do                   \
319                         printf '%s%03o' '\\' $$((0x$$ch));              \
320                 done;                                                   \
321         }                                                               \
322 )
323
324 quiet_cmd_bzip2 = BZIP2   $@
325       cmd_bzip2 = { cat $(real-prereqs) | bzip2 -9; $(size_append); } > $@
326
327 # Lzma
328 # ---------------------------------------------------------------------------
329
330 quiet_cmd_lzma = LZMA    $@
331       cmd_lzma = { cat $(real-prereqs) | lzma -9; $(size_append); } > $@
332
333 quiet_cmd_lzo = LZO     $@
334       cmd_lzo = { cat $(real-prereqs) | lzop -9; $(size_append); } > $@
335
336 quiet_cmd_lz4 = LZ4     $@
337       cmd_lz4 = { cat $(real-prereqs) | lz4c -l -c1 stdin stdout; \
338                   $(size_append); } > $@
339
340 # U-Boot mkimage
341 # ---------------------------------------------------------------------------
342
343 MKIMAGE := $(srctree)/scripts/mkuboot.sh
344
345 # SRCARCH just happens to match slightly more than ARCH (on sparc), so reduces
346 # the number of overrides in arch makefiles
347 UIMAGE_ARCH ?= $(SRCARCH)
348 UIMAGE_COMPRESSION ?= $(if $(2),$(2),none)
349 UIMAGE_OPTS-y ?=
350 UIMAGE_TYPE ?= kernel
351 UIMAGE_LOADADDR ?= arch_must_set_this
352 UIMAGE_ENTRYADDR ?= $(UIMAGE_LOADADDR)
353 UIMAGE_NAME ?= 'Linux-$(KERNELRELEASE)'
354
355 quiet_cmd_uimage = UIMAGE  $@
356       cmd_uimage = $(BASH) $(MKIMAGE) -A $(UIMAGE_ARCH) -O linux \
357                         -C $(UIMAGE_COMPRESSION) $(UIMAGE_OPTS-y) \
358                         -T $(UIMAGE_TYPE) \
359                         -a $(UIMAGE_LOADADDR) -e $(UIMAGE_ENTRYADDR) \
360                         -n $(UIMAGE_NAME) -d $< $@
361
362 # XZ
363 # ---------------------------------------------------------------------------
364 # Use xzkern to compress the kernel image and xzmisc to compress other things.
365 #
366 # xzkern uses a big LZMA2 dictionary since it doesn't increase memory usage
367 # of the kernel decompressor. A BCJ filter is used if it is available for
368 # the target architecture. xzkern also appends uncompressed size of the data
369 # using size_append. The .xz format has the size information available at
370 # the end of the file too, but it's in more complex format and it's good to
371 # avoid changing the part of the boot code that reads the uncompressed size.
372 # Note that the bytes added by size_append will make the xz tool think that
373 # the file is corrupt. This is expected.
374 #
375 # xzmisc doesn't use size_append, so it can be used to create normal .xz
376 # files. xzmisc uses smaller LZMA2 dictionary than xzkern, because a very
377 # big dictionary would increase the memory usage too much in the multi-call
378 # decompression mode. A BCJ filter isn't used either.
379 quiet_cmd_xzkern = XZKERN  $@
380       cmd_xzkern = { cat $(real-prereqs) | sh $(srctree)/scripts/xz_wrap.sh; \
381                      $(size_append); } > $@
382
383 quiet_cmd_xzmisc = XZMISC  $@
384       cmd_xzmisc = cat $(real-prereqs) | xz --check=crc32 --lzma2=dict=1MiB > $@
385
386 # ASM offsets
387 # ---------------------------------------------------------------------------
388
389 # Default sed regexp - multiline due to syntax constraints
390 #
391 # Use [:space:] because LLVM's integrated assembler inserts <tab> around
392 # the .ascii directive whereas GCC keeps the <space> as-is.
393 define sed-offsets
394         's:^[[:space:]]*\.ascii[[:space:]]*"\(.*\)".*:\1:; \
395         /^->/{s:->#\(.*\):/* \1 */:; \
396         s:^->\([^ ]*\) [\$$#]*\([^ ]*\) \(.*\):#define \1 \2 /* \3 */:; \
397         s:->::; p;}'
398 endef
399
400 # Use filechk to avoid rebuilds when a header changes, but the resulting file
401 # does not
402 define filechk_offsets
403          echo "#ifndef $2"; \
404          echo "#define $2"; \
405          echo "/*"; \
406          echo " * DO NOT MODIFY."; \
407          echo " *"; \
408          echo " * This file was generated by Kbuild"; \
409          echo " */"; \
410          echo ""; \
411          sed -ne $(sed-offsets) < $<; \
412          echo ""; \
413          echo "#endif"
414 endef