/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
1
1
#_______________________________________________________________________________
2
2
#
3
 
#                         edam's Arduino makefile
 
3
#                         edam's arduino makefile
4
4
#_______________________________________________________________________________
5
 
#                                                                 version 0.3dev
 
5
#                                                                    version 0.1
6
6
#
7
 
# Copyright (C) 2011, 1012 Tim Marston <tim@ed.am>.
 
7
# Copyright (c) 2011 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 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 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:
 
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:
42
51
#
43
52
#   $ ln -s ~/src/arduino.mk Makefile
44
53
#
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
 
# 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
62
 
# example:
63
 
#
64
 
#   $ export BOARD=uno
65
 
#   $ make
66
 
#
67
 
# You may also need to set SERIALDEV if it is not detected correctly.
68
 
#
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.
74
 
#
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:
78
 
#
79
 
#   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
80
69
#   LIBRARIES := EEPROM
81
70
#   include ~/src/arduino.mk
82
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
# 
83
87
# Here is a complete list of configuration parameters:
84
88
#
85
 
# ARDUINODIR   The path where the Arduino software is installed on your system.
86
 
#
87
 
# ARDUINOCONST The Arduino software version, as an integer, used to define the
88
 
#              ARDUINO version constant. This defaults to 100 if undefined.
89
 
#
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).
93
 
#
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.
97
 
#
98
 
# BOARD        Specify a target board type.  Run `make boards` to see available
99
 
#              board types.
100
 
#
101
 
# LIBRARIES    A list of Arduino libraries to build and include.  This is set
102
 
#              automatically if a .ino (or .pde) is found.
103
 
#
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.
107
 
#
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.
111
 
#
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
114
 
#              otherwise.
115
 
#
116
 
# This makefile also defines the following goals for use on the command line
117
 
# when you run make:
118
 
#
119
 
# all          This is the default if no goal is specified.  It builds the
120
 
#              target and uploads it.
121
 
#
122
 
# target       Builds the target.
123
 
#
124
 
# upload       Uploads the last built target to an attached Arduino.
125
 
#
126
 
# clean        Deletes files created during the build.
127
 
#
128
 
# boards       Display a list of available board names, so that you can set the
129
 
#              BOARD environment variable appropriately.
130
 
#
131
 
# monitor      Start `screen` on the serial device.  This is meant to be an
132
 
#              equivalent to the Arduino serial monitor.
133
 
#
134
 
# <file>       Builds the specified file, either an object file or the target,
135
 
#              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.
136
132
#_______________________________________________________________________________
137
133
#
138
134
 
139
 
# default arduino software directory, check software exists
 
135
# The full path to the arduino software, from arduino.cc
140
136
ifndef ARDUINODIR
141
 
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))
 
137
ARDUINODIR := $(wildcard ~/opt/arduino-1.0)
142
138
endif
143
 
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
 
139
 
 
140
# check arduino software
 
141
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
144
142
$(error ARDUINODIR is not set correctly; arduino software not found)
145
143
endif
146
144
 
147
 
# default arduino version
148
 
ARDUINOCONST ?= 100
149
 
 
150
 
# default path for avr tools
151
 
ifndef AVRTOOLSPATH
152
 
AVRTOOLSPATH := $(subst :, , $(PATH))
153
 
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools
154
 
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
155
 
endif
156
 
 
157
145
# auto mode?
158
146
INOFILE := $(wildcard *.ino *.pde)
159
147
ifdef INOFILE
160
 
ifneq "$(words $(INOFILE))" "1"
 
148
ifneq ($(words $(INOFILE)), 1)
161
149
$(error There is more than one .pde or .ino file in this directory!)
162
150
endif
163
 
 
164
 
# automatically determine sources and targeet
165
151
TARGET := $(basename $(INOFILE))
166
152
SOURCES := $(INOFILE) \
167
153
        $(wildcard *.c *.cc *.cpp) \
168
154
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
169
155
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
170
 
 
171
156
# automatically determine included libraries
172
157
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
173
158
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
174
159
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
175
 
 
176
 
endif
177
 
 
178
 
# no serial device? make a poor attempt to detect an arduino
179
 
SERIALDEVGUESS := 0
180
 
ifeq "$(SERIALDEV)" ""
181
 
SERIALDEV := $(firstword $(wildcard \
182
 
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbmodem*))
183
 
SERIALDEVGUESS := 1
184
 
endif
185
 
 
186
 
# software
187
 
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
188
 
CC := $(call findsoftware,avr-gcc)
189
 
CXX := $(call findsoftware,avr-g++)
190
 
LD := $(call findsoftware,avr-ld)
191
 
AR := $(call findsoftware,avr-ar)
192
 
OBJCOPY := $(call findsoftware,avr-objcopy)
193
 
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
194
180
 
195
181
# files
196
 
TARGET := $(if $(TARGET),$(TARGET),a.out)
197
182
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
198
183
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
199
 
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
200
184
ARDUINOLIB := _arduino.a
201
 
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
 
185
ARDUINOLIBTMP := _arduino.a.tmp
202
186
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
203
187
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
204
188
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
205
189
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
206
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
207
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
208
 
ifeq "$(AVRDUDECONF)" ""
209
 
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
210
 
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
211
 
else
212
 
AVRDUDECONF := $(wildcard $(AVRDUDE).conf)
213
 
endif
214
 
endif
215
 
 
216
 
# no board?
217
 
ifndef BOARD
218
 
ifneq "$(MAKECMDGOALS)" "boards"
219
 
ifneq "$(MAKECMDGOALS)" "clean"
220
 
$(error BOARD is unset.  Type 'make boards' to see possible values)
221
 
endif
222
 
endif
223
 
endif
 
190
        $(wildcard $(addprefix $(ARDUINODIR)/libraries/$(lib)/, *.c *.cpp))))))
224
191
 
225
192
# obtain board parameters from the arduino boards.txt file
226
193
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
235
202
BOARD_UPLOAD_PROTOCOL := \
236
203
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
237
204
 
238
 
# invalid board?
239
 
ifeq "$(BOARD_BUILD_MCU)" ""
240
 
ifneq "$(MAKECMDGOALS)" "boards"
241
 
ifneq "$(MAKECMDGOALS)" "clean"
242
 
$(error BOARD is invalid.  Type 'make boards' to see possible values)
243
 
endif
244
 
endif
245
 
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
246
212
 
247
213
# flags
248
 
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
249
 
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
250
 
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
251
 
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)
252
216
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
253
217
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
254
218
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
255
219
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
256
 
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
 
220
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
257
221
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
258
222
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
259
 
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
260
 
 
261
 
# figure out which arg to use with stty
262
 
STTYFARG := $(shell stty --help > /dev/null 2>&1 && echo -F || echo -f)
 
223
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
263
224
 
264
225
# default rule
265
226
.DEFAULT_GOAL := all
274
235
target: $(TARGET).hex
275
236
 
276
237
upload:
277
 
        @echo "\nUploading to board..."
278
 
        @test -n "$(SERIALDEV)" || { \
279
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
280
 
                exit 1; }
281
 
        @test 0 -eq $(SERIALDEVGUESS) || { \
282
 
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
283
 
                echo; }
284
 
        stty $(STTYFARG) $(SERIALDEV) hupcl
 
238
        stty -F $(SERIALDEV) hupcl
285
239
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
286
240
 
287
241
clean:
295
249
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
296
250
 
297
251
monitor:
298
 
        @test -n "$(SERIALDEV)" || { \
299
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
300
 
                exit 1; }
301
 
        @test -n `which screen` || { \
302
 
                echo "error: can't find GNU screen, you might need to install it." >&2 \
303
 
                ecit 1; }
304
 
        @test 0 -eq $(SERIALDEVGUESS) || { \
305
 
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
306
 
                echo; }
307
252
        screen $(SERIALDEV)
308
253
 
309
254
# building the target
345
290
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
346
291
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
347
292
        $(COMPILE.cpp) -o $@ $<
348
 
 
349
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c
350
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
351
 
        $(COMPILE.c) -o $@ $<
352
 
 
353
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp
354
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
355
 
        $(COMPILE.cpp) -o $@ $<