/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: Tim Marston
  • Date: 2013-02-25 22:42:47 UTC
  • Revision ID: tim@ed.am-20130225224247-mlvghfkv6qiy0ns2
updated reference documentation

Show diffs side-by-side

added added

removed removed

Lines of Context:
28
28
#
29
29
#
30
30
# This is a general purpose makefile for use with Arduino hardware and
31
 
# software.  It works with the arduino-1.0 software release.  To download the
32
 
# latest version of this makefile, visit the following website, where you can
33
 
# also find more information and documentation on it's use.  The following text
34
 
# can only really be considered a reference to it's use.
 
31
# software.  It works with the arduino-1.0 and later software releases.  It
 
32
# should work GNU/Linux and OS X.  To download the latest version of this
 
33
# makefile visit the following website where you can also find documentation on
 
34
# it's use.  (The following text can only really be considered a reference.)
35
35
#
36
36
#   http://ed.am/dev/make/arduino-mk
37
37
#
38
38
# This makefile can be used as a drop-in replacement for the Arduino IDE's
39
 
# build system.  To use it, save arduino.mk somewhere (I keep mine at
40
 
# ~/src/arduino.mk) and create a symlink to it in your project directory named
41
 
# "Makefile".  For example:
 
39
# build system.  To use it, just copy arduino.mk in to your project directory.
 
40
# Or, you could save it somewhere (I keep mine at ~/src/arduino.mk) and create
 
41
# a symlink to it in your project directory, named "Makefile".  For example:
42
42
#
43
43
#   $ ln -s ~/src/arduino.mk Makefile
44
44
#
45
 
# The Arduino software (version 1.0 or later) is required.  If you are using
46
 
# Debian (or a derivative), type `apt-get install arduino`.  Otherwise, you
47
 
# will have to download the Arduino software manually from http://arduino.cc/.
48
 
# It is suggested that you install it at ~/opt/arduino if you are unsure.
 
45
# The Arduino software (version 1.0 or later) is required.  On GNU/Linux you
 
46
# can probably install the software from your package manager.  If you are
 
47
# using Debian (or a derivative), try `apt-get install arduino`.  Otherwise,
 
48
# you can download the Arduino software manually from http://arduino.cc/.  It
 
49
# is suggested that you install it at ~/opt/arduino (or /Applications on OS X)
 
50
# if you are unsure.
49
51
#
50
52
# If you downloaded the Arduino software manually and unpacked it somewhere
51
 
# other than ~/opt/arduino, you will need to set up ARDUINODIR to be the path
52
 
# where you unpacked it.  (If unset, ARDUINODIR defaults to ~/opt/arduino and
53
 
# then /usr/share/arduino, in that order.)  You might be best to set this in
 
53
# other than ~/opt/arduino (or /Applications), you will need to set up the
 
54
# ARDUINODIR environment variable to be the path where you unpacked it.  (If
 
55
# unset, ARDUINODIR defaults to some sensible places).  You could set this in
54
56
# your ~/.profile by adding something like this:
55
57
#
56
58
#   export ARDUINODIR=~/somewhere/arduino-1.0
57
59
#
58
 
# You will also need to set BOARD to the type of Arduino you're building for.
59
 
# Type `make boards` for a list of acceptable values.  You could set a default
60
 
# in your ~/.profile if you want, but it is suggested that you specify this at
61
 
# build time, especially if you work with different types of Arduino.  For
62
 
# example:
 
60
# For each project, you will also need to set BOARD to the type of Arduino
 
61
# you're building for.  Type `make boards` for a list of acceptable values.
 
62
# For example:
63
63
#
64
64
#   $ export BOARD=uno
65
65
#   $ make
70
70
# determine values for SOURCES, TARGET and LIBRARIES.  Any .c, .cc and .cpp
71
71
# files in the project directory (or any "util" or "utility" subdirectories)
72
72
# are automatically included in the build and are scanned for Arduino libraries
73
 
# that have been #included.  Note, there can only be one .ino (or .pde) file.
 
73
# that have been #included.  Note, there can only be one .ino (or .pde) file in
 
74
# a project directory and if you want to be compatible with the Arduino IDE, it
 
75
# should be called the same as the directory name.
74
76
#
75
77
# Alternatively, if you want to manually specify build variables, create a
76
78
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
77
 
# (There is no need to define TARGET).  Here is an example Makefile:
 
79
# (There is no need to define TARGET).  You can also specify the BOARD here, if
 
80
# the project has a specific one.  Here is an example Makefile:
78
81
#
79
82
#   SOURCES := main.cc other.cc
80
83
#   LIBRARIES := EEPROM
 
