/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-30 23:12:46 UTC
  • Revision ID: edam@waxworlds.org-20111230231246-zl8980dsrlfhcugf
added included-library autodetection and updated comments

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 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 as described below (remembering to specify a
49
 
# BOARD).  You would create the symlink like like so:
50
 
#
51
 
#   $ ln -s ~/src/arduino.mk Makefile
52
 
#
53
 
# The presence of a .ino or .pde file causes the arduino.mk to
54
 
# atuomatically determine va;ues for SOURCES, TARGET and LIBRARIES.
55
 
# Any .c, .cc and .cpp files in the project directory (or a "util" or
56
 
# "utility" subdirectory) are automatically included in the build and
57
 
# are scanned for libraries that have been #included.
58
 
#
59
 
# Alternatively, if you want to manually specify build variables,
60
 
# create a Makefile that defines SOURCES and LIBRARARIES and then
61
 
# includes arduino.mk.  (There is no need to define TARGET).  You will
62
 
# also be expected to provide a main() function, for example in
63
 
# main.cc, which may or may not duplicate the functionality of the
64
 
# default main() that calls init() and loop().  Here is an example
65
 
# Makefile:
66
 
#
67
 
#   SOURCES := main.cc foo.cc
68
 
#   LIBRARIES := EEPROM
69
 
#   include ~/src/arduino.mk
 
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.  It can be downloaded
 
33
# from http://ed.am/dev/make/arduino-makefile where you can also find
 
34
# more information and documentation on it's use.  The following text
 
35
# can only really be considered a reference to it's use.
 
36
#
 
37
# To use this makefile, put a file named "Makefile" in your project
 
38
# directory.  Add all your project's settings to your Makefile and
 
39
# then include this file from it. For example, your Makefile might
 
40
# look something like this:
 
41
#
 
42
#               BOARD = nano
 
43
#               SERIALDEV = /dev/ttyACM0
 
44
#       include ~/src/arduino.mk
70
45
#
71
46
# A complete list of all the settings you can use in your Makefile
72
 
# follows shortly.  It should be noted, however, that some variables
73
 
# are better specified in the environment or on the command line than
74
 
# in a Makefile.  Specifically, the BOARD and SERIALDEV (if it is not
75
 
# automatically detected).
76
 
#
77
 
# When running make, you might want to specify the board type:
78
 
#
79
 
#   $ BOARD=pro5v make
80
 
#
81
 
# Or in the environment:
82
 
#
83
 
#   $ export BOARD=pro5v
84
 
#   $ make
85
 
#
86
 
# For a list of available board types, run `make boards`.
87
 
# 
 
47
# follows shortly. But it should be noted that there are two ways to
 
48
# use this file, an automatic mode and a manual mode.
 
49
#
 
50
# In automatic mode, you simply define a BOARD and SERIALDEV and then
 
51
# include this makefile.  The project directory must contain an .ino
 
52
# or .pde file, which will automatically be used, along with any other
 
53
# .c, .cc or .cpp files in the project directory.  When buliding, any
 
54
# arduino libraries that are #included in your code are detected and
 
55
# automatically linked against.  In this way, this makefile should act
 
56
# as a drop-in replacement for the Arduino IDE's build system.  You
 
57
# should be able to type "make" from the command line and achieve the
 
58
# same as building and uploading from the Arduino IDE.
 
59
#
 
60
# The alternative, manual mode, makes no assumptions.  If the
 
61
# directory doesn't contain an .ino or .pde file, you must also
 
62
# specify the SOURCES, TARGET and LIBRARIES manually in your Makefile.
 
63
# You will also be expected to provide a main() function, for example
 
64
# in main.cc, which may or may not duplicate the functionality of the
 
65
# default main() that calls init() and loop().
 
66
#
88
67
# Here is a list of all configuration parameters:
89
68
#
90
 
# BOARD        Specify a target board type.
 
69
# BOARD        Specify a target board type.  These are defined in boards.txt,
 
70
#              which came with your arduino installation.  If unspecified,
 
71
#              a default is used.  (See below).
91
72
#
92
 
# SERIALDEV    The unix device of the device where the arduino can be
93
 
#              found.  If unspecified, an attempt is made to determine
94
 
#              the name of a connected arduino's serial device.
 
73
# SERIALDEV    The unix device of the device where the arduino can be found.
 
74
#              If unspecified, a default is used.  (See below).
95
75
#
96
76
# The following configuration parameters can be determined automatically:
97
77
#
98
 
# TARGET       The name of the target file.  This need not be set if it
99
 
#              is not determined automatically.
100
 
#
101
 
# SOURCES      A list of all source files of whatever language.  The
102
 
#              language type is determined by the file extension.
103
 
#
104
 
# LIBRARIES    A list of arduino libraries to build and include.
105
 
#
106
 
# This general-purpose makefile also defines the following goals for
107
 
# use on the command line when you run make:
108
 
#
109
 
# all          This is the default if no goal is specified. It builds
110
 
#              the target and uploads it.
 
78
# TARGET       The name of the target file.  This is typically the same name
 
79
#              as the project directory for an arduino project and, if
 
80
#              unspecified, that is used as a default.
 
81
#
 
82
# SOURCES      A list of all source files of whatever language. The language
 
83
#              type is determined by the file extension.
 
84
#
 
85
# LIBRARIES    A list of arduino libraries to include
 
86
#
 
87
# This general-purpose makefile also defines the following goals for use on the
 
88
# command line when you run make:
 
89
#
 
90
# all          This is the default if no goal is specified. It builds the
 
91
#              target and uploads it.
111
92
#
112
93
# target       Builds the target of your Makefile.
113
94
#
115
96
#
116
97
# clean        Deletes temporary files.
117
98
#
118
 
# <file>       Builds the specified file, either an object file or the
119
 
#              target, from those that that would be built for the
120
 
#              project.
 
99
# <file>       Builds the specified file, either an object file or the target,
 
100
#              from those that that would be built for the project.
121
101
#
122
102
#_______________________________________________________________________________
123
 
#
 
103
#                                                                       SETTINGS
124
104
 
125
105
# The full path to the arduino software, from arduino.cc
126
106
ARDUINODIR := $(wildcard ~/opt/arduino-1.0)
127
107
 
128
 
# check arduino software
129
 
ifeq ($(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt), )
130
 
$(error ARDUINODIR is not set correctly at the top of arduino.mk)
131
 
endif
 
108
# The board name to build for and upload to. For a complete list of available
 
109
# boards, see hardware/arduino/boards.txt in your arduino software directory.
 
110
# Here is a list of available boards at time of writing:
 
111
#   uno         Arduino Uno
 
112
#   atmega328   Arduino Duemilanove w/ ATmega328
 
113
#   diecimila   Arduino Diecimila or Duemilanove w/ ATmega168
 
114
#   nano328     Arduino Nano w/ ATmega328
 
115
#   nano        Arduino Nano w/ ATmega168
 
116
#   mega2560    Arduino Mega 2560 or Mega ADK
 
117
#   mega        Arduino Mega (ATmega1280)
 
118
#   mini328     Arduino Mini w/ ATmega328
 
119
#   mini        Arduino Mini w/ ATmega168
 
120
#   fio         Arduino Fio
 
121
#   bt328       Arduino BT w/ ATmega328
 
122
#   bt          Arduino BT w/ ATmega168
 
123
#   lilypad328  LilyPad Arduino w/ ATmega328
 
124
#   lilypad     LilyPad Arduino w/ ATmega168
 
125
#   pro5v328    Arduino Pro or Pro Mini (5V, 16 MHz) w/ ATmega328
 
126
#   pro5v       Arduino Pro or Pro Mini (5V, 16 MHz) w/ ATmega168
 
127
#   pro328      Arduino Pro or Pro Mini (3.3V, 8 MHz) w/ ATmega328
 
128
#   pro         Arduino Pro or Pro Mini (3.3V, 8 MHz) w/ ATmega168
 
129
#   atmega168   Arduino NG or older w/ ATmega168
 
130
#   atmega8     Arduino NG or older w/ ATmega8
 
131
ifndef BOARD
 
132
BOARD := uno
 
133
endif
 
134
 
 
135
# The name of the serial device that the arduino is at. For example,
 
136
# /dev/ttyACM0 (Uno), or /dev/ttyUSB0 (Duemilanove)
 
137
ifndef SERIALDEV
 
138
SERIALDEV := /dev/ttyACM0
 
139
endif
 
140
 
 
141
#_______________________________________________________________________________
 
142
#
132
143
 
133
144
# auto mode?
134
145
INOFILE := $(wildcard *.ino *.pde)
135
146
ifdef INOFILE
136
147
ifneq ($(words $(INOFILE)), 1)
137
 
$(error There is more than one .pde or .ino file in this directory!)
 
148
$(error There is more than one .pde or .ino file in the directory!)
138
149
endif
139
150
TARGET := $(basename $(INOFILE))
140
151
SOURCES := $(INOFILE) \
147
158
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
148
159
endif
149
160
 
150
 
# no target? use default
151
 
ifndef TARGET
152
 
TARGET := a.out
153
 
endif
154
 
 
155
 
# no serial device? attempt to detect an arduino
156
 
ifndef SERIALDEV
157
 
SERIALDEV := $(firstword $(wildcard /dev/ttyACM? /dev/ttyUSB?))
158
 
endif
159
 
 
160
 
# no board? oh dear...
161
 
ifndef BOARD
162
 
ifneq "$(MAKECMDGOALS)" "boards"
163
 
ifneq "$(MAKECMDGOALS)" "clean"
164
 
$(error BOARD is unset.  Type 'make boards' to see possible values)
165
 
endif
166
 
endif
167
 
endif
168
 
 
169
161
# files
170
162
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
171
163
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
197
189
AR := avr-ar
198
190
OBJCOPY := avr-objcopy
199
191
AVRDUDE := avrdude
 
192
#$(ARDUINODIR)/hardware/tools/avrdude
200
193
 
201
194
# flags
202
195
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
203
196
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
204
 
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
 
197
CPPFLAGS += -I. -Iutility -I$(ARDUINOSRCDIR)
205
198
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
206
199
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/,$(LIBRARIES))
207
200
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
209
202
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
210
203
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
211
204
 
 
205
# checks
 
206
ifeq ($(TARGET),)
 
207
$(error No target defined!)
 
208
endif
 
209
 
212
210
# default rule
213
211
.DEFAULT_GOAL := all
214
212
 
215
213
#_______________________________________________________________________________
216
214
#                                                                          RULES
217
215
 
218
 
.PHONY: all target upload clean boards
 
216
.PHONY: all target upload clean
219
217
 
220
218
all: target upload
221
219
 
230
228
        rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
231
229
        rm -rf $(ARDUINOLIBTMP)
232
230
 
233
 
boards:
234
 
        @echo Available values for BOARD:
235
 
        @sed -ne '/^#/d;s/^\(.*\).name=\(.*\)/\1            \2/;T' \
236
 
                -e 's/\(.\{12\}\) *\(.*\)/\1 \2/;p' $(BOARDS_FILE)
237
 
 
238
231
# building the target
239
232
 
240
233
$(TARGET).hex: $(TARGET).elf