retention.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_RETENTION_
#define ZEPHYR_INCLUDE_RETENTION_
 
#include <stdint.h>
#include <stddef.h>
#include <sys/types.h>
#include <zephyr/kernel.h>
#include <zephyr/device.h>
#include <zephyr/types.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef ssize_t (*retention_size_api)(const struct device *dev);
typedef int (*retention_is_valid_api)(const struct device *dev);
typedef int (*retention_read_api)(const struct device *dev, off_t offset, uint8_t *buffer,
                                  size_t size);
typedef int (*retention_write_api)(const struct device *dev, off_t offset,
                                   const uint8_t *buffer, size_t size);
typedef int (*retention_clear_api)(const struct device *dev);
 
struct retention_api {
        retention_size_api size;
        retention_is_valid_api is_valid;
        retention_read_api read;
        retention_write_api write;
        retention_clear_api clear;
};
 
ssize_t retention_size(const struct device *dev);
 
int retention_is_valid(const struct device *dev);
 
int retention_read(const struct device *dev, off_t offset, uint8_t *buffer, size_t size);
 
int retention_write(const struct device *dev, off_t offset, const uint8_t *buffer, size_t size);
 
int retention_clear(const struct device *dev);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_RETENTION_ */