/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-12-02 19:57:07 UTC
  • Revision ID: edam@waxworlds.org-20111202195707-lko4ap3pfe1jrgd9
renamed code directories and updated the comments in the code

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 variables. 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
 
# override 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 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.
67
 
#
68
 
# Alternatively, if you want to manually specify build variables, create a
69
 
# Makefile that defines SOURCES and LIBRARIES 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
 
# 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
 
# BOARD        Specify a target board type.  Run `make boards` to see available
89
 
#              board types.
90
 
#
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.
95
 
#              If unspecified, an attempt is made to determine the name of a
96
 
#              connected arduino's serial device.
97
 
#
98
 
# SOURCES      A list of all source files of whatever language.  The language
99
 
#              type is determined by the file extension.  This is set
100
 
#              automatically if a .ino (or .pde) is found.
101
 
#
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.
105
 
#
106
 
# This makefile also defines the following goals for use on the command line
107
 
# when you run make:
108
 
#
109
 
# all          This is the default if no goal is specified.  It builds the
110
 
#              target and uploads it.
111
 
#
112
 
# target       Builds the target.
113
 
#
114
 
# upload       Uploads the last built target to an attached arduino.
115
 
#
116
 
# clean        Deletes files created during the build.
117
 
#
118
 
# boards       Display a list of available board names, so that you can set the
119
 
#              BOARD environment variable appropriately.
120
 
#
121
 
# monitor      Start `screen` on the serial device.  This is meant to be an
122
 
#              equivalent to the arduino serial monitor.
123
 
#
124
 
# <file>       Builds the specified file, either an object file or the target,
125
 
#              from those that that would be built for the project.
126
 
#_______________________________________________________________________________
127
 
#
128
 
 
129
 
# default arduino software directory, check software exists
130
 
ifndef ARDUINODIR
131
 
ARDUINODIR := $(wildcard ~/opt/arduino)
132
 
endif
133
 
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
134
 
$(error ARDUINODIR is not set correctly; arduino software not found)
135
 
endif
136
 
 
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
 
# auto mode?
148
 
INOFILE := $(wildcard *.ino *.pde)
149
 
ifdef INOFILE
150
 
ifneq ($(words $(INOFILE)), 1)
151
 
$(error There is more than one .pde or .ino file in this directory!)
152
 
endif
153
 
 
154
 
# automatically determine sources and targeet
155
 
TARGET := $(basename $(INOFILE))
156
 
SOURCES := $(INOFILE) \
157
 
        $(wildcard *.c *.cc *.cpp) \
158
 
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
159
 
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
160
 
 
161
 
# automatically determine included libraries
162
 
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
163
 
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
164
 
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
165
 
 
166
 
endif
167
 
 
168
 
# no board? oh dear...
169
 
ifndef BOARD
170
 
ifneq "$(MAKECMDGOALS)" "boards"
171
 
ifneq "$(MAKECMDGOALS)" "clean"
172
 
$(error BOARD is unset.  Type 'make boards' to see possible values)
173
 
endif
174
 
endif
175
 
endif
176
 
 
177
 
# no serial device? make a poor attempt to detect an arduino
178
 
ifeq ($(SERIALDEV), )
179
 
SERIALDEV := $(firstword $(wildcard \
180
 
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbmodem*))
181
 
endif
182
 
 
183
 
# software
184
 
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
185
 
CC := $(call findsoftware,avr-gcc)
186
 
CXX := $(call findsoftware,avr-g++)
187
 
LD := $(call findsoftware,avr-ld)
188
 
AR := $(call findsoftware,avr-ar)
189
 
OBJCOPY := $(call findsoftware,avr-objcopy)
190
 
AVRDUDE := $(call findsoftware,avrdude)
191
 
 
192
 
# files
193
 
TARGET := $(if $(TARGET),$(TARGET),a.out)
194
 
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
195
 
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
196
 
ARDUINOLIBSDIR := $(ARDUINODIR)/libraries
197
 
ARDUINOLIB := _arduino.a
198
 
ARDUINOLIBTMP := $(ARDUINOLIB).tmp
199
 
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
200
 
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
201
 
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
202
 
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
203
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \
204
 
        $(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))
205
 
AVRDUDECONF := $(wildcard $(AVRDUDE).conf)
206
 
 
207
 