84
#   BOARD := pro5v
81
85
#   include ~/src/arduino.mk
82
86
#
83
87
# Here is a complete list of configuration parameters:
88
92
#              ARDUINO version constant.  This defaults to 100 if undefined.
89
93
#
90
94
# AVRDUDECONF  The avrdude.conf to use.  If undefined, this defaults to a guess
91
 
#              based on where the avrdude in use is.  If empty, no avrdude.conf
92
 
#              is passed to avrdude (to the system default is used).
 
95
#              based on where avrdude is.  If set empty, no avrdude.conf is
 
96
#              passed to avrdude (so the system default is used).
93
97
#
94
98
# AVRDUDEFLAGS Specify any additional flags for avrdude.  The usual flags,
95
99
#              required to build the project, will be appended to this.
112
116
#
113
117
# LIBRARYPATH  A space-separated list of directories that is searched in order
114
118
#              when looking for Arduino libraries.  This defaults to "libs",
115
 
#              "libraries" and then the Arduino software's libraries directory.
 
119
#              "libraries" (in the project directory), then your sketchbook
 
120
#              "libraries" directory, then the Arduino libraries directory.
116
121
#
117
 
# SERIALDEV    The unix device name of the serial device that is the Arduino.
118
 
#              If unspecified, an attempt is made to determine the name of a
119
 
#              connected Arduino's serial device.
 
122
# SERIALDEV    The POSIX device name of the serial device that is the Arduino.
 
123
#              If unspecified, an attempt is made to guess the name of a
 
124
#              connected Arduino's serial device, which may work in some cases.
120
125
#
121
126
# SOURCES      A list of all source files of whatever language.  The language
122
127
#              type is determined by the file extension.  This is set
134
139
#
135
140
# target       Builds the target.
136
141
#
137
 
# upload       Uploads the last built target to an attached Arduino.
 
142
# upload       Uploads the target (building it, as necessary) to an attached
 
143
#              Arduino.
138
144
#
139
145
# clean        Deletes files created during the build.
140
146
#
144
150
# monitor      Start `screen` on the serial device.  This is meant to be an
145
151
#              equivalent to the Arduino serial monitor.
146
152
#
147
 
# size         Displays size information about the bulit target.
 
153
# size         Displays size information about the built target.
 
154
#
 
155
# bootloader   Burns the bootloader for your board to it.
148
156
#
149
157
# <file>       Builds the specified file, either an object file or the target,
150
158
#              from those that that would be built for the project.
153
161
 
154
162
# default arduino software directory, check software exists
155
163
ifndef ARDUINODIR
156
 
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))
 
164
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino \
 
165
        /Applications/Arduino.app/Contents/Resources/Java \
 
166
        $(HOME)/Applications/Arduino.app/Contents/Resources/Java))
157
167
endif
158
168
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
159
169
$(error ARDUINODIR is not set correctly; arduino software not found)
163
173
ARDUINOCONST ?= 100
164
174
 
165
175
# default path for avr tools
166
 
ifndef AVRTOOLSPATH
167
 
AVRTOOLSPATH := $(subst :, , $(PATH))
168
 
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools
169
 
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
170
 
endif
 
176
AVRTOOLSPATH ?= $(subst :, , $(PATH)) $(ARDUINODIR)/hardware/tools \
 
177
        $(ARDUINODIR)/hardware/tools/avr/bin
171
178
 
172
179
# default path to find libraries
173
 
LIBRARYPATH ?= libraries libs $(ARDUINODIR)/libraries
 
180
LIBRARYPATH ?= libraries libs $(SKETCHBOOKDIR)/libraries $(ARDUINODIR)/libraries
 
181
 
 
182
# default serial device to a poor guess (something that might be an arduino)
 
183
SERIALDEVGUESS := 0
 
184
ifndef SERIALDEV
 
185
SERIALDEV := $(firstword $(wildcard \
 
186
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))
 
187
SERIALDEVGUESS := 1
 
188
endif
 
189
 
 
190
# no board?
 
191
ifndef BOARD
 
192
ifneq "$(MAKECMDGOALS)" "boards"
 
193
ifneq "$(MAKECMDGOALS)" "clean"
 
194
$(error BOARD is unset.  Type 'make boards' to see possible values)
 
195
endif
 
196
endif
 
197
endif
 
198
 
 
199
# obtain board parameters from the arduino boards.txt file
 
200
BOARDSFILE := $(ARDUINODIR)/hardware/arduino/boards.txt
 
