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