/make/arduino-mk : revision 51

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-10-29 22:48:06 UTC
Revision ID: tim@ed.am-20121029224806-3oyj7v3lxp19ae8m

updated .bzrignore

files added:
.bzrignore

NEWS

THANKS

files modified:
arduino.mk

Show diffs side-by-side

added added

removed removed

arduino.mk

#_______________________________________________________________________________

# edam's arduino makefile

# edam's Arduino makefile

#_______________________________________________________________________________

# version 0.1

# version 0.4dev

# Permission is hereby granted, free of charge, to any person obtaining a copy

# of this software and associated documentation files (the "Software"), to deal

# This is a general purpose makefile for use with Arduino hardware and

# software. It works with the arduino-1.0 release and requires that software

# to be downloaded separately (see http://arduino.cc/). To download the latest

# version of this makefile, visit the following website, where you can also

# find more information and documentation on it's use. The following text can

# only really be considered a reference to it's use.

# software. It works with the arduino-1.0 software release. To download the

# latest version of this makefile, visit the following website, where you can

# also find more information and documentation on it's use. The following text

# can only really be considered a reference to it's use.

# http://ed.am/dev/make/arduino-mk

# $ ln -s ~/src/arduino.mk Makefile

# You also need to set up a couple of environment varibales. ARDUINODIR should

# be set to the path where you unpacked the arduino software from arduino.cc

# (it defaults to ~/opt/arduino if unset). You might be best to set this in

# The Arduino software (version 1.0 or later) is required. If you are using

# Debian (or a derivative), type `apt-get install arduino`. Otherwise, you

# will have to download the Arduino software manually from http://arduino.cc/.

# It is suggested that you install it at ~/opt/arduino if you are unsure.

# If you downloaded the Arduino software manually and unpacked it somewhere

# other than ~/opt/arduino, you will need to set up ARDUINODIR to be the path

# where you unpacked it. (If unset, ARDUINODIR defaults to ~/opt/arduino and

# then /usr/share/arduino, in that order.) You might be best to set this in

# your ~/.profile by adding something like this:

# export ARDUINODIR=~/somewhere/arduino-1.0

# You will also need to set BOARD to the type of arduino you're using. This

# can be done when running make (or you could set a default in ~/.profile and

# iverride it as necessary). For example:

# You will also need to set BOARD to the type of Arduino you're building for.

# Type `make boards` for a list of acceptable values. You could set a default

# in your ~/.profile if you want, but it is suggested that you specify this at

# build time, especially if you work with different types of Arduino. For

# example:

# $ export BOARD=uno

# $ make

# You may also need to set SERIALDEV if it is not detected correctly.

# The presence of a .ino or .pde file causes the arduino.mk to atuomatically

# determine va;ues for SOURCES, TARGET and LIBRARIES. Any .c, .cc and .cpp

# files in the project directory (or any "util" or "utility" subdirectoried)

# are automatically included in the build and are scanned for Atduino libraries

# that have been #included.

# The presence of a .ino (or .pde) file causes the arduino.mk to automatically

# determine values for SOURCES, TARGET and LIBRARIES. Any .c, .cc and .cpp

# files in the project directory (or any "util" or "utility" subdirectories)

# are automatically included in the build and are scanned for Arduino libraries

# that have been #included. Note, there can only be one .ino (or .pde) file.

# Alternatively, if you want to manually specify build variables, create a

# Makefile that defines SOURCES and LIBRARARIES and then includes arduino.mk.

# Makefile that defines SOURCES and LIBRARIES and then includes arduino.mk.

# (There is no need to define TARGET). Here is an example Makefile:

# SOURCES := main.cc other.cc

# Here is a complete list of configuration parameters:

# ARDUINODIR The path where you have installed/unpacked the arduino software

# (from http://arduino.cc/)

# ARDUINODIR The path where the Arduino software is installed on your system.

# ARDUINOCONST The Arduino software version, as an integer, used to define the

# ARDUINO version constant. This defaults to 100 if undefined.

# AVRDUDECONF The avrdude.conf to use. If undefined, this defaults to a guess

# based on where the avrdude in use is. If empty, no avrdude.conf

# is passed to avrdude (to the system default is used).

# AVRTOOLSPATH A space-separated list of directories to search in order when

# looking for the avr build tools. This defaults to the system PATH

# followed by subdirectories in ARDUINODIR if undefined.

# BOARD Specify a target board type. Run `make boards` to see available

