/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-16 14:27:17 UTC
  • Revision ID: edam@waxworlds.org-20120216142717-ede6uok4fc9vw8em
updated NEWS

Show diffs side-by-side

added added

removed removed

arduino.mk
36
36
#
37
37
#   http://ed.am/dev/make/arduino-mk
38
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
39
# 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:
 
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:
49
43
#
50
44
#   $ ln -s ~/src/arduino.mk Makefile
51
45
#
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.
 
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.
57
67
#
58
68
# 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:
 
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:
64
71
#
65
 
#   SOURCES := main.cc foo.cc
 
72
#   SOURCES := main.cc other.cc
66
73
#   LIBRARIES := EEPROM
67
74
#   include ~/src/arduino.mk
68
75
#
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
76
# Here is a complete list of configuration parameters:
85
77
#
86
78
# ARDUINODIR   The path where you have installed/unpacked the arduino software
87
79
#              (from http://arduino.cc/)
88
80
#
89
 
# BOARD        Specify a target board type.
90
 
#
91
 
# SERIALDEV    The unix device of the device where the arduino can be found.
 
81
# ARDUINOCONST The arduino software version, as an integer, used to define the
 
82
#              ARDUINO version constant. This defaults to 100 if undefined.
 
83
#
 
84
# AVRDUDECONF  The avrdude.conf to use. If undefined, this defaults to a guess
 
85
#              based on where the avrdude in use is. If empty, no avrdude.conf
 
86
#              is passed to avrdude (to the system default is used).
 
87
#
 
88
# AVRTOOLSPATH A space-separated list of directories to search in order when
 
89
#              lookin for the avr build tools. This defaults to the system PATH
 
90
#              followed by subdirectories in ARDUINODIR if undefined.
 
91
#
 
92
# BOARD        Specify a target board type.  Run `make boards` to see available
 
93
#              board types.
 
94
#
 
95
# LIBRARIES    A list of arduino libraries to build and include.  This is set
 
96
#              automatically if a .ino (or .pde) is found.
 
97
#
 
98
# SERIALDEV    The unix device name of the serial device that is the arduino.
92
99
#              If unspecified, an attempt is made to determine the name of a
93
100
#              connected arduino's serial device.
94
101
#
 
102
# SOURCES      A list of all source files of whatever language.  The language
 
103
#              type is determined by the file extension.  This is set
 
104
#              automatically if a .ino (or .pde) is found.
 
105
#
95
106
# 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
 
107
#              .ino (or .pde) is found, but it is not necessary to set it
97
108
#              otherwise.
98
109
#
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:
108
 
#
109
 
# all          This is the default if no goal is specified. It builds the
 
110
# This makefile also defines the following goals for use on the command line
 
111
# when you run make:
 
112
#
 
113
# all          This is the default if no goal is specified.  It builds the
110
114
#              target and uploads it.
111
115
#
112
 
# target       Builds the target of your Makefile.
113
 
#
114
 
# upload       Uploads the target to an attached arduino.
115
 
#
116
 
# clean        Deletes temporary files.
 
116
# target       Builds the target.
 
117
#
 
118
# upload       Uploads the last built target to an attached arduino.
 
119
#
 
120
# clean        Deletes files created during the build.
117
121
#
118
122
# boards       Display a list of available board names, so that you can set the
119
123
#              BOARD environment variable appropriately.
120
124
#
121
 
# monitor      Start `screen` on the serial device.  It is ment to be an
122
 
#              equivelant to the arduino serial monitor.
 
125
# monitor      Start `screen` on the serial device.  This is meant to be an
 
126
#              equivalent to the arduino serial monitor.
123
127
#
124
128
# <file>       Builds the specified file, either an object file or the target,
125
129
#              from those that that would be built for the project.
126
130
#_______________________________________________________________________________
127
131
#
128
132
 
129
 
# The full path to the arduino software, from arduino.cc
 
133
# default arduino software directory, check software exists
130
134
ifndef ARDUINODIR
131
135
ARDUINODIR := $(wildcard ~/opt/arduino)
132
136
endif
133
 
 
134
 
# check arduino software
135
 
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
 
137
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
136
138
$(error ARDUINODIR is not set correctly; arduino software not found)
137
139
endif
138
140
 
 
141
# default arduino version
 
142
ARDUINOCONST ?= 100
 
143
 
 
144
# default path for avr tools
 
145
ifndef AVRTOOLSPATH
 
146
AVRTOOLSPATH := $(subst :, , $(PATH))
 
147
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools
 
148
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
 
149
endif
 
150
 
139
151
# auto mode?
140
152
INOFILE := $(wildcard *.ino *.pde)
141
153
ifdef INOFILE
142
 
ifneq ($(words $(INOFILE)), 1)
 
154
ifneq "$(words $(INOFILE))" "1"
143
155
$(error There is more than one .pde or .ino file in this directory!)
144
156
endif
 
