Add fireserve to CLEANUP
[people/oremanj/gpxe.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 .toolcheck :
92         @if $(CC) -v 2>&1 | grep -is 'gcc version 2\.96' > /dev/null; then \
93                 $(ECHO) 'gcc 2.96 is unsuitable for compiling Etherboot'; \
94                 $(ECHO) 'Use gcc 2.95 or gcc 3.x instead'; \
95                 exit 1; \
96         fi
97         @if [ `perl -e 'use bytes; print chr(255)' | wc -c` = 2 ]; then \
98                 $(ECHO) 'Your Perl version has a Unicode handling bug'; \
99                 $(ECHO) 'Execute this command before compiling Etherboot:'; \
100                 $(ECHO) 'export LANG=$${LANG%.UTF-8}'; \
101                 exit 1; \
102         fi
103         @$(TOUCH) $@
104 MAKEDEPS        += .toolcheck
105 VERYCLEANUP     += .toolcheck
106
107 ###############################################################################
108 #
109 # Check for various tool workarounds
110 #
111
112 # Make syntax does not allow use of comma or space in certain places.
113 # This ugly workaround is suggested in the manual.
114 #
115 COMMA   := ,
116 EMPTY   :=
117 SPACE   := $(EMPTY) $(EMPTY)
118
119 # Check for an old version of gas (binutils 2.9.1)
120 #
121 OLDGAS  := $(shell $(AS) --version | grep -q '2\.9\.1' && $(ECHO) -DGAS291)
122 CFLAGS  += $(OLDGAS)
123 oldgas :
124         @$(ECHO) $(oldgas)
125
126 # Some widespread patched versions of gcc include -fstack-protector by
127 # default, even when -ffreestanding is specified.  We therefore need
128 # to disable -fstack-protector if the compiler supports it.
129 #
130 ifeq ($(CCTYPE),gcc)
131 SP_TEST = $(CC) -fno-stack-protector -x c -c /dev/null \
132                 -o /dev/null >/dev/null 2>&1
133 SP_FLAGS := $(shell $(SP_TEST) && $(ECHO) '-fno-stack-protector')
134 CFLAGS  += $(SP_FLAGS)
135 endif
136
137 # Some versions of gas choke on division operators, treating them as
138 # comment markers.  Specifying --divide will work around this problem,
139 # but isn't available on older gas versions.
140 #
141 DIVIDE_TEST = $(AS) --divide /dev/null -o /dev/null 2>/dev/null
142 DIVIDE_FLAGS := $(shell $(DIVIDE_TEST) && $(ECHO) '--divide')
143 ASFLAGS += $(DIVIDE_FLAGS)
144
145 ###############################################################################
146 #
147 # Build verbosity
148 #
149 ifeq ($(V),1)
150 Q :=
151 QM := @\#
152 else
153 Q := @
154 QM := @
155 endif
156
157 ###############################################################################
158 #
159 # Set BIN according to whatever was specified on the command line as
160 # the build target.
161 #
162
163 # Determine how many different BIN directories are mentioned in the
164 # make goals.
165 #
166 BIN_GOALS       := $(filter bin/% bin-%,$(MAKECMDGOALS))
167 BIN_GOAL_BINS   := $(foreach BG,$(BIN_GOALS),$(firstword $(subst /, ,$(BG))))
168 NUM_BINS        := $(words $(sort $(BIN_GOAL_BINS)))
169
170 ifeq ($(NUM_BINS),0)
171
172 # No BIN directory was specified.  Set BIN to "bin" as a sensible
173 # default.
174
175 BIN             := bin
176
177 else # NUM_BINS == 0
178
179 ifeq ($(NUM_BINS),1)
180
181 # If exactly one BIN directory was specified, set BIN to match this
182 # directory.
183 #
184 BIN             := $(firstword $(BIN_GOAL_BINS))
185
186 else # NUM_BINS == 1
187
188 # More than one BIN directory was specified.  We cannot handle the
189 # latter case within a single make invocation, so set up recursive
190 # targets for each BIN directory.
191 #
192 # Leave $(BIN) undefined.  This has implications for any target that
193 # depends on $(BIN); such targets should be made conditional upon the
194 # existence of $(BIN).
195 #
196 $(BIN_GOALS) : % : BIN_RECURSE
197         $(Q)$(MAKE) --no-print-directory BIN=$(firstword $(subst /, ,$@)) $@
198 .PHONY : BIN_RECURSE
199
200 endif # NUM_BINS == 1
201 endif # NUM_BINS == 0
202
203 ifdef BIN
204
205 # Create $(BIN) directory if it doesn't exist yet
206 #
207 ifeq ($(wildcard $(BIN)),)
208 $(shell $(MKDIR) -p $(BIN))
209 endif
210
211 # Target to allow e.g. "make bin-efi arch"
212 #
213 $(BIN) :
214         @# Do nothing, silently
215 .PHONY : $(BIN)
216
217 # Remove everything in $(BIN) for a "make clean"
218 #
219 CLEANUP += $(BIN)/*.* # Avoid picking up directories
220
221 endif # defined(BIN)
222
223 # Determine whether or not we need to include the dependency files
224 #
225 NO_DEP_TARGETS  := $(BIN) clean veryclean
226 ifeq ($(MAKECMDGOALS),)
227 NEED_DEPS       := 1
228 endif
229 ifneq ($(strip $(filter-out $(NO_DEP_TARGETS),$(MAKECMDGOALS))),)
230 NEED_DEPS       := 1
231 endif
232
233 ###############################################################################
234 #
235 # Select build architecture and platform based on $(BIN)
236 #
237 # BIN has the form bin[-[arch-]platform]
238
239 ARCHS           := $(patsubst arch/%,%,$(wildcard arch/*))
240 PLATFORMS       := $(patsubst config/defaults/%.h,%,\
241                      $(wildcard config/defaults/*.h))
242 archs :
243         @$(ECHO) $(ARCHS)
244
245 platforms :
246         @$(ECHO) $(PLATFORMS)
247
248 ifdef BIN
249
250 # Determine architecture portion of $(BIN), if present
251 BIN_ARCH        := $(strip $(foreach A,$(ARCHS),\
252                              $(patsubst bin-$(A)-%,$(A),\
253                                $(filter bin-$(A)-%,$(BIN)))))
254
255 # Determine platform portion of $(BIN), if present
256 ifeq ($(BIN_ARCH),)
257 BIN_PLATFORM    := $(patsubst bin-%,%,$(filter bin-%,$(BIN)))
258 else
259 BIN_PLATFORM    := $(patsubst bin-$(BIN_ARCH)-%,%,$(BIN))
260 endif
261
262 # Determine build architecture
263 DEFAULT_ARCH    := i386
264 ARCH            := $(firstword $(BIN_ARCH) $(DEFAULT_ARCH))
265 CFLAGS          += -DARCH=$(ARCH)
266 arch :
267         @$(ECHO) $(ARCH)
268 .PHONY : arch
269
270 # Determine build platform
271 DEFAULT_PLATFORM := pcbios
272 PLATFORM        := $(firstword $(BIN_PLATFORM) $(DEFAULT_PLATFORM))
273 CFLAGS          += -DPLATFORM=$(PLATFORM)
274 platform :
275         @$(ECHO) $(PLATFORM)
276
277 endif # defined(BIN)
278
279 # Include architecture-specific Makefile
280 ifdef ARCH
281 MAKEDEPS        += arch/$(ARCH)/Makefile
282 include arch/$(ARCH)/Makefile
283 endif
284
285 ###############################################################################
286 #
287 # Source file handling
288
289 # SRCDIRS lists all directories containing source files.
290 srcdirs :
291         @$(ECHO) $(SRCDIRS)
292
293 # SRCS lists all .c or .S files found in any SRCDIR
294 #
295 SRCS    += $(wildcard $(patsubst %,%/*.c,$(SRCDIRS)))
296 SRCS    += $(wildcard $(patsubst %,%/*.S,$(SRCDIRS)))
297 srcs :
298         @$(ECHO) $(SRCS)
299
300 # AUTO_SRCS lists all files in SRCS that are not mentioned in
301 # NON_AUTO_SRCS.  Files should be added to NON_AUTO_SRCS if they
302 # cannot be built using the standard build template.
303 #
304 AUTO_SRCS = $(filter-out $(NON_AUTO_SRCS),$(SRCS))
305 autosrcs :
306         @$(ECHO) $(AUTO_SRCS)
307
308 # Just about everything else in this section depends upon having
309 # $(BIN) set
310
311 ifdef BIN
312
313 # Common flags
314 #
315 CFLAGS          += -I include -I arch/$(ARCH)/include -I .
316 CFLAGS          += -Os
317 CFLAGS          += -g
318 ifeq ($(CCTYPE),gcc)
319 CFLAGS          += -ffreestanding
320 CFLAGS          += -Wall -W -Wformat-nonliteral
321 endif
322 ifeq ($(CCTYPE),icc)
323 CFLAGS          += -fno-builtin
324 CFLAGS          += -no-ip
325 CFLAGS          += -no-gcc
326 CFLAGS          += -diag-disable 111 # Unreachable code
327 CFLAGS          += -diag-disable 128 # Unreachable loop
328 CFLAGS          += -diag-disable 170 # Array boundary checks
329 CFLAGS          += -diag-disable 177 # Unused functions
330 CFLAGS          += -diag-disable 181 # printf() format checks
331 CFLAGS          += -diag-disable 188 # enum strictness
332 CFLAGS          += -diag-disable 193 # Undefined preprocessor identifiers
333 CFLAGS          += -diag-disable 280 # switch ( constant )
334 CFLAGS          += -diag-disable 310 # K&R parameter lists
335 CFLAGS          += -diag-disable 424 # Extra semicolon
336 CFLAGS          += -diag-disable 589 # Declarations mid-code
337 CFLAGS          += -diag-disable 593 # Unused variables
338 CFLAGS          += -diag-disable 810 # Casting ints to smaller ints
339 CFLAGS          += -diag-disable 981 # Sequence point violations
340 CFLAGS          += -diag-disable 1292 # Ignored attributes
341 CFLAGS          += -diag-disable 1338 # void pointer arithmetic
342 CFLAGS          += -diag-disable 1361 # Variable-length arrays
343 CFLAGS          += -diag-disable 1418 # Missing prototypes
344 CFLAGS          += -diag-disable 1419 # Missing prototypes
345 CFLAGS          += -diag-disable 1599 # Hidden variables
346 CFLAGS          += -Wall -Wmissing-declarations
347 endif
348 CFLAGS          += $(EXTRA_CFLAGS)
349 ASFLAGS         += $(EXTRA_ASFLAGS)
350 LDFLAGS         += $(EXTRA_LDFLAGS)
351
352 # Inhibit -Werror if NO_WERROR is specified on make command line
353 #
354 ifneq ($(NO_WERROR),1)
355 CFLAGS          += -Werror
356 ASFLAGS         += --fatal-warnings
357 endif
358
359 # compiler.h is needed for our linking and debugging system
360 #
361 CFLAGS          += -include compiler.h
362
363 # CFLAGS for specific object types
364 #
365 CFLAGS_c        +=
366 CFLAGS_S        += -DASSEMBLY
367
368 # Base object name of the current target
369 #
370 OBJECT          = $(firstword $(subst ., ,$(@F)))
371
372 # CFLAGS for specific object files.  You can define
373 # e.g. CFLAGS_rtl8139, and have those flags automatically used when
374 # compiling bin/rtl8139.o.
375 #
376 OBJ_CFLAGS      = $(CFLAGS_$(OBJECT)) -DOBJECT=$(subst -,_,$(OBJECT))
377 $(BIN)/%.flags :
378         @$(ECHO) $(OBJ_CFLAGS)
379
380 # ICC requires postprocessing objects to fix up table alignments
381 #
382 ifeq ($(CCTYPE),icc)
383 POST_O          = && $(ICCFIX) $@
384 POST_O_DEPS     := $(ICCFIX)
385 else
386 POST_O          :=
387 POST_O_DEPS     :=
388 endif
389
390 # Rules for specific object types.
391 #
392 COMPILE_c       = $(CC) $(CFLAGS) $(CFLAGS_c) $(OBJ_CFLAGS)
393 RULE_c          = $(Q)$(COMPILE_c) -c $< -o $@ $(POST_O)
394 RULE_c_to_dbg%.o = $(Q)$(COMPILE_c) -Ddebug_$(OBJECT)=$* -c $< -o $@ $(POST_O)
395 RULE_c_to_c     = $(Q)$(COMPILE_c) -E -c $< > $@
396 RULE_c_to_s     = $(Q)$(COMPILE_c) -S -g0 -c $< -o $@
397
398 PREPROCESS_S    = $(CPP) $(CFLAGS) $(CFLAGS_S) $(OBJ_CFLAGS)
399 ASSEMBLE_S      = $(AS) $(ASFLAGS)
400 RULE_S          = $(Q)$(PREPROCESS_S) $< | $(ASSEMBLE_S) -o $@
401 RULE_S_to_s     = $(Q)$(PREPROCESS_S) $< > $@
402
403 DEBUG_TARGETS   += dbg%.o c s
404
405 # We automatically generate rules for any file mentioned in AUTO_SRCS
406 # using the following set of templates.  It would be cleaner to use
407 # $(eval ...), but this function exists only in GNU make >= 3.80.
408
409 # src_template : generate Makefile rules for a given source file
410 #
411 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
412 # $(2) is the full path to the .d file (e.g. "bin/deps/drivers/net/rtl8139.d")
413 # $(3) is the source type (e.g. "c")
414 # $(4) is the source base name (e.g. "rtl8139")
415 #
416 define src_template
417
418         @$(ECHO) "  [DEPS] $(1)"
419         @$(MKDIR) -p $(dir $(2))
420         @$(RM) $(2)
421         @$(TOUCH) $(2)
422         $(foreach OBJ,$(if $(OBJS_$(4)),$(OBJS_$(4)),$(4)), \
423                 $(call obj_template,$(1),$(2),$(3),$(OBJ)))
424         @$(PARSEROM) $(1) >> $(2)
425
426 endef
427
428 # obj_template : generate Makefile rules for a given resultant object
429 # of a particular source file.  (We can have multiple objects per
430 # source file via the OBJS_xxx list.)
431 #
432 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
433 # $(2) is the full path to the .d file (e.g. "bin/deps/drivers/net/rtl8139.d")
434 # $(3) is the source type (e.g. "c")
435 # $(4) is the object name (e.g. "rtl8139")
436 #
437 define obj_template
438
439         @$(CPP) $(CFLAGS) $(CFLAGS_$(3)) $(CFLAGS_$(4)) -DOBJECT=$(4) \
440                 -Wno-error -MM $(1) -MG -MP | \
441                 sed 's/\.o\s*:/_DEPS =/' >> $(2)
442         @$(ECHO_E) '\n$$(BIN)/$(4).o :' \
443                  '$(1) $$(MAKEDEPS) $$(POST_O_DEPS) $$($(4)_DEPS)' \
444                  '\n\t$$(QM)$(ECHO) "  [BUILD] $$@"' \
445                  '\n\t$$(RULE_$(3))\n' \
446                  '\nBOBJS += $$(BIN)/$(4).o\n' \
447                  $(foreach TGT,$(DEBUG_TARGETS), \
448                     $(if $(RULE_$(3)_to_$(TGT)), \
449                     '\n$$(BIN)/$(4).$(TGT) :' \
450                     '$(1) $$(MAKEDEPS) $$(POST_O_DEPS) $$($(4)_DEPS)' \
451                     '\n\t$$(QM)$(ECHO) "  [BUILD] $$@"' \
452                     '\n\t$$(RULE_$(3)_to_$(TGT))\n' \
453                     '\n$(TGT)_OBJS += $$(BIN)/$(4).$(TGT)\n' ) ) \
454                  '\n$(2) : $$($(4)_DEPS)\n' \
455                  '\nTAGS : $$($(4)_DEPS)\n' \
456                 >> $(2)
457
458 endef
459
460 # Rule to generate the Makefile rules files to be included
461 #
462 $(BIN)/deps/%.d : % $(MAKEDEPS) $(PARSEROM)
463         $(if $(filter $(AUTO_SRCS),$<),$(call src_template,$<,$@,$(subst .,,$(suffix $<)),$(basename $(notdir $<))),@$(ECHO) 'ERROR: $< is not an AUTO_SRC' ; exit 1)
464
465 # Calculate and include the list of Makefile rules files
466 #
467 AUTO_DEPS       = $(patsubst %,$(BIN)/deps/%.d,$(AUTO_SRCS))
468 ifdef NEED_DEPS
469 ifneq ($(AUTO_DEPS),)
470 -include $(AUTO_DEPS)
471 endif
472 endif
473 autodeps :
474         @$(ECHO) $(AUTO_DEPS)
475 VERYCLEANUP     += $(BIN)/deps
476
477 # The following variables are created by the Makefile rules files
478 #
479 bobjs :
480         @$(ECHO) $(BOBJS)
481 drivers :
482         @$(ECHO) $(DRIVERS)
483 .PHONY : drivers
484 roms :
485         @$(ECHO) $(ROMS)
486
487 # List of embedded images included in the last build of embedded.o.
488 # This is needed in order to correctly rebuild embedded.o whenever the
489 # list of objects changes.
490 #
491 EMBEDDED_LIST   := $(BIN)/.embedded.list
492 ifeq ($(wildcard $(EMBEDDED_LIST)),)
493 EMBEDDED_LIST_IMAGE := <invalid>
494 else
495 EMBEDDED_LIST_IMAGE := $(shell cat $(EMBEDDED_LIST))
496 endif
497 ifneq ($(EMBEDDED_LIST_IMAGE),$(EMBEDDED_IMAGE))
498 $(shell $(ECHO) "$(EMBEDDED_IMAGE)" > $(EMBEDDED_LIST))
499 endif
500
501 $(EMBEDDED_LIST) :
502
503 VERYCLEANUP     += $(EMBEDDED_LIST)
504
505 EMBEDDED_FILES  := $(subst $(COMMA), ,$(EMBEDDED_IMAGE))
506 EMBED_ALL       := $(foreach i,$(call seq,1,$(words $(EMBEDDED_FILES))),\
507                      EMBED ( $(i), \"$(word $(i), $(EMBEDDED_FILES))\",\
508                              \"$(notdir $(word $(i),$(EMBEDDED_FILES)))\" ))
509
510 $(BIN)/embedded.o : $(EMBEDDED_FILES) $(EMBEDDED_LIST)
511 CFLAGS_embedded = -DEMBED_ALL="$(EMBED_ALL)"
512
513 # Generate the NIC file from the parsed source files.  The NIC file is
514 # only for rom-o-matic.
515 #
516 $(BIN)/NIC : $(AUTO_DEPS)
517         @$(ECHO) '# This is an automatically generated file, do not edit' > $@
518         @$(ECHO) '# It does not affect anything in the build, ' \
519              'it is only for rom-o-matic' >> $@
520         @$(ECHO) >> $@
521         @perl -ne 'chomp; print "$$1\n" if /\# NIC\t(.*)$$/' $^ >> $@
522 CLEANUP         += $(BIN)/NIC   # Doesn't match the $(BIN)/*.* pattern
523
524 # Analyse a target name (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and
525 # derive the variables:
526
527 # TGT_ELEMENTS : the elements of the target (e.g. "dfe538 prism2_pci")
528 # TGT_PREFIX   : the prefix type (e.g. "zrom")
529 # TGT_DRIVERS  : the driver for each element (e.g. "rtl8139 prism2_pci")
530 # TGT_ROM_NAME : the ROM name (e.g. "dfe538")
531 # TGT_MEDIA    : the media type (e.g. "rom")
532 #
533 DRIVERS_gpxe    = $(DRIVERS)
534 CARD_DRIVER     = $(firstword $(DRIVER_$(1)) $(1))
535 TGT_ELEMENTS    = $(subst --, ,$(firstword $(subst ., ,$(notdir $@))))
536 TGT_PREFIX      = $(word 2,$(subst ., ,$(notdir $@)))
537 TGT_ROM_NAME    = $(firstword $(TGT_ELEMENTS))
538 TGT_DRIVERS     = $(strip $(if $(DRIVERS_$(TGT_ROM_NAME)), \
539                                $(DRIVERS_$(TGT_ROM_NAME)), \
540                                $(foreach TGT_ELEMENT,$(TGT_ELEMENTS), \
541                                  $(call CARD_DRIVER,$(TGT_ELEMENT))) ))
542 TGT_MEDIA       = $(subst z,,$(TGT_PREFIX))
543
544 # Look up ROM IDs for the current target
545 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
546 #
547 # TGT_PCI_VENDOR : the PCI vendor ID (e.g. "0x1186")
548 # TGT_PCI_DEVICE : the PCI device ID (e.g. "0x1300")
549 #
550 TGT_PCI_VENDOR  = $(PCI_VENDOR_$(TGT_ROM_NAME))
551 TGT_PCI_DEVICE  = $(PCI_DEVICE_$(TGT_ROM_NAME))
552
553 # Calculate link-time options for the current target
554 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
555 #
556 # TGT_LD_DRIVERS : symbols to require in order to drag in the relevant drivers
557 #                  (e.g. "obj_rtl8139 obj_prism2_pci")
558 # TGT_LD_IDS :     symbols to define in order to fill in ID structures in the
559 #                  ROM header (e.g."pci_vendor_id=0x1186 pci_device_id=0x1300")
560 #
561 TGT_LD_DRIVERS  = $(subst -,_,$(patsubst %,obj_%,$(TGT_DRIVERS)))
562 TGT_LD_PREFIX   = obj_$(TGT_PREFIX)prefix
563 TGT_LD_IDS      = pci_vendor_id=$(firstword $(TGT_PCI_VENDOR) 0) \
564                   pci_device_id=$(firstword $(TGT_PCI_DEVICE) 0)
565
566 # Calculate linker flags based on link-time options for the current
567 # target type (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the
568 # variables:
569 #
570 # TGT_LD_FLAGS : target-specific flags to pass to linker (e.g.
571 #                "-u obj_zpciprefix -u obj_rtl8139 -u obj_prism2_pci
572 #                 --defsym pci_vendor=0x1186 --defsym pci_device=0x1300")
573 #
574 TGT_LD_FLAGS    = $(foreach SYM,$(TGT_LD_PREFIX) $(TGT_LD_DRIVERS) obj_config,\
575                     -u $(SYM) --defsym check_$(SYM)=$(SYM) ) \
576                   $(patsubst %,--defsym %,$(TGT_LD_IDS))
577
578 # Calculate makerom flags for the specific target
579 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
580 #
581 # TGT_MAKEROM_FLAGS : target-specific flags for makerom (e.g.
582 #                     "-p 0x1186,0x1300")
583 #
584 TGT_MAKEROM_FLAGS = $(strip $(MAKEROM_FLAGS_$(TGT_ROM_NAME)) \
585        $(if $(TGT_PCI_VENDOR),$(strip -p $(TGT_PCI_VENDOR),$(TGT_PCI_DEVICE))))
586
587 # Calculate list of debugging versions of objects to be included in
588 # the target.
589 #
590 DEBUG_LIST      = $(subst $(COMMA), ,$(DEBUG))
591 DEBUG_OBJ_LEVEL = $(firstword $(word 2,$(subst :, ,$(1))) 1)
592 DEBUG_OBJ_BASE  = $(word 1,$(subst :, ,$(1))).dbg$(call DEBUG_OBJ_LEVEL,$(1))
593 DEBUG_OBJ       = $(BIN)/$(call DEBUG_OBJ_BASE,$(1)).o
594 DEBUG_ORIG_OBJ  = $(BIN)/$(word 1,$(subst :, ,$(1))).o
595 DEBUG_OBJS      = $(foreach D,$(DEBUG_LIST),$(call DEBUG_OBJ,$(D)))
596 DEBUG_ORIG_OBJS = $(foreach D,$(DEBUG_LIST),$(call DEBUG_ORIG_OBJ,$(D)))
597 BLIB_OBJS       = $(DEBUG_OBJS) $(filter-out $(DEBUG_ORIG_OBJS),$(BOBJS))
598
599 # Print out all derived information for a given target.
600 #
601 $(BIN)/%.info :
602         @$(ECHO) 'Elements             : $(TGT_ELEMENTS)'
603         @$(ECHO) 'Prefix               : $(TGT_PREFIX)'
604         @$(ECHO) 'Drivers              : $(TGT_DRIVERS)'
605         @$(ECHO) 'ROM name             : $(TGT_ROM_NAME)'
606         @$(ECHO) 'Media                : $(TGT_MEDIA)'
607         @$(ECHO)
608         @$(ECHO) 'PCI vendor           : $(TGT_PCI_VENDOR)'
609         @$(ECHO) 'PCI device           : $(TGT_PCI_DEVICE)'
610         @$(ECHO)
611         @$(ECHO) 'LD driver symbols    : $(TGT_LD_DRIVERS)'
612         @$(ECHO) 'LD prefix symbols    : $(TGT_LD_PREFIX)'
613         @$(ECHO) 'LD ID symbols        : $(TGT_LD_IDS)'
614         @$(ECHO)
615         @$(ECHO) 'LD target flags      : $(TGT_LD_FLAGS)'
616         @$(ECHO)
617         @$(ECHO) 'makerom target flags : $(TGT_MAKEROM_FLAGS)'
618         @$(ECHO)
619         @$(ECHO) 'Debugging objects    : $(DEBUG_OBJS)'
620         @$(ECHO) 'Replaced objects     : $(DEBUG_ORIG_OBJS)'
621
622 # List of objects included in the last build of blib.  This is needed
623 # in order to correctly rebuild blib whenever the list of objects
624 # changes.
625 #
626 BLIB_LIST       := $(BIN)/.blib.list
627 ifeq ($(wildcard $(BLIB_LIST)),)
628 BLIB_LIST_OBJS  := <invalid>
629 else
630 BLIB_LIST_OBJS  := $(shell cat $(BLIB_LIST))
631 endif
632 ifneq ($(BLIB_LIST_OBJS),$(BLIB_OBJS))
633 $(shell $(ECHO) "$(BLIB_OBJS)" > $(BLIB_LIST))
634 endif
635
636 $(BLIB_LIST) :
637
638 VERYCLEANUP     += $(BLIB_LIST)
639
640 # Library of all objects
641 #
642 BLIB            = $(BIN)/blib.a
643 $(BLIB) : $(BLIB_OBJS) $(BLIB_LIST) $(MAKEDEPS)
644         $(Q)$(RM) $(BLIB)
645         $(QM)$(ECHO) "  [AR] $@"
646         $(Q)$(AR) r $@ $(BLIB_OBJS)
647         $(Q)$(RANLIB) $@
648 blib : $(BLIB)
649
650 # Build an intermediate object file from the objects required for the
651 # specified target.
652 #
653 $(BIN)/%.tmp : $(BLIB) $(MAKEDEPS) $(LDSCRIPT) 
654         $(QM)$(ECHO) "  [LD] $@"
655         $(Q)$(LD) $(LDFLAGS) -T $(LDSCRIPT) $(TGT_LD_FLAGS) $(BLIB) -o $@ \
656                 -Map $(BIN)/$*.tmp.map
657         $(Q)$(OBJDUMP) -ht $@ | $(SORTOBJDUMP) >> $(BIN)/$*.tmp.map
658
659 # Keep intermediate object file (useful for debugging)
660 .PRECIOUS : $(BIN)/%.tmp
661
662 # Show a linker map for the specified target
663 #
664 $(BIN)/%.map : $(BIN)/%.tmp
665         @less $(BIN)/$*.tmp.map
666
667 # Extract compression information from intermediate object file
668 #
669 $(BIN)/%.zinfo : $(BIN)/%.tmp
670         $(QM)$(ECHO) "  [ZINFO] $@"
671         $(Q)$(OBJCOPY) -O binary -j .zinfo $< $@
672
673 # Build raw binary file from intermediate object file
674 #
675 $(BIN)/%.bin : $(BIN)/%.tmp
676         $(QM)$(ECHO) "  [BIN] $@"
677         $(Q)$(OBJCOPY) -O binary -R .zinfo $< $@
678
679 # Compress raw binary file
680 #
681 $(BIN)/%.zbin : $(BIN)/%.bin $(BIN)/%.zinfo $(ZBIN)
682         $(QM)$(ECHO) "  [ZBIN] $@"
683         $(Q)$(ZBIN) $(BIN)/$*.bin $(BIN)/$*.zinfo > $@
684
685 # Rules for each media format.  These are generated and placed in an
686 # external Makefile fragment.  We could do this via $(eval ...), but
687 # that would require make >= 3.80.
688
689 # Note that there's an alternative way to generate most .rom images:
690 # they can be copied from their 'master' ROM image using cp and
691 # reprocessed with makerom to add the PCI IDs and ident string.  The
692 # relevant rule would look something like:
693 #
694 #   $(BIN)/dfe538%rom : $(BIN)/rtl8139%rom
695 #       cat $< $@
696 #       $(FINALISE_rom)
697
698 # You can derive the ROM/driver relationships using the variables
699 # DRIVER_<rom> and/or ROMS_<driver>.
700
701 # We don't currently do this, because (a) it would require generating
702 # yet more Makefile fragments (since you need a rule for each ROM in
703 # ROMS), and (b) the linker is so fast that it probably wouldn't make
704 # much difference to the overall build time.
705
706 media :
707         @$(ECHO) $(MEDIA)
708
709 AUTO_MEDIA      = $(filter-out $(NON_AUTO_MEDIA),$(MEDIA))
710 automedia :
711         @$(ECHO) $(AUTO_MEDIA)
712
713 # media_template : create Makefile rules for specified media
714 #
715 # $(1) is the media name (e.g. "rom")
716 # $(2) is the full path to the .d file (e.g. "bin/deps/rom.media.d")
717 #
718 define media_template
719
720         @$(ECHO) "  [MEDIADEPS] $(1)"
721         @$(MKDIR) -p $(dir $(2))
722         @$(RM) $(2)
723         @$(TOUCH) $(2)
724         @$(ECHO_E) '$$(BIN)/%.$(1) : $$(BIN)/%.$(1).zbin' \
725                   '\n\t$$(QM)$(ECHO) "  [FINISH] $$@"' \
726                   '\n\t$$(Q)$$(CP) $$< $$@' \
727                   '\n\t$$(Q)$$(FINALISE_$(1))' \
728                 > $(2)
729
730 endef
731
732 # Rule to generate the Makefile rules to be included
733 #
734 $(BIN)/deps/%.media.d : $(MAKEDEPS)
735         $(if $(filter $(AUTO_MEDIA),$*), \
736                 $(call media_template,$*,$@), \
737                 @$(ECHO) 'ERROR: $* is not an AUTO_MEDIA' ; exit 1)
738
739 # Calculate and include the list of Makefile rules files
740 #
741 MEDIA_DEPS              = $(patsubst %,$(BIN)/deps/%.media.d,$(AUTO_MEDIA))
742 mediadeps :
743         @$(ECHO) $(MEDIA_DEPS)
744 ifdef NEED_DEPS
745 ifneq ($(MEDIA_DEPS),)
746 -include $(MEDIA_DEPS)
747 endif
748 endif
749
750 # Wrap up binary blobs (for embedded images)
751 #
752 $(BIN)/%.o : payload/%.img
753         $(QM)echo "  [WRAP] $@"
754         $(Q)$(LD) -b binary -r -o $@ $< --undefined obj_payload \
755                 --defsym obj_$*=0
756
757 BOBJS += $(patsubst payload/%.img,$(BIN)/%.o,$(wildcard payload/*.img))
758
759 # The "allXXXs" targets for each suffix
760 #
761 allall: allroms allzroms allpxes allisos alldsks
762 allroms allzroms : all%s : $(foreach ROM,$(ROMS),$(BIN)/$(ROM).%)
763 allpxes allisos alldsks : all%s : $(foreach DRIVER,$(DRIVERS),$(BIN)/$(DRIVER).%)
764
765 # Alias for gpxe.%
766 #
767 $(BIN)/etherboot.% : $(BIN)/gpxe.%
768         ln -sf $(notdir $<) $@
769
770 endif # defined(BIN)
771
772 ###############################################################################
773 #
774 # Rules for finalising files.  TGT_MAKEROM_FLAGS is defined as part of
775 # the automatic build system and varies by target; it includes the
776 # "-p 0x1234,0x5678" string to set the PCI IDs.
777 #
778 FINALISE_rom    = $(MAKEROM) $(MAKEROM_FLAGS) $(TGT_MAKEROM_FLAGS) \
779                   -i$(IDENT) -s 0 $@
780
781 # Some ROMs require specific flags to be passed to makerom.pl
782 #
783 MAKEROM_FLAGS_3c503 = -3
784
785 ###############################################################################
786 #
787 # The compression utilities
788 #
789 $(NRV2B) : util/nrv2b.c $(MAKEDEPS)
790         $(QM)$(ECHO) "  [HOSTCC] $@"
791         $(Q)$(HOST_CC) -O2 -DENCODE -DDECODE -DMAIN -DVERBOSE -DNDEBUG \
792                        -DBITSIZE=32 -DENDIAN=0 -o $@ $<
793 CLEANUP += $(NRV2B)
794
795 $(ZBIN) : util/zbin.c util/nrv2b.c $(MAKEDEPS)
796         $(QM)$(ECHO) "  [HOSTCC] $@"
797         $(Q)$(HOST_CC) -O2 -o $@ $<
798 CLEANUP += $(ZBIN)
799
800 ###############################################################################
801 #
802 # The EFI image converter
803 #
804 ELF2EFI_CFLAGS  := -I$(BINUTILS_DIR)/include -I$(BFD_DIR)/include \
805                    -idirafter include -L$(BINUTILS_DIR)/lib -L$(BFD_DIR)/lib \
806                    -lbfd -liberty -lz
807
808 $(ELF2EFI32) : util/elf2efi.c $(MAKEDEPS)
809         $(QM)$(ECHO) "  [HOSTCC] $@"
810         $(Q)$(HOST_CC) $(ELF2EFI_CFLAGS) -DMDE_CPU_IA32 -O2 -o $@ $<
811 CLEANUP += $(ELF2EFI32)
812
813 $(ELF2EFI64) : util/elf2efi.c $(MAKEDEPS)
814         $(QM)$(ECHO) "  [HOSTCC] $@"
815         $(Q)$(HOST_CC) $(ELF2EFI_CFLAGS) -DMDE_CPU_X64 -O2 -o $@ $<
816 CLEANUP += $(ELF2EFI64)
817
818 $(EFIROM) : util/efirom.c $(MAKEDEPS)
819         $(QM)$(ECHO) "  [HOSTCC] $@"
820         $(Q)$(HOST_CC) -idirafter include -O2 -o $@ $<
821 CLEANUP += $(EFIROM)
822
823 ###############################################################################
824 #
825 # The ICC fixup utility
826 #
827 $(ICCFIX) : util/iccfix.c $(MAKEDEPS)
828         $(QM)$(ECHO) "  [HOSTCC] $@"
829         $(Q)$(HOST_CC) -idirafter include -O2 -o $@ $<
830 CLEANUP += $(ICCFIX)
831
832 ###############################################################################
833 #
834 # The FireWire debugging proxy
835 #
836 $(FIREBUG) : util/firebug.c util/fwtools.c $(MAKEDEPS)
837         $(QM)$(ECHO) "  [HOSTCC] $@"
838         $(Q)$(HOST_CC) -idirafter include -O2 -o $@ $< util/fwtools.c -lraw1394
839 CLEANUP += $(FIREBUG)
840
841 ###############################################################################
842 #
843 # The FireWire image server
844 #
845 $(FIRESERVE) : util/fireserve.c util/fwtools.c $(MAKEDEPS)
846         $(QM)$(ECHO) "  [HOSTCC] $@"
847         $(Q)$(HOST_CC) -idirafter include -O2 -o $@ $< util/fwtools.c -lraw1394
848 CLEANUP += $(FIRESERVE)
849
850 ###############################################################################
851 #
852 # Auto-incrementing build serial number.  Append "bs" to your list of
853 # build targets to get a serial number printed at the end of the
854 # build.  Enable -DBUILD_SERIAL in order to see it when the code runs.
855 #
856 BUILDSERIAL_H           = config/.buildserial.h
857 BUILDSERIAL_NOW         = config/.buildserial.now
858 BUILDSERIAL_NEXT        = config/.buildserial.next
859
860 $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT) :
861         $(ECHO) 1 > $@
862
863 $(BUILDSERIAL_H) : $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT)
864         $(ECHO) '#define BUILD_SERIAL_NUM $(shell cat $<)' > $@
865
866 ifeq ($(filter bs,$(MAKECMDGOALS)),bs)
867 $(shell diff -q $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT) > /dev/null || \
868         cp -f $(BUILDSERIAL_NEXT) $(BUILDSERIAL_NOW))
869 endif
870
871 bs : $(BUILDSERIAL_NOW)
872         @$(ECHO) $$(( $(shell cat $<) + 1 )) > $(BUILDSERIAL_NEXT)
873         @$(ECHO) "Build serial number is $(shell cat $<)"
874
875 ###############################################################################
876 #
877 # Build the TAGS file(s) for emacs
878 #
879 TAGS :
880         ctags -e -R -f $@ --exclude=bin
881
882 CLEANUP += TAGS
883
884 ###############################################################################
885 #
886 # Force rebuild for any given target
887 #
888 %.rebuild :
889         rm -f $*
890         $(Q)$(MAKE) $*
891
892 ###############################################################################
893 #
894 # Symbol table checks
895 #
896
897 ifdef BIN
898
899 SYMTAB  = $(BIN)/symtab
900 $(SYMTAB) : $(BLIB)
901         $(OBJDUMP) -w -t $< > $@
902
903 CLEANUP += $(BIN)/symtab
904
905 symcheck : $(SYMTAB)
906         $(SYMCHECK) $<
907
908 endif # defined(BIN)
909
910 ###############################################################################
911 #
912 # Build bochs symbol table
913 #
914
915 ifdef BIN
916
917 $(BIN)/%.bxs : $(BIN)/%.tmp
918         $(NM) $< | cut -d" " -f1,3 > $@
919
920 endif # defined(BIN)
921
922 ###############################################################################
923 #
924 # Documentation
925 #
926
927 ifdef BIN
928
929 $(BIN)/doxygen.cfg : doxygen.cfg $(MAKEDEPS)
930         $(PERL) -pe 's{\@SRCDIRS\@}{$(SRCDIRS)}; ' \
931                 -e  's{\@BIN\@}{$(BIN)}; ' \
932                 -e  's{\@ARCH\@}{$(ARCH)}; ' \
933                 $< > $@
934
935 $(BIN)/doc : $(BIN)/doxygen.cfg
936         $(DOXYGEN) $<
937
938 .PHONY : $(BIN)/doc
939
940 VERYCLEANUP     += $(BIN)/doc
941
942 doc : $(BIN)/doc
943
944 docview :
945         @[ -f $(BIN)/doc/html/index.html ] || $(MAKE) $(BIN)/doc
946         @if [ -n "$$BROWSER" ] ; then \
947                 ( $$BROWSER $(BIN)/doc/html/index.html & ) ; \
948         else \
949                 $(ECHO) "Documentation index in $(BIN)/doc/html/index.html" ; \
950         fi
951
952 endif # defined(BIN)
953
954 ###############################################################################
955 #
956 # Clean-up
957 #
958 clean :
959         $(RM) $(CLEANUP)
960
961 veryclean : clean
962         $(RM) -r $(VERYCLEANUP)