/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: 2011-12-30 23:12:46 UTC
  • Revision ID: edam@waxworlds.org-20111230231246-zl8980dsrlfhcugf
added included-library autodetection and updated comments

Show diffs side-by-side

added added

removed removed

Lines of Context:
arduino.mk
2
2
#
3
3
#                         edam's arduino makefile
4
4
#_______________________________________________________________________________
5
 
#                                                                    version 0.3
 
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
21
21
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22
22
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23
23
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24
 
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25
 
# SOFTWARE.
 
24
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 
25
# THE SOFTWARE.
26
26
#
27
27
#_______________________________________________________________________________
28
28
#
29
29
#
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
 
30
# This is a general purpose makefile for use with Arduino (arduino.cc)
 
31
# hardware and software.  It works with the arduino-1.0 release and
 
32
# requires that to be downloaded separately.  It can be downloaded
 
33
# from http://ed.am/dev/make/arduino-makefile where you can also find
 
34
# more information and documentation on it's use.  The following text
34
35
# can only really be considered a reference to it's use.
35
36
#
36
 
#   http://ed.am/dev/make/arduino-mk
37
 
#
38
 
# This makefile can be used as a drop-in replacement for the Arduino IDE's
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
 
#
43
 
#   $ ln -s ~/src/arduino.mk Makefile
44
 
#
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
54
 
# your ~/.profile by adding something like this:
55
 
#
56
 
#   export ARDUINODIR=~/somewhere/arduino-1.0
57
 
#
58
 
# You will also need to set BOARD to the type of Arduino you're building for.
59
 
# You could set a default in your ~/.profile if you want, but it is suggested
60
 
# that you specify this at build time, especially if you work with different
61
 
# types of Arduino.  For example:
62
 
#
63
 
#   $ export BOARD=uno
64
 
#   $ make
65
 
#
66
 
# You may also need to set SERIALDEV if it is not detected correctly.
67
 
#
68
 
# The presence of a .ino (or .pde) file causes the arduino.mk to automatically
69
 
# determine values for SOURCES, TARGET and LIBRARIES.  Any .c, .cc and .cpp
70
 
# files in the project directory (or any "util" or "utility" subdirectories)
71
 
# are automatically included in the build and are scanned for Arduino libraries
72
 
# that have been #included. Note, there can only be one .ino (or .pde) file.
73
 
#
74
 
# Alternatively, if you want to manually specify build variables, create a
75
 
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
76
 
# (There is no need to define TARGET).  Here is an example Makefile:
77
 
#
78
 
#   SOURCES := main.cc other.cc
79
 
#   LIBRARIES := EEPROM
80
 
#   include ~/src/arduino.mk
81
 
#
82
 
# Here is a complete list of configuration parameters:
83
 
#
84
 
# ARDUINODIR   The path where the Arduino software is installed on your system.
85
 
#
86
 
# ARDUINOCONST The Arduino software version, as an integer, used to define the
87
 
#              ARDUINO version constant. This defaults to 100 if undefined.
88
 
#
89
 
# AVRDUDECONF  The avrdude.conf to use. If undefined, this defaults to a guess
90
 
#              based on where the avrdude in use is. If empty, no avrdude.conf
91
 
#              is passed to avrdude (to the system default is used).
92
 
#
93
 
# AVRTOOLSPATH A space-separated list of directories to search in order when
94
 
#              lookin for the avr build tools. This defaults to the system PATH
95
 
#              followed by subdirectories in ARDUINODIR if undefined.
96
 
#
97
 
# BOARD        Specify a target board type.  Run `make boards` to see available
98
 
#              board types.
99
 
#
100
 
# LIBRARIES    A list of Arduino libraries to build and include.  This is set
101
 
#              automatically if a .ino (or .pde) is found.
102
 
#
103
 
# SERIALDEV    The unix device name of the serial device that is the Arduino.
104
 
#              If unspecified, an attempt is made to determine the name of a
105
 
#              connected Arduino's serial device.
106
 
#
107
 
# SOURCES      A list of all source files of whatever language.  The language
108
 
#              type is determined by the file extension.  This is set
109
 
#              automatically if a .ino (or .pde) is found.
110
 
#
111
 
# TARGET       The name of the target file.  This is set automatically if a
112
 
#              .ino (or .pde) is found, but it is not necessary to set it
113
 
