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