add version info to built fw

CMakeLists.txt

@@ -73,6 +73,14 @@ set_source_files_properties(pico-sdk/lib/btstack/src/classic/goep_client.c PROPE
 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)
 
+# repo meta data
+include(FetchContent)
+FetchContent_Declare(cmake_git_version_tracking
+    GIT_REPOSITORY https://github.com/andrew-hardin/cmake-git-version-tracking.git
+    GIT_TAG 6c0cb87edd029ddfb403a8e24577c144a03605a6
+)
+FetchContent_MakeAvailable(cmake_git_version_tracking)
+
 # pull in common dependencies
 target_link_libraries(drumkit
     pico_stdlib
@@ -83,6 +91,7 @@ target_link_libraries(drumkit
     pico_unique_id
     tinyusb_device
     tinyusb_board
+    cmake_git_version_tracking
 )
 
 # enable usb output, disable uart output

README.md

@@ -86,8 +86,14 @@ A copy of the license can be found in `COPYING`.
 
 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.
+
+To control the OLED display, [pico-ssd1306](https://github.com/daschr/pico-ssd1306) is used, licensed under the MIT license.
+
 The code in `src/encoder.c` is derived from [mathertel/RotaryEncoder](https://github.com/mathertel/RotaryEncoder) and therefore licensed as BSD 3-clause.
 
+Repo metadata is embedded into the project using [cmake-git-version-tracking](https://github.com/andrew-hardin/cmake-git-version-tracking), licensed under the MIT license.
+
 The docs are built using [mdbook](https://github.com/rust-lang/mdBook), licensed as `MPL-2.0`.
 
 The PCB SVG files in the documentation are displayed using [svg-pan-zoom](https://github.com/bumbu/svg-pan-zoom), licensed as `BSD-2-Clause`.

include/buttons.h

@@ -21,8 +21,6 @@
 
 #include <stdbool.h>
 
-#define DEBOUNCE_DELAY_MS 50
-
 enum buttons {
     BTN_A = 0,
     BTN_B,

include/config.h

@@ -0,0 +1,41 @@
+/*
+ * config.h
+ *
+ * Copyright (c) 2022 - 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/>.
+ */
+
+#ifndef __CONFIG_H__
+#define __CONFIG_H__
+
+#define VERSION_MAJOR 0
+#define VERSION_MINOR 1
+
+#define WATCHDOG_PERIOD_MS 100
+#define LOGO_INIT_MS 1000
+
+// ASCII 0x18 = CAN (cancel)
+#define ENTER_BOOTLOADER_MAGIC 0x18
+
+//#define DISABLE_CDC_DTR_CHECK
+#define DEBOUNCE_DELAY_MS 5
+
+// ----------------------------------------------------------------------------
+
+#define STR_HELPER(x) #x
+#define STR(x) STR_HELPER(x)
+
+#define VERSION_STR "V" STR(VERSION_MAJOR) "." STR(VERSION_MINOR)
+
+#endif // __CONFIG_H__

include/lcd.h

@@ -24,6 +24,9 @@
 #define LCD_WIDTH 128
 #define LCD_HEIGHT 64
 
+#define FONT_HEIGHT 8
+#define FONT_WIDTH 5
+
 void lcd_init(void);
 void lcd_draw(const char *mode, const char *val, const char *bat);
 void lcd_draw_bye(void);

src/buttons.c

@@ -19,6 +19,7 @@
 #include <stdio.h>
 #include "pico/stdlib.h"
 
+#include "config.h"
 #include "main.h"
 #include "buttons.h"
 

src/lcd.c

@@ -16,11 +16,16 @@
  * See <http://www.gnu.org/licenses/>.
  */
 
+#include <stdio.h>
+#include <string.h>
+
 #include "hardware/i2c.h"
 #include "hardware/watchdog.h"
 
 #include "ssd1306.h"
+#include "git.h"
 
+#include "config.h"
 #include "buttons.h"
 #include "console.h"
 #include "main.h"
@@ -143,7 +148,44 @@ void lcd_draw_bye(void) {
 
 void lcd_draw_version(void) {
     ssd1306_clear(&disp);
-    // TODO
-    ssd1306_draw_string(&disp, 0, LCD_HEIGHT / 2 - 4, 1, "TODO");
+
+    ssd1306_draw_string(&disp, 0, 0, 2,
+                        "LARS");
+
+    ssd1306_draw_string(&disp, 0, FONT_HEIGHT * 2 + 1, 1,
+                        "Release: " VERSION_STR);
+
+    ssd1306_draw_string(&disp, 0, FONT_HEIGHT * 2 + 1 + FONT_HEIGHT + 1, 1,
+                        __DATE__ " " __TIME__);
+
+    if (git_IsPopulated()) {
+        const char *hash = git_CommitSHA1();
+        char short_hash[6 + 7 + 6 + 1] = {0};
+        memcpy(short_hash, "Hash: ", 6);
+        memcpy(short_hash + 6, hash, 7);
+        if (git_AnyUncommittedChanges()) {
+            memcpy(short_hash + 6 + 7, " dirty", 6);
+        }
+        ssd1306_draw_string(&disp, 0, FONT_HEIGHT * 2 + 1 + (FONT_HEIGHT + 1) * 2, 1,
+                            short_hash);
+    } else {
+        ssd1306_draw_string(&disp, 0, FONT_HEIGHT * 2 + 1 + (FONT_HEIGHT + 1) * 2, 1,
+                            "No Git Repo");
+    }
+
+    char hw_id_str[42] = {0};
+    if (hw_type == HW_PROTOTYPE) {
+        snprintf(hw_id_str, sizeof(hw_id_str) - 1,
+                 "HW Prototype");
+    } else if (hw_type == HW_V2) {
+        snprintf(hw_id_str, sizeof(hw_id_str) - 1,
+                 "HW V2");
+    } else {
+        snprintf(hw_id_str, sizeof(hw_id_str) - 1,
+                 "HW unknown %X", hw_type);
+    }
+    ssd1306_draw_string(&disp, 0, FONT_HEIGHT * 2 + 1 + (FONT_HEIGHT + 1) * 3, 1,
+                        hw_id_str);
+
     ssd1306_show(&disp);
 }

src/main.c

@@ -20,6 +20,7 @@
 #include "pico/bootrom.h"
 #include "hardware/watchdog.h"
 
+#include "config.h"
 #include "adc.h"
 #include "buttons.h"
 #include "console.h"
@@ -34,9 +35,6 @@
 #include "usb.h"
 #include "main.h"
 
-#define WATCHDOG_PERIOD_MS 100
-#define LOGO_INIT_MS 1000
-
 static const uint gpio_hw_detect = 21;
 
 enum hw_versions hw_type = HW_UNKNOWN;

src/usb_cdc.c

@@ -30,15 +30,13 @@
 #include "bsp/board.h"
 #include "tusb.h"
 
+#include "config.h"
 #include "console.h"
 #include "log.h"
 #include "main.h"
 #include "usb_descriptors.h"
 #include "usb_cdc.h"
 
-#define ENTER_BOOTLOADER_MAGIC 0x18
-#define DISABLE_CDC_DTR_CHECK
-
 static bool reroute_cdc_debug = false;
 
 void usb_cdc_write(const void *buf, size_t count) {