30
30
# This is a general purpose makefile for use with Arduino hardware and
31
# software. It works with the arduino-1.0 and later software releases. It
32
# should work GNU/Linux and OS X. To download the latest version of this
33
# makefile visit the following website where you can also find documentation on
34
# it's use. (The following text can only really be considered a reference.)
31
# software. It works with the arduino-1.0 release and requires that software
32
# to be downloaded separately (see http://arduino.cc/). To download the latest
33
# version of this makefile, visit the following website, where you can also
34
# find more information and documentation on it's use. The following text can
35
# only really be considered a reference to it's use.
36
37
# http://ed.am/dev/make/arduino-mk
38
39
# This makefile can be used as a drop-in replacement for the Arduino IDE's
39
# build system. To use it, just copy arduino.mk in to your project directory.
40
# Or, you could save it somewhere (I keep mine at ~/src/arduino.mk) and create
41
# a symlink to it in your project directory, named "Makefile". For example:
40
# build system. To use it, save arduino.mk somewhere (I keep mine at
41
# ~/src/arduino.mk) and create a symlink to it in your project directory named
42
# "Makefile". For example:
43
44
# $ ln -s ~/src/arduino.mk Makefile
45
# The Arduino software (version 1.0 or later) is required. On GNU/Linux you
46
# can probably install the software from your package manager. If you are
47
# using Debian (or a derivative), try `apt-get install arduino`. Otherwise,
48
# you can download the Arduino software manually from http://arduino.cc/. It
49
# is suggested that you install it at ~/opt/arduino (or /Applications on OS X)
52
# If you downloaded the Arduino software manually and unpacked it somewhere
53
# other than ~/opt/arduino (or /Applications), you will need to set up the
54
# ARDUINODIR environment variable to be the path where you unpacked it. (If
55
# unset, ARDUINODIR defaults to some sensible places). You could set this in
46
# You also need to set up a couple of environment variables. ARDUINODIR should
47
# be set to the path where you unpacked the arduino software from arduino.cc
48
# (it defaults to ~/opt/arduino if unset). You might be best to set this in
56
49
# your ~/.profile by adding something like this:
58
51
# export ARDUINODIR=~/somewhere/arduino-1.0
60
# For each project, you will also need to set BOARD to the type of Arduino
61
# you're building for. Type `make boards` for a list of acceptable values.
53
# You will also need to set BOARD to the type of arduino you're using. This
54
# can be done when running make (or you could set a default in ~/.profile and
55
# override it as necessary). For example:
64
57
# $ export BOARD=uno
70
63
# determine values for SOURCES, TARGET and LIBRARIES. Any .c, .cc and .cpp
71
64
# files in the project directory (or any "util" or "utility" subdirectories)
72
65
# 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 in
74
# a project directory and if you want to be compatible with the Arduino IDE, it
75
# should be called the same as the directory name.
66
# that have been #included. Note, there can only be one .ino (or .pde) file.
77
68
# Alternatively, if you want to manually specify build variables, create a
78
69
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
79
# (There is no need to define TARGET). You can also specify the BOARD here, if
80
# the project has a specific one. Here is an example Makefile:
70
# (There is no need to define TARGET). Here is an example Makefile:
82
72
# SOURCES := main.cc other.cc
83
73
# LIBRARIES := EEPROM
85
74
# include ~/src/arduino.mk
87
76
# Here is a complete list of configuration parameters:
89
# ARDUINODIR The path where the Arduino software is installed on your system.
91
# ARDUINOCONST The Arduino software version, as an integer, used to define the
92
# ARDUINO version constant. This defaults to 100 if undefined.
94
# AVRDUDECONF The avrdude.conf to use. If undefined, this defaults to a guess
95
# based on where avrdude is. If set empty, no avrdude.conf is
96
# passed to avrdude (so the system default is used).
98
# AVRDUDEFLAGS Specify any additional flags for avrdude. The usual flags,
99
# required to build the project, will be appended to this.
101
# AVRTOOLSPATH A space-separated list of directories that is searched in order
102
# when looking for the avr build tools. This defaults to PATH,
103
# followed by subdirectories in ARDUINODIR.
78
# ARDUINODIR The path where you have installed/unpacked the arduino software
79
# (from http://arduino.cc/)
81
# ARDUINOCONST The arduino software version, as an integer, used to define the
82
# ARDUINO version constant. This defaults to 100 if undefined.
84
# AVRDUDECONF The avrdude.conf to use. If undefined, this defaults to a guess
85
# based on where the avrdude in use is. If empty, no avrdude.conf
86
# is passed to avrdude (to the system default is used).
88
# AVRTOOLSPATH A space-separated list of directories to search in order when
89
# lookin for the avr build tools. This defaults to the system PATH
90
# followed by subdirectories in ARDUINODIR if undefined.
105
92
# BOARD Specify a target board type. Run `make boards` to see available
108
# CPPFLAGS Specify any additional flags for the compiler. The usual flags,
109
# required to build the project, will be appended to this.
111
# LINKFLAGS Specify any additional flags for the linker. The usual flags,
112
# required to build the project, will be appended to this.
114
# LIBRARIES A list of Arduino libraries to build and include. This is set
95
# LIBRARIES A list of arduino libraries to build and include. This is set
115
96
# automatically if a .ino (or .pde) is found.
117
# LIBRARYPATH A space-separated list of directories that is searched in order
118
# when looking for Arduino libraries. This defaults to "libs",
119
# "libraries" (in the project directory), then your sketchbook
120
# "libraries" directory, then the Arduino libraries directory.
122
# SERIALDEV The POSIX device name of the serial device that is the Arduino.
123
# If unspecified, an attempt is made to guess the name of a
124
# connected Arduino's serial device, which may work in some cases.
98
# SERIALDEV The unix device name of the serial device that is the arduino.
99
# If unspecified, an attempt is made to determine the name of a
100
# connected arduino's serial device.
126
102
# SOURCES A list of all source files of whatever language. The language
127
103
# type is determined by the file extension. This is set
173
142
ARDUINOCONST ?= 100
175
144
# default path for avr tools
176
AVRTOOLSPATH ?= $(subst :, , $(PATH)) $(ARDUINODIR)/hardware/tools \
177
$(ARDUINODIR)/hardware/tools/avr/bin
179
# default path to find libraries
180
LIBRARYPATH ?= libraries libs $(SKETCHBOOKDIR)/libraries $(ARDUINODIR)/libraries
182
# default serial device to a poor guess (something that might be an arduino)
185
SERIALDEV := $(firstword $(wildcard \
186
/dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))
192
ifneq "$(MAKECMDGOALS)" "boards"
193
ifneq "$(MAKECMDGOALS)" "clean"
194
$(error BOARD is unset. Type 'make boards' to see possible values)
199
# obtain board parameters from the arduino boards.txt file
200
BOARDSFILE := $(ARDUINODIR)/hardware/arduino/boards.txt
201
readboardsparam = $(shell sed -ne "s/$(BOARD).$(1)=\(.*\)/\1/p" $(BOARDSFILE))
202
BOARD_BUILD_MCU := $(call readboardsparam,build.mcu)
203
BOARD_BUILD_FCPU := $(call readboardsparam,build.f_cpu)
204
BOARD_BUILD_VARIANT := $(call readboardsparam,build.variant)
205
BOARD_BUILD_CORE := $(call readboardsparam,build.core)
206
BOARD_UPLOAD_SPEED := $(call readboardsparam,upload.speed)
207
BOARD_UPLOAD_PROTOCOL := $(call readboardsparam,upload.protocol)
208
BOARD_USB_VID := $(call readboardsparam,build.vid)
209
BOARD_USB_PID := $(call readboardsparam,build.pid)
210
BOARD_BOOTLOADER_UNLOCK := $(call readboardsparam,bootloader.unlock_bits)
211
BOARD_BOOTLOADER_LOCK := $(call readboardsparam,bootloader.lock_bits)
212
BOARD_BOOTLOADER_LFUSES := $(call readboardsparam,bootloader.low_fuses)
213
BOARD_BOOTLOADER_HFUSES := $(call readboardsparam,bootloader.high_fuses)
214
BOARD_BOOTLOADER_EFUSES := $(call readboardsparam,bootloader.extended_fuses)
215
BOARD_BOOTLOADER_PATH := $(call readboardsparam,bootloader.path)
216
BOARD_BOOTLOADER_FILE := $(call readboardsparam,bootloader.file)
218
# obtain preferences from the IDE's preferences.txt
219
PREFERENCESFILE := $(firstword $(wildcard \
220
$(HOME)/.arduino/preferences.txt $(HOME)/Library/Arduino/preferences.txt))
221
ifneq "$(PREFERENCESFILE)" ""
222
readpreferencesparam = $(shell sed -ne "s/$(1)=\(.*\)/\1/p" $(PREFERENCESFILE))
223
SKETCHBOOKDIR := $(call readpreferencesparam,sketchbook.path)
227
ifeq "$(BOARD_BUILD_MCU)" ""
228
ifneq "$(MAKECMDGOALS)" "boards"
229
ifneq "$(MAKECMDGOALS)" "clean"
230
$(error BOARD is invalid. Type 'make boards' to see possible values)
146
AVRTOOLSPATH := $(subst :, , $(PATH))
147
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools
148
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
242
158
# automatically determine sources and targeet
243
159
TARGET := $(basename $(INOFILE))
244
160
SOURCES := $(INOFILE) \
245
$(wildcard *.c *.cc *.cpp *.C) \
246
$(wildcard $(addprefix util/, *.c *.cc *.cpp *.C)) \
247
$(wildcard $(addprefix utility/, *.c *.cc *.cpp *.C))
161
$(wildcard *.c *.cc *.cpp) \
162
$(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
163
$(wildcard $(addprefix utility/, *.c *.cc *.cpp))
249
165
# automatically determine included libraries
250
LIBRARIES := $(filter $(notdir $(wildcard $(addsuffix /*, $(LIBRARYPATH)))), \
166
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
167
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
251
168
$(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
172
# no serial device? make a poor attempt to detect an arduino
174
ifeq "$(SERIALDEV)" ""
175
SERIALDEV := $(firstword $(wildcard \
176
/dev/ttyACM? /dev/ttyUSB? /dev/tty.usbmodem*))
256
181
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
257
182
CC := $(call findsoftware,avr-gcc)
260
185
AR := $(call findsoftware,avr-ar)
261
186
OBJCOPY := $(call findsoftware,avr-objcopy)
262
187
AVRDUDE := $(call findsoftware,avrdude)
263
AVRSIZE := $(call findsoftware,avr-size)
266
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/$(BOARD_BUILD_CORE)
267
LIBRARYDIRS := $(foreach lib, $(LIBRARIES), \
268
$(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARYPATH)))))
269
LIBRARYDIRS += $(addsuffix /utility, $(LIBRARYDIRS))
272
190
TARGET := $(if $(TARGET),$(TARGET),a.out)
273
191
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
274
DEPFILES := $(patsubst %, .dep/%.dep, $(SOURCES))
275
ARDUINOLIB := .lib/arduino.a
276
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(LIBRARYDIRS), \
277
$(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, *.c *.cpp))))
278
BOOTLOADERHEX := $(addprefix \
279
$(ARDUINODIR)/hardware/arduino/bootloaders/$(BOARD_BOOTLOADER_PATH)/, \
280
$(BOARD_BOOTLOADER_FILE))
282
# avrdude confifuration
192
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
193
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
194
ARDUINOLIB := _arduino.a
195
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
196
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
197
$(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
198
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
199
$(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
200
$(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
201
$(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
283
202
ifeq "$(AVRDUDECONF)" ""
284
203
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
285
204
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
212
ifneq "$(MAKECMDGOALS)" "boards"
213
ifneq "$(MAKECMDGOALS)" "clean"
214
$(error BOARD is unset. Type 'make boards' to see possible values)
219
# obtain board parameters from the arduino boards.txt file
220
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
222
$(shell sed -ne "s/$(BOARD).build.mcu=\(.*\)/\1/p" $(BOARDS_FILE))
223
BOARD_BUILD_FCPU := \
224
$(shell sed -ne "s/$(BOARD).build.f_cpu=\(.*\)/\1/p" $(BOARDS_FILE))
225
BOARD_BUILD_VARIANT := \
226
$(shell sed -ne "s/$(BOARD).build.variant=\(.*\)/\1/p" $(BOARDS_FILE))
227
BOARD_UPLOAD_SPEED := \
228
$(shell sed -ne "s/$(BOARD).upload.speed=\(.*\)/\1/p" $(BOARDS_FILE))
229
BOARD_UPLOAD_PROTOCOL := \
230
$(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
233
ifeq "$(BOARD_BUILD_MCU)" ""
234
ifneq "$(MAKECMDGOALS)" "boards"
235
ifneq "$(MAKECMDGOALS)" "clean"
236
$(error BOARD is invalid. Type 'make boards' to see possible values)
292
CPPFLAGS += -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
242
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
293
243
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
294
244
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
295
245
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
296
CPPFLAGS += -DUSB_VID=$(BOARD_USB_VID) -DUSB_PID=$(BOARD_USB_PID)
297
CPPFLAGS += -I. -Iutil -Iutility -I $(ARDUINOCOREDIR)
298
CPPFLAGS += -I $(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
299
CPPFLAGS += $(addprefix -I , $(LIBRARYDIRS))
300
CPPDEPFLAGS = -MMD -MP -MF .dep/$<.dep
301
CPPINOFLAGS := -x c++ -include $(ARDUINOCOREDIR)/Arduino.h
302
AVRDUDEFLAGS += $(addprefix -C , $(AVRDUDECONF)) -DV
246
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
247
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
248
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
249
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
250
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
303
251
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
304
252
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
305
LINKFLAGS += -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
307
# figure out which arg to use with stty (for OS X, GNU and busybox stty)
308
STTYFARG := $(shell stty --help 2>&1 | \
309
grep -q 'illegal option' && echo -f || echo -F)
311
# include dependencies
312
ifneq "$(MAKECMDGOALS)" "clean"
253
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
255
# figure out which arg to use with stty
256
STTYFARG := $(shell stty --help > /dev/null 2>&1 && echo -F || echo -f)
317
259
.DEFAULT_GOAL := all
333
275
@test 0 -eq $(SERIALDEVGUESS) || { \
334
276
echo "*GUESSING* at serial device:" $(SERIALDEV); \
336
ifeq "$(BOARD_BOOTLOADER_PATH)" "caterina"
337
stty $(STTYFARG) $(SERIALDEV) speed 1200
340
278
stty $(STTYFARG) $(SERIALDEV) hupcl
342
279
$(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
346
283
rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
284
rm -rf $(ARDUINOLIBTMP)
350
@echo "Available values for BOARD:"
351
@sed -nEe '/^#/d; /^[^.]+\.name=/p' $(BOARDSFILE) | \
352
sed -Ee 's/([^.]+)\.name=(.*)/\1 \2/' \
353
-e 's/(.{12}) *(.*)/\1 \2/'
287
@echo Available values for BOARD:
288
@sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1 \2/;T' \
289
-e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
356
292
@test -n "$(SERIALDEV)" || { \
359
295
@test -n `which screen` || { \
360
296
echo "error: can't find GNU screen, you might need to install it." >&2 \
362
298
@test 0 -eq $(SERIALDEVGUESS) || { \
363
299
echo "*GUESSING* at serial device:" $(SERIALDEV); \
365
301
screen $(SERIALDEV)
368
echo && $(AVRSIZE) --format=avr --mcu=$(BOARD_BUILD_MCU) $(TARGET).elf
371
@echo "Burning bootloader to board..."
372
@test -n "$(SERIALDEV)" || { \
373
echo "error: SERIALDEV could not be determined automatically." >&2; \
375
@test 0 -eq $(SERIALDEVGUESS) || { \
376
echo "*GUESSING* at serial device:" $(SERIALDEV); \
378
stty $(STTYFARG) $(SERIALDEV) hupcl
379
$(AVRDUDE) $(AVRDUDEFLAGS) -U lock:w:$(BOARD_BOOTLOADER_UNLOCK):m
380
$(AVRDUDE) $(AVRDUDEFLAGS) -eU lfuse:w:$(BOARD_BOOTLOADER_LFUSES):m
381
$(AVRDUDE) $(AVRDUDEFLAGS) -U hfuse:w:$(BOARD_BOOTLOADER_HFUSES):m
382
ifneq "$(BOARD_BOOTLOADER_EFUSES)" ""
383
$(AVRDUDE) $(AVRDUDEFLAGS) -U efuse:w:$(BOARD_BOOTLOADER_EFUSES):m
385
ifneq "$(BOOTLOADERHEX)" ""
386
$(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(BOOTLOADERHEX):i
388
$(AVRDUDE) $(AVRDUDEFLAGS) -U lock:w:$(BOARD_BOOTLOADER_LOCK):m
390
303
# building the target
392
305
$(TARGET).hex: $(TARGET).elf
395
308
.INTERMEDIATE: $(TARGET).elf
397
310
$(TARGET).elf: $(ARDUINOLIB) $(OBJECTS)
398
$(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -lm -o $@
401
mkdir -p .dep/$(dir $<)
402
$(COMPILE.c) $(CPPDEPFLAGS) -o $@ $<
405
mkdir -p .dep/$(dir $<)
406
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
409
mkdir -p .dep/$(dir $<)
410
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
413
mkdir -p .dep/$(dir $<)
414
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
311
$(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -o $@
417
mkdir -p .dep/$(dir $<)
418
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
314
$(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
421
mkdir -p .dep/$(dir $<)
422
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
317
$(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
424
319
# building the arduino library
426
321
$(ARDUINOLIB): $(ARDUINOLIBOBJS)
431
$(COMPILE.c) -o $@ $<
435
$(COMPILE.cpp) -o $@ $<
439
$(COMPILE.cpp) -o $@ $<
443
$(COMPILE.cpp) -o $@ $<
323
rm -rf $(ARDUINOLIBTMP)
325
.INTERMEDIATE: $(ARDUINOLIBOBJS)
327
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.c
328
@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
329
$(COMPILE.c) -o $@ $<
331
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.cpp
332
@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
333
$(COMPILE.cpp) -o $@ $<
335
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.c
336
@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
337
$(COMPILE.c) -o $@ $<
339
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
340
@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
341
$(COMPILE.cpp) -o $@ $<
343
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c
344
@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
345
$(COMPILE.c) -o $@ $<
347
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp
348
@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
349
$(COMPILE.cpp) -o $@ $<