This commit adds support for multiple NVS partitions. This provides application a flexibility to have multiple NVS partitions such as separate partition with read-only manufacturing data and read-write partition with configuration. Application can also use this to separate out application's configuration storage from system configuration. This feature does not change any of the basic property of NVS subsystem. The same-named namespaces across partitions are considered to be different namespaces. The original NVS API available for the applications remains unchanged. The only difference is that instead of first NVS partition in the partition table, it now operates on the partition with label "nvs" (which is default in the IDF provided partition table files). Additional APIs are provided to open a handle and erase NVS with partition name as a parameter. A test case is added in the host tests and it is made sure that all the host tests pass. nvs_rw_value app is also tested with multiple partitions. Signed-off-by: Amey Inamdar <amey.inamdar@gmail.com>
84 lines
2.8 KiB
C
84 lines
2.8 KiB
C
// 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.
|
|
#ifndef nvs_flash_h
|
|
#define nvs_flash_h
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include "nvs.h"
|
|
|
|
/**
|
|
* @brief Initialize the default NVS partition.
|
|
*
|
|
* This API initialises the default NVS partition. The default NVS partition
|
|
* is the one that is labelled "nvs" in the partition table.
|
|
*
|
|
* @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_NOT_FOUND if no partition with label "nvs" is found in the partition table
|
|
* - one of the error codes from the underlying flash storage driver
|
|
*/
|
|
esp_err_t nvs_flash_init(void);
|
|
|
|
/**
|
|
* @brief Initialize NVS flash storage for the specified partition.
|
|
*
|
|
* @param[in] partition_name Name (label) of the partition. Note that internally a reference to
|
|
* passed value is kept and it should be accessible for future operations
|
|
*
|
|
* @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_NOT_FOUND if specified partition is not found in the partition table
|
|
* - one of the error codes from the underlying flash storage driver
|
|
*/
|
|
esp_err_t nvs_flash_init_partition(const char *partition_name);
|
|
|
|
/**
|
|
* @brief Erase the default NVS partition
|
|
*
|
|
* This function erases all contents of the default NVS partition (one with label "nvs")
|
|
*
|
|
* @return
|
|
* - ESP_OK on success
|
|
* - ESP_ERR_NOT_FOUND if there is no NVS partition labeled "nvs" in the
|
|
* partition table
|
|
*/
|
|
esp_err_t nvs_flash_erase(void);
|
|
|
|
/**
|
|
* @brief Erase specified NVS partition
|
|
*
|
|
* This function erases all contents of specified NVS partition
|
|
*
|
|
* @param[in] part_name Name (label) of the partition to be erased
|
|
*
|
|
* @return
|
|
* - ESP_OK on success
|
|
* - ESP_ERR_NOT_FOUND if there is no NVS partition with the specified name
|
|
* in the partition table
|
|
*/
|
|
esp_err_t nvs_flash_erase_partition(const char *part_name);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
|
|
#endif /* nvs_flash_h */
|