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