/make/arduino-mk : revision 89

2

#

3

# edam's Arduino makefile

4

#_______________________________________________________________________________

5

# version 0.5dev

5

# version 0.6dev

6

#

7

8

#

9

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

10

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

28

#

29

#

30

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

31

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

32

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

33

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

34

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

31

# software. It works with the arduino-1.0 and later software releases. It

32

# should work GNU/Linux and OS X. To download the latest version of this

33

# makefile visit the following website where you can also find documentation on

34

# it's use. (The following text can only really be considered a reference.)

35

#

36

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

37

#

38

# This makefile can be used as a drop-in replacement for the Arduino IDE's

39

# build system. To use it, save arduino.mk somewhere (I keep mine at

40

# ~/src/arduino.mk) and create a symlink to it in your project directory named

41

# "Makefile". For example:

39

# build system. To use it, just copy arduino.mk in to your project directory.

40

# Or, you could save it somewhere (I keep mine at ~/src/arduino.mk) and create

41

# a symlink to it in your project directory, named "Makefile". For example:

42

#

43

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

44

#

45

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

46

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

47

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

48

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

45

# The Arduino software (version 1.0 or later) is required. On GNU/Linux you

46

# can probably install the software from your package manager. If you are

47

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

48

# you can download the Arduino software manually from http://arduino.cc/. It

49

# is suggested that you install it at ~/opt/arduino (or /Applications on OS X)

50

# if you are unsure.

49

51

#

50

52

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

51

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

52

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

53

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

53

# other than ~/opt/arduino (or /Applications), you will need to set up the

54

# ARDUINODIR environment variable to be the path where you unpacked it. (If

55

# unset, ARDUINODIR defaults to some sensible places). You could set this in

54

56

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

55

57

#

56

58

# export ARDUINODIR=~/somewhere/arduino-1.0

57

59

#

58

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

59

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

60

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

61

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

62

# example:

60

# For each project, you will also need to set BOARD to the type of Arduino

61

# you're building for. Type `make boards` for a list of acceptable values.

62

# For example:

63

#

64

# $ export BOARD=uno

65

# $ make

70

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

71

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

72

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

73

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

73

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

74

# a project directory and if you want to be compatible with the Arduino IDE, it

75

# should be called the same as the directory name.

74

76

#

75

77

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

76

78

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

77

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

79

# (There is no need to define TARGET). You can also specify the BOARD here, if

80

# the project has a specific one. Here is an example Makefile:

78

81

#

79

82

# SOURCES := main.cc other.cc

80

83

# LIBRARIES := EEPROM

84

# BOARD := pro5v

81

85

# include ~/src/arduino.mk

82

86

#

83

87

# Here is a complete list of configuration parameters:

88

92

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

89

93

#

90

94

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

91

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

92

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

95

# based on where avrdude is. If set empty, no avrdude.conf is

96

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

93

97

#

94

98

# AVRDUDEFLAGS Specify any additional flags for avrdude. The usual flags,

95

99

# required to build the project, will be appended to this.

112

116

#

113

117

# LIBRARYPATH A space-separated list of directories that is searched in order

114

118

# when looking for Arduino libraries. This defaults to "libs",

115

# "libraries" and then the Arduino software's libraries directory.

119

# "libraries" (in the project directory), then your sketchbook

120

# "libraries" directory, then the Arduino libraries directory.

116

121

#

117

# SERIALDEV The unix device name of the serial device that is the Arduino.

118

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

119

# connected Arduino's serial device.

122

# SERIALDEV The POSIX device name of the serial device that is the Arduino.

123

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

124

# connected Arduino's serial device, which may work in some cases.

120

125

#

121

126

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

122

127

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

134

139

#

135

140

# target Builds the target.

136

141

#

137

# upload Uploads the last built target to an attached Arduino.

142

# upload Uploads the target (building it, as necessary) to an attached

143

# Arduino.

138

144

#

139

145

# clean Deletes files created during the build.

140

146

#

144

150

# monitor Start `screen` on the serial device. This is meant to be an

145

151

# equivalent to the Arduino serial monitor.

146

152

#

147

# size Displays size information about the bulit target.

153

# size Displays size information about the built target.

154

#

155

# bootloader Burns the bootloader for your board to it.

148

156

#

149

157

# <file> Builds the specified file, either an object file or the target,

