/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-01-25 14:24:01 UTC
  • Revision ID: edam@waxworlds.org-20120125142401-t6mwsp0621wd8w6q
fixed URL

Show diffs side-by-side

added added

removed removed

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