sapi_nvm.h

Go to the documentation of this file.

#ifndef SAFEAPI_OS_NVM_H
#define SAFEAPI_OS_NVM_H
 
#include "safeapi/utils/status/sapi_status.h"
#include "safeapi/utils/types/sapi_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif

SAFEAPI_DECLARE_STORAGE(sapi_nvm_storage_t, 64U);

typedef struct sapi_nvm_impl_s *sapi_nvm_handle_t;

typedef struct sapi_nvm_config_s
{
    const char *region_name;   
    size_t      region_size;   
} sapi_nvm_config_t;

sapi_status_t sapi_nvm_open(sapi_nvm_storage_t *storage,
                             const sapi_nvm_config_t *config,
                             sapi_nvm_handle_t *out_handle);

sapi_status_t sapi_nvm_read(sapi_nvm_handle_t handle,
                             size_t offset,
                             void *out_buffer,
                             size_t buffer_size);

sapi_status_t sapi_nvm_write(sapi_nvm_handle_t handle,
                              size_t offset,
                              const void *buffer,
                              size_t buffer_size);

sapi_status_t sapi_nvm_sync(sapi_nvm_handle_t handle);

sapi_status_t sapi_nvm_close(sapi_nvm_handle_t handle);
 
/*
 * The backend vtable (sapi_nvm_backend_t) and sapi_nvm_register_backend()
 * live in safeapi_backend/nvm/sapi_nvm_backend.h, not here (ADR-021).
 * This header is the consumer-facing surface only.
 */
 
#ifdef __cplusplus
}
#endif
 
#endif /* SAFEAPI_OS_NVM_H */
 /* NVM */