/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: 2013-01-04 16:45:47 UTC
  • Revision ID: tim@ed.am-20130104164547-xxr8xicwbxzrdn67
updated TODO

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
 
# 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.
 
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.
97
100
#
98
101
# BOARD        Specify a target board type.  Run `make boards` to see available
99
102
#              board types.
100
103
#
 
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
#
101
110
# LIBRARIES    A list of Arduino libraries to build and include.  This is set
102
111
#              automatically if a .ino (or .pde) is found.
103
112
#
 
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
#
104
117
# SERIALDEV    The unix device name of the serial device that is the Arduino.
105
118
#              If unspecified, an attempt is made to determine the name of a
106
119
#              connected Arduino's serial device.
133
146
#
134
147
# size         Displays size information about the bulit target.
135
148
#
 
149
# bootloader   Burns the bootloader for your board to it.
 
150
#
136
151
# <file>       Builds the specified file, either an object file or the target,
137
152
#              from those that that would be built for the project.
138
153
#_______________________________________________________________________________
150
165
ARDUINOCONST ?= 100
151
166
 
152
167
# default path for avr tools
153
 
ifndef AVRTOOLSPATH
154
 
AVRTOOLSPATH := $(subst :, , $(PATH))
155
 
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools
156
 
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
157
 
endif
 
168
AVRTOOLSPATH ?= $(subst :, , $(PATH)) $(ARDUINODIR)/hardware/tools \
 
169
        $(ARDUINODIR)/hardware/tools/avr/bin
158
170
 
159
171
# default path to find libraries
160
 
LIBRARIESPATH := libraries libs $(ARDUINODIR)/libraries
 
172
LIBRARYPATH ?= libraries libs $(SKETCHBOOKDIR)/libraries $(ARDUINODIR)/libraries
 
173
 
 
174
# default serial device to a poor guess (something that might be an arduino)
 
175
SERIALDEVGUESS := 0
 
176
ifndef SERIALDEV
 
177
SERIALDEV := $(firstword $(wildcard \
 
178
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))
 
179
SERIALDEVGUESS := 1
 
180
endif
 
181
 
 
182
# no board?
 
183
ifndef BOARD
 
184
ifneq "$(MAKECMDGOALS)" "boards"
 
185
ifneq "$(MAKECMDGOALS)" "clean"
 
186
$(error BOARD is unset.  Type 'make boards' to see possible values)
 
187
endif
 
188
endif
 
189
endif
 
190
 
 
191
# obtain board parameters from the arduino boards.txt file
 
192
BOARDSFILE := $(ARDUINODIR)/hardware/arduino/boards.txt
 
193
readboardsparam = $(shell sed -ne "s/$(BOARD).$(1)=\(.*\)/\1/p" $(BOARDSFILE))
 
194
BOARD_BUILD_MCU := $(call readboardsparam,build.mcu)
 
195
BOARD_BUILD_FCPU := $(call readboardsparam,build.f_cpu)
 
196
BOARD_BUILD_VARIANT := $(call readboardsparam,build.variant)
 
197
BOARD_UPLOAD_SPEED := $(call readboardsparam,upload.speed)
 
198
BOARD_UPLOAD_PROTOCOL := $(call readboardsparam,upload.protocol)
 
199
BOARD_USB_VID := $(call readboardsparam,build.vid)
 
200
BOARD_USB_PID := $(call readboardsparam,build.pid)
 
201
BOARD_BOOTLOADER_UNLOCK := $(call readboardsparam,bootloader.unlock_bits)
 
202
BOARD_BOOTLOADER_LOCK := $(call readboardsparam,bootloader.lock_bits)
 
203
BOARD_BOOTLOADER_LFUSES := $(call readboardsparam,bootloader.low_fuses)
 
204
BOARD_BOOTLOADER_HFUSES := $(call readboardsparam,bootloader.high_fuses)
 
205
BOARD_BOOTLOADER_EFUSES := $(call readboardsparam,bootloader.extended_fuses)
 
206
BOARD_BOOTLOADER_PATH := $(call readboardsparam,bootloader.path)
 
207
BOARD_BOOTLOADER_FILE := $(call readboardsparam,bootloader.file)
 
208
 
 
209
# obtain preferences from the IDE's preferences.txt
 
210
PREFERENCESFILE := $(wildcard $(HOME)/.arduino/preferences.txt)
 
211
ifneq "$(PREFERENCESFILE)" ""
 
212
readpreferencesparam = $(shell sed -ne "s/$(1)=\(.*\)/\1/p" $(PREFERENCESFILE))
 
213
SKETCHBOOKDIR := $(call readpreferencesparam,sketchbook.path)
 
