/elec/propeller-clock

To get this branch, use:
bzr branch http://bzr.ed.am/elec/propeller-clock

« back to all changes in this revision

Viewing changes to arduino.mk

  • Committer: edam
  • Date: 2011-11-04 13:48:15 UTC
  • Revision ID: edam@waxworlds.org-20111104134815-kj7qdhqfbxaj1tng
finished writing up electronics notes

Show diffs side-by-side

added added

removed removed

Lines of Context:
arduino.mk
1
 
#_______________________________________________________________________________
2
 
#
3
 
#                         edam's arduino makefile
4
 
#_______________________________________________________________________________
5
 
#                                                                    version 0.1
6
 
#
7
 
# Copyright (c) 2011 Tim Marston <tim@ed.am>.
8
 
#
9
 
# Permission is hereby granted, free of charge, to any person obtaining a copy
10
 
# of this software and associated documentation files (the "Software"), to deal
11
 
# in the Software without restriction, including without limitation the rights
12
 
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13
 
# copies of the Software, and to permit persons to whom the Software is
14
 
# furnished to do so, subject to the following conditions:
15
 
#
16
 
# The above copyright notice and this permission notice shall be included in
17
 
# all copies or substantial portions of the Software.
18
 
#
19
 
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20
 
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21
 
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22
 
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23
 
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24
 
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25
 
# SOFTWARE.
26
 
#
27
 
#_______________________________________________________________________________
28
 
#
29
 
#
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.
36
 
#
37
 
#   http://ed.am/dev/make/arduino-mk
38
 
#
39
 
# This makefile can be used as a drop-in replacement for the Arduino IDE's
40
 
# build system.  To use it, save arduino.mk somewhere (I keep mine at
41
 
# ~/src/arduino.mk) and create a symlink to it in your project directory named
42
 
# "Makefile".  For example:
43
 
#
44
 
#   $ ln -s ~/src/arduino.mk Makefile
45
 
#
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
49
 
# your ~/.profile by adding something like this:
50
 
#
51
 
#   export ARDUINODIR=~/somewhere/arduino-1.0
52
 
#
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:
56
 
#
57
 
#   $ export BOARD=uno
58
 
#   $ make
59
 
#
60
 
# You may also need to set SERIALDEV if it is not detected correctly.
61
 
#
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
 
#
68
 
# Alternatively, if you want to manually specify build variables, create a
69
 
# Makefile that defines SOURCES and LIBRARARIES and then includes arduino.mk.
70
 
# (There is no need to define TARGET).  Here is an example Makefile:
71
 
#
72
 
#   SOURCES := main.cc other.cc
73
 
#   LIBRARIES := EEPROM
74
 
#   include ~/src/arduino.mk
75
 
#
76
 
# Here is a complete list of configuration parameters:
77
 
#
78
 
# ARDUINODIR   The path where you have installed/unpacked the arduino software
79
 
#              (from http://arduino.cc/)
80
 
#
81
 
# BOARD        Specify a target board type.  Run `make boards` to see available
82
 
#              board types.
83
 
#
84
 
# SERIALDEV    The unix device of the device where the arduino can be found.
85
 
#              If unspecified, an attempt is made to determine the name of a
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.
91
 
#
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
 
# This makefile also defines the following goals for use on the command line
100
 
# when you run make:
101
 
#
102
 
# all          This is the default if no goal is specified.  It builds the
103
 
#              target and uploads it.
104
 
#
105
 
# target       Builds the target.
106
 
#
107
 
# upload       Uploads the last built target to an attached arduino.
108
 
#
109
 
# clean        Deletes files created during the build.
110
 
#
111
 
# boards       Display a list of available board names, so that you can set the
112
 
#              BOARD environment variable appropriately.
113
 
#
114
 
# monitor      Start `screen` on the serial device.  It is ment to be an
115
 
#              equivelant to the arduino serial monitor.
116
 
#
117
 
# <file>       Builds the specified file, either an object file or the target,
118
 
#              from those that that would be built for the project.
119
 
#_______________________________________________________________________________
120
 
#
121
 
 
122
 
# The full path to the arduino software, from arduino.cc
123
 
ifndef ARDUINODIR
124
 
ARDUINODIR := $(wildcard ~/opt/arduino)
125
 
endif
126
 
 
127
 
# check arduino software
128
 
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
129
 
$(error ARDUINODIR is not set correctly; arduino software not found)
130
 
endif
131
 
 
132
 
# auto mode?
133
 
INOFILE := $(wildcard *.ino *.pde)
134
 
ifdef INOFILE
135
 
ifneq ($(words $(INOFILE)), 1)
136
 
$(error There is more than one .pde or .ino file in this directory!)
137
 
endif
138
 
TARGET := $(basename $(INOFILE))
139
 
SOURCES := $(INOFILE) \
140
 
        $(wildcard *.c *.cc *.cpp) \
141
 
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
142
 
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
143
 
# automatically determine included libraries
144
 
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
145
 
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
146
 
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
147
 
endif
148
 
 
149
 
# no target? use default
150
 
ifeq ($(TARGET), )
151
 
TARGET := a.out
152
 
