Merge branch 'feat/bootloader_uf2' into 'master'

feat(bootloader_uf2): add bootloader uf2

See merge request ae_group/esp-iot-solution!1170

Author: lijunru-hub

.gitlab/ci/build.yml

@@ -700,6 +700,14 @@ build_example_ulp_lp_cpu_lp_environment_sensor:
   variables:
     EXAMPLE_DIR: examples/ulp/lp_cpu/lp_environment_sensor
 
+build_example_usb_device_bootloader_uf2:
+  extends:
+    - .build_examples_template
+    - .rules:build:example_usb_device_bootloader_uf2
+    - .build_idf_version_greater_equal_v5_0
+  variables:
+    EXAMPLE_DIR: examples/usb/device/bootloader_uf2
+
 build_example_usb_device_usb_dongle:
   extends:
     - .build_examples_template

.gitlab/ci/deploy.yml

@@ -95,6 +95,7 @@ pack-upload_files:
     - job: "build_example_display_lcd_rgb_avoid_tearing: [espressif/idf:release-v5.1]"
     - job: "build_example_display_lcd_rgb_lcd_8bit: [espressif/idf:release-v5.1]"
     - job: "build_example_keyboard: [espressif/idf:release-v5.3]"
+    - job: "build_example_usb_device_bootloader_uf2: [espressif/idf:release-v5.3]"
     - job: "build_example_usb_device_usb_dongle: [espressif/idf:release-v5.3]"
     - job: "build_example_usb_device_usb_dual_uvc_device: [espressif/idf:release-v5.3]"
     - job: "build_example_usb_device_usb_extend_screen"

.gitlab/ci/rules.yml

@@ -510,6 +510,9 @@
 .patterns-example_sensors_sensor_hub_monitor: &patterns-example_sensors_sensor_hub_monitor
   - "examples/sensors/sensor_hub_monitor/**/*"
 
+.patterns-example_usb_device_bootloader_uf2: &patterns-example_usb_device_bootloader_uf2
+  - "examples/usb/device/bootloader_uf2/**/*"
+
 .patterns-example_usb_device_usb_dongle: &patterns-example_usb_device_usb_dongle
   - "examples/usb/device/usb_dongle/**/*"
 
@@ -1256,6 +1259,17 @@
     - <<: *if-dev-push
       changes: *patterns-example_usb_device_usb_lcd_display
 
+.rules:build:example_usb_device_bootloader_uf2:
+  rules:
+    - <<: *if-protected
+    - <<: *if-label-build
+    - <<: *if-dev-push
+      changes: *patterns-build_system
+    - <<: *if-dev-push
+      changes: *patterns-components_usb_esp_tinyuf2
+    - <<: *if-dev-push
+      changes: *patterns-example_usb_device_bootloader_uf2
+
 .rules:build:example_usb_device_usb_dongle:
   rules:
     - <<: *if-protected

components/usb/esp_tinyuf2/CHANGELOG.md

@@ -1,5 +1,10 @@
 # ChangeLog
 
+## v1.1.0 - 2024-12-11
+
+* Support bootloader uf2
+* Support ESP32-P4
+
 ## v0.2.2 - 2024-06-19
 
 * Fix usb may not be enumerated after switch from usb-serial-jtag to usb-otg

components/usb/esp_tinyuf2/CMakeLists.txt

@@ -1,3 +1,8 @@
+if(BOOTLOADER_BUILD)
+    idf_component_register()
+    return()
+endif()
+
 idf_component_get_property(TUSB_PATH leeebo__tinyusb_src COMPONENT_DIR)
 idf_component_get_property(DCD_CORE_INCLUDES leeebo__tinyusb_src DCD_CORE_INCLUDES)
 idf_component_get_property(DCD_CORE_SRCS leeebo__tinyusb_src DCD_CORE_SRCS)

components/usb/esp_tinyuf2/Kconfig

@@ -2,7 +2,7 @@ menu "TinyUF2 Config"
     # We not support disable now
     config ENABLE_UF2_FLASHING
         bool
-        default y if IDF_TARGET_ESP32S2 || IDF_TARGET_ESP32S3
+        default y if IDF_TARGET_ESP32S2 || IDF_TARGET_ESP32S3 || IDF_TARGET_ESP32P4
         select TINYUSB_SOURCE_CODE_ONLY
         help
             Enable UF2, only support ESP SoC with USB-OTG
@@ -38,6 +38,7 @@ menu "TinyUF2 Config"
         depends on ENABLE_UF2_FLASHING
         default "ESP32S2-UF2" if IDF_TARGET_ESP32S2
         default "ESP32S3-UF2" if IDF_TARGET_ESP32S3
+        default "ESP32P4-UF2" if IDF_TARGET_ESP32P4
     config TUSB_MANUFACTURER
         string "USB Device Manufacture"
         depends on ENABLE_UF2_FLASHING
@@ -59,4 +60,38 @@ menu "TinyUF2 Config"
         depends on ENABLE_UF2_FLASHING
         default 512
         range 256 2048
+    config UF2_INI_NVS_VALUE_HIDDEN
+        bool "Enable UF2 ini file hide NVS value"
+        depends on ENABLE_UF2_FLASHING
+        default n
+    config UF2_INI_NVS_HIDDEN_MAX_NUM
+        int "UF2 ini file hide NVS value max number"
+        depends on UF2_INI_NVS_VALUE_HIDDEN
+        default 32
+    config UF2_OTA_FACTORY_ONLY
+        bool "OTA Factory Only"
+        help
+            Enable this option to limit the OTA updates to the factory partition only.
+    config UF2_OTA_RESET_REASON_VALUE
+        hex "OTA Reset Reason Value"
+        depends on ENABLE_UF2_FLASHING
+        default 0xF2
+        help
+            The reset value for uf2 ota reset.
+
+    choice TINYUSB_RHPORT
+        prompt "TinyUSB Root Port"
+        default TINYUSB_RHPORT_HS if IDF_TARGET_ESP32P4
+        default TINYUSB_RHPORT_FS
+        help
+            Allows set the USB PHY Controller for TinyUSB: HS (USB OTG2.0 PHY for HighSpeed)
+
+        config TINYUSB_RHPORT_HS
+            depends on IDF_TARGET_ESP32P4
+            bool "High Speed"
+
+        config TINYUSB_RHPORT_FS
+            bool "Full Speed"
+    endchoice
+
 endmenu

components/usb/esp_tinyuf2/esp_tinyuf2.c

@@ -12,7 +12,10 @@
 #include "soc/soc_caps.h"
 #include "soc/gpio_pins.h"
 #include "soc/gpio_sig_map.h"
+#if CONFIG_IDF_TARGET_ESP32S2 || CONFIG_IDF_TARGET_ESP32S3
 #include "soc/rtc_cntl_struct.h"
+#endif
+#include "esp_private/system_internal.h"
 #include "tusb.h"
 #include "esp_tinyuf2.h"
 #include "esp_private/usb_phy.h"
@@ -136,13 +139,15 @@ static void usb_device_task(void* param)
 }
 
 // To generate a disconnect event
+#if CONFIG_IDF_TARGET_ESP32S2 || CONFIG_IDF_TARGET_ESP32S3
 static void usbd_vbus_enable(bool enable)
 {
     esp_rom_gpio_connect_in_signal(enable ? GPIO_MATRIX_CONST_ONE_INPUT : GPIO_MATRIX_CONST_ZERO_INPUT, USB_OTG_VBUSVALID_IN_IDX, 0);
     esp_rom_gpio_connect_in_signal(enable ? GPIO_MATRIX_CONST_ONE_INPUT : GPIO_MATRIX_CONST_ZERO_INPUT, USB_SRP_BVALID_IN_IDX, 0);
     esp_rom_gpio_connect_in_signal(enable ? GPIO_MATRIX_CONST_ONE_INPUT : GPIO_MATRIX_CONST_ZERO_INPUT, USB_SRP_SESSEND_IN_IDX, 1);
     return;
 }
+#endif
 
 static esp_err_t tinyusb_init()
 {
@@ -154,7 +159,11 @@ static esp_err_t tinyusb_init()
     // init device stack on configured roothub port
     // This should be called after scheduler/kernel is started.
     // Otherwise it could cause kernel issue since USB IRQ handler does use RTOS queue API.
-    tud_init(BOARD_TUD_RHPORT);
+    bool usb_init = tusb_init();
+    if (!usb_init) {
+        ESP_LOGE(TAG, "USB Device Stack Init Fail");
+        return ESP_FAIL;
+    }
     xTaskCreatePinnedToCore(usb_device_task, "usbd", 4096, NULL, 5, &_task_handle, 0);
     return ESP_OK;
 }
