/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-02-21 15:27:09 UTC
  • Revision ID: tim@ed.am-20120221152709-zo3surexmx2789wn
added THANKS, fixed ARDUINODIR default to look in /usr/share/arduino and capitalised the use of "Arduino" where appropriate.

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.1
 
5
#                                                                    version 0.3
6
6
#
7
 
# Copyright (c) 2011 Tim Marston <tim@ed.am>.
 
7
# Copyright (C) 2011, 1012 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 release and requires that software
32
 
# to be downloaded separately (see http://arduino.cc/).  To download the latest
33
 
# version of this makefile, visit the following website, where you can also
34
 
# find more information and documentation on it's use.  The following text can
35
 
# only really be considered a reference to it's use.
 
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.
36
35
#
37
36
#   http://ed.am/dev/make/arduino-mk
38
37
#
43
42
#
44
43
#   $ ln -s ~/src/arduino.mk Makefile
45
44
#
46
 
# You also need to set up a couple of environment varibales. ARDUINODIR should
47
 
# be set to the path where you unpacked the arduino software from arduino.cc
48
 
# (it defaults to ~/opt/arduino if unset).  You might be best to set this in
 
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.
 
49
#
 
50
# 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
49
54
# your ~/.profile by adding something like this:
50
55
#
51
56
#   export ARDUINODIR=~/somewhere/arduino-1.0
52
57
#
53
 
# You will also need to set BOARD to the type of arduino you're using.  This
54
 
# can be done when running make (or you could set a default in ~/.profile and
55
 
# iverride it as necessary).  For example:
 
58
# You will also need to set BOARD to the type of Arduino you're building for.
 
59
# You could set a default in your ~/.profile if you want, but it is suggested
 
60
# that you specify this at build time, especially if you work with different
 
61
# types of Arduino.  For example:
56
62
#
57
63
#   $ export BOARD=uno
58
64
#   $ make
59
65
#
60
66
# You may also need to set SERIALDEV if it is not detected correctly.
61
67
#
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.
 
68
# The presence of a .ino (or .pde) file causes the arduino.mk to automatically
 
69
# determine values for SOURCES, TARGET and LIBRARIES.  Any .c, .cc and .cpp
 
70
# files in the project directory (or any "util" or "utility" subdirectories)
 
71
# are automatically included in the build and are scanned for Arduino libraries
 
72
# that have been #included. Note, there can only be one .ino (or .pde) file.
67
73
#
68
74
# Alternatively, if you want to manually specify build variables, create a
69
 
# Makefile that defines SOURCES and LIBRARARIES and then includes arduino.mk.
 
75
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
70
76
# (There is no need to define TARGET).  Here is an example Makefile:
71
77
#
72
78
#   SOURCES := main.cc other.cc
75
81
#
76
82
# Here is a complete list of configuration parameters:
77
83
#
78
 
# ARDUINODIR   The path where you have installed/unpacked the arduino software
79
 
#              (from http://arduino.cc/)
 
84
# ARDUINODIR   The path where the Arduino software is installed on your system.
 
85
#
 
86
# ARDUINOCONST The Arduino software version, as an integer, used to define the
 
87
#              ARDUINO version constant. This defaults to 100 if undefined.
 
88
#
 
89
# AVRDUDECONF  The avrdude.conf to use. If undefined, this defaults to a guess
 
90
#              based on where the avrdude in use is. If empty, no avrdude.conf
 
91
#              is passed to avrdude (to the system default is used).
 
92
#
 
93
# AVRTOOLSPATH A space-separated list of directories to search in order when
 
94
#              lookin for the avr build tools. This defaults to the system PATH
 
95
#              followed by subdirectories in ARDUINODIR if undefined.
80
96
#
81
97
# BOARD        Specify a target board type.  Run `make boards` to see available
82
98
#              board types.
83
99
#
84
 
# SERIALDEV    The unix device of the device where the arduino can be found.
 
