SdCardInfo.h

Go to the documentation of this file.

 
#ifndef SdCardInfo_h
#define SdCardInfo_h
#include "../common/SysCall.h"
#include <stdint.h>
// Based on the document:
//
// SD Specifications
// Part 1
// Physical Layer
// Simplified Specification
// Version 5.00
// Aug 10, 2016
//
// https://www.sdcard.org/downloads/pls/
//------------------------------------------------------------------------------
// SD card errors
// See the SD Specification for command info.
#define SD_ERROR_CODE_LIST                                                                                             \
    SD_CARD_ERROR(NONE, "No error")                                                                                    \
    SD_CARD_ERROR(CMD0, "Card reset failed")                                                                           \
    SD_CARD_ERROR(CMD2, "SDIO read CID")                                                                               \
    SD_CARD_ERROR(CMD3, "SDIO publish RCA")                                                                            \
    SD_CARD_ERROR(CMD6, "Switch card function")                                                                        \
    SD_CARD_ERROR(CMD7, "SDIO card select")                                                                            \
    SD_CARD_ERROR(CMD8, "Send and check interface settings")                                                           \
    SD_CARD_ERROR(CMD9, "Read CSD data")                                                                               \
    SD_CARD_ERROR(CMD10, "Read CID data")                                                                              \
    SD_CARD_ERROR(CMD12, "Stop multiple block read")                                                                   \
    SD_CARD_ERROR(CMD13, "Read card status")                                                                           \
    SD_CARD_ERROR(CMD17, "Read single block")                                                                          \
    SD_CARD_ERROR(CMD18, "Read multiple blocks")                                                                       \
    SD_CARD_ERROR(CMD24, "Write single block")                                                                         \
    SD_CARD_ERROR(CMD25, "Write multiple blocks")                                                                      \
    SD_CARD_ERROR(CMD32, "Set first erase block")                                                                      \
    SD_CARD_ERROR(CMD33, "Set last erase block")                                                                       \
    SD_CARD_ERROR(CMD38, "Erase selected blocks")                                                                      \
    SD_CARD_ERROR(CMD58, "Read OCR register")                                                                          \
    SD_CARD_ERROR(CMD59, "Set CRC mode")                                                                               \
    SD_CARD_ERROR(ACMD6, "Set SDIO bus width")                                                                         \
    SD_CARD_ERROR(ACMD13, "Read extended status")                                                                      \
    SD_CARD_ERROR(ACMD23, "Set pre-erased count")                                                                      \
    SD_CARD_ERROR(ACMD41, "Activate card initialization")                                                              \
    SD_CARD_ERROR(READ_TOKEN, "Bad read data token")                                                                   \
    SD_CARD_ERROR(READ_CRC, "Read CRC error")                                                                          \
    SD_CARD_ERROR(READ_FIFO, "SDIO fifo read timeout")                                                                 \
    SD_CARD_ERROR(READ_REG, "Read CID or CSD failed.")                                                                 \
    SD_CARD_ERROR(READ_START, "Bad readStart argument")                                                                \
    SD_CARD_ERROR(READ_TIMEOUT, "Read data timeout")                                                                   \
    SD_CARD_ERROR(STOP_TRAN, "Multiple block stop failed")                                                             \
    SD_CARD_ERROR(TRANSFER_COMPLETE, "SDIO transfer complete")                                                         \
    SD_CARD_ERROR(WRITE_DATA, "Write data not accepted")                                                               \
    SD_CARD_ERROR(WRITE_FIFO, "SDIO fifo write timeout")                                                               \
    SD_CARD_ERROR(WRITE_START, "Bad writeStart argument")                                                              \
    SD_CARD_ERROR(WRITE_PROGRAMMING, "Flash programming")                                                              \
    SD_CARD_ERROR(WRITE_TIMEOUT, "Write timeout")                                                                      \
    SD_CARD_ERROR(DMA, "DMA transfer failed")                                                                          \
    SD_CARD_ERROR(ERASE, "Card did not accept erase commands")                                                         \
    SD_CARD_ERROR(ERASE_SINGLE_SECTOR, "Card does not support erase")                                                  \
    SD_CARD_ERROR(ERASE_TIMEOUT, "Erase command timeout")                                                              \
    SD_CARD_ERROR(INIT_NOT_CALLED, "Card has not been initialized")                                                    \
    SD_CARD_ERROR(INVALID_CARD_CONFIG, "Invalid card config")                                                          \
    SD_CARD_ERROR(FUNCTION_NOT_SUPPORTED, "Unsupported SDIO command")
 
enum
{
#define SD_CARD_ERROR(e, m) SD_CARD_ERROR_##e,
    SD_ERROR_CODE_LIST
#undef SD_CARD_ERROR
        SD_CARD_ERROR_UNKNOWN
};
void printSdErrorSymbol(print_t *pr, uint8_t code);
void printSdErrorText(print_t *pr, uint8_t code);
//------------------------------------------------------------------------------
// card types
const uint8_t SD_CARD_TYPE_SD1 = 1;
const uint8_t SD_CARD_TYPE_SD2 = 2;
const uint8_t SD_CARD_TYPE_SDHC = 3;
//------------------------------------------------------------------------------
// SD operation timeouts
const uint8_t SD_CMD0_RETRY = 10;
const uint16_t SD_CMD_TIMEOUT = 300;
const uint16_t SD_ERASE_TIMEOUT = 10000;
const uint16_t SD_INIT_TIMEOUT = 2000;
const uint16_t SD_READ_TIMEOUT = 300;
const uint16_t SD_WRITE_TIMEOUT = 600;
//------------------------------------------------------------------------------
// SD card commands
const uint8_t CMD0 = 0X00;
const uint8_t CMD2 = 0X02;
const uint8_t CMD3 = 0X03;
const uint8_t CMD6 = 0X06;
const uint8_t CMD7 = 0X07;
const uint8_t CMD8 = 0X08;
const uint8_t CMD9 = 0X09;
const uint8_t CMD10 = 0X0A;
const uint8_t CMD11 = 0X0B;
const uint8_t CMD12 = 0X0C;
const uint8_t CMD13 = 0X0D;
const uint8_t CMD17 = 0X11;
const uint8_t CMD18 = 0X12;
const uint8_t CMD24 = 0X18;
const uint8_t CMD25 = 0X19;
const uint8_t CMD32 = 0X20;
const uint8_t CMD33 = 0X21;
const uint8_t CMD38 = 0X26;
const uint8_t CMD55 = 0X37;
const uint8_t CMD58 = 0X3A;
const uint8_t CMD59 = 0X3B;
const uint8_t ACMD6 = 0X06;
const uint8_t ACMD13 = 0X0D;
const uint8_t ACMD23 = 0X17;
const uint8_t ACMD41 = 0X29;
//==============================================================================
// CARD_STATUS
const uint32_t CARD_STATUS_OUT_OF_RANGE = 1UL << 31;
const uint32_t CARD_STATUS_ADDRESS_ERROR = 1UL << 30;
const uint32_t CARD_STATUS_SECTOR_LEN_ERROR = 1UL << 29;
const uint32_t CARD_STATUS_ERASE_SEQ_ERROR = 1UL << 28;
const uint32_t CARD_STATUS_ERASE_PARAM = 1UL << 27;
const uint32_t CARD_STATUS_WP_VIOLATION = 1UL << 26;
const uint32_t CARD_STATUS_CARD_IS_LOCKED = 1UL << 25;
const uint32_t CARD_STATUS_LOCK_UNLOCK_FAILED = 1UL << 24;
const uint32_t CARD_STATUS_COM_CRC_ERROR = 1UL << 23;
const uint32_t CARD_STATUS_ILLEGAL_COMMAND = 1UL << 22;
const uint32_t CARD_STATUS_CARD_ECC_FAILED = 1UL << 21;
const uint32_t CARD_STATUS_CC_ERROR = 1UL << 20;
const uint32_t CARD_STATUS_ERROR = 1UL << 19;
// bits 19, 18, and 17 reserved.
const uint32_t CARD_STATUS_CSD_OVERWRITE = 1UL << 16;
const uint32_t CARD_STATUS_WP_ERASE_SKIP = 1UL << 15;
const uint32_t CARD_STATUS_CARD_ECC_DISABLED = 1UL << 14;
const uint32_t CARD_STATUS_ERASE_RESET = 1UL << 13;
const uint32_t CARD_STATUS_CURRENT_STATE = 0XF << 9;
const uint32_t CARD_STATUS_CURRENT_STATE_SHIFT = 9;
const uint32_t CARD_STATUS_READY_FOR_DATA = 1UL << 8;
// bit 7 reserved.
const uint32_t CARD_STATUS_FX_EVENT = 1UL << 6;
const uint32_t CARD_STATUS_APP_CMD = 1UL << 5;
// bit 4 reserved.
const uint32_t CARD_STATUS_AKE_SEQ_ERROR = 1UL << 3;
// bits 2,1, and 0 reserved for manufacturer test mode.
//==============================================================================
const uint8_t R1_READY_STATE = 0X00;
const uint8_t R1_IDLE_STATE = 0X01;
const uint8_t R1_ILLEGAL_COMMAND = 0X04;
const uint8_t DATA_START_SECTOR = 0XFE;
const uint8_t STOP_TRAN_TOKEN = 0XFD;
const uint8_t WRITE_MULTIPLE_TOKEN = 0XFC;
const uint8_t DATA_RES_MASK = 0X1F;
const uint8_t DATA_RES_ACCEPTED = 0X05;
//==============================================================================
typedef struct CID
{
    // byte 0
    unsigned char mid;
    // byte 1-2
    char oid[2];
    // byte 3-7
    char pnm[5];
    // byte 8
    unsigned char prv_m : 4;
    unsigned char prv_n : 4;
    // byte 9-12
    uint32_t psn;
    // byte 13
    unsigned char mdt_year_high : 4;
    unsigned char reserved : 4;
    // byte 14
    unsigned char mdt_month : 4;
    unsigned char mdt_year_low : 4;
    // byte 15
    unsigned char always1 : 1;
    unsigned char crc : 7;
} __attribute__((packed)) cid_t;
 
