/make/arduino-mk : revision 73

2

#

3

# edam's Arduino makefile

4

#_______________________________________________________________________________

5

# version 0.3

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.

131

144

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

132

145

# equivalent to the Arduino serial monitor.

133

146

#

134

# size Displays size information about the bulit target.

147

# size Displays size information about the built target.

148

#

149

# bootloader Burns the bootloader for your board to it.

135

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.

140

155

141

156

# default arduino software directory, check software exists

142

157

ifndef ARDUINODIR

143

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

158

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

159

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

160

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

144

161

endif

145

162

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

146

163

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

150

167

ARDUINOCONST ?= 100

151

168

152

169

# default path for avr tools

153

ifndef AVRTOOLSPATH

154

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

155

AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools

156

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

170

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

171

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

172

173

# default path to find libraries

174

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

175

176

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

177

SERIALDEVGUESS := 0

178

ifndef SERIALDEV

179

SERIALDEV := $(firstword $(wildcard \

180

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

181

SERIALDEVGUESS := 1

182

endif

183

184

# no board?

185

ifndef BOARD

186

ifneq "$(MAKECMDGOALS)" "boards"

187

ifneq "$(MAKECMDGOALS)" "clean"

188

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

189

endif

190

endif

191

endif

192

193

# obtain board parameters from the arduino boards.txt file

194

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

195

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

196

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

197

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

198

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

199

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

200

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

201

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

202

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

203

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

204

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

205

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

206

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

207

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

208

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

209

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

210

211

# obtain preferences from the IDE's preferences.txt

212

PREFERENCESFILE := $(firstword $(wildcard \

213

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

214

ifneq "$(PREFERENCESFILE)" ""

215

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

216

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

217

endif

218

219

# invalid board?

220

ifeq "$(BOARD_BUILD_MCU)" ""

221

ifneq "$(MAKECMDGOALS)" "boards"

222

ifneq "$(MAKECMDGOALS)" "clean"

223

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

224

endif

225

endif

157

226

endif

158

227

159

228

# auto mode?

166

235

# automatically determine sources and targeet

167

236

TARGET := $(basename $(INOFILE))

168

237

SOURCES := $(INOFILE) \

169

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

170

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

171

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

238

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

239

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

240

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

172

241

173

242

# automatically determine included libraries

174

LIBRARIES := $(filter $(notdir $(wildcard $(ARDUINODIR)/libraries/*)), \

243

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

175

244

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

176

245

177

246

endif

178

247

179

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

180

SERIALDEVGUESS := 0

181

ifeq "$(SERIALDEV)" ""

182

SERIALDEV := $(firstword $(wildcard \

183

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

184

SERIALDEVGUESS := 1

185

endif

186

187

248

# software

188

249

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

189

250

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

194

255

AVRDUDE := $(call findsoftware,avrdude)

195

256

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

196

257

258

# directories

259

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

260

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

261

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

262

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

263

197

264

# files

198

265

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

199

266

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

200

267

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

201

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

202

268

ARDUINOLIB := .lib/arduino.a

203

ARDUINOLIBLIBSDIR := $(ARDUINODIR)/libraries

204

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

205

$(ARDUINODIR)/libraries/$(lib)/ $(ARDUINODIR)/libraries/$(lib)/utility/ )

206

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

269

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

207

270

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

271

BOOTLOADERHEX := $(addprefix \

272

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

273

$(BOARD_BOOTLOADER_FILE))

274

275

# avrdude confifuration

208

276

ifeq "$(AVRDUDECONF)" ""

209

277

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

210

278

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

213

281

endif

214

282

endif

215

283

216

# no board?

217

ifndef BOARD

218

ifneq "$(MAKECMDGOALS)" "boards"

219

ifneq "$(MAKECMDGOALS)" "clean"

220

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

221

endif

222

endif

223

endif

224

225

# obtain board parameters from the arduino boards.txt file

226

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

227

BOARD_BUILD_MCU := \

228

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

229

BOARD_BUILD_FCPU := \

230

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

231

BOARD_BUILD_VARIANT := \

232

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

233

BOARD_UPLOAD_SPEED := \

234

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

235

BOARD_UPLOAD_PROTOCOL := \

236

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

237

238

# invalid board?

239

ifeq "$(BOARD_BUILD_MCU)" ""

240

ifneq "$(MAKECMDGOALS)" "boards"

241

ifneq "$(MAKECMDGOALS)" "clean"

242

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

243

endif

244

endif

245

endif

246

247

284

# flags

248

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

285

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

249

286

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

250

287

CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)

251

288

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

252

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

253

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

254

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

255

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

289

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

290

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

291

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

292

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

256

293

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

257

294

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

258

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

295

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

259

296

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

260

297

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

261

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

298

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

262

299

263

# figure out which arg to use with stty

264

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

300

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

301

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

302

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

265

303

266

304

# include dependencies

267

305

ifneq "$(MAKECMDGOALS)" "clean"

274

312

#_______________________________________________________________________________

275

313

# RULES

276

314

277

.PHONY: all target upload clean boards monitor size

315

.PHONY: all target upload clean boards monitor size bootloader

278

316

279

317

all: target

280

318

281

319

target: $(TARGET).hex

282

320

283

upload:

321

upload: target

284

322

@echo "\nUploading to board..."

285

323

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

286

324

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

288

326

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

289

327

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

290

328

echo; }

329

ifeq "$(BOARD_BOOTLOADER_PATH)" "caterina"

330

stty $(STTYFARG) $(SERIALDEV) speed 1200

331

sleep 1

332

endif

291

333

stty $(STTYFARG) $(SERIALDEV) hupcl

292

334

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

293

335

297

339

rm -rf .lib .dep

298

340

299

341

boards:

300

@echo Available values for BOARD:

301

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

302

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

303

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

342

@echo "Available values for BOARD:"

343

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

344

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

345

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

304

346

305

347

monitor:

306

348

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

308

350

exit 1; }

309

351

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

310

352

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

311

ecit 1; }

353

exit 1; }

312

354

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

313

355

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

314

356

echo; }

317

359

size: $(TARGET).elf

318

360

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

319

361

362

bootloader:

363

@echo "Burning bootloader to board..."

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) -eU lfuse:w:$(BOARD_BOOTLOADER_LFUSES):m

373

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

374

ifneq "$(BOARD_BOOTLOADER_EFUSES)" ""

375

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

376

endif

377

ifneq "$(BOOTLOADERHEX)" ""

378

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

379

endif

380

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

381

320

382

# building the target

321

383

322

384

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

325

387

.INTERMEDIATE: $(TARGET).elf

326

388

327

389

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

328

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

390

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

329

391

330

392

%.o: %.c

331

393

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

349

411

350

412

%.o: %.pde

351

413

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

352

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

414

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

353

415

354

416

# building the arduino library

355

417