Zpal-nvm#

zpal_nvm_area_t#

zpal_nvm_area_t

Defines the different areas of NVM storage.

zpal_nvm_object_key_t#

typedef uint32_t zpal_nvm_object_key_t

Data id type.

Only the 20 least significant bits are used.

zpal_nvm_handle_t#

typedef void* zpal_nvm_handle_t

Defines the NVM handle type.

zpal_nvm_init#

zpal_nvm_handle_t zpal_nvm_init (zpal_nvm_area_t area)

Initializes the NVM for a given area.

Returns

• A valid NVM handle if successfully initialized. Otherwise it returns NULL.

zpal_nvm_close#

zpal_status_t zpal_nvm_close (zpal_nvm_handle_t handle)

Closes the NVM of a given handle.

Returns

• ZPAL_STATUS_OK if the file system was successfully closed and ZPAL_STATUS_FAIL otherwise.

zpal_nvm_read#

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.

Returns

• ZPAL_STATUS_OK if the object was successfully read and ZPAL_STATUS_FAIL otherwise.

zpal_nvm_read_object_part#

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.

Returns

• ZPAL_STATUS_OK if the object was successfully read and ZPAL_STATUS_FAIL otherwise.

zpal_nvm_write#

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.

Returns

• ZPAL_STATUS_OK if the object was successfully written and ZPAL_STATUS_FAIL otherwise.

zpal_nvm_erase_all#

zpal_status_t zpal_nvm_erase_all (zpal_nvm_handle_t handle)

Erases everything in a given area.

Returns

• ZPAL_STATUS_OK if the all objects was successfully erased and ZPAL_STATUS_FAIL otherwise.

zpal_nvm_erase_object#

zpal_status_t zpal_nvm_erase_object (zpal_nvm_handle_t handle, zpal_nvm_object_key_t key)

Delete an object from NVM.

Returns

• ZPAL_STATUS_OK on success and ZPAL_STATUS_FAIL otherwise.

zpal_nvm_get_object_size#

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.

Returns

• ZPAL_STATUS_OK on success and ZPAL_STATUS_FAIL otherwise.

zpal_nvm_enum_objects#

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.

Returns

• The number of keys written to the key list. This value is less than or equal to key_list_size.

zpal_nvm_backup_open#

zpal_status_t zpal_nvm_backup_open (void)

Opens the NVM for a backup/restore operation.

Returns

• ZPAL_STATUS_OK on success and ZPAL_STATUS_FAIL otherwise.

zpal_nvm_backup_close#

void zpal_nvm_backup_close (void)

Closes the NVM after backup/restore operation.

zpal_nvm_backup_read#

zpal_status_t zpal_nvm_backup_read (uint32_t offset, void *data, size_t data_length)

Reads raw data from the NVM.

Returns

• ZPAL_STATUS_OK if the data was successfully read and ZPAL_STATUS_FAIL otherwise.

zpal_nvm_backup_write#

zpal_status_t zpal_nvm_backup_write (uint32_t offset, const void *data, size_t data_length)

Writes raw data to the NVM.

Returns

• ZPAL_STATUS_OK if the data was successfully written and ZPAL_STATUS_FAIL otherwise.

zpal_nvm_backup_get_size#

size_t zpal_nvm_backup_get_size (void)

Get size of raw NVM area.

Returns

• Size of raw NVM area.

zpal_nvm_lock#

zpal_status_t zpal_nvm_lock (zpal_nvm_handle_t handle)

Set write protection for storage.

Returns

• ZPAL_STATUS_OK if the lock was set successfully, ZPAL_STATUS_FAIL otherwise.

zpal_nvm_migrate_legacy_app_file_system#

zpal_status_t zpal_nvm_migrate_legacy_app_file_system (void)

Migrates 800s legacy application file system to shared app/protocol file system.

Returns

• ZPAL_STATUS_OK if the file system was successfully migrated and ZPAL_STATUS_FAIL otherwise.