#              otherwise.
114
 
#
115
 
# This makefile also defines the following goals for use on the command line
116
 
# when you run make:
117
 
#
118
 
# all          This is the default if no goal is specified.  It builds the
 
37
# To use this makefile, put a file named "Makefile" in your project
 
38
# directory.  Add all your project's settings to your Makefile and
 
39
# then include this file from it. For example, your Makefile might
 
40
# look something like this:
 
41
#
 
42
#               BOARD = nano
 
43
#               SERIALDEV = /dev/ttyACM0
 
44
#       include ~/src/arduino.mk
 
45
#
 
46
# A complete list of all the settings you can use in your Makefile
 
47
# follows shortly. But it should be noted that there are two ways to
 
48
# use this file, an automatic mode and a manual mode.
 
49
#
 
50
# In automatic mode, you simply define a BOARD and SERIALDEV and then
 
51
# include this makefile.  The project directory must contain an .ino
 
52
# or .pde file, which will automatically be used, along with any other
 
53
# .c, .cc or .cpp files in the project directory.  When buliding, any
 
54
# arduino libraries that are #included in your code are detected and
 
55
# automatically linked against.  In this way, this makefile should act
 
56
# as a drop-in replacement for the Arduino IDE's build system.  You
 
57
# should be able to type "make" from the command line and achieve the
 
58
# same as building and uploading from the Arduino IDE.
 
59
#
 
60
# The alternative, manual mode, makes no assumptions.  If the
 
61
# directory doesn't contain an .ino or .pde file, you must also
 
62
# specify the SOURCES, TARGET and LIBRARIES manually in your Makefile.
 
63
# You will also be expected to provide a main() function, for example
 
64
# in main.cc, which may or may not duplicate the functionality of the
 
65
# default main() that calls init() and loop().
 
66
#
 
67
# Here is a list of all configuration parameters:
 
68
#
 
69
# BOARD        Specify a target board type.  These are defined in boards.txt,
 
70
#              which came with your arduino installation.  If unspecified,
 
71
#              a default is used.  (See below).
 
72
#
 
73
# SERIALDEV    The unix device of the device where the arduino can be found.
 
74
#              If unspecified, a default is used.  (See below).
 
75
#
 
76
# The following configuration parameters can be determined automatically:
 
77
#
 
78
# TARGET       The name of the target file.  This is typically the same name
 
79
#              as the project directory for an arduino project and, if
 
80
#              unspecified, that is used as a default.
 
81
#
 
82
# SOURCES      A list of all source files of whatever language. The language
 
83
#              type is determined by the file extension.
 
84
#
 
85
# LIBRARIES    A list of arduino libraries to include
 
86
#
 
87
# This general-purpose makefile also defines the following goals for use on the
 
88
# command line when you run make:
 
89
#
 
90
# all          This is the default if no goal is specified. It builds the
119
91
#              target and uploads it.
120
92
#
121
 
# target       Builds the target.
122
 
#
123
 
# upload       Uploads the last built target to an attached Arduino.
124
 
#
125
 
# clean        Deletes files created during the build.
126
 
#
127
 
# boards       Display a list of available board names, so that you can set the
128
 
#              BOARD environment variable appropriately.
129
 
#
130
 
# monitor      Start `screen` on the serial device.  This is meant to be an
131
 
#              equivalent to the Arduino serial monitor.
 
93
# target       Builds the target of your Makefile.
 
94
#
 
95
# upload       Uploads the target to an attached arduino.
 
96
#
 
97
# clean        Deletes temporary files.
132
98
#
133
99
# <file>       Builds the specified file, either an object file or the target,
134
100
#              from those that that would be built for the project.
135
 
#_______________________________________________________________________________
136
 
#
137
 
 
138
 
# default arduino software directory, check software exists
139
 
ifndef ARDUINODIR
140
 
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))
141
 
endif
142
 
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
143
 
$(error ARDUINODIR is not set correctly; arduino software not found)
144
 
endif
145
 
 
146
 
# default arduino version
147
 
ARDUINOCONST ?= 100
148
 
 
149
 
# default path for avr tools
150
 
ifndef AVRTOOLSPATH
151
 
AVRTOOLSPATH := $(subst :, , $(PATH))
152
 
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools
153
 
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
154
 
endif
 
101
#
 
