/make/arduino-mk

To get this branch, use:
bzr branch http://bzr.ed.am/make/arduino-mk

« back to all changes in this revision

Viewing changes to arduino.mk

  • Committer: edam
  • Date: 2012-11-30 15:13:27 UTC
  • Revision ID: tim@ed.am-20121130151327-scygxxvu0crec501
documented AVRDUDEFLAGS, CPPFLAGS, LINKFLAGS and LINBRARYPATH, cleaned up a
little bit, and fixed a tiny bug (called ecit, not exit, during an error)

Show diffs side-by-side

added added

removed removed

Lines of Context:
arduino.mk
1
1
#_______________________________________________________________________________
2
2
#
3
 
#                         edam's arduino makefile
 
3
#                         edam's Arduino makefile
4
4
#_______________________________________________________________________________
5
 
#                                                                    version 0.3
 
5
#                                                                 version 0.5dev
6
6
#
7
 
# Copyright (C) 2011, 1012 Tim Marston <tim@ed.am>.
 
7
# Copyright (C) 2011, 2012 Tim Marston <tim@ed.am>.
8
8
#
9
9
# Permission is hereby granted, free of charge, to any person obtaining a copy
10
10
# of this software and associated documentation files (the "Software"), to deal
44
44
#
45
45
# The Arduino software (version 1.0 or later) is required.  If you are using
46
46
# Debian (or a derivative), type `apt-get install arduino`.  Otherwise, you
47
 
# will have to download the arduino software manually from http://arduino.cc/.
 
47
# will have to download the Arduino software manually from http://arduino.cc/.
48
48
# It is suggested that you install it at ~/opt/arduino if you are unsure.
49
49
#
50
50
# If you downloaded the Arduino software manually and unpacked it somewhere
56
56
#   export ARDUINODIR=~/somewhere/arduino-1.0
57
57
#
58
58
# You will also need to set BOARD to the type of Arduino you're building for.
59
 
# You could set a default in your ~/.profile if you want, but it is suggested
60
 
# that you specify this at build time, especially if you work with different
61
 
# types of Arduino.  For example:
 
59
# Type `make boards` for a list of acceptable values.  You could set a default
 
60
# in your ~/.profile if you want, but it is suggested that you specify this at
 
61
# build time, especially if you work with different types of Arduino.  For
 
62
# example:
62
63
#
63
64
#   $ export BOARD=uno
64
65
#   $ make
69
70
# determine values for SOURCES, TARGET and LIBRARIES.  Any .c, .cc and .cpp
70
71
# files in the project directory (or any "util" or "utility" subdirectories)
71
72
# are automatically included in the build and are scanned for Arduino libraries
72
 
# that have been #included. Note, there can only be one .ino (or .pde) file.
 
73
# that have been #included.  Note, there can only be one .ino (or .pde) file.
73
74
#
74
75
# Alternatively, if you want to manually specify build variables, create a
75
76
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
84
85
# ARDUINODIR   The path where the Arduino software is installed on your system.
85
86
#
86
87
# ARDUINOCONST The Arduino software version, as an integer, used to define the
87
 
#              ARDUINO version constant. This defaults to 100 if undefined.
 
88
#              ARDUINO version constant.  This defaults to 100 if undefined.
88
89
#
89
 
# AVRDUDECONF  The avrdude.conf to use. If undefined, this defaults to a guess
90
 
#              based on where the avrdude in use is. If empty, no avrdude.conf
 
90
# AVRDUDECONF  The avrdude.conf to use.  If undefined, this defaults to a guess
 
91
#              based on where the avrdude in use is.  If empty, no avrdude.conf
91
92
#              is passed to avrdude (to the system default is used).
92
93
#
93
 
# AVRTOOLSPATH A space-separated list of directories to search in order when
94
 
#              lookin for the avr build tools. This defaults to the system PATH
95
 
