cache_store_demo.h

Go to the documentation of this file.

#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_cache_store.h"
#include "ra8_err.h"

typedef enum : uint8_t {
  k_cache_store_demo_stage_none      = 0U, 
  k_cache_store_demo_stage_mounted   = 1U, 
  k_cache_store_demo_stage_seeded    = 2U, 
  k_cache_store_demo_stage_evicted   = 3U, 
  k_cache_store_demo_stage_reused    = 4U, 
  k_cache_store_demo_stage_closed    = 5U, 
  k_cache_store_demo_stage_remounted = 6U, 
  k_cache_store_demo_stage_persisted = 7U, 
} cache_store_demo_stage_t;

typedef enum : uint8_t {
  k_cache_store_demo_ok          = 0U, 
  k_cache_store_demo_err_arg     = 1U, 
  k_cache_store_demo_err_mount   = 2U, 
  k_cache_store_demo_err_seed    = 3U, 
  k_cache_store_demo_err_evict   = 4U, 
  k_cache_store_demo_err_reuse   = 5U, 
  k_cache_store_demo_err_close   = 6U, 
  k_cache_store_demo_err_remount = 7U, 
  k_cache_store_demo_err_persist = 8U, 
} cache_store_demo_status_t;

typedef struct {
  cache_store_demo_status_t status;              
  cache_store_demo_stage_t  last_stage;          
  uint32_t                  survivors;           
  uint32_t                  evicted_key;         
  bool                      evicted_stayed_gone; 
  bool                      pin_survived;        
} cache_store_demo_result_t;

typedef struct {
  struct LX_NOR_FLASH_STRUCT* nor_flash;       
  ra8_cache_store_nor_init_fn nor_driver_init; 
  ra8_cache_store_entry_t*    index;           
  uint8_t*                    staging;         
  uint8_t*                    scratch;         
  uint32_t                    staging_bytes;   
  uint32_t                    scratch_bytes;   
  uint32_t                    logical_sectors; 
  uint16_t                    index_cap;       
} cache_store_demo_cfg_t;

[[nodiscard]] ra8_err_t cache_store_demo_run(const cache_store_demo_cfg_t* cfg,
                                             cache_store_demo_result_t*    out);
 
#ifdef __cplusplus
}
#endif