firmware: Store quantizer table in flash

Author: aquaticsarah

firmware/scripts/samd21g18a.ld

@@ -552,7 +552,6 @@ SECTIONS
 
    References:
    * ../src/gem_quantizer.c
-   TODO: Add a marker to the packed config, and hook up to this symbol
 */
 _nvm_quantizer_base_address = ORIGIN(nvm);
 _nvm_quantizer_length = QUANTIZER_SIZE;

firmware/src/gem_quantizer.c

@@ -22,6 +22,13 @@
 #include "wntr_pack.h"
 #include <string.h>
 
+#define QUANTIZER_MARKER_V1 0xA1
+
+#define QUANTIZER_MARKER_MIN QUANTIZER_MARKER_V1
+#define QUANTIZER_MARKER_MAX QUANTIZER_MARKER_V1
+
+extern uint8_t _nvm_quantizer_base_address;
+
 /* Static variables */
 
 /* Forward declarations */
@@ -32,9 +39,8 @@ static const struct GemQuantizerConfig default_quantizer_config;
 
 struct GemQuantizerConfig gem_quantizer_config;
 
-void gem_quantizer_init() {
-    // TODO: Load from flash
-    gem_quantizer_config = default_quantizer_config;
+void GemQuantizer_init(GemQuantizer *config) {
+    *config = default_quantizer_config;
 }
 
 uint32_t GemQuantizer_search_table(fix16_t pitch_cv) {
@@ -73,12 +79,7 @@ uint32_t GemQuantizer_search_table(fix16_t pitch_cv) {
     return lo;
 }
 
-void GemQuantizer_erase() {
-    // TODO: Clear stored table instead
-    gem_quantizer_config = default_quantizer_config;
-}
-
-bool GemQuantizer_unpack(struct GemQuantizerConfig* config, const uint8_t* data) {
+bool GemQuantizer_unpack(struct GemQuantizerConfig *config, const uint8_t *data) {
     config->hysteresis = (fix16_t)WNTR_UNPACK_32(data, 0);
     config->notes_len = (uint32_t)data[4];
     for (uint32_t i = 0; i < config->notes_len; i++) {
@@ -103,6 +104,60 @@ bool GemQuantizer_pack(const struct GemQuantizerConfig* config, uint8_t* data) {
     return true;
 }
 
+void GemQuantizer_erase() {
+    /* Just erase the marker byte. */
+    uint8_t data[1] = {0xFF};
+    // NOLINTNEXTLINE(clang-diagnostic-pointer-to-int-cast)
+    gem_nvm_write((uint32_t)(&_nvm_quantizer_base_address), data, 1);
+}
+
+bool GemQuantizer_load(struct GemQuantizerConfig *config) {
+    uint8_t data[GEMQUANTIZER_PACKED_SIZE + 1];
+
+    // NOLINTNEXTLINE(clang-diagnostic-pointer-to-int-cast)
+    gem_nvm_read((uint32_t)(&_nvm_quantizer_base_address), data, GEMQUANTIZER_PACKED_SIZE + 1);
+
+    uint8_t marker = data[0];
+
+    if (marker < QUANTIZER_MARKER_MIN || marker > QUANTIZER_MARKER_MAX) {
+        printf("Invalid quantizer config marker.\n");
+        goto fail;
+    }
+
+    bool result = GemQuantizer_unpack(config, data + 1);
+
+    // TODO
+    /*
+    if (result == true) {
+        return GemQuantizer_check(marker, config);
+    }
+    */
+
+    printf("Failed to load quantizer config.\n");
+
+fail:
+    printf("Loading default quantizer config.\n");
+    GemQuantizer_init(config);
+    return false;
+}
+
+bool GemQuantizer_save(const struct GemQuantizerConfig *config) {
+    uint8_t data[GEMQUANTIZER_PACKED_SIZE + 1];
+    // We might not fill the entire data buffer, as the config struct is variable size.
+    // So we zero out the buffer before starting, to avoid saving garbage off the stack
+    memset(data, 0, sizeof(data));
+
+    data[0] = QUANTIZER_MARKER_MAX;
+    bool result = GemQuantizer_pack(config, data + 1);
+    WNTR_ASSERT(result == true);
+
+    // NOLINTNEXTLINE(clang-diagnostic-pointer-to-int-cast)
+    gem_nvm_write((uint32_t)(&_nvm_quantizer_base_address), data, GEMQUANTIZER_PACKED_SIZE + 1);
+
+    printf("Saved quantizer config: \n");
+    //GemQuantizer_print(config);
+}
+
 /* Private functions */
 
 /*

firmware/src/gem_quantizer.h

@@ -94,8 +94,6 @@ struct GemQuantizerConfig {
 
     uint32_t notes_len;
     struct GemQuantizerTableEntry notes[MAX_QUANTIZER_TABLE_SIZE];
-
-    // TODO: Add checksum
 };
 
 // Maximum size of a packed quantizer table
@@ -107,13 +105,15 @@ struct GemQuantizerConfig {
 
 extern struct GemQuantizerConfig gem_quantizer_config;
 
-void gem_quantizer_init();
-
 // Search the quantizer table to figure out which bin the incoming pitch CV
 // falls into.
 // Returns the index of the quantizer bin.
 uint32_t GemQuantizer_search_table(fix16_t pitch_cv);
 
+void GemQuantizer_init(GemQuantizer *config);
+bool GemQuantizer_unpack(struct GemQuantizerConfig *config, const uint8_t *data);
+bool GemQuantizer_pack(const struct GemQuantizerConfig *config, uint8_t *data);
+
 void GemQuantizer_erase();
-bool GemQuantizer_unpack(struct GemQuantizerConfig* config, const uint8_t* data);
-bool GemQuantizer_pack(const struct GemQuantizerConfig* config, uint8_t* data);
+bool GemQuantizer_load(struct GemQuantizerConfig *config);
+bool GemQuantizer_save(const struct GemQuantizerConfig *config);

firmware/src/gem_sysex_commands.c

@@ -434,9 +434,11 @@ static void cmd_0x1A_read_quantizer_config_(const uint8_t* data, size_t len) {
     (void)data;
     (void)len;
 
-    /* Read live quantizer config. TODO: Read from flash instead */
+    /* Read quantizer config from flash */
+    GemQuantizerConfig config;
     uint8_t config_buf[GEMQUANTIZER_PACKED_SIZE];
-    GemQuantizer_pack(&gem_quantizer_config, config_buf);
+    GemQuantizer_load(&config);
+    GemQuantizer_pack(&config, config_buf);
 
     PREPARE_RESPONSE(0x1A, TEETH_ENCODED_LENGTH(GEMQUANTIZER_PACKED_SIZE));
     teeth_encode(config_buf, GEMQUANTIZER_PACKED_SIZE, response);
@@ -446,32 +448,18 @@ static void cmd_0x1A_read_quantizer_config_(const uint8_t* data, size_t len) {
 }
 
 static void cmd_0x1B_write_quantizer_config_(const uint8_t* data, size_t len) {
-    (void)data;
-    (void)len;
-
-#if 0
-    /* Request (teeth): serialized settings */
-    DECODE_TEETH_REQUEST(GEMSETTINGS_PACKED_SIZE);
+    /* Write quantizer config to flash */
+    DECODE_TEETH_REQUEST(GEMQUANTIZER_PACKED_SIZE);
 
-    struct GemSettings settings;
+    GemQuantizerConfig config;
 
-    if (GemSettings_unpack(&settings, request).status == STRUCTY_RESULT_OKAY) {
-        GemSettings_save(&settings);
+    bool result = GemQuantizer_unpack(&config, request);
+    if (result == true) {
+        GemQuantizer_save(&config);
     } else {
-        debug_printf("Failed to save settings, unable to deserialize.\n");
+        debug_printf("Failed to save quantizer config, unable to deserialize.\n");
     }
 
-    /* Ack the data. */
-    RESPONSE_0(0x19);
-
-    debug_printf("SysEx 0x19: Wrote settings\n");
-#endif
-
-    /* Write live quantizer config. TODO: Write to flash instead */
-    DECODE_TEETH_REQUEST(GEMQUANTIZER_PACKED_SIZE);
-
-    GemQuantizer_unpack(&gem_quantizer_config, request);
-
     /* Ack the data. */
     RESPONSE_0(0x1B);
 

firmware/src/main.c

@@ -190,7 +190,7 @@ static void init_() {
     /*
         Load quantizer configuration
     */
-    gem_quantizer_init();
+    GemQuantizer_load(&gem_quantizer_config);
 
     /*
         Gemini has two oscillators - Castor & Pollux. For the most part they're