[makefile] Add support for multiple build platforms
[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 include arch/$(ARCH)/Makefile
233 endif
234
235 ###############################################################################
236 #
237 # config/%.h files are generated from config.h using mkconfig.pl
238 #
239 config/%.h : config*.h
240         $(MKCONFIG) config.h
241 CLEANUP += config/*.h
242
243 ###############################################################################
244 #
245 # Source file handling
246
247 # SRCDIRS lists all directories containing source files.
248 srcdirs :
249         @$(ECHO) $(SRCDIRS)
250
251 # SRCS lists all .c or .S files found in any SRCDIR
252 #
253 SRCS    += $(wildcard $(patsubst %,%/*.c,$(SRCDIRS)))
254 SRCS    += $(wildcard $(patsubst %,%/*.S,$(SRCDIRS)))
255 srcs :
256         @$(ECHO) $(SRCS)
257
258 # AUTO_SRCS lists all files in SRCS that are not mentioned in
259 # NON_AUTO_SRCS.  Files should be added to NON_AUTO_SRCS if they
260 # cannot be built using the standard build template.
261 #
262 AUTO_SRCS = $(filter-out $(NON_AUTO_SRCS),$(SRCS))
263 autosrcs :
264         @$(ECHO) $(AUTO_SRCS)
265
266 # Just about everything else in this section depends upon having
267 # $(BIN) set
268
269 ifdef BIN
270
271 # Common flags
272 #
273 CFLAGS          += -I include -I arch/$(ARCH)/include -I .
274 CFLAGS          += -Os -ffreestanding
275 CFLAGS          += -Wall -W
276 CFLAGS          += -g
277 CFLAGS          += $(EXTRA_CFLAGS)
278 ASFLAGS         += $(EXTRA_ASFLAGS)
279 LDFLAGS         += $(EXTRA_LDFLAGS)
280
281 # Embedded image, if present
282 #
283 EMBEDDED_IMAGE  = /dev/null
284
285 # Inhibit -Werror if NO_WERROR is specified on make command line
286 #
287 ifneq ($(NO_WERROR),1)
288 CFLAGS          += -Werror
289 endif
290
291 # compiler.h is needed for our linking and debugging system
292 #
293 CFLAGS          += -include compiler.h
294
295 # CFLAGS for specific object types
296 #
297 CFLAGS_c        +=
298 CFLAGS_S        += -DASSEMBLY
299
300 # Base object name of the current target
301 #
302 OBJECT          = $(firstword $(subst ., ,$(@F)))
303
304 # CFLAGS for specific object files.  You can define
305 # e.g. CFLAGS_rtl8139, and have those flags automatically used when
306 # compiling bin/rtl8139.o.
307 #
308 OBJ_CFLAGS      = $(CFLAGS_$(OBJECT)) -DOBJECT=$(subst -,_,$(OBJECT))
309 $(BIN)/%.flags :
310         @$(ECHO) $(OBJ_CFLAGS)
311
312 # Rules for specific object types.
313 #
314 COMPILE_c       = $(CC) $(CFLAGS) $(CFLAGS_c) $(OBJ_CFLAGS)
315 RULE_c          = $(Q)$(COMPILE_c) -c $< -o $@
316 RULE_c_to_dbg%.o = $(Q)$(COMPILE_c) -Ddebug_$(OBJECT)=$* -c $< -o $@
317 RULE_c_to_c     = $(Q)$(COMPILE_c) -E -c $< > $@
318 RULE_c_to_s     = $(Q)$(COMPILE_c) -S -g0 -c $< -o $@
319
320 PREPROCESS_S    = $(CPP) $(CFLAGS) $(CFLAGS_S) $(OBJ_CFLAGS)
321 ASSEMBLE_S      = $(AS) $(ASFLAGS)
322 RULE_S          = $(Q)$(PREPROCESS_S) $< | $(ASSEMBLE_S) -o $@
323 RULE_S_to_s     = $(Q)$(PREPROCESS_S) $< > $@
324
325 DEBUG_TARGETS   += dbg%.o c s
326
327 # We automatically generate rules for any file mentioned in AUTO_SRCS
328 # using the following set of templates.  It would be cleaner to use
329 # $(eval ...), but this function exists only in GNU make >= 3.80.
330
331 # src_template : generate Makefile rules for a given source file
332 #
333 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
334 # $(2) is the full path to the .d file (e.g. "bin/deps/drivers/net/rtl8139.d")
335 # $(3) is the source type (e.g. "c")
336 # $(4) is the source base name (e.g. "rtl8139")
337 #
338 define src_template
339
340         @$(ECHO) "  [DEPS] $(1)"
341         @$(MKDIR) -p $(dir $(2))
342         @$(RM) $(2)
343         @$(TOUCH) $(2)
344         $(foreach OBJ,$(if $(OBJS_$(4)),$(OBJS_$(4)),$(4)), \
345                 $(call obj_template,$(1),$(2),$(3),$(OBJ)))
346         @$(PARSEROM) $(1) >> $(2)
347
348 endef
349
350 # obj_template : generate Makefile rules for a given resultant object
351 # of a particular source file.  (We can have multiple objects per
352 # source file via the OBJS_xxx list.)
353 #
354 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
355 # $(2) is the full path to the .d file (e.g. "bin/deps/drivers/net/rtl8139.d")
356 # $(3) is the source type (e.g. "c")
357 # $(4) is the object name (e.g. "rtl8139")
358 #
359 define obj_template
360
361         @$(CPP) $(CFLAGS) $(CFLAGS_$(3)) $(CFLAGS_$(4)) -DOBJECT=$(4) \
362                 -Wno-error -MM $(1) -MT "$(4)_DEPS" -MG -MP | \
363                 sed 's/_DEPS\s*:/_DEPS =/' >> $(2)
364         @$(ECHO_E) '\n$$(BIN)/$(4).o : $(1) $$(MAKEDEPS) $$($(4)_DEPS)' \
365                  '\n\t$$(QM)$(ECHO) "  [BUILD] $$@"' \
366                  '\n\t$$(RULE_$(3))\n' \
367                  '\nBOBJS += $$(BIN)/$(4).o\n' \
368                  $(foreach TGT,$(DEBUG_TARGETS), \
369                     $(if $(RULE_$(3)_to_$(TGT)), \
370                     '\n$$(BIN)/$(4).$(TGT) : $(1) $$(MAKEDEPS) $$($(4)_DEPS)' \
371                     '\n\t$$(QM)$(ECHO) "  [BUILD] $$@"' \
372                     '\n\t$$(RULE_$(3)_to_$(TGT))\n' \
373                     '\n$(TGT)_OBJS += $$(BIN)/$(4).$(TGT)\n' ) ) \
374                  '\n$(2) : $$($(4)_DEPS)\n' \
375                  '\nTAGS : $$($(4)_DEPS)\n' \
376                 >> $(2)
377
378 endef
379
380 # Rule to generate the Makefile rules files to be included
381 #
382 $(BIN)/deps/%.d : % $(MAKEDEPS) $(PARSEROM)
383         $(if $(filter $(AUTO_SRCS),$<),$(call src_template,$<,$@,$(subst .,,$(suffix $<)),$(basename $(notdir $<))),@$(ECHO) 'ERROR: $< is not an AUTO_SRC' ; exit 1)
384
385 # Calculate and include the list of Makefile rules files
386 #
387 AUTO_DEPS       = $(patsubst %,$(BIN)/deps/%.d,$(AUTO_SRCS))
388 ifdef NEED_DEPS
389 -include $(AUTO_DEPS)
390 endif
391 autodeps :
392         @$(ECHO) $(AUTO_DEPS)
393 VERYCLEANUP     += $(BIN)/deps
394
395 # The following variables are created by the Makefile rules files
396 #
397 bobjs :
398         @$(ECHO) $(BOBJS)
399 drivers :
400         @$(ECHO) $(DRIVERS)
401 .PHONY : drivers
402 roms :
403         @$(ECHO) $(ROMS)
404
405 # Embedded binary
406 $(BIN)/embedimg.bin: $(EMBEDDED_IMAGE)
407         $(QM)$(ECHO) "  [COPY] $@"
408         $(Q)$(CP) -f $(EMBEDDED_IMAGE) $@
409
410 $(BIN)/embed.o: $(BIN)/embedimg.bin
411 CFLAGS_embed = -DEMBEDIMG=\"$(BIN)/embedimg.bin\"
412
413 # Generate the NIC file from the parsed source files.  The NIC file is
414 # only for rom-o-matic.
415 #
416 $(BIN)/NIC : $(AUTO_DEPS)
417         @$(ECHO) '# This is an automatically generated file, do not edit' > $@
418         @$(ECHO) '# It does not affect anything in the build, ' \
419              'it is only for rom-o-matic' >> $@
420         @$(ECHO) >> $@
421         @perl -ne 'chomp; print "$$1\n" if /\# NIC\t(.*)$$/' $^ >> $@
422 CLEANUP         += $(BIN)/NIC   # Doesn't match the $(BIN)/*.* pattern
423
424 # Analyse a target name (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and
425 # derive the variables:
426
427 # TGT_ELEMENTS : the elements of the target (e.g. "dfe538 prism2_pci")
428 # TGT_PREFIX   : the prefix type (e.g. "zrom")
429 # TGT_DRIVERS  : the driver for each element (e.g. "rtl8139 prism2_pci")
430 # TGT_ROM_NAME : the ROM name (e.g. "dfe538")
431 # TGT_MEDIA    : the media type (e.g. "rom")
432 #
433 DRIVERS_gpxe    = $(DRIVERS)
434 CARD_DRIVER     = $(firstword $(DRIVER_$(1)) $(1))
435 TGT_ELEMENTS    = $(subst --, ,$(firstword $(subst ., ,$(notdir $@))))
436 TGT_PREFIX      = $(word 2,$(subst ., ,$(notdir $@)))
437 TGT_ROM_NAME    = $(firstword $(TGT_ELEMENTS))
438 TGT_DRIVERS     = $(strip $(if $(DRIVERS_$(TGT_ROM_NAME)), \
439                                $(DRIVERS_$(TGT_ROM_NAME)), \
440                                $(foreach TGT_ELEMENT,$(TGT_ELEMENTS), \
441                                  $(call CARD_DRIVER,$(TGT_ELEMENT))) ))
442 TGT_MEDIA       = $(subst z,,$(TGT_PREFIX))
443
444 # Look up ROM IDs for the current target
445 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
446 #
447 # TGT_PCI_VENDOR : the PCI vendor ID (e.g. "0x1186")
448 # TGT_PCI_DEVICE : the PCI device ID (e.g. "0x1300")
449 #
450 TGT_PCI_VENDOR  = $(PCI_VENDOR_$(TGT_ROM_NAME))
451 TGT_PCI_DEVICE  = $(PCI_DEVICE_$(TGT_ROM_NAME))
452
453 # Calculate link-time options for the current target
454 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
455 #
456 # TGT_LD_DRIVERS : symbols to require in order to drag in the relevant drivers
457 #                  (e.g. "obj_rtl8139 obj_prism2_pci")
458 # TGT_LD_IDS :     symbols to define in order to fill in ID structures in the
459 #                  ROM header (e.g."pci_vendor_id=0x1186 pci_device_id=0x1300")
460 #
461 TGT_LD_DRIVERS  = $(subst -,_,$(patsubst %,obj_%,$(TGT_DRIVERS)))
462 TGT_LD_PREFIX   = obj_$(TGT_PREFIX)prefix
463 TGT_LD_IDS      = pci_vendor_id=$(firstword $(TGT_PCI_VENDOR) 0) \
464                   pci_device_id=$(firstword $(TGT_PCI_DEVICE) 0)
465
466 # Calculate linker flags based on link-time options for the current
467 # target type (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the
468 # variables:
469 #
470 # TGT_LD_FLAGS : target-specific flags to pass to linker (e.g.
471 #                "-u obj_zpciprefix -u obj_rtl8139 -u obj_prism2_pci
472 #                 --defsym pci_vendor=0x1186 --defsym pci_device=0x1300")
473 #
474 TGT_LD_FLAGS    = $(foreach SYM,$(TGT_LD_PREFIX) $(TGT_LD_DRIVERS) obj_config,\
475                     -u $(SYM) --defsym check_$(SYM)=$(SYM) ) \
476                   $(patsubst %,--defsym %,$(TGT_LD_IDS))
477
478 # Calculate makerom flags for the specific target
479 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
480 #
481 # TGT_MAKEROM_FLAGS : target-specific flags for makerom (e.g.
482 #                     "-p 0x1186,0x1300")
483 #
484 TGT_MAKEROM_FLAGS = $(strip $(MAKEROM_FLAGS_$(TGT_ROM_NAME)) \
485        $(if $(TGT_PCI_VENDOR),$(strip -p $(TGT_PCI_VENDOR),$(TGT_PCI_DEVICE))))
486
487 # Calculate list of debugging versions of objects to be included in
488 # the target.
489 #
490 COMMA           := ,
491 DEBUG_LIST      = $(subst $(COMMA), ,$(DEBUG))
492 DEBUG_OBJ_LEVEL = $(firstword $(word 2,$(subst :, ,$(1))) 1)
493 DEBUG_OBJ_BASE  = $(word 1,$(subst :, ,$(1))).dbg$(call DEBUG_OBJ_LEVEL,$(1))
494 DEBUG_OBJ       = $(BIN)/$(call DEBUG_OBJ_BASE,$(1)).o
495 DEBUG_ORIG_OBJ  = $(BIN)/$(word 1,$(subst :, ,$(1))).o
496 DEBUG_OBJS      = $(foreach D,$(DEBUG_LIST),$(call DEBUG_OBJ,$(D)))
497 DEBUG_ORIG_OBJS = $(foreach D,$(DEBUG_LIST),$(call DEBUG_ORIG_OBJ,$(D)))
498 BLIB_OBJS       = $(DEBUG_OBJS) $(filter-out $(DEBUG_ORIG_OBJS),$(BOBJS))
499
500 # Print out all derived information for a given target.
501 #
502 $(BIN)/%.info :
503         @$(ECHO) 'Elements             : $(TGT_ELEMENTS)'
504         @$(ECHO) 'Prefix               : $(TGT_PREFIX)'
505         @$(ECHO) 'Drivers              : $(TGT_DRIVERS)'
506         @$(ECHO) 'ROM name             : $(TGT_ROM_NAME)'
507         @$(ECHO) 'Media                : $(TGT_MEDIA)'
508         @$(ECHO)
509         @$(ECHO) 'PCI vendor           : $(TGT_PCI_VENDOR)'
510         @$(ECHO) 'PCI device           : $(TGT_PCI_DEVICE)'
511         @$(ECHO)
512         @$(ECHO) 'LD driver symbols    : $(TGT_LD_DRIVERS)'
513         @$(ECHO) 'LD prefix symbols    : $(TGT_LD_PREFIX)'
514         @$(ECHO) 'LD ID symbols        : $(TGT_LD_IDS)'
515         @$(ECHO)
516         @$(ECHO) 'LD target flags      : $(TGT_LD_FLAGS)'
517         @$(ECHO)
518         @$(ECHO) 'makerom target flags : $(TGT_MAKEROM_FLAGS)'
519         @$(ECHO)
520         @$(ECHO) 'Debugging objects    : $(DEBUG_OBJS)'
521         @$(ECHO) 'Replaced objects     : $(DEBUG_ORIG_OBJS)'
522
523 # List of objects included in the last build of blib.  This is needed
524 # in order to correctly rebuild blib whenever the list of objects
525 # changes.
526 #
527 BLIB_LIST       := $(BIN)/.blib.list
528 ifeq ($(wildcard $(BLIB_LIST)),)
529 BLIB_LIST_OBJS  :=
530 else
531 BLIB_LIST_OBJS  := $(shell cat $(BLIB_LIST))
532 endif
533 ifneq ($(BLIB_LIST_OBJS),$(BLIB_OBJS))
534 $(shell $(ECHO) "$(BLIB_OBJS)" > $(BLIB_LIST))
535 endif
536
537 $(BLIB_LIST) :
538
539 VERYCLEANUP     += $(BLIB_LIST)
540
541 # Library of all objects
542 #
543 BLIB            = $(BIN)/blib.a
544 $(BLIB) : $(BLIB_OBJS) $(BLIB_LIST) $(MAKEDEPS)
545         $(Q)$(RM) $(BLIB)
546         $(QM)$(ECHO) "  [AR] $@"
547         $(Q)$(AR) r $@ $(BLIB_OBJS)
548         $(Q)$(RANLIB) $@
549 blib : $(BLIB)
550
551 # Build an intermediate object file from the objects required for the
552 # specified target.
553 #
554 $(BIN)/%.tmp : $(BLIB) $(MAKEDEPS) $(LDSCRIPT) 
555         $(QM)$(ECHO) "  [LD] $@"
556         $(Q)$(LD) $(LDFLAGS) -T $(LDSCRIPT) $(TGT_LD_FLAGS) $(BLIB) -o $@ \
557                 -Map $(BIN)/$*.tmp.map
558         $(Q)$(OBJDUMP) -ht $@ | $(SORTOBJDUMP) >> $(BIN)/$*.tmp.map
559
560 # Keep intermediate object file (useful for debugging)
561 .PRECIOUS : $(BIN)/%.tmp
562
563 # Show a linker map for the specified target
564 #
565 $(BIN)/%.map : $(BIN)/%.tmp
566         @less $(BIN)/$*.tmp.map
567
568 # Extract compression information from intermediate object file
569 #
570 $(BIN)/%.zinfo : $(BIN)/%.tmp
571         $(QM)$(ECHO) "  [ZINFO] $@"
572         $(Q)$(OBJCOPY) -O binary -j .zinfo $< $@
573
574 # Build raw binary file from intermediate object file
575 #
576 $(BIN)/%.bin : $(BIN)/%.tmp
577         $(QM)$(ECHO) "  [BIN] $@"
578         $(Q)$(OBJCOPY) -O binary -R .zinfo $< $@
579
580 # Compress raw binary file
581 #
582 $(BIN)/%.zbin : $(BIN)/%.bin $(BIN)/%.zinfo $(ZBIN)
583         $(QM)$(ECHO) "  [ZBIN] $@"
584         $(Q)$(ZBIN) $(BIN)/$*.bin $(BIN)/$*.zinfo > $@
585
586 # Rules for each media format.  These are generated and placed in an
587 # external Makefile fragment.  We could do this via $(eval ...), but
588 # that would require make >= 3.80.
589
590 # Note that there's an alternative way to generate most .rom images:
591 # they can be copied from their 'master' ROM image using cp and
592 # reprocessed with makerom to add the PCI IDs and ident string.  The
593 # relevant rule would look something like:
594 #
595 #   $(BIN)/dfe538%rom : $(BIN)/rtl8139%rom
596 #       cat $< $@
597 #       $(FINALISE_rom)
598
599 # You can derive the ROM/driver relationships using the variables
600 # DRIVER_<rom> and/or ROMS_<driver>.
601
602 # We don't currently do this, because (a) it would require generating
603 # yet more Makefile fragments (since you need a rule for each ROM in
604 # ROMS), and (b) the linker is so fast that it probably wouldn't make
605 # much difference to the overall build time.
606
607 media :
608         @$(ECHO) $(MEDIA)
609
610 AUTO_MEDIA      = $(filter-out $(NON_AUTO_MEDIA),$(MEDIA))
611 automedia :
612         @$(ECHO) $(AUTO_MEDIA)
613
614 # media_template : create Makefile rules for specified media
615 #
616 # $(1) is the media name (e.g. "rom")
617 # $(2) is the full path to the .d file (e.g. "bin/deps/rom.media.d")
618 #
619 define media_template
620
621         @$(ECHO) "  [MEDIADEPS] $(1)"
622         @$(MKDIR) -p $(dir $(2))
623         @$(RM) $(2)
624         @$(TOUCH) $(2)
625         @$(ECHO_E) '$$(BIN)/%.$(1) : $$(BIN)/%.$(1).zbin' \
626                   '\n\t$$(QM)$(ECHO) "  [FINISH] $$@"' \
627                   '\n\t$$(Q)$$(CP) $$< $$@' \
628                   '\n\t$$(Q)$$(FINALISE_$(1))' \
629                 > $(2)
630
631 endef
632
633 # Rule to generate the Makefile rules to be included
634 #
635 $(BIN)/deps/%.media.d : $(MAKEDEPS)
636         $(if $(filter $(AUTO_MEDIA),$*), \
637                 $(call media_template,$*,$@), \
638                 @$(ECHO) 'ERROR: $* is not an AUTO_MEDIA' ; exit 1)
639
640 # Calculate and include the list of Makefile rules files
641 #
642 MEDIA_DEPS              = $(patsubst %,$(BIN)/deps/%.media.d,$(AUTO_MEDIA))
643 mediadeps :
644         @$(ECHO) $(MEDIA_DEPS)
645 ifdef NEED_DEPS
646 -include $(MEDIA_DEPS)
647 endif
648
649 # Wrap up binary blobs (for embedded images)
650 #
651 $(BIN)/%.o : payload/%.img
652         $(QM)echo "  [WRAP] $@"
653         $(Q)$(LD) -b binary -r -o $@ $< --undefined obj_payload \
654                 --defsym obj_$*=0
655
656 BOBJS += $(patsubst payload/%.img,$(BIN)/%.o,$(wildcard payload/*.img))
657
658 # The "allXXXs" targets for each suffix
659 #
660 allall: allroms allzroms allpxes allisos alldsks
661 allroms allzroms : all%s : $(foreach ROM,$(ROMS),$(BIN)/$(ROM).%)
662 allpxes allisos alldsks : all%s : $(foreach DRIVER,$(DRIVERS),$(BIN)/$(DRIVER).%)
663
664 # Alias for gpxe.%
665 #
666 $(BIN)/etherboot.% : $(BIN)/gpxe.%
667         ln -sf $(notdir $<) $@
668
669 endif # defined(BIN)
670
671 ###############################################################################
672 #
673 # Rules for finalising files.  TGT_MAKEROM_FLAGS is defined as part of
674 # the automatic build system and varies by target; it includes the
675 # "-p 0x1234,0x5678" string to set the PCI IDs.
676 #
677 FINALISE_rom    = $(MAKEROM) $(MAKEROM_FLAGS) $(TGT_MAKEROM_FLAGS) \
678                   -i$(IDENT) -s 0 $@
679
680 # Some ROMs require specific flags to be passed to makerom.pl
681 #
682 MAKEROM_FLAGS_3c503 = -3
683
684 ###############################################################################
685 #
686 # The compression utilities
687 #
688 $(NRV2B) : util/nrv2b.c $(MAKEDEPS)
689         $(QM)$(ECHO) "  [HOSTCC] $@"
690         $(Q)$(HOST_CC) -O2 -DENCODE -DDECODE -DMAIN -DVERBOSE -DNDEBUG \
691                        -DBITSIZE=32 -DENDIAN=0 -o $@ $<
692 CLEANUP += $(NRV2B)
693
694 $(ZBIN) : util/zbin.c util/nrv2b.c $(MAKEDEPS)
695         $(QM)$(ECHO) "  [HOSTCC] $@"
696         $(Q)$(HOST_CC) -O2 -o $@ $<
697 CLEANUP += $(ZBIN)
698
699 ###############################################################################
700 #
701 # Auto-incrementing build serial number.  Append "bs" to your list of
702 # build targets to get a serial number printed at the end of the
703 # build.  Enable -DBUILD_SERIAL in order to see it when the code runs.
704 #
705 BUILDSERIAL_H           = config/.buildserial.h
706 BUILDSERIAL_NOW         = config/.buildserial.now
707 BUILDSERIAL_NEXT        = config/.buildserial.next
708
709 $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT) :
710         $(ECHO) 1 > $@
711
712 $(BUILDSERIAL_H) : $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT)
713         $(ECHO) '#define BUILD_SERIAL_NUM $(shell cat $<)' > $@
714
715 ifeq ($(filter bs,$(MAKECMDGOALS)),bs)
716 $(shell diff -q $(BUILDSERIAL_NOW) $(BUILDSERIAL_NEXT) > /dev/null || \
717         cp -f $(BUILDSERIAL_NEXT) $(BUILDSERIAL_NOW))
718 endif
719
720 bs : $(BUILDSERIAL_NOW)
721         @$(ECHO) $$(( $(shell cat $<) + 1 )) > $(BUILDSERIAL_NEXT)
722         @$(ECHO) "Build serial number is $(shell cat $<)"
723
724 ###############################################################################
725 #
726 # Build the TAGS file(s) for emacs
727 #
728 TAGS :
729         ctags -e -R -f $@ --exclude=bin
730
731 CLEANUP += TAGS
732
733 ###############################################################################
734 #
735 # Force rebuild for any given target
736 #
737 %.rebuild :
738         rm -f $*
739         $(Q)$(MAKE) $*
740
741 ###############################################################################
742 #
743 # Symbol table checks
744 #
745
746 ifdef BIN
747
748 SYMTAB  = $(BIN)/symtab
749 $(SYMTAB) : $(BLIB)
750         $(OBJDUMP) -w -t $< > $@
751
752 CLEANUP += $(BIN)/symtab
753
754 symcheck : $(SYMTAB)
755         $(SYMCHECK) $<
756
757 endif # defined(BIN)
758
759 ###############################################################################
760 #
761 # Build bochs symbol table
762 #
763
764 ifdef BIN
765
766 $(BIN)/%.bxs : $(BIN)/%.tmp
767         $(NM) $< | cut -d" " -f1,3 > $@
768
769 endif # defined(BIN)
770
771 ###############################################################################
772 #
773 # Documentation
774 #
775
776 ifdef BIN
777
778 $(BIN)/doxygen.cfg : doxygen.cfg $(MAKEDEPS)
779         $(PERL) -pe 's{\@SRCDIRS\@}{$(SRCDIRS)}; ' \
780                 -e  's{\@BIN\@}{$(BIN)}; ' \
781                 -e  's{\@ARCH\@}{$(ARCH)}; ' \
782                 $< > $@
783
784 $(BIN)/doc : $(BIN)/doxygen.cfg
785         $(DOXYGEN) $<
786
787 .PHONY : $(BIN)/doc
788
789 VERYCLEANUP     += $(BIN)/doc
790
791 doc : $(BIN)/doc
792
793 docview :
794         @[ -f $(BIN)/doc/html/index.html ] || $(MAKE) $(BIN)/doc
795         @if [ -n "$$BROWSER" ] ; then \
796                 ( $$BROWSER $(BIN)/doc/html/index.html & ) ; \
797         else \
798                 $(ECHO) "Documentation index in $(BIN)/doc/html/index.html" ; \
799         fi
800
801 endif # defined(BIN)
802
803 ###############################################################################
804 #
805 # Clean-up
806 #
807 clean :
808         $(RM) $(CLEANUP)
809
810 veryclean : clean
811         $(RM) -r $(VERYCLEANUP)