/make/arduino-mk : revision 65

1

#_______________________________________________________________________________

2

#

3

# edam's arduino makefile

3

# edam's Arduino makefile

4

#_______________________________________________________________________________

5

# version 0.1

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

28

#

29

#

30

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

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.

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.

36

35

#

37

36

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

38

37

#

43

42

#

44

43

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

45

44

#

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

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

49

54

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

50

55

#

51

56

# export ARDUINODIR=~/somewhere/arduino-1.0

52

57

#

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:

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:

56

63

#

57

64

# $ export BOARD=uno

58

65

# $ make

63

70

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

64

71

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

65

72

# are automatically included in the build and are scanned for Arduino libraries

66

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

67

74

#

68

75

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

69

76

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

75

82

#

76

83

# Here is a complete list of configuration parameters:

77

84

#

78

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

79

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

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.

80

100

#

81

101

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

82

102

# board types.

83

103

#

84

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

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

111

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

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

#

117

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

85

118

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

86

# connected arduino's serial device.

119

# connected Arduino's serial device.

120

#

121

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

122

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

123

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

87

124

#

88

125

# TARGET The name of the target file. This is set automatically if a

89

126

# .ino (or .pde) is found, but it is not necessary to set it

90

127

# otherwise.

91

128

#

92

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

93

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

94

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

95

#

96

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

97

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

98

#

99

129

# This makefile also defines the following goals for use on the command line

100

130

# when you run make:

101

131

#

102

132

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

103

# target and uploads it.

133

# target.

104

134

#

105

135

# target Builds the target.

106

136

#

107

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

137

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

108

138

#

109

139

# clean Deletes files created during the build.

110

140

#

112

142

# BOARD environment variable appropriately.

113

143

#

114

144

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

115

# equivalent to the arduino serial monitor.

145

# equivalent to the Arduino serial monitor.

146

#

147

# size Displays size information about the bulit target.

116

148

#

117

149

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

118

150

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

119

151

#_______________________________________________________________________________

120

152

#

121

153

122

# The full path to the arduino software, from arduino.cc

154

# default arduino software directory, check software exists

123

155

ifndef ARDUINODIR

124

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

156

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

125

157

endif

126

127

# check arduino software

128

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

158

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

129

159

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

130

160

endif

131

161

162

# default arduino version

163

ARDUINOCONST ?= 100

164

165

# default path for avr tools

166

ifndef AVRTOOLSPATH

167

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

168

AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools

169

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

170

endif

171

172

# default path to find libraries

173

LIBRARYPATH ?= libraries libs $(ARDUINODIR)/libraries

174

132

175

# auto mode?

133

176

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

134

177

ifdef INOFILE

135

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

178

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

136

179

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

137

180

endif

181

182

# automatically determine sources and targeet

138

183

TARGET := $(basename $(INOFILE))

139

184

SOURCES := $(INOFILE) \

140

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

141

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

142

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

185

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

186

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

187

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

188

143

189

# automatically determine included libraries

144

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

145

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

190

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

146

191

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

147

endif

148

149

# no target? use default

150

ifeq ($(TARGET), )

151

TARGET := a.out

152

endif

153

154

# no serial device? attempt to detect an arduino

155

ifeq ($(SERIALDEV), )

156

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

157

endif

158

159

# no board? oh dear...

192

193

endif

194

195

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

196

SERIALDEVGUESS := 0

197

ifeq "$(SERIALDEV)" ""

198

SERIALDEV := $(firstword $(wildcard \

199

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

200

SERIALDEVGUESS := 1

201

endif

202

203

# software

204

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

205

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

206

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

207

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

208

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

209

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

210

AVRDUDE := $(call findsoftware,avrdude)

211

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

212

213

# directories

214

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

215

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

216

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

217

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

218

219

# files

220

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

221

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

222

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

223

ARDUINOLIB := .lib/arduino.a

224

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

225

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

226

227

# avrdude confifuration

228

ifeq "$(AVRDUDECONF)" ""

229

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

230

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

231

else

232

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

233

endif

234

endif

235

236

# no board?

160

237

ifndef BOARD

161

238

ifneq "$(MAKECMDGOALS)" "boards"

162

239

ifneq "$(MAKECMDGOALS)" "clean"

165

242

endif

166

243

endif

167

244

168

# files

169

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

170

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

171

ARDUINOLIBSDIR := $(ARDUINODIR)/libraries

172

ARDUINOLIB := _arduino.a

173

ARDUINOLIBTMP := $(ARDUINOLIB).tmp

174

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

175

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

176

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

177

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

178

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

179

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

180

181

245

# obtain board parameters from the arduino boards.txt file

182

246

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

183

247

BOARD_BUILD_MCU := \

190

254

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

191

255

BOARD_UPLOAD_PROTOCOL := \

192

256

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

257

BOARD_USB_VID := \

258

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

259

BOARD_USB_PID := \

260

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

193

261

194

# software (prioritise binaries that came with arduino software)

195

FIND_SOFTWARE = $(firstword $(wildcard \

196

$(ARDUINODIR)/hardware/tools/$(1) \

197

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

198

) $(1) )

199

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

200

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

201

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

202

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

203

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

204

AVRDUDE := $(call FIND_SOFTWARE,avrdude)

262

# invalid board?

263

ifeq "$(BOARD_BUILD_MCU)" ""

264

ifneq "$(MAKECMDGOALS)" "boards"

265

ifneq "$(MAKECMDGOALS)" "clean"

266

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

267

endif

268

endif

269

endif

205

270

206

271

# flags

207

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

208

CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU) -DF_CPU=$(BOARD_BUILD_FCPU)

209

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

210

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

211

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

212

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

213

AVRDUDEFLAGS = -C $(ARDUINODIR)/hardware/tools/avrdude.conf -DV

272

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

273

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

274

CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)

275

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

276

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

277

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

278

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

279

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

280

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

281

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

282

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

214

283

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

215

284

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

216

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

285

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

286

287

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

288

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

289

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

290

291

# include dependencies

292

ifneq "$(MAKECMDGOALS)" "clean"

293

-include $(DEPFILES)

294

endif

217

295

218

296

# default rule

219

297

.DEFAULT_GOAL := all

221

299

#_______________________________________________________________________________

222

300

# RULES

223

301

224

.PHONY: all target upload clean boards monitor

302

.PHONY: all target upload clean boards monitor size

225

303

226

all: target upload

304

all: target

227

305

228

306

target: $(TARGET).hex

229

307

230

upload:

308

upload: target

231

309

@echo "\nUploading to board..."

232

310

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

233

311

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

234

312

exit 1; }

235

stty -F $(SERIALDEV) hupcl

313

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

314

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

315

echo; }

316

stty $(STTYFARG) $(SERIALDEV) hupcl

236

317

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

237

318

238

319

clean:

239

320

rm -f $(OBJECTS)

240

321

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

241

rm -rf $(ARDUINOLIBTMP)

322

rm -rf .lib .dep

242

323

243

324

boards:

244

325

@echo Available values for BOARD:

245

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

246

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

326

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

327

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

328

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

247

329

248

330

monitor:

249

331

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

251

333

exit 1; }

252

334

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

253

335

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

254

ecit 1; }

336

exit 1; }

337

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

338

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

339

echo; }

255

340

screen $(SERIALDEV)

256

341

342

size: $(TARGET).elf

343

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

344

257

345

# building the target

258

346

259

347

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

262

350

.INTERMEDIATE: $(TARGET).elf

263

351

264

352

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

265

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

353

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

354

355

%.o: %.c

356

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

357

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

358

359

%.o: %.cpp

360

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

361

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

362

363

%.o: %.cc

364

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

365

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

366

367

%.o: %.C

368

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

369

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

266

370

267

371

%.o: %.ino

268

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

372

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

373

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

269

374

270

375

%.o: %.pde

271

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

376

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

377

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

272

378

273

379

# building the arduino library

274

380

275

381

$(ARDUINOLIB): $(ARDUINOLIBOBJS)

276

382

$(AR) rcs $@ $?

277

rm -rf $(ARDUINOLIBTMP)

278

279

.INTERMEDIATE: $(ARDUINOLIBOBJS)

280

281

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

282

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

283

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

284

285

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

286

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

287

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

288

289

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

290

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

291

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

292

293

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

294

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

295

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

296

297

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

298

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

299

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

300

301

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

302

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

383

384

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

385

mkdir -p $(dir $@)

386

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

387

388

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

389

mkdir -p $(dir $@)

390

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

391

392

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

393

mkdir -p $(dir $@)

394

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

395

396

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

397

mkdir -p $(dir $@)

303

398

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