Implementation for Non-Volatile Storage (NVS) drivers Insterface APIs. More...

#include "interface/utils/meshx_nvs_interface.h"
#include "interface/logging/meshx_log.h"
#include "module_id.h"
#include "esp_err.h"
#include "nvs.h"

Include dependency graph for esp_nvs.c:

Go to the source code of this file.

Macros
#define	MESHX_NVS_NAMESPACE "MESHX_NVS"

Functions
meshx_err_t	meshx_nvs_plat_open (uintptr_t *p_nvs_handle)
	Open non-volatile storage with a given namespace from the default partition.

meshx_err_t	meshx_nvs_plat_close (uintptr_t p_nvs_handle)
	Close the non-volatile storage handle.

meshx_err_t	meshx_nvs_plat_read (uintptr_t p_nvs_handle, char const key, uint8_t p_data, uint16_t len)
	Read blob value for given key from non-volatile storage.

meshx_err_t	meshx_nvs_plat_write (uintptr_t p_nvs_handle, char const key, uint8_t const p_data, uint16_t len)
	Write a blob value to the non-volatile storage with a given key and namespace.

meshx_err_t	meshx_nvs_plat_erase (uintptr_t p_nvs_handle)
	Erase all key-value pairs in the given namespace.

meshx_err_t	meshx_nvs_plat_remove (uintptr_t p_nvs_handle, char const *key)
	Remove a key-value pair from the non-volatile storage with a given key and namespace.

meshx_err_t	meshx_nvs_plat_commit (uintptr_t p_nvs_handle)
	Commit changes to the non-volatile storage.

Detailed Description

Implementation for Non-Volatile Storage (NVS) drivers Insterface APIs.

Implementation for ESP Non-Volatile Storage (NVS) drivers operations.

Author: Pranjal Chanda

This file provides APIs to manage the Non-Volatile Storage (NVS) used in the platform driver system. It includes functions to read, write, erase, and manage key-value pairs stored persistently.

Author: Pranjal Chanda

Definition in file esp_nvs.c.

Macro Definition Documentation

◆ MESHX_NVS_NAMESPACE

#define MESHX_NVS_NAMESPACE "MESHX_NVS"

Definition at line 19 of file esp_nvs.c.

Function Documentation

◆ meshx_nvs_plat_close()

meshx_err_t meshx_nvs_plat_close ( uintptr_t p_nvs_handle )

Close the non-volatile storage handle.

Parameters

[in] p_nvs_handle Handle obtained with meshx_nvs_plat_open.

Returns

MESHX_SUCCESS if the handle was closed successfully
MESHX_ERR_PLAT for any platform error

Definition at line 72 of file esp_nvs.c.

{
 
    nvs_close((nvs_handle_t)p_nvs_handle);
 
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

◆ meshx_nvs_plat_commit()

meshx_err_t meshx_nvs_plat_commit ( uintptr_t p_nvs_handle )

Commit changes to the non-volatile storage.

Note: This function is a prototype and can be returned with MESHX_SUCCESS if no such platform function exists

Parameters

[in] p_nvs_handle Pointer to the opened handle.

Returns

MESHX_SUCCESS if the changes were committed successfully
MESHX_ERR_PLAT for any platform error

Definition at line 208 of file esp_nvs.c.

{
    esp_err_t err = ESP_OK;
 
    err = nvs_commit((nvs_handle_t)p_nvs_handle);
 
    if (err != ESP_OK)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "nvs_commit failed");
        return MESHX_ERR_PLAT;
    }
 
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

◆ meshx_nvs_plat_erase()

meshx_err_t meshx_nvs_plat_erase ( uintptr_t p_nvs_handle )

Erase all key-value pairs in the given namespace.

Parameters

[in] p_nvs_handle Pointer to the opened handle.

Returns

MESHX_SUCCESS if all key-value pairs were erased successfully
MESHX_ERR_PLAT for any platform error

Definition at line 156 of file esp_nvs.c.

{
    esp_err_t err = ESP_OK;
 
    err = nvs_erase_all((nvs_handle_t)p_nvs_handle);
 
    if (err != ESP_OK)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "nvs_erase_all failed");
        return MESHX_ERR_PLAT;
    }
 
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

◆ meshx_nvs_plat_open()

meshx_err_t meshx_nvs_plat_open ( uintptr_t * p_nvs_handle )

Open non-volatile storage with a given namespace from the default partition.

If CONFIG_BLE_MESH_SPECIFIC_PARTITION is not defined, this function will open the namespace from the default partition. Otherwise, it will open the namespace from the MESHX_NVS_PARTITION.

Parameters

[out] p_nvs_handle Pointer to the output variable populated with the opened handle.

Returns

