implementation.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef NRF_COMPRESS_IMPLEMENTATION_H_
#define NRF_COMPRESS_IMPLEMENTATION_H_
 
#include "lzma_types.h"
#include <stdint.h>
#include <stdlib.h>
#include <zephyr/kernel.h>
#include <zephyr/types.h>
#include <zephyr/sys/iterable_sections.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef int (*nrf_compress_init_func_t)(void *inst, size_t decompressed_size);
 
typedef int (*nrf_compress_deinit_func_t)(void *inst);
 
typedef int (*nrf_compress_reset_func_t)(void *inst, size_t decompressed_size);
 
typedef int (*nrf_compress_compress_func_t)(void *inst);
 
typedef size_t (*nrf_compress_decompress_bytes_needed_t)(void *inst);
 
typedef int (*nrf_compress_decompress_func_t)(void *inst, const uint8_t *input, size_t input_size,
                                              bool last_part, uint32_t *offset, uint8_t **output,
                                              size_t *output_size);
 
enum nrf_compress_types {
        NRF_COMPRESS_TYPE_LZMA,
 
        NRF_COMPRESS_TYPE_ARM_THUMB,
 
        NRF_COMPRESS_TYPE_COUNT,
 
        NRF_COMPRESS_TYPE_USER_CUSTOM_START = 32768
};
 
struct nrf_compress_implementation {
        const uint16_t id;
 
        const nrf_compress_init_func_t init;
        const nrf_compress_deinit_func_t deinit;
        const nrf_compress_reset_func_t reset;
 
#if defined(CONFIG_NRF_COMPRESS_COMPRESSION) || defined(__DOXYGEN__)
        const nrf_compress_compress_func_t compress;
#endif
 
#if defined(CONFIG_NRF_COMPRESS_DECOMPRESSION) || defined(__DOXYGEN__)
        const nrf_compress_decompress_bytes_needed_t decompress_bytes_needed;
        const nrf_compress_decompress_func_t decompress;
#endif
};
 
#define NRF_COMPRESS_IMPLEMENTATION_DEFINE(name, _id, _init, _deinit, _reset, _compress,        \
                                           _decompress_bytes_needed, _decompress)               \
        STRUCT_SECTION_ITERABLE(nrf_compress_implementation, name) = {                          \
                .id = _id,                                                                      \
                .init = _init,                                                                  \
                .deinit = _deinit,                                                              \
                .reset = _reset,                                                                \
                COND_CODE_1(CONFIG_NRF_COMPRESS_COMPRESSION, (                                  \
                                .compress = _compress,                                          \
                            ), ())                                                              \
                COND_CODE_1(CONFIG_NRF_COMPRESS_DECOMPRESSION, (                                \
                                .decompress_bytes_needed = _decompress_bytes_needed,            \
                                .decompress = _decompress,                                      \
                            ), ())                                                              \
        }
 
struct nrf_compress_implementation *nrf_compress_implementation_find(uint16_t id);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_COMPRESS_IMPLEMENTATION_H_ */