//==============================================================================
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct CSDV1
{
    // byte 0
    unsigned char reserved1 : 6;
    unsigned char csd_ver : 2;
    // byte 1
    unsigned char taac;
    // byte 2
    unsigned char nsac;
    // byte 3
    unsigned char tran_speed;
    // byte 4
    unsigned char ccc_high;
    // byte 5
    unsigned char read_bl_len : 4;
    unsigned char ccc_low : 4;
    // byte 6
    unsigned char c_size_high : 2;
    unsigned char reserved2 : 2;
    unsigned char dsr_imp : 1;
    unsigned char read_blk_misalign : 1;
    unsigned char write_blk_misalign : 1;
    unsigned char read_bl_partial : 1;
    // byte 7
    unsigned char c_size_mid;
    // byte 8
    unsigned char vdd_r_curr_max : 3;
    unsigned char vdd_r_curr_min : 3;
    unsigned char c_size_low : 2;
    // byte 9
    unsigned char c_size_mult_high : 2;
    unsigned char vdd_w_cur_max : 3;
    unsigned char vdd_w_curr_min : 3;
    // byte 10
    unsigned char sector_size_high : 6;
    unsigned char erase_blk_en : 1;
    unsigned char c_size_mult_low : 1;
    // byte 11
    unsigned char wp_grp_size : 7;
    unsigned char sector_size_low : 1;
    // byte 12
    unsigned char write_bl_len_high : 2;
    unsigned char r2w_factor : 3;
    unsigned char reserved3 : 2;
    unsigned char wp_grp_enable : 1;
    // byte 13
    unsigned char reserved4 : 5;
    unsigned char write_partial : 1;
    unsigned char write_bl_len_low : 2;
    // byte 14
    unsigned char reserved5 : 2;
    unsigned char file_format : 2;
    unsigned char tmp_write_protect : 1;
    unsigned char perm_write_protect : 1;
    unsigned char copy : 1;
    unsigned char file_format_grp : 1;
    // byte 15
    unsigned char always1 : 1;
    unsigned char crc : 7;
} __attribute__((packed)) csd1_t;
//==============================================================================
typedef struct CSDV2
{
    // byte 0
    unsigned char reserved1 : 6;
    unsigned char csd_ver : 2;
    // byte 1
    unsigned char taac;
    // byte 2
    unsigned char nsac;
    // byte 3
    unsigned char tran_speed;
    // byte 4
    unsigned char ccc_high;
    // byte 5
    unsigned char read_bl_len : 4;
    unsigned char ccc_low : 4;
    // byte 6
    unsigned char reserved2 : 4;
    unsigned char dsr_imp : 1;
    unsigned char read_blk_misalign : 1;
    unsigned char write_blk_misalign : 1;
    unsigned char read_bl_partial : 1;
    // byte 7
    unsigned char c_size_high : 6;
    unsigned char reserved3 : 2;
    // byte 8
    unsigned char c_size_mid;
    // byte 9
    unsigned char c_size_low;
    // byte 10
    unsigned char sector_size_high : 6;
    unsigned char erase_blk_en : 1;
    unsigned char reserved4 : 1;
    // byte 11
    unsigned char wp_grp_size : 7;
    unsigned char sector_size_low : 1;
    // byte 12
    unsigned char write_bl_len_high : 2;
    unsigned char r2w_factor : 3;
    unsigned char reserved5 : 2;
    unsigned char wp_grp_enable : 1;
    // byte 13
    unsigned char reserved6 : 5;
    unsigned char write_partial : 1;
    unsigned char write_bl_len_low : 2;
    // byte 14
    unsigned char reserved7 : 2;
    unsigned char file_format : 2;
    unsigned char tmp_write_protect : 1;
    unsigned char perm_write_protect : 1;
    unsigned char copy : 1;
    unsigned char file_format_grp : 1;
    // byte 15
    unsigned char always1 : 1;
    unsigned char crc : 7;
} __attribute__((packed)) csd2_t;
//==============================================================================
union csd_t {
    csd1_t v1;
    csd2_t v2;
};
//-----------------------------------------------------------------------------
inline uint32_t sdCardCapacity(csd_t *csd)
{
    if (csd->v1.csd_ver == 0)
    {
        uint8_t read_bl_len = csd->v1.read_bl_len;
        uint16_t c_size = (csd->v1.c_size_high << 10) | (csd->v1.c_size_mid << 2) | csd->v1.c_size_low;
        uint8_t c_size_mult = (csd->v1.c_size_mult_high << 1) | csd->v1.c_size_mult_low;
        return (uint32_t)(c_size + 1) << (c_size_mult + read_bl_len - 7);
    }
    else if (csd->v2.csd_ver == 1)
    {
        return (((uint32_t)csd->v2.c_size_high << 16) + ((uint16_t)csd->v2.c_size_mid << 8) + csd->v2.c_size_low + 1)
               << 10;
    }
    else
    {
        return 0;
    }
}
//-----------------------------------------------------------------------------
// fields are big endian
typedef struct SdStatus
{
    uint8_t busWidthSecureMode;
    uint8_t reserved1;
    uint8_t sdCardType[2];
    uint8_t sizeOfProtectedArea[4];
    uint8_t speedClass;
    uint8_t performanceMove;
    uint8_t auSize;
    uint8_t eraseSize[2];
    uint8_t eraseTimeoutOffset;
    uint8_t uhsSpeedAuSize;
    uint8_t videoSpeed;
    uint8_t vscAuSize[2];
    uint8_t susAddr[3];
    uint8_t reserved2[3];
    uint8_t reservedManufacturer[40];
} SdStatus_t;
#endif // DOXYGEN_SHOULD_SKIP_THIS
#endif // SdCardInfo_h