/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-31 22:12:25 UTC
  • Revision ID: edam@waxworlds.org-20111231221225-52dt61v5b2r3cmam
updated comments; added checks for missing or misconfigured variables; use a default TARGET; attempt to autodetect SERIALDEV; added 'boards' goal; fixed use of 'util' project subdirectory.

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.  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
 
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
45
68
#
46
69
# A complete list of all the settings you can use in your Makefile
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
 
#
 
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
# 
67
86
# Here is a list of all configuration parameters:
68
87
#
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).
 
88
# BOARD        Specify a target board type.
72
89
#
73
 
# SERIALDEV    The unix device of the device where the arduino can be found.
74
 
#              If unspecified, a default is used.  (See below).
 
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.
75
93
#
76
94
# The following configuration parameters can be determined automatically:
77
95
#
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.
 
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.
92
109
#
93
110
# target       Builds the target of your Makefile.
94
111
#
96
113
#
97
114
# clean        Deletes temporary files.
98
115
#
99
 
# <file>       Builds the specified file, either an object file or the target,
100
 
#              from those that that would be built for the project.
 
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.
101
119
#
102
120
#_______________________________________________________________________________
103
 
#                                                                       SETTINGS
 
121
#
104
122
 
105
123
# The full path to the arduino software, from arduino.cc
106
124
ARDUINODIR := $(wildcard ~/opt/arduino-1.0)
107
125
 
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
 
#
 
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
143
130
 
144
131
# auto mode?
145
132
INOFILE := $(wildcard *.ino *.pde)
146
133
ifdef INOFILE
147
134
ifneq ($(words $(INOFILE)), 1)
148
 
$(error There is more than one .pde or .ino file in the directory!)
 
135
$(error There is more than one .pde or .ino file in this directory!)
149
136
endif
150
137
TARGET := $(basename $(INOFILE))
151
138
SOURCES := $(INOFILE) \
158
145
        $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(SOURCES)))
159
146
endif
160
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
 
165
endif
 
166
 
161
167
# files
162
168
OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))
163
169
ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino
189
195
AR := avr-ar
190
196
OBJCOPY := avr-objcopy
191
197
AVRDUDE := avrdude
192
 
#$(ARDUINODIR)/hardware/tools/avrdude
193
198
 
194
199
# flags
195
200
CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections
196
201
CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)
197
 
CPPFLAGS += -I. -Iutility -I$(ARDUINOSRCDIR)
 
202
CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)
198
203
CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/
199
204
CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/,$(LIBRARIES))
200
205
AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV
202
207
AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)
203
208
LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)
204
209
 
205
 
# checks
206
 
ifeq ($(TARGET),)
207
 
$(error No target defined!)
208
 
endif
209
 
 
210
210
# default rule
211
211
.DEFAULT_GOAL := all
212
212
 
213
213
#_______________________________________________________________________________
214
214
#                                                                          RULES
215
215
 
216
 
.PHONY: all target upload clean
 
216
.PHONY: all target upload clean show-boards
217
217
 
218
218
all: target upload
219
219
 
228
228
        rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~
229
229
        rm -rf $(ARDUINOLIBTMP)
230
230
 
 
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
 
231
236
# building the target
232
237
 
233
238
$(TARGET).hex: $(TARGET).elf