100
# LIBRARIES    A list of Arduino libraries to build and include.  This is set
 
101
#              automatically if a .ino (or .pde) is found.
 
102
#
 
103
# SERIALDEV    The unix device name of the serial device that is the Arduino.
85
104
#              If unspecified, an attempt is made to determine the name of a
86
 
#              connected arduino's serial device.
 
105
#              connected Arduino's serial device.
 
106
#
 
107
# SOURCES      A list of all source files of whatever language.  The language
 
108
#              type is determined by the file extension.  This is set
 
109
#              automatically if a .ino (or .pde) is found.
87
110
#
88
111
# 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
 
112
#              .ino (or .pde) is found, but it is not necessary to set it
90
113
#              otherwise.
91
114
#
92
 
# SOURCES      A list of all source files of whatever language.  The language
93
 
#              type is determined by the file extension.  This is set
94
 
#              automatically if a .ino or .pde is found.
95
 
#
96
 
# LIBRARIES    A list of arduino libraries to build and include.  This is set
97
 
#              automatically if a .ino or .pde is found.
98
 
#
99
115
# This makefile also defines the following goals for use on the command line
100
116
# when you run make:
101
117
#
104
120
#
105
121
# target       Builds the target.
106
122
#
107
 
# upload       Uploads the last built target to an attached arduino.
 
123
# upload       Uploads the last built target to an attached Arduino.
108
124
#
109
125
# clean        Deletes files created during the build.
110
126
#
111
127
# boards       Display a list of available board names, so that you can set the
112
128
#              BOARD environment variable appropriately.
113
129
#
114
 
# monitor      Start `screen` on the serial device.  It is ment to be an
115
 
#              equivelant to the arduino serial monitor.
 
130
# monitor      Start `screen` on the serial device.  This is meant to be an
 
131
#              equivalent to the Arduino serial monitor.
116
132
#
117
133
# <file>       Builds the specified file, either an object file or the target,
118
134
#              from those that that would be built for the project.
119
135
#_______________________________________________________________________________
120
136
#
121
137
 
122
 
# The full path to the arduino software, from arduino.cc
 
138
# default arduino software directory, check software exists
123
139
ifndef ARDUINODIR
124
 
ARDUINODIR := $(wildcard ~/opt/arduino)
 
140
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))
125
141
endif
126
 
 
127
 
# check arduino software
128
 
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
 
142
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
129
143
$(error ARDUINODIR is not set correctly; arduino software not found)
130
144
endif
131
145
 
 
146
# default arduino version
 
147
ARDUINOCONST ?= 100
 
148
 
 
149
# default path for avr tools
 
150
ifndef AVRTOOLSPATH
 
151
AVRTOOLSPATH := $(subst :, , $(PATH))
 
152
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools
 
153
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
 
154
endif
 
155
 
132
156
# auto mode?
133
157
INOFILE := $(wildcard *.ino *.pde)
134
158
ifdef INOFILE
135
 
ifneq ($(words $(INOFILE)), 1)
 
159
ifneq "$(words $(INOFILE))" "1"
136
160
$(error There is more than one .pde or .ino file in this directory!)
137
161
endif
 
162
 
 
163
# automatically determine sources and targeet
138
164
TARGET := $(basename $(INOFILE))
139
165
SOURCES := $(INOFILE) \
140
166
        $(wildcard *.c *.cc *.cpp) \
141
167
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
142
168
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
 
169
 
143
170
# automatically determine included libraries
144
171
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
145
172
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
146
173
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
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
 
174
 
 
175
endif
 
176
 
 
177
# no serial device? make a poor attempt to detect an arduino
 
178
SERIALDEVGUESS := 0
 
179
ifeq "$(SERIALDEV)" ""
 
180
SERIALDEV := $(firstword $(wildcard \
 
181
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbmodem*))
 
182
SERIALDEVGUESS := 1
 
183
endif
 
184
 
 
185
# software
 
