/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: 2011-12-29 13:52:05 UTC
  • Revision ID: edam@waxworlds.org-20111229135205-ppyojdxqty9sdikj
initial commit

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