/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-29 13:52:05 UTC
  • Revision ID: edam@waxworlds.org-20111229135205-ppyojdxqty9sdikj
initial commit

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