/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:
43
43
#
44
44
#   $ ln -s ~/src/arduino.mk Makefile
45
45
#
46
 
# You also need to set up a couple of environment variables. ARDUINODIR should
 
46
# You also need to set up a couple of environment varibales. ARDUINODIR should
47
47
# be set to the path where you unpacked the arduino software from arduino.cc
48
48
# (it defaults to ~/opt/arduino if unset).  You might be best to set this in
49
49
# your ~/.profile by adding something like this:
52
52
#
53
53
# You will also need to set BOARD to the type of arduino you're using.  This
54
54
# can be done when running make (or you could set a default in ~/.profile and
55
 
# override it as necessary).  For example:
 
55
# iverride it as necessary).  For example:
56
56
#
57
57
#   $ export BOARD=uno
58
58
#   $ make
59
59
#
60
60
# You may also need to set SERIALDEV if it is not detected correctly.
61
61
#
62
 
# The presence of a .ino (or .pde) file causes the arduino.mk to automatically
63
 
# determine values for SOURCES, TARGET and LIBRARIES.  Any .c, .cc and .cpp
64
 
# files in the project directory (or any "util" or "utility" subdirectories)
65
 
# are automatically included in the build and are scanned for Arduino libraries
66
 
# 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.
67
67
#
68
68
# Alternatively, if you want to manually specify build variables, create a
69
 
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
 
69
# Makefile that defines SOURCES and LIBRARARIES and then includes arduino.mk.
70
70
# (There is no need to define TARGET).  Here is an example Makefile:
71
71
#
72
72
#   SOURCES := main.cc other.cc
78
78
# ARDUINODIR   The path where you have installed/unpacked the arduino software
79
79
#              (from http://arduino.cc/)
80
80
#
81
 
# ARDUINOCONST The arduino software version, as an integer, used to define the
82
 
#              ARDUINO version constant. This defaults to 100 if unset.
83
 
#
84
 
# AVRTOOLSPATH A space-separated list of directories to search in order when
85
 
#              lookin for the avr build tools. This defaults to the system PATH
86
 
#              followed by subdirectories in ARDUINODIR if unset.
87
 
#
88
81
# BOARD        Specify a target board type.  Run `make boards` to see available
89
82
#              board types.
90
83
#
91
 
# LIBRARIES    A list of arduino libraries to build and include.  This is set
92
 
#              automatically if a .ino (or .pde) is found.
93
 
#
94
 
# 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.
95
85
#              If unspecified, an attempt is made to determine the name of a
96
86
#              connected arduino's serial device.
97
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.
 
91
#
98
92
# SOURCES      A list of all source files of whatever language.  The language
99
93
#              type is determined by the file extension.  This is set
100
 
#              automatically if a .ino (or .pde) is found.
 
94
#              automatically if a .ino or .pde is found.
101
95
#
102
 
# TARGET       The name of the target file.  This is set automatically if a
103
 
#              .ino (or .pde) is found, but it is not necessary to set it
104
 
#              otherwise.
 
96
# LIBRARIES    A list of arduino libraries to build and include.  This is set
 
97
#              automatically if a .ino or .pde is found.
105
98
#
106
99
# This makefile also defines the following goals for use on the command line
107
100
# when you run make:
118
111
# boards       Display a list of available board names, so that you can set the
119
112
#              BOARD environment variable appropriately.
120
113
#
121
 
# monitor      Start `screen` on the serial device.  This is meant to be an
122
 
#              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.
123
116
#
124
117
# <file>       Builds the specified file, either an object file or the target,
125
118
#              from those that that would be built for the project.
126
119
#_______________________________________________________________________________
127
120
#
128
121
 
129
 
# default arduino software directory, check software exists
 
122
# The full path to the arduino software, from arduino.cc
130
123
ifndef ARDUINODIR
131
124
ARDUINODIR := $(wildcard ~/opt/arduino)
132
125
endif
 
126
 
 
127
# check arduino software
133
128
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
134
129
$(error ARDUINODIR is not set correctly; arduino software not found)
135
130
endif
136
131
 
