/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-23 17:48:28 UTC
  • Revision ID: tim@ed.am-20121123174828-lp4x2oo7ygfeqkp8
updated NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
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.
74
74
#
75
75
# Alternatively, if you want to manually specify build variables, create a
76
76
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
85
85
# ARDUINODIR   The path where the Arduino software is installed on your system.
86
86
#
87
87
# ARDUINOCONST The Arduino software version, as an integer, used to define the
88
 
#              ARDUINO version constant.  This defaults to 100 if undefined.
 
88
#              ARDUINO version constant. This defaults to 100 if undefined.
89
89
#
90
 
# 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
 
90
# 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
92
#              is passed to avrdude (to the system default is used).
93
93
#
94
 
# AVRDUDEFLAGS Specify any additional flags for avrdude.  The usual flags,
95
 
#              required to build the project, will be appended to this.
96
 
#
97
 
# AVRTOOLSPATH A space-separated list of directories that is searched in order
98
 
#              when looking for the avr build tools.  This defaults to PATH,
99
 
#              followed by subdirectories in ARDUINODIR.
 
94
# AVRTOOLSPATH A space-separated list of directories to search in order when
 
95
#              looking for the avr build tools. This defaults to the system PATH
 
96
#              followed by subdirectories in ARDUINODIR if undefined.
100
97
#
101
98
# BOARD        Specify a target board type.  Run `make boards` to see available
102
99
#              board types.
103
100
#
104
 
# CPPFLAGS     Specify any additional flags for the compiler.  The usual flags,
105
 
#              required to build the project, will be appended to this.
106
 
#
107
 
# LINKFLAGS    Specify any additional flags for the linker.  The usual flags,
108
 
#              required to build the project, will be appended to this.
109
 
#
110
101
# LIBRARIES    A list of Arduino libraries to build and include.  This is set
111
102
#              automatically if a .ino (or .pde) is found.
112
103
#
113
 
# LIBRARYPATH  A space-separated list of directories that is searched in order
114
 
#              when looking for Arduino libraries.  This defaults to "libs",
115
 
#              "libraries" and then the Arduino software's libraries directory.
116
 
#
117
104
# SERIALDEV    The unix device name of the serial device that is the Arduino.
118
105
#              If unspecified, an attempt is made to determine the name of a
119
106
#              connected Arduino's serial device.
144
131
# monitor      Start `screen` on the serial device.  This is meant to be an
145
132
#              equivalent to the Arduino serial monitor.
146
133
#
147
 
# size         Displays size information about the built target.
148
 
#
149
 
# bootloader   Burns the bootloader for your board to it.
 
134
# size         Displays size information about the bulit target.
150
135
#
151
136
# <file>       Builds the specified file, either an object file or the target,
152
137
#              from those that that would be built for the project.
155
140
 
156
141
# default arduino software directory, check software exists
157
142
ifndef ARDUINODIR
158
 
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino \
159
 
        /Applications/Arduino.app/Contents/Resources/Java \
160
 
        $(HOME)/Applications/Arduino.app/Contents/Resources/Java))
 
143
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))
161
144
endif
162
145
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
163
146
$(error ARDUINODIR is not set correctly; arduino software not found)
167
150
ARDUINOCONST ?= 100
168
151
 
169
152
# default path for avr tools
170
 
AVRTOOLSPATH ?= $(subst :, , $(PATH)) $(ARDUINODIR)/hardware/tools \
171
 
        $(ARDUINODIR)/hardware/tools/avr/bin
172
 
 
173
 
# default path to find libraries
174
 
LIBRARYPATH ?= libraries libs $(SKETCHBOOKDIR)/libraries $(ARDUINODIR)/libraries
175
 
 
176
 
# default serial device to a poor guess (something that might be an arduino)
177
 
SERIALDEVGUESS := 0
178
 
ifndef SERIALDEV
179
 
SERIALDEV := $(firstword $(wildcard \
180
 
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))
181
 
SERIALDEVGUESS := 1
182
 
endif
183
 
 
184
 
# no board?
185
 
ifndef BOARD
186
 
ifneq "$(MAKECMDGOALS)" "boards"
187
 
ifneq "$(MAKECMDGOALS)" "clean"
188
 
$(error BOARD is unset.  Type 'make boards' to see possible values)
189
 
endif
190
 
endif
191
 
endif
192
 
 
193
 
