/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 21:37:46 UTC
  • Revision ID: edam@waxworlds.org-20111230213746-l3bd5co3j5fmg1ne
minor optimisations

Show diffs side-by-side

added added

removed removed

Lines of Context:
arduino.mk
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
32
 
# software to be downloaded separately (see http://arduino.cc/).  To
33
 
# download the latest version of this makefile, visit the following
34
 
# website, where you can also find more information and documentation
35
 
# on it's use.  The following text can only really be considered a
36
 
# reference to it's use.
37
 
#
38
 
#   http://ed.am/dev/make/arduino-makefile
39
 
#
40
 
# To install, it is suggested that you keep arduino.mk somewhere and
41
 
# either symlink to it or include it in your make files.  I keep mine
42
 
# at ~/src/arduino.mk.  You will need to alter the value of the
43
 
# ARDUINODIR variable (below) to be the path where you have unpacked
44
 
# the arduino software from arduino.cc.
45
 
#
46
 
# This makefile can be used as a drop-in replacement for the Arduino
47
 
# IDE's build system.  Simply create a symlink to it under the name
48
 
# "Makefile" and run make (remembering to specify an ARDUINODIR and
49
 
# BOARD, as described below).  You would create the symlink like like
50
 
# so:
51
 
#
52
 
#   $ ln -s ~/src/arduino.mk Makefile
53
 
#
54
 
# The presence of a .ino or .pde file causes the arduino.mk to
55
 
# atuomatically determine va;ues for SOURCES, TARGET and LIBRARIES.
56
 
# Any .c, .cc and .cpp files in the project directory (or a "util" or
57
 
# "utility" subdirectory) are automatically included in the build and
58
 
# are scanned for libraries that have been #included.
59
 
#
60
 
# Alternatively, if you want to manually specify build variables,
61
 
# create a Makefile that defines SOURCES and LIBRARARIES and then
62
 
# includes arduino.mk.  (There is no need to define TARGET).  You will
63
 
# also be expected to provide a main() function, for example in
64
 
# main.cc, which may or may not duplicate the functionality of the
65
 
# default main() that calls init() and loop().  Here is an example
66
 
# Makefile:
67
 
#
68
 
#   SOURCES := main.cc foo.cc
69
 
#   LIBRARIES := EEPROM
70
 
#   include ~/src/arduino.mk
71
 
#
72
 
# A complete list of all the settings you can use in your Makefile
73
 
# follows shortly.  It should be noted, however, that some variables
74
 
# are better specified in the environment (or on the command line)
75
 
# than in your Makefile.  Specifically, the ARDUINODIR, BOARD and, if
76
 
# it is not automatically detected, SERIALDEV.
77
 
#
78
 
# When running make, you might want to specify the board and path to
79
 
# your installation of the arduino software, like this:
80
 
#
81
 
#   $ export ARDUINODIR=~/opt/arduino-1.0
82
 
#   $ export BOARD=pro5v
83
 
#   $ make
84
 
#
85
 
# For a list of available board types, run `make boards`.
86
 
# 
87
 
# Here is a complete list of configuration parameters:
88
 
#
89
 
# ARDUINODIR   The path where you have installed/unpacked the arduino
90
 
#              software (from http://arduino.cc/)
91
 
#
92
 
# BOARD        Specify a target board type.
93
 
#
94
 
# SERIALDEV    The unix device of the device where the arduino can be
95
 
#              found.  If unspecified, an attempt is made to determine
96
 
#              the name of a connected arduino's serial device.
97
 
#
98
 
# TARGET       The name of the target file.  This is set automatically
99
 
#              if a .ino or .pde is found, but it is not neccesary to
100
 
#              set it otherwise.
101
 
#
102
 
# SOURCES      A list of all source files of whatever language.  The
103
 
#              language type is determined by the file extension.
104
 
#              This is set automatically if a .ino or .pde is found.
105
 
#
106
 
# LIBRARIES    A list of arduino libraries to build and include.  This
107
 
#              is set automatically if a .ino or .pde is found.
108
 
#
109
 
# This general-purpose makefile also defines the following goals for
110
 
# use on the command line when you run make:
111
 
#
112
 
# all          This is the default if no goal is specified. It builds
113
 
#              the target and uploads it.
 
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
# There are two ways to use this file, an automatic mode and a manual
 
38
# mode.  In automatic mode, you simply copy this makefile to your
 
39
# arduino project directory, rename it "Makefile" and type make.  The
 
40
# project directory is expected to contain an .ino or .pde file, which
 
41
# will automatically be used automatically, along with any other .c,
 
42
# .cc or .cpp files in the project directory and any subdirectory
 
43
# named "utility".  In this way, this makefile should act as a drop-in
 
44
# replacement for the Arduino IDE's build process and can build a
 
45
# project automatically from the files in a project directory.
 
46
#
 
47
# Alternatively, you can manually specify what files should be
 
