/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-30 21:37:46 UTC
  • Revision ID: edam@waxworlds.org-20111230213746-l3bd5co3j5fmg1ne
minor optimisations

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 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
 
# 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 undefined.
83
 
#
84
 
# AVRDUDECONF  The avrdude.conf to use. If undefined, this defaults to a guess
85
 
#              based on where the avrdude in use is. If empty, no avrdude.conf
86
 
#              is passed to avrdude (to the system default is used).
87
 
#
88
 
# AVRTOOLSPATH A space-separated list of directories to search in order when
89
 
#              lookin for the avr build tools. This defaults to the system PATH
90
 
#              followed by subdirectories in ARDUINODIR if undefined.
91
 
#
92
 
# BOARD        Specify a target board type.  Run `make boards` to see available
93
 
#              board types.
94
 
#
95
 
# LIBRARIES    A list of arduino libraries to build and include.  This is set
96
 
#              automatically if a .ino (or .pde) is found.
97
 
#
98
 
# SERIALDEV    The unix device name of the serial device that is the arduino.
99
 
#              If unspecified, an attempt is made to determine the name of a
100
 
#              connected arduino's serial device.
101
 
#
102
 
# SOURCES      A list of all source files of whatever language.  The language
103
 
#              type is determined by the file extension.  This is set
104
 
#              automatically if a .ino (or .pde) is found.
105
 
#
106
 
# TARGET       The name of the target file.  This is set automatically if a
107
 
#              .ino (or .pde) is found, but it is not necessary to set it
108
 
#              otherwise.
109
 
#
110
 
# This makefile also defines the following goals for use on the command line
111
 
# when you run make:
112
 
#
113
 
# all          This is the default if no goal is specified.  It builds the
 
30
# This is a general purpose makefile for use with Arduino (arduino.cc)
 
31
# hardware and software.  It works with the arduino-1.0 release and
 
32
# requires that to be downloaded separately.  It can be downloaded
 
33
# from http://ed.am/dev/make/arduino-makefile where you can also find
 
34
# more information and documentation on it's use.  The following text
 
35
# can only really be considered a reference to it's use.
 
36
#
 
37
# There are two ways to use this file, an automatic mode and a manual
 
38
# mode.  In automatic mode, you simply copy this makefile to your
 
39
# arduino project directory, rename it "Makefile" and type make.  The
 
40
# project directory is expected to contain an .ino or .pde file, which
 
41
# will automatically be used automatically, along with any other .c,
 
42
# .cc or .cpp files in the project directory and any subdirectory
 
43
# named "utility".  In this way, this makefile should act as a drop-in
 
44
# replacement for the Arduino IDE's build process and can build a
 
45
# project automatically from the files in a project directory.
 
46
#
 
47
# Alternatively, you can manually specify what files should be
 
48
# inclided in a build.  To use this makefile manually, you might be
 
49
# better to keep it somewhere and include it in your project's
 
50
# Makefile after having defined certain parameters that control the
 
51
# build.  As an example, consider the following Makefile:
 
52
#
 
53
#       TARGET = my_program
 
54
#       SOURCES = main.cc foo.cc
 
55
#               BOARD = nano
 
56
#               SERIALDEV = /dev/ttyACM0
 
57
#       include ~/src/arduino.mk
 
58
#
 
59
# In both manual and automatic modes, the standard Arduino main.cpp's
 
60
# main() is included, which expects to be able to call init() and
 
61
# loop() in your code.  The main difference is that, in manual mode,
 
62
# these would typically be placed in a .cc or .cpp file.
 
63
#
 
64
# When using manual mode, the following variables can be used:
 
65
#
 
66
# TARGET       The name of the target file.  This is typically the same name
 
67
#              as the project directory for an arduino project and, if
 
68
#              unspecified, that is used as a default.
 
69
#
 
70
# SOURCES      A list of all source files of whatever language. The language
 
71
#              type is determined by the file extension.
 
72
#
 
