/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: Tim Marston
  • Date: 2012-11-30 16:27:32 UTC
  • Revision ID: tim@ed.am-20121130162732-24y7bv8ykr9pw4w1
cleaned up THANKS

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.2
 
5
#                                                                 version 0.5dev
6
6
#
7
 
# Copyright (c) 2011 Tim Marston <tim@ed.am>.
 
7
# Copyright (C) 2011, 2012 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
63
70
# determine values for SOURCES, TARGET and LIBRARIES.  Any .c, .cc and .cpp
64
71
# files in the project directory (or any "util" or "utility" subdirectories)
65
72
# 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.
 
73
# that have been #included.  Note, there can only be one .ino (or .pde) file.
67
74
#
68
75
# Alternatively, if you want to manually specify build variables, create a
69
76
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
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 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
 
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
86
92
#              is passed to avrdude (to the system default is used).
87
93
#
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.
 
94
# AVRDUDEFLAGS Specify any additional flags for avrdude.  The usual flags,
 
95
#              required to build the project, will be appended to this.
 
96
#
 
97
# AVRTOOLSPATH A space-separated list of directories that is searched in order
 
98
#              when looking for the avr build tools.  This defaults to PATH,
 
99
#              followed by subdirectories in ARDUINODIR.
91
100
#
92
101
# BOARD        Specify a target board type.  Run `make boards` to see available
93
102
#              board types.
94
103
#
95
 
# LIBRARIES    A list of arduino libraries to build and include.  This is set
 
104
# CPPFLAGS     Specify any additional flags for the compiler.  The usual flags,
 
105
#              required to build the project, will be appended to this.
 
106
#
 
107
# LINKFLAGS    Specify any additional flags for the linker.  The usual flags,
 
108
#              required to build the project, will be appended to this.
 
109
#
 
110
# LIBRARIES    A list of Arduino libraries to build and include.  This is set
96
111
#              automatically if a .ino (or .pde) is found.
97
112
#
98
 
# SERIALDEV    The unix device name of the serial device that is the arduino.
 
113
# LIBRARYPATH  A space-separated list of directories that is searched in order
 
114
#              when looking for Arduino libraries.  This defaults to "libs",
 
115
#              "libraries" and then the Arduino software's libraries directory.
 
116
#
 
117
# SERIALDEV    The unix device name of the serial device that is the Arduino.
99
118
#              If unspecified, an attempt is made to determine the name of a
100
 
#              connected arduino's serial device.
 
119
#              connected Arduino's serial device.
101
120
#
102
121
# SOURCES      A list of all source files of whatever language.  The language
103
122
#              type is determined by the file extension.  This is set
111
130
# when you run make:
112
131
#
113
132
# all          This is the default if no goal is specified.  It builds the
114
 
#              target and uploads it.
 
133
#              target.
115
134
#
116
135
# target       Builds the target.
117
136
#
118
 
# upload       Uploads the last built target to an attached arduino.
 
137
# upload       Uploads the last built target to an attached Arduino.
119
138
#
120
139
# clean        Deletes files created during the build.
121
140
#
123
142
#              BOARD environment variable appropriately.
124
143
#
125
144
# monitor      Start `screen` on the serial device.  This is meant to be an
126
 
#              equivalent to the arduino serial monitor.
 
145
#              equivalent to the Arduino serial monitor.
 
146
#
 
147
# size         Displays size information about the bulit target.
127
148
#
128
149
# <file>       Builds the specified file, either an object file or the target,
129
150
#              from those that that would be built for the project.
132
153
 
133
154
# default arduino software directory, check software exists
134
155
ifndef ARDUINODIR
135
 
ARDUINODIR := $(wildcard ~/opt/arduino)
 
156
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))
136
157
endif
137
158
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
138
159
$(error ARDUINODIR is not set correctly; arduino software not found)
148
169
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
149
170
endif
150
171
 
 
172
# default path to find libraries
 
173
LIBRARYPATH ?= libraries libs $(ARDUINODIR)/libraries
 
174
 
151
175
# auto mode?
152
176
INOFILE := $(wildcard *.ino *.pde)
153
177
ifdef INOFILE
158
182
# automatically determine sources and targeet
159
183
TARGET := $(basename $(INOFILE))
160
184
SOURCES := $(INOFILE) \
161
 
        $(wildcard *.c *.cc *.cpp) \
