Genericize MSC callback, allowing application to follow update progress

Author: wormyrocks

components/usb/esp_tinyuf2/esp_tinyuf2.c

@@ -229,7 +229,7 @@ esp_err_t esp_tinyuf2_install(tinyuf2_ota_config_t *ota_config, tinyuf2_nvs_conf
         if (ota_config->if_restart) {
             ESP_LOGW(TAG, "Enable restart, SoC will restart after update complete");
         }
-        board_flash_init(ota_config->subtype, ota_config->label, ota_config->complete_cb, ota_config->if_restart);
+        board_flash_init(ota_config->subtype, ota_config->label, ota_config->event_cb, ota_config->if_restart);
     }
 
     if (nvs_config) {

components/usb/esp_tinyuf2/esp_tinyuf2.h

@@ -26,11 +26,18 @@ extern "C" {
 
 #define UF2_RESET_REASON_VALUE (CONFIG_UF2_OTA_RESET_REASON_VALUE)
 
+typedef enum {
+    TINYUF2_UPDATE_COMPLETE = 0,
+    TINYUF2_UPDATE_PCT = 1,
+    TINYUF2_UPDATE_MOUNT = 2,
+    TINYUF2_UPDATE_EJECT = 3
+} uf2_update_event_t;
+
 /**
  * @brief user callback called after uf2 update complete
  *
  */
-typedef void (*update_complete_cb_t)(void);
+typedef void (*update_event_cb_t)(uf2_update_event_t, uint32_t);
 
 /**
  * @brief user callback called after nvs modified
@@ -46,7 +53,7 @@ typedef struct {
     esp_partition_subtype_t subtype;  /*!< Partition subtype. if ESP_PARTITION_SUBTYPE_ANY will use the next_update_partition by default. */
     const char *label;                /*!< Partition label. Set this value if looking for partition with a specific name. if subtype==ESP_PARTITION_SUBTYPE_ANY, label default to NULL.*/
     bool if_restart;                  /*!< if restart system to new app partition after UF2 flashing done */
-    update_complete_cb_t complete_cb; /*!< user callback called after uf2 update complete */
+    update_event_cb_t event_cb; /*!< user callback called after uf2 update complete */
 } tinyuf2_ota_config_t;
 
 /**

components/usb/esp_tinyuf2/msc/msc.c

@@ -184,6 +184,8 @@ void tud_msc_write10_complete_cb(uint8_t lun)
             ESP_LOGI(TAG, "STATE_WRITING_FINISHED");
             board_dfu_complete();
         }
+        else
+            board_event_cb(TINYUF2_UPDATE_PCT, _wr_state.numWritten * 100 / _wr_state.numBlocks);
     }
 }
 

components/usb/esp_tinyuf2/private_include/board_flash.h

@@ -83,6 +83,9 @@ extern char *_ini_file_dummy;
 // DFU is complete, should reset or jump to application mode and not return
 void board_dfu_complete(void);
 
+// Access to user callback from msc.c, etc
+void board_event_cb(uf2_update_event_t, uint32_t);
+
 // Fill Serial Number and return its length (limit to 16 bytes)
 uint8_t board_usb_get_serial(uint8_t serial_id[16]);
 
@@ -91,7 +94,7 @@ uint8_t board_usb_get_serial(uint8_t serial_id[16]);
 //--------------------------------------------------------------------+
 
 // Initialize flash for DFU
-void board_flash_init(esp_partition_subtype_t subtype, const char *label, update_complete_cb_t complete_cb, bool if_restart);
+void board_flash_init(esp_partition_subtype_t subtype, const char *label, update_event_cb_t event_cb, bool if_restart);
 void board_flash_deinit(void);
 
 // Initialize flash for NVS

components/usb/esp_tinyuf2/uf2/board_flash.c

@@ -57,7 +57,7 @@
 static uint32_t _fl_addr = FLASH_CACHE_INVALID_ADDR;
 static uint8_t *_fl_buf = NULL;
 static bool _if_restart = false;
-static update_complete_cb_t _complete_cb = NULL;
+static update_event_cb_t _event_cb = NULL;
 static esp_partition_t const* _part_ota = NULL;
 char *_ini_file = NULL;
 char *_ini_file_dummy = NULL;
@@ -77,14 +77,17 @@ uint8_t board_usb_get_serial(uint8_t serial_id[16])
     return 6;
 }
 
+void board_event_cb(uf2_update_event_t e, uint32_t p) {
+    if (!_event_cb)
+        return;
+    _event_cb(e, p);
+}
+
 void board_dfu_complete(void)
 {
     esp_ota_set_boot_partition(_part_ota);
 
-    if (_complete_cb) {
-        PRINTF("dfu_complete: run user callback");
-        _complete_cb();
-    }
+    board_event_cb(TINYUF2_UPDATE_COMPLETE, 0);
 
     if (_if_restart) {
         /* code */
@@ -94,11 +97,11 @@ void board_dfu_complete(void)
     }
 }
 
-void board_flash_init(esp_partition_subtype_t subtype, const char *label, update_complete_cb_t complete_cb, bool if_restart)
+void board_flash_init(esp_partition_subtype_t subtype, const char *label, update_event_cb_t event_cb, bool if_restart)
 {
     _fl_addr = FLASH_CACHE_INVALID_ADDR;
     _if_restart = if_restart;
-    _complete_cb = complete_cb;
+    _event_cb = event_cb;
 
     if (subtype == ESP_PARTITION_SUBTYPE_ANY) {
         _part_ota = esp_ota_get_next_update_partition(NULL);
@@ -261,6 +264,7 @@ static int nvs_write_back(void* user, const char* section, const char* name,
 {
     if (check_value_if_hidden(name) && strcmp(value, NVS_HIDDEN_PLACEHOLDER) == 0)
     {
+	 PRINTFD("Ignore %s", name); 
 	 return 1;
     }
     nvs_handle_t nvs = (nvs_handle_t)user;