/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-01-26 12:36:55 UTC
  • Revision ID: edam@waxworlds.org-20120126123655-hvebajnzf7z94fk3
cleaned up comments

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.3
 
5
#                                                                    version 0.1
6
6
#
7
 
# Copyright (C) 2011, 1012 Tim Marston <tim@ed.am>.
 
7
# Copyright (c) 2011 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 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 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.
35
36
#
36
37
#   http://ed.am/dev/make/arduino-mk
37
38
#
42
43
#
43
44
#   $ ln -s ~/src/arduino.mk Makefile
44
45
#
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
 
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
54
49
# your ~/.profile by adding something like this:
55
50
#
56
51
#   export ARDUINODIR=~/somewhere/arduino-1.0
57
52
#
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:
 
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:
62
56
#
63
57
#   $ export BOARD=uno
64
58
#   $ make
65
59
#
66
60
# You may also need to set SERIALDEV if it is not detected correctly.
67
61
#
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.
 
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.
73
67
#
74
68
# Alternatively, if you want to manually specify build variables, create a
75
 
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
 
69
# Makefile that defines SOURCES and LIBRARARIES and then includes arduino.mk.
76
70
# (There is no need to define TARGET).  Here is an example Makefile:
77
71
#
78
72
#   SOURCES := main.cc other.cc
81
75
#
82
76
# Here is a complete list of configuration parameters:
83
77
#
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.
 
78
# ARDUINODIR   The path where you have installed/unpacked the arduino software
 
79
#              (from http://arduino.cc/)
96
80
#
97
81
# BOARD        Specify a target board type.  Run `make boards` to see available
98
82
#              board types.
99
83
#
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.
 
84
# SERIALDEV    The unix device of the device where the arduino can be found.
104
85
#              If unspecified, an attempt is made to determine the name of a
105
 
#              connected Arduino's serial device.
 
86
#              connected arduino's serial device.
 
87
#
 
88
# 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
 
90
#              otherwise.
106
91
#
107
92
# SOURCES      A list of all source files of whatever language.  The language
108
93
#              type is determined by the file extension.  This is set
109
 
#              automatically if a .ino (or .pde) is found.
 
94
#              automatically if a .ino or .pde is found.
110
95
#
111
 
# TARGET       The name of the target file.  This is set automatically if a
112
 
#              .ino (or .pde) is found, but it is not necessary to set it
113
 
#              otherwise.
 
96
# LIBRARIES    A list of arduino libraries to build and include.  This is set
 
97
#              automatically if a .ino or .pde is found.
114
98
#
115
99
# This makefile also defines the following goals for use on the command line
116
100
# when you run make:
120
104
#
121
105
# target       Builds the target.
122
106
#
123
 
# upload       Uploads the last built target to an attached Arduino.
 
107
# upload       Uploads the last built target to an attached arduino.
124
108
#
125
109
# clean        Deletes files created during the build.
126
110
#
127
111
# boards       Display a list of available board names, so that you can set the
128
112
#              BOARD environment variable appropriately.
129
113
#
130
 
# monitor      Start `screen` on the serial device.  This is meant to be an
131
 
#              equivalent to the Arduino serial monitor.
 
114
# monitor      Start `screen` on the serial device.  It is ment to be an
 
115
#              equivelant to the arduino serial monitor.
132
116
#
133
117
# <file>       Builds the specified file, either an object file or the target,
134
118
#              from those that that would be built for the project.
135
119
#_______________________________________________________________________________
136
120
#
137
121
 
138
 
# default arduino software directory, check software exists
 
122
# The full path to the arduino software, from arduino.cc
139
123
ifndef ARDUINODIR
140
 
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))
 
124
ARDUINODIR := $(wildcard ~/opt/arduino)
141
125
endif
142
 
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
 
126
 
 
127
# check arduino software
 
128
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
143
129
$(error ARDUINODIR is not set correctly; arduino software not found)
144
130
endif
145
131
 
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
 
 
156
132
# auto mode?
157
133
INOFILE := $(wildcard *.ino *.pde)
158
134
ifdef INOFILE
159
 
ifneq "$(words $(INOFILE))" "1"
 
135
ifneq ($(words $(INOFILE)), 1)
160
136
$(error There is more than one .pde or .ino file in this directory!)
161
137
endif
162
 
 
163
 
# automatically determine sources and targeet
164
138
TARGET := $(basename $(INOFILE))
165
139
SOURCES := $(INOFILE) \
166
140
        $(wildcard *.c *.cc *.cpp) \
167
141
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
168
142
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
169
 
 
170
143
# automatically determine included libraries
171
144
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
172
145
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
173
146
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
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)
 
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
193
167
 
194
168
# files
195
 
TARGET := $(if $(TARGET),$(TARGET),a.out)
196
169
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
197
170
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
198
 
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
199
171
ARDUINOLIB := _arduino.a
200
 
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
 
172
ARDUINOLIBTMP := _arduino.a.tmp
201
173
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
202
174
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
203
175
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
204
176
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
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
 
177
        $(wildcard $(addprefix $(ARDUINODIR)/libraries/$(lib)/, *.c *.cpp))))))
223
178
 
224
179
# obtain board parameters from the arduino boards.txt file
225
180
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
234
189
BOARD_UPLOAD_PROTOCOL := \
235
190
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
236
191
 
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
 
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
245
199
 
246
200
# flags
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)
 
201
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
 
202
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
251
203
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
252
204
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
253
205
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
254
206
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
255
 
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
 
207
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
256
208
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
257
209
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
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)
 
210
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
262
211
 
263
212
# default rule
264
213
.DEFAULT_GOAL := all
273
222
target: $(TARGET).hex
274
223
 
275
224
upload:
276
 
        @echo "\nUploading to board..."
277
 
        @test -n "$(SERIALDEV)" || { \
278
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
279
 
                exit 1; }
280
 
        @test 0 -eq $(SERIALDEVGUESS) || { \
281
 
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
282
 
                echo; }
283
 
        stty $(STTYFARG) $(SERIALDEV) hupcl
 
225
        stty -F $(SERIALDEV) hupcl
284
226
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
285
227
 
286
228
clean:
294
236
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
295
237
 
296
238
monitor:
297
 
        @test -n "$(SERIALDEV)" || { \
298
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
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; }
306
239
        screen $(SERIALDEV)
307
240
 
308
241
# building the target
344
277
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
345
278
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
346
279
        $(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 $@ $<