/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-04 19:15:03 UTC
  • Revision ID: edam@waxworlds.org-20120104191503-1ergc301tahmx6j2
broke out ARDUINODIR, so it is not configured in the makefile

Show diffs side-by-side

added added

removed removed

arduino.mk
27
27
#_______________________________________________________________________________
28
28
#
29
29
#
30
 
# This is a general purpose makefile for use with Arduino (arduino.cc)
31
 
# hardware and software.  It works with the arduino-1.0 release and
32
 
# requires that to be downloaded separately.
33
 
#
34
 
# There are two ways to use this file, an automatic mode and a manual
35
 
# mode.  In automatic mode, you simply copy this makefile to your
36
 
# arduino project directory, rename it "Makefile" and type make.  The
37
 
# project directory is expected to contain an .ino or .pde file, which
38
 
# will automatically be used automatically, along with any other .c,
39
 
# .cc or .cpp files in the project directory and any subdirectory
40
 
# named "utility".  In this way, this makefile should act as a drop-in
41
 
# replacement for the Arduino IDE's build process and can build a
42
 
# project automatically from the files in a project directory.
43
 
#
44
 
# Alternatively, you can manually specify what files should be
45
 
# inclided in a build.  To use this makefile manually, you might be
46
 
# better to keep it somewhere and include it in your project's
47
 
# Makefile after having defined certain parameters that control the
48
 
# build.  As an example, consider the following Makefile:
49
 
#
50
 
#       TARGET = my_program
51
 
#       SOURCES = main.cc foo.cc
52
 
#               BOARD = nano
53
 
#               SERIALDEV = /dev/ttyACM0
54
 
#       include ~/src/arduino.mk
55
 
#
56
 
# In both manual and automatic modes, the standard Arduino main.cpp's
57
 
# main() is included, which expects to be able to call init() and
58
 
# loop() in your code.  The main difference is that, in manual mode,
59
 
# these would typically be placed in a .cc or .cpp file.
60
 
#
61
 
# When using manual mode, the following variables can be used:
62
 
#
63
 
# TARGET       The name of the target file.  This is typically the same name
64
 
#              as the project directory for an arduino project and, if
65
 
#              unspecified, that is used as a default.
66
 
#
67
 
# SOURCES      A list of all source files of whatever language. The language
68
 
#              type is determined by the file extension.
69
 
#
70
 
# BOARD        Specify a target board type.  These are defined in boards.txt,
71
 
#              which came with your arduino installation.  If unspecified,
72
 
#              a default is used.  (See below).
73
 
#
74
 
# SERIALDEV    The unix device of the device where the arduino can be found.
75
 
#              If unspecified, a default is used.  (See below).
76
 
#
77
 
# This general-purpose makefile also defines the following goals for use on the
78
 
# command line when you run make:
79
 
#
80
 
# all          This is the default if no goal is specified. It builds the
81
 
#              target and uploads it.
 
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
 
32
# software to be downloaded separately (see http://arduino.cc/).  To
 
33
# download the latest version of this makefile, visit the following
 
34
# website, where you can also find more information and documentation
 
35
# on it's use.  The following text can only really be considered a
 
36
# reference to it's use.
 
37
#
 
38
#   http://ed.am/dev/make/arduino-makefile
 
39
#
 
40
# To install, it is suggested that you keep arduino.mk somewhere and
 
41
# either symlink to it or include it in your make files.  I keep mine
 
42
# at ~/src/arduino.mk.  You will need to alter the value of the
 
43
# ARDUINODIR variable (below) to be the path where you have unpacked
 
44
# the arduino software from arduino.cc.
 
45
#
 
46
# This makefile can be used as a drop-in replacement for the Arduino
 
47
# IDE's build system.  Simply create a symlink to it under the name
 
48
# "Makefile" and run make (remembering to specify an ARDUINODIR and
 
49
# BOARD, as described below).  You would create the symlink like like
 
50
# so:
 
51
#
 
52
#   $ ln -s ~/src/arduino.mk Makefile
 
53
#
 
