/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-03-20 22:14:41 UTC
  • Revision ID: tim@ed.am-20120320221441-1w3uknfaki3u7ohu
build arduino static lib in .lib using full pathnames in object files (so files of the same name but in different locations can co-exist)

Show diffs side-by-side

added added

removed removed

Lines of Context:
arduino.mk
1
1
#_______________________________________________________________________________
2
2
#
3
 
#                         edam's arduino makefile
 
3
#                         edam's Arduino makefile
4
4
#_______________________________________________________________________________
5
 
#                                                                    version 0.1
 
5
#                                                                 version 0.3dev
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
# Type `make boards` for a list of acceptable values.  You could set a default
 
60
# in your ~/.profile if you want, but it is suggested that you specify this at
 
61
# build time, especially if you work with different types of Arduino.  For
 
62
# example:
56
63
#
57
64
#   $ export BOARD=uno
58
65
#   $ make
59
66
#
60
67
# You may also need to set SERIALDEV if it is not detected correctly.
61
68
#
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.
 
69
# The presence of a .ino (or .pde) file causes the arduino.mk to automatically
 
70
# determine values for SOURCES, TARGET and LIBRARIES.  Any .c, .cc and .cpp
 
71
# files in the project directory (or any "util" or "utility" subdirectories)
 
72
# are automatically included in the build and are scanned for Arduino libraries
 
73
# that have been #included. Note, there can only be one .ino (or .pde) file.
67
74
#
68
75
# Alternatively, if you want to manually specify build variables, create a
69
 
# Makefile that defines SOURCES and LIBRARARIES and then includes arduino.mk.
 
76
# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.
70
77
# (There is no need to define TARGET).  Here is an example Makefile:
71
78
#
72
79
#   SOURCES := main.cc other.cc
75
82
#
76
83
# Here is a complete list of configuration parameters:
77
84
#
78
 
# ARDUINODIR   The path where you have installed/unpacked the arduino software
79
 
#              (from http://arduino.cc/)
 
85
# ARDUINODIR   The path where the Arduino software is installed on your system.
 
86
#
 
87
# ARDUINOCONST The Arduino software version, as an integer, used to define the
 
88
#              ARDUINO version constant. This defaults to 100 if undefined.
 
89
#
 
90
# AVRDUDECONF  The avrdude.conf to use. If undefined, this defaults to a guess
 
91
#              based on where the avrdude in use is. If empty, no avrdude.conf
 
92
#              is passed to avrdude (to the system default is used).
 
93
#
 
94
# AVRTOOLSPATH A space-separated list of directories to search in order when
 
95
#              looking for the avr build tools. This defaults to the system PATH
 
96
#              followed by subdirectories in ARDUINODIR if undefined.
80
97
#
81
98
# BOARD        Specify a target board type.  Run `make boards` to see available
82
99
#              board types.
83
100
#
84
 
# SERIALDEV    The unix device of the device where the arduino can be found.
 
101
# LIBRARIES    A list of Arduino libraries to build and include.  This is set
 
102
#              automatically if a .ino (or .pde) is found.
 
103
#
 
104
# SERIALDEV    The unix device name of the serial device that is the Arduino.
85
105
#              If unspecified, an attempt is made to determine the name of a
86
 
#              connected arduino's serial device.
 
106
#              connected Arduino's serial device.
 
107
#
 
108
# SOURCES      A list of all source files of whatever language.  The language
 
109
#              type is determined by the file extension.  This is set
 
110
#              automatically if a .ino (or .pde) is found.
87
111
#
88
112
# 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
 
113
#              .ino (or .pde) is found, but it is not necessary to set it
90
114
#              otherwise.
91
115
#
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
116
# This makefile also defines the following goals for use on the command line
100
117
# when you run make:
101
118
#
102
119
# all          This is the default if no goal is specified.  It builds the
103
 
#              target and uploads it.
 
120
#              target.
104
121
#
105
122
# target       Builds the target.
106
123
#
107
 
# upload       Uploads the last built target to an attached arduino.
 
124
# upload       Uploads the last built target to an attached Arduino.
108
125
#
109
126
# clean        Deletes files created during the build.
110
127
#
111
128
# boards       Display a list of available board names, so that you can set the
112
129
#              BOARD environment variable appropriately.
113
130
#
114
 
# monitor      Start `screen` on the serial device.  It is ment to be an
115
 
#              equivelant to the arduino serial monitor.
 
131
# monitor      Start `screen` on the serial device.  This is meant to be an
 
132
#              equivalent to the Arduino serial monitor.
 