#              followed by subdirectories in ARDUINODIR if undefined.
 
94
# AVRDUDEFLAGS Specify any additional flags for avrdude.  The usual flags,
 
95
#              required to build the project, will be appended to this.
 
96
#
 
97
# AVRTOOLSPATH A space-separated list of directories that is searched in order
 
98
#              when looking for the avr build tools.  This defaults to PATH,
 
99
#              followed by subdirectories in ARDUINODIR.
96
100
#
97
101
# BOARD        Specify a target board type.  Run `make boards` to see available
98
102
#              board types.
99
103
#
 
104
# CPPFLAGS     Specify any additional flags for the compiler.  The usual flags,
 
105
#              required to build the project, will be appended to this.
 
106
#
 
107
# LINKFLAGS    Specify any additional flags for the linker.  The usual flags,
 
108
#              required to build the project, will be appended to this.
 
109
#
100
110
# LIBRARIES    A list of Arduino libraries to build and include.  This is set
101
111
#              automatically if a .ino (or .pde) is found.
102
112
#
 
113
# LIBRARYPATH  A space-separated list of directories that is searched in order
 
114
#              when looking for Arduino libraries.  This defaults to "libs",
 
115
#              "libraries" and then the Arduino software's libraries directory.
 
116
#
103
117
# SERIALDEV    The unix device name of the serial device that is the Arduino.
104
118
#              If unspecified, an attempt is made to determine the name of a
105
119
#              connected Arduino's serial device.
116
130
# when you run make:
117
131
#
118
132
# all          This is the default if no goal is specified.  It builds the
119
 
#              target and uploads it.
 
133
#              target.
120
134
#
121
135
# target       Builds the target.
122
136
#
130
144
# monitor      Start `screen` on the serial device.  This is meant to be an
131
145
#              equivalent to the Arduino serial monitor.
132
146
#
 
147
# size         Displays size information about the bulit target.
 
148
#
133
149
# <file>       Builds the specified file, either an object file or the target,
134
150
#              from those that that would be built for the project.
135
151
#_______________________________________________________________________________
153
169
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
154
170
endif
155
171
 
 
172
# default path to find libraries
 
173
LIBRARYPATH ?= libraries libs $(ARDUINODIR)/libraries
 
174
 
156
175
# auto mode?
157
176
INOFILE := $(wildcard *.ino *.pde)
158
177
ifdef INOFILE
163
182
# automatically determine sources and targeet
164
183
TARGET := $(basename $(INOFILE))
165
184
SOURCES := $(INOFILE) \
166
 
        $(wildcard *.c *.cc *.cpp) \
167
 
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
168
 
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
 
185
        $(wildcard *.c *.cc *.cpp *.C) \
 
186
        $(wildcard $(addprefix util/, *.c *.cc *.cpp *.C)) \
 
187
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp *.C))
169
188
 
170
189
# automatically determine included libraries
171
 
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
172
 
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
 
