/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-11-30 15:13:27 UTC
  • Revision ID: tim@ed.am-20121130151327-scygxxvu0crec501
documented AVRDUDEFLAGS, CPPFLAGS, LINKFLAGS and LINBRARYPATH, cleaned up a
little bit, and fixed a tiny bug (called ecit, not exit, during an error)

Show diffs side-by-side

added added

removed removed

Lines of Context:
arduino.mk
2
2
#
3
3
#                         edam's Arduino makefile
4
4
#_______________________________________________________________________________
5
 
#                                                                 version 0.6dev
 
5
#                                                                 version 0.5dev
6
6
#
7
 
# Copyright (C) 2011, 2012, 2013 Tim Marston <tim@ed.am>.
 
7
# Copyright (C) 2011, 2012 Tim Marston <tim@ed.am>.
8
8
#
9
9
# Permission is hereby granted, free of charge, to any person obtaining a copy
10
10
# of this software and associated documentation files (the "Software"), to deal
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 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.)
 
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.
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, 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:
 
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:
42
42
#
43
43
#   $ ln -s ~/src/arduino.mk Makefile
44
44
#
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.
 
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.
51
49
#
52
50
# If you downloaded the Arduino software manually and unpacked it somewhere
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
 
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
56
54
# your ~/.profile by adding something like this:
57
55
#
58
56
#   export ARDUINODIR=~/somewhere/arduino-1.0
59
57
#
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:
 
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:
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 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.
 
73
# that have been #included.  Note, there can only be one .ino (or .pde) file.
76
74
#
77
75
# Alternatively, if you want to manually specify build variables, create a
78
76
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
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:
 
77
# (There is no need to define TARGET).  Here is an example Makefile:
81
78
#
82
79
#   SOURCES := main.cc other.cc
83
80
#   LIBRARIES := EEPROM
84
 
#   BOARD := pro5v
85
81
#   include ~/src/arduino.mk
86
82
#
87
83
# Here is a complete list of configuration parameters:
92
88
#              ARDUINO version constant.  This defaults to 100 if undefined.
93
89
#
94
90
# AVRDUDECONF  The avrdude.conf to use.  If undefined, this defaults to a guess
95
 
#              based on where avrdude is.  If set empty, no avrdude.conf is
96
 
#              passed to avrdude (so the system default is used).
 
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).
97
93
#
98
94
# AVRDUDEFLAGS Specify any additional flags for avrdude.  The usual flags,
99
95
#              required to build the project, will be appended to this.
116
112
#
117
113
# LIBRARYPATH  A space-separated list of directories that is searched in order
118
114
#              when looking for Arduino libraries.  This defaults to "libs",
119
 
#              "libraries" (in the project directory), then your sketchbook
120
 
#              "libraries" directory, then the Arduino libraries directory.
 
115
#              "libraries" and then the Arduino software's libraries directory.
121
116
#
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.
 
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.
125
120
#
126
121
# SOURCES      A list of all source files of whatever language.  The language
127
122
#              type is determined by the file extension.  This is set
139
134
#
140
135
# target       Builds the target.
141
136
#
142
 
# upload       Uploads the target (building it, as necessary) to an attached
143
 
#              Arduino.
 
137
# upload       Uploads the last built target to an attached Arduino.
144
138
#
145
139
# clean        Deletes files created during the build.
146
140
#
150
144
# monitor      Start `screen` on the serial device.  This is meant to be an
151
145
#              equivalent to the Arduino serial monitor.
152
146
#
153
 
# size         Displays size information about the built target.
154
 
#
155
 
# bootloader   Burns the bootloader for your board to it.
 
147
# size         Displays size information about the bulit target.
156
148
#
157
149
# <file>       Builds the specified file, either an object file or the target,
158
150
#              from those that that would be built for the project.
161
153
 
162
154
# default arduino software directory, check software exists
163
155
ifndef ARDUINODIR
164
 
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino \
165
 
        /Applications/Arduino.app/Contents/Resources/Java \
166
 
        $(HOME)/Applications/Arduino.app/Contents/Resources/Java))
 
156
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))
167
157
endif
168
158
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
169
159
$(error ARDUINODIR is not set correctly; arduino software not found)
173
163
ARDUINOCONST ?= 100
174
164
 
175
165
# default path for avr tools
176
 
AVRTOOLSPATH ?= $(subst :, , $(PATH)) $(ARDUINODIR)/hardware/tools \
177
 
        $(ARDUINODIR)/hardware/tools/avr/bin
 
166
ifndef AVRTOOLSPATH
 
167
AVRTOOLSPATH := $(subst :, , $(PATH))
 
168
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools
 
169
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
 
170
endif
178
171
 
179
172
# default path to find 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_BUILD_CORE := $(call readboardsparam,build.core)
206
 
BOARD_UPLOAD_SPEED := $(call readboardsparam,upload.speed)
207
 
BOARD_UPLOAD_PROTOCOL := $(call readboardsparam,upload.protocol)
208
 
BOARD_USB_VID := $(call readboardsparam,build.vid)
209
 
BOARD_USB_PID := $(call readboardsparam,build.pid)
210
 
BOARD_BOOTLOADER_UNLOCK := $(call readboardsparam,bootloader.unlock_bits)
211
 
BOARD_BOOTLOADER_LOCK := $(call readboardsparam,bootloader.lock_bits)
212
 
BOARD_BOOTLOADER_LFUSES := $(call readboardsparam,bootloader.low_fuses)
213
 
BOARD_BOOTLOADER_HFUSES := $(call readboardsparam,bootloader.high_fuses)
214
 
BOARD_BOOTLOADER_EFUSES := $(call readboardsparam,bootloader.extended_fuses)
215
 
BOARD_BOOTLOADER_PATH := $(call readboardsparam,bootloader.path)
216
 
BOARD_BOOTLOADER_FILE := $(call readboardsparam,bootloader.file)
217
 
 
218
 
# obtain preferences from the IDE's preferences.txt
219
 
PREFERENCESFILE := $(firstword $(wildcard \
220
 
        $(HOME)/.arduino/preferences.txt $(HOME)/Library/Arduino/preferences.txt))
221
 
ifneq "$(PREFERENCESFILE)" ""
222
 
readpreferencesparam = $(shell sed -ne "s/$(1)=\(.*\)/\1/p" $(PREFERENCESFILE))
223
 
SKETCHBOOKDIR := $(call readpreferencesparam,sketchbook.path)
224
 
endif
225
 
 
226
 
# invalid board?
227
 
ifeq "$(BOARD_BUILD_MCU)" ""
228
 
ifneq "$(MAKECMDGOALS)" "boards"
229
 
ifneq "$(MAKECMDGOALS)" "clean"
230
 
$(error BOARD is invalid.  Type 'make boards' to see possible values)
231
 
endif
232
 
endif
233
 
endif
 
173
LIBRARYPATH ?= libraries libs $(ARDUINODIR)/libraries
234
174
 
235
175
# auto mode?
236
176
INOFILE := $(wildcard *.ino *.pde)
252
192
 
253
193
endif
254
194
 
 
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
 
255
203
# software
256
204
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
257
205
CC := $(call findsoftware,avr-gcc)
263
211
AVRSIZE := $(call findsoftware,avr-size)
264
212
 
265
213
# directories
266
 
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/$(BOARD_BUILD_CORE)
 
214
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
267
215
LIBRARYDIRS := $(foreach lib, $(LIBRARIES), \
268
216
        $(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARYPATH)))))
269
217
LIBRARYDIRS += $(addsuffix /utility, $(LIBRARYDIRS))
275
223
ARDUINOLIB := .lib/arduino.a
276
224
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(LIBRARYDIRS), \
277
225
        $(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, *.c *.cpp))))
278
 
BOOTLOADERHEX := $(addprefix \
279
 
        $(ARDUINODIR)/hardware/arduino/bootloaders/$(BOARD_BOOTLOADER_PATH)/, \
280
 
        $(BOARD_BOOTLOADER_FILE))
281
226
 
282
227
# avrdude confifuration
283
228
ifeq "$(AVRDUDECONF)" ""
288
233
endif
289
234
endif
290
235
 
 
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
 
