/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: 2011-12-31 22:12:25 UTC
  • Revision ID: edam@waxworlds.org-20111231221225-52dt61v5b2r3cmam
updated comments; added checks for missing or misconfigured variables; use a default TARGET; attempt to autodetect SERIALDEV; added 'boards' goal; fixed use of 'util' project subdirectory.

Show diffs side-by-side

added added

removed removed

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