ra8_sdmmc_spi_internal.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stdint.h>
 
#include "ra8_attributes.h"
#include "ra8_err.h"
#include "ra8_sdmmc_spi.h"
 
/* ---------------------------------------------------------------------------
 * Protocol constants shared between the core/init and block-I/O TUs
 * ---------------------------------------------------------------------------
 */

typedef enum : uint8_t {
  k_sd_cmd_go_idle_state           = 0x40U,       
  k_sd_cmd_send_if_cond            = 0x40U | 8U,  
  k_sd_cmd_send_csd                = 0x40U | 9U,  
  k_sd_cmd_send_cid                = 0x40U | 10U, 
  k_sd_cmd_stop_transmission       = 0x40U | 12U, 
  k_sd_cmd_set_blocklen            = 0x40U | 16U, 
  k_sd_cmd_read_single_block       = 0x40U | 17U, 
  k_sd_cmd_read_multi_block        = 0x40U | 18U, 
  k_sd_cmd_write_single_block      = 0x40U | 24U, 
  k_sd_cmd_write_multi_block       = 0x40U | 25U, 
  k_sd_cmd_erase_wr_blk_start      = 0x40U | 32U, 
  k_sd_cmd_erase_wr_blk_end        = 0x40U | 33U, 
  k_sd_cmd_erase                   = 0x40U | 38U, 
  k_sd_cmd_app_cmd                 = 0x40U | 55U, 
  k_sd_cmd_read_ocr                = 0x40U | 58U, 
  k_sd_acmd_sd_send_op_cond        = 0x40U | 41U, 
  k_sd_acmd_set_wr_blk_erase_count = 0x40U | 23U, 
} sd_cmd_t;

typedef enum : uint8_t {
  k_sd_token_data_start_single = 0xFEU, 
  k_sd_token_data_start_multi  = 0xFCU, 
  k_sd_token_stop_multi        = 0xFDU, 
  k_sd_token_idle              = 0xFFU, 
} sd_data_token_t;

typedef enum : uint8_t {
  k_sd_data_response_mask      = 0x1FU, 
  k_sd_data_response_accepted  = 0x05U, 
  k_sd_data_response_crc_err   = 0x0BU, 
  k_sd_data_response_write_err = 0x0DU, 
} sd_data_response_t;

typedef enum : uint32_t {
  /* CMD0 has a static CRC7-shifted-and-tagged byte of 0x95 (SD spec PHY
   * v9 section 7.3.1.1 example). Pre-computing avoids running CRC7 over
   * the all-zero argument every probe. */
  k_sd_crc7_cmd0_byte = 0x95U, 
  /* CMD8 with argument 0x000001AA uses the documented "pattern 0xAA at
   * 2.7-3.6 V" check (SD spec PHY v9 section 7.3.2.6). The CRC7-shifted
   * byte for this exact frame is 0x87, also published in the spec. */
  k_sd_cmd8_arg_check_pattern = 0x000001AAUL, 
  k_sd_crc7_cmd8_byte         = 0x87U,        
  /* ACMD41 with HCS=1 for v2.x cards. */
  k_sd_acmd41_arg_hcs = 0x40000000UL, 
  /* OCR bit set when CCS = 1 (block-addressed SDHC/SDXC). */
  k_sd_ocr_ccs_bit  = 0x40000000UL, 
  k_sd_ocr_busy_bit = 0x80000000UL, 
  /* Retry budgets -- bounded loops, NASA P10 Rule 2. */
  k_sd_max_r1_wait_bytes    = 16U,      
  k_sd_max_data_token_polls = 50000U,   
  k_sd_max_busy_poll_bytes  = 100000U,  
  k_sd_max_acmd41_attempts  = 1000U,    
  k_sd_init_dummy_clocks    = 80U,      
  k_sd_recover_flush_bytes  = 530U,     
  k_sd_recover_idle_bytes   = 64U,      
  k_sd_max_recover_attempts = 4U,       
  k_sd_max_erase_poll_bytes = 5000000U, 
} sd_protocol_const_t;

typedef enum : uint8_t {
  k_sd_bit_byte       = 8U,  
  k_sd_bit_two_byte   = 16U, 
  k_sd_bit_three_byte = 24U, 
} sd_bit_shift_t;

typedef enum : uint32_t {
  k_sd_mask_byte  = 0xFFU,  
  k_sd_mask_12bit = 0xFFFU, 
} sd_byte_mask_t;
 
/* ---------------------------------------------------------------------------
 * Shared driver state
 * ---------------------------------------------------------------------------
 */

typedef struct {
  ra8_sdmmc_spi_transport_t transport;       
  ra8_sdmmc_spi_card_type_t card_type;       
  uint32_t                  capacity_blocks; 
  bool                      initialized;     
} sd_state_t;

RA8_PRIV extern sd_state_t g_sdmmc_spi_state;
 
/* ---------------------------------------------------------------------------
 * Low-level helpers shared with the block-I/O TU
 * ---------------------------------------------------------------------------
 */

RA8_PRIV ra8_err_t priv_sdmmc_spi_xfer_one(uint8_t tx, uint8_t* rx);

RA8_PRIV ra8_err_t priv_sdmmc_spi_send_idle(uint32_t n);

RA8_PRIV ra8_err_t priv_sdmmc_spi_cs_assert(void);

RA8_PRIV ra8_err_t priv_sdmmc_spi_cs_release(void);

RA8_PRIV ra8_err_t priv_sdmmc_spi_send_command(sd_cmd_t cmd, uint32_t arg, uint8_t* out_r1);

RA8_PRIV ra8_err_t priv_sdmmc_spi_send_acmd(sd_cmd_t acmd, uint32_t arg, uint8_t* out_r1);

RA8_PRIV ra8_err_t priv_sdmmc_spi_send_stop_transmission(uint8_t* out_r1);

RA8_PRIV ra8_err_t priv_sdmmc_spi_wait_data_token(void);

RA8_PRIV ra8_err_t priv_sdmmc_spi_wait_not_busy_bounded(uint32_t max_polls);

RA8_PRIV ra8_err_t priv_sdmmc_spi_wait_not_busy(void);

RA8_PRIV ra8_err_t priv_sdmmc_spi_validate_transport(const ra8_sdmmc_spi_transport_t* transport);

RA8_PRIV ra8_err_t priv_sdmmc_spi_run_init_sequence(void);
 
#ifdef __cplusplus
}
#endif