/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-12-17 13:29:17 UTC
  • Revision ID: tim@ed.am-20121217132917-o69n7upetk4ggg9x
added support for the user's sketchbook libraries directory

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
#
3
3
#                         edam's Arduino makefile
4
4
#_______________________________________________________________________________
5
 
#                                                                 version 0.3dev
 
5
#                                                                 version 0.5dev
6
6
#
7
 
# Copyright (C) 2011, 1012 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
70
70
# determine values for SOURCES, TARGET and LIBRARIES.  Any .c, .cc and .cpp
71
71
# files in the project directory (or any "util" or "utility" subdirectories)
72
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.
 
73
# that have been #included.  Note, there can only be one .ino (or .pde) file.
74
74
#
75
75
# Alternatively, if you want to manually specify build variables, create a
76
76
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
85
85
# ARDUINODIR   The path where the Arduino software is installed on your system.
86
86
#
87
87
# ARDUINOCONST The Arduino software version, as an integer, used to define the
88
 
#              ARDUINO version constant. This defaults to 100 if undefined.
 
88
#              ARDUINO version constant.  This defaults to 100 if undefined.
89
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
 
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
92
#              is passed to avrdude (to the system default is used).
93
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.
 
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.
97
100
#
98
101
# BOARD        Specify a target board type.  Run `make boards` to see available
99
102
#              board types.
100
103
#
 
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
#
101
110
# LIBRARIES    A list of Arduino libraries to build and include.  This is set
102
111
#              automatically if a .ino (or .pde) is found.
103
112
#
 
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
#
104
117
# SERIALDEV    The unix device name of the serial device that is the Arduino.
105
118
#              If unspecified, an attempt is made to determine the name of a
106
119
#              connected Arduino's serial device.
117
130
# when you run make:
118
131
#
119
132
# all          This is the default if no goal is specified.  It builds the
120
 
#              target and uploads it.
 
133
#              target.
121
134
#
122
135
# target       Builds the target.
123
136
#
146
159
$(error ARDUINODIR is not set correctly; arduino software not found)
147
160
endif
148
161
 
 
162
# obtain preferences from the IDE's preferences.txt
 
163
PREFERENCES_FILE := $(wildcard $(HOME)/.arduino/preferences.txt)
 
164
ifneq "$(PREFERENCES_FILE)" ""
 
165
SKETCHBOOKDIR := \
 
166
        $(shell sed -ne "s/sketchbook.path=\(.*\)/\1/p" $(PREFERENCES_FILE))
 
167
endif
 
168
 
149
169
# default arduino version
150
170
ARDUINOCONST ?= 100
151
171
 
152
172
# default path for avr tools
153
 
ifndef AVRTOOLSPATH
154
 
AVRTOOLSPATH := $(subst :, , $(PATH))
155
 
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools
156
 
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
157
 
endif
 
173
AVRTOOLSPATH ?= $(subst :, , $(PATH)) $(ARDUINODIR)/hardware/tools \
 
174
        $(ARDUINODIR)/hardware/tools/avr/bin
 
175
 
 
176
# default path to find libraries
 
177
LIBRARYPATH ?= libraries libs $(SKETCHBOOKDIR)/libraries $(ARDUINODIR)/libraries
158
178
 
159
179
# auto mode?
160
180
INOFILE := $(wildcard *.ino *.pde)
166
186
# automatically determine sources and targeet
167
187
TARGET := $(basename $(INOFILE))
168
188
SOURCES := $(INOFILE) \
169
 
        $(wildcard *.c *.cc *.cpp) \
170
 
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
171
 
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
 
189
        $(wildcard *.c *.cc *.cpp *.C) \
 
190
        $(wildcard $(addprefix util/, *.c *.cc *.cpp *.C)) \
 
191
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp *.C))
172
192
 
173
193
# automatically determine included libraries
174
 
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
175
 
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
 
