1
1
#_______________________________________________________________________________
3
# edam's Arduino makefile
3
# edam's arduino makefile
4
4
#_______________________________________________________________________________
7
# Copyright (C) 2011, 2012 Tim Marston <tim@ed.am>.
7
# Copyright (c) 2011 Tim Marston <tim@ed.am>.
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
30
30
# This is a general purpose makefile for use with Arduino hardware and
31
# software. It works with the arduino-1.0 software release. To download the
32
# latest version of this makefile, visit the following website, where you can
33
# also find more information and documentation on it's use. The following text
34
# can only really be considered a reference to it's use.
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
43
44
# $ ln -s ~/src/arduino.mk Makefile
45
# The Arduino software (version 1.0 or later) is required. If you are using
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/.
48
# It is suggested that you install it at ~/opt/arduino if you are unsure.
50
# If you downloaded the Arduino software manually and unpacked it somewhere
51
# other than ~/opt/arduino, you will need to set up ARDUINODIR to be the path
52
# where you unpacked it. (If unset, ARDUINODIR defaults to ~/opt/arduino and
53
# then /usr/share/arduino, in that order.) You might be best to 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
54
49
# your ~/.profile by adding something like this:
56
51
# export ARDUINODIR=~/somewhere/arduino-1.0
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
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.
66
# that have been #included. Note, there can only be one .ino (or .pde) file.
75
68
# Alternatively, if you want to manually specify build variables, create a
76
69
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
83
76
# Here is a complete list of configuration parameters:
85
# ARDUINODIR The path where the Arduino software is installed on your system.
87
# ARDUINOCONST The Arduino software version, as an integer, used to define the
88
# ARDUINO version constant. This defaults to 100 if undefined.
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
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
92
86
# is passed to avrdude (to the system default is used).
94
# AVRDUDEFLAGS Specify any additional flags for avrdude. The usual flags,
95
# required to build the project, will be appended to this.
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.
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.
101
92
# BOARD Specify a target board type. Run `make boards` to see available
104
# CPPFLAGS Specify any additional flags for the compiler. The usual flags,
105
# required to build the project, will be appended to this.
107
# LINKFLAGS Specify any additional flags for the linker. The usual flags,
108
# required to build the project, will be appended to this.
110
# 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
111
96
# automatically if a .ino (or .pde) is found.
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.
117
# SERIALDEV The unix device name of the serial device that is the Arduino.
98
# SERIALDEV The unix device name of the serial device that is the arduino.
118
99
# If unspecified, an attempt is made to determine the name of a
119
# connected Arduino's serial device.
100
# connected arduino's serial device.
121
102
# SOURCES A list of all source files of whatever language. The language
122
103
# type is determined by the file extension. This is set
142
123
# BOARD environment variable appropriately.
144
125
# monitor Start `screen` on the serial device. This is meant to be an
145
# equivalent to the Arduino serial monitor.
147
# size Displays size information about the bulit target.
149
# bootloader Burns the bootloader for your board to it.
126
# equivalent to the arduino serial monitor.
151
128
# <file> Builds the specified file, either an object file or the target,
152
129
# from those that that would be built for the project.
165
142
ARDUINOCONST ?= 100
167
144
# default path for avr tools
168
AVRTOOLSPATH ?= $(subst :, , $(PATH)) $(ARDUINODIR)/hardware/tools \
169
$(ARDUINODIR)/hardware/tools/avr/bin
171
# default path to find libraries
172
LIBRARYPATH ?= libraries libs $(SKETCHBOOKDIR)/libraries $(ARDUINODIR)/libraries
174
# default serial device to a poor guess (something that might be an arduino)
177
SERIALDEV := $(firstword $(wildcard \
178
/dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))
184
ifneq "$(MAKECMDGOALS)" "boards"
185
ifneq "$(MAKECMDGOALS)" "clean"
186
$(error BOARD is unset. Type 'make boards' to see possible values)
191
# obtain board parameters from the arduino boards.txt file
192
BOARDSFILE := $(ARDUINODIR)/hardware/arduino/boards.txt
193
readboardsparam = $(shell sed -ne "s/$(BOARD).$(1)=\(.*\)/\1/p" $(BOARDSFILE))
194
BOARD_BUILD_MCU := $(call readboardsparam,build.mcu)
195
BOARD_BUILD_FCPU := $(call readboardsparam,build.f_cpu)
196
BOARD_BUILD_VARIANT := $(call readboardsparam,build.variant)
197
BOARD_UPLOAD_SPEED := $(call readboardsparam,upload.speed)
198
BOARD_UPLOAD_PROTOCOL := $(call readboardsparam,upload.protocol)
199
BOARD_USB_VID := $(call readboardsparam,build.vid)
200
BOARD_USB_PID := $(call readboardsparam,build.pid)
201
BOARD_BOOTLOADER_UNLOCK := $(call readboardsparam,bootloader.unlock_bits)
202
BOARD_BOOTLOADER_LOCK := $(call readboardsparam,bootloader.lock_bits)
203
BOARD_BOOTLOADER_LFUSES := $(call readboardsparam,bootloader.low_fuses)
204
BOARD_BOOTLOADER_HFUSES := $(call readboardsparam,bootloader.high_fuses)
205
BOARD_BOOTLOADER_EFUSES := $(call readboardsparam,bootloader.extended_fuses)
206
BOARD_BOOTLOADER_PATH := $(call readboardsparam,bootloader.path)
207
BOARD_BOOTLOADER_FILE := $(call readboardsparam,bootloader.file)
209
# obtain preferences from the IDE's preferences.txt
210
PREFERENCESFILE := $(wildcard $(HOME)/.arduino/preferences.txt)
211
ifneq "$(PREFERENCESFILE)" ""
212
readpreferencesparam = $(shell sed -ne "s/$(1)=\(.*\)/\1/p" $(PREFERENCESFILE))
213
SKETCHBOOKDIR := $(call readpreferencesparam,sketchbook.path)
217
ifeq "$(BOARD_BUILD_MCU)" ""
218
ifneq "$(MAKECMDGOALS)" "boards"
219
ifneq "$(MAKECMDGOALS)" "clean"
220
$(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
232
158
# automatically determine sources and targeet
233
159
TARGET := $(basename $(INOFILE))
234
160
SOURCES := $(INOFILE) \
235
$(wildcard *.c *.cc *.cpp *.C) \
236
$(wildcard $(addprefix util/, *.c *.cc *.cpp *.C)) \
237
$(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))
239
165
# automatically determine included libraries
240
LIBRARIES := $(filter $(notdir $(wildcard $(addsuffix /*, $(LIBRARYPATH)))), \
166
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
167
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
241
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*))
246
181
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
247
182
CC := $(call findsoftware,avr-gcc)
250
185
AR := $(call findsoftware,avr-ar)
251
186
OBJCOPY := $(call findsoftware,avr-objcopy)
252
187
AVRDUDE := $(call findsoftware,avrdude)
253
AVRSIZE := $(call findsoftware,avr-size)
256
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
257
LIBRARYDIRS := $(foreach lib, $(LIBRARIES), \
258
$(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARYPATH)))))
259
LIBRARYDIRS += $(addsuffix /utility, $(LIBRARYDIRS))
261
$(ARDUINODIR)/hardware/arduino/bootloaders/$(BOARD_BOOTLOADER_PATH)
264
190
TARGET := $(if $(TARGET),$(TARGET),a.out)
265
191
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
266
DEPFILES := $(patsubst %, .dep/%.dep, $(SOURCES))
267
ARDUINOLIB := .lib/arduino.a
268
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(LIBRARYDIRS), \
269
$(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, *.c *.cpp))))
270
BOOTLOADERHEX := $(wildcard $(BOOTLOADERDIR)/$(BOARD_BOOTLOADER_FILE))
272
# 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)) ))))
273
202
ifeq "$(AVRDUDECONF)" ""
274
203
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
275
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)
282
CPPFLAGS += -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
242
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
283
243
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
284
244
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
285
245
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
286
CPPFLAGS += -DUSB_VID=$(BOARD_USB_VID) -DUSB_PID=$(BOARD_USB_PID)
287
CPPFLAGS += -I. -Iutil -Iutility -I $(ARDUINOCOREDIR)
288
CPPFLAGS += -I $(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
289
CPPFLAGS += $(addprefix -I , $(LIBRARYDIRS))
290
CPPDEPFLAGS = -MMD -MP -MF .dep/$<.dep
291
CPPINOFLAGS := -x c++ -include $(ARDUINOCOREDIR)/Arduino.h
292
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
293
251
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
294
252
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
295
LINKFLAGS += -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
297
# figure out which arg to use with stty (for OS X, GNU and busybox stty)
298
STTYFARG := $(shell stty --help 2>&1 | \
299
grep -q 'illegal option' && echo -f || echo -F)
301
# include dependencies
302
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)
307
259
.DEFAULT_GOAL := all
309
261
#_______________________________________________________________________________
312
.PHONY: all target upload clean boards monitor size bootloader
264
.PHONY: all target upload clean boards monitor
316
268
target: $(TARGET).hex
319
271
@echo "\nUploading to board..."
320
272
@test -n "$(SERIALDEV)" || { \
321
273
echo "error: SERIALDEV could not be determined automatically." >&2; \
323
@test 0 -eq $(SERIALDEVGUESS) || { \
275
@test 1 -eq $(SERIALDEVGUESS) && { \
324
276
echo "*GUESSING* at serial device:" $(SERIALDEV); \
326
ifeq "$(BOARD_BOOTLOADER_PATH)" "caterina"
327
stty $(STTYFARG) $(SERIALDEV) speed 1200
330
278
stty $(STTYFARG) $(SERIALDEV) hupcl
331
279
$(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
335
283
rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
284
rm -rf $(ARDUINOLIBTMP)
339
@echo "Available values for BOARD:"
340
@sed -nEe '/^#/d; /^[^.]+\.name=/p' $(BOARDSFILE) | \
341
sed -Ee 's/([^.]+)\.name=(.*)/\1 \2/' \
342
-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)
345
292
@test -n "$(SERIALDEV)" || { \
348
295
@test -n `which screen` || { \
349
296
echo "error: can't find GNU screen, you might need to install it." >&2 \
351
@test 0 -eq $(SERIALDEVGUESS) || { \
298
@test 1 -eq $(SERIALDEVGUESS) && { \
352
299
echo "*GUESSING* at serial device:" $(SERIALDEV); \
354
301
screen $(SERIALDEV)
357
echo && $(AVRSIZE) --format=avr --mcu=$(BOARD_BUILD_MCU) $(TARGET).elf
360
@echo "Burning bootloader to board..."
361
@test -n "$(BOOTLOADERHEX)" || { \
362
echo "error: bootloader file could not be determined." >&2; \
364
@test -n "$(SERIALDEV)" || { \
365
echo "error: SERIALDEV could not be determined automatically." >&2; \
367
@test 0 -eq $(SERIALDEVGUESS) || { \
368
echo "*GUESSING* at serial device:" $(SERIALDEV); \
370
stty $(STTYFARG) $(SERIALDEV) hupcl
371
$(AVRDUDE) $(AVRDUDEFLAGS) -U lock:w:$(BOARD_BOOTLOADER_UNLOCK):m
372
$(AVRDUDE) $(AVRDUDEFLAGS) -e -U lfuse:w:$(BOARD_BOOTLOADER_LFUSES):m \
373
-U hfuse:w:$(BOARD_BOOTLOADER_HFUSES):m \
374
$(patsubst %, -U efuse:w:%:m, $(BOARD_BOOTLOADER_EFUSES))
375
$(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(BOOTLOADERHEX):i
376
$(AVRDUDE) $(AVRDUDEFLAGS) -U lock:w:$(BOARD_BOOTLOADER_LOCK):m
378
303
# building the target
380
305
$(TARGET).hex: $(TARGET).elf
383
308
.INTERMEDIATE: $(TARGET).elf
385
310
$(TARGET).elf: $(ARDUINOLIB) $(OBJECTS)
386
$(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -lm -o $@
389
mkdir -p .dep/$(dir $<)
390
$(COMPILE.c) $(CPPDEPFLAGS) -o $@ $<
393
mkdir -p .dep/$(dir $<)
394
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
397
mkdir -p .dep/$(dir $<)
398
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
401
mkdir -p .dep/$(dir $<)
402
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
311
$(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -o $@
405
mkdir -p .dep/$(dir $<)
406
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
314
$(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
409
mkdir -p .dep/$(dir $<)
410
$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
317
$(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
412
319
# building the arduino library
414
321
$(ARDUINOLIB): $(ARDUINOLIBOBJS)
419
$(COMPILE.c) -o $@ $<
423
$(COMPILE.cpp) -o $@ $<
427
$(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)
431
349
$(COMPILE.cpp) -o $@ $<