54
# The presence of a .ino or .pde file causes the arduino.mk to
 
55
# atuomatically determine va;ues for SOURCES, TARGET and LIBRARIES.
 
56
# Any .c, .cc and .cpp files in the project directory (or a "util" or
 
57
# "utility" subdirectory) are automatically included in the build and
 
58
# are scanned for libraries that have been #included.
 
59
#
 
60
# Alternatively, if you want to manually specify build variables,
 
61
# create a Makefile that defines SOURCES and LIBRARARIES and then
 
62
# includes arduino.mk.  (There is no need to define TARGET).  You will
 
63
# also be expected to provide a main() function, for example in
 
64
# main.cc, which may or may not duplicate the functionality of the
 
65
# default main() that calls init() and loop().  Here is an example
 
66
# Makefile:
 
67
#
 
68
#   SOURCES := main.cc foo.cc
 
69
#   LIBRARIES := EEPROM
 
70
#   include ~/src/arduino.mk
 
71
#
 
72
# A complete list of all the settings you can use in your Makefile
 
73
# follows shortly.  It should be noted, however, that some variables
 
74
# are better specified in the environment (or on the command line)
 
75
# than in your Makefile.  Specifically, the ARDUINODIR, BOARD and, if
 
76
# it is not automatically detected, SERIALDEV.
 
77
#
 
78
# When running make, you might want to specify the board and path to
 
79
# your installation of the arduino software, like this:
 
80
#
 
81
#   $ export ARDUINODIR=~/opt/arduino-1.0
 
82
#   $ export BOARD=pro5v
 
83
#   $ make
 
84
#
 
85
# For a list of available board types, run `make boards`.
 
86
# 
 
87
# Here is a complete list of configuration parameters:
 
88
#
 
89
# ARDUINODIR   The path where you have installed/unpacked the arduino
 
90
#              software (from http://arduino.cc/)
 
91
#
 
92
# BOARD        Specify a target board type.
 
93
#
 
94
# SERIALDEV    The unix device of the device where the arduino can be
 
95
#              found.  If unspecified, an attempt is made to determine
 
96
#              the name of a connected arduino's serial device.
 
97
#
 
98
# TARGET       The name of the target file.  This is set automatically
 
99
#              if a .ino or .pde is found, but it is not neccesary to
 
100
#              set it otherwise.
 
101
#
 
102
# SOURCES      A list of all source files of whatever language.  The
 
103
#              language type is determined by the file extension.
 
104
#              This is set automatically if a .ino or .pde is found.
 
105
#
 
106
# LIBRARIES    A list of arduino libraries to build and include.  This
 
107
#              is set automatically if a .ino or .pde is found.
 
108
#
 
109
# This general-purpose makefile also defines the following goals for
 
110
# use on the command line when you run make:
 
111
#
 
112
# all          This is the default if no goal is specified. It builds
 
113
#              the target and uploads it.
82
114
#
83
115
# target       Builds the target of your Makefile.
84
116
#
86
118
#
87
119
# clean        Deletes temporary files.
88
120
#
89
 
# <file>       Builds the specified file, either an object file or the target,
90
 
#              from those that that would be built for the project.
 
121
# <file>       Builds the specified file, either an object file or the
 
122
#              target, from those that that would be built for the
 
123
#              project.
91
124
#
92
125
#_______________________________________________________________________________
93
 
#                                                                       SETTINGS
 
126
#
94
127
 
95
128
# The full path to the arduino software, from arduino.cc
 
129
ifndef ARDUINODIR
96
130
ARDUINODIR := $(wildcard ~/opt/arduino-1.0)
97
 
 
98
 
# The board name to build for and upload to. For a complete list of available
99
 
# boards, see hardware/arduino/boards.txt in your arduino software directory.
100
 
# Here is a list of available boards at time of writing:
101
 
#   uno         Arduino Uno
102
 
#   atmega328   Arduino Duemilanove w/ ATmega328
103
 
#   diecimila   Arduino Diecimila or Duemilanove w/ ATmega168
104
 
#   nano328     Arduino Nano w/ ATmega328
105
 