201
readboardsparam = $(shell sed -ne "s/$(BOARD).$(1)=\(.*\)/\1/p" $(BOARDSFILE))
 
202
BOARD_BUILD_MCU := $(call readboardsparam,build.mcu)
 
203
BOARD_BUILD_FCPU := $(call readboardsparam,build.f_cpu)
 
204
BOARD_BUILD_VARIANT := $(call readboardsparam,build.variant)
 
205
BOARD_UPLOAD_SPEED := $(call readboardsparam,upload.speed)
 
206
BOARD_UPLOAD_PROTOCOL := $(call readboardsparam,upload.protocol)
 
207
BOARD_USB_VID := $(call readboardsparam,build.vid)
 
208
BOARD_USB_PID := $(call readboardsparam,build.pid)
 
209
BOARD_BOOTLOADER_UNLOCK := $(call readboardsparam,bootloader.unlock_bits)
 
210
BOARD_BOOTLOADER_LOCK := $(call readboardsparam,bootloader.lock_bits)
 
211
BOARD_BOOTLOADER_LFUSES := $(call readboardsparam,bootloader.low_fuses)
 
212
BOARD_BOOTLOADER_HFUSES := $(call readboardsparam,bootloader.high_fuses)
 
213
BOARD_BOOTLOADER_EFUSES := $(call readboardsparam,bootloader.extended_fuses)
 
214
BOARD_BOOTLOADER_PATH := $(call readboardsparam,bootloader.path)
 
215
BOARD_BOOTLOADER_FILE := $(call readboardsparam,bootloader.file)
 
216
 
 
217
# obtain preferences from the IDE's preferences.txt
 
218
PREFERENCESFILE := $(firstword $(wildcard \
 
219
        $(HOME)/.arduino/preferences.txt $(HOME)/Library/Arduino/preferences.txt))
 
220
ifneq "$(PREFERENCESFILE)" ""
 
221
readpreferencesparam = $(shell sed -ne "s/$(1)=\(.*\)/\1/p" $(PREFERENCESFILE))
 
222
SKETCHBOOKDIR := $(call readpreferencesparam,sketchbook.path)
 
223
endif
 
224
 
 
225
# invalid board?
 
226
ifeq "$(BOARD_BUILD_MCU)" ""
 
227
ifneq "$(MAKECMDGOALS)" "boards"
 
228
ifneq "$(MAKECMDGOALS)" "clean"
 
229
$(error BOARD is invalid.  Type 'make boards' to see possible values)
 
230
endif
 
231
endif
 
232
endif
174
233
 
175
234
# auto mode?
176
235
INOFILE := $(wildcard *.ino *.pde)
192
251
 
193
252
endif
194
253
 
195
 
# no serial device? make a poor attempt to detect an arduino
196
 
SERIALDEVGUESS := 0
197
 
ifeq "$(SERIALDEV)" ""
198
 
SERIALDEV := $(firstword $(wildcard \
199
 
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))
200
 
SERIALDEVGUESS := 1
201
 
endif
202
 
 
203
254
# software
204
255
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
205
256
CC := $(call findsoftware,avr-gcc)
223
274
ARDUINOLIB := .lib/arduino.a
224
275
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(LIBRARYDIRS), \
225
276
        $(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, *.c *.cpp))))
 
277
BOOTLOADERHEX := $(addprefix \
 
278
        $(ARDUINODIR)/hardware/arduino/bootloaders/$(BOARD_BOOTLOADER_PATH)/, \
 
279
        $(BOARD_BOOTLOADER_FILE))
226
280
 
227
281
# avrdude confifuration
228
282
ifeq "$(AVRDUDECONF)" ""
233
287
endif
234
288
endif
235
289
 
236
 
# no board?
237
 
ifndef BOARD
238
 
ifneq "$(MAKECMDGOALS)" "boards"
239
 
ifneq "$(MAKECMDGOALS)" "clean"
240
 
$(error BOARD is unset.  Type 'make boards' to see possible values)
241
 
endif
242
 
endif
243
 
endif
244
 
 
245
 
# obtain board parameters from the arduino boards.txt file
246
 
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
247
 
BOARD_BUILD_MCU := \
248
 
        $(shell sed -ne "s/$(BOARD).build.mcu=\(.*\)/\1/p" $(BOARDS_FILE))
249
 
BOARD_BUILD_FCPU := \
250
 
        $(shell sed -ne "s/$(BOARD).build.f_cpu=\(.*\)/\1/p" $(BOARDS_FILE))
251
 
BOARD_BUILD_VARIANT := \
252
 
        $(shell sed -ne "s/$(BOARD).build.variant=\(.*\)/\1/p" $(BOARDS_FILE))
