/make/arduino-mk : revision 24

1

#_______________________________________________________________________________

2

#

3

# edam's Arduino makefile

3

# edam's arduino makefile

4

#_______________________________________________________________________________

5

# version 0.5dev

5

# version 0.1

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 release and requires that software

32

# to be downloaded separately (see http://arduino.cc/). To download the latest

33

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

34

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

35

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

35

36

#

36

37

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

37

38

#

42

43

#

43

44

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

44

45

#

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.

49

#

50

# 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

46

# You also need to set up a couple of environment variables. ARDUINODIR should

47

# be set to the path where you unpacked the arduino software from arduino.cc

48

# (it defaults to ~/opt/arduino if unset). You might be best to set this in

54

49

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

55

50

#

56

51

# export ARDUINODIR=~/somewhere/arduino-1.0

57

52

#

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:

53

# You will also need to set BOARD to the type of arduino you're using. This

54

# can be done when running make (or you could set a default in ~/.profile and

55

# override it as necessary). For example:

63

56

#

64

57

# $ export BOARD=uno

65

58

# $ make

70

63

# determine values for SOURCES, TARGET and LIBRARIES. Any .c, .cc and .cpp

71

64

# files in the project directory (or any "util" or "utility" subdirectories)

72

65

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

66

# that have been #included. Note, there can only be one .ino (or .pde) file.

74

67

#

75

68

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

76

69

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

82

75

#

83

76

# Here is a complete list of configuration parameters:

84

77

#

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.

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

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

78

# ARDUINODIR The path where you have installed/unpacked the arduino software

79

# (from http://arduino.cc/)

80

#

81

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

82

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

83

#

84

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

85

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

86

# followed by subdirectories in ARDUINODIR if unset.

100

87

#

101

88

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

102

89

# board types.

103

90

#

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

#

110

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

91

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

111

92

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

112

93

#

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

#

117

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

94

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

118

95

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

119

# connected Arduino's serial device.

96

# connected arduino's serial device.

120

97

#

121

98

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

122

99

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

130

107

# when you run make:

131

108

#

132

109

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

133

# target.

110

# target and uploads it.

134

111

#

135

112

# target Builds the target.

136

113

#

137

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

114

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

138

115

#

139

116

# clean Deletes files created during the build.

140

117

#

142

119

# BOARD environment variable appropriately.

143

120

#

144

121

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

145

# equivalent to the Arduino serial monitor.

146

#

147

# size Displays size information about the bulit target.

122

# equivalent to the arduino serial monitor.

148

123

#

149

124

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

150

125

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

153

128

154

129

# default arduino software directory, check software exists

155

130

ifndef ARDUINODIR

156

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

131

ARDUINODIR := $(wildcard ~/opt/arduino)

157

132

endif

158

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

133

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

159

134

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

160

135

endif

161

136

162

# obtain preferences from the IDE's preferences.txt

163

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

164

ifneq "$(PREFERENCES_FILE)" ""

165

SKETCHBOOKDIR := \

166

$(shell sed -ne "s/sketchbook.path=$.*$/\1/p" $(PREFERENCES_FILE))

167

endif

168

169

137

# default arduino version

170

138

ARDUINOCONST ?= 100

171

139

172

140

# default path for avr tools

173

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

174

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

175

176

# default path to find libraries

177

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

141

ifndef AVRTOOLSPATH

142

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

143

AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools

144

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

145

endif

178

146

179

147

# auto mode?

180

148

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

181

149

ifdef INOFILE

182

ifneq "$(words $(INOFILE))" "1"

150

ifneq ($(words $(INOFILE)), 1)

183

151

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

184

152

endif

185

153

186

154

# automatically determine sources and targeet

187

155

TARGET := $(basename $(INOFILE))

188

156

SOURCES := $(INOFILE) \

189

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

190

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

191

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

157

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

158

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

159

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

192

160

193

161

# automatically determine included libraries

194

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

162

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

163

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

195

164

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

196

165

197

166

endif

198

167

168

# no board? oh dear...

169

ifndef BOARD

170

ifneq "$(MAKECMDGOALS)" "boards"

171

ifneq "$(MAKECMDGOALS)" "clean"

172

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

173

endif

174

endif

175

endif

176

199

177

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

200

SERIALDEVGUESS := 0

201

ifeq "$(SERIALDEV)" ""

202

