start work on firmware

.github/workflows/cmake.yml

@@ -0,0 +1,65 @@
+# https://github.com/raspberrypi/pico-examples/blob/master/.github/workflows/cmake.yml
+
+name: Firmware
+
+# build for each push and pull request
+on: [push, pull_request]
+
+env:
+  BUILD_TYPE: Release
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: write
+
+    steps:
+      - name: Install dependencies
+        run: sudo apt-get install -y cxxtest build-essential gcc-arm-none-eabi mtools zip
+
+      - name: Checkout repo
+        uses: actions/checkout@v4
+        with:
+          path: repo
+          fetch-depth: 0
+
+      - name: Checkout repo submodules
+        working-directory: ${{github.workspace}}/repo
+        run: git submodule update --init
+
+      - name: Checkout pico-sdk submodules
+        working-directory: ${{github.workspace}}/repo/pico-sdk
+        run: git submodule update --init
+
+      - name: Create Build Environment
+        working-directory: ${{github.workspace}}/repo
+        run:  cmake -E make_directory ${{github.workspace}}/repo/build
+
+      - name: Configure CMake
+        shell: bash
+        working-directory: ${{github.workspace}}/repo/build
+        run: cmake .. -DCMAKE_BUILD_TYPE=$BUILD_TYPE
+
+      - name: Get core count
+        id: core_count
+        run : cat /proc/cpuinfo  | grep processor | wc -l
+
+      - name: Build
+        working-directory: ${{github.workspace}}/repo/build
+        shell: bash
+        run: cmake --build . --config $BUILD_TYPE --parallel $(nproc)
+
+      - name: Upload a Build Artifact
+        uses: actions/upload-artifact@v4.0.0
+        with:
+          name: dispensy.uf2
+          path: ${{github.workspace}}/repo/build/dispensy.uf2
+          if-no-files-found: error
+
+      - name: Upload release files
+        if: startsWith(github.ref, 'refs/tags/')
+        uses: softprops/action-gh-release@v1
+        with:
+          files: ${{github.workspace}}/repo/build/dispensy.uf2

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "docs/svg-pan-zoom"]
 	path = docs/svg-pan-zoom
 	url = https://github.com/WebSVG/svg-pan-zoom
+[submodule "firmware/pico-sdk"]
+	path = firmware/pico-sdk
+	url = https://github.com/raspberrypi/pico-sdk

README.md