48
# inclided in a build.  To use this makefile manually, you might be
 
49
# better to keep it somewhere and include it in your project's
 
50
# Makefile after having defined certain parameters that control the
 
51
# build.  As an example, consider the following Makefile:
 
52
#
 
53
#       TARGET = my_program
 
54
#       SOURCES = main.cc foo.cc
 
55
#               BOARD = nano
 
56
#               SERIALDEV = /dev/ttyACM0
 
57
#       include ~/src/arduino.mk
 
58
#
 
59
# In both manual and automatic modes, the standard Arduino main.cpp's
 
60
# main() is included, which expects to be able to call init() and
 
61
# loop() in your code.  The main difference is that, in manual mode,
 
62
# these would typically be placed in a .cc or .cpp file.
 
63
#
 
64
# When using manual mode, the following variables can be used:
 
65
#
 
66
# TARGET       The name of the target file.  This is typically the same name
 
67
#              as the project directory for an arduino project and, if
 
68
#              unspecified, that is used as a default.
 
69
#
 
70
# SOURCES      A list of all source files of whatever language. The language
 
71
#              type is determined by the file extension.
 
72
#
 
73
# BOARD        Specify a target board type.  These are defined in boards.txt,
 
74
#              which came with your arduino installation.  If unspecified,
 
75
#              a default is used.  (See below).
 
76
#
 
77
# SERIALDEV    The unix device of the device where the arduino can be found.
 
78
#              If unspecified, a default is used.  (See below).
 
79
#
 
80
# This general-purpose makefile also defines the following goals for use on the
 
81
# command line when you run make:
 
82
#
 
83
# all          This is the default if no goal is specified. It builds the
 
84
#              target and uploads it.
114
85
#
115
86
# target       Builds the target of your Makefile.
116
87
#
118
89
#
119
90
# clean        Deletes temporary files.
120
91
#
121
 
# <file>       Builds the specified file, either an object file or the
122
 
#              target, from those that that would be built for the
123
 
#              project.
124
 
#
125
 
# boards       This is not a real goal.  It just displays a list of
126
 
#              available board names, so that you can set the BOARD
127
 
#              environment variable appropriately.
128
 
#
129
 
# monitor      This is not a real goal.  It starts screen on the serial
130
 
#              device.  It is ment to be an equivelant to the arduino
131
 
#              serial monitor.
 
92
# <file>       Builds the specified file, either an object file or the target,
 
93
#              from those that that would be built for the project.
 
94
#
132
95
#_______________________________________________________________________________
133
 
#
 
96
#                                                                       SETTINGS
134
97
 
135
98
# The full path to the arduino software, from arduino.cc
136
 
ifndef ARDUINODIR
137
99
ARDUINODIR := $(wildcard ~/opt/arduino-1.0)
138
 
endif
139
 
 
140
 
# check arduino software
141
 
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
142
 
$(error ARDUINODIR is not set correctly; arduino software not found)
143
 
endif
 
100
 
 
101
# The board name to build for and upload to. For a complete list of available
 
102
# boards, see hardware/arduino/boards.txt in your arduino software directory.
 
103
# Here is a list of available boards at time of writing:
 
104
#   uno         Arduino Uno
 
105
#   atmega328   Arduino Duemilanove w/ ATmega328
 
106
#   diecimila   Arduino Diecimila or Duemilanove w/ ATmega168
 
107
#   nano328     Arduino Nano w/ ATmega328
 
108
#   nano        Arduino Nano w/ ATmega168
 
109
#   mega2560    Arduino Mega 2560 or Mega ADK
 
110
#   mega        Arduino Mega (ATmega1280)
 
111
#   mini328     Arduino Mini w/ ATmega328
 
112
#   mini        Arduino Mini w/ ATmega168
 
113
#   fio         Arduino Fio
 
114
#   bt328       Arduino BT w/ ATmega328
 
115
#   bt          Arduino BT w/ ATmega168
 
116
#   lilypad328  LilyPad Arduino w/ ATmega328
 
117
#   lilypad     LilyPad Arduino w/ ATmega168
 
118
#   pro5v328    Arduino Pro or Pro Mini (5V, 16 MHz) w/ ATmega328
 
119
#   pro5v       Arduino Pro or Pro Mini (5V, 16 MHz) w/ ATmega168
 
120
#   pro328      Arduino Pro or Pro Mini (3.3V, 8 MHz) w/ ATmega328
 
121
#   pro         Arduino Pro or Pro Mini (3.3V, 8 MHz) w/ ATmega168
 
122
#   atmega168   Arduino NG or older w/ ATmega168
 
123
#   atmega8     Arduino NG or older w/ ATmega8
 
124
ifndef BOARD
 
125
BOARD := nano
 
126
endif
 
127
 
 
128
# The name of the serial device that the arduino is at. For example,
 
129
# /dev/ttyACM0 (Uno), or /dev/ttyUSB0 (Duemilanove)
 
