FS#12102 - Manual, "Quick Start" section for AMSv2 players: Clarifies
[kugel-rb.git] / tools / root.make
blob1ac55683168b82fb74965c29e72f75b7e6c00812
1 # __________ __ ___.
2 # Open \______ \ ____ ____ | | _\_ |__ _______ ___
3 # Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
4 # Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
5 # Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
6 # \/ \/ \/ \/ \/
7 # $Id$
10 include $(TOOLSDIR)/functions.make
12 DEFINES = -DROCKBOX -DMEMORYSIZE=$(MEMORYSIZE) $(TARGET) \
13 -DTARGET_ID=$(TARGET_ID) -DTARGET_NAME=\"$(MODELNAME)\" $(BUILDDATE) \
14 $(EXTRA_DEFINES) # <-- -DSIMULATOR or not
15 INCLUDES = -I$(BUILDDIR) -I$(BUILDDIR)/lang $(TARGET_INC)
17 CFLAGS = $(INCLUDES) $(DEFINES) $(GCCOPTS)
18 PPCFLAGS = $(filter-out -g -Dmain=SDL_main,$(CFLAGS)) # cygwin sdl-config fix
19 ASMFLAGS = -D__ASSEMBLER__ # work around gcc 3.4.x bug with -std=gnu99, only meant for .S files
21 TOOLS = $(TOOLSDIR)/rdf2binary $(TOOLSDIR)/convbdf \
22 $(TOOLSDIR)/codepages $(TOOLSDIR)/scramble $(TOOLSDIR)/bmp2rb \
23 $(TOOLSDIR)/uclpack $(TOOLSDIR)/mkboot $(TOOLSDIR)/iaudio_bl_flash.c \
24 $(TOOLSDIR)/iaudio_bl_flash.h
27 ifeq (,$(PREFIX))
28 ifdef APP_TYPE
29 # for sims, set simdisk/ as default
30 ifeq ($(APP_TYPE),sdl-sim)
31 RBPREFIX = simdisk
32 else ifeq ($(APP_TYPE),sdl-app)
33 RBPREFIX = /usr/local
34 endif
36 INSTALL = --install="$(RBPREFIX)"
37 else
38 # /dev/null as magic to tell it wasn't set, error out later in buildzip.pl
39 INSTALL = --install=/dev/null
40 endif
41 else
42 RBPREFIX = $(PREFIX)
43 INSTALL = --install="$(RBPREFIX)"
44 endif
46 RBINFO = $(BUILDDIR)/rockbox-info.txt
48 # list suffixes to be understood by $*
49 .SUFFIXES: .rock .codec .map .elf .c .S .o .bmp .a
51 .PHONY: all clean tags zip tools manual bin build info langs
53 ifeq (,$(filter clean veryclean reconf tags voice voicetools manual manual-pdf manual-html manual-zhtml manual-txt manual-ztxt manual-zip help fontzip ,$(MAKECMDGOALS)))
54 # none of the above
55 DEPFILE = $(BUILDDIR)/make.dep
57 endif
59 all: $(DEPFILE) build
61 # Subdir makefiles. their primary purpose is to populate SRC, OTHER_SRC &
62 # ASMDEFS_SRC but they also define special dependencies and compile rules
63 include $(TOOLSDIR)/tools.make
65 ifeq (,$(findstring checkwps,$(APPSDIR)))
66 ifeq (,$(findstring database,$(APPSDIR)))
67 include $(FIRMDIR)/firmware.make
68 include $(ROOTDIR)/lib/skin_parser/skin_parser.make
69 include $(ROOTDIR)/apps/bitmaps/bitmaps.make
70 endif
71 endif
73 #included before codecs.make and plugins.make so they see $(LIBSETJMP)
74 ifndef APP_TYPE
75 include $(ROOTDIR)/lib/libsetjmp/libsetjmp.make
76 endif
78 ifneq (,$(findstring bootloader,$(APPSDIR)))
79 include $(APPSDIR)/bootloader.make
80 else ifneq (,$(findstring bootbox,$(APPSDIR)))
81 BOOTBOXLDOPTS = -Wl,--gc-sections
82 include $(APPSDIR)/bootbox.make
83 else ifneq (,$(findstring checkwps,$(APPSDIR)))
84 include $(APPSDIR)/checkwps.make
85 include $(ROOTDIR)/lib/skin_parser/skin_parser.make
86 else ifneq (,$(findstring database,$(APPSDIR)))
87 include $(APPSDIR)/database.make
88 else
89 include $(APPSDIR)/apps.make
90 include $(APPSDIR)/lang/lang.make
92 ifdef SOFTWARECODECS
93 include $(APPSDIR)/codecs/codecs.make
94 endif
96 ifdef ENABLEDPLUGINS
97 include $(APPSDIR)/plugins/bitmaps/pluginbitmaps.make
98 include $(APPSDIR)/plugins/plugins.make
99 endif
101 ifneq (,$(findstring sdl,$(APP_TYPE)))
102 include $(ROOTDIR)/uisimulator/uisimulator.make
103 endif
105 ifneq (,$(findstring android, $(APP_TYPE)))
106 include $(ROOTDIR)/android/android.make
107 endif
109 endif # bootloader
111 OBJ := $(SRC:.c=.o)
112 OBJ := $(OBJ:.S=.o)
113 OBJ += $(BMP:.bmp=.o)
114 OBJ := $(subst $(ROOTDIR),$(BUILDDIR),$(OBJ))
116 build: $(TOOLS) $(BUILDDIR)/$(BINARY) $(CODECS) $(ROCKS) $(ARCHOSROM) $(RBINFO)
118 $(RBINFO): $(BUILDDIR)/$(BINARY)
119 $(SILENT)echo Creating $(@F)
120 $(SILENT)$(TOOLSDIR)/mkinfo.pl $@
122 $(DEPFILE) dep:
123 $(call PRINTS,Generating dependencies)
124 $(call mkdepfile,$(DEPFILE)_,$(SRC))
125 $(call mkdepfile,$(DEPFILE)_,$(OTHER_SRC:%.lua=))
126 $(call mkdepfile,$(DEPFILE)_,$(ASMDEFS_SRC))
127 $(call bmpdepfile,$(DEPFILE)_,$(BMP) $(PBMP))
128 @mv $(DEPFILE)_ $(DEPFILE)
130 bin: $(DEPFILE) $(TOOLS) $(BUILDDIR)/$(BINARY) $(RBINFO)
131 rocks: $(DEPFILE) $(TOOLS) $(ROCKS)
132 codecs: $(DEPFILE) $(TOOLS) $(CODECS)
133 tools: $(TOOLS)
135 -include $(DEPFILE)
137 veryclean: clean
138 $(SILENT)rm -rf $(TOOLS)
140 clean::
141 $(SILENT)echo Cleaning build directory
142 $(SILENT)rm -rf rockbox.zip rockbox.7z rockbox.tar rockbox.tar.gz \
143 rockbox.tar.bz2 TAGS apps firmware tools comsim sim lang lib \
144 manual *.pdf *.a credits.raw rockbox.ipod bitmaps \
145 pluginbitmaps UI256.bmp rockbox-full.zip html txt \
146 rockbox-manual*.zip sysfont.h rockbox-info.txt voicefontids \
147 *.wav *.mp3 *.voice $(CLEANOBJS) \
148 $(LINKRAM) $(LINKROM) rockbox.elf rockbox.map rockbox.bin \
149 make.dep rombox.elf rombox.map rombox.bin rombox.ucl romstart.txt \
150 $(BINARY) $(FLASHFILE) uisimulator bootloader flash $(BOOTLINK) \
151 rockbox.apk
153 #### linking the binaries: ####
155 .SECONDEXPANSION:
157 ifeq (,$(findstring bootloader,$(APPSDIR)))
158 # not bootloader
160 OBJ += $(LANG_O)
162 ifndef APP_TYPE
164 ## target build
165 CONFIGFILE := $(FIRMDIR)/export/config/$(MODELNAME).h
166 RAMLDS := $(FIRMDIR)/target/$(CPU)/$(MANUFACTURER)/app.lds
167 LINKRAM := $(BUILDDIR)/ram.link
168 ROMLDS := $(FIRMDIR)/rom.lds
169 LINKROM := $(BUILDDIR)/rom.link
172 $(LINKRAM): $(RAMLDS) $(CONFIGFILE)
173 $(call PRINTS,PP $(@F))
174 $(call preprocess2file,$<,$@,-DLOADADDRESS=$(LOADADDRESS))
176 $(LINKROM): $(ROMLDS)
177 $(call PRINTS,PP $(@F))
178 $(call preprocess2file,$<,$@,-DLOADADDRESS=$(LOADADDRESS))
180 $(BUILDDIR)/rockbox.elf : $$(OBJ) $$(FIRMLIB) $$(VOICESPEEXLIB) $$(SKINLIB) $$(LINKRAM)
181 $(call PRINTS,LD $(@F))$(CC) $(GCCOPTS) -Os -nostdlib -o $@ $(OBJ) \
182 -L$(BUILDDIR)/firmware -lfirmware \
183 -L$(BUILDDIR)/lib -lskin_parser \
184 -L$(BUILDDIR)/apps/codecs $(VOICESPEEXLIB:lib%.a=-l%) \
185 -lgcc $(BOOTBOXLDOPTS) $(GLOBAL_LDOPTS) \
186 -T$(LINKRAM) -Wl,-Map,$(BUILDDIR)/rockbox.map
188 $(BUILDDIR)/rombox.elf : $$(OBJ) $$(FIRMLIB) $$(VOICESPEEXLIB) $$(SKINLIB) $$(LINKROM)
189 $(call PRINTS,LD $(@F))$(CC) $(GCCOPTS) -Os -nostdlib -o $@ $(OBJ) \
190 $(VOICESPEEXLIB) $(FIRMLIB) -lgcc $(GLOBAL_LDOPTS) \
191 -L$(BUILDDIR)/lib -lskin_parser \
192 -L$(BUILDDIR)/firmware -T$(LINKROM) -Wl,-Map,$(BUILDDIR)/rombox.map
194 $(BUILDDIR)/rockbox.bin : $(BUILDDIR)/rockbox.elf
195 $(call PRINTS,OC $(@F))$(OC) $(if $(filter yes, $(USE_ELF)), -S -x, -O binary) $< $@
197 $(BUILDDIR)/rombox.bin : $(BUILDDIR)/rombox.elf
198 $(call PRINTS,OC $(@F))$(OC) -O binary $< $@
201 # If there's a flashfile defined for this target (rockbox.ucl for Archos
202 # models) Then check if the mkfirmware script fails, as then it is (likely)
203 # because the image is too big and we need to create a compressed image
204 # instead.
206 $(BUILDDIR)/$(BINARY) : $(BUILDDIR)/rockbox.bin $(FLASHFILE)
207 $(call PRINTS,SCRAMBLE $(notdir $@))($(MKFIRMWARE) $< $@; \
208 stat=$$?; \
209 if test -n "$(FLASHFILE)"; then \
210 if test "$$stat" -ne 0; then \
211 echo "Image too big, making a compressed version!"; \
212 $(MAKE) -C $(FIRMDIR)/decompressor OBJDIR=$(BUILDDIR)/firmware/decompressor; \
213 $(MKFIRMWARE) $(BUILDDIR)/firmware/decompressor/compressed.bin $@; \
214 fi \
215 fi )
217 # archos
218 $(BUILDDIR)/rockbox.ucl: $(BUILDDIR)/rockbox.bin
219 $(call PRINTS,UCLPACK $(@F))$(TOOLSDIR)/uclpack --best --2e -b1048576 $< $@ >/dev/null
221 MAXINFILE = $(BUILDDIR)/temp.txt
222 MAXOUTFILE = $(BUILDDIR)/romstart.txt
224 $(BUILDDIR)/rombox.ucl: $(BUILDDIR)/rombox.bin $(MAXOUTFILE)
225 $(call PRINTS,UCLPACK $(@F))$(TOOLSDIR)/uclpack --none $< $@ >/dev/null; \
226 perl $(TOOLSDIR)/romsizetest.pl `cat $(MAXOUTFILE)` $<; \
227 if test $$? -ne 0; then \
228 echo "removing UCL file again, making it a fake one"; \
229 echo "fake" > $@; \
232 $(MAXOUTFILE):
233 $(call PRINTS,Creating $(@F))
234 $(SILENT)echo '#include "config.h"' > $(MAXINFILE)
235 $(SILENT)echo "ROM_START" >> $(MAXINFILE)
236 $(call preprocess2file,$(MAXINFILE),$(MAXOUTFILE))
237 $(SILENT)rm $(MAXINFILE)
239 # iriver
240 $(BUILDDIR)/rombox.iriver: $(BUILDDIR)/rombox.bin
241 $(call PRINTS,Build ROM file)$(MKFIRMWARE) $< $@
243 endif # !APP_TYPE
244 endif # !bootloader
247 voicetools:
248 $(SILENT)$(MAKE) -C $(TOOLSDIR) CC=$(HOSTCC) AR=$(HOSTAR) rbspeexenc voicefont wavtrim
250 tags:
251 $(SILENT)rm -f TAGS
252 $(SILENT)etags -o $(BUILDDIR)/TAGS $(filter-out %.o,$(SRC) $(OTHER_SRC))
254 fontzip:
255 $(SILENT)$(TOOLSDIR)/buildzip.pl $(VERBOSEOPT) --app=$(APPLICATION) -m \"$(MODELNAME)\" -r "$(ROOTDIR)" --rbdir="$(RBDIR)" -f 1 -o rockbox-fonts.zip $(TARGET) $(BINARY)
257 zip:
258 $(SILENT)$(TOOLSDIR)/buildzip.pl $(VERBOSEOPT) --app=$(APPLICATION) -m \"$(MODELNAME)\" -i \"$(TARGET_ID)\" -r "$(ROOTDIR)" --rbdir="$(RBDIR)" $(TARGET) $(BINARY)
260 mapzip:
261 $(SILENT)find . -name "*.map" | xargs zip rockbox-maps.zip
263 elfzip:
264 $(SILENT)find . -name "*.elf" | xargs zip rockbox-elfs.zip
266 fullzip:
267 $(SILENT)$(TOOLSDIR)/buildzip.pl $(VERBOSEOPT) --app=$(APPLICATION) -m \"$(MODELNAME)\" -i \"$(TARGET_ID)\" -r "$(ROOTDIR)" --rbdir="$(RBDIR)" -f 2 -o rockbox-full.zip $(TARGET) $(BINARY)
269 7zip:
270 $(SILENT)$(TOOLSDIR)/buildzip.pl $(VERBOSEOPT) --app=$(APPLICATION) -m \"$(MODELNAME)\" -i \"$(TARGET_ID)\" -o "rockbox.7z" -z "7za a -mx=9" -r "$(ROOTDIR)" --rbdir="$(RBDIR)" $(TARGET) $(BINARY)
272 tar:
273 $(SILENT)rm -f rockbox.tar
274 $(SILENT)$(TOOLSDIR)/buildzip.pl $(VERBOSEOPT) --app=$(APPLICATION) -m \"$(MODELNAME)\" -i \"$(TARGET_ID)\" -o "rockbox.tar" -z "tar -cf" -r "$(ROOTDIR)" --rbdir="$(RBDIR)" $(TARGET) $(BINARY)
276 bzip2: tar
277 $(SILENT)bzip2 -f9 rockbox.tar
279 gzip: tar
280 $(SILENT)gzip -f9 rockbox.tar
282 manual manual-pdf:
283 $(SILENT)$(MAKE) -C $(MANUALDIR) OBJDIR=$(BUILDDIR)/manual manual-pdf
284 manual-html:
285 $(SILENT)$(MAKE) -C $(MANUALDIR) OBJDIR=$(BUILDDIR)/manual manual-html
286 manual-zhtml: manual-zip
287 manual-txt:
288 $(SILENT)$(MAKE) -C $(MANUALDIR) OBJDIR=$(BUILDDIR)/manual manual-txt
289 manual-ztxt:
290 $(SILENT)$(MAKE) -C $(MANUALDIR) OBJDIR=$(BUILDDIR)/manual manual-txt-zip
291 manual-zip:
292 $(SILENT)$(MAKE) -C $(MANUALDIR) OBJDIR=$(BUILDDIR)/manual manual-zip
294 ifdef TTS_ENGINE
296 voice: voicetools $(BUILDDIR)/apps/features
297 $(SILENT)for f in `cat $(BUILDDIR)/apps/features`; do feat="$$feat:$$f" ; done ; \
298 for lang in `echo $(VOICELANGUAGE) |sed "s/,/ /g"`; do $(TOOLSDIR)/voice.pl -V -l=$$lang -t=$(MODELNAME)$$feat -i=$(TARGET_ID) -e="$(ENCODER)" -E="$(ENC_OPTS)" -s=$(TTS_ENGINE) -S="$(TTS_OPTS)"; done \
300 endif
302 ifeq (,$(findstring android, $(APP_TYPE)))
303 bininstall: $(BUILDDIR)/$(BINARY)
304 @echo "Installing your rockbox binary in your '$(RBPREFIX)' dir"
305 $(SILENT)cp $(BINARY) "$(RBPREFIX)/.rockbox/"
307 install:
308 @echo "Installing your build in your '$(RBPREFIX)' dir"
309 $(SILENT)$(TOOLSDIR)/buildzip.pl $(VERBOSEOPT) --app=$(APPLICATION) -m "$(MODELNAME)" -i "$(TARGET_ID)" $(INSTALL) -z "zip -r0" -r "$(ROOTDIR)" --rbdir="$(RBDIR)" -f 0 $(TARGET) $(BINARY)
311 fullinstall:
312 @echo "Installing a full setup in your '$(RBPREFIX)' dir"
313 $(SILENT)$(TOOLSDIR)/buildzip.pl $(VERBOSEOPT) --app=$(APPLICATION) -m "$(MODELNAME)" -i "$(TARGET_ID)" $(INSTALL) -z "zip -r0" -r "$(ROOTDIR)" --rbdir="$(RBDIR)" -f 2 $(TARGET) $(BINARY)
315 symlinkinstall:
316 @echo "Installing a full setup with links in your '$(RBPREFIX)' dir"
317 $(SILENT)$(TOOLSDIR)/buildzip.pl $(VERBOSEOPT) --app=$(APPLICATION) -m "$(MODELNAME)" -i "$(TARGET_ID)" $(INSTALL) -z "zip -r0" -r "$(ROOTDIR)" --rbdir="$(RBDIR)" -f 2 $(TARGET) $(BINARY) -l
318 endif
320 help:
321 @echo "A few helpful make targets"
322 @echo ""
323 @echo "all - builds a full Rockbox (default), including tools"
324 @echo "bin - builds only the Rockbox.<target name> file"
325 @echo "rocks - builds only plugins"
326 @echo "codecs - builds only codecs"
327 @echo "dep - regenerates make dependency database"
328 @echo "clean - cleans a build directory (not tools)"
329 @echo "veryclean - cleans the build and tools directories"
330 @echo "manual - builds a manual (pdf)"
331 @echo "manual-html - HTML manual"
332 @echo "manual-zip - HTML manual (zipped)"
333 @echo "manual-txt - txt manual"
334 @echo "fullzip - creates a rockbox.zip of your build with fonts"
335 @echo "zip - creates a rockbox.zip of your build (no fonts)"
336 @echo "gzip - creates a rockbox.tar.gz of your build (no fonts)"
337 @echo "bzip2 - creates a rockbox.tar.bz2 of your build (no fonts)"
338 @echo "7zip - creates a rockbox.7z of your build (no fonts)"
339 @echo "fontzip - creates rockbox-fonts.zip"
340 @echo "mapzip - creates rockbox-maps.zip with all .map files"
341 @echo "elfzip - creates rockbox-elfs.zip with all .elf files"
342 @echo "tools - builds the tools only"
343 @echo "voice - creates the voice clips (voice builds only)"
344 @echo "voicetools - builds the voice tools only"
345 @echo "install - installs your build (at PREFIX, defaults to simdisk/ for simulators (no fonts))"
346 @echo "fullinstall - installs your build (like install, but with fonts)"
347 @echo "symlinkinstall - like fullinstall, but with links instead of copying files. (Good for developing on simulator)"
348 @echo "reconf - rerun configure with the same selection"
350 ### general compile rules:
352 # when source and object are in different locations (normal):
353 $(BUILDDIR)/%.o: $(ROOTDIR)/%.c
354 $(SILENT)mkdir -p $(dir $@)
355 $(call PRINTS,CC $(subst $(ROOTDIR)/,,$<))$(CC) $(CFLAGS) -c $< -o $@
357 $(BUILDDIR)/%.o: $(ROOTDIR)/%.S
358 $(SILENT)mkdir -p $(dir $@)
359 $(call PRINTS,CC $(subst $(ROOTDIR)/,,$<))$(CC) $(CFLAGS) $(ASMFLAGS) -c $< -o $@
361 # generated definitions for use in .S files
362 $(BUILDDIR)/%_asmdefs.h: $(ROOTDIR)/%_asmdefs.c
363 $(call PRINTS,ASMDEFS $(@F))
364 $(SILENT)mkdir -p $(dir $@)
365 $(call asmdefs2file,$<,$@)
367 # when source and object are both in BUILDDIR (generated code):
368 %.o: %.c
369 $(SILENT)mkdir -p $(dir $@)
370 $(call PRINTS,CC $(subst $(ROOTDIR)/,,$<))$(CC) $(CFLAGS) -c $< -o $@
372 %.o: %.S
373 $(SILENT)mkdir -p $(dir $@)
374 $(call PRINTS,CC $(subst $(ROOTDIR)/,,$<))$(CC) $(CFLAGS) $(ASMFLAGS) -c $< -o $@
376 Makefile: $(TOOLSDIR)/configure
377 ifneq (reconf,$(MAKECMDGOALS))
378 $(SILENT)echo "*** tools/configure is newer than Makefile. You should run 'make reconf'."
379 endif
381 reconf:
382 $(SILENT$)$(TOOLSDIR)/configure $(CONFIGURE_OPTIONS)