/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-15 17:10:04 UTC
  • Revision ID: edam@waxworlds.org-20120215171004-43rba3x55m7e8aoe
updated NEWS

Show diffs side-by-side

added added

removed removed

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
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 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:
50
43
#
51
44
#   $ ln -s ~/src/arduino.mk Makefile
52
45
#
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
 
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
68
73
#   LIBRARIES := EEPROM
69
74
#   include ~/src/arduino.mk
70
75
#
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
 
#
 
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.
122
126
#_______________________________________________________________________________
123
127
#
124
128
 
125
 
# The full path to the arduino software, from arduino.cc
126
 
ARDUINODIR := $(wildcard ~/opt/arduino-1.0)
127
 
 
128
 
# check arduino software
 
129
# default arduino software directory, check software exists
 
130
ifndef ARDUINODIR
 
131
ARDUINODIR := $(wildcard ~/opt/arduino)
 
132
endif
129
133
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
130
 
$(error ARDUINODIR is not set correctly at the top of arduino.mk)
 
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
131
145
endif
132
146
 
133
147
# auto mode?
136
150
ifneq ($(words $(INOFILE)), 1)
137
151
$(error There is more than one .pde or .ino file in this directory!)
138
152
endif
 
153
 
 
154
# automatically determine sources and targeet
139
155
TARGET := $(basename $(INOFILE))
140
156
SOURCES := $(INOFILE) \
141
157
        $(wildcard *.c *.cc *.cpp) \
142
158
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
143
159
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
 
160
 
144
161
# automatically determine included libraries
145
162
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
146
163
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
147
164
        $(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?))
 
165
 
158
166
endif
159
167
 
160
168
# no board? oh dear...
166
174
endif
167
175
endif
168
176
 
 
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
 
169
191
# files
 
192
TARGET := $(if $(TARGET), $(TARGET), a.out)
170
193
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
171
194
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
 
195
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
172
196
ARDUINOLIB := _arduino.a
173
 
ARDUINOLIBTMP := _arduino.a.tmp
 
197
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
174
198
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
175
199
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
176
200
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
177
201
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
178
 
        $(wildcard $(addprefix $(ARDUINODIR)/libraries/$(lib)/, *.c *.cpp))))))
 
202
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
 
203
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
 
204
AVRDUDECONF := $(wildcard $(AVRDUDE).conf)
179
205
 
180
206
# obtain board parameters from the arduino boards.txt file
181
207
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
190
216
BOARD_UPLOAD_PROTOCOL := \
191
217
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
192
218
 
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
200
 
 
201
219
# flags
202
 
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
203
 
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
 
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)
204
224
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
205
225
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
 
226
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
 
227
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
 
228
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
208
229
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
209
230
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
210
 
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
 
231
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
211
232
 
212
233
# default rule
213
234
.DEFAULT_GOAL := all
215
236
#_______________________________________________________________________________
216
237
#                                                                          RULES
217
238
 
218
 
.PHONY: all target upload clean boards
 
239
.PHONY: all target upload clean boards monitor
219
240
 
220
241
all: target upload
221
242
 
222
243
target: $(TARGET).hex
223
244
 
224
245
upload:
 
246
        @echo "\nUploading to board..."
 
247
        @test -n "$(SERIALDEV)" || { \
 
248
                echo "error: SERIALDEV could not be determined automatically." >&2; \
 
249
                exit 1; }
225
250
        stty -F $(SERIALDEV) hupcl
226
251
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
227
252
 
235
260
        @sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
236
261
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
237
262
 
 
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
 
238
272
# building the target
239
273
 
240
274
$(TARGET).hex: $(TARGET).elf
274
308
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
275
309
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
276
310
        $(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 $@ $<