73
# BOARD        Specify a target board type.  These are defined in boards.txt,
 
74
#              which came with your arduino installation.  If unspecified,
 
75
#              a default is used.  (See below).
 
76
#
 
77
# SERIALDEV    The unix device of the device where the arduino can be found.
 
78
#              If unspecified, a default is used.  (See below).
 
79
#
 
80
# This general-purpose makefile also defines the following goals for use on the
 
81
# command line when you run make:
 
82
#
 
83
# all          This is the default if no goal is specified. It builds the
114
84
#              target and uploads it.
115
85
#
116
 
# target       Builds the target.
117
 
#
118
 
# upload       Uploads the last built target to an attached arduino.
119
 
#
120
 
# clean        Deletes files created during the build.
121
 
#
122
 
# boards       Display a list of available board names, so that you can set the
123
 
#              BOARD environment variable appropriately.
124
 
#
125
 
# monitor      Start `screen` on the serial device.  This is meant to be an
126
 
#              equivalent to the arduino serial monitor.
 
86
# target       Builds the target of your Makefile.
 
87
#
 
88
# upload       Uploads the target to an attached arduino.
 
89
#
 
90
# clean        Deletes temporary files.
127
91
#
128
92
# <file>       Builds the specified file, either an object file or the target,
129
93
#              from those that that would be built for the project.
130
 
#_______________________________________________________________________________
131
 
#
132
 
 
133
 
# default arduino software directory, check software exists
134
 
ifndef ARDUINODIR
135
 
ARDUINODIR := $(wildcard ~/opt/arduino)
136
 
endif
137
 
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
138
 
$(error ARDUINODIR is not set correctly; arduino software not found)
139
 
endif
140
 
 
141
 
# default arduino version
142
 
ARDUINOCONST ?= 100
143
 
 
144
 
# default path for avr tools
145
 
ifndef AVRTOOLSPATH
146
 
AVRTOOLSPATH := $(subst :, , $(PATH))
147
 
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools
148
 
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
149
 
endif
 
94
#
 
95
#_______________________________________________________________________________
 
96
#                                                                       SETTINGS
 
97
 
 
98
# The full path to the arduino software, from arduino.cc
 
99
ARDUINODIR := $(wildcard ~/opt/arduino-1.0)
 
100
 
 
101
# The board name to build for and upload to. For a complete list of available
 
102
# boards, see hardware/arduino/boards.txt in your arduino software directory.
 
103
# Here is a list of available boards at time of writing:
 
104
#   uno         Arduino Uno
 
105
#   atmega328   Arduino Duemilanove w/ ATmega328
 
106
#   diecimila   Arduino Diecimila or Duemilanove w/ ATmega168
 
107
#   nano328     Arduino Nano w/ ATmega328
 
108
#   nano        Arduino Nano w/ ATmega168
 
109
#   mega2560    Arduino Mega 2560 or Mega ADK
 
110
#   mega        Arduino Mega (ATmega1280)
 
111
#   mini328     Arduino Mini w/ ATmega328
 
112
#   mini        Arduino Mini w/ ATmega168
 
113
#   fio         Arduino Fio
 
114
#   bt328       Arduino BT w/ ATmega328
 
115
#   bt          Arduino BT w/ ATmega168
 
116
#   lilypad328  LilyPad Arduino w/ ATmega328
 
117
#   lilypad     LilyPad Arduino w/ ATmega168
 
118
#   pro5v328    Arduino Pro or Pro Mini (5V, 16 MHz) w/ ATmega328
 
119
#   pro5v       Arduino Pro or Pro Mini (5V, 16 MHz) w/ ATmega168
 
120
#   pro328      Arduino Pro or Pro Mini (3.3V, 8 MHz) w/ ATmega328
 
121
#   pro         Arduino Pro or Pro Mini (3.3V, 8 MHz) w/ ATmega168
 
122
#   atmega168   Arduino NG or older w/ ATmega168
 