# obtain board parameters from the arduino boards.txt file
194
 
BOARDSFILE := $(ARDUINODIR)/hardware/arduino/boards.txt
195
 
readboardsparam = $(shell sed -ne "s/$(BOARD).$(1)=\(.*\)/\1/p" $(BOARDSFILE))
196
 
BOARD_BUILD_MCU := $(call readboardsparam,build.mcu)
197
 
BOARD_BUILD_FCPU := $(call readboardsparam,build.f_cpu)
198
 
BOARD_BUILD_VARIANT := $(call readboardsparam,build.variant)
199
 
BOARD_UPLOAD_SPEED := $(call readboardsparam,upload.speed)
200
 
BOARD_UPLOAD_PROTOCOL := $(call readboardsparam,upload.protocol)
201
 
BOARD_USB_VID := $(call readboardsparam,build.vid)
202
 
BOARD_USB_PID := $(call readboardsparam,build.pid)
203
 
BOARD_BOOTLOADER_UNLOCK := $(call readboardsparam,bootloader.unlock_bits)
204
 
BOARD_BOOTLOADER_LOCK := $(call readboardsparam,bootloader.lock_bits)
205
 
BOARD_BOOTLOADER_LFUSES := $(call readboardsparam,bootloader.low_fuses)
206
 
BOARD_BOOTLOADER_HFUSES := $(call readboardsparam,bootloader.high_fuses)
207
 
BOARD_BOOTLOADER_EFUSES := $(call readboardsparam,bootloader.extended_fuses)
208
 
BOARD_BOOTLOADER_PATH := $(call readboardsparam,bootloader.path)
209
 
BOARD_BOOTLOADER_FILE := $(call readboardsparam,bootloader.file)
210
 
 
211
 
# obtain preferences from the IDE's preferences.txt
212
 
PREFERENCESFILE := $(firstword $(wildcard \
213
 
        $(HOME)/.arduino/preferences.txt $(HOME)/Library/Arduino/preferences.txt))
214
 
ifneq "$(PREFERENCESFILE)" ""
215
 
readpreferencesparam = $(shell sed -ne "s/$(1)=\(.*\)/\1/p" $(PREFERENCESFILE))
216
 
SKETCHBOOKDIR := $(call readpreferencesparam,sketchbook.path)
217
 
endif
218
 
 
219
 
# invalid board?
220
 
ifeq "$(BOARD_BUILD_MCU)" ""
221
 
ifneq "$(MAKECMDGOALS)" "boards"
222
 
ifneq "$(MAKECMDGOALS)" "clean"
223
 
$(error BOARD is invalid.  Type 'make boards' to see possible values)
224
 
endif
225
 
endif
 
153
ifndef AVRTOOLSPATH
 
154
AVRTOOLSPATH := $(subst :, , $(PATH))
 
155
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools
 
156
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
226
157
endif
227
158
 
228
159
# auto mode?
235
166
# automatically determine sources and targeet
236
167
TARGET := $(basename $(INOFILE))
237
168
SOURCES := $(INOFILE) \
238
 
        $(wildcard *.c *.cc *.cpp *.C) \
239
 
        $(wildcard $(addprefix util/, *.c *.cc *.cpp *.C)) \
240
 
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp *.C))
 
169
        $(wildcard *.c *.cc *.cpp) \
 
170
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
 
171
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
241
172
 
242
173
# automatically determine included libraries
243
 