#   nano        Arduino Nano w/ ATmega168
106
 
#   mega2560    Arduino Mega 2560 or Mega ADK
107
 
#   mega        Arduino Mega (ATmega1280)
108
 
#   mini328     Arduino Mini w/ ATmega328
109
 
#   mini        Arduino Mini w/ ATmega168
110
 
#   fio         Arduino Fio
111
 
#   bt328       Arduino BT w/ ATmega328
112
 
#   bt          Arduino BT w/ ATmega168
113
 
#   lilypad328  LilyPad Arduino w/ ATmega328
114
 
#   lilypad     LilyPad Arduino w/ ATmega168
115
 
#   pro5v328    Arduino Pro or Pro Mini (5V, 16 MHz) w/ ATmega328
116
 
#   pro5v       Arduino Pro or Pro Mini (5V, 16 MHz) w/ ATmega168
117
 
#   pro328      Arduino Pro or Pro Mini (3.3V, 8 MHz) w/ ATmega328
118
 
#   pro         Arduino Pro or Pro Mini (3.3V, 8 MHz) w/ ATmega168
119
 
#   atmega168   Arduino NG or older w/ ATmega168
120
 
#   atmega8     Arduino NG or older w/ ATmega8
121
 
ifndef BOARD
122
 
BOARD := nano
123
 
endif
124
 
 
125
 
# The name of the serial device that the arduino is at. For example,
126
 
# /dev/ttyACM0 (Uno), or /dev/ttyUSB0 (Duemilanove)
127
 
ifndef SERIALDEV
128
 
SERIALDEV := /dev/ttyACM0
129
 
endif
130
 
 
131
 
#_______________________________________________________________________________
132
 
#
 
131
endif
 
132
 
 
133
# check arduino software
 
134
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
 
135
$(error ARDUINODIR is not set correctly; arduino software not found)
 
136
endif
133
137
 
134
138
# auto mode?
135
139
INOFILE := $(wildcard *.ino *.pde)
136
140
ifdef INOFILE
137
141
ifneq ($(words $(INOFILE)), 1)
138
 
$(error There is more than one .pde or .ino file in the directory!)
 
142
$(error There is more than one .pde or .ino file in this directory!)
139
143
endif
140
144
TARGET := $(basename $(INOFILE))
141
145
SOURCES := $(INOFILE) \
142
 
        $(wildcard *.c *.cc *.cpp $(addprefix utility/, *.c *.cc *.cpp))
 
146
        $(wildcard *.c *.cc *.cpp) \
 
147
        $(wildcard $(addprefix util/, *.c *.cc *.cpp)) \
 
148
        $(wildcard $(addprefix utility/, *.c *.cc *.cpp))
 
149
# automatically determine included libraries
 
150
ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))
 
151
LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \
 
152
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
 
153
endif
 
154
 
 
155
# no target? use default
 
156
ifndef TARGET
 
157
TARGET := a.out
 
158
endif
 
159
 
 
160
# no serial device? attempt to detect an arduino
 
161
ifndef SERIALDEV
 
162
SERIALDEV := $(firstword $(wildcard /dev/ttyACM? /dev/ttyUSB?))
 
163
endif
 
164
 
 
165
# no board? oh dear...
 
166
ifndef BOARD
 
167
ifneq "$(MAKECMDGOALS)" "boards"
 
168
ifneq "$(MAKECMDGOALS)" "clean"
 
169
$(error BOARD is unset.  Type 'make boards' to see possible values)
 
170
endif
 
171
endif
143
172
endif
144
173
 
145
174
# files
146
175
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
147
 
ifdef INOFILE
148
 
OBJECT += main.o
149
 
endif
150
176
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
151
177
ARDUINOLIB := _arduino.a
152
178
ARDUINOLIBTMP := _arduino.a.tmp
153
 
ARDUINOSOURCES := $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp))
154
 
ARDUINOOBJECTS := $(addsuffix .o, $(addprefix $(ARDUINOLIBTMP)/, $(basename \
155
 
        $(subst $(ARDUINOSRCDIR)/,,$(ARDUINOSOURCES)))))
 
179
ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
 
180
        $(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))
 
181
ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \
 
182
        $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \
 
183
        $(wildcard $(addprefix $(ARDUINODIR)/libraries/$(lib)/, *.c *.cpp))))))
156
184
 
157
 
# obtain parameters from the arduino boards.txt file
 
185
# obtain board parameters from the arduino boards.txt file
158
186
BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt
159
187
BOARD_BUILD_MCU := \
160
188
        $(shell sed -ne "s/$(BOARD).build.mcu=\(.*\)/\1/p" $(BOARDS_FILE))
173
201
LD := avr-ld
174
202
AR := avr-ar
175
203
OBJCOPY := avr-objcopy
176
 
AVRDUDE := $(ARDUINODIR)/hardware/tools/avrdude
 
204
AVRDUDE := avrdude
177
205
 
178
206
# flags
179
207
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
180
208
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
181
 
CPPFLAGS += -I. -Iutility -I$(ARDUINOSRCDIR)
 
209
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
182
210
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
183
 
AVRDUDEFLAGS = -V -F -C $(ARDUINODIR)/hardware/tools/avrdude.conf
 
211
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/,$(LIBRARIES))
 
212
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
184
213
AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)
185
214
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
186
 
 
187
 
# checks
188
 
ifeq ($(TARGET),)
189
 
$(error No target defined!)
190
 
endif
 
215
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
191
216
 
192
217
# default rule
193
218
.DEFAULT_GOAL := all
195
220
#_______________________________________________________________________________
196
221
#                                                                          RULES
197
222
 
198
 
.PHONY: all target upload clean
 
223
.PHONY: all target upload clean boards
199
224
 
200
225
all: target upload
201
226
 
202
 
target: $(TARGET).elf
 
227
target: $(TARGET).hex
203
228
 
204
229
upload:
205
230
        stty -F $(SERIALDEV) hupcl
206
 
        $(OBJCOPY) -O ihex -R .eeprom $(TARGET).elf $(TARGET).hex
207
 
        $(AVRDUDE) $(ARVDUDEFLAGS) -U flash:w:$(TARGET).hex
208
 
        rm $(TARGET).hex
 
231
        $(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i
209
232
 
210
233
clean:
211
234
        rm -f $(OBJECTS)
212
235
        rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
213
236
        rm -rf $(ARDUINOLIBTMP)
214
237
 
 
238
boards:
 
239
        @echo Available values for BOARD:
 
240
        @sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
 
241
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
 
242
 
215
243
# building the target
216
244
 
 
245
$(TARGET).hex: $(TARGET).elf
 
246
        $(OBJCOPY) -O ihex -R .eeprom $< $@
 
247
 
 
248
.INTERMEDIATE: $(TARGET).elf
 
249
 
217
250
$(TARGET).elf: $(ARDUINOLIB) $(OBJECTS)
218
 
        $(CC) -Os -Wl,--gc-sections $(OBJECTS) $(ARDUINOLIB) -o $@
 
251
        $(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -o $@
219
252
 
220
253
%.o: %.ino
221
254
        $(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<
225
258
 
226
259
# building the arduino library
227
260
 
228
 
$(ARDUINOLIB): $(ARDUINOOBJECTS)
 
261
$(ARDUINOLIB): $(ARDUINOLIBOBJS)
229
262
        $(AR) rcs $@ $?
230
263
        rm -rf $(ARDUINOLIBTMP)
231
264
 
232
 
.INTERMEDIATE: $(ARDUINOOBJECTS)
 
265
.INTERMEDIATE: $(ARDUINOLIBOBJS)
233
266
 
234
267
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.c
235
268
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
238
271
$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.cpp
239
272
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
240
273
        $(COMPILE.cpp) -o $@ $<
 
274
 
 
275
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.c
 
276
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
277
        $(COMPILE.c) -o $@ $<
 
278
 
 
279
$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp
 
280
        @test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)
 
281
        $(COMPILE.cpp) -o $@ $<