162
 
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
163
 
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
 
185
        $(wildcard *.c *.cc *.cpp *.C) \
 
186
        $(wildcard $(addprefix util/, *.c *.cc *.cpp *.C)) \
 
187
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp *.C))
164
188
 
165
189
# automatically determine included libraries
166
 
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
167
 
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
 
190
LIBRARIES := $(filter $(notdir $(wildcard $(addsuffix /*, $(LIBRARYPATH)))), \
168
191
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
169
192
 
170
193
endif
173
196
SERIALDEVGUESS := 0
174
197
ifeq "$(SERIALDEV)" ""
175
198
SERIALDEV := $(firstword $(wildcard \
176
 
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbmodem*))
 
199
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))
177
200
SERIALDEVGUESS := 1
178
201
endif
179
202
 
185
208
AR := $(call findsoftware,avr-ar)
186
209
OBJCOPY := $(call findsoftware,avr-objcopy)
187
210
AVRDUDE := $(call findsoftware,avrdude)
 
211
AVRSIZE := $(call findsoftware,avr-size)
 
212
 
 
213
# directories
 
214
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
 
215
LIBRARYDIRS := $(foreach lib, $(LIBRARIES), \
 
216
        $(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARYPATH)))))
 
217
LIBRARYDIRS += $(addsuffix /utility, $(LIBRARYDIRS))
188
218
 
189
219
# files
190
220
TARGET := $(if $(TARGET),$(TARGET),a.out)
191
221
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
192
 
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
193
 
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
194
 
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)) ))))
 
222
DEPFILES := $(patsubst %, .dep/%.dep, $(SOURCES))
 
223
ARDUINOLIB := .lib/arduino.a
 
224
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(LIBRARYDIRS), \
 
225
        $(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, *.c *.cpp))))
 
226
 
 
227
# avrdude confifuration
202
228
ifeq "$(AVRDUDECONF)" ""
203
229
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
204
230
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
228
254
        $(shell sed -ne "s/$(BOARD).upload.speed=\(.*\)/\1/p" $(BOARDS_FILE))
229
255
BOARD_UPLOAD_PROTOCOL := \
230
256
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
 
257
BOARD_USB_VID := \
 
258
        $(shell sed -ne "s/$(BOARD).build.vid=\(.*\)/\1/p" $(BOARDS_FILE))
 
259
BOARD_USB_PID := \
 
260
        $(shell sed -ne "s/$(BOARD).build.pid=\(.*\)/\1/p" $(BOARDS_FILE))
231
261
 
232
262
# invalid board?
233
263
ifeq "$(BOARD_BUILD_MCU)" ""
239
269
endif
240
270
 
241
271
# flags
242
 
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
 
272
CPPFLAGS += -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
243
273
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
244
274
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
245
275
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
246
 
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
247
 
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
 
276
CPPFLAGS += -DUSB_VID=$(BOARD_USB_VID) -DUSB_PID=$(BOARD_USB_PID)
 
277
CPPFLAGS += -I. -Iutil -Iutility -I $(ARDUINOCOREDIR)
 
278
CPPFLAGS += -I $(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
 
279
CPPFLAGS += $(addprefix -I , $(LIBRARYDIRS))
 
280
CPPDEPFLAGS = -MMD -MP -MF .dep/$<.dep
 
281
CPPINOFLAGS := -x c++ -include $(ARDUINOCOREDIR)/Arduino.h
 
282
AVRDUDEFLAGS += $(addprefix -C , $(AVRDUDECONF)) -DV
251
283
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
252
284
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
253
 
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
254
 
 
255
 
# figure out which arg to use with stty
256
 
STTYFARG := $(shell stty --help > /dev/null 2>&1 && echo -F || echo -f)
 
285
LINKFLAGS += -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
 
286
 
 
287
# figure out which arg to use with stty (for OS X, GNU and busybox stty)
 
288
STTYFARG := $(shell stty --help 2>&1 | \
 
289
        grep -q 'illegal option' && echo -f || echo -F)
 
290
 
 
291
# include dependencies
 
292
ifneq "$(MAKECMDGOALS)" "clean"
 
293
-include $(DEPFILES)
 
294
endif
257
295
 
258
296
# default rule
259
297
.DEFAULT_GOAL := all
261
299
#_______________________________________________________________________________
262
300
#                                                                          RULES
263
301
 
264
 
.PHONY: all target upload clean boards monitor
 
302
.PHONY: all target upload clean boards monitor size
265
303
 
266
 
all: target upload
 
304
all: target
267
305
 
268
306
target: $(TARGET).hex
269
307
 
270
 
upload:
 
308
upload: target
271
309
        @echo "\nUploading to board..."
272
310
        @test -n "$(SERIALDEV)" || { \
273
311
                echo "error: SERIALDEV could not be determined automatically." >&2; \
281
319
clean:
282
320
        rm -f $(OBJECTS)
283
321
        rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
284
 
        rm -rf $(ARDUINOLIBTMP)
 
322
        rm -rf .lib .dep
285
323
 
286
324
boards:
287
325
        @echo Available values for BOARD:
288
 
        @sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
289
 
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
 
326
        @sed -nEe '/^#/d; /^[^.]+\.name=/p' $(BOARDS_FILE) | \
 
327
                sed -Ee 's/([^.]+)\.name=(.*)/\1            \2/' \
 
328
                        -e 's/(.{12}) *(.*)/\1 \2/'
290
329
 
291
330
monitor:
292
331
        @test -n "$(SERIALDEV)" || { \
294
333
                exit 1; }
295
334
        @test -n `which screen` || { \
296
335
                echo "error: can't find GNU screen, you might need to install it." >&2 \
297
 
                ecit 1; }
 
336
                exit 1; }
298
337
        @test 0 -eq $(SERIALDEVGUESS) || { \
299
338
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
300
339
                echo; }
301
340
        screen $(SERIALDEV)
302
341
 
 
342
size: $(TARGET).elf
 
343
        echo && $(AVRSIZE) --format=avr --mcu=$(BOARD_BUILD_MCU) $(TARGET).elf
 
344
 
303
345
# building the target
304
346
 
305
347
$(TARGET).hex: $(TARGET).elf
308
350
.INTERMEDIATE: $(TARGET).elf
309
351
 
310
352
$(TARGET).elf: $(ARDUINOLIB) $(OBJECTS)
311
 
        $(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -o $@
 
353
        $(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -lm -o $@
 
354
 
 
355
%.o: %.c
 
356
        mkdir -p .dep/$(dir $<)
 
357
        $(COMPILE.c) $(CPPDEPFLAGS) -o $@ $<
 
358
 
 
359
%.o: %.cpp
 
360
        mkdir -p .dep/$(dir $<)
 
361
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
 
362
 
 
363
%.o: %.cc
 
364
        mkdir -p .dep/$(dir $<)
 
365
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
 
366
 
 
367
%.o: %.C
 
368
        mkdir -p .dep/$(dir $<)
 
369
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
312
370
 
313
371
%.o: %.ino
314
 
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
 
372
        mkdir -p .dep/$(dir $<)
 
373
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
315
374
 
316
375
%.o: %.pde
317
 
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
 
376
        mkdir -p .dep/$(dir $<)
 
377
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
318
378
 
319
379
# building the arduino library
320
380
 
321
381
$(ARDUINOLIB): $(ARDUINOLIBOBJS)
322
382
        $(AR) rcs $@ $?
323
 
        rm -rf $(ARDUINOLIBTMP)
324
 
 
325
 
.INTERMEDIATE: $(ARDUINOLIBOBJS)
326
 
 
327
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.c
328
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
329
 
        $(COMPILE.c) -o $@ $<
330
 
 
331
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.cpp
332
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
333
 
        $(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)
 
383
 
 
384
.lib/%.c.o: %.c
 
385
        mkdir -p $(dir $@)
 
386
        $(COMPILE.c) -o $@ $<
 
387
 
 
388
.lib/%.cpp.o: %.cpp
 
389
        mkdir -p $(dir $@)
 
390
        $(COMPILE.cpp) -o $@ $<
 
391
 
 
392
.lib/%.cc.o: %.cc
 
393
        mkdir -p $(dir $@)
 
394
        $(COMPILE.cpp) -o $@ $<
 
395
 
 
396
.lib/%.C.o: %.C
 
397
        mkdir -p $(dir $@)
349
398
        $(COMPILE.cpp) -o $@ $<