@@ -2,6 +2,7 @@
 
 ![PCB](https://github.com/drinkrobotics/dispensy/actions/workflows/kicad.yml/badge.svg)
 ![Docs](https://github.com/drinkrobotics/dispensy/actions/workflows/docs.yml/badge.svg)
+![Firmware](https://github.com/drinkrobotics/dispensy/actions/workflows/cmake.yml/badge.svg)
 
 One day aims to be a new hardware base for the [DrinkRobotics UbaBot](https://www.xythobuz.de/drinkrobotics.html).
 

firmware/.gitignore

@@ -0,0 +1,2 @@
+build
+.cache

firmware/CMakeLists.txt

@@ -0,0 +1,78 @@
+# ----------------------------------------------------------------------------
+# Copyright (c) 2024 Thomas Buck (thomas@xythobuz.de)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# See <http://www.gnu.org/licenses/>.
+# ----------------------------------------------------------------------------
+
+cmake_minimum_required(VERSION 3.5)
+
+# initialize pico-sdk from submodule
+include(pico-sdk/pico_sdk_init.cmake)
+
+project(dispensy C CXX)
+set(CMAKE_C_STANDARD 11)
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
+
+# initialize the Raspberry Pi Pico SDK
+pico_sdk_init()
+
+add_executable(dispensy)
+
+target_sources(dispensy PUBLIC
+    ${CMAKE_CURRENT_LIST_DIR}/src/main.c
+    ${CMAKE_CURRENT_LIST_DIR}/src/console.c
+    ${CMAKE_CURRENT_LIST_DIR}/src/log.c
+    ${CMAKE_CURRENT_LIST_DIR}/src/util.c
+    ${CMAKE_CURRENT_LIST_DIR}/src/usb.c
+    ${CMAKE_CURRENT_LIST_DIR}/src/usb_cdc.c
+    ${CMAKE_CURRENT_LIST_DIR}/src/usb_descriptors.c
+    ${CMAKE_CURRENT_LIST_DIR}/src/buttons.c
+    ${CMAKE_CURRENT_LIST_DIR}/src/lcd.c
+    ${CMAKE_CURRENT_LIST_DIR}/src/ring.c
+)
+
+target_include_directories(dispensy PUBLIC ${CMAKE_CURRENT_LIST_DIR}/include)
+
+# enable generous warnings
+target_compile_options(dispensy PUBLIC
+    -Wall
+    -Wextra
+    -Werror
+    -Wshadow
+)
+
+# suppress some warnings for borked 3rd party files in Pico SDK
+set_source_files_properties(pico-sdk/lib/btstack/src/ble/sm.c PROPERTIES COMPILE_FLAGS -Wno-unused-parameter)
+set_source_files_properties(pico-sdk/lib/btstack/src/btstack_hid_parser.c PROPERTIES COMPILE_FLAGS -Wno-maybe-uninitialized)
+set_source_files_properties(pico-sdk/src/rp2_common/pico_cyw43_driver/cyw43_driver.c PROPERTIES COMPILE_FLAGS -Wno-unused-parameter)
+set_source_files_properties(pico-sdk/lib/btstack/src/classic/avdtp_util.c PROPERTIES COMPILE_FLAGS -Wno-unused-parameter)
+set_source_files_properties(pico-sdk/lib/btstack/src/classic/goep_client.c PROPERTIES COMPILE_FLAGS -Wno-unused-parameter)
+set_source_files_properties(pico-sdk/lib/btstack/src/classic/goep_server.c PROPERTIES COMPILE_FLAGS -Wno-unused-parameter)
+set_source_files_properties(pico-sdk/src/rp2_common/hardware_flash/flash.c PROPERTIES COMPILE_FLAGS -Wno-shadow)
+
+# pull in common dependencies
+target_link_libraries(dispensy
+    pico_stdlib
+    pico_unique_id
+    tinyusb_device
+    tinyusb_board
+    hardware_adc
+    hardware_gpio
+    hardware_pwm
+)
+
+# fix for Errata RP2040-E5 (the fix requires use of GPIO 15)
+target_compile_definitions(dispensy PUBLIC PICO_RP2040_USB_DEVICE_ENUMERATION_FIX=1)
+
+pico_add_extra_outputs(dispensy)

firmware/README.md

@@ -0,0 +1,120 @@
+# Dispensy Firmware
+
+TODO
+
+## Quick Start
+
+When compiling for the first time, check out the required git submodules.
+
+    git submodule update --init
+    cd pico-sdk
+    git submodule update --init
+
+Then do this to build.
+
+    mkdir build
+    cmake -B build
+    make -C build -j4
+
+And flash the resulting `dispensy.uf2` file to your Pico as usual.
+
+For convenience you can use the included `flash.sh`, as long as you flashed the binary manually once before.
+
+    make -C build -j4
+    ./flash.sh build/dispensy.uf2
+
+This will use the mass storage bootloader to upload a new uf2 image.
+
+For old-school debugging a serial port will be presented by the firmware.
+Open it using eg. `picocom`, or with the included `debug.sh` script.
+
+For dependencies to compile, on Arch install these.
+
+    sudo pacman -S arm-none-eabi-gcc arm-none-eabi-newlib picocom cmake cxxtest
+
+## Proper Debugging
+
+You can also use the SWD interface for proper hardware debugging.
+
+This follows the instructions from the [RP2040 Getting Started document](https://datasheets.raspberrypi.com/pico/getting-started-with-pico.pdf) from chapter 5 and 6.
+
+For ease of reading the disassembly, create a debug build.
+
+    mkdir build_debug
+    cmake -B build_debug -DCMAKE_BUILD_TYPE=Debug
+    make -C build -j4
+
+You need a hardware SWD probe.
+This can be made from another Pico, see Appendix A in the document linked above.
+For this you need to compile the `picoprobe` firmware, like this.
+
+    git clone https://github.com/raspberrypi/picoprobe.git
+    cd picoprobe
+
+    git submodule update --init
+    mkdir build
+    cd build
+
+    PICO_SDK_PATH=../../../pico-sdk cmake ..
+    make -j4
+
+    cd ../.. # back to build_debug directory from before
+
+And flash the resulting `picoprobe.uf2` to your probe.
+Connect `GP2` of the probe to `SWCLK` of the target and `GP3` of the probe to `SWDIO` of the target.
+Of course you also need to connect GND between both.
+
+You need some dependencies, mainly `gdb-multiarch` and the RP2040 fork of `OpenOCD`.
+
+    sudo apt install gdb-multiarch   # Debian / Ubuntu
+    sudo pacman -S arm-none-eabi-gdb # Arch Linux
+
+    git clone https://github.com/raspberrypi/openocd.git --branch rp2040 --recursive --depth=1
+    cd openocd
+
+    # install udev rules
+    sudo cp contrib/60-openocd.rules /etc/udev/rules.d
+    sudo udevadm control --reload-rules && sudo udevadm trigger
+
+    ./bootstrap
+    ./configure --enable-ftdi --enable-sysfsgpio --enable-bcm2835gpio
+    make -j4
+
+    cd .. # back to build_debug directory from before
+
+Now we can flash a firmware image via OpenOCD.
+
+    ./openocd/src/openocd -s openocd/tcl -f interface/cmsis-dap.cfg -f target/rp2040.cfg -c "adapter speed 5000" -c "cmsis_dap_vid_pid 0x2e8a 0x000c" -c "program gadget.elf verify reset exit"
+
+And also start a GDB debugging session.
+
+    ./openocd/src/openocd -s openocd/tcl -f interface/cmsis-dap.cfg -f target/rp2040.cfg -c "adapter speed 5000" -c "cmsis_dap_vid_pid 0x2e8a 0x000c"
+    arm-none-eabi-gdb gadget.elf
+    target extended-remote localhost:3333
+
+    load # program elf into flash
+    monitor reset init # put into clean initial state
+    continue # start program
+
+These commands have also been put in the `flash_swd.sh` and `debug_swd.sh` scripts, respectively.
+They require the `build_debug` folder where you checked out and built OpenOCD.
+Here are some [general GDB tips](https://beej.us/guide/bggdb/).
+
+## License
+
+The firmware itself is licensed as GPLv3.
+I initially adapted it from my own [Trackball](https://git.xythobuz.de/thomas/Trackball) and [Volcano Remote](https://git.xythobuz.de/thomas/sb-py) projects.
+It uses the [Pi Pico SDK](https://github.com/raspberrypi/pico-sdk), licensed as BSD 3-clause, and therefore also [TinyUSB](https://github.com/hathach/tinyusb), licensed under the MIT license.
+Some code is adapted from the TinyUSB examples.
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program 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 General Public License for more details.
+
+    See <http://www.gnu.org/licenses/>.

firmware/debug.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+
+# ----------------------------------------------------------------------------
+# Copyright (c) 2023 Thomas Buck (thomas@xythobuz.de)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# See <http://www.gnu.org/licenses/>.
+# ----------------------------------------------------------------------------
+
+set -euo pipefail
+
+SERIAL=/dev/serial/by-id/usb-xythobuz_Dispensy_*
+
+echo -n Waiting for serial port to appear
+until [ -e $SERIAL ]
+do
+    echo -n .
+    sleep 1
+done
+echo
+
+echo Opening picocom terminal
+echo "[C-a] [C-x] to exit"
+echo
+
+picocom -q --omap crcrlf --imap lfcrlf $SERIAL

firmware/debug_swd.sh

@@ -0,0 +1,48 @@
+#!/bin/bash
+
+# ----------------------------------------------------------------------------
+# Copyright (c) 2023 Thomas Buck (thomas@xythobuz.de)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# See <http://www.gnu.org/licenses/>.
+# ----------------------------------------------------------------------------
+
+set -euo pipefail
+
+cd "$(dirname "$0")"
+
+echo Starting OpenOCD in background
+echo "\n\nstarting new openocd" >> openocd.log
+./build_debug/openocd/src/openocd -s build_debug/openocd/tcl -f interface/cmsis-dap.cfg -f target/rp2040.cfg -c "adapter speed 5000" -c "cmsis_dap_vid_pid 0x2e8a 0x000c" >> openocd.log 2>&1 &
+OPENOCD_PID=$!
+
+# give OpenOCD some time to output stuff
+sleep 1
+
+echo -n Waiting for debugger to appear
+while ! netstat -tna | grep 'LISTEN\>' | grep -q ':3333\>'; do
+    echo -n .
+    sleep 1
+done
+
+echo Starting GDB
+arm-none-eabi-gdb \
+-ex "set history save" \
+-ex "show print pretty" \
+-ex "target extended-remote localhost:3333" \
+-ex "tui new-layout default src 1 status 1 cmd 2" \
+-ex "tui layout default" \
+-ex "tui enable" \
+$1
+
+echo Killing OpenOCD instance in background
+kill $OPENOCD_PID

firmware/flash.sh

@@ -0,0 +1,45 @@
+#!/bin/bash
+
+# ----------------------------------------------------------------------------
+# Copyright (c) 2023 Thomas Buck (thomas@xythobuz.de)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# See <http://www.gnu.org/licenses/>.
+# ----------------------------------------------------------------------------
+
+set -euo pipefail
+
+SERIAL=/dev/serial/by-id/usb-xythobuz_Dispensy_*
+DISK=/dev/disk/by-label/RPI-RP2
+MOUNT=/mnt/tmp
+
+if [ ! -e $DISK ]
+then
+    echo Resetting Raspberry Pi Pico
+    echo -n -e "\\x18" > $SERIAL
+fi
+
+echo -n Waiting for disk to appear
+until [ -e $DISK ]
+do
+    echo -n .
+    sleep 1
+done
+echo
+
+echo Mounting bootloader disk
+sudo mount $DISK $MOUNT
+
+echo Copying binary
+sudo cp $1 $MOUNT
+
+echo Done

firmware/flash_swd.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+# ----------------------------------------------------------------------------
+# Copyright (c) 2023 Thomas Buck (thomas@xythobuz.de)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# See <http://www.gnu.org/licenses/>.
+# ----------------------------------------------------------------------------
+
+set -euo pipefail
+
+cd "$(dirname "$0")"
+
+./build_debug/openocd/src/openocd -s build_debug/openocd/tcl -f interface/cmsis-dap.cfg -f target/rp2040.cfg -c "adapter speed 5000" -c "cmsis_dap_vid_pid 0x2e8a 0x000c" -c "program $1 verify reset exit"

firmware/include/buttons.h

@@ -0,0 +1,42 @@
+/*
+ * buttons.h
+ *
+ * Copyright (c) 2022 - 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * See <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __BUTTONS_H__
+#define __BUTTONS_H__
+
+#include <stdbool.h>
+
+enum buttons {
+    BTN_A = 0,
+    BTN_B,
+    BTN_X,
+    BTN_Y,
+    BTN_UP,
+    BTN_DOWN,
+    BTN_LEFT,
+    BTN_RIGHT,
+    BTN_ENTER,
+    NUM_BTNS // count
+};
+
+void buttons_init(void);
+void buttons_callback(void (*fp)(enum buttons, bool));
+void buttons_run(void);
+
+#endif // __BUTTONS_H__
+

firmware/include/config.h

@@ -0,0 +1,57 @@
+/*
+ * config.h
+ *
+ * Copyright (c) 2022 - 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * See <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __CONFIG_H__
+#define __CONFIG_H__
+
+#define APP_VERSION_MAJOR 0
+#define APP_VERSION_MINOR 3
+
+#define MENU_PREFER_VOLCANO
+//#define MENU_PREFER_CRAFTY
+
+#define VOLCANO_AUTO_CONNECT_TIMEOUT_MS 2000
+#define VOLCANO_AUTO_CONNECT_WITHIN_MS 10000
+
+#define COUNTRY_CODE CYW43_COUNTRY_GERMANY
+
+#ifdef NDEBUG
+// Release build
+#define AUTO_MOUNT_MASS_STORAGE
+#define AUTO_LOG_ON_MASS_STORAGE
+#endif // NDEBUG
+
+#define WATCHDOG_PERIOD_MS 1000
+#define FLASH_LOCK_TIMEOUT_MS 500
+
+// ASCII 0x18 = CAN (cancel)
+#define ENTER_BOOTLOADER_MAGIC 0x18
+
+//#define DISABLE_CDC_DTR_CHECK
+#define DEBOUNCE_DELAY_MS 5
+
+#define SERIAL_WRITES_BLOCK_WHEN_BUFFER_FULL
+
+// TODO needs to be the same as in pack_data.sh
+#define DISK_BLOCK_SIZE 512
+#define DISK_BLOCK_COUNT (256 + 128) // 384 * 512 = 196608
+
+#define TEST_VOLCANO_AUTO_CONNECT "EA:06:75:A7:D1:15 1"
+#define TEST_CRAFTY_AUTO_CONNECT "60:B6:E1:BB:61:36 0"
+
+#endif // __CONFIG_H__

firmware/include/console.h

@@ -0,0 +1,26 @@
+/*
+ * console.h
+ *
+ * Copyright (c) 2022 - 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * See <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __CONSOLE_H__
+#define __CONSOLE_H__
+
+void cnsl_init(void);
+void cnsl_run(void);
+void cnsl_handle_input(const void *buf, size_t len);
+
+#endif // __CONSOLE_H__

firmware/include/lcd.h

@@ -0,0 +1,27 @@
+/*
+ * lipo.h
+ *
+ * Copyright (c) 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * See <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __LCD_H__
+#define __LCD_H__
+
+#define LCD_WIDTH 128
+#define LCD_HEIGHT 64
+
+void lcd_init(void);
+
+#endif // __LCD_H__

firmware/include/log.h

@@ -0,0 +1,58 @@
+/*
+ * log.h
+ *
+ * Copyright (c) 2022 - 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * See <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __LOG_H__
+#define __LOG_H__
+
+#include <stdarg.h>
+#include <stdbool.h>
+#include <inttypes.h>
+#include "pico/stdlib.h"
+
+// for output that is stored in the debug log.
+// will be re-played from buffer when terminal connects
+#ifndef PICOWOTA
+#define debug(fmt, ...) debug_log(true, \
+        "%08" PRIu32 " %s:%d: " fmt "\r\n", \
+        to_ms_since_boot(get_absolute_time()), \
+        __func__, __LINE__, \
+        ##__VA_ARGS__)
+#else // PICOWOTA
+#define debug(fmt, ...) debug_log(true, \
+        fmt "\r\n", \
+        ##__VA_ARGS__)
+#endif // PICOWOTA
+
+// for interactive output. is not stored or re-played.
+#define print(fmt, ...) debug_log(false, fmt, ##__VA_ARGS__)
+#define println(fmt, ...) debug_log(false, fmt "\r\n", ##__VA_ARGS__)
+
+void debug_log(bool log, const char *format, ...) __attribute__((format(printf, 2, 3)));
+void debug_wait_input(const char *format, ...) __attribute__((format(printf, 1, 2)));
+void debug_log_va(bool log, const char *format, va_list args);
+
+void log_dump_to_usb(void);
+void log_dump_to_uart(void);
+void log_dump_to_disk(void);
+
+void debug_handle_input(const void *buff, size_t len);
+
+#include "ring.h"
+struct ring_buffer *log_get(void);
+
+#endif // __LOG_H__

firmware/include/main.h

@@ -0,0 +1,28 @@
+/*
+ * main.h
+ *
+ * Copyright (c) 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * See <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __MAIN_H__
+#define __MAIN_H__
+
+void main_loop_hw(void);
+
+void networking_init(void);
+void networking_deinit(void);
+void networking_run(void);
+
+#endif // __MAIN_H__

firmware/include/ring.h

@@ -0,0 +1,45 @@
+/*
+ * ring.h
+ *
+ * Copyright (c) 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * See <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __RING_BUFFER_H__
+#define __RING_BUFFER_H__
+
+#include <stddef.h>
+#include <stdint.h>
+#include <stdbool.h>
+
+struct ring_buffer {
+    void *buffer;
+    size_t size;
+    size_t el_len;
+    size_t head, tail;
+    bool full;
+};
+#define RB_INIT(b, s, e) { .buffer = b, .size = s, .el_len = e, .head = 0, .tail = 0, .full = false }
+
+void rb_add(struct ring_buffer *rb, const void *data, size_t length);
+#define rb_push(rb, v) rb_add(rb, v, 1)
+size_t rb_len(struct ring_buffer *rb);
+#define rb_space(rb) ((rb)->size - rb_len(rb))
+void rb_dump(struct ring_buffer *rb, void (*write)(const void *, size_t), size_t skip);
+void rb_move(struct ring_buffer *rb, void (*write)(const void *, size_t));
+void rb_peek(struct ring_buffer *rb, void *buf);
+void rb_pop(struct ring_buffer *rb, void *buf);
+size_t rb_get(struct ring_buffer *rb, void *data, size_t length);
+
+#endif // __RING_BUFFER_H__

firmware/include/tusb_config.h

@@ -0,0 +1,123 @@
+/*
+ * Extended from TinyUSB example code.
+ *
+ * Copyright (c) 2022 - 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019 Ha Thach (tinyusb.org)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ */
+
+#ifndef _TUSB_CONFIG_H_
+#define _TUSB_CONFIG_H_
+
+#ifdef __cplusplus
+ extern "C" {
+#endif
+
+//--------------------------------------------------------------------
+// COMMON CONFIGURATION
+//--------------------------------------------------------------------
+
+// defined by board.mk
+#ifndef CFG_TUSB_MCU
+  #error CFG_TUSB_MCU must be defined
+#endif
+
+// RHPort number used for device can be defined by board.mk, default to port 0
+#ifndef BOARD_DEVICE_RHPORT_NUM
+  #define BOARD_DEVICE_RHPORT_NUM     0
+#endif
+
+// RHPort max operational speed can defined by board.mk
+// Default to Highspeed for MCU with internal HighSpeed PHY (can be port specific), otherwise FullSpeed
+#ifndef BOARD_DEVICE_RHPORT_SPEED
+  #if (CFG_TUSB_MCU == OPT_MCU_LPC18XX || CFG_TUSB_MCU == OPT_MCU_LPC43XX || CFG_TUSB_MCU == OPT_MCU_MIMXRT10XX || \
+       CFG_TUSB_MCU == OPT_MCU_NUC505  || CFG_TUSB_MCU == OPT_MCU_CXD56 || CFG_TUSB_MCU == OPT_MCU_SAMX7X)
+    #define BOARD_DEVICE_RHPORT_SPEED   OPT_MODE_HIGH_SPEED
+  #else
+    #define BOARD_DEVICE_RHPORT_SPEED   OPT_MODE_FULL_SPEED
+  #endif
+#endif
+
+// Device mode with rhport and speed defined by board.mk
+#if   BOARD_DEVICE_RHPORT_NUM == 0
+  #define CFG_TUSB_RHPORT0_MODE     (OPT_MODE_DEVICE | BOARD_DEVICE_RHPORT_SPEED)
+#elif BOARD_DEVICE_RHPORT_NUM == 1
+  #define CFG_TUSB_RHPORT1_MODE     (OPT_MODE_DEVICE | BOARD_DEVICE_RHPORT_SPEED)
+#else
+  #error "Incorrect RHPort configuration"
+#endif
+
+#ifndef CFG_TUSB_OS
+#define CFG_TUSB_OS               OPT_OS_NONE
+#endif
+
+// CFG_TUSB_DEBUG is defined by compiler in DEBUG build
+// #define CFG_TUSB_DEBUG           0
+
+/* USB DMA on some MCUs can only access a specific SRAM region with restriction on alignment.
+ * Tinyusb use follows macros to declare transferring memory so that they can be put
+ * into those specific section.
+ * e.g
+ * - CFG_TUSB_MEM SECTION : __attribute__ (( section(".usb_ram") ))
+ * - CFG_TUSB_MEM_ALIGN   : __attribute__ ((aligned(4)))
+ */
+#ifndef CFG_TUSB_MEM_SECTION
+#define CFG_TUSB_MEM_SECTION
+#endif
+
+#ifndef CFG_TUSB_MEM_ALIGN
+#define CFG_TUSB_MEM_ALIGN          __attribute__ ((aligned(4)))
+#endif
+
+//--------------------------------------------------------------------
+// DEVICE CONFIGURATION
+//--------------------------------------------------------------------
+
+#ifndef CFG_TUD_ENDPOINT0_SIZE
+#define CFG_TUD_ENDPOINT0_SIZE    64
+#endif
+
+//------------- CLASS -------------//
+#define CFG_TUD_HID               0
+#define CFG_TUD_CDC               1
+#define CFG_TUD_MSC               0
+#define CFG_TUD_MIDI              0
+#define CFG_TUD_VENDOR            0
+
+// CDC FIFO size of TX and RX
+#define CFG_TUD_CDC_RX_BUFSIZE   (TUD_OPT_HIGH_SPEED ? 512 : 64)
+#define CFG_TUD_CDC_TX_BUFSIZE   (TUD_OPT_HIGH_SPEED ? 512 : 64)
+
+// CDC Endpoint transfer buffer size, more is faster
+#define CFG_TUD_CDC_EP_BUFSIZE   (TUD_OPT_HIGH_SPEED ? 512 : 64)
+
+// MIDI FIFO size of TX and RX
+#define CFG_TUD_MIDI_RX_BUFSIZE   (TUD_OPT_HIGH_SPEED ? 512 : 64)
+#define CFG_TUD_MIDI_TX_BUFSIZE   (TUD_OPT_HIGH_SPEED ? 512 : 64)
+
+#ifdef __cplusplus
+ }
+#endif
+
+#endif /* _TUSB_CONFIG_H_ */

firmware/include/usb.h

@@ -0,0 +1,25 @@
+/*
+ * usb.h
+ *
+ * Copyright (c) 2022 - 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * See <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __USB_H__
+#define __USB_H__
+
+void usb_init(void);
+void usb_run(void);
+
+#endif // __USB_H__

firmware/include/usb_cdc.h

@@ -0,0 +1,29 @@
+/*
+ * usb_cdc.h
+ *
+ * Copyright (c) 2022 - 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * See <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __USB_CDC_H__
+#define __USB_CDC_H__
+
+#include <stddef.h>
+#include <stdint.h>
+#include <stdbool.h>
+
+void usb_cdc_write(const void *buf, size_t count);
+void usb_cdc_set_reroute(bool reroute);
+
+#endif // __USB_CDC_H__

firmware/include/usb_descriptors.h

@@ -0,0 +1,28 @@
+/*
+ * usb_descriptors.h
+ *
+ * Copyright (c) 2022 - 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * See <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef USB_DESCRIPTORS_H_
+#define USB_DESCRIPTORS_H_
+
+#include "pico/unique_id.h"
+
+extern char string_pico_serial[2 * PICO_UNIQUE_BOARD_ID_SIZE_BYTES + 1];
+
+void usb_descriptor_init_id(void);
+
+#endif /* USB_DESCRIPTORS_H_ */

firmware/include/util.h

@@ -0,0 +1,36 @@
+/*
+ * util.h
+ *
+ * Copyright (c) 2022 - 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * See <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef __UTIL_H__
+#define __UTIL_H__
+
+void heartbeat_init(void);
+void heartbeat_run(void);
+
+int32_t convert_two_complement(int32_t b);
+
+bool str_startswith(const char *str, const char *start);
+
+void reset_to_bootloader(void);
+void reset_to_main(void);
+
+void hexdump(const uint8_t *buff, size_t len);
+
+float map(float value, float leftMin, float leftMax, float rightMin, float rightMax);
+
+#endif // __UTIL_H__

firmware/pico-sdk

@@ -0,0 +1 @@
+Subproject commit 6a7db34ff63345a7badec79ebea3aaef1712f374

firmware/src/buttons.c

@@ -0,0 +1,83 @@
+/*
+ * buttons.c
+ *
+ * Copyright (c) 2022 - 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * See <http://www.gnu.org/licenses/>.
+ */
+
+#include "pico/stdlib.h"
+
+#include "config.h"
+#include "log.h"
+#include "buttons.h"
+
+static const uint gpio_num[NUM_BTNS] = {
+    15, // BTN_A
+    17, // BTN_B
+    19, // BTN_X
+    21, // BTN_Y
+     2, // BTN_UP
+    18, // BTN_DOWN
+    16, // BTN_LEFT
+    20, // BTN_RIGHT
+     3, // BTN_ENTER
+};
+
+struct button_state {
+    uint32_t last_time;
+    bool current_state, last_state;
+};
+
+static struct button_state buttons[NUM_BTNS];
+static void (*callback)(enum buttons, bool) = NULL;
+
+void buttons_init(void) {
+    for (uint i = 0; i < NUM_BTNS; i++) {
+        gpio_init(gpio_num[i]);
+        gpio_set_dir(gpio_num[i], GPIO_IN);
+        gpio_pull_up(gpio_num[i]);
+
+        buttons[i].last_time = 0;
+        buttons[i].current_state = false;
+        buttons[i].last_state = false;
+    }
+}
+
+void buttons_callback(void (*fp)(enum buttons, bool)) {
+    callback = fp;
+}
+
+void buttons_run(void) {
+    for (uint i = 0; i < NUM_BTNS; i++) {
+        bool state = !gpio_get(gpio_num[i]);
+        uint32_t now = to_ms_since_boot(get_absolute_time());
+
+        if (state != buttons[i].last_state) {
+            buttons[i].last_time = now;
+        }
+
+        if ((now - buttons[i].last_time) > DEBOUNCE_DELAY_MS) {
+            if (state != buttons[i].current_state) {
+                //debug("btn %d now %s", i, state ? "pressed" : "released");
+
+                buttons[i].current_state = state;
+                if (callback) {
+                    callback(i, state);
+                }
+            }
+        }
+
+        buttons[i].last_state = state;
+    }
+}

firmware/src/console.c

@@ -0,0 +1,202 @@
+/*
+ * console.c
+ *
+ * Copyright (c) 2022 - 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * See <http://www.gnu.org/licenses/>.
+ */
+
+#include <inttypes.h>
+#include <string.h>
+#include <unistd.h>
+#include <stdio.h>
+
+#include "pico/stdlib.h"
+#include "hardware/watchdog.h"
+
+#include "config.h"
+#include "log.h"
+#include "util.h"
+#include "usb_cdc.h"
+#include "lcd.h"
+#include "main.h"
+#include "console.h"
+
+#define CNSL_BUFF_SIZE 64
+#define CNSL_REPEAT_MS 500
+
+#define DEV_AUTO_CONNECT(s) {                                     \
+    ble_scan(BLE_SCAN_OFF);                                       \
+    bd_addr_t addr;                                               \
+    bd_addr_type_t type;                                          \
+    const char *foo = s;                                          \
+    sscanf(foo, "%02hhX:%02hhX:%02hhX:%02hhX:%02hhX:%02hhX %hhu", \
+            &addr[0], &addr[1], &addr[2], &addr[3],               \
+            &addr[4], &addr[5], &type);                           \
+    ble_connect(addr, type);                                      \
+    while (!ble_is_connected()) {                                 \
+        sleep_ms(1);                                              \
+    }                                                             \
+}
+
+static char cnsl_line_buff[CNSL_BUFF_SIZE + 1];
+static uint32_t cnsl_buff_pos = 0;
+
+static char cnsl_last_command[CNSL_BUFF_SIZE + 1];
+
+static char cnsl_repeated_command[CNSL_BUFF_SIZE + 1];
+static bool repeat_command = false;
+static uint32_t last_repeat_time = 0;
+
+static void cnsl_interpret(const char *line) {
+    if (strlen(line) == 0) {
+        if ((strlen(cnsl_last_command) > 0) && (strcmp(cnsl_last_command, "repeat") != 0)) {
+            // repeat last command once
+            println("repeating command \"%s\"", cnsl_last_command);
+            cnsl_interpret(cnsl_last_command);
+            println();
+        }
+        return;
+    } else if (strcmp(line, "repeat") == 0) {
+        if (!repeat_command) {
+            // mark last command to be repeated multiple times
+            strncpy(cnsl_repeated_command, cnsl_last_command, CNSL_BUFF_SIZE + 1);
+            last_repeat_time = to_ms_since_boot(get_absolute_time()) - 1001;
+            repeat_command = true;
+        } else {
+            // stop repeating
+            repeat_command = false;
+        }
+    } else if ((strcmp(line, "help") == 0)
+            || (strcmp(line, "h") == 0)
+            || (strcmp(line, "?") == 0)) {
+        println("Dispensy Firmware Usage:");
+        println("");
+        println("  reset - reset back into this firmware");
+        println("   \\x18 - reset to bootloader");
+        println("");
+        println("Press Enter with no input to repeat last command.");
+        println("Use repeat to continuously execute last command.");
+        println("Stop this by calling repeat again.");
+    } else if (strcmp(line, "reset") == 0) {
+        reset_to_main();
+    } else {
+        println("unknown command \"%s\"", line);
+    }
+
+    println();
+}
+
+void cnsl_init(void) {
+    cnsl_buff_pos = 0;
+    for (int i = 0; i < CNSL_BUFF_SIZE + 1; i++) {
+        cnsl_line_buff[i] = '\0';
+        cnsl_last_command[i] = '\0';
+        cnsl_repeated_command[i] = '\0';
+    }
+}
+
+static int32_t cnsl_find_line_end(void) {
+    for (uint32_t i = 0; i < cnsl_buff_pos; i++) {
+        if ((cnsl_line_buff[i] == '\r') || (cnsl_line_buff[i] == '\n')) {
+            return i;
+        }
+    }
+    return -1;
+}
+
+void cnsl_run(void) {
+    if (repeat_command && (strlen(cnsl_repeated_command) > 0)
+            && (strcmp(cnsl_repeated_command, "repeat") != 0)) {
+        uint32_t now = to_ms_since_boot(get_absolute_time());
+        if (now >= (last_repeat_time + CNSL_REPEAT_MS)) {
+            println("repeating command \"%s\"", cnsl_repeated_command);
+            cnsl_interpret(cnsl_repeated_command);
+            println();
+
+            last_repeat_time = now;
+        }
+    } else {
+        if (repeat_command) {
+            println("nothing to repeat");
+        }
+        repeat_command = false;
+    }
+}
+
+void cnsl_handle_input(const void *buf, size_t len) {
+    if ((cnsl_buff_pos + len) > CNSL_BUFF_SIZE) {
+        debug("error: console input buffer overflow! %lu > %u", cnsl_buff_pos + len, CNSL_BUFF_SIZE);
+        cnsl_init();
+    }
+
+    memcpy(cnsl_line_buff + cnsl_buff_pos, buf, len);
+    cnsl_buff_pos += len;
+
+    // handle backspace and local echo
+    for (ssize_t i = cnsl_buff_pos - len; i < (ssize_t)cnsl_buff_pos; i++) {
+        if ((cnsl_line_buff[i] == '\b') || (cnsl_line_buff[i] == 0x7F)) {
+            if (i > 0) {
+                // overwrite previous character and backspace
+                for (ssize_t j = i; j < (ssize_t)cnsl_buff_pos - 1; j++) {
+                    cnsl_line_buff[j - 1] = cnsl_line_buff[j + 1];
+                }
+                cnsl_buff_pos -= 2;
+            } else {
+                // just remove the backspace
+                for (ssize_t j = i; j < (ssize_t)cnsl_buff_pos - 1; j++) {
+                    cnsl_line_buff[j] = cnsl_line_buff[j + 1];
+                }
+                cnsl_buff_pos -= 1;
+            }
+
+            usb_cdc_write((const uint8_t *)"\b \b", 3);
+
+#ifndef NDEBUG
+            serial_write((const uint8_t *)"\b \b", 3);
+#endif
+
+            // check for another backspace in this space
+            i--;
+        } else {
+            usb_cdc_write((const uint8_t *)(cnsl_line_buff + i), 1);
+
+#ifndef NDEBUG
+            serial_write((const uint8_t *)(cnsl_line_buff + i), 1);
+#endif
+        }
+    }
+
+    int32_t line_len = cnsl_find_line_end();
+    if (line_len < 0) {
+        // user has not pressed enter yet
+        return;
+    }
+
+    // convert line to C-style string
+    cnsl_line_buff[line_len] = '\0';
+
+    cnsl_interpret(cnsl_line_buff);
+
+    // store command for eventual repeats
+    strncpy(cnsl_last_command, cnsl_line_buff, CNSL_BUFF_SIZE + 1);
+
+    // clear string and move following data over
+    uint32_t cnt = line_len + 1;
+    if (cnsl_line_buff[line_len + 1] == '\n') {
+        cnt++;
+    }
+    memset(cnsl_line_buff, '\0', cnt);
+    memmove(cnsl_line_buff, cnsl_line_buff + cnt, sizeof(cnsl_line_buff) - cnt);
+    cnsl_buff_pos -= cnt;
+}

firmware/src/lcd.c

@@ -0,0 +1,26 @@
+/*
+ * lcd.c
+ *
+ * Copyright (c) 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * See <http://www.gnu.org/licenses/>.
+ */
+
+#include "pico/stdlib.h"
+
+#include "config.h"
+#include "log.h"
+#include "lcd.h"
+
+void lcd_init(void) {
+}

firmware/src/log.c

@@ -0,0 +1,114 @@
+/*
+ * log.c
+ *
+ * Copyright (c) 2022 - 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * See <http://www.gnu.org/licenses/>.
+ */
+
+#include <stdio.h>
+#include <string.h>
+
+#include "hardware/watchdog.h"
+
+#include "config.h"
+#include "main.h"
+#include "usb_cdc.h"
+#include "ring.h"
+#include "log.h"
+
+static uint8_t log_buff[4096] = {0};
+static struct ring_buffer log_rb = RB_INIT(log_buff, sizeof(log_buff), 1);
+
+static uint8_t line_buff[256] = {0};
+static volatile bool got_input = false;
+
+static void add_to_log(const void *buff, size_t len) {
+    rb_add(&log_rb, buff, len);
+}
+
+struct ring_buffer *log_get(void) {
+    return &log_rb;
+}
+
+static void log_dump_to_x(void (*write)(const void *, size_t)) {
+    if (rb_len(&log_rb) == 0) {
+        return;
+    }
+
+    int l = snprintf((char *)line_buff, sizeof(line_buff), "\r\n\r\nbuffered log output:\r\n");
+    if ((l > 0) && (l <= (int)sizeof(line_buff))) {
+        write(line_buff, l);
+    }
+
+    rb_dump(&log_rb, write, 0);
+
+    l = snprintf((char *)line_buff, sizeof(line_buff), "\r\n\r\nlive log:\r\n");
+    if ((l > 0) && (l <= (int)sizeof(line_buff))) {
+        write(line_buff, l);
+    }
+}
+
+void log_dump_to_usb(void) {
+    log_dump_to_x(usb_cdc_write);
+}
+
+void debug_log_va(bool do_log, const char *format, va_list args) {
+    int l = vsnprintf((char *)line_buff, sizeof(line_buff), format, args);
+
+    if (l < 0) {
+        // encoding error
+        l = snprintf((char *)line_buff, sizeof(line_buff), "%s: encoding error\r\n", __func__);
+    } else if (l >= (ssize_t)sizeof(line_buff)) {
+        // not enough space for string
+        l = snprintf((char *)line_buff, sizeof(line_buff), "%s: message too long (%d)\r\n", __func__, l);
+    }
+    if ((l > 0) && (l <= (int)sizeof(line_buff))) {
+        usb_cdc_write(line_buff, l);
+
+        if (do_log) {
+            add_to_log(line_buff, l);
+        }
+    }
+}
+
+void debug_log(bool do_log, const char* format, ...) {
+    va_list args;
+    va_start(args, format);
+    debug_log_va(do_log, format, args);
+    va_end(args);
+}
+
+void debug_handle_input(const void *buff, size_t len) {
+    (void)buff;
+
+    if (len > 0) {
+        got_input = true;
+    }
+}
+
+void debug_wait_input(const char *format, ...) {
+    va_list args;
+    va_start(args, format);
+    debug_log_va(false, format, args);
+    va_end(args);
+
+    got_input = false;
+    usb_cdc_set_reroute(true);
+
+    while (!got_input) {
+        main_loop_hw();
+    }
+
+    usb_cdc_set_reroute(false);
+}

firmware/src/main.c

@@ -0,0 +1,63 @@
+/*
+ * main.c
+ *
+ * Copyright (c) 2022 - 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * See <http://www.gnu.org/licenses/>.
+ */
+
+#include "pico/stdlib.h"
+#include "hardware/watchdog.h"
+
+#include "config.h"
+#include "util.h"
+#include "console.h"
+#include "log.h"
+#include "usb.h"
+#include "buttons.h"
+#include "lcd.h"
+#include "main.h"
+
+void main_loop_hw(void) {
+    watchdog_update();
+    usb_run();
+    heartbeat_run();
+}
+
+int main(void) {
+    watchdog_enable(WATCHDOG_PERIOD_MS, 1);
+
+    // detect hardware type
+    // TODO
+
+    // required for debug console
+    cnsl_init();
+    usb_init();
+    debug("init");
+
+    if (watchdog_caused_reboot()) {
+        debug("reset by watchdog");
+    }
+
+    buttons_init();
+
+    debug("go");
+
+    while (1) {
+        main_loop_hw();
+        buttons_run();
+        cnsl_run();
+    }
+
+    return 0;
+}

firmware/src/ring.c

@@ -0,0 +1,112 @@
+/*
+ * ring.c
+ *
+ * Copyright (c) 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * See <http://www.gnu.org/licenses/>.
+ */
+
+#define MIN(x, y) ((x < y) ? x : y)
+
+#include <string.h>
+
+#include "config.h"
+#include "ring.h"
+
+void rb_add(struct ring_buffer *rb, const void *data, size_t length) {
+    for (size_t i = 0; i < length; i++) {
+        memcpy(rb->buffer + rb->head * rb->el_len, data + i * rb->el_len, rb->el_len);
+
+        if (rb->full && (++(rb->tail) == rb->size)) {
+            rb->tail = 0;
+        }
+
+        if (++(rb->head) == rb->size) {
+            rb->head = 0;
+        }
+
+        rb->full = ((rb->head) == (rb->tail));
+    }
+}
+
+size_t rb_len(struct ring_buffer *rb) {
+    if (rb->head == rb->tail) {
+        if (rb->full) {
+            return rb->size;
+        } else {
+            return 0;
+        }
+    } else if (rb->head > rb->tail) {
+        return rb->head - rb->tail;
+    } else {
+        return rb->size - rb->tail + rb->head;
+    }
+}
+
+void rb_dump(struct ring_buffer *rb, void (*write)(const void *, size_t), size_t skip) {
+    if (rb_len(rb) <= skip) {
+        return;
+    }
+
+    if (rb->head > rb->tail) {
+        if ((rb->head - rb->tail) > skip) {
+            write(rb->buffer + ((rb->tail + skip) * rb->el_len), rb->head - rb->tail - skip);
+        }
+    } else {
+        if ((rb->size - rb->tail) > skip) {
+            write(rb->buffer + ((rb->tail + skip) * rb->el_len), rb->size - rb->tail - skip);
+        }
+
+        skip -= MIN(skip, rb->size - rb->tail);
+        if (rb->head > skip) {
+            write(rb->buffer + (skip + rb->el_len), rb->head - skip);
+        }
+    }
+}
+
+void rb_move(struct ring_buffer *rb, void (*write)(const void *, size_t)) {
+    rb_dump(rb, write, 0);
+    rb->head = 0;
+    rb->tail = 0;
+    rb->full = false;
+}
+
+void rb_peek(struct ring_buffer *rb, void *buf) {
+    if (rb_len(rb) == 0) {
+        return;
+    }
+
+    memcpy(buf, rb->buffer + rb->tail * rb->el_len, rb->el_len);
+}
+
+void rb_pop(struct ring_buffer *rb, void *buf) {
+    if (rb_len(rb) == 0) {
+        return;
+    }
+
+    memcpy(buf, rb->buffer + rb->tail * rb->el_len, rb->el_len);
+    rb->tail++;
+    if (rb->tail >= rb->size) {
+        rb->tail = 0;
+    }
+}
+
+size_t rb_get(struct ring_buffer *rb, void *data, size_t length) {
+    size_t count = 0;
+    while ((length > 0) && (rb_len(rb) > 0)) {
+        rb_pop(rb, data + count * rb->el_len);
+        count++;
+        length--;
+    }
+    return count;
+}

firmware/src/usb.c

@@ -0,0 +1,70 @@
+/*
+ * Extended from TinyUSB example code.
+ *
+ * Copyright (c) 2022 - 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019 Ha Thach (tinyusb.org)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ */
+
+#include "bsp/board.h"
+#include "tusb.h"
+
+#include "config.h"
+#include "log.h"
+#include "usb_descriptors.h"
+#include "usb_cdc.h"
+#include "usb.h"
+
+void usb_init(void) {
+    usb_descriptor_init_id();
+
+    board_init();
+    tusb_init();
+}
+
+void usb_run(void) {
+    tud_task();
+}
+
+// Invoked when device is mounted
+void tud_mount_cb(void) {
+    debug("device mounted");
+}
+
+// Invoked when device is unmounted
+void tud_umount_cb(void) {
+    debug("device unmounted");
+}
+
+// Invoked when usb bus is suspended
+// remote_wakeup_en : if host allow us  to perform remote wakeup
+// Within 7ms, device must draw an average of current less than 2.5 mA from bus
+void tud_suspend_cb(bool remote_wakeup_en) {
+    debug("device suspended wakeup=%d", remote_wakeup_en);
+}
+
+// Invoked when usb bus is resumed
+void tud_resume_cb(void) {
+    debug("device resumed");
+}

firmware/src/usb_cdc.c

@@ -0,0 +1,115 @@
+/*
+ * Extended from TinyUSB example code.
+ *
+ * Copyright (c) 2022 - 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019 Ha Thach (tinyusb.org)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ */
+
+#include "bsp/board.h"
+#include "tusb.h"
+
+#include "config.h"
+#include "console.h"
+#include "log.h"
+#include "util.h"
+#include "usb_descriptors.h"
+#include "usb_cdc.h"
+
+static bool reroute_cdc_debug = false;
+
+void usb_cdc_write(const void *buf, size_t count) {
+#ifndef DISABLE_CDC_DTR_CHECK
+    if (!tud_cdc_connected()) {
+        return;
+    }
+#endif // DISABLE_CDC_DTR_CHECK
+
+    // implemented similar to Pico SDK stdio usb
+    uint32_t len = 0;
+    while (len < count) {
+        uint32_t n = count - len;
+        uint32_t available = tud_cdc_write_available();
+
+        // only write as much as possible
+        if (n > available) {
+            n = available;
+        }
+
+        len += tud_cdc_write(buf + len, n);
+
+        // run tud_task to actually move stuff from FIFO
+        tud_task();
+        tud_cdc_write_flush();
+    }
+}
+
+void usb_cdc_set_reroute(bool reroute) {
+    reroute_cdc_debug = reroute;
+}
+
+static void cdc_task(void) {
+    const uint32_t cdc_buf_len = 64;
+
+    if (tud_cdc_available()) {
+        char buf[cdc_buf_len + 1];
+        uint32_t count = tud_cdc_read(buf, cdc_buf_len);
+
+        if ((count >= 1) && (buf[0] == ENTER_BOOTLOADER_MAGIC)) {
+            reset_to_bootloader();
+        } else if (reroute_cdc_debug) {
+            debug_handle_input((const uint8_t *)buf, count);
+        } else {
+            cnsl_handle_input((const uint8_t *)buf, count);
+        }
+    }
+}
+
+// invoked when cdc when line state changed e.g connected/disconnected
+void tud_cdc_line_state_cb(uint8_t itf, bool dtr, bool rts) {
+    (void) itf;
+    (void) rts;
+
+    static bool last_dtr = false;
+
+    if (dtr && !last_dtr) {
+        // clear left-over console input
+        cnsl_init();
+
+        // show past history
+        log_dump_to_usb();
+
+        debug("terminal connected");
+    } else if (!dtr && last_dtr) {
+        debug("terminal disconnected");
+    }
+
+    last_dtr = dtr;
+}
+
+// invoked when CDC interface received data from host
+void tud_cdc_rx_cb(uint8_t itf) {
+    (void) itf;
+    cdc_task();
+}

firmware/src/usb_descriptors.c

@@ -0,0 +1,229 @@
+/*
+ * Extended from TinyUSB example code.
+ *
+ * Copyright (c) 2022 - 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2019 Ha Thach (tinyusb.org)
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ */
+
+#include "tusb.h"
+
+#include "config.h"
+#include "usb_descriptors.h"
+
+/*
+ * A combination of interfaces must have a unique product id,
+ * since PC will save device driver after the first plug.
+ * Same VID/PID with different interface e.g MSC (first),
+ * then CDC (later) will possibly cause system error on PC.
+ *
+ * Auto ProductID layout's Bitmap:
+ *   [MSB]         HID | MSC | CDC          [LSB]
+ */
+#define _PID_MAP(itf, n) ((CFG_TUD_##itf) << (n))
+#define USB_PID (0x2300 | _PID_MAP(CDC, 0) | _PID_MAP(MSC, 1) \
+    | _PID_MAP(HID, 2) | _PID_MAP(MIDI, 3) | _PID_MAP(VENDOR, 4) )
+
+#define USB_VID   0xCafe
+#define USB_BCD   0x0200
+
+//--------------------------------------------------------------------+
+// Device Descriptors
+//--------------------------------------------------------------------+
+
+tusb_desc_device_t const desc_device =
+{
+    .bLength            = sizeof(tusb_desc_device_t),
+    .bDescriptorType    = TUSB_DESC_DEVICE,
+    .bcdUSB             = USB_BCD,
+
+    /*
+     * Use Interface Association Descriptor (IAD) for CDC
+     * As required by USB Specs IAD's subclass must be common class (2)
+     * and protocol must be IAD (1)
+     */
+    .bDeviceClass       = TUSB_CLASS_MISC,
+    .bDeviceSubClass    = MISC_SUBCLASS_COMMON,
+    .bDeviceProtocol    = MISC_PROTOCOL_IAD,
+
+    .bMaxPacketSize0    = CFG_TUD_ENDPOINT0_SIZE,
+
+    .idVendor           = USB_VID,
+    .idProduct          = USB_PID,
+    .bcdDevice          = 0x0100,
+
+    .iManufacturer      = 0x01,
+    .iProduct           = 0x02,
+    .iSerialNumber      = 0x03,
+
+    .bNumConfigurations = 0x01
+};
+
+// Invoked when received GET DEVICE DESCRIPTOR
+// Application return pointer to descriptor
+uint8_t const * tud_descriptor_device_cb(void) {
+    return (uint8_t const *) &desc_device;
+}
+
+//--------------------------------------------------------------------+
+// Configuration Descriptor
+//--------------------------------------------------------------------+
+
+enum {
+    ITF_NUM_CDC = 0,
+    ITF_NUM_CDC_DATA,
+    //ITF_NUM_MIDI,
+    //ITF_NUM_MIDI_STREAMING,
+    ITF_NUM_TOTAL
+};
+
+#define  CONFIG_TOTAL_LEN  (TUD_CONFIG_DESC_LEN + TUD_CDC_DESC_LEN /*+ TUD_MIDI_DESC_LEN*/)
+
+#define EPNUM_CDC_NOTIF 0x82
+#define EPNUM_CDC_OUT   0x02
+#define EPNUM_CDC_IN    0x83
+#define EPNUM_MIDI_OUT  0x03
+#define EPNUM_MIDI_IN   0x84
+
+uint8_t const desc_configuration[] = {
+    // Config number, interface count, string index, total length, attribute, power in mA
+    TUD_CONFIG_DESCRIPTOR(1, ITF_NUM_TOTAL, 0, CONFIG_TOTAL_LEN, TUSB_DESC_CONFIG_ATT_REMOTE_WAKEUP, 100),
+
+    // Interface number, string index, EP notification address and size, EP data address (out, in) and size.
+    TUD_CDC_DESCRIPTOR(ITF_NUM_CDC, 4, EPNUM_CDC_NOTIF, 8, EPNUM_CDC_OUT, EPNUM_CDC_IN, 64),
+
+    // Interface number, string index, EP Out & EP In address, EP size
+    //TUD_MIDI_DESCRIPTOR(ITF_NUM_MIDI, 5, EPNUM_MIDI_OUT, EPNUM_MIDI_IN, 64),
+};
+
+#if TUD_OPT_HIGH_SPEED
+// Per USB specs: high speed capable device must report device_qualifier and other_speed_configuration
+
+// other speed configuration
+uint8_t desc_other_speed_config[CONFIG_TOTAL_LEN];
+
+// device qualifier is mostly similar to device descriptor since we don't change configuration based on speed
+tusb_desc_device_qualifier_t const desc_device_qualifier = {
+    .bLength            = sizeof(tusb_desc_device_qualifier_t),
+    .bDescriptorType    = TUSB_DESC_DEVICE_QUALIFIER,
+    .bcdUSB             = USB_BCD,
+
+    .bDeviceClass       = TUSB_CLASS_MISC,
+    .bDeviceSubClass    = MISC_SUBCLASS_COMMON,
+    .bDeviceProtocol    = MISC_PROTOCOL_IAD,
+
+    .bMaxPacketSize0    = CFG_TUD_ENDPOINT0_SIZE,
+    .bNumConfigurations = 0x01,
+    .bReserved          = 0x00
+};
+
+// Invoked when received GET DEVICE QUALIFIER DESCRIPTOR request
+// Application return pointer to descriptor, whose contents must exist long enough for transfer to complete.
+// device_qualifier descriptor describes information about a high-speed capable device that would
+// change if the device were operating at the other speed. If not highspeed capable stall this request.
+uint8_t const* tud_descriptor_device_qualifier_cb(void) {
+    return (uint8_t const*) &desc_device_qualifier;
+}
+
+// Invoked when received GET OTHER SEED CONFIGURATION DESCRIPTOR request
+// Application return pointer to descriptor, whose contents must exist long enough for transfer to complete
+// Configuration descriptor in the other speed e.g if high speed then this is for full speed and vice versa
+uint8_t const* tud_descriptor_other_speed_configuration_cb(uint8_t index) {
+    (void) index; // for multiple configurations
+
+    // other speed config is basically configuration with type = OHER_SPEED_CONFIG
+    memcpy(desc_other_speed_config, desc_configuration, CONFIG_TOTAL_LEN);
+    desc_other_speed_config[1] = TUSB_DESC_OTHER_SPEED_CONFIG;
+
+    // this example use the same configuration for both high and full speed mode
+    return desc_other_speed_config;
+}
+
+#endif // highspeed
+
+// Invoked when received GET CONFIGURATION DESCRIPTOR
+// Application return pointer to descriptor
+// Descriptor contents must exist long enough for transfer to complete
+uint8_t const * tud_descriptor_configuration_cb(uint8_t index) {
+    (void) index; // for multiple configurations
+
+    // This example use the same configuration for both high and full speed mode
+    return desc_configuration;
+}
+
+//--------------------------------------------------------------------+
+// String Descriptors
+//--------------------------------------------------------------------+
+
+char string_pico_serial[2 * PICO_UNIQUE_BOARD_ID_SIZE_BYTES + 1];
+
+void usb_descriptor_init_id(void) {
+    pico_get_unique_board_id_string(string_pico_serial, sizeof(string_pico_serial));
+}
+
+// array of pointer to string descriptors
+char const* string_desc_arr [] = {
+    (const char[]) { 0x09, 0x04 }, // 0: is supported language is English (0x0409)
+    "xythobuz",                           // 1: Manufacturer
+    "Dispensy",                           // 2: Product
+    string_pico_serial,                   // 3: Serials, should use chip ID
+    "Debug Serial",                       // 4: CDC Interface
+    //"LARS Midi",                          // 5: MIDI Interface
+};
+
+static uint16_t _desc_str[32];
+
+// Invoked when received GET STRING DESCRIPTOR request
+// Application return pointer to descriptor, whose contents must exist long enough for transfer to complete
+uint16_t const* tud_descriptor_string_cb(uint8_t index, uint16_t langid) {
+    (void) langid;
+
+    uint8_t chr_count;
+
+    if ( index == 0) {
+        memcpy(&_desc_str[1], string_desc_arr[0], 2);
+        chr_count = 1;
+    } else {
+        // Note: the 0xEE index string is a Microsoft OS 1.0 Descriptors.
+        // https://docs.microsoft.com/en-us/windows-hardware/drivers/usbcon/microsoft-defined-usb-descriptors
+
+        if ( !(index < sizeof(string_desc_arr)/sizeof(string_desc_arr[0])) ) return NULL;
+
+        const char* str = string_desc_arr[index];
+
+        // Cap at max char
+        chr_count = strlen(str);
+        if ( chr_count > 31 ) chr_count = 31;
+
+        // Convert ASCII string into UTF-16
+        for(uint8_t i=0; i<chr_count; i++) {
+            _desc_str[1+i] = str[i];
+        }
+    }
+
+    // first byte is length (including header), second byte is string type
+    _desc_str[0] = (TUSB_DESC_STRING << 8 ) | (2*chr_count + 2);
+
+    return _desc_str;
+}

firmware/src/util.c

@@ -0,0 +1,106 @@
+/*
+ * util.c
+ *
+ * Copyright (c) 2022 - 2023 Thomas Buck (thomas@xythobuz.de)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program 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 General Public License for more details.
+ *
+ * See <http://www.gnu.org/licenses/>.
+ */
+
+#include <string.h>
+#include "pico/stdlib.h"
+#include "pico/bootrom.h"
+#include "hardware/watchdog.h"
+
+#ifdef CYW43_WL_GPIO_LED_PIN
+#include "pico/cyw43_arch.h"
+#endif // CYW43_WL_GPIO_LED_PIN
+
+#include "config.h"
+#include "log.h"
+#include "util.h"
+
+#define HEARTBEAT_INTERVAL_MS 500
+
+void heartbeat_init(void) {
+#ifdef PICO_DEFAULT_LED_PIN
+    gpio_init(PICO_DEFAULT_LED_PIN);
+    gpio_set_dir(PICO_DEFAULT_LED_PIN, GPIO_OUT);
+    gpio_put(PICO_DEFAULT_LED_PIN, 1);
+#endif // PICO_DEFAULT_LED_PIN
+#ifdef CYW43_WL_GPIO_LED_PIN
+    cyw43_arch_gpio_put(CYW43_WL_GPIO_LED_PIN, 1);
+#endif // CYW43_WL_GPIO_LED_PIN
+}
+
+void heartbeat_run(void) {
+#if defined(PICO_DEFAULT_LED_PIN) || defined(CYW43_WL_GPIO_LED_PIN)
+    static uint32_t last_heartbeat = 0;
+    uint32_t now = to_ms_since_boot(get_absolute_time());
+    if (now >= (last_heartbeat + HEARTBEAT_INTERVAL_MS)) {
+        last_heartbeat = now;
+#ifdef PICO_DEFAULT_LED_PIN
+        gpio_xor_mask(1 << PICO_DEFAULT_LED_PIN);
+#endif // PICO_DEFAULT_LED_PIN
+#ifdef CYW43_WL_GPIO_LED_PIN
+        cyw43_arch_gpio_put(CYW43_WL_GPIO_LED_PIN, !cyw43_arch_gpio_get(CYW43_WL_GPIO_LED_PIN));
+#endif // CYW43_WL_GPIO_LED_PIN
+    }
+#endif // defined(PICO_DEFAULT_LED_PIN) || defined(CYW43_WL_GPIO_LED_PIN)
+}
+
+bool str_startswith(const char *str, const char *start) {
+    size_t l = strlen(start);
+    if (l > strlen(str)) {
+        return false;
+    }
+    return (strncmp(str, start, l) == 0);
+}
+
+int32_t convert_two_complement(int32_t b) {
+    if (b & 0x8000) {
+        b = -1 * ((b ^ 0xffff) + 1);
+    }
+    return b;
+}
+
+void reset_to_bootloader(void) {
+#ifdef PICO_DEFAULT_LED_PIN
+    reset_usb_boot(1 << PICO_DEFAULT_LED_PIN, 0);
+#else // ! PICO_DEFAULT_LED_PIN
+    reset_usb_boot(0, 0);
+#endif // PICO_DEFAULT_LED_PIN
+}
+
+void reset_to_main(void) {
+    watchdog_enable(1, false);
+    while (1);
+}
+
+void hexdump(const uint8_t *buff, size_t len) {
+    for (size_t i = 0; i < len; i += 16) {
+        for (size_t j = 0; (j < 16) && ((i + j) < len); j++) {
+            print("0x%02X", buff[i + j]);
+            if ((j < 15) && ((i + j) < (len - 1))) {
+                print(" ");
+            }
+        }
+        println();
+    }
+}
+
+float map(float value, float leftMin, float leftMax, float rightMin, float rightMax) {
+    float leftSpan = leftMax - leftMin;
+    float rightSpan = rightMax - rightMin;
+    float valueScaled = (value - leftMin) / leftSpan;
+    return rightMin + (valueScaled * rightSpan);
+}

hardware/.gitignore

@@ -7,3 +7,4 @@ replicate_layout.log
 fabrication
 plot
 fab.zip
+jlcpcb

hardware/README.md

@@ -1,6 +1,6 @@
 # Hardware
 
-This is a KiCAD 7 hierarchical schematic and layout.
+This is a KiCAD 8 hierarchical schematic and layout.
 Take a look at the [docs](https://docs.kicad.org/7.0/en/eeschema/eeschema.html#hierarchical-schematics).
 
 The repeated schematic sheets can also be replicated in the layout using [this plugin](https://github.com/MitjaNemec/ReplicateLayout).