ra8_ftl.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"
#include "ra8_io_blockdev.h"
 
/* =============================================================================
 * Constants
 * =============================================================================
 */

typedef enum : uint16_t {
  k_ra8_ftl_unmapped    = 0xFFFF, 
  k_ra8_ftl_max_pblocks = 0xFFFE, 
  k_ra8_ftl_min_spare   = 1,      
} ra8_ftl_const_t;

typedef enum : uint8_t {
  k_ra8_ftl_pstate_free  = 0, 
  k_ra8_ftl_pstate_live  = 1, 
  k_ra8_ftl_pstate_stale = 2, 
} ra8_ftl_pstate_t;
 
/* =============================================================================
 * Per-physical-block metadata
 * =============================================================================
 */

typedef struct {
  uint32_t erase_count; 
  uint8_t  state;       
} ra8_ftl_pblock_t;
 
/* =============================================================================
 * Handle
 * =============================================================================
 */

typedef struct {
  const ra8_io_blockdev_t* raw;             
  uint16_t*                map;             
  ra8_ftl_pblock_t*        pblocks;         
  uint8_t*                 scratch;         
  uint32_t                 logical_blocks;  
  uint32_t                 physical_blocks; 
  uint8_t                  erase_value;     
} ra8_ftl_t;
 
/* =============================================================================
 * API
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_ftl_init(ra8_ftl_t*               bd,
                                     const ra8_io_blockdev_t* raw,
                                     uint16_t*                map,
                                     uint32_t                 logical_blocks,
                                     ra8_ftl_pblock_t*        pblocks,
                                     uint32_t                 physical_blocks,
                                     uint8_t*                 scratch);

[[nodiscard]] ra8_err_t ra8_ftl_as_blockdev(ra8_ftl_t* ftl, ra8_io_blockdev_t* out);

[[nodiscard]] ra8_err_t
ra8_ftl_wear_stats(const ra8_ftl_t* ftl, uint32_t* max_out, uint32_t* min_out);

[[nodiscard]] ra8_err_t ra8_ftl_phys_of(const ra8_ftl_t* ftl, uint32_t lbn, uint16_t* phys_out);

[[nodiscard]] ra8_err_t ra8_ftl_checkpoint_size(const ra8_ftl_t* ftl, uint32_t* size_out);

[[nodiscard]] ra8_err_t
ra8_ftl_checkpoint_save(const ra8_ftl_t* ftl, uint8_t* buf, uint32_t buf_len);

[[nodiscard]] ra8_err_t
ra8_ftl_checkpoint_load(ra8_ftl_t* ftl, const uint8_t* buf, uint32_t buf_len);
 
#ifdef __cplusplus
}
#endif