214
endif
 
215
 
 
216
# invalid board?
 
217
ifeq "$(BOARD_BUILD_MCU)" ""
 
218
ifneq "$(MAKECMDGOALS)" "boards"
 
219
ifneq "$(MAKECMDGOALS)" "clean"
 
220
$(error BOARD is invalid.  Type 'make boards' to see possible values)
 
221
endif
 
222
endif
 
223
endif
161
224
 
162
225
# auto mode?
163
226
INOFILE := $(wildcard *.ino *.pde)
174
237
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp *.C))
175
238
 
176
239
# automatically determine included libraries
177
 
LIBRARIES := $(filter $(notdir $(wildcard $(addsuffix /*, $(LIBRARIESPATH)))), \
 
240
LIBRARIES := $(filter $(notdir $(wildcard $(addsuffix /*, $(LIBRARYPATH)))), \
178
241
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
179
242
 
180
243
endif
181
244
 
182
 
# no serial device? make a poor attempt to detect an arduino
183
 
SERIALDEVGUESS := 0
184
 
ifeq "$(SERIALDEV)" ""
185
 
SERIALDEV := $(firstword $(wildcard \
186
 
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))
187
 
SERIALDEVGUESS := 1
188
 
endif
189
 
 
190
245
# software
191
246
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
192
247
CC := $(call findsoftware,avr-gcc)
197
252
AVRDUDE := $(call findsoftware,avrdude)
198
253
AVRSIZE := $(call findsoftware,avr-size)
199
254
 
 
255
# directories
 
256
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
 
257
LIBRARYDIRS := $(foreach lib, $(LIBRARIES), \
 
258
        $(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARYPATH)))))
 
259
LIBRARYDIRS += $(addsuffix /utility, $(LIBRARYDIRS))
 
260
 
200
261
# files
201
262
TARGET := $(if $(TARGET),$(TARGET),a.out)
202
263
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
203
264
DEPFILES := $(patsubst %, .dep/%.dep, $(SOURCES))
204
 
 
205
 
# directories
206
 
LIBRARIESDIRS := $(foreach lib, $(LIBRARIES), \
207
 
        $(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARIESPATH)))))
208
 
LIBRARIESDIRS += $(addsuffix /utility, $(LIBRARIESDIRS))
209
 
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
210
 
 
211
 
# static arduino lib
212
265
ARDUINOLIB := .lib/arduino.a
213
 
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(LIBRARIESDIRS), \
 
266
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(LIBRARYDIRS), \
214
267
        $(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, *.c *.cpp))))
 
268
BOOTLOADERHEX := $(addprefix \
 
269
        $(ARDUINODIR)/hardware/arduino/bootloaders/$(BOARD_BOOTLOADER_PATH)/, \
 
270
        $(BOARD_BOOTLOADER_FILE))
215
271
 
216
272
# avrdude confifuration
217
273
ifeq "$(AVRDUDECONF)" ""
222
278
endif
223
279
endif
224
280
 
225
 
# no board?
226
 
ifndef BOARD
227
 
ifneq "$(MAKECMDGOALS)" "boards"
228
 
ifneq "$(MAKECMDGOALS)" "clean"
229
 
$(error BOARD is unset.  Type 'make boards' to see possible values)
230
 
endif
231
 
endif
232
 
endif
233
 
 
234
 
# obtain board parameters from the arduino boards.txt file
235
 
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
236
 
BOARD_BUILD_MCU := \
237
 
        $(shell sed -ne "s/$(BOARD).build.mcu=\(.*\)/\1/p" $(BOARDS_FILE))
238
 
BOARD_BUILD_FCPU := \
239
 
        $(shell sed -ne "s/$(BOARD).build.f_cpu=\(.*\)/\1/p" $(BOARDS_FILE))
240
 
BOARD_BUILD_VARIANT := \
241
 
        $(shell sed -ne "s/$(BOARD).build.variant=\(.*\)/\1/p" $(BOARDS_FILE))
242
 
BOARD_UPLOAD_SPEED := \
243
 
        $(shell sed -ne "s/$(BOARD).upload.speed=\(.*\)/\1/p" $(BOARDS_FILE))
244
 
BOARD_UPLOAD_PROTOCOL := \
245
 
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
246
 
BOARD_USB_VID := \
247
 
        $(shell sed -ne "s/$(BOARD).build.vid=\(.*\)/\1/p" $(BOARDS_FILE))
248
 
BOARD_USB_PID := \
249
 
        $(shell sed -ne "s/$(BOARD).build.pid=\(.*\)/\1/p" $(BOARDS_FILE))
250
 
 
251
 
# invalid board?
252
 
ifeq "$(BOARD_BUILD_MCU)" ""
253
 
ifneq "$(MAKECMDGOALS)" "boards"
254
 
ifneq "$(MAKECMDGOALS)" "clean"
255
 
$(error BOARD is invalid.  Type 'make boards' to see possible values)
256
 
endif
257
 
endif
258
 
endif
259
 
 
260
281
# flags
261
282
CPPFLAGS += -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
262
283
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
265
286
CPPFLAGS += -DUSB_VID=$(BOARD_USB_VID) -DUSB_PID=$(BOARD_USB_PID)
266
287
CPPFLAGS += -I. -Iutil -Iutility -I $(ARDUINOCOREDIR)
267
288
CPPFLAGS += -I $(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
268
 
CPPFLAGS += $(addprefix -I , $(LIBRARIESDIRS))
 
289
CPPFLAGS += $(addprefix -I , $(LIBRARYDIRS))
269
290
CPPDEPFLAGS = -MMD -MP -MF .dep/$<.dep
270
291
CPPINOFLAGS := -x c++ -include $(ARDUINOCOREDIR)/Arduino.h
271
292
AVRDUDEFLAGS += $(addprefix -C , $(AVRDUDECONF)) -DV
288
309
#_______________________________________________________________________________
289
310
#                                                                          RULES
290
311
 
291
 
.PHONY: all target upload clean boards monitor size
 
312
.PHONY: all target upload clean boards monitor size bootloader
292
313
 
293
314
all: target
294
315
 
302
323
        @test 0 -eq $(SERIALDEVGUESS) || { \
303
324
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
304
325
                echo; }
 
326
ifeq "$(BOARD_BOOTLOADER_PATH)" "caterina"
 
327
        stty $(STTYFARG) $(SERIALDEV) speed 1200
 
328
        sleep 1
 
329
endif
305
330
        stty $(STTYFARG) $(SERIALDEV) hupcl
306
331
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
307
332
 
311
336
        rm -rf .lib .dep
312
337
 
313
338
boards:
314
 
        @echo Available values for BOARD:
315
 
        @sed -nEe '/^#/d; /^[^.]+\.name=/p' $(BOARDS_FILE) | \
 
339
        @echo "Available values for BOARD:"
 
340
        @sed -nEe '/^#/d; /^[^.]+\.name=/p' $(BOARDSFILE) | \
316
341
                sed -Ee 's/([^.]+)\.name=(.*)/\1            \2/' \
317
342
                        -e 's/(.{12}) *(.*)/\1 \2/'
318
343
 
322
347
                exit 1; }
323
348
        @test -n `which screen` || { \
324
349
                echo "error: can't find GNU screen, you might need to install it." >&2 \
325
 
                ecit 1; }
 
350
                exit 1; }
326
351
        @test 0 -eq $(SERIALDEVGUESS) || { \
327
352
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
328
353
                echo; }
331
356
size: $(TARGET).elf
332
357
        echo && $(AVRSIZE) --format=avr --mcu=$(BOARD_BUILD_MCU) $(TARGET).elf
333
358
 
 
359
bootloader:
 
360
        @echo "Burning bootloader to board..."
 
361
        @test -n "$(SERIALDEV)" || { \
 
362
                echo "error: SERIALDEV could not be determined automatically." >&2; \
 
363
                exit 1; }
 
364
        @test 0 -eq $(SERIALDEVGUESS) || { \
 
365
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
 
366
                echo; }
 
367
        stty $(STTYFARG) $(SERIALDEV) hupcl
 
368
        $(AVRDUDE) $(AVRDUDEFLAGS) -U lock:w:$(BOARD_BOOTLOADER_UNLOCK):m
 
369
        $(AVRDUDE) $(AVRDUDEFLAGS) -eU lfuse:w:$(BOARD_BOOTLOADER_LFUSES):m
 
370
        $(AVRDUDE) $(AVRDUDEFLAGS) -U hfuse:w:$(BOARD_BOOTLOADER_HFUSES):m
 
371
ifneq "$(BOARD_BOOTLOADER_EFUSES)" ""
 
372
        $(AVRDUDE) $(AVRDUDEFLAGS) -U efuse:w:$(BOARD_BOOTLOADER_EFUSES):m
 
373
endif
 
374
ifneq "$(BOOTLOADERHEX)" ""
 
375
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(BOOTLOADERHEX):i
 
376
endif
 
377
        $(AVRDUDE) $(AVRDUDEFLAGS) -U lock:w:$(BOARD_BOOTLOADER_LOCK):m
 
378
 
334
379
# building the target
335
380
 
336
381
$(TARGET).hex: $(TARGET).elf