aboutsummaryrefslogtreecommitdiffstats
path: root/tools
diff options
context:
space:
mode:
authorJesse Vincent <jesse@keyboard.io>2017-02-19 17:04:09 -0800
committerJesse Vincent <jesse@keyboard.io>2017-02-19 17:04:09 -0800
commita0e03fa82c999744b8b2d449784f1e14bf8dc21f (patch)
treeedbb8421e1a994a25691f1cdfe488d12d0e26be6 /tools
parent12f774d34c66429c59eb0564f5327d9d148e9ca7 (diff)
downloadModel01-Firmware-a0e03fa82c999744b8b2d449784f1e14bf8dc21f.tar.gz
Model01-Firmware-a0e03fa82c999744b8b2d449784f1e14bf8dc21f.zip
snapshot sketch and infrastructure from the Kaleidoscope example
Diffstat (limited to 'tools')
-rwxr-xr-xtools/kaleidoscope-builder312
-rw-r--r--tools/settings.sh85
2 files changed, 397 insertions, 0 deletions
diff --git a/tools/kaleidoscope-builder b/tools/kaleidoscope-builder
new file mode 100755
index 0000000..97d1188
--- /dev/null
+++ b/tools/kaleidoscope-builder
@@ -0,0 +1,312 @@
+#! /bin/sh
+
+set -e
+
+firmware_size () {
+ ## This is a terrible hack, please don't hurt me. - algernon
+
+ MAX_PROG_SIZE=28672
+
+ output="$($@ | grep "\\(Program\\|Data\\):" | sed -e 's,^, - ,' && echo)"
+
+ PROGSIZE="$(echo "${output}" | grep Program: | cut -d: -f2 | awk '{print $1}')"
+
+ PERCENT="$(echo ${PROGSIZE} ${MAX_PROG_SIZE} | awk "{ printf \"%02.01f\", \$1 / \$2 * 100 }")"
+
+ echo "${output}" | sed -e "s,\(Program:.*\)(\([0-9\.]*%\) Full),\1(${PERCENT}% Full),"
+}
+
+find_sketch () {
+ if [ -e "${SOURCEDIR}/.kaleidoscope-builder.conf" ]; then
+ . "${SOURCEDIR}/.kaleidoscope-builder.conf"
+ fi
+
+ SKETCH="${SKETCH:-${DEFAULT_SKETCH}}"
+ LIBRARY="${LIBRARY:-${SKETCH}}"
+
+ for path in "hardware/keyboardio/avr/libraries/Kaleidoscope-${LIBRARY}/examples/${SKETCH}" \
+ "examples/${LIBRARY}" \
+ "src"; do
+ if [ -f "${path}/${SKETCH}.ino" ]; then
+ echo "${path}"
+ return
+ fi
+ done
+ exit 1
+}
+
+prepare_to_flash () {
+ if [ ! -e "${HEX_FILE_PATH}" ]; then
+ compile
+ fi
+
+ echo "Press ENTER when ready..."
+ read a
+}
+
+flash () {
+ prepare_to_flash
+ reset_device
+ sleep 3s
+ flash_over_usb
+
+}
+
+flash_over_usb () {
+ avrdude -q -q -p${MCU} -cavr109 -D -P ${DEVICE_PORT_BOOTLOADER} -b57600 "-Uflash:w:${HEX_FILE_PATH}:i"
+
+}
+
+program() {
+ prepare_to_flash
+ flash_with_programmer
+}
+
+flash_with_programmer() {
+
+ avrdude -v \
+ -p${MCU} \
+ -cusbtiny \
+ -D \
+ -B 1 \
+ "-Uflash:w:${HEX_FILE_PATH}:i"
+}
+
+hex_with_bootloader () {
+ if [ ! -e "${HEX_FILE_PATH}" ]; then
+ compile
+ fi
+
+ cat ${HEX_FILE_PATH} | awk '/^:00000001FF/ == 0' > ${HEX_FILE_WITH_BOOTLOADER_PATH}
+ echo "Using ${BOOTLOADER_PATH}"
+ ${MD5} ${BOOTLOADER_PATH}
+ cat ${BOOTLOADER_PATH} >> ${HEX_FILE_WITH_BOOTLOADER_PATH}
+ cat <<EOF
+
+Combined firmware and bootloader are now at ${HEX_FILE_WITH_BOOTLOADER_PATH}
+Make sure you have the bootloader version you expect.
+
+And TEST THIS ON REAL HARDWARE BEFORE YOU GIVE IT TO ANYONE
+
+EOF
+}
+
+build () {
+ compile $@
+ size $@
+}
+
+compile () {
+ install -d "${OUTPUT_PATH}"
+
+ echo "Building ${OUTPUT_DIR}/${SKETCH} (${LIB_VERSION}) ..."
+
+ ${compile_HOOKS}
+
+ if [ -d "${ARDUINO_LOCAL_LIB_PATH}/libraries" ]; then
+ local_LIBS="-libraries \"${ARDUINO_LOCAL_LIB_PATH}/libraries\""
+ fi
+
+ ${ARDUINO_BUILDER} \
+ -compile \
+ -hardware "${ARDUINO_PATH}/hardware" \
+ -hardware "${BOARD_HARDWARE_PATH}" \
+ ${ARDUINO_TOOLS_PARAM} \
+ -tools "${ARDUINO_PATH}/tools-builder" \
+ -fqbn "${FQBN}" \
+ ${local_LIBS} \
+ -libraries "${BOARD_HARDWARE_PATH}/.." \
+ -libraries "${ROOT}" \
+ ${EXTRA_BUILDER_ARGS} \
+ -build-path "${BUILD_PATH}" \
+ -ide-version "${ARDUINO_IDE_VERSION}" \
+ -warnings all \
+ ${ARDUINO_VERBOSE} \
+ -prefs "compiler.cpp.extra_flags=-std=c++11 -Woverloaded-virtual -Wno-unused-parameter -Wno-unused-variable -Wno-ignored-qualifiers" \
+ ${ARDUINO_AVR_GCC_PREFIX_PARAM} \
+ "$(find_sketch)/${SKETCH}.ino"
+
+ cp "${BUILD_PATH}/${SKETCH}.ino.hex" "${HEX_FILE_PATH}"
+ cp "${BUILD_PATH}/${SKETCH}.ino.elf" "${ELF_FILE_PATH}"
+ ln -sf "${OUTPUT_FILE_PREFIX}.hex" "${OUTPUT_PATH}/${SKETCH}-latest.hex"
+ ln -sf "${OUTPUT_FILE_PREFIX}.elf" "${OUTPUT_PATH}/${SKETCH}-latest.elf"
+ rm -rf "${BUILD_PATH}"
+}
+
+_find_all () {
+ for plugin in hardware/keyboardio/avr/libraries/Kaleidoscope-*/examples/* \
+ examples/* \
+ src/*.ino; do
+ if [ -d "$(dirname ${plugin})" ] || [ -f "${plugin}" ]; then
+ p="$(basename "${plugin}" .ino)"
+ if [ "${p}" != '*' ]; then
+ echo "${p}"
+ fi
+ fi
+ done | sort
+}
+
+build_all () {
+ plugins="$(_find_all)"
+
+ for plugin in ${plugins}; do
+ export SKETCH="${plugin}"
+ export LIBRARY="${plugin}"
+ $0 ${plugin} build
+ done
+}
+
+size () {
+ if [ ! -e "${HEX_FILE_PATH}" ]; then
+ compile
+ fi
+
+ echo "- Size: firmware/${LIBRARY}/${OUTPUT_FILE_PREFIX}.elf"
+ firmware_size "${AVR_SIZE}" -C --mcu="${MCU}" "${ELF_FILE_PATH}"
+ echo
+}
+
+size_map () {
+ if [ ! -e "${HEX_FILE_PATH}" ]; then
+ compile
+ fi
+
+ "${AVR_NM}" --size-sort -C -r -l "${ELF_FILE_PATH}"
+}
+
+decompile () {
+
+ if [ ! -e "${HEX_FILE_PATH}" ]; then
+ compile
+ fi
+
+ "${AVR_OBJDUMP}" -d "${ELF_FILE_PATH}"
+}
+
+clean () {
+ rm -rf "${OUTPUT_PATH}"
+}
+
+reset_device () {
+ ${RESET_DEVICE}
+}
+
+usage () {
+ cat <<EOF
+Usage: $0 SKETCH commands...
+
+Runs all of the commands in the context of the Sketch.
+
+Available commands:
+
+ help
+ This help screen.
+
+ compile
+ Compiles the sketch.
+
+ size
+ Reports the size of the compiled sketch.
+
+ build
+ Runs compile and report-size.
+
+ clean
+ Cleans up the output directory.
+
+ size-map
+ Displays the size map for the sketch.
+
+ decomple
+ Decompile the sketch.
+
+ reset-device
+ Reset the device.
+
+ flash
+ Flashes the firmware using avrdude.
+
+ build-all
+ Build all Sketches we can find.
+EOF
+}
+
+help () {
+ usage
+}
+
+if [ $# -lt 1 ]; then
+ usage
+ exit 1
+fi
+
+## Parse the command-line
+## - anything that has a =, is an env var
+## - from the remaining stuff, the first one is the Library/Sketch
+## - everything else are commands
+##
+## - if there is only one argument, that's a command
+
+ROOT="$(cd $(dirname $0)/..; pwd)"
+export ROOT
+export SOURCEDIR="$(pwd)"
+
+if [ -e "${HOME}/.kaleidoscope-builder.conf" ]; then
+ . "${HOME}/.kaleidoscope-builder.conf"
+fi
+
+if [ -e "${SOURCEDIR}/.kaleidoscope-builder.conf" ]; then
+ . "${SOURCEDIR}/.kaleidoscope-builder.conf"
+fi
+
+
+. ${ROOT}/tools/settings.sh
+
+
+cmds=""
+
+## Export vars
+for i in $(seq 1 $#); do
+ v="$1"
+ shift
+
+ case "${v}" in
+ *=*)
+ export ${v}
+ ;;
+ *)
+ cmds="${cmds} ${v}"
+ ;;
+ esac
+done
+
+set -- ${cmds}
+
+if [ $# -eq 1 ]; then
+ cmd="$(echo $1 | tr '-' '_')"
+ ${cmd}
+ exit $?
+fi
+
+SKETCH="$1"
+shift
+
+if [ "${SKETCH}" = "default" ]; then
+ SKETCH="${DEFAULT_SKETCH}"
+fi
+
+cmds=""
+
+for i in $(seq 1 $#); do
+ cmds="${cmds} $(echo $1 | tr '-' '_')"
+ shift
+done
+
+LIBRARY="${SKETCH}"
+
+export SKETCH
+export LIBRARY
+
+for cmd in ${cmds}; do
+ ${cmd}
+done
diff --git a/tools/settings.sh b/tools/settings.sh
new file mode 100644
index 0000000..d5b8fdf
--- /dev/null
+++ b/tools/settings.sh
@@ -0,0 +1,85 @@
+## NEEDS: LIBRARY, SKETCH, ROOT, SOURCEDIR
+## Should be included when the current directory is the dir of the Sketch.
+
+case "$0" in
+ */settings.sh)
+ echo "This file must be included, never run directly!" >&2
+ exit 1
+ ;;
+esac
+
+SKETCH="${SKETCH:-${DEFAULT_SKETCH}}"
+LIBRARY="${LIBRARY:-${SKETCH}}"
+
+if [ -z "${SKETCH}" ] || [ -z "${LIBRARY}" ] || [ -z "${ROOT}" ] || [ -z "${SOURCEDIR}" ]; then
+ echo "SKETCH, LIBRARY, SOURCEDIR, and ROOT need to be set before including this file!" >&2
+ exit 1
+fi
+
+BOARD="${BOARD:-model01}"
+MCU="${MCU:-atmega32u4}"
+FQBN="${FQBN:-keyboardio:avr:${BOARD}}"
+
+DEVICE_PORT="$(ls /dev/ttyACM* 2>/dev/null || echo '')"
+DEVICE_PORT_BOOTLOADER="$(ls /dev/ttyACM* 2>/dev/null || echo '')"
+
+RESET_DEVICE="stty -F ${DEVICE_PORT} 1200 hupcl"
+
+ARDUINO_PATH="${ARDUINO_PATH:-/usr/local/arduino}"
+ARDUINO_LOCAL_LIB_PATH="${ARDUINO_LOCAL_LIB_PATH:-${HOME}/Arduino}"
+ARDUINO_TOOLS_PATH="${ARDUINO_TOOLS_PATH:-${ARDUINO_PATH}/hardware/tools}"
+ARDUINO_BUILDER="${ARDUINO_BUILDER:-${ARDUINO_PATH}/arduino-builder}"
+ARDUINO_IDE_VERSION="100607"
+
+BOARD_HARDWARE_PATH="${BOARD_HARDWARE_PATH:-${ARDUINO_LOCAL_LIB_PATH}/hardware}"
+BOOTLOADER_PATH="${BOARD_HARDWARE_PATH}/keyboardio/avr/bootloaders/caterina/Caterina.hex"
+
+AVR_SIZE="${AVR_SIZE:-${ARDUINO_TOOLS_PATH}/avr/bin/avr-size}"
+AVR_NM="${AVR_NM:-${ARDUINO_TOOLS_PATH}/avr/bin/avr-nm}"
+AVR_OBJDUMP="${AVR_OBJDUMP:-${ARDUINO_TOOLS_PATH}/avr/bin/avr-objdump}"
+
+MD5="md5sum"
+
+BUILD_PATH="${BUILD_PATH:-$(mktemp -d 2>/dev/null || mktemp -d -t 'build')}"
+OUTPUT_DIR="${OUTPUT_DIR:-output/${LIBRARY}}"
+OUTPUT_PATH="${OUTPUT_PATH:-${SOURCEDIR}/${OUTPUT_DIR}}"
+
+GIT_VERSION="$(cd $(find_sketch); git describe --abbrev=4 --dirty --always)"
+LIB_VERSION="$(cd $(find_sketch); (grep version= ../../library.properties 2>/dev/null || echo version=0.0.0) | cut -d= -f2)-g${GIT_VERSION}"
+
+OUTPUT_FILE_PREFIX="${SKETCH}-${LIB_VERSION}"
+
+HEX_FILE_PATH="${OUTPUT_PATH}/${OUTPUT_FILE_PREFIX}.hex"
+HEX_FILE_WITH_BOOTLOADER_PATH="${OUTPUT_PATH}/${OUTPUT_FILE_PREFIX}-with-bootloader.hex"
+ELF_FILE_PATH="${OUTPUT_PATH}/${OUTPUT_FILE_PREFIX}.elf"
+
+ARDUINO_TOOLS_PARAM="-tools ${ARDUINO_TOOLS_PATH}"
+if [ -z "${ARDUINO_TOOLS_PATH}" ]; then
+ ARDUINO_TOOLS_PARAM=""
+fi
+
+if [ ! -z "${AVR_GCC_PREFIX}" ]; then
+ ARDUINO_AVR_GCC_PREFIX_PARAM="-prefs \"runtime.tools.avr-gcc.path=${AVR_GCC_PREFIX}\""
+fi
+
+if [ ! -z "${VERBOSE}" ] && [ "${VERBOSE}" -gt 0 ]; then
+ ARDUINO_VERBOSE="-verbose"
+else
+ ARDUINO_VERBOSE="-quiet"
+fi
+
+## Platform-specific overrides
+# Shamelessly stolen from git's Makefile
+uname_S=$(uname -s 2>/dev/null || echo not)
+
+if [ "${uname_S}" = "Darwin" ]; then
+ DEVICE_PORT="$(ls /dev/cu.usbmodemHID?? /dev/cu.usbmodem14*)"
+ DEVICE_PORT_BOOTLOADER="$(ls /dev/cu.usbmodem14*)"
+
+ ARDUINO_PATH="/Applications/Arduino.app/Contents/Java/"
+ ARDUINO_LOCAL_LIB_PATH="${HOME}/Documents/Arduino"
+
+ MD5="md5"
+
+ RESET_DEVICE="stty -f ${DEVICE_PORT} 1200"
+fi