MESHX_SUCCESS if the storage handle was opened successfully
MESHX_ERR_PLAT if p_nvs_handle is NULL

Definition at line 34 of file esp_nvs.c.

{
    if (p_nvs_handle == NULL)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "Invalid argument");
    }
 
    esp_err_t err = ESP_OK;
#ifndef CONFIG_BLE_MESH_SPECIFIC_PARTITION
    err = nvs_open(
        MESHX_NVS_NAMESPACE,
        NVS_READWRITE,
        (nvs_handle_t*)p_nvs_handle);
#else
    err = nvs_open_from_partition(
        MESHX_NVS_PARTITION,
        MESHX_NVS_NAMESPACE,
        NVS_READWRITE,
        (nvs_handle_t*)p_nvs_handle);
#endif /* CONFIG_BLE_MESH_SPECIFIC_PARTITION */
 
    if (err != ESP_OK)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "Failed to open NVS handle: %d", err);
        return MESHX_ERR_PLAT;
    }
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

◆ meshx_nvs_plat_read()

meshx_err_t meshx_nvs_plat_read	(	uintptr_t	p_nvs_handle,
		char const *	key,
		uint8_t *	p_data,
		uint16_t	len )

Read blob value for given key from non-volatile storage.

Parameters

[in]	p_nvs_handle	Handle obtained with meshx_nvs_plat_open.
[in]	key	Key name. Maximum length is (NVS_KEY_NAME_MAX_SIZE-1) characters. Shouldn't be empty.
[out]	p_data	Pointer to the output variable populated with the read blob value.
[in]	len	Length of the read blob value.

Returns

MESHX_SUCCESS if the blob value was read successfully
MESHX_ERR_PLAT if there is an internal error;

Definition at line 92 of file esp_nvs.c.

{
    esp_err_t err = ESP_OK;
 
    if (key == NULL || p_data == NULL || len == 0)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "Invalid argument");
        return MESHX_INVALID_ARG;
    }
 
    size_t read_len = len;
    err = nvs_get_blob((nvs_handle_t)p_nvs_handle, key, p_data, &read_len);
 
    if (err != ESP_OK)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "nvs_get_blob failed");
        return MESHX_ERR_PLAT;
    }
 
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

◆ meshx_nvs_plat_remove()

meshx_err_t meshx_nvs_plat_remove	(	uintptr_t	p_nvs_handle,
		char const *	key )

Remove a key-value pair from the non-volatile storage with a given key and namespace.

Parameters

[in]	p_nvs_handle	Pointer to the opened handle.
[in]	key	Key name. Maximum length is (NVS_KEY_NAME_MAX_SIZE-1) characters. Shouldn't be empty.

Returns

MESHX_SUCCESS if the key-value pair was removed successfully
MESHX_ERR_PLAT for any platform error

Definition at line 181 of file esp_nvs.c.

{
    esp_err_t err = ESP_OK;
 
    err = nvs_erase_key((nvs_handle_t)p_nvs_handle, key);
 
    if (err != ESP_OK)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "nvs_erase_key failed");
        return MESHX_ERR_PLAT;
    }
 
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

◆ meshx_nvs_plat_write()

meshx_err_t meshx_nvs_plat_write	(	uintptr_t	p_nvs_handle,
		char const *	key,
		uint8_t const *	p_data,
		uint16_t	len )

Write a blob value to the non-volatile storage with a given key and namespace.

Parameters

[in]	p_nvs_handle	Pointer to the opened handle.
[in]	key	Key name. Maximum length is (NVS_KEY_NAME_MAX_SIZE-1) characters. Shouldn't be empty.
[in]	p_data	Pointer to the data to write.
[in]	len	Number of bytes to write.

Returns

MESHX_SUCCESS if the value was written successfully
MESHX_ERR_PLAT for any platform error

Definition at line 126 of file esp_nvs.c.

{
    if (key == NULL || p_data == NULL || len == 0)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "Invalid argument");
        return MESHX_INVALID_ARG;
    }
 
    esp_err_t err = ESP_OK;
 
    err = nvs_set_blob((nvs_handle_t)p_nvs_handle, key, p_data, len);
 
    if (err != ESP_OK)
    {
        MESHX_LOGE(MODULE_ID_COMMON, "nvs_set_blob failed");
        return MESHX_ERR_PLAT;
    }
 
    return MESHX_SUCCESS;
}

Here is the caller graph for this function:

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ MESHX_NVS_NAMESPACE

Function Documentation

◆ meshx_nvs_plat_close()

◆ meshx_nvs_plat_commit()

◆ meshx_nvs_plat_erase()

◆ meshx_nvs_plat_open()

◆ meshx_nvs_plat_read()

◆ meshx_nvs_plat_remove()

◆ meshx_nvs_plat_write()