/make/arduino-mk

To get this branch, use:
bzr branch http://bzr.ed.am/make/arduino-mk

« back to all changes in this revision

Viewing changes to arduino.mk

  • Committer: edam
  • Date: 2012-02-21 15:27:09 UTC
  • Revision ID: tim@ed.am-20120221152709-zo3surexmx2789wn
added THANKS, fixed ARDUINODIR default to look in /usr/share/arduino and capitalised the use of "Arduino" where appropriate.

Show diffs side-by-side

added added

removed removed

Lines of Context:
arduino.mk
2
2
#
3
3
#                         edam's arduino makefile
4
4
#_______________________________________________________________________________
5
 
#                                                                    version 0.1
 
5
#                                                                    version 0.3
6
6
#
7
 
# Copyright (c) 2011 Tim Marston <tim@ed.am>.
 
7
# Copyright (C) 2011, 1012 Tim Marston <tim@ed.am>.
8
8
#
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
21
21
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22
22
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23
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
25
 
# THE SOFTWARE.
 
24
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 
25
# SOFTWARE.
26
26
#
27
27
#_______________________________________________________________________________
28
28
#
29
29
#
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
32
 
# software to be downloaded separately (see http://arduino.cc/).  To
33
 
# download the latest version of this makefile, visit the following
34
 
# website, where you can also find more information and documentation
35
 
# on it's use.  The following text can only really be considered a
36
 
# reference to it's use.
37
 
#
38
 
#   http://ed.am/dev/make/arduino-makefile
39
 
#
40
 
# To install, it is suggested that you keep arduino.mk somewhere and
41
 
# either symlink to it or include it in your make files.  I keep mine
42
 
# at ~/src/arduino.mk.  You will need to alter the value of the
43
 
# ARDUINODIR variable (below) to be the path where you have unpacked
44
 
# the arduino software from arduino.cc.
45
 
#
46
 
# This makefile can be used as a drop-in replacement for the Arduino
47
 
# IDE's build system.  Simply create a symlink to it under the name
48
 
# "Makefile" and run make as described below (remembering to specify a
49
 
# BOARD).  You would create the symlink like like so:
 
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.
 
35
#
 
36
#   http://ed.am/dev/make/arduino-mk
 
37
#
 
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:
50
42
#
51
43
#   $ ln -s ~/src/arduino.mk Makefile
52
44
#
53
 
# The presence of a .ino or .pde file causes the arduino.mk to
54
 
# atuomatically determine va;ues for SOURCES, TARGET and LIBRARIES.
55
 
# Any .c, .cc and .cpp files in the project directory (or a "util" or
56
 
# "utility" subdirectory) are automatically included in the build and
57
 
# are scanned for libraries that have been #included.
58
 
#
59
 
# Alternatively, if you want to manually specify build variables,
60
 
# create a Makefile that defines SOURCES and LIBRARARIES and then
61
 
# includes arduino.mk.  (There is no need to define TARGET).  You will
62
 
# also be expected to provide a main() function, for example in
63
 
# main.cc, which may or may not duplicate the functionality of the
64
 
# default main() that calls init() and loop().  Here is an example
65
 
# Makefile:
66
 
#
67
 
#   SOURCES := main.cc foo.cc
 
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.
 
49
#
 
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:
 
55
#
 
56
#   export ARDUINODIR=~/somewhere/arduino-1.0
 
57
#
 
58
# You will also need to set BOARD to the type of Arduino you're building for.
 
59
# You could set a default in your ~/.profile if you want, but it is suggested
 
60
# that you specify this at build time, especially if you work with different
 
61
# types of Arduino.  For example:
 
62
#
 
63
#   $ export BOARD=uno
 
64
#   $ make
 
65
#
 
66
# You may also need to set SERIALDEV if it is not detected correctly.
 
67
#
 
68
# The presence of a .ino (or .pde) file causes the arduino.mk to automatically
 
69
# determine values for SOURCES, TARGET and LIBRARIES.  Any .c, .cc and .cpp
 
70
# files in the project directory (or any "util" or "utility" subdirectories)
 
71
# are automatically included in the build and are scanned for Arduino libraries
 
72
# that have been #included. Note, there can only be one .ino (or .pde) file.
 
73
#
 
74
# Alternatively, if you want to manually specify build variables, create a
 
75
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
 
76
# (There is no need to define TARGET).  Here is an example Makefile:
 
77
#
 
78
#   SOURCES := main.cc other.cc
68
79
#   LIBRARIES := EEPROM
69
80
#   include ~/src/arduino.mk
70
81
#
71
 
# A complete list of all the settings you can use in your Makefile
72
 
# follows shortly.  It should be noted, however, that some variables
73
 
# are better specified in the environment or on the command line than
74
 
# in a Makefile.  Specifically, the BOARD and SERIALDEV (if it is not
75
 
# automatically detected).
76
 
#
77
 
# When running make, you might want to specify the board type:
78
 
#
79
 
#   $ BOARD=pro5v make
80
 
#
81
 
# Or in the environment:
82
 
#
83
 
#   $ export BOARD=pro5v
84
 
#   $ make
85
 
#
86
 
# For a list of available board types, run `make boards`.
87
 
# 
88
 
# Here is a list of all configuration parameters:
89
 
#
90
 
# BOARD        Specify a target board type.
91
 
#
92
 
# SERIALDEV    The unix device of the device where the arduino can be
93
 
#              found.  If unspecified, an attempt is made to determine
94
 
#              the name of a connected arduino's serial device.
95
 
#
96
 
# The following configuration parameters can be determined automatically:
97
 
#
98
 
# TARGET       The name of the target file.  This need not be set if it
99
 
#              is not determined automatically.
100
 
#
101
 
# SOURCES      A list of all source files of whatever language.  The
102
 
#              language type is determined by the file extension.
103
 
#
104
 
# LIBRARIES    A list of arduino libraries to build and include.
105
 
#
106
 
# This general-purpose makefile also defines the following goals for
107
 
# use on the command line when you run make:
108
 
#
109
 
# all          This is the default if no goal is specified. It builds
110
 
#              the target and uploads it.
111
 
#
112
 
# target       Builds the target of your Makefile.
113
 
#
114
 
# upload       Uploads the target to an attached arduino.
115
 
#
116
 
# clean        Deletes temporary files.
117
 
#
118
 
# <file>       Builds the specified file, either an object file or the
119
 
#              target, from those that that would be built for the
120
 
#              project.
121
 
#
 
82
# Here is a complete list of configuration parameters:
 
83
#
 
84
# ARDUINODIR   The path where the Arduino software is installed on your system.
 
85
#
 
86
# ARDUINOCONST The Arduino software version, as an integer, used to define the
 
87
#              ARDUINO version constant. This defaults to 100 if undefined.
 
88
#
 
89
# AVRDUDECONF  The avrdude.conf to use. If undefined, this defaults to a guess
 
90
#              based on where the avrdude in use is. If empty, no avrdude.conf
 
91
#              is passed to avrdude (to the system default is used).
 
92
#
 
93
# AVRTOOLSPATH A space-separated list of directories to search in order when
 
94
#              lookin for the avr build tools. This defaults to the system PATH
 
95
#              followed by subdirectories in ARDUINODIR if undefined.
 
96
#
 
97
# BOARD        Specify a target board type.  Run `make boards` to see available
 
98
#              board types.
 
99
#
 
100
# LIBRARIES    A list of Arduino libraries to build and include.  This is set
 
101
#              automatically if a .ino (or .pde) is found.
 
102
#
 
103
# SERIALDEV    The unix device name of the serial device that is the Arduino.
 
104
#              If unspecified, an attempt is made to determine the name of a
 
105
#              connected Arduino's serial device.
 
106
#
 
107
# SOURCES      A list of all source files of whatever language.  The language
 
108
#              type is determined by the file extension.  This is set
 
109
#              automatically if a .ino (or .pde) is found.
 
110
#
 
111
# TARGET       The name of the target file.  This is set automatically if a
 
112
#              .ino (or .pde) is found, but it is not necessary to set it
 
113
#              otherwise.
 
114
#
 
115
# This makefile also defines the following goals for use on the command line
 
