/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-31 22:12:25 UTC
  • Revision ID: edam@waxworlds.org-20111231221225-52dt61v5b2r3cmam
updated comments; added checks for missing or misconfigured variables; use a default TARGET; attempt to autodetect SERIALDEV; added 'boards' goal; fixed use of 'util' project subdirectory.

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
 
# 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
 
30
# This is a general purpose makefile for use with Arduino (see
 
31
# http://arduino.cc/) hardware and software.  It works with the
 
32
# arduino-1.0 release and requires that to be downloaded separately.
 
33
# It can be downloaded from http://ed.am/dev/make/arduino-makefile
 
34
# where you can also find more information and documentation on it's
 
35
# use.  The following text can only really be considered a reference
 
36
# to it's use.
 
37
#
 
38
# To install, it is suggested that you keep arduino.mk somewhere and
 
39
# either symlink to it or include it in your make files.  I keep mine
 
40
# at ~/src/arduino.mk.  You will need to alter the value of the
 
41
# ARDUINODIR variable (below) to be the path where you have unpacked
 
42
# the arduino software from arduino.cc.
 
43
#
 
44
# This makefile can be used as a drop-in replacement for the Arduino
 
45
# IDE's build system.  Simply create a symlink to it under the name
 
46
# "Makefile" and run make as described below (remembering to specify a
 
47
# BOARD).  You would create the symlink like like so:
 
48
#
 
49
#       $ ln -s ~/src/arduino.mk Makefile
 
50
#
 
51
# The presence of a .ino or .pde file causes the arduino.mk to
 
52
# atuomatically determine va;ues for SOURCES, TARGET and LIBRARIES.
 
53
# Any .c, .cc and .cpp files in the project directory (or a "util" or
 
54
# "utility" subdirectory) are automatically included in the build and
 
55
# are scanned for libraries that have been #included.
 
56
#
 
57
# Alternatively, if you want to manually specify build variables,
 
58
# create a Makefile that defines SOURCES and LIBRARARIES and then
 
59
# includes arduino.mk.  (There is no need to define TARGET).  You will
 
60
# also be expected to provide a main() function, for example in
 
61
# main.cc, which may or may not duplicate the functionality of the
 
62
# default main() that calls init() and loop().  Here is an example
 
63
# 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
 
70
# follows shortly.  It should be noted, however, that some variables
 
71
# are better specified in the environment or on the command line than
 
72
# in a Makefile.  Specifically, the BOARD and SERIALDEV (if it is not
 
73
# automatically detected).
 
74
#
 
75
# When running make, you might want to specify the board type:
 
76
#
 
77
#       $ BOARD=pro5v make
 
78
#
 
79
# Or in the environment:
 
80
#
 
81
#       $ export BOARD=pro5v
 
82
#       $ make
81
83
#
82
84
# For a list of available board types, run `make boards`.
83
85
# 
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/)
 
86
# Here is a list of all configuration parameters:
88
87
#
89
88
# BOARD        Specify a target board type.
90
89
#
91
 
# 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.
 
90
# SERIALDEV    The unix device of the device where the arduino can be
 
91
#              found.  If unspecified, an attempt is made to determine
 
92
#              the name of a connected arduino's serial device.
 
93
#
 
94
# The following configuration parameters can be determined automatically:
 
95
#
 
96
# TARGET       The name of the target file.  This need not be set if it
 
97
#              is not determined automatically.
 
98
#
 
99
# SOURCES      A list of all source files of whatever language.  The
 
100
#              language type is determined by the file extension.
 
101
#
 
102
# LIBRARIES    A list of arduino libraries to build and include.
105
103
#
106
104
# This general-purpose makefile also defines the following goals for
107
105
# use on the command line when you run make:
108
106
#
109
 
# all          This is the default if no goal is specified. It builds the
110
 
#              target and uploads it.
 
107
# all          This is the default if no goal is specified. It builds
 
108
#              the target and uploads it.
111
109
#
112
110
# target       Builds the target of your Makefile.
113
111
#
115
113
#
116
114
# clean        Deletes temporary files.
117
115
#
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
 
# <file>       Builds the specified file, either an object file or the target,
125
 
#              from those that that would be built for the project.
 
116
# <file>       Builds the specified file, either an object file or the
 
117
#              target, from those that that would be built for the
 
118
#              project.
 
119
#
126
120
#_______________________________________________________________________________
127
121
#
128
122
 
129
123
# The full path to the arduino software, from arduino.cc
130
 
ifndef ARDUINODIR
131
 
ARDUINODIR := $(wildcard ~/opt/arduino)
132
 
endif
 
124
ARDUINODIR := $(wildcard ~/opt/arduino-1.0)
133
125
 
134
126
# check arduino software
135
127
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
136
 
$(error ARDUINODIR is not set correctly; arduino software not found)
 
128
$(error ARDUINODIR is not set correctly at the top of arduino.mk)
137
129
endif
138
130
 
139
131
# auto mode?
209
201
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
210
202
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
211
203
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
212
 
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
213
 
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
 
204
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/,$(LIBRARIES))
214
205
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
215
206
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
216
207
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
222
213
#_______________________________________________________________________________
223
214
#                                                                          RULES
224
215
 
225
 
.PHONY: all target upload clean boards monitor
 
216
.PHONY: all target upload clean show-boards
226
217
 
227
218
all: target upload
228
219
 
242
233
        @sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
243
234
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
244
235
 
245
 
monitor:
246
 
        screen $(SERIALDEV)
247
 
 
248
236
# building the target
249
237
 
250
238
$(TARGET).hex: $(TARGET).elf