diff --git a/components/nvs_flash/include/nvs_flash.h b/components/nvs_flash/include/nvs_flash.h index eafca2ce18..f2d2e00656 100644 --- a/components/nvs_flash/include/nvs_flash.h +++ b/components/nvs_flash/include/nvs_flash.h @@ -62,6 +62,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 * @@ -119,6 +133,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 0357494168..37defc42cc 100644 --- a/components/nvs_flash/src/nvs_api.cpp +++ b/components/nvs_flash/src/nvs_api.cpp @@ -143,9 +143,9 @@ 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) +static esp_err_t close_handles_and_deinit(const char* partition_name) { - nvs::Storage* storage = lookup_storage_from_name(part_name); + nvs::Storage* storage = lookup_storage_from_name(partition_name); if (!storage) { return ESP_ERR_NVS_NOT_INITIALIZED; } @@ -164,7 +164,7 @@ static esp_err_t close_handles_and_deinit(const char* part_name) next++; if (it->mStoragePtr == storage) { ESP_LOGD(TAG, "Deleting handle %d (ns=%d) related to partition \"%s\" (missing call to nvs_close?)", - it->mHandle, it->mNsIndex, part_name); + it->mHandle, it->mNsIndex, partition_name); s_nvs_handles.erase(it); delete static_cast(it); } @@ -178,6 +178,20 @@ static esp_err_t close_handles_and_deinit(const char* part_name) return ESP_OK; } +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) { @@ -257,6 +271,23 @@ 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 (lookup_storage_from_name(partition->label)) { + close_handles_and_deinit(partition->label); + } + + return esp_partition_erase_range(partition, 0, partition->size); +} + extern "C" esp_err_t nvs_flash_erase() { return nvs_flash_erase_partition(NVS_DEFAULT_PART_NAME);