# obtain board parameters from the arduino boards.txt file
208
 
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
209
 
BOARD_BUILD_MCU := \
210
 
        $(shell sed -ne "s/$(BOARD).build.mcu=\(.*\)/\1/p" $(BOARDS_FILE))
211
 
BOARD_BUILD_FCPU := \
212
 
        $(shell sed -ne "s/$(BOARD).build.f_cpu=\(.*\)/\1/p" $(BOARDS_FILE))
213
 
BOARD_BUILD_VARIANT := \
214
 
        $(shell sed -ne "s/$(BOARD).build.variant=\(.*\)/\1/p" $(BOARDS_FILE))
215
 
BOARD_UPLOAD_SPEED := \
216
 
        $(shell sed -ne "s/$(BOARD).upload.speed=\(.*\)/\1/p" $(BOARDS_FILE))
217
 
BOARD_UPLOAD_PROTOCOL := \
218
 
        $(shell sed -ne "s/$(BOARD).upload.protocol=\(.*\)/\1/p" $(BOARDS_FILE))
219
 
 
220
 
# flags
221
 
CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
222
 
CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
223
 
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)
224
 
CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
225
 
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
226
 
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
227
 
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
228
 
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
229
 
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
230
 
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
231
 
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
232
 
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
233
 
 
234
 
# figure out which arg to use with stty
235
 
STTYFARG := $(shell stty --help > /dev/null 2>&1 && echo -F || echo -f)
236
 
 
237
 
# default rule
238
 
.DEFAULT_GOAL := all
239
 
 
240
 
#_______________________________________________________________________________
241
 
#                                                                          RULES
242
 
 
243
 
.PHONY: all target upload clean boards monitor
244
 
 
245
 
all: target upload
246
 
 
247
 
target: $(TARGET).hex
248
 
 
249
 
upload:
250
 
        @echo "\nUploading to board..."
251
 
        @test -n "$(SERIALDEV)" || { \
252
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
253
 
                exit 1; }
254
 
        stty $(STTYFARG) $(SERIALDEV) hupcl
255
 
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
256
 
 
257
 
clean:
258
 
        rm -f $(OBJECTS)
259
 
        rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
260
 
        rm -rf $(ARDUINOLIBTMP)
261
 
 
262
 
boards:
263
 
        @echo Available values for BOARD:
264
 
        @sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
265
 
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
266
 
 
267
 
monitor:
268
 
        @test -n "$(SERIALDEV)" || { \
269
 
                echo "error: SERIALDEV could not be determined automatically." >&2; \
270
 
                exit 1; }
271
 
        @test -n `which screen` || { \
272
 
                echo "error: can't find GNU screen, you might need to install it." >&2 \
273
 
                ecit 1; }
274
 
        screen $(SERIALDEV)
275
 
 
276
 
# building the target
277
 
 
278
 
$(TARGET).hex: $(TARGET).elf
279
 
        $(OBJCOPY) -O ihex -R .eeprom $< $@
280
 
 
281
 
.INTERMEDIATE: $(TARGET).elf
282
 
 
283
 
$(TARGET).elf: $(ARDUINOLIB) $(OBJECTS)
284
 
        $(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -o $@
285
 
 
286
 
%.o: %.ino
287
 
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
288
 
 
289
 
%.o: %.pde
290
 
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
291
 
 
292
 
# building the arduino library
293
 
 
294
 
$(ARDUINOLIB): $(ARDUINOLIBOBJS)
295
 
        $(AR) rcs $@ $?
296
 
        rm -rf $(ARDUINOLIBTMP)
297
 
 
298
 
.INTERMEDIATE: $(ARDUINOLIBOBJS)
299
 
 
300
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.c
301
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
302
 
        $(COMPILE.c) -o $@ $<
303
 
 
304
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.cpp
305
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
306
 
        $(COMPILE.cpp) -o $@ $<
307
 
 
308
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.c
309
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
310
 
        $(COMPILE.c) -o $@ $<
311
 
 
312
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
313
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
314
 
        $(COMPILE.cpp) -o $@ $<
315
 
 
316
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c
317
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
318
 
        $(COMPILE.c) -o $@ $<
319
 
 
320
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp
321
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
322
 
        $(COMPILE.cpp) -o $@ $<