/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: 2013-02-20 22:40:06 UTC
  • Revision ID: tim@ed.am-20130220224006-utw6bryf5vyo4ci2
added emacs formatting variables and updated TODO

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.6dev
 
5
#                                                                 version 0.5dev
6
6
#
7
 
# Copyright (C) 2011, 2012, 2013 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 and later software releases.  It
32
 
# should work GNU/Linux and OS X.  To download the latest version of this
33
 
# makefile visit the following website where you can also find documentation on
34
 
# it's use.  (The following text can only really be considered a reference.)
 
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.
35
35
#
36
36
#   http://ed.am/dev/make/arduino-mk
37
37
#
38
38
# This makefile can be used as a drop-in replacement for the Arduino IDE's
39
 
# build system.  To use it, just copy arduino.mk in to your project directory.
40
 
# Or, you could save it somewhere (I keep mine at ~/src/arduino.mk) and create
41
 
# a symlink to it in your project directory, named "Makefile".  For example:
 
39
# build system.  To use it, save arduino.mk somewhere (I keep mine at
 
40
# ~/src/arduino.mk) and create a symlink to it in your project directory named
 
41
# "Makefile".  For example:
42
42
#
43
43
#   $ ln -s ~/src/arduino.mk Makefile
44
44
#
45
 
# The Arduino software (version 1.0 or later) is required.  On GNU/Linux you
46
 
# can probably install the software from your package manager.  If you are
47
 
# using Debian (or a derivative), try `apt-get install arduino`.  Otherwise,
48
 
# you can download the Arduino software manually from http://arduino.cc/.  It
49
 
# is suggested that you install it at ~/opt/arduino (or /Applications on OS X)
50
 
# if you are unsure.
 
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.
51
49
#
52
50
# If you downloaded the Arduino software manually and unpacked it somewhere
53
 
# other than ~/opt/arduino (or /Applications), you will need to set up the
54
 
# ARDUINODIR environment variable to be the path where you unpacked it.  (If
55
 
# unset, ARDUINODIR defaults to some sensible places).  You could set this in
 
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
56
54
# your ~/.profile by adding something like this:
57
55
#
58
56
#   export ARDUINODIR=~/somewhere/arduino-1.0
59
57
#
60
 
# For each project, you will also need to set BOARD to the type of Arduino
61
 
# you're building for.  Type `make boards` for a list of acceptable values.
62
 
# 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:
63
63
#
64
64
#   $ export BOARD=uno
65
65
#   $ make
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 in
74
 
# a project directory and if you want to be compatible with the Arduino IDE, it
75
 
# should be called the same as the directory name.
 
73
# that have been #included.  Note, there can only be one .ino (or .pde) file.
76
74
#
77
75
# Alternatively, if you want to manually specify build variables, create a
78
76
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
79
 
# (There is no need to define TARGET).  You can also specify the BOARD here, if
80
 
# the project has a specific one.  Here is an example Makefile:
 
77
# (There is no need to define TARGET).  Here is an example Makefile:
81
78
#
82
79
#   SOURCES := main.cc other.cc
83
80
#   LIBRARIES := EEPROM
84
 
#   BOARD := pro5v
85
81
#   include ~/src/arduino.mk
86
82
#
87
83
# Here is a complete list of configuration parameters:
92
88
#              ARDUINO version constant.  This defaults to 100 if undefined.
93
89
#
94
90
# AVRDUDECONF  The avrdude.conf to use.  If undefined, this defaults to a guess
95
 
#              based on where avrdude is.  If set empty, no avrdude.conf is
96
 
#              passed to avrdude (so the system default is used).
 
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).
97
93
#
98
94
# AVRDUDEFLAGS Specify any additional flags for avrdude.  The usual flags,
99
95
#              required to build the project, will be appended to this.
116
112
#
117
113
# LIBRARYPATH  A space-separated list of directories that is searched in order
118
114
#              when looking for Arduino libraries.  This defaults to "libs",
119
 
#              "libraries" (in the project directory), then your sketchbook
120
 
#              "libraries" directory, then the Arduino libraries directory.
 
115
#              "libraries" and then the Arduino software's libraries directory.
121
116
#
122
 
# SERIALDEV    The POSIX device name of the serial device that is the Arduino.
123
 
#              If unspecified, an attempt is made to guess the name of a
124
 
#              connected Arduino's serial device, which may work in some cases.
 
117
# SERIALDEV    The unix device name of the serial device that is the Arduino.
 
118
#              If unspecified, an attempt is made to determine the name of a
 
119
#              connected Arduino's serial device.
125
120
#
126
121
# SOURCES      A list of all source files of whatever language.  The language
127
122
#              type is determined by the file extension.  This is set
139
134
#
140
135
# target       Builds the target.
141
136
#
142
 
# upload       Uploads the target (building it, as necessary) to an attached
143
 
#              Arduino.
 
137
# upload       Uploads the last built target to an attached Arduino.
144
138
#
145
139
# clean        Deletes files created during the build.
146
140
#
198
192
 
199
193
# obtain board parameters from the arduino boards.txt file
200
194
BOARDSFILE := $(ARDUINODIR)/hardware/arduino/boards.txt
201
 
readboardsparam = $(shell sed -ne "s/^$(BOARD).$(1)=\(.*\)/\1/p" $(BOARDSFILE))
 
195
readboardsparam = $(shell sed -ne "s/$(BOARD).$(1)=\(.*\)/\1/p" $(BOARDSFILE))
202
196
BOARD_BUILD_MCU := $(call readboardsparam,build.mcu)
203
197
BOARD_BUILD_FCPU := $(call readboardsparam,build.f_cpu)
204
198
BOARD_BUILD_VARIANT := $(call readboardsparam,build.variant)
205
 
BOARD_BUILD_CORE := $(call readboardsparam,build.core)
206
199
BOARD_UPLOAD_SPEED := $(call readboardsparam,upload.speed)
207
200
BOARD_UPLOAD_PROTOCOL := $(call readboardsparam,upload.protocol)
208
201
BOARD_USB_VID := $(call readboardsparam,build.vid)
239
232
$(error There is more than one .pde or .ino file in this directory!)
240
233
endif
241
234
 
242
 
# automatically determine sources and target
 
235
# automatically determine sources and targeet
243
236
TARGET := $(basename $(INOFILE))
244
237
SOURCES := $(INOFILE) \
245
 
        $(wildcard *.c *.cc *.cpp *.C *.s *.S) \
246
 
        $(wildcard $(addprefix util/, *.c *.cc *.cpp *.C *.s *.S)) \
247
 
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp *.C *.s *.S))
248
 
 
249
 
# automatically determine library directories (to pull library sources in from)
250
 
# by matching included headers in poject sources to headers that exist in the
251
 
# roots of any library directories, giving priority to libraries in the order
252
 
# they're in LIBRARYPATH, and then to the alphabetically-greater named library
253
 
# (this is a really stupid way of doing it, but it's how the IDE works -- if
254
 
# it's causing problems, you can override it by setting LIBRARIES manually)
255
 
INCLUDEDHEADERS := \
256
 
        $(shell sed -nre "s/^\s*\#\s*include\s*[<\"](\S+\.h)[>\"].*/\1/p" \
257
 
        $(SOURCES))
258
 
reverse = $(if $(1),$(call reverse,$(wordlist 2,$(words $(1)),$(1)))) \
259
 
        $(firstword $(1))
260
 
