From fa6b9215c83e4629b24beb0ca3704b1a3ee3eec1 Mon Sep 17 00:00:00 2001 From: Simon John Date: Mon, 13 Jan 2014 11:35:57 +0000 Subject: Move files out of `arduino-mk` subdirectory fix #152 --- Arduino.mk | 1231 ++++++++++++++++++++++++++++++++++++++++++++++++ Common.mk | 38 ++ arduino-mk/Arduino.mk | 1231 ------------------------------------------------ arduino-mk/Common.mk | 38 -- arduino-mk/chipKIT.mk | 113 ----- arduino-mk/licence.txt | 502 -------------------- chipKIT.mk | 113 +++++ licence.txt | 502 ++++++++++++++++++++ 8 files changed, 1884 insertions(+), 1884 deletions(-) create mode 100644 Arduino.mk create mode 100644 Common.mk delete mode 100644 arduino-mk/Arduino.mk delete mode 100644 arduino-mk/Common.mk delete mode 100644 arduino-mk/chipKIT.mk delete mode 100644 arduino-mk/licence.txt create mode 100644 chipKIT.mk create mode 100644 licence.txt diff --git a/Arduino.mk b/Arduino.mk new file mode 100644 index 0000000..3241cca --- /dev/null +++ b/Arduino.mk @@ -0,0 +1,1231 @@ +######################################################################## +# +# Makefile for compiling Arduino sketches from command line +# System part (i.e. project independent) +# +# Copyright (C) 2012 Sudar , based on +# - M J Oldfield work: https://github.com/mjoldfield/Arduino-Makefile +# +# Copyright (C) 2010,2011,2012 Martin Oldfield , based on +# work that is copyright Nicholas Zambetti, David A. Mellis & Hernando +# Barragan. +# +# This file is free software; you can redistribute it and/or modify it +# under the terms of the GNU Lesser General Public License as +# published by the Free Software Foundation; either version 2.1 of the +# License, or (at your option) any later version. +# +# Adapted from Arduino 0011 Makefile by M J Oldfield +# +# Original Arduino adaptation by mellis, eighthave, oli.keller +# +# Current version: 1.1.0 +# +# Refer to HISTORY.md file for complete history of changes +# +######################################################################## +# +# PATHS YOU NEED TO SET UP +# +# We need to worry about three different sorts of file: +# +# 1. Things which are included in this distribution e.g. ard-reset-arduino +# => ARDMK_DIR - Where the *.mk files are stored +# => ARDMK_PATH - Where the ard-reset-arduino script is stored +# +# 2. Things which are always in the Arduino distribution e.g. +# boards.txt, libraries, &c. +# => ARDUINO_DIR +# +# 3. Things which might be bundled with the Arduino distribution, but +# might come from the system. Most of the toolchain is like this: +# on Linux it's supplied by the system. +# => AVR_TOOLS_DIR +# +# Having set these three variables, we can work out the rest assuming +# that things are canonically arranged beneath the directories defined +# above. +# +# On the Mac you might want to set: +# +# ARDUINO_DIR = /Applications/Arduino.app/Contents/Resources/Java +# ARDMK_DIR = /usr/local +# +# On Linux, you might prefer: +# +# ARDUINO_DIR = /usr/share/arduino +# ARDMK_DIR = /usr +# AVR_TOOLS_DIR = /usr +# +# You can either set these up in the Makefile, or put them in your +# environment e.g. in your .bashrc +# +# If you don't specify these, we can try to guess, but that might not work +# or work the way you want it to. +# +# If you don't install the ard-reset-arduino binary to /usr/local/bin, but +# instead copy them to e.g. /home/mjo/arduino.mk/bin then set +# ARDMK_PATH = /home/mjo/arduino.mk/bin +# +# If you'd rather not see the configuration output, define ARDUINO_QUIET. +# +######################################################################## +# +# DEPENDENCIES +# +# The Perl programs need a couple of libraries: +# Device::SerialPort +# +######################################################################## +# +# STANDARD ARDUINO WORKFLOW +# +# Given a normal sketch directory, all you need to do is to create +# a small Makefile which defines a few things, and then includes this one. +# +# For example: +# +# ARDUINO_LIBS = Ethernet SPI +# BOARD_TAG = uno +# MONITOR_PORT = /dev/cu.usb* +# +# include /usr/share/arduino/Arduino.mk +# +# Hopefully these will be self-explanatory but in case they're not: +# +# ARDUINO_LIBS - A list of any libraries used by the sketch (we +# assume these are in $(ARDUINO_DIR)/hardware/libraries +# or your sketchbook's libraries directory) +# +# MONITOR_PORT - The port where the Arduino can be found (only needed +# when uploading) +# +# BOARD_TAG - The tag for the board e.g. uno or mega +# 'make show_boards' shows a list +# +# If you have your additional libraries relative to your source, rather +# than in your "sketchbook", also set USER_LIB_PATH, like this example: +# +# USER_LIB_PATH := $(realpath ../../libraries) +# +# If you've added the Arduino-Makefile repository to your git repo as a +# submodule (or other similar arrangement), you might have lines like this +# in your Makefile: +# +# ARDMK_DIR := $(realpath ../../tools/Arduino-Makefile) +# include $(ARDMK_DIR)/arduino-mk/Arduino.mk +# +# In any case, once this file has been created the typical workflow is just +# +# $ make upload +# +# All of the object files are created in the build-{BOARD_TAG} subdirectory +# All sources should be in the current directory and can include: +# - at most one .pde or .ino file which will be treated as C++ after +# the standard Arduino header and footer have been affixed. +# - any number of .c, .cpp, .s and .h files +# +# Included libraries are built in the build-{BOARD_TAG}/libs subdirectory. +# +# Besides make upload, there are a couple of other targets that are available. +# Do make help to get the complete list of targets and their description +# +######################################################################## +# +# SERIAL MONITOR +# +# The serial monitor just invokes the GNU screen program with suitable +# options. For more information see screen (1) and search for +# 'character special device'. +# +# The really useful thing to know is that ^A-k gets you out! +# +# The fairly useful thing to know is that you can bind another key to +# escape too, by creating $HOME{.screenrc} containing e.g. +# +# bindkey ^C kill +# +# If you want to change the baudrate, just set MONITOR_BAUDRATE. If you +# don't set it, it tries to read from the sketch. If it couldn't read +# from the sketch, then it defaults to 9600 baud. +# +######################################################################## +# +# ARDUINO WITH ISP +# +# You need to specify some details of your ISP programmer and might +# also need to specify the fuse values: +# +# ISP_PROG = stk500v2 +# ISP_PORT = /dev/ttyACM0 +# +# You might also need to set the fuse bits, but typically they'll be +# read from boards.txt, based on the BOARD_TAG variable: +# +# ISP_LOCK_FUSE_PRE = 0x3f +# ISP_LOCK_FUSE_POST = 0xcf +# ISP_HIGH_FUSE = 0xdf +# ISP_LOW_FUSE = 0xff +# ISP_EXT_FUSE = 0x01 +# +# You can specify to also upload the EEPROM file: +# ISP_EEPROM = 1 +# +# I think the fuses here are fine for uploading to the ATmega168 +# without bootloader. +# +# To actually do this upload use the ispload target: +# +# make ispload +# +# +######################################################################## +# +# ALTERNATIVE CORES +# +# To use alternative cores for platforms such as ATtiny, you need to +# specify a few more variables, depending on the core in use. +# +# The HLT (attiny-master) core can be used just by specifying +# ALTERNATE_CORE, assuming your core is in your ~/sketchbook/hardware +# directory. For example: +# +# ISP_PORT = /dev/ttyACM0 +# BOARD_TAG = attiny85 +# ALTERNATE_CORE = attiny-master +# +# To use the more complex arduino-tiny and TinyCore2 cores, you must +# also set ARDUINO_CORE_PATH and ARDUINO_VAR_PATH to the core +# directory, as these cores essentially replace the main Arduino core. +# For example: +# +# ISP_PORT = /dev/ttyACM0 +# BOARD_TAG = attiny85at8 +# ALTERNATE_CORE = arduino-tiny +# ARDUINO_VAR_PATH = ~/sketchbook/hardware/arduino-tiny/cores/tiny +# ARDUINO_CORE_PATH = ~/sketchbook/hardware/arduino-tiny/cores/tiny +# +# or.... +# +# ISP_PORT = /dev/ttyACM0 +# BOARD_TAG = attiny861at8 +# ALTERNATE_CORE = tiny2 +# ARDUINO_VAR_PATH = ~/sketchbook/hardware/tiny2/cores/tiny +# ARDUINO_CORE_PATH = ~/sketchbook/hardware/tiny2/cores/tiny +# +######################################################################## + +arduino_output = +# When output is not suppressed and we're in the top-level makefile, +# running for the first time (i.e., not after a restart after +# regenerating the dependency file), then output the configuration. +ifndef ARDUINO_QUIET + ifeq ($(MAKE_RESTARTS),) + ifeq ($(MAKELEVEL),0) + arduino_output = $(info $(1)) + endif + endif +endif + +######################################################################## +# Makefile distribution path + +ifndef ARDMK_DIR + # presume it's a level above the path to our own file + ARDMK_DIR := $(realpath $(dir $(realpath $(lastword $(MAKEFILE_LIST))))/..) +else + # show_config_variable macro is defined in Common.mk file and is not available yet. + # Let's define a variable to know that user specified ARDMK_DIR + ARDMK_DIR_MSG = USER +endif + +ifneq ($(wildcard $(ARDMK_DIR)/arduino-mk/Common.mk),) + # git checkout + ARDMK_FILE = $(ARDMK_DIR)/arduino-mk/arduino.mk + include $(ARDMK_DIR)/arduino-mk/Common.mk +else + ifneq ($(wildcard $(ARDMK_DIR)/Common.mk),) + # package install + ARDMK_FILE = $(ARDMK_DIR)/arduino.mk + include $(ARDMK_DIR)/Common.mk + endif +endif + +# show_config_variable macro is available now. So let's print config details for ARDMK_DIR +ifndef ARDMK_DIR_MSG + $(call show_config_variable,ARDMK_DIR,[COMPUTED],(relative to $(notdir $(lastword $(MAKEFILE_LIST))))) +else + $(call show_config_variable,ARDMK_DIR,[USER]) +endif + +ifndef ARDMK_PATH + ARDMK_PATH = $(ARDMK_DIR)/bin + $(call show_config_variable,ARDMK_PATH,[COMPUTED],(relative to ARDMK_DIR)) +else + $(call show_config_variable,ARDMK_PATH,[USER]) +endif + +######################################################################## +# Arduino Directory + +ifndef ARDUINO_DIR + AUTO_ARDUINO_DIR := $(firstword \ + $(call dir_if_exists,/usr/share/arduino) \ + $(call dir_if_exists,/Applications/Arduino.app/Contents/Resources/Java) ) + ifdef AUTO_ARDUINO_DIR + ARDUINO_DIR = $(AUTO_ARDUINO_DIR) + $(call show_config_variable,ARDUINO_DIR,[AUTODETECTED]) + else + echo $(error "ARDUINO_DIR is not defined") + endif +else + $(call show_config_variable,ARDUINO_DIR,[USER]) +endif + +######################################################################## +# Default TARGET to pwd (ex Daniele Vergini) + +ifndef TARGET + TARGET = $(notdir $(CURDIR)) +endif + +######################################################################## +# Arduino version number + +ifndef ARDUINO_VERSION + # Remove all the decimals, and right-pad with zeros, and finally grab the first 3 bytes. + # Works for 1.0 and 1.0.1 + VERSION_FILE := $(ARDUINO_DIR)/lib/version.txt + AUTO_ARDUINO_VERSION := $(shell [ -e $(VERSION_FILE) ] && cat $(VERSION_FILE) | sed -e 's/^[0-9]://g' -e 's/[.]//g' -e 's/$$/0000/' | head -c3) + ifdef AUTO_ARDUINO_VERSION + ARDUINO_VERSION = $(AUTO_ARDUINO_VERSION) + $(call show_config_variable,ARDUINO_VERSION,[AUTODETECTED]) + else + ARDUINO_VERSION = 100 + $(call show_config_variable,ARDUINO_VERSION,[DEFAULT]) + endif +else + $(call show_config_variable,ARDUINO_VERSION,[USER]) +endif + +######################################################################## +# Arduino Sketchbook folder + +ifndef ARDUINO_SKETCHBOOK + ifndef ARDUINO_PREFERENCES_PATH + + AUTO_ARDUINO_PREFERENCES := $(firstword \ + $(call dir_if_exists,$(HOME)/.arduino/preferences.txt) \ + $(call dir_if_exists,$(HOME)/Library/Arduino/preferences.txt) ) + ifdef AUTO_ARDUINO_PREFERENCES + ARDUINO_PREFERENCES_PATH = $(AUTO_ARDUINO_PREFERENCES) + $(call show_config_variable,ARDUINO_PREFERENCES_PATH,[AUTODETECTED]) + endif + + else + $(call show_config_variable,ARDUINO_PREFERENCES_PATH,[USER]) + endif + + ifneq ($(ARDUINO_PREFERENCES_PATH),) + ARDUINO_SKETCHBOOK = $(shell grep --max-count=1 --regexp="sketchbook.path=" \ + $(ARDUINO_PREFERENCES_PATH) | \ + sed -e 's/sketchbook.path=//' ) + endif + + ifneq ($(ARDUINO_SKETCHBOOK),) + $(call show_config_variable,ARDUINO_SKETCHBOOK,[AUTODETECTED],(from arduino preferences file)) + else + ARDUINO_SKETCHBOOK = $(HOME)/sketchbook + $(call show_config_variable,ARDUINO_SKETCHBOOK,[DEFAULT]) + endif +else + $(call show_config_variable,ARDUINO_SKETCHBOOK,[USER]) +endif + +######################################################################## +# Arduino and system paths + +ifndef CC_NAME +CC_NAME = avr-gcc +endif + +ifndef CXX_NAME +CXX_NAME = avr-g++ +endif + +ifndef OBJCOPY_NAME +OBJCOPY_NAME = avr-objcopy +endif + +ifndef OBJDUMP_NAME +OBJDUMP_NAME = avr-objdump +endif + +ifndef AR_NAME +AR_NAME = avr-ar +endif + +ifndef SIZE_NAME +SIZE_NAME = avr-size +endif + +ifndef NM_NAME +NM_NAME = avr-nm +endif + +ifndef AVR_TOOLS_DIR + + BUNDLED_AVR_TOOLS_DIR := $(call dir_if_exists,$(ARDUINO_DIR)/hardware/tools/avr) + ifdef BUNDLED_AVR_TOOLS_DIR + AVR_TOOLS_DIR = $(BUNDLED_AVR_TOOLS_DIR) + $(call show_config_variable,AVR_TOOLS_DIR,[BUNDLED],(in Arduino distribution)) + + # In Linux distribution of Arduino, the path to avrdude and avrdude.conf are different + # More details at https://github.com/sudar/Arduino-Makefile/issues/48 and + # https://groups.google.com/a/arduino.cc/d/msg/developers/D_m97jGr8Xs/uQTt28KO_8oJ + ifeq ($(CURRENT_OS),LINUX) + + ifndef AVRDUDE + AVRDUDE = $(AVR_TOOLS_DIR)/../avrdude + endif + + ifndef AVRDUDE_CONF + AVRDUDE_CONF = $(AVR_TOOLS_DIR)/../avrdude.conf + endif + + else + + ifndef AVRDUDE_CONF + AVRDUDE_CONF = $(AVR_TOOLS_DIR)/etc/avrdude.conf + endif + + endif + + else + + SYSTEMPATH_AVR_TOOLS_DIR := $(call dir_if_exists,$(abspath $(dir $(shell which $(CC_NAME)))/..)) + ifdef SYSTEMPATH_AVR_TOOLS_DIR + AVR_TOOLS_DIR = $(SYSTEMPATH_AVR_TOOLS_DIR) + $(call show_config_variable,AVR_TOOLS_DIR,[AUTODETECTED],(found in $$PATH)) + else + echo $(error No AVR tools directory found) + endif # SYSTEMPATH_AVR_TOOLS_DIR + + endif # BUNDLED_AVR_TOOLS_DIR + +else + $(call show_config_variable,AVR_TOOLS_DIR,[USER]) +endif #ndef AVR_TOOLS_DIR + +ifndef AVR_TOOLS_PATH + AVR_TOOLS_PATH = $(AVR_TOOLS_DIR)/bin +endif + +ARDUINO_LIB_PATH = $(ARDUINO_DIR)/libraries +$(call show_config_variable,ARDUINO_LIB_PATH,[COMPUTED],(from ARDUINO_DIR)) +ifndef ARDUINO_CORE_PATH + ARDUINO_CORE_PATH = $(ARDUINO_DIR)/hardware/arduino/cores/arduino + $(call show_config_variable,ARDUINO_CORE_PATH,[DEFAULT]) +else + $(call show_config_variable,ARDUINO_CORE_PATH,[USER]) +endif + +# Third party hardware and core like ATtiny or ATmega 16 +ifdef ALTERNATE_CORE + $(call show_config_variable,ALTERNATE_CORE,[USER]) + + ifndef ALTERNATE_CORE_PATH + ALTERNATE_CORE_PATH = $(ARDUINO_SKETCHBOOK)/hardware/$(ALTERNATE_CORE) + endif +endif + +ifdef ALTERNATE_CORE_PATH + + ifdef ALTERNATE_CORE + $(call show_config_variable,ALTERNATE_CORE_PATH,[COMPUTED], (from ARDUINO_SKETCHBOOK and ALTERNATE_CORE)) + else + $(call show_config_variable,ALTERNATE_CORE_PATH,[USER]) + endif + + ifndef ARDUINO_VAR_PATH + ARDUINO_VAR_PATH = $(ALTERNATE_CORE_PATH)/variants + $(call show_config_variable,ARDUINO_VAR_PATH,[COMPUTED],(from ALTERNATE_CORE_PATH)) + endif + + ifndef BOARDS_TXT + BOARDS_TXT = $(ALTERNATE_CORE_PATH)/boards.txt + $(call show_config_variable,BOARDS_TXT,[COMPUTED],(from ALTERNATE_CORE_PATH)) + endif + +else + + ifndef ARDUINO_VAR_PATH + ARDUINO_VAR_PATH = $(ARDUINO_DIR)/hardware/arduino/variants + $(call show_config_variable,ARDUINO_VAR_PATH,[COMPUTED],(from ARDUINO_DIR)) + else + $(call show_config_variable,ARDUINO_VAR_PATH,[USER]) + endif + + ifndef BOARDS_TXT + BOARDS_TXT = $(ARDUINO_DIR)/hardware/arduino/boards.txt + $(call show_config_variable,BOARDS_TXT,[COMPUTED],(from ARDUINO_DIR)) + else + $(call show_config_variable,BOARDS_TXT,[USER]) + endif + +endif + +######################################################################## +# Miscellaneous + +ifndef USER_LIB_PATH + USER_LIB_PATH = $(ARDUINO_SKETCHBOOK)/libraries + $(call show_config_variable,USER_LIB_PATH,[DEFAULT],(in user sketchbook)) +else + $(call show_config_variable,USER_LIB_PATH,[USER]) +endif + +######################################################################## +# boards.txt parsing + +ifndef BOARD_TAG + BOARD_TAG = uno + $(call show_config_variable,BOARD_TAG,[DEFAULT]) +else + # Strip the board tag of any extra whitespace, since it was causing the makefile to fail + # https://github.com/sudar/Arduino-Makefile/issues/57 + BOARD_TAG := $(strip $(BOARD_TAG)) + $(call show_config_variable,BOARD_TAG,[USER]) +endif + +ifndef PARSE_BOARD + # result = $(call READ_BOARD_TXT, 'boardname', 'parameter') + PARSE_BOARD = $(shell grep -v "^\#" $(BOARDS_TXT) | grep $(1).$(2) | cut -d = -f 2 ) +endif + +# If NO_CORE is set, then we don't have to parse boards.txt file +# But the user might have to define MCU, F_CPU etc +ifeq ($(strip $(NO_CORE)),) + + # Which variant ? This affects the include path + ifndef VARIANT + VARIANT = $(call PARSE_BOARD,$(BOARD_TAG),build.variant) + endif + + # see if we are a caterina device like leonardo or micro + CATERINA = $(findstring caterina,$(call PARSE_BOARD,$(BOARD_TAG),bootloader.path)) + + # processor stuff + ifndef MCU + MCU = $(call PARSE_BOARD,$(BOARD_TAG),build.mcu) + endif + + ifndef F_CPU + F_CPU = $(call PARSE_BOARD,$(BOARD_TAG),build.f_cpu) + endif + + ifneq ($(CATERINA),) + # USB IDs for the caterina devices like leonardo or micro + ifndef USB_VID + USB_VID = $(call PARSE_BOARD,$(BOARD_TAG),build.vid) + endif + + ifndef USB_PID + USB_PID = $(call PARSE_BOARD,$(BOARD_TAG),build.pid) + endif + endif + + # normal programming info + ifndef AVRDUDE_ARD_PROGRAMMER + AVRDUDE_ARD_PROGRAMMER = $(call PARSE_BOARD,$(BOARD_TAG),upload.protocol) + endif + + ifndef AVRDUDE_ARD_BAUDRATE + AVRDUDE_ARD_BAUDRATE = $(call PARSE_BOARD,$(BOARD_TAG),upload.speed) + endif + + # fuses if you're using e.g. ISP + ifndef ISP_LOCK_FUSE_PRE + ISP_LOCK_FUSE_PRE = $(call PARSE_BOARD,$(BOARD_TAG),bootloader.unlock_bits) + endif + + ifndef ISP_HIGH_FUSE + ISP_HIGH_FUSE = $(call PARSE_BOARD,$(BOARD_TAG),bootloader.high_fuses) + endif + + ifndef ISP_LOW_FUSE + ISP_LOW_FUSE = $(call PARSE_BOARD,$(BOARD_TAG),bootloader.low_fuses) + endif + + ifndef ISP_EXT_FUSE + ISP_EXT_FUSE = $(call PARSE_BOARD,$(BOARD_TAG),bootloader.extended_fuses) + endif + + ifndef BOOTLOADER_PATH + BOOTLOADER_PATH = $(call PARSE_BOARD,$(BOARD_TAG),bootloader.path) + endif + + ifndef BOOTLOADER_FILE + BOOTLOADER_FILE = $(call PARSE_BOARD,$(BOARD_TAG),bootloader.file) + endif + + ifndef ISP_LOCK_FUSE_POST + ISP_LOCK_FUSE_POST = $(call PARSE_BOARD,$(BOARD_TAG),bootloader.lock_bits) + endif + + ifndef HEX_MAXIMUM_SIZE + HEX_MAXIMUM_SIZE = $(call PARSE_BOARD,$(BOARD_TAG),upload.maximum_size) + endif + +endif + +# Everything gets built in here (include BOARD_TAG now) +ifndef OBJDIR + OBJDIR = build-$(BOARD_TAG) + $(call show_config_variable,OBJDIR,[COMPUTED],(from BOARD_TAG)) +else + $(call show_config_variable,OBJDIR,[USER]) +endif + +######################################################################## +# Reset + +ifndef RESET_CMD + ifneq ($(CATERINA),) + RESET_CMD = $(ARDMK_PATH)/ard-reset-arduino --caterina \ + $(ARD_RESET_OPTS) $(call get_monitor_port) + else + RESET_CMD = $(ARDMK_PATH)/ard-reset-arduino \ + $(ARD_RESET_OPTS) $(call get_monitor_port) + endif +endif + +ifneq ($(CATERINA),) + ERROR_ON_CATERINA = $(error On $(BOARD_TAG), raw_xxx operation is not supported) +else + ERROR_ON_CATERINA = +endif + +######################################################################## +# Local sources + +LOCAL_C_SRCS ?= $(wildcard *.c) +LOCAL_CPP_SRCS ?= $(wildcard *.cpp) +LOCAL_CC_SRCS ?= $(wildcard *.cc) +LOCAL_PDE_SRCS ?= $(wildcard *.pde) +LOCAL_INO_SRCS ?= $(wildcard *.ino) +LOCAL_AS_SRCS ?= $(wildcard *.S) +LOCAL_SRCS = $(LOCAL_C_SRCS) $(LOCAL_CPP_SRCS) \ + $(LOCAL_CC_SRCS) $(LOCAL_PDE_SRCS) \ + $(LOCAL_INO_SRCS) $(LOCAL_AS_SRCS) +LOCAL_OBJ_FILES = $(LOCAL_C_SRCS:.c=.o) $(LOCAL_CPP_SRCS:.cpp=.o) \ + $(LOCAL_CC_SRCS:.cc=.o) $(LOCAL_PDE_SRCS:.pde=.o) \ + $(LOCAL_INO_SRCS:.ino=.o) $(LOCAL_AS_SRCS:.S=.o) +LOCAL_OBJS = $(patsubst %,$(OBJDIR)/%,$(LOCAL_OBJ_FILES)) + +ifeq ($(words $(LOCAL_SRCS)), 0) + $(error Atleast one source file (*.ino, *.pde, *.cpp, *c, *cc, *.S) is needed) +endif + +ifeq ($(strip $(NO_CORE)),) + + # Ideally, this should just check if there are more than one file + ifneq ($(words $(LOCAL_PDE_SRCS) $(LOCAL_INO_SRCS)), 1) + ifeq ($(words $(LOCAL_PDE_SRCS) $(LOCAL_INO_SRCS)), 0) + $(call show_config_info,No .pde or .ino files found. If you are compiling .c or .cpp files then you need to explicitly include Arduino header files) + else + #TODO: Support more than one file. https://github.com/sudar/Arduino-Makefile/issues/49 + $(error Need exactly one .pde or .ino file. This makefile doesn't support multiple .ino/.pde files yet) + endif + endif + +endif + +# core sources +ifeq ($(strip $(NO_CORE)),) + ifdef ARDUINO_CORE_PATH + CORE_C_SRCS = $(wildcard $(ARDUINO_CORE_PATH)/*.c) + CORE_CPP_SRCS = $(wildcard $(ARDUINO_CORE_PATH)/*.cpp) + + ifneq ($(strip $(NO_CORE_MAIN_CPP)),) + CORE_CPP_SRCS := $(filter-out %main.cpp, $(CORE_CPP_SRCS)) + $(call show_config_info,NO_CORE_MAIN_CPP set so core library will not include main.cpp,[MANUAL]) + endif + + CORE_OBJ_FILES = $(CORE_C_SRCS:.c=.o) $(CORE_CPP_SRCS:.cpp=.o) $(CORE_AS_SRCS:.S=.o) + CORE_OBJS = $(patsubst $(ARDUINO_CORE_PATH)/%, \ + $(OBJDIR)/%,$(CORE_OBJ_FILES)) + endif +else + $(call show_config_info,NO_CORE set so core library will not be built,[MANUAL]) +endif + +######################################################################## +# Determine ARDUINO_LIBS automatically + +ifndef ARDUINO_LIBS + # automatically determine included libraries + ARDUINO_LIBS += $(filter $(notdir $(wildcard $(ARDUINO_DIR)/libraries/*)), \ + $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(LOCAL_SRCS))) + ARDUINO_LIBS += $(filter $(notdir $(wildcard $(ARDUINO_SKETCHBOOK)/libraries/*)), \ + $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(LOCAL_SRCS))) + ARDUINO_LIBS += $(filter $(notdir $(wildcard $(USER_LIB_PATH)/*)), \ + $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(LOCAL_SRCS))) +endif + +######################################################################## +# Serial monitor (just a screen wrapper) + +# Quite how to construct the monitor command seems intimately tied +# to the command we're using (here screen). So, read the screen docs +# for more information (search for 'character special device'). + +ifeq ($(strip $(NO_CORE)),) + ifndef MONITOR_BAUDRATE + ifeq ($(words $(LOCAL_PDE_SRCS) $(LOCAL_INO_SRCS)), 1) + SPEED = $(shell egrep -h 'Serial.begin\([0-9]+\)' $(LOCAL_PDE_SRCS) $(LOCAL_INO_SRCS) | sed -e 's/[^0-9]//g'| head -n1) + MONITOR_BAUDRATE = $(findstring $(SPEED),300 1200 2400 4800 9600 14400 19200 28800 38400 57600 115200) + endif + + ifeq ($(MONITOR_BAUDRATE),) + MONITOR_BAUDRATE = 9600 + $(call show_config_variable,MONITOR_BAUDRATE,[ASSUMED]) + else + $(call show_config_variable,MONITOR_BAUDRATE,[DETECTED], (in sketch)) + endif + else + $(call show_config_variable,MONITOR_BAUDRATE, [USER]) + endif + + ifndef MONITOR_CMD + MONITOR_CMD = screen + endif +endif + +######################################################################## +# Include Arduino Header file + +ifndef ARDUINO_HEADER + # We should check for Arduino version, not just the file extension + # because, a .pde file can be used in Arduino 1.0 as well + ifeq ($(shell expr $(ARDUINO_VERSION) '<' 100), 1) + ARDUINO_HEADER=WProgram.h + else + ARDUINO_HEADER=Arduino.h + endif +endif + +######################################################################## +# Rules for making stuff + +# The name of the main targets +TARGET_HEX = $(OBJDIR)/$(TARGET).hex +TARGET_ELF = $(OBJDIR)/$(TARGET).elf +TARGET_EEP = $(OBJDIR)/$(TARGET).eep +TARGETS = $(OBJDIR)/$(TARGET).* +CORE_LIB = $(OBJDIR)/libcore.a + +# Names of executables +CC = $(AVR_TOOLS_PATH)/$(CC_NAME) +CXX = $(AVR_TOOLS_PATH)/$(CXX_NAME) +AS = $(AVR_TOOLS_PATH)/$(AS_NAME) +OBJCOPY = $(AVR_TOOLS_PATH)/$(OBJCOPY_NAME) +OBJDUMP = $(AVR_TOOLS_PATH)/$(OBJDUMP_NAME) +AR = $(AVR_TOOLS_PATH)/$(AR_NAME) +SIZE = $(AVR_TOOLS_PATH)/$(SIZE_NAME) +NM = $(AVR_TOOLS_PATH)/$(NM_NAME) +REMOVE = rm -rf +MV = mv -f +CAT = cat +ECHO = printf +MKDIR = mkdir -p + +# General arguments +USER_LIBS = $(wildcard $(patsubst %,$(USER_LIB_PATH)/%,$(ARDUINO_LIBS))) +USER_LIB_NAMES = $(patsubst $(USER_LIB_PATH)/%,%,$(USER_LIBS)) + +# Let user libraries override system ones. +SYS_LIBS = $(wildcard $(patsubst %,$(ARDUINO_LIB_PATH)/%,$(filter-out $(USER_LIB_NAMES),$(ARDUINO_LIBS)))) +SYS_LIB_NAMES = $(patsubst $(ARDUINO_LIB_PATH)/%,%,$(SYS_LIBS)) + +# Error here if any are missing. +LIBS_NOT_FOUND = $(filter-out $(USER_LIB_NAMES) $(SYS_LIB_NAMES),$(ARDUINO_LIBS)) +ifneq (,$(strip $(LIBS_NOT_FOUND))) + $(error The following libraries specified in ARDUINO_LIBS could not be found (searched USER_LIB_PATH and ARDUINO_LIB_PATH): $(LIBS_NOT_FOUND)) +endif + +SYS_LIBS := $(wildcard $(SYS_LIBS) $(addsuffix /utility,$(SYS_LIBS))) +USER_LIBS := $(wildcard $(USER_LIBS) $(addsuffix /utility,$(USER_LIBS))) +SYS_INCLUDES = $(patsubst %,-I%,$(SYS_LIBS)) +USER_INCLUDES = $(patsubst %,-I%,$(USER_LIBS)) +LIB_C_SRCS = $(wildcard $(patsubst %,%/*.c,$(SYS_LIBS))) +LIB_CPP_SRCS = $(wildcard $(patsubst %,%/*.cpp,$(SYS_LIBS))) +USER_LIB_CPP_SRCS = $(wildcard $(patsubst %,%/*.cpp,$(USER_LIBS))) +USER_LIB_C_SRCS = $(wildcard $(patsubst %,%/*.c,$(USER_LIBS))) +LIB_OBJS = $(patsubst $(ARDUINO_LIB_PATH)/%.c,$(OBJDIR)/libs/%.o,$(LIB_C_SRCS)) \ + $(patsubst $(ARDUINO_LIB_PATH)/%.cpp,$(OBJDIR)/libs/%.o,$(LIB_CPP_SRCS)) +USER_LIB_OBJS = $(patsubst $(USER_LIB_PATH)/%.cpp,$(OBJDIR)/libs/%.o,$(USER_LIB_CPP_SRCS)) \ + $(patsubst $(USER_LIB_PATH)/%.c,$(OBJDIR)/libs/%.o,$(USER_LIB_C_SRCS)) + +# Dependency files +DEPS = $(LOCAL_OBJS:.o=.d) $(LIB_OBJS:.o=.d) $(USER_LIB_OBJS:.o=.d) $(CORE_OBJS:.o=.d) + +# Optimization level for the compiler. +# You can get the list of options at http://www.nongnu.org/avr-libc/user-manual/using_tools.html#gcc_optO +# Also read http://www.nongnu.org/avr-libc/user-manual/FAQ.html#faq_optflags +ifndef OPTIMIZATION_LEVEL + OPTIMIZATION_LEVEL=s + $(call show_config_variable,OPTIMIZATION_LEVEL,[DEFAULT]) +else + $(call show_config_variable,OPTIMIZATION_LEVEL,[USER]) +endif + +ifndef DEBUG_FLAGS + DEBUG_FLAGS = -O0 -g +endif + +# SoftwareSerial requires -Os (some delays are tuned for this optimization level) +%SoftwareSerial.o : OPTIMIZATION_FLAGS = -Os + +ifndef MCU_FLAG_NAME + MCU_FLAG_NAME = mmcu + $(call show_config_variable,MCU_FLAG_NAME,[DEFAULT]) +else + $(call show_config_variable,MCU_FLAG_NAME,[USER]) +endif + +# Using += instead of =, so that CPPFLAGS can be set per sketch level +CPPFLAGS += -$(MCU_FLAG_NAME)=$(MCU) -DF_CPU=$(F_CPU) -DARDUINO=$(ARDUINO_VERSION) \ + -I. -I$(ARDUINO_CORE_PATH) -I$(ARDUINO_VAR_PATH)/$(VARIANT) \ + $(SYS_INCLUDES) $(USER_INCLUDES) -Wall -ffunction-sections \ + -fdata-sections + +ifdef DEBUG +OPTIMIZATION_FLAGS= $(DEBUG_FLAGS) +else +OPTIMIZATION_FLAGS = -O$(OPTIMIZATION_LEVEL) +endif + +CPPFLAGS += $(OPTIMIZATION_FLAGS) + +# USB IDs for the Caterina devices like leonardo or micro +ifneq ($(CATERINA),) + CPPFLAGS += -DUSB_VID=$(USB_VID) -DUSB_PID=$(USB_PID) +endif + +ifndef CFLAGS_STD + CFLAGS_STD = -std=gnu99 + $(call show_config_variable,CFLAGS_STD,[DEFAULT]) +else + $(call show_config_variable,CFLAGS_STD,[USER]) +endif + +CFLAGS += $(EXTRA_FLAGS) $(EXTRA_CFLAGS) +CXXFLAGS += -fno-exceptions $(EXTRA_FLAGS) $(EXTRA_CXXFLAGS) +ASFLAGS += -x assembler-with-cpp +LDFLAGS += -$(MCU_FLAG_NAME)=$(MCU) -Wl,--gc-sections -O$(OPTIMIZATION_LEVEL) $(EXTRA_FLAGS) $(EXTRA_CXXFLAGS) $(EXTRA_LDFLAGS) +SIZEFLAGS ?= --mcu=$(MCU) -C + +# for backwards compatibility, grab ARDUINO_PORT if the user has it set +MONITOR_PORT ?= $(ARDUINO_PORT) + +# Returns the Arduino port (first wildcard expansion) if it exists, otherwise it errors. +get_monitor_port = $(if $(wildcard $(MONITOR_PORT)),$(firstword $(wildcard $(MONITOR_PORT))),$(error Arduino port $(MONITOR_PORT) not found!)) + +# Returns the ISP port (first wildcard expansion) if it exists, otherwise it errors. +get_isp_port = $(if $(wildcard $(ISP_PORT)),$(firstword $(wildcard $(ISP_PORT))),$(error ISP port $(ISP_PORT) not found!)) + +# Command for avr_size: do $(call avr_size,elffile,hexfile) +ifneq (,$(findstring AVR,$(shell $(SIZE) --help))) + # We have a patched version of binutils that mentions AVR - pass the MCU + # and the elf to get nice output. + avr_size = $(SIZE) $(SIZEFLAGS) --format=avr $(1) + $(call show_config_info,Size utility: AVR-aware for enhanced output,[AUTODETECTED]) +else + # We have a plain-old binutils version - just give it the hex. + avr_size = $(SIZE) $(2) + $(call show_config_info,Size utility: Basic (not AVR-aware),[AUTODETECTED]) +endif + +ifneq (,$(strip $(ARDUINO_LIBS))) + $(call arduino_output,-) + $(call show_config_info,ARDUINO_LIBS =) +endif + +ifneq (,$(strip $(USER_LIB_NAMES))) + $(foreach lib,$(USER_LIB_NAMES),$(call show_config_info, $(lib),[USER])) +endif + +ifneq (,$(strip $(SYS_LIB_NAMES))) + $(foreach lib,$(SYS_LIB_NAMES),$(call show_config_info, $(lib),[SYSTEM])) +endif + +# either calculate parent dir from arduino dir, or user-defined path +ifndef BOOTLOADER_PARENT + BOOTLOADER_PARENT = $(ARDUINO_DIR)/hardware/arduino/bootloaders + $(call show_config_variable,BOOTLOADER_PARENT,[COMPUTED],(from ARDUINO_DIR)) +else + $(call show_config_variable,BOOTLOADER_PARENT,[USER]) +endif + +# end of config output +$(call show_separator) + +# Implicit rules for building everything (needed to get everything in +# the right directory) +# +# Rather than mess around with VPATH there are quasi-duplicate rules +# here for building e.g. a system C++ file and a local C++ +# file. Besides making things simpler now, this would also make it +# easy to change the build options in future + +# library sources +$(OBJDIR)/libs/%.o: $(ARDUINO_LIB_PATH)/%.c + @$(MKDIR) $(dir $@) + $(CC) -MMD -c $(CPPFLAGS) $(CFLAGS) $< -o $@ + +$(OBJDIR)/libs/%.o: $(ARDUINO_LIB_PATH)/%.cpp + @$(MKDIR) $(dir $@) + $(CC) -MMD -c $(CPPFLAGS) $(CXXFLAGS) $< -o $@ + +$(OBJDIR)/libs/%.o: $(USER_LIB_PATH)/%.cpp + @$(MKDIR) $(dir $@) + $(CC) -MMD -c $(CPPFLAGS) $(CFLAGS) $< -o $@ + +$(OBJDIR)/libs/%.o: $(USER_LIB_PATH)/%.c + @$(MKDIR) $(dir $@) + $(CC) -MMD -c $(CPPFLAGS) $(CFLAGS) $< -o $@ + +ifdef COMMON_DEPS + COMMON_DEPS := $(COMMON_DEPS) $(MAKEFILE_LIST) +else + COMMON_DEPS := $(MAKEFILE_LIST) +endif + +# normal local sources +$(OBJDIR)/%.o: %.c $(COMMON_DEPS) | $(OBJDIR) + @$(MKDIR) $(dir $@) + $(CC) -MMD -c $(CPPFLAGS) $(CFLAGS) $< -o $@ + +$(OBJDIR)/%.o: %.cc $(COMMON_DEPS) | $(OBJDIR) + @$(MKDIR) $(dir $@) + $(CXX) -MMD -c $(CPPFLAGS) $(CXXFLAGS) $< -o $@ + +$(OBJDIR)/%.o: %.cpp $(COMMON_DEPS) | $(OBJDIR) + @$(MKDIR) $(dir $@) + $(CXX) -MMD -c $(CPPFLAGS) $(CXXFLAGS) $< -o $@ + +$(OBJDIR)/%.o: %.S $(COMMON_DEPS) | $(OBJDIR) + @$(MKDIR) $(dir $@) + $(CC) -MMD -c $(CPPFLAGS) $(ASFLAGS) $< -o $@ + +$(OBJDIR)/%.o: %.s $(COMMON_DEPS) | $(OBJDIR) + @$(MKDIR) $(dir $@) + $(CC) -c $(CPPFLAGS) $(ASFLAGS) $< -o $@ + +# the pde -> o file +$(OBJDIR)/%.o: %.pde $(COMMON_DEPS) | $(OBJDIR) + @$(MKDIR) $(dir $@) + $(CXX) -x c++ -include $(ARDUINO_HEADER) -MMD -c $(CPPFLAGS) $(CXXFLAGS) $< -o $@ + +# the ino -> o file +$(OBJDIR)/%.o: %.ino $(COMMON_DEPS) | $(OBJDIR) + @$(MKDIR) $(dir $@) + $(CXX) -x c++ -include $(ARDUINO_HEADER) -MMD -c $(CPPFLAGS) $(CXXFLAGS) $< -o $@ + +# generated assembly +$(OBJDIR)/%.s: %.pde $(COMMON_DEPS) | $(OBJDIR) + @$(MKDIR) $(dir $@) + $(CXX) -x c++ -include $(ARDUINO_HEADER) -MMD -S -fverbose-asm $(CPPFLAGS) $(CXXFLAGS) $< -o $@ + +$(OBJDIR)/%.s: %.ino $(COMMON_DEPS) | $(OBJDIR) + @$(MKDIR) $(dir $@) + $(CXX) -x c++ -include $(ARDUINO_HEADER) -MMD -S -fverbose-asm $(CPPFLAGS) $(CXXFLAGS) $< -o $@ + +#$(OBJDIR)/%.lst: $(OBJDIR)/%.s +# $(AS) -$(MCU_FLAG_NAME)=$(MCU) -alhnd $< > $@ + +# core files +$(OBJDIR)/%.o: $(ARDUINO_CORE_PATH)/%.c $(COMMON_DEPS) | $(OBJDIR) + @$(MKDIR) $(dir $@) + $(CC) -MMD -c $(CPPFLAGS) $(CFLAGS) $< -o $@ + +$(OBJDIR)/%.o: $(ARDUINO_CORE_PATH)/%.cpp $(COMMON_DEPS) | $(OBJDIR) + @$(MKDIR) $(dir $@) + $(CXX) -MMD -c $(CPPFLAGS) $(CXXFLAGS) $< -o $@ + +$(OBJDIR)/%.o: $(ARDUINO_CORE_PATH)/%.S $(COMMON_DEPS) | $(OBJDIR) + @$(MKDIR) $(dir $@) + $(CC) -MMD -c $(CPPFLAGS) $(ASFLAGS) $< -o $@ + +# various object conversions +$(OBJDIR)/%.hex: $(OBJDIR)/%.elf $(COMMON_DEPS) + @$(MKDIR) $(dir $@) + $(OBJCOPY) -O ihex -R .eeprom $< $@ + @$(ECHO) '\n' + $(call avr_size,$<,$@) +ifneq ($(strip $(HEX_MAXIMUM_SIZE)),) + @if [ `$(SIZE) $@ | awk 'FNR == 2 {print $$2}'` -le $(HEX_MAXIMUM_SIZE) ]; then touch $@.sizeok; fi +else + @$(ECHO) "Maximum flash memory of $(BOARD_TAG) is not specified. Make sure the size of $@ is less than $(BOARD_TAG)\'s flash memory" + @touch $@.sizeok +endif + +$(OBJDIR)/%.eep: $(OBJDIR)/%.elf $(COMMON_DEPS) + @$(MKDIR) $(dir $@) + -$(OBJCOPY) -j .eeprom --set-section-flags=.eeprom="alloc,load" \ + --change-section-lma .eeprom=0 -O ihex $< $@ + +$(OBJDIR)/%.lss: $(OBJDIR)/%.elf $(COMMON_DEPS) + @$(MKDIR) $(dir $@) + $(OBJDUMP) -h --source --demangle --wide $< > $@ + +$(OBJDIR)/%.sym: $(OBJDIR)/%.elf $(COMMON_DEPS) + @$(MKDIR) $(dir $@) + $(NM) --size-sort --demangle --reverse-sort --line-numbers $< > $@ + +######################################################################## +# Avrdude + +# If avrdude is installed separately, it can find its own config file +ifndef AVRDUDE + AVRDUDE = $(AVR_TOOLS_PATH)/avrdude +endif + +# Default avrdude options +# -V Do not verify +# -q - suppress progress output +# -D - Disable auto erase for flash memory +# (-D is needed for Mega boards. See https://github.com/sudar/Arduino-Makefile/issues/114#issuecomment-25011005) +ifndef AVRDUDE_OPTS + AVRDUDE_OPTS = -q -V -D +endif + +AVRDUDE_COM_OPTS = $(AVRDUDE_OPTS) -p $(MCU) +ifdef AVRDUDE_CONF + AVRDUDE_COM_OPTS += -C $(AVRDUDE_CONF) +endif + +AVRDUDE_ARD_OPTS = -c $(AVRDUDE_ARD_PROGRAMMER) -b $(AVRDUDE_ARD_BAUDRATE) -P $(call get_monitor_port) + +ifndef ISP_PROG + ifneq ($(strip $(AVRDUDE_ARD_PROGRAMMER)),) + ISP_PROG = $(AVRDUDE_ARD_PROGRAMMER) + else + ISP_PROG = stk500v1 + endif +endif + +ifndef AVRDUDE_ISP_BAUDRATE + ifneq ($(strip $(AVRDUDE_ARD_BAUDRATE)),) + AVRDUDE_ISP_BAUDRATE = $(AVRDUDE_ARD_BAUDRATE) + else + AVRDUDE_ISP_BAUDRATE = 19200 + endif +endif + +# Fuse settings copied from Arduino IDE. +# https://github.com/arduino/Arduino/blob/master/app/src/processing/app/debug/AvrdudeUploader.java#L254 + +# Pre fuse settings +ifndef AVRDUDE_ISP_FUSES_PRE + ifneq ($(strip $(ISP_LOCK_FUSE_PRE)),) + AVRDUDE_ISP_FUSES_PRE += -U lock:w:$(ISP_LOCK_FUSE_PRE):m + endif + + ifneq ($(strip $(ISP_EXT_FUSE)),) + AVRDUDE_ISP_FUSES_PRE += -U efuse:w:$(ISP_EXT_FUSE):m + endif + + ifneq ($(strip $(ISP_HIGH_FUSE)),) + AVRDUDE_ISP_FUSES_PRE += -U hfuse:w:$(ISP_HIGH_FUSE):m + endif + + ifneq ($(strip $(ISP_LOW_FUSE)),) + AVRDUDE_ISP_FUSES_PRE += -U lfuse:w:$(ISP_LOW_FUSE):m + endif +endif + +# Bootloader file settings +ifndef AVRDUDE_ISP_BURN_BOOTLOADER + ifneq ($(strip $(BOOTLOADER_PATH)),) + ifneq ($(strip $(BOOTLOADER_FILE)),) + AVRDUDE_ISP_BURN_BOOTLOADER += -U flash:w:$(BOOTLOADER_PARENT)/$(BOOTLOADER_PATH)/$(BOOTLOADER_FILE):i + endif + endif +endif + +# Post fuse settings +ifndef AVRDUDE_ISP_FUSES_POST + ifneq ($(strip $(ISP_LOCK_FUSE_POST)),) + AVRDUDE_ISP_FUSES_POST += -U lock:w:$(ISP_LOCK_FUSE_POST):m + endif +endif + +AVRDUDE_ISP_OPTS = -c $(ISP_PROG) -b $(AVRDUDE_ISP_BAUDRATE) + +ifneq ($(strip $(ISP_PROG)),$(filter $(ISP_PROG), usbasp usbtiny)) + AVRDUDE_ISP_OPTS += -P $(call get_isp_port) +endif + +ifndef ISP_EEPROM + ISP_EEPROM = 0 +endif + +AVRDUDE_UPLOAD_HEX = -U flash:w:$(TARGET_HEX):i +AVRDUDE_UPLOAD_EEP = -U eeprom:w:$(TARGET_EEP):i +AVRDUDE_ISPLOAD_OPTS = $(AVRDUDE_UPLOAD_HEX) + +ifneq ($(ISP_EEPROM), 0) + AVRDUDE_ISPLOAD_OPTS += $(AVRDUDE_UPLOAD_EEP) +endif + +######################################################################## +# Explicit targets start here + +all: $(TARGET_EEP) $(TARGET_HEX) + +# Rule to create $(OBJDIR) automatically. All rules with recipes that +# create a file within it, but do not already depend on a file within it +# should depend on this rule. They should use a "order-only +# prerequisite" (e.g., put "| $(OBJDIR)" at the end of the prerequisite +# list) to prevent remaking the target when any file in the directory +# changes. +$(OBJDIR): + $(MKDIR) $(OBJDIR) + +$(TARGET_ELF): $(LOCAL_OBJS) $(CORE_LIB) $(OTHER_OBJS) + $(CC) $(LDFLAGS) -o $@ $(LOCAL_OBJS) $(CORE_LIB) $(OTHER_OBJS) -lc -lm + +$(CORE_LIB): $(CORE_OBJS) $(LIB_OBJS) $(USER_LIB_OBJS) + $(AR) rcs $@ $(CORE_OBJS) $(LIB_OBJS) $(USER_LIB_OBJS) + +error_on_caterina: + $(ERROR_ON_CATERINA) + +# Use submake so we can guarantee the reset happens +# before the upload, even with make -j +upload: $(TARGET_HEX) verify_size + $(MAKE) reset + $(MAKE) do_upload + +raw_upload: $(TARGET_HEX) verify_size + $(MAKE) error_on_caterina + $(MAKE) do_upload + +do_upload: + $(AVRDUDE) $(AVRDUDE_COM_OPTS) $(AVRDUDE_ARD_OPTS) \ + $(AVRDUDE_UPLOAD_HEX) + +do_eeprom: $(TARGET_EEP) $(TARGET_HEX) + $(AVRDUDE) $(AVRDUDE_COM_OPTS) $(AVRDUDE_ARD_OPTS) \ + $(AVRDUDE_UPLOAD_EEP) + +eeprom: $(TARGET_HEX) verify_size + $(MAKE) reset + $(MAKE) do_eeprom + +raw_eeprom: $(TARGET_HEX) verify_size + $(MAKE) error_on_caterina + $(MAKE) do_eeprom + +reset: + $(call arduino_output,Resetting Arduino...) + $(RESET_CMD) + +# stty on MacOS likes -F, but on Debian it likes -f redirecting +# stdin/out appears to work but generates a spurious error on MacOS at +# least. Perhaps it would be better to just do it in perl ? +reset_stty: + for STTYF in 'stty -F' 'stty --file' 'stty -f' 'stty <' ; \ + do $$STTYF /dev/tty >/dev/null 2>&1 && break ; \ + done ; \ + $$STTYF $(call get_monitor_port) hupcl ; \ + (sleep 0.1 2>/dev/null || sleep 1) ; \ + $$STTYF $(call get_monitor_port) -hupcl + +ispload: $(TARGET_EEP) $(TARGET_HEX) verify_size + $(AVRDUDE) $(AVRDUDE_COM_OPTS) $(AVRDUDE_ISP_OPTS) \ + $(AVRDUDE_ISPLOAD_OPTS) + +burn_bootloader: +ifneq ($(strip $(AVRDUDE_ISP_FUSES_PRE)),) + $(AVRDUDE) $(AVRDUDE_COM_OPTS) $(AVRDUDE_ISP_OPTS) -e $(AVRDUDE_ISP_FUSES_PRE) +endif +ifneq ($(strip $(AVRDUDE_ISP_BURN_BOOTLOADER)),) + $(AVRDUDE) $(AVRDUDE_COM_OPTS) $(AVRDUDE_ISP_OPTS) $(AVRDUDE_ISP_BURN_BOOTLOADER) +endif +ifneq ($(strip $(AVRDUDE_ISP_FUSES_POST)),) + $(AVRDUDE) $(AVRDUDE_COM_OPTS) $(AVRDUDE_ISP_OPTS) $(AVRDUDE_ISP_FUSES_POST) +endif + +set_fuses: +ifneq ($(strip $(AVRDUDE_ISP_FUSES_PRE)),) + $(AVRDUDE) $(AVRDUDE_COM_OPTS) $(AVRDUDE_ISP_OPTS) -e $(AVRDUDE_ISP_FUSES_PRE) +endif +ifneq ($(strip $(AVRDUDE_ISP_FUSES_POST)),) + $(AVRDUDE) $(AVRDUDE_COM_OPTS) $(AVRDUDE_ISP_OPTS) $(AVRDUDE_ISP_FUSES_POST) +endif + +clean: + $(REMOVE) $(LOCAL_OBJS) $(CORE_OBJS) $(LIB_OBJS) $(CORE_LIB) $(TARGETS) $(DEPS) $(USER_LIB_OBJS) ${OBJDIR} + +size: $(TARGET_HEX) + $(call avr_size,$(TARGET_ELF),$(TARGET_HEX)) + +show_boards: + @cat $(BOARDS_TXT) | grep -E "^[[:alnum:]]" | cut -d . -f 1 | uniq + +monitor: + $(MONITOR_CMD) $(call get_monitor_port) $(MONITOR_BAUDRATE) + +disasm: $(OBJDIR)/$(TARGET).lss + @$(ECHO) "The compiled ELF file has been disassembled to $(OBJDIR)/$(TARGET).lss" + +symbol_sizes: $(OBJDIR)/$(TARGET).sym + @$(ECHO) "A symbol listing sorted by their size have been dumped to $(OBJDIR)/$(TARGET).sym" + +verify_size: +ifeq ($(strip $(HEX_MAXIMUM_SIZE)),) + @$(ECHO) "\nMaximum flash memory of $(BOARD_TAG) is not specified. Make sure the size of $(TARGET_HEX) is less than $(BOARD_TAG)\'s flash memory\n\n" +endif + @if [ ! -f $(TARGET_HEX).sizeok ]; then echo >&2 "\nThe size of the compiled binary file is greater than the $(BOARD_TAG)'s flash memory. \ +See http://www.arduino.cc/en/Guide/Troubleshooting#size for tips on reducing it."; false; fi + +generate_assembly: $(OBJDIR)/$(TARGET).s + @$(ECHO) "Compiler-generated assembly for the main input source has been dumped to $(OBJDIR)/$(TARGET).s" + +generated_assembly: generate_assembly + @$(ECHO) "\"generated_assembly\" target is deprecated. Use \"generate_assembly\" target instead" + +help: + @$(ECHO) "\nAvailable targets:\n\ + make - no upload\n\ + make upload - upload\n\ + make clean - remove all our dependencies\n\ + make depends - update dependencies\n\ + make reset - reset the Arduino by tickling DTR on the serial port\n\ + make raw_upload - upload without first resetting\n\ + make show_boards - list all the boards defined in boards.txt\n\ + make monitor - connect to the Arduino's serial port\n\ + make size - show the size of the compiled output (relative to\n\ + resources, if you have a patched avr-size)\n\ + make disasm - generate a .lss file in build-cli that contains\n\ + disassembly of the compiled file interspersed\n\ + with your original source code.\n\ + make verify_size - Verify that the size of the final file is less than\n\ + the capacity of the micro controller.\n\ + make eeprom - upload the eep file\n\ + make raw_eeprom - upload the eep file without first resetting\n\ + make burn_bootloader - burn bootloader and fuses\n\ + make set_fuses - set fuses without burning bootloader\n\ + make help - show this help\n\ +" + @$(ECHO) "Please refer to $(ARDMK_FILE) for more details.\n" + +.PHONY: all upload raw_upload raw_eeprom error_on_caterina reset reset_stty ispload \ + clean depends size show_boards monitor disasm symbol_sizes generated_assembly \ + generate_assembly verify_size burn_bootloader help + +# added - in the beginning, so that we don't get an error if the file is not present +-include $(DEPS) diff --git a/Common.mk b/Common.mk new file mode 100644 index 0000000..a94c37f --- /dev/null +++ b/Common.mk @@ -0,0 +1,38 @@ +# Useful functions +# Returns the first argument (typically a directory), if the file or directory +# named by concatenating the first and optionally second argument +# (directory and optional filename) exists +dir_if_exists = $(if $(wildcard $(1)$(2)),$(1)) + +# For message printing: pad the right side of the first argument with spaces to +# the number of bytes indicated by the second argument. +space_pad_to = $(shell echo $(1) " " | head -c$(2)) + +# Call with some text, and a prefix tag if desired (like [AUTODETECTED]), +show_config_info = $(call arduino_output,- $(call space_pad_to,$(2),20) $(1)) + +# Call with the name of the variable, a prefix tag if desired (like [AUTODETECTED]), +# and an explanation if desired (like (found in $$PATH) +show_config_variable = $(call show_config_info,$(1) = $($(1)) $(3),$(2)) + +# Just a nice simple visual separator +show_separator = $(call arduino_output,-------------------------) + +$(call show_separator) +$(call arduino_output,Arduino.mk Configuration:) + +######################################################################## +# +# Detect OS +ifeq ($(OS),Windows_NT) + CURRENT_OS = WINDOWS +else + UNAME_S := $(shell uname -s) + ifeq ($(UNAME_S),Linux) + CURRENT_OS = LINUX + endif + ifeq ($(UNAME_S),Darwin) + CURRENT_OS = MAC + endif +endif +$(call show_config_variable,CURRENT_OS,[AUTODETECTED]) diff --git a/arduino-mk/Arduino.mk b/arduino-mk/Arduino.mk deleted file mode 100644 index 3241cca..0000000 --- a/arduino-mk/Arduino.mk +++ /dev/null @@ -1,1231 +0,0 @@ -######################################################################## -# -# Makefile for compiling Arduino sketches from command line -# System part (i.e. project independent) -# -# Copyright (C) 2012 Sudar , based on -# - M J Oldfield work: https://github.com/mjoldfield/Arduino-Makefile -# -# Copyright (C) 2010,2011,2012 Martin Oldfield , based on -# work that is copyright Nicholas Zambetti, David A. Mellis & Hernando -# Barragan. -# -# This file is free software; you can redistribute it and/or modify it -# under the terms of the GNU Lesser General Public License as -# published by the Free Software Foundation; either version 2.1 of the -# License, or (at your option) any later version. -# -# Adapted from Arduino 0011 Makefile by M J Oldfield -# -# Original Arduino adaptation by mellis, eighthave, oli.keller -# -# Current version: 1.1.0 -# -# Refer to HISTORY.md file for complete history of changes -# -######################################################################## -# -# PATHS YOU NEED TO SET UP -# -# We need to worry about three different sorts of file: -# -# 1. Things which are included in this distribution e.g. ard-reset-arduino -# => ARDMK_DIR - Where the *.mk files are stored -# => ARDMK_PATH - Where the ard-reset-arduino script is stored -# -# 2. Things which are always in the Arduino distribution e.g. -# boards.txt, libraries, &c. -# => ARDUINO_DIR -# -# 3. Things which might be bundled with the Arduino distribution, but -# might come from the system. Most of the toolchain is like this: -# on Linux it's supplied by the system. -# => AVR_TOOLS_DIR -# -# Having set these three variables, we can work out the rest assuming -# that things are canonically arranged beneath the directories defined -# above. -# -# On the Mac you might want to set: -# -# ARDUINO_DIR = /Applications/Arduino.app/Contents/Resources/Java -# ARDMK_DIR = /usr/local -# -# On Linux, you might prefer: -# -# ARDUINO_DIR = /usr/share/arduino -# ARDMK_DIR = /usr -# AVR_TOOLS_DIR = /usr -# -# You can either set these up in the Makefile, or put them in your -# environment e.g. in your .bashrc -# -# If you don't specify these, we can try to guess, but that might not work -# or work the way you want it to. -# -# If you don't install the ard-reset-arduino binary to /usr/local/bin, but -# instead copy them to e.g. /home/mjo/arduino.mk/bin then set -# ARDMK_PATH = /home/mjo/arduino.mk/bin -# -# If you'd rather not see the configuration output, define ARDUINO_QUIET. -# -######################################################################## -# -# DEPENDENCIES -# -# The Perl programs need a couple of libraries: -# Device::SerialPort -# -######################################################################## -# -# STANDARD ARDUINO WORKFLOW -# -# Given a normal sketch directory, all you need to do is to create -# a small Makefile which defines a few things, and then includes this one. -# -# For example: -# -# ARDUINO_LIBS = Ethernet SPI -# BOARD_TAG = uno -# MONITOR_PORT = /dev/cu.usb* -# -# include /usr/share/arduino/Arduino.mk -# -# Hopefully these will be self-explanatory but in case they're not: -# -# ARDUINO_LIBS - A list of any libraries used by the sketch (we -# assume these are in $(ARDUINO_DIR)/hardware/libraries -# or your sketchbook's libraries directory) -# -# MONITOR_PORT - The port where the Arduino can be found (only needed -# when uploading) -# -# BOARD_TAG - The tag for the board e.g. uno or mega -# 'make show_boards' shows a list -# -# If you have your additional libraries relative to your source, rather -# than in your "sketchbook", also set USER_LIB_PATH, like this example: -# -# USER_LIB_PATH := $(realpath ../../libraries) -# -# If you've added the Arduino-Makefile repository to your git repo as a -# submodule (or other similar arrangement), you might have lines like this -# in your Makefile: -# -# ARDMK_DIR := $(realpath ../../tools/Arduino-Makefile) -# include $(ARDMK_DIR)/arduino-mk/Arduino.mk -# -# In any case, once this file has been created the typical workflow is just -# -# $ make upload -# -# All of the object files are created in the build-{BOARD_TAG} subdirectory -# All sources should be in the current directory and can include: -# - at most one .pde or .ino file which will be treated as C++ after -# the standard Arduino header and footer have been affixed. -# - any number of .c, .cpp, .s and .h files -# -# Included libraries are built in the build-{BOARD_TAG}/libs subdirectory. -# -# Besides make upload, there are a couple of other targets that are available. -# Do make help to get the complete list of targets and their description -# -######################################################################## -# -# SERIAL MONITOR -# -# The serial monitor just invokes the GNU screen program with suitable -# options. For more information see screen (1) and search for -# 'character special device'. -# -# The really useful thing to know is that ^A-k gets you out! -# -# The fairly useful thing to know is that you can bind another key to -# escape too, by creating $HOME{.screenrc} containing e.g. -# -# bindkey ^C kill -# -# If you want to change the baudrate, just set MONITOR_BAUDRATE. If you -# don't set it, it tries to read from the sketch. If it couldn't read -# from the sketch, then it defaults to 9600 baud. -# -######################################################################## -# -# ARDUINO WITH ISP -# -# You need to specify some details of your ISP programmer and might -# also need to specify the fuse values: -# -# ISP_PROG = stk500v2 -# ISP_PORT = /dev/ttyACM0 -# -# You might also need to set the fuse bits, but typically they'll be -# read from boards.txt, based on the BOARD_TAG variable: -# -# ISP_LOCK_FUSE_PRE = 0x3f -# ISP_LOCK_FUSE_POST = 0xcf -# ISP_HIGH_FUSE = 0xdf -# ISP_LOW_FUSE = 0xff -# ISP_EXT_FUSE = 0x01 -# -# You can specify to also upload the EEPROM file: -# ISP_EEPROM = 1 -# -# I think the fuses here are fine for uploading to the ATmega168 -# without bootloader. -# -# To actually do this upload use the ispload target: -# -# make ispload -# -# -######################################################################## -# -# ALTERNATIVE CORES -# -# To use alternative cores for platforms such as ATtiny, you need to -# specify a few more variables, depending on the core in use. -# -# The HLT (attiny-master) core can be used just by specifying -# ALTERNATE_CORE, assuming your core is in your ~/sketchbook/hardware -# directory. For example: -# -# ISP_PORT = /dev/ttyACM0 -# BOARD_TAG = attiny85 -# ALTERNATE_CORE = attiny-master -# -# To use the more complex arduino-tiny and TinyCore2 cores, you must -# also set ARDUINO_CORE_PATH and ARDUINO_VAR_PATH to the core -# directory, as these cores essentially replace the main Arduino core. -# For example: -# -# ISP_PORT = /dev/ttyACM0 -# BOARD_TAG = attiny85at8 -# ALTERNATE_CORE = arduino-tiny -# ARDUINO_VAR_PATH = ~/sketchbook/hardware/arduino-tiny/cores/tiny -# ARDUINO_CORE_PATH = ~/sketchbook/hardware/arduino-tiny/cores/tiny -# -# or.... -# -# ISP_PORT = /dev/ttyACM0 -# BOARD_TAG = attiny861at8 -# ALTERNATE_CORE = tiny2 -# ARDUINO_VAR_PATH = ~/sketchbook/hardware/tiny2/cores/tiny -# ARDUINO_CORE_PATH = ~/sketchbook/hardware/tiny2/cores/tiny -# -######################################################################## - -arduino_output = -# When output is not suppressed and we're in the top-level makefile, -# running for the first time (i.e., not after a restart after -# regenerating the dependency file), then output the configuration. -ifndef ARDUINO_QUIET - ifeq ($(MAKE_RESTARTS),) - ifeq ($(MAKELEVEL),0) - arduino_output = $(info $(1)) - endif - endif -endif - -######################################################################## -# Makefile distribution path - -ifndef ARDMK_DIR - # presume it's a level above the path to our own file - ARDMK_DIR := $(realpath $(dir $(realpath $(lastword $(MAKEFILE_LIST))))/..) -else - # show_config_variable macro is defined in Common.mk file and is not available yet. - # Let's define a variable to know that user specified ARDMK_DIR - ARDMK_DIR_MSG = USER -endif - -ifneq ($(wildcard $(ARDMK_DIR)/arduino-mk/Common.mk),) - # git checkout - ARDMK_FILE = $(ARDMK_DIR)/arduino-mk/arduino.mk - include $(ARDMK_DIR)/arduino-mk/Common.mk -else - ifneq ($(wildcard $(ARDMK_DIR)/Common.mk),) - # package install - ARDMK_FILE = $(ARDMK_DIR)/arduino.mk - include $(ARDMK_DIR)/Common.mk - endif -endif - -# show_config_variable macro is available now. So let's print config details for ARDMK_DIR -ifndef ARDMK_DIR_MSG - $(call show_config_variable,ARDMK_DIR,[COMPUTED],(relative to $(notdir $(lastword $(MAKEFILE_LIST))))) -else - $(call show_config_variable,ARDMK_DIR,[USER]) -endif - -ifndef ARDMK_PATH - ARDMK_PATH = $(ARDMK_DIR)/bin - $(call show_config_variable,ARDMK_PATH,[COMPUTED],(relative to ARDMK_DIR)) -else - $(call show_config_variable,ARDMK_PATH,[USER]) -endif - -######################################################################## -# Arduino Directory - -ifndef ARDUINO_DIR - AUTO_ARDUINO_DIR := $(firstword \ - $(call dir_if_exists,/usr/share/arduino) \ - $(call dir_if_exists,/Applications/Arduino.app/Contents/Resources/Java) ) - ifdef AUTO_ARDUINO_DIR - ARDUINO_DIR = $(AUTO_ARDUINO_DIR) - $(call show_config_variable,ARDUINO_DIR,[AUTODETECTED]) - else - echo $(error "ARDUINO_DIR is not defined") - endif -else - $(call show_config_variable,ARDUINO_DIR,[USER]) -endif - -######################################################################## -# Default TARGET to pwd (ex Daniele Vergini) - -ifndef TARGET - TARGET = $(notdir $(CURDIR)) -endif - -######################################################################## -# Arduino version number - -ifndef ARDUINO_VERSION - # Remove all the decimals, and right-pad with zeros, and finally grab the first 3 bytes. - # Works for 1.0 and 1.0.1 - VERSION_FILE := $(ARDUINO_DIR)/lib/version.txt - AUTO_ARDUINO_VERSION := $(shell [ -e $(VERSION_FILE) ] && cat $(VERSION_FILE) | sed -e 's/^[0-9]://g' -e 's/[.]//g' -e 's/$$/0000/' | head -c3) - ifdef AUTO_ARDUINO_VERSION - ARDUINO_VERSION = $(AUTO_ARDUINO_VERSION) - $(call show_config_variable,ARDUINO_VERSION,[AUTODETECTED]) - else - ARDUINO_VERSION = 100 - $(call show_config_variable,ARDUINO_VERSION,[DEFAULT]) - endif -else - $(call show_config_variable,ARDUINO_VERSION,[USER]) -endif - -######################################################################## -# Arduino Sketchbook folder - -ifndef ARDUINO_SKETCHBOOK - ifndef ARDUINO_PREFERENCES_PATH - - AUTO_ARDUINO_PREFERENCES := $(firstword \ - $(call dir_if_exists,$(HOME)/.arduino/preferences.txt) \ - $(call dir_if_exists,$(HOME)/Library/Arduino/preferences.txt) ) - ifdef AUTO_ARDUINO_PREFERENCES - ARDUINO_PREFERENCES_PATH = $(AUTO_ARDUINO_PREFERENCES) - $(call show_config_variable,ARDUINO_PREFERENCES_PATH,[AUTODETECTED]) - endif - - else - $(call show_config_variable,ARDUINO_PREFERENCES_PATH,[USER]) - endif - - ifneq ($(ARDUINO_PREFERENCES_PATH),) - ARDUINO_SKETCHBOOK = $(shell grep --max-count=1 --regexp="sketchbook.path=" \ - $(ARDUINO_PREFERENCES_PATH) | \ - sed -e 's/sketchbook.path=//' ) - endif - - ifneq ($(ARDUINO_SKETCHBOOK),) - $(call show_config_variable,ARDUINO_SKETCHBOOK,[AUTODETECTED],(from arduino preferences file)) - else - ARDUINO_SKETCHBOOK = $(HOME)/sketchbook - $(call show_config_variable,ARDUINO_SKETCHBOOK,[DEFAULT]) - endif -else - $(call show_config_variable,ARDUINO_SKETCHBOOK,[USER]) -endif - -######################################################################## -# Arduino and system paths - -ifndef CC_NAME -CC_NAME = avr-gcc -endif - -ifndef CXX_NAME -CXX_NAME = avr-g++ -endif - -ifndef OBJCOPY_NAME -OBJCOPY_NAME = avr-objcopy -endif - -ifndef OBJDUMP_NAME -OBJDUMP_NAME = avr-objdump -endif - -ifndef AR_NAME -AR_NAME = avr-ar -endif - -ifndef SIZE_NAME -SIZE_NAME = avr-size -endif - -ifndef NM_NAME -NM_NAME = avr-nm -endif - -ifndef AVR_TOOLS_DIR - - BUNDLED_AVR_TOOLS_DIR := $(call dir_if_exists,$(ARDUINO_DIR)/hardware/tools/avr) - ifdef BUNDLED_AVR_TOOLS_DIR - AVR_TOOLS_DIR = $(BUNDLED_AVR_TOOLS_DIR) - $(call show_config_variable,AVR_TOOLS_DIR,[BUNDLED],(in Arduino distribution)) - - # In Linux distribution of Arduino, the path to avrdude and avrdude.conf are different - # More details at https://github.com/sudar/Arduino-Makefile/issues/48 and - # https://groups.google.com/a/arduino.cc/d/msg/developers/D_m97jGr8Xs/uQTt28KO_8oJ - ifeq ($(CURRENT_OS),LINUX) - - ifndef AVRDUDE - AVRDUDE = $(AVR_TOOLS_DIR)/../avrdude - endif - - ifndef AVRDUDE_CONF - AVRDUDE_CONF = $(AVR_TOOLS_DIR)/../avrdude.conf - endif - - else - - ifndef AVRDUDE_CONF - AVRDUDE_CONF = $(AVR_TOOLS_DIR)/etc/avrdude.conf - endif - - endif - - else - - SYSTEMPATH_AVR_TOOLS_DIR := $(call dir_if_exists,$(abspath $(dir $(shell which $(CC_NAME)))/..)) - ifdef SYSTEMPATH_AVR_TOOLS_DIR - AVR_TOOLS_DIR = $(SYSTEMPATH_AVR_TOOLS_DIR) - $(call show_config_variable,AVR_TOOLS_DIR,[AUTODETECTED],(found in $$PATH)) - else - echo $(error No AVR tools directory found) - endif # SYSTEMPATH_AVR_TOOLS_DIR - - endif # BUNDLED_AVR_TOOLS_DIR - -else - $(call show_config_variable,AVR_TOOLS_DIR,[USER]) -endif #ndef AVR_TOOLS_DIR - -ifndef AVR_TOOLS_PATH - AVR_TOOLS_PATH = $(AVR_TOOLS_DIR)/bin -endif - -ARDUINO_LIB_PATH = $(ARDUINO_DIR)/libraries -$(call show_config_variable,ARDUINO_LIB_PATH,[COMPUTED],(from ARDUINO_DIR)) -ifndef ARDUINO_CORE_PATH - ARDUINO_CORE_PATH = $(ARDUINO_DIR)/hardware/arduino/cores/arduino - $(call show_config_variable,ARDUINO_CORE_PATH,[DEFAULT]) -else - $(call show_config_variable,ARDUINO_CORE_PATH,[USER]) -endif - -# Third party hardware and core like ATtiny or ATmega 16 -ifdef ALTERNATE_CORE - $(call show_config_variable,ALTERNATE_CORE,[USER]) - - ifndef ALTERNATE_CORE_PATH - ALTERNATE_CORE_PATH = $(ARDUINO_SKETCHBOOK)/hardware/$(ALTERNATE_CORE) - endif -endif - -ifdef ALTERNATE_CORE_PATH - - ifdef ALTERNATE_CORE - $(call show_config_variable,ALTERNATE_CORE_PATH,[COMPUTED], (from ARDUINO_SKETCHBOOK and ALTERNATE_CORE)) - else - $(call show_config_variable,ALTERNATE_CORE_PATH,[USER]) - endif - - ifndef ARDUINO_VAR_PATH - ARDUINO_VAR_PATH = $(ALTERNATE_CORE_PATH)/variants - $(call show_config_variable,ARDUINO_VAR_PATH,[COMPUTED],(from ALTERNATE_CORE_PATH)) - endif - - ifndef BOARDS_TXT - BOARDS_TXT = $(ALTERNATE_CORE_PATH)/boards.txt - $(call show_config_variable,BOARDS_TXT,[COMPUTED],(from ALTERNATE_CORE_PATH)) - endif - -else - - ifndef ARDUINO_VAR_PATH - ARDUINO_VAR_PATH = $(ARDUINO_DIR)/hardware/arduino/variants - $(call show_config_variable,ARDUINO_VAR_PATH,[COMPUTED],(from ARDUINO_DIR)) - else - $(call show_config_variable,ARDUINO_VAR_PATH,[USER]) - endif - - ifndef BOARDS_TXT - BOARDS_TXT = $(ARDUINO_DIR)/hardware/arduino/boards.txt - $(call show_config_variable,BOARDS_TXT,[COMPUTED],(from ARDUINO_DIR)) - else - $(call show_config_variable,BOARDS_TXT,[USER]) - endif - -endif - -######################################################################## -# Miscellaneous - -ifndef USER_LIB_PATH - USER_LIB_PATH = $(ARDUINO_SKETCHBOOK)/libraries - $(call show_config_variable,USER_LIB_PATH,[DEFAULT],(in user sketchbook)) -else - $(call show_config_variable,USER_LIB_PATH,[USER]) -endif - -######################################################################## -# boards.txt parsing - -ifndef BOARD_TAG - BOARD_TAG = uno - $(call show_config_variable,BOARD_TAG,[DEFAULT]) -else - # Strip the board tag of any extra whitespace, since it was causing the makefile to fail - # https://github.com/sudar/Arduino-Makefile/issues/57 - BOARD_TAG := $(strip $(BOARD_TAG)) - $(call show_config_variable,BOARD_TAG,[USER]) -endif - -ifndef PARSE_BOARD - # result = $(call READ_BOARD_TXT, 'boardname', 'parameter') - PARSE_BOARD = $(shell grep -v "^\#" $(BOARDS_TXT) | grep $(1).$(2) | cut -d = -f 2 ) -endif - -# If NO_CORE is set, then we don't have to parse boards.txt file -# But the user might have to define MCU, F_CPU etc -ifeq ($(strip $(NO_CORE)),) - - # Which variant ? This affects the include path - ifndef VARIANT - VARIANT = $(call PARSE_BOARD,$(BOARD_TAG),build.variant) - endif - - # see if we are a caterina device like leonardo or micro - CATERINA = $(findstring caterina,$(call PARSE_BOARD,$(BOARD_TAG),bootloader.path)) - - # processor stuff - ifndef MCU - MCU = $(call PARSE_BOARD,$(BOARD_TAG),build.mcu) - endif - - ifndef F_CPU - F_CPU = $(call PARSE_BOARD,$(BOARD_TAG),build.f_cpu) - endif - - ifneq ($(CATERINA),) - # USB IDs for the caterina devices like leonardo or micro - ifndef USB_VID - USB_VID = $(call PARSE_BOARD,$(BOARD_TAG),build.vid) - endif - - ifndef USB_PID - USB_PID = $(call PARSE_BOARD,$(BOARD_TAG),build.pid) - endif - endif - - # normal programming info - ifndef AVRDUDE_ARD_PROGRAMMER - AVRDUDE_ARD_PROGRAMMER = $(call PARSE_BOARD,$(BOARD_TAG),upload.protocol) - endif - - ifndef AVRDUDE_ARD_BAUDRATE - AVRDUDE_ARD_BAUDRATE = $(call PARSE_BOARD,$(BOARD_TAG),upload.speed) - endif - - # fuses if you're using e.g. ISP - ifndef ISP_LOCK_FUSE_PRE - ISP_LOCK_FUSE_PRE = $(call PARSE_BOARD,$(BOARD_TAG),bootloader.unlock_bits) - endif - - ifndef ISP_HIGH_FUSE - ISP_HIGH_FUSE = $(call PARSE_BOARD,$(BOARD_TAG),bootloader.high_fuses) - endif - - ifndef ISP_LOW_FUSE - ISP_LOW_FUSE = $(call PARSE_BOARD,$(BOARD_TAG),bootloader.low_fuses) - endif - - ifndef ISP_EXT_FUSE - ISP_EXT_FUSE = $(call PARSE_BOARD,$(BOARD_TAG),bootloader.extended_fuses) - endif - - ifndef BOOTLOADER_PATH - BOOTLOADER_PATH = $(call PARSE_BOARD,$(BOARD_TAG),bootloader.path) - endif - - ifndef BOOTLOADER_FILE - BOOTLOADER_FILE = $(call PARSE_BOARD,$(BOARD_TAG),bootloader.file) - endif - - ifndef ISP_LOCK_FUSE_POST - ISP_LOCK_FUSE_POST = $(call PARSE_BOARD,$(BOARD_TAG),bootloader.lock_bits) - endif - - ifndef HEX_MAXIMUM_SIZE - HEX_MAXIMUM_SIZE = $(call PARSE_BOARD,$(BOARD_TAG),upload.maximum_size) - endif - -endif - -# Everything gets built in here (include BOARD_TAG now) -ifndef OBJDIR - OBJDIR = build-$(BOARD_TAG) - $(call show_config_variable,OBJDIR,[COMPUTED],(from BOARD_TAG)) -else - $(call show_config_variable,OBJDIR,[USER]) -endif - -######################################################################## -# Reset - -ifndef RESET_CMD - ifneq ($(CATERINA),) - RESET_CMD = $(ARDMK_PATH)/ard-reset-arduino --caterina \ - $(ARD_RESET_OPTS) $(call get_monitor_port) - else - RESET_CMD = $(ARDMK_PATH)/ard-reset-arduino \ - $(ARD_RESET_OPTS) $(call get_monitor_port) - endif -endif - -ifneq ($(CATERINA),) - ERROR_ON_CATERINA = $(error On $(BOARD_TAG), raw_xxx operation is not supported) -else - ERROR_ON_CATERINA = -endif - -######################################################################## -# Local sources - -LOCAL_C_SRCS ?= $(wildcard *.c) -LOCAL_CPP_SRCS ?= $(wildcard *.cpp) -LOCAL_CC_SRCS ?= $(wildcard *.cc) -LOCAL_PDE_SRCS ?= $(wildcard *.pde) -LOCAL_INO_SRCS ?= $(wildcard *.ino) -LOCAL_AS_SRCS ?= $(wildcard *.S) -LOCAL_SRCS = $(LOCAL_C_SRCS) $(LOCAL_CPP_SRCS) \ - $(LOCAL_CC_SRCS) $(LOCAL_PDE_SRCS) \ - $(LOCAL_INO_SRCS) $(LOCAL_AS_SRCS) -LOCAL_OBJ_FILES = $(LOCAL_C_SRCS:.c=.o) $(LOCAL_CPP_SRCS:.cpp=.o) \ - $(LOCAL_CC_SRCS:.cc=.o) $(LOCAL_PDE_SRCS:.pde=.o) \ - $(LOCAL_INO_SRCS:.ino=.o) $(LOCAL_AS_SRCS:.S=.o) -LOCAL_OBJS = $(patsubst %,$(OBJDIR)/%,$(LOCAL_OBJ_FILES)) - -ifeq ($(words $(LOCAL_SRCS)), 0) - $(error Atleast one source file (*.ino, *.pde, *.cpp, *c, *cc, *.S) is needed) -endif - -ifeq ($(strip $(NO_CORE)),) - - # Ideally, this should just check if there are more than one file - ifneq ($(words $(LOCAL_PDE_SRCS) $(LOCAL_INO_SRCS)), 1) - ifeq ($(words $(LOCAL_PDE_SRCS) $(LOCAL_INO_SRCS)), 0) - $(call show_config_info,No .pde or .ino files found. If you are compiling .c or .cpp files then you need to explicitly include Arduino header files) - else - #TODO: Support more than one file. https://github.com/sudar/Arduino-Makefile/issues/49 - $(error Need exactly one .pde or .ino file. This makefile doesn't support multiple .ino/.pde files yet) - endif - endif - -endif - -# core sources -ifeq ($(strip $(NO_CORE)),) - ifdef ARDUINO_CORE_PATH - CORE_C_SRCS = $(wildcard $(ARDUINO_CORE_PATH)/*.c) - CORE_CPP_SRCS = $(wildcard $(ARDUINO_CORE_PATH)/*.cpp) - - ifneq ($(strip $(NO_CORE_MAIN_CPP)),) - CORE_CPP_SRCS := $(filter-out %main.cpp, $(CORE_CPP_SRCS)) - $(call show_config_info,NO_CORE_MAIN_CPP set so core library will not include main.cpp,[MANUAL]) - endif - - CORE_OBJ_FILES = $(CORE_C_SRCS:.c=.o) $(CORE_CPP_SRCS:.cpp=.o) $(CORE_AS_SRCS:.S=.o) - CORE_OBJS = $(patsubst $(ARDUINO_CORE_PATH)/%, \ - $(OBJDIR)/%,$(CORE_OBJ_FILES)) - endif -else - $(call show_config_info,NO_CORE set so core library will not be built,[MANUAL]) -endif - -######################################################################## -# Determine ARDUINO_LIBS automatically - -ifndef ARDUINO_LIBS - # automatically determine included libraries - ARDUINO_LIBS += $(filter $(notdir $(wildcard $(ARDUINO_DIR)/libraries/*)), \ - $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(LOCAL_SRCS))) - ARDUINO_LIBS += $(filter $(notdir $(wildcard $(ARDUINO_SKETCHBOOK)/libraries/*)), \ - $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(LOCAL_SRCS))) - ARDUINO_LIBS += $(filter $(notdir $(wildcard $(USER_LIB_PATH)/*)), \ - $(shell sed -ne "s/^ *\# *include *[<\"]\(.*\)\.h[>\"]/\1/p" $(LOCAL_SRCS))) -endif - -######################################################################## -# Serial monitor (just a screen wrapper) - -# Quite how to construct the monitor command seems intimately tied -# to the command we're using (here screen). So, read the screen docs -# for more information (search for 'character special device'). - -ifeq ($(strip $(NO_CORE)),) - ifndef MONITOR_BAUDRATE - ifeq ($(words $(LOCAL_PDE_SRCS) $(LOCAL_INO_SRCS)), 1) - SPEED = $(shell egrep -h 'Serial.begin\([0-9]+\)' $(LOCAL_PDE_SRCS) $(LOCAL_INO_SRCS) | sed -e 's/[^0-9]//g'| head -n1) - MONITOR_BAUDRATE = $(findstring $(SPEED),300 1200 2400 4800 9600 14400 19200 28800 38400 57600 115200) - endif - - ifeq ($(MONITOR_BAUDRATE),) - MONITOR_BAUDRATE = 9600 - $(call show_config_variable,MONITOR_BAUDRATE,[ASSUMED]) - else - $(call show_config_variable,MONITOR_BAUDRATE,[DETECTED], (in sketch)) - endif - else - $(call show_config_variable,MONITOR_BAUDRATE, [USER]) - endif - - ifndef MONITOR_CMD - MONITOR_CMD = screen - endif -endif - -######################################################################## -# Include Arduino Header file - -ifndef ARDUINO_HEADER - # We should check for Arduino version, not just the file extension - # because, a .pde file can be used in Arduino 1.0 as well - ifeq ($(shell expr $(ARDUINO_VERSION) '<' 100), 1) - ARDUINO_HEADER=WProgram.h - else - ARDUINO_HEADER=Arduino.h - endif -endif - -######################################################################## -# Rules for making stuff - -# The name of the main targets -TARGET_HEX = $(OBJDIR)/$(TARGET).hex -TARGET_ELF = $(OBJDIR)/$(TARGET).elf -TARGET_EEP = $(OBJDIR)/$(TARGET).eep -TARGETS = $(OBJDIR)/$(TARGET).* -CORE_LIB = $(OBJDIR)/libcore.a - -# Names of executables -CC = $(AVR_TOOLS_PATH)/$(CC_NAME) -CXX = $(AVR_TOOLS_PATH)/$(CXX_NAME) -AS = $(AVR_TOOLS_PATH)/$(AS_NAME) -OBJCOPY = $(AVR_TOOLS_PATH)/$(OBJCOPY_NAME) -OBJDUMP = $(AVR_TOOLS_PATH)/$(OBJDUMP_NAME) -AR = $(AVR_TOOLS_PATH)/$(AR_NAME) -SIZE = $(AVR_TOOLS_PATH)/$(SIZE_NAME) -NM = $(AVR_TOOLS_PATH)/$(NM_NAME) -REMOVE = rm -rf -MV = mv -f -CAT = cat -ECHO = printf -MKDIR = mkdir -p - -# General arguments -USER_LIBS = $(wildcard $(patsubst %,$(USER_LIB_PATH)/%,$(ARDUINO_LIBS))) -USER_LIB_NAMES = $(patsubst $(USER_LIB_PATH)/%,%,$(USER_LIBS)) - -# Let user libraries override system ones. -SYS_LIBS = $(wildcard $(patsubst %,$(ARDUINO_LIB_PATH)/%,$(filter-out $(USER_LIB_NAMES),$(ARDUINO_LIBS)))) -SYS_LIB_NAMES = $(patsubst $(ARDUINO_LIB_PATH)/%,%,$(SYS_LIBS)) - -# Error here if any are missing. -LIBS_NOT_FOUND = $(filter-out $(USER_LIB_NAMES) $(SYS_LIB_NAMES),$(ARDUINO_LIBS)) -ifneq (,$(strip $(LIBS_NOT_FOUND))) - $(error The following libraries specified in ARDUINO_LIBS could not be found (searched USER_LIB_PATH and ARDUINO_LIB_PATH): $(LIBS_NOT_FOUND)) -endif - -SYS_LIBS := $(wildcard $(SYS_LIBS) $(addsuffix /utility,$(SYS_LIBS))) -USER_LIBS := $(wildcard $(USER_LIBS) $(addsuffix /utility,$(USER_LIBS))) -SYS_INCLUDES = $(patsubst %,-I%,$(SYS_LIBS)) -USER_INCLUDES = $(patsubst %,-I%,$(USER_LIBS)) -LIB_C_SRCS = $(wildcard $(patsubst %,%/*.c,$(SYS_LIBS))) -LIB_CPP_SRCS = $(wildcard $(patsubst %,%/*.cpp,$(SYS_LIBS))) -USER_LIB_CPP_SRCS = $(wildcard $(patsubst %,%/*.cpp,$(USER_LIBS))) -USER_LIB_C_SRCS = $(wildcard $(patsubst %,%/*.c,$(USER_LIBS))) -LIB_OBJS = $(patsubst $(ARDUINO_LIB_PATH)/%.c,$(OBJDIR)/libs/%.o,$(LIB_C_SRCS)) \ - $(patsubst $(ARDUINO_LIB_PATH)/%.cpp,$(OBJDIR)/libs/%.o,$(LIB_CPP_SRCS)) -USER_LIB_OBJS = $(patsubst $(USER_LIB_PATH)/%.cpp,$(OBJDIR)/libs/%.o,$(USER_LIB_CPP_SRCS)) \ - $(patsubst $(USER_LIB_PATH)/%.c,$(OBJDIR)/libs/%.o,$(USER_LIB_C_SRCS)) - -# Dependency files -DEPS = $(LOCAL_OBJS:.o=.d) $(LIB_OBJS:.o=.d) $(USER_LIB_OBJS:.o=.d) $(CORE_OBJS:.o=.d) - -# Optimization level for the compiler. -# You can get the list of options at http://www.nongnu.org/avr-libc/user-manual/using_tools.html#gcc_optO -# Also read http://www.nongnu.org/avr-libc/user-manual/FAQ.html#faq_optflags -ifndef OPTIMIZATION_LEVEL - OPTIMIZATION_LEVEL=s - $(call show_config_variable,OPTIMIZATION_LEVEL,[DEFAULT]) -else - $(call show_config_variable,OPTIMIZATION_LEVEL,[USER]) -endif - -ifndef DEBUG_FLAGS - DEBUG_FLAGS = -O0 -g -endif - -# SoftwareSerial requires -Os (some delays are tuned for this optimization level) -%SoftwareSerial.o : OPTIMIZATION_FLAGS = -Os - -ifndef MCU_FLAG_NAME - MCU_FLAG_NAME = mmcu - $(call show_config_variable,MCU_FLAG_NAME,[DEFAULT]) -else - $(call show_config_variable,MCU_FLAG_NAME,[USER]) -endif - -# Using += instead of =, so that CPPFLAGS can be set per sketch level -CPPFLAGS += -$(MCU_FLAG_NAME)=$(MCU) -DF_CPU=$(F_CPU) -DARDUINO=$(ARDUINO_VERSION) \ - -I. -I$(ARDUINO_CORE_PATH) -I$(ARDUINO_VAR_PATH)/$(VARIANT) \ - $(SYS_INCLUDES) $(USER_INCLUDES) -Wall -ffunction-sections \ - -fdata-sections - -ifdef DEBUG -OPTIMIZATION_FLAGS= $(DEBUG_FLAGS) -else -OPTIMIZATION_FLAGS = -O$(OPTIMIZATION_LEVEL) -endif - -CPPFLAGS += $(OPTIMIZATION_FLAGS) - -# USB IDs for the Caterina devices like leonardo or micro -ifneq ($(CATERINA),) - CPPFLAGS += -DUSB_VID=$(USB_VID) -DUSB_PID=$(USB_PID) -endif - -ifndef CFLAGS_STD - CFLAGS_STD = -std=gnu99 - $(call show_config_variable,CFLAGS_STD,[DEFAULT]) -else - $(call show_config_variable,CFLAGS_STD,[USER]) -endif - -CFLAGS += $(EXTRA_FLAGS) $(EXTRA_CFLAGS) -CXXFLAGS += -fno-exceptions $(EXTRA_FLAGS) $(EXTRA_CXXFLAGS) -ASFLAGS += -x assembler-with-cpp -LDFLAGS += -$(MCU_FLAG_NAME)=$(MCU) -Wl,--gc-sections -O$(OPTIMIZATION_LEVEL) $(EXTRA_FLAGS) $(EXTRA_CXXFLAGS) $(EXTRA_LDFLAGS) -SIZEFLAGS ?= --mcu=$(MCU) -C - -# for backwards compatibility, grab ARDUINO_PORT if the user has it set -MONITOR_PORT ?= $(ARDUINO_PORT) - -# Returns the Arduino port (first wildcard expansion) if it exists, otherwise it errors. -get_monitor_port = $(if $(wildcard $(MONITOR_PORT)),$(firstword $(wildcard $(MONITOR_PORT))),$(error Arduino port $(MONITOR_PORT) not found!)) - -# Returns the ISP port (first wildcard expansion) if it exists, otherwise it errors. -get_isp_port = $(if $(wildcard $(ISP_PORT)),$(firstword $(wildcard $(ISP_PORT))),$(error ISP port $(ISP_PORT) not found!)) - -# Command for avr_size: do $(call avr_size,elffile,hexfile) -ifneq (,$(findstring AVR,$(shell $(SIZE) --help))) - # We have a patched version of binutils that mentions AVR - pass the MCU - # and the elf to get nice output. - avr_size = $(SIZE) $(SIZEFLAGS) --format=avr $(1) - $(call show_config_info,Size utility: AVR-aware for enhanced output,[AUTODETECTED]) -else - # We have a plain-old binutils version - just give it the hex. - avr_size = $(SIZE) $(2) - $(call show_config_info,Size utility: Basic (not AVR-aware),[AUTODETECTED]) -endif - -ifneq (,$(strip $(ARDUINO_LIBS))) - $(call arduino_output,-) - $(call show_config_info,ARDUINO_LIBS =) -endif - -ifneq (,$(strip $(USER_LIB_NAMES))) - $(foreach lib,$(USER_LIB_NAMES),$(call show_config_info, $(lib),[USER])) -endif - -ifneq (,$(strip $(SYS_LIB_NAMES))) - $(foreach lib,$(SYS_LIB_NAMES),$(call show_config_info, $(lib),[SYSTEM])) -endif - -# either calculate parent dir from arduino dir, or user-defined path -ifndef BOOTLOADER_PARENT - BOOTLOADER_PARENT = $(ARDUINO_DIR)/hardware/arduino/bootloaders - $(call show_config_variable,BOOTLOADER_PARENT,[COMPUTED],(from ARDUINO_DIR)) -else - $(call show_config_variable,BOOTLOADER_PARENT,[USER]) -endif - -# end of config output -$(call show_separator) - -# Implicit rules for building everything (needed to get everything in -# the right directory) -# -# Rather than mess around with VPATH there are quasi-duplicate rules -# here for building e.g. a system C++ file and a local C++ -# file. Besides making things simpler now, this would also make it -# easy to change the build options in future - -# library sources -$(OBJDIR)/libs/%.o: $(ARDUINO_LIB_PATH)/%.c - @$(MKDIR) $(dir $@) - $(CC) -MMD -c $(CPPFLAGS) $(CFLAGS) $< -o $@ - -$(OBJDIR)/libs/%.o: $(ARDUINO_LIB_PATH)/%.cpp - @$(MKDIR) $(dir $@) - $(CC) -MMD -c $(CPPFLAGS) $(CXXFLAGS) $< -o $@ - -$(OBJDIR)/libs/%.o: $(USER_LIB_PATH)/%.cpp - @$(MKDIR) $(dir $@) - $(CC) -MMD -c $(CPPFLAGS) $(CFLAGS) $< -o $@ - -$(OBJDIR)/libs/%.o: $(USER_LIB_PATH)/%.c - @$(MKDIR) $(dir $@) - $(CC) -MMD -c $(CPPFLAGS) $(CFLAGS) $< -o $@ - -ifdef COMMON_DEPS - COMMON_DEPS := $(COMMON_DEPS) $(MAKEFILE_LIST) -else - COMMON_DEPS := $(MAKEFILE_LIST) -endif - -# normal local sources -$(OBJDIR)/%.o: %.c $(COMMON_DEPS) | $(OBJDIR) - @$(MKDIR) $(dir $@) - $(CC) -MMD -c $(CPPFLAGS) $(CFLAGS) $< -o $@ - -$(OBJDIR)/%.o: %.cc $(COMMON_DEPS) | $(OBJDIR) - @$(MKDIR) $(dir $@) - $(CXX) -MMD -c $(CPPFLAGS) $(CXXFLAGS) $< -o $@ - -$(OBJDIR)/%.o: %.cpp $(COMMON_DEPS) | $(OBJDIR) - @$(MKDIR) $(dir $@) - $(CXX) -MMD -c $(CPPFLAGS) $(CXXFLAGS) $< -o $@ - -$(OBJDIR)/%.o: %.S $(COMMON_DEPS) | $(OBJDIR) - @$(MKDIR) $(dir $@) - $(CC) -MMD -c $(CPPFLAGS) $(ASFLAGS) $< -o $@ - -$(OBJDIR)/%.o: %.s $(COMMON_DEPS) | $(OBJDIR) - @$(MKDIR) $(dir $@) - $(CC) -c $(CPPFLAGS) $(ASFLAGS) $< -o $@ - -# the pde -> o file -$(OBJDIR)/%.o: %.pde $(COMMON_DEPS) | $(OBJDIR) - @$(MKDIR) $(dir $@) - $(CXX) -x c++ -include $(ARDUINO_HEADER) -MMD -c $(CPPFLAGS) $(CXXFLAGS) $< -o $@ - -# the ino -> o file -$(OBJDIR)/%.o: %.ino $(COMMON_DEPS) | $(OBJDIR) - @$(MKDIR) $(dir $@) - $(CXX) -x c++ -include $(ARDUINO_HEADER) -MMD -c $(CPPFLAGS) $(CXXFLAGS) $< -o $@ - -# generated assembly -$(OBJDIR)/%.s: %.pde $(COMMON_DEPS) | $(OBJDIR) - @$(MKDIR) $(dir $@) - $(CXX) -x c++ -include $(ARDUINO_HEADER) -MMD -S -fverbose-asm $(CPPFLAGS) $(CXXFLAGS) $< -o $@ - -$(OBJDIR)/%.s: %.ino $(COMMON_DEPS) | $(OBJDIR) - @$(MKDIR) $(dir $@) - $(CXX) -x c++ -include $(ARDUINO_HEADER) -MMD -S -fverbose-asm $(CPPFLAGS) $(CXXFLAGS) $< -o $@ - -#$(OBJDIR)/%.lst: $(OBJDIR)/%.s -# $(AS) -$(MCU_FLAG_NAME)=$(MCU) -alhnd $< > $@ - -# core files -$(OBJDIR)/%.o: $(ARDUINO_CORE_PATH)/%.c $(COMMON_DEPS) | $(OBJDIR) - @$(MKDIR) $(dir $@) - $(CC) -MMD -c $(CPPFLAGS) $(CFLAGS) $< -o $@ - -$(OBJDIR)/%.o: $(ARDUINO_CORE_PATH)/%.cpp $(COMMON_DEPS) | $(OBJDIR) - @$(MKDIR) $(dir $@) - $(CXX) -MMD -c $(CPPFLAGS) $(CXXFLAGS) $< -o $@ - -$(OBJDIR)/%.o: $(ARDUINO_CORE_PATH)/%.S $(COMMON_DEPS) | $(OBJDIR) - @$(MKDIR) $(dir $@) - $(CC) -MMD -c $(CPPFLAGS) $(ASFLAGS) $< -o $@ - -# various object conversions -$(OBJDIR)/%.hex: $(OBJDIR)/%.elf $(COMMON_DEPS) - @$(MKDIR) $(dir $@) - $(OBJCOPY) -O ihex -R .eeprom $< $@ - @$(ECHO) '\n' - $(call avr_size,$<,$@) -ifneq ($(strip $(HEX_MAXIMUM_SIZE)),) - @if [ `$(SIZE) $@ | awk 'FNR == 2 {print $$2}'` -le $(HEX_MAXIMUM_SIZE) ]; then touch $@.sizeok; fi -else - @$(ECHO) "Maximum flash memory of $(BOARD_TAG) is not specified. Make sure the size of $@ is less than $(BOARD_TAG)\'s flash memory" - @touch $@.sizeok -endif - -$(OBJDIR)/%.eep: $(OBJDIR)/%.elf $(COMMON_DEPS) - @$(MKDIR) $(dir $@) - -$(OBJCOPY) -j .eeprom --set-section-flags=.eeprom="alloc,load" \ - --change-section-lma .eeprom=0 -O ihex $< $@ - -$(OBJDIR)/%.lss: $(OBJDIR)/%.elf $(COMMON_DEPS) - @$(MKDIR) $(dir $@) - $(OBJDUMP) -h --source --demangle --wide $< > $@ - -$(OBJDIR)/%.sym: $(OBJDIR)/%.elf $(COMMON_DEPS) - @$(MKDIR) $(dir $@) - $(NM) --size-sort --demangle --reverse-sort --line-numbers $< > $@ - -######################################################################## -# Avrdude - -# If avrdude is installed separately, it can find its own config file -ifndef AVRDUDE - AVRDUDE = $(AVR_TOOLS_PATH)/avrdude -endif - -# Default avrdude options -# -V Do not verify -# -q - suppress progress output -# -D - Disable auto erase for flash memory -# (-D is needed for Mega boards. See https://github.com/sudar/Arduino-Makefile/issues/114#issuecomment-25011005) -ifndef AVRDUDE_OPTS - AVRDUDE_OPTS = -q -V -D -endif - -AVRDUDE_COM_OPTS = $(AVRDUDE_OPTS) -p $(MCU) -ifdef AVRDUDE_CONF - AVRDUDE_COM_OPTS += -C $(AVRDUDE_CONF) -endif - -AVRDUDE_ARD_OPTS = -c $(AVRDUDE_ARD_PROGRAMMER) -b $(AVRDUDE_ARD_BAUDRATE) -P $(call get_monitor_port) - -ifndef ISP_PROG - ifneq ($(strip $(AVRDUDE_ARD_PROGRAMMER)),) - ISP_PROG = $(AVRDUDE_ARD_PROGRAMMER) - else - ISP_PROG = stk500v1 - endif -endif - -ifndef AVRDUDE_ISP_BAUDRATE - ifneq ($(strip $(AVRDUDE_ARD_BAUDRATE)),) - AVRDUDE_ISP_BAUDRATE = $(AVRDUDE_ARD_BAUDRATE) - else - AVRDUDE_ISP_BAUDRATE = 19200 - endif -endif - -# Fuse settings copied from Arduino IDE. -# https://github.com/arduino/Arduino/blob/master/app/src/processing/app/debug/AvrdudeUploader.java#L254 - -# Pre fuse settings -ifndef AVRDUDE_ISP_FUSES_PRE - ifneq ($(strip $(ISP_LOCK_FUSE_PRE)),) - AVRDUDE_ISP_FUSES_PRE += -U lock:w:$(ISP_LOCK_FUSE_PRE):m - endif - - ifneq ($(strip $(ISP_EXT_FUSE)),) - AVRDUDE_ISP_FUSES_PRE += -U efuse:w:$(ISP_EXT_FUSE):m - endif - - ifneq ($(strip $(ISP_HIGH_FUSE)),) - AVRDUDE_ISP_FUSES_PRE += -U hfuse:w:$(ISP_HIGH_FUSE):m - endif - - ifneq ($(strip $(ISP_LOW_FUSE)),) - AVRDUDE_ISP_FUSES_PRE += -U lfuse:w:$(ISP_LOW_FUSE):m - endif -endif - -# Bootloader file settings -ifndef AVRDUDE_ISP_BURN_BOOTLOADER - ifneq ($(strip $(BOOTLOADER_PATH)),) - ifneq ($(strip $(BOOTLOADER_FILE)),) - AVRDUDE_ISP_BURN_BOOTLOADER += -U flash:w:$(BOOTLOADER_PARENT)/$(BOOTLOADER_PATH)/$(BOOTLOADER_FILE):i - endif - endif -endif - -# Post fuse settings -ifndef AVRDUDE_ISP_FUSES_POST - ifneq ($(strip $(ISP_LOCK_FUSE_POST)),) - AVRDUDE_ISP_FUSES_POST += -U lock:w:$(ISP_LOCK_FUSE_POST):m - endif -endif - -AVRDUDE_ISP_OPTS = -c $(ISP_PROG) -b $(AVRDUDE_ISP_BAUDRATE) - -ifneq ($(strip $(ISP_PROG)),$(filter $(ISP_PROG), usbasp usbtiny)) - AVRDUDE_ISP_OPTS += -P $(call get_isp_port) -endif - -ifndef ISP_EEPROM - ISP_EEPROM = 0 -endif - -AVRDUDE_UPLOAD_HEX = -U flash:w:$(TARGET_HEX):i -AVRDUDE_UPLOAD_EEP = -U eeprom:w:$(TARGET_EEP):i -AVRDUDE_ISPLOAD_OPTS = $(AVRDUDE_UPLOAD_HEX) - -ifneq ($(ISP_EEPROM), 0) - AVRDUDE_ISPLOAD_OPTS += $(AVRDUDE_UPLOAD_EEP) -endif - -######################################################################## -# Explicit targets start here - -all: $(TARGET_EEP) $(TARGET_HEX) - -# Rule to create $(OBJDIR) automatically. All rules with recipes that -# create a file within it, but do not already depend on a file within it -# should depend on this rule. They should use a "order-only -# prerequisite" (e.g., put "| $(OBJDIR)" at the end of the prerequisite -# list) to prevent remaking the target when any file in the directory -# changes. -$(OBJDIR): - $(MKDIR) $(OBJDIR) - -$(TARGET_ELF): $(LOCAL_OBJS) $(CORE_LIB) $(OTHER_OBJS) - $(CC) $(LDFLAGS) -o $@ $(LOCAL_OBJS) $(CORE_LIB) $(OTHER_OBJS) -lc -lm - -$(CORE_LIB): $(CORE_OBJS) $(LIB_OBJS) $(USER_LIB_OBJS) - $(AR) rcs $@ $(CORE_OBJS) $(LIB_OBJS) $(USER_LIB_OBJS) - -error_on_caterina: - $(ERROR_ON_CATERINA) - -# Use submake so we can guarantee the reset happens -# before the upload, even with make -j -upload: $(TARGET_HEX) verify_size - $(MAKE) reset - $(MAKE) do_upload - -raw_upload: $(TARGET_HEX) verify_size - $(MAKE) error_on_caterina - $(MAKE) do_upload - -do_upload: - $(AVRDUDE) $(AVRDUDE_COM_OPTS) $(AVRDUDE_ARD_OPTS) \ - $(AVRDUDE_UPLOAD_HEX) - -do_eeprom: $(TARGET_EEP) $(TARGET_HEX) - $(AVRDUDE) $(AVRDUDE_COM_OPTS) $(AVRDUDE_ARD_OPTS) \ - $(AVRDUDE_UPLOAD_EEP) - -eeprom: $(TARGET_HEX) verify_size - $(MAKE) reset - $(MAKE) do_eeprom - -raw_eeprom: $(TARGET_HEX) verify_size - $(MAKE) error_on_caterina - $(MAKE) do_eeprom - -reset: - $(call arduino_output,Resetting Arduino...) - $(RESET_CMD) - -# stty on MacOS likes -F, but on Debian it likes -f redirecting -# stdin/out appears to work but generates a spurious error on MacOS at -# least. Perhaps it would be better to just do it in perl ? -reset_stty: - for STTYF in 'stty -F' 'stty --file' 'stty -f' 'stty <' ; \ - do $$STTYF /dev/tty >/dev/null 2>&1 && break ; \ - done ; \ - $$STTYF $(call get_monitor_port) hupcl ; \ - (sleep 0.1 2>/dev/null || sleep 1) ; \ - $$STTYF $(call get_monitor_port) -hupcl - -ispload: $(TARGET_EEP) $(TARGET_HEX) verify_size - $(AVRDUDE) $(AVRDUDE_COM_OPTS) $(AVRDUDE_ISP_OPTS) \ - $(AVRDUDE_ISPLOAD_OPTS) - -burn_bootloader: -ifneq ($(strip $(AVRDUDE_ISP_FUSES_PRE)),) - $(AVRDUDE) $(AVRDUDE_COM_OPTS) $(AVRDUDE_ISP_OPTS) -e $(AVRDUDE_ISP_FUSES_PRE) -endif -ifneq ($(strip $(AVRDUDE_ISP_BURN_BOOTLOADER)),) - $(AVRDUDE) $(AVRDUDE_COM_OPTS) $(AVRDUDE_ISP_OPTS) $(AVRDUDE_ISP_BURN_BOOTLOADER) -endif -ifneq ($(strip $(AVRDUDE_ISP_FUSES_POST)),) - $(AVRDUDE) $(AVRDUDE_COM_OPTS) $(AVRDUDE_ISP_OPTS) $(AVRDUDE_ISP_FUSES_POST) -endif - -set_fuses: -ifneq ($(strip $(AVRDUDE_ISP_FUSES_PRE)),) - $(AVRDUDE) $(AVRDUDE_COM_OPTS) $(AVRDUDE_ISP_OPTS) -e $(AVRDUDE_ISP_FUSES_PRE) -endif -ifneq ($(strip $(AVRDUDE_ISP_FUSES_POST)),) - $(AVRDUDE) $(AVRDUDE_COM_OPTS) $(AVRDUDE_ISP_OPTS) $(AVRDUDE_ISP_FUSES_POST) -endif - -clean: - $(REMOVE) $(LOCAL_OBJS) $(CORE_OBJS) $(LIB_OBJS) $(CORE_LIB) $(TARGETS) $(DEPS) $(USER_LIB_OBJS) ${OBJDIR} - -size: $(TARGET_HEX) - $(call avr_size,$(TARGET_ELF),$(TARGET_HEX)) - -show_boards: - @cat $(BOARDS_TXT) | grep -E "^[[:alnum:]]" | cut -d . -f 1 | uniq - -monitor: - $(MONITOR_CMD) $(call get_monitor_port) $(MONITOR_BAUDRATE) - -disasm: $(OBJDIR)/$(TARGET).lss - @$(ECHO) "The compiled ELF file has been disassembled to $(OBJDIR)/$(TARGET).lss" - -symbol_sizes: $(OBJDIR)/$(TARGET).sym - @$(ECHO) "A symbol listing sorted by their size have been dumped to $(OBJDIR)/$(TARGET).sym" - -verify_size: -ifeq ($(strip $(HEX_MAXIMUM_SIZE)),) - @$(ECHO) "\nMaximum flash memory of $(BOARD_TAG) is not specified. Make sure the size of $(TARGET_HEX) is less than $(BOARD_TAG)\'s flash memory\n\n" -endif - @if [ ! -f $(TARGET_HEX).sizeok ]; then echo >&2 "\nThe size of the compiled binary file is greater than the $(BOARD_TAG)'s flash memory. \ -See http://www.arduino.cc/en/Guide/Troubleshooting#size for tips on reducing it."; false; fi - -generate_assembly: $(OBJDIR)/$(TARGET).s - @$(ECHO) "Compiler-generated assembly for the main input source has been dumped to $(OBJDIR)/$(TARGET).s" - -generated_assembly: generate_assembly - @$(ECHO) "\"generated_assembly\" target is deprecated. Use \"generate_assembly\" target instead" - -help: - @$(ECHO) "\nAvailable targets:\n\ - make - no upload\n\ - make upload - upload\n\ - make clean - remove all our dependencies\n\ - make depends - update dependencies\n\ - make reset - reset the Arduino by tickling DTR on the serial port\n\ - make raw_upload - upload without first resetting\n\ - make show_boards - list all the boards defined in boards.txt\n\ - make monitor - connect to the Arduino's serial port\n\ - make size - show the size of the compiled output (relative to\n\ - resources, if you have a patched avr-size)\n\ - make disasm - generate a .lss file in build-cli that contains\n\ - disassembly of the compiled file interspersed\n\ - with your original source code.\n\ - make verify_size - Verify that the size of the final file is less than\n\ - the capacity of the micro controller.\n\ - make eeprom - upload the eep file\n\ - make raw_eeprom - upload the eep file without first resetting\n\ - make burn_bootloader - burn bootloader and fuses\n\ - make set_fuses - set fuses without burning bootloader\n\ - make help - show this help\n\ -" - @$(ECHO) "Please refer to $(ARDMK_FILE) for more details.\n" - -.PHONY: all upload raw_upload raw_eeprom error_on_caterina reset reset_stty ispload \ - clean depends size show_boards monitor disasm symbol_sizes generated_assembly \ - generate_assembly verify_size burn_bootloader help - -# added - in the beginning, so that we don't get an error if the file is not present --include $(DEPS) diff --git a/arduino-mk/Common.mk b/arduino-mk/Common.mk deleted file mode 100644 index a94c37f..0000000 --- a/arduino-mk/Common.mk +++ /dev/null @@ -1,38 +0,0 @@ -# Useful functions -# Returns the first argument (typically a directory), if the file or directory -# named by concatenating the first and optionally second argument -# (directory and optional filename) exists -dir_if_exists = $(if $(wildcard $(1)$(2)),$(1)) - -# For message printing: pad the right side of the first argument with spaces to -# the number of bytes indicated by the second argument. -space_pad_to = $(shell echo $(1) " " | head -c$(2)) - -# Call with some text, and a prefix tag if desired (like [AUTODETECTED]), -show_config_info = $(call arduino_output,- $(call space_pad_to,$(2),20) $(1)) - -# Call with the name of the variable, a prefix tag if desired (like [AUTODETECTED]), -# and an explanation if desired (like (found in $$PATH) -show_config_variable = $(call show_config_info,$(1) = $($(1)) $(3),$(2)) - -# Just a nice simple visual separator -show_separator = $(call arduino_output,-------------------------) - -$(call show_separator) -$(call arduino_output,Arduino.mk Configuration:) - -######################################################################## -# -# Detect OS -ifeq ($(OS),Windows_NT) - CURRENT_OS = WINDOWS -else - UNAME_S := $(shell uname -s) - ifeq ($(UNAME_S),Linux) - CURRENT_OS = LINUX - endif - ifeq ($(UNAME_S),Darwin) - CURRENT_OS = MAC - endif -endif -$(call show_config_variable,CURRENT_OS,[AUTODETECTED]) diff --git a/arduino-mk/chipKIT.mk b/arduino-mk/chipKIT.mk deleted file mode 100644 index 2d9abb4..0000000 --- a/arduino-mk/chipKIT.mk +++ /dev/null @@ -1,113 +0,0 @@ -# -# chipKIT extensions for Arduino Makefile -# System part (i.e. project independent) -# -# Copyright (C) 2011, 2012, 2013 Christopher Peplin -# , based on work that is Copyright Martin -# Oldfield -# -# This file is free software; you can redistribute it and/or modify it -# under the terms of the GNU Lesser General Public License as -# published by the Free Software Foundation; either version 2.1 of the -# License, or (at your option) any later version. -# -# Modified by John Wallbank for Visual Studio -# -# Development changes, John Wallbank, -# -# - made inclusion of WProgram.h optional so that -# including it in the source doesn't mess up compile error line numbers -# - parameterised the routine used to reset the serial port -# - -######################################################################## -# Makefile distribution path -# - -# The show_config_variable is unavailable before we include the common makefile, -# so we defer logging the ARDMK_DIR info until it happens in Arduino.mk -ifndef ARDMK_DIR - # presume it's a level above the path to our own file - ARDMK_DIR := $(realpath $(dir $(realpath $(lastword $(MAKEFILE_LIST))))/..) -endif - -ifndef ARDMK_PATH - ARDMK_PATH = $(ARDMK_DIR)/bin -endif - -ifneq ($(wildcard $(ARDMK_DIR)/arduino-mk/Common.mk),) - # git checkout - include $(ARDMK_DIR)/arduino-mk/Common.mk -else - ifneq ($(wildcard $(ARDMK_DIR)/Common.mk),) - # package install - include $(ARDMK_DIR)/Common.mk - endif -endif - -ifndef MPIDE_DIR - AUTO_MPIDE_DIR := $(firstword \ - $(call dir_if_exists,/usr/share/mpide) \ - $(call dir_if_exists,/Applications/Mpide.app/Contents/Resources/Java) ) - ifdef AUTO_MPIDE_DIR - MPIDE_DIR = $(AUTO_MPIDE_DIR) - $(call show_config_variable,MPIDE_DIR,[autodetected]) - else - echo $(error "mpide_dir is not defined") - endif -else - $(call show_config_variable,MPIDE_DIR,[USER]) -endif - -ifndef MPIDE_PREFERENCES_PATH - AUTO_MPIDE_PREFERENCES_PATH := $(firstword \ - $(call dir_if_exists,$(HOME)/.mpide/preferences.txt) \ - $(call dir_if_exists,$(HOME)/Library/Mpide/preferences.txt) ) - ifdef AUTO_MPIDE_PREFERENCES_PATH - MPIDE_PREFERENCES_PATH = $(AUTO_MPIDE_PREFERENCES_PATH) - $(call show_config_variable,MPIDE_PREFERENCES_PATH,[autodetected]) - endif -endif - - -AVR_TOOLS_DIR = $(ARDUINO_DIR)/hardware/pic32/compiler/pic32-tools - -# The same as in Arduino, the Linux distribution contains avrdude and -# avrdude.conf in a different location. -ifeq ($(CURRENT_OS),LINUX) - AVRDUDE_DIR = $(ARDUINO_DIR)/hardware/tools - AVRDUDE = $(AVRDUDE_DIR)/avrdude - AVRDUDE_CONF = $(AVRDUDE_DIR)/avrdude.conf -else - AVRDUDE_DIR = $(ARDUINO_DIR)/hardware/tools/avr - AVRDUDE = $(AVRDUDE_DIR)/bin/avrdude - AVRDUDE_CONF = $(AVRDUDE_DIR)/etc/avrdude.conf -endif - -ALTERNATE_CORE = pic32 -ALTERNATE_CORE_PATH = $(MPIDE_DIR)/hardware/pic32 -ARDUINO_CORE_PATH = $(ALTERNATE_CORE_PATH)/cores/$(ALTERNATE_CORE) -ARDUINO_PREFERENCES_PATH = $(MPIDE_PREFERENCES_PATH) -ARDUINO_DIR = $(MPIDE_DIR) - -CORE_AS_SRCS = $(ARDUINO_CORE_PATH)/vector_table.S - -ARDUINO_VERSION = 23 - -CC_NAME = pic32-gcc -CXX_NAME = pic32-g++ -AR_NAME = pic32-ar -OBJDUMP_NAME = pic32-objdump -OBJCOPY_NAME = pic32-objcopy -SIZE_NAME = pic32-size - -LDSCRIPT = $(call PARSE_BOARD,$(BOARD_TAG),ldscript) -LDSCRIPT_FILE = $(ARDUINO_CORE_PATH)/$(LDSCRIPT) - -MCU_FLAG_NAME=mprocessor -LDFLAGS += -T$(ARDUINO_CORE_PATH)/$(LDSCRIPT) -LDFLAGS += -T$(ARDUINO_CORE_PATH)/chipKIT-application-COMMON.ld -CPPFLAGS += -mno-smart-io -fno-short-double -CFLAGS_STD = - -include $(ARDMK_DIR)/arduino-mk/Arduino.mk diff --git a/arduino-mk/licence.txt b/arduino-mk/licence.txt deleted file mode 100644 index 4362b49..0000000 --- a/arduino-mk/licence.txt +++ /dev/null @@ -1,502 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 2.1, February 1999 - - Copyright (C) 1991, 1999 Free Software Foundation, Inc. - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - -[This is the first released version of the Lesser GPL. It also counts - as the successor of the GNU Library Public License, version 2, hence - the version number 2.1.] - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -Licenses are intended to guarantee your freedom to share and change -free software--to make sure the software is free for all its users. - - This license, the Lesser General Public License, applies to some -specially designated software packages--typically libraries--of the -Free Software Foundation and other authors who decide to use it. You -can use it too, but we suggest you first think carefully about whether -this license or the ordinary General Public License is the better -strategy to use in any particular case, based on the explanations below. - - When we speak of free software, we are referring to freedom of use, -not price. Our General Public Licenses are designed to make sure that -you have the freedom to distribute copies of free software (and charge -for this service if you wish); that you receive source code or can get -it if you want it; that you can change the software and use pieces of -it in new free programs; and that you are informed that you can do -these things. - - To protect your rights, we need to make restrictions that forbid -distributors to deny you these rights or to ask you to surrender these -rights. These restrictions translate to certain responsibilities for -you if you distribute copies of the library or if you modify it. - - For example, if you distribute copies of the library, whether gratis -or for a fee, you must give the recipients all the rights that we gave -you. You must make sure that they, too, receive or can get the source -code. If you link other code with the library, you must provide -complete object files to the recipients, so that they can relink them -with the library after making changes to the library and recompiling -it. And you must show them these terms so they know their rights. - - We protect your rights with a two-step method: (1) we copyright the -library, and (2) we offer you this license, which gives you legal -permission to copy, distribute and/or modify the library. - - To protect each distributor, we want to make it very clear that -there is no warranty for the free library. Also, if the library is -modified by someone else and passed on, the recipients should know -that what they have is not the original version, so that the original -author's reputation will not be affected by problems that might be -introduced by others. - - Finally, software patents pose a constant threat to the existence of -any free program. We wish to make sure that a company cannot -effectively restrict the users of a free program by obtaining a -restrictive license from a patent holder. Therefore, we insist that -any patent license obtained for a version of the library must be -consistent with the full freedom of use specified in this license. - - Most GNU software, including some libraries, is covered by the -ordinary GNU General Public License. This license, the GNU Lesser -General Public License, applies to certain designated libraries, and -is quite different from the ordinary General Public License. We use -this license for certain libraries in order to permit linking those -libraries into non-free programs. - - When a program is linked with a library, whether statically or using -a shared library, the combination of the two is legally speaking a -combined work, a derivative of the original library. The ordinary -General Public License therefore permits such linking only if the -entire combination fits its criteria of freedom. The Lesser General -Public License permits more lax criteria for linking other code with -the library. - - We call this license the "Lesser" General Public License because it -does Less to protect the user's freedom than the ordinary General -Public License. It also provides other free software developers Less -of an advantage over competing non-free programs. These disadvantages -are the reason we use the ordinary General Public License for many -libraries. However, the Lesser license provides advantages in certain -special circumstances. - - For example, on rare occasions, there may be a special need to -encourage the widest possible use of a certain library, so that it becomes -a de-facto standard. To achieve this, non-free programs must be -allowed to use the library. A more frequent case is that a free -library does the same job as widely used non-free libraries. In this -case, there is little to gain by limiting the free library to free -software only, so we use the Lesser General Public License. - - In other cases, permission to use a particular library in non-free -programs enables a greater number of people to use a large body of -free software. For example, permission to use the GNU C Library in -non-free programs enables many more people to use the whole GNU -operating system, as well as its variant, the GNU/Linux operating -system. - - Although the Lesser General Public License is Less protective of the -users' freedom, it does ensure that the user of a program that is -linked with the Library has the freedom and the wherewithal to run -that program using a modified version of the Library. - - The precise terms and conditions for copying, distribution and -modification follow. Pay close attention to the difference between a -"work based on the library" and a "work that uses the library". The -former contains code derived from the library, whereas the latter must -be combined with the library in order to run. - - GNU LESSER GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License Agreement applies to any software library or other -program which contains a notice placed by the copyright holder or -other authorized party saying it may be distributed under the terms of -this Lesser General Public License (also called "this License"). -Each licensee is addressed as "you". - - A "library" means a collection of software functions and/or data -prepared so as to be conveniently linked with application programs -(which use some of those functions and data) to form executables. - - The "Library", below, refers to any such software library or work -which has been distributed under these terms. A "work based on the -Library" means either the Library or any derivative work under -copyright law: that is to say, a work containing the Library or a -portion of it, either verbatim or with modifications and/or translated -straightforwardly into another language. (Hereinafter, translation is -included without limitation in the term "modification".) - - "Source code" for a work means the preferred form of the work for -making modifications to it. For a library, complete source code means -all the source code for all modules it contains, plus any associated -interface definition files, plus the scripts used to control compilation -and installation of the library. - - Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running a program using the Library is not restricted, and output from -such a program is covered only if its contents constitute a work based -on the Library (independent of the use of the Library in a tool for -writing it). Whether that is true depends on what the Library does -and what the program that uses the Library does. - - 1. You may copy and distribute verbatim copies of the Library's -complete source code as you receive it, in any medium, provided that -you conspicuously and appropriately publish on each copy an -appropriate copyright notice and disclaimer of warranty; keep intact -all the notices that refer to this License and to the absence of any -warranty; and distribute a copy of this License along with the -Library. - - You may charge a fee for the physical act of transferring a copy, -and you may at your option offer warranty protection in exchange for a -fee. - - 2. You may modify your copy or copies of the Library or any portion -of it, thus forming a work based on the Library, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) The modified work must itself be a software library. - - b) You must cause the files modified to carry prominent notices - stating that you changed the files and the date of any change. - - c) You must cause the whole of the work to be licensed at no - charge to all third parties under the terms of this License. - - d) If a facility in the modified Library refers to a function or a - table of data to be supplied by an application program that uses - the facility, other than as an argument passed when the facility - is invoked, then you must make a good faith effort to ensure that, - in the event an application does not supply such function or - table, the facility still operates, and performs whatever part of - its purpose remains meaningful. - - (For example, a function in a library to compute square roots has - a purpose that is entirely well-defined independent of the - application. Therefore, Subsection 2d requires that any - application-supplied function or table used by this function must - be optional: if the application does not supply it, the square - root function must still compute square roots.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Library, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Library, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote -it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Library. - -In addition, mere aggregation of another work not based on the Library -with the Library (or with a work based on the Library) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may opt to apply the terms of the ordinary GNU General Public -License instead of this License to a given copy of the Library. To do -this, you must alter all the notices that refer to this License, so -that they refer to the ordinary GNU General Public License, version 2, -instead of to this License. (If a newer version than version 2 of the -ordinary GNU General Public License has appeared, then you can specify -that version instead if you wish.) Do not make any other change in -these notices. - - Once this change is made in a given copy, it is irreversible for -that copy, so the ordinary GNU General Public License applies to all -subsequent copies and derivative works made from that copy. - - This option is useful when you wish to copy part of the code of -the Library into a program that is not a library. - - 4. You may copy and distribute the Library (or a portion or -derivative of it, under Section 2) in object code or executable form -under the terms of Sections 1 and 2 above provided that you accompany -it with the complete corresponding machine-readable source code, which -must be distributed under the terms of Sections 1 and 2 above on a -medium customarily used for software interchange. - - If distribution of object code is made by offering access to copy -from a designated place, then offering equivalent access to copy the -source code from the same place satisfies the requirement to -distribute the source code, even though third parties are not -compelled to copy the source along with the object code. - - 5. A program that contains no derivative of any portion of the -Library, but is designed to work with the Library by being compiled or -linked with it, is called a "work that uses the Library". Such a -work, in isolation, is not a derivative work of the Library, and -therefore falls outside the scope of this License. - - However, linking a "work that uses the Library" with the Library -creates an executable that is a derivative of the Library (because it -contains portions of the Library), rather than a "work that uses the -library". The executable is therefore covered by this License. -Section 6 states terms for distribution of such executables. - - When a "work that uses the Library" uses material from a header file -that is part of the Library, the object code for the work may be a -derivative work of the Library even though the source code is not. -Whether this is true is especially significant if the work can be -linked without the Library, or if the work is itself a library. The -threshold for this to be true is not precisely defined by law. - - If such an object file uses only numerical parameters, data -structure layouts and accessors, and small macros and small inline -functions (ten lines or less in length), then the use of the object -file is unrestricted, regardless of whether it is legally a derivative -work. (Executables containing this object code plus portions of the -Library will still fall under Section 6.) - - Otherwise, if the work is a derivative of the Library, you may -distribute the object code for the work under the terms of Section 6. -Any executables containing that work also fall under Section 6, -whether or not they are linked directly with the Library itself. - - 6. As an exception to the Sections above, you may also combine or -link a "work that uses the Library" with the Library to produce a -work containing portions of the Library, and distribute that work -under terms of your choice, provided that the terms permit -modification of the work for the customer's own use and reverse -engineering for debugging such modifications. - - You must give prominent notice with each copy of the work that the -Library is used in it and that the Library and its use are covered by -this License. You must supply a copy of this License. If the work -during execution displays copyright notices, you must include the -copyright notice for the Library among them, as well as a reference -directing the user to the copy of this License. Also, you must do one -of these things: - - a) Accompany the work with the complete corresponding - machine-readable source code for the Library including whatever - changes were used in the work (which must be distributed under - Sections 1 and 2 above); and, if the work is an executable linked - with the Library, with the complete machine-readable "work that - uses the Library", as object code and/or source code, so that the - user can modify the Library and then relink to produce a modified - executable containing the modified Library. (It is understood - that the user who changes the contents of definitions files in the - Library will not necessarily be able to recompile the application - to use the modified definitions.) - - b) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (1) uses at run time a - copy of the library already present on the user's computer system, - rather than copying library functions into the executable, and (2) - will operate properly with a modified version of the library, if - the user installs one, as long as the modified version is - interface-compatible with the version that the work was made with. - - c) Accompany the work with a written offer, valid for at - least three years, to give the same user the materials - specified in Subsection 6a, above, for a charge no more - than the cost of performing this distribution. - - d) If distribution of the work is made by offering access to copy - from a designated place, offer equivalent access to copy the above - specified materials from the same place. - - e) Verify that the user has already received a copy of these - materials or that you have already sent this user a copy. - - For an executable, the required form of the "work that uses the -Library" must include any data and utility programs needed for -reproducing the executable from it. However, as a special exception, -the materials to be distributed need not include anything that is -normally distributed (in either source or binary form) with the major -components (compiler, kernel, and so on) of the operating system on -which the executable runs, unless that component itself accompanies -the executable. - - It may happen that this requirement contradicts the license -restrictions of other proprietary libraries that do not normally -accompany the operating system. Such a contradiction means you cannot -use both them and the Library together in an executable that you -distribute. - - 7. You may place library facilities that are a work based on the -Library side-by-side in a single library together with other library -facilities not covered by this License, and distribute such a combined -library, provided that the separate distribution of the work based on -the Library and of the other library facilities is otherwise -permitted, and provided that you do these two things: - - a) Accompany the combined library with a copy of the same work - based on the Library, uncombined with any other library - facilities. This must be distributed under the terms of the - Sections above. - - b) Give prominent notice with the combined library of the fact - that part of it is a work based on the Library, and explaining - where to find the accompanying uncombined form of the same work. - - 8. You may not copy, modify, sublicense, link with, or distribute -the Library except as expressly provided under this License. Any -attempt otherwise to copy, modify, sublicense, link with, or -distribute the Library is void, and will automatically terminate your -rights under this License. However, parties who have received copies, -or rights, from you under this License will not have their licenses -terminated so long as such parties remain in full compliance. - - 9. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Library or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Library (or any work based on the -Library), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Library or works based on it. - - 10. Each time you redistribute the Library (or any work based on the -Library), the recipient automatically receives a license from the -original licensor to copy, distribute, link with or modify the Library -subject to these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties with -this License. - - 11. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Library at all. For example, if a patent -license would not permit royalty-free redistribution of the Library by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Library. - -If any portion of this section is held invalid or unenforceable under any -particular circumstance, the balance of the section is intended to apply, -and the section as a whole is intended to apply in other circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 12. If the distribution and/or use of the Library is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Library under this License may add -an explicit geographical distribution limitation excluding those countries, -so that distribution is permitted only in or among countries not thus -excluded. In such case, this License incorporates the limitation as if -written in the body of this License. - - 13. The Free Software Foundation may publish revised and/or new -versions of the Lesser General Public License from time to time. -Such new versions will be similar in spirit to the present version, -but may differ in detail to address new problems or concerns. - -Each version is given a distinguishing version number. If the Library -specifies a version number of this License which applies to it and -"any later version", you have the option of following the terms and -conditions either of that version or of any later version published by -the Free Software Foundation. If the Library does not specify a -license version number, you may choose any version ever published by -the Free Software Foundation. - - 14. If you wish to incorporate parts of the Library into other free -programs whose distribution conditions are incompatible with these, -write to the author to ask for permission. For software which is -copyrighted by the Free Software Foundation, write to the Free -Software Foundation; we sometimes make exceptions for this. Our -decision will be guided by the two goals of preserving the free status -of all derivatives of our free software and of promoting the sharing -and reuse of software generally. - - NO WARRANTY - - 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO -WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. -EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR -OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY -KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE -LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME -THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN -WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY -AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU -FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR -CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE -LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING -RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A -FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF -SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH -DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Libraries - - If you develop a new library, and you want it to be of the greatest -possible use to the public, we recommend making it free software that -everyone can redistribute and change. You can do so by permitting -redistribution under these terms (or, alternatively, under the terms of the -ordinary General Public License). - - To apply these terms, attach the following notices to the library. It is -safest to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least the -"copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This library is free software; you can redistribute it and/or - modify it under the terms of the GNU Lesser General Public - License as published by the Free Software Foundation; either - version 2.1 of the License, or (at your option) any later version. - - This library is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - Lesser General Public License for more details. - - You should have received a copy of the GNU Lesser General Public - License along with this library; if not, write to the Free Software - Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - -Also add information on how to contact you by electronic and paper mail. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the library, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the - library `Frob' (a library for tweaking knobs) written by James Random Hacker. - - , 1 April 1990 - Ty Coon, President of Vice - -That's all there is to it! diff --git a/chipKIT.mk b/chipKIT.mk new file mode 100644 index 0000000..2d9abb4 --- /dev/null +++ b/chipKIT.mk @@ -0,0 +1,113 @@ +# +# chipKIT extensions for Arduino Makefile +# System part (i.e. project independent) +# +# Copyright (C) 2011, 2012, 2013 Christopher Peplin +# , based on work that is Copyright Martin +# Oldfield +# +# This file is free software; you can redistribute it and/or modify it +# under the terms of the GNU Lesser General Public License as +# published by the Free Software Foundation; either version 2.1 of the +# License, or (at your option) any later version. +# +# Modified by John Wallbank for Visual Studio +# +# Development changes, John Wallbank, +# +# - made inclusion of WProgram.h optional so that +# including it in the source doesn't mess up compile error line numbers +# - parameterised the routine used to reset the serial port +# + +######################################################################## +# Makefile distribution path +# + +# The show_config_variable is unavailable before we include the common makefile, +# so we defer logging the ARDMK_DIR info until it happens in Arduino.mk +ifndef ARDMK_DIR + # presume it's a level above the path to our own file + ARDMK_DIR := $(realpath $(dir $(realpath $(lastword $(MAKEFILE_LIST))))/..) +endif + +ifndef ARDMK_PATH + ARDMK_PATH = $(ARDMK_DIR)/bin +endif + +ifneq ($(wildcard $(ARDMK_DIR)/arduino-mk/Common.mk),) + # git checkout + include $(ARDMK_DIR)/arduino-mk/Common.mk +else + ifneq ($(wildcard $(ARDMK_DIR)/Common.mk),) + # package install + include $(ARDMK_DIR)/Common.mk + endif +endif + +ifndef MPIDE_DIR + AUTO_MPIDE_DIR := $(firstword \ + $(call dir_if_exists,/usr/share/mpide) \ + $(call dir_if_exists,/Applications/Mpide.app/Contents/Resources/Java) ) + ifdef AUTO_MPIDE_DIR + MPIDE_DIR = $(AUTO_MPIDE_DIR) + $(call show_config_variable,MPIDE_DIR,[autodetected]) + else + echo $(error "mpide_dir is not defined") + endif +else + $(call show_config_variable,MPIDE_DIR,[USER]) +endif + +ifndef MPIDE_PREFERENCES_PATH + AUTO_MPIDE_PREFERENCES_PATH := $(firstword \ + $(call dir_if_exists,$(HOME)/.mpide/preferences.txt) \ + $(call dir_if_exists,$(HOME)/Library/Mpide/preferences.txt) ) + ifdef AUTO_MPIDE_PREFERENCES_PATH + MPIDE_PREFERENCES_PATH = $(AUTO_MPIDE_PREFERENCES_PATH) + $(call show_config_variable,MPIDE_PREFERENCES_PATH,[autodetected]) + endif +endif + + +AVR_TOOLS_DIR = $(ARDUINO_DIR)/hardware/pic32/compiler/pic32-tools + +# The same as in Arduino, the Linux distribution contains avrdude and +# avrdude.conf in a different location. +ifeq ($(CURRENT_OS),LINUX) + AVRDUDE_DIR = $(ARDUINO_DIR)/hardware/tools + AVRDUDE = $(AVRDUDE_DIR)/avrdude + AVRDUDE_CONF = $(AVRDUDE_DIR)/avrdude.conf +else + AVRDUDE_DIR = $(ARDUINO_DIR)/hardware/tools/avr + AVRDUDE = $(AVRDUDE_DIR)/bin/avrdude + AVRDUDE_CONF = $(AVRDUDE_DIR)/etc/avrdude.conf +endif + +ALTERNATE_CORE = pic32 +ALTERNATE_CORE_PATH = $(MPIDE_DIR)/hardware/pic32 +ARDUINO_CORE_PATH = $(ALTERNATE_CORE_PATH)/cores/$(ALTERNATE_CORE) +ARDUINO_PREFERENCES_PATH = $(MPIDE_PREFERENCES_PATH) +ARDUINO_DIR = $(MPIDE_DIR) + +CORE_AS_SRCS = $(ARDUINO_CORE_PATH)/vector_table.S + +ARDUINO_VERSION = 23 + +CC_NAME = pic32-gcc +CXX_NAME = pic32-g++ +AR_NAME = pic32-ar +OBJDUMP_NAME = pic32-objdump +OBJCOPY_NAME = pic32-objcopy +SIZE_NAME = pic32-size + +LDSCRIPT = $(call PARSE_BOARD,$(BOARD_TAG),ldscript) +LDSCRIPT_FILE = $(ARDUINO_CORE_PATH)/$(LDSCRIPT) + +MCU_FLAG_NAME=mprocessor +LDFLAGS += -T$(ARDUINO_CORE_PATH)/$(LDSCRIPT) +LDFLAGS += -T$(ARDUINO_CORE_PATH)/chipKIT-application-COMMON.ld +CPPFLAGS += -mno-smart-io -fno-short-double +CFLAGS_STD = + +include $(ARDMK_DIR)/arduino-mk/Arduino.mk diff --git a/licence.txt b/licence.txt new file mode 100644 index 0000000..4362b49 --- /dev/null +++ b/licence.txt @@ -0,0 +1,502 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 2.1, February 1999 + + Copyright (C) 1991, 1999 Free Software Foundation, Inc. + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the Lesser GPL. It also counts + as the successor of the GNU Library Public License, version 2, hence + the version number 2.1.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Lesser General Public License, applies to some +specially designated software packages--typically libraries--of the +Free Software Foundation and other authors who decide to use it. You +can use it too, but we suggest you first think carefully about whether +this license or the ordinary General Public License is the better +strategy to use in any particular case, based on the explanations below. + + When we speak of free software, we are referring to freedom of use, +not price. Our General Public Licenses are designed to make sure that +you have the freedom to distribute copies of free software (and charge +for this service if you wish); that you receive source code or can get +it if you want it; that you can change the software and use pieces of +it in new free programs; and that you are informed that you can do +these things. + + To protect your rights, we need to make restrictions that forbid +distributors to deny you these rights or to ask you to surrender these +rights. These restrictions translate to certain responsibilities for +you if you distribute copies of the library or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link other code with the library, you must provide +complete object files to the recipients, so that they can relink them +with the library after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + We protect your rights with a two-step method: (1) we copyright the +library, and (2) we offer you this license, which gives you legal +permission to copy, distribute and/or modify the library. + + To protect each distributor, we want to make it very clear that +there is no warranty for the free library. Also, if the library is +modified by someone else and passed on, the recipients should know +that what they have is not the original version, so that the original +author's reputation will not be affected by problems that might be +introduced by others. + + Finally, software patents pose a constant threat to the existence of +any free program. We wish to make sure that a company cannot +effectively restrict the users of a free program by obtaining a +restrictive license from a patent holder. Therefore, we insist that +any patent license obtained for a version of the library must be +consistent with the full freedom of use specified in this license. + + Most GNU software, including some libraries, is covered by the +ordinary GNU General Public License. This license, the GNU Lesser +General Public License, applies to certain designated libraries, and +is quite different from the ordinary General Public License. We use +this license for certain libraries in order to permit linking those +libraries into non-free programs. + + When a program is linked with a library, whether statically or using +a shared library, the combination of the two is legally speaking a +combined work, a derivative of the original library. The ordinary +General Public License therefore permits such linking only if the +entire combination fits its criteria of freedom. The Lesser General +Public License permits more lax criteria for linking other code with +the library. + + We call this license the "Lesser" General Public License because it +does Less to protect the user's freedom than the ordinary General +Public License. It also provides other free software developers Less +of an advantage over competing non-free programs. These disadvantages +are the reason we use the ordinary General Public License for many +libraries. However, the Lesser license provides advantages in certain +special circumstances. + + For example, on rare occasions, there may be a special need to +encourage the widest possible use of a certain library, so that it becomes +a de-facto standard. To achieve this, non-free programs must be +allowed to use the library. A more frequent case is that a free +library does the same job as widely used non-free libraries. In this +case, there is little to gain by limiting the free library to free +software only, so we use the Lesser General Public License. + + In other cases, permission to use a particular library in non-free +programs enables a greater number of people to use a large body of +free software. For example, permission to use the GNU C Library in +non-free programs enables many more people to use the whole GNU +operating system, as well as its variant, the GNU/Linux operating +system. + + Although the Lesser General Public License is Less protective of the +users' freedom, it does ensure that the user of a program that is +linked with the Library has the freedom and the wherewithal to run +that program using a modified version of the Library. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, whereas the latter must +be combined with the library in order to run. + + GNU LESSER GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library or other +program which contains a notice placed by the copyright holder or +other authorized party saying it may be distributed under the terms of +this Lesser General Public License (also called "this License"). +Each licensee is addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also combine or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (1) uses at run time a + copy of the library already present on the user's computer system, + rather than copying library functions into the executable, and (2) + will operate properly with a modified version of the library, if + the user installs one, as long as the modified version is + interface-compatible with the version that the work was made with. + + c) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + d) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + e) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the materials to be distributed need not include anything that is +normally distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties with +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Lesser General Public License from time to time. +Such new versions will be similar in spirit to the present version, +but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY +KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU +FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR +CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE +LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING +RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A +FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This library is free software; you can redistribute it and/or + modify it under the terms of the GNU Lesser General Public + License as published by the Free Software Foundation; either + version 2.1 of the License, or (at your option) any later version. + + This library is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + Lesser General Public License for more details. + + You should have received a copy of the GNU Lesser General Public + License along with this library; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! -- cgit v1.2.3