UM1725

HAL SD Generic Driver

53.2.27HAL_SD_HighSpeed

Function Name	HAL_SD_ErrorTypedef HAL_SD_HighSpeed
	(SD_HandleTypeDef * hsd)
Function Description	Switches the SD card to High Speed mode.
Parameters	hsd: SD handle
Return values	SD Card error state
Notes	This operation should be followed by the configuration of PLL
	to have SDIOCK clock between 67 and 75 MHz

53.2.28HAL_SD_SendSDStatus

Function Name	HAL_SD_ErrorTypedef HAL_SD_SendSDStatus
	(SD_HandleTypeDef * hsd, uint32_t * pSDstatus)
Function Description	Returns the current SD card's status.
Parameters	hsd: SD handle
	pSDstatus: Pointer to the buffer that will contain the SD card
	status SD Status register)
Return values	SD Card error state

53.2.29HAL_SD_GetStatus

Function Name	HAL_SD_TransferStateTypedef HAL_SD_GetStatus
	(SD_HandleTypeDef * hsd)
Function Description	Gets the current sd card data status.
Parameters		hsd: SD handle
Return values		Data Transfer state

53.2.30HAL_SD_GetCardStatus

Function Name	HAL_SD_ErrorTypedef HAL_SD_GetCardStatus
	(SD_HandleTypeDef * hsd, HAL_SD_CardStatusTypedef *
	pCardStatus)
Function Description	Gets the SD card status.
Parameters	hsd: SD handle
	pCardStatus: Pointer to the HAL_SD_CardStatusTypedef
	structure that will contain the SD card status information
Return values	SD Card error state

53.3SD Firmware driver defines

53.3.1	SD
	SD Exported Constants
	SD_CMD_GO_IDLE_STATE	Resets the SD memory
		card.
	DOCID025834 Rev 2	709/900

HAL SD Generic Driver

UM1725

SD_CMD_SEND_OP_COND

SD_CMD_ALL_SEND_CID

SD_CMD_SET_REL_ADDR

SD_CMD_SET_DSR

SD_CMD_SDIO_SEN_OP_COND

SD_CMD_HS_SWITCH

SD_CMD_SEL_DESEL_CARD

SD_CMD_HS_SEND_EXT_CSD

SD_CMD_SEND_CSD

SD_CMD_SEND_CID

SD_CMD_READ_DAT_UNTIL_STOP

SD_CMD_STOP_TRANSMISSION

SD_CMD_SEND_STATUS

SD_CMD_HS_BUSTEST_READ

SD_CMD_GO_INACTIVE_STATE

SD_CMD_SET_BLOCKLEN

710/900

DOCID025834 Rev 2

Sends host capacity support information and activates the card's initialization process.

Asks any card connected to the host to send the CID numbers on the CMD line.

Asks the card to publish a new relative address (RCA).

Programs the DSR of all cards.

Sends host capacity support information (HCS) and asks the accessed card to send its operating condition register (OCR) content in the response on the CMD line.

Checks switchable function (mode 0) and switch card function (mode 1).

Selects the card by its own relative address and gets deselected by any other address

Sends SD Memory Card interface condition, which includes host supply voltage information and asks the card whether card supports voltage.

Addressed card sends its card specific data (CSD) on the CMD line.

Addressed card sends its card identification (CID) on the CMD line.

SD card doesn't support it.

Forces the card to stop transmission.

Addressed card sends its status register.

Sends an addressed card into the inactive state.

Sets the block length (in bytes for SDSC) for all following block commands

UM1725

HAL SD Generic Driver

SD_CMD_READ_SINGLE_BLOCK

SD_CMD_READ_MULT_BLOCK

SD_CMD_HS_BUSTEST_WRITE

SD_CMD_WRITE_DAT_UNTIL_STOP SD_CMD_SET_BLOCK_COUNT SD_CMD_WRITE_SINGLE_BLOCK

SD_CMD_WRITE_MULT_BLOCK

SD_CMD_PROG_CID

SD_CMD_PROG_CSD

SD_CMD_SET_WRITE_PROT

SD_CMD_CLR_WRITE_PROT

SD_CMD_SEND_WRITE_PROT

SD_CMD_SD_ERASE_GRP_START

SD_CMD_SD_ERASE_GRP_END

DOCID025834 Rev 2

(read, write, lock). Default block length is fixed to 512 Bytes. Not effective for SDHS and SDXC.

Reads single block of size selected by SET_BLOCKLEN in case of SDSC, and a block of fixed 512 bytes in case of SDHC and SDXC.

Continuously transfers data blocks from card to host until interrupted by STOP_TRANSMISSION command.

64 bytes tuning pattern is sent for SDR50 and SDR104.

Speed class control command.

Specify block count for CMD18 and CMD25.

Writes single block of size selected by SET_BLOCKLEN in case of SDSC, and a block of fixed 512 bytes in case of SDHC and SDXC.

Continuously writes blocks of data until a STOP_TRANSMISSION follows.

Reserved for manufacturers.

Programming of the programmable bits of the CSD.

Sets the write protection bit of the addressed group.

Clears the write protection bit of the addressed group.

Asks the card to send the status of the write protection bits.

Sets the address of the first write block to be erased. (For SD card only).

Sets the address of the last write block of the continuous

711/900

HAL SD Generic Driver

UM1725

SD_CMD_ERASE_GRP_START

SD_CMD_ERASE_GRP_END

SD_CMD_ERASE

SD_CMD_FAST_IO

SD_CMD_GO_IRQ_STATE

SD_CMD_LOCK_UNLOCK

SD_CMD_APP_CMD

SD_CMD_GEN_CMD

SD_CMD_NO_CMD

SD_CMD_APP_SD_SET_BUSWIDTH

SD_CMD_SD_APP_STATUS SD_CMD_SD_APP_SEND_NUM_WRITE_BLOCKS

712/900

DOCID025834 Rev 2

range to be erased.

Sets the address of the first write block to be erased. Reserved for each command system set by switch function command (CMD6).

Sets the address of the last write block of the continuous range to be erased. Reserved for each command system set by switch function command (CMD6).

Reserved for SD security applications.

SD card doesn't support it (Reserved).

SD card doesn't support it (Reserved).

Sets/resets the password or lock/unlock the card. The size of the data block is set by the SET_BLOCK_LEN command.

Indicates to the card that the next command is an application specific command rather than a standard command.

Used either to transfer a data block to the card or to get a data block from the card for general purpose/application specific commands.

SDIO_APP_CMD should be sent before sending these commands. (ACMD6) Defines the data bus width to be used for data transfer. The allowed data bus widths are given in SCR register.

(ACMD13) Sends the SD status.

(ACMD22) Sends the number of the written (without errors) write blocks.

UM1725

HAL SD Generic Driver

SD_CMD_SD_APP_OP_COND

SD_CMD_SD_APP_SET_CLR_CARD_DETECT

SD_CMD_SD_APP_SEND_SCR

SD_CMD_SDIO_RW_DIRECT

SD_CMD_SDIO_RW_EXTENDED

SD_CMD_SD_APP_GET_MKB

SD_CMD_SD_APP_GET_MID SD_CMD_SD_APP_SET_CER_RN1 SD_CMD_SD_APP_GET_CER_RN2 SD_CMD_SD_APP_SET_CER_RES2 SD_CMD_SD_APP_GET_CER_RES1 SD_CMD_SD_APP_SECURE_READ_MULTIPLE_BLOCK SD_CMD_SD_APP_SECURE_WRITE_MULTIPLE_BLOCK SD_CMD_SD_APP_SECURE_ERASE SD_CMD_SD_APP_CHANGE_SECURE_AREA SD_CMD_SD_APP_SECURE_WRITE_MKB STD_CAPACITY_SD_CARD_V1_1 STD_CAPACITY_SD_CARD_V2_0 HIGH_CAPACITY_SD_CARD

MULTIMEDIA_CARD

SECURE_DIGITAL_IO_CARD

HIGH_SPEED_MULTIMEDIA_CARD

SECURE_DIGITAL_IO_COMBO_CARD

HIGH_CAPACITY_MMC_CARD

Responds with 32bit+CRC data block.

(ACMD41) Sends host capacity support information (HCS) and asks the accessed card to send its operating condition register (OCR) content in the response on the CMD line.

(ACMD42) Connects/Disconnects the 50 KOhm pull-up resistor on CD/DAT3 (pin 1) of the card.

Reads the SD Configuration

Register (SCR).

For SD I/O card only, reserved for security specification.

For SD I/O card only, reserved for security specification.

SD_CMD_APP_CMD should be sent before sending these commands. For SD card only

For SD card only

For SD card only

For SD card only

For SD card only

For SD card only

For SD card only

For SD card only

For SD card only

For SD card only

For SD card only

DOCID025834 Rev 2

713/900

HAL SD Generic Driver			UM1725
	SD Exported Macros
	__HAL_SD_SDIO_ENABLE	Description:
		Enable the SD device.
		Return value:
			None
	__HAL_SD_SDIO_DISABLE	Description:
		Disable the SD device.
		Return value:
			None
	__HAL_SD_SDIO_DMA_ENABLE	Description:
		Enable the SDIO DMA transfer.
		Return value:
			None
	__HAL_SD_SDIO_DMA_DISABLE	Description:
		Disable the SDIO DMA transfer.
		Return value:
			None
	__HAL_SD_SDIO_ENABLE_IT	Description:
		Enable the SD device interrupt.
		Parameters:
			__HANDLE__: SD Handle
		__INTERRUPT__: specifies the SDIO interrupt
			sources to be enabled. This parameter can be
			one or a combination of the following values:
			SDIO_IT_CCRCFAIL: Command response
			received (CRC check failed) interrupt
			SDIO_IT_DCRCFAIL: Data block
			sent/received (CRC check failed) interrupt
			SDIO_IT_CTIMEOUT: Command response
			timeout interrupt
			SDIO_IT_DTIMEOUT: Data timeout
			interrupt
			SDIO_IT_TXUNDERR: Transmit FIFO
			underrun error interrupt
			SDIO_IT_RXOVERR: Received FIFO
			overrun error interrupt
			SDIO_IT_CMDREND: Command response
			received (CRC check passed) interrupt
			SDIO_IT_CMDSENT: Command sent (no
			response required) interrupt
			SDIO_IT_DATAEND: Data end (data
			counter, SDIDCOUNT, is zero) interrupt
			SDIO_IT_STBITERR: Start bit not detected
			on all data signals in wide bus mode
714/900	DOCID025834 Rev 2

UM1725	HAL SD Generic Driver
	interrupt
	SDIO_IT_DBCKEND: Data block
	sent/received (CRC check passed) interrupt
	SDIO_IT_CMDACT: Command transfer in
	progress interrupt
	SDIO_IT_TXACT: Data transmit in progress
	interrupt
	SDIO_IT_RXACT: Data receive in progress
	interrupt
	SDIO_IT_TXFIFOHE: Transmit FIFO Half
	Empty interrupt
	SDIO_IT_RXFIFOHF: Receive FIFO Half
	Full interrupt
	SDIO_IT_TXFIFOF: Transmit FIFO full
	interrupt
	SDIO_IT_RXFIFOF: Receive FIFO full
	interrupt
	SDIO_IT_TXFIFOE: Transmit FIFO empty
	interrupt
	SDIO_IT_RXFIFOE: Receive FIFO empty
	interrupt
	SDIO_IT_TXDAVL: Data available in
	transmit FIFO interrupt
	SDIO_IT_RXDAVL: Data available in
	receive FIFO interrupt
	SDIO_IT_SDIOIT: SD I/O interrupt received
	interrupt
	SDIO_IT_CEATAEND: CE-ATA command
	completion signal received for CMD61
	interrupt
Return value:
	None

__HAL_SD_SDIO_DISABLE_IT Description:

Disable the SD device interrupt.

Parameters:

__HANDLE__: SD Handle

__INTERRUPT__: specifies the SDIO interrupt sources to be disabled. This parameter can be one or a combination of the following values:

SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt

SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt

SDIO_IT_CTIMEOUT: Command response timeout interrupt

SDIO_IT_DTIMEOUT: Data timeout interrupt

SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt

SDIO_IT_RXOVERR: Received FIFO overrun error interrupt

DOCID025834 Rev 2

715/900

HAL SD Generic Driver	UM1725
	SDIO_IT_CMDREND: Command response
	received (CRC check passed) interrupt
	SDIO_IT_CMDSENT: Command sent (no
	response required) interrupt
	SDIO_IT_DATAEND: Data end (data
	counter, SDIDCOUNT, is zero) interrupt
	SDIO_IT_STBITERR: Start bit not detected
	on all data signals in wide bus mode
	interrupt
	SDIO_IT_DBCKEND: Data block
	sent/received (CRC check passed) interrupt
	SDIO_IT_CMDACT: Command transfer in
	progress interrupt
	SDIO_IT_TXACT: Data transmit in progress
	interrupt
	SDIO_IT_RXACT: Data receive in progress
	interrupt
	SDIO_IT_TXFIFOHE: Transmit FIFO Half
	Empty interrupt
	SDIO_IT_RXFIFOHF: Receive FIFO Half
	Full interrupt
	SDIO_IT_TXFIFOF: Transmit FIFO full
	interrupt
	SDIO_IT_RXFIFOF: Receive FIFO full
	interrupt
	SDIO_IT_TXFIFOE: Transmit FIFO empty
	interrupt
	SDIO_IT_RXFIFOE: Receive FIFO empty
	interrupt
	SDIO_IT_TXDAVL: Data available in
	transmit FIFO interrupt
	SDIO_IT_RXDAVL: Data available in
	receive FIFO interrupt
	SDIO_IT_SDIOIT: SD I/O interrupt received
	interrupt
	SDIO_IT_CEATAEND: CE-ATA command
	completion signal received for CMD61
	interrupt
Return value:
	None

__HAL_SD_SDIO_GET_FLAG Description:

Check whether the specified SD flag is set or not.

Parameters:

__HANDLE__: SD Handle

__FLAG__: specifies the flag to check. This parameter can be one of the following values:

SDIO_FLAG_CCRCFAIL: Command response received (CRC check failed)

SDIO_FLAG_DCRCFAIL: Data block sent/received (CRC check failed)

716/900

DOCID025834 Rev 2

UM1725	HAL SD Generic Driver
	SDIO_FLAG_CTIMEOUT: Command
	response timeout
	SDIO_FLAG_DTIMEOUT: Data timeout
	SDIO_FLAG_TXUNDERR: Transmit FIFO
	underrun error
	SDIO_FLAG_RXOVERR: Received FIFO
	overrun error
	SDIO_FLAG_CMDREND: Command
	response received (CRC check passed)
	SDIO_FLAG_CMDSENT: Command sent
	(no response required)
	SDIO_FLAG_DATAEND: Data end (data
	counter, SDIDCOUNT, is zero)
	SDIO_FLAG_STBITERR: Start bit not
	detected on all data signals in wide bus
	mode.
	SDIO_FLAG_DBCKEND: Data block
	sent/received (CRC check passed)
	SDIO_FLAG_CMDACT: Command transfer
	in progress
	SDIO_FLAG_TXACT: Data transmit in
	progress
	SDIO_FLAG_RXACT: Data receive in
	progress
	SDIO_FLAG_TXFIFOHE: Transmit FIFO
	Half Empty
	SDIO_FLAG_RXFIFOHF: Receive FIFO
	Half Full
	SDIO_FLAG_TXFIFOF: Transmit FIFO full
	SDIO_FLAG_RXFIFOF: Receive FIFO full
	SDIO_FLAG_TXFIFOE: Transmit FIFO
	empty
	SDIO_FLAG_RXFIFOE: Receive FIFO
	empty
	SDIO_FLAG_TXDAVL: Data available in
	transmit FIFO
	SDIO_FLAG_RXDAVL: Data available in
	receive FIFO
	SDIO_FLAG_SDIOIT: SD I/O interrupt
	received
	SDIO_FLAG_CEATAEND: CE-ATA
	command completion signal received for
	CMD61

Return value:

The: new state of SD FLAG (SET or RESET). __HAL_SD_SDIO_CLEAR_FLAG Description:

Clear the SD's pending flags.

Parameters:

__HANDLE__: SD Handle

__FLAG__: specifies the flag to clear. This parameter can be one or a combination of the

DOCID025834 Rev 2

717/900

HAL SD Generic Driver	UM1725
	following values:
	SDIO_FLAG_CCRCFAIL: Command
	response received (CRC check failed)
	SDIO_FLAG_DCRCFAIL: Data block
	sent/received (CRC check failed)
	SDIO_FLAG_CTIMEOUT: Command
	response timeout
	SDIO_FLAG_DTIMEOUT: Data timeout
	SDIO_FLAG_TXUNDERR: Transmit FIFO
	underrun error
	SDIO_FLAG_RXOVERR: Received FIFO
	overrun error
	SDIO_FLAG_CMDREND: Command
	response received (CRC check passed)
	SDIO_FLAG_CMDSENT: Command sent
	(no response required)
	SDIO_FLAG_DATAEND: Data end (data
	counter, SDIDCOUNT, is zero)
	SDIO_FLAG_STBITERR: Start bit not
	detected on all data signals in wide bus
	mode
	SDIO_FLAG_DBCKEND: Data block
	sent/received (CRC check passed)
	SDIO_FLAG_SDIOIT: SD I/O interrupt
	received
	SDIO_FLAG_CEATAEND: CE-ATA
	command completion signal received for
	CMD61
Return value:
	None

__HAL_SD_SDIO_GET_IT Description:

Check whether the specified SD interrupt has occurred or not.

Parameters:

__HANDLE__: SD Handle

__INTERRUPT__: specifies the SDIO interrupt source to check. This parameter can be one of the following values:

SDIO_IT_CCRCFAIL: Command response received (CRC check failed) interrupt

SDIO_IT_DCRCFAIL: Data block sent/received (CRC check failed) interrupt

SDIO_IT_CTIMEOUT: Command response timeout interrupt

SDIO_IT_DTIMEOUT: Data timeout interrupt

SDIO_IT_TXUNDERR: Transmit FIFO underrun error interrupt

SDIO_IT_RXOVERR: Received FIFO overrun error interrupt

SDIO_IT_CMDREND: Command response

718/900

DOCID025834 Rev 2

UM1725	HAL SD Generic Driver
	received (CRC check passed) interrupt
	SDIO_IT_CMDSENT: Command sent (no
	response required) interrupt
	SDIO_IT_DATAEND: Data end (data
	counter, SDIDCOUNT, is zero) interrupt
	SDIO_IT_STBITERR: Start bit not detected
	on all data signals in wide bus mode
	interrupt
	SDIO_IT_DBCKEND: Data block
	sent/received (CRC check passed) interrupt
	SDIO_IT_CMDACT: Command transfer in
	progress interrupt
	SDIO_IT_TXACT: Data transmit in progress
	interrupt
	SDIO_IT_RXACT: Data receive in progress
	interrupt
	SDIO_IT_TXFIFOHE: Transmit FIFO Half
	Empty interrupt
	SDIO_IT_RXFIFOHF: Receive FIFO Half
	Full interrupt
	SDIO_IT_TXFIFOF: Transmit FIFO full
	interrupt
	SDIO_IT_RXFIFOF: Receive FIFO full
	interrupt
	SDIO_IT_TXFIFOE: Transmit FIFO empty
	interrupt
	SDIO_IT_RXFIFOE: Receive FIFO empty
	interrupt
	SDIO_IT_TXDAVL: Data available in
	transmit FIFO interrupt
	SDIO_IT_RXDAVL: Data available in
	receive FIFO interrupt
	SDIO_IT_SDIOIT: SD I/O interrupt received
	interrupt
	SDIO_IT_CEATAEND: CE-ATA command
	completion signal received for CMD61
	interrupt

	Return value:
	The: new state of SD IT (SET or RESET).
__HAL_SD_SDIO_CLEAR_IT	Description:
	Clear the SD's interrupt pending bits.
	Parameters:
	__HANDLE__: : SD Handle
	__INTERRUPT__: specifies the interrupt
	pending bit to clear. This parameter can be one
	or a combination of the following values:
	SDIO_IT_CCRCFAIL: Command response
	received (CRC check failed) interrupt
	SDIO_IT_DCRCFAIL: Data block
	sent/received (CRC check failed) interrupt
	SDIO_IT_CTIMEOUT: Command response
DOCID025834 Rev 2		719/900

HAL SD Generic Driver	UM1725
	timeout interrupt
	SDIO_IT_DTIMEOUT: Data timeout
	interrupt
	SDIO_IT_TXUNDERR: Transmit FIFO
	underrun error interrupt
	SDIO_IT_RXOVERR: Received FIFO
	overrun error interrupt
	SDIO_IT_CMDREND: Command response
	received (CRC check passed) interrupt
	SDIO_IT_CMDSENT: Command sent (no
	response required) interrupt
	SDIO_IT_DATAEND: Data end (data
	counter, SDIO_DCOUNT, is zero) interrupt
	SDIO_IT_STBITERR: Start bit not detected
	on all data signals in wide bus mode
	interrupt
	SDIO_IT_SDIOIT: SD I/O interrupt received
	interrupt
	SDIO_IT_CEATAEND: CE-ATA command
	completion signal received for CMD61
Return value:
	None

SD Handle Structure definition

SD_InitTypeDef

SD_TypeDef

SD Private Defines

DATA_BLOCK_SIZE

SDIO_STATIC_FLAGS

SDIO_CMD0TIMEOUT

SD_OCR_ADDR_OUT_OF_RANGE

SD_OCR_ADDR_MISALIGNED

SD_OCR_BLOCK_LEN_ERR

SD_OCR_ERASE_SEQ_ERR

SD_OCR_BAD_ERASE_PARAM

SD_OCR_WRITE_PROT_VIOLATION

SD_OCR_LOCK_UNLOCK_FAILED

SD_OCR_COM_CRC_FAILED

SD_OCR_ILLEGAL_CMD

SD_OCR_CARD_ECC_FAILED

SD_OCR_CC_ERROR

SD_OCR_GENERAL_UNKNOWN_ERROR

SD_OCR_STREAM_READ_UNDERRUN

720/900

DOCID025834 Rev 2

UM1725

HAL SD Generic Driver

SD_OCR_STREAM_WRITE_OVERRUN SD_OCR_CID_CSD_OVERWRITE SD_OCR_WP_ERASE_SKIP SD_OCR_CARD_ECC_DISABLED SD_OCR_ERASE_RESET SD_OCR_AKE_SEQ_ERROR SD_OCR_ERRORBITS SD_R6_GENERAL_UNKNOWN_ERROR SD_R6_ILLEGAL_CMD SD_R6_COM_CRC_FAILED SD_VOLTAGE_WINDOW_SD SD_HIGH_CAPACITY SD_STD_CAPACITY SD_CHECK_PATTERN SD_MAX_VOLT_TRIAL

SD_ALLZERO

SD_WIDE_BUS_SUPPORT

SD_SINGLE_BUS_SUPPORT

SD_CARD_LOCKED

SD_DATATIMEOUT

SD_0TO7BITS

SD_8TO15BITS

SD_16TO23BITS

SD_24TO31BITS

SD_MAX_DATA_LENGTH

SD_HALFFIFO

SD_HALFFIFOBYTES

SD_CCCC_LOCK_UNLOCK

SD_CCCC_WRITE_PROT

SD_CCCC_ERASE

SD_SDIO_SEND_IF_COND

SDIO_APP_CMD should be sent before sending these commands.

DOCID025834 Rev 2

721/900