/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-26 12:36:55 UTC
  • Revision ID: edam@waxworlds.org-20120126123655-hvebajnzf7z94fk3
cleaned up comments

Show diffs side-by-side

added added

removed removed

Lines of Context:
arduino.mk
43
43
#
44
44
#   $ ln -s ~/src/arduino.mk Makefile
45
45
#
46
 
# You also need to set up a couple of environment variables. ARDUINODIR should
 
46
# You also need to set up a couple of environment varibales. ARDUINODIR should
47
47
# be set to the path where you unpacked the arduino software from arduino.cc
48
48
# (it defaults to ~/opt/arduino if unset).  You might be best to set this in
49
49
# your ~/.profile by adding something like this:
52
52
#
53
53
# You will also need to set BOARD to the type of arduino you're using.  This
54
54
# can be done when running make (or you could set a default in ~/.profile and
55
 
# override it as necessary).  For example:
 
55
# iverride it as necessary).  For example:
56
56
#
57
57
#   $ export BOARD=uno
58
58
#   $ make
59
59
#
60
60
# You may also need to set SERIALDEV if it is not detected correctly.
61
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.
 
62
# The presence of a .ino or .pde file causes the arduino.mk to atuomatically
 
63
# determine va;ues for SOURCES, TARGET and LIBRARIES.  Any .c, .cc and .cpp
 
64
# files in the project directory (or any "util" or "utility" subdirectoried)
 
65
# are automatically included in the build and are scanned for Atduino libraries
 
66
# that have been #included.
67
67
#
68
68
# Alternatively, if you want to manually specify build variables, create a
69
 
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
 
69
# Makefile that defines SOURCES and LIBRARARIES and then includes arduino.mk.
70
70
# (There is no need to define TARGET).  Here is an example Makefile:
71
71
#
72
72
#   SOURCES := main.cc other.cc
78
78
# ARDUINODIR   The path where you have installed/unpacked the arduino software
79
79
#              (from http://arduino.cc/)
80
80
#
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
81
# BOARD        Specify a target board type.  Run `make boards` to see available
93
82
#              board types.
94
83
#
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.
 
84
# SERIALDEV    The unix device of the device where the arduino can be found.
99
85
#              If unspecified, an attempt is made to determine the name of a
100
86
#              connected arduino's serial device.
101
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 neccesary to set it
 
90
#              otherwise.
 
91
#
102
92
# SOURCES      A list of all source files of whatever language.  The language
103
93
#              type is determined by the file extension.  This is set
104
 
#              automatically if a .ino (or .pde) is found.
 
94
#              automatically if a .ino or .pde is found.
105
95
#
106
 
# TARGET       The name of the target file.  This is set automatically if a
107
 
#              .ino (or .pde) is found, but it is not necessary to set it
108
 
#              otherwise.
 
96
# LIBRARIES    A list of arduino libraries to build and include.  This is set
 
97
#              automatically if a .ino or .pde is found.
109
98
#
110
99
# This makefile also defines the following goals for use on the command line
111
100
# when you run make:
122
111
# boards       Display a list of available board names, so that you can set the
123
112
#              BOARD environment variable appropriately.
124
113
#
125
 
# monitor      Start `screen` on the serial device.  This is meant to be an
126
 
#              equivalent to the arduino serial monitor.
 
114
# monitor      Start `screen` on the serial device.  It is ment to be an
 
115
#              equivelant to the arduino serial monitor.
127
116
#
128
117
# <file>       Builds the specified file, either an object file or the target,
129
118
#              from those that that would be built for the project.
130
119
#_______________________________________________________________________________
131
120
#
132
121
 
133
 
# default arduino software directory, check software exists
 
122
# The full path to the arduino software, from arduino.cc
134
123
ifndef ARDUINODIR
135
124
ARDUINODIR := $(wildcard ~/opt/arduino)
136
125
endif
137
 
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
 
126
 
 
127
# check arduino software
 
128
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
138
129
$(error ARDUINODIR is not set correctly; arduino software not found)
139
130
endif
140
131
 
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
 
 
151
132
# auto mode?
152
133
INOFILE := $(wildcard *.ino *.pde)
153
134
ifdef INOFILE
154
 
ifneq "$(words $(INOFILE))" "1"
 
135
ifneq ($(words $(INOFILE)), 1)
155
136
$(error There is more than one .pde or .ino file in this directory!)
156
137
endif
157
 
 
158
 
# automatically determine sources and targeet
159
138
TARGET := $(basename $(INOFILE))
160
139
SOURCES := $(INOFILE) \
161
140
        $(wildcard *.c *.cc *.cpp) \
162
141
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
163
142
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
164
 
 
165
143
# automatically determine included libraries
166
144
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
167
145
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
168
146
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
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)
 
147
endif
 
148
 
 
149
# no target? use default
 
150
ifndef TARGET
 
151
TARGET := a.out
 
152
endif
 
153
 
 
154
# no serial device? attempt to detect an arduino
 
155
ifndef 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
 
166
endif
188
167
 
189
168
# files
190
 
TARGET := $(if $(TARGET),$(TARGET),a.out)
191
169
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
192
170
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
193
 
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
194
171
ARDUINOLIB := _arduino.a
195
 
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
 
172
ARDUINOLIBTMP := _arduino.a.tmp
196
173
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
197
174
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
198
175
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
199
176
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
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
 
177
        $(wildcard $(addprefix $(ARDUINODIR)/libraries/$(lib)/, *.c *.cpp))))))
218
178
 
219
179
# obtain board parameters from the arduino boards.txt file
220
180
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
229
189
BOARD_UPLOAD_PROTOCOL := \
230
190
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
231
191
 
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
 
192
# software
 
193
CC := avr-gcc
 
194
CXX := avr-g++
 
195
LD := avr-ld
 
196
AR := avr-ar
 
197
OBJCOPY := avr-objcopy
 
198
AVRDUDE := avrdude
240
199
 
241
200
# flags
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)
 
201
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
 
202
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
246
203
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
247
204
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
248
205
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
249
206
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
250
 
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
 
207
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
251
208
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
252
209
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
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)
 
210
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
257
211
 
258
212
# default rule
259
213
.DEFAULT_GOAL := all
268
222
target: $(TARGET).hex
269
223
 
270
224
upload:
271
 
        @echo "\nUploading to board..."
272
 
        @test -n "$(SERIALDEV)" || { \
273
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
274
 
                exit 1; }
275
 
        @test 0 -eq $(SERIALDEVGUESS) || { \
276
 
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
277
 
                echo; }
278
 
        stty $(STTYFARG) $(SERIALDEV) hupcl
 
225
        stty -F $(SERIALDEV) hupcl
279
226
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
280
227
 
281
228
clean:
289
236
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
290
237
 
291
238
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 0 -eq $(SERIALDEVGUESS) || { \
299
 
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
300
 
                echo; }
301
239
        screen $(SERIALDEV)
302
240
 
303
241
# building the target
339
277
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
340
278
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
341
279
        $(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 $@ $<