@@ -171,8 +180,10 @@ static esp_err_t tinyusb_deinit()
 {
     //prepare to exit the task
     xTaskNotify(_task_handle, (uint32_t)xTaskGetCurrentTaskHandle(), eSetValueWithOverwrite);
+#if CONFIG_IDF_TARGET_ESP32S2 || CONFIG_IDF_TARGET_ESP32S3
     //we give a false signal to make disconnect event happen
     usbd_vbus_enable(false);
+#endif
     //wait for the task exit
     uint32_t notify = ulTaskNotifyTake(pdTRUE, pdMS_TO_TICKS(2000));
     if (!notify) {
@@ -202,10 +213,17 @@ esp_err_t esp_tinyuf2_install(tinyuf2_ota_config_t *ota_config, tinyuf2_nvs_conf
     }
 
     if (ota_config) {
+#ifndef CONFIG_UF2_OTA_FACTORY_ONLY
         if (ota_config->subtype < ESP_PARTITION_SUBTYPE_APP_OTA_MIN || (ota_config->subtype > ESP_PARTITION_SUBTYPE_APP_OTA_MAX && ota_config->subtype != ESP_PARTITION_SUBTYPE_ANY)) {
             ESP_LOGE(TAG, "Invalid partition type");
             return ESP_ERR_INVALID_ARG;
         }
+#else
+        if (ota_config->subtype != ESP_PARTITION_SUBTYPE_APP_FACTORY) {
+            ESP_LOGE(TAG, "Invalid partition type, only support factory partition");
+            return ESP_ERR_INVALID_ARG;
+        }
+#endif
         if (ota_config->if_restart) {
             ESP_LOGW(TAG, "Enable restart, SoC will restart after update complete");
         }
@@ -252,3 +270,9 @@ tinyuf2_state_t esp_tinyuf2_current_state(void)
 {
     return _uf2_state;
 }
+
+void esp_restart_from_tinyuf2(void)
+{
+    esp_reset_reason_set_hint(UF2_RESET_REASON_VALUE);
+    esp_restart();
+}

components/usb/esp_tinyuf2/esp_tinyuf2.h

@@ -24,6 +24,8 @@ extern "C" {
     .namespace_name = "tuf2",             \
 }
 
+#define UF2_RESET_REASON_VALUE (CONFIG_UF2_OTA_RESET_REASON_VALUE)
+
 /**
  * @brief user callback called after uf2 update complete
  *
@@ -96,6 +98,45 @@ esp_err_t esp_tinyuf2_uninstall(void);
  */
 tinyuf2_state_t esp_tinyuf2_current_state(void);
 
+/**
+ * @brief Restart system and set reset reason to UF2_RESET_REASON_VALUE
+ *
+ */
+void esp_restart_from_tinyuf2(void);
+
+#ifdef CONFIG_UF2_INI_NVS_VALUE_HIDDEN
+/**
+ * @brief Set the state of the "all keys hidden" flag.
+ *
+ * This function updates the global flag indicating whether all keys
+ * should be treated as hidden.
+ *
+ * @param[in] if_hidden Boolean flag to indicate the hidden state:
+ *                      - true: Set all keys as hidden.
+ *                      - false: Set all keys as visible.
+ *
+ * @return
+ *      - ESP_OK: Operation was successful.
+ */
+esp_err_t esp_tinyuf2_set_all_key_hidden(bool if_hidden)
+
+/**
+ * @brief Add a key to the hidden keys list.
+ *
+ * This function dynamically allocates memory to store a copy of the
+ * provided key and adds it to the list of hidden keys. It ensures
+ * that the maximum limit of hidden keys is not exceeded (CONFIG_UF2_INI_NVS_HIDDEN_MAX_NUM).
+ *
+ * @param[in] key A pointer to the null-terminated string representing the key to hide.
+ *
+ * @return
+ *      - ESP_OK: Key added successfully.
+ *      - ESP_ERR_INVALID_ARG: Provided key is NULL.
+ *      - ESP_ERR_NO_MEM: Memory allocation failed or maximum number of hidden keys exceeded.
+ */
+esp_err_t esp_tinyuf2_add_key_hidden(const char *key)
+#endif
+
 #ifdef __cplusplus
 }
 #endif

components/usb/esp_tinyuf2/idf_component.yml

@@ -1,7 +1,8 @@
-version: "1.0.0"
+version: "1.1.0"
 targets:
   - esp32s2
   - esp32s3
+  - esp32p4
 
 description: Enhanced TinyUF2 for ESP32Sx, support OTA update and NVS operate through USB MSC
 url: https://github.com/espressif/esp-iot-solution
@@ -14,11 +15,13 @@ dependencies:
   cmake_utilities: "0.*"
   leeebo/esp-inih: "0.*"
   leeebo/tinyusb_src:
-    version: ">=0.16.0~5"
+    version: "==0.16.0~6"
 
 examples:
   - path: ../../../examples/usb/device/usb_uf2_ota
   - path: ../../../examples/usb/device/usb_uf2_nvs
+  - path: ../../../examples/usb/device/bootloader_uf2
+
 sbom:
   supplier: 'Organization: Espressif Systems (Shanghai) CO LTD'
   originator: 'Organization: Espressif Systems (Shanghai) CO LTD'

components/usb/esp_tinyuf2/private_include/board_flash.h

@@ -47,6 +47,8 @@
 #define BOARD_UF2_FAMILY_ID     0xbfdd4eee
 #elif CONFIG_IDF_TARGET_ESP32S3
 #define BOARD_UF2_FAMILY_ID     0xc47e5767
+#elif CONFIG_IDF_TARGET_ESP32P4
+#define BOARD_UF2_FAMILY_ID     0x3d308e94
 #else
 #error unsupported MCUs
 #endif