194
LIBRARIES := $(filter $(notdir $(wildcard $(addsuffix /*, $(LIBRARYPATH)))), \
176
195
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
177
196
 
178
197
endif
181
200
SERIALDEVGUESS := 0
182
201
ifeq "$(SERIALDEV)" ""
183
202
SERIALDEV := $(firstword $(wildcard \
184
 
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbmodem*))
 
203
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))
185
204
SERIALDEVGUESS := 1
186
205
endif
187
206
 
195
214
AVRDUDE := $(call findsoftware,avrdude)
196
215
AVRSIZE := $(call findsoftware,avr-size)
197
216
 
 
217
# directories
 
218
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
 
219
LIBRARYDIRS := $(foreach lib, $(LIBRARIES), \
 
220
        $(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARYPATH)))))
 
221
LIBRARYDIRS += $(addsuffix /utility, $(LIBRARYDIRS))
 
222
 
198
223
# files
199
224
TARGET := $(if $(TARGET),$(TARGET),a.out)
200
225
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
201
 
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
202
 
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
203
 
ARDUINOLIB := _arduino.a
204
 
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
205
 
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
206
 
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
207
 
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
208
 
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
209
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
210
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
 
226
DEPFILES := $(patsubst %, .dep/%.dep, $(SOURCES))
 
227
ARDUINOLIB := .lib/arduino.a
 
228
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(LIBRARYDIRS), \
 
229
        $(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, *.c *.cpp))))
 
230
 
 
231
# avrdude confifuration
211
232
ifeq "$(AVRDUDECONF)" ""
212
233
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
213
234
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
237
258
        $(shell sed -ne "s/$(BOARD).upload.speed=\(.*\)/\1/p" $(BOARDS_FILE))
238
259
BOARD_UPLOAD_PROTOCOL := \
239
260
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
 
261
BOARD_USB_VID := \
 
262
        $(shell sed -ne "s/$(BOARD).build.vid=\(.*\)/\1/p" $(BOARDS_FILE))
 
263
BOARD_USB_PID := \
 
264
        $(shell sed -ne "s/$(BOARD).build.pid=\(.*\)/\1/p" $(BOARDS_FILE))
 
265
BOARD_BOOTLOADER_PATH := \
 
266
        $(shell sed -ne "s/$(BOARD).bootloader.path=\(.*\)/\1/p" $(BOARDS_FILE))
240
267
 
241
268
# invalid board?
242
269
ifeq "$(BOARD_BUILD_MCU)" ""
248
275
endif
249
276
 
250
277
# flags
251
 
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
 
278
CPPFLAGS += -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
252
279
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
253
280
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
254
281
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
255
 
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
256
 
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
 
282
CPPFLAGS += -DUSB_VID=$(BOARD_USB_VID) -DUSB_PID=$(BOARD_USB_PID)
 
283
CPPFLAGS += -I. -Iutil -Iutility -I $(ARDUINOCOREDIR)
 
284
CPPFLAGS += -I $(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
 
285
CPPFLAGS += $(addprefix -I , $(LIBRARYDIRS))
 
286
CPPDEPFLAGS = -MMD -MP -MF .dep/$<.dep
 
287
CPPINOFLAGS := -x c++ -include $(ARDUINOCOREDIR)/Arduino.h
 
288
AVRDUDEFLAGS += $(addprefix -C , $(AVRDUDECONF)) -DV
260
289
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
261
290
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)
 
291
LINKFLAGS += -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
 
292
 
 
293
# figure out which arg to use with stty (for OS X, GNU and busybox stty)
 
294
STTYFARG := $(shell stty --help 2>&1 | \
 
295
        grep -q 'illegal option' && echo -f || echo -F)
 
296
 
 
297
# include dependencies
 
298
ifneq "$(MAKECMDGOALS)" "clean"
 
299
-include $(DEPFILES)
 
300
endif
266
301
 
267
302
# default rule
268
303
.DEFAULT_GOAL := all
272
307
 
273
308
.PHONY: all target upload clean boards monitor size
274
309
 
275
 
all: target upload
 
310
all: target
276
311
 
277
312
target: $(TARGET).hex
278
313
 
279
 
upload:
 
314
upload: target
280
315
        @echo "\nUploading to board..."
281
316
        @test -n "$(SERIALDEV)" || { \
282
317
                echo "error: SERIALDEV could not be determined automatically." >&2; \
284
319
        @test 0 -eq $(SERIALDEVGUESS) || { \
285
320
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
286
321
                echo; }
 
322
ifeq "$(BOARD_BOOTLOADER_PATH)" "caterina"
 
323
        stty $(STTYFARG) $(SERIALDEV) speed 1200
 
324
        sleep 1
 
325
endif
287
326
        stty $(STTYFARG) $(SERIALDEV) hupcl
288
327
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
289
328
 
290
329
clean:
291
330
        rm -f $(OBJECTS)
292
331
        rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
293
 
        rm -rf $(ARDUINOLIBTMP)
 
332
        rm -rf .lib .dep
294
333
 
295
334
boards:
296
335
        @echo Available values for BOARD:
297
 
        @sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
298
 
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
 
336
        @sed -nEe '/^#/d; /^[^.]+\.name=/p' $(BOARDS_FILE) | \
 
337
                sed -Ee 's/([^.]+)\.name=(.*)/\1            \2/' \
 
338
                        -e 's/(.{12}) *(.*)/\1 \2/'
299
339
 
300
340
monitor:
301
341
        @test -n "$(SERIALDEV)" || { \
303
343
                exit 1; }
304
344
        @test -n `which screen` || { \
305
345
                echo "error: can't find GNU screen, you might need to install it." >&2 \
306
 
                ecit 1; }
 
346
                exit 1; }
307
347
        @test 0 -eq $(SERIALDEVGUESS) || { \
308
348
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
309
349
                echo; }
320
360
.INTERMEDIATE: $(TARGET).elf
321
361
 
322
362
$(TARGET).elf: $(ARDUINOLIB) $(OBJECTS)
323
 
        $(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -o $@
 
363
        $(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -lm -o $@
 
364
 
 
365
%.o: %.c
 
366
        mkdir -p .dep/$(dir $<)
 
367
        $(COMPILE.c) $(CPPDEPFLAGS) -o $@ $<
 
368
 
 
369
%.o: %.cpp
 
370
        mkdir -p .dep/$(dir $<)
 
371
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
 
372
 
 
373
%.o: %.cc
 
374
        mkdir -p .dep/$(dir $<)
 
375
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
 
376
 
 
377
%.o: %.C
 
378
        mkdir -p .dep/$(dir $<)
 
379
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
324
380
 
325
381
%.o: %.ino
326
 
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
 
382
        mkdir -p .dep/$(dir $<)
 
383
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
327
384
 
328
385
%.o: %.pde
329
 
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
 
386
        mkdir -p .dep/$(dir $<)
 
387
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
330
388
 
331
389
# building the arduino library
332
390
 
333
391
$(ARDUINOLIB): $(ARDUINOLIBOBJS)
334
392
        $(AR) rcs $@ $?
335
 
        rm -rf $(ARDUINOLIBTMP)
336
 
 
337
 
.INTERMEDIATE: $(ARDUINOLIBOBJS)
338
 
 
339
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.c
340
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
341
 
        $(COMPILE.c) -o $@ $<
342
 
 
343
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.cpp
344
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
345
 
        $(COMPILE.cpp) -o $@ $<
346
 
 
347
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.c
348
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
349
 
        $(COMPILE.c) -o $@ $<
350
 
 
351
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
352
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
353
 
        $(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)
 
393
 
 
394
.lib/%.c.o: %.c
 
395
        mkdir -p $(dir $@)
 
396
        $(COMPILE.c) -o $@ $<
 
397
 
 
398
.lib/%.cpp.o: %.cpp
 
399
        mkdir -p $(dir $@)
 
400
        $(COMPILE.cpp) -o $@ $<
 
401
 
 
402
.lib/%.cc.o: %.cc
 
403
        mkdir -p $(dir $@)
 
404
        $(COMPILE.cpp) -o $@ $<
 
405
 
 
406
.lib/%.C.o: %.C
 
407
        mkdir -p $(dir $@)
361
408
        $(COMPILE.cpp) -o $@ $<