STM32F439xx HAL User Manual: stm32f4xx_hal

SD card HAL module driver. This file provides firmware functions to manage the following functionalities of the Secure Digital (SD) peripheral: + Initialization and de-initialization functions + IO operation functions + Peripheral Control functions + SD card Control functions. More...

#include "stm32f4xx_hal.h"

Go to the source code of this file.

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 HAL_StatusTypeDef	SD_PowerOFF (SD_HandleTypeDef *hsd)
	Turns the SDIO output signals off.
static HAL_StatusTypeDef	SD_Write_IT (SD_HandleTypeDef *hsd)
	Wrap up writing in non-blocking mode.
static HAL_StatusTypeDef	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.
__weak void	HAL_SD_MspInit (SD_HandleTypeDef *hsd)
	Initializes the SD MSP.
__weak 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.
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.
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.
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.
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.
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.
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.
__weak void	HAL_SD_TxCpltCallback (SD_HandleTypeDef *hsd)
	Tx Transfer completed callbacks.
__weak void	HAL_SD_RxCpltCallback (SD_HandleTypeDef *hsd)
	Rx Transfer completed callbacks.
__weak void	HAL_SD_ErrorCallback (SD_HandleTypeDef *hsd)
	SD error callbacks.
__weak 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

Author:

MCD Application Team

  ==============================================================================
                        ##### 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 implement 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 IP(STM32 side) and the SD Card, and put it into StandBy State (Ready for data transfer). 
    This function provide the following operations:

    (#) Initialize the SDIO peripheral interface with defaullt configuration.
        The initialization process is done at 400KHz. 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. By Default, the card transfer 
        frequency is set to 24MHz. 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 allows the read of 512 bytes blocks.
        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 allows the read of 512 bytes blocks.
        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 allows the read of 512 bytes blocks.
        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 allows the read of 512 bytes blocks.
        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 allows the read of 512 bytes blocks.
        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 allows the read of 512 bytes blocks.
        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

Attention:

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file stm32f4xx_hal_sd.c.

Functions

Detailed Description

© COPYRIGHT(c) 2017 STMicroelectronics