/make/arduino-mk

To get this branch, use:
bzr branch http://bzr.ed.am/make/arduino-mk
1 by edam
initial commit
1
#_______________________________________________________________________________
2
#
3
#                         edam's arduino makefile
4
#_______________________________________________________________________________
5
#                                                                    version 0.1
6
#
7
# Copyright (c) 2011 Tim Marston <tim@ed.am>.
8
#
9
# Permission is hereby granted, free of charge, to any person obtaining a copy
10
# of this software and associated documentation files (the "Software"), to deal
11
# in the Software without restriction, including without limitation the rights
12
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13
# copies of the Software, and to permit persons to whom the Software is
14
# furnished to do so, subject to the following conditions:
15
#
16
# The above copyright notice and this permission notice shall be included in
17
# all copies or substantial portions of the Software.
18
#
19
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
10 by edam
formatting, and changed default for ARDUINODIR
24
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25
# SOFTWARE.
1 by edam
initial commit
26
#
27
#_______________________________________________________________________________
28
#
29
#
7 by edam
fixed comments for publishing
30
# This is a general purpose makefile for use with Arduino hardware and
10 by edam
formatting, and changed default for ARDUINODIR
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.
7 by edam
fixed comments for publishing
36
#
11 by edam
fixed URL
37
#   http://ed.am/dev/make/arduino-mk
5 by edam
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.
38
#
10 by edam
formatting, and changed default for ARDUINODIR
39
# This makefile can be used as a drop-in replacement for the Arduino IDE's
12 by edam
cleaned up comments
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:
5 by edam
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.
43
#
7 by edam
fixed comments for publishing
44
#   $ ln -s ~/src/arduino.mk Makefile
5 by edam
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.
45
#
16 by edam
spellcheck, and added check for missing GNU screen
46
# You also need to set up a couple of environment variables. ARDUINODIR should
12 by edam
cleaned up comments
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
16 by edam
spellcheck, and added check for missing GNU screen
55
# override it as necessary).  For example:
12 by edam
cleaned up comments
56
#
57
#   $ export BOARD=uno
58
#   $ make
59
#
60
# You may also need to set SERIALDEV if it is not detected correctly.
61
#
18 by edam
downplay importance of .pde files
62
# The presence of a .ino (or .pde) file causes the arduino.mk to automatically
16 by edam
spellcheck, and added check for missing GNU screen
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
18 by edam
downplay importance of .pde files
66
# that have been #included. Note, there can only be one .ino (or .pde) file.
5 by edam
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.
67
#
10 by edam
formatting, and changed default for ARDUINODIR
68
# Alternatively, if you want to manually specify build variables, create a
16 by edam
spellcheck, and added check for missing GNU screen
69
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
12 by edam
cleaned up comments
70
# (There is no need to define TARGET).  Here is an example Makefile:
5 by edam
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.
71
#
12 by edam
cleaned up comments
72
#   SOURCES := main.cc other.cc
7 by edam
fixed comments for publishing
73
#   LIBRARIES := EEPROM
74
#   include ~/src/arduino.mk
1 by edam
initial commit
75
#
8 by edam
broke out ARDUINODIR, so it is not configured in the makefile
76
# Here is a complete list of configuration parameters:
77
#
10 by edam
formatting, and changed default for ARDUINODIR
78
# ARDUINODIR   The path where you have installed/unpacked the arduino software
79
#              (from http://arduino.cc/)
4 by edam
added included-library autodetection and updated comments
80
#
12 by edam
cleaned up comments
81
# BOARD        Specify a target board type.  Run `make boards` to see available
82
#              board types.
4 by edam
added included-library autodetection and updated comments
83
#
16 by edam
spellcheck, and added check for missing GNU screen
84
# SERIALDEV    The unix device name of the serial device that is the arduino.
10 by edam
formatting, and changed default for ARDUINODIR
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
18 by edam
downplay importance of .pde files
89
#              .ino (or .pde) is found, but it is not necessary to set it
10 by edam
formatting, and changed default for ARDUINODIR
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
18 by edam
downplay importance of .pde files
94
#              automatically if a .ino (or .pde) is found.
10 by edam
formatting, and changed default for ARDUINODIR
95
#
96
# LIBRARIES    A list of arduino libraries to build and include.  This is set
18 by edam
downplay importance of .pde files
97
#              automatically if a .ino (or .pde) is found.
5 by edam
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.
98
#
12 by edam
cleaned up comments
99
# This makefile also defines the following goals for use on the command line
100
# when you run make:
5 by edam
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.
101
#
12 by edam
cleaned up comments
102
# all          This is the default if no goal is specified.  It builds the
10 by edam
formatting, and changed default for ARDUINODIR
103
#              target and uploads it.
1 by edam
initial commit
104
#
12 by edam
cleaned up comments
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.
1 by edam
initial commit
110
#
10 by edam
formatting, and changed default for ARDUINODIR
111
# boards       Display a list of available board names, so that you can set the
112
#              BOARD environment variable appropriately.
113
#
16 by edam
spellcheck, and added check for missing GNU screen
114
# monitor      Start `screen` on the serial device.  This is meant to be an
115
#              equivalent to the arduino serial monitor.
10 by edam
formatting, and changed default for ARDUINODIR
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.
1 by edam
initial commit
119
#_______________________________________________________________________________
5 by edam
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.
120
#
1 by edam
initial commit
121
122
# The full path to the arduino software, from arduino.cc
8 by edam
broke out ARDUINODIR, so it is not configured in the makefile
123
ifndef ARDUINODIR
10 by edam
formatting, and changed default for ARDUINODIR
124
ARDUINODIR := $(wildcard ~/opt/arduino)
8 by edam
broke out ARDUINODIR, so it is not configured in the makefile
125
endif
1 by edam
initial commit
126
5 by edam
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.
127
# check arduino software
128
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
8 by edam
broke out ARDUINODIR, so it is not configured in the makefile
129
$(error ARDUINODIR is not set correctly; arduino software not found)
5 by edam
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.
130
endif
1 by edam
initial commit
131
132
# auto mode?
133
INOFILE := $(wildcard *.ino *.pde)
134
ifdef INOFILE
135
ifneq ($(words $(INOFILE)), 1)
5 by edam
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.
136
$(error There is more than one .pde or .ino file in this directory!)
1 by edam
initial commit
137
endif
138
TARGET := $(basename $(INOFILE))
139
SOURCES := $(INOFILE) \
4 by edam
added included-library autodetection and updated comments
140
	$(wildcard *.c *.cc *.cpp) \