SERIALDEV := $(firstword $(wildcard \

203

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

204

SERIALDEVGUESS := 1

178

ifeq ($(SERIALDEV), )

179

SERIALDEV := $(firstword $(wildcard /dev/ttyACM? /dev/ttyUSB?))

205

180

endif

206

181

207

182

# software

212

187

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

213

188

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

214

189

AVRDUDE := $(call findsoftware,avrdude)

215

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

216

217

# directories

218

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

219

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

220

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

221

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

222

190

223

191

# files

224

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

192

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

225

193

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

226

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

227

ARDUINOLIB := .lib/arduino.a

228

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

229

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

230

231

# avrdude confifuration

232

ifeq "$(AVRDUDECONF)" ""

233

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

234

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

235

else

194

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

195

ARDUINOLIBSDIR := $(ARDUINODIR)/libraries

196

ARDUINOLIB := _arduino.a

197

ARDUINOLIBTMP := $(ARDUINOLIB).tmp

198

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

199

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

200

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

201

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

202

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

203

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

236

204

AVRDUDECONF := $(wildcard $(AVRDUDE).conf)

237

endif

238

endif

239

240

# no board?

241

ifndef BOARD

242

ifneq "$(MAKECMDGOALS)" "boards"

243

ifneq "$(MAKECMDGOALS)" "clean"

244

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

245

endif

246

endif

247

endif

248

205

249

206

# obtain board parameters from the arduino boards.txt file

250

207

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

258

215

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

259

216

BOARD_UPLOAD_PROTOCOL := \

260

217

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

261

BOARD_USB_VID := \

262

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

263

BOARD_USB_PID := \

264

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

265

BOARD_BOOTLOADER_PATH := \

266

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

267

268

# invalid board?

269

ifeq "$(BOARD_BUILD_MCU)" ""

270

ifneq "$(MAKECMDGOALS)" "boards"

271

ifneq "$(MAKECMDGOALS)" "clean"

272

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

273

endif

274

endif

275

endif

276

218

277

219

# flags

278

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

220

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

279

221

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

280

222

CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)

281

223

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

282

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

283

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

284

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

285

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

286

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

287

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

288

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

224

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

225

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

226

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

227

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

228

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

289

229

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

290

230

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

291

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

292

293

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

294

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

295

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

296

297

# include dependencies

298

ifneq "$(MAKECMDGOALS)" "clean"

299

-include $(DEPFILES)

300

endif

231

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

301

232

302

233

# default rule

303

234

.DEFAULT_GOAL := all

305

236

#_______________________________________________________________________________

306

237

# RULES

307

238

308

.PHONY: all target upload clean boards monitor size

239

.PHONY: all target upload clean boards monitor

309

240

310

all: target

241

all: target upload

311

242

312

243

target: $(TARGET).hex

313

244

314

upload: target

245

upload:

315

246

@echo "\nUploading to board..."

316

247

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

317

248

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

318

249

exit 1; }

319

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

320

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

321

echo; }

322

ifeq "$(BOARD_BOOTLOADER_PATH)" "caterina"

323

stty $(STTYFARG) $(SERIALDEV) speed 1200

324

sleep 1

325

endif

326

stty $(STTYFARG) $(SERIALDEV) hupcl

250

stty -F $(SERIALDEV) hupcl

327

251

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

328

252

329

253

clean:

330

254

rm -f $(OBJECTS)

331

255

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

332

rm -rf .lib .dep

256

rm -rf $(ARDUINOLIBTMP)

333

257

334

258

boards:

335

259

@echo Available values for BOARD:

336

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

337

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

338

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

260

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

261

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

339

262

340

263

monitor:

341

264

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

343

266

exit 1; }

344

267

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

345

268

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

346

exit 1; }

347

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

348

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

349

echo; }

269

ecit 1; }

350

270

screen $(SERIALDEV)

351

271

352

size: $(TARGET).elf

353

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

354

355

272

# building the target

356

273

357

274

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

360

277

.INTERMEDIATE: $(TARGET).elf

361

278

362

279

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

363

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

364

365

%.o: %.c

366

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

367

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

368

369

%.o: %.cpp

370

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

371

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

372

373

%.o: %.cc

374

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

375

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

376

377

%.o: %.C

378

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

379

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

280

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

380

281

381

282

%.o: %.ino

382

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

383

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

283

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

384

284

385

285

%.o: %.pde

386

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

387

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

286

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

388

287

389

288

# building the arduino library

390

289

391

290

$(ARDUINOLIB): $(ARDUINOLIBOBJS)

392

291

$(AR) rcs $@ $?

393

394

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

395

mkdir -p $(dir $@)

396

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

397

398

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

399

mkdir -p $(dir $@)

400

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

401

402

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

403

mkdir -p $(dir $@)

404

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

405

406

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

407

mkdir -p $(dir $@)

292

rm -rf $(ARDUINOLIBTMP)

293

294

.INTERMEDIATE: $(ARDUINOLIBOBJS)

295

296

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

297

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

298

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

299

300

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

301

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

302

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

303

304

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

305

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

306

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

307

308

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

309

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

310

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

311

312

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

313

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

314

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

315

316

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

317

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

408

318

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