186
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
 
187
CC := $(call findsoftware,avr-gcc)
 
188
CXX := $(call findsoftware,avr-g++)
 
189
LD := $(call findsoftware,avr-ld)
 
190
AR := $(call findsoftware,avr-ar)
 
191
OBJCOPY := $(call findsoftware,avr-objcopy)
 
192
AVRDUDE := $(call findsoftware,avrdude)
167
193
 
168
194
# files
 
195
TARGET := $(if $(TARGET),$(TARGET),a.out)
169
196
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
170
197
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
 
198
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
171
199
ARDUINOLIB := _arduino.a
172
 
ARDUINOLIBTMP := _arduino.a.tmp
 
200
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
173
201
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
174
202
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
175
203
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
176
204
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
177
 
        $(wildcard $(addprefix $(ARDUINODIR)/libraries/$(lib)/, *.c *.cpp))))))
 
205
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
 
206
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
 
207
ifeq "$(AVRDUDECONF)" ""
 
208
ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"
 
209
AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf
 
210
else
 
211
AVRDUDECONF := $(wildcard $(AVRDUDE).conf)
 
212
endif
 
213
endif
 
214
 
 
215
# no board?
 
216
ifndef BOARD
 
217
ifneq "$(MAKECMDGOALS)" "boards"
 
218
ifneq "$(MAKECMDGOALS)" "clean"
 
219
$(error BOARD is unset.  Type 'make boards' to see possible values)
 
220
endif
 
221
endif
 
222
endif
178
223
 
179
224
# obtain board parameters from the arduino boards.txt file
180
225
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
189
234
BOARD_UPLOAD_PROTOCOL := \
190
235
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
191
236
 
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
 
237
# invalid board?
 
238
ifeq "$(BOARD_BUILD_MCU)" ""
 
239
ifneq "$(MAKECMDGOALS)" "boards"
 
240
ifneq "$(MAKECMDGOALS)" "clean"
 
241
$(error BOARD is invalid.  Type 'make boards' to see possible values)
 
242
endif
 
243
endif
 
244
endif
199
245
 
200
246
# flags
201
 
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
202
 
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
 
247
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
 
248
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
 
249
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
 
250
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
203
251
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
204
252
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
205
253
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
206
254
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
207
 
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
 
255
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
208
256
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
209
257
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
210
 
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
 
258
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
 
259
 
 
260
# figure out which arg to use with stty
 
261
STTYFARG := $(shell stty --help > /dev/null 2>&1 && echo -F || echo -f)
211
262
 
212
263
# default rule
213
264
.DEFAULT_GOAL := all
226
277
        @test -n "$(SERIALDEV)" || { \
227
278
                echo "error: SERIALDEV could not be determined automatically." >&2; \
228
279
                exit 1; }
229
 
        stty -F $(SERIALDEV) hupcl
 
280
        @test 0 -eq $(SERIALDEVGUESS) || { \
 
281
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
 
282
                echo; }
 
283
        stty $(STTYFARG) $(SERIALDEV) hupcl
230
284
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
231
285
 
232
286
clean:
243
297
        @test -n "$(SERIALDEV)" || { \
244
298
                echo "error: SERIALDEV could not be determined automatically." >&2; \
245
299
                exit 1; }
 
300
        @test -n `which screen` || { \
 
301
                echo "error: can't find GNU screen, you might need to install it." >&2 \
 
302
                ecit 1; }
 
303
        @test 0 -eq $(SERIALDEVGUESS) || { \
 
304
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
 
305
                echo; }
246
306
        screen $(SERIALDEV)
247
307
 
248
308
# building the target
284
344
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
285
345
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
286
346
        $(COMPILE.cpp) -o $@ $<
 
347
 
 
348
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c
 
349
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
350
        $(COMPILE.c) -o $@ $<
 
351
 
 
352
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp
 
353
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
354
        $(COMPILE.cpp) -o $@ $<