endif
153
 
 
154
 
# no serial device? attempt to detect an arduino
155
 
ifeq ($(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
167
 
 
168
 
# files
169
 
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
170
 
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
171
 
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
172
 
ARDUINOLIB := _arduino.a
173
 
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
174
 
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
175
 
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
176
 
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
177
 
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
178
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
179
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
180
 
 
181
 
# obtain board parameters from the arduino boards.txt file
182
 
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
183
 
BOARD_BUILD_MCU := \
184
 
        $(shell sed -ne "s/$(BOARD).build.mcu=\(.*\)/\1/p" $(BOARDS_FILE))
185
 
BOARD_BUILD_FCPU := \
186
 
        $(shell sed -ne "s/$(BOARD).build.f_cpu=\(.*\)/\1/p" $(BOARDS_FILE))
187
 
BOARD_BUILD_VARIANT := \
188
 
        $(shell sed -ne "s/$(BOARD).build.variant=\(.*\)/\1/p" $(BOARDS_FILE))
189
 
BOARD_UPLOAD_SPEED := \
190
 
        $(shell sed -ne "s/$(BOARD).upload.speed=\(.*\)/\1/p" $(BOARDS_FILE))
191
 
BOARD_UPLOAD_PROTOCOL := \
192
 
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
193
 
 
194
 
# prefer software that comes with arduino
195
 
TOOLSDIRPREFIX = $(wildcard $(ARDUINODIR)/hardware/tools/)
196
 
TOOLSAVRDIRPREFIX = $(wildcard $(ARDUINODIR)/hardware/tools/avr/)
197
 
 
198
 
# software (prioritise binaries that came with arduino software)
199
 
FIND_SOFTWARE = $(firstword $(wildcard \
200
 
        $(ARDUINODIR)/hardware/tools/$(1) \
201
 
        $(ARDUINODIR)/hardware/tools/avr/bin/$(1) \
202
 
        ) $(1) )
203
 
CC := $(call FIND_SOFTWARE,avr-gcc)
204
 
CXX := $(call FIND_SOFTWARE,avr-g++)
205
 
LD := $(call FIND_SOFTWARE,avr-ld)
206
 
AR := $(call FIND_SOFTWARE,avr-ar)
207
 
OBJCOPY := $(call FIND_SOFTWARE,avr-objcopy)
208
 
AVRDUDE := $(call FIND_SOFTWARE,avrdude)
209
 
 
210
 
# flags
211
 
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
212
 
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
213
 
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
214
 
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
215
 
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
216
 
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
217
 
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
218
 
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
219
 
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
220
 
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
221
 
 
222
 
# default rule
223
 
.DEFAULT_GOAL := all
224
 
 
225
 
#_______________________________________________________________________________
226
 
#                                                                          RULES
227
 
 
228
 
.PHONY: all target upload clean boards monitor
229
 
 
230
 
all: target upload
231
 
 
232
 
target: $(TARGET).hex
233
 
 
234
 
upload:
235
 
        @echo "\nUploading to board..."
236
 
        @test -n "$(SERIALDEV)" || { \
237
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
238
 
                exit 1; }
239
 
        stty -F $(SERIALDEV) hupcl
240
 
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
241
 
 
242
 
clean:
243
 
        rm -f $(OBJECTS)
244
 
        rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
245
 
        rm -rf $(ARDUINOLIBTMP)
246
 
 
247
 
boards:
248
 
        @echo Available values for BOARD:
249
 
        @sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
250
 
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
251
 
 
252
 
monitor:
253
 
        @test -n "$(SERIALDEV)" || { \
254
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
255
 
                exit 1; }
256
 
        screen $(SERIALDEV)
257
 
 
258
 
# building the target
259
 
 
260
 
$(TARGET).hex: $(TARGET).elf
261
 
        $(OBJCOPY) -O ihex -R .eeprom $< $@
262
 
 
263
 
.INTERMEDIATE: $(TARGET).elf
264
 
 
265
 
$(TARGET).elf: $(ARDUINOLIB) $(OBJECTS)
266
 
        $(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -o $@
267
 
 
268
 
%.o: %.ino
269
 
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
270
 
 
271
 
%.o: %.pde
272
 
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
273
 
 
274
 
# building the arduino library
275
 
 
276
 
$(ARDUINOLIB): $(ARDUINOLIBOBJS)
277
 
        $(AR) rcs $@ $?
278
 
        rm -rf $(ARDUINOLIBTMP)
279
 
 
280
 
.INTERMEDIATE: $(ARDUINOLIBOBJS)
281
 
 
282
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.c
283
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
284
 
        $(COMPILE.c) -o $@ $<
285
 
 
286
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.cpp
287
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
288
 
        $(COMPILE.cpp) -o $@ $<
289
 
 
290
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.c
291
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
292
 
        $(COMPILE.c) -o $@ $<
293
 
 
294
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
295
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
296
 
        $(COMPILE.cpp) -o $@ $<
297
 
 
298
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c
299
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
300
 
        $(COMPILE.c) -o $@ $<
301
 
 
302
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp
303
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
304
 
        $(COMPILE.cpp) -o $@ $<