/make/arduino-mk : revision 88

4

#_______________________________________________________________________________

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

18

#

19

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

20

# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

21

# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

21

# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

22

# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

23

# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

24

# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

28

#

29

#

30

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

31

# software. It is intended to be a drop-in replacement for the Arduino IDE's

32

# build system. It works with the Arduino 1.0 and 1.5 software releases, on

33

# GNU/Linux and OS X. To download the latest version of this makefile visit

34

# the following website where you can also find documentation on it's use.

35

# (The following text can only really be considered a reference.)

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

36

35

#

37

36

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

38

37

#

39

# To use this makefile, copy arduino.mk in to your project directory. Or, you

40

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

41

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

38

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

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, including the new 1.5 BETA) is

46

# required. On GNU/Linux you can probably install the software from your

47

# package manager. If you are using Debian (or a derivative), try `apt-get

48

# install arduino`. Otherwise, you can download the Arduino software manually

49

# from http://arduino.cc/. It is suggested that you install it at

50

# ~/opt/arduino (or /Applications on OS X) 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.

51

#

52

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

53

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

54

# ARDUINODIR environment variable to be the directory where you unpacked it.

55

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

56

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

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

56

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

57

#

58

# export ARDUINODIR=~/somewhere/arduino-1.0.5

58

# export ARDUINODIR=~/somewhere/arduino-1.0

59

#

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

#

66

# Note that if you're using the newer 1.5 Arduino software and the board you

67

# want to use is availble with different processors, you will also need to

68

# specify one. For example:

69

#

70

# $ export BOARD=mini.atmega328

71

#

72

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

65

# $ make

66

#

67

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

73

68

#

74

69

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

75

# determine values for SOURCES, TARGET and which libraries to pull-in to the

76

# build (although you can still override thius by setting LIBRARIES). Any .c,

77

# .cc and .cpp files in the project directory (or any "util" or "utility"

78

# subdirectories) are automatically included in the build and are scanned for

79

# Arduino libraries that have been #included. Note, there can only be one .ino

80

# (or .pde) file in a project directory and if you want to be compatible with

81

# the Arduino IDE, it should be called the same as the directory name.

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

82

76

#

83

77

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

84

78

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

85

# (You don't need to define TARGET). You can also specify the BOARD here, if

79

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

86

80

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

87

81

#

88

82

# SOURCES := main.cc other.cc

90

84

# BOARD := pro5v

91

85

# include ~/src/arduino.mk

92

86

#

93

# Here is a complete list of environment variables that affect the build:

87

# Here is a complete list of configuration parameters:

94

88

#

95

# ARDUINODIR The directory where the Arduino software resides on your system.

89

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

96

90

#

97

91

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

98

92

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

109

103

# followed by subdirectories in ARDUINODIR.

110

104

#

111

105

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

112

# board types. For Arduino 1.5, you will also need to specify a

113

# processor if the board supports multiple processors (see above).

106

# board types.

114

107

#

115

108

# CPPFLAGS Specify any additional flags for the compiler. The usual flags,

116

109

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

166

159

#_______________________________________________________________________________

167

160

#

168

161

169

# default arduino software directory

162

# default arduino software directory, check software exists

170

163

ifndef ARDUINODIR

171

164

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

172

165

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

173

166

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

174

167

endif

175

176

# check ARDUINODIR (and determine which backends are available)

177

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

178

ARDUINOBACKENDS := /

179

else ifneq "" "$(wildcard $(ARDUINODIR)/hardware/arduino/avr/boards.txt)"

180

ARDUINOBACKENDS := /avr /sam

181

else

168

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

182

169

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

183

170

endif

184

171

172

# default arduino version

173

ARDUINOCONST ?= 100

174

175

# default path for avr tools

176

AVRTOOLSPATH ?= $(subst :, , $(PATH)) $(ARDUINODIR)/hardware/tools \

177

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

178

179

# default path to find libraries

180

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

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

185

190

# no board?

186

191

ifndef BOARD

187

192

ifneq "$(MAKECMDGOALS)" "boards"

191

196

endif

192

197

endif

193

198

194

# obtain board parameters from the arduino boards.txt file(s)

195

BOARDSFILES := $(foreach dir, $(ARDUINOBACKENDS), \

196

$(ARDUINODIR)/hardware/arduino$(dir)/boards.txt)

197

readboardsparam = $(firstword \

198

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

199

$(BOARDSFILES)) \

200

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

201

$(BOARDSFILES)))

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)

215

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

216

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

217

218

# invalid board?

219

ifeq "$(BOARD_BUILD_MCU)" ""

220

ifneq "$(MAKECMDGOALS)" "boards"

221

ifneq "$(MAKECMDGOALS)" "clean"

222

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

223

endif

224

endif

225

endif

226

227

218

# obtain preferences from the IDE's preferences.txt

228

219

