Merge branch 'feature/nvs_allow_custom_part' into 'master'

NVS: allow custom partition

See merge request espressif/esp-idf!8910

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
  *
@@ -118,6 +132,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.
  *

components/nvs_flash/src/nvs_api.cpp

@@ -127,6 +127,20 @@ static esp_err_t close_handles_and_deinit(const char* part_name)
     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)
 {
@@ -193,6 +207,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);

components/nvs_flash/test_nvs_host/Makefile

@@ -26,6 +26,7 @@ SOURCE_FILES = \
 	test_nvs_handle.cpp \
 	test_nvs_storage.cpp \
 	test_nvs_cxx_api.cpp \
+	test_nvs_initialization.cpp \
 	crc.cpp \
 	main.cpp
 

components/nvs_flash/test_nvs_host/test_nvs_initialization.cpp

@@ -0,0 +1,48 @@
+// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+#include "catch.hpp"
+#include "nvs_partition_manager.hpp"
+#include "spi_flash_emulation.h"
+#include "esp_partition.h"
+#include "nvs.h"
+#include <string.h>
+
+using namespace nvs;
+
+TEST_CASE("nvs_flash_init_partition_ptr fails due to nullptr arg", "[nvs_custom_part]")
+{
+    const uint32_t NVS_FLASH_SECTOR = 6;
+    const uint32_t NVS_FLASH_SECTOR_COUNT_MIN = 3;
+    SpiFlashEmulator emu(10);
+
+    CHECK(nvs_flash_init_partition_ptr(nullptr) == ESP_ERR_INVALID_ARG);
+}
+
+TEST_CASE("nvs_flash_init_partition_ptr inits one partition", "[nvs_custom_part]")
+{
+    const uint32_t NVS_FLASH_SECTOR = 6;
+    const uint32_t NVS_FLASH_SECTOR_COUNT_MIN = 3;
+    SpiFlashEmulator emu(10);
+
+    esp_partition_t partition = {};
+    strcpy(partition.label, "test");
+    partition.address = NVS_FLASH_SECTOR * SPI_FLASH_SEC_SIZE;
+    partition.size = NVS_FLASH_SECTOR_COUNT_MIN * SPI_FLASH_SEC_SIZE;
+
+    CHECK(nvs_flash_init_partition_ptr(&partition) == ESP_OK);
+    CHECK(NVSPartitionManager::get_instance()->lookup_storage_from_name("test") != nullptr);
+    CHECK(NVSPartitionManager::get_instance()->deinit_partition("test") == ESP_OK);
+}
+
+