291
271
# flags
292
272
CPPFLAGS += -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
293
273
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
300
280
CPPDEPFLAGS = -MMD -MP -MF .dep/$<.dep
301
281
CPPINOFLAGS := -x c++ -include $(ARDUINOCOREDIR)/Arduino.h
302
282
AVRDUDEFLAGS += $(addprefix -C , $(AVRDUDECONF)) -DV
303
 
AVRDUDEFLAGS += -p$(BOARD_BUILD_MCU) -P$(SERIALDEV) -c$(BOARD_UPLOAD_PROTOCOL)
304
 
AVRDUDEFLAGS += $(addprefix -b, $(BOARD_UPLOAD_SPEED))
 
283
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
 
284
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
305
285
LINKFLAGS += -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
306
286
 
307
287
# figure out which arg to use with stty (for OS X, GNU and busybox stty)
319
299
#_______________________________________________________________________________
320
300
#                                                                          RULES
321
301
 
322
 
.PHONY: all target upload clean boards monitor size bootloader
 
302
.PHONY: all target upload clean boards monitor size
323
303
 
324
304
all: target
325
305
 
333
313
        @test 0 -eq $(SERIALDEVGUESS) || { \
334
314
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
335
315
                echo; }
336
 
ifeq "$(BOARD_BOOTLOADER_PATH)" "caterina"
337
 
        stty $(STTYFARG) $(SERIALDEV) speed 1200
338
 
        sleep 1
339
 
else
340
316
        stty $(STTYFARG) $(SERIALDEV) hupcl
341
 
endif
342
317
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
343
318
 
344
319
clean:
347
322
        rm -rf .lib .dep
348
323
 
349
324
boards:
350
 
        @echo "Available values for BOARD:"
351
 
        @sed -nEe '/^#/d; /^[^.]+\.name=/p' $(BOARDSFILE) | \
 
325
        @echo Available values for BOARD:
 
326
        @sed -nEe '/^#/d; /^[^.]+\.name=/p' $(BOARDS_FILE) | \
352
327
                sed -Ee 's/([^.]+)\.name=(.*)/\1            \2/' \
353
328
                        -e 's/(.{12}) *(.*)/\1 \2/'
354
329
 
367
342
size: $(TARGET).elf
368
343
        echo && $(AVRSIZE) --format=avr --mcu=$(BOARD_BUILD_MCU) $(TARGET).elf
369
344
 
370
 
bootloader:
371
 
        @echo "Burning bootloader to board..."
372
 
        @test -n "$(SERIALDEV)" || { \
373
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
374
 
                exit 1; }
375
 
        @test 0 -eq $(SERIALDEVGUESS) || { \
376
 
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
377
 
                echo; }
378
 
        stty $(STTYFARG) $(SERIALDEV) hupcl
379
 
        $(AVRDUDE) $(AVRDUDEFLAGS) -U lock:w:$(BOARD_BOOTLOADER_UNLOCK):m
380
 
        $(AVRDUDE) $(AVRDUDEFLAGS) -eU lfuse:w:$(BOARD_BOOTLOADER_LFUSES):m
381
 
        $(AVRDUDE) $(AVRDUDEFLAGS) -U hfuse:w:$(BOARD_BOOTLOADER_HFUSES):m
382
 
ifneq "$(BOARD_BOOTLOADER_EFUSES)" ""
383
 
        $(AVRDUDE) $(AVRDUDEFLAGS) -U efuse:w:$(BOARD_BOOTLOADER_EFUSES):m
384
 
endif
385
 
ifneq "$(BOOTLOADERHEX)" ""
386
 
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(BOOTLOADERHEX):i
387
 
endif
388
 
        $(AVRDUDE) $(AVRDUDEFLAGS) -U lock:w:$(BOARD_BOOTLOADER_LOCK):m
389
 
 
390
345
# building the target
391
346
 
392
347
$(TARGET).hex: $(TARGET).elf
441
396
.lib/%.C.o: %.C
442
397
        mkdir -p $(dir $@)
443
398
        $(COMPILE.cpp) -o $@ $<
444
 
 
445
 
# Local Variables:
446
 
# mode: makefile
447
 
# tab-width: 4
448
 
# End: