sd_card_spi.h

#pragma once
 
/************************************************************************************************
 * @file   sd_card_spi.h
 *
 * @brief  SD Card SPI Library Header File
 *
 * @date   2025-07-05
 * @author Midnight Sun Team #24 - MSXVI
 ************************************************************************************************/
 
/* Standard library Headers */
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
/* Inter-component Headers */
#include "gpio.h"
 
/* Intra-component Headers */
#include "status.h"
 
typedef enum {
  SD_SPI_BAUDRATE_312_5KHZ = 0, 
  SD_SPI_BAUDRATE_625KHZ,       
  SD_SPI_BAUDRATE_1_25MHZ,      
  SD_SPI_BAUDRATE_2_5MHZ,       
  SD_SPI_BAUDRATE_5MHZ,         
  SD_SPI_BAUDRATE_10MHZ,        
  SD_SPI_BAUDRATE_20MHZ,        
  SD_SPI_BAUDRATE_40MHZ,        
  NUM_SD_SPI_BAUDRATES          
} SdSpiBaudrate;
 
typedef enum {
  SD_SPI_MODE_0 = 0, 
  SD_SPI_MODE_1,     
  SD_SPI_MODE_2,     
  SD_SPI_MODE_3,     
  NUM_SD_SPI_MODES   
} SdSpiMode;
 
typedef enum { SD_SPI_PORT_1 = 0, SD_SPI_PORT_2, SD_SPI_PORT_3, NUM_SD_SPI_PORTS } SdSpiPort;
 
typedef struct {
  SdSpiBaudrate baudrate; 
  SdSpiMode mode;         
  GpioAddress mosi;       
  GpioAddress miso;       
  GpioAddress sclk;       
  GpioAddress cs;         
} SdSpiSettings;
 
StatusCode sd_spi_init(SdSpiPort spi, const SdSpiSettings *settings);
 
StatusCode sd_spi_tx(SdSpiPort spi, uint8_t *tx_data, size_t tx_len);
 
StatusCode sd_spi_rx(SdSpiPort spi, uint8_t *rx_data, size_t rx_len, uint8_t placeholder);
 
StatusCode sd_spi_exchange(SdSpiPort spi, uint8_t *tx_data, size_t tx_len, uint8_t *rx_data, size_t rx_len);
 
StatusCode sd_spi_cs_set_state(SdSpiPort spi, GpioState state);
 
GpioState sd_spi_cs_get_state(SdSpiPort spi);
 
StatusCode sd_spi_set_frequency(SdSpiPort spi, SdSpiBaudrate baudrate);