/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-02-16 14:27:17 UTC
  • Revision ID: edam@waxworlds.org-20120216142717-ede6uok4fc9vw8em
updated NEWS

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