Add docs and check rules to build infrastructure.
[bertos.git] / rules.mk
1 #
2 # $Id$
3 # Copyright 2002,2003,2004,2005,2006 Develer S.r.l. (http://www.develer.com/)
4 # All rights reserved.
5 #
6 # Based on:
7 #   GCC-AVR standard Makefile part 2
8 #   Volker Oth 1/2000
9 #
10 # Author: Bernardo Innocenti <bernie@develer.com>
11 #
12
13 # Remove all default pattern rules
14 .SUFFIXES:
15
16 # Verbosity
17 ifeq ($(V),1)
18 # Verbose build
19 Q :=
20 L := @echo >/dev/null
21 else
22 # Quiet build
23 Q := @
24 L := @echo
25 endif
26
27 # Select Bourne Again SHell as default make shell
28 SHELL := bash
29
30 # Checker build
31 ifeq ($(C),1)
32 CC = $(CHECKER)
33 CFLAGS += -Wundef -D__x86_64__=1 -D__unix__=1 -D__linux__=1 -D__STDC_VERSION__=199901L
34 endif
35
36 # Initialize $(top_srcdir) with current directory, unless it was already initialized
37 top_srcdir ?= $(shell pwd)
38
39 # Products
40 TRG_ELF = $(TRG:%=$(OUTDIR)/%.elf)
41 TRG_S19 = $(TRG:%=$(OUTDIR)/%.s19)
42 TRG_HEX = $(TRG:%=$(OUTDIR)/%.hex)
43 TRG_BIN = $(TRG:%=$(OUTDIR)/%.bin)
44 TRG_ROM = $(TRG:%=$(OUTDIR)/%.rom)
45 TRG_COF = $(TRG:%=$(OUTDIR)/%.cof)
46 TRG_EXE = $(TRG:%=$(OUTDIR)/%)
47
48
49 RECURSIVE_TARGETS = all-recursive install-recursive clean-recursive
50
51 # The default target
52 .PHONY: all
53 ifeq ($(EMBEDDED_TARGET),1)
54 all:: all-recursive $(TRG_S19) $(TRG_HEX) $(TRG_BIN)
55 else
56 all:: all-recursive $(TRG_EXE)
57 endif
58
59 # Generate project documentation
60 .PHONY: docs
61 docs:
62         $Q $(DOXYGEN)
63
64 # Generate ctags
65 tags:
66         ctags -R --exclude=doc
67
68 # Run testsuite
69 check:
70         ./run_tests.sh
71
72 define build_target
73
74 ifneq ($$(strip $$($(1)_MCU)),)
75 # Define all project specific object files
76 $(1)_CFLAGS    += -mmcu=$$($(1)_MCU)
77 $(1)_CXXFLAGS  += -mmcu=$$($(1)_MCU)
78 $(1)_ASFLAGS   += -mmcu=$$($(1)_MCU)
79 $(1)_CPPAFLAGS += -mmcu=$$($(1)_MCU)
80 $(1)_LDFLAGS   += -mmcu=$$($(1)_MCU)
81 endif
82 ifneq ($$(strip $$($(1)_CPU)),)
83 # Define all project specific object files
84 $(1)_CFLAGS    += -mcpu=$$($(1)_CPU)
85 $(1)_CXXFLAGS  += -mcpu=$$($(1)_CPU)
86 $(1)_ASFLAGS   += -mcpu=$$($(1)_CPU)
87 $(1)_CPPAFLAGS += -mcpu=$$($(1)_CPU)
88 $(1)_LDFLAGS   += -mcpu=$$($(1)_CPU)
89 endif
90 ifneq ($$(strip $$($(1)_LDSCRIPT)),)
91 $(1)_LDFLAGS += -Wl,-T$$($(1)_LDSCRIPT)
92 endif
93
94 $(1)_CC      = $$($(1)_CROSS)$$(CC)
95 $(1)_CXX     = $$($(1)_CROSS)$$(CXX)
96 $(1)_AS      = $$($(1)_CROSS)$$(AS)
97 $(1)_OBJCOPY = $$($(1)_CROSS)$$(OBJCOPY)
98
99 $(1)_COBJ    = $$(foreach file,$$($(1)_CSRC:%.c=%.o),$$(OBJDIR)/$(1)/$$(file))
100 $(1)_CXXOBJ  = $$(foreach file,$$($(1)_CXXSRC:%.cpp=%.o),$$(OBJDIR)/$(1)/$$(file))
101 $(1)_PCOBJ   = $$(foreach file,$$($(1)_PCSRC:%.c=%_P.o),$$(OBJDIR)/$(1)/$$(file))
102 $(1)_AOBJ    = $$(foreach file,$$($(1)_ASRC:%.s=%.o),$$(OBJDIR)/$(1)/$$(file))
103 $(1)_CPPAOBJ = $$(foreach file,$$($(1)_CPPASRC:%.S=%.o),$$(OBJDIR)/$(1)/$$(file))
104 $(1)_OBJ    := $$($(1)_COBJ) $$($(1)_CXXOBJ) $$($(1)_PCOBJ) $$($(1)_AOBJ) $$($(1)_CPPAOBJ)
105 $(1)_SRC    := $$($(1)_CSRC) $$($(1)_CXXSRC) $$($(1)_PCSRC) $$($(1)_ASRC) $$($(1)_CPPASRC)
106 OBJ         += $$($(1)_OBJ)
107
108 ifneq ($$(strip $$($(1)_CXXSRC)),)
109 $(1)_LD = $$($(1)_CROSS)$$(LDXX)
110 else
111 $(1)_LD = $$($(1)_CROSS)$$(LD)
112 endif
113
114 # Compile: instructions to create assembler and/or object files from C source
115 $$($(1)_COBJ) : $$(OBJDIR)/$(1)/%.o : %.c
116         $L "$(1): Compiling $$< (C)"
117         @$$(MKDIR_P) $$(dir $$@)
118         $Q $$($(1)_CC) -c $$(CFLAGS) $$($(1)_CFLAGS) $$($(1)_CPPFLAGS) $$(CPPFLAGS) $$< -o $$@
119
120 # Compile: instructions to create assembler and/or object files from C++ source
121 $$($(1)_CXXOBJ) : $$(OBJDIR)/$(1)/%.o : %.cpp
122         $L "$(1): Compiling $$< (C++)"
123         @$$(MKDIR_P) $$(dir $$@)
124         $Q $$($(1)_CXX) -c $$(CXXFLAGS) $$($(1)_CXXFLAGS) $$($(1)_CPPFLAGS) $$(CPPFLAGS) $$< -o $$@
125
126 # Generate assembly sources from C files (debug)
127 $$(OBJDIR)/$(1)/%.s : %.c
128         $L "$(1): Generating asm source $$<"
129         @$$(MKDIR_P) $$(dir $$@)
130         $Q $$($(1)_CC) -S $$(CFLAGS) $$($(1)_CFLAGS) $$($(1)_CPPFLAGS) $$< -o $$@
131
132 # Generate special progmem variant of a source file
133 $$($(1)_PCOBJ) : $$(OBJDIR)/$(1)/%_P.o : %.c
134         $L "$(1): Compiling $$< (PROGMEM)"
135         @$$(MKDIR_P) $$(dir $$@)
136         $Q $$($(1)_CC) -c -D_PROGMEM $$(CFLAGS) $$($(1)_CFLAGS) $$($(1)_CPPFLAGS) $$(CPPFLAGS) $$< -o $$@
137
138 # Assemble: instructions to create object file from assembler files
139 $$($(1)_AOBJ): $$(OBJDIR)/$(1)/%.o : %.s
140         $L "$(1): Assembling $$<"
141         @$$(MKDIR_P) $$(dir $$@)
142         $Q $$($(1)_AS) -c $$(ASFLAGS) $$($(1)_ASFLAGS) $$< -o $$@
143
144 $$($(1)_CPPAOBJ): $$(OBJDIR)/$(1)/%.o : %.S
145         $L "$(1): Assembling with CPP $$<"
146         @$$(MKDIR_P) $$(dir $$@)
147         $Q $$($(1)_CC) -c $$(CPPAFLAGS) $$($(1)_CPPAFLAGS) $$($(1)_CPPFLAGS) $$(CPPFLAGS) $$< -o $$@
148         
149
150 # Link: instructions to create elf output file from object files
151 $$(OUTDIR)/$(1).elf $$(OUTDIR)/$(1)_nostrip: bumprev $$($(1)_OBJ) $$($(1)_LDSCRIPT)
152         $L "$(1): Linking $$@"
153         @$$(MKDIR_P) $$(dir $$@)
154         $Q $$($(1)_LD) $$($(1)_OBJ) $$(LIB) $$(LDFLAGS) $$($(1)_LDFLAGS) -o $$@
155
156 # Strip debug info
157 $$(OUTDIR)/$(1): $$(OUTDIR)/$(1)_nostrip
158         $L "$(1): Generating stripped executable $$@"
159         $Q $$($(1)_STRIP) -o $$@ $$^
160  
161 # Compile and link (program-at-a-time)
162 $$(OUTDIR)/$(1)_whole.elf: bumprev $$($(1)_SRC) $$($(1)_LDSCRIPT)
163         $L "$(1): Compiling and Linking whole program $$@"
164         @$$(MKDIR_P) $$(dir $$@)
165         $Q $$($(1)_CC) $$($(1)_SRC) $$(CFLAGS) $$($(1)_CFLAGS) $$(LIB) $$(LDFLAGS) $$($(1)_LDFLAGS) -o $$@
166
167 # Flash target
168 # NOTE: we retry in case of failure because the STK500 programmer is crappy
169 .PHONY: flash_$(1)
170 flash_$(1): $(OUTDIR)/$(1).s19 flash_$(1)_local
171         if ! $(AVRDUDE) $(DPROG) -p $$($(1)_MCU) -U flash:w:$$< ; then \
172              $(AVRDUDE) $(DPROG) -p $$($(1)_MCU) -U flash:w:$$< ; \
173         fi
174         #avarice --mkII -j usb --erase --program --verify --file images/triface.elf
175
176 .PHONY: flash_$(1)_local
177 flash_$(1)_local:
178
179 .PHONY: fuses_$(!)
180 fuses_$(1):
181         if [ ! -z "$$($(1)_efuse)" ] ; then \
182                 if ! $(AVRDUDE) $(DPROG) -p $$($(1)_MCU) -U efuse:w:$$($(1)_efuse):m ; then \
183                      $(AVRDUDE) $(DPROG) -p $$($(1)_MCU) -U efuse:w:$$($(1)_efuse):m ; \
184                 fi \
185         fi
186         if [ ! -z "$$($(1)_hfuse)" ] ; then \
187                 if ! $(AVRDUDE) $(DPROG) -p $$($(1)_MCU) -U hfuse:w:$$($(1)_hfuse):m ; then \
188                      $(AVRDUDE) $(DPROG) -p $$($(1)_MCU) -U hfuse:w:$$($(1)_hfuse):m ; \
189                 fi \
190         fi
191         if [ ! -z "$$($(1)_lfuse)" ] ; then \
192                 if ! $(AVRDUDE) $(DPROG) -p $$($(1)_MCU) -U lfuse:w:$$($(1)_lfuse):m ; then \
193                      $(AVRDUDE) $(DPROG) -p $$($(1)_MCU) -U lfuse:w:$$($(1)_lfuse):m ; \
194                 fi \
195         fi
196         if [ ! -z "$$($(1)_lock)" ] ; then \
197                 if ! $(AVRDUDE) $(DPROG) -p $$($(1)_MCU) -U lock:w:$$($(1)_lock):m ; then \
198                      $(AVRDUDE) $(DPROG) -p $$($(1)_MCU) -U lock:w:$$($(1)_lock):m ; \
199                 fi \
200         fi
201
202 $$(OUTDIR)/$(1).hex: $$(OUTDIR)/$(1).elf
203         $$($(1)_OBJCOPY) -O ihex $$< $$@
204
205 $$(OUTDIR)/$(1).s19: $$(OUTDIR)/$(1).elf
206         $$($(1)_OBJCOPY) -O srec $$< $$@
207
208 $$(OUTDIR)/$(1).bin: $$(OUTDIR)/$(1).elf
209         $$($(1)_OBJCOPY) -O binary $$< $$@
210
211 $$(OUTDIR)/$(1).obj: $$(OUTDIR)/$(1).elf
212         $$($(1)_OBJCOPY) -O avrobj $$< $$@
213
214 $$(OUTDIR)/$(1).rom: $$(OUTDIR)/$(1).elf
215         $$($(1)_OBJCOPY) -O $$(FORMAT) $$< $$@
216 #       $$($(1)_OBJCOPY) -j .eeprom --set-section-flags=.eeprom="alloc,load" -O $$(FORMAT) $$< $$(@:.rom=.eep)
217
218 endef
219
220 # Generate build rules for all targets
221 $(foreach t,$(TRG),$(eval $(call build_target,$(t))))
222
223 # Generate Qt's moc files from headers
224 # NOTE: moc totally sucks and can generate empty files for some error conditions,
225 #       leading to puzzling linker errors.  Kill 'em and abort build.
226 %_moc.cpp: %.h
227         $(MOC) -o $@ $<
228         if [ ! -s $< ]; then \
229                 rm -f $@; \
230                 exit 1; \
231         fi
232
233
234 %.cof: %.elf
235         $(COFFCONVERT) -O coff-ext-avr $< $@
236 #       $(COFFCONVERT) -O coff-avr $< $@   # For use with AVRstudio 3
237
238 #make instruction to delete created files
239 clean: clean-recursive
240         -$(RM_R) $(OBJDIR)
241         -$(RM_R) $(OUTDIR)
242
243 $(RECURSIVE_TARGETS):
244         @target=`echo $@ | sed s/-recursive//`; \
245         for dir in $(SUBDIRS); do \
246                 if [ -e $$dir/configure.in ] || [ -e $$dir/configure.ac ] && [ ! -x $$dir/configure ]; then \
247                         echo "Running autogen.sh in $$dir..."; \
248                         ( cd $$dir && chmod a+x autogen.sh && ./autogen.sh && rm -f Makefile || exit 1 ); \
249                 fi; \
250                 if [ ! -e $$dir/Makefile ]; then \
251                         if [ -e "$$dir/build-$(ARCH)" ]; then \
252                                 echo "Running build script in $$dir..."; \
253                                 ( cd $$dir && chmod a+x build && ./build || exit 1 ); \
254                         else \
255                                 echo "Running configure in $$dir..."; \
256                                 ( cd $$dir && ./configure --prefix=$(PREFIX) || exit 1 ); \
257                         fi; \
258                 fi; \
259                 $(MAKE) -C $$dir $$target || exit 1; \
260         done
261
262 BUILDREV_H = buildrev.h
263
264 ifeq ($(shell [ -e verstag.c ] && echo yes),yes)
265 .PHONY: bumprev
266 bumprev:
267         @buildnr=0; \
268         if [ -f $(BUILDREV_H) ]; then \
269                 buildnr=`sed <"$(BUILDREV_H)" -n -e 's/#define VERS_BUILD \([0-9][0-9]*\)/\1/p'`; \
270         fi; \
271         buildnr=`expr $$buildnr + 1`; \
272         buildhost=`hostname`; \
273         echo "#define VERS_BUILD $$buildnr" >"$(BUILDREV_H)"; \
274         echo "#define VERS_HOST  \"$$buildhost\"" >>"$(BUILDREV_H)"; \
275         echo "Building revision $$buildnr"
276 else
277 .PHONY: bumprev
278 bumprev:
279
280 endif
281
282 # Include dependencies
283 ifneq ($(strip $(OBJ)),)
284 -include $(OBJ:%.o=%.d)
285 endif