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