102
#_______________________________________________________________________________
 
103
#                                                                       SETTINGS
 
104
 
 
105
# The full path to the arduino software, from arduino.cc
 
106
ARDUINODIR := $(wildcard ~/opt/arduino-1.0)
 
107
 
 
108
# The board name to build for and upload to. For a complete list of available
 
109
# boards, see hardware/arduino/boards.txt in your arduino software directory.
 
110
# Here is a list of available boards at time of writing:
 
111
#   uno         Arduino Uno
 
112
#   atmega328   Arduino Duemilanove w/ ATmega328
 
113
#   diecimila   Arduino Diecimila or Duemilanove w/ ATmega168
 
114
#   nano328     Arduino Nano w/ ATmega328
 
115
#   nano        Arduino Nano w/ ATmega168
 
116
#   mega2560    Arduino Mega 2560 or Mega ADK
 
117
#   mega        Arduino Mega (ATmega1280)
 
118
#   mini328     Arduino Mini w/ ATmega328
 
119
#   mini        Arduino Mini w/ ATmega168
 
120
#   fio         Arduino Fio
 
121
#   bt328       Arduino BT w/ ATmega328
 
122
#   bt          Arduino BT w/ ATmega168
 
123
#   lilypad328  LilyPad Arduino w/ ATmega328
 
124
#   lilypad     LilyPad Arduino w/ ATmega168
 
125
#   pro5v328    Arduino Pro or Pro Mini (5V, 16 MHz) w/ ATmega328
 
126
#   pro5v       Arduino Pro or Pro Mini (5V, 16 MHz) w/ ATmega168
 
127
#   pro328      Arduino Pro or Pro Mini (3.3V, 8 MHz) w/ ATmega328
 
128
#   pro         Arduino Pro or Pro Mini (3.3V, 8 MHz) w/ ATmega168
 
129
#   atmega168   Arduino NG or older w/ ATmega168
 
130
#   atmega8     Arduino NG or older w/ ATmega8
 
131
ifndef BOARD
 
132
BOARD := uno
 
133
endif
 
134
 
 
135
# The name of the serial device that the arduino is at. For example,
 
136
# /dev/ttyACM0 (Uno), or /dev/ttyUSB0 (Duemilanove)
 
137
ifndef SERIALDEV
 
138
SERIALDEV := /dev/ttyACM0
 
139
endif
 
140
 
 
141
#_______________________________________________________________________________
 
142
#
155
143
 
156
144
# auto mode?
157
145
INOFILE := $(wildcard *.ino *.pde)
158
146
ifdef INOFILE
159
 
ifneq "$(words $(INOFILE))" "1"
160
 
$(error There is more than one .pde or .ino file in this directory!)
 
147
ifneq ($(words $(INOFILE)), 1)
 
148
$(error There is more than one .pde or .ino file in the directory!)
161
149
endif
162
 
 
163
 
# automatically determine sources and targeet
164
150
TARGET := $(basename $(INOFILE))
165
151
SOURCES := $(INOFILE) \
166
152
        $(wildcard *.c *.cc *.cpp) \
167
153
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
168
154
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
169
 
 
170
155
# automatically determine included libraries
171
156
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
172
157
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
173
158
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
174
 
 
175
 
endif
176
 
 
177
 
# no serial device? make a poor attempt to detect an arduino
178
 
SERIALDEVGUESS := 0
179
 
ifeq "$(SERIALDEV)" ""
180
 
SERIALDEV := $(firstword $(wildcard \
181
 
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbmodem*))
182
 
SERIALDEVGUESS := 1
183
 
endif
184
 
 
185
 
# software
186
 
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
187
 
CC := $(call findsoftware,avr-gcc)
188
 
CXX := $(call findsoftware,avr-g++)
189
 
LD := $(call findsoftware,avr-ld)
190
 
AR := $(call findsoftware,avr-ar)
191
 
OBJCOPY := $(call findsoftware,avr-objcopy)
192
 
AVRDUDE := $(call findsoftware,avrdude)
 
159
endif
193
160
 
194
161
# files
195
 
TARGET := $(if $(TARGET),$(TARGET),a.out)
196
162
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
197
163
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
198
 
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
199
164
ARDUINOLIB := _arduino.a
200
 
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
 