# board types.

100

# 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.

105

# If unspecified, an attempt is made to determine the name of a

# 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.

111

112

# TARGET The name of the target file. This is set automatically if a

# .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

114

# otherwise.

115

# SOURCES A list of all source files of whatever language. The language

# type is determined by the file extension. This is set

# automatically if a .ino or .pde is found.

# LIBRARIES A list of arduino libraries to build and include. This is set

# automatically if a .ino or .pde is found.

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

ifeq ($(TARGET), )

151

TARGET := a.out

152

endif

153

154

# no serial device? attempt to detect an arduino

155

ifeq ($(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.usbserial* /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

DEPFILES := $(patsubst %, .dep/%.dep, $(SOURCES))

201

ARDUINOCOREDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino

202

ARDUINOLIB := .lib/arduino.a

203

ARDUINOLIBLIBSDIR := $(ARDUINODIR)/libraries

204

ARDUINOLIBLIBSPATH := $(foreach lib, $(LIBRARIES), \

205

$(ARDUINODIR)/libraries/$(lib)/ $(ARDUINODIR)/libraries/$(lib)/utility/ )

206

ARDUINOLIBOBJS := $(foreach dir, $(ARDUINOCOREDIR) $(ARDUINOLIBLIBSPATH), \

207

$(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, *.c *.cpp))))

208

ifeq "$(AVRDUDECONF)" ""

209

ifeq "$(AVRDUDE)" "$(ARDUINODIR)/hardware/tools/avr/bin/avrdude"

210

AVRDUDECONF := $(ARDUINODIR)/hardware/tools/avr/etc/avrdude.conf

211

else

212

AVRDUDECONF := $(wildcard $(AVRDUDE).conf)

213

endif

214

endif

215

216

# no board?

160

217

ifndef BOARD

161

218

ifneq "$(MAKECMDGOALS)" "boards"

162

219

ifneq "$(MAKECMDGOALS)" "clean"

165

222

endif

166

223

endif

167

224

168

# files

169

OBJECTS := $(addsuffix .o, $(basename $(SOURCES)))

170

ARDUINOSRCDIR := $(ARDUINODIR)/hardware/arduino/cores/arduino

171

ARDUINOLIBSDIR := $(ARDUINODIR)/libraries

172

ARDUINOLIB := _arduino.a

173

ARDUINOLIBTMP := $(ARDUINOLIB).tmp

174

ARDUINOLIBOBJS := $(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \

175

$(wildcard $(addprefix $(ARDUINOSRCDIR)/, *.c *.cpp)))))

176

ARDUINOLIBOBJS += $(foreach lib, $(LIBRARIES), \

177

$(patsubst %, $(ARDUINOLIBTMP)/%.o, $(basename $(notdir \

178

$(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/, *.c *.cpp)) \

179

$(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.c *.cpp)) ))))

180

181

225

# obtain board parameters from the arduino boards.txt file

182

226

BOARDS_FILE := $(ARDUINODIR)/hardware/arduino/boards.txt

183

227

BOARD_BUILD_MCU := \

190

234

$(shell sed -ne "s/$(BOARD).upload.speed=$.*$/\1/p" $(BOARDS_FILE))

191

235

BOARD_UPLOAD_PROTOCOL := \

192

236

$(shell sed -ne "s/$(BOARD).upload.protocol=$.*$/\1/p" $(BOARDS_FILE))

193

194

# prefer software that comes with arduino

195

TOOLSDIRPREFIX = $(wildcard $(ARDUINODIR)/hardware/tools/)

196

TOOLSAVRDIRPREFIX = $(wildcard $(ARDUINODIR)/hardware/tools/avr/)

197

198

# software (prioritise binaries that came with arduino software)

199

FIND_SOFTWARE = $(firstword $(wildcard \

200

$(ARDUINODIR)/hardware/tools/$(1) \

201

$(ARDUINODIR)/hardware/tools/avr/bin/$(1) \

202

) $(1) )

203

CC := $(call FIND_SOFTWARE,avr-gcc)

204

CXX := $(call FIND_SOFTWARE,avr-g++)

205

LD := $(call FIND_SOFTWARE,avr-ld)

206

AR := $(call FIND_SOFTWARE,avr-ar)

207

OBJCOPY := $(call FIND_SOFTWARE,avr-objcopy)

208

AVRDUDE := $(call FIND_SOFTWARE,avrdude)

