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