/make/arduino-mk : revision 24

1

#_______________________________________________________________________________

2

#

3

# edam's Arduino makefile

3

# edam's arduino makefile

4

#_______________________________________________________________________________

5

# version 0.4dev

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

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

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.

93

83

#

94

84

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

85

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

86

# followed by subdirectories in ARDUINODIR if unset.

97

87

#

98

88

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

99

89

# board types.

100

90

#

101

# 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

102

92

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

103

93

#

104

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

105

95

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

106

# connected Arduino's serial device.

96

# connected arduino's serial device.

107

97

#

108

98

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

109

99

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

117

107

# when you run make:

118

108

#

119

109

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

120

# target.

110

# target and uploads it.

121

111

#

122

112

# target Builds the target.

123

113

#

124

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

114

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

125

115

#

126

116

# clean Deletes files created during the build.

127

117

#

129

119

# BOARD environment variable appropriately.

130

120

#

131

121

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

132

# equivalent to the Arduino serial monitor.

133

#

134

# size Displays size information about the bulit target.

122

# equivalent to the arduino serial monitor.

135

123

#

136

124

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

137

125

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

140

128

141

129

# default arduino software directory, check software exists

142

130

ifndef ARDUINODIR

143

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

131

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

144

132

endif

145

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

133

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

146

134

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

147

135

endif

148

136

159

147

# auto mode?

160

148

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

161

149

ifdef INOFILE

162

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

150

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

163

151

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

164

152

endif

165

153

171

159

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

172

160

173

161

# automatically determine included libraries

174

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

162

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

163

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

175

164

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

176

165

177

166

endif

178

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

179

177

# 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

178

ifeq ($(SERIALDEV), )

179

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

185

180

endif

186

181

187

182

# software

192

187

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

193

188

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

194

189

AVRDUDE := $(call findsoftware,avrdude)

195

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

196

190

197

191

# files

198

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

192

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

199

193

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

200

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

201

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

202

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

207

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

208

ifeq "$(AVRDUDECONF)" ""

209

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

210

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

211

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

212

204

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

213

endif

214

endif

215

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

205

225

206

# obtain board parameters from the arduino boards.txt file

226

207

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

234

215

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

235

216

BOARD_UPLOAD_PROTOCOL := \

236

217

$(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

218

251

219

# flags

252

220

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

253

221

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

254

222

CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)

255

223

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

256

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

257

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

258

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

259

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

260

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

261

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

262

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

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

263

228

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

264

229

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

265

230

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

266

231

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

267

232

268

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

269

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

270

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

271

272

# include dependencies

273

ifneq "$(MAKECMDGOALS)" "clean"

274

-include $(DEPFILES)

275

endif

276

277

233

# default rule

278

234

.DEFAULT_GOAL := all

279

235

280

236

#_______________________________________________________________________________

281

237

# RULES

282

238

283

.PHONY: all target upload clean boards monitor size

239

.PHONY: all target upload clean boards monitor

284

240

285

all: target

241

all: target upload

286

242

287

243

target: $(TARGET).hex

288

244

289

upload: target

245

upload:

290

246

@echo "\nUploading to board..."

291

247

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

292

248

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

293

249

exit 1; }

294

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

295

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

296

echo; }

297

stty $(STTYFARG) $(SERIALDEV) hupcl

250

stty -F $(SERIALDEV) hupcl

298

251

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

299

252

300

253

clean:

301

254

rm -f $(OBJECTS)

302

255

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

303

rm -rf .lib .dep

256

rm -rf $(ARDUINOLIBTMP)

304

257

305

258

boards:

306

259

@echo Available values for BOARD:

307

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

308

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

309

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

260

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

261

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

310

262

311

263

monitor:

312

264

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

315

267

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

316

268

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

317

269

ecit 1; }

318

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

319

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

320

echo; }

321

270

screen $(SERIALDEV)

322

271

323

size: $(TARGET).elf

324

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

325

326

272

# building the target

327

273

328

274

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

331

277

.INTERMEDIATE: $(TARGET).elf

332

278

333

279

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

334

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

335

336

%.o: %.c

337

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

338

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

339

340

%.o: %.cpp

341

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

342

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

343

344

%.o: %.cc

345

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

346

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

347

348

%.o: %.C

349

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

350

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

280

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

351

281

352

282

%.o: %.ino

353

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

354

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

283

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

355

284

356

285

%.o: %.pde

357

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

358

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

286

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

359

287

360

288

# building the arduino library

361

289

362

290

$(ARDUINOLIB): $(ARDUINOLIBOBJS)

363

291

$(AR) rcs $@ $?

364

365

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

366

mkdir -p $(dir $@)

367

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

368

369

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

370

mkdir -p $(dir $@)

371

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

372

373

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

374

mkdir -p $(dir $@)

375

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

376

377

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

378

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)

379

318

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