/make/arduino-mk : revision 15

1

#_______________________________________________________________________________

2

#

3

# edam's Arduino makefile

3

# edam's arduino makefile

4

#_______________________________________________________________________________

5

# version 0.3dev

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

# iverride it as necessary). For example:

63

56

#

64

57

# $ export BOARD=uno

65

58

# $ make

66

59

#

67

60

# You may also need to set SERIALDEV if it is not detected correctly.

68

61

#

69

# The presence of a .ino (or .pde) file causes the arduino.mk to automatically

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.

62

# The presence of a .ino or .pde file causes the arduino.mk to atuomatically

63

# determine va;ues for SOURCES, TARGET and LIBRARIES. Any .c, .cc and .cpp

64

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

65

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

66

# that have been #included.

74

67

#

75

68

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

76

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

69

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

77

70

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

78

71

#

79

72

# SOURCES := main.cc other.cc

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

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

78

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

79

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

97

80

#

98

81

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

99

82

# board types.

100

83

#

101

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

102

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

103

#

104

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

84

# SERIALDEV The unix device of the device where the arduino can be found.

105

85

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

106

# connected Arduino's serial device.

86

# connected arduino's serial device.

87

#

88

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

89

# .ino or .pde is found, but it is not neccesary to set it

90

# otherwise.

107

91

#

108

92

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

109

93

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

110

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

94

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

111

95

#

112

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

113

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

114

# otherwise.

96

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

97

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

115

98

#

116

99

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

117

100

# when you run make:

121

104

#

122

105

# target Builds the target.

123

106

#

124

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

107

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

125

108

#

126

109

# clean Deletes files created during the build.

127

110

#

128

111

# boards Display a list of available board names, so that you can set the

129

112

# BOARD environment variable appropriately.

130

113

#

131

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

114

# monitor Start `screen` on the serial device. It is ment to be an

115

# equivelant to the arduino serial monitor.

135

116

#

136

117

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

137

118

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

138

119

#_______________________________________________________________________________

139

120

#

140

121

141

# default arduino software directory, check software exists

122

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

142

123

ifndef ARDUINODIR

143

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

124

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

144

125

endif

145

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

126

127

# check arduino software

128

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

146

129

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

147

130

endif

148

131

149

# default arduino version

150

ARDUINOCONST ?= 100

151

152

# default path for avr tools

153

ifndef AVRTOOLSPATH

154

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

155

AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools

156

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

157

endif

158

159

132

# auto mode?

160

133

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

161

134

ifdef INOFILE

162

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

135

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

163

136

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

164

137

endif

165

166

# automatically determine sources and targeet

167

138

TARGET := $(basename $(INOFILE))

168

139

SOURCES := $(INOFILE) \

169

140

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

170

141

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

171

142

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

172

173

143

# automatically determine included libraries

174

144

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

175

145

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

176

146

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

177

178

endif

179

180

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

181

SERIALDEVGUESS := 0

182

ifeq "$(SERIALDEV)" ""

183

SERIALDEV := $(firstword $(wildcard \

184

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

185

SERIALDEVGUESS := 1

186

endif

187

188

# software

189

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

190

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

191

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

192

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

193

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

194

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

195

AVRDUDE := $(call findsoftware,avrdude)

196

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

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

160

ifndef BOARD

161

ifneq "$(MAKECMDGOALS)" "boards"

162

ifneq "$(MAKECMDGOALS)" "clean"

163

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

164

endif

165

endif

166

endif

197

167

198

168

# files

199

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

200

169

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

201

170

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

202

171

ARDUINOLIBSDIR := $(ARDUINODIR)/libraries

208

177

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

209

178

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

210

179

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

211

ifeq "$(AVRDUDECONF)" ""

212

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

213

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

214

else

215

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

216

endif

217

endif

218

219

# no board?

220

ifndef BOARD

221

ifneq "$(MAKECMDGOALS)" "boards"

222

ifneq "$(MAKECMDGOALS)" "clean"

223

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

224

endif

225

endif

226

endif

227

180

228

181

# obtain board parameters from the arduino boards.txt file

229

182

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

238

191

BOARD_UPLOAD_PROTOCOL := \

239

192

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

240

193

241

# invalid board?

242

ifeq "$(BOARD_BUILD_MCU)" ""

243

ifneq "$(MAKECMDGOALS)" "boards"

244

ifneq "$(MAKECMDGOALS)" "clean"

245

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

246

endif

247

endif

248

endif

194

# prefer software that comes with arduino

195

TOOLSDIRPREFIX = $(wildcard $(ARDUINODIR)/hardware/tools/)

196

TOOLSAVRDIRPREFIX = $(wildcard $(ARDUINODIR)/hardware/tools/avr/)

197

198

# software (prioritise binaries that came with arduino software)

199

FIND_SOFTWARE = $(firstword $(wildcard \

200

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

201

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

202

) $(1) )

203

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

204

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

205

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

206

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

207

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

208

AVRDUDE := $(call FIND_SOFTWARE,avrdude)

249

209

250

210

# flags

251

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

252

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

253

CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)

254

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

211

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

212

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

255

213

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

256

214

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

257

215

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

258

216

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

259

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

217

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

260

218

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

261

219

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

262

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

263

264

# figure out which arg to use with stty

265

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

220

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

266

221

267

222

# default rule

268

223

.DEFAULT_GOAL := all

270

225

#_______________________________________________________________________________

271

226

# RULES

272

227

273

.PHONY: all target upload clean boards monitor size

228

.PHONY: all target upload clean boards monitor

274

229

275

230

all: target upload

276

231

281

236

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

282

237

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

283

238

exit 1; }

284

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

285

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

286

echo; }

287

stty $(STTYFARG) $(SERIALDEV) hupcl

239

stty -F $(SERIALDEV) hupcl

288

240

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

289

241

290

242

clean:

301

253

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

302

254

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

303

255

exit 1; }

304

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

305

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

306

ecit 1; }

307

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

308

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

309

echo; }

310

256

screen $(SERIALDEV)

311

257

312

size: $(TARGET).elf

313

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

314

315

258

# building the target

316

259

317

260

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