190
LIBRARIES := $(filter $(notdir $(wildcard $(addsuffix /*, $(LIBRARYPATH)))), \
173
191
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
174
192
 
175
193
endif
178
196
SERIALDEVGUESS := 0
179
197
ifeq "$(SERIALDEV)" ""
180
198
SERIALDEV := $(firstword $(wildcard \
181
 
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbmodem*))
 
199
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))
182
200
SERIALDEVGUESS := 1
183
201
endif
184
202
 
190
208
AR := $(call findsoftware,avr-ar)
191
209
OBJCOPY := $(call findsoftware,avr-objcopy)
192
210
AVRDUDE := $(call findsoftware,avrdude)
 
211
AVRSIZE := $(call findsoftware,avr-size)
 
212
 
 
213
# directories
 
214
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
 
215
LIBRARYDIRS := $(foreach lib, $(LIBRARIES), \
 
216
        $(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARYPATH)))))
 
217
LIBRARYDIRS += $(addsuffix /utility, $(LIBRARYDIRS))
193
218
 
194
219
# files
195
220
TARGET := $(if $(TARGET),$(TARGET),a.out)
196
221
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
197
 
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
198
 
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
199
 
ARDUINOLIB := _arduino.a
200
 
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
201
 
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
202
 
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
203
 
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
204
 
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
205
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
206
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
 
222
DEPFILES := $(patsubst %, .dep/%.dep, $(SOURCES))
 
223
ARDUINOLIB := .lib/arduino.a
 
224
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(LIBRARYDIRS), \
 
225
        $(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, *.c *.cpp))))
 
226
 
 
227
# avrdude confifuration
207
228
ifeq "$(AVRDUDECONF)" ""
208
229
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
209
230
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
233
254
        $(shell sed -ne "s/$(BOARD).upload.speed=\(.*\)/\1/p" $(BOARDS_FILE))
234
255
BOARD_UPLOAD_PROTOCOL := \
235
256
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
 
257
BOARD_USB_VID := \
 
258
        $(shell sed -ne "s/$(BOARD).build.vid=\(.*\)/\1/p" $(BOARDS_FILE))
 
259
BOARD_USB_PID := \
 
260
        $(shell sed -ne "s/$(BOARD).build.pid=\(.*\)/\1/p" $(BOARDS_FILE))
236
261
 
237
262
# invalid board?
238
263
ifeq "$(BOARD_BUILD_MCU)" ""
244
269
endif
245
270
 
246
271
# flags
247
 
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
 
272
CPPFLAGS += -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
248
273
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
249
274
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
250
275
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
251
 
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
252
 
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
253
 
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
254
 
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
255
 
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
 
276
CPPFLAGS += -DUSB_VID=$(BOARD_USB_VID) -DUSB_PID=$(BOARD_USB_PID)
 
277
CPPFLAGS += -I. -Iutil -Iutility -I $(ARDUINOCOREDIR)
 
278
CPPFLAGS += -I $(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
 
279
CPPFLAGS += $(addprefix -I , $(LIBRARYDIRS))
 
280
CPPDEPFLAGS = -MMD -MP -MF .dep/$<.dep
 
281
CPPINOFLAGS := -x c++ -include $(ARDUINOCOREDIR)/Arduino.h
 
282
AVRDUDEFLAGS += $(addprefix -C , $(AVRDUDECONF)) -DV
256
283
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
257
284
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
258
 
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
259
 
 
260
 
# figure out which arg to use with stty
261
 
STTYFARG := $(shell stty --help > /dev/null 2>&1 && echo -F || echo -f)
 
285
LINKFLAGS += -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
 
286
 
 
287
# figure out which arg to use with stty (for OS X, GNU and busybox stty)
 
288
STTYFARG := $(shell stty --help 2>&1 | \
 
289
        grep -q 'illegal option' && echo -f || echo -F)
 
290
 
 
291
# include dependencies
 
292
ifneq "$(MAKECMDGOALS)" "clean"
 
293
-include $(DEPFILES)
 
294
endif
262
295
 
263
296
# default rule
264
297
.DEFAULT_GOAL := all
266
299
#_______________________________________________________________________________
267
300
#                                                                          RULES
268
301
 
269
 
.PHONY: all target upload clean boards monitor
 
302
.PHONY: all target upload clean boards monitor size
270
303
 
271
 
all: target upload
 
304
all: target
272
305
 
273
306
target: $(TARGET).hex
274
307
 
275
 
upload:
 
308
upload: target
276
309
        @echo "\nUploading to board..."
277
310
        @test -n "$(SERIALDEV)" || { \
278
311
                echo "error: SERIALDEV could not be determined automatically." >&2; \
286
319
clean:
287
320
        rm -f $(OBJECTS)
288
321
        rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
289
 
        rm -rf $(ARDUINOLIBTMP)
 
322
        rm -rf .lib .dep
290
323
 
291
324
boards:
292
325
        @echo Available values for BOARD:
293
 
        @sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
294
 
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
 
326
        @sed -nEe '/^#/d; /^[^.]+\.name=/p' $(BOARDS_FILE) | \
 
327
                sed -Ee 's/([^.]+)\.name=(.*)/\1            \2/' \
 
328
                        -e 's/(.{12}) *(.*)/\1 \2/'
295
329
 
296
330
monitor:
297
331
        @test -n "$(SERIALDEV)" || { \
299
333
                exit 1; }
300
334
        @test -n `which screen` || { \
301
335
                echo "error: can't find GNU screen, you might need to install it." >&2 \
302
 
                ecit 1; }
 
336
                exit 1; }
303
337
        @test 0 -eq $(SERIALDEVGUESS) || { \
304
338
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
305
339
                echo; }
306
340
        screen $(SERIALDEV)
307
341
 
 
342
size: $(TARGET).elf
 
343
        echo && $(AVRSIZE) --format=avr --mcu=$(BOARD_BUILD_MCU) $(TARGET).elf
 
344
 
308
345
# building the target
309
346
 
310
347
$(TARGET).hex: $(TARGET).elf
313
350
.INTERMEDIATE: $(TARGET).elf
314
351
 
315
352
$(TARGET).elf: $(ARDUINOLIB) $(OBJECTS)
316
 
        $(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -o $@
 
353
        $(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -lm -o $@
 
354
 
 
355
%.o: %.c
 
356
        mkdir -p .dep/$(dir $<)
 
357
        $(COMPILE.c) $(CPPDEPFLAGS) -o $@ $<
 
358
 
 
359
%.o: %.cpp
 
360
        mkdir -p .dep/$(dir $<)
 
361
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
 
362
 
 
363
%.o: %.cc
 
364
        mkdir -p .dep/$(dir $<)
 
365
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
 
366
 
 
367
%.o: %.C
 
368
        mkdir -p .dep/$(dir $<)
 
369
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
317
370
 
318
371
%.o: %.ino
319
 
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
 
372
        mkdir -p .dep/$(dir $<)
 
373
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
320
374
 
321
375
%.o: %.pde
322
 
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
 
376
        mkdir -p .dep/$(dir $<)
 
377
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
323
378
 
324
379
# building the arduino library
325
380
 
326
381
$(ARDUINOLIB): $(ARDUINOLIBOBJS)
327
382
        $(AR) rcs $@ $?
328
 
        rm -rf $(ARDUINOLIBTMP)
329
 
 
330
 
.INTERMEDIATE: $(ARDUINOLIBOBJS)
331
 
 
332
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.c
333
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
334
 
        $(COMPILE.c) -o $@ $<
335
 
 
336
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.cpp
337
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
338
 
        $(COMPILE.cpp) -o $@ $<
339
 
 
340
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.c
341
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
342
 
        $(COMPILE.c) -o $@ $<
343
 
 
344
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
345
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
346
 
        $(COMPILE.cpp) -o $@ $<
347
 
 
348
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c
349
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
350
 
        $(COMPILE.c) -o $@ $<
351
 
 
352
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp
353
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
383
 
 
384
.lib/%.c.o: %.c
 
385
        mkdir -p $(dir $@)
 
386
        $(COMPILE.c) -o $@ $<
 
387
 
 
388
.lib/%.cpp.o: %.cpp
 
389
        mkdir -p $(dir $@)
 
390
        $(COMPILE.cpp) -o $@ $<
 
391
 
 
392
.lib/%.cc.o: %.cc
 
393
        mkdir -p $(dir $@)
 
394
        $(COMPILE.cpp) -o $@ $<
 
395
 
 
396
.lib/%.C.o: %.C
 
397
        mkdir -p $(dir $@)
354
398
        $(COMPILE.cpp) -o $@ $<