1
 
#_______________________________________________________________________________
 
3
 
#                         edam's Arduino makefile
 
4
 
#_______________________________________________________________________________
 
7
 
# Copyright (C) 2011, 1012 Tim Marston <tim@ed.am>.
 
9
 
# Permission is hereby granted, free of charge, to any person obtaining a copy
 
10
 
# of this software and associated documentation files (the "Software"), to deal
 
11
 
# in the Software without restriction, including without limitation the rights
 
12
 
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 
13
 
# copies of the Software, and to permit persons to whom the Software is
 
14
 
# furnished to do so, subject to the following conditions:
 
16
 
# The above copyright notice and this permission notice shall be included in
 
17
 
# all copies or substantial portions of the Software.
 
19
 
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 
20
 
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 
21
 
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 
22
 
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 
23
 
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 
24
 
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 
27
 
#_______________________________________________________________________________
 
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.
 
36
 
#   http://ed.am/dev/make/arduino-mk
 
38
 
# This makefile can be used as a drop-in replacement for the Arduino IDE's
 
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
 
#   $ 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
 
54
 
# your ~/.profile by adding something like this:
 
56
 
#   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
 
67
 
# You may also need to set SERIALDEV if it is not detected correctly.
 
69
 
# The presence of a .ino (or .pde) file causes the arduino.mk to automatically
 
70
 
# determine values for SOURCES, TARGET and LIBRARIES.  Any .c, .cc and .cpp
 
71
 
# files in the project directory (or any "util" or "utility" subdirectories)
 
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.
 
75
 
# Alternatively, if you want to manually specify build variables, create a
 
76
 
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
 
77
 
# (There is no need to define TARGET).  Here is an example Makefile:
 
79
 
#   SOURCES := main.cc other.cc
 
81
 
#   include ~/src/arduino.mk
 
83
 
# 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
 
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.
 
98
 
# BOARD        Specify a target board type.  Run `make boards` to see available
 
101
 
# LIBRARIES    A list of Arduino libraries to build and include.  This is set
 
102
 
#              automatically if a .ino (or .pde) is found.
 
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.
 
108
 
# SOURCES      A list of all source files of whatever language.  The language
 
109
 
#              type is determined by the file extension.  This is set
 
110
 
#              automatically if a .ino (or .pde) is found.
 
112
 
# TARGET       The name of the target file.  This is set automatically if a
 
113
 
#              .ino (or .pde) is found, but it is not necessary to set it
 
116
 
# This makefile also defines the following goals for use on the command line
 
119
 
# all          This is the default if no goal is specified.  It builds the
 
120
 
#              target and uploads it.
 
122
 
# target       Builds the target.
 
124
 
# upload       Uploads the last built target to an attached Arduino.
 
126
 
# clean        Deletes files created during the build.
 
128
 
# boards       Display a list of available board names, so that you can set the
 
129
 
#              BOARD environment variable appropriately.
 
131
 
# monitor      Start `screen` on the serial device.  This is meant to be an
 
132
 
#              equivalent to the Arduino serial monitor.
 
134
 
# size         Displays size information about the bulit target.
 
136
 
# <file>       Builds the specified file, either an object file or the target,
 
137
 
#              from those that that would be built for the project.
 
138
 
#_______________________________________________________________________________
 
141
 
# default arduino software directory, check software exists
 
143
 
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))
 
145
 
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
 
146
 
$(error ARDUINODIR is not set correctly; arduino software not found)
 
149
 
# default arduino version
 
152
 
# default path for avr tools
 
154
 
AVRTOOLSPATH := $(subst :, , $(PATH))
 
155
 
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools
 
156
 
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
 
160
 
INOFILE := $(wildcard *.ino *.pde)
 
162
 
ifneq "$(words $(INOFILE))" "1"
 
163
 
$(error There is more than one .pde or .ino file in this directory!)
 
166
 
# automatically determine sources and targeet
 
167
 
TARGET := $(basename $(INOFILE))
 
168
 
SOURCES := $(INOFILE) \
 
169
 
        $(wildcard *.c *.cc *.cpp) \
 
170
 
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
 
171
 
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
 
173
 
# automatically determine included libraries
 
174
 
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
 
175
 
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
 
176
 
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
 
180
 
# no serial device? make a poor attempt to detect an arduino
 
182
 
ifeq "$(SERIALDEV)" ""
 
183
 
SERIALDEV := $(firstword $(wildcard \
 
184
 
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbmodem*))
 
189
 
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
 
190
 
CC := $(call findsoftware,avr-gcc)
 
191
 
CXX := $(call findsoftware,avr-g++)
 
192
 
LD := $(call findsoftware,avr-ld)
 
193
 
AR := $(call findsoftware,avr-ar)
 
194
 
OBJCOPY := $(call findsoftware,avr-objcopy)
 
195
 
AVRDUDE := $(call findsoftware,avrdude)
 
196
 
AVRSIZE := $(call findsoftware,avr-size)
 
199
 
TARGET := $(if $(TARGET),$(TARGET),a.out)
 
200
 
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
 
201
 
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
 
202
 
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
 
203
 
ARDUINOLIB := _arduino.a
 
204
 
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
 
205
 
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
 
206
 
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
 
207
 
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
 
208
 
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
 
209
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
 
210
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
 
211
 
ifeq "$(AVRDUDECONF)" ""
 
212
 
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
 
213
 
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
 
215
 
AVRDUDECONF := $(wildcard $(AVRDUDE).conf)
 
221
 
ifneq "$(MAKECMDGOALS)" "boards"
 
222
 
ifneq "$(MAKECMDGOALS)" "clean"
 
223
 
$(error BOARD is unset.  Type 'make boards' to see possible values)
 
228
 
# obtain board parameters from the arduino boards.txt file
 
229
 
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
 
231
 
        $(shell sed -ne "s/$(BOARD).build.mcu=\(.*\)/\1/p" $(BOARDS_FILE))
 
232
 
BOARD_BUILD_FCPU := \
 
233
 
        $(shell sed -ne "s/$(BOARD).build.f_cpu=\(.*\)/\1/p" $(BOARDS_FILE))
 
234
 
BOARD_BUILD_VARIANT := \
 
235
 
        $(shell sed -ne "s/$(BOARD).build.variant=\(.*\)/\1/p" $(BOARDS_FILE))
 
236
 
BOARD_UPLOAD_SPEED := \
 
237
 
        $(shell sed -ne "s/$(BOARD).upload.speed=\(.*\)/\1/p" $(BOARDS_FILE))
 
238
 
BOARD_UPLOAD_PROTOCOL := \
 
239
 
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
 
242
 
ifeq "$(BOARD_BUILD_MCU)" ""
 
243
 
ifneq "$(MAKECMDGOALS)" "boards"
 
244
 
ifneq "$(MAKECMDGOALS)" "clean"
 
245
 
$(error BOARD is invalid.  Type 'make boards' to see possible values)
 
251
 
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
 
252
 
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
 
253
 
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
 
254
 
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
 
255
 
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
 
256
 
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
 
257
 
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
 
258
 
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
 
259
 
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
 
260
 
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
 
261
 
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
 
262
 
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
 
264
 
# figure out which arg to use with stty
 
265
 
STTYFARG := $(shell stty --help > /dev/null 2>&1 && echo -F || echo -f)
 
270
 
#_______________________________________________________________________________
 
273
 
.PHONY: all target upload clean boards monitor size
 
277
 
target: $(TARGET).hex
 
280
 
        @echo "\nUploading to board..."
 
281
 
        @test -n "$(SERIALDEV)" || { \
 
282
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
 
284
 
        @test 0 -eq $(SERIALDEVGUESS) || { \
 
285
 
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
 
287
 
        stty $(STTYFARG) $(SERIALDEV) hupcl
 
288
 
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
 
292
 
        rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
 
293
 
        rm -rf $(ARDUINOLIBTMP)
 
296
 
        @echo Available values for BOARD:
 
297
 
        @sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
 
298
 
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
 
301
 
        @test -n "$(SERIALDEV)" || { \
 
302
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
 
304
 
        @test -n `which screen` || { \
 
305
 
                echo "error: can't find GNU screen, you might need to install it." >&2 \
 
307
 
        @test 0 -eq $(SERIALDEVGUESS) || { \
 
308
 
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
 
313
 
        echo && $(AVRSIZE) --format=avr --mcu=$(BOARD_BUILD_MCU) $(TARGET).elf
 
315
 
# building the target
 
317
 
$(TARGET).hex: $(TARGET).elf
 
318
 
        $(OBJCOPY) -O ihex -R .eeprom $< $@
 
320
 
.INTERMEDIATE: $(TARGET).elf
 
322
 
$(TARGET).elf: $(ARDUINOLIB) $(OBJECTS)
 
323
 
        $(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -o $@
 
326
 
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
 
329
 
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
 
331
 
# building the arduino library
 
333
 
$(ARDUINOLIB): $(ARDUINOLIBOBJS)
 
335
 
        rm -rf $(ARDUINOLIBTMP)
 
337
 
.INTERMEDIATE: $(ARDUINOLIBOBJS)
 
339
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.c
 
340
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
341
 
        $(COMPILE.c) -o $@ $<
 
343
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.cpp
 
344
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
345
 
        $(COMPILE.cpp) -o $@ $<
 
347
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.c
 
348
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
349
 
        $(COMPILE.c) -o $@ $<
 
351
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
 
352
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
353
 
        $(COMPILE.cpp) -o $@ $<
 
355
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c
 
356
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
357
 
        $(COMPILE.c) -o $@ $<
 
359
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp
 
360
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
361
 
        $(COMPILE.cpp) -o $@ $<