SD card HAL module driver. This file provides firmware functions to manage the following functionalities of the Secure Digital (SD) peripheral: More...

#include "stm32f4xx_hal.h"

Include dependency graph for stm32f4xx_hal_sd.c:

Functions
static uint32_t	SD_InitCard (SD_HandleTypeDef *hsd)
	Initializes the sd card.

static uint32_t	SD_PowerON (SD_HandleTypeDef *hsd)
	Enquires cards about their operating voltage and configures clock controls and stores SD information that will be needed in future in the SD handle.

static uint32_t	SD_SendSDStatus (SD_HandleTypeDef hsd, uint32_t pSDstatus)
	Send Status info command.

static uint32_t	SD_SendStatus (SD_HandleTypeDef hsd, uint32_t pCardStatus)
	Returns the current card's status.

static uint32_t	SD_WideBus_Enable (SD_HandleTypeDef *hsd)
	Enables the SDIO wide bus mode.

static uint32_t	SD_WideBus_Disable (SD_HandleTypeDef *hsd)
	Disables the SDIO wide bus mode.

static uint32_t	SD_FindSCR (SD_HandleTypeDef hsd, uint32_t pSCR)
	Finds the SD card SCR register value.

static void	SD_PowerOFF (SD_HandleTypeDef *hsd)
	Turns the SDIO output signals off.

static void	SD_Write_IT (SD_HandleTypeDef *hsd)
	Wrap up writing in non-blocking mode.

static void	SD_Read_IT (SD_HandleTypeDef *hsd)
	Wrap up reading in non-blocking mode.

static void	SD_DMATransmitCplt (DMA_HandleTypeDef *hdma)
	DMA SD transmit process complete callback.

static void	SD_DMAReceiveCplt (DMA_HandleTypeDef *hdma)
	DMA SD receive process complete callback.

static void	SD_DMAError (DMA_HandleTypeDef *hdma)
	DMA SD communication error callback.

static void	SD_DMATxAbort (DMA_HandleTypeDef *hdma)
	DMA SD Tx Abort callback.

static void	SD_DMARxAbort (DMA_HandleTypeDef *hdma)
	DMA SD Rx Abort callback.

HAL_StatusTypeDef	HAL_SD_Init (SD_HandleTypeDef *hsd)
	Initializes the SD according to the specified parameters in the SD_HandleTypeDef and create the associated handle.

HAL_StatusTypeDef	HAL_SD_InitCard (SD_HandleTypeDef *hsd)
	Initializes the SD Card.

HAL_StatusTypeDef	HAL_SD_DeInit (SD_HandleTypeDef *hsd)
	De-Initializes the SD card.

void	HAL_SD_MspInit (SD_HandleTypeDef *hsd)
	Initializes the SD MSP.

void	HAL_SD_MspDeInit (SD_HandleTypeDef *hsd)
	De-Initialize SD MSP.

HAL_StatusTypeDef	HAL_SD_ReadBlocks (SD_HandleTypeDef hsd, uint8_t pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout)
	Reads block(s) from a specified address in a card. The Data transfer is managed by polling mode.

HAL_StatusTypeDef	HAL_SD_WriteBlocks (SD_HandleTypeDef hsd, uint8_t pData, uint32_t BlockAdd, uint32_t NumberOfBlocks, uint32_t Timeout)
	Allows to write block(s) to a specified address in a card. The Data transfer is managed by polling mode.

HAL_StatusTypeDef	HAL_SD_ReadBlocks_IT (SD_HandleTypeDef hsd, uint8_t pData, uint32_t BlockAdd, uint32_t NumberOfBlocks)
	Reads block(s) from a specified address in a card. The Data transfer is managed in interrupt mode.

HAL_StatusTypeDef	HAL_SD_WriteBlocks_IT (SD_HandleTypeDef hsd, uint8_t pData, uint32_t BlockAdd, uint32_t NumberOfBlocks)
	Writes block(s) to a specified address in a card. The Data transfer is managed in interrupt mode.

HAL_StatusTypeDef	HAL_SD_ReadBlocks_DMA (SD_HandleTypeDef hsd, uint8_t pData, uint32_t BlockAdd, uint32_t NumberOfBlocks)
	Reads block(s) from a specified address in a card. The Data transfer is managed by DMA mode.

HAL_StatusTypeDef	HAL_SD_WriteBlocks_DMA (SD_HandleTypeDef hsd, uint8_t pData, uint32_t BlockAdd, uint32_t NumberOfBlocks)
	Writes block(s) to a specified address in a card. The Data transfer is managed by DMA mode.

HAL_StatusTypeDef	HAL_SD_Erase (SD_HandleTypeDef *hsd, uint32_t BlockStartAdd, uint32_t BlockEndAdd)
	Erases the specified memory area of the given SD card.

