/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-05-26 12:09:36 UTC
  • Revision ID: tim@ed.am-20120526120936-udje92i2dogga25y
updated boards goal to work on OS X (explicitly use extended REs)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
#_______________________________________________________________________________
2
2
#
3
 
#                         edam's arduino makefile
 
3
#                         edam's Arduino makefile
4
4
#_______________________________________________________________________________
5
 
#                                                                    version 0.1
 
5
#                                                                 version 0.4dev
6
6
#
7
 
# Copyright (c) 2011 Tim Marston <tim@ed.am>.
 
7
# Copyright (C) 2011, 1012 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
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 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.
 
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.
36
35
#
37
36
#   http://ed.am/dev/make/arduino-mk
38
37
#
43
42
#
44
43
#   $ ln -s ~/src/arduino.mk Makefile
45
44
#
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
 
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
49
54
# your ~/.profile by adding something like this:
50
55
#
51
56
#   export ARDUINODIR=~/somewhere/arduino-1.0
52
57
#
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:
 
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:
56
63
#
57
64
#   $ export BOARD=uno
58
65
#   $ make
75
82
#
76
83
# Here is a complete list of configuration parameters:
77
84
#
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.
 
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).
83
93
#
84
94
# 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.
 
95
#              looking for the avr build tools. This defaults to the system PATH
 
96
#              followed by subdirectories in ARDUINODIR if undefined.
87
97
#
88
98
# BOARD        Specify a target board type.  Run `make boards` to see available
89
99
#              board types.
90
100
#
91
 
# LIBRARIES    A list of arduino libraries to build and include.  This is set
 
101
# LIBRARIES    A list of Arduino libraries to build and include.  This is set
92
102
#              automatically if a .ino (or .pde) is found.
93
103
#
94
 
# SERIALDEV    The unix device name of the serial device that is the arduino.
 
104
# SERIALDEV    The unix device name of the serial device that is the Arduino.
95
105
#              If unspecified, an attempt is made to determine the name of a
96
 
#              connected arduino's serial device.
 
106
#              connected Arduino's serial device.
97
107
#
98
108
# SOURCES      A list of all source files of whatever language.  The language
99
109
#              type is determined by the file extension.  This is set
107
117
# when you run make:
108
118
#
109
119
# all          This is the default if no goal is specified.  It builds the
110
 
#              target and uploads it.
 
120
#              target.
111
121
#
112
122
# target       Builds the target.
113
123
#
114
 
# upload       Uploads the last built target to an attached arduino.
 
124
# upload       Uploads the last built target to an attached Arduino.
115
125
#
116
126
# clean        Deletes files created during the build.
117
127
#
119
129
#              BOARD environment variable appropriately.
120
130
#
121
131
# monitor      Start `screen` on the serial device.  This is meant to be an
122
 
#              equivalent to the arduino serial monitor.
 
132
#              equivalent to the Arduino serial monitor.
 
133
#
 
134
# size         Displays size information about the bulit target.
123
135
#
124
136
# <file>       Builds the specified file, either an object file or the target,
125
137
#              from those that that would be built for the project.
128
140
 
129
141
# default arduino software directory, check software exists
130
142
ifndef ARDUINODIR
131
 
ARDUINODIR := $(wildcard ~/opt/arduino)
 
143
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))
132
144
endif
133
 
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
 
145
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
134
146
$(error ARDUINODIR is not set correctly; arduino software not found)
135
147
endif
136
148
 
147
159
# auto mode?
148
160
INOFILE := $(wildcard *.ino *.pde)
149
161
ifdef INOFILE
150
 
ifneq ($(words $(INOFILE)), 1)
 
162
ifneq "$(words $(INOFILE))" "1"
151
163
$(error There is more than one .pde or .ino file in this directory!)
152
164
endif
153
165
 
159
171
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
160
172
 
161
173
# automatically determine included libraries
162
 
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
163
 
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
 
174
LIBRARIES := $(filter $(notdir $(wildcard $(ARDUINODIR)/libraries/*)), \
164
175
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
165
176
 
166
177
endif
167
178
 
168
 
# no board? oh dear...
169
 
ifndef BOARD
170
 
ifneq "$(MAKECMDGOALS)" "boards"
171
 
ifneq "$(MAKECMDGOALS)" "clean"
172
 
$(error BOARD is unset.  Type 'make boards' to see possible values)
173
 
endif
174
 
endif
175
 
endif
176
 
 
177
179
# no serial device? make a poor attempt to detect an arduino
178
 
ifeq ($(SERIALDEV), )
179
 
SERIALDEV := $(firstword $(wildcard /dev/ttyACM? /dev/ttyUSB?))
 
180
SERIALDEVGUESS := 0
 
181
ifeq "$(SERIALDEV)" ""
 
182
SERIALDEV := $(firstword $(wildcard \
 
183
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))
 
184
SERIALDEVGUESS := 1
180
185
endif
181
186
 
182
187
# software
187
192
AR := $(call findsoftware,avr-ar)
188
193
OBJCOPY := $(call findsoftware,avr-objcopy)
189
194
AVRDUDE := $(call findsoftware,avrdude)
 
195
AVRSIZE := $(call findsoftware,avr-size)
190
196
 
191
197
# files
192
 
TARGET := $(if $(TARGET), $(TARGET), a.out)
 
198
TARGET := $(if $(TARGET),$(TARGET),a.out)
193
199
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
194
 
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
195
 
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
196
 
ARDUINOLIB := _arduino.a
197
 
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
198
 
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
199
 
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
200
 
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
201
 
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
202
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
203
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
 
200
DEPFILES := $(patsubst %, .dep/%.dep, $(SOURCES))
 
201
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
 
202
ARDUINOLIB := .lib/arduino.a
 
203
ARDUINOLIBLIBSDIR := $(ARDUINODIR)/libraries
 
204
ARDUINOLIBLIBSPATH := $(foreach lib, $(LIBRARIES), \
 
205
        $(ARDUINODIR)/libraries/$(lib)/ $(ARDUINODIR)/libraries/$(lib)/utility/ )
 
206
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(ARDUINOLIBLIBSPATH), \
 
207
        $(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, *.c *.cpp))))
 
208
ifeq "$(AVRDUDECONF)" ""
 
209
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
 
210
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
 
211
else
204
212
AVRDUDECONF := $(wildcard $(AVRDUDE).conf)
 
213
endif
 
214
endif
 
215
 
 
216
# no board?
 
217
ifndef BOARD
 
218
ifneq "$(MAKECMDGOALS)" "boards"
 
219
ifneq "$(MAKECMDGOALS)" "clean"
 
220
$(error BOARD is unset.  Type 'make boards' to see possible values)
 
221
endif
 
222
endif
 
223
endif
205
224
 
206
225
# obtain board parameters from the arduino boards.txt file
207
226
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
216
235
BOARD_UPLOAD_PROTOCOL := \
217
236
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
218
237
 
 
238
# invalid board?
 
239
ifeq "$(BOARD_BUILD_MCU)" ""
 
240
ifneq "$(MAKECMDGOALS)" "boards"
 
241
ifneq "$(MAKECMDGOALS)" "clean"
 
242
$(error BOARD is invalid.  Type 'make boards' to see possible values)
 
243
endif
 
244
endif
 
245
endif
 
246
 
219
247
# flags
220
248
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
221
249
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
222
250
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
223
251
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
224
 
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
 
252
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOCOREDIR)
225
253
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
226
254
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
227
255
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
 
256
CPPDEPFLAGS = -MMD -MP -MF .dep/$<.dep
 
257
CPPINOFLAGS := -x c++ -include $(ARDUINOCOREDIR)/Arduino.h
228
258
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
229
259
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
230
260
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
231
261
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
232
262
 
 
263
# figure out which arg to use with stty
 
264
STTYFARG := $(shell stty --help > /dev/null 2>&1 && echo -F || echo -f)
 
265
 
 
266
# include dependencies
 
267
ifneq "$(MAKECMDGOALS)" "clean"
 
268
-include $(DEPFILES)
 
269
endif
 
270
 
233
271
# default rule
234
272
.DEFAULT_GOAL := all
235
273
 
236
274
#_______________________________________________________________________________
237
275
#                                                                          RULES
238
276
 
239
 
.PHONY: all target upload clean boards monitor
 
277
.PHONY: all target upload clean boards monitor size
240
278
 
241
 
all: target upload
 
279
all: target
242
280
 
243
281
target: $(TARGET).hex
244
282
 
245
 
upload:
 
283
upload: target
246
284
        @echo "\nUploading to board..."
247
285
        @test -n "$(SERIALDEV)" || { \
248
286
                echo "error: SERIALDEV could not be determined automatically." >&2; \
249
287
                exit 1; }
250
 
        stty -F $(SERIALDEV) hupcl
 
288
        @test 0 -eq $(SERIALDEVGUESS) || { \
 
289
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
 
290
                echo; }
 
291
        stty $(STTYFARG) $(SERIALDEV) hupcl
251
292
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
252
293
 
253
294
clean:
254
295
        rm -f $(OBJECTS)
255
296
        rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
256
 
        rm -rf $(ARDUINOLIBTMP)
 
297
        rm -rf .lib .dep
257
298
 
258
299
boards:
259
300
        @echo Available values for BOARD:
260
 
        @sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
261
 
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
 
301
        @sed -nEe '/^#/d; /^[^.]+\.name=/p' $(BOARDS_FILE) | \
 
302
                sed -Ee 's/([^.]+)\.name=(.*)/\1            \2/' \
 
303
                        -e 's/(.{12}) *(.*)/\1 \2/'
262
304
 
263
305
monitor:
264
306
        @test -n "$(SERIALDEV)" || { \
267
309
        @test -n `which screen` || { \
268
310
                echo "error: can't find GNU screen, you might need to install it." >&2 \
269
311
                ecit 1; }
 
312
        @test 0 -eq $(SERIALDEVGUESS) || { \
 
313
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
 
314
                echo; }
270
315
        screen $(SERIALDEV)
271
316
 
 
317
size: $(TARGET).elf
 
318
        echo && $(AVRSIZE) --format=avr --mcu=$(BOARD_BUILD_MCU) $(TARGET).elf
 
319
 
272
320
# building the target
273
321
 
274
322
$(TARGET).hex: $(TARGET).elf
279
327
$(TARGET).elf: $(ARDUINOLIB) $(OBJECTS)
280
328
        $(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -o $@
281
329
 
 
330
%.o: %.c
 
331
        mkdir -p .dep/$(dir $<)
 
332
        $(COMPILE.c) $(CPPDEPFLAGS) -o $@ $<
 
333
 
 
334
%.o: %.cpp
 
335
        mkdir -p .dep/$(dir $<)
 
336
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
 
337
 
 
338
%.o: %.cc
 
339
        mkdir -p .dep/$(dir $<)
 
340
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
 
341
 
 
342
%.o: %.C
 
343
        mkdir -p .dep/$(dir $<)
 
344
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
 
345
 
282
346
%.o: %.ino
283
 
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
 
347
        mkdir -p .dep/$(dir $<)
 
348
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
284
349
 
285
350
%.o: %.pde
286
 
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
 
351
        mkdir -p .dep/$(dir $<)
 
352
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ -x c++ -include $(ARDUINOCOREDIR)/Arduino.h $<
287
353
 
288
354
# building the arduino library
289
355
 
290
356
$(ARDUINOLIB): $(ARDUINOLIBOBJS)
291
357
        $(AR) rcs $@ $?
292
 
        rm -rf $(ARDUINOLIBTMP)
293
 
 
294
 
.INTERMEDIATE: $(ARDUINOLIBOBJS)
295
 
 
296
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.c
297
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
298
 
        $(COMPILE.c) -o $@ $<
299
 
 
300
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.cpp
301
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
302
 
        $(COMPILE.cpp) -o $@ $<
303
 
 
304
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.c
305
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
306
 
        $(COMPILE.c) -o $@ $<
307
 
 
308
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
309
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
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)
 
358
 
 
359
.lib/%.c.o: %.c
 
360
        mkdir -p $(dir $@)
 
361
        $(COMPILE.c) -o $@ $<
 
362
 
 
363
.lib/%.cpp.o: %.cpp
 
364
        mkdir -p $(dir $@)
 
365
        $(COMPILE.cpp) -o $@ $<
 
366
 
 
367
.lib/%.cc.o: %.cc
 
368
        mkdir -p $(dir $@)
 
369
        $(COMPILE.cpp) -o $@ $<
 
370
 
 
371
.lib/%.C.o: %.C
 
372
        mkdir -p $(dir $@)
318
373
        $(COMPILE.cpp) -o $@ $<