157
 
 
158
# automatically determine sources and targeet
145
159
TARGET := $(basename $(INOFILE))
146
160
SOURCES := $(INOFILE) \
147
161
        $(wildcard *.c *.cc *.cpp) \
148
162
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
149
163
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
 
164
 
150
165
# automatically determine included libraries
151
166
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
152
167
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
153
168
        $(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
173
 
endif
 
169
 
 
170
endif
 
171
 
 
172
# no serial device? make a poor attempt to detect an arduino
 
173
SERIALDEVGUESS := 0
 
174
ifeq "$(SERIALDEV)" ""
 
175
SERIALDEV := $(firstword $(wildcard \
 
176
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbmodem*))
 
177
SERIALDEVGUESS := 1
 
178
endif
 
179
 
 
180
# software
 
181
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
 
182
CC := $(call findsoftware,avr-gcc)
 
183
CXX := $(call findsoftware,avr-g++)
 
184
LD := $(call findsoftware,avr-ld)
 
185
AR := $(call findsoftware,avr-ar)
 
186
OBJCOPY := $(call findsoftware,avr-objcopy)
 
187
AVRDUDE := $(call findsoftware,avrdude)
174
188
 
175
189
# files
 
190
TARGET := $(if $(TARGET),$(TARGET),a.out)
176
191
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
177
192
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
 
193
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
178
194
ARDUINOLIB := _arduino.a
179
 
ARDUINOLIBTMP := _arduino.a.tmp
 
195
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
180
196
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
181
197
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
182
198
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
183
199
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
184
 
        $(wildcard $(addprefix $(ARDUINODIR)/libraries/$(lib)/, *.c *.cpp))))))
 
200
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
 
201
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
 
202
ifeq "$(AVRDUDECONF)" ""
 
203
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
 
204
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
 
205
else
 
206
AVRDUDECONF := $(wildcard $(AVRDUDE).conf)
 
207
endif
 
208
endif
 
209
 
 
210
# no board?
 
211
ifndef BOARD
 
212
ifneq "$(MAKECMDGOALS)" "boards"
 
213
ifneq "$(MAKECMDGOALS)" "clean"
 
214
$(error BOARD is unset.  Type 'make boards' to see possible values)
 
215
endif
 
216
endif
 
217
endif
185
218
 
186
219
# obtain board parameters from the arduino boards.txt file
187
220
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
196
229
BOARD_UPLOAD_PROTOCOL := \
197
230
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
198
231
 
199
 
# software
200
 
CC := avr-gcc
201
 
CXX := avr-g++
202
 
LD := avr-ld
203
 
AR := avr-ar
204
 
OBJCOPY := avr-objcopy
205
 
AVRDUDE := avrdude
 
232
# invalid board?
 
233
ifeq "$(BOARD_BUILD_MCU)" ""
 
234
ifneq "$(MAKECMDGOALS)" "boards"
 
235
ifneq "$(MAKECMDGOALS)" "clean"
 
236
$(error BOARD is invalid.  Type 'make boards' to see possible values)
 
237
endif
 
238
endif
 
239
endif
206
240
 
207
241
# flags
208
 
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
209
 
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
 
242
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
 
243
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
 
244
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
 
245
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
210
246
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
211
247
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
212
248
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
213
249
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
214
 
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
 
250
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
215
251
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
216
252
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
217
 
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
 
253
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
 
254
 
 
255
# figure out which arg to use with stty
 
256
STTYFARG := $(shell stty --help > /dev/null 2>&1 && echo -F || echo -f)
218
257
 
219
258
# default rule
220
259
.DEFAULT_GOAL := all
229
268
target: $(TARGET).hex
230
269
 
231
270
upload:
232
 
        stty -F $(SERIALDEV) hupcl
 
271
        @echo "\nUploading to board..."
 
272
        @test -n "$(SERIALDEV)" || { \
 
273
                echo "error: SERIALDEV could not be determined automatically." >&2; \
 
274
                exit 1; }
 
275
        @test 1 -eq $(SERIALDEVGUESS) && { \
 
276
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
 
277
                echo; }
 
278
        stty $(STTYFARG) $(SERIALDEV) hupcl
233
279
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
234
280
 
235
281
clean:
243
289
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
244
290
 
245
291
monitor:
 
292
        @test -n "$(SERIALDEV)" || { \
 
293
                echo "error: SERIALDEV could not be determined automatically." >&2; \
 
294
                exit 1; }
 
295
        @test -n `which screen` || { \
 
296
                echo "error: can't find GNU screen, you might need to install it." >&2 \
 
297
                ecit 1; }
 
298
        @test 1 -eq $(SERIALDEVGUESS) && { \
 
299
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
 
300
                echo; }
246
301
        screen $(SERIALDEV)
247
302
 
248
303
# building the target
284
339
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
285
340
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
286
341
        $(COMPILE.cpp) -o $@ $<
 
342
 
 
343
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c
 
344
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
345
        $(COMPILE.c) -o $@ $<
 
346
 
 
347
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp
 
348
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
349
        $(COMPILE.cpp) -o $@ $<