sdcard_spi.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2016 Michel Rottleuthner <michel.rottleuthner@haw-hamburg.de>
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "periph/spi.h"
#include "periph/gpio.h"
#include "stdbool.h"
 
#define SD_HC_BLOCK_SIZE      (512)  
#define SDCARD_SPI_INIT_ERROR (-1)   
#define SDCARD_SPI_OK         (0)    
 
#define SD_SIZE_OF_OID 2 
#define SD_SIZE_OF_PNM 5 

typedef struct {
    uint8_t MID;              
    char OID[SD_SIZE_OF_OID]; 
    char PNM[SD_SIZE_OF_PNM]; 
    uint8_t PRV;              
    uint32_t PSN;             
    uint16_t MDT;             
    uint8_t CID_CRC;          
} cid_t;

typedef struct {
    uint8_t CSD_STRUCTURE : 2;        
    uint8_t TAAC : 8;                 
    uint8_t NSAC : 8;                 
    uint8_t TRAN_SPEED : 8;           
    uint16_t CCC : 12;                
    uint8_t READ_BL_LEN : 4;          
    uint8_t READ_BL_PARTIAL : 1;      
    uint8_t WRITE_BLK_MISALIGN : 1;   
    uint8_t READ_BLK_MISALIGN : 1;    
    uint8_t DSR_IMP : 1;              
    uint16_t C_SIZE : 12;             
    uint8_t VDD_R_CURR_MIN : 3;       
    uint8_t VDD_R_CURR_MAX : 3;       
    uint8_t VDD_W_CURR_MIN : 3;       
    uint8_t VDD_W_CURR_MAX : 3;       
    uint8_t C_SIZE_MULT : 3;          
    uint8_t ERASE_BLK_EN : 1;         
    uint8_t SECTOR_SIZE : 7;          
    uint8_t WP_GRP_SIZE : 7;          
    uint8_t WP_GRP_ENABLE : 1;        
    uint8_t R2W_FACTOR : 3;           
    uint8_t WRITE_BL_LEN : 4;         
    uint8_t WRITE_BL_PARTIAL : 1;     
    uint8_t FILE_FORMAT_GRP : 1;      
    uint8_t COPY : 1;                 
    uint8_t PERM_WRITE_PROTECT : 1;   
    uint8_t TMP_WRITE_PROTECT : 1;    
    uint8_t FILE_FORMAT : 2;          
    uint8_t CSD_CRC : 8;              
} csd_v1_t;

typedef struct {
    uint8_t CSD_STRUCTURE : 2;        
    uint8_t TAAC : 8;                 
    uint8_t NSAC : 8;                 
    uint8_t TRAN_SPEED : 8;           
    uint16_t CCC : 12;                
    uint8_t READ_BL_LEN : 4;          
    uint8_t READ_BL_PARTIAL : 1;      
    uint8_t WRITE_BLK_MISALIGN : 1;   
    uint8_t READ_BLK_MISALIGN : 1;    
    uint8_t DSR_IMP : 1;              
    uint32_t C_SIZE : 22;             
    uint8_t ERASE_BLK_EN : 1;         
    uint8_t SECTOR_SIZE : 7;          
    uint8_t WP_GRP_SIZE : 7;          
    uint8_t WP_GRP_ENABLE : 1;        
    uint8_t R2W_FACTOR : 3;           
    uint8_t WRITE_BL_LEN : 4;         
    uint8_t WRITE_BL_PARTIAL : 1;     
    uint8_t FILE_FORMAT_GRP : 1;      
    uint8_t COPY : 1;                 
    uint8_t PERM_WRITE_PROTECT : 1;   
    uint8_t TMP_WRITE_PROTECT : 1;    
    uint8_t FILE_FORMAT : 2;          
    uint8_t CSD_CRC : 8;              
} csd_v2_t;

typedef union {
    csd_v1_t v1;   
    csd_v2_t v2;   
} csd_t;

typedef struct {
    uint32_t SIZE_OF_PROTECTED_AREA : 32;   
    uint32_t SUS_ADDR : 22;                 
    uint32_t VSC_AU_SIZE : 10;              
    uint16_t SD_CARD_TYPE : 16;             
    uint16_t ERASE_SIZE : 16;               
    uint8_t  SPEED_CLASS : 8;               
    uint8_t  PERFORMANCE_MOVE : 8;          
    uint8_t  VIDEO_SPEED_CLASS : 8;         
    uint8_t  ERASE_TIMEOUT : 6;             
    uint8_t  ERASE_OFFSET : 2;              
    uint8_t  UHS_SPEED_GRADE : 4;           
    uint8_t  UHS_AU_SIZE : 4;               
    uint8_t  AU_SIZE : 4;                   
    uint8_t  DAT_BUS_WIDTH : 2;             
    uint8_t  SECURED_MODE : 1;              
} sd_status_t;

typedef enum {
    SD_V2,                 
    SD_V1,                 
    MMC_V3,                
    SD_UNKNOWN             
} sd_version_t;

typedef enum {
    SD_RW_OK = 0,           
    SD_RW_NO_TOKEN,         
    SD_RW_TIMEOUT,          
    SD_RW_RX_TX_ERROR,      
    SD_RW_WRITE_ERROR,      
    SD_RW_CRC_MISMATCH,     
    SD_RW_NOT_SUPPORTED     
} sd_rw_response_t;

typedef struct {
    spi_t spi_dev;          
    gpio_t cs;              
    gpio_t clk;             
    gpio_t mosi;            
    gpio_t miso;            
    gpio_t power;           
    bool power_act_high;    
} sdcard_spi_params_t;

typedef struct {
    const sdcard_spi_params_t *params;    
    spi_clk_t spi_clk;      
    bool use_block_addr;    
    bool init_done;         
    sd_version_t card_type; 
    int csd_structure;      
    cid_t cid;              
    csd_t csd;              
} sdcard_spi_t;

int sdcard_spi_init(sdcard_spi_t *card, const sdcard_spi_params_t *params);

int sdcard_spi_read_blocks(sdcard_spi_t *card, uint32_t blockaddr,
                           void *data, uint16_t blocksize,
                           uint16_t nblocks, sd_rw_response_t *state);

int sdcard_spi_write_blocks(sdcard_spi_t *card, uint32_t blockaddr,
                            const void *data, uint16_t blocksize,
                            uint16_t nblocks, sd_rw_response_t *state);

uint64_t sdcard_spi_get_capacity(sdcard_spi_t *card);
 
#ifdef __cplusplus
}
#endif