/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: 2012-02-14 12:36:21 UTC
  • Revision ID: edam@waxworlds.org-20120214123621-a0r1rby8218wrnmq
updated NEWS

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
25
 
# THE SOFTWARE.
 
24
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 
25
# SOFTWARE.
26
26
#
27
27
#_______________________________________________________________________________
28
28
#
29
29
#
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).
73
 
#
74
 
# SERIALDEV    The unix device of the device where the arduino can be found.
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:
79
 
#
80
 
# all          This is the default if no goal is specified. It builds the
 
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
81
103
#              target and uploads it.
82
104
#
83
 
# target       Builds the target of your Makefile.
84
 
#
85
 
# upload       Uploads the target to an attached arduino.
86
 
#
87
 
# clean        Deletes temporary files.
 
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.
88
116
#
89
117
# <file>       Builds the specified file, either an object file or the target,
90
118
#              from those that that would be built for the project.
 
119
#_______________________________________________________________________________
91
120
#
92
 
#_______________________________________________________________________________
93
 
#                                                                       SETTINGS
94
121
 
95
122
# The full path to the arduino software, from arduino.cc
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
 
#
 
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
133
131
 
134
132
# auto mode?
135
133
INOFILE := $(wildcard *.ino *.pde)
136
134
ifdef INOFILE
137
135
ifneq ($(words $(INOFILE)), 1)
138
 
$(error There is more than one .pde or .ino file in the directory!)
 
136
$(error There is more than one .pde or .ino file in this directory!)
139
137
endif
140
138
TARGET := $(basename $(INOFILE))
141
139
SOURCES := $(INOFILE) \
142
 
        $(wildcard *.c *.cc *.cpp $(addprefix utility/, *.c *.cc *.cpp))
 
140
        $(wildcard *.c *.cc *.cpp) \
 
141
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
 
142
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
 
143
# automatically determine included libraries
 
144
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
 
145
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
 
146
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
 
147
endif
 
148
 
 
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
143
166
endif
144
167
 
145
168
# files
146
169
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
147
 
ifdef INOFILE
148
 
OBJECT += main.o
149
 
endif
150
170
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
 
171
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
151
172
ARDUINOLIB := _arduino.a
152
 
ARDUINOLIBTMP := _arduino.a.tmp
153
 
ARDUINOSOURCES := $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp))
154
 
ARDUINOOBJECTS := $(addsuffix .o, $(addprefix $(ARDUINOLIBTMP)/, $(basename \
155
 
        $(subst $(ARDUINOSRCDIR)/,,$(ARDUINOSOURCES)))))
 
173
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
 
174
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
 
175
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
 
176
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
 
177
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
 
178
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
 
179
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
156
180
 
157
 
# obtain parameters from the arduino boards.txt file
 
181
# obtain board parameters from the arduino boards.txt file
158
182
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
159
183
BOARD_BUILD_MCU := \
160
184
        $(shell sed -ne "s/$(BOARD).build.mcu=\(.*\)/\1/p" $(BOARDS_FILE))
167
191
BOARD_UPLOAD_PROTOCOL := \
168
192
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
169
193
 
170
 
# software
171
 
CC := avr-gcc
172
 
CXX := avr-g++
173
 
LD := avr-ld
174
 
AR := avr-ar
175
 
OBJCOPY := avr-objcopy
176
 
AVRDUDE := $(ARDUINODIR)/hardware/tools/avrdude
 
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)
177
208
 
178
209
# flags
179
210
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
180
 
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
181
 
CPPFLAGS += -I. -Iutility -I$(ARDUINOSRCDIR)
 
211
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
 
212
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
 
213
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOVER)
 
214
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
182
215
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
183
 
AVRDUDEFLAGS = -V -F -C $(ARDUINODIR)/hardware/tools/avrdude.conf
 
216
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
 
217
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
 
218
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
184
219
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
185
220
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
186
 
 
187
 
# checks
188
 
ifeq ($(TARGET),)
189
 
$(error No target defined!)
190
 
endif
 
221
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
191
222
 
192
223
# default rule
193
224
.DEFAULT_GOAL := all
195
226
#_______________________________________________________________________________
196
227
#                                                                          RULES
197
228
 
198
 
.PHONY: all target upload clean
 
229
.PHONY: all target upload clean boards monitor
199
230
 
200
231
all: target upload
201
232
 
202
 
target: $(TARGET).elf
 
233
target: $(TARGET).hex
203
234
 
204
235
upload:
 
236
        @echo "\nUploading to board..."
 
237
        @test -n "$(SERIALDEV)" || { \
 
238
                echo "error: SERIALDEV could not be determined automatically." >&2; \
 
239
                exit 1; }
205
240
        stty -F $(SERIALDEV) hupcl
206
 
        $(OBJCOPY) -O ihex -R .eeprom $(TARGET).elf $(TARGET).hex
207
 
        $(AVRDUDE) $(ARVDUDEFLAGS) -U flash:w:$(TARGET).hex
208
 
        rm $(TARGET).hex
 
241
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
209
242
 
210
243
clean:
211
244
        rm -f $(OBJECTS)
212
245
        rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
213
246
        rm -rf $(ARDUINOLIBTMP)
214
247
 
 
248
boards:
 
249
        @echo Available values for BOARD:
 
250
        @sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
 
251
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
 
252
 
 
253
monitor:
 
254
        @test -n "$(SERIALDEV)" || { \
 
255
                echo "error: SERIALDEV could not be determined automatically." >&2; \
 
256
                exit 1; }
 
257
        @test -n `which screen` || { \
 
258
                echo "error: can't find GNU screen, you might need to install it." >&2 \
 
259
                ecit 1; }
 
260
        screen $(SERIALDEV)
 
261
 
215
262
# building the target
216
263
 
 
264
$(TARGET).hex: $(TARGET).elf
 
265
        $(OBJCOPY) -O ihex -R .eeprom $< $@
 
266
 
 
267
.INTERMEDIATE: $(TARGET).elf
 
268
 
217
269
$(TARGET).elf: $(ARDUINOLIB) $(OBJECTS)
218
 
        $(CC) -Os -Wl,--gc-sections $(OBJECTS) $(ARDUINOLIB) -o $@
 
270
        $(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -o $@
219
271
 
220
272
%.o: %.ino
221
273
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
225
277
 
226
278
# building the arduino library
227
279
 
228
 
$(ARDUINOLIB): $(ARDUINOOBJECTS)
 
280
$(ARDUINOLIB): $(ARDUINOLIBOBJS)
229
281
        $(AR) rcs $@ $?
230
282
        rm -rf $(ARDUINOLIBTMP)
231
283
 
232
 
.INTERMEDIATE: $(ARDUINOOBJECTS)
 
284
.INTERMEDIATE: $(ARDUINOLIBOBJS)
233
285
 
234
286
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.c
235
287
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
238
290
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.cpp
239
291
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
240
292
        $(COMPILE.cpp) -o $@ $<
 
293
 
 
294
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.c
 
295
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
296
        $(COMPILE.c) -o $@ $<
 
297
 
 
298
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
 
299
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
300
        $(COMPILE.cpp) -o $@ $<
 
301
 
 
302
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c
 
303
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
304
        $(COMPILE.c) -o $@ $<
 
305
 
 
306
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp
 
307
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
308
        $(COMPILE.cpp) -o $@ $<