116
# when you run make:
 
117
#
 
118
# all          This is the default if no goal is specified.  It builds the
 
119
#              target and uploads it.
 
120
#
 
121
# target       Builds the target.
 
122
#
 
123
# upload       Uploads the last built target to an attached Arduino.
 
124
#
 
125
# clean        Deletes files created during the build.
 
126
#
 
127
# boards       Display a list of available board names, so that you can set the
 
128
#              BOARD environment variable appropriately.
 
129
#
 
130
# monitor      Start `screen` on the serial device.  This is meant to be an
 
131
#              equivalent to the Arduino serial monitor.
 
132
#
 
133
# <file>       Builds the specified file, either an object file or the target,
 
134
#              from those that that would be built for the project.
122
135
#_______________________________________________________________________________
123
136
#
124
137
 
125
 
# The full path to the arduino software, from arduino.cc
126
 
ARDUINODIR := $(wildcard ~/opt/arduino-1.0)
127
 
 
128
 
# check arduino software
129
 
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
130
 
$(error ARDUINODIR is not set correctly at the top of arduino.mk)
 
138
# default arduino software directory, check software exists
 
139
ifndef ARDUINODIR
 
140
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))
 
141
endif
 
142
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
 
143
$(error ARDUINODIR is not set correctly; arduino software not found)
 
144
endif
 
145
 
 
146
# default arduino version
 
147
ARDUINOCONST ?= 100
 
148
 
 
149
# default path for avr tools
 
150
ifndef AVRTOOLSPATH
 
151
AVRTOOLSPATH := $(subst :, , $(PATH))
 
152
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools
 
153
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
131
154
endif
132
155
 
133
156
# auto mode?
134
157
INOFILE := $(wildcard *.ino *.pde)
135
158
ifdef INOFILE
136
 
ifneq ($(words $(INOFILE)), 1)
 
159
ifneq "$(words $(INOFILE))" "1"
137
160
$(error There is more than one .pde or .ino file in this directory!)
138
161
endif
 
162
 
 
163
# automatically determine sources and targeet
139
164
TARGET := $(basename $(INOFILE))
140
165
SOURCES := $(INOFILE) \
141
166
        $(wildcard *.c *.cc *.cpp) \
142
167
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
143
168
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
 
169
 
144
170
# automatically determine included libraries
145
171
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
146
172
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
147
173
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
148
 
endif
149
 
 
150
 
# no target? use default
151
 
ifndef TARGET
152
 
TARGET := a.out
153
 
endif
154
 
 
155
 
# no serial device? attempt to detect an arduino
156
 
ifndef SERIALDEV
157
 
SERIALDEV := $(firstword $(wildcard /dev/ttyACM? /dev/ttyUSB?))
158
 
endif
159
 
 
160
 
# no board? oh dear...
161
 
ifndef BOARD
162
 
ifneq "$(MAKECMDGOALS)" "boards"
163
 
ifneq "$(MAKECMDGOALS)" "clean"
164
 
$(error BOARD is unset.  Type 'make boards' to see possible values)
165
 
endif
166
 
endif
167
 
endif
 
174
 
 
175
endif
 
176
 
 
177
# no serial device? make a poor attempt to detect an arduino
 
178
SERIALDEVGUESS := 0
 
179
ifeq "$(SERIALDEV)" ""
 
180
SERIALDEV := $(firstword $(wildcard \
 
181
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbmodem*))
 
182
SERIALDEVGUESS := 1
 
183
endif
 
184
 
 
185
# software
 
186
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
 
187
CC := $(call findsoftware,avr-gcc)
 
188
CXX := $(call findsoftware,avr-g++)
 
189
LD := $(call findsoftware,avr-ld)
 
190
AR := $(call findsoftware,avr-ar)
 
191
OBJCOPY := $(call findsoftware,avr-objcopy)
 
192
AVRDUDE := $(call findsoftware,avrdude)
168
193
 
169
194
# files
 
195
TARGET := $(if $(TARGET),$(TARGET),a.out)
170
196
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
171
197
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
 
198
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
172
199
ARDUINOLIB := _arduino.a
173
 