137
 
# default arduino version
138
 
ARDUINOCONST ?= 100
139
 
 
140
 
# default path for avr tools
141
 
ifndef AVRTOOLSPATH
142
 
AVRTOOLSPATH := $(subst :, , $(PATH))
143
 
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools
144
 
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
145
 
endif
146
 
 
147
132
# auto mode?
148
133
INOFILE := $(wildcard *.ino *.pde)
149
134
ifdef INOFILE
150
135
ifneq ($(words $(INOFILE)), 1)
151
136
$(error There is more than one .pde or .ino file in this directory!)
152
137
endif
153
 
 
154
 
# automatically determine sources and targeet
155
138
TARGET := $(basename $(INOFILE))
156
139
SOURCES := $(INOFILE) \
157
140
        $(wildcard *.c *.cc *.cpp) \
158
141
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
159
142
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
160
 
 
161
143
# automatically determine included libraries
162
144
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
163
145
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
164
146
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
165
 
 
 
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?))
166
157
endif
167
158
 
168
159
# no board? oh dear...
174
165
endif
175
166
endif
176
167
 
177
 
# no serial device? make a poor attempt to detect an arduino
178
 
ifeq ($(SERIALDEV), )
179
 
SERIALDEV := $(firstword $(wildcard /dev/ttyACM? /dev/ttyUSB?))
180
 
endif
181
 
 
182
 
# software
183
 
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
184
 
CC := $(call findsoftware,avr-gcc)
185
 
CXX := $(call findsoftware,avr-g++)
186
 
LD := $(call findsoftware,avr-ld)
187
 
AR := $(call findsoftware,avr-ar)
188
 
OBJCOPY := $(call findsoftware,avr-objcopy)
189
 
AVRDUDE := $(call findsoftware,avrdude)
190
 
 
191
168
# files
192
 
TARGET := $(if $(TARGET), $(TARGET), a.out)
193
169
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
194
170
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
195
 
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
196
171
ARDUINOLIB := _arduino.a
197
 
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
 
172
ARDUINOLIBTMP := _arduino.a.tmp
198
173
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
199
174
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
200
175
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
201
176
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
202
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
203
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
204
 
AVRDUDECONF := $(wildcard $(AVRDUDE).conf)
 
177
        $(wildcard $(addprefix $(ARDUINODIR)/libraries/$(lib)/, *.c *.cpp))))))
205
178
 
206
179
# obtain board parameters from the arduino boards.txt file
207
180
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
216
189
BOARD_UPLOAD_PROTOCOL := \
217
190
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
218
191
 
 
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
 
199
 
219
200
# flags
220
 
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
221
 
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
222
 
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
223
 
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)
224
203
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
225
204
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
226
205
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
227
206
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
228
 
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
 
207
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
229
208
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
230
209
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
231
 
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
 
210
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
232
211
 
233
212
# default rule
234
213
.DEFAULT_GOAL := all
243
222
target: $(TARGET).hex
244
223
 
245
224
upload:
246
 
        @echo "\nUploading to board..."
247
 
        @test -n "$(SERIALDEV)" || { \
248
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
249
 
                exit 1; }
250
225
        stty -F $(SERIALDEV) hupcl
251
226
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
252
227
 
261
236
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
262
237
 
263
238
monitor:
264
 
        @test -n "$(SERIALDEV)" || { \
265
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
266
 
                exit 1; }
267
 
        @test -n `which screen` || { \
268
 
                echo "error: can't find GNU screen, you might need to install it." >&2 \
269
 
                ecit 1; }
270
239
        screen $(SERIALDEV)
271
240
 
272
241
# building the target
308
277
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
309
278
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
310
279
        $(COMPILE.cpp) -o $@ $<
311
 
 
312
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c
313
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
314
 
        $(COMPILE.c) -o $@ $<
315
 
 
316
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp
317
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
318
 
        $(COMPILE.cpp) -o $@ $<