void	HAL_SD_IRQHandler (SD_HandleTypeDef *hsd)
	This function handles SD card interrupt request.

HAL_SD_StateTypeDef	HAL_SD_GetState (SD_HandleTypeDef *hsd)
	return the SD state

uint32_t	HAL_SD_GetError (SD_HandleTypeDef *hsd)
	Return the SD error code.

void	HAL_SD_TxCpltCallback (SD_HandleTypeDef *hsd)
	Tx Transfer completed callbacks.

void	HAL_SD_RxCpltCallback (SD_HandleTypeDef *hsd)
	Rx Transfer completed callbacks.

void	HAL_SD_ErrorCallback (SD_HandleTypeDef *hsd)
	SD error callbacks.

void	HAL_SD_AbortCallback (SD_HandleTypeDef *hsd)
	SD Abort callbacks.

HAL_StatusTypeDef	HAL_SD_GetCardCID (SD_HandleTypeDef hsd, HAL_SD_CardCIDTypeDef pCID)
	Returns information the information of the card which are stored on the CID register.

HAL_StatusTypeDef	HAL_SD_GetCardCSD (SD_HandleTypeDef hsd, HAL_SD_CardCSDTypeDef pCSD)
	Returns information the information of the card which are stored on the CSD register.

HAL_StatusTypeDef	HAL_SD_GetCardStatus (SD_HandleTypeDef hsd, HAL_SD_CardStatusTypeDef pStatus)
	Gets the SD status info.

HAL_StatusTypeDef	HAL_SD_GetCardInfo (SD_HandleTypeDef hsd, HAL_SD_CardInfoTypeDef pCardInfo)
	Gets the SD card info.

HAL_StatusTypeDef	HAL_SD_ConfigWideBusOperation (SD_HandleTypeDef *hsd, uint32_t WideMode)
	Enables wide bus operation for the requested card if supported by card.

HAL_SD_CardStateTypeDef	HAL_SD_GetCardState (SD_HandleTypeDef *hsd)
	Gets the current sd card data state.

HAL_StatusTypeDef	HAL_SD_Abort (SD_HandleTypeDef *hsd)
	Abort the current transfer and disable the SD.

HAL_StatusTypeDef	HAL_SD_Abort_IT (SD_HandleTypeDef *hsd)
	Abort the current transfer and disable the SD (IT mode).

Detailed Description

SD card HAL module driver. This file provides firmware functions to manage the following functionalities of the Secure Digital (SD) peripheral:

Author

MCD Application Team

Initialization and de-initialization functions
IO operation functions
Peripheral Control functions
Peripheral State functions

Attention

This software is licensed under terms that can be found in the LICENSE file in the root directory of this software component. If no LICENSE file comes with this software, it is provided AS-IS.

==============================================================================
                      ##### How to use this driver #####
==============================================================================
[..]
  This driver implements a high level communication layer for read and write from/to
  this memory. The needed STM32 hardware resources (SDIO and GPIO) are performed by
  the user in HAL_SD_MspInit() function (MSP layer).
  Basically, the MSP layer configuration should be the same as we provide in the
  examples.
  You can easily tailor this configuration according to hardware resources.

