/make/arduino-mk : revision 32

1

#_______________________________________________________________________________

2

#

3

# edam's arduino makefile

3

# edam's Arduino makefile

4

#_______________________________________________________________________________

5

# version 0.1

5

# version 0.3

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

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

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

59

66

#

60

67

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

61

68

#

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.

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.

67

74

#

68

75

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

69

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

76

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

70

77

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

71

78

#

72

79

# SOURCES := main.cc other.cc

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

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

80

97

#

81

98

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

82

99

# board types.

83

100

#

84

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

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.

85

105

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

86

# connected arduino's serial device.

106

# connected Arduino's serial device.

107

#

108

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

109

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

110

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

87

111

#

88

112

# 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

113

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

90

114

# otherwise.

91

115

#

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

116

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

100

117

# when you run make:

101

118

#

104

121

#

105

122

# target Builds the target.

106

123

#

107

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

124

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

108

125

#

109

126

# clean Deletes files created during the build.

110

127

#

111

128

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

112

129

# BOARD environment variable appropriately.

113

130

#

114

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

115

# equivelant to the arduino serial monitor.

131

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

132

# equivalent to the Arduino serial monitor.

116

133

#

117

134

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

118

135

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

119

136

#_______________________________________________________________________________

120

137

#

121

138

122

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

139

# default arduino software directory, check software exists

123

140

ifndef ARDUINODIR

124

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

141

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

125

142

endif

126

127

# check arduino software

128

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

143

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

129

144

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

130

145

endif

131

146

147

# default arduino version

148

ARDUINOCONST ?= 100

149

150

# default path for avr tools

151

ifndef AVRTOOLSPATH

152

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

153

AVRTOOLSPATH += $(ARDUINODIR)/hardware/tools

154

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

155

endif

156

132

157

# auto mode?

133

158

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

134

159

ifdef INOFILE

135

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

160

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

136

161

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

137

162

endif

163

164

# automatically determine sources and targeet

138

165

TARGET := $(basename $(INOFILE))

139

166

SOURCES := $(INOFILE) \

140

167

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

141

168

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

142

169

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

170

143

171

# automatically determine included libraries

144

172

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

145

173

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

146

174

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

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

175

176

endif

177

178

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

179

SERIALDEVGUESS := 0

180

ifeq "$(SERIALDEV)" ""

181

SERIALDEV := $(firstword $(wildcard \

182

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

183

SERIALDEVGUESS := 1

184

endif

185

186

# software

187

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

188

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

189

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

190

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

191

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

192

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

193

AVRDUDE := $(call findsoftware,avrdude)

167

194

168

195

# files

196

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

169

197

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

170

198

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

171

199

ARDUINOLIBSDIR := $(ARDUINODIR)/libraries

177

205

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

178

206

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

179

207

$(wildcard $(addprefix $(ARDUINOLIBSDIR)/$(lib)/utility/, *.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

212

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

180

224

181

225

# obtain board parameters from the arduino boards.txt file

182

226

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

191

235

BOARD_UPLOAD_PROTOCOL := \

192

236

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

193

237

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)

238

# invalid board?

239

ifeq "$(BOARD_BUILD_MCU)" ""

240

ifneq "$(MAKECMDGOALS)" "boards"

241

ifneq "$(MAKECMDGOALS)" "clean"

242

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

243

endif

244

endif

245

endif

209

246

210

247

# flags

211

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

212

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

248

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

249

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

250

CPPFLAGS += -mmcu=$(BOARD_BUILD_MCU)

251

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

213

252

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

214

253

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

215

254

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

216

255

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

217

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

256

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

218

257

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

219

258

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

220

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

259

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

260

261

# figure out which arg to use with stty

262

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

221

263

222

264

# default rule

223

265

.DEFAULT_GOAL := all

236

278

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

237

279

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

238

280

exit 1; }

239

stty -F $(SERIALDEV) hupcl

281

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

282

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

283

echo; }

284

stty $(STTYFARG) $(SERIALDEV) hupcl

240

285

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

241

286

242

287

clean:

253

298

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

254

299

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

255

300

exit 1; }

301

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

302

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

303

ecit 1; }

304

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

305

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

306

echo; }

256

307

screen $(SERIALDEV)

257

308

258

309

# building the target