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