237

BOARD_USB_VID := \

238

$(shell sed -ne "s/$(BOARD).build.vid=$.*$/\1/p" $(BOARDS_FILE))

239

BOARD_USB_PID := \

240

$(shell sed -ne "s/$(BOARD).build.pid=$.*$/\1/p" $(BOARDS_FILE))

241

242

# invalid board?

243

ifeq "$(BOARD_BUILD_MCU)" ""

244

ifneq "$(MAKECMDGOALS)" "boards"

245

ifneq "$(MAKECMDGOALS)" "clean"

246

$(error BOARD is invalid. Type 'make boards' to see possible values)

247

endif

248

endif

249

endif

209

250

210

251

# flags

211

CPPFLAGS = -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections

212

CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)

213

CPPFLAGS += -I. -Iutil -Iutility -I$(ARDUINOSRCDIR)

214

CPPFLAGS += -I$(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/

215

CPPFLAGS += $(addprefix -I$(ARDUINODIR)/libraries/, $(LIBRARIES))

216

CPPFLAGS += $(patsubst %, -I$(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))

217

AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV

252

CPPFLAGS := -Os -Wall -fno-exceptions -ffunction-sections -fdata-sections

253

CPPFLAGS += -funsigned-char -funsigned-bitfields -fpack-struct -fshort-enums

254

CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)

255

CPPFLAGS += -DF_CPU=$(BOARD_BUILD_FCPU) -DARDUINO=$(ARDUINOCONST)

256

CPPFLAGS += -DUSB_VID=$(BOARD_USB_VID) -DUSB_PID=$(BOARD_USB_PID)

257

CPPFLAGS += -I. -Iutil -Iutility -I $(ARDUINOCOREDIR)

258

CPPFLAGS += -I $(ARDUINODIR)/hardware/arduino/variants/$(BOARD_BUILD_VARIANT)/

259

CPPFLAGS += $(addprefix -I $(ARDUINODIR)/libraries/, $(LIBRARIES))

260

CPPFLAGS += $(patsubst %, -I $(ARDUINODIR)/libraries/%/utility, $(LIBRARIES))

261

CPPDEPFLAGS = -MMD -MP -MF .dep/$<.dep

262

CPPINOFLAGS := -x c++ -include $(ARDUINOCOREDIR)/Arduino.h

263

AVRDUDEFLAGS := $(addprefix -C , $(AVRDUDECONF)) -DV

218

264

AVRDUDEFLAGS += -p $(BOARD_BUILD_MCU) -P $(SERIALDEV)

219

265

AVRDUDEFLAGS += -c $(BOARD_UPLOAD_PROTOCOL) -b $(BOARD_UPLOAD_SPEED)

220

LINKFLAGS = -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)

266

LINKFLAGS := -Os -Wl,--gc-sections -mmcu=$(BOARD_BUILD_MCU)

267

268

# figure out which arg to use with stty (for OS X, GNU and busybox stty)

269

STTYFARG := $(shell stty --help 2>&1 | \

270

grep -q 'illegal option' && echo -f || echo -F)

271

272

# include dependencies

273

ifneq "$(MAKECMDGOALS)" "clean"

274

-include $(DEPFILES)

275

endif

221

276

222

277

# default rule

223

278

.DEFAULT_GOAL := all

225

280

#_______________________________________________________________________________

226

281

# RULES

227

282

228

.PHONY: all target upload clean boards monitor

283

.PHONY: all target upload clean boards monitor size

229

284

230

all: target upload

285

all: target

231

286

232

287

target: $(TARGET).hex

233

288

234

upload:

289

upload: target

235

290

@echo "\nUploading to board..."

236

291

@test -n "$(SERIALDEV)" || { \

237

292

echo "error: SERIALDEV could not be determined automatically." >&2; \

238

293

exit 1; }

239

stty -F $(SERIALDEV) hupcl

294

@test 0 -eq $(SERIALDEVGUESS) || { \

295

echo "*GUESSING* at serial device:" $(SERIALDEV); \

296

echo; }

297

stty $(STTYFARG) $(SERIALDEV) hupcl

240

298

