ra8-firmware/unarch__xz__pool_8h_source.html

#pragma once


#include <stdint.h>


#include "ra8_err.h"


#ifdef __cplusplus

extern "C" {

#endif


typedef enum : uint32_t {

  k_unarch_xz_pool_align = 8U,

} unarch_xz_pool_dims_t;


[[nodiscard]] ra8_err_t unarch_xz_pool_install(void* base, uint32_t len);


void unarch_xz_pool_reset(void);


[[nodiscard]] void* unarch_xz_pool_alloc(uint32_t size);


[[nodiscard]] uint32_t unarch_xz_pool_used(void);


#ifdef __cplusplus

}

#endif

ra8_err.h
Error Code Definitions for ra8-firmware.

ra8_err_t
ra8_err_codes_t ra8_err_t
Canonical error-return type used by every ra8-firmware API.
Definition ra8_err.h:546

unarch_xz_pool_reset
void unarch_xz_pool_reset(void)
Release the installed arena (invalidates every pool allocation).
Definition unarch_xz_pool.c:77

unarch_xz_pool_used
uint32_t unarch_xz_pool_used(void)
Bytes currently bump-allocated from the installed arena.
Definition unarch_xz_pool.c:105

unarch_xz_pool_dims_t
unarch_xz_pool_dims_t
Alignment and sizing constants for the XZ bump arena.
Definition unarch_xz_pool.h:54

k_unarch_xz_pool_align
@ k_unarch_xz_pool_align
Bump-allocation alignment, bytes.
Definition unarch_xz_pool.h:55

unarch_xz_pool_alloc
void * unarch_xz_pool_alloc(uint32_t size)
Bump-allocate size bytes from the installed arena.
Definition unarch_xz_pool.c:84

unarch_xz_pool_install
ra8_err_t unarch_xz_pool_install(void *base, uint32_t len)
Install a caller-owned scratch buffer as the XZ allocation arena.
Definition unarch_xz_pool.c:57