123
#   atmega8     Arduino NG or older w/ ATmega8
 
124
ifndef BOARD
 
125
BOARD := nano
 
126
endif
 
127
 
 
128
# The name of the serial device that the arduino is at. For example,
 
129
# /dev/ttyACM0 (Uno), or /dev/ttyUSB0 (Duemilanove)
 
130
ifndef SERIALDEV
 
131
SERIALDEV := /dev/ttyACM0
 
132
endif
 
133
 
 
134
#_______________________________________________________________________________
 
135
#
150
136
 
151
137
# auto mode?
152
138
INOFILE := $(wildcard *.ino *.pde)
153
139
ifdef INOFILE
154
 
ifneq "$(words $(INOFILE))" "1"
155
 
$(error There is more than one .pde or .ino file in this directory!)
 
140
ifneq ($(words $(INOFILE)), 1)
 
141
$(error There is more than one .pde or .ino file in the directory!)
156
142
endif
157
 
 
158
 
# automatically determine sources and targeet
159
143
TARGET := $(basename $(INOFILE))
160
144
SOURCES := $(INOFILE) \
161
 
        $(wildcard *.c *.cc *.cpp) \
162
 
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
163
 
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
164
 
 
165
 
# automatically determine included libraries
166
 
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
167
 
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
168
 
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
169
 
 
170
 
endif
171
 
 
172
 
# no serial device? make a poor attempt to detect an arduino
173
 
SERIALDEVGUESS := 0
174
 
ifeq "$(SERIALDEV)" ""
175
 
SERIALDEV := $(firstword $(wildcard \
176
 
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbmodem*))
177
 
SERIALDEVGUESS := 1
178
 
endif
179
 
 
180
 
# software
181
 
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
182
 
CC := $(call findsoftware,avr-gcc)
183
 
CXX := $(call findsoftware,avr-g++)
184
 
LD := $(call findsoftware,avr-ld)
185
 
AR := $(call findsoftware,avr-ar)
186
 
OBJCOPY := $(call findsoftware,avr-objcopy)
187
 
AVRDUDE := $(call findsoftware,avrdude)
 
145
        $(wildcard *.c *.cc *.cpp $(addprefix utility/, *.c *.cc *.cpp))
 
146
endif
188
147
 
189
148
# files
190
 
TARGET := $(if $(TARGET),$(TARGET),a.out)
191
149
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
 
150
ifdef INOFILE
 
151
OBJECT += main.o
 
152
endif
192
153
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
193
 
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
194
154
ARDUINOLIB := _arduino.a
195
 
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
196
 
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
197
 
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
198
 
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
199
 
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
200
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
201
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
202
 
ifeq "$(AVRDUDECONF)" ""
203
 
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
204
 
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
205
 
else
206
 
AVRDUDECONF := $(wildcard $(AVRDUDE).conf)
207
 
endif
208
 
endif
209
 
 
210
 
# no board?
211
 
ifndef BOARD
212
 
ifneq "$(MAKECMDGOALS)" "boards"
213
 
ifneq "$(MAKECMDGOALS)" "clean"
214
 
$(error BOARD is unset.  Type 'make boards' to see possible values)
215
 
endif
216
 
endif
217
 
endif
 
155
ARDUINOLIBTMP := _arduino.a.tmp
 
