/make/arduino-mk : revision 94

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

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

35

36

#

36

37

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

37

38

#

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:

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:

42

#

43

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

44

#

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.

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.

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

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:

57

#

58

# export ARDUINODIR=~/somewhere/arduino-1.0

58

# export ARDUINODIR=~/somewhere/arduino-1.0.5

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

# $ make

66

#

67

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

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.

68

73

#

69

74

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

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.

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.

76

82

#

77

83

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

78

84

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

79

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

85

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

80

86

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

81

87

#

82

88

# SOURCES := main.cc other.cc

84

90

# BOARD := pro5v

85

91

# include ~/src/arduino.mk

86

92

#

87

# Here is a complete list of configuration parameters:

93

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

88

94

#

89

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

95

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

90

96

#

91

97

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

92

98

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

103

109

# followed by subdirectories in ARDUINODIR.

104

110

#

105

111

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

106

# board types.

112

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

113

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

107

114

#

108

115

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

109

116

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

159

166

#_______________________________________________________________________________

160

167

#

161

168

162

# default arduino software directory, check software exists

169

# default arduino software directory

163

170

ifndef ARDUINODIR

164

171

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

165

172

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

166

173

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

167

174

endif

168

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

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

169

182

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

170

183

endif

171

184

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

190

185

# no board?

191

186

ifndef BOARD

192

187

ifneq "$(MAKECMDGOALS)" "boards"

196

191

endif

197

192

endif

198

193

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

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/Ip" \

199

$(BOARDSFILES)) \

200

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

201

$(BOARDSFILES)))

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)

205

206

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

206

207

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

207

208

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

214

215

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

215

216

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

216

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

217

227

# obtain preferences from the IDE's preferences.txt

218

228

PREFERENCESFILE := $(firstword $(wildcard \

219

229

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

222

232

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

223

233

endif

224

234

225

# invalid board?

226

ifeq "$(BOARD_BUILD_MCU)" ""

227

ifneq "$(MAKECMDGOALS)" "boards"

228

ifneq "$(MAKECMDGOALS)" "clean"

229

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

230

endif

231

endif

232

endif

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

233

245

234

246

# auto mode?

235

247

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

238

250

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

239

251

endif

240

252

241

# automatically determine sources and targeet

253

# automatically determine sources and target

242

254

TARGET := $(basename $(INOFILE))

243

255

SOURCES := $(INOFILE) \

244

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

245

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

246

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

256

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

257

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

258

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

247

259

248

# automatically determine included libraries

249

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

250

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

260

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

261

# by matching included headers in poject 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 := \

267

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

268

$(SOURCES))

269

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

270

$(firstword $(1))

271

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

272

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

273

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

274

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

275

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

251

276

252

277

endif

253

278

254

# software

255

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

256

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

257

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

258

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

259

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

260

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

261

AVRDUDE := $(call findsoftware,avrdude)

262

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

263

264

# directories

265

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

279

# expand LIBRARYDIRS (initialised from LIBRARIES, if specified)

280

ifneq "$(LIBRARIES)" ""

266

281

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

267

282

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

268

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

283

endif

284

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

269

285

270

286

# files

271

287

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

273

289

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

274

290

ARDUINOLIB := .lib/arduino.a

275

291

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

276

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

292

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

293

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

277

294

BOOTLOADERHEX := $(addprefix \

278

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

295

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

279

296

$(BOARD_BOOTLOADER_FILE))

280

297

298

# software

299

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

300

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

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

AVRDUDE := $(call findsoftware,avrdude)

309

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

310

311

# default arduino version

312

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

313

314

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

315

SERIALDEVGUESS := 0

316

ifndef SERIALDEV

317

SERIALDEV := $(firstword $(wildcard \

318

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

319

SERIALDEVGUESS := 1

320

endif

321

281

322

# avrdude confifuration

282

323

ifeq "$(AVRDUDECONF)" ""

283

324

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

294

335

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

295

336

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

296

337

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

297

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

338

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

298

339

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

299

340

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

300

341

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

301

342

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

302

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

303

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

343

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

344

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

304

345

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

305

346

306

347

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

335

376

ifeq "$(BOARD_BOOTLOADER_PATH)" "caterina"

336

377

stty $(STTYFARG) $(SERIALDEV) speed 1200

337

378

sleep 1

338

else

379

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

339

380

stty $(STTYFARG) $(SERIALDEV) hupcl

340

381

endif

341

382

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

346

387

rm -rf .lib .dep

347

388

348

389

boards:

349

@echo "Available values for BOARD:"

350

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

351

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

352

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

390

@echo "Available BOARD values:"

391

@sed -nre '/^\w+\.name=/p; /^menu\.cpu\.\w+\.\w+=/p;' $(BOARDSFILES) | \

392

sed -re 's/(\w+)\.name=(.*)/\1 \2/' \

393

-e 's/menu.cpu.\w+(\.\w+)=(.*)/ \1 --\2/' \

394

-e 's/(.{19}) *(.*)/ \1 \2/; s/--/ w\/ /;'

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

402

354

403

monitor:

355

404

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

364

413

screen $(SERIALDEV)

365

414

366

415

size: $(TARGET).elf

367

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

416

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

368

417

369

418

bootloader:

370

419

@echo "Burning bootloader to board..."

396

445

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

397

446

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

398

447

448

%.o: %.ino

449

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

450

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

451

452

%.o: %.pde

453

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

454

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

455

399

456

%.o: %.c

400

457

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

401

458

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

412

469

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

413

470

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

414

471

415

%.o: %.ino

416

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

417

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

418

419

%.o: %.pde

420

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

421

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

472

%.o: %.S

473

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

474

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

422

475

423

476

# building the arduino library

424

477

441

494

mkdir -p $(dir $@)

442

495

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

443

496

497

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

498

mkdir -p $(dir $@)

499

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

500

501

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

502

mkdir -p $(dir $@)

503

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

504

444

505

# Local Variables:

445

506

# mode: makefile

446

507

# tab-width: 4