zpal_nvm.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Silicon Laboratories Inc. <https://www.silabs.com/>
//
// SPDX-License-Identifier: BSD-3-Clause

 
#ifndef ZPAL_NVM_H_
#define ZPAL_NVM_H_
 
#include <stdint.h>
#include <stddef.h>
#include "zpal_status.h"
 
#ifdef __cplusplus
extern "C" {
#endif


typedef enum {
  ZPAL_NVM_AREA_APPLICATION,          
  ZPAL_NVM_AREA_ZAF,                  
  ZPAL_NVM_AREA_STACK,                
  ZPAL_NVM_AREA_MANUFACTURER_TOKENS,  
} zpal_nvm_area_t;

typedef uint32_t zpal_nvm_object_key_t;

typedef void * zpal_nvm_handle_t;

zpal_nvm_handle_t zpal_nvm_init(zpal_nvm_area_t area);

zpal_status_t zpal_nvm_close(zpal_nvm_handle_t handle);

zpal_status_t zpal_nvm_read(zpal_nvm_handle_t handle, zpal_nvm_object_key_t key, void *object, size_t object_size);

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);

zpal_status_t zpal_nvm_write(zpal_nvm_handle_t handle, zpal_nvm_object_key_t key, const void *object, size_t object_size);

zpal_status_t zpal_nvm_erase_all(zpal_nvm_handle_t handle);

zpal_status_t zpal_nvm_erase_object(zpal_nvm_handle_t handle, zpal_nvm_object_key_t key);

zpal_status_t zpal_nvm_get_object_size(zpal_nvm_handle_t handle, zpal_nvm_object_key_t key, size_t *len);

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);

zpal_status_t zpal_nvm_backup_open(void);

zpal_status_t zpal_nvm_backup_close(void);

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

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

size_t zpal_nvm_backup_get_size(void);

zpal_status_t zpal_nvm_lock(zpal_nvm_handle_t handle);

zpal_status_t zpal_nvm_migrate_legacy_app_file_system(void);

 
#ifdef __cplusplus
}
#endif
 
#endif /* ZPAL_NVM_H_ */