Merge branch 'master' into feat/nand_flash_bdl_support

Author: RathiSonika

.idf_build_apps.toml

@@ -8,6 +8,7 @@ manifest_file = [
     "ccomp_timer/.build-test-rules.yml",
     "coremark/.build-test-rules.yml",
     "esp_daylight/.build-test-rules.yml",
+    "esp_delta_ota/.build-test-rules.yml",
     "esp_cli_commands/.build-test-rules.yml",
     "esp_encrypted_img/.build-test-rules.yml",
     "esp_flash_dispatcher/.build-test-rules.yml",

esp_cli_commands/idf_component.yml

@@ -1,4 +1,4 @@
-version: "0.1.2"
+version: "0.1.3"
 description: "esp_cli_commands - Command handling component"
 url: https://github.com/espressif/idf-extra-components/tree/master/esp_cli_commands
 dependencies:

esp_cli_commands/src/esp_cli_commands.c

@@ -129,11 +129,11 @@ void go_through_commands(esp_cli_command_sets_t *cmd_sets, void *cmd_walker_ctx,
     }
 
     esp_cli_command_set_t *dynamic_set = cmd_sets ? &cmd_sets->dynamic_set : NULL;
-    /* it is possible that the set is empty, in which case set dynamic_set to NULL
-     * to prevent the for loop to try to access a list of commands pointer set to NULL */
-    if (dynamic_set && !dynamic_set->cmd_ptr_set) {
-        dynamic_set = NULL;
-    }
+    /* Note: unlike FOR_EACH_STATIC_COMMAND which uses the comma operator,
+     * FOR_EACH_DYNAMIC_COMMAND uses && short-circuit evaluation, so it is safe
+     * to pass a set with cmd_ptr_set == NULL and cmd_set_size == 0.
+     * We must NOT null out the set here, because FOR_EACH_DYNAMIC_COMMAND(NULL, ...)
+     * means "walk ALL dynamic commands", bypassing the set filter. */
     esp_cli_dynamic_commands_lock();
     FOR_EACH_DYNAMIC_COMMAND(dynamic_set, cmd) {
         continue_walk = cmd_walker(cmd_walker_ctx, cmd);
@@ -325,6 +325,13 @@ esp_cli_command_t *esp_cli_commands_find_command(esp_cli_command_set_handle_t cm
     find_cmd_ctx_t ctx = { .cmd = NULL, .name = name };
     go_through_commands(cmd_set, &ctx, compare_command_name);
 
+    /* The "help" command is a built-in registered by esp_cli_commands itself.
+     * It must always be found regardless of the command set passed by the user.
+     * If not found in the filtered set, search all commands. */
+    if (!ctx.cmd && cmd_set != NULL && strcmp(name, "help") == 0) {
+        go_through_commands(NULL, &ctx, compare_command_name);
+    }
+
     /* if command was found during the walk, cmd field will be populated with
      * the command matching the name given in parameter, otherwise it will still
      * be NULL (value set as default value above) */
@@ -541,6 +548,12 @@ void esp_cli_commands_get_completion(esp_cli_command_set_handle_t cmd_set, const
         .completion_cb = completion_cb
     };
     go_through_commands(cmd_set, &ctx, call_completion_cb);
+
+    /* The "help" command is a built-in that must always be completable
+     * regardless of the command set */
+    if (cmd_set != NULL && len <= 4 && strncmp(buf, "help", len) == 0) {
+        completion_cb(cb_ctx, "help");
+    }
 }
 
 const char *esp_cli_commands_get_hint(esp_cli_command_set_handle_t cmd_set, const char *buf, int *color, bool *bold)
@@ -740,6 +753,22 @@ static int help_command(void *context, esp_cli_commands_exec_arg_t *cmd_args, in
     };
     go_through_commands(cmd_sets, &ctx, call_command_funcs);
 
+    /* The "help" command is a built-in that must always appear in listings
+     * regardless of the command set */
+    if (cmd_sets != NULL) {
+        esp_cli_command_t *help_cmd = esp_cli_commands_find_command(NULL, "help");
+        if (help_cmd) {
+            if (!command_name) {
+                /* Listing all commands: also print the help entry */
+                print_verbose_level_arr[verbose_level](cmd_args, help_cmd);
+            } else if (strcmp(command_name, "help") == 0) {
+                /* User asked specifically for "help help" */
+                print_verbose_level_arr[verbose_level](cmd_args, help_cmd);
+                ctx.command_found = true;
+            }
+        }
+    }
+
     if (command_name && !ctx.command_found) {
         ESP_CLI_COMMANDS_FD_PRINT(cmd_args->out_fd, cmd_args->write_func, "help: invalid command name %s\n", command_name);
         return 1;

esp_delta_ota/.build-test-rules.yml

@@ -0,0 +1,9 @@
+esp_delta_ota/examples:
+  enable:
+    - if: IDF_TARGET == "esp32"
+      reason: Delta OTA example currently only tested on ESP32
+
+esp_delta_ota/test_apps:
+  enable:
+    - if: IDF_TARGET == "esp32"
+      reason: Delta OTA test app currently only tested on ESP32

esp_delta_ota/examples/https_delta_ota/CMakeLists.txt

@@ -1,7 +1,6 @@
 # The following lines of boilerplate have to be in your project's CMakeLists
 # in this exact order for cmake to work correctly
-cmake_minimum_required(VERSION 3.5)
+cmake_minimum_required(VERSION 3.16)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-set(COMPONENTS main)
 project(https_delta_ota)

esp_delta_ota/examples/https_delta_ota/main/CMakeLists.txt

@@ -1,4 +1,21 @@
-idf_component_register(SRCS "main.c"
-                    INCLUDE_DIRS "."
-                    EMBED_TXTFILES ca_cert.pem
-                    PRIV_REQUIRES esp_http_client esp_partition nvs_flash app_update esp_timer esp_wifi console)
+set(SRCS "main.c")
+set(INCLUDE_DIRS ".")
+set(EMBED_TXTFILES "tests/certs/servercert.pem")
+set(PRIV_REQS "esp_http_client esp_partition nvs_flash app_update esp_timer esp_wifi console")
+
+if(CONFIG_EXAMPLE_ENABLE_CI_TEST)
+    list(APPEND SRCS
+        "tests/test_local_server_ota.c")
+    list(APPEND INCLUDE_DIRS "tests")
+    list(APPEND EMBED_TXTFILES "tests/certs/prvtkey.pem")
+endif()
+
+idf_component_register(SRCS ${SRCS}
+                    INCLUDE_DIRS ${INCLUDE_DIRS}
+                    EMBED_TXTFILES ${EMBED_TXTFILES}
+                    PRIV_REQUIRES ${PRIV_REQS})
+
+
+if(CONFIG_EXAMPLE_ENABLE_CI_TEST)
+    target_link_libraries(${COMPONENT_LIB} PRIVATE idf::esp_https_server)
+endif()

esp_delta_ota/examples/https_delta_ota/main/Kconfig.projbuild

@@ -24,4 +24,14 @@ menu "Example Configuration"
         help
             Maximum time for reception
 
+    config EXAMPLE_FIRMWARE_UPG_URL_FROM_STDIN
+        bool
+        default y if EXAMPLE_FIRMWARE_UPG_URL = "FROM_STDIN"
+
+    config EXAMPLE_ENABLE_CI_TEST
+        bool "Enable the CI test code"
+        default n
+        help
+            This enables the CI test code i.e. https local server code.
+
 endmenu

esp_delta_ota/examples/https_delta_ota/main/main.c

@@ -36,13 +36,18 @@
 #define BUFFSIZE 1024
 #define PATCH_HEADER_SIZE 64
 #define DIGEST_SIZE 32
+#define OTA_URL_SIZE 256
 static uint32_t esp_delta_ota_magic = 0xfccdde10;
 
 static const char *TAG = "https_delta_ota_example";
 
 static char ota_write_data[BUFFSIZE + 1] = { 0 };
-extern const uint8_t server_cert_pem_start[] asm("_binary_ca_cert_pem_start");
-extern const uint8_t server_cert_pem_end[] asm("_binary_ca_cert_pem_end");
+extern const uint8_t server_cert_pem_start[] asm("_binary_servercert_pem_start");
+extern const uint8_t server_cert_pem_end[] asm("_binary_servercert_pem_end");
+
+#ifdef CONFIG_EXAMPLE_ENABLE_CI_TEST
+#include "test_local_server_ota.h"
+#endif
 
 const esp_partition_t *current_partition, *destination_partition;
 static esp_ota_handle_t ota_handle;
@@ -156,6 +161,24 @@ static void ota_example_task(void *pvParameter)
     config.skip_cert_common_name_check = true;
 #endif
 
+#ifdef CONFIG_EXAMPLE_ENABLE_CI_TEST
+    ESP_LOGI(TAG, "Reading OTA URL from stdin");
+    delta_ota_test_firmware_data_from_stdin(&config.url);
+#elif defined(CONFIG_EXAMPLE_FIRMWARE_UPG_URL_FROM_STDIN)
+    if (strcmp(config.url, "FROM_STDIN") == 0) {
+        ESP_LOGI(TAG, "Reading OTA URL from stdin");
+        char url_buf[OTA_URL_SIZE];
+        example_configure_stdin_stdout();
+        fgets(url_buf, OTA_URL_SIZE, stdin);
+        int len = strlen(url_buf);
+        url_buf[len - 1] = '\0';
+        config.url = url_buf;
+    } else {
+        ESP_LOGE(TAG, "Configuration mismatch: wrong firmware upgrade image url");
+        abort();
+    }
+#endif
+
     esp_http_client_handle_t client = esp_http_client_init(&config);
     if (client == NULL) {
         ESP_LOGE(TAG, "Failed to initialise HTTP connection");
@@ -273,5 +296,12 @@ void app_main(void)
      * examples/protocols/README.md for more information about this function.
      */
     ESP_ERROR_CHECK(example_connect());
+
+#ifdef CONFIG_EXAMPLE_ENABLE_CI_TEST
+    /* Start the local HTTPS server for CI test */
+    ESP_ERROR_CHECK(delta_ota_test_start_webserver());
+    ESP_LOGI(TAG, "Local HTTPS server started for CI test");
+#endif
+
     xTaskCreate(&ota_example_task, "ota_example_task", 8192, NULL, 5, NULL);
 }

esp_delta_ota/examples/https_delta_ota/main/tests/certs/prvtkey.pem

@@ -0,0 +1,28 @@
+-----BEGIN PRIVATE KEY-----
+MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDhxF/y7bygndxP
+wiWLSwS9LY3uBMaJgup0ufNKVhx+FhGQOu44SghuJAaH3KkPUnt6SOM8jC97/yQu
+c32WukI7eBZoA12kargSnzdv5m5rZZpd+NznSSpoDArOAONKVlzr25A1+aZbix2m
+KRbQS5w9o1N2BriQuSzd8gL0Y0zEk3VkOWXEL+0yFUT144HnErnD+xnJtHe11yPO
+2fEzYaGiilh0ddL26PXTugXMZN/8fRVHP50P2OG0SvFpC7vghlLp4VFM1/r3UJnv
+L6Oz3ALc6dhxZEKQucqlpj8l1UegszQToopemtIj0qXTHw2+uUnkUyWIPjPC+wdO
+AoaprFTRAgMBAAECggEAE0HCxV/N1Q1h+1OeDDGL5+74yjKSFKyb/vTVcaPCrmaH
+fPvp0ddOvMZJ4FDMAsiQS6/n4gQ7EKKEnYmwTqj4eUYW8yxGUn3f0YbPHbZT+Mkj
+z5woi3nMKi/MxCGDQZX4Ow3xUQlITUqibsfWcFHis8c4mTqdh4qj7xJzehD2PVYF
+gNHZsvVj6MltjBDAVwV1IlGoHjuElm6vuzkfX7phxcA1B4ZqdYY17yCXUnvui46z
+Xn2kUTOOUCEgfgvGa9E+l4OtdXi5IxjaSraU+dlg2KsE4TpCuN2MEVkeR5Ms3Y7Q
+jgJl8vlNFJDQpbFukLcYwG7rO5N5dQ6WWfVia/5XgQKBgQD74at/bXAPrh9NxPmz
+i1oqCHMDoM9sz8xIMZLF9YVu3Jf8ux4xVpRSnNy5RU1gl7ZXbpdgeIQ4v04zy5aw
+8T4tu9K3XnR3UXOy25AK0q+cnnxZg3kFQm+PhtOCKEFjPHrgo2MUfnj+EDddod7N
+JQr9q5rEFbqHupFPpWlqCa3QmQKBgQDldWUGokNaEpmgHDMnHxiibXV5LQhzf8Rq
+gJIQXb7R9EsTSXEvsDyqTBb7PHp2Ko7rZ5YQfyf8OogGGjGElnPoU/a+Jij1gVFv
+kZ064uXAAISBkwHdcuobqc5EbG3ceyH46F+FBFhqM8KcbxJxx08objmh58+83InN
+P9Qr25Xw+QKBgEGXMHuMWgQbSZeM1aFFhoMvlBO7yogBTKb4Ecpu9wI5e3Kan3Al
+pZYltuyf+VhP6XG3IMBEYdoNJyYhu+nzyEdMg8CwXg+8LC7FMis/Ve+o7aS5scgG
+1to/N9DK/swCsdTRdzmc/ZDbVC+TuVsebFBGYZTyO5KgqLpezqaIQrTxAoGALFCU
+10glO9MVyl9H3clap5v+MQ3qcOv/EhaMnw6L2N6WVT481tnxjW4ujgzrFcE4YuxZ
+hgwYu9TOCmeqopGwBvGYWLbj+C4mfSahOAs0FfXDoYazuIIGBpuv03UhbpB1Si4O
+rJDfRnuCnVWyOTkl54gKJ2OusinhjztBjcrV1XkCgYEA3qNi4uBsPdyz9BZGb/3G
+rOMSw0CaT4pEMTLZqURmDP/0hxvTk1polP7O/FYwxVuJnBb6mzDa0xpLFPTpIAnJ
+YXB8xpXU69QVh+EBbemdJWOd+zp5UCfXvb2shAeG3Tn/Dz4cBBMEUutbzP+or0nG
+vSXnRLaxQhooWm+IuX9SuBQ=
+-----END PRIVATE KEY-----

esp_delta_ota/examples/https_delta_ota/main/tests/certs/servercert.pem

@@ -0,0 +1,20 @@
+-----BEGIN CERTIFICATE-----
+MIIDWDCCAkACCQCbF4+gVh/MLjANBgkqhkiG9w0BAQsFADBuMQswCQYDVQQGEwJJ
+TjELMAkGA1UECAwCTUgxDDAKBgNVBAcMA1BVTjEMMAoGA1UECgwDRVNQMQwwCgYD
+VQQLDANFU1AxDDAKBgNVBAMMA0VTUDEaMBgGCSqGSIb3DQEJARYLZXNwQGVzcC5j
+b20wHhcNMjEwNzEyMTIzNjI3WhcNNDEwNzA3MTIzNjI3WjBuMQswCQYDVQQGEwJJ
+TjELMAkGA1UECAwCTUgxDDAKBgNVBAcMA1BVTjEMMAoGA1UECgwDRVNQMQwwCgYD
+VQQLDANFU1AxDDAKBgNVBAMMA0VTUDEaMBgGCSqGSIb3DQEJARYLZXNwQGVzcC5j
+b20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDhxF/y7bygndxPwiWL
+SwS9LY3uBMaJgup0ufNKVhx+FhGQOu44SghuJAaH3KkPUnt6SOM8jC97/yQuc32W
+ukI7eBZoA12kargSnzdv5m5rZZpd+NznSSpoDArOAONKVlzr25A1+aZbix2mKRbQ
+S5w9o1N2BriQuSzd8gL0Y0zEk3VkOWXEL+0yFUT144HnErnD+xnJtHe11yPO2fEz
+YaGiilh0ddL26PXTugXMZN/8fRVHP50P2OG0SvFpC7vghlLp4VFM1/r3UJnvL6Oz
+3ALc6dhxZEKQucqlpj8l1UegszQToopemtIj0qXTHw2+uUnkUyWIPjPC+wdOAoap
+rFTRAgMBAAEwDQYJKoZIhvcNAQELBQADggEBAItw24y565k3C/zENZlxyzto44ud
+IYPQXN8Fa2pBlLe1zlSIyuaA/rWQ+i1daS8nPotkCbWZyf5N8DYaTE4B0OfvoUPk
+B5uGDmbuk6akvlB5BGiYLfQjWHRsK9/4xjtIqN1H58yf3QNROuKsPAeywWS3Fn32
+3//OpbWaClQePx6udRYMqAitKR+QxL7/BKZQsX+UyShuq8hjphvXvk0BW8ONzuw9
+RcoORxM0FzySYjeQvm4LhzC/P3ZBhEq0xs55aL2a76SJhq5hJy7T/Xz6NFByvlrN
+lFJJey33KFrAf5vnV9qcyWFIo7PYy2VsaaEjFeefr7q3sTFSMlJeadexW2Y=
+-----END CERTIFICATE-----