mmconfig.h

/*
 * Copyright 2023 Morse Micro
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#pragma once
 
#include <stddef.h>
#include <stdbool.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#define MMCONFIG_MAX_KEYLEN 32
 
enum mmconfig_result
{
    MMCONFIG_OK = 0, 
    MMCONFIG_DATA_ERASED = 1, 
    MMCONFIG_ERR_INVALID_KEY = -1, 
    MMCONFIG_ERR_FULL = -2, 
    MMCONFIG_ERR_NOT_FOUND = -3, 
    MMCONFIG_ERR_INCORRECT_TYPE = -4, 
    MMCONFIG_ERR_INVALID_PARTITION = -5, 
    MMCONFIG_ERR_INSUFFICIENT_MEMORY = -6, 
    MMCONFIG_ERR_OUT_OF_BOUNDS = -7, 
    MMCONFIG_ERR_NOT_SUPPORTED = -8, 
    MMCONFIG_ERR_WILDCARD_KEY = -9 
};
 
struct mmconfig_update_node
{
    const char *key;
 
    void *data;
 
    size_t size;
 
    bool data_malloced;
 
    struct mmconfig_update_node *next;
};
 
int mmconfig_eraseall(void);
 
enum mmconfig_result mmconfig_check_factory_partition_status(void);
 
int mmconfig_write_data(const char *key, const void *data, size_t size);
 
static inline int mmconfig_delete_key(const char *key)
{
    return mmconfig_write_data(key, NULL, 0);
}
 
int mmconfig_write_update_node_list(const struct mmconfig_update_node *node_list);
 
int mmconfig_write_string(const char *key, const char *value);
 
int mmconfig_read_string(const char *key, char *buffer, int bufsize);
 
int mmconfig_alloc_and_load(const char *key, void **data);
 
int mmconfig_write_int(const char *key, int value);
 
int mmconfig_read_int(const char *key, int *value);
 
int mmconfig_write_uint32(const char *key, uint32_t value);
 
int mmconfig_read_uint32(const char *key, uint32_t *value);
 
int mmconfig_write_bool(const char *key, bool value);
 
int mmconfig_read_bool(const char *key, bool *value);
 
int mmconfig_read_bytes(const char *key, void *buffer, uint32_t buffsize, uint32_t offset);
 
int mmconfig_validate_key(const char *key);
 
int mmconfig_validate_key_character(char character);
 
int mmconfig_check_usage(const struct mmconfig_update_node *node_list,
                         uint32_t *bytes_used,
                         int32_t *bytes_remaining);
 
#ifdef __cplusplus
}
#endif