[efi] Do not raise TPL within EFI_DRIVER_BINDING_PROTOCOL.Supported()
[ipxe.git] / src / Makefile.housekeeping
1 # -*- makefile -*- : Force emacs to use Makefile mode
2 #
3 # This file contains various boring housekeeping functions that would
4 # otherwise seriously clutter up the main Makefile.
5
6 ###############################################################################
7 #
8 # Find a usable "echo -e" substitute.
9 #
10 TAB                     := $(shell $(PRINTF) '\t')
11 ECHO_E_ECHO             := $(ECHO)
12 ECHO_E_ECHO_E           := $(ECHO) -e
13 ECHO_E_BIN_ECHO         := /bin/echo
14 ECHO_E_BIN_ECHO_E       := /bin/echo -e
15 ECHO_E_ECHO_TAB         := $(shell $(ECHO_E_ECHO) '\t' | cat)
16 ECHO_E_ECHO_E_TAB       := $(shell $(ECHO_E_ECHO_E) '\t' | cat)
17 ECHO_E_BIN_ECHO_TAB     := $(shell $(ECHO_E_BIN_ECHO) '\t')
18 ECHO_E_BIN_ECHO_E_TAB   := $(shell $(ECHO_E_BIN_ECHO_E) '\t')
19
20 ifeq ($(ECHO_E_ECHO_TAB),$(TAB))
21 ECHO_E          := $(ECHO_E_ECHO)
22 endif
23 ifeq ($(ECHO_E_ECHO_E_TAB),$(TAB))
24 ECHO_E          := $(ECHO_E_ECHO_E)
25 endif
26 ifeq ($(ECHO_E_BIN_ECHO_TAB),$(TAB))
27 ECHO_E          := $(ECHO_E_BIN_ECHO)
28 endif
29 ifeq ($(ECHO_E_BIN_ECHO_E_TAB),$(TAB))
30 ECHO_E          := $(ECHO_E_BIN_ECHO_E)
31 endif
32
33 .echocheck :
34 ifdef ECHO_E
35         @$(TOUCH) $@
36 else
37         @$(PRINTF) '%24s : x%sx\n' 'tab' '$(TAB)'
38         @$(PRINTF) '%24s : x%sx\n' '"$(ECHO_E_ECHO) \t"' \
39                                     '$(ECHO_E_ECHO_TAB)'
40         @$(PRINTF) '%24s : x%sx\n' '"$(ECHO_E_ECHO_E) \t"' \
41                                     '$(ECHO_E_ECHO_E_TAB)'
42         @$(PRINTF) '%24s : x%sx\n' '"$(ECHO_E_BIN_ECHO) \t"' \
43                                     '$(ECHO_E_BIN_ECHO_TAB)'
44         @$(PRINTF) '%24s : x%sx\n' '"$(ECHO_E_BIN_ECHO_E) \t"' \
45                                     '$(ECHO_E_BIN_ECHO_E_TAB)'
46         @$(ECHO) "No usable \"echo -e\" substitute found"
47         @exit 1
48 endif
49 MAKEDEPS        += .echocheck
50 VERYCLEANUP     += .echocheck
51
52 echo :
53         @$(ECHO) "Using \"$(ECHO_E)\" for \"echo -e\""
54
55 ###############################################################################
56 #
57 # Generate a usable "seq" substitute
58 #
59 define seq
60         $(shell awk 'BEGIN { for ( i = $(1) ; i <= $(2) ; i++ ) print i }')
61 endef
62
63 ###############################################################################
64 #
65 # Determine host OS
66 #
67 HOST_OS         := $(shell uname -s)
68 hostos :
69         @$(ECHO) $(HOST_OS)
70
71 ###############################################################################
72 #
73 # Determine compiler
74
75 CCDEFS          := $(shell $(CC) -E -x c -c /dev/null -dM | cut -d" " -f2)
76 ccdefs:
77         @$(ECHO) $(CCDEFS)
78
79 ifeq ($(filter __ICC,$(CCDEFS)),__ICC)
80 CCTYPE          := icc
81 else
82 CCTYPE          := gcc
83 endif
84 cctype:
85         @$(ECHO) $(CCTYPE)
86
87 ###############################################################################
88 #
89 # Check for tools that can cause failed builds
90 #
91
92 ifeq ($(CCTYPE),gcc)
93 GCC_2_96_BANNER := $(shell $(CC) -v 2>&1 | grep -is 'gcc version 2\.96')
94 ifneq ($(GCC_2_96_BANNER),)
95 $(warning gcc 2.96 is unsuitable for compiling iPXE)
96 $(warning Use gcc 2.95 or a newer version instead)
97 $(error Unsuitable build environment found)
98 endif
99 endif
100
101 PERL_UNICODE_CHECK := $(shell $(PERL) -e 'use bytes; print chr(255)' | wc -c)
102 ifeq ($(PERL_UNICODE_CHECK),2)
103 $(warning Your Perl version has a Unicode handling bug)
104 $(warning Execute this command before building iPXE:)
105 $(warning export LANG=$${LANG%.UTF-8})
106 $(error Unsuitable build environment found)
107 endif
108
109 LD_GOLD_BANNER := $(shell $(LD) -v 2>&1 | grep 'GNU gold')
110 ifneq ($(LD_GOLD_BANNER),)
111 $(warning GNU gold is unsuitable for building iPXE)
112 $(warning Use GNU ld instead)
113 $(error Unsuitable build environment found)
114 endif
115
116 ###############################################################################
117 #
118 # Check if $(eval ...) is available to use
119 #
120
121 HAVE_EVAL :=
122 ifndef NO_EVAL
123 $(eval HAVE_EVAL := yes)
124 endif
125 eval :
126         @$(ECHO) $(HAVE_EVAL)
127
128 ###############################################################################
129 #
130 # Check for various tool workarounds
131 #
132
133 WORKAROUND_CFLAGS :=
134 WORKAROUND_ASFLAGS :=
135 WORKAROUND_LDFLAGS :=
136
137 # Make syntax does not allow use of comma or space in certain places.
138 # This ugly workaround is suggested in the manual.
139 #
140 COMMA   := ,
141 EMPTY   :=
142 SPACE   := $(EMPTY) $(EMPTY)
143 HASH    := \#
144 define NEWLINE
145
146
147 endef
148
149 # Some widespread patched versions of gcc include -fstack-protector by
150 # default, even when -ffreestanding is specified.  We therefore need
151 # to disable -fstack-protector if the compiler supports it.
152 #
153 ifeq ($(CCTYPE),gcc)
154 SP_TEST = $(CC) -fno-stack-protector -x c -c /dev/null \
155                 -o /dev/null >/dev/null 2>&1
156 SP_FLAGS := $(shell $(SP_TEST) && $(ECHO) '-fno-stack-protector')
157 WORKAROUND_CFLAGS += $(SP_FLAGS)
158 endif
159
160 # gcc 4.4 generates .eh_frame sections by default, which distort the
161 # output of "size".  Inhibit this.
162 #
163 ifeq ($(CCTYPE),gcc)
164 CFI_TEST = $(CC) -fno-dwarf2-cfi-asm -fno-exceptions -fno-unwind-tables \
165                  -fno-asynchronous-unwind-tables -x c -c /dev/null \
166                  -o /dev/null >/dev/null 2>&1
167 CFI_FLAGS := $(shell $(CFI_TEST) && \
168                $(ECHO) '-fno-dwarf2-cfi-asm -fno-exceptions ' \
169                        '-fno-unwind-tables -fno-asynchronous-unwind-tables')
170 WORKAROUND_CFLAGS += $(CFI_FLAGS)
171 endif
172
173 # gcc 4.6 generates spurious warnings if -Waddress is in force.
174 # Inhibit this.
175 #
176 ifeq ($(CCTYPE),gcc)
177 WNA_TEST = $(CC) -Wno-address -x c -c /dev/null -o /dev/null >/dev/null 2>&1
178 WNA_FLAGS := $(shell $(WNA_TEST) && $(ECHO) '-Wno-address')
179 WORKAROUND_CFLAGS += $(WNA_FLAGS)
180 endif
181
182 # Some versions of gas choke on division operators, treating them as
183 # comment markers.  Specifying --divide will work around this problem,
184 # but isn't available on older gas versions.
185 #
186 DIVIDE_TEST = $(AS) --divide /dev/null -o /dev/null 2>/dev/null
187 DIVIDE_FLAGS := $(shell $(DIVIDE_TEST) && $(ECHO) '--divide')
188 WORKAROUND_ASFLAGS += $(DIVIDE_FLAGS)
189
190 ###############################################################################
191 #
192 # Build verbosity
193 #
194 ifeq ($(V),1)
195 Q :=
196 QM := @\#
197 else
198 Q := @
199 QM := @
200 endif
201
202 ###############################################################################
203 #
204 # Checker
205 #
206 ifeq ($(C),1)
207 export REAL_CC := $(CC)
208 CC := cgcc
209 CFLAGS += -Wno-decl
210 endif
211
212 ###############################################################################
213 #
214 # Set BIN according to whatever was specified on the command line as
215 # the build target.
216 #
217
218 # Determine how many different BIN directories are mentioned in the
219 # make goals.
220 #
221 BIN_GOALS       := $(filter bin bin/% bin-%,$(MAKECMDGOALS))
222 BIN_GOALS_BINS  := $(sort $(foreach BG,$(BIN_GOALS),\
223                                     $(firstword $(subst /, ,$(BG)))))
224 NUM_BINS        := $(words $(BIN_GOALS_BINS))
225
226 ifeq ($(NUM_BINS),0)
227
228 # No BIN directory was specified.  Set BIN to "bin" as a sensible
229 # default.
230
231 BIN             := bin
232
233 else # NUM_BINS == 0
234
235 ifeq ($(NUM_BINS),1)
236
237 # If exactly one BIN directory was specified, set BIN to match this
238 # directory.
239 #
240 BIN             := $(firstword $(BIN_GOALS_BINS))
241
242 else # NUM_BINS == 1
243
244 # More than one BIN directory was specified.  We cannot handle the
245 # latter case within a single make invocation, so set up recursive
246 # targets for each BIN directory.  Use exactly one target for each BIN
247 # directory since running multiple make invocations within the same
248 # BIN directory is likely to cause problems.
249 #
250 # Leave $(BIN) undefined.  This has implications for any target that
251 # depends on $(BIN); such targets should be made conditional upon the
252 # existence of $(BIN).
253 #
254 BIN_GOALS_FIRST := $(foreach BGB,$(BIN_GOALS_BINS),\
255                              $(firstword $(filter $(BGB)/%,$(BIN_GOALS))))
256 BIN_GOALS_OTHER := $(filter-out $(BIN_GOALS_FIRST),$(BIN_GOALS))
257
258 $(BIN_GOALS_FIRST) : % : BIN_RECURSE
259         $(Q)$(MAKE) --no-print-directory BIN=$(firstword $(subst /, ,$@)) \
260             $(filter $(firstword $(subst /, ,$@))/%, $(BIN_GOALS))
261 $(BIN_GOALS_OTHER) : % : BIN_RECURSE
262         $(Q)$(TRUE)
263 .PHONY : BIN_RECURSE
264
265 endif # NUM_BINS == 1
266 endif # NUM_BINS == 0
267
268 ifdef BIN
269
270 # Create $(BIN) directory if it doesn't exist yet
271 #
272 ifeq ($(wildcard $(BIN)),)
273 $(shell $(MKDIR) -p $(BIN))
274 endif
275
276 # Target to allow e.g. "make bin-efi arch"
277 #
278 $(BIN) :
279         @# Do nothing, silently
280 .PHONY : $(BIN)
281
282 # Remove everything in $(BIN) for a "make clean"
283 #
284 CLEANUP += $(BIN)/*.* # Avoid picking up directories
285
286 endif # defined(BIN)
287
288 # Determine whether or not we need to include the dependency files
289 #
290 NO_DEP_TARGETS  := $(BIN) clean veryclean
291 ifeq ($(MAKECMDGOALS),)
292 NEED_DEPS       := 1
293 endif
294 ifneq ($(strip $(filter-out $(NO_DEP_TARGETS),$(MAKECMDGOALS))),)
295 NEED_DEPS       := 1
296 endif
297
298 ###############################################################################
299 #
300 # Select build architecture and platform based on $(BIN)
301 #
302 # BIN has the form bin[-[<arch>-]<platform>[-sb]]
303
304 ARCHS           := $(patsubst arch/%,%,$(wildcard arch/*))
305 PLATFORMS       := $(patsubst config/defaults/%.h,%,\
306                      $(wildcard config/defaults/*.h))
307 archs :
308         @$(ECHO) $(ARCHS)
309
310 platforms :
311         @$(ECHO) $(PLATFORMS)
312
313 ifdef BIN
314
315 # Split $(BIN) into architecture, platform, and security flag (where present)
316 BIN_ELEMENTS    := $(subst -,$(SPACE),$(BIN))
317 BIN_APS         := $(wordlist 2,4,$(BIN_ELEMENTS))
318 ifeq ($(lastword $(BIN_APS)),sb)
319 BIN_AP          := $(wordlist 2,$(words $(BIN_APS)),discard $(BIN_APS))
320 BIN_SECUREBOOT  := 1
321 else
322 BIN_AP          := $(BIN_APS)
323 BIN_SECUREBOOT  := 0
324 endif
325 BIN_PLATFORM    := $(lastword $(BIN_AP))
326 BIN_ARCH        := $(wordlist 2,$(words $(BIN_AP)),discard $(BIN_AP))
327
328 # Determine build architecture
329 DEFAULT_ARCH    := i386
330 ARCH            := $(firstword $(BIN_ARCH) $(DEFAULT_ARCH))
331 CFLAGS          += -DARCH=$(ARCH)
332 arch :
333         @$(ECHO) $(ARCH)
334 .PHONY : arch
335
336 # Determine build platform
337 DEFAULT_PLATFORM := pcbios
338 PLATFORM        := $(firstword $(BIN_PLATFORM) $(DEFAULT_PLATFORM))
339 CFLAGS          += -DPLATFORM=$(PLATFORM)
340 platform :
341         @$(ECHO) $(PLATFORM)
342
343 # Determine security flag
344 DEFAULT_SECUREBOOT := 0
345 SECUREBOOT      := $(firstword $(BIN_SECUREBOOT) $(DEFAULT_SECUREBOOT))
346 CFLAGS          += -DSECUREBOOT=$(SECUREBOOT)
347 secureboot :
348         @$(ECHO) $(SECUREBOOT)
349
350 endif # defined(BIN)
351
352 # Include architecture-specific Makefile
353 ifdef ARCH
354 MAKEDEPS        += arch/$(ARCH)/Makefile
355 include arch/$(ARCH)/Makefile
356 endif
357
358 # Include architecture-specific include path
359 ifdef ARCH
360 INCDIRS         += arch/$(ARCH)/include
361 INCDIRS         += arch/$(ARCH)/include/$(PLATFORM)
362 endif
363
364 ###############################################################################
365 #
366 # Source file handling
367
368 # Exclude known-insecure files from Secure Boot builds
369 ifeq ($(SECUREBOOT),0)
370 SRCDIRS         += $(SRCDIRS_INSEC)
371 endif
372
373 # SRCDIRS lists all directories containing source files.
374 srcdirs :
375         @$(ECHO) $(SRCDIRS)
376
377 # SRCS lists all .c or .S files found in any SRCDIR
378 #
379 SRCS    += $(wildcard $(patsubst %,%/*.c,$(SRCDIRS)))
380 SRCS    += $(wildcard $(patsubst %,%/*.S,$(SRCDIRS)))
381 srcs :
382         @$(ECHO) $(SRCS)
383
384 # AUTO_SRCS lists all files in SRCS that are not mentioned in
385 # NON_AUTO_SRCS.  Files should be added to NON_AUTO_SRCS if they
386 # cannot be built using the standard build template.
387 #
388 AUTO_SRCS = $(filter-out $(NON_AUTO_SRCS),$(SRCS))
389 autosrcs :
390         @$(ECHO) $(AUTO_SRCS)
391
392 # Just about everything else in this section depends upon having
393 # $(BIN) set
394
395 ifdef BIN
396
397 # INCDIRS lists the include path
398 incdirs :
399         @$(ECHO) $(INCDIRS)
400
401 # Common flags
402 #
403 CFLAGS          += $(foreach INC,$(INCDIRS),-I$(INC))
404 CFLAGS          += -Os
405 CFLAGS          += -g
406 ifeq ($(CCTYPE),gcc)
407 CFLAGS          += -ffreestanding
408 CFLAGS          += -Wall -W -Wformat-nonliteral
409 HOST_CFLAGS     += -Wall -W -Wformat-nonliteral
410 endif
411 ifeq ($(CCTYPE),icc)
412 CFLAGS          += -fno-builtin
413 CFLAGS          += -no-ip
414 CFLAGS          += -no-gcc
415 CFLAGS          += -diag-disable 111 # Unreachable code
416 CFLAGS          += -diag-disable 128 # Unreachable loop
417 CFLAGS          += -diag-disable 170 # Array boundary checks
418 CFLAGS          += -diag-disable 177 # Unused functions
419 CFLAGS          += -diag-disable 181 # printf() format checks
420 CFLAGS          += -diag-disable 188 # enum strictness
421 CFLAGS          += -diag-disable 193 # Undefined preprocessor identifiers
422 CFLAGS          += -diag-disable 280 # switch ( constant )
423 CFLAGS          += -diag-disable 310 # K&R parameter lists
424 CFLAGS          += -diag-disable 424 # Extra semicolon
425 CFLAGS          += -diag-disable 589 # Declarations mid-code
426 CFLAGS          += -diag-disable 593 # Unused variables
427 CFLAGS          += -diag-disable 810 # Casting ints to smaller ints
428 CFLAGS          += -diag-disable 981 # Sequence point violations
429 CFLAGS          += -diag-disable 1292 # Ignored attributes
430 CFLAGS          += -diag-disable 1338 # void pointer arithmetic
431 CFLAGS          += -diag-disable 1361 # Variable-length arrays
432 CFLAGS          += -diag-disable 1418 # Missing prototypes
433 CFLAGS          += -diag-disable 1419 # Missing prototypes
434 CFLAGS          += -diag-disable 1599 # Hidden variables
435 CFLAGS          += -Wall -Wmissing-declarations
436 endif
437 CFLAGS          += $(WORKAROUND_CFLAGS) $(EXTRA_CFLAGS)
438 ASFLAGS         += $(WORKAROUND_ASFLAGS) $(EXTRA_ASFLAGS)
439 LDFLAGS         += $(WORKAROUND_LDFLAGS) $(EXTRA_LDFLAGS)
440 HOST_CFLAGS     += -O2 -g
441
442 # Inhibit -Werror if NO_WERROR is specified on make command line
443 #
444 ifneq ($(NO_WERROR),1)
445 CFLAGS          += -Werror
446 ASFLAGS         += --fatal-warnings
447 HOST_CFLAGS     += -Werror
448 endif
449
450 # Function trace recorder state in the last build.  This is needed
451 # in order to correctly rebuild whenever the function recorder is
452 # enabled/disabled.
453 #
454 FNREC_STATE     := $(BIN)/.fnrec.state
455 ifeq ($(wildcard $(FNREC_STATE)),)
456 FNREC_OLD       := <invalid>
457 else
458 FNREC_OLD       := $(shell cat $(FNREC_STATE))
459 endif
460 ifeq ($(FNREC_OLD),$(FNREC))
461 $(FNREC_STATE) :
462 else
463 $(FNREC_STATE) : clean
464 $(shell $(ECHO) "$(FNREC)" > $(FNREC_STATE))
465 endif
466
467 VERYCLEANUP     += $(FNREC_STATE)
468 MAKEDEPS        += $(FNREC_STATE)
469
470 ifeq ($(FNREC),1)
471 # Enabling -finstrument-functions affects gcc's analysis and leads to spurious
472 # warnings about use of uninitialised variables.
473 #
474 CFLAGS          += -Wno-uninitialized
475 CFLAGS          += -finstrument-functions
476 CFLAGS          += -finstrument-functions-exclude-file-list=core/fnrec.c
477 endif
478
479 # Enable per-item sections and section garbage collection.  Note that
480 # some older versions of gcc support -fdata-sections but treat it as
481 # implying -fno-common, which would break our build.  Some other older
482 # versions issue a spurious and uninhibitable warning if
483 # -ffunction-sections is used with -g, which would also break our
484 # build since we use -Werror.
485 #
486 ifeq ($(CCTYPE),gcc)
487 DS_TEST         = $(ECHO) 'char x;' | \
488                   $(CC) -fdata-sections -S -x c - -o - 2>/dev/null | \
489                   grep -E '\.comm' > /dev/null
490 DS_FLAGS        := $(shell $(DS_TEST) && $(ECHO) '-fdata-sections')
491 FS_TEST         = $(CC) -ffunction-sections -g -c -x c /dev/null \
492                   -o /dev/null 2>/dev/null
493 FS_FLAGS        := $(shell $(FS_TEST) && $(ECHO) '-ffunction-sections')
494 CFLAGS          += $(FS_FLAGS) $(DS_FLAGS)
495 endif
496 LDFLAGS         += --gc-sections
497
498 # Force creation of static binaries (required for OpenBSD, does no
499 # harm on other platforms).
500 #
501 LDFLAGS         += -static
502
503 # compiler.h is needed for our linking and debugging system
504 #
505 CFLAGS          += -include include/compiler.h
506
507 # The section type character (e.g. "@" in "@progbits") varies by
508 # architecture.
509 #
510 CFLAGS          += -DASM_TCHAR='$(ASM_TCHAR)' -DASM_TCHAR_OPS='$(ASM_TCHAR_OPS)'
511
512 # CFLAGS for specific object types
513 #
514 CFLAGS_c        +=
515 CFLAGS_S        += -DASSEMBLY
516
517 # Base object name of the current target
518 #
519 OBJECT          = $(firstword $(subst ., ,$(@F)))
520
521 # CFLAGS for specific object files.  You can define
522 # e.g. CFLAGS_rtl8139, and have those flags automatically used when
523 # compiling bin/rtl8139.o.
524 #
525 OBJ_CFLAGS      = $(CFLAGS_$(OBJECT)) -DOBJECT=$(subst -,_,$(OBJECT))
526 $(BIN)/%.flags :
527         @$(ECHO) $(OBJ_CFLAGS)
528
529 # ICC requires postprocessing objects to fix up table alignments
530 #
531 ifeq ($(CCTYPE),icc)
532 POST_O          = && $(ICCFIX) $@
533 POST_O_DEPS     := $(ICCFIX)
534 else
535 POST_O          :=
536 POST_O_DEPS     :=
537 endif
538
539 # Debug level calculations
540 #
541 DBGLVL_MAX      = -DDBGLVL_MAX=$(firstword $(subst ., ,$(1)))
542 DBGLVL_DFLT     = -DDBGLVL_DFLT=$(lastword $(subst ., ,$(1)))
543 DBGLVL          = $(call DBGLVL_MAX,$(1)) $(call DBGLVL_DFLT,$(1))
544
545 # Rules for specific object types.
546 #
547 COMPILE_c       = $(CC) $(CFLAGS) $(CFLAGS_c) $(OBJ_CFLAGS)
548 RULE_c          = $(Q)$(COMPILE_c) -c $< -o $@ $(POST_O)
549 RULE_c_to_ids.o = $(Q)$(ECHO_E) '$(OBJ_IDS_ASM_NL)' | $(ASSEMBLE_S) -o $@
550 RULE_c_to_dbg%.o= $(Q)$(COMPILE_c) $(call DBGLVL,$*) -c $< -o $@ $(POST_O)
551 RULE_c_to_c     = $(Q)$(COMPILE_c) -E -c $< > $@
552 RULE_c_to_s     = $(Q)$(COMPILE_c) -S -g0 -c $< -o $@
553
554 PREPROCESS_S    = $(CPP) $(CFLAGS) $(CFLAGS_S) $(OBJ_CFLAGS)
555 ASSEMBLE_S      = $(AS) $(ASFLAGS)
556 RULE_S          = $(Q)$(PREPROCESS_S) $< | $(ASSEMBLE_S) -o $@
557 RULE_S_to_dbg%.o= $(Q)$(PREPROCESS_S) $(call DBGLVL,$*) $< | $(ASSEMBLE_S) -o $@
558 RULE_S_to_s     = $(Q)$(PREPROCESS_S) $< > $@
559
560 GENERIC_TARGETS += ids.o dbg%.o c s
561
562 # List of embedded images included in the last build of embedded.o.
563 # This is needed in order to correctly rebuild embedded.o whenever the
564 # list of objects changes.
565 #
566 EMBED           := $(EMBEDDED_IMAGE) # Maintain backwards compatibility
567 EMBEDDED_LIST   := $(BIN)/.embedded.list
568 ifeq ($(wildcard $(EMBEDDED_LIST)),)
569 EMBED_OLD := <invalid>
570 else
571 EMBED_OLD := $(shell cat $(EMBEDDED_LIST))
572 endif
573 ifneq ($(EMBED_OLD),$(EMBED))
574 $(shell $(ECHO) "$(EMBED)" > $(EMBEDDED_LIST))
575 endif
576
577 $(EMBEDDED_LIST) : $(MAKEDEPS)
578
579 VERYCLEANUP     += $(EMBEDDED_LIST)
580
581 EMBEDDED_FILES  := $(subst $(COMMA), ,$(EMBED))
582 EMBED_ALL       := $(foreach i,$(call seq,1,$(words $(EMBEDDED_FILES))),\
583                      EMBED ( $(i), \"$(word $(i), $(EMBEDDED_FILES))\",\
584                              \"$(notdir $(word $(i),$(EMBEDDED_FILES)))\" ))
585
586 embedded_DEPS += $(EMBEDDED_FILES) $(EMBEDDED_LIST)
587
588 CFLAGS_embedded = -DEMBED_ALL="$(EMBED_ALL)"
589
590 # List of trusted root certificates
591 #
592 TRUSTED_LIST    := $(BIN)/.trusted.list
593 ifeq ($(wildcard $(TRUSTED_LIST)),)
594 TRUST_OLD := <invalid>
595 else
596 TRUST_OLD := $(shell cat $(TRUSTED_LIST))
597 endif
598 ifneq ($(TRUST_OLD),$(TRUST))
599 $(shell $(ECHO) "$(TRUST)" > $(TRUSTED_LIST))
600 endif
601
602 $(TRUSTED_LIST) : $(MAKEDEPS)
603
604 VERYCLEANUP     += $(TRUSTED_LIST)
605
606 # Trusted root certificate fingerprints
607 #
608 TRUSTED_CERTS   := $(subst $(COMMA), ,$(TRUST))
609 TRUSTED_FPS     := $(foreach CERT,$(TRUSTED_CERTS),\
610                      0x$(subst :,$(COMMA) 0x,$(lastword $(subst =, ,\
611                          $(shell $(OPENSSL) x509 -in $(CERT) -noout -sha256 \
612                                  -fingerprint))))$(COMMA))
613
614 rootcert_DEPS += $(TRUSTED_FILES) $(TRUSTED_LIST)
615
616 CFLAGS_rootcert = $(if $(TRUSTED_FPS),-DTRUSTED="$(TRUSTED_FPS)")
617
618 # List of embedded certificates
619 #
620 CERT_LIST := $(BIN)/.certificate.list
621 ifeq ($(wildcard $(CERT_LIST)),)
622 CERT_OLD := <invalid>
623 else
624 CERT_OLD := $(shell cat $(CERT_LIST))
625 endif
626 ifneq ($(CERT_OLD),$(CERT))
627 $(shell $(ECHO) "$(CERT)" > $(CERT_LIST))
628 endif
629
630 $(CERT_LIST) : $(MAKEDEPS)
631
632 VERYCLEANUP += $(CERT_LIST)
633
634 # Embedded certificates concatenated and then split into one file per
635 # certificate (even if original files contained certificate chains)
636 #
637 CERT_FILES := $(subst $(COMMA), ,$(CERT))
638 CERT_CONCAT := $(BIN)/.certificates.pem
639
640 ifneq ($(CERT),)
641
642 CERT_COUNT := $(shell grep "BEGIN CERTIFICATE" $(CERT_FILES) | wc -l)
643
644 $(CERT_CONCAT) : $(CERT_FILES) $(CERT_LIST)
645         $(Q)cat $(CERT_FILES) > $@
646
647 # We must use an (otherwise unnecessary) pattern rule here to encode
648 # the fact that one "csplit" command generates multiple targets
649 CERT_PEMS := $(foreach i,$(call seq,1,$(CERT_COUNT)),\
650                $(BIN)/.certificate.pem.$(i))
651 $(subst .pem.,.%.,$(CERT_PEMS)) : $(BIN)/.certificates.%
652         $(Q)$(CSPLIT) -q -n 1 -f $(BIN)/.certificate.pem. $< \
653                 '/BEGIN CERTIFICATE/' '{*}'
654
655 CERT_DERS := $(subst .certificate.pem.,.certificate.der.,$(CERT_PEMS))
656 $(BIN)/.certificate.der.% : $(BIN)/.certificate.pem.%
657         $(Q)$(OPENSSL) x509 -in $< -outform DER -out $@
658
659 CERT_ALL := $(foreach i,$(call seq,1,$(CERT_COUNT)),\
660               CERT ( $(i), \"$(word $(i),$(CERT_DERS))\" ))
661
662 endif
663
664 certstore_DEPS += $(CERT_LIST) $(CERT_FILES) $(CERT_PEMS) $(CERT_DERS)
665
666 CFLAGS_certstore += -DCERT_ALL="$(CERT_ALL)"
667
668 CLEANUP += $(BIN)/.certificate.* $(BIN)/.certificates.*
669
670 # (Single-element) list of private keys
671 #
672 ifdef KEY
673 PRIVKEY := $(KEY) # Maintain backwards compatibility
674 endif
675 PRIVKEY_LIST := $(BIN)/.private_key.list
676 ifeq ($(wildcard $(PRIVKEY_LIST)),)
677 PRIVKEY_OLD := <invalid>
678 else
679 PRIVKEY_OLD := $(shell cat $(PRIVKEY_LIST))
680 endif
681 ifneq ($(PRIVKEY_OLD),$(PRIVKEY))
682 $(shell $(ECHO) "$(PRIVKEY)" > $(PRIVKEY_LIST))
683 endif
684
685 $(PRIVKEY_LIST) : $(MAKEDEPS)
686
687 VERYCLEANUP += $(PRIVKEY_LIST)
688
689 # Embedded private key
690 #
691 PRIVKEY_INC := $(BIN)/.private_key.der
692
693 ifdef PRIVKEY
694 $(PRIVKEY_INC) : $(PRIVKEY) $(PRIVKEY_LIST)
695         $(Q)$(OPENSSL) rsa -in $< -outform DER -out $@
696
697 privkey_DEPS += $(PRIVKEY_INC)
698 endif
699
700 CLEANUP += $(BIN)/.private_key.*
701
702 privkey_DEPS += $(PRIVKEY_LIST)
703
704 CFLAGS_privkey += $(if $(PRIVKEY),-DPRIVATE_KEY="\"$(PRIVKEY_INC)\"")
705
706 # (Single-element) list of named configurations
707 #
708 CONFIG_LIST := $(BIN)/.config.list
709 ifeq ($(wildcard $(CONFIG_LIST)),)
710 CONFIG_OLD := <invalid>
711 else
712 CONFIG_OLD := $(shell cat $(CONFIG_LIST))
713 endif
714 ifneq ($(CONFIG_OLD),$(CONFIG))
715 $(shell $(ECHO) "$(CONFIG)" > $(CONFIG_LIST))
716 endif
717
718 $(CONFIG_LIST) : $(MAKEDEPS)
719
720 VERYCLEANUP += $(CONFIG_LIST)
721
722 # Named configurations
723 #
724 ifneq ($(CONFIG),)
725 ifneq ($(wildcard config/$(CONFIG)),)
726 CFLAGS  += -DCONFIG=$(CONFIG)
727 endif
728 CFLAGS  += -DLOCAL_CONFIG=$(CONFIG)
729 endif
730
731 config/named.h : $(CONFIG_LIST)
732         $(Q)$(TOUCH) $@
733
734 .PRECIOUS : config/named.h
735
736 # (Single-element) list of assertion configuration
737 #
738 ASSERT_LIST := $(BIN)/.assert.list
739 ifeq ($(wildcard $(ASSERT_LIST)),)
740 ASSERT_OLD := <invalid>
741 else
742 ASSERT_OLD := $(shell cat $(ASSERT_LIST))
743 endif
744 ifneq ($(ASSERT_OLD),$(ASSERT))
745 $(shell $(ECHO) "$(ASSERT)" > $(ASSERT_LIST))
746 endif
747
748 $(ASSERT_LIST) : $(MAKEDEPS)
749
750 VERYCLEANUP += $(ASSERT_LIST)
751
752 # Assertion configuration
753 #
754 ifneq ($(ASSERT),)
755 CFLAGS  += -DASSERTING=$(ASSERT)
756 endif
757
758 include/assert.h : $(ASSERT_LIST)
759         $(Q)$(TOUCH) $@
760
761 .PRECIOUS : include/assert.h
762
763 # (Single-element) list of profiling configuration
764 #
765 PROFILE_LIST := $(BIN)/.profile.list
766 ifeq ($(wildcard $(PROFILE_LIST)),)
767 PROFILE_OLD := <invalid>
768 else
769 PROFILE_OLD := $(shell cat $(PROFILE_LIST))
770 endif
771 ifneq ($(PROFILE_OLD),$(PROFILE))
772 $(shell $(ECHO) "$(PROFILE)" > $(PROFILE_LIST))
773 endif
774
775 $(PROFILE_LIST) : $(MAKEDEPS)
776
777 VERYCLEANUP += $(PROFILE_LIST)
778
779 # Profiling configuration
780 #
781 ifneq ($(PROFILE),)
782 CFLAGS  += -DPROFILING=$(PROFILE)
783 endif
784
785 include/ipxe/profile.h : $(PROFILE_LIST)
786         $(Q)$(TOUCH) $@
787
788 .PRECIOUS : include/ipxe/profile.h
789
790 # These files use .incbin inline assembly to include a binary file.
791 # Unfortunately ccache does not detect this dependency and caches
792 # builds even when the binary file has changed.
793 #
794 $(BIN)/embedded.% : override CC := env CCACHE_DISABLE=1 $(CC)
795 $(BIN)/certstore.% : override CC := env CCACHE_DISABLE=1 $(CC)
796 $(BIN)/privkey.% : override CC := env CCACHE_DISABLE=1 $(CC)
797
798 # Debug message autocolourisation range
799 #
800 DBGCOL_LIST     := $(BIN)/.dbgcol.list
801 ifeq ($(wildcard $(DBGCOL_LIST)),)
802 DBGCOL_OLD := <invalid>
803 else
804 DBGCOL_OLD := $(shell cat $(DBGCOL_LIST))
805 endif
806 ifneq ($(DBGCOL_OLD),$(DBGCOL))
807 $(shell $(ECHO) "$(DBGCOL)" > $(DBGCOL_LIST))
808 endif
809
810 $(DBGCOL_LIST) : $(MAKEDEPS)
811
812 VERYCLEANUP += $(DBGCOL_LIST)
813
814 DBGCOL_COLOURS := $(subst -, ,$(DBGCOL))
815 DBGCOL_MIN := $(firstword $(DBGCOL_COLOURS))
816 DBGCOL_MAX := $(lastword $(DBGCOL_COLOURS))
817
818 debug_DEPS += $(DBGCOL_LIST)
819
820 CFLAGS_debug += $(if $(DBGCOL_MIN),-DDBGCOL_MIN=$(DBGCOL_MIN))
821 CFLAGS_debug += $(if $(DBGCOL_MAX),-DDBGCOL_MAX=$(DBGCOL_MAX))
822
823 # We automatically generate rules for any file mentioned in AUTO_SRCS
824 # using the following set of templates.  We use $(eval ...) if
825 # available, otherwise we generate separate Makefile fragments and
826 # include them.
827
828 # deps_template : generate dependency list for a given source file
829 #
830 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
831 #
832 define deps_template_file
833 $(call deps_template_parts,$(1),$(subst .,,$(suffix $(1))),$(basename $(notdir $(1))))
834 endef
835 #
836 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
837 # $(2) is the source type (e.g. "c")
838 # $(3) is the source base name (e.g. "rtl8139")
839 #
840 define deps_template_parts
841         @$(ECHO) "  [DEPS] $(1)"
842         @$(MKDIR) -p $(BIN)/deps/$(dir $(1))
843         $(Q)$(CPP) $(CFLAGS) $(CFLAGS_$(2)) $(CFLAGS_$(3)) -DOBJECT=$(3) \
844                 -Wno-error -M $(1) -MG -MP | \
845                 sed 's/\.o\s*:/_DEPS +=/' > $(BIN)/deps/$(1).d
846 endef
847
848 # rules_template : generate rules for a given source file
849 #
850 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
851 #
852 define rules_template
853 $(call rules_template_parts,$(1),$(subst .,,$(suffix $(1))),$(basename $(notdir $(1))))
854 endef
855 #
856 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
857 # $(2) is the source type (e.g. "c")
858 # $(3) is the source base name (e.g. "rtl8139")
859 #
860 define rules_template_parts
861 $$(BIN)/$(3).o : $(1) $$(MAKEDEPS) $$(POST_O_DEPS) $$($(3)_DEPS)
862         $$(QM)$(ECHO) "  [BUILD] $$@"
863         $$(RULE_$(2))
864 BOBJS += $$(BIN)/$(3).o
865 $(foreach TGT,$(GENERIC_TARGETS),$(if $(RULE_$(2)_to_$(TGT)),$(NEWLINE)$(call rules_template_target,$(1),$(2),$(3),$(TGT))))
866 $$(BIN)/deps/$(1).d : $$($(3)_DEPS)
867 TAGS : $$($(3)_DEPS)
868 endef
869 #
870 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
871 # $(2) is the source type (e.g. "c")
872 # $(3) is the source base name (e.g. "rtl8139")
873 # $(4) is the destination type (e.g. "dbg%.o")
874 #
875 define rules_template_target
876 $$(BIN)/$(3).$(4) : $(1) $$(MAKEDEPS) $$(POST_O_DEPS) $$($(3)_DEPS)
877         $$(QM)$(ECHO) "  [BUILD] $$@"
878         $$(RULE_$(2)_to_$(4))
879 $(TGT)_OBJS += $$(BIN)/$(3).$(4)
880 endef
881 #
882 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
883 #
884 define rules_template_file
885         @$(ECHO) "  [RULES] $(1)"
886         @$(MKDIR) -p $(BIN)/rules/$(dir $(1))
887         @$(ECHO_E) '$(subst $(NEWLINE),\n,$(call rules_template,$(1)))' \
888                  > $(BIN)/rules/$(1).r
889 endef
890
891 # Generate the dependency files
892 #
893 $(BIN)/deps/%.d : % $(MAKEDEPS)
894         $(call deps_template_file,$<)
895
896 # Calculate list of dependency files
897 #
898 AUTO_DEPS       = $(patsubst %,$(BIN)/deps/%.d,$(AUTO_SRCS))
899 autodeps :
900         @$(ECHO) $(AUTO_DEPS)
901 VERYCLEANUP     += $(BIN)/deps
902
903 # Include dependency files
904 #
905 ifdef NEED_DEPS
906 ifneq ($(AUTO_DEPS),)
907 -include $(AUTO_DEPS)
908 endif
909 endif
910
911 # Generate the rules files
912 #
913 $(BIN)/rules/%.r : % $(MAKEDEPS)
914         $(call rules_template_file,$<)
915
916 # Calculate list of rules files
917 #
918 AUTO_RULES      = $(patsubst %,$(BIN)/rules/%.r,$(AUTO_SRCS))
919 autorules :
920         @$(ECHO) $(AUTO_RULES)
921 VERYCLEANUP     += $(BIN)/rules
922
923 # Evaluate rules (or include rules files)
924 #
925 ifdef NEED_DEPS
926 ifneq ($(AUTO_RULES),)
927 ifneq ($(HAVE_EVAL),)
928 $(foreach SRC,$(AUTO_SRCS),$(eval $(call rules_template,$(SRC))))
929 else
930 -include $(AUTO_RULES)
931 endif
932 endif
933 endif
934
935 # Files to be parsed using parserom.pl
936 #
937 ROM_SRCS        = $(foreach SRC,$(AUTO_SRCS),\
938                     $(if $(findstring drivers/,$(SRC)),$(SRC)))
939 romsrcs :
940         @$(ECHO) $(ROM_SRCS)
941
942 # List of files to be parsed using parserom.pl
943 #
944 ROM_SRCS_LIST   := $(BIN)/.rom.list
945 ifeq ($(wildcard $(ROM_SRCS_LIST)),)
946 ROM_SRCS_OLD := <invalid>
947 else
948 ROM_SRCS_OLD := $(shell cat $(ROM_SRCS_LIST))
949 endif
950 ifneq ($(ROM_SRCS_OLD),$(ROM_SRCS))
951 $(shell $(ECHO) "$(ROM_SRCS)" > $(ROM_SRCS_LIST))
952 endif
953
954 $(ROM_SRCS_LIST) : $(MAKEDEPS)
955
956 VERYCLEANUP     += $(ROM_SRCS_LIST)
957
958 # ROM definition file
959 #
960 ROMDEFS         = $(BIN)/.rom.defs
961 $(ROMDEFS) : $(ROM_SRCS) $(ROM_SRCS_LIST) $(PARSEROM) $(MAKEDEPS)
962         $(QM)$(ECHO) "  [PARSEROM]"
963         $(Q)$(PERL) $(PARSEROM) $(ROM_SRCS) > $@
964
965 VERYCLEANUP     += $(ROMDEFS)
966
967 # Evaluate ROM definition file
968 ifdef NEED_DEPS
969 ifneq ($(ROM_SRCS),)
970 -include $(ROMDEFS)
971 endif
972 endif
973
974 # Device ID tables (using IDs from ROM definition file)
975 #
976 define obj_pci_id_asm
977         .section ".pci_devlist.$(1)", "a", $(ASM_TCHAR)progbits
978         .globl pci_devlist_$(1)
979 pci_devlist_$(1):
980         .short ( 0x$(1) & 0xffff )
981
982 endef
983 define obj_isa_id_asm
984 endef
985 OBJ_IDS_ASM     = $(foreach ROM,$(ROMS_$(OBJECT)),$(call obj_$(ROM_TYPE_$(ROM))_id_asm,$(ROM)))
986 OBJ_IDS_ASM_NL  = $(subst $(NEWLINE),\n,$(OBJ_IDS_ASM))
987 $(BIN)/%.ids :
988         @$(ECHO_E) '$(OBJ_IDS_ASM_NL)'
989
990 BOBJS   += $(patsubst %,$(BIN)/%.ids.o,$(DRIVERS))
991
992 # The following variables are created by the autogenerated rules
993 #
994 bobjs :
995         @$(ECHO) $(BOBJS)
996 drivers_% :
997         @$(ECHO) $(DRIVERS_$*)
998 drivers :
999         @$(ECHO) $(DRIVERS)
1000 .PHONY : drivers
1001 roms :
1002         @$(ECHO) $(ROMS)
1003
1004 # Generate error usage information
1005 #
1006 $(BIN)/%.einfo : $(BIN)/%.o
1007         $(QM)$(ECHO) "  [EINFO] $@"
1008         $(Q)$(OBJCOPY) -O binary -j .einfo --set-section-flags .einfo=alloc \
1009                 $< $@
1010
1011 EINFOS          := $(patsubst $(BIN)/%.o,$(BIN)/%.einfo,$(BOBJS))
1012 $(BIN)/errors : $(EINFOS) $(EINFO)
1013         $(QM)$(ECHO) "  [EINFO] $@"
1014         $(Q)$(EINFO) $(EINFOS) | sort > $@
1015 CLEANUP         += $(BIN)/errors        # Doesn't match the $(BIN)/*.* pattern
1016
1017 # Generate the NIC file from the parsed source files.  The NIC file is
1018 # only for rom-o-matic.
1019 #
1020 $(BIN)/NIC : $(AUTO_DEPS)
1021         @$(ECHO) '# This is an automatically generated file, do not edit' > $@
1022         @$(ECHO) '# It does not affect anything in the build, ' \
1023              'it is only for rom-o-matic' >> $@
1024         @$(ECHO) >> $@
1025         @perl -ne 'chomp; print "$$1\n" if /\# NIC\t(.*)$$/' $^ >> $@
1026 CLEANUP         += $(BIN)/NIC   # Doesn't match the $(BIN)/*.* pattern
1027
1028 # Select drivers to be included in the all-drivers build
1029 #
1030 DRIVERS_ipxe    = $(DRIVERS_net) $(DRIVERS_infiniband) \
1031                   $(DRIVERS_xen) $(DRIVERS_hyperv)
1032
1033 # Analyse a target name (e.g. "bin/dfe538--prism2_pci.rom.tmp") and
1034 # derive the variables:
1035
1036 # TGT_ELEMENTS : the elements of the target (e.g. "dfe538 prism2_pci")
1037 # TGT_PREFIX   : the prefix type (e.g. "pcirom")
1038 # TGT_DRIVERS  : the driver for each element (e.g. "rtl8139 prism2_pci")
1039 # TGT_ROM_NAME : the ROM name (e.g. "dfe538")
1040 #
1041 TGT_ELEMENTS    = $(subst --, ,$(firstword $(subst ., ,$(notdir $@))))
1042 TGT_ROM_NAME    = $(firstword $(TGT_ELEMENTS))
1043 TGT_DRIVERS     = $(strip $(foreach TGT_ELEMENT,$(TGT_ELEMENTS), \
1044                                     $(if $(DRIVERS_$(TGT_ELEMENT)), \
1045                                          $(DRIVERS_$(TGT_ELEMENT)), \
1046                                          $(firstword $(DRIVER_$(TGT_ELEMENT)) \
1047                                                      $(TGT_ELEMENT)))))
1048 TGT_PREFIX_NAME = $(word 2,$(subst ., ,$(notdir $@)))
1049 TGT_PREFIX      = $(strip $(if $(filter rom,$(TGT_PREFIX_NAME)), \
1050                                $(ROM_TYPE_$(TGT_ROM_NAME))rom, \
1051                                $(TGT_PREFIX_NAME)))
1052
1053 # Look up ROM IDs for the current target
1054 # (e.g. "bin/dfe538--prism2_pci.rom.tmp") and derive the variables:
1055 #
1056 # TGT_PCI_VENDOR : the PCI vendor ID (e.g. "0x1186")
1057 # TGT_PCI_DEVICE : the PCI device ID (e.g. "0x1300")
1058 #
1059 TGT_PCI_VENDOR  = $(PCI_VENDOR_$(TGT_ROM_NAME))
1060 TGT_PCI_DEVICE  = $(PCI_DEVICE_$(TGT_ROM_NAME))
1061
1062 # Calculate link-time options for the current target
1063 # (e.g. "bin/dfe538--prism2_pci.rom.tmp") and derive the variables:
1064 #
1065 # TGT_LD_DRIVERS : symbols to require in order to drag in the relevant drivers
1066 #                  (e.g. "obj_rtl8139 obj_prism2_pci")
1067 # TGT_LD_IDS :     symbols to define in order to fill in ID structures in the
1068 #                  ROM header (e.g."pci_vendor_id=0x1186 pci_device_id=0x1300")
1069 #
1070 TGT_LD_DRIVERS  = $(subst -,_,$(patsubst %,obj_%,$(TGT_DRIVERS)))
1071 TGT_LD_IDS      = pci_vendor_id=$(firstword $(TGT_PCI_VENDOR) 0) \
1072                   pci_device_id=$(firstword $(TGT_PCI_DEVICE) 0)
1073 TGT_LD_DEVLIST  = $(foreach ELEM,$(TGT_ELEMENTS),$(if $(PCI_VENDOR_$(ELEM)),\
1074                     pci_devlist_$(patsubst 0x%,%,$(PCI_VENDOR_$(ELEM)))$(patsubst 0x%,%,$(PCI_DEVICE_$(ELEM)))))
1075 TGT_LD_ENTRY    = _$(TGT_PREFIX)_start
1076
1077 # Calculate linker flags based on link-time options for the current
1078 # target type (e.g. "bin/dfe538--prism2_pci.rom.tmp") and derive the
1079 # variables:
1080 #
1081 # TGT_LD_FLAGS : target-specific flags to pass to linker (e.g.
1082 #                "-u obj_zpciprefix -u obj_rtl8139 -u obj_prism2_pci
1083 #                 --defsym pci_vendor=0x1186 --defsym pci_device=0x1300")
1084 #
1085 TGT_LD_FLAGS    = $(foreach SYM,$(TGT_LD_ENTRY) $(TGT_LD_DRIVERS) \
1086                     $(TGT_LD_DEVLIST) obj_config obj_config_$(PLATFORM),\
1087                     -u $(SYM) --defsym check_$(SYM)=$(SYM) ) \
1088                   $(patsubst %,--defsym %,$(TGT_LD_IDS)) \
1089                   -e $(TGT_LD_ENTRY)
1090
1091 # Calculate list of debugging versions of objects to be included in
1092 # the target.
1093 #
1094 DEBUG_LIST      = $(subst $(COMMA), ,$(DEBUG))
1095 DEBUG_MAX       = $(firstword $(word 2,$(subst :, ,$(1))) 1)
1096 DEBUG_DFLT      = $(if $(word 3,$(subst :, ,$(1))),.$(word 3,$(subst :, ,$(1))))
1097 DEBUG_LEVEL     = $(call DEBUG_MAX,$(1))$(call DEBUG_DFLT,$(1))
1098 DEBUG_BASE      = $(firstword $(subst :, ,$(1))).dbg$(call DEBUG_LEVEL,$(1))
1099 DEBUG_OBJ       = $(BIN)/$(call DEBUG_BASE,$(1)).o
1100 DEBUG_ORIG_OBJ  = $(BIN)/$(firstword $(subst :, ,$(1))).o
1101 DEBUG_OBJS      = $(foreach D,$(DEBUG_LIST),$(call DEBUG_OBJ,$(D)))
1102 DEBUG_ORIG_OBJS = $(foreach D,$(DEBUG_LIST),$(call DEBUG_ORIG_OBJ,$(D)))
1103 BLIB_OBJS       = $(DEBUG_OBJS) $(filter-out $(DEBUG_ORIG_OBJS),$(BOBJS))
1104
1105 # Print out all derived information for a given target.
1106 #
1107 $(BIN)/%.info :
1108         @$(ECHO) 'Elements             : $(TGT_ELEMENTS)'
1109         @$(ECHO) 'Prefix               : $(TGT_PREFIX)'
1110         @$(ECHO) 'Drivers              : $(TGT_DRIVERS)'
1111         @$(ECHO) 'ROM name             : $(TGT_ROM_NAME)'
1112         @$(ECHO)
1113         @$(ECHO) 'PCI vendor           : $(TGT_PCI_VENDOR)'
1114         @$(ECHO) 'PCI device           : $(TGT_PCI_DEVICE)'
1115         @$(ECHO)
1116         @$(ECHO) 'LD driver symbols    : $(TGT_LD_DRIVERS)'
1117         @$(ECHO) 'LD ID symbols        : $(TGT_LD_IDS)'
1118         @$(ECHO) 'LD devlist symbols   : $(TGT_LD_DEVLIST)'
1119         @$(ECHO) 'LD entry point       : $(TGT_LD_ENTRY)'
1120         @$(ECHO)
1121         @$(ECHO) 'LD target flags      : $(TGT_LD_FLAGS)'
1122         @$(ECHO)
1123         @$(ECHO) 'Debugging objects    : $(DEBUG_OBJS)'
1124         @$(ECHO) 'Replaced objects     : $(DEBUG_ORIG_OBJS)'
1125
1126 # List of objects included in the last build of blib.  This is needed
1127 # in order to correctly rebuild blib whenever the list of objects
1128 # changes.
1129 #
1130 BLIB_LIST       := $(BIN)/.blib.list
1131 ifeq ($(wildcard $(BLIB_LIST)),)
1132 BLIB_OBJS_OLD   := <invalid>
1133 else
1134 BLIB_OBJS_OLD   := $(shell cat $(BLIB_LIST))
1135 endif
1136 ifneq ($(BLIB_OBJS_OLD),$(BLIB_OBJS))
1137 $(shell $(ECHO) "$(BLIB_OBJS)" > $(BLIB_LIST))
1138 endif
1139
1140 $(BLIB_LIST) : $(MAKEDEPS)
1141
1142 VERYCLEANUP     += $(BLIB_LIST)
1143
1144 # Library of all objects
1145 #
1146 BLIB            = $(BIN)/blib.a
1147 $(BLIB) : $(BLIB_OBJS) $(BLIB_LIST) $(MAKEDEPS)
1148         $(Q)$(RM) $(BLIB)
1149         $(QM)$(ECHO) "  [AR] $@"
1150         $(Q)$(AR) r $@ $(sort $(BLIB_OBJS))
1151         $(Q)$(RANLIB) $@
1152 blib : $(BLIB)
1153
1154 # Command to generate build ID.  Must be unique for each $(BIN)/%.tmp,
1155 # even within the same build run.
1156 #
1157 BUILD_ID_CMD    := perl -e 'printf "0x%08x", int ( rand ( 0xffffffff ) );'
1158
1159 # Build timestamp
1160 #
1161 BUILD_TIMESTAMP := $(shell date +%s)
1162
1163 # Build version
1164 #
1165 GIT_INDEX := $(if $(GITVERSION),$(if $(wildcard ../.git/index),../.git/index))
1166 $(BIN)/version.%.o : core/version.c $(MAKEDEPS) $(GIT_INDEX)
1167         $(QM)$(ECHO) "  [VERSION] $@"
1168         $(Q)$(COMPILE_c) -DBUILD_NAME="\"$*\"" \
1169                 -DVERSION_MAJOR=$(VERSION_MAJOR) \
1170                 -DVERSION_MINOR=$(VERSION_MINOR) \
1171                 -DVERSION_PATCH=$(VERSION_PATCH) \
1172                 -DVERSION="\"$(VERSION)\"" \
1173                 -c $< -o $@
1174
1175 # Build an intermediate object file from the objects required for the
1176 # specified target.
1177 #
1178 $(BIN)/%.tmp : $(BIN)/version.%.o $(BLIB) $(MAKEDEPS) $(LDSCRIPT)
1179         $(QM)$(ECHO) "  [LD] $@"
1180         $(Q)$(LD) $(LDFLAGS) -T $(LDSCRIPT) $(TGT_LD_FLAGS) $< $(BLIB) -o $@ \
1181                 --defsym _build_id=`$(BUILD_ID_CMD)` \
1182                 --defsym _build_timestamp=$(BUILD_TIMESTAMP) \
1183                 -Map $(BIN)/$*.tmp.map
1184         $(Q)$(OBJDUMP) -ht $@ | $(PERL) $(SORTOBJDUMP) >> $(BIN)/$*.tmp.map
1185
1186 # Keep intermediate object file (useful for debugging)
1187 .PRECIOUS : $(BIN)/%.tmp
1188
1189 # Show a linker map for the specified target
1190 #
1191 $(BIN)/%.map : $(BIN)/%.tmp
1192         @less $(BIN)/$*.tmp.map
1193
1194 # Get objects list for the specified target
1195 #
1196 define objs_list
1197         $(sort $(foreach OBJ_SYMBOL,\
1198                  $(filter obj_%,$(shell $(NM) $(1) | cut -d" " -f3)),\
1199                  $(patsubst obj_%,%,$(OBJ_SYMBOL))))
1200 endef
1201 $(BIN)/%.objs : $(BIN)/%.tmp
1202         $(Q)$(ECHO) $(call objs_list,$<)
1203 $(BIN)/%.sizes : $(BIN)/%.tmp
1204         $(Q)$(SIZE) -t $(foreach OBJ,$(call objs_list,$<),$(wildcard $(BIN)/$(subst _,?,$(OBJ)).o)) | \
1205                 sort -g
1206
1207 # Get dependency list for the specified target
1208 #
1209 define deps_list
1210         $(sort $(foreach OBJ,$(call objs_list,$(1)),$($(OBJ)_DEPS)))
1211 endef
1212 $(BIN)/%.deps : $(BIN)/%.tmp
1213         $(Q)$(ECHO) $(call deps_list,$<)
1214
1215 # Get unneeded source files for the specified target
1216 #
1217 define nodeps_list
1218         $(sort $(filter-out $(call deps_list,$(1)),\
1219                  $(foreach BOBJ,$(BOBJS),\
1220                    $($(basename $(notdir $(BOBJ)))_DEPS))))
1221 endef
1222 $(BIN)/%.nodeps : $(BIN)/%.tmp
1223         $(Q)$(ECHO) $(call nodeps_list,$<)
1224
1225 # Get licensing verdict for the specified target
1226 #
1227 define licensable_deps_list
1228         $(filter-out config/local/%.h,\
1229           $(filter-out $(BIN)/.%.list,\
1230             $(call deps_list,$(1))))
1231 endef
1232 define unlicensed_deps_list
1233         $(shell grep -L FILE_LICENCE $(call licensable_deps_list,$(1)))
1234 endef
1235 define licence_list
1236         $(sort $(foreach LICENCE,\
1237                  $(filter __licence__%,$(shell $(NM) $(1) | cut -d" " -f3)),\
1238                  $(word 2,$(subst __, ,$(LICENCE)))))
1239 endef
1240 $(BIN)/%.licence_list : $(BIN)/%.tmp
1241         $(Q)$(ECHO) $(call licence_list,$<)
1242 $(BIN)/%.licence : $(BIN)/%.tmp
1243         $(QM)$(ECHO) "  [LICENCE] $@"
1244         $(Q)$(if $(strip $(call unlicensed_deps_list,$<)),\
1245                 echo -n "Unable to determine licence because the following " ;\
1246                 echo "files are missing a licence declaration:" ;\
1247                 echo $(call unlicensed_deps_list,$<);\
1248                 exit 1,\
1249                 $(PERL) $(LICENCE) $(call licence_list,$<))
1250
1251 # Extract compression information from intermediate object file
1252 #
1253 $(BIN)/%.zinfo : $(BIN)/%.tmp
1254         $(QM)$(ECHO) "  [ZINFO] $@"
1255         $(Q)$(OBJCOPY) -O binary -j .zinfo $< $@
1256
1257 # Build raw binary file from intermediate object file
1258 #
1259 $(BIN)/%.bin : $(BIN)/%.tmp
1260         $(QM)$(ECHO) "  [BIN] $@"
1261         $(Q)$(OBJCOPY) -O binary -R .zinfo $< $@
1262
1263 # Compress raw binary file
1264 #
1265 $(BIN)/%.zbin : $(BIN)/%.bin $(BIN)/%.zinfo $(ZBIN)
1266         $(QM)$(ECHO) "  [ZBIN] $@"
1267         $(Q)$(ZBIN) $(BIN)/$*.bin $(BIN)/$*.zinfo > $@
1268
1269 # Rules for each media format.  These are generated and placed in an
1270 # external Makefile fragment.  We could do this via $(eval ...), but
1271 # that would require make >= 3.80.
1272
1273 # Note that there's an alternative way to generate most .rom images:
1274 # they can be copied from their 'master' ROM image using cp and
1275 # reprocessed with makerom to add the PCI IDs and ident string.  The
1276 # relevant rule would look something like:
1277 #
1278 #   $(BIN)/dfe538%rom : $(BIN)/rtl8139%rom
1279 #       cat $< $@
1280 #       $(FINALISE_rom)
1281
1282 # You can derive the ROM/driver relationships using the variables
1283 # DRIVER_<rom> and/or ROMS_<driver>.
1284
1285 # We don't currently do this, because (a) it would require generating
1286 # yet more Makefile fragments (since you need a rule for each ROM in
1287 # ROMS), and (b) the linker is so fast that it probably wouldn't make
1288 # much difference to the overall build time.
1289
1290 # Add NON_AUTO_MEDIA to the media list, so that they show up in the
1291 # output of "make"
1292 #
1293 MEDIA           += $(NON_AUTO_MEDIA)
1294
1295 media :
1296         @$(ECHO) $(MEDIA)
1297
1298 AUTO_MEDIA      = $(filter-out $(NON_AUTO_MEDIA),$(MEDIA))
1299 automedia :
1300         @$(ECHO) $(AUTO_MEDIA)
1301
1302 # media_template : create media rules
1303 #
1304 # $(1) is the media name (e.g. "rom")
1305 #
1306 define media_template
1307 $(if $(filter $(1),$(AUTO_MEDIA)),$(call auto_media_template,$(1)))
1308 LIST_$(1) := $$(if $$(LIST_NAME_$(1)),$$($$(LIST_NAME_$(1))),$$(DRIVERS))
1309 ALL_$(1) = $$(foreach ITEM,$$(LIST_$(1)),$$(BIN)/$$(ITEM).$(1))
1310 $$(BIN)/all$(1)s : $$(ALL_$(1))
1311 $$(BIN)/allall : $$(BIN)/all$(1)s
1312 all$(1)s : $$(BIN)/all$(1)s
1313 allall : $$(BIN)/allall
1314 endef
1315 #
1316 # $(1) is the media name (e.g. "rom")
1317 #
1318 define auto_media_template
1319 $$(BIN)/%.$(1) : $$(BIN)/%.$(1).zbin
1320         $$(QM)echo "  [FINISH] $$@"
1321         $$(Q)$$(CP) $$< $$@
1322         $$(Q)$$(if $$(PAD_$(1)),$$(PAD_$(1)) $$@)
1323         $$(Q)$$(if $$(FINALISE_$(1)),$$(FINALISE_$(1)) $$@)
1324 endef
1325 #
1326 # $(1) is the media name (e.g. "rom")
1327 #
1328 define media_template_file
1329         @$(ECHO) "  [MEDIARULES] $(1)"
1330         @$(MKDIR) -p $(BIN)/rules/$(dir $(1))
1331         @$(ECHO_E) '$(subst $(NEWLINE),\n,$(call media_template,$(1)))' \
1332                 > $(BIN)/rules/$(1).media.r
1333 endef
1334
1335 # Generate media rules files
1336 #
1337 $(BIN)/rules/%.media.r : $(MAKEDEPS)
1338         $(call media_template_file,$*)
1339
1340 # Calculate list of media rules files
1341 #
1342 MEDIA_RULES             = $(patsubst %,$(BIN)/rules/%.media.r,$(MEDIA))
1343 mediarules :
1344         @$(ECHO) $(MEDIA_RULES)
1345
1346 # Evaluate media rules (or include media rules files)
1347 #
1348 ifdef NEED_DEPS
1349 ifneq ($(MEDIA_RULES),)
1350 ifneq ($(HAVE_EVAL),)
1351 $(foreach MEDIUM,$(MEDIA),$(eval $(call media_template,$(MEDIUM))))
1352 else
1353 -include $(MEDIA_RULES)
1354 endif
1355 endif
1356 endif
1357
1358 # Alias for ipxe.%
1359 #
1360 $(BIN)/etherboot.% : $(BIN)/ipxe.%
1361         ln -sf $(notdir $<) $@
1362
1363 endif # defined(BIN)
1364
1365 ###############################################################################
1366 #
1367 # The compression utilities
1368 #
1369
1370 ZBIN_LDFLAGS := -llzma
1371
1372 $(ZBIN) : util/zbin.c $(MAKEDEPS)
1373         $(QM)$(ECHO) "  [HOSTCC] $@"
1374         $(Q)$(HOST_CC) $(HOST_CFLAGS) $< $(ZBIN_LDFLAGS) -o $@
1375 CLEANUP += $(ZBIN)
1376
1377 ###############################################################################
1378 #
1379 # The EFI image converter
1380 #
1381
1382 $(ELF2EFI32) : util/elf2efi.c $(MAKEDEPS)
1383         $(QM)$(ECHO) "  [HOSTCC] $@"
1384         $(Q)$(HOST_CC) $(HOST_CFLAGS) -idirafter include -DEFI_TARGET32 $< -o $@
1385 CLEANUP += $(ELF2EFI32)
1386
1387 $(ELF2EFI64) : util/elf2efi.c $(MAKEDEPS)
1388         $(QM)$(ECHO) "  [HOSTCC] $@"
1389         $(Q)$(HOST_CC) $(HOST_CFLAGS) -idirafter include -DEFI_TARGET64 $< -o $@
1390 CLEANUP += $(ELF2EFI64)
1391
1392 $(EFIROM) : util/efirom.c $(MAKEDEPS)
1393         $(QM)$(ECHO) "  [HOSTCC] $@"
1394         $(Q)$(HOST_CC) $(HOST_CFLAGS) -idirafter include -o $@ $<
1395 CLEANUP += $(EFIROM)
1396
1397 $(EFIFATBIN) : util/efifatbin.c $(MAKEDEPS)
1398         $(QM)$(ECHO) "  [HOSTCC] $@"
1399         $(Q)$(HOST_CC) $(HOST_CFLAGS) -idirafter include -o $@ $<
1400 CLEANUP += $(EFIFATBIN)
1401
1402 ###############################################################################
1403 #
1404 # The ICC fixup utility
1405 #
1406 $(ICCFIX) : util/iccfix.c $(MAKEDEPS)
1407         $(QM)$(ECHO) "  [HOSTCC] $@"
1408         $(Q)$(HOST_CC) $(HOST_CFLAGS) -idirafter include -o $@ $<
1409 CLEANUP += $(ICCFIX)
1410
1411 ###############################################################################
1412 #
1413 # The error usage information utility
1414 #
1415 $(EINFO) : util/einfo.c $(MAKEDEPS)
1416         $(QM)$(ECHO) "  [HOSTCC] $@"
1417         $(Q)$(HOST_CC) $(HOST_CFLAGS) -idirafter include -o $@ $<
1418 CLEANUP += $(EINFO)
1419
1420 ###############################################################################
1421 #
1422 # Local configs
1423 #
1424 CONFIG_HEADERS := $(patsubst config/%,%,$(wildcard config/*.h))
1425 CONFIG_LOCAL_HEADERS := $(foreach HEADER,$(CONFIG_HEADERS),\
1426                                   config/local/$(HEADER))
1427
1428 $(CONFIG_LOCAL_HEADERS) :
1429         $(Q)$(TOUCH) $@
1430
1431 .PRECIOUS : $(CONFIG_LOCAL_HEADERS)
1432
1433 ifneq ($(CONFIG),)
1434
1435 CONFIG_LOCAL_NAMED_HEADERS := $(foreach HEADER,$(CONFIG_HEADERS),\
1436                                         config/local/$(CONFIG)/$(HEADER))
1437
1438 $(CONFIG_LOCAL_NAMED_HEADERS) :
1439         $(Q)$(MKDIR) -p $(dir $@)
1440         $(Q)$(TOUCH) $@
1441
1442 .PRECIOUS : $(CONFIG_LOCAL_NAMED_HEADERS)
1443
1444 endif
1445
1446 ###############################################################################
1447 #
1448 # Build the TAGS file(s) for emacs
1449 #
1450 TAGS :
1451         ctags -e -R -f $@ --exclude=bin
1452
1453 CLEANUP += TAGS
1454
1455 ###############################################################################
1456 #
1457 # Force rebuild for any given target
1458 #
1459 %.rebuild :
1460         rm -f $*
1461         $(Q)$(MAKE) $*
1462
1463 ###############################################################################
1464 #
1465 # Symbol table checks
1466 #
1467
1468 ifdef BIN
1469
1470 SYMTAB  = $(BIN)/symtab
1471 $(SYMTAB) : $(BLIB)
1472         $(OBJDUMP) -w -t $< > $@
1473
1474 CLEANUP += $(BIN)/symtab
1475
1476 symcheck : $(SYMTAB)
1477         $(PERL) $(SYMCHECK) $<
1478
1479 endif # defined(BIN)
1480
1481 ###############################################################################
1482 #
1483 # Build bochs symbol table
1484 #
1485
1486 ifdef BIN
1487
1488 $(BIN)/%.bxs : $(BIN)/%.tmp
1489         $(NM) $< | cut -d" " -f1,3 > $@
1490
1491 endif # defined(BIN)
1492
1493 ###############################################################################
1494 #
1495 # Documentation
1496 #
1497
1498 ifdef BIN
1499
1500 $(BIN)/doxygen.cfg : doxygen.cfg $(MAKEDEPS)
1501         $(Q)$(PERL) -pe 's{\@SRCDIRS\@}{$(SRCDIRS)}; ' \
1502                 -e  's{\@INCDIRS\@}{$(filter-out .,$(INCDIRS))}; ' \
1503                 -e  's{\@BIN\@}{$(BIN)}; ' \
1504                 -e  's{\@ARCH\@}{$(ARCH)}; ' \
1505                 $< > $@
1506
1507 $(BIN)/doc : $(BIN)/doxygen.cfg
1508         $(Q)$(DOXYGEN) $<
1509
1510 .PHONY : $(BIN)/doc
1511
1512 doc : $(BIN)/doc
1513
1514 doc-clean :
1515         $(Q)$(RM) -r $(BIN)/doc
1516
1517 VERYCLEANUP     += $(BIN)/doc
1518
1519 docview :
1520         @[ -f $(BIN)/doc/html/index.html ] || $(MAKE) $(BIN)/doc
1521         @if [ -n "$$BROWSER" ] ; then \
1522                 ( $$BROWSER $(BIN)/doc/html/index.html & ) ; \
1523         else \
1524                 $(ECHO) "Documentation index in $(BIN)/doc/html/index.html" ; \
1525         fi
1526
1527 endif # defined(BIN)
1528
1529 ###############################################################################
1530 #
1531 # Keyboard maps
1532 #
1533
1534 hci/keymap/keymap_%.c :
1535         $(Q)$(PERL) $(GENKEYMAP) $* > $@
1536
1537 ###############################################################################
1538 #
1539 # Force deletion of incomplete targets
1540 #
1541
1542 .DELETE_ON_ERROR :
1543
1544 ###############################################################################
1545 #
1546 # Clean-up
1547 #
1548
1549 ifeq ($(NUM_BINS),0)
1550 ALLBINS         := bin{,-*}
1551 CLEANUP         := $(patsubst $(BIN)/%,$(ALLBINS)/%,$(CLEANUP))
1552 VERYCLEANUP     := $(patsubst $(BIN)/%,$(ALLBINS)/%,$(VERYCLEANUP))
1553 endif
1554
1555 clean :
1556         $(RM) $(CLEANUP)
1557
1558 veryclean : clean
1559         $(RM) -r $(VERYCLEANUP)