/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

ifeq "$(ARDUINOBACKENDS)" "/"

198

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

199

$(BOARDSFILES))

200

else

201

readboardsparam = $(firstword \

202

$(call readboardsmenuparam,$(1),$(basename $(BOARD)),$(suffix $(BOARD))) \

203

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

204

$(BOARDSFILES)))

205

ifneq "$(wildcard /usr/bin/perl)" ""

206

readboardsmenuparam = $(shell perl -ne \

207

'/^$(2)\.menu\.cpu/ && s/.*$(3)\.$(1)=(.*)/\1/i && print' $(BOARDSFILES))

208

else

209

readboardsmenuparam = $(shell sed -ne '/^$(2)\.menu\.cpu/ {' \

210

-e 's/.*$(3)\.$(1)=$.*$/\1/p' -e '}' $(BOARDSFILES))

211

endif

212

endif

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

213

202

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

214

203

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

215

204

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

216

205

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

217

BOARD_BUILD_BOARD := $(call readboardsparam,build.board)

218

206

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

219

207

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

220

208

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

227

215

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

228

216

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

229

217

230

# invalid board?

231

ifeq "$(BOARD_BUILD_MCU)" ""

232

ifneq "$(MAKECMDGOALS)" "boards"

233

ifneq "$(MAKECMDGOALS)" "clean"

234

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

235

endif

236

endif

237

endif

238

239

218

# obtain preferences from the IDE's preferences.txt

240

219

PREFERENCESFILE := $(firstword $(wildcard \

241

220

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

244

223

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

245

224

endif

246

225

247

# arduino directories

248

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

249

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

250

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

251

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

252

ARDUINOBACKENDARCH=AVR

253

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

254

255

# default library path (places to look for libraries)

256

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

257

$(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

258

234

259

235

# auto mode?

260

236

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

263

239

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

264

240

endif

265

241

266

# automatically determine sources and target

242

# automatically determine sources and targeet

267

243

TARGET := $(basename $(INOFILE))

268

244

SOURCES := $(INOFILE) \

269

245

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

270

246

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

271

247

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

272

248

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

$(firstword $(1))

283

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

284

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

285

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

286

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

287

$(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)))

288

253

289

254

endif

290

255

291

# expand LIBRARYDIRS (initialised from LIBRARIES, if specified)

292

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)

293

269

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

294

270

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

295

endif

296

LIBRARYDIRS := $(LIBRARYDIRS) \

297

$(addsuffix /utility, $(LIBRARYDIRS)) \

298

$(addsuffix /src, $(LIBRARYDIRS))

271

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

299

272

300

273

# files

301

274

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

306

279

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

307

280

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

308

281

BOOTLOADERHEX := $(addprefix \

309

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

282

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

310

283

$(BOARD_BOOTLOADER_FILE))

311

284

312

# software

313

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

314

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

315

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

316

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

317

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

318

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

319

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

320

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

321

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

322

AVRDUDE := $(call findsoftware,avrdude)

323

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

324

325

# default arduino version

326

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

327

328

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

329

SERIALDEVGUESS := 0

330

ifndef SERIALDEV

331

SERIALDEV := $(firstword $(wildcard \

332

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

333

SERIALDEVGUESS := 1

334

endif

335

336

285

# avrdude confifuration

337

286

ifeq "$(AVRDUDECONF)" ""

338

287

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

345

294

# flags

346

295

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

347

296

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

348

CPPFLAGS += -fpermissive -mmcu=$(BOARD_BUILD_MCU)

297

CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)

349

298

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

350

CPPFLAGS += -DARDUINO_$(BOARD_BUILD_BOARD) -DARDUINO_ARCH_$(ARDUINOBACKENDARCH)

351

299

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

352

300

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

353

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

301

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

354

302

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

355

303

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

356

304

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

391

339

ifeq "$(BOARD_BOOTLOADER_PATH)" "caterina"

392

340

stty $(STTYFARG) $(SERIALDEV) speed 1200

393

341

sleep 1

394

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

342

else

395

343

stty $(STTYFARG) $(SERIALDEV) hupcl

396

344

endif

397

345

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

402

350

rm -rf .lib .dep

403

351

404

352

boards:

405

@echo "Available BOARD values:"

406

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

407

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

408

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

409

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

410

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

411

ifneq "$(ARDUINOBACKENDS)" "/"

412

@echo

413

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

414

"one. For example,"

415

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

416

"its own, is not."

417

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/'

418

357

419

358

monitor:

420

359

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

429

368

screen $(SERIALDEV)

430

369

431

370

size: $(TARGET).elf

432

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

371

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

433

372

434

373

bootloader:

435

374

@echo "Burning bootloader to board..."

462

401

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

463

402

464

403

%.o: %.ino

465

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

404

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

466

405

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

467

406

468

407

%.o: %.pde

469

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

408

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

470

409

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

471

410

472

411

%.o: %.c

473

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

412

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

474

413

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

475

414

476

415

%.o: %.cpp

477

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

416

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

478

417

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

479

418

480

419

%.o: %.cc

481

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

420

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

482

421

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

483

422

484

423

%.o: %.C

485

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

424

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

486

425

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

487

426

488

427

%.o: %.S

489

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

428

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

490

429

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

491

430

492

431

# building the arduino library