3
3
# edam's Arduino makefile
4
4
#_______________________________________________________________________________
7
# Copyright (C) 2011, 2012, 2013 Tim Marston <tim@ed.am>.
7
# Copyright (C) 2011, 2012 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 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 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.
36
36
# http://ed.am/dev/make/arduino-mk
38
38
# 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:
39
# build system. To use it, save arduino.mk somewhere (I keep mine at
40
# ~/src/arduino.mk) and create a symlink to it in your project directory named
41
# "Makefile". For example:
43
43
# $ 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)
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.
52
50
# 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
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
56
54
# your ~/.profile by adding something like this:
58
56
# 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.
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
64
64
# $ export BOARD=uno
70
70
# determine values for SOURCES, TARGET and LIBRARIES. Any .c, .cc and .cpp
71
71
# files in the project directory (or any "util" or "utility" subdirectories)
72
72
# 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.
73
# that have been #included. Note, there can only be one .ino (or .pde) file.
77
75
# Alternatively, if you want to manually specify build variables, create a
78
76
# 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:
77
# (There is no need to define TARGET). Here is an example Makefile:
82
79
# SOURCES := main.cc other.cc
83
80
# LIBRARIES := EEPROM
85
81
# include ~/src/arduino.mk
87
83
# Here is a complete list of configuration parameters:
89
85
# ARDUINODIR The path where the Arduino software is installed on your system.
91
87
# 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
# 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
92
# is passed to avrdude (to the system default is used).
94
# AVRTOOLSPATH A space-separated list of directories to search in order when
95
# looking for the avr build tools. This defaults to the system PATH
96
# followed by subdirectories in ARDUINODIR if undefined.
105
98
# 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
101
# LIBRARIES A list of Arduino libraries to build and include. This is set
115
102
# 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.
104
# SERIALDEV The unix device name of the serial device that is the Arduino.
105
# If unspecified, an attempt is made to determine the name of a
106
# connected Arduino's serial device.
126
108
# SOURCES A list of all source files of whatever language. The language
127
109
# type is determined by the file extension. This is set
150
131
# monitor Start `screen` on the serial device. This is meant to be an
151
132
# equivalent to the Arduino serial monitor.
153
# size Displays size information about the built target.
155
# bootloader Burns the bootloader for your board to it.
134
# size Displays size information about the bulit target.
157
136
# <file> Builds the specified file, either an object file or the target,
158
137
# from those that that would be built for the project.
162
141
# default arduino software directory, check software exists
163
142
ifndef ARDUINODIR
164
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino \
165
/Applications/Arduino.app/Contents/Resources/Java \
166
$(HOME)/Applications/Arduino.app/Contents/Resources/Java))
143
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))
168
145
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
169
146
$(error ARDUINODIR is not set correctly; arduino software not found)
173
150
ARDUINOCONST ?= 100
175
152
# 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)
154
AVRTOOLSPATH := $(subst :, , $(PATH))
155
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools
156
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
242
166
# automatically determine sources and targeet
243
167
TARGET := $(basename $(INOFILE))
244
168
SOURCES := $(INOFILE) \
245
$(wildcard *.c *.cc *.cpp *.C) \
246
$(wildcard $(addprefix util/, *.c *.cc *.cpp *.C)) \
247
$(wildcard $(addprefix utility/, *.c *.cc *.cpp *.C))
169
$(wildcard *.c *.cc *.cpp) \
170
$(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
171
$(wildcard $(addprefix utility/, *.c *.cc *.cpp))
249
173
# automatically determine included libraries
250
LIBRARIES := $(filter $(notdir $(wildcard $(addsuffix /*, $(LIBRARYPATH)))), \
174
LIBRARIES := $(filter $(notdir $(wildcard $(ARDUINODIR)/libraries/*)), \
251
175
$(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
179
# no serial device? make a poor attempt to detect an arduino
181
ifeq "$(SERIALDEV)" ""
182
SERIALDEV := $(firstword $(wildcard \
183
/dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))
256
188
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
257
189
CC := $(call findsoftware,avr-gcc)
262
194
AVRDUDE := $(call findsoftware,avrdude)
263
195
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
198
TARGET := $(if $(TARGET),$(TARGET),a.out)
273
199
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
274
200
DEPFILES := $(patsubst %, .dep/%.dep, $(SOURCES))
201
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
275
202
ARDUINOLIB := .lib/arduino.a
276
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(LIBRARYDIRS), \
203
ARDUINOLIBLIBSDIR := $(ARDUINODIR)/libraries
204
ARDUINOLIBLIBSPATH := $(foreach lib, $(LIBRARIES), \
205
$(ARDUINODIR)/libraries/$(lib)/ $(ARDUINODIR)/libraries/$(lib)/utility/ )
206
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(ARDUINOLIBLIBSPATH), \
277
207
$(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
283
208
ifeq "$(AVRDUDECONF)" ""
284
209
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
285
210
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
218
ifneq "$(MAKECMDGOALS)" "boards"
219
ifneq "$(MAKECMDGOALS)" "clean"
220
$(error BOARD is unset. Type 'make boards' to see possible values)
225
# obtain board parameters from the arduino boards.txt file
226
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
228
$(shell sed -ne "s/$(BOARD).build.mcu=\(.*\)/\1/p" $(BOARDS_FILE))
229
BOARD_BUILD_FCPU := \
230
$(shell sed -ne "s/$(BOARD).build.f_cpu=\(.*\)/\1/p" $(BOARDS_FILE))
231
BOARD_BUILD_VARIANT := \
232
$(shell sed -ne "s/$(BOARD).build.variant=\(.*\)/\1/p" $(BOARDS_FILE))
233
BOARD_UPLOAD_SPEED := \
234
$(shell sed -ne "s/$(BOARD).upload.speed=\(.*\)/\1/p" $(BOARDS_FILE))
235
BOARD_UPLOAD_PROTOCOL := \
236
$(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
238
$(shell sed -ne "s/$(BOARD).build.vid=\(.*\)/\1/p" $(BOARDS_FILE))
240
$(shell sed -ne "s/$(BOARD).build.pid=\(.*\)/\1/p" $(BOARDS_FILE))
243
ifeq "$(BOARD_BUILD_MCU)" ""
244
ifneq "$(MAKECMDGOALS)" "boards"
245
ifneq "$(MAKECMDGOALS)" "clean"
246
$(error BOARD is invalid. Type 'make boards' to see possible values)
292
252
CPPFLAGS += -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
293
253
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
296
256
CPPFLAGS += -DUSB_VID=$(BOARD_USB_VID) -DUSB_PID=$(BOARD_USB_PID)
297
257
CPPFLAGS += -I. -Iutil -Iutility -I $(ARDUINOCOREDIR)
298
258
CPPFLAGS += -I $(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
299
CPPFLAGS += $(addprefix -I , $(LIBRARYDIRS))
259
CPPFLAGS += $(addprefix -I $(ARDUINODIR)/libraries/, $(LIBRARIES))
260
CPPFLAGS += $(patsubst %, -I $(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
300
261
CPPDEPFLAGS = -MMD -MP -MF .dep/$<.dep
301
262
CPPINOFLAGS := -x c++ -include $(ARDUINOCOREDIR)/Arduino.h
302
263
AVRDUDEFLAGS += $(addprefix -C , $(AVRDUDECONF)) -DV
367
323
size: $(TARGET).elf
368
324
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
326
# building the target
392
328
$(TARGET).hex: $(TARGET).elf