/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-01-14 00:21:26 UTC
  • Revision ID: edam@waxworlds.org-20120114002126-0m1ktlytlif4dyt6
added "monitor" goal; documented boards and monitor goals

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