$(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(TARGET).hex:i

241

299

242

300

clean:

243

301

rm -f $(OBJECTS)

244

302

rm -f $(TARGET).elf $(TARGET).hex $(ARDUINOLIB) *~

245

rm -rf $(ARDUINOLIBTMP)

303

rm -rf .lib .dep

246

304

247

305

boards:

248

306

@echo Available values for BOARD:

249

@sed -ne '/^#/d;s/^$.*$.name=$.*$/\1 \2/;T' \

250

-e 's/$.\{12\}$ *$.*$/\1 \2/;p' $(BOARDS_FILE)

307

@sed -nEe '/^#/d; /^[^.]+\.name=/p' $(BOARDS_FILE) | \

308

sed -Ee 's/([^.]+)\.name=(.*)/\1 \2/' \

309

-e 's/(.{12}) *(.*)/\1 \2/'

251

310

252

311

monitor:

253

312

@test -n "$(SERIALDEV)" || { \

254

313

echo "error: SERIALDEV could not be determined automatically." >&2; \

255

314

exit 1; }

315

@test -n `which screen` || { \

316

echo "error: can't find GNU screen, you might need to install it." >&2 \

317

ecit 1; }

318

@test 0 -eq $(SERIALDEVGUESS) || { \

319

echo "*GUESSING* at serial device:" $(SERIALDEV); \

320

echo; }

256

321

screen $(SERIALDEV)

257

322

323

size: $(TARGET).elf

324

echo && $(AVRSIZE) --format=avr --mcu=$(BOARD_BUILD_MCU) $(TARGET).elf

325

258

326

# building the target

259

327

260

328

$(TARGET).hex: $(TARGET).elf

263

331

.INTERMEDIATE: $(TARGET).elf

264

332

265

333

$(TARGET).elf: $(ARDUINOLIB) $(OBJECTS)

266

$(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -o $@

334

$(CC) $(LINKFLAGS) $(OBJECTS) $(ARDUINOLIB) -lm -o $@

335

336

%.o: %.c

337

mkdir -p .dep/$(dir $<)

338

$(COMPILE.c) $(CPPDEPFLAGS) -o $@ $<

339

340

%.o: %.cpp

341

mkdir -p .dep/$(dir $<)

342

$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<

343

344

%.o: %.cc

345

mkdir -p .dep/$(dir $<)

346

$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<

347

348

%.o: %.C

349

mkdir -p .dep/$(dir $<)

350

$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $<

267

351

268

352

%.o: %.ino

269

$(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<

353

mkdir -p .dep/$(dir $<)

354

$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ $(CPPINOFLAGS) $<

270

355

271

356

%.o: %.pde

272

$(COMPILE.cpp) -o $@ -x c++ -include $(ARDUINOSRCDIR)/Arduino.h $<

357

mkdir -p .dep/$(dir $<)

358

$(COMPILE.cpp) $(CPPDEPFLAGS) -o $@ -x c++ -include $(ARDUINOCOREDIR)/Arduino.h $<

273

359

274

360

# building the arduino library

275

361

276

362

$(ARDUINOLIB): $(ARDUINOLIBOBJS)

277

363

$(AR) rcs $@ $?

278

rm -rf $(ARDUINOLIBTMP)

279

280

.INTERMEDIATE: $(ARDUINOLIBOBJS)

281

282

$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.c

283

@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)

284

$(COMPILE.c) -o $@ $<

285

286

$(ARDUINOLIBTMP)/%.o: $(ARDUINOSRCDIR)/%.cpp

287

@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)

288

$(COMPILE.cpp) -o $@ $<

289

290

$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.c

291

@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)

292

$(COMPILE.c) -o $@ $<

293

294

$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/%.cpp

295

@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)

296

$(COMPILE.cpp) -o $@ $<

297

298

$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.c

299

@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)

300

$(COMPILE.c) -o $@ $<

301

302

$(ARDUINOLIBTMP)/%.o: $(ARDUINODIR)/libraries/*/utility/%.cpp

303

@test -d $(ARDUINOLIBTMP) || mkdir $(ARDUINOLIBTMP)

364

365

.lib/%.c.o: %.c

366

mkdir -p $(dir $@)

367

$(COMPILE.c) -o $@ $<

368

369

.lib/%.cpp.o: %.cpp

370

mkdir -p $(dir $@)

371

$(COMPILE.cpp) -o $@ $<

372

373

.lib/%.cc.o: %.cc

374

mkdir -p $(dir $@)

375

$(COMPILE.cpp) -o $@ $<

376

377

.lib/%.C.o: %.C

378

mkdir -p $(dir $@)

304

379

$(COMPILE.cpp) -o $@ $<

Older »