150

158

# from those that that would be built for the project.

153

161

154

162

# default arduino software directory, check software exists

155

163

ifndef ARDUINODIR

156

ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino))

164

ARDUINODIR := $(firstword $(wildcard ~/opt/arduino /usr/share/arduino \

165

/Applications/Arduino.app/Contents/Resources/Java \

166

$(HOME)/Applications/Arduino.app/Contents/Resources/Java))

157

167

endif

158

168

ifeq "$(wildcard $(ARDUINODIR)/hardware/arduino/boards.txt)" ""

159

169

$(error ARDUINODIR is not set correctly; arduino software not found)

160

170

endif

161

171

162

# obtain preferences from the IDE's preferences.txt

163

PREFERENCES_FILE := $(wildcard $(HOME)/.arduino/preferences.txt)

164

ifneq "$(PREFERENCES_FILE)" ""

165

SKETCHBOOKDIR := \

166

$(shell sed -ne "s/sketchbook.path=$.*$/\1/p" $(PREFERENCES_FILE))

167

endif

168

169

172

# default arduino version

170

173

ARDUINOCONST ?= 100

171

174

176

179

# default path to find libraries

177

180

LIBRARYPATH ?= libraries libs $(SKETCHBOOKDIR)/libraries $(ARDUINODIR)/libraries

178

181

182

# default serial device to a poor guess (something that might be an arduino)

183

SERIALDEVGUESS := 0

184

ifndef SERIALDEV

185

SERIALDEV := $(firstword $(wildcard \

186

/dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))

187

SERIALDEVGUESS := 1

188

endif

189

190

# no board?

191

ifndef BOARD

192

ifneq "$(MAKECMDGOALS)" "boards"

193

ifneq "$(MAKECMDGOALS)" "clean"

194

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

195

endif

196

endif

197

endif

198

199

# obtain board parameters from the arduino boards.txt file

200

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

201

readboardsparam = $(shell sed -ne "s/^$(BOARD).$(1)=$.*$/\1/p" $(BOARDSFILE))

202

BOARD_BUILD_MCU := $(call readboardsparam,build.mcu)

203

BOARD_BUILD_FCPU := $(call readboardsparam,build.f_cpu)

204

BOARD_BUILD_VARIANT := $(call readboardsparam,build.variant)

205

BOARD_BUILD_CORE := $(call readboardsparam,build.core)

206

BOARD_UPLOAD_SPEED := $(call readboardsparam,upload.speed)

207

BOARD_UPLOAD_PROTOCOL := $(call readboardsparam,upload.protocol)

208

BOARD_USB_VID := $(call readboardsparam,build.vid)

209

BOARD_USB_PID := $(call readboardsparam,build.pid)

210

BOARD_BOOTLOADER_UNLOCK := $(call readboardsparam,bootloader.unlock_bits)

211

BOARD_BOOTLOADER_LOCK := $(call readboardsparam,bootloader.lock_bits)

212

BOARD_BOOTLOADER_LFUSES := $(call readboardsparam,bootloader.low_fuses)

213

BOARD_BOOTLOADER_HFUSES := $(call readboardsparam,bootloader.high_fuses)

214

BOARD_BOOTLOADER_EFUSES := $(call readboardsparam,bootloader.extended_fuses)

215

BOARD_BOOTLOADER_PATH := $(call readboardsparam,bootloader.path)

216

BOARD_BOOTLOADER_FILE := $(call readboardsparam,bootloader.file)

217

218

# obtain preferences from the IDE's preferences.txt

219

PREFERENCESFILE := $(firstword $(wildcard \

220

$(HOME)/.arduino/preferences.txt $(HOME)/Library/Arduino/preferences.txt))

221

ifneq "$(PREFERENCESFILE)" ""

222

readpreferencesparam = $(shell sed -ne "s/$(1)=$.*$/\1/p" $(PREFERENCESFILE))

223

SKETCHBOOKDIR := $(call readpreferencesparam,sketchbook.path)

224

endif

225

226

# invalid board?

227

ifeq "$(BOARD_BUILD_MCU)" ""

228

ifneq "$(MAKECMDGOALS)" "boards"

229

ifneq "$(MAKECMDGOALS)" "clean"

230

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

231

endif

232

endif

233

endif

234

179

235

# auto mode?

180

236