[..]
  This driver is a generic layered driver for SDIO memories which uses the HAL
  SDIO driver functions to interface with SD and uSD cards devices.
  It is used as follows:

  (#)Initialize the SDIO low level resources by implementing the HAL_SD_MspInit() API:
      (##) Enable the SDIO interface clock using __HAL_RCC_SDIO_CLK_ENABLE();
      (##) SDIO pins configuration for SD card
          (+++) Enable the clock for the SDIO GPIOs using the functions __HAL_RCC_GPIOx_CLK_ENABLE();
          (+++) Configure these SDIO pins as alternate function pull-up using HAL_GPIO_Init()
                and according to your pin assignment;
      (##) DMA configuration if you need to use DMA process (HAL_SD_ReadBlocks_DMA()
           and HAL_SD_WriteBlocks_DMA() APIs).
          (+++) Enable the DMAx interface clock using __HAL_RCC_DMAx_CLK_ENABLE();
          (+++) Configure the DMA using the function HAL_DMA_Init() with predeclared and filled.
      (##) NVIC configuration if you need to use interrupt process when using DMA transfer.
          (+++) Configure the SDIO and DMA interrupt priorities using functions
                HAL_NVIC_SetPriority(); DMA priority is superior to SDIO's priority
          (+++) Enable the NVIC DMA and SDIO IRQs using function HAL_NVIC_EnableIRQ()
          (+++) SDIO interrupts are managed using the macros __HAL_SD_ENABLE_IT()
                and __HAL_SD_DISABLE_IT() inside the communication process.
          (+++) SDIO interrupts pending bits are managed using the macros __HAL_SD_GET_IT()
                and __HAL_SD_CLEAR_IT()
      (##) NVIC configuration if you need to use interrupt process (HAL_SD_ReadBlocks_IT()
           and HAL_SD_WriteBlocks_IT() APIs).
          (+++) Configure the SDIO interrupt priorities using function HAL_NVIC_SetPriority();
          (+++) Enable the NVIC SDIO IRQs using function HAL_NVIC_EnableIRQ()
          (+++) SDIO interrupts are managed using the macros __HAL_SD_ENABLE_IT()
                and __HAL_SD_DISABLE_IT() inside the communication process.
          (+++) SDIO interrupts pending bits are managed using the macros __HAL_SD_GET_IT()
                and __HAL_SD_CLEAR_IT()
  (#) At this stage, you can perform SD read/write/erase operations after SD card initialization


*** SD Card Initialization and configuration ***
================================================
[..]
  To initialize the SD Card, use the HAL_SD_Init() function. It Initializes
  SDIO Peripheral(STM32 side) and the SD Card, and put it into StandBy State (Ready for data transfer).
  This function provide the following operations:

  (#) Apply the SD Card initialization process at 400KHz and check the SD Card
      type (Standard Capacity or High Capacity). You can change or adapt this
      frequency by adjusting the "ClockDiv" field.
      The SD Card frequency (SDIO_CK) is computed as follows:

         SDIO_CK = SDIOCLK / (ClockDiv + 2)

      In initialization mode and according to the SD Card standard,
      make sure that the SDIO_CK frequency doesn't exceed 400KHz.

      This phase of initialization is done through SDIO_Init() and
      SDIO_PowerState_ON() SDIO low level APIs.

  (#) Initialize the SD card. The API used is HAL_SD_InitCard().
      This phase allows the card initialization and identification
      and check the SD Card type (Standard Capacity or High Capacity)
      The initialization flow is compatible with SD standard.

      This API (HAL_SD_InitCard()) could be used also to reinitialize the card in case
      of plug-off plug-in.

  (#) Configure the SD Card Data transfer frequency. You can change or adapt this
      frequency by adjusting the "ClockDiv" field.
      In transfer mode and according to the SD Card standard, make sure that the
      SDIO_CK frequency doesn't exceed 25MHz and 50MHz in High-speed mode switch.
      To be able to use a frequency higher than 24MHz, you should use the SDIO
      peripheral in bypass mode. Refer to the corresponding reference manual
      for more details.

  (#) Select the corresponding SD Card according to the address read with the step 2.

  (#) Configure the SD Card in wide bus mode: 4-bits data.

*** SD Card Read operation ***
==============================
[..]
  (+) You can read from SD card in polling mode by using function HAL_SD_ReadBlocks().
      This function support only 512-bytes block length (the block size should be
      chosen as 512 bytes).
      You can choose either one block read operation or multiple block read operation
      by adjusting the "NumberOfBlocks" parameter.
      After this, you have to ensure that the transfer is done correctly. The check is done
      through HAL_SD_GetCardState() function for SD card state.

  (+) You can read from SD card in DMA mode by using function HAL_SD_ReadBlocks_DMA().
      This function support only 512-bytes block length (the block size should be
      chosen as 512 bytes).
      You can choose either one block read operation or multiple block read operation
      by adjusting the "NumberOfBlocks" parameter.
      After this, you have to ensure that the transfer is done correctly. The check is done
      through HAL_SD_GetCardState() function for SD card state.
      You could also check the DMA transfer process through the SD Rx interrupt event.

  (+) You can read from SD card in Interrupt mode by using function HAL_SD_ReadBlocks_IT().
      This function support only 512-bytes block length (the block size should be
      chosen as 512 bytes).
      You can choose either one block read operation or multiple block read operation
      by adjusting the "NumberOfBlocks" parameter.
      After this, you have to ensure that the transfer is done correctly. The check is done
      through HAL_SD_GetCardState() function for SD card state.
      You could also check the IT transfer process through the SD Rx interrupt event.

*** SD Card Write operation ***
===============================
[..]
  (+) You can write to SD card in polling mode by using function HAL_SD_WriteBlocks().
      This function support only 512-bytes block length (the block size should be
      chosen as 512 bytes).
      You can choose either one block read operation or multiple block read operation
      by adjusting the "NumberOfBlocks" parameter.
      After this, you have to ensure that the transfer is done correctly. The check is done
      through HAL_SD_GetCardState() function for SD card state.

  (+) You can write to SD card in DMA mode by using function HAL_SD_WriteBlocks_DMA().
      This function support only 512-bytes block length (the block size should be
      chosen as 512 bytes).
      You can choose either one block read operation or multiple block read operation
      by adjusting the "NumberOfBlocks" parameter.
      After this, you have to ensure that the transfer is done correctly. The check is done
      through HAL_SD_GetCardState() function for SD card state.
      You could also check the DMA transfer process through the SD Tx interrupt event.

  (+) You can write to SD card in Interrupt mode by using function HAL_SD_WriteBlocks_IT().
      This function support only 512-bytes block length (the block size should be
      chosen as 512 bytes).
      You can choose either one block read operation or multiple block read operation
      by adjusting the "NumberOfBlocks" parameter.
      After this, you have to ensure that the transfer is done correctly. The check is done
      through HAL_SD_GetCardState() function for SD card state.
      You could also check the IT transfer process through the SD Tx interrupt event.

*** SD card status ***
======================
[..]
  (+) The SD Status contains status bits that are related to the SD Memory
      Card proprietary features. To get SD card status use the HAL_SD_GetCardStatus().

*** SD card information ***
===========================
[..]
  (+) To get SD card information, you can use the function HAL_SD_GetCardInfo().
      It returns useful information about the SD card such as block size, card type,
      block number ...

*** SD card CSD register ***
============================
  (+) The HAL_SD_GetCardCSD() API allows to get the parameters of the CSD register.
      Some of the CSD parameters are useful for card initialization and identification.

*** SD card CID register ***
============================
  (+) The HAL_SD_GetCardCID() API allows to get the parameters of the CID register.
      Some of the CSD parameters are useful for card initialization and identification.

*** SD HAL driver macros list ***
==================================
[..]
  Below the list of most used macros in SD HAL driver.

  (+) __HAL_SD_ENABLE : Enable the SD device
  (+) __HAL_SD_DISABLE : Disable the SD device
  (+) __HAL_SD_DMA_ENABLE: Enable the SDIO DMA transfer
  (+) __HAL_SD_DMA_DISABLE: Disable the SDIO DMA transfer
  (+) __HAL_SD_ENABLE_IT: Enable the SD device interrupt
  (+) __HAL_SD_DISABLE_IT: Disable the SD device interrupt
  (+) __HAL_SD_GET_FLAG:Check whether the specified SD flag is set or not
  (+) __HAL_SD_CLEAR_FLAG: Clear the SD's pending flags

  (@) You can refer to the SD HAL driver header file for more useful macros

*** Callback registration ***
=============================================
[..]
  The compilation define USE_HAL_SD_REGISTER_CALLBACKS when set to 1
  allows the user to configure dynamically the driver callbacks.

  Use Functions HAL_SD_RegisterCallback() to register a user callback,
  it allows to register following callbacks:
    (+) TxCpltCallback : callback when a transmission transfer is completed.
    (+) RxCpltCallback : callback when a reception transfer is completed.
    (+) ErrorCallback : callback when error occurs.
    (+) AbortCpltCallback : callback when abort is completed.
    (+) MspInitCallback    : SD MspInit.
    (+) MspDeInitCallback  : SD MspDeInit.
  This function takes as parameters the HAL peripheral handle, the Callback ID
  and a pointer to the user callback function.

  Use function HAL_SD_UnRegisterCallback() to reset a callback to the default
  weak (surcharged) function. It allows to reset following callbacks:
    (+) TxCpltCallback : callback when a transmission transfer is completed.
    (+) RxCpltCallback : callback when a reception transfer is completed.
    (+) ErrorCallback : callback when error occurs.
    (+) AbortCpltCallback : callback when abort is completed.
    (+) MspInitCallback    : SD MspInit.
    (+) MspDeInitCallback  : SD MspDeInit.
  This function) takes as parameters the HAL peripheral handle and the Callback ID.

  By default, after the HAL_SD_Init and if the state is HAL_SD_STATE_RESET
  all callbacks are reset to the corresponding legacy weak (surcharged) functions.
  Exception done for MspInit and MspDeInit callbacks that are respectively
  reset to the legacy weak (surcharged) functions in the HAL_SD_Init
  and  HAL_SD_DeInit only when these callbacks are null (not registered beforehand).
  If not, MspInit or MspDeInit are not null, the HAL_SD_Init and HAL_SD_DeInit
  keep and use the user MspInit/MspDeInit callbacks (registered beforehand)

  Callbacks can be registered/unregistered in READY state only.
  Exception done for MspInit/MspDeInit callbacks that can be registered/unregistered
  in READY or RESET state, thus registered (user) MspInit/DeInit callbacks can be used
  during the Init/DeInit.
  In that case first register the MspInit/MspDeInit user callbacks
  using HAL_SD_RegisterCallback before calling HAL_SD_DeInit
  or HAL_SD_Init function.

  When The compilation define USE_HAL_SD_REGISTER_CALLBACKS is set to 0 or
  not defined, the callback registering feature is not available
  and weak (surcharged) callbacks are used.

Definition in file stm32f4xx_hal_sd.c.