LIBRARYHEADERS := $(foreach dir, $(LIBRARYPATH), \
261
 
        $(call reverse, $(sort $(wildcard $(dir)/*))))
262
 
LIBRARYHEADERS := $(foreach dir, $(LIBRARYHEADERS), $(wildcard $(dir)/*.h))
263
 
LIBRARYDIRS := $(foreach hdr, $(INCLUDEDHEADERS), $(patsubst %/$(hdr), %, \
264
 
        $(firstword $(filter %/$(hdr), $(LIBRARYHEADERS)))))
265
 
 
266
 
endif
267
 
 
268
 
# if LIBRARIES is specified, use it
269
 
ifneq "$(LIBRARIES)" ""
270
 
LIBRARYDIRS := $(foreach lib, $(LIBRARIES), \
271
 
        $(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARYPATH)))))
 
238
        $(wildcard *.c *.cc *.cpp *.C) \
 
239
        $(wildcard $(addprefix util/, *.c *.cc *.cpp *.C)) \
 
240
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp *.C))
 
241
 
 
242
# automatically determine included libraries
 
243
LIBRARIES := $(filter $(notdir $(wildcard $(addsuffix /*, $(LIBRARYPATH)))), \
 
244
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
 
245
 
272
246
endif
273
247
 
274
248
# software
277
251
CXX := $(call findsoftware,avr-g++)
278
252
LD := $(call findsoftware,avr-ld)
279
253
AR := $(call findsoftware,avr-ar)
280
 
AS := $(call findsoftware,avr-as)
281
254
OBJCOPY := $(call findsoftware,avr-objcopy)
282
255
AVRDUDE := $(call findsoftware,avrdude)
283
256
AVRSIZE := $(call findsoftware,avr-size)
284
257
 
285
258
# directories
286
 
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/$(BOARD_BUILD_CORE)
 
259
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
 
260
LIBRARYDIRS := $(foreach lib, $(LIBRARIES), \
 
261
        $(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARYPATH)))))
287
262
LIBRARYDIRS += $(addsuffix /utility, $(LIBRARYDIRS))
288
263
 
289
264
# files
292
267
DEPFILES := $(patsubst %, .dep/%.dep, $(SOURCES))
293
268
ARDUINOLIB := .lib/arduino.a
294
269
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(LIBRARYDIRS), \
295
 
        $(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, \
296
 
                *.c *.cc *.cpp *.C *.s *.S))))
 
270
        $(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, *.c *.cpp))))
297
271
BOOTLOADERHEX := $(addprefix \
298
272
        $(ARDUINODIR)/hardware/arduino/bootloaders/$(BOARD_BOOTLOADER_PATH)/, \
299
273
        $(BOARD_BOOTLOADER_FILE))
319
293
CPPDEPFLAGS = -MMD -MP -MF .dep/$<.dep
320
294
CPPINOFLAGS := -x c++ -include $(ARDUINOCOREDIR)/Arduino.h
321
295
AVRDUDEFLAGS += $(addprefix -C , $(AVRDUDECONF)) -DV
322
 
AVRDUDEFLAGS += -p$(BOARD_BUILD_MCU) -P$(SERIALDEV) -c$(BOARD_UPLOAD_PROTOCOL)
323
 
AVRDUDEFLAGS += $(addprefix -b, $(BOARD_UPLOAD_SPEED))
 
296
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
 
297
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
324
298
LINKFLAGS += -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
325
299
 
326
300
# figure out which arg to use with stty (for OS X, GNU and busybox stty)
355
329
ifeq "$(BOARD_BOOTLOADER_PATH)" "caterina"
356
330
        stty $(STTYFARG) $(SERIALDEV) speed 1200
357
331
        sleep 1
358
 
else
 
332
endif
359
333
        stty $(STTYFARG) $(SERIALDEV) hupcl
360
 
endif
361
334
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
362
335
 
363
336
clean:
416
389
$(TARGET).elf: $(ARDUINOLIB) $(OBJECTS)
417
390
        $(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -lm -o $@
418
391
 
419
 
%.o: %.ino
420
 
        mkdir -p .dep/$(dir $<)
421
 
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
422
 
 
423
 
%.o: %.pde
424
 
        mkdir -p .dep/$(dir $<)
425
 
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
426
 
 
427
392
%.o: %.c
428
393
        mkdir -p .dep/$(dir $<)
429
394
        $(COMPILE.c) $(CPPDEPFLAGS) -o $@ $<
440
405
        mkdir -p .dep/$(dir $<)
441
406
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<
442
407
 
443
 
%.o: %.S
444
 
        mkdir -p .dep/$(dir $<)
445
 
        $(COMPILE.S) $(CPPDEPFLAGS) -o $@ $<
 
408
%.o: %.ino
 
409
        mkdir -p .dep/$(dir $<)
 
410
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
 
411
 
 
412
%.o: %.pde
 
413
        mkdir -p .dep/$(dir $<)
 
414
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
446
415
 
447
416
# building the arduino library
448
417
 
465
434
        mkdir -p $(dir $@)
466
435
        $(COMPILE.cpp) -o $@ $<
467
436
 
468
 
.lib/%.s.o: %.s
469
 
        mkdir -p $(dir $@)
470
 
        $(COMPILE.s) -o $@ $<
471
 
 
472
 
.lib/%.S.o: %.S
473
 
        mkdir -p $(dir $@)
474
 
        $(COMPILE.S) -o $@ $<
475
 
 
476
437
# Local Variables:
477
438
# mode: makefile
478
439
# tab-width: 4