/make/arduino-mk : revision 69

2

#

3

# edam's Arduino makefile

4

#_______________________________________________________________________________

5

# version 0.3dev

5

# version 0.5dev

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

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.

74

#

75

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

76

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

85

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

86

#

87

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

88

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

88

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

89

#

90

# 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

90

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

93

#

94

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

95

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

96

# followed by subdirectories in ARDUINODIR if undefined.

94

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

95

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

96

#

97

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

98

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

99

# followed by subdirectories in ARDUINODIR.

97

100

#

98

101

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

99

102

# board types.

100

103

#

104

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

105

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

106

#

107

# LINKFLAGS Specify any additional flags for the linker. The usual flags,

108

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

109

#

101

110

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

102

111

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

103

112

#

113

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

114

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

115

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

116

#

104

117

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

105

118

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

106

119

# connected Arduino's serial device.

117

130

# when you run make:

118

131

#

119

132

# all This is the default if no goal is specified. It builds the

120

# target and uploads it.

133

# target.

121

134

#

122

135

# target Builds the target.

123

136

#

133

146

#

134

147

# size Displays size information about the bulit target.

135

148

#

149

# bootloader Burns the bootloader for your board to it.

150

#

136

151

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

137

152

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

138

153

#_______________________________________________________________________________

150

165

ARDUINOCONST ?= 100

151

166

152

167

# default path for avr tools

153

ifndef AVRTOOLSPATH

154

AVRTOOLSPATH := $(subst :, , $(PATH))

155

AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools

156

AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools/avr/bin

168

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

169

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

170

171

# default path to find libraries

172

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

173

174

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

175

SERIALDEVGUESS := 0

176

ifndef SERIALDEV

177

SERIALDEV := $(firstword $(wildcard \

178

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

179

SERIALDEVGUESS := 1

180

endif

181

182

# no board?

183

ifndef BOARD

184

ifneq "$(MAKECMDGOALS)" "boards"

185

ifneq "$(MAKECMDGOALS)" "clean"

186

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

187

endif

188

endif

189

endif

190

191

# obtain board parameters from the arduino boards.txt file

192

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

193

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

194

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

195

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

196

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

197

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

198

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

199

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

200

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

201

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

202

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

203

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

204

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

205

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

206

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

207

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

208

209

# obtain preferences from the IDE's preferences.txt

210

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

211

ifneq "$(PREFERENCESFILE)" ""

212

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

213

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

214

endif

215

216

# invalid board?

217

ifeq "$(BOARD_BUILD_MCU)" ""

218

ifneq "$(MAKECMDGOALS)" "boards"

219

ifneq "$(MAKECMDGOALS)" "clean"

220

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

221

endif

222

endif

157

223

endif

158

224

159

225

# auto mode?

166

232

# automatically determine sources and targeet

167

233

TARGET := $(basename $(INOFILE))

168

234

SOURCES := $(INOFILE) \

169

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

170

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

171

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

235

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

236

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

237

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

172

238

173

239

# automatically determine included libraries

174

ARDUINOLIBSAVAIL := $(notdir $(wildcard $(ARDUINODIR)/libraries/*))

175

LIBRARIES := $(filter $(ARDUINOLIBSAVAIL), \

240

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

176

241

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

177

242

178

243

endif

179

244

180

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

181

SERIALDEVGUESS := 0

182

ifeq "$(SERIALDEV)" ""

183

SERIALDEV := $(firstword $(wildcard \

184

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

185

SERIALDEVGUESS := 1

186

endif

187

188

245

# software

189

246

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

190

247

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

195

252

AVRDUDE := $(call findsoftware,avrdude)

196

253

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

197

254

255

# directories

256

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

257

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

258

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

259

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

260

BOOTLOADERDIR := \

261

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

262

198

263

# files

199

264

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

200

265

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

201

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

202

ARDUINOLIBSDIR := $(ARDUINODIR)/libraries

203

ARDUINOLIB := _arduino.a

204

ARDUINOLIBTMP := $(ARDUINOLIB).tmp

205

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

206

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

207

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

208

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

209

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

210

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

266

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

267

ARDUINOLIB := .lib/arduino.a

268

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

269

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

270

BOOTLOADERHEX := $(wildcard $(BOOTLOADERDIR)/$(BOARD_BOOTLOADER_FILE))

271

272

# avrdude confifuration

211

273

ifeq "$(AVRDUDECONF)" ""

212

274

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

213

275

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

216

278

endif

217

279

endif

218

280

219

# no board?

220

ifndef BOARD

221

ifneq "$(MAKECMDGOALS)" "boards"

222

ifneq "$(MAKECMDGOALS)" "clean"

223

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

224

endif

225

endif

226

endif

227

228

# obtain board parameters from the arduino boards.txt file

229

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

230

BOARD_BUILD_MCU := \

231

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

232

BOARD_BUILD_FCPU := \

233

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

234

BOARD_BUILD_VARIANT := \

235

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

236

BOARD_UPLOAD_SPEED := \

237

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

238

BOARD_UPLOAD_PROTOCOL := \

239

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

240

241

# invalid board?

242

ifeq "$(BOARD_BUILD_MCU)" ""

243

ifneq "$(MAKECMDGOALS)" "boards"

244

ifneq "$(MAKECMDGOALS)" "clean"

245

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

246

endif

247

endif

248

endif

249

250

281

# flags

251

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

282

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

252

283

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

253

284

CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)

254

285

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

255

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

256

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

257

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

258

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

259

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

286

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

287

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

288

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

289

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

290

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

291

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

292

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

260

293

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

261

294

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

262

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

263

264

# figure out which arg to use with stty

265

STTYFARG := $(shell stty --help > /dev/null 2>&1 && echo -F || echo -f)

295

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

296

297

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

298

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

299

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

300

301

# include dependencies

302

ifneq "$(MAKECMDGOALS)" "clean"

303

-include $(DEPFILES)

304

endif

266

305

267

306

# default rule

268

307

.DEFAULT_GOAL := all

270

309

#_______________________________________________________________________________

271

310

# RULES

272

311

273

.PHONY: all target upload clean boards monitor size

312

.PHONY: all target upload clean boards monitor size bootloader

274

313

275

all: target upload

314

all: target

276

315

277

316

target: $(TARGET).hex

278

317

279

upload:

318

upload: target

280

319

@echo "\nUploading to board..."

281

320

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

282

321

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

284

323

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

285

324

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

286

325

echo; }

326

ifeq "$(BOARD_BOOTLOADER_PATH)" "caterina"

327

stty $(STTYFARG) $(SERIALDEV) speed 1200

328

sleep 1

329

endif

287

330

stty $(STTYFARG) $(SERIALDEV) hupcl

288

331

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

289

332

290

333

clean:

291

334

rm -f $(OBJECTS)

292

335

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

293

rm -rf $(ARDUINOLIBTMP)

336

rm -rf .lib .dep

294

337

295

338

boards:

296

@echo Available values for BOARD:

297

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

298

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

339

@echo "Available values for BOARD:"

340

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

341

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

342

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

299

343

300

344

monitor:

301

345

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

303

347

exit 1; }

304

348

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

305

349

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

306

ecit 1; }

350

exit 1; }

307

351

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

308

352

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

309

353

echo; }

312

356

size: $(TARGET).elf

313

357

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

314

358

359

bootloader:

360

@echo "Burning bootloader to board..."

361

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

362

echo "error: bootloader file could not be determined." >&2; \

363

exit 1; }

364

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

365

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

366

exit 1; }

367

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

368

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

369

echo; }

370

stty $(STTYFARG) $(SERIALDEV) hupcl

371

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

372

$(AVRDUDE) $(AVRDUDEFLAGS) -e -U lfuse:w:$(BOARD_BOOTLOADER_LFUSES):m \

373

-U hfuse:w:$(BOARD_BOOTLOADER_HFUSES):m \

374

$(patsubst %, -U efuse:w:%:m, $(BOARD_BOOTLOADER_EFUSES))

375

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

376

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

377

315

378

# building the target

316

379

317

380

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

320

383

.INTERMEDIATE: $(TARGET).elf

321

384

322

385

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

323

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

386

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

387

388

%.o: %.c

389

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

390

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

391

392

%.o: %.cpp

393

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

394

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

395

396

%.o: %.cc

397

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

398

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

399

400

%.o: %.C

401

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

402

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

324

403

325

404

%.o: %.ino

326

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

405

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

406

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

327

407

328

408

%.o: %.pde

329

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

409

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

410

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

330

411

331

412

# building the arduino library

332

413

333

414

$(ARDUINOLIB): $(ARDUINOLIBOBJS)

334

415

$(AR) rcs $@ $?

335

rm -rf $(ARDUINOLIBTMP)

336

337

.INTERMEDIATE: $(ARDUINOLIBOBJS)

338

339

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

340

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

341

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

342

343

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

344

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

345

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

346

347

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

348

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

349

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

350

351

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

352

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

353

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

354

355

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

356

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

357

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

358

359

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

360

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

416

417

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

418

mkdir -p $(dir $@)

419

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

420

421

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

422

mkdir -p $(dir $@)

423

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

424

425

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

426

mkdir -p $(dir $@)

427

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

428

429

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

430

mkdir -p $(dir $@)

361

431

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