30
30
# This is a general purpose makefile for use with Arduino hardware and
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.
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.)
37
36
# http://ed.am/dev/make/arduino-mk
39
38
# This makefile can be used as a drop-in replacement for the Arduino IDE's
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:
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:
44
43
# $ ln -s ~/src/arduino.mk Makefile
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
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
49
56
# your ~/.profile by adding something like this:
51
58
# export ARDUINODIR=~/somewhere/arduino-1.0
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:
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.
57
64
# $ export BOARD=uno
63
70
# determine values for SOURCES, TARGET and LIBRARIES. Any .c, .cc and .cpp
64
71
# files in the project directory (or any "util" or "utility" subdirectories)
65
72
# are automatically included in the build and are scanned for Arduino libraries
66
# 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 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.
68
77
# Alternatively, if you want to manually specify build variables, create a
69
78
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
70
# (There is no need to define TARGET). Here is an example Makefile:
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:
72
82
# SOURCES := main.cc other.cc
73
83
# LIBRARIES := EEPROM
74
85
# include ~/src/arduino.mk
76
87
# Here is a complete list of configuration parameters:
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 unset.
84
# AVRTOOLSPATH A space-separated list of directories to search in order when
85
# lookin for the avr build tools. This defaults to the system PATH
86
# followed by subdirectories in ARDUINODIR if unset.
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.
88
105
# BOARD Specify a target board type. Run `make boards` to see available
91
# LIBRARIES A list of arduino libraries to build and include. This is set
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
92
115
# automatically if a .ino (or .pde) is found.
94
# SERIALDEV The unix device name of the serial device that is the arduino.
95
# If unspecified, an attempt is made to determine the name of a
96
# connected arduino's serial device.
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
126
# SOURCES A list of all source files of whatever language. The language
99
127
# type is determined by the file extension. This is set
138
173
ARDUINOCONST ?= 100
140
175
# default path for avr tools
142
AVRTOOLSPATH := $(subst :, , $(PATH))
143
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools
144
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
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_UPLOAD_SPEED := $(call readboardsparam,upload.speed)
206
BOARD_UPLOAD_PROTOCOL := $(call readboardsparam,upload.protocol)
207
BOARD_USB_VID := $(call readboardsparam,build.vid)
208
BOARD_USB_PID := $(call readboardsparam,build.pid)
209
BOARD_BOOTLOADER_UNLOCK := $(call readboardsparam,bootloader.unlock_bits)
210
BOARD_BOOTLOADER_LOCK := $(call readboardsparam,bootloader.lock_bits)
211
BOARD_BOOTLOADER_LFUSES := $(call readboardsparam,bootloader.low_fuses)
212
BOARD_BOOTLOADER_HFUSES := $(call readboardsparam,bootloader.high_fuses)
213
BOARD_BOOTLOADER_EFUSES := $(call readboardsparam,bootloader.extended_fuses)
214
BOARD_BOOTLOADER_PATH := $(call readboardsparam,bootloader.path)
215
BOARD_BOOTLOADER_FILE := $(call readboardsparam,bootloader.file)
217
# obtain preferences from the IDE's preferences.txt
218
PREFERENCESFILE := $(firstword $(wildcard \
219
$(HOME)/.arduino/preferences.txt $(HOME)/Library/Arduino/preferences.txt))
220
ifneq "$(PREFERENCESFILE)" ""
221
readpreferencesparam = $(shell sed -ne "s/$(1)=\(.*\)/\1/p" $(PREFERENCESFILE))
222
SKETCHBOOKDIR := $(call readpreferencesparam,sketchbook.path)
226
ifeq "$(BOARD_BUILD_MCU)" ""
227
ifneq "$(MAKECMDGOALS)" "boards"
228
ifneq "$(MAKECMDGOALS)" "clean"
229
$(error BOARD is invalid. Type 'make boards' to see possible values)
148
235
INOFILE := $(wildcard *.ino *.pde)
150
ifneq ($(words $(INOFILE)), 1)
237
ifneq "$(words $(INOFILE))" "1"
151
238
$(error There is more than one .pde or .ino file in this directory!)
154
241
# automatically determine sources and targeet
155
242
TARGET := $(basename $(INOFILE))
156
243
SOURCES := $(INOFILE) \
157
$(wildcard *.c *.cc *.cpp) \
158
$(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
159
$(wildcard $(addprefix utility/, *.c *.cc *.cpp))
244
$(wildcard *.c *.cc *.cpp *.C) \
245
$(wildcard $(addprefix util/, *.c *.cc *.cpp *.C)) \
246
$(wildcard $(addprefix utility/, *.c *.cc *.cpp *.C))
161
248
# automatically determine included libraries
162
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
163
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
249
LIBRARIES := $(filter $(notdir $(wildcard $(addsuffix /*, $(LIBRARYPATH)))), \
164
250
$(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
168
# no board? oh dear...
170
ifneq "$(MAKECMDGOALS)" "boards"
171
ifneq "$(MAKECMDGOALS)" "clean"
172
$(error BOARD is unset. Type 'make boards' to see possible values)
177
# no serial device? make a poor attempt to detect an arduino
178
ifeq ($(SERIALDEV), )
179
SERIALDEV := $(firstword $(wildcard /dev/ttyACM? /dev/ttyUSB?))
183
255
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
184
256
CC := $(call findsoftware,avr-gcc)
187
259
AR := $(call findsoftware,avr-ar)
188
260
OBJCOPY := $(call findsoftware,avr-objcopy)
189
261
AVRDUDE := $(call findsoftware,avrdude)
262
AVRSIZE := $(call findsoftware,avr-size)
265
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
266
LIBRARYDIRS := $(foreach lib, $(LIBRARIES), \
267
$(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARYPATH)))))
268
LIBRARYDIRS += $(addsuffix /utility, $(LIBRARYDIRS))
192
TARGET := $(if $(TARGET), $(TARGET), a.out)
271
TARGET := $(if $(TARGET),$(TARGET),a.out)
193
272
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
194
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
195
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
196
ARDUINOLIB := _arduino.a
197
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
198
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
199
$(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
200
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
201
$(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
202
$(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
203
$(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
273
DEPFILES := $(patsubst %, .dep/%.dep, $(SOURCES))
274
ARDUINOLIB := .lib/arduino.a
275
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(LIBRARYDIRS), \
276
$(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, *.c *.cpp))))
277
BOOTLOADERHEX := $(addprefix \
278
$(ARDUINODIR)/hardware/arduino/bootloaders/$(BOARD_BOOTLOADER_PATH)/, \
279
$(BOARD_BOOTLOADER_FILE))
281
# avrdude confifuration
282
ifeq "$(AVRDUDECONF)" ""
283
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
284
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
204
286
AVRDUDECONF := $(wildcard $(AVRDUDE).conf)
206
# obtain board parameters from the arduino boards.txt file
207
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
209
$(shell sed -ne "s/$(BOARD).build.mcu=\(.*\)/\1/p" $(BOARDS_FILE))
210
BOARD_BUILD_FCPU := \
211
$(shell sed -ne "s/$(BOARD).build.f_cpu=\(.*\)/\1/p" $(BOARDS_FILE))
212
BOARD_BUILD_VARIANT := \
213
$(shell sed -ne "s/$(BOARD).build.variant=\(.*\)/\1/p" $(BOARDS_FILE))
214
BOARD_UPLOAD_SPEED := \
215
$(shell sed -ne "s/$(BOARD).upload.speed=\(.*\)/\1/p" $(BOARDS_FILE))
216
BOARD_UPLOAD_PROTOCOL := \
217
$(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
220
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
291
CPPFLAGS += -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
221
292
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
222
293
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
223
294
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
224
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
225
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
226
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
227
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
228
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
295
CPPFLAGS += -DUSB_VID=$(BOARD_USB_VID) -DUSB_PID=$(BOARD_USB_PID)
296
CPPFLAGS += -I. -Iutil -Iutility -I $(ARDUINOCOREDIR)
297
CPPFLAGS += -I $(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
298
CPPFLAGS += $(addprefix -I , $(LIBRARYDIRS))
299
CPPDEPFLAGS = -MMD -MP -MF .dep/$<.dep
300
CPPINOFLAGS := -x c++ -include $(ARDUINOCOREDIR)/Arduino.h
301
AVRDUDEFLAGS += $(addprefix -C , $(AVRDUDECONF)) -DV
229
302
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
230
303
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
231
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
304
LINKFLAGS += -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
306
# figure out which arg to use with stty (for OS X, GNU and busybox stty)
307
STTYFARG := $(shell stty --help 2>&1 | \
308
grep -q 'illegal option' && echo -f || echo -F)
310
# include dependencies
311
ifneq "$(MAKECMDGOALS)" "clean"
234
316
.DEFAULT_GOAL := all
236
318
#_______________________________________________________________________________
239
.PHONY: all target upload clean boards monitor
321
.PHONY: all target upload clean boards monitor size bootloader
243
325
target: $(TARGET).hex
246
328
@echo "\nUploading to board..."
247
329
@test -n "$(SERIALDEV)" || { \
248
330
echo "error: SERIALDEV could not be determined automatically." >&2; \
250
stty -F $(SERIALDEV) hupcl
332
@test 0 -eq $(SERIALDEVGUESS) || { \
333
echo "*GUESSING* at serial device:" $(SERIALDEV); \
335
ifeq "$(BOARD_BOOTLOADER_PATH)" "caterina"
336
stty $(STTYFARG) $(SERIALDEV) speed 1200
339
stty $(STTYFARG) $(SERIALDEV) hupcl
251
340
$(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
255
344
rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
256
rm -rf $(ARDUINOLIBTMP)
259
@echo Available values for BOARD:
260
@sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1 \2/;T' \
261
-e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
348
@echo "Available values for BOARD:"
349
@sed -nEe '/^#/d; /^[^.]+\.name=/p' $(BOARDSFILE) | \
350
sed -Ee 's/([^.]+)\.name=(.*)/\1 \2/' \
351
-e 's/(.{12}) *(.*)/\1 \2/'
264
354
@test -n "$(SERIALDEV)" || { \
267
357
@test -n `which screen` || { \
268
358
echo "error: can't find GNU screen, you might need to install it." >&2 \
360
@test 0 -eq $(SERIALDEVGUESS) || { \
361
echo "*GUESSING* at serial device:" $(SERIALDEV); \
270
363
screen $(SERIALDEV)
366
echo && $(AVRSIZE) --format=avr --mcu=$(BOARD_BUILD_MCU) $(TARGET).elf
369
@echo "Burning bootloader to board..."
370
@test -n "$(SERIALDEV)" || { \
371
echo "error: SERIALDEV could not be determined automatically." >&2; \
373
@test 0 -eq $(SERIALDEVGUESS) || { \
374
echo "*GUESSING* at serial device:" $(SERIALDEV); \
376
stty $(STTYFARG) $(SERIALDEV) hupcl
377
$(AVRDUDE) $(AVRDUDEFLAGS) -U lock:w:$(BOARD_BOOTLOADER_UNLOCK):m
378
$(AVRDUDE) $(AVRDUDEFLAGS) -eU lfuse:w:$(BOARD_BOOTLOADER_LFUSES):m
379
$(AVRDUDE) $(AVRDUDEFLAGS) -U hfuse:w:$(BOARD_BOOTLOADER_HFUSES):m
380
ifneq "$(BOARD_BOOTLOADER_EFUSES)" ""
381
$(AVRDUDE) $(AVRDUDEFLAGS) -U efuse:w:$(BOARD_BOOTLOADER_EFUSES):m
383
ifneq "$(BOOTLOADERHEX)" ""
384
$(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(BOOTLOADERHEX):i
386
$(AVRDUDE) $(AVRDUDEFLAGS) -U lock:w:$(BOARD_BOOTLOADER_LOCK):m
272
388
# building the target
274
390
$(TARGET).hex: $(TARGET).elf
277
393
.INTERMEDIATE: $(TARGET).elf
279
395
$(TARGET).elf: $(ARDUINOLIB) $(OBJECTS)
280
$(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -o $@
396
$(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -lm -o $@
399
mkdir -p .dep/$(dir $<)
400
$(COMPILE.c) $(CPPDEPFLAGS) -o $@ $<
403
mkdir -p .dep/$(dir $<)
404
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
407
mkdir -p .dep/$(dir $<)
408
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
411
mkdir -p .dep/$(dir $<)
412
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
283
$(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
415
mkdir -p .dep/$(dir $<)
416
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
286
$(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
419
mkdir -p .dep/$(dir $<)
420
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
288
422
# building the arduino library
290
424
$(ARDUINOLIB): $(ARDUINOLIBOBJS)
292
rm -rf $(ARDUINOLIBTMP)
294
.INTERMEDIATE: $(ARDUINOLIBOBJS)
296
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.c
297
@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
298
$(COMPILE.c) -o $@ $<
300
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.cpp
301
@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
302
$(COMPILE.cpp) -o $@ $<
304
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.c
305
@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
306
$(COMPILE.c) -o $@ $<
308
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
309
@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
310
$(COMPILE.cpp) -o $@ $<
312
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c
313
@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
314
$(COMPILE.c) -o $@ $<
316
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp
317
@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
318
$(COMPILE.cpp) -o $@ $<
429
$(COMPILE.c) -o $@ $<
433
$(COMPILE.cpp) -o $@ $<
437
$(COMPILE.cpp) -o $@ $<
441
$(COMPILE.cpp) -o $@ $<