alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-08-09 12:35:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add more details about pre-encrypted OTA scheme

Browse Source
This commit is contained in:
Mahavir Jain
2024-04-23 13:42:43 +05:30
parent b7a8e6102f
commit f2a03f27cf
2 changed files with 35 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
components/esp_https_ota/include/esp_https_ota.h
View File

@@ -1,5 +1,5 @@
/*
* SPDX-FileCopyrightText: 2017-2022 Espressif Systems (Shanghai) CO LTD
* SPDX-FileCopyrightText: 2017-2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
@@ -39,7 +39,10 @@ typedef enum {
typedef void *esp_https_ota_handle_t;
typedef esp_err_t(*http_client_init_cb_t)(esp_http_client_handle_t);
#if CONFIG_ESP_HTTPS_OTA_DECRYPT_CB
#if CONFIG_ESP_HTTPS_OTA_DECRYPT_CB || __DOXYGEN__
/**
* @brief ESP HTTPS OTA decrypt callback args
*/
typedef struct {
const char *data_in; /*!< Pointer to data to be decrypted */
size_t data_in_len; /*!< Input data length */
@@ -48,7 +51,7 @@ typedef struct {
} decrypt_cb_arg_t;
typedef esp_err_t(*decrypt_cb_t)(decrypt_cb_arg_t *args, void *user_ctx);
#endif // CONFIG_ESP_HTTPS_OTA_DECRYPT_CB
#endif // CONFIG_ESP_HTTPS_OTA_DECRYPT_CB || __DOXYGEN__
/**
* @brief ESP HTTPS OTA configuration
@@ -60,7 +63,7 @@ typedef struct {
bool partial_http_download; /*!< Enable Firmware image to be downloaded over multiple HTTP requests */
int max_http_request_size; /*!< Maximum request size for partial HTTP download */
uint32_t buffer_caps; /*!< The memory capability to use when allocating the buffer for OTA update. Default capability is MALLOC_CAP_DEFAULT */
#if CONFIG_ESP_HTTPS_OTA_DECRYPT_CB
#if CONFIG_ESP_HTTPS_OTA_DECRYPT_CB || __DOXYGEN__
decrypt_cb_t decrypt_cb; /*!< Callback for external decryption layer */
void *decrypt_user_ctx; /*!< User context for external decryption layer */
uint16_t enc_img_header_size; /*!< Header size of pre-encrypted ota image header */