pbio/sys/storage: Add basics for persistent settings.

Author: laurensvalk

lib/pbio/include/pbsys/storage.h

@@ -16,6 +16,16 @@
 
 #include <pbsys/config.h>
 
+/**
+ * System settings. All data types are little-endian.
+ */
+typedef struct _pbsys_storage_settings_t {
+    /**
+     * User has enabled Bluetooth Low Energy.
+     */
+    bool bluetooth_ble_user_enabled : 1;
+} pbsys_storage_settings_t;
+
 #if PBSYS_CONFIG_STORAGE
 
 // Sanity check that application RAM is enough to load ROM and still do something useful
@@ -51,6 +61,11 @@ typedef struct _pbsys_storage_data_map_t {
      * End-user read-write accessible data.
      */
     uint8_t user_data[PBSYS_CONFIG_STORAGE_USER_DATA_SIZE];
+    /**
+     * System settings. Settings will be reset to defaults when the firmware
+     * version changes due to an update.
+     */
+    pbsys_storage_settings_t settings;
     /**
      * Size of the application program (size of code only).
      */
@@ -67,6 +82,10 @@ pbio_error_t pbsys_storage_set_user_data(uint32_t offset, const uint8_t *data, u
 
 pbio_error_t pbsys_storage_get_user_data(uint32_t offset, uint8_t **data, uint32_t size);
 
+pbio_error_t pbsys_storage_get_settings(pbsys_storage_settings_t **settings);
+
+void pbsys_storage_request_settings_write(void);
+
 #else
 
 #define PBSYS_STORAGE_MAX_PROGRAM_SIZE (0)
@@ -80,6 +99,13 @@ static inline pbio_error_t pbsys_storage_get_user_data(uint32_t offset, uint8_t
     return PBIO_ERROR_NOT_SUPPORTED;
 }
 
+static inline pbio_error_t pbsys_storage_get_settings(pbsys_storage_settings_t **settings) {
+    *settings = NULL;
+    return PBIO_ERROR_NOT_SUPPORTED;
+}
+
+static inline void pbsys_storage_request_settings_write(void) {
+}
 
 #endif // PBSYS_CONFIG_STORAGE
 

lib/pbio/sys/bluetooth.c

@@ -21,6 +21,7 @@
 #include <pbsys/bluetooth.h>
 #include <pbsys/command.h>
 #include <pbsys/status.h>
+#include <pbsys/storage.h>
 
 #include "light.h"
 
@@ -202,10 +203,13 @@ bool pbsys_bluetooth_tx_is_idle(void) {
     return !send_busy && lwrb_get_full(&stdout_ring_buf) == 0;
 }
 
-static bool pbsys_bluetooth_user_enabled = true;
+static pbsys_storage_settings_t *settings;
 
 bool pbsys_bluetooth_is_user_enabled(void) {
-    return pbsys_bluetooth_user_enabled;
+    if (!settings) {
+        return false;
+    }
+    return settings->bluetooth_ble_user_enabled;
 }
 
 void pbsys_bluetooth_is_user_enabled_request_toggle(void) {
@@ -219,13 +223,14 @@ void pbsys_bluetooth_is_user_enabled_request_toggle(void) {
         || pbdrv_bluetooth_is_connected(PBDRV_BLUETOOTH_CONNECTION_LE)
         || pbdrv_bluetooth_is_connected(PBDRV_BLUETOOTH_CONNECTION_PERIPHERAL)
         // Ignore if last request not yet finished processing.
-        || pbsys_bluetooth_user_enabled != pbdrv_bluetooth_is_ready()
+        || settings->bluetooth_ble_user_enabled != pbdrv_bluetooth_is_ready()
         ) {
         return;
     }
 
     // Toggle the user enabled state and poll process to take action.
-    pbsys_bluetooth_user_enabled = !pbsys_bluetooth_user_enabled;
+    settings->bluetooth_ble_user_enabled = !settings->bluetooth_ble_user_enabled;
+    pbsys_storage_request_settings_write();
     pbsys_bluetooth_process_poll();
 }
 
@@ -316,6 +321,8 @@ PROCESS_THREAD(pbsys_bluetooth_process, ev, data) {
 
     PROCESS_BEGIN();
 
+    PROCESS_WAIT_EVENT_UNTIL(pbsys_storage_get_settings(&settings) == PBIO_SUCCESS);
+
     pbdrv_bluetooth_set_on_event(pbsys_bluetooth_process_poll);
     pbdrv_bluetooth_set_receive_handler(handle_receive);
 
@@ -325,7 +332,7 @@ PROCESS_THREAD(pbsys_bluetooth_process, ev, data) {
         PROCESS_WAIT_EVENT_UNTIL(ev == PROCESS_EVENT_TIMER && etimer_expired(&timer));
 
         // Wait until Bluetooth enabled requested by user, but stop waiting on shutdown.
-        PROCESS_WAIT_UNTIL(pbsys_bluetooth_user_enabled || pbsys_status_test(PBIO_PYBRICKS_STATUS_SHUTDOWN));
+        PROCESS_WAIT_UNTIL(settings->bluetooth_ble_user_enabled || pbsys_status_test(PBIO_PYBRICKS_STATUS_SHUTDOWN));
         if (pbsys_status_test(PBIO_PYBRICKS_STATUS_SHUTDOWN)) {
             break;
         }
@@ -346,7 +353,7 @@ PROCESS_THREAD(pbsys_bluetooth_process, ev, data) {
             pbdrv_bluetooth_is_connected(PBDRV_BLUETOOTH_CONNECTION_LE)
             || pbsys_status_test(PBIO_PYBRICKS_STATUS_USER_PROGRAM_RUNNING)
             || pbsys_status_test(PBIO_PYBRICKS_STATUS_SHUTDOWN)
-            || !pbsys_bluetooth_user_enabled);
+            || !settings->bluetooth_ble_user_enabled);
 
         // Now change the state depending on which of the above was triggered.
 
@@ -365,7 +372,7 @@ PROCESS_THREAD(pbsys_bluetooth_process, ev, data) {
         // The Bluetooth enabled flag can only change while disconnected and
         // while no program is running. So here it just serves to skip the
         // Bluetooth loop below and go directly to the disable step below it.
-        while (pbsys_bluetooth_user_enabled
+        while (settings->bluetooth_ble_user_enabled
                && pbdrv_bluetooth_is_connected(PBDRV_BLUETOOTH_CONNECTION_LE)
                && !pbsys_status_test(PBIO_PYBRICKS_STATUS_SHUTDOWN)) {
 
@@ -406,7 +413,7 @@ PROCESS_THREAD(pbsys_bluetooth_process, ev, data) {
 
         // Indicate status only if user requested Bluetooth to be disabled to
         // avoid always flashing red in between program runs when disconnected.
-        if (!pbsys_bluetooth_user_enabled) {
+        if (!settings->bluetooth_ble_user_enabled) {
             pbsys_status_light_bluetooth_set_color(PBIO_COLOR_RED);
         }
 

lib/pbio/sys/storage.c

@@ -31,6 +31,8 @@ union {
 
 static pbsys_storage_data_map_t *map = &pbsys_user_ram_data_map.data_map;
 
+static bool data_map_is_loaded = false;
+
 /**
  * Sets write size to how much data must be written on shutdown. This is not
  * simply a boolean flag because it is also used as the load size on boot.
@@ -76,6 +78,30 @@ pbio_error_t pbsys_storage_get_user_data(uint32_t offset, uint8_t **data, uint32
     return PBIO_SUCCESS;
 }
 
+/**
+ * Requests that settings will be saved on shutdown. Should be called by
+ * functions that change user settings.
+ */
+void pbsys_storage_request_settings_write(void) {
+    update_write_size();
+}
+
+/**
+ * Gets the stored system settings.
+ *
+ * @param [out] settings   The settings.
+ * @returns                ::PBIO_ERROR_AGAIN if settings still being loaded.
+ *                         Otherwise, ::PBIO_SUCCESS.
+ */
+pbio_error_t pbsys_storage_get_settings(pbsys_storage_settings_t **settings) {
+    if (!data_map_is_loaded) {
+        return PBIO_ERROR_AGAIN;
+    }
+
+    *settings = &map->settings;
+    return PBIO_SUCCESS;
+}
+
 #if PBSYS_CONFIG_STORAGE_OVERLAPS_BOOTLOADER_CHECKSUM
 // Updates checksum in data map to satisfy bootloader requirements.
 static void pbsys_storage_update_checksum(void) {
@@ -236,6 +262,10 @@ PROCESS_THREAD(pbsys_storage_process, ev, data) {
         update_write_size();
     }
 
+    // Poke processes that await on system settings to become available.
+    data_map_is_loaded = true;
+    process_post(PROCESS_BROADCAST, PROCESS_EVENT_COM, NULL);
+
     // Initialization done.
     pbsys_init_busy_down();