/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-11-30 15:13:27 UTC
  • Revision ID: tim@ed.am-20121130151327-scygxxvu0crec501
documented AVRDUDEFLAGS, CPPFLAGS, LINKFLAGS and LINBRARYPATH, cleaned up a
little bit, and fixed a tiny bug (called ecit, not exit, during an error)

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
#
131
144
# monitor      Start `screen` on the serial device.  This is meant to be an
132
145
#              equivalent to the Arduino serial monitor.
133
146
#
 
147
# size         Displays size information about the bulit target.
 
148
#
134
149
# <file>       Builds the specified file, either an object file or the target,
135
150
#              from those that that would be built for the project.
136
151
#_______________________________________________________________________________
154
169
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
155
170
endif
156
171
 
 
172
# default path to find libraries
 
173
LIBRARYPATH ?= libraries libs $(ARDUINODIR)/libraries
 
174
 
157
175
# auto mode?
158
176
INOFILE := $(wildcard *.ino *.pde)
159
177
ifdef INOFILE
164
182
# automatically determine sources and targeet
165
183
TARGET := $(basename $(INOFILE))
166
184
SOURCES := $(INOFILE) \
167
 
        $(wildcard *.c *.cc *.cpp) \
168
 
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
169
 
        $(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))
170
188
 
171
189
# automatically determine included libraries
172
 
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
173
 
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
 
190
LIBRARIES := $(filter $(notdir $(wildcard $(addsuffix /*, $(LIBRARYPATH)))), \
174
191
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
175
192
 
176
193
endif
179
196
SERIALDEVGUESS := 0
180
197
ifeq "$(SERIALDEV)" ""
181
198
SERIALDEV := $(firstword $(wildcard \
182
 
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbmodem*))
 
199
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))
183
200
SERIALDEVGUESS := 1
184
201
endif
185
202
 
191
208
AR := $(call findsoftware,avr-ar)
192
209
OBJCOPY := $(call findsoftware,avr-objcopy)
193
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))
194
218
 
195
219
# files
196
220
TARGET := $(if $(TARGET),$(TARGET),a.out)
197
221
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
198
 
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
199
 
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
200
 
ARDUINOLIB := _arduino.a
201
 
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
202
 
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
203
 
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
204
 
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
205
 
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
206
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
207
 
        $(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
208
228
ifeq "$(AVRDUDECONF)" ""
209
229
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
210
230
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
234
254
        $(shell sed -ne "s/$(BOARD).upload.speed=\(.*\)/\1/p" $(BOARDS_FILE))
235
255
BOARD_UPLOAD_PROTOCOL := \
236
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))
237
261
 
238
262
# invalid board?
239
263
ifeq "$(BOARD_BUILD_MCU)" ""
245
269
endif
246
270
 
247
271
# flags
248
 
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
 
272
CPPFLAGS += -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
249
273
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
250
274
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
251
275
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
252
 
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
253
 
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
254
 
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
255
 
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
256
 
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
257
283
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
258
284
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
259
 
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
260
 
 
261
 
# figure out which arg to use with stty
262
 
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
263
295
 
264
296
# default rule
265
297
.DEFAULT_GOAL := all
267
299
#_______________________________________________________________________________
268
300
#                                                                          RULES
269
301
 
270
 
.PHONY: all target upload clean boards monitor
 
302
.PHONY: all target upload clean boards monitor size
271
303
 
272
 
all: target upload
 
304
all: target
273
305
 
274
306
target: $(TARGET).hex
275
307
 
276
 
upload:
 
308
upload: target
277
309
        @echo "\nUploading to board..."
278
310
        @test -n "$(SERIALDEV)" || { \
279
311
                echo "error: SERIALDEV could not be determined automatically." >&2; \
287
319
clean:
288
320
        rm -f $(OBJECTS)
289
321
        rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
290
 
        rm -rf $(ARDUINOLIBTMP)
 
322
        rm -rf .lib .dep
291
323
 
292
324
boards:
293
325
        @echo Available values for BOARD:
294
 
        @sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
295
 
                -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/'
296
329
 
297
330
monitor:
298
331
        @test -n "$(SERIALDEV)" || { \
300
333
                exit 1; }
301
334
        @test -n `which screen` || { \
302
335
                echo "error: can't find GNU screen, you might need to install it." >&2 \
303
 
                ecit 1; }
 
336
                exit 1; }
304
337
        @test 0 -eq $(SERIALDEVGUESS) || { \
305
338
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
306
339
                echo; }
307
340
        screen $(SERIALDEV)
308
341
 
 
342
size: $(TARGET).elf
 
343
        echo && $(AVRSIZE) --format=avr --mcu=$(BOARD_BUILD_MCU) $(TARGET).elf
 
344
 
309
345
# building the target
310
346
 
311
347
$(TARGET).hex: $(TARGET).elf
314
350
.INTERMEDIATE: $(TARGET).elf
315
351
 
316
352
$(TARGET).elf: $(ARDUINOLIB) $(OBJECTS)
317
 
        $(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 $@ $<
318
370
 
319
371
%.o: %.ino
320
 
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
 
372
        mkdir -p .dep/$(dir $<)
 
373
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
321
374
 
322
375
%.o: %.pde
323
 
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
 
376
        mkdir -p .dep/$(dir $<)
 
377
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
324
378
 
325
379
# building the arduino library
326
380
 
327
381
$(ARDUINOLIB): $(ARDUINOLIBOBJS)
328
382
        $(AR) rcs $@ $?
329
 
        rm -rf $(ARDUINOLIBTMP)
330
 
 
331
 
.INTERMEDIATE: $(ARDUINOLIBOBJS)
332
 
 
333
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.c
334
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
335
 
        $(COMPILE.c) -o $@ $<
336
 
 
337
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.cpp
338
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
339
 
        $(COMPILE.cpp) -o $@ $<
340
 
 
341
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.c
342
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
343
 
        $(COMPILE.c) -o $@ $<
344
 
 
345
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
346
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
347
 
        $(COMPILE.cpp) -o $@ $<
348
 
 
349
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c
350
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
351
 
        $(COMPILE.c) -o $@ $<
352
 
 
353
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp
354
 
        @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 $@)
355
398
        $(COMPILE.cpp) -o $@ $<