/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
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 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.
36
 
#
37
 
#   http://ed.am/dev/make/arduino-mk
38
 
#
39
 
# This makefile can be used as a drop-in replacement for the Arduino IDE's
40
 
# build system.  To use it, save arduino.mk somewhere (I keep mine at
41
 
# ~/src/arduino.mk) and create a symlink to it in your project directory named
42
 
# "Makefile".  For example:
43
 
#
44
 
#   $ ln -s ~/src/arduino.mk Makefile
45
 
#
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
49
 
# your ~/.profile by adding something like this:
50
 
#
51
 
#   export ARDUINODIR=~/somewhere/arduino-1.0
52
 
#
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:
56
 
#
57
 
#   $ export BOARD=uno
58
 
#   $ make
59
 
#
60
 
# You may also need to set SERIALDEV if it is not detected correctly.
61
 
#
62
 
# The presence of a .ino (or .pde) file causes the arduino.mk to automatically
63
 
# determine values for SOURCES, TARGET and LIBRARIES.  Any .c, .cc and .cpp
64
 
# files in the project directory (or any "util" or "utility" subdirectories)
65
 
# are automatically included in the build and are scanned for Arduino libraries
66
 
# that have been #included. Note, there can only be one .ino (or .pde) file.
67
 
#
68
 
# Alternatively, if you want to manually specify build variables, create a
69
 
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
70
 
# (There is no need to define TARGET).  Here is an example Makefile:
71
 
#
72
 
#   SOURCES := main.cc other.cc
73
 
#   LIBRARIES := EEPROM
74
 
#   include ~/src/arduino.mk
75
 
#
76
 
# Here is a complete list of configuration parameters:
77
 
#
78
 
# ARDUINODIR   The path where you have installed/unpacked the arduino software
79
 
#              (from http://arduino.cc/)
80
 
#
81
 
# BOARD        Specify a target board type.  Run `make boards` to see available
82
 
#              board types.
83
 
#
84
 
# SERIALDEV    The unix device name of the serial device that is the arduino.
85
 
#              If unspecified, an attempt is made to determine the name of a
86
 
#              connected arduino's serial device.
87
 
#
88
 
# TARGET       The name of the target file.  This is set automatically if a
89
 
#              .ino (or .pde) is found, but it is not necessary to set it
90
 
#              otherwise.
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
 
#
99
 
# This makefile also defines the following goals for use on the command line
100
 
# when you run make:
101
 
#
102
 
# all          This is the default if no goal is specified.  It builds the
 
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
 
35
# can only really be considered a reference to it's use.
 
36
#
 
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
103
91
#              target and uploads it.
104
92
#
105
 
# target       Builds the target.
106
 
#
107
 
# upload       Uploads the last built target to an attached arduino.
108
 
#
109
 
# clean        Deletes files created during the build.
110
 
#
111
 
# boards       Display a list of available board names, so that you can set the
112
 
#              BOARD environment variable appropriately.
113
 
#
114
 
# monitor      Start `screen` on the serial device.  This is meant to be an
115
 
#              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.
116
98
#
117
99
# <file>       Builds the specified file, either an object file or the target,
118
100
#              from those that that would be built for the project.
 
101
#
119
102
#_______________________________________________________________________________
120
 
#
 
103
#                                                                       SETTINGS
121
104
 
122
105
# The full path to the arduino software, from arduino.cc
123
 
ifndef ARDUINODIR
124
 
ARDUINODIR := $(wildcard ~/opt/arduino)
125
 
endif
126
 
 
127
 
# check arduino software
128
 
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
129
 
$(error ARDUINODIR is not set correctly; arduino software not found)
130
 
endif
 
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
#
131
143
 
132
144
# auto mode?
133
145
INOFILE := $(wildcard *.ino *.pde)
134
146
ifdef INOFILE
135
147
ifneq ($(words $(INOFILE)), 1)
136
 
$(error There is more than one .pde or .ino file in this directory!)
 
148
$(error There is more than one .pde or .ino file in the directory!)
137
149
endif
138
150
TARGET := $(basename $(INOFILE))
139
151
SOURCES := $(INOFILE) \
146
158
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
147
159
endif
148
160
 
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
167
 
 
168
161
# files
169
162
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
170
163
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
171
 
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
172
164
ARDUINOLIB := _arduino.a
173
 
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
 
165
ARDUINOLIBTMP := _arduino.a.tmp
174
166
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
175
167
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
176
168
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
177
169
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
178
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
179
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
 
170
        $(wildcard $(addprefix $(ARDUINODIR)/libraries/$(lib)/, *.c *.cpp))))))
180
171
 
181
172
# obtain board parameters from the arduino boards.txt file
182
173
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
191
182
BOARD_UPLOAD_PROTOCOL := \
192
183
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
193
184
 
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)
 
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
208
193
 
209
194
# flags
210
195
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
211
 
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
212
 
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOVER)
213
 
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
 
196
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
 
197
CPPFLAGS += -I. -Iutility -I$(ARDUINOSRCDIR)
214
198
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
215
 
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
216
 
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
 
199
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/,$(LIBRARIES))
217
200
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
218
201
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
219
202
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
220
203
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
221
204
 
 
205
# checks
 
206
ifeq ($(TARGET),)
 
207
$(error No target defined!)
 
208
endif
 
209
 
222
210
# default rule
223
211
.DEFAULT_GOAL := all
224
212
 
225
213
#_______________________________________________________________________________
226
214
#                                                                          RULES
227
215
 
228
 
.PHONY: all target upload clean boards monitor
 
216
.PHONY: all target upload clean
229
217
 
230
218
all: target upload
231
219
 
232
220
target: $(TARGET).hex
233
221
 
234
222
upload:
235
 
        @echo "\nUploading to board..."
236
 
        @test -n "$(SERIALDEV)" || { \
237
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
238
 
                exit 1; }
239
223
        stty -F $(SERIALDEV) hupcl
240
224
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
241
225
 
244
228
        rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
245
229
        rm -rf $(ARDUINOLIBTMP)
246
230
 
247
 
boards:
248
 
        @echo Available values for BOARD:
249
 
        @sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
250
 
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
251
 
 
252
 
monitor:
253
 
        @test -n "$(SERIALDEV)" || { \
254
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
255
 
                exit 1; }
256
 
        @test -n `which screen` || { \
257
 
                echo "error: can't find GNU screen, you might need to install it." >&2 \
258
 
                ecit 1; }
259
 
        screen $(SERIALDEV)
260
 
 
261
231
# building the target
262
232
 
263
233
$(TARGET).hex: $(TARGET).elf
297
267
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
298
268
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
299
269
        $(COMPILE.cpp) -o $@ $<
300
 
 
301
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c
302
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
303
 
        $(COMPILE.c) -o $@ $<
304
 
 
305
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp
306
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
307
 
        $(COMPILE.cpp) -o $@ $<