Merged mcb30-realmode-redesign back to HEAD
[people/xl0/gpxe.git] / src / Makefile.housekeeping
1 # -*- makefile -*- : Force emacs to use Makefile mode
2
3 # This file contains various boring housekeeping functions that would
4 # otherwise seriously clutter up the main Makefile.
5
6 # Objects to be removed by "make clean"
7 #
8 CLEANUP := $(BIN)/*.* # *.* to avoid catching the "CVS" directory
9
10 # Version number calculations 
11 #
12 VERSION_MAJOR   = 5
13 VERSION_MINOR   = 3
14 VERSION_PATCH   = 14
15 EXTRAVERSION    =       
16 MM_VERSION      = $(VERSION_MAJOR).$(VERSION_MINOR)
17 VERSION         = $(MM_VERSION).$(VERSION_PATCH)$(EXTRAVERSION)
18 CFLAGS          += -DVERSION_MAJOR=$(VERSION_MAJOR) \
19                    -DVERSION_MINOR=$(VERSION_MINOR) \
20                    -DVERSION=\"$(VERSION)\"
21 IDENT           = '$(@F) $(VERSION) (GPL) etherboot.org'
22 version :
23         @echo $(VERSION)
24
25 # Check for tools that can cause failed builds
26 #
27 .toolcheck : Makefile Config
28         @if $(CC) -v 2>&1 | grep -is 'gcc version 2\.96' > /dev/null; then \
29                 echo 'gcc 2.96 is unsuitable for compiling Etherboot'; \
30                 echo 'Use gcc 2.95 or gcc 3.x instead'; \
31                 exit 1; \
32         fi
33         @if [ `perl -e 'use bytes; print chr(255)' | wc -c` = 2 ]; then \
34                 echo 'Your Perl version has a Unicode handling bug'; \
35                 echo 'Execute this command before compiling Etherboot:'; \
36                 echo 'export LANG=$${LANG%.UTF-8}'; \
37                 exit 1; \
38         fi
39         @$(TOUCH) $@
40 VERYCLEANUP     += .toolcheck
41
42 # Check for an old version of gas (binutils 2.9.1)
43 #
44 OLDGAS  := $(shell $(AS) --version | grep -q '2\.9\.1' && echo -DGAS291)
45 CFLAGS  += $(OLDGAS)
46 oldgas :
47         @echo $(oldgas)
48
49 # SRCDIRS lists all directories containing source files.
50 srcdirs :
51         @echo $(SRCDIRS)
52
53 # SRCS lists all .c or .S files found in any SRCDIR
54 #
55 SRCS    += $(wildcard $(patsubst %,%/*.c,$(SRCDIRS)))
56 SRCS    += $(wildcard $(patsubst %,%/*.S,$(SRCDIRS)))
57 srcs :
58         @echo $(SRCS)
59
60 # AUTO_SRCS lists all files in SRCS that are not mentioned in
61 # NON_AUTO_SRCS.  Files should be added to NON_AUTO_SRCS if they
62 # cannot be built using the standard build template.
63 #
64 AUTO_SRCS = $(filter-out $(NON_AUTO_SRCS),$(SRCS))
65 autosrcs :
66         @echo $(AUTO_SRCS)
67
68 # We automatically generate rules for any file mentioned in AUTO_SRCS
69 # using the following set of templates.  It would be cleaner to use
70 # $(eval ...), but this function exists only in GNU make >= 3.80.
71
72 # src_template : generate Makefile rules for a given source file
73 #
74 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
75 # $(2) is the full path to the .d file (e.g. "bin/deps/drivers/net/rtl8139.d")
76 # $(3) is the source type (e.g. "c")
77 # $(4) is the source base name (e.g. "rtl8139")
78 #
79 define src_template
80
81         @echo "Generating Makefile rules for $(1)"
82         @$(MKDIR) -p $(dir $(2))
83         @$(RM) $(2)
84         @$(TOUCH) $(2)
85         $(foreach OBJ,$(if $(OBJS_$(4)),$(OBJS_$(4)),$(4)), \
86                 $(call obj_template,$(1),$(2),$(3),$(OBJ)))
87         @$(PARSEROM) $(1) >> $(2)
88
89 endef
90
91 # obj_template : generate Makefile rules for a given resultant object
92 # of a particular source file.  (We can have multiple objects per
93 # source file via the OBJS_xxx list.)
94 #
95 # $(1) is the full path to the source file (e.g. "drivers/net/rtl8139.c")
96 # $(2) is the full path to the .d file (e.g. "bin/deps/drivers/net/rtl8139.d")
97 # $(3) is the source type (e.g. "c")
98 # $(4) is the object name (e.g. "rtl8139")
99 #
100 define obj_template
101
102         @$(CPP) $(CFLAGS) $(CFLAGS_$(3)) $(CFLAGS_$(4)) \
103                 -M $(1) -MT "$(4)_DEPS" | tr : = >> $(2)
104         @echo -e '\n$$(BIN)/$(4).o : $(1) $$(MAKEDEPS) $$($(4)_DEPS)' \
105                  '\n\t$$(RULE_$(3))\n' \
106                  '\nBOBJS += $$(BIN)/$(4).o\n' \
107                  $(foreach TGT,$(DEBUG_TARGETS), \
108                     $(if $(RULE_$(3)_to_$(TGT)), \
109                     '\n$$(BIN)/$(4).$(TGT) : $(1) $$(MAKEDEPS) $$($(4)_DEPS)' \
110                     '\n\t$$(RULE_$(3)_to_$(TGT))\n' ) ) \
111                  '\n$(2) : $$($(4)_DEPS)\n' \
112                  '\nTAGS : $$($(4)_DEPS)\n' \
113                 >> $(2)
114
115 endef
116
117 # Rule to generate the Makefile rules files to be included
118 #
119 $(BIN)/deps/%.d : % $(MAKEDEPS) $(PARSEROM)
120         $(if $(filter $(AUTO_SRCS),$<),$(call src_template,$<,$@,$(subst .,,$(suffix $<)),$(basename $(notdir $<))),@echo 'ERROR: $< is not an AUTO_SRC' ; exit 1)
121
122 # Calculate and include the list of Makefile rules files
123 #
124 AUTO_DEPS       = $(patsubst %,$(BIN)/deps/%.d,$(AUTO_SRCS))
125 include $(AUTO_DEPS)
126 autodeps :
127         @echo $(AUTO_DEPS)
128 VERYCLEANUP     += $(BIN)/deps
129
130 # The following variables are created by the Makefile rules files
131 #
132 bobjs :
133         @echo $(BOBJS)
134 drivers :
135         @echo $(DRIVERS)
136 .PHONY : drivers
137 roms :
138         @echo $(ROMS)
139
140 # Generate the NIC file from the parsed source files.  The NIC file is
141 # only for rom-o-matic.
142 #
143 $(BIN)/NIC : $(AUTO_DEPS)
144         @echo '# This is an automatically generated file, do not edit' > $@
145         @echo '# It does not affect anything in the build, ' \
146              'it is only for rom-o-matic' >> $@
147         @echo >> $@
148         @perl -ne 'chomp; print "$$1\n" if /\# NIC\t(.*)$$/' $^ >> $@
149 CLEANUP         += $(BIN)/NIC
150
151 # Library of all objects
152 #
153 $(BLIB) : $(BOBJS)
154         $(AR) r $@ $(BOBJS)
155         $(RANLIB) $@
156 blib : $(BLIB)
157
158 # Analyse a target name (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and
159 # derive the variables:
160
161 # TGT_ELEMENTS : the elements of the target (e.g. "dfe538 prism2_pci")
162 # TGT_PREFIX   : the prefix type (e.g. "zrom")
163 # TGT_DRIVERS  : the driver for each element (e.g. "rtl8139 prism2_pci")
164 # TGT_ROM_NAME : the ROM name (e.g. "dfe538")
165 # TGT_MEDIA    : the media type (e.g. "rom")
166 #
167 TGT_ELEMENTS    = $(subst --, ,$(firstword $(subst ., ,$(notdir $@))))
168 TGT_PREFIX      = $(word 2,$(subst ., ,$(notdir $@)))
169 TGT_DRIVERS     = $(strip $(foreach TGT_ELEMENT,$(TGT_ELEMENTS), \
170                    $(firstword $(DRIVER_$(TGT_ELEMENT)) $(TGT_ELEMENT))))
171 TGT_ROM_NAME    = $(firstword $(TGT_ELEMENTS))
172 TGT_MEDIA       = $(subst z,,$(TGT_PREFIX))
173
174 # Look up ROM type and IDs for the current target
175 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
176 #
177 # TGT_ROM_TYPE   : PCI/ISA indicator (e.g. "pci")
178 # TGT_PCI_VENDOR : the PCI vendor ID (e.g. "0x1186")
179 # TGT_PCI_DEVICE : the PCI device ID (e.g. "0x1300")
180 #
181 TGT_ROM_TYPE    = $(ROM_TYPE_$(TGT_ROM_NAME))
182 TGT_PCI_VENDOR  = $(PCI_VENDOR_$(TGT_ROM_NAME))
183 TGT_PCI_DEVICE  = $(PCI_DEVICE_$(TGT_ROM_NAME))
184
185 # Calculate link-time options for the current target
186 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
187 #
188 # TGT_LD_DRIVERS : symbols to require in order to drag in the relevant drivers
189 #                  (e.g. "obj_rtl8139 obj_prism2_pci")
190 # TGT_LD_PREFIX  : symbols to require in order to drag in the relevant prefix
191 #                  (e.g. "obj_zpciprefix")
192 # TGT_LD_IDS :     symbols to define in order to fill in ID structures in the
193 #                  ROM header (e.g. "pci_vendor=0x1186 pci_device=0x1300")
194 #
195 TGT_LD_DRIVERS  = $(subst -,_,$(patsubst %,obj_%,$(TGT_DRIVERS)))
196 TGT_LD_PREFIX   = obj_$(subst rom,$(TGT_ROM_TYPE),$(TGT_PREFIX))prefix
197 TGT_LD_IDS      = $(if $(TGT_PCI_VENDOR),pci_vendor=$(TGT_PCI_VENDOR)) \
198                   $(if $(TGT_PCI_DEVICE),pci_device=$(TGT_PCI_DEVICE))
199
200 # Calculate linker flags based on link-time options for the current
201 # target type (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the
202 # variables:
203 #
204 # TGT_LD_FLAGS : target-specific flags to pass to linker (e.g.
205 #                "-u obj_zpciprefix -u obj_rtl8139 -u obj_prism2_pci
206 #                 --defsym pci_vendor=0x1186 --defsym pci_device=0x1300")
207 #
208 TGT_LD_FLAGS    = $(foreach SYM,$(TGT_LD_PREFIX) $(TGT_LD_DRIVERS) obj_config,\
209                     -u $(SYM) --defsym check_$(SYM)=$(SYM) ) \
210                   $(patsubst %,--defsym %,$(TGT_LD_IDS))
211
212 # Calculate makerom flags for the specific target
213 # (e.g. "bin/dfe538--prism2_pci.zrom.tmp") and derive the variables:
214 #
215 # TGT_MAKEROM_FLAGS : target-specific flags for makerom (e.g.
216 #                     "-p 0x1186,0x1300")
217 #
218 TGT_MAKEROM_FLAGS = $(strip $(MAKEROM_FLAGS_$(TGT_ROM_NAME)) \
219        $(if $(TGT_PCI_VENDOR),$(strip -p $(TGT_PCI_VENDOR),$(TGT_PCI_DEVICE))))
220
221 # Print out all derived information for a given target.
222 #
223 $(BIN)/%.info :
224         @echo 'Elements             : $(TGT_ELEMENTS)'
225         @echo 'Prefix               : $(TGT_PREFIX)'
226         @echo 'Drivers              : $(TGT_DRIVERS)'
227         @echo 'ROM name             : $(TGT_ROM_NAME)'
228         @echo 'Media                : $(TGT_MEDIA)'
229         @echo
230         @echo 'ROM type             : $(TGT_ROM_TYPE)'
231         @echo 'PCI vendor           : $(TGT_PCI_VENDOR)'
232         @echo 'PCI device           : $(TGT_PCI_DEVICE)'
233         @echo
234         @echo 'LD driver symbols    : $(TGT_LD_DRIVERS)'
235         @echo 'LD prefix symbols    : $(TGT_LD_PREFIX)'
236         @echo 'LD ID symbols        : $(TGT_LD_IDS)'
237         @echo
238         @echo 'LD target flags      : $(TGT_LD_FLAGS)'
239         @echo
240         @echo 'makerom target flags : $(TGT_MAKEROM_FLAGS)'
241
242 # Build an intermediate object file from the objects required for the
243 # specified target.
244 #
245 $(BIN)/%.tmp : $(BLIB) $(MAKEDEPS) $(LDSCRIPT)
246         $(LD) $(LDFLAGS) -T $(LDSCRIPT) $(TGT_LD_FLAGS) $< -o $@ \
247                 -Map $(BIN)/$*.tmp.map
248
249 # Show a linker map for the specified target
250 #
251 $(BIN)/%.map : $(BIN)/%.tmp
252         @less $(BIN)/$*.tmp.map
253
254 # Rules for each media format.  These are generated and placed in an
255 # external Makefile fragment.  We could do this via $(eval ...), but
256 # that would require make >= 3.80.
257
258 # Note that there's an alternative way to generate most .rom images:
259 # they can be copied from their 'master' ROM image using cp and
260 # reprocessed with makerom to add the PCI IDs and ident string.  The
261 # relevant rule would look something like:
262 #
263 #   $(BIN)/dfe538%rom : $(BIN)/rtl8139%rom
264 #       cat $< $@
265 #       $(FINALISE_rom)
266
267 # You can derive the ROM/driver relationships using the variables
268 # DRIVER_<rom> and/or ROMS_<driver>.
269
270 # We don't currently do this, because (a) it would require generating
271 # yet more Makefile fragments (since you need a rule for each ROM in
272 # ROMS), and (b) the linker is so fast that it probably wouldn't make
273 # much difference to the overall build time.
274
275 media :
276         @echo $(MEDIA)
277
278 AUTO_MEDIA      = $(filter-out $(NON_AUTO_MEDIA),$(MEDIA))
279 automedia :
280         @echo $(AUTO_MEDIA)
281
282 # media_template : create Makefile rules for specified media
283 #
284 # $(1) is the media name (e.g. "rom")
285 # $(2) is the full path to the .d file (e.g. "bin/deps/rom.media.d")
286 #
287 define media_template
288
289         @echo "Generating Makefile rules for $(1) media"
290         @$(MKDIR) -p $(dir $(2))
291         @$(RM) $(2)
292         @$(TOUCH) $(2)
293         @echo -e '$$(BIN)/%$(1) : $$(BIN)/%$(1).tmp' \
294                   '\n\t$$(OBJCOPY) -O binary $$< $$@' \
295                   '\n\t$$(FINALISE_$(1))' \
296                 > $(2)
297
298 endef
299
300 # Rule to generate the Makefile rules to be included
301 #
302 $(BIN)/deps/%.media.d : $(MAKEDEPS)
303         $(if $(filter $(AUTO_MEDIA),$*), \
304                 $(call media_template,$*,$@), \
305                 @echo 'ERROR: $* is not an AUTO_MEDIA' ; exit 1)
306
307 # Calculate and include the list of Makefile rules files
308 #
309 MEDIA_DEPS              = $(patsubst %,$(BIN)/deps/%.media.d,$(AUTO_MEDIA))
310 mediadeps :
311         @echo $(MEDIA_DEPS)
312 include $(MEDIA_DEPS)
313
314 # The "allXXXs" targets for each suffix
315 #
316 allroms allzroms : all%s : $(foreach ROM,$(ROMS),$(BIN)/$(ROM).%)
317 all%s : $(foreach DRIVER,$(DRIVERS),$(BIN)/$(DRIVER).%)
318
319 # The compressor utility
320 #
321 $(NRV2B) : util/nrv2b.c $(MAKEDEPS)
322         $(HOST_CC) -O2 -DENCODE -DDECODE -DMAIN -DVERBOSE -DNDEBUG \
323                        -DBITSIZE=32 -DENDIAN=0 -o $@ $<
324 CLEANUP += $(NRV2B)
325
326 # Auto-incrementing build serial number.  Append "bs" to your list of
327 # build targets to get a serial number printed at the end of the
328 # build.  Enable -DBUILD_SERIAL in order to see it when the code runs.
329 #
330 BUILDSERIAL_H = include/.buildserial.h
331
332 $(BUILDSERIAL_H) :
333         @if [ ! -s $@ ]; then echo '#define BUILD_SERIAL_NUM 0' > $@; fi
334         @perl -pi -e 's/(BUILD_SERIAL_NUM)\s+(\d+)/"$${1} ".($${2}+1)/e' $@
335
336 bs : $(BUILDSERIAL_H)
337         @perl -n -e '/BUILD_SERIAL_NUM\s+(\d+)/ && ' \
338                 -e 'print "Build serial number is $$1\n";' $<
339
340 ifeq ($(filter bs,$(MAKECMDGOALS)),bs)
341 .PHONY : $(BUILDSERIAL_H)
342 endif
343
344 # Ensure that include/.buildserial.h always exists, to solve the
345 # problem of bootstrapping a BUILD_SERIAL-enabled build.
346 #
347 ifeq ($(wildcard $(BUILDSERIAL_H)),)
348 $(shell $(TOUCH) $(BUILDSERIAL_H))
349 endif
350
351 # List of available architectures
352 #
353 ARCHS   = $(filter-out CVS,$(patsubst arch/%,%,$(wildcard arch/*)))
354 archs :
355         @echo $(ARCHS)
356
357 OTHER_ARCHS     = $(filter-out $(ARCH),$(ARCHS))
358 otherarchs :
359         @echo $(OTHER_ARCHS)
360
361 # Build the TAGS file for emacs
362 #
363 TAGS : TAGS.$(ARCH)
364
365 TAGS.$(ARCH) : 
366         ctags -e -R -f $@ $(foreach ARCH,$(OTHER_ARCHS),--exclude=arch/$(ARCH))
367 CLEANUP += TAGS*
368
369 # Clean-up
370 #
371 clean :
372         $(RM) $(CLEANUP)
373
374 veryclean : clean
375         $(RM) -r $(VERYCLEANUP)