fdskey/FdsKey_bootloader/Core/Inc/sdcard.h

#ifndef __SDCARD_H__
#define __SDCARD_H__

#include "main.h"

#define SD_SPI_PORT      hspi3

#define SD_INIT_TRIES             32
#define SD_TIMEOUT                1000 // milliseconds
#define SD_R1_ANSWER_RETRY_COUNT  32
#define SD_CMD0_RETRY_COUNT       100
#define SD_ACMD41_TIMEOUT         500 // milliseconds

#define SD_R1_IDLE (1 << 0)
#define SD_R1_ERASE_CLEARED (1 << 1)
#define SD_R1_ILLEGAL_COMMAND (1 << 2)
#define SD_R1_CRC_ERROR (1 << 3)
#define SD_R1_ERASE_COMMANDS_ERROR (1 << 4)
#define SD_R1_MISALIGNED_ADDRESS (1 << 5)
#define SD_R1_ARGUMENT_OUTSIDE_OF_RANGE (1 << 6)

#define SD_BLOCK_LENGTH               512
#define SD_DATA_TOKEN                 0xFE
#define SD_SEND_MULTIPLE_DATA_TOKEN   0xFC
#define SD_STOP_DATA_TOKEN            0xFD

typedef enum {
  SD_RES_OK = 0,
  SD_R1_FAILED = 1,
  SD_RES_CMD0_R1_FAILED = 2,
  SD_RES_CMD0_COUNT_FAILED = 3,
  SD_RES_CMD8_R7_FAILED = 4,
  SD_RES_CMD8_GEN_FAILED = 5,
  SD_RES_ACMD41_R1_FAILED = 6,
  SD_RES_ACMD41_TIMEOUT = 7,
  SD_RES_CMD8_VOLTAGE_FAILED = 8,
  SD_RES_CMD58_R3_FAILED = 9,
  SD_RES_CMD58_GEN_FAILED = 10,
  SD_RES_CMD58_VOLTAGE_FAILED = 11,
  SD_RES_CMD16_R1_FAILED = 12,
  SD_RES_CMD16_R1_NOT_NULL = 13,
  SD_RES_DATA_TOKEN_WRONG = 14,
  SD_RES_DATA_TOKEN_TIMEOUT = 15,
  SD_RES_BUSY_TIMEOUT = 16,
  SD_RES_CMD17_R1_FAILED = 17,
  SD_RES_CMD17_R1_NOT_NULL = 18,
  SD_RES_CMD55_R1_FAILED = 19,
  SD_RES_CMD55_R1_NOT_NULL = 20,
  SD_RES_CMD24_BUSY_TIMEOUT = 21,
  SD_RES_CMD24_DATA_REJECTED = 22,
  SD_RES_CMD18_R1_FAILED = 23,
  SD_RES_CMD18_R1_NOT_NULL = 24,
  SD_RES_CMD24_R1_FAILED = 25,
  SD_RES_CMD24_R1_NOT_NULL = 26,
  SD_RES_CMD12_R1_FAILED = 27,
  SD_RES_CMD12_R1_NOT_NULL = 28,
  SD_RES_CMD25_R1_FAILED = 29,
  SD_RES_CMD25_R1_NOT_NULL = 30,
  SD_RES_WRITE_MULTI_BUSY_TIMEOUT = 31,
  SD_RES_WRITE_MULTI_DATA_REJECTED = 32,
  SD_RES_WRITE_MULTI_END_NOT_BUSY_TIMEOUT = 33,
  SD_RES_CMD9_R1_FAILED = 34,
  SD_RES_CMD9_R1_NOT_NULL = 35,
  SD_RES_CMD10_R1_FAILED = 36,
  SD_RES_CMD10_R1_NOT_NULL = 37,
  SD_RES_INVALID_CSD_VERSION = 38
} SD_RESULT;

