ra8_fs_types.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_err.h"
 
/* =============================================================================
 * Compile-time limits
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_fs_max_files      = 4,  
  k_ra8_fs_max_mounts     = 2,  
  k_ra8_fs_short_name_len = 12, 
} ra8_fs_limits_t;

typedef enum : uint16_t {
  k_ra8_fs_sector_min      = 512,  
  k_ra8_fs_sector_max      = 4096, 
  k_ra8_fs_dir_entry_bytes = 32,   
  k_ra8_fs_dir_name_cap    = 742,  
  k_ra8_fs_dir_state_bytes = 640,  
} ra8_fs_byte_sizes_t;

typedef enum : uint32_t {
  k_ra8_fs_fat_max_file_bytes = 0xFFFFFFFFU, 
} ra8_fs_fat_limit_t;
 
/* =============================================================================
 * File-mode + attribute enums
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_fs_mode_read   = 0, 
  k_ra8_fs_mode_write  = 1, 
  k_ra8_fs_mode_append = 2, 
} ra8_fs_mode_t;

typedef enum : uint8_t {
  k_ra8_fs_attr_read_only = 0x01, 
  k_ra8_fs_attr_hidden    = 0x02, 
  k_ra8_fs_attr_system    = 0x04, 
  k_ra8_fs_attr_volume_id = 0x08, 
  k_ra8_fs_attr_directory = 0x10, 
  k_ra8_fs_attr_archive   = 0x20, 
  k_ra8_fs_attr_lfn       = 0x0F, 
} ra8_fs_attr_t;

typedef enum : uint8_t {
  k_ra8_fs_type_unknown = 0,  
  k_ra8_fs_type_fat12   = 12, 
  k_ra8_fs_type_fat16   = 16, 
  k_ra8_fs_type_fat32   = 32, 
  k_ra8_fs_type_exfat   = 64, 
} ra8_fs_type_t;
 
/* =============================================================================
 * Backend interface
 * =============================================================================
 */

typedef struct {
  ra8_err_t (*read_block)(void* ctx, uint64_t lba, uint32_t count, uint8_t* buf);

  ra8_err_t (*write_block)(void* ctx, uint64_t lba, uint32_t count, const uint8_t* buf);

  ra8_err_t (*get_capacity)(void* ctx, uint64_t* block_count, uint32_t* block_size);

  ra8_err_t (*erase_blocks)(void* ctx, uint64_t lba, uint64_t count);

  void* ctx;
} ra8_fs_backend_t;
 
/* =============================================================================
 * Format (mkfs) options
 * =============================================================================
 */

typedef struct {
  ra8_fs_type_t type;                
  const char*   label;               
  uint8_t       sectors_per_cluster; 
} ra8_fs_format_opts_t;
 
/* =============================================================================
 * Mount / file handle (opaque-ish)
 * =============================================================================
 */

typedef struct {
  ra8_fs_backend_t backend;             
  ra8_fs_type_t    type;                
  uint32_t         bytes_per_sector;    
  uint32_t         sectors_per_cluster; 
  uint32_t         reserved_sectors;    
  uint32_t         num_fats;            
  uint32_t         root_entries;        
  uint64_t         total_sectors;       
  uint32_t         fat_size_sectors;    
  uint32_t         root_cluster;        
  uint64_t         first_fat_lba;       
  uint64_t         first_root_lba;      
  uint64_t         first_data_lba;      
  uint32_t         count_of_clusters;   
  uint64_t         partition_base_lba;  
  uint8_t          in_use;              
  uint8_t          exfat_upcase_ok;     
} ra8_fs_mount_t;

typedef struct {
  char     name[k_ra8_fs_dir_name_cap]; 
  uint64_t size_bytes;                  
  uint8_t  attr;                        
} ra8_fs_dirent_t;

typedef struct {
  alignas(uint64_t) uint8_t state[k_ra8_fs_dir_state_bytes]; 
  bool is_open;                                              
} ra8_fs_dir_t;

typedef struct {
  ra8_fs_mount_t* mount;              
  uint32_t        first_cluster;      
  uint32_t        cur_cluster;        
  uint32_t        walk_cache_idx;     
  uint32_t        walk_cache_cluster; 
  uint64_t        size_bytes;         
  uint64_t        offset;             
  uint64_t        dir_entry_lba;      
  uint32_t        dir_entry_idx;      
  uint64_t        valid_bytes;        
  uint32_t        entry_set_cluster;  
  uint32_t        entry_set_index;    
  uint32_t        entry_set_count;    
  uint32_t        alloc_clusters;     
  uint32_t        tail_cluster;       
  ra8_fs_mode_t   mode;               
  uint8_t         in_use;             
  uint8_t         no_fat_chain;       
  uint8_t         dirty;              
} ra8_fs_file_t;

typedef struct {
  uint16_t year;           
  int16_t  utc_offset_min; 
  uint8_t  month;          
  uint8_t  day;            
  uint8_t  hour;           
  uint8_t  minute;         
  uint8_t  second;         
  uint8_t  centisecond;    
} ra8_fs_datetime_t;

typedef struct {
  ra8_fs_datetime_t value;            
  bool              valid;            
  bool              utc_offset_valid; 
} ra8_fs_timestamp_t;

typedef struct {
  uint64_t           size_bytes;    
  uint32_t           first_cluster; 
  ra8_fs_timestamp_t created;       
  ra8_fs_timestamp_t modified;      
  ra8_fs_timestamp_t accessed;      
  uint8_t            attr;          
  bool               is_directory;  
} ra8_fs_stat_t;
 
/* =============================================================================
 * Listdir callback
 * =============================================================================
 */

typedef void (*ra8_fs_listdir_cb_t)(const char* name, uint8_t attr, uint64_t size, void* ctx);
 
/* =============================================================================
 * Partition selector
 * =============================================================================
 */

typedef enum : uint8_t {
  k_ra8_fs_partition_auto = 0xFFU, 
} ra8_fs_partition_sel_t;
 
#ifdef __cplusplus
}
#endif