141
	$(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
142
	$(wildcard $(addprefix utility/, *.c *.cc *.cpp))
143
# automatically determine included libraries
144
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
145
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
146
	$(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
1 by edam
initial commit
147
endif
148
5 by edam
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.
149
# no target? use default
15 by edam
fixed detection of env. vars. and a typo in a rule that caused it not to work
150
ifeq ($(TARGET), )
5 by edam
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.
151
TARGET := a.out
152
endif
153
154
# no serial device? attempt to detect an arduino
15 by edam
fixed detection of env. vars. and a typo in a rule that caused it not to work
155
ifeq ($(SERIALDEV), )
5 by edam
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.
156
SERIALDEV := $(firstword $(wildcard /dev/ttyACM? /dev/ttyUSB?))
157
endif
158
159
# no board? oh dear...
160
ifndef BOARD
161
ifneq "$(MAKECMDGOALS)" "boards"
162
ifneq "$(MAKECMDGOALS)" "clean"
163
$(error BOARD is unset.  Type 'make boards' to see possible values)
164
endif
165
endif
166
endif
167
1 by edam
initial commit
168
# files
169
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
170
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
15 by edam
fixed detection of env. vars. and a typo in a rule that caused it not to work
171
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
1 by edam
initial commit
172
ARDUINOLIB := _arduino.a
14 by Dan
search for software in ARDUINODIR; include library/*/utility code in core lib
173
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
4 by edam
added included-library autodetection and updated comments
174
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
175
	$(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
176
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
177
	$(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
15 by edam
fixed detection of env. vars. and a typo in a rule that caused it not to work
178
	$(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
179
	$(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
1 by edam
initial commit
180
2 by edam
fixed build (missing library), tested upload, and made the .elf file an intermediate file (the .hex file is now the target)
181
# obtain board parameters from the arduino boards.txt file
1 by edam
initial commit
182
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
183
BOARD_BUILD_MCU := \
184
	$(shell sed -ne "s/$(BOARD).build.mcu=\(.*\)/\1/p" $(BOARDS_FILE))
185
BOARD_BUILD_FCPU := \
186
	$(shell sed -ne "s/$(BOARD).build.f_cpu=\(.*\)/\1/p" $(BOARDS_FILE))
187
BOARD_BUILD_VARIANT := \
188
	$(shell sed -ne "s/$(BOARD).build.variant=\(.*\)/\1/p" $(BOARDS_FILE))
189
BOARD_UPLOAD_SPEED := \
190
	$(shell sed -ne "s/$(BOARD).upload.speed=\(.*\)/\1/p" $(BOARDS_FILE))
191
BOARD_UPLOAD_PROTOCOL := \
192
	$(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
193
14 by Dan
search for software in ARDUINODIR; include library/*/utility code in core lib
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)
1 by edam
initial commit
205
206
# flags
207
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
208
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
5 by edam
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.
209
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
1 by edam
initial commit
210
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
9 by edam
added "monitor" goal; documented boards and monitor goals
211
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
212
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
2 by edam
fixed build (missing library), tested upload, and made the .elf file an intermediate file (the .hex file is now the target)
213
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
1 by edam
initial commit
214
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
215
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
2 by edam
fixed build (missing library), tested upload, and made the .elf file an intermediate file (the .hex file is now the target)
216
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
1 by edam
initial commit
217
218
# default rule
219
.DEFAULT_GOAL := all
220
221
#_______________________________________________________________________________
222
#                                                                          RULES
223
9 by edam
added "monitor" goal; documented boards and monitor goals
224
.PHONY:	all target upload clean boards monitor
1 by edam
initial commit
225
226
all: target upload
227
2 by edam
fixed build (missing library), tested upload, and made the .elf file an intermediate file (the .hex file is now the target)
228
target: $(TARGET).hex
1 by edam
initial commit
229
230
upload:
13 by edam
announce that we're uploading and error on SERIALDEV blank
231
	@echo "\nUploading to board..."
232
	@test -n "$(SERIALDEV)" || { \
233
		echo "error: SERIALDEV could not be determined automatically." >&2; \
234
		exit 1; }
1 by edam
initial commit
235
	stty -F $(SERIALDEV) hupcl
2 by edam
fixed build (missing library), tested upload, and made the .elf file an intermediate file (the .hex file is now the target)
236
	$(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
1 by edam
initial commit
237
238
clean:
239
	rm -f $(OBJECTS)
240
	rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
241
	rm -rf $(ARDUINOLIBTMP)
242
5 by edam
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.
243
boards:
244
	@echo Available values for BOARD:
245
	@sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
246
		-e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
247
9 by edam
added "monitor" goal; documented boards and monitor goals
248
monitor:
13 by edam
announce that we're uploading and error on SERIALDEV blank
249
	@test -n "$(SERIALDEV)" || { \
250
		echo "error: SERIALDEV could not be determined automatically." >&2; \
251
		exit 1; }
16 by edam
spellcheck, and added check for missing GNU screen
252
	@test -n `which screen` || { \
253
		echo "error: can't find GNU screen, you might need to install it." >&2 \
254
		ecit 1; }
9 by edam
added "monitor" goal; documented boards and monitor goals
255
	screen $(SERIALDEV)
256
1 by edam
initial commit
257
# building the target
258
2 by edam
fixed build (missing library), tested upload, and made the .elf file an intermediate file (the .hex file is now the target)
259
$(TARGET).hex: $(TARGET).elf
260
	$(OBJCOPY) -O ihex -R .eeprom $< $@
261
262
.INTERMEDIATE: $(TARGET).elf
263
1 by edam
initial commit
264
$(TARGET).elf: $(ARDUINOLIB) $(OBJECTS)
2 by edam
fixed build (missing library), tested upload, and made the .elf file an intermediate file (the .hex file is now the target)
265
	$(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -o $@
1 by edam
initial commit
266
267
%.o: %.ino
268
	$(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
269
270
%.o: %.pde
271
	$(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
272
273
# building the arduino library
274
4 by edam
added included-library autodetection and updated comments
275
$(ARDUINOLIB): $(ARDUINOLIBOBJS)
1 by edam
initial commit
276
	$(AR) rcs $@ $?
277
	rm -rf $(ARDUINOLIBTMP)
278
4 by edam
added included-library autodetection and updated comments
279
.INTERMEDIATE: $(ARDUINOLIBOBJS)
1 by edam
initial commit
280
281
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.c
282
	@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
283
	$(COMPILE.c) -o $@ $<
284
285
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.cpp
286
	@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
287
	$(COMPILE.cpp) -o $@ $<
4 by edam
added included-library autodetection and updated comments
288
289
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.c
290
	@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
291
	$(COMPILE.c) -o $@ $<
292
293
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
294
	@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
295
	$(COMPILE.cpp) -o $@ $<
14 by Dan
search for software in ARDUINODIR; include library/*/utility code in core lib
296
297
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c
298
	@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
15 by edam
fixed detection of env. vars. and a typo in a rule that caused it not to work
299
	$(COMPILE.c) -o $@ $<
14 by Dan
search for software in ARDUINODIR; include library/*/utility code in core lib
300
301
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp
302
	@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
303
	$(COMPILE.cpp) -o $@ $<