INOFILE := $(wildcard *.ino *.pde)

181

237

ifdef INOFILE

183

239

$(error There is more than one .pde or .ino file in this directory!)

184

240

endif

185

241

186

# automatically determine sources and targeet

242

# automatically determine sources and target

187

243

TARGET := $(basename $(INOFILE))

188

244

SOURCES := $(INOFILE) \

189

$(wildcard *.c *.cc *.cpp *.C) \

190

$(wildcard $(addprefix util/, *.c *.cc *.cpp *.C)) \

191

$(wildcard $(addprefix utility/, *.c *.cc *.cpp *.C))

245

$(wildcard *.c *.cc *.cpp *.C *.s *.S) \

246

$(wildcard $(addprefix util/, *.c *.cc *.cpp *.C *.s *.S)) \

247

$(wildcard $(addprefix utility/, *.c *.cc *.cpp *.C *.s *.S))

192

248

193

# automatically determine included libraries

194

LIBRARIES := $(filter $(notdir $(wildcard $(addsuffix /*, $(LIBRARYPATH)))), \

195

$(shell sed -ne "s/^ *\# *include *[<\"]$.*$\.h[>\"]/\1/p" $(SOURCES)))

249

# automatically determine library directories (to pull library sources in from)

250

# by matching included headers in poject sources to headers that exist in the

251

# roots of any library directories, giving priority to libraries in the order

252

# they're in LIBRARYPATH, and then to the alphabetically-greater named library

253

# (this is a really stupid way of doing it, but it's how the IDE works -- if

254

# it's causing problems, you can override it by setting LIBRARIES manually)

255

INCLUDEDHEADERS := \

256

$(shell sed -nre "s/^\s*\#\s*include\s*[<\"](\S+\.h)[>\"].*/\1/p" \

257

$(SOURCES))

258

reverse = $(if $(1),$(call reverse,$(wordlist 2,$(words $(1)),$(1)))) \

259

$(firstword $(1))

260

LIBRARYHEADERS := $(foreach dir, $(LIBRARYPATH), \

261

$(call reverse, $(sort $(wildcard $(dir)/*))))

262

LIBRARYHEADERS := $(foreach dir, $(LIBRARYHEADERS), $(wildcard $(dir)/*.h))

263

LIBRARYDIRS := $(foreach hdr, $(INCLUDEDHEADERS), $(patsubst %/$(hdr), %, \

264

$(firstword $(filter %/$(hdr), $(LIBRARYHEADERS)))))

196

265

197

266

endif

198

267

199

# no serial device? make a poor attempt to detect an arduino

200

SERIALDEVGUESS := 0

201

ifeq "$(SERIALDEV)" ""

202

SERIALDEV := $(firstword $(wildcard \

203

/dev/ttyACM? /dev/ttyUSB? /dev/tty.usbserial* /dev/tty.usbmodem*))

204

SERIALDEVGUESS := 1

268

# if LIBRARIES is specified, use it

269

ifneq "$(LIBRARIES)" ""

270

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

271

$(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARYPATH)))))

205

272

endif

206

273

207

274

# software

210

277

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

211

278

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

212

279

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

280

AS := $(call findsoftware,avr-as)

213

281

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

214

282

AVRDUDE := $(call findsoftware,avrdude)

215

283

AVRSIZE := $(call findsoftware,avr-size)

216

284

217

285

# directories

218

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

219

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

220

$(firstword $(wildcard $(addsuffix /$(lib), $(LIBRARYPATH)))))

286

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

221

287

LIBRARYDIRS += $(addsuffix /utility, $(LIBRARYDIRS))

222

288

223

289

# files

226

292

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

227

293

ARDUINOLIB := .lib/arduino.a

228

294

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

229

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

295

$(patsubst %, .lib/%.o, $(wildcard $(addprefix $(dir)/, \

296

*.c *.cc *.cpp *.C *.s *.S))))

297

BOOTLOADERHEX := $(addprefix \

298

$(ARDUINODIR)/hardware/arduino/bootloaders/$(BOARD_BOOTLOADER_PATH)/, \

299

$(BOARD_BOOTLOADER_FILE))

230

300

231

301

# avrdude confifuration

232

302

ifeq "$(AVRDUDECONF)" ""

237

307

endif

238

308

endif

239

309

240

# no board?

241

ifndef BOARD

242

ifneq "$(MAKECMDGOALS)" "boards"

243

ifneq "$(MAKECMDGOALS)" "clean"

244

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

245

endif

246

endif

247

endif

248

249

# obtain board parameters from the arduino boards.txt file

250

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

251

BOARD_BUILD_MCU := \

252

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

253

BOARD_BUILD_FCPU := \

254

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

255

BOARD_BUILD_VARIANT := \

256

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

257

BOARD_UPLOAD_SPEED := \

258

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

259

BOARD_UPLOAD_PROTOCOL := \

260

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

261

BOARD_USB_VID := \

262

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

263

BOARD_USB_PID := \

264

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

265

BOARD_BOOTLOADER_PATH := \

266

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

267

268

# invalid board?

269

ifeq "$(BOARD_BUILD_MCU)" ""

270

ifneq "$(MAKECMDGOALS)" "boards"

271

ifneq "$(MAKECMDGOALS)" "clean"

272

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

273

endif

274

endif

275

endif

276

277

310

# flags

278

311

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

279

312

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

286

319

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

287

320

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

288

321

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

289

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

290

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

322

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

323

AVRDUDEFLAGS += $(addprefix -b, $(BOARD_UPLOAD_SPEED))

291

324

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

292

325

293

326

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

305

338

#_______________________________________________________________________________

306

339

# RULES

307

340

308

.PHONY: all target upload clean boards monitor size

341

.PHONY: all target upload clean boards monitor size bootloader

309

342

310

343

all: target

311

344

322

355

ifeq "$(BOARD_BOOTLOADER_PATH)" "caterina"

323

356

stty $(STTYFARG) $(SERIALDEV) speed 1200

324

357

sleep 1

358

else

359

stty $(STTYFARG) $(SERIALDEV) hupcl

325

360

endif

326

stty $(STTYFARG) $(SERIALDEV) hupcl

327

361

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

328

362

329

363

clean:

332

366

rm -rf .lib .dep

333

367

334

368

boards:

335

@echo Available values for BOARD:

336

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

369

@echo "Available values for BOARD:"

370

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

337

371

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

338

372

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

339

373

352

386

size: $(TARGET).elf

353

387

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

354

388

389

bootloader:

390

@echo "Burning bootloader to board..."

391

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

392

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

393

exit 1; }

394

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

395

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

396

echo; }

397

stty $(STTYFARG) $(SERIALDEV) hupcl

398

$(AVRDUDE) $(AVRDUDEFLAGS) -U lock:w:$(BOARD_BOOTLOADER_UNLOCK):m

399

$(AVRDUDE) $(AVRDUDEFLAGS) -eU lfuse:w:$(BOARD_BOOTLOADER_LFUSES):m

400

$(AVRDUDE) $(AVRDUDEFLAGS) -U hfuse:w:$(BOARD_BOOTLOADER_HFUSES):m

401

ifneq "$(BOARD_BOOTLOADER_EFUSES)" ""

402

$(AVRDUDE) $(AVRDUDEFLAGS) -U efuse:w:$(BOARD_BOOTLOADER_EFUSES):m

403

endif

404

ifneq "$(BOOTLOADERHEX)" ""

405

$(AVRDUDE) $(AVRDUDEFLAGS) -U flash:w:$(BOOTLOADERHEX):i

406

endif

407

$(AVRDUDE) $(AVRDUDEFLAGS) -U lock:w:$(BOARD_BOOTLOADER_LOCK):m

408

355

409

# building the target

356

410

357

411

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

362

416

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

363

417

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

364

418

419

%.o: %.ino

420

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

421

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

422

423

%.o: %.pde

424

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

425

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

426

365

427

%.o: %.c

366

428

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

367

429

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

378

440

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

379

441

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

380

442

381

%.o: %.ino

382

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

383

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

384

385

%.o: %.pde

386

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

387

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

443

%.o: %.S

444

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

445

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

388

446

389

447

# building the arduino library

390

448

406

464

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

407

465

mkdir -p $(dir $@)

408

466

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

467

468

.lib/%.s.o: %.s

469

mkdir -p $(dir $@)

470

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

471

472

.lib/%.S.o: %.S

473

mkdir -p $(dir $@)

474

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

475

476

# Local Variables:

477

# mode: makefile

478

# tab-width: 4

479

# End: