/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-03 20:08:42 UTC
  • Revision ID: edam@waxworlds.org-20120103200842-mzqkg2bewooqxc2w
fixed comments for publishing

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 as described below (remembering to specify a
 
49
# BOARD).  You would create the symlink like like so:
42
50
#
43
51
#   $ ln -s ~/src/arduino.mk Makefile
44
52
#
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
 
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
80
68
#   LIBRARIES := EEPROM
81
69
#   include ~/src/arduino.mk
82
70
#
83
 
# Here is a complete list of configuration parameters:
84
 
#
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
 
# size         Displays size information about the bulit target.
135
 
#
136
 
# <file>       Builds the specified file, either an object file or the target,
137
 
#              from those that that would be built for the project.
 
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
#
138
122
#_______________________________________________________________________________
139
123
#
140
124
 
141
 
# default arduino software directory, check software exists
142
 
ifndef ARDUINODIR
143
 
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))
144
 
endif
145
 
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
146
 
$(error ARDUINODIR is not set correctly; arduino software not found)
147
 
endif
148
 
 
149
 
# default arduino version
150
 
ARDUINOCONST ?= 100
151
 
 
152
 
# default path for avr tools
153
 
ifndef AVRTOOLSPATH
154
 
AVRTOOLSPATH := $(subst :, , $(PATH))
155
 
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools
156
 
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
 
125
# The full path to the arduino software, from arduino.cc
 
126
ARDUINODIR := $(wildcard ~/opt/arduino-1.0)
 
127
 
 
128
# check arduino software
 
129
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
 
130
$(error ARDUINODIR is not set correctly at the top of arduino.mk)
157
131
endif
158
132
 
159
133
# auto mode?
160
134
INOFILE := $(wildcard *.ino *.pde)
161
135
ifdef INOFILE
162
 
ifneq "$(words $(INOFILE))" "1"
 
136
ifneq ($(words $(INOFILE)), 1)
163
137
$(error There is more than one .pde or .ino file in this directory!)
164
138
endif
165
 
 
166
 
# automatically determine sources and targeet
167
139
TARGET := $(basename $(INOFILE))
168
140
SOURCES := $(INOFILE) \
169
141
        $(wildcard *.c *.cc *.cpp) \
170
142
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
171
143
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
172
 
 
173
144
# automatically determine included libraries
174
145
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
175
146
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
176
147
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
177
 
 
178
 
endif
179
 
 
180
 
# no serial device? make a poor attempt to detect an arduino
181
 
SERIALDEVGUESS := 0
182
 
ifeq "$(SERIALDEV)" ""
183
 
SERIALDEV := $(firstword $(wildcard \
184
 
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbmodem*))
185
 
SERIALDEVGUESS := 1
186
 
endif
187
 
 
188
 
# software
189
 
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
190
 
CC := $(call findsoftware,avr-gcc)
191
 
CXX := $(call findsoftware,avr-g++)
192
 
LD := $(call findsoftware,avr-ld)
193
 
AR := $(call findsoftware,avr-ar)
194
 
OBJCOPY := $(call findsoftware,avr-objcopy)
195
 
AVRDUDE := $(call findsoftware,avrdude)
196
 
AVRSIZE := $(call findsoftware,avr-size)
 
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?))
 
158
endif
 
159
 
 
160
# no board? oh dear...
 
161
ifndef BOARD
 
162
ifneq "$(MAKECMDGOALS)" "boards"
 
163
ifneq "$(MAKECMDGOALS)" "clean"
 
164
$(error BOARD is unset.  Type 'make boards' to see possible values)
 
165
endif
 
166
endif
 
167
endif
197
168
 
198
169
# files
199
 
TARGET := $(if $(TARGET),$(TARGET),a.out)
200
170
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
201
171
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
202
 
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
203
172
ARDUINOLIB := _arduino.a
204
 
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
 
173
ARDUINOLIBTMP := _arduino.a.tmp
205
174
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
206
175
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
207
176
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
208
177
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
209
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
210
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
211
 
ifeq "$(AVRDUDECONF)" ""
212
 
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
213
 
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
214
 
else
215
 
AVRDUDECONF := $(wildcard $(AVRDUDE).conf)
216
 
endif
217
 
endif
218
 
 
219
 
# no board?
220
 
ifndef BOARD
221
 
ifneq "$(MAKECMDGOALS)" "boards"
222
 
ifneq "$(MAKECMDGOALS)" "clean"
223
 
$(error BOARD is unset.  Type 'make boards' to see possible values)
224
 
endif
225
 
endif
226
 
endif
 
178
        $(wildcard $(addprefix $(ARDUINODIR)/libraries/$(lib)/, *.c *.cpp))))))
227
179
 
228
180
# obtain board parameters from the arduino boards.txt file
229
181
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
238
190
BOARD_UPLOAD_PROTOCOL := \
239
191
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
240
192
 
241
 
# invalid board?
242
 
ifeq "$(BOARD_BUILD_MCU)" ""
243
 
ifneq "$(MAKECMDGOALS)" "boards"
244
 
ifneq "$(MAKECMDGOALS)" "clean"
245
 
$(error BOARD is invalid.  Type 'make boards' to see possible values)
246
 
endif
247
 
endif
248
 
endif
 
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
249
200
 
250
201
# flags
251
 
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
252
 
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
253
 
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
254
 
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
 
202
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
 
203
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
255
204
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
256
205
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
257
 
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
258
 
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
259
 
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
 
206
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/,$(LIBRARIES))
 
207
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
260
208
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
261
209
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
262
 
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
263
 
 
264
 
# figure out which arg to use with stty
265
 
STTYFARG := $(shell stty --help > /dev/null 2>&1 && echo -F || echo -f)
 
210
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
266
211
 
267
212
# default rule
268
213
.DEFAULT_GOAL := all
270
215
#_______________________________________________________________________________
271
216
#                                                                          RULES
272
217
 
273
 
.PHONY: all target upload clean boards monitor size
 
218
.PHONY: all target upload clean boards
274
219
 
275
220
all: target upload
276
221
 
277
222
target: $(TARGET).hex
278
223
 
279
224
upload:
280
 
        @echo "\nUploading to board..."
281
 
        @test -n "$(SERIALDEV)" || { \
282
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
283
 
                exit 1; }
284
 
        @test 0 -eq $(SERIALDEVGUESS) || { \
285
 
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
286
 
                echo; }
287
 
        stty $(STTYFARG) $(SERIALDEV) hupcl
 
225
        stty -F $(SERIALDEV) hupcl
288
226
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
289
227
 
290
228
clean:
297
235
        @sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
298
236
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
299
237
 
300
 
monitor:
301
 
        @test -n "$(SERIALDEV)" || { \
302
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
303
 
                exit 1; }
304
 
        @test -n `which screen` || { \
305
 
                echo "error: can't find GNU screen, you might need to install it." >&2 \
306
 
                ecit 1; }
307
 
        @test 0 -eq $(SERIALDEVGUESS) || { \
308
 
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
309
 
                echo; }
310
 
        screen $(SERIALDEV)
311
 
 
312
 
size: $(TARGET).elf
313
 
        echo && $(AVRSIZE) --format=avr --mcu=$(BOARD_BUILD_MCU) $(TARGET).elf
314
 
 
315
238
# building the target
316
239
 
317
240
$(TARGET).hex: $(TARGET).elf
351
274
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
352
275
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
353
276
        $(COMPILE.cpp) -o $@ $<
354
 
 
355
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c
356
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
357
 
        $(COMPILE.c) -o $@ $<
358
 
 
359
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp
360
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
361
 
        $(COMPILE.cpp) -o $@ $<