typedef struct {
    /* Header part */
    uint8_t CSDStruct : 2; /* CSD structure */
    uint8_t Reserved1 : 6; /* Reserved */
    uint8_t TAAC : 8; /* Data read access-time 1 */
    uint8_t NSAC : 8; /* Data read access-time 2 in CLK cycles */
    uint8_t MaxBusClkFrec : 8; /* Max. bus clock frequency */
    uint16_t CardComdClasses : 12; /* Card command classes */
    uint8_t RdBlockLen : 4; /* Max. read data block length */
    uint8_t PartBlockRead : 1; /* Partial blocks for read allowed */
    uint8_t WrBlockMisalign : 1; /* Write block misalignment */
    uint8_t RdBlockMisalign : 1; /* Read block misalignment */
    uint8_t DSRImpl : 1; /* DSR implemented */

    /* v1 or v2 struct */
    union csd_version {
        struct {
            uint8_t Reserved1 : 2; /* Reserved */
            uint16_t DeviceSize : 12; /* Device Size */
            uint8_t MaxRdCurrentVDDMin : 3; /* Max. read current @ VDD min */
            uint8_t MaxRdCurrentVDDMax : 3; /* Max. read current @ VDD max */
            uint8_t MaxWrCurrentVDDMin : 3; /* Max. write current @ VDD min */
            uint8_t MaxWrCurrentVDDMax : 3; /* Max. write current @ VDD max */
            uint8_t DeviceSizeMul : 3; /* Device size multiplier */
        } v1;
        struct {
            uint8_t Reserved1 : 6; /* Reserved */
            uint32_t DeviceSize : 22; /* Device Size */
            uint8_t Reserved2 : 1; /* Reserved */
        } v2;
    } version;

    uint8_t EraseSingleBlockEnable : 1; /* Erase single block enable */
    uint8_t EraseSectorSize : 7; /* Erase group size multiplier */
    uint8_t WrProtectGrSize : 7; /* Write protect group size */
    uint8_t WrProtectGrEnable : 1; /* Write protect group enable */
    uint8_t Reserved2 : 2; /* Reserved */
    uint8_t WrSpeedFact : 3; /* Write speed factor */
    uint8_t MaxWrBlockLen : 4; /* Max. write data block length */
    uint8_t WriteBlockPartial : 1; /* Partial blocks for write allowed */
    uint8_t Reserved3 : 5; /* Reserved */
    uint8_t FileFormatGrouop : 1; /* File format group */
    uint8_t CopyFlag : 1; /* Copy flag (OTP) */
    uint8_t PermWrProtect : 1; /* Permanent write protection */
    uint8_t TempWrProtect : 1; /* Temporary write protection */
    uint8_t FileFormat : 2; /* File Format */
    uint8_t Reserved4 : 2; /* Reserved */
    uint8_t crc : 7; /* Reserved */
    uint8_t Reserved5 : 1; /* always 1*/

} SD_CSD;

typedef struct {
    uint8_t ManufacturerID; /* ManufacturerID */
    char OEM_AppliID[3]; /* OEM/Application ID */
    char ProdName[6]; /* Product Name */
    uint8_t ProdRev; /* Product Revision */
    uint32_t ProdSN; /* Product Serial Number */
    uint8_t Reserved1; /* Reserved1 */
    uint8_t ManufactYear; /* Manufacturing Year */
    uint8_t ManufactMonth; /* Manufacturing Month */
    uint8_t CID_CRC; /* CID CRC */
    uint8_t Reserved2; /* always 1 */
} SD_CID;

extern SPI_HandleTypeDef SD_SPI_PORT;

// Initialization
SD_RESULT SD_init();
SD_RESULT SD_init_try_speed();
uint32_t SD_get_spi_speed();

// Read/write single blocks
SD_RESULT SD_read_single_block(uint32_t blockNum, uint8_t* buff); // sizeof(buff) == 512!
SD_RESULT SD_write_single_block(uint32_t blockNum, const uint8_t* buff); // sizeof(buff) == 512!

// Read Multiple Blocks
SD_RESULT SD_read_begin(uint32_t blockNum);
SD_RESULT SD_read_data(uint8_t* buff); // sizeof(buff) == 512!
SD_RESULT SD_read_end();

// Write Multiple Blocks
SD_RESULT SD_write_begin(uint32_t blockNum);
SD_RESULT SD_write_data(const uint8_t* buff); // sizeof(buff) == 512!
SD_RESULT SD_write_end();

// SD card info
SD_RESULT SD_read_CSD(SD_CSD* csd);
SD_RESULT SD_read_CID(SD_CID* cid);
uint64_t SD_read_capacity();

// TODO: read lock flag? CMD13, SEND_STATUS

#endif // __SDCARD_H__