156
ARDUINOSOURCES := $(wildcard $(ARDUINOSRCDIR)/*.c $(ARDUINOSRCDIR)/*.cpp)
 
157
ARDUINOOBJECTS := $(addsuffix .o, $(addprefix $(ARDUINOLIBTMP)/, $(basename \
 
158
        $(notdir $(ARDUINOSOURCES)))))
218
159
 
219
160
# obtain board parameters from the arduino boards.txt file
220
161
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
229
170
BOARD_UPLOAD_PROTOCOL := \
230
171
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
231
172
 
232
 
# invalid board?
233
 
ifeq "$(BOARD_BUILD_MCU)" ""
234
 
ifneq "$(MAKECMDGOALS)" "boards"
235
 
ifneq "$(MAKECMDGOALS)" "clean"
236
 
$(error BOARD is invalid.  Type 'make boards' to see possible values)
237
 
endif
238
 
endif
239
 
endif
 
173
# software
 
174
CC := avr-gcc
 
175
CXX := avr-g++
 
176
LD := avr-ld
 
177
AR := avr-ar
 
178
OBJCOPY := avr-objcopy
 
179
AVRDUDE := avrdude
 
180
#$(ARDUINODIR)/hardware/tools/avrdude
240
181
 
241
182
# flags
242
 
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
243
 
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
244
 
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
245
 
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
246
 
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
 
183
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
 
184
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
 
185
CPPFLAGS += -I. -Iutility -I$(ARDUINOSRCDIR)
247
186
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
248
 
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
249
 
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
250
 
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
 
187
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
251
188
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
252
189
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
253
 
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
 
190
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
254
191
 
255
 
# figure out which arg to use with stty
256
 
STTYFARG := $(shell stty --help > /dev/null 2>&1 && echo -F || echo -f)
 
192
# checks
 
193
ifeq ($(TARGET),)
 
194
$(error No target defined!)
 
195
endif
257
196
 
258
197
# default rule
259
198
.DEFAULT_GOAL := all
261
200
#_______________________________________________________________________________
262
201
#                                                                          RULES
263
202
 
264
 
.PHONY: all target upload clean boards monitor
 
203
.PHONY: all target upload clean
265
204
 
266
205
all: target upload
267
206
 
268
207
target: $(TARGET).hex
269
208
 
270
209
upload:
271
 
        @echo "\nUploading to board..."
272
 
        @test -n "$(SERIALDEV)" || { \
273
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
274
 
                exit 1; }
275
 
        @test 1 -eq $(SERIALDEVGUESS) && { \
276
 
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
277
 
                echo; }
278
 
        stty $(STTYFARG) $(SERIALDEV) hupcl
 
210
        stty -F $(SERIALDEV) hupcl
279
211
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
280
212
 
281
213
clean:
283
215
        rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
284
216
        rm -rf $(ARDUINOLIBTMP)
285
217
 
286
 
boards:
287
 
        @echo Available values for BOARD:
288
 
        @sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
289
 
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
290
 
 
291
 
monitor:
292
 
        @test -n "$(SERIALDEV)" || { \
293
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
294
 
                exit 1; }
295
 
        @test -n `which screen` || { \
296
 
                echo "error: can't find GNU screen, you might need to install it." >&2 \
297
 
                ecit 1; }
298
 
        @test 1 -eq $(SERIALDEVGUESS) && { \
299
 
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
300
 
                echo; }
301
 
        screen $(SERIALDEV)
302
 
 
303
218
# building the target
304
219
 
305
220
$(TARGET).hex: $(TARGET).elf
318
233
 
319
234
# building the arduino library
320
235
 
321
 
$(ARDUINOLIB): $(ARDUINOLIBOBJS)
 
236
$(ARDUINOLIB): $(ARDUINOOBJECTS)
322
237
        $(AR) rcs $@ $?
323
238
        rm -rf $(ARDUINOLIBTMP)
324
239
 
325
 
.INTERMEDIATE: $(ARDUINOLIBOBJS)
 
240
.INTERMEDIATE: $(ARDUINOOBJECTS)
326
241
 
327
242
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.c
328
243
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
331
246
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.cpp
332
247
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
333
248
        $(COMPILE.cpp) -o $@ $<
334
 
 
335
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.c
336
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
337
 
        $(COMPILE.c) -o $@ $<
338
 
 
339
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
340
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
341
 
        $(COMPILE.cpp) -o $@ $<
342
 
 
343
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c
344
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
345
 
        $(COMPILE.c) -o $@ $<
346
 
 
347
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp
348
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
349
 
        $(COMPILE.cpp) -o $@ $<