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