/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-02-21 15:27:09 UTC
  • Revision ID: tim@ed.am-20120221152709-zo3surexmx2789wn
added THANKS, fixed ARDUINODIR default to look in /usr/share/arduino and capitalised the use of "Arduino" where appropriate.

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