PREFERENCESFILE := $(firstword $(wildcard \

229

220

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

232

223

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

233

224

endif

234

225

235

# arduino directories

236

ARDUINOBACKENDDIR := $(strip $(foreach dir, $(ARDUINOBACKENDS), \

237

$(if $(shell grep ^$(basename $(BOARD))\\.name \

238

$(ARDUINODIR)/hardware/arduino$(dir)/boards.txt), \

239

$(ARDUINODIR)/hardware/arduino$(dir))))

240

ARDUINOCOREDIR := $(ARDUINOBACKENDDIR)/cores/$(BOARD_BUILD_CORE)

241

242

# default library path (places to look for libraries)

243

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

244

$(ARDUINODIR)/libraries $(ARDUINOBACKENDDIR)/libraries

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

245

234

246

235

# auto mode?

247

236

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

250

239

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

251

240

endif

252

241

253

# automatically determine sources and target

242

# automatically determine sources and targeet

254

243

TARGET := $(basename $(INOFILE))

255

244

SOURCES := $(INOFILE) \

256

245

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

257

246

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

258

247

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

259

248

260

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

261

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

262

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

263

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

264

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

265

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

266

INCLUDEDHEADERS := $(shell sed -ne "/^[ \t]*\#[ \t]*include[ \t<\"]/ {" \

267

-e "s/^.*[<\"]$.*$[>\"].*/\1/" -e "p" -e "}" $(SOURCES))

268

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

269

$(firstword $(1))

270

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

271

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

272

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

273

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

274

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

249

# automatically determine included libraries

250

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

251

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

252

$(SOURCES)))

275

253

276

254

endif

277

255

278

# expand LIBRARYDIRS (initialised from LIBRARIES, if specified)

279

ifneq "$(LIBRARIES)" ""

256

# software

257

findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(AVRTOOLSPATH))))

258

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

259

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

260

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

261

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

262

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

263

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

264

AVRDUDE := $(call findsoftware,avrdude)

265

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

266

267

# directories

268

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

280

269

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

281

270

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

282

endif

283

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

271

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

284

272

285

273

# files

286

274

TARGET := $(if $(TARGET),$(TARGET),a.out)

291

279

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

292

280

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

293

281

BOOTLOADERHEX := $(addprefix \

294

$(ARDUINOBACKENDDIR)/bootloaders/$(BOARD_BOOTLOADER_PATH)/, \

282

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

295

283

$(BOARD_BOOTLOADER_FILE))

296

284

297

# software

298

BUILDTOOLSPATH ?= $(subst :, , $(PATH)) $(ARDUINODIR)/hardware/tools \

299

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

300

findsoftware = $(firstword $(wildcard $(addsuffix /$(1), $(BUILDTOOLSPATH))))

301

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

302

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

303

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

304

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

305

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

306

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

307

AVRDUDE := $(call findsoftware,avrdude)

308

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

309

310

# default arduino version

311

ARDUINOCONST ?= $(if $(filter /, $(ARDUINOBACKENDS)),100,150)

312

313

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

314

SERIALDEVGUESS := 0

315

ifndef SERIALDEV

316

SERIALDEV := $(firstword $(wildcard \

317

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

318

SERIALDEVGUESS := 1

319

endif

320

321

285

# avrdude confifuration

322

286

ifeq "$(AVRDUDECONF)" ""

323

287

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

334

298

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

335

299

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

336

300

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

337

CPPFLAGS += -I $(ARDUINOBACKENDDIR)/variants/$(BOARD_BUILD_VARIANT)/

301

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

338

302

CPPFLAGS += $(addprefix -I , $(LIBRARYDIRS))

339

303

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

340

304

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

375

339

ifeq "$(BOARD_BOOTLOADER_PATH)" "caterina"

376

340

stty $(STTYFARG) $(SERIALDEV) speed 1200

377

341

sleep 1

378

else ifeq "" "$(filter net:% usb:%,$(SERIALDEV))"

342

else

379

343

stty $(STTYFARG) $(SERIALDEV) hupcl

380

344

endif

381

345

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

386

350

rm -rf .lib .dep

387

351

388

352

boards:

389

@echo "Available BOARD values:"

390

@sed -ne '/[[:alnum:]]*\.name=/p' \

391

-e '/^[[:alnum:]]*\.menu\.cpu\.[[:alnum:]]*=/p' $(BOARDSFILES) | \

392

sed -e 's/$[[:alnum:]]*$\.name=$.*$/\1 \2/' \

393

-e 's/^.*$\.[[:alnum:]]*$=$.*$/ \1 --\2/' \

394

-e 's/$.\{19\}$ *$.*$/ \1 \2/' -e 's/--/ ...with /'

395

ifneq "$(ARDUINOBACKENDS)" "/"

396

@echo

397

@echo "NOTE: where a board supports multiple CPUs, you must specify" \

398

"one. For example,"

399

@echo "'uno' is OK, and so is 'pro.16mhzatmega328'. But 'pro', on" \

400

"its own, is not."

401

endif

353

@echo "Available values for BOARD:"

354

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

355

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

356

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

402

357

403

358

monitor:

404

359

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

413

368

screen $(SERIALDEV)

414

369

415

370

size: $(TARGET).elf

416

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

371

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

417

372

418

373

bootloader:

419

374

@echo "Burning bootloader to board..."

446

401

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

447

402

448

403

%.o: %.ino

449

mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))

404

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

450

405

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

451

406

452

407

%.o: %.pde

453

mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))

408

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

454

409

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

455

410

456

411

%.o: %.c

457

mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))

412

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

458

413

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

459

414

460

415

%.o: %.cpp

461

mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))

416

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

462

417

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

463

418

464

419

%.o: %.cc

465

mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))

420

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

466

421

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

467

422

468

423

%.o: %.C

469

mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))

424

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

470

425

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

471

426

472

427

%.o: %.S

473

mkdir -p .dep/$(pathsubst ./%,%,$(dir $<))

428

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

474

429

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

475

430

476

431

# building the arduino library