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