board_periph_sd_internal.h

Go to the documentation of this file.

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

typedef enum : uint16_t {
  k_sd_block         = 512U,    
  k_sd_cmd_len       = 6U,      
  k_sd_resp_cap      = 520U,    
  k_sd_cmd_start     = 0x40U,   
  k_sd_cmd_mask      = 0xC0U,   
  k_sd_idx_mask      = 0x3FU,   
  k_sd_idle          = 0xFFU,   
  k_sd_tok_data      = 0xFEU,   
  k_sd_tok_wmulti    = 0xFCU,   
  k_sd_tok_stop      = 0xFDU,   
  k_sd_data_accept   = 0x05U,   
  k_sd_data_error    = 0x0DU,   
  k_sd_read_error    = 0x01U,   
  k_sd_busy          = 0x00U,   
  k_sd_crc_len       = 2U,      
  k_sd_label_cap     = 12U,     
  k_sd_r1_idle       = 0x01U,   
  k_sd_r1_ready      = 0x00U,   
  k_sd_r1_param_err  = 0x40U,   
  k_sd_byte_mask     = 0xFFU,   
  k_sd_byte_bits     = 8U,      
  k_sd_r7_len        = 5U,      
  k_sd_arg_sh0       = 24U,     
  k_sd_arg_sh1       = 16U,     
  k_sd_cmd8_echo     = 0xAAU,   
  k_sd_ocr_pwrccs    = 0xC0U,   
  k_sd_ocr_volt      = 0x80U,   
  k_sd_csd_v2        = 0x40U,   
  k_sd_csd_csize     = 0x0FU,   
  k_sd_csd_len       = 16U,     
  k_sd_csd_csize_b7  = 7U,      
  k_sd_csd_csize_b8  = 8U,      
  k_sd_csd_off       = 9U,      
  k_sd_csize_b7_mask = 0x3FU,   
  k_sd_crc_poly      = 0x1021U, 
  k_sd_crc_msb       = 0x8000U, 
} board_sd_const_t;

typedef enum : uint8_t {
  k_sd_wr_idle  = 0U, 
  k_sd_wr_token = 1U, 
  k_sd_wr_data  = 2U, 
  k_sd_wr_crc   = 3U, 
} board_sd_wr_phase_t;

typedef struct {
  int                 image_fd;              
  uint64_t            image_len;             
  bool                attached;              
  uint8_t             fat_bits;              
  char                label[k_sd_label_cap]; 
  bool                collecting;            
  bool                app_cmd;               
  bool                ready;                 
  uint8_t             cmd[k_sd_cmd_len];     
  uint32_t            cmd_idx;               
  uint8_t             resp[k_sd_resp_cap];   
  uint32_t            resp_len;              
  uint32_t            resp_pos;              
  board_sd_wr_phase_t wr_phase;              
  bool                wr_multi;              
  uint64_t            wr_off;                
  uint32_t            wr_cnt;                
  uint8_t             wr_block[k_sd_block];  
  bool                rd_multi;              
  uint64_t            rd_off;                
  uint32_t            erase_start;           
  uint32_t            erase_end;             
} board_sd_state_t;

typedef enum : uint32_t {
  k_sd_csd_unit       = 512U * 1024U,               
  k_sd_save_max_bytes = 2U * 1024U * 1024U * 1024U, 
  k_unit_kib          = 1024U,                      
  k_sd_min_sectors    = 64U,                        
} board_sd_const32_t;

extern board_sd_state_t g_board_sd;

typedef enum : uint32_t {
  k_fat32_bits = 32U, 
  k_fat16_bits = 16U, 
} sd_fat_bits_t;

typedef enum : uint32_t {
  k_fmt_sec_bytes    = 512U,        
  k_fmt_fat16_max    = 65524U,      
  k_fmt_fat16_min    = 4085U,       
  k_fmt_spc_max      = 64U,         
  k_fmt_fat32_pref   = 4194304U,    
  k_fmt_root_ents    = 512U,        
  k_fmt_volid        = 0x52A8D200U, 
  k_fmt_resv_f16     = 1U,          
  k_fmt_resv_f32     = 32U,         
  k_fmt_label_len    = 11U,         
  k_fmt_totsec16_max = 0x10000U,    
} sd_fmt_const_t;

RA8_PRIV [[nodiscard]] bool priv_board_sd_format_fat16(int         image_fd,
                                                       uint32_t    total_sectors,
                                                       const char* label,
                                                       uint32_t*   out_spc);

RA8_PRIV [[nodiscard]] bool priv_board_sd_format_fat32(int         image_fd,
                                                       uint32_t    total_sectors,
                                                       const char* label,
                                                       uint32_t*   out_spc);

RA8_PRIV [[nodiscard]] bool priv_board_sd_storage_read(uint64_t offset, void* dst, size_t count);
RA8_PRIV [[nodiscard]] bool
priv_board_sd_storage_write(uint64_t offset, const void* src, size_t count);
RA8_PRIV [[nodiscard]] bool priv_board_sd_storage_zero(uint64_t offset, uint64_t count);

RA8_PRIV void priv_board_sd_label_field(uint8_t* dst, const char* label);
 
#ifdef __cplusplus
}
#endif