ra8_io_blockdev.h

Go to the documentation of this file.

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

typedef enum : uint16_t {
  k_ra8_io_block_size_bytes = 512, 
} ra8_io_block_size_t;

typedef enum : uint8_t {
  k_ra8_io_erase_value_zero = 0x00, 
  k_ra8_io_erase_value_ones = 0xFF, 
} ra8_io_erase_value_t;
 
/* =============================================================================
 * Capabilities
 * =============================================================================
 */

typedef struct {
  uint32_t block_count;             
  uint32_t erase_unit_blocks;       
  uint32_t program_size_bytes;      
  uint16_t logical_block_bytes;     
  uint8_t  erase_value;             
  bool     must_erase_before_write; 
  bool     read_only;               
} ra8_io_blockdev_caps_t;
 
/* =============================================================================
 * Interface + handle
 * =============================================================================
 */

typedef struct ra8_io_blockdev_iface ra8_io_blockdev_iface_t;

typedef struct {
  const ra8_io_blockdev_iface_t* iface; 
  void*                          ctx;   
} ra8_io_blockdev_t;
 
/* =============================================================================
 * Public API
 * =============================================================================
 */

[[nodiscard]] ra8_err_t
ra8_io_blockdev_read(const ra8_io_blockdev_t* bd, uint32_t lba, uint32_t count, uint8_t* buf);

[[nodiscard]] ra8_err_t ra8_io_blockdev_write(const ra8_io_blockdev_t* bd,
                                              uint32_t                 lba,
                                              uint32_t                 count,
                                              const uint8_t*           buf);

[[nodiscard]] ra8_err_t
ra8_io_blockdev_erase(const ra8_io_blockdev_t* bd, uint32_t lba, uint32_t count);

[[nodiscard]] ra8_err_t ra8_io_blockdev_get_caps(const ra8_io_blockdev_t* bd,
                                                 ra8_io_blockdev_caps_t*  out);

[[nodiscard]] ra8_err_t ra8_io_blockdev_sync(const ra8_io_blockdev_t* bd);

[[nodiscard]] ra8_err_t ra8_io_blockdev_as_fs_backend(const ra8_io_blockdev_t* bd,
                                                      ra8_fs_backend_t*        out);
 
#ifdef __cplusplus
}
#endif