LIBRARIES := $(filter $(notdir $(wildcard $(addsuffix /*, $(LIBRARYPATH)))), \
 
174
LIBRARIES := $(filter $(notdir $(wildcard $(ARDUINODIR)/libraries/*)), \
244
175
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
245
176
 
246
177
endif
247
178
 
 
179
# no serial device? make a poor attempt to detect an arduino
 
180
SERIALDEVGUESS := 0
 
181
ifeq "$(SERIALDEV)" ""
 
182
SERIALDEV := $(firstword $(wildcard \
 
183
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))
 
184
SERIALDEVGUESS := 1
 
185
endif
 
186
 
248
187
# software
249
188
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
250
189
CC := $(call findsoftware,avr-gcc)
255
194
AVRDUDE := $(call findsoftware,avrdude)
256
195
AVRSIZE := $(call findsoftware,avr-size)
257
196
 
258
 
# directories
259
 
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
260
 
LIBRARYDIRS := $(foreach lib, $(LIBRARIES), \
261
 
        $(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARYPATH)))))
262
 
LIBRARYDIRS += $(addsuffix /utility, $(LIBRARYDIRS))
263
 
 
264
197
# files
265
198
TARGET := $(if $(TARGET),$(TARGET),a.out)
266
199
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
267
200
DEPFILES := $(patsubst %, .dep/%.dep, $(SOURCES))
 
201
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
268
202
ARDUINOLIB := .lib/arduino.a
269
 
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(LIBRARYDIRS), \
 
203
ARDUINOLIBLIBSDIR := $(ARDUINODIR)/libraries
 
204
ARDUINOLIBLIBSPATH := $(foreach lib, $(LIBRARIES), \
 
205
        $(ARDUINODIR)/libraries/$(lib)/ $(ARDUINODIR)/libraries/$(lib)/utility/ )
 
206
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(ARDUINOLIBLIBSPATH), \
270
207
        $(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, *.c *.cpp))))
271
 
BOOTLOADERHEX := $(addprefix \
272
 
        $(ARDUINODIR)/hardware/arduino/bootloaders/$(BOARD_BOOTLOADER_PATH)/, \
273
 
        $(BOARD_BOOTLOADER_FILE))
274
 
 
275
 
# avrdude confifuration
276
208
ifeq "$(AVRDUDECONF)" ""
277
209
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
278
210
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
281
213
endif
282
214
endif
283
215
 
 
216
# no board?
 
217
ifndef BOARD
 
218
ifneq "$(MAKECMDGOALS)" "boards"
 
219
ifneq "$(MAKECMDGOALS)" "clean"
 
220
$(error BOARD is unset.  Type 'make boards' to see possible values)
 
221
endif
 
222
endif
 
223
endif
 
224
 
 
225
# obtain board parameters from the arduino boards.txt file
 
226
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
 
227
BOARD_BUILD_MCU := \
 
228
        $(shell sed -ne "s/$(BOARD).build.mcu=\(.*\)/\1/p" $(BOARDS_FILE))
 
229
BOARD_BUILD_FCPU := \
 
230
        $(shell sed -ne "s/$(BOARD).build.f_cpu=\(.*\)/\1/p" $(BOARDS_FILE))
 
231
BOARD_BUILD_VARIANT := \
 
232
        $(shell sed -ne "s/$(BOARD).build.variant=\(.*\)/\1/p" $(BOARDS_FILE))
 
233
BOARD_UPLOAD_SPEED := \
 
234
        $(shell sed -ne "s/$(BOARD).upload.speed=\(.*\)/\1/p" $(BOARDS_FILE))
 
235
BOARD_UPLOAD_PROTOCOL := \
 
236
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
 
237
BOARD_USB_VID := \
 
238
        $(shell sed -ne "s/$(BOARD).build.vid=\(.*\)/\1/p" $(BOARDS_FILE))
 
239
BOARD_USB_PID := \
 
240
        $(shell sed -ne "s/$(BOARD).build.pid=\(.*\)/\1/p" $(BOARDS_FILE))
 
241
 
 
242
# invalid board?
 
243
ifeq "$(BOARD_BUILD_MCU)" ""
 
244
ifneq "$(MAKECMDGOALS)" "boards"
 
245
ifneq "$(MAKECMDGOALS)" "clean"
 
246
$(error BOARD is invalid.  Type 'make boards' to see possible values)
 
247
endif
 
248
endif
 
249
endif
 
250
 
284
251
# flags
285
 
CPPFLAGS += -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
 
252
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
286
253
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
287
254
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
288
255
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
289
256
CPPFLAGS += -DUSB_VID=$(BOARD_USB_VID) -DUSB_PID=$(BOARD_USB_PID)
290
257
CPPFLAGS += -I. -Iutil -Iutility -I $(ARDUINOCOREDIR)
291
258
CPPFLAGS += -I $(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
292
 
CPPFLAGS += $(addprefix -I , $(LIBRARYDIRS))
 
259
CPPFLAGS += $(addprefix -I $(ARDUINODIR)/libraries/, $(LIBRARIES))
 
260
CPPFLAGS += $(patsubst %, -I $(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
293
261
CPPDEPFLAGS = -MMD -MP -MF .dep/$<.dep
294
262
CPPINOFLAGS := -x c++ -include $(ARDUINOCOREDIR)/Arduino.h
295
 
AVRDUDEFLAGS += $(addprefix -C , $(AVRDUDECONF)) -DV
 
263
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
296
264
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
297
265
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
298
 
LINKFLAGS += -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
 
266
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
299
267
 
300
268
# figure out which arg to use with stty (for OS X, GNU and busybox stty)
301
269
STTYFARG := $(shell stty --help 2>&1 | \
312
280
#_______________________________________________________________________________
313
281
#                                                                          RULES
314
282
 
315
 
.PHONY: all target upload clean boards monitor size bootloader
 
283
.PHONY: all target upload clean boards monitor size
316
284
 
317
285
all: target
318
286
 
326
294
        @test 0 -eq $(SERIALDEVGUESS) || { \
327
295
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
328
296
                echo; }
329
 
ifeq "$(BOARD_BOOTLOADER_PATH)" "caterina"
330
 
        stty $(STTYFARG) $(SERIALDEV) speed 1200
331
 
        sleep 1
332
 
endif
333
297
        stty $(STTYFARG) $(SERIALDEV) hupcl
334
298
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
335
299
 
339
303
        rm -rf .lib .dep
340
304
 
341
305
boards:
342
 
        @echo "Available values for BOARD:"
343
 
        @sed -nEe '/^#/d; /^[^.]+\.name=/p' $(BOARDSFILE) | \
 
306
        @echo Available values for BOARD:
 
307
        @sed -nEe '/^#/d; /^[^.]+\.name=/p' $(BOARDS_FILE) | \
344
308
                sed -Ee 's/([^.]+)\.name=(.*)/\1            \2/' \
345
309
                        -e 's/(.{12}) *(.*)/\1 \2/'
346
310
 
350
314
                exit 1; }
351
315
        @test -n `which screen` || { \
352
316
                echo "error: can't find GNU screen, you might need to install it." >&2 \
353
 
                exit 1; }
 
317
                ecit 1; }
354
318
        @test 0 -eq $(SERIALDEVGUESS) || { \
355
319
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
356
320
                echo; }
359
323
size: $(TARGET).elf
360
324
        echo && $(AVRSIZE) --format=avr --mcu=$(BOARD_BUILD_MCU) $(TARGET).elf
361
325
 
362
 
bootloader:
363
 
        @echo "Burning bootloader to board..."
364
 
        @test -n "$(SERIALDEV)" || { \
365
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
366
 
                exit 1; }
367
 
        @test 0 -eq $(SERIALDEVGUESS) || { \
368
 
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
369
 
                echo; }
370
 
        stty $(STTYFARG) $(SERIALDEV) hupcl
371
 
        $(AVRDUDE) $(AVRDUDEFLAGS) -U lock:w:$(BOARD_BOOTLOADER_UNLOCK):m
372
 
        $(AVRDUDE) $(AVRDUDEFLAGS) -eU lfuse:w:$(BOARD_BOOTLOADER_LFUSES):m
373
 
        $(AVRDUDE) $(AVRDUDEFLAGS) -U hfuse:w:$(BOARD_BOOTLOADER_HFUSES):m
374
 
ifneq "$(BOARD_BOOTLOADER_EFUSES)" ""
375
 
        $(AVRDUDE) $(AVRDUDEFLAGS) -U efuse:w:$(BOARD_BOOTLOADER_EFUSES):m
376
 
endif
377
 
ifneq "$(BOOTLOADERHEX)" ""
378
 
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(BOOTLOADERHEX):i
379
 
endif
380
 
        $(AVRDUDE) $(AVRDUDEFLAGS) -U lock:w:$(BOARD_BOOTLOADER_LOCK):m
381
 
 
382
326
# building the target
383
327
 
384
328
$(TARGET).hex: $(TARGET).elf
411
355
 
412
356
%.o: %.pde
413
357
        mkdir -p .dep/$(dir $<)
414
 
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<
 
358
        $(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ -x c++ -include $(ARDUINOCOREDIR)/Arduino.h $<
415
359
 
416
360
# building the arduino library
417
361
 
433
377
.lib/%.C.o: %.C
434
378
        mkdir -p $(dir $@)
435
379
        $(COMPILE.cpp) -o $@ $<
436
 
 
437
 
# Local Variables:
438
 
# mode: makefile
439
 
# tab-width: 4
440
 
# End: