/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-13 15:44:24 UTC
  • Revision ID: edam@waxworlds.org-20120213154424-2wsncooiohmcn7oz
clarify number of permitted .ino files

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
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
 
# 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
 
#
 
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
# BOARD        Specify a target board type.  Run `make boards` to see available
 
82
#              board types.
 
83
#
 
84
# SERIALDEV    The unix device name of the serial device that is the arduino.
 
85
#              If unspecified, an attempt is made to determine the name of a
 
86
#              connected arduino's serial device.
 
87
#
 
88
# TARGET       The name of the target file.  This is set automatically if a
 
89
#              .ino or .pde is found, but it is not necessary to set it
 
90
#              otherwise.
 
91
#
 
92
# SOURCES      A list of all source files of whatever language.  The language
 
93
#              type is determined by the file extension.  This is set
 
94
#              automatically if a .ino or .pde is found.
 
95
#
 
96
# LIBRARIES    A list of arduino libraries to build and include.  This is set
 
97
#              automatically if a .ino or .pde is found.
 
98
#
 
99
# This makefile also defines the following goals for use on the command line
 
100
# when you run make:
 
101
#
 
102
# all          This is the default if no goal is specified.  It builds the
 
103
#              target and uploads it.
 
104
#
 
105
# target       Builds the target.
 
106
#
 
107
# upload       Uploads the last built target to an attached arduino.
 
108
#
 
109
# clean        Deletes files created during the build.
 
110
#
 
111
# boards       Display a list of available board names, so that you can set the
 
112
#              BOARD environment variable appropriately.
 
113
#
 
114
# monitor      Start `screen` on the serial device.  This is meant to be an
 
115
#              equivalent to the arduino serial monitor.
 
116
#
 
117
# <file>       Builds the specified file, either an object file or the target,
 
118
#              from those that that would be built for the project.
120
119
#_______________________________________________________________________________
121
120
#
122
121
 
123
122
# The full path to the arduino software, from arduino.cc
124
 
ARDUINODIR := $(wildcard ~/opt/arduino-1.0)
 
123
ifndef ARDUINODIR
 
124
ARDUINODIR := $(wildcard ~/opt/arduino)
 
125
endif
125
126
 
126
127
# check arduino software
127
128
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
128
 
$(error ARDUINODIR is not set correctly at the top of arduino.mk)
 
129
$(error ARDUINODIR is not set correctly; arduino software not found)
129
130
endif
130
131
 
131
132
# auto mode?
146
147
endif
147
148
 
148
149
# no target? use default
149
 
ifndef TARGET
 
150
ifeq ($(TARGET), )
150
151
TARGET := a.out
151
152
endif
152
153
 
153
154
# no serial device? attempt to detect an arduino
154
 
ifndef SERIALDEV
 
155
ifeq ($(SERIALDEV), )
155
156
SERIALDEV := $(firstword $(wildcard /dev/ttyACM? /dev/ttyUSB?))
156
157
endif
157
158
 
167
168
# files
168
169
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
169
170
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
 
171
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
170
172
ARDUINOLIB := _arduino.a
171
 
ARDUINOLIBTMP := _arduino.a.tmp
 
173
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
172
174
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
173
175
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
174
176
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
175
177
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
176
 
        $(wildcard $(addprefix $(ARDUINODIR)/libraries/$(lib)/, *.c *.cpp))))))
 
178
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
 
179
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
177
180
 
178
181
# obtain board parameters from the arduino boards.txt file
179
182
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
188
191
BOARD_UPLOAD_PROTOCOL := \
189
192
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
190
193
 
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
 
194
# software (prioritise binaries that came with arduino software)
 
195
FIND_SOFTWARE = $(firstword $(wildcard \
 
196
        $(ARDUINODIR)/hardware/tools/$(1) \
 
197
        $(ARDUINODIR)/hardware/tools/avr/bin/$(1) \
 
198
        ) $(1) )
 
199
CC := $(call FIND_SOFTWARE,avr-gcc)
 
200
CXX := $(call FIND_SOFTWARE,avr-g++)
 
201
LD := $(call FIND_SOFTWARE,avr-ld)
 
202
AR := $(call FIND_SOFTWARE,avr-ar)
 
203
OBJCOPY := $(call FIND_SOFTWARE,avr-objcopy)
 
204
AVRDUDE := $(call FIND_SOFTWARE,avrdude)
198
205
 
199
206
# flags
200
207
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
201
208
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
202
209
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
203
210
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
204
 
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/,$(LIBRARIES))
 
211
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
 
212
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
205
213
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
206
214
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
207
215
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
213
221
#_______________________________________________________________________________
214
222
#                                                                          RULES
215
223
 
216
 
.PHONY: all target upload clean show-boards
 
224
.PHONY: all target upload clean boards monitor
217
225
 
218
226
all: target upload
219
227
 
220
228
target: $(TARGET).hex
221
229
 
222
230
upload:
 
231
        @echo "\nUploading to board..."
 
232
        @test -n "$(SERIALDEV)" || { \
 
233
                echo "error: SERIALDEV could not be determined automatically." >&2; \
 
234
                exit 1; }
223
235
        stty -F $(SERIALDEV) hupcl
224
236
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
225
237
 
233
245
        @sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
234
246
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
235
247
 
 
248
monitor:
 
249
        @test -n "$(SERIALDEV)" || { \
 
250
                echo "error: SERIALDEV could not be determined automatically." >&2; \
 
251
                exit 1; }
 
252
        @test -n `which screen` || { \
 
253
                echo "error: can't find GNU screen, you might need to install it." >&2 \
 
254
                ecit 1; }
 
255
        screen $(SERIALDEV)
 
256
 
236
257
# building the target
237
258
 
238
259
$(TARGET).hex: $(TARGET).elf
272
293
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
273
294
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
274
295
        $(COMPILE.cpp) -o $@ $<
 
296
 
 
297
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c
 
298
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
299
        $(COMPILE.c) -o $@ $<
 
300
 
 
301
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp
 
302
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
303
        $(COMPILE.cpp) -o $@ $<