133
#
 
134
# size         Displays size information about the bulit target.
116
135
#
117
136
# <file>       Builds the specified file, either an object file or the target,
118
137
#              from those that that would be built for the project.
119
138
#_______________________________________________________________________________
120
139
#
121
140
 
122
 
# The full path to the arduino software, from arduino.cc
 
141
# default arduino software directory, check software exists
123
142
ifndef ARDUINODIR
124
 
ARDUINODIR := $(wildcard ~/opt/arduino)
 
143
ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))
125
144
endif
126
 
 
127
 
# check arduino software
128
 
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
 
145
ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""
129
146
$(error ARDUINODIR is not set correctly; arduino software not found)
130
147
endif
131
148
 
 
149
# default arduino version
 
150
ARDUINOCONST ?= 100
 
151
 
 
152
# default path for avr tools
 
153
ifndef AVRTOOLSPATH
 
154
AVRTOOLSPATH := $(subst :, , $(PATH))
 
155
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools
 
156
AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin
 
157
endif
 
158
 
132
159
# auto mode?
133
160
INOFILE := $(wildcard *.ino *.pde)
134
161
ifdef INOFILE
135
 
ifneq ($(words $(INOFILE)), 1)
 
162
ifneq "$(words $(INOFILE))" "1"
136
163
$(error There is more than one .pde or .ino file in this directory!)
137
164
endif
 
165
 
 
166
# automatically determine sources and targeet
138
167
TARGET := $(basename $(INOFILE))
139
168
SOURCES := $(INOFILE) \
140
169
        $(wildcard *.c *.cc *.cpp) \
141
170
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
142
171
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
 
172
 
143
173
# automatically determine included libraries
144
 
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
145
 
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
 
174
LIBRARIES := $(filter $(notdir $(wildcard $(ARDUINODIR)/libraries/*)), \
146
175
        $(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...
 
176
 
 
177
endif
 
178
 
 
179
# no serial device? make a poor attempt to detect an arduino
 
180
SERIALDEVGUESS := 0
 
181
ifeq "$(SERIALDEV)" ""
 
182
SERIALDEV := $(firstword $(wildcard \
 
183
        /dev/ttyACM? /dev/ttyUSB? /dev/tty.usbmodem*))
 
184
SERIALDEVGUESS := 1
 
185
endif
 
186
 
 
187
# software
 
188
findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))
 
189
CC := $(call findsoftware,avr-gcc)
 
190
CXX := $(call findsoftware,avr-g++)
 
191
LD := $(call findsoftware,avr-ld)
 
192
AR := $(call findsoftware,avr-ar)
 
193
OBJCOPY := $(call findsoftware,avr-objcopy)
 
194
AVRDUDE := $(call findsoftware,avrdude)
 
195
AVRSIZE := $(call findsoftware,avr-size)
 
196
 
 
197
# files
 
198
TARGET := $(if $(TARGET),$(TARGET),a.out)
 
199
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
 
200
ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
 
201
ARDUINOLIB := .lib/arduino.a
 
202
ARDUINOLIBLIBSDIR := $(ARDUINODIR)/libraries
 
203
ARDUINOLIBLIBSPATH := $(foreach lib, $(LIBRARIES), \
 
204
        $(ARDUINODIR)/libraries/$(lib)/ $(ARDUINODIR)/libraries/$(lib)/utility/ )
 
205
ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(ARDUINOLIBLIBSPATH), \
 
206
        $(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, *.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?
160
216
ifndef BOARD
161
217
ifneq "$(MAKECMDGOALS)" "boards"
162
218
ifneq "$(MAKECMDGOALS)" "clean"
165
221
endif
166
222
endif
167
223
 
168
 
# files
169
 
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
170
 
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
171
 
ARDUINOLIB := _arduino.a
172
 
ARDUINOLIBTMP := _arduino.a.tmp
173
 
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
174
 
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
175
 
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
176
 
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
177
 
        $(wildcard $(addprefix $(ARDUINODIR)/libraries/$(lib)/, *.c *.cpp))))))
178
 
 
179
224
# obtain board parameters from the arduino boards.txt file
180
225
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
181
226
BOARD_BUILD_MCU := \
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)
203
 
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
204
 
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
205
 
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
206
 
CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
207
 
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
 
247
CPPFLAGS_S := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
 
248
CPPFLAGS_S += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums
 
249
CPPFLAGS_S += -mmcu=$(BOARD_BUILD_MCU)
 
250
CPPFLAGS_S += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)
 
251
CPPFLAGS_S += -I. -Iutil -Iutility -I$(ARDUINOCOREDIR)
 
252
CPPFLAGS_S += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
 
253
CPPFLAGS_S += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))
 
254
CPPFLAGS_S += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))
 
255
CPPFLAGS = $(CPPFLAGS_S)
 
256
AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV
208
257
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
209
258
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
210
 
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
 
259
LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
 
260
 
 
261
# figure out which arg to use with stty
 
262
STTYFARG := $(shell stty --help > /dev/null 2>&1 && echo -F || echo -f)
211
263
 
212
264
# default rule
213
265
.DEFAULT_GOAL := all
215
267
#_______________________________________________________________________________
216
268
#                                                                          RULES
217
269
 
218
 
.PHONY: all target upload clean boards monitor
 
270
.PHONY: all target upload clean boards monitor size
219
271
 
220
 
all: target upload
 
272
all: target
221
273
 
222
274
target: $(TARGET).hex
223
275
 
224
276
upload:
225
 
        stty -F $(SERIALDEV) hupcl
 
277
        @echo "\nUploading to board..."
 
278
        @test -n "$(SERIALDEV)" || { \
 
279
                echo "error: SERIALDEV could not be determined automatically." >&2; \
 
280
                exit 1; }
 
281
        @test 0 -eq $(SERIALDEVGUESS) || { \
 
282
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
 
283
                echo; }
 
284
        stty $(STTYFARG) $(SERIALDEV) hupcl
226
285
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
227
286
 
228
287
clean:
229
288
        rm -f $(OBJECTS)
230
289
        rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
231
 
        rm -rf $(ARDUINOLIBTMP)
 
290
        rm -rf .lib
232
291
 
233
292
boards:
234
293
        @echo Available values for BOARD:
236
295
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
237
296
 
238
297
monitor:
 
298
        @test -n "$(SERIALDEV)" || { \
 
299
                echo "error: SERIALDEV could not be determined automatically." >&2; \
 
300
                exit 1; }
 
301
        @test -n `which screen` || { \
 
302
                echo "error: can't find GNU screen, you might need to install it." >&2 \
 
303
                ecit 1; }
 
304
        @test 0 -eq $(SERIALDEVGUESS) || { \
 
305
                echo "*GUESSING* at serial device:" $(SERIALDEV); \
 
306
                echo; }
239
307
        screen $(SERIALDEV)
240
308
 
 
309
size: $(TARGET).elf
 
310
        echo && $(AVRSIZE) --format=avr --mcu=$(BOARD_BUILD_MCU) $(TARGET).elf
 
311
 
241
312
# building the target
242
313
 
243
314
$(TARGET).hex: $(TARGET).elf
248
319
$(TARGET).elf: $(ARDUINOLIB) $(OBJECTS)
249
320
        $(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -o $@
250
321
 
 
322
#%.o: %.c
 
323
#       $(COMPILE.c) -o $@ $<
 
324
 
251
325
%.o: %.ino
252
 
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
 
326
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOCOREDIR)/Arduino.h $<
253
327
 
254
328
%.o: %.pde
255
 
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
 
329
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOCOREDIR)/Arduino.h $<
256
330
 
257
331
# building the arduino library
258
332
 
259
333
$(ARDUINOLIB): $(ARDUINOLIBOBJS)
260
334
        $(AR) rcs $@ $?
261
 
        rm -rf $(ARDUINOLIBTMP)
262
 
 
263
 
.INTERMEDIATE: $(ARDUINOLIBOBJS)
264
 
 
265
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.c
266
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
267
 
        $(COMPILE.c) -o $@ $<
268
 
 
269
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.cpp
270
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
271
 
        $(COMPILE.cpp) -o $@ $<
272
 
 
273
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.c
274
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
275
 
        $(COMPILE.c) -o $@ $<
276
 
 
277
 
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
278
 
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
335
 
 
336
.lib/%.c.o: %.c
 
337
        mkdir -p $(dir $@)
 
338
        $(COMPILE.c) -o $@ $<
 
339
 
 
340
.lib/%.cpp.o: %.cpp
 
341
        mkdir -p $(dir $@)
 
342
        $(COMPILE.cpp) -o $@ $<
 
343
 
 
344
.lib/%.cc.o: %.cc
 
345
        mkdir -p $(dir $@)
 
346
        $(COMPILE.cpp) -o $@ $<
 
347
 
 
348
.lib/%.C.o: %.C
 
349
        mkdir -p $(dir $@)
279
350
        $(COMPILE.cpp) -o $@ $<