zpal_nvm.h File Reference

#include <stdint.h>
#include <stddef.h>
#include "zpal_status.h"

Include dependency graph for zpal_nvm.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef uint32_t	zpal_nvm_object_key_t
	Data id type. Only the 20 least significant bits are used.
typedef void *	zpal_nvm_handle_t
	Defines the NVM handle type.

Enumerations
enum	zpal_nvm_area_t {   ZPAL_NVM_AREA_APPLICATION ,   ZPAL_NVM_AREA_ZAF ,   ZPAL_NVM_AREA_STACK ,   ZPAL_NVM_AREA_MANUFACTURER_TOKENS }
	Defines the different areas of NVM storage. More...

Functions
zpal_nvm_handle_t	zpal_nvm_init (zpal_nvm_area_t area)
	Initializes the NVM for a given area.
zpal_status_t	zpal_nvm_close (zpal_nvm_handle_t handle)
	Closes the NVM of a given handle.
zpal_status_t	zpal_nvm_read (zpal_nvm_handle_t handle, zpal_nvm_object_key_t key, void *object, size_t object_size)
	Reads object from a given area handle and given object key.
zpal_status_t	zpal_nvm_read_object_part (zpal_nvm_handle_t handle, zpal_nvm_object_key_t key, void *object, size_t offset, size_t object_size)
	Reads part of object from a given area handle and given object key.
zpal_status_t	zpal_nvm_write (zpal_nvm_handle_t handle, zpal_nvm_object_key_t key, const void *object, size_t object_size)
	Writes object to a given area handle and given object key.
zpal_status_t	zpal_nvm_erase_all (zpal_nvm_handle_t handle)
	Erases everything in a given area.
zpal_status_t	zpal_nvm_erase_object (zpal_nvm_handle_t handle, zpal_nvm_object_key_t key)
	Delete an object from NVM.
zpal_status_t	zpal_nvm_get_object_size (zpal_nvm_handle_t handle, zpal_nvm_object_key_t key, size_t *len)
	Get the object size identified with a given key from NVM.
size_t	zpal_nvm_enum_objects (zpal_nvm_handle_t handle, zpal_nvm_object_key_t *key_list, size_t key_list_size, zpal_nvm_object_key_t key_min, zpal_nvm_object_key_t key_max)
	Create a list of key for valid objects in NVM.
zpal_status_t	zpal_nvm_backup_open (void)
	Opens the NVM for a backup/restore operation.
void	zpal_nvm_backup_close (void)
	Closes the NVM after backup/restore operation.
zpal_status_t	zpal_nvm_backup_read (uint32_t offset, void *data, size_t data_length)
	Reads raw data from the NVM.
zpal_status_t	zpal_nvm_backup_write (uint32_t offset, const void *data, size_t data_length)
	Writes raw data to the NVM.
size_t	zpal_nvm_backup_get_size (void)
	Get size of raw NVM area.
zpal_status_t	zpal_nvm_lock (zpal_nvm_handle_t handle)
	Set write protection for storage.
zpal_status_t	zpal_nvm_migrate_legacy_app_file_system (void)
	Migrates 800s legacy application file system to shared app/protocol file system.

Detailed Description

Defines a platform abstraction layer for the Z-Wave NVM.

Copyright

2021 Silicon Laboratories Inc.