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