/make/arduino-mk : revision 84

2

#

3

# edam's Arduino makefile

4

#_______________________________________________________________________________

5

# version 0.5dev

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

28

#

29

#

30

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

31

# software. It works with the arduino-1.0 software release. To download the

32

# latest version of this makefile, visit the following website, where you can

33

# also find more information and documentation on it's use. The following text

34

# can only really be considered a reference to it's use.

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

35

#

36

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

37

#

38

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

39

# build system. To use it, save arduino.mk somewhere (I keep mine at

40

# ~/src/arduino.mk) and create a symlink to it in your project directory named

41

# "Makefile". For example:

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) is required. If you are using

46

# Debian (or a derivative), type `apt-get install arduino`. Otherwise, you

47

# will have to download the Arduino software manually from http://arduino.cc/.

48

# It is suggested that you install it at ~/opt/arduino 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.

49

51

#

50

52

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

51

# other than ~/opt/arduino, you will need to set up ARDUINODIR to be the path

52

# where you unpacked it. (If unset, ARDUINODIR defaults to ~/opt/arduino and

53

# then /usr/share/arduino, in that order.) You might be best to set this in

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

54

56

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

55

57

#

56

58

# export ARDUINODIR=~/somewhere/arduino-1.0

57

59

#

58

# You will also need to set BOARD to the type of Arduino you're building for.

59

# Type `make boards` for a list of acceptable values. You could set a default

60

# in your ~/.profile if you want, but it is suggested that you specify this at

61

# build time, especially if you work with different types of Arduino. For

62

# example:

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

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

74

76

#

75

77

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

76

78

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

77

# (There is no need to define TARGET). Here is an example Makefile:

79

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

80

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

78

81

#

79

82

# SOURCES := main.cc other.cc

80

83

# LIBRARIES := EEPROM

84

# BOARD := pro5v

81

85

# include ~/src/arduino.mk

82

86

#

83

87

# Here is a complete list of configuration parameters:

85

89

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

86

90

#

87

91

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

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

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.

92

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

93

#

94

# AVRDUDECONF The avrdude.conf to use. If undefined, this defaults to a guess

95

# based on where avrdude is. If set empty, no avrdude.conf is

96

# passed to avrdude (so the system default is used).

97

#

98

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

99

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

100

#

101

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

102

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

103

# followed by subdirectories in ARDUINODIR.

97

104

#

98

105

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

99

106

# board types.

100

107

#

108

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

109

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

110

#

111

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

112

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

113

#

101

114

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

102

115

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

103

116

#

104

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

105

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

106

# connected Arduino's serial device.

117

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

118

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

119

# "libraries" (in the project directory), then your sketchbook

120

# "libraries" directory, then the Arduino libraries directory.

121

#

122

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

123

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

124

# connected Arduino's serial device, which may work in some cases.

107

125

#

108

126

# SOURCES A list of all source files of whatever language. The language

109

127

# type is determined by the file extension. This is set

121

139

#

122

140

# target Builds the target.

123

141

#

124

# upload Uploads the last built target to an attached Arduino.

142

# upload Uploads the target (building it, as necessary) to an attached

143

# Arduino.

125

144

#

126

145

# clean Deletes files created during the build.

127

146

#

131

150

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

132

151

# equivalent to the Arduino serial monitor.

133

152

#

134

# size Displays size information about the bulit target.

153

# size Displays size information about the built target.

154

#

155

# bootloader Burns the bootloader for your board to it.

135

156

#

136

157

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

137

158

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

140

161

141

162

# default arduino software directory, check software exists

142

163

ifndef ARDUINODIR

143

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

164

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

165

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

166

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

144

167

endif

145

168

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

146

169

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

150

173

ARDUINOCONST ?= 100

151

174

152

175

# default path for avr tools

153

ifndef AVRTOOLSPATH

154

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

155

AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools

156

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

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

# no board?

191

ifndef BOARD

192

ifneq "$(MAKECMDGOALS)" "boards"

193

ifneq "$(MAKECMDGOALS)" "clean"

194

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

195

endif

196

endif

197

endif

198

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)

205

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

206

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

207

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

208

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

209

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

210

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

211

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

212

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

213

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

214

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

215

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

216

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

217

218

# obtain preferences from the IDE's preferences.txt

219

PREFERENCESFILE := $(firstword $(wildcard \

220

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

221

ifneq "$(PREFERENCESFILE)" ""

222

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

223

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

224

endif

225

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

157

233

endif

158

234

159

235

# auto mode?

166

242

# automatically determine sources and targeet

167

243

TARGET := $(basename $(INOFILE))

168

244

SOURCES := $(INOFILE) \

169

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

170

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

171

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

245

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

246

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

247

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

172

248

173

249

# automatically determine included libraries

174

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

250

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

175

251

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

176

252

177

253

endif

178

254

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

255

# software

188

256

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

189

257

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

194

262

AVRDUDE := $(call findsoftware,avrdude)

195

263

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

196

264

265

# directories

266

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

267

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

268

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

269

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

270

197

271

# files

198

272

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

199

273

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

200

274

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

201

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

202

275

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

276

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

207

277

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

278

BOOTLOADERHEX := $(addprefix \

279

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

280

$(BOARD_BOOTLOADER_FILE))

281

282

# avrdude confifuration

208

283

ifeq "$(AVRDUDECONF)" ""

209

284

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

210

285

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

213

288

endif

214

289

endif

215

290

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

BOARD_USB_VID := \

238

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

239

BOARD_USB_PID := \

240

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

241

242

# invalid board?

243

ifeq "$(BOARD_BUILD_MCU)" ""

244

ifneq "$(MAKECMDGOALS)" "boards"

245

ifneq "$(MAKECMDGOALS)" "clean"

246

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

247

endif

248

endif

249

endif

250

251

291

# flags

252

292

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

253

293

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

256

296

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

257

297

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

258

298

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

259

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

260

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

299

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

261

300

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

262

301

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

263

302

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

280

319

#_______________________________________________________________________________

281

320

# RULES

282

321

283

.PHONY: all target upload clean boards monitor size

322

.PHONY: all target upload clean boards monitor size bootloader

284

323

285

324

all: target

286

325

294

333

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

295

334

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

296

335

echo; }

336

ifeq "$(BOARD_BOOTLOADER_PATH)" "caterina"

337

stty $(STTYFARG) $(SERIALDEV) speed 1200

338

sleep 1

339

else

297

340

stty $(STTYFARG) $(SERIALDEV) hupcl

341

endif

298

342

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

299

343

300

344

clean:

303

347

rm -rf .lib .dep

304

348

305

349

boards:

306

@echo Available values for BOARD:

307

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

350

@echo "Available values for BOARD:"

351

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

308

352

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

309

353

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

310

354

314

358

exit 1; }

315

359

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

316

360

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

317

ecit 1; }

361

exit 1; }

318

362

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

319

363

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

320

364

echo; }

323

367

size: $(TARGET).elf

324

368

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

325

369

370

bootloader:

371

@echo "Burning bootloader to board..."

372

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

373

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

374

exit 1; }

375

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

376

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

377

echo; }

378

stty $(STTYFARG) $(SERIALDEV) hupcl

379

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

380

$(AVRDUDE) $(AVRDUDEFLAGS) -eU lfuse:w:$(BOARD_BOOTLOADER_LFUSES):m

381

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

382

ifneq "$(BOARD_BOOTLOADER_EFUSES)" ""

383

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

384

endif

385

ifneq "$(BOOTLOADERHEX)" ""

386

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

387

endif

388

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

389

326

390

# building the target

327

391

328

392

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

355

419

356

420

%.o: %.pde

357

421

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

358

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

422

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

359

423

360

424

# building the arduino library

361

425

377

441

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

378

442

mkdir -p $(dir $@)

379

443

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

444

445

# Local Variables:

446

# mode: makefile

447

# tab-width: 4

448

# End: