486 lines
16 KiB
C
486 lines
16 KiB
C
/**
|
|
* Copyright (c) 2011-2018 Bill Greiman
|
|
* This file is part of the SdFat library for SD memory cards.
|
|
*
|
|
* MIT License
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a
|
|
* copy of this software and associated documentation files (the "Software"),
|
|
* to deal in the Software without restriction, including without limitation
|
|
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
* and/or sell copies of the Software, and to permit persons to whom the
|
|
* Software is furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included
|
|
* in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
* DEALINGS IN THE SOFTWARE.
|
|
*/
|
|
#ifndef SdInfo_h
|
|
#define SdInfo_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.
|
|
typedef enum {
|
|
SD_CARD_ERROR_NONE = 0,
|
|
|
|
// Basic commands and switch command.
|
|
SD_CARD_ERROR_CMD0 = 0X20,
|
|
SD_CARD_ERROR_CMD2,
|
|
SD_CARD_ERROR_CMD3,
|
|
SD_CARD_ERROR_CMD6,
|
|
SD_CARD_ERROR_CMD7,
|
|
SD_CARD_ERROR_CMD8,
|
|
SD_CARD_ERROR_CMD9,
|
|
SD_CARD_ERROR_CMD10,
|
|
SD_CARD_ERROR_CMD12,
|
|
SD_CARD_ERROR_CMD13,
|
|
|
|
// Read, write, erase, and extension commands.
|
|
SD_CARD_ERROR_CMD17 = 0X30,
|
|
SD_CARD_ERROR_CMD18,
|
|
SD_CARD_ERROR_CMD24,
|
|
SD_CARD_ERROR_CMD25,
|
|
SD_CARD_ERROR_CMD32,
|
|
SD_CARD_ERROR_CMD33,
|
|
SD_CARD_ERROR_CMD38,
|
|
SD_CARD_ERROR_CMD58,
|
|
SD_CARD_ERROR_CMD59,
|
|
|
|
// Application specific commands.
|
|
SD_CARD_ERROR_ACMD6 = 0X40,
|
|
SD_CARD_ERROR_ACMD13,
|
|
SD_CARD_ERROR_ACMD23,
|
|
SD_CARD_ERROR_ACMD41,
|
|
|
|
// Read/write errors
|
|
SD_CARD_ERROR_READ = 0X50,
|
|
SD_CARD_ERROR_READ_CRC,
|
|
SD_CARD_ERROR_READ_FIFO,
|
|
SD_CARD_ERROR_READ_REG,
|
|
SD_CARD_ERROR_READ_START,
|
|
SD_CARD_ERROR_READ_TIMEOUT,
|
|
SD_CARD_ERROR_STOP_TRAN,
|
|
SD_CARD_ERROR_WRITE,
|
|
SD_CARD_ERROR_WRITE_FIFO,
|
|
SD_CARD_ERROR_WRITE_START,
|
|
SD_CARD_ERROR_FLASH_PROGRAMMING,
|
|
SD_CARD_ERROR_WRITE_TIMEOUT,
|
|
|
|
// Misc errors.
|
|
SD_CARD_ERROR_DMA = 0X60,
|
|
SD_CARD_ERROR_ERASE,
|
|
SD_CARD_ERROR_ERASE_SINGLE_BLOCK,
|
|
SD_CARD_ERROR_ERASE_TIMEOUT,
|
|
SD_CARD_ERROR_INIT_NOT_CALLED,
|
|
SD_CARD_ERROR_FUNCTION_NOT_SUPPORTED
|
|
} sd_error_code_t;
|
|
//------------------------------------------------------------------------------
|
|
// card types
|
|
/** Standard capacity V1 SD card */
|
|
const uint8_t SD_CARD_TYPE_SD1 = 1;
|
|
/** Standard capacity V2 SD card */
|
|
const uint8_t SD_CARD_TYPE_SD2 = 2;
|
|
/** High Capacity SD card */
|
|
const uint8_t SD_CARD_TYPE_SDHC = 3;
|
|
//------------------------------------------------------------------------------
|
|
#define SD_SCK_HZ(maxSpeed) SPISettings(maxSpeed, MSBFIRST, SPI_MODE0)
|
|
#define SD_SCK_MHZ(maxMhz) SPISettings(1000000UL*maxMhz, MSBFIRST, SPI_MODE0)
|
|
// SPI divisor constants
|
|
/** Set SCK to max rate of F_CPU/2. */
|
|
#define SPI_FULL_SPEED SD_SCK_MHZ(50)
|
|
/** Set SCK rate to F_CPU/3 for Due */
|
|
#define SPI_DIV3_SPEED SD_SCK_HZ(F_CPU/3)
|
|
/** Set SCK rate to F_CPU/4. */
|
|
#define SPI_HALF_SPEED SD_SCK_HZ(F_CPU/4)
|
|
/** Set SCK rate to F_CPU/6 for Due */
|
|
#define SPI_DIV6_SPEED SD_SCK_HZ(F_CPU/6)
|
|
/** Set SCK rate to F_CPU/8. */
|
|
#define SPI_QUARTER_SPEED SD_SCK_HZ(F_CPU/8)
|
|
/** Set SCK rate to F_CPU/16. */
|
|
#define SPI_EIGHTH_SPEED SD_SCK_HZ(F_CPU/16)
|
|
/** Set SCK rate to F_CPU/32. */
|
|
#define SPI_SIXTEENTH_SPEED SD_SCK_HZ(F_CPU/32)
|
|
//------------------------------------------------------------------------------
|
|
// SD operation timeouts
|
|
/** CMD0 retry count */
|
|
const uint8_t SD_CMD0_RETRY = 10;
|
|
/** command timeout ms */
|
|
const uint16_t SD_CMD_TIMEOUT = 300;
|
|
/** init timeout ms */
|
|
const uint16_t SD_INIT_TIMEOUT = 2000;
|
|
/** erase timeout ms */
|
|
const uint16_t SD_ERASE_TIMEOUT = 10000;
|
|
/** read timeout ms */
|
|
const uint16_t SD_READ_TIMEOUT = 1000;
|
|
/** write time out ms */
|
|
const uint16_t SD_WRITE_TIMEOUT = 2000;
|
|
//------------------------------------------------------------------------------
|
|
// SD card commands
|
|
/** GO_IDLE_STATE - init card in spi mode if CS low */
|
|
const uint8_t CMD0 = 0X00;
|
|
/** ALL_SEND_CID - Asks any card to send the CID. */
|
|
const uint8_t CMD2 = 0X02;
|
|
/** SEND_RELATIVE_ADDR - Ask the card to publish a new RCA. */
|
|
const uint8_t CMD3 = 0X03;
|
|
/** SWITCH_FUNC - Switch Function Command */
|
|
const uint8_t CMD6 = 0X06;
|
|
/** SELECT/DESELECT_CARD - toggles between the stand-by and transfer states. */
|
|
const uint8_t CMD7 = 0X07;
|
|
/** SEND_IF_COND - verify SD Memory Card interface operating condition.*/
|
|
const uint8_t CMD8 = 0X08;
|
|
/** SEND_CSD - read the Card Specific Data (CSD register) */
|
|
const uint8_t CMD9 = 0X09;
|
|
/** SEND_CID - read the card identification information (CID register) */
|
|
const uint8_t CMD10 = 0X0A;
|
|
/** STOP_TRANSMISSION - end multiple block read sequence */
|
|
const uint8_t CMD12 = 0X0C;
|
|
/** SEND_STATUS - read the card status register */
|
|
const uint8_t CMD13 = 0X0D;
|
|
/** READ_SINGLE_BLOCK - read a single data block from the card */
|
|
const uint8_t CMD17 = 0X11;
|
|
/** READ_MULTIPLE_BLOCK - read a multiple data blocks from the card */
|
|
const uint8_t CMD18 = 0X12;
|
|
/** WRITE_BLOCK - write a single data block to the card */
|
|
const uint8_t CMD24 = 0X18;
|
|
/** WRITE_MULTIPLE_BLOCK - write blocks of data until a STOP_TRANSMISSION */
|
|
const uint8_t CMD25 = 0X19;
|
|
/** ERASE_WR_BLK_START - sets the address of the first block to be erased */
|
|
const uint8_t CMD32 = 0X20;
|
|
/** ERASE_WR_BLK_END - sets the address of the last block of the continuous
|
|
range to be erased*/
|
|
const uint8_t CMD33 = 0X21;
|
|
/** ERASE - erase all previously selected blocks */
|
|
const uint8_t CMD38 = 0X26;
|
|
/** APP_CMD - escape for application specific command */
|
|
const uint8_t CMD55 = 0X37;
|
|
/** READ_OCR - read the OCR register of a card */
|
|
const uint8_t CMD58 = 0X3A;
|
|
/** CRC_ON_OFF - enable or disable CRC checking */
|
|
const uint8_t CMD59 = 0X3B;
|
|
/** SET_BUS_WIDTH - Defines the data bus width for data transfer. */
|
|
const uint8_t ACMD6 = 0X06;
|
|
/** SD_STATUS - Send the SD Status. */
|
|
const uint8_t ACMD13 = 0X0D;
|
|
/** SET_WR_BLK_ERASE_COUNT - Set the number of write blocks to be
|
|
pre-erased before writing */
|
|
const uint8_t ACMD23 = 0X17;
|
|
/** SD_SEND_OP_COMD - Sends host capacity support information and
|
|
activates the card's initialization process */
|
|
const uint8_t ACMD41 = 0X29;
|
|
//==============================================================================
|
|
// CARD_STATUS
|
|
/** The command's argument was out of the allowed range for this card. */
|
|
const uint32_t CARD_STATUS_OUT_OF_RANGE = 1UL << 31;
|
|
/** A misaligned address which did not match the block length. */
|
|
const uint32_t CARD_STATUS_ADDRESS_ERROR = 1UL << 30;
|
|
/** The transferred block length is not allowed for this card. */
|
|
const uint32_t CARD_STATUS_BLOCK_LEN_ERROR = 1UL << 29;
|
|
/** An error in the sequence of erase commands occurred. */
|
|
const uint32_t CARD_STATUS_ERASE_SEQ_ERROR = 1UL <<28;
|
|
/** An invalid selection of write-blocks for erase occurred. */
|
|
const uint32_t CARD_STATUS_ERASE_PARAM = 1UL << 27;
|
|
/** Set when the host attempts to write to a protected block. */
|
|
const uint32_t CARD_STATUS_WP_VIOLATION = 1UL << 26;
|
|
/** When set, signals that the card is locked by the host. */
|
|
const uint32_t CARD_STATUS_CARD_IS_LOCKED = 1UL << 25;
|
|
/** Set when a sequence or password error has been detected. */
|
|
const uint32_t CARD_STATUS_LOCK_UNLOCK_FAILED = 1UL << 24;
|
|
/** The CRC check of the previous command failed. */
|
|
const uint32_t CARD_STATUS_COM_CRC_ERROR = 1UL << 23;
|
|
/** Command not legal for the card state. */
|
|
const uint32_t CARD_STATUS_ILLEGAL_COMMAND = 1UL << 22;
|
|
/** Card internal ECC was applied but failed to correct the data. */
|
|
const uint32_t CARD_STATUS_CARD_ECC_FAILED = 1UL << 21;
|
|
/** Internal card controller error */
|
|
const uint32_t CARD_STATUS_CC_ERROR = 1UL << 20;
|
|
/** A general or an unknown error occurred during the operation. */
|
|
const uint32_t CARD_STATUS_ERROR = 1UL << 19;
|
|
// bits 19, 18, and 17 reserved.
|
|
/** Permanent WP set or attempt to change read only values of CSD. */
|
|
const uint32_t CARD_STATUS_CSD_OVERWRITE = 1UL <<16;
|
|
/** partial address space was erased due to write protect. */
|
|
const uint32_t CARD_STATUS_WP_ERASE_SKIP = 1UL << 15;
|
|
/** The command has been executed without using the internal ECC. */
|
|
const uint32_t CARD_STATUS_CARD_ECC_DISABLED = 1UL << 14;
|
|
/** out of erase sequence command was received. */
|
|
const uint32_t CARD_STATUS_ERASE_RESET = 1UL << 13;
|
|
/** The state of the card when receiving the command.
|
|
* 0 = idle
|
|
* 1 = ready
|
|
* 2 = ident
|
|
* 3 = stby
|
|
* 4 = tran
|
|
* 5 = data
|
|
* 6 = rcv
|
|
* 7 = prg
|
|
* 8 = dis
|
|
* 9-14 = reserved
|
|
* 15 = reserved for I/O mode
|
|
*/
|
|
const uint32_t CARD_STATUS_CURRENT_STATE = 0XF << 9;
|
|
/** Shift for current state. */
|
|
const uint32_t CARD_STATUS_CURRENT_STATE_SHIFT = 9;
|
|
/** Corresponds to buffer empty signaling on the bus. */
|
|
const uint32_t CARD_STATUS_READY_FOR_DATA = 1UL << 8;
|
|
// bit 7 reserved.
|
|
/** Extension Functions may set this bit to get host to deal with events. */
|
|
const uint32_t CARD_STATUS_FX_EVENT = 1UL << 6;
|
|
/** The card will expect ACMD, or the command has been interpreted as ACMD */
|
|
const uint32_t CARD_STATUS_APP_CMD = 1UL << 5;
|
|
// bit 4 reserved.
|
|
/** Error in the sequence of the authentication process. */
|
|
const uint32_t CARD_STATUS_AKE_SEQ_ERROR = 1UL << 3;
|
|
// bits 2,1, and 0 reserved for manufacturer test mode.
|
|
//==============================================================================
|
|
/** status for card in the ready state */
|
|
const uint8_t R1_READY_STATE = 0X00;
|
|
/** status for card in the idle state */
|
|
const uint8_t R1_IDLE_STATE = 0X01;
|
|
/** status bit for illegal command */
|
|
const uint8_t R1_ILLEGAL_COMMAND = 0X04;
|
|
/** start data token for read or write single block*/
|
|
const uint8_t DATA_START_BLOCK = 0XFE;
|
|
/** stop token for write multiple blocks*/
|
|
const uint8_t STOP_TRAN_TOKEN = 0XFD;
|
|
/** start data token for write multiple blocks*/
|
|
const uint8_t WRITE_MULTIPLE_TOKEN = 0XFC;
|
|
/** mask for data response tokens after a write block operation */
|
|
const uint8_t DATA_RES_MASK = 0X1F;
|
|
/** write data accepted token */
|
|
const uint8_t DATA_RES_ACCEPTED = 0X05;
|
|
//==============================================================================
|
|
/**
|
|
* \class CID
|
|
* \brief Card IDentification (CID) register.
|
|
*/
|
|
typedef struct CID {
|
|
// byte 0
|
|
/** Manufacturer ID */
|
|
unsigned char mid;
|
|
// byte 1-2
|
|
/** OEM/Application ID */
|
|
char oid[2];
|
|
// byte 3-7
|
|
/** Product name */
|
|
char pnm[5];
|
|
// byte 8
|
|
/** Product revision least significant digit */
|
|
unsigned char prv_m : 4;
|
|
/** Product revision most significant digit */
|
|
unsigned char prv_n : 4;
|
|
// byte 9-12
|
|
/** Product serial number */
|
|
uint32_t psn;
|
|
// byte 13
|
|
/** Manufacturing date year low digit */
|
|
unsigned char mdt_year_high : 4;
|
|
/** not used */
|
|
unsigned char reserved : 4;
|
|
// byte 14
|
|
/** Manufacturing date month */
|
|
unsigned char mdt_month : 4;
|
|
/** Manufacturing date year low digit */
|
|
unsigned char mdt_year_low : 4;
|
|
// byte 15
|
|
/** not used always 1 */
|
|
unsigned char always1 : 1;
|
|
/** CRC7 checksum */
|
|
unsigned char crc : 7;
|
|
} __attribute__((packed)) cid_t;
|
|
|
|
//==============================================================================
|
|
/**
|
|
* \class CSDV1
|
|
* \brief CSD register for version 1.00 cards .
|
|
*/
|
|
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;
|
|
/** Indicates the file format on the card */
|
|
unsigned char file_format_grp : 1;
|
|
// byte 15
|
|
unsigned char always1 : 1;
|
|
unsigned char crc : 7;
|
|
} __attribute__((packed)) csd1_t;
|
|
//==============================================================================
|
|
/**
|
|
* \class CSDV2
|
|
* \brief CSD register for version 2.00 cards.
|
|
*/
|
|
typedef struct CSDV2 {
|
|
// byte 0
|
|
unsigned char reserved1 : 6;
|
|
unsigned char csd_ver : 2;
|
|
// byte 1
|
|
/** fixed to 0X0E */
|
|
unsigned char taac;
|
|
// byte 2
|
|
/** fixed to 0 */
|
|
unsigned char nsac;
|
|
// byte 3
|
|
unsigned char tran_speed;
|
|
// byte 4
|
|
unsigned char ccc_high;
|
|
// byte 5
|
|
/** This field is fixed to 9h, which indicates READ_BL_LEN=512 Byte */
|
|
unsigned char read_bl_len : 4;
|
|
unsigned char ccc_low : 4;
|
|
// byte 6
|
|
/** not used */
|
|
unsigned char reserved2 : 4;
|
|
unsigned char dsr_imp : 1;
|
|
/** fixed to 0 */
|
|
unsigned char read_blk_misalign : 1;
|
|
/** fixed to 0 */
|
|
unsigned char write_blk_misalign : 1;
|
|
/** fixed to 0 - no partial read */
|
|
unsigned char read_bl_partial : 1;
|
|
// byte 7
|
|
/** high part of card size */
|
|
unsigned char c_size_high : 6;
|
|
/** not used */
|
|
unsigned char reserved3 : 2;
|
|
// byte 8
|
|
/** middle part of card size */
|
|
unsigned char c_size_mid;
|
|
// byte 9
|
|
/** low part of card size */
|
|
unsigned char c_size_low;
|
|
// byte 10
|
|
/** sector size is fixed at 64 KB */
|
|
unsigned char sector_size_high : 6;
|
|
/** fixed to 1 - erase single is supported */
|
|
unsigned char erase_blk_en : 1;
|
|
/** not used */
|
|
unsigned char reserved4 : 1;
|
|
// byte 11
|
|
unsigned char wp_grp_size : 7;
|
|
/** sector size is fixed at 64 KB */
|
|
unsigned char sector_size_low : 1;
|
|
// byte 12
|
|
/** write_bl_len fixed for 512 byte blocks */
|
|
unsigned char write_bl_len_high : 2;
|
|
/** fixed value of 2 */
|
|
unsigned char r2w_factor : 3;
|
|
/** not used */
|
|
unsigned char reserved5 : 2;
|
|
/** fixed value of 0 - no write protect groups */
|
|
unsigned char wp_grp_enable : 1;
|
|
// byte 13
|
|
unsigned char reserved6 : 5;
|
|
/** always zero - no partial block read*/
|
|
unsigned char write_partial : 1;
|
|
/** write_bl_len fixed for 512 byte blocks */
|
|
unsigned char write_bl_len_low : 2;
|
|
// byte 14
|
|
unsigned char reserved7: 2;
|
|
/** Do not use always 0 */
|
|
unsigned char file_format : 2;
|
|
unsigned char tmp_write_protect : 1;
|
|
unsigned char perm_write_protect : 1;
|
|
unsigned char copy : 1;
|
|
/** Do not use always 0 */
|
|
unsigned char file_format_grp : 1;
|
|
// byte 15
|
|
/** not used always 1 */
|
|
unsigned char always1 : 1;
|
|
/** checksum */
|
|
unsigned char crc : 7;
|
|
} __attribute__((packed)) csd2_t;
|
|
//==============================================================================
|
|
/**
|
|
* \class csd_t
|
|
* \brief Union of old and new style CSD register.
|
|
*/
|
|
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) {
|
|
uint32_t c_size = 0X10000L * csd->v2.c_size_high + 0X100L
|
|
* (uint32_t)csd->v2.c_size_mid + csd->v2.c_size_low;
|
|
return (c_size + 1) << 10;
|
|
} else {
|
|
return 0;
|
|
}
|
|
}
|
|
#endif // SdInfo_h
|