ARDUINOLIBTMP := _arduino.a.tmp
 
200
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
174
201
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
175
202
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
176
203
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
177
204
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
178
 
        $(wildcard $(addprefix $(ARDUINODIR)/libraries/$(lib)/, *.c *.cpp))))))
 
205
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
 
206
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
 
207
ifeq "$(AVRDUDECONF)" ""
 
208
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
 
209
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
 
210
else
 
211
AVRDUDECONF := $(wildcard $(AVRDUDE).conf)
 
212
endif
 
213
endif
 
214
 
 
215
# no board?
 
216
ifndef BOARD
 
217
ifneq "$(MAKECMDGOALS)" "boards"
 
218
ifneq "$(MAKECMDGOALS)" "clean"
 
219
$(error BOARD is unset.  Type 'make boards' to see possible values)
 
220
endif
 
221
endif
 
222
endif
179
223
 
180
224
# obtain board parameters from the arduino boards.txt file
181
225
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
190
234
BOARD_UPLOAD_PROTOCOL := \
191
235
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
192
236
 
193
 
# software
194
 
CC := avr-gcc
195
 
CXX := avr-g++
196
 
LD := avr-ld
197
 
AR := avr-ar
198
 
OBJCOPY := avr-objcopy
199
 
AVRDUDE := avrdude
 
237
# invalid board?
 
238
ifeq "$(BOARD_BUILD_MCU)" ""
 
239
ifneq "$(MAKECMDGOALS)" "boards"
 
240
ifneq "$(MAKECMDGOALS)" "clean"
 
241
$(error BOARD is invalid.  Type 'make boards' to see possible values)
 
242
endif
 
243
endif
 
244
endif
200
245
 
201
246
# flags
202
 
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
203
 
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
 
247
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
 
248
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
 
249
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
 
250
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
204
251
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
205
252
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
206
 
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/,$(LIBRARIES))
207
 
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
 
253
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
 
254
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
 
255
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
208
256
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
209
257
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
210
 
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
 
258
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
 
259
 
 
260
# figure out which arg to use with stty
 
261
STTYFARG := $(shell stty --help > /dev/null 2>&1 && echo -F || echo -f)
211
262
 
212
263
# default rule
213
264
.DEFAULT_GOAL := all
215
266
#_______________________________________________________________________________
216
267
#                                                                          RULES
217
268
 
218
 
.PHONY: all target upload clean boards
 
269
.PHONY: all target upload clean boards monitor
219
270
 
220
271
all: target upload
221
272
 
222
273
target: $(TARGET).hex
223
274
 
224
275
upload:
225
 
        stty -F $(SERIALDEV) hupcl
 
276
        @echo "\nUploading to board..."
 
277
        @test -n "$(SERIALDEV)" || { \
 
278
                echo "error: SERIALDEV could not be determined automatically." >&2; \
 
279
                exit 1; }
 
280
        @test 0 -eq $(SERIALDEVGUESS) || { \
 
281
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
 
282
                echo; }
 
283
        stty $(STTYFARG) $(SERIALDEV) hupcl
226
284
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
227
285
 
228
286
clean:
235
293
        @sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
236
294
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
237
295
 
 
296
monitor:
 
297
        @test -n "$(SERIALDEV)" || { \
 
298
                echo "error: SERIALDEV could not be determined automatically." >&2; \
 
299
                exit 1; }
 
300
        @test -n `which screen` || { \
 
301
                echo "error: can't find GNU screen, you might need to install it." >&2 \
 
302
                ecit 1; }
 
303
        @test 0 -eq $(SERIALDEVGUESS) || { \
 
304
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
 
305
                echo; }
 
306
        screen $(SERIALDEV)
 
307
 
238
308
# building the target
239
309
 
240
310
$(TARGET).hex: $(TARGET).elf
274
344
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
275
345
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
276
346
        $(COMPILE.cpp) -o $@ $<
 
347
 
 
348
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c
 
349
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
350
        $(COMPILE.c) -o $@ $<
 
351
 
 
352
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp
 
353
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
354
        $(COMPILE.cpp) -o $@ $<