util/abuild: Only update submodules once
[coreboot.git] / Makefile.inc
blob7f61a5e4ad3cc544babb6307c25374191b956757
1 # SPDX-License-Identifier: GPL-2.0-only
3 ifneq ($(NOCOMPILE),1)
4 GIT:=$(shell git -C "$(top)" rev-parse --git-dir 1>/dev/null 2>&1 \
5         && command -v git)
6 else
7 GIT:=
8 endif
10 #######################################################################
11 # normalize Kconfig variables in a central place
12 CONFIG_CBFS_PREFIX:=$(call strip_quotes,$(CONFIG_CBFS_PREFIX))
13 CONFIG_FMDFILE:=$(call strip_quotes,$(CONFIG_FMDFILE))
14 CONFIG_DEVICETREE:=$(call strip_quotes, $(CONFIG_DEVICETREE))
15 CONFIG_OVERRIDE_DEVICETREE:=$(call strip_quotes, $(CONFIG_OVERRIDE_DEVICETREE))
16 CONFIG_MEMLAYOUT_LD_FILE:=$(call strip_quotes, $(CONFIG_MEMLAYOUT_LD_FILE))
18 #######################################################################
19 # misleadingly named, this is the coreboot version
20 ifeq ($(KERNELVERSION),)
21 ifeq ($(BUILD_TIMELESS),1)
22 KERNELVERSION := -TIMELESS--LESSTIME-
23 else
24 KERNELVERSION := $(strip $(if $(GIT),\
25         $(shell git describe --dirty --always || git describe),\
26         $(if $(wildcard $(top)/.coreboot-version),\
27                 $(shell cat $(top)/.coreboot-version),\
28                 coreboot-unknown$(KERNELREVISION))))
29 endif
30 endif
31 COREBOOT_EXPORTS += KERNELVERSION
33 #######################################################################
34 # Basic component discovery
35 MAINBOARDDIR=$(call strip_quotes,$(CONFIG_MAINBOARD_DIR))
36 VARIANT_DIR:=$(call strip_quotes,$(CONFIG_VARIANT_DIR))
37 COREBOOT_EXPORTS += MAINBOARDDIR VARIANT_DIR
39 ## Final build results, which CBFSTOOL uses to create the final
40 ## rom image file, are placed under $(objcbfs).
41 ## These typically have suffixes .debug .elf .bin and .map
42 objcbfs := $(obj)/cbfs/$(CONFIG_CBFS_PREFIX)
43 COREBOOT_EXPORTS += objcbfs
45 ## Based on the active configuration, Makefile conditionally collects
46 ## the required assembly includes and saves them in a file.
47 ## Such files that do not have a clear one-to-one relation to a source
48 ## file under src/ are placed and built under $(objgenerated)
49 objgenerated := $(obj)/generated
50 COREBOOT_EXPORTS += objgenerated
52 ## CCACHE_EXTRAFILES can be set by individual rules to help CCACHE
53 ## discover dependencies it might not notice on its own (e.g. asm (".incbin")).
54 COREBOOT_EXPORTS += CCACHE_EXTRAFILES
56 #######################################################################
57 # root rule to resolve if in build mode (ie. configuration exists)
58 real-target: $(obj)/config.h coreboot files_added
59 coreboot: build-dirs $(obj)/coreboot.rom $(obj)/cbfstool $(obj)/rmodtool $(obj)/ifwitool
61 # This target can be used in site local to run scripts or additional
62 # targets after the build completes by creating a Makefile.inc in the
63 # site-local directory with a target named 'build_complete::'
64 build_complete:: coreboot
65         printf "\nBuilt %s (%s)\n" $(MAINBOARDDIR) \
66                 $(CONFIG_MAINBOARD_PART_NUMBER)
68 # This target can be used to run rules after all files were added to CBFS,
69 # for example to process FMAP regions or the entire image.
70 files_added:: build_complete
72 #######################################################################
73 # our phony targets
74 PHONY+= clean-abuild coreboot check-style build-dirs build_complete
76 #######################################################################
77 # root source directories of coreboot
78 subdirs-y := src/lib src/commonlib/ src/console src/device src/acpi
79 subdirs-y += src/ec/acpi $(wildcard src/ec/*/*) $(wildcard src/southbridge/*/*)
80 subdirs-y += $(wildcard src/soc/*/*) $(wildcard src/northbridge/*/*)
81 subdirs-y += src/superio
82 subdirs-y += $(wildcard src/drivers/*) $(wildcard src/drivers/*/*)
83 subdirs-y += src/cpu src/vendorcode
84 subdirs-y += util/cbfstool util/sconfig util/nvramtool util/pgtblgen
85 subdirs-y += util/futility util/marvell util/bincfg util/supermicro
86 subdirs-y += $(wildcard src/arch/*)
87 subdirs-y += src/mainboard/$(MAINBOARDDIR)
88 subdirs-y += src/security
89 subdirs-y += payloads payloads/external
91 subdirs-y += site-local
92 subdirs-y += util/checklist util/testing
94 #######################################################################
95 # Add source classes and their build options
96 classes-y := ramstage romstage bootblock decompressor postcar smm smmstub cpu_microcode verstage
98 # Add a special 'all' class to add sources to all stages
99 $(call add-special-class,all)
100 all-handler = $(foreach class,bootblock verstage romstage postcar ramstage,$(eval $(class)-y += $(2)))
102 $(call add-special-class,verstage_x86)
103 ifeq ($(CONFIG_ARCH_VERSTAGE_X86_32)$(CONFIG_ARCH_VERSTAGE_X86_64),y)
104 verstage_x86-handler = $(eval verstage-y += $(2))
105 else
106 verstage_x86-handler =
107 endif
109 # Add dynamic classes for rmodules
110 $(foreach supported_arch,$(ARCH_SUPPORTED), \
111             $(eval $(call define_class,rmodules_$(supported_arch),$(supported_arch))))
112 # Provide a macro to determine environment for free standing rmodules.
113 $(foreach supported_arch,$(ARCH_SUPPORTED), \
114         $(eval rmodules_$(supported_arch)-generic-ccopts += -D__RMODULE__))
116 #######################################################################
117 # Helper functions for math, strings, and various file placement matters.
118 # macros work on all formats understood by printf(1)
119 # values are space separated if using more than one value
121 # int-add:        adds an arbitrary length list of integers
122 # int-subtract:   subtracts the second of two integers from the first
123 # int-multiply:   multiplies an arbitrary length list of integers
124 # int-divide:     divides the first integer by the second
125 # int-remainder:  arithmetic remainder of the first number divided by the second
126 # int-shift-left: Shift $1 left by $2 bits
127 # int-lt:         1 if the first value is less than the second.  0 otherwise
128 # int-gt:         1 if the first values is greater than the second.  0 otherwise
129 # int-eq:         1 if the two values are equal.  0 otherwise
130 # int-align:      align $1 to $2 units
131 # file-size:      returns the filesize of the given file
132 # tolower:        returns the value in all lowercase
133 # toupper:        returns the value in all uppercase
134 # ws_to_under:    returns the value with any whitespace changed to underscores
135 _toint=$(shell printf "%d" $1)
136 _int-add2=$(shell expr $(call _toint,$1) + $(call _toint,$2))
137 int-add=$(if $(filter 1,$(words $1)),$(strip $1),$(call int-add,$(call _int-add2,$(word 1,$1),$(word 2,$1)) $(wordlist 3,$(words $1),$1)))
138 int-subtract=$(if $(filter 1,$(words $1)),$(strip $1),$(shell expr $(call _toint,$(word 1,$1)) - $(call _toint,$(word 2,$1))))
139 _int-multiply2=$(shell expr $(call _toint,$1) \* $(call _toint,$2))
140 int-multiply=$(if $(filter 1,$(words $1)),$(strip $1),$(call int-multiply,$(call _int-multiply2,$(word 1,$1),$(word 2,$1)) $(wordlist 3,$(words $1),$1)))
141 int-divide=$(if $(filter 1,$(words $1)),$(strip $1),$(shell expr $(call _toint,$(word 1,$1)) / $(call _toint,$(word 2,$1))))
142 int-remainder=$(if $(filter 1,$(words $1)),$(strip $1),$(shell expr $(call _toint,$(word 1,$1)) % $(call _toint,$(word 2,$1))))
143 int-shift-left=$(shell echo "$(call _toint,$(word 1, $1)) * (2 ^ $(call _toint,$(word 2, $1)))" | bc)
144 int-lt=$(if $(filter 1,$(words $1)),$(strip $1),$(shell expr $(call _toint,$(word 1,$1)) \< $(call _toint,$(word 2,$1))))
145 int-gt=$(if $(filter 1,$(words $1)),$(strip $1),$(shell expr $(call _toint,$(word 1,$1)) \> $(call _toint,$(word 2,$1))))
146 int-eq=$(if $(filter 1,$(words $1)),$(strip $1),$(shell expr $(call _toint,$(word 1,$1)) = $(call _toint,$(word 2,$1))))
147 int-align=$(shell A=$(call _toint,$1) B=$(call _toint,$2); expr $$A + \( \( $$B - \( $$A % $$B \) \) % $$B \) )
148 int-align-down=$(shell A=$(call _toint,$1) B=$(call _toint,$2); expr $$A - \( $$A % $$B \) )
149 file-size=$(strip $(shell cat $1 | wc -c))
150 tolower=$(shell echo '$1' | tr '[:upper:]' '[:lower:]')
151 toupper=$(shell echo '$1' | tr '[:lower:]' '[:upper:]')
152 ws_to_under=$(shell echo '$1' | tr ' \t' '_')
154 #######################################################################
155 # Helper functions for ramstage postprocess
156 spc :=
157 spc := $(spc) $(spc)
158 comma := ,
160 # Returns all files and dirs below `dir` (recursively).
161 # files-below-dir,dir,files
162 files-below-dir=$(filter $(1)%,$(2))
164 # Returns all dirs below `dir` (recursively).
165 # dirs-below-dir,dir,files
166 dirs-below-dir=$(filter-out $(1),$(sort $(dir $(call files-below-dir,$(1),$(2)))))
168 # Returns all files directly in `dir` (non-recursively).
169 # files-in-dir,dir,files
170 files-in-dir=$(filter-out $(addsuffix %,$(call dirs-below-dir,$(1),$(2))),$(call files-below-dir,$(1),$(2)))
172 #######################################################################
173 # reduce command line length by linking the objects of each
174 # directory into an intermediate file
175 ramstage-postprocess=$$(eval DEPENDENCIES+=$$(addsuffix .d,$$(basename $(1)))) \
176         $(foreach d,$(sort $(dir $(filter-out %.ld,$(1)))), \
177         $(eval $(d)ramstage.a: $(call files-in-dir,$(d),$(filter-out %.ld,$(1))); rm -f $$@ && $(AR_ramstage) rcsT $$@ $$^ ) \
178         $(eval ramstage-objs:=$(d)ramstage.a $(filter-out $(filter-out %.ld, $(call files-in-dir,$(d),$(1))),$(ramstage-objs))))
180 decompressor-generic-ccopts += -D__DECOMPRESSOR__
181 bootblock-generic-ccopts += -D__BOOTBLOCK__
182 romstage-generic-ccopts += -D__ROMSTAGE__
183 ramstage-generic-ccopts += -D__RAMSTAGE__
184 ifeq ($(CONFIG_TRACE),y)
185 ramstage-c-ccopts += -finstrument-functions
186 endif
187 ifeq ($(CONFIG_COVERAGE),y)
188 ramstage-c-ccopts += -fprofile-arcs -ftest-coverage
189 endif
191 ifneq ($(UPDATED_SUBMODULES),1)
192 # try to fetch non-optional submodules if the source is under git
193 forgetthis:=$(if $(GIT),$(shell git submodule update --init))
194 ifeq ($(CONFIG_USE_BLOBS),y)
195 # These items are necessary because each has update=none in .gitmodules.  They are ignored
196 # until expressly requested and enabled with --checkout
197 forgetthis:=$(if $(GIT),$(shell git submodule update --init --checkout 3rdparty/blobs))
198 forgetthis:=$(if $(GIT),$(shell git submodule update --init --checkout 3rdparty/intel-microcode))
199 ifeq ($(CONFIG_PLATFORM_USES_FSP1_0)$(CONFIG_PLATFORM_USES_FSP1_1)$(CONFIG_PLATFORM_USES_FSP2_0),y)
200 forgetthis:=$(if $(GIT),$(shell git submodule update --init --checkout 3rdparty/fsp))
201 endif
202 ifeq ($(CONFIG_USE_AMD_BLOBS),y)
203 forgetthis:=$(if $(GIT),$(shell git submodule update --init --checkout 3rdparty/amd_blobs))
204 endif
205 endif
206 UPDATED_SUBMODULES:=1
207 COREBOOT_EXPORTS += UPDATED_SUBMODULES
208 endif
210 postcar-c-deps:=$$(OPTION_TABLE_H)
211 ramstage-c-deps:=$$(OPTION_TABLE_H)
212 romstage-c-deps:=$$(OPTION_TABLE_H)
213 verstage-c-deps:=$$(OPTION_TABLE_H)
214 bootblock-c-deps:=$$(OPTION_TABLE_H)
215 $(foreach type,ads adb, \
216   $(foreach stage,$(COREBOOT_STANDARD_STAGES), \
217     $(eval $(stage)-$(type)-deps := \
218         $(obj)/$(stage)/$(notdir $(KCONFIG_AUTOADS)) \
219         $(obj)/libgnat-$(ARCH-$(stage)-y)/libgnat.a)))
221 # Add handler to copy linker scripts
222 define generic-objs_ld_template_gen
223 de$(EMPTY)fine $(1)-objs_ld_template
224 $$(call src-to-obj,$1,$$(1).ld): $$(1).ld $(obj)/config.h $(obj)/fmap_config.h
225         @printf "    CP         $$$$(subst $$$$(obj)/,,$$$$(@))\n"
226         $$(CC_$(1)) -MMD $$(CPPFLAGS_$(1)) $$($(1)-ld-ccopts) $(PREPROCESS_ONLY) -include $(obj)/config.h -MT $$$$@ -o $$$$@ $$$$<
227 en$(EMPTY)def
228 endef
230 # Add handler to deal with archives
231 define generic-objs_a_template_gen
232 de$(EMPTY)fine $(1)-objs_a_template
233 $$(call src-to-obj,$1,$$(1).a): $$(1).a
234         @printf "    AR         $$$$(subst $$$$(obj)/,,$$$$(@))\n"
235         $$$$(AR_$(1)) rcsT $$$$@.tmp $$$$<
236         mv $$$$@.tmp $$$$@
237 en$(EMPTY)def
238 endef
240 # Add handler to add no rules for manual files
241 define generic-objs_manual_template_gen
242 # do nothing
243 endef
245 #######################################################################
246 # Add handler to compile ACPI's ASL
247 # arg1: base file name
248 # arg2: y or n for including in cbfs. defaults to y
250 # Empty resource templates were marked as a warning in IASL with the comment
251 # "This would appear to be worthless in real-world ASL code.", which is
252 # possibly true in many cases.  In other cases it seems that an empty
253 # ResourceTemplate is the correct code.
254 # As it's valid ASL, disable the warning.
255 EMPTY_RESOURCE_TEMPLATE_WARNING = 3150
256 # Redundant offset remarks are not useful in any way and are masking useful
257 # ones that might indicate an issue so it is better to hide them.
258 REDUNDANT_OFFSET_REMARK = 2158
259 # Ignore _HID & _ADR coexisting in Intel Lynxpoint and Broadwell ASL code.
260 # See cb:38803 & cb:38802
261 # "Multiple types (Device object requires either a _HID or _ADR, but not both)"
262 MULTIPLE_TYPES_WARNING = 3073
264 ifeq ($(CONFIG_SOUTHBRIDGE_INTEL_LYNXPOINT)$(CONFIG_SOC_INTEL_BROADWELL),y)
265 IGNORED_IASL_WARNINGS = -vw $(EMPTY_RESOURCE_TEMPLATE_WARNING) -vw $(REDUNDANT_OFFSET_REMARK) -vw $(MULTIPLE_TYPES_WARNING)
266 else
267 IGNORED_IASL_WARNINGS = -vw $(EMPTY_RESOURCE_TEMPLATE_WARNING) -vw $(REDUNDANT_OFFSET_REMARK)
268 endif
270 define asl_template
271 $(CONFIG_CBFS_PREFIX)/$(1).aml-file = $(obj)/$(1).aml
272 $(CONFIG_CBFS_PREFIX)/$(1).aml-type = raw
273 $(CONFIG_CBFS_PREFIX)/$(1).aml-compression = none
274 cbfs-files-$(if $(2),$(2),y) += $(CONFIG_CBFS_PREFIX)/$(1).aml
275 -include $(obj)/$(1).d
276 $(obj)/$(1).aml: $(src)/mainboard/$(MAINBOARDDIR)/$(1).asl $(obj)/config.h
277         @printf "    IASL       $$(subst $(top)/,,$$(@))\n"
278         $(CC_ramstage) -x assembler-with-cpp -E -MMD -MT $$(@) $$(CPPFLAGS_ramstage) -D__ACPI__ -P -include $(src)/include/kconfig.h -I$(obj) -I$(src) -I$(src)/include -I$(src)/arch/$(ARCHDIR-$(ARCH-ramstage-y))/include -I$(src)/mainboard/$(MAINBOARDDIR) $$< -o $(obj)/$(1).asl
279         cd $$(dir $$@); $(IASL) $(IGNORED_IASL_WARNINGS) -we -p $$(notdir $$@) $(1).asl
280         if ! $(IASL) -d $$@ 2>&1 | grep -Eq 'ACPI (Warning|Error)'; then        \
281                 echo "    IASL       $$@ disassembled correctly.";              \
282                 true;                                                           \
283         else                                                                    \
284                 echo "Error: Could not correctly disassemble $$@";              \
285                 $(IASL) -d $$@;                                                 \
286                 false;                                                          \
287         fi
288 endef
290 #######################################################################
291 # Parse plaintext CMOS defaults into binary format
292 # arg1: source file
293 # arg2: binary file name
294 cbfs-files-processor-nvramtool= \
295         $(eval $(2): $(1) $(src)/mainboard/$(MAINBOARDDIR)/cmos.layout | $(objutil)/nvramtool/nvramtool ; \
296                 printf "    CREATE     $(2) (from $(1))\n"; \
297                 $(objutil)/nvramtool/nvramtool -y $(src)/mainboard/$(MAINBOARDDIR)/cmos.layout -D $(2).tmp -p $(1) && \
298                 mv $(2).tmp $(2))
300 #######################################################################
301 # Link VSA binary to ELF-ish stage
302 # arg1: source file
303 # arg2: binary file name
304 cbfs-files-processor-vsa= \
305         $(eval $(2): $(1) ; \
306                 printf "    CREATE     $(2) (from $(1))\n"; \
307                 $(OBJCOPY_ramstage) --set-start 0x20 --adjust-vma 0x60000 -I binary -O elf32-i386 -B i386 $(1) $(2).tmp && \
308                 $(LD_ramstage) -m elf_i386 -e 0x60020 --section-start .data=0x60000 $(2).tmp -o $(2))
310 #######################################################################
311 # Reduce a .config file to its minimal representation
312 # arg1: input
313 # arg2: output
314 define cbfs-files-processor-defconfig
315         $(eval $(2): $(1) $(obj)/build.h $(objutil)/kconfig/conf; \
316                 +printf "    CREATE     $(2) (from $(1))\n"; \
317                 printf "# This image was built using coreboot " > $(2).tmp && \
318                 grep "\<COREBOOT_VERSION\>" $(obj)/build.h |cut -d\" -f2 >> $(2).tmp && \
319                 $(MAKE) DOTCONFIG=$(1) DEFCONFIG=$(2).tmp2 savedefconfig && \
320                 cat $(2).tmp2 >> $(2).tmp && \
321                 rm -f $(2).tmp2 && \
322                 \mv -f $(2).tmp $(2))
323 endef
325 #######################################################################
326 # Compile a C file with a bare struct definition into binary
327 # arg1: C source file
328 # arg2: binary file
329 cbfs-files-processor-struct= \
330         $(eval $(2): $(1) $(obj)/build.h $(KCONFIG_AUTOHEADER); \
331                 printf "    CC+STRIP   $(@)\n"; \
332                 $(CC_ramstage) -MMD $(CPPFLAGS_ramstage) $(CFLAGS_ramstage) $$(ramstage-c-ccopts) -include $(KCONFIG_AUTOHEADER) -MT $(2) -o $(2).tmp -c $(1) && \
333                 $(OBJCOPY_ramstage) -O binary $(2).tmp $(2); \
334                 rm -f $(2).tmp) \
335         $(eval DEPENDENCIES += $(2).d)
337 #######################################################################
338 # Add handler for arbitrary files in CBFS
339 $(call add-special-class,cbfs-files)
340 cbfs-files-handler= \
341                 $(eval tmp-cbfs-method:=$(word 2, $(subst :, ,$($(2)-file)))) \
342                 $(eval $(2)-file:=$(call strip_quotes,$(word 1, $(subst :, ,$($(2)-file))))) \
343                 $(eval tmp-cbfs-file:= ) \
344                 $(if $($(2)-file), \
345                         $(if $(wildcard $(1)$($(2)-file)), \
346                                 $(eval tmp-cbfs-file:= $(wildcard $(1)$($(2)-file))), \
347                                 $(eval tmp-cbfs-file:= $($(2)-file)))) \
348                 $(if $(strip $($(2)-required)), \
349                         $(if $(wildcard $(tmp-cbfs-file)),, \
350                                 $(info This build configuration requires $($(2)-required)) \
351                                 $(eval FAILBUILD:=1) \
352                         )) \
353                 $(if $(strip $($(2)-align)), \
354                         $(if $(strip $($(2)-position)), \
355                                 $(info ERROR: It is not allowed to specify both alignment and position for $($(2)-file)) \
356                                 $(eval FAILBUILD:=1) \
357                         )) \
358                 $(if $(tmp-cbfs-method), \
359                         $(eval tmp-old-cbfs-file:=$(tmp-cbfs-file)) \
360                         $(eval tmp-cbfs-file:=$(shell mkdir -p $(obj)/mainboard/$(MAINBOARDDIR); mktemp $(obj)/mainboard/$(MAINBOARDDIR)/cbfs-file.XXXXXX).out) \
361                         $(call cbfs-files-processor-$(tmp-cbfs-method),$(tmp-old-cbfs-file),$(tmp-cbfs-file))) \
362                 $(if $(tmp-cbfs-file), \
363                         $(eval cbfs-files += $(subst $(spc),*,$(tmp-cbfs-file)|$(2)|$($(2)-type)|$($(2)-compression)|$(strip $($(2)-position))|$($(2)-align)|$($(2)-options)))) \
364                 $(eval $(2)-name:=) \
365                 $(eval $(2)-type:=) \
366                 $(eval $(2)-compression:=) \
367                 $(eval $(2)-position:=) \
368                 $(eval $(2)-required:=) \
369                 $(eval $(2)-options:=) \
370                 $(eval $(2)-align:=)
372 #######################################################################
373 # a variety of flags for our build
374 CBFS_COMPRESS_FLAG:=none
375 ifeq ($(CONFIG_COMPRESS_RAMSTAGE),y)
376 CBFS_COMPRESS_FLAG:=LZMA
377 endif
379 CBFS_PAYLOAD_COMPRESS_FLAG:=none
380 ifeq ($(CONFIG_COMPRESSED_PAYLOAD_LZMA),y)
381 CBFS_PAYLOAD_COMPRESS_FLAG:=LZMA
382 endif
383 ifeq ($(CONFIG_COMPRESSED_PAYLOAD_LZ4),y)
384 CBFS_PAYLOAD_COMPRESS_FLAG:=LZ4
385 endif
387 CBFS_SECONDARY_PAYLOAD_COMPRESS_FLAG:=none
388 ifeq ($(CONFIG_COMPRESS_SECONDARY_PAYLOAD),y)
389 CBFS_SECONDARY_PAYLOAD_COMPRESS_FLAG:=LZMA
390 endif
392 CBFS_PRERAM_COMPRESS_FLAG:=none
393 ifeq ($(CONFIG_COMPRESS_PRERAM_STAGES),y)
394 CBFS_PRERAM_COMPRESS_FLAG:=LZ4
395 endif
397 ifneq ($(CONFIG_LOCALVERSION),"")
398 COREBOOT_EXTRA_VERSION := -$(call strip_quotes,$(CONFIG_LOCALVERSION))
399 COREBOOT_EXPORTS += COREBOOT_EXTRA_VERSION
400 endif
402 CPPFLAGS_common := -Isrc -Isrc/include -Isrc/commonlib/include -Isrc/commonlib/bsd/include -I$(obj)
403 VBOOT_SOURCE ?= 3rdparty/vboot
404 CPPFLAGS_common += -I$(VBOOT_SOURCE)/firmware/include
405 CPPFLAGS_common += -include $(src)/include/kconfig.h
406 CPPFLAGS_common += -include $(src)/include/rules.h
407 CPPFLAGS_common += -include $(src)/commonlib/bsd/include/commonlib/bsd/compiler.h
408 CPPFLAGS_common += -I3rdparty
409 CPPFLAGS_common += -D__BUILD_DIR__=\"$(obj)\"
411 ifeq ($(CONFIG_PCI_OPTION_ROM_RUN_YABEL)$(CONFIG_PCI_OPTION_ROM_RUN_REALMODE),y)
412 CPPFLAGS_ramstage += -Isrc/device/oprom/include
413 endif
415 CFLAGS_common += -pipe -g -nostdinc -std=gnu11
416 CFLAGS_common += -nostdlib -Wall -Wundef -Wstrict-prototypes -Wmissing-prototypes
417 CFLAGS_common += -Wwrite-strings -Wredundant-decls -Wno-trigraphs -Wimplicit-fallthrough
418 CFLAGS_common += -Wstrict-aliasing -Wshadow -Wdate-time -Wtype-limits -Wvla
419 CFLAGS_common += -Wlogical-op -Wduplicated-cond -Wdangling-else
420 CFLAGS_common += -fno-common -ffreestanding -fno-builtin -fomit-frame-pointer
421 CFLAGS_common += -ffunction-sections -fdata-sections -fno-pie
422 ifeq ($(CONFIG_COMPILER_GCC),y)
423 # Don't add these GCC specific flags when running scan-build
424 ifeq ($(CCC_ANALYZER_OUTPUT_FORMAT),)
425 CFLAGS_common += -Wno-packed-not-aligned
426 CFLAGS_common += -fconserve-stack
427 CFLAGS_common += -Wnull-dereference -Wreturn-type
428 # cf. commit f69a99db (coreboot: x86: enable gc-sections)
429 CFLAGS_common += -Wno-unused-but-set-variable
430 endif
431 endif
433 ADAFLAGS_common += -gnatp
434 ADAFLAGS_common += -Wuninitialized -Wall -Werror
435 ADAFLAGS_common += -pipe -g -nostdinc
436 ADAFLAGS_common += -Wstrict-aliasing -Wshadow
437 ADAFLAGS_common += -fno-common -fomit-frame-pointer
438 ADAFLAGS_common += -ffunction-sections -fdata-sections
439 # Ada warning options:
441 #  a   Activate most optional warnings.
442 # .e   Activate every optional warnings.
443 #  e   Treat warnings and style checks as errors.
445 #  D   Suppress warnings on implicit dereferences:
446 #      As SPARK does not accept access types we have to map the
447 #      dynamically chosen register locations to a static SPARK
448 #      variable.
450 # .H   Suppress warnings on holes/gaps in records:
451 #      We are modelling hardware here!
453 #  H   Suppress warnings on hiding:
454 #      It's too annoying, you run out of ideas for identifiers fast.
456 #  T   Suppress warnings for tracking of deleted conditional code:
457 #      We use static options to select code paths at compile time.
459 #  U   Suppress warnings on unused entities:
460 #      Would have lots of warnings for unused register definitions,
461 #      `withs` for debugging etc.
463 # .U   Deactivate warnings on unordered enumeration types:
464 #      As SPARK doesn't support `pragma Ordered` by now, we don't
465 #      use that, yet.
467 # .W   Suppress warnings on unnecessary Warnings Off pragmas:
468 #      Things get really messy when you use different compiler
469 #      versions, otherwise.
470 # .Y   Disable information messages for why package spec needs body:
471 #      Those messages are annoying. But don't forget to enable those,
472 #      if you need the information.
473 ADAFLAGS_common += -gnatwa.eeD.HHTU.U.W.Y
474 # Disable style checks for now
475 ADAFLAGS_common += -gnatyN
477 LDFLAGS_common := --gc-sections -nostdlib -nostartfiles -static --emit-relocs
479 ifeq ($(CONFIG_WARNINGS_ARE_ERRORS),y)
480 CFLAGS_common += -Werror
481 endif
482 ifneq ($(GDB_DEBUG),)
483 CFLAGS_common += -Og
484 ADAFLAGS_common += -Og
485 else
486 CFLAGS_common += -Os
487 ADAFLAGS_common += -Os
488 endif
490 ifeq ($(CONFIG_DEBUG_ADA_CODE),y)
491 ADAFLAGS_common += -gnata
492 endif
494 additional-dirs := $(objutil)/cbfstool $(objutil)/ifdtool \
495                    $(objutil)/options $(objutil)/amdfwtool \
496                    $(objutil)/cbootimage
498 export $(COREBOOT_EXPORTS)
500 #######################################################################
501 # generate build support files
503 build_h := $(obj)/build.h
505 # We have to manually export variables that `genbuild_h.sh` uses
506 # when we call it through the `$(shell)` function. This is fragile
507 # but as variables newly added to `genbuild_h.sh` would just not
508 # work, we'd notice that instantly at least.
509 build_h_exports := BUILD_TIMELESS KERNELVERSION COREBOOT_EXTRA_VERSION
511 # Report new `build.ht` as dependency if `build.h` differs.
512 build_h_check := \
513         export $(foreach exp,$(build_h_exports),$(exp)="$($(exp))"); \
514         util/genbuild_h/genbuild_h.sh .xcompile >$(build_h)t 2>/dev/null; \
515         cmp -s $(build_h)t $(build_h) >/dev/null 2>&1 || echo $(build_h)t
517 $(build_h): $$(shell $$(build_h_check))
518         @printf "    GEN        build.h\n"
519         mv $< $@
521 build-dirs $(objcbfs) $(objgenerated):
522         mkdir -p $(objcbfs) $(objgenerated)
524 #######################################################################
525 # Build the tools
526 CBFSTOOL:=$(objutil)/cbfstool/cbfstool
527 FMAPTOOL:=$(objutil)/cbfstool/fmaptool
528 RMODTOOL:=$(objutil)/cbfstool/rmodtool
529 IFWITOOL:=$(objutil)/cbfstool/ifwitool
530 IFITTOOL:=$(objutil)/cbfstool/ifittool
531 AMDCOMPRESS:=$(objutil)/cbfstool/amdcompress
533 $(obj)/cbfstool: $(CBFSTOOL)
534         cp $< $@
536 $(obj)/fmaptool: $(FMAPTOOL)
537         cp $< $@
539 $(obj)/rmodtool: $(RMODTOOL)
540         cp $< $@
542 $(obj)/ifwitool: $(IFWITOOL)
543         cp $< $@
545 $(obj)/ifittool: $(IFITTOOL)
546         cp $< $@
548 $(obj)/amdcompress: $(AMDCOMPRESS)
549         cp $< $@
551 _WINCHECK=$(shell uname -o 2> /dev/null)
552 STACK=
553 ifeq ($(_WINCHECK),Msys)
554         STACK=-Wl,--stack,16384000
555 endif
556 ifeq ($(_WINCHECK),Cygwin)
557         STACK=-Wl,--stack,16384000
558 endif
560 BINCFG:=$(objutil)/bincfg/bincfg
562 IFDTOOL:=$(objutil)/ifdtool/ifdtool
563 $(IFDTOOL):
564         @printf "    Compile IFDTOOL\n"
565         +$(MAKE) -C $(top)/util/ifdtool
566         cp -a $(top)/util/ifdtool/ifdtool $@
568 AMDFWTOOL:=$(objutil)/amdfwtool/amdfwtool
569 $(AMDFWTOOL): $(top)/util/amdfwtool/amdfwtool.c
570         @printf "    HOSTCC     $(subst $(obj)/,,$(@))\n"
571         $(HOSTCC) $(HOSTCFLAGS) -DCONFIG_ROM_SIZE=$(CONFIG_ROM_SIZE) -o $@ $<
573 APCB_EDIT_TOOL:=$(top)/util/apcb/apcb_edit.py
575 CBOOTIMAGE:=$(objutil)/cbootimage/cbootimage
577 FUTILITY?=$(objutil)/futility/futility
579 subdirs-y += util/nvidia
581 $(obj)/config.h: $(objutil)/kconfig/conf
583 #######################################################################
584 # needed objects that every mainboard uses
585 # Creation of these is architecture and mainboard independent
586 DEVICETREE_FILE := $(src)/mainboard/$(MAINBOARDDIR)/$(CONFIG_DEVICETREE)
588 ifneq ($(CONFIG_OVERRIDE_DEVICETREE),)
590 OVERRIDE_DEVICETREE_FILE := $(src)/mainboard/$(MAINBOARDDIR)/$(CONFIG_OVERRIDE_DEVICETREE)
592 endif
594 DEVICETREE_STATIC_C := $(obj)/mainboard/$(MAINBOARDDIR)/static.c
595 DEVICETREE_STATIC_H := $(obj)/static.h
597 $(DEVICETREE_STATIC_C): $(DEVICETREE_FILE) $(OVERRIDE_DEVICETREE_FILE) $(objutil)/sconfig/sconfig
598         @printf "    SCONFIG    $(subst $(src)/,,$(<))\n"
599         mkdir -p $(dir $(DEVICETREE_STATIC_C))
600         $(objutil)/sconfig/sconfig $(DEVICETREE_FILE) $(DEVICETREE_STATIC_C) $(DEVICETREE_STATIC_H) $(OVERRIDE_DEVICETREE_FILE)
602 ramstage-y+=$(DEVICETREE_STATIC_C)
603 romstage-y+=$(DEVICETREE_STATIC_C)
604 verstage-y+=$(DEVICETREE_STATIC_C)
605 bootblock-y+=$(DEVICETREE_STATIC_C)
606 postcar-y+=$(DEVICETREE_STATIC_C)
607 smm-y+=$(DEVICETREE_STATIC_C)
609 # Ensure static.c and static.h are created before any objects are compiled
610 ramstage-c-deps+=$(DEVICETREE_STATIC_C)
611 romstage-c-deps+=$(DEVICETREE_STATIC_C)
612 verstage-c-deps+=$(DEVICETREE_STATIC_C)
613 bootblock-c-deps+=$(DEVICETREE_STATIC_C)
614 postcar-c-deps+=$(DEVICETREE_STATIC_C)
615 smm-c-deps+=$(DEVICETREE_STATIC_C)
617 .PHONY: devicetree
618 devicetree: $(DEVICETREE_STATIC_C)
620 ramstage-y += $(CONFIG_MEMLAYOUT_LD_FILE)
621 romstage-y += $(CONFIG_MEMLAYOUT_LD_FILE)
622 bootblock-y += $(CONFIG_MEMLAYOUT_LD_FILE)
623 verstage-y += $(CONFIG_MEMLAYOUT_LD_FILE)
624 postcar-y += $(CONFIG_MEMLAYOUT_LD_FILE)
625 decompressor-y += $(CONFIG_MEMLAYOUT_LD_FILE)
627 #######################################################################
628 # Clean up rules
629 clean-abuild:
630         rm -rf coreboot-builds
632 clean-for-update-target: clean-payloads
633         rm -f $(obj)/ramstage?* $(obj)/coreboot.romstage $(obj)/coreboot.pre* $(obj)/coreboot.bootblock $(obj)/coreboot.a
634         rm -rf $(obj)/bootblock?* $(obj)/romstage?* $(obj)/location.*
635         rm -f $(obj)/option_table.* $(obj)/crt0.S $(obj)/ldscript
636         rm -f $(obj)/mainboard/$(MAINBOARDDIR)/static.c $(obj)/mainboard/$(MAINBOARDDIR)/config.py $(obj)/mainboard/$(MAINBOARDDIR)/static.dot
637         rm -f $(obj)/mainboard/$(MAINBOARDDIR)/crt0.s $(obj)/mainboard/$(MAINBOARDDIR)/crt0.disasm
638         rm -f $(obj)/mainboard/$(MAINBOARDDIR)/romstage.inc
639         rm -f $(obj)/mainboard/$(MAINBOARDDIR)/bootblock.* $(obj)/dsdt.*
640         rm -f $(obj)/cpu/x86/smm/smm_bin.c $(obj)/cpu/x86/smm/smm.* $(obj)/cpu/x86/smm/smm
642 clean-target:
643         rm -f $(obj)/coreboot*
645 #######################################################################
646 # Development utilities
647 printcrt0s:
648         @echo crt0s=$(crt0s)
649         @echo ldscripts=$(ldscripts)
651 update:
652         dongle.py -c /dev/term/1 $(obj)/coreboot.rom EOF
654 check-style:
655         grep "^# DESCR:" util/lint/check-style | sed "s,.*DESCR: *,,"
656         echo "========"
657         util/lint/check-style
658         echo "========"
660 gitconfig:
661         util/gitconfig/gitconfig.sh "$(MAKE)"
663 install-git-commit-clangfmt:
664         cp util/scripts/prepare-commit-msg.clang-format .git/hooks/prepare-commit-msg
666 include util/crossgcc/Makefile.inc
668 .PHONY: tools
669 tools: $(objutil)/kconfig/conf $(objutil)/kconfig/toada $(CBFSTOOL) $(objutil)/cbfstool/cbfs-compression-tool $(FMAPTOOL) $(RMODTOOL) $(IFWITOOL) $(objutil)/nvramtool/nvramtool $(objutil)/sconfig/sconfig $(IFDTOOL) $(CBOOTIMAGE) $(AMDFWTOOL) $(AMDCOMPRESS) $(FUTILITY) $(BINCFG) $(IFITTOOL) $(objutil)/supermicro/smcbiosinfo
671 ###########################################################################
672 # Common recipes for all stages
673 ###########################################################################
675 # loadaddr can determine the load address of a stage, which may be needed for
676 # platform-specific image headers (only works *after* the stage has been built)
677 loadaddr = $(shell $(OBJDUMP_$(1)) -p $(objcbfs)/$(1).debug | \
678              sed -ne '/LOAD/s/^.*vaddr 0x\([0-9a-fA-F]\{8\}\).*$$/0x\1/p')
680 # find-substr is required for stages like romstage_null and romstage_xip to
681 # eliminate the _* part of the string
682 find-substr = $(word 1,$(subst _, ,$(1)))
684 # find-class is used to identify the class from the name of the stage
685 # The input to this macro can be something like romstage.x or romstage.x.y
686 # find-class recursively strips off the suffixes to extract the exact class name
687 # e.g.: if romstage.x is provided to find-class, it will remove .x and return romstage
688 # if romstage.x.y is provided, it will first remove .y, call find-class with romstage.x
689 # and remove .x the next time and finally return romstage
690 find-class = $(if $(filter $(1),$(basename $(1))),$(if $(CC_$(1)), $(1), $(call find-substr,$(1))),$(call find-class,$(basename $(1))))
692 # Bootblocks are not CBFS stages. coreboot is currently expecting the bss to
693 # be cleared by the loader of the stage. For ARM SoCs that means one needs to
694 # include the bss section in the binary so the BootROM clears the bss on
695 # loading of the bootblock stage. Achieve this by marking the bss section
696 # loadable,allocatable, and data. Do the same for the .data section in case
697 # the linker marked it NOBITS automatically because there are only zeroes in it.
698 preserve-bss-flags := --set-section-flags .bss=load,alloc,data --set-section-flags .data=load,alloc,data
700 # For Intel TXT files in the CBFS needs to be marked as 'Initial Boot Block'.
701 # As CBFS attributes aren't cheap, only mark them if TXT is enabled.
702 ifeq ($(CONFIG_INTEL_TXT),y)
704 TXTIBB := --ibb
706 else
708 TXTIBB :=
710 endif
712 ifeq ($(CONFIG_COMPRESS_BOOTBLOCK),y)
714 $(objcbfs)/bootblock.lz4: $(objcbfs)/bootblock.elf $(objutil)/cbfstool/cbfs-compression-tool
715         @printf "    LZ4        $(subst $(obj)/,,$(@))\n"
716         $(OBJCOPY_bootblock) $(preserve-bss-flags) $< $@.tmp
717         $(OBJCOPY_bootblock) -O binary $@.tmp
718         $(objutil)/cbfstool/cbfs-compression-tool rawcompress $@.tmp $@.tmp2 lz4
719         rm -f $@.tmp
720         mv $@.tmp2 $@
722 # Put assembled decompressor+bootblock into bootblock.raw.elf so that SoC
723 # Makefiles wrapping the bootblock in a header can always key off the same file.
724 $(objcbfs)/bootblock.raw.elf: $(objcbfs)/decompressor.elf
725         @printf "    OBJCOPY    $(notdir $(@))\n"
726         $(OBJCOPY_bootblock) $(preserve-bss-flags) $< $@
728 else    # CONFIG_COMPRESS_BOOTBLOCK
730 $(objcbfs)/bootblock.raw.elf: $(objcbfs)/bootblock.elf
731         @printf "    OBJCOPY    $(notdir $(@))\n"
732         $(OBJCOPY_bootblock) $(preserve-bss-flags) $< $@
734 endif   # CONFIG_COMPRESS_BOOTBLOCK
736 $(objcbfs)/bootblock.raw.bin: $(objcbfs)/bootblock.raw.elf
737         @printf "    OBJCOPY    $(notdir $(@))\n"
738         $(OBJCOPY_bootblock) -O binary $< $@
740 ifneq ($(CONFIG_HAVE_BOOTBLOCK),y)
741 $(objcbfs)/bootblock.bin: $(objcbfs)
742         dd if=/dev/zero of=$@ bs=64 count=1
743 endif
745 $(objcbfs)/%.bin: $(objcbfs)/%.raw.bin
746         cp $< $@
748 $(objcbfs)/%.elf: $(objcbfs)/%.debug
749         $(eval class := $(call find-class,$(@F)))
750         @printf "    OBJCOPY    $(subst $(obj)/,,$(@))\n"
751         cp $< $@.tmp
752         $(NM_$(class)) -n $@.tmp | sort > $(basename $@).map
753         $(OBJCOPY_$(class)) --strip-debug $@.tmp
754         $(OBJCOPY_$(class)) --add-gnu-debuglink=$< $@.tmp
755         mv $@.tmp $@
758 ###########################################################################
759 # Build the final rom image
760 ###########################################################################
762 # extract_nth - Return a subsection of the $file string
764 # the input string looks like this:
765 # ./build/cbfs/fallback/romstage.elf|fallback/romstage|stage|none||64|--xip*-S*.car.data*-P*0x10000
767 # Sections:
768 # 1 - Path and name of file [FILENAME: Added to cbfs-files-y list variable]
769 # 2 - Name of file in cbfs  [$(FILENAME)-file]
770 # 3 - File type:            [$(FILENAME)-type]
771 #                bootblock, cbfs header, stage, payload, optionrom, bootsplash, raw, vsa,
772 #                mbi, microcode, fsp, mrc, cmos_default, cmos_layout, spd, mrc_cache,
773 #                mma, efi, deleted, null
774 # 4 - Compression type      [$(FILENAME)-compression]
775 #                      none, LZMA
776 # 5 - Base address          [$(FILANAME)-position]
777 # 6 - Alignment             [$(FILENAME)-align]
778 # 7 - cbfstool flags        [$(FILENAME)-options]
780 # Input:
781 #  $(1) = Section to extract
782 #  $(2) = Input string
784 # Steps:
785 # 1) replace all '|' characters with the sequence '- -' within the full string, prepended and appended with the character '-'
786 # 2) extract the specified section from the string - this gets us the section surrounded by '-' characters
787 # 3) remove the leading and trailing '-' characters
788 # 4) replace all '*' characters with spaces
789 extract_nth=$(subst *,$(spc),$(patsubst -%-,%,$(word $(1), $(subst |,- -,-$(2)-))))
791 # regions-for-file - Returns a cbfstool regions parameter
792 # $(call regions-for-file,$(filename))
793 # returns "REGION1,REGION2,..."
795 # This is the default implementation. When using a boot strategy employing
796 # multiple CBFSes in fmap regions, override it.
797 regions-for-file ?= COREBOOT
799 ifeq ($(CONFIG_CBFS_AUTOGEN_ATTRIBUTES),y)
800         cbfs-autogen-attributes=-g
801 endif
803 # cbfs-add-cmd-for-region
804 # $(call cbfs-add-cmd-for-region,file in extract_nth format,region name)
805 define cbfs-add-cmd-for-region
806         $(CBFSTOOL) $@.tmp \
807         add$(if $(filter stage,$(call extract_nth,3,$(1))),-stage)$(if \
808                 $(filter payload,$(call extract_nth,3,$(1))),-payload)$(if \
809                 $(filter flat-binary,$(call extract_nth,3,$(1))),-flat-binary) \
810         -f $(call extract_nth,1,$(1)) \
811         -n $(call extract_nth,2,$(1)) \
812         $(if $(filter-out flat-binary payload stage,$(call \
813                 extract_nth,3,$(1))),-t $(call extract_nth,3,$(1))) \
814         $(if $(call extract_nth,4,$(1)),-c $(call extract_nth,4,$(1))) \
815         $(cbfs-autogen-attributes) \
816         -r $(2) \
817         $(if $(call extract_nth,6,$(1)),-a $(call extract_nth,6,$(file)), \
818                 $(if $(call extract_nth,5,$(file)),-b $(call extract_nth,5,$(file)))) \
819                 $(call extract_nth,7,$(1))
822 endef
823 # Empty line before endef is necessary so cbfs-add-cmd-for-region ends in a
824 # newline
826 # cbfs-add-cmd
827 # $(call cbfs-add-cmd,
828 #          file in extract_nth format,
829 #          region name,
830 #          non-empty if file removal requested)
831 define cbfs-add-cmd
832         printf "    CBFS       $(call extract_nth,2,$(1))\n"
833         $(if $(3),-$(CBFSTOOL) $@.tmp remove -n $(call extract_nth,2,$(file)) 2>/dev/null)
834         $(call cbfs-add-cmd-for-region,$(1),$(2))
835 endef
837 # list of files to add (using their file system names, not CBFS names),
838 # for dependencies etc.
839 prebuilt-files = $(foreach file,$(cbfs-files), $(call extract_nth,1,$(file)))
841 # $(all-regions)
842 # returns full list of fmap regions that we add files to
843 all-regions = $(sort $(subst $(comma),$(spc), \
844         $(foreach file,$(cbfs-files), \
845                 $(call regions-for-file,$(call extract_nth,2,$(file))))))
847 # $(call all-files-in-region,region name)
848 # returns elements in $(cbfs-files) that end up in that region, in the order
849 # they appear in $(cbfs-files)
850 all-files-in-region = $(foreach file,$(cbfs-files), \
851         $(if $(filter $(1), \
852                 $(subst $(comma),$(spc),$(call regions-for-file,$(call extract_nth,2,$(file))))), \
853                 $(file)))
855 # $(call update-file-for-region,file string from $(cbfs-files),region name)
856 # Update position and alignment according to overrides for region
857 # Doesn't check for invalid configurations (eg. resetting neither or both
858 # position and align)
859 # Returns the updated file string
860 update-file-for-region = \
861         $(subst $(spc),*,$(call extract_nth,1,$(1))|$(call extract_nth,2,$(1))|$(call extract_nth,3,$(1))|$(call extract_nth,4,$(1))|$($(call extract_nth,2,$(1))-$(2)-position)|$($(call extract_nth,2,$(1))-$(2)-align)|$(call extract_nth,7,$(1)))
863 # $(call placed-files-in-region,region name)
864 # like all-files-in-region, but updates the files to contain region overrides
865 # to position or alignment.
866 placed-files-in-region = $(foreach file,$(call all-files-in-region,$(1)), \
867         $(if $($(call extract_nth,2,$(file))-$(1)-position), \
868                 $(if $($(call extract_nth,2,$(file))-$(1)-align), \
869                         $(error It is not allowed to specify both alignment and position for $(call extract_nth,2,$(file))-$(1))) \
870                 $(call update-file-for-region,$(file),$(1)), \
871                 $(if $($(call extract_nth,2,$(file))-$(1)-align), \
872                         $(call update-file-for-region,$(file),$(1)), \
873                         $(file))))
875 # $(call sort-files,subset of $(cbfs-files))
876 # reorders the files in the given set to list files at fixed positions first,
877 # followed by aligned files and finally those with no constraints.
878 sort-files = \
879         $(eval _tmp_fixed:=) \
880         $(eval _tmp_aligned:=) \
881         $(eval _tmp_regular:=) \
882         $(foreach file,$(1), \
883                 $(if $(call extract_nth,5,$(file)),\
884                         $(eval _tmp_fixed += $(file)), \
885                 $(if $(call extract_nth,6,$(file)), \
886                         $(eval _tmp_aligned += $(file)), \
887                         $(eval _tmp_regular += $(file))))) \
888         $(_tmp_fixed) $(_tmp_aligned) $(_tmp_regular)
890 # command list to add files to CBFS
891 prebuild-files = $(foreach region,$(all-regions), \
892         $(foreach file, \
893                 $(call sort-files,$(call placed-files-in-region,$(region))), \
894                 $(call cbfs-add-cmd,$(file),$(region),$(CONFIG_UPDATE_IMAGE))))
896 ifeq ($(CONFIG_FMDFILE),)
897 # For a description of the flash layout described by these variables, check
898 # the $(DEFAULT_FLASHMAP) .fmd files.
899 ifeq ($(CONFIG_ARCH_X86),y)
900 DEFAULT_FLASHMAP:=$(top)/util/cbfstool/default-x86.fmd
901 # entire flash
902 FMAP_ROM_ADDR := $(call int-subtract, 0x100000000 $(CONFIG_ROM_SIZE))
903 FMAP_ROM_SIZE := $(CONFIG_ROM_SIZE)
904 # entire "BIOS" region (everything directly of concern to the host system)
905 # relative to ROM_BASE
906 FMAP_BIOS_BASE := $(call int-align, $(call int-subtract, $(CONFIG_ROM_SIZE) $(CONFIG_CBFS_SIZE)), 0x10000)
907 FMAP_BIOS_SIZE := $(call int-align-down, $(shell echo $(CONFIG_CBFS_SIZE) | tr A-F a-f), 0x10000)
908 # position and size of flashmap, relative to BIOS_BASE
911 # X86 CONSOLE FMAP region
913 # position, size and entry line of CONSOLE relative to BIOS_BASE, if enabled
915 FMAP_CURRENT_BASE := 0
917 ifeq ($(CONFIG_CONSOLE_SPI_FLASH),y)
918 FMAP_CONSOLE_BASE := $(FMAP_CURRENT_BASE)
919 FMAP_CONSOLE_SIZE := $(CONFIG_CONSOLE_SPI_FLASH_BUFFER_SIZE)
920 FMAP_CONSOLE_ENTRY := CONSOLE@$(FMAP_CONSOLE_BASE) $(FMAP_CONSOLE_SIZE)
921 FMAP_CURRENT_BASE := $(call int-add, $(FMAP_CONSOLE_BASE) $(FMAP_CONSOLE_SIZE))
922 else
923 FMAP_CONSOLE_ENTRY :=
924 endif
926 ifeq ($(CONFIG_CACHE_MRC_SETTINGS),y)
927 FMAP_MRC_CACHE_BASE := $(call int-align, $(FMAP_CURRENT_BASE), 0x10000)
928 FMAP_MRC_CACHE_SIZE := $(CONFIG_MRC_SETTINGS_CACHE_SIZE)
929 FMAP_MRC_CACHE_ENTRY := RW_MRC_CACHE@$(FMAP_MRC_CACHE_BASE) $(FMAP_MRC_CACHE_SIZE)
930 FMAP_CURRENT_BASE := $(call int-add, $(FMAP_MRC_CACHE_BASE) $(FMAP_MRC_CACHE_SIZE))
931 else
932 FMAP_MRC_CACHE_ENTRY :=
933 endif
935 ifeq ($(CONFIG_SMMSTORE),y)
936 FMAP_SMMSTORE_BASE := $(call int-align, $(FMAP_CURRENT_BASE), 0x10000)
937 FMAP_SMMSTORE_SIZE := $(CONFIG_SMMSTORE_SIZE)
938 FMAP_SMMSTORE_ENTRY := SMMSTORE@$(FMAP_SMMSTORE_BASE) $(FMAP_SMMSTORE_SIZE)
939 FMAP_CURRENT_BASE := $(call int-add, $(FMAP_SMMSTORE_BASE) $(FMAP_SMMSTORE_SIZE))
940 else
941 FMAP_SMMSTORE_ENTRY :=
942 endif
945 # X86 FMAP region
948 # position, size
949 FMAP_FMAP_BASE := $(FMAP_CURRENT_BASE)
950 FMAP_FMAP_SIZE := 0x200
953 # X86 COREBOOT default cbfs FMAP region
955 # position and size of CBFS, relative to BIOS_BASE
956 FMAP_CBFS_BASE := $(call int-add, $(FMAP_FMAP_BASE) $(FMAP_FMAP_SIZE))
957 FMAP_CBFS_SIZE := $(call int-subtract, $(FMAP_BIOS_SIZE) $(FMAP_CBFS_BASE))
959 else # ifeq ($(CONFIG_ARCH_X86),y)
961 DEFAULT_FLASHMAP:=$(top)/util/cbfstool/default.fmd
962 # entire flash
963 FMAP_ROM_ADDR := 0
964 FMAP_ROM_SIZE := $(CONFIG_ROM_SIZE)
965 # entire "BIOS" region (everything directly of concern to the host system)
966 # relative to ROM_BASE
967 FMAP_BIOS_BASE := 0
968 FMAP_BIOS_SIZE := $(CONFIG_CBFS_SIZE)
969 # position and size of flashmap, relative to BIOS_BASE
970 FMAP_FMAP_BASE := 0x20000
971 FMAP_FMAP_SIZE := 0x200
973 FMAP_CURRENT_BASE := $(call int-add, $(FMAP_FMAP_BASE) $(FMAP_FMAP_SIZE))
976 # NON-X86 CONSOLE FMAP region
978 # position, size and entry line of CONSOLE relative to BIOS_BASE, if enabled
979 ifeq ($(CONFIG_CONSOLE_SPI_FLASH),y)
980 FMAP_CONSOLE_BASE := $(FMAP_CURRENT_BASE)
981 FMAP_CONSOLE_SIZE := $(CONFIG_CONSOLE_SPI_FLASH_BUFFER_SIZE)
982 FMAP_CONSOLE_ENTRY := CONSOLE@$(FMAP_CONSOLE_BASE) $(FMAP_CONSOLE_SIZE)
983 FMAP_CURRENT_BASE := $(call int-add, $(FMAP_CONSOLE_BASE) $(FMAP_CONSOLE_SIZE))
984 else
985 FMAP_CONSOLE_ENTRY :=
986 endif
989 # NON-X86 RW_MRC_CACHE FMAP region
991 # position, size and entry line of MRC_CACHE relative to BIOS_BASE, if enabled
992 ifeq ($(CONFIG_CACHE_MRC_SETTINGS),y)
993 FMAP_MRC_CACHE_BASE := $(call int-align, $(FMAP_CURRENT_BASE), 0x10000)
994 FMAP_MRC_CACHE_SIZE := $(CONFIG_MRC_SETTINGS_CACHE_SIZE)
995 FMAP_MRC_CACHE_ENTRY := RW_MRC_CACHE@$(FMAP_MRC_CACHE_BASE) $(FMAP_MRC_CACHE_SIZE)
996 FMAP_CURRENT_BASE := $(call int-add, $(FMAP_MRC_CACHE_BASE) $(FMAP_MRC_CACHE_SIZE))
997 else
998 FMAP_MRC_CACHE_ENTRY :=
999 endif
1002 # NON-X86 COREBOOT default cbfs FMAP region
1004 # position and size of CBFS, relative to BIOS_BASE
1005 FMAP_CBFS_BASE := $(FMAP_CURRENT_BASE)
1006 FMAP_CBFS_SIZE := $(call int-subtract,$(FMAP_BIOS_SIZE) $(FMAP_CBFS_BASE))
1008 endif # ifeq ($(CONFIG_ARCH_X86),y)
1010 $(obj)/fmap.fmd: $(top)/Makefile.inc $(DEFAULT_FLASHMAP) $(obj)/config.h
1011         sed -e "s,##ROM_BASE##,$(FMAP_ROM_ADDR)," \
1012             -e "s,##ROM_SIZE##,$(FMAP_ROM_SIZE)," \
1013             -e "s,##BIOS_BASE##,$(FMAP_BIOS_BASE)," \
1014             -e "s,##BIOS_SIZE##,$(FMAP_BIOS_SIZE)," \
1015             -e "s,##FMAP_BASE##,$(FMAP_FMAP_BASE)," \
1016             -e "s,##FMAP_SIZE##,$(FMAP_FMAP_SIZE)," \
1017             -e "s,##CONSOLE_ENTRY##,$(FMAP_CONSOLE_ENTRY)," \
1018             -e "s,##MRC_CACHE_ENTRY##,$(FMAP_MRC_CACHE_ENTRY)," \
1019             -e "s,##SMMSTORE_ENTRY##,$(FMAP_SMMSTORE_ENTRY)," \
1020             -e "s,##CBFS_BASE##,$(FMAP_CBFS_BASE)," \
1021             -e "s,##CBFS_SIZE##,$(FMAP_CBFS_SIZE)," \
1022                 $(DEFAULT_FLASHMAP) > $@.tmp
1023         mv $@.tmp $@
1024 else # ifeq ($(CONFIG_FMDFILE),)
1025 $(obj)/fmap.fmd: $(CONFIG_FMDFILE) $(obj)/config.h
1026         $(HOSTCC) $(PREPROCESS_ONLY) -include $(obj)/config.h $< -o $@.pre
1027         mv $@.pre $@
1028 endif # ifeq ($(CONFIG_FMDFILE),)
1030 # generated at the same time as fmap.fmap
1031 $(obj)/fmap_config.h: $(obj)/fmap.fmap
1032         true
1033 $(obj)/fmap.desc: $(obj)/fmap.fmap
1034         true
1036 $(obj)/fmap.fmap: $(obj)/fmap.fmd $(FMAPTOOL)
1037         echo "    FMAP       $(FMAPTOOL) -h $(obj)/fmap_config.h $< $@"
1038         $(FMAPTOOL) -h $(obj)/fmap_config.h -R $(obj)/fmap.desc $< $@
1040 ifeq ($(CONFIG_INTEL_ADD_TOP_SWAP_BOOTBLOCK),y)
1041 TS_OPTIONS := -j $(CONFIG_INTEL_TOP_SWAP_BOOTBLOCK_SIZE)
1042 endif
1043 ifneq ($(CONFIG_UPDATE_IMAGE),y)
1044 $(obj)/coreboot.pre: $(objcbfs)/bootblock.bin $$(prebuilt-files) $(CBFSTOOL) $(IFITTOOL) $$(cpu_ucode_cbfs_file) $(obj)/fmap.fmap $(obj)/fmap.desc
1045         $(CBFSTOOL) $@.tmp create -M $(obj)/fmap.fmap -r $(shell cat $(obj)/fmap.desc)
1046 ifeq ($(CONFIG_ARCH_X86),y)
1047         $(CBFSTOOL) $@.tmp add \
1048                 -f $(objcbfs)/bootblock.bin \
1049                 -n bootblock \
1050                 -t bootblock \
1051                 $(TXTIBB) \
1052                 -b -$(call file-size,$(objcbfs)/bootblock.bin) $(cbfs-autogen-attributes) \
1053                 $(TS_OPTIONS)
1054 else # ifeq ($(CONFIG_ARCH_X86),y)
1055         $(CBFSTOOL) $@.tmp write -u \
1056                 -r BOOTBLOCK \
1057                 -f $(objcbfs)/bootblock.bin
1058         # make space for the CBFS master header pointer. "ptr_" is just
1059         # arbitrary 4 bytes that will be overwritten by add-master-header.
1060         printf "ptr_" > $@.tmp.2
1061         $(CBFSTOOL) $@.tmp add \
1062                 -f $@.tmp.2 \
1063                 -n "header pointer" \
1064                 -t "cbfs header" \
1065                 -b -4
1066         rm -f $@.tmp.2
1067 endif # ifeq ($(CONFIG_ARCH_X86),y)
1068         $(CBFSTOOL) $@.tmp add-master-header $(TS_OPTIONS)
1069         $(prebuild-files) true
1070         mv $@.tmp $@
1071 else # ifneq ($(CONFIG_UPDATE_IMAGE),y)
1072 .PHONY: $(obj)/coreboot.pre
1073 $(obj)/coreboot.pre: $$(prebuilt-files) $(CBFSTOOL)
1074         mv $(obj)/coreboot.rom $@.tmp || \
1075         (echo "Error: You have UPDATE_IMAGE set in Kconfig, but have no existing image to update." && \
1076         echo "Exiting." && \
1077         false)
1078         $(prebuild-files) true
1079         mv $@.tmp $@
1080 endif # ifneq ($(CONFIG_UPDATE_IMAGE),y)
1082 ifeq ($(CONFIG_HAVE_REFCODE_BLOB),y)
1083 REFCODE_BLOB=$(obj)/refcode.rmod
1084 $(REFCODE_BLOB): $(RMODTOOL)
1085         $(RMODTOOL) -i $(CONFIG_REFCODE_BLOB_FILE) -o $@
1086 endif
1088 FIT_ENTRY=$(call strip_quotes, $(CONFIG_INTEL_TOP_SWAP_FIT_ENTRY_FMAP_REG))
1090 ifeq ($(CONFIG_HAVE_RAMSTAGE),y)
1091 RAMSTAGE=$(objcbfs)/ramstage.elf
1092 else
1093 RAMSTAGE=
1094 endif
1096 $(obj)/coreboot.rom: $(obj)/coreboot.pre $(RAMSTAGE) $(CBFSTOOL) $$(INTERMEDIATE)
1098         @printf "    CBFS       $(subst $(obj)/,,$(@))\n"
1099 # The full ROM may be larger than the CBFS part, so create an empty
1100 # file (filled with \377 = 0xff) and copy the CBFS image over it.
1101         dd if=/dev/zero bs=$(call _toint,$(CONFIG_ROM_SIZE)) count=1 2> /dev/null | tr '\000' '\377' > $@.tmp
1102         dd if=$(obj)/coreboot.pre of=$@.tmp bs=8192 conv=notrunc 2> /dev/null
1103 ifneq ($(CONFIG_SEABIOS_PS2_TIMEOUT),)
1104 ifneq ($(CONFIG_SEABIOS_PS2_TIMEOUT),0)
1105 ifneq ($(CONFIG_UPDATE_IMAGE),y)
1106         @printf "    SeaBIOS    Wait up to $(CONFIG_SEABIOS_PS2_TIMEOUT) ms for PS/2 keyboard controller initialization\n"
1107         $(CBFSTOOL) $@.tmp add-int -i $(CONFIG_SEABIOS_PS2_TIMEOUT) -n etc/ps2-keyboard-spinup
1108 endif
1109 endif
1110 endif
1111 ifeq ($(CONFIG_SEABIOS_ADD_SERCON_PORT_FILE),y)
1112         @printf "    SeaBIOS    Add sercon-port file\n"
1113         $(CBFSTOOL) $@.tmp add-int -i $(CONFIG_SEABIOS_SERCON_PORT_ADDR) -n etc/sercon-port
1114 endif
1115 ifeq ($(CONFIG_SEABIOS_THREAD_OPTIONROMS),y)
1116         @printf "    SeaBIOS    Thread optionroms\n"
1117         $(CBFSTOOL) $@.tmp add-int -i 2 -n etc/threads
1118 endif
1119 ifeq ($(CONFIG_CPU_INTEL_FIRMWARE_INTERFACE_TABLE),y)
1120 ifneq ($(CONFIG_UPDATE_IMAGE),y) # never update the bootblock
1121 ifeq ($(CONFIG_CPU_MICROCODE_CBFS_EXTERNAL_HEADER),y)
1122         @printf "    UPDATE-FIT\n"
1123         $(IFITTOOL) -f $@.tmp -a -n cpu_microcode_blob.bin -t 1 -s $(CONFIG_CPU_INTEL_NUM_FIT_ENTRIES) \
1124         -r COREBOOT
1125 endif
1126 ifeq ($(CONFIG_USE_CPU_MICROCODE_CBFS_BINS),y)
1127         @printf "    UPDATE-FIT\n"
1128         $(IFITTOOL) -f $@.tmp -a -n cpu_microcode_blob.bin -t 1 -s $(CONFIG_CPU_INTEL_NUM_FIT_ENTRIES) \
1129         -r COREBOOT
1130 endif
1131         $(IFITTOOL) -f $@.tmp -D -r COREBOOT
1133 # Second FIT in TOP_SWAP bootblock
1134 ifeq ($(CONFIG_INTEL_ADD_TOP_SWAP_BOOTBLOCK),y)
1135 # INTEL_TOP_SWAP_FIT_ENTRY_FMAP_REG adds a region as first ucode into the seconds bootblock
1136 ifneq ($(FIT_ENTRY),)
1137         @printf "    UPDATE-FIT2\n"
1138         $(IFITTOOL) -f $@.tmp -A -n $(FIT_ENTRY) -t 1 -s $(CONFIG_CPU_INTEL_NUM_FIT_ENTRIES) \
1139         $(TS_OPTIONS) -r COREBOOT
1140 endif
1141 ifeq ($(CONFIG_CPU_MICROCODE_CBFS_EXTERNAL_HEADER),y)
1142         @printf "    UPDATE-FIT2\n"
1143         $(IFITTOOL) -f $@.tmp -a -n cpu_microcode_blob.bin -t 1 -s $(CONFIG_CPU_INTEL_NUM_FIT_ENTRIES) \
1144         $(TS_OPTIONS) -r COREBOOT
1145 endif
1146 ifeq ($(CONFIG_USE_CPU_MICROCODE_CBFS_BINS),y)
1147         @printf "    UPDATE-FIT2\n"
1148         $(IFITTOOL) -f $@.tmp -a -n cpu_microcode_blob.bin -t 1 -s $(CONFIG_CPU_INTEL_NUM_FIT_ENTRIES) \
1149         $(TS_OPTIONS) -r COREBOOT
1150 endif
1151         $(IFITTOOL) -f $@.tmp -D $(TS_OPTIONS) -r COREBOOT
1153 endif
1155 endif # !CONFIG_UPDATE_IMAGE
1156 endif # CONFIG_CPU_INTEL_FIRMWARE_INTERFACE_TABLE
1157         mv $@.tmp $@
1158         @printf "    CBFSLAYOUT  $(subst $(obj)/,,$(@))\n\n"
1159         $(CBFSTOOL) $@ layout
1160         @printf "    CBFSPRINT  $(subst $(obj)/,,$(@))\n\n"
1161         $(CBFSTOOL) $@ print -r $(subst $(spc),$(comma),$(all-regions))
1163 cbfs-files-y += $(CONFIG_CBFS_PREFIX)/romstage
1164 $(CONFIG_CBFS_PREFIX)/romstage-file := $(objcbfs)/romstage.elf
1165 $(CONFIG_CBFS_PREFIX)/romstage-type := stage
1166 $(CONFIG_CBFS_PREFIX)/romstage-compression := $(CBFS_PRERAM_COMPRESS_FLAG)
1167 ifeq ($(CONFIG_ARCH_ROMSTAGE_ARM),y)
1168 $(CONFIG_CBFS_PREFIX)/romstage-options := -b 0
1169 endif
1170 ifeq ($(CONFIG_ARCH_ROMSTAGE_X86_32)$(CONFIG_ARCH_ROMSTAGE_X86_64),y)
1171 # Use a 64 byte alignment to provide a minimum alignment
1172 # requirement for the overall romstage. While the first object within
1173 # romstage could have a 4 byte minimum alignment that doesn't mean the linker
1174 # won't decide the entire section should be aligned to a larger value. In the
1175 # future cbfstool should add XIP files proper and honor the alignment
1176 # requirements of the program segment.
1178 # Make sure that segment for .car.data is ignored while adding romstage.
1179 $(CONFIG_CBFS_PREFIX)/romstage-align := 64
1180 $(CONFIG_CBFS_PREFIX)/romstage-options := -S ".car.data"
1182 # If CAR does not support execution of code, romstage on x86 is expected to be
1183 # xip.
1184 ifneq ($(CONFIG_NO_XIP_EARLY_STAGES),y)
1185 $(CONFIG_CBFS_PREFIX)/romstage-options += --xip
1187 # For efficient MTRR utilisation use natural alignment for romstage.
1188 ifeq ($(CONFIG_SETUP_XIP_CACHE),y)
1189 $(CONFIG_CBFS_PREFIX)/romstage-options += --pow2page
1190 endif    # CONFIG_SETUP_XIP_CACHE
1192 endif   # CONFIG_NO_XIP_EARLY_STAGES
1193 endif   # CONFIG_ARCH_ROMSTAGE_X86_32 / CONFIG_ARCH_ROMSTAGE_X86_64
1194 ifeq ($(CONFIG_VBOOT_STARTS_IN_ROMSTAGE),y)
1195 $(CONFIG_CBFS_PREFIX)/romstage-options += $(TXTIBB)
1196 endif
1198 cbfs-files-$(CONFIG_HAVE_RAMSTAGE) += $(CONFIG_CBFS_PREFIX)/ramstage
1199 $(CONFIG_CBFS_PREFIX)/ramstage-file := $(RAMSTAGE)
1200 $(CONFIG_CBFS_PREFIX)/ramstage-type := stage
1201 $(CONFIG_CBFS_PREFIX)/ramstage-compression := $(CBFS_COMPRESS_FLAG)
1203 cbfs-files-$(CONFIG_HAVE_REFCODE_BLOB) += $(CONFIG_CBFS_PREFIX)/refcode
1204 $(CONFIG_CBFS_PREFIX)/refcode-file := $(REFCODE_BLOB)
1205 $(CONFIG_CBFS_PREFIX)/refcode-type := stage
1206 $(CONFIG_CBFS_PREFIX)/refcode-compression := $(CBFS_COMPRESS_FLAG)
1208 cbfs-files-$(CONFIG_SEABIOS_VGA_COREBOOT) += vgaroms/seavgabios.bin
1209 vgaroms/seavgabios.bin-file := $(CONFIG_PAYLOAD_VGABIOS_FILE)
1210 vgaroms/seavgabios.bin-type := raw
1212 cbfs-files-$(CONFIG_INCLUDE_CONFIG_FILE) += config
1213 config-file := $(DOTCONFIG):defconfig
1214 config-type := raw
1216 cbfs-files-$(CONFIG_INCLUDE_CONFIG_FILE) += revision
1217 revision-file := $(obj)/build.h
1218 revision-type := raw
1220 BOOTSPLASH_SUFFIX=$(suffix $(call strip_quotes,$(CONFIG_BOOTSPLASH_FILE)))
1221 cbfs-files-$(CONFIG_BOOTSPLASH_IMAGE) += bootsplash$(BOOTSPLASH_SUFFIX)
1222 bootsplash$(BOOTSPLASH_SUFFIX)-file := $(call strip_quotes,$(CONFIG_BOOTSPLASH_FILE))
1223 bootsplash$(BOOTSPLASH_SUFFIX)-type := bootsplash
1225 # Ensure that no payload segment overlaps with memory regions used by ramstage
1226 # (not for x86 since it can relocate itself in that case)
1227 ifneq ($(CONFIG_ARCH_X86),y)
1228 check-ramstage-overlap-regions := ramstage
1229 check-ramstage-overlap-files :=
1230 ifneq ($(CONFIG_PAYLOAD_NONE),y)
1231 check-ramstage-overlap-files += $(CONFIG_CBFS_PREFIX)/payload
1232 endif
1234 # will output one or more lines of "<load address in hex> <memlen in decimal>"
1235 cbfs-get-segments-cmd = $(CBFSTOOL) $(obj)/coreboot.pre print -v | sed -n \
1236         '\%$(1)%,\%^[^ ]\{4\}%s%    .*load: \(0x[0-9a-fA-F]*\),.*length: [0-9]*/\([0-9]*\).*%\1 \2%p'
1238 ramstage-symbol-addr-cmd = $(OBJDUMP_ramstage) -t $(objcbfs)/ramstage.elf | \
1239         sed -n '/ $(1)$$/s/^\([0-9a-fA-F]*\) .*/0x\1/p'
1241 check-ramstage-overlaps: $(obj)/coreboot.pre
1242         programs=$$($(foreach file,$(check-ramstage-overlap-files), \
1243                 $(call cbfs-get-segments-cmd,$(file)) ; )) ; \
1244         regions=$$($(foreach region,$(check-ramstage-overlap-regions), \
1245                 echo $(region) ; \
1246                 $(call ramstage-symbol-addr-cmd,_$(region)) ; \
1247                 $(call ramstage-symbol-addr-cmd,_e$(region)) ; )) ; \
1248         pstart= ; pend= ; \
1249         for x in $$programs; do \
1250             if [ -z $$pstart ]; then pstart=$$(($$x)) ; continue ; fi ; \
1251             pend=$$(($$pstart + $$x)) ; \
1252             rname= ; rstart= ; rend= ; \
1253             for y in $$regions ; do \
1254                 if [ -z $$rname ]; then rname=$$y ; continue ; fi ; \
1255                 if [ -z $$rstart ]; then rstart=$$(($$y)) ; continue ; fi ; \
1256                 rend=$$(($$y)) ; \
1257                 if [ $$pstart -lt $$rend -a $$rstart -lt $$pend ]; then \
1258                     echo "ERROR: Ramstage region _$$rname overlapped by:" \
1259                          $(check-ramstage-overlap-files) ; \
1260                     exit 1 ; \
1261                 fi ; \
1262                 rname= ; rstart= ; rend= ; \
1263             done ; \
1264             pstart= ; pend= ; \
1265         done
1267 INTERMEDIATE+=check-ramstage-overlaps
1268 PHONY+=check-ramstage-overlaps
1269 endif