130
ifndef SERIALDEV
 
131
SERIALDEV := /dev/ttyACM0
 
132
endif
 
133
 
 
134
#_______________________________________________________________________________
 
135
#
144
136
 
145
137
# auto mode?
146
138
INOFILE := $(wildcard *.ino *.pde)
147
139
ifdef INOFILE
148
140
ifneq ($(words $(INOFILE)), 1)
149
 
$(error There is more than one .pde or .ino file in this directory!)
 
141
$(error There is more than one .pde or .ino file in the directory!)
150
142
endif
151
143
TARGET := $(basename $(INOFILE))
152
144
SOURCES := $(INOFILE) \
153
 
        $(wildcard *.c *.cc *.cpp) \
154
 
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
155
 
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
156
 
# automatically determine included libraries
157
 
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
158
 
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
159
 
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
160
 
endif
161
 
 
162
 
# no target? use default
163
 
ifndef TARGET
164
 
TARGET := a.out
165
 
endif
166
 
 
167
 
# no serial device? attempt to detect an arduino
168
 
ifndef SERIALDEV
169
 
SERIALDEV := $(firstword $(wildcard /dev/ttyACM? /dev/ttyUSB?))
170
 
endif
171
 
 
172
 
# no board? oh dear...
173
 
ifndef BOARD
174
 
ifneq "$(MAKECMDGOALS)" "boards"
175
 
ifneq "$(MAKECMDGOALS)" "clean"
176
 
$(error BOARD is unset.  Type 'make boards' to see possible values)
177
 
endif
178
 
endif
 
145
        $(wildcard *.c *.cc *.cpp $(addprefix utility/, *.c *.cc *.cpp))
179
146
endif
180
147
 
181
148
# files
182
149
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
 
150
ifdef INOFILE
 
151
OBJECT += main.o
 
152
endif
183
153
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
184
154
ARDUINOLIB := _arduino.a
185
155
ARDUINOLIBTMP := _arduino.a.tmp
186
 
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
187
 
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
188
 
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
189
 
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
190
 
        $(wildcard $(addprefix $(ARDUINODIR)/libraries/$(lib)/, *.c *.cpp))))))
 
156
ARDUINOSOURCES := $(wildcard $(ARDUINOSRCDIR)/*.c $(ARDUINOSRCDIR)/*.cpp)
 
157
ARDUINOOBJECTS := $(addsuffix .o, $(addprefix $(ARDUINOLIBTMP)/, $(basename \
 
158
        $(notdir $(ARDUINOSOURCES)))))
191
159
 
192
160
# obtain board parameters from the arduino boards.txt file
193
161
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
209
177
AR := avr-ar
210
178
OBJCOPY := avr-objcopy
211
179
AVRDUDE := avrdude
 
180
#$(ARDUINODIR)/hardware/tools/avrdude
212
181
 
213
182
# flags
214
183
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
215
184
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
216
 
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
 
185
CPPFLAGS += -I. -Iutility -I$(ARDUINOSRCDIR)
217
186
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
218
 
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
219
 
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
220
187
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
221
188
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
222
189
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
223
190
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
224
191
 
 
192
# checks
 
193
ifeq ($(TARGET),)
 
194
$(error No target defined!)
 
195
endif
 
196
 
225
197
# default rule
226
198
.DEFAULT_GOAL := all
227
199
 
228
200
#_______________________________________________________________________________
229
201
#                                                                          RULES
230
202
 
231
 
.PHONY: all target upload clean boards monitor
 
203
.PHONY: all target upload clean
232
204
 
233
205
all: target upload
234
206
 
243
215
        rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
244
216
        rm -rf $(ARDUINOLIBTMP)
245
217
 
246
 
boards:
247
 
        @echo Available values for BOARD:
248
 
        @sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
249
 
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
250
 
 
251
 
monitor:
252
 
        screen $(SERIALDEV)
253
 
 
254
218
# building the target
255
219
 
256
220
$(TARGET).hex: $(TARGET).elf
269
233
 
270
234
# building the arduino library
271
235
 
272
 
$(ARDUINOLIB): $(ARDUINOLIBOBJS)
 
236
$(ARDUINOLIB): $(ARDUINOOBJECTS)
273
237
        $(AR) rcs $@ $?
274
238
        rm -rf $(ARDUINOLIBTMP)
275
239
 
276
 
.INTERMEDIATE: $(ARDUINOLIBOBJS)
 
240
.INTERMEDIATE: $(ARDUINOOBJECTS)
277
241
 
278
242
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.c
279
243
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
282
246
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.cpp
283
247
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
284
248
        $(COMPILE.cpp) -o $@ $<
285
 
 
286
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.c
287
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
288
 
        $(COMPILE.c) -o $@ $<
289
 
 
290
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
291
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
292
 
        $(COMPILE.cpp) -o $@ $<