165
ARDUINOLIBTMP := _arduino.a.tmp
201
166
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
202
167
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
203
168
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
204
169
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
205
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
206
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
207
 
ifeq "$(AVRDUDECONF)" ""
208
 
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
209
 
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
210
 
else
211
 
AVRDUDECONF := $(wildcard $(AVRDUDE).conf)
212
 
endif
213
 
endif
214
 
 
215
 
# no board?
216
 
ifndef BOARD
217
 
ifneq "$(MAKECMDGOALS)" "boards"
218
 
ifneq "$(MAKECMDGOALS)" "clean"
219
 
$(error BOARD is unset.  Type 'make boards' to see possible values)
220
 
endif
221
 
endif
222
 
endif
 
170
        $(wildcard $(addprefix $(ARDUINODIR)/libraries/$(lib)/, *.c *.cpp))))))
223
171
 
224
172
# obtain board parameters from the arduino boards.txt file
225
173
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
234
182
BOARD_UPLOAD_PROTOCOL := \
235
183
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
236
184
 
237
 
# invalid board?
238
 
ifeq "$(BOARD_BUILD_MCU)" ""
239
 
ifneq "$(MAKECMDGOALS)" "boards"
240
 
ifneq "$(MAKECMDGOALS)" "clean"
241
 
$(error BOARD is invalid.  Type 'make boards' to see possible values)
242
 
endif
243
 
endif
244
 
endif
 
185
# software
 
186
CC := avr-gcc
 
187
CXX := avr-g++
 
188
LD := avr-ld
 
189
AR := avr-ar
 
190
OBJCOPY := avr-objcopy
 
191
AVRDUDE := avrdude
 
192
#$(ARDUINODIR)/hardware/tools/avrdude
245
193
 
246
194
# flags
247
 
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
248
 
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
249
 
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
250
 
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
251
 
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
 
195
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
 
196
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
 
197
CPPFLAGS += -I. -Iutility -I$(ARDUINOSRCDIR)
252
198
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
253
 
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
254
 
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
255
 
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
 
199
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/,$(LIBRARIES))
 
200
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
256
201
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
257
202
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
258
 
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
 
203
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
259
204
 
260
 
# figure out which arg to use with stty
261
 
STTYFARG := $(shell stty --help > /dev/null 2>&1 && echo -F || echo -f)
 
205
# checks
 
206
ifeq ($(TARGET),)
 
207
$(error No target defined!)
 
208
endif
262
209
 
263
210
# default rule
264
211
.DEFAULT_GOAL := all
266
213
#_______________________________________________________________________________
267
214
#                                                                          RULES
268
215
 
269
 
.PHONY: all target upload clean boards monitor
 
216
.PHONY: all target upload clean
270
217
 
271
218
all: target upload
272
219
 
273
220
target: $(TARGET).hex
274
221
 
275
222
upload:
276
 
        @echo "\nUploading to board..."
277
 
        @test -n "$(SERIALDEV)" || { \
278
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
279
 
                exit 1; }
280
 
        @test 0 -eq $(SERIALDEVGUESS) || { \
281
 
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
282
 
                echo; }
283
 
        stty $(STTYFARG) $(SERIALDEV) hupcl
 
223
        stty -F $(SERIALDEV) hupcl
284
224
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
285
225
 
286
226
clean:
288
228
        rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
289
229
        rm -rf $(ARDUINOLIBTMP)
290
230
 
291
 
boards:
292
 
        @echo Available values for BOARD:
293
 
        @sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
294
 
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
295
 
 
296
 
monitor:
297
 
        @test -n "$(SERIALDEV)" || { \
298
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
299
 
                exit 1; }
300
 
        @test -n `which screen` || { \
301
 
                echo "error: can't find GNU screen, you might need to install it." >&2 \
302
 
                ecit 1; }
303
 
        @test 0 -eq $(SERIALDEVGUESS) || { \
304
 
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
305
 
                echo; }
306
 
        screen $(SERIALDEV)
307
 
 
308
231
# building the target
309
232
 
310
233
$(TARGET).hex: $(TARGET).elf
344
267
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
345
268
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
346
269
        $(COMPILE.cpp) -o $@ $<
347
 
 
348
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c
349
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
350
 
        $(COMPILE.c) -o $@ $<
351
 
 
352
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp
353
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
354
 
        $(COMPILE.cpp) -o $@ $<