diff --git a/components/nvs_flash/include/nvs_flash.h b/components/nvs_flash/include/nvs_flash.h index 0f25e95ad8..a19f612b8f 100644 --- a/components/nvs_flash/include/nvs_flash.h +++ b/components/nvs_flash/include/nvs_flash.h @@ -61,6 +61,20 @@ esp_err_t nvs_flash_init(void); */ esp_err_t nvs_flash_init_partition(const char *partition_label); +/** + * @brief Initialize NVS flash storage for the partition specified by partition pointer. + * + * @param[in] partition pointer to a partition obtained by the ESP partition API. + * + * @return + * - ESP_OK if storage was successfully initialized + * - ESP_ERR_NVS_NO_FREE_PAGES if the NVS storage contains no empty pages + * (which may happen if NVS partition was truncated) + * - ESP_ERR_INVALID_ARG in case partition is NULL + * - one of the error codes from the underlying flash storage driver + */ +esp_err_t nvs_flash_init_partition_ptr(const esp_partition_t *partition); + /** * @brief Deinitialize NVS storage for the default NVS partition * @@ -111,6 +125,26 @@ esp_err_t nvs_flash_erase(void); esp_err_t nvs_flash_erase_partition(const char *part_name); +/** + * @brief Erase custom partition. + * + * Erase all content of specified custom partition. + * + * @note + * If the partition is initialized, this function first de-initializes it. + * Afterwards, the partition has to be initialized again to be used. + * + * @param[in] partition pointer to a partition obtained by the ESP partition API. + * + * @return + * - ESP_OK on success + * - ESP_ERR_NOT_FOUND if there is no partition with the specified + * parameters in the partition table + * - ESP_ERR_INVALID_ARG in case partition is NULL + * - one of the error codes from the underlying flash storage driver + */ +esp_err_t nvs_flash_erase_partition_ptr(const esp_partition_t *partition); + /** * @brief Initialize the default NVS partition. * diff --git a/components/nvs_flash/src/nvs_api.cpp b/components/nvs_flash/src/nvs_api.cpp index 7df027a820..a30b74ef77 100644 --- a/components/nvs_flash/src/nvs_api.cpp +++ b/components/nvs_flash/src/nvs_api.cpp @@ -115,6 +115,28 @@ extern "C" esp_err_t nvs_flash_secure_init_custom(const char *partName, uint32_t } #endif +static esp_err_t close_handles_and_deinit(const char* part_name) +{ + // Delete all corresponding open handles + s_nvs_handles.clearAndFreeNodes(); + + // Deinit partition + return NVSPartitionManager::get_instance()->deinit_partition(part_name); +} + +extern "C" esp_err_t nvs_flash_init_partition_ptr(const esp_partition_t *partition) +{ + Lock::init(); + Lock lock; + + if (!partition) { + return ESP_ERR_INVALID_ARG; + } + + return nvs_flash_init_custom(partition->label, + partition->address / SPI_FLASH_SEC_SIZE, + partition->size / SPI_FLASH_SEC_SIZE); +} #ifdef ESP_PLATFORM extern "C" esp_err_t nvs_flash_init_partition(const char *part_name) @@ -169,6 +191,28 @@ extern "C" esp_err_t nvs_flash_erase_partition(const char *part_name) return esp_partition_erase_range(partition, 0, partition->size); } +extern "C" esp_err_t nvs_flash_erase_partition_ptr(const esp_partition_t *partition) +{ + Lock::init(); + Lock lock; + + if (!partition) { + return ESP_ERR_INVALID_ARG; + } + + // if the partition is initialized, uninitialize it first + if (NVSPartitionManager::get_instance()->lookup_storage_from_name(partition->label)) { + const esp_err_t err = close_handles_and_deinit(partition->label); + + // only hypothetical/future case, deinit_partition() only fails if partition is uninitialized + if (err != ESP_OK) { + return err; + } + } + + return esp_partition_erase_range(partition, 0, partition->size); +} + extern "C" esp_err_t nvs_flash_erase(void) { return nvs_flash_erase_partition(NVS_DEFAULT_PART_NAME); @@ -180,11 +224,7 @@ extern "C" esp_err_t nvs_flash_deinit_partition(const char* partition_name) Lock::init(); Lock lock; - // Delete all corresponding open handles - s_nvs_handles.clearAndFreeNodes(); - - // Deinit partition - return nvs::NVSPartitionManager::get_instance()->deinit_partition(partition_name); + return close_handles_and_deinit(partition_name); } extern "C" esp_err_t nvs_flash_deinit(void)