/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-14 12:36:21 UTC
  • Revision ID: edam@waxworlds.org-20120214123621-a0r1rby8218wrnmq
updated NEWS

Show diffs side-by-side

added added

removed removed

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