253
 
BOARD_UPLOAD_SPEED := \
254
 
        $(shell sed -ne "s/$(BOARD).upload.speed=\(.*\)/\1/p" $(BOARDS_FILE))
255
 
BOARD_UPLOAD_PROTOCOL := \
256
 
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
257
 
BOARD_USB_VID := \
258
 
        $(shell sed -ne "s/$(BOARD).build.vid=\(.*\)/\1/p" $(BOARDS_FILE))
259
 
BOARD_USB_PID := \
260
 
        $(shell sed -ne "s/$(BOARD).build.pid=\(.*\)/\1/p" $(BOARDS_FILE))
261
 
 
262
 
# invalid board?
263
 
ifeq "$(BOARD_BUILD_MCU)" ""
264
 
ifneq "$(MAKECMDGOALS)" "boards"
265
 
ifneq "$(MAKECMDGOALS)" "clean"
266
 
$(error BOARD is invalid.  Type 'make boards' to see possible values)
267
 
endif
268
 
endif
269
 
endif
270
 
 
271
290
# flags
272
291
CPPFLAGS += -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
273
292
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
299
318
#_______________________________________________________________________________
300
319
#                                                                          RULES
301
320
 
302
 
.PHONY: all target upload clean boards monitor size
 
321
.PHONY: all target upload clean boards monitor size bootloader
303
322
 
304
323
all: target
305
324
 
313
332
        @test 0 -eq $(SERIALDEVGUESS) || { \
314
333
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
315
334
                echo; }
 
335
ifeq "$(BOARD_BOOTLOADER_PATH)" "caterina"
 
336
        stty $(STTYFARG) $(SERIALDEV) speed 1200
 
337
        sleep 1
 
338
endif
316
339
        stty $(STTYFARG) $(SERIALDEV) hupcl
317
340
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
318
341
 
322
345
        rm -rf .lib .dep
323
346
 
324
347
boards:
325
 
        @echo Available values for BOARD:
326
 
        @sed -nEe '/^#/d; /^[^.]+\.name=/p' $(BOARDS_FILE) | \
 
348
        @echo "Available values for BOARD:"
 
349
        @sed -nEe '/^#/d; /^[^.]+\.name=/p' $(BOARDSFILE) | \
327
350
                sed -Ee 's/([^.]+)\.name=(.*)/\1            \2/' \
328
351
                        -e 's/(.{12}) *(.*)/\1 \2/'
329
352
 
342
365
size: $(TARGET).elf
343
366
        echo && $(AVRSIZE) --format=avr --mcu=$(BOARD_BUILD_MCU) $(TARGET).elf
344
367
 
 
368
bootloader:
 
369
        @echo "Burning bootloader to board..."
 
370
        @test -n "$(SERIALDEV)" || { \
 
371
                echo "error: SERIALDEV could not be determined automatically." >&2; \
 
372
                exit 1; }
 
373
        @test 0 -eq $(SERIALDEVGUESS) || { \
 
374
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
 
375
                echo; }
 
376
        stty $(STTYFARG) $(SERIALDEV) hupcl
 
377
        $(AVRDUDE) $(AVRDUDEFLAGS) -U lock:w:$(BOARD_BOOTLOADER_UNLOCK):m
 
378
        $(AVRDUDE) $(AVRDUDEFLAGS) -eU lfuse:w:$(BOARD_BOOTLOADER_LFUSES):m
 
379
        $(AVRDUDE) $(AVRDUDEFLAGS) -U hfuse:w:$(BOARD_BOOTLOADER_HFUSES):m
 
380
ifneq "$(BOARD_BOOTLOADER_EFUSES)" ""
 
381
        $(AVRDUDE) $(AVRDUDEFLAGS) -U efuse:w:$(BOARD_BOOTLOADER_EFUSES):m
 
382
endif
 
383
ifneq "$(BOOTLOADERHEX)" ""
 
384
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(BOOTLOADERHEX):i
 
385
endif
 
386
        $(AVRDUDE) $(AVRDUDEFLAGS) -U lock:w:$(BOARD_BOOTLOADER_LOCK):m
 
387
 
345
388
# building the target
346
389
 
347
390
$(TARGET).hex: $(TARGET).elf
396
439
.lib/%.C.o: %.C
397
440
        mkdir -p $(dir $@)
398
441
        $(COMPILE.cpp) -o $@ $<
 
442
 
 
443
# Local Variables:
 
444
# mode: makefile
 
445
# tab-width: 4
 
446
# End: