Merged mcb30-realmode-redesign back to HEAD

1 files changed, 375 insertions, 0 deletions

diff --git a/src/Makefile.housekeeping b/src/Makefile.housekeeping
new file mode 100644
index 00000000..57538bef
--- /dev/null
+++ b/src/Makefile.housekeeping
@@ -0,0 +1,375 @@
+# -*- makefile -*- : Force emacs to use Makefile mode
+
+# This file contains various boring housekeeping functions that would
+# otherwise seriously clutter up the main Makefile.
+
+# Objects to be removed by "make clean"
+#
+CLEANUP	:= $(BIN)/*.* # *.* to avoid catching the "CVS" directory
+
+# Version number calculations 
+#
+VERSION_MAJOR	= 5
+VERSION_MINOR	= 3
+VERSION_PATCH	= 14
+EXTRAVERSION	=	
+MM_VERSION	= $(VERSION_MAJOR).$(VERSION_MINOR)
+VERSION		= $(MM_VERSION).$(VERSION_PATCH)$(EXTRAVERSION)
+CFLAGS		+= -DVERSION_MAJOR=$(VERSION_MAJOR) \
+		   -DVERSION_MINOR=$(VERSION_MINOR) \
+		   -DVERSION=\"$(VERSION)\"
+IDENT		= '$(@F) $(VERSION) (GPL) etherboot.org'
+version :
+	@echo $(VERSION)
+
+# Check for tools that can cause failed builds
+#
+.toolcheck : Makefile Config
+	@if $(CC) -v 2>&1 | grep -is 'gcc version 2\.96' > /dev/null; then \
+		echo 'gcc 2.96 is unsuitable for compiling Etherboot'; \
+		echo 'Use gcc 2.95 or gcc 3.x instead'; \
+		exit 1; \
+	fi
+	@if [ `perl -e 'use bytes; print chr(255)' | wc -c` = 2 ]; then \
+		echo 'Your Perl version has a Unicode handling bug'; \
+		echo 'Execute this command before compiling Etherboot:'; \
+		echo 'export LANG=$${LANG%.UTF-8}'; \
+		exit 1; \
+	fi
+	@$(TOUCH) $@
+VERYCLEANUP	+= .toolcheck
+
+# Check for an old version of gas (binutils 2.9.1)
+#
+OLDGAS	:= $(shell $(AS) --version | grep -q '2\.9\.1' && echo -DGAS291)
+CFLAGS	+= $(OLDGAS)
+oldgas :
+	@echo $(oldgas)
+
+# SRCDIRS lists all directories containing source files.
+srcdirs :
+	@echo $(SRCDIRS)
+
+# SRCS lists all .c or .S files found in any SRCDIR
+#
+SRCS	+= $(wildcard $(patsubst %,%/*.c,$(SRCDIRS)))
+SRCS	+= $(wildcard $(patsubst %,%/*.S,$(SRCDIRS)))
+srcs :
+	@echo $(SRCS)
+
+# AUTO_SRCS lists all files in SRCS that are not mentioned in
+# NON_AUTO_SRCS.  Files should be added to NON_AUTO_SRCS if they
+# cannot be built using the standard build template.
+#
+AUTO_SRCS = $(filter-out $(NON_AUTO_SRCS),$(SRCS))
+autosrcs :
+	@echo $(AUTO_SRCS)
+
+# We automatically generate rules for any file mentioned in AUTO_SRCS
+# using the following set of templates.  It would be cleaner to use
+# $(eval ...), but this function exists only in GNU make >= 3.80.
+
+# src_template : generate Makefile rules for a given source file
+#
+# $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
+# $(2) is the full path to the .d file (e.g. "bin/deps/drivers/net/rtl8139.d")
+# $(3) is the source type (e.g. "c")
+# $(4) is the source base name (e.g. "rtl8139")
+#
+define src_template
+
+	@echo "Generating Makefile rules for $(1)"
+	@$(MKDIR) -p $(dir $(2))
+	@$(RM) $(2)
+	@$(TOUCH) $(2)
+	$(foreach OBJ,$(if $(OBJS_$(4)),$(OBJS_$(4)),$(4)), \
+		$(call obj_template,$(1),$(2),$(3),$(OBJ)))
+	@$(PARSEROM) $(1) >> $(2)
+
+endef
+
+# obj_template : generate Makefile rules for a given resultant object
+# of a particular source file.  (We can have multiple objects per
+# source file via the OBJS_xxx list.)
+#
+# $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
+# $(2) is the full path to the .d file (e.g. "bin/deps/drivers/net/rtl8139.d")
+# $(3) is the source type (e.g. "c")
+# $(4) is the object name (e.g. "rtl8139")
+#
+define obj_template
+
+	@$(CPP) $(CFLAGS) $(CFLAGS_$(3)) $(CFLAGS_$(4)) \
+		-M $(1) -MT "$(4)_DEPS" | tr : = >> $(2)
+	@echo -e '\n$$(BIN)/$(4).o : $(1) $$(MAKEDEPS) $$($(4)_DEPS)' \
+		 '\n\t$$(RULE_$(3))\n' \
+		 '\nBOBJS += $$(BIN)/$(4).o\n' \
+		 $(foreach TGT,$(DEBUG_TARGETS), \
+		    $(if $(RULE_$(3)_to_$(TGT)), \
+		    '\n$$(BIN)/$(4).$(TGT) : $(1) $$(MAKEDEPS) $$($(4)_DEPS)' \
+		    '\n\t$$(RULE_$(3)_to_$(TGT))\n' ) ) \
+		 '\n$(2) : $$($(4)_DEPS)\n' \
+		 '\nTAGS : $$($(4)_DEPS)\n' \
+		>> $(2)
+
+endef
+
+# Rule to generate the Makefile rules files to be included
+#
+$(BIN)/deps/%.d : % $(MAKEDEPS) $(PARSEROM)
+	$(if $(filter $(AUTO_SRCS),$<),$(call src_template,$<,$@,$(subst .,,$(suffix $<)),$(basename $(notdir $<))),@echo 'ERROR: $< is not an AUTO_SRC' ; exit 1)
+
+# Calculate and include the list of Makefile rules files
+#
+AUTO_DEPS	= $(patsubst %,$(BIN)/deps/%.d,$(AUTO_SRCS))
+include $(AUTO_DEPS)
+autodeps :
+	@echo $(AUTO_DEPS)
+VERYCLEANUP	+= $(BIN)/deps
+
+# The following variables are created by the Makefile rules files
+#
+bobjs :
+	@echo $(BOBJS)
+drivers :
+	@echo $(DRIVERS)
+.PHONY : drivers
+roms :
+	@echo $(ROMS)
+
+# Generate the NIC file from the parsed source files.  The NIC file is
+# only for rom-o-matic.
+#
+$(BIN)/NIC : $(AUTO_DEPS)
+	@echo '# This is an automatically generated file, do not edit' > $@
+	@echo '# It does not affect anything in the build, ' \
+	     'it is only for rom-o-matic' >> $@
+	@echo >> $@
+	@perl -ne 'chomp; print "$$1\n" if /\# NIC\t(.*)$$/' $^ >> $@
+CLEANUP		+= $(BIN)/NIC
+
+# Library of all objects
+#
+$(BLIB) : $(BOBJS)
+	$(AR) r $@ $(BOBJS)
+	$(RANLIB) $@
+blib : $(BLIB)
+
+# Analyse a target name (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and
+# derive the variables:
+# 
+# TGT_ELEMENTS : the elements of the target (e.g. "dfe538 prism2_pci")
+# TGT_PREFIX   : the prefix type (e.g. "zrom")
+# TGT_DRIVERS  : the driver for each element (e.g. "rtl8139 prism2_pci")
+# TGT_ROM_NAME : the ROM name (e.g. "dfe538")
+# TGT_MEDIA    : the media type (e.g. "rom")
+#
+TGT_ELEMENTS	= $(subst --, ,$(firstword $(subst ., ,$(notdir $@))))
+TGT_PREFIX	= $(word 2,$(subst ., ,$(notdir $@)))
+TGT_DRIVERS	= $(strip $(foreach TGT_ELEMENT,$(TGT_ELEMENTS), \
+		   $(firstword $(DRIVER_$(TGT_ELEMENT)) $(TGT_ELEMENT))))
+TGT_ROM_NAME	= $(firstword $(TGT_ELEMENTS))
+TGT_MEDIA	= $(subst z,,$(TGT_PREFIX))
+
+# Look up ROM type and IDs for the current target
+# (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
+#
+# TGT_ROM_TYPE   : PCI/ISA indicator (e.g. "pci")
+# TGT_PCI_VENDOR : the PCI vendor ID (e.g. "0x1186")
+# TGT_PCI_DEVICE : the PCI device ID (e.g. "0x1300")
+#
+TGT_ROM_TYPE	= $(ROM_TYPE_$(TGT_ROM_NAME))
+TGT_PCI_VENDOR	= $(PCI_VENDOR_$(TGT_ROM_NAME))
+TGT_PCI_DEVICE	= $(PCI_DEVICE_$(TGT_ROM_NAME))
+
+# Calculate link-time options for the current target
+# (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
+#
+# TGT_LD_DRIVERS : symbols to require in order to drag in the relevant drivers
+#		   (e.g. "obj_rtl8139 obj_prism2_pci")
+# TGT_LD_PREFIX  : symbols to require in order to drag in the relevant prefix
+#		   (e.g. "obj_zpciprefix")
+# TGT_LD_IDS :     symbols to define in order to fill in ID structures in the
+#		   ROM header (e.g. "pci_vendor=0x1186 pci_device=0x1300")
+#
+TGT_LD_DRIVERS	= $(subst -,_,$(patsubst %,obj_%,$(TGT_DRIVERS)))
+TGT_LD_PREFIX	= obj_$(subst rom,$(TGT_ROM_TYPE),$(TGT_PREFIX))prefix
+TGT_LD_IDS	= $(if $(TGT_PCI_VENDOR),pci_vendor=$(TGT_PCI_VENDOR)) \
+		  $(if $(TGT_PCI_DEVICE),pci_device=$(TGT_PCI_DEVICE))
+
+# Calculate linker flags based on link-time options for the current
+# target type (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the
+# variables:
+#
+# TGT_LD_FLAGS : target-specific flags to pass to linker (e.g.
+#		 "-u obj_zpciprefix -u obj_rtl8139 -u obj_prism2_pci
+#		  --defsym pci_vendor=0x1186 --defsym pci_device=0x1300")
+#
+TGT_LD_FLAGS	= $(foreach SYM,$(TGT_LD_PREFIX) $(TGT_LD_DRIVERS) obj_config,\
+		    -u $(SYM) --defsym check_$(SYM)=$(SYM) ) \
+		  $(patsubst %,--defsym %,$(TGT_LD_IDS))
+
+# Calculate makerom flags for the specific target
+# (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
+#
+# TGT_MAKEROM_FLAGS : target-specific flags for makerom (e.g.
+#		      "-p 0x1186,0x1300")
+#
+TGT_MAKEROM_FLAGS = $(strip $(MAKEROM_FLAGS_$(TGT_ROM_NAME)) \
+       $(if $(TGT_PCI_VENDOR),$(strip -p $(TGT_PCI_VENDOR),$(TGT_PCI_DEVICE))))
+
+# Print out all derived information for a given target.
+#
+$(BIN)/%.info :
+	@echo 'Elements             : $(TGT_ELEMENTS)'
+	@echo 'Prefix               : $(TGT_PREFIX)'
+	@echo 'Drivers              : $(TGT_DRIVERS)'
+	@echo 'ROM name             : $(TGT_ROM_NAME)'
+	@echo 'Media                : $(TGT_MEDIA)'
+	@echo
+	@echo 'ROM type             : $(TGT_ROM_TYPE)'
+	@echo 'PCI vendor           : $(TGT_PCI_VENDOR)'
+	@echo 'PCI device           : $(TGT_PCI_DEVICE)'
+	@echo
+	@echo 'LD driver symbols    : $(TGT_LD_DRIVERS)'
+	@echo 'LD prefix symbols    : $(TGT_LD_PREFIX)'
+	@echo 'LD ID symbols        : $(TGT_LD_IDS)'
+	@echo
+	@echo 'LD target flags      : $(TGT_LD_FLAGS)'
+	@echo
+	@echo 'makerom target flags : $(TGT_MAKEROM_FLAGS)'
+
+# Build an intermediate object file from the objects required for the
+# specified target.
+#
+$(BIN)/%.tmp : $(BLIB) $(MAKEDEPS) $(LDSCRIPT)
+	$(LD) $(LDFLAGS) -T $(LDSCRIPT) $(TGT_LD_FLAGS) $< -o $@ \
+		-Map $(BIN)/$*.tmp.map
+
+# Show a linker map for the specified target
+#
+$(BIN)/%.map : $(BIN)/%.tmp
+	@less $(BIN)/$*.tmp.map
+
+# Rules for each media format.  These are generated and placed in an
+# external Makefile fragment.  We could do this via $(eval ...), but
+# that would require make >= 3.80.
+# 
+# Note that there's an alternative way to generate most .rom images:
+# they can be copied from their 'master' ROM image using cp and
+# reprocessed with makerom to add the PCI IDs and ident string.  The
+# relevant rule would look something like:
+#
+#   $(BIN)/dfe538%rom : $(BIN)/rtl8139%rom
+#	cat $< $@
+#	$(FINALISE_rom)
+# 
+# You can derive the ROM/driver relationships using the variables
+# DRIVER_<rom> and/or ROMS_<driver>.
+# 
+# We don't currently do this, because (a) it would require generating
+# yet more Makefile fragments (since you need a rule for each ROM in
+# ROMS), and (b) the linker is so fast that it probably wouldn't make
+# much difference to the overall build time.
+
+media :
+	@echo $(MEDIA)
+
+AUTO_MEDIA	= $(filter-out $(NON_AUTO_MEDIA),$(MEDIA))
+automedia :
+	@echo $(AUTO_MEDIA)
+
+# media_template : create Makefile rules for specified media
+#
+# $(1) is the media name (e.g. "rom")
+# $(2) is the full path to the .d file (e.g. "bin/deps/rom.media.d")
+#
+define media_template
+
+	@echo "Generating Makefile rules for $(1) media"
+	@$(MKDIR) -p $(dir $(2))
+	@$(RM) $(2)
+	@$(TOUCH) $(2)
+	@echo -e '$$(BIN)/%$(1) : $$(BIN)/%$(1).tmp' \
+		  '\n\t$$(OBJCOPY) -O binary $$< $$@' \
+		  '\n\t$$(FINALISE_$(1))' \
+		> $(2)
+
+endef
+
+# Rule to generate the Makefile rules to be included
+#
+$(BIN)/deps/%.media.d : $(MAKEDEPS)
+	$(if $(filter $(AUTO_MEDIA),$*), \
+		$(call media_template,$*,$@), \
+		@echo 'ERROR: $* is not an AUTO_MEDIA' ; exit 1)
+
+# Calculate and include the list of Makefile rules files
+#
+MEDIA_DEPS		= $(patsubst %,$(BIN)/deps/%.media.d,$(AUTO_MEDIA))
+mediadeps :
+	@echo $(MEDIA_DEPS)
+include $(MEDIA_DEPS)
+
+# The "allXXXs" targets for each suffix
+#
+allroms allzroms : all%s : $(foreach ROM,$(ROMS),$(BIN)/$(ROM).%)
+all%s : $(foreach DRIVER,$(DRIVERS),$(BIN)/$(DRIVER).%)
+
+# The compressor utility
+#
+$(NRV2B) : util/nrv2b.c $(MAKEDEPS)
+	$(HOST_CC) -O2 -DENCODE -DDECODE -DMAIN -DVERBOSE -DNDEBUG \
+		       -DBITSIZE=32 -DENDIAN=0 -o $@ $<
+CLEANUP	+= $(NRV2B)
+
+# Auto-incrementing build serial number.  Append "bs" to your list of
+# build targets to get a serial number printed at the end of the
+# build.  Enable -DBUILD_SERIAL in order to see it when the code runs.
+#
+BUILDSERIAL_H = include/.buildserial.h
+
+$(BUILDSERIAL_H) :
+	@if [ ! -s $@ ]; then echo '#define BUILD_SERIAL_NUM 0' > $@; fi
+	@perl -pi -e 's/(BUILD_SERIAL_NUM)\s+(\d+)/"$${1} ".($${2}+1)/e' $@
+
+bs : $(BUILDSERIAL_H)
+	@perl -n -e '/BUILD_SERIAL_NUM\s+(\d+)/ && ' \
+		-e 'print "Build serial number is $$1\n";' $<
+
+ifeq ($(filter bs,$(MAKECMDGOALS)),bs)
+.PHONY : $(BUILDSERIAL_H)
+endif
+
+# Ensure that include/.buildserial.h always exists, to solve the
+# problem of bootstrapping a BUILD_SERIAL-enabled build.
+#
+ifeq ($(wildcard $(BUILDSERIAL_H)),)
+$(shell $(TOUCH) $(BUILDSERIAL_H))
+endif
+
+# List of available architectures
+#
+ARCHS	= $(filter-out CVS,$(patsubst arch/%,%,$(wildcard arch/*)))
+archs :
+	@echo $(ARCHS)
+
+OTHER_ARCHS	= $(filter-out $(ARCH),$(ARCHS))
+otherarchs :
+	@echo $(OTHER_ARCHS)
+
+# Build the TAGS file for emacs
+#
+TAGS : TAGS.$(ARCH)
+
+TAGS.$(ARCH) : 
+	ctags -e -R -f $@ $(foreach ARCH,$(OTHER_ARCHS),--exclude=arch/$(ARCH))
+CLEANUP	+= TAGS*
+
+# Clean-up
+#
+clean :
+	$(RM) $(CLEANUP)
+
+veryclean : clean
+	$(RM) -r $(VERYCLEANUP)