ra8_sdmmc_spi.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"
#include "ra8_port_constants.h"
 
/* =============================================================================
 * Compile-time limits and protocol constants
 * =============================================================================
 */

typedef enum : uint16_t {
  k_ra8_sdmmc_spi_block_size       = 512U, 
  k_ra8_sdmmc_spi_cmd_frame_bytes  = 6U,   
  k_ra8_sdmmc_spi_csd_response_len = 16U,  
} ra8_sdmmc_spi_limits_t;

typedef enum : uint32_t {
  k_ra8_sdmmc_spi_clock_init_hz = 400000U,   
  k_ra8_sdmmc_spi_clock_data_hz = 25000000U, 
} ra8_sdmmc_spi_clock_t;

typedef enum : uint8_t {
  k_ra8_sdmmc_spi_type_unknown = 0U, 
  k_ra8_sdmmc_spi_type_sdv1    = 1U, 
  k_ra8_sdmmc_spi_type_sdv2    = 2U, 
  k_ra8_sdmmc_spi_type_sdhc    = 3U, 
} ra8_sdmmc_spi_card_type_t;
 
/* =============================================================================
 * Transport descriptor (Dependency Inversion seam)
 * =============================================================================
 */

typedef ra8_err_t (*ra8_sdmmc_spi_set_clock_fn_t)(void* ctx, uint32_t hz);

typedef ra8_err_t (*ra8_sdmmc_spi_cs_fn_t)(void* ctx, bool asserted);

typedef ra8_err_t (*ra8_sdmmc_spi_xfer_fn_t)(void*          ctx,
                                             const uint8_t* tx,
                                             uint8_t*       rx,
                                             uint32_t       len);

typedef struct {
  ra8_sdmmc_spi_set_clock_fn_t set_clock; 
  ra8_sdmmc_spi_cs_fn_t        cs;        
  ra8_sdmmc_spi_xfer_fn_t      xfer;      
  void*                        ctx;       
} ra8_sdmmc_spi_transport_t;
 
/* =============================================================================
 * Convenience SCI Simple-SPI transport factory (EK-RA8D2 Pmod)
 * =============================================================================
 */

typedef struct {
  ra8_port_pin_t sck;  
  ra8_port_pin_t cipo; 
  ra8_port_pin_t copi; 
  ra8_port_pin_t cs;   
} ra8_sdmmc_spi_sci_pins_t;

[[nodiscard]] ra8_err_t ra8_sdmmc_spi_transport_sci(uint8_t                         sci_channel,
                                                    uint32_t                        pclk_hz,
                                                    const ra8_sdmmc_spi_sci_pins_t* pins,
                                                    ra8_sdmmc_spi_transport_t*      out);
 
/* =============================================================================
 * Lifecycle
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_sdmmc_spi_init(const ra8_sdmmc_spi_transport_t* transport);

[[nodiscard]] ra8_err_t ra8_sdmmc_spi_deinit(void);
 
/* =============================================================================
 * Block I/O
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_sdmmc_spi_read_block(uint32_t lba, uint8_t* buf);

[[nodiscard]] ra8_err_t ra8_sdmmc_spi_read_blocks(uint32_t lba, uint8_t* buf, uint32_t count);

[[nodiscard]] ra8_err_t ra8_sdmmc_spi_write_block(uint32_t lba, const uint8_t* buf);

[[nodiscard]] ra8_err_t
ra8_sdmmc_spi_write_blocks(uint32_t lba, const uint8_t* buf, uint32_t count);

[[nodiscard]] ra8_err_t ra8_sdmmc_spi_erase_blocks(uint32_t lba, uint32_t count);
 
/* =============================================================================
 * Status queries
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_sdmmc_spi_get_capacity(uint32_t* out_blocks);

[[nodiscard]] ra8_err_t ra8_sdmmc_spi_get_card_type(ra8_sdmmc_spi_card_type_t* out_type);
 
/* =============================================================================
 * ra8_fs backend adapter
 * =============================================================================
 */

[[nodiscard]] ra8_err_t ra8_sdmmc_spi_bind_fs_backend(ra8_fs_backend_t* out_backend);
 
/* =============================================================================
 * Test-only helpers (CRC primitives)
 * =============================================================================
 */

uint8_t ra8_sdmmc_spi_crc7(const uint8_t* data, uint32_t len);

uint16_t ra8_sdmmc_spi_crc16(const uint8_t* data, uint32_t len);
 
#ifdef __cplusplus
}
#endif