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