STM32F4xx_HAL_Driver  1.8.3
stm32f4xx_ll_sdmmc.c File Reference

SDMMC Low Layer HAL module driver. More...

Go to the source code of this file.

Functions

HAL_StatusTypeDef SDIO_Init (SDIO_TypeDef *SDIOx, SDIO_InitTypeDef Init)
 Initializes the SDMMC according to the specified parameters in the SDMMC_InitTypeDef and create the associated handle. More...
 
uint32_t SDIO_ReadFIFO (SDIO_TypeDef *SDIOx)
 Read data (word) from Rx FIFO in blocking mode (polling) More...
 
HAL_StatusTypeDef SDIO_WriteFIFO (SDIO_TypeDef *SDIOx, uint32_t *pWriteData)
 Write data (word) to Tx FIFO in blocking mode (polling) More...
 
HAL_StatusTypeDef SDIO_PowerState_ON (SDIO_TypeDef *SDIOx)
 Set SDMMC Power state to ON. More...
 
HAL_StatusTypeDef SDIO_PowerState_OFF (SDIO_TypeDef *SDIOx)
 Set SDMMC Power state to OFF. More...
 
uint32_t SDIO_GetPowerState (SDIO_TypeDef *SDIOx)
 Get SDMMC Power state. More...
 
HAL_StatusTypeDef SDIO_SendCommand (SDIO_TypeDef *SDIOx, SDIO_CmdInitTypeDef *Command)
 Configure the SDMMC command path according to the specified parameters in SDIO_CmdInitTypeDef structure and send the command. More...
 
uint8_t SDIO_GetCommandResponse (SDIO_TypeDef *SDIOx)
 Return the command index of last command for which response received. More...
 
uint32_t SDIO_GetResponse (SDIO_TypeDef *SDIOx, uint32_t Response)
 Return the response received from the card for the last command. More...
 
HAL_StatusTypeDef SDIO_ConfigData (SDIO_TypeDef *SDIOx, SDIO_DataInitTypeDef *Data)
 Configure the SDMMC data path according to the specified parameters in the SDIO_DataInitTypeDef. More...
 
uint32_t SDIO_GetDataCounter (SDIO_TypeDef *SDIOx)
 Returns number of remaining data bytes to be transferred. More...
 
uint32_t SDIO_GetFIFOCount (SDIO_TypeDef *SDIOx)
 Get the FIFO data. More...
 
HAL_StatusTypeDef SDIO_SetSDMMCReadWaitMode (SDIO_TypeDef *SDIOx, uint32_t SDIO_ReadWaitMode)
 Sets one of the two options of inserting read wait interval. More...
 
uint32_t SDMMC_CmdBlockLength (SDIO_TypeDef *SDIOx, uint32_t BlockSize)
 Send the Data Block Length command and check the response. More...
 
uint32_t SDMMC_CmdReadSingleBlock (SDIO_TypeDef *SDIOx, uint32_t ReadAdd)
 Send the Read Single Block command and check the response. More...
 
uint32_t SDMMC_CmdReadMultiBlock (SDIO_TypeDef *SDIOx, uint32_t ReadAdd)
 Send the Read Multi Block command and check the response. More...
 
uint32_t SDMMC_CmdWriteSingleBlock (SDIO_TypeDef *SDIOx, uint32_t WriteAdd)
 Send the Write Single Block command and check the response. More...
 
uint32_t SDMMC_CmdWriteMultiBlock (SDIO_TypeDef *SDIOx, uint32_t WriteAdd)
 Send the Write Multi Block command and check the response. More...
 
uint32_t SDMMC_CmdSDEraseStartAdd (SDIO_TypeDef *SDIOx, uint32_t StartAdd)
 Send the Start Address Erase command for SD and check the response. More...
 
uint32_t SDMMC_CmdSDEraseEndAdd (SDIO_TypeDef *SDIOx, uint32_t EndAdd)
 Send the End Address Erase command for SD and check the response. More...
 
uint32_t SDMMC_CmdEraseStartAdd (SDIO_TypeDef *SDIOx, uint32_t StartAdd)
 Send the Start Address Erase command and check the response. More...
 
uint32_t SDMMC_CmdEraseEndAdd (SDIO_TypeDef *SDIOx, uint32_t EndAdd)
 Send the End Address Erase command and check the response. More...
 
uint32_t SDMMC_CmdErase (SDIO_TypeDef *SDIOx)
 Send the Erase command and check the response. More...
 
uint32_t SDMMC_CmdStopTransfer (SDIO_TypeDef *SDIOx)
 Send the Stop Transfer command and check the response. More...
 
uint32_t SDMMC_CmdSelDesel (SDIO_TypeDef *SDIOx, uint64_t Addr)
 Send the Select Deselect command and check the response. More...
 
uint32_t SDMMC_CmdGoIdleState (SDIO_TypeDef *SDIOx)
 Send the Go Idle State command and check the response. More...
 
uint32_t SDMMC_CmdOperCond (SDIO_TypeDef *SDIOx)
 Send the Operating Condition command and check the response. More...
 
uint32_t SDMMC_CmdAppCommand (SDIO_TypeDef *SDIOx, uint32_t Argument)
 Send the Application command to verify that that the next command is an application specific com-mand rather than a standard command and check the response. More...
 
uint32_t SDMMC_CmdAppOperCommand (SDIO_TypeDef *SDIOx, uint32_t Argument)
 Send the command asking the accessed card to send its operating condition register (OCR) More...
 
uint32_t SDMMC_CmdBusWidth (SDIO_TypeDef *SDIOx, uint32_t BusWidth)
 Send the Bus Width command and check the response. More...
 
uint32_t SDMMC_CmdSendSCR (SDIO_TypeDef *SDIOx)
 Send the Send SCR command and check the response. More...
 
uint32_t SDMMC_CmdSendCID (SDIO_TypeDef *SDIOx)
 Send the Send CID command and check the response. More...
 
uint32_t SDMMC_CmdSendCSD (SDIO_TypeDef *SDIOx, uint32_t Argument)
 Send the Send CSD command and check the response. More...
 
uint32_t SDMMC_CmdSetRelAdd (SDIO_TypeDef *SDIOx, uint16_t *pRCA)
 Send the Send CSD command and check the response. More...
 
uint32_t SDMMC_CmdSetRelAddMmc (SDIO_TypeDef *SDIOx, uint16_t RCA)
 Send the Set Relative Address command to MMC card (not SD card). More...
 
uint32_t SDMMC_CmdSendStatus (SDIO_TypeDef *SDIOx, uint32_t Argument)
 Send the Status command and check the response. More...
 
uint32_t SDMMC_CmdStatusRegister (SDIO_TypeDef *SDIOx)
 Send the Status register command and check the response. More...
 
uint32_t SDMMC_CmdOpCondition (SDIO_TypeDef *SDIOx, uint32_t Argument)
 Sends host capacity support information and activates the card's initialization process. Send SDMMC_CMD_SEND_OP_COND command. More...
 
uint32_t SDMMC_CmdSwitch (SDIO_TypeDef *SDIOx, uint32_t Argument)
 Checks switchable function and switch card function. SDMMC_CMD_HS_SWITCH command. More...
 
uint32_t SDMMC_CmdSendEXTCSD (SDIO_TypeDef *SDIOx, uint32_t Argument)
 Send the Send EXT_CSD command and check the response. More...
 
uint32_t SDMMC_GetCmdResp1 (SDIO_TypeDef *SDIOx, uint8_t SD_CMD, uint32_t Timeout)
 Checks for error conditions for R1 response. More...
 
uint32_t SDMMC_GetCmdResp2 (SDIO_TypeDef *SDIOx)
 Checks for error conditions for R2 (CID or CSD) response. More...
 
uint32_t SDMMC_GetCmdResp3 (SDIO_TypeDef *SDIOx)
 Checks for error conditions for R3 (OCR) response. More...
 
uint32_t SDMMC_GetCmdResp6 (SDIO_TypeDef *SDIOx, uint8_t SD_CMD, uint16_t *pRCA)
 Checks for error conditions for R6 (RCA) response. More...
 
uint32_t SDMMC_GetCmdResp7 (SDIO_TypeDef *SDIOx)
 Checks for error conditions for R7 response. More...
 

Detailed Description

SDMMC Low Layer HAL module driver.

Author
MCD Application Team
     This file provides firmware functions to manage the following 
     functionalities of the SDMMC peripheral:
      + Initialization/de-initialization functions
      + I/O operation functions
      + Peripheral Control functions 
      + Peripheral State functions
Attention

Copyright (c) 2016 STMicroelectronics. All rights reserved.

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.

==============================================================================
                     ##### SDMMC peripheral features #####
==============================================================================        
  [..] The SD/SDMMC MMC card host interface (SDMMC) provides an interface between the AHB
       peripheral bus and MultiMedia cards (MMCs), SD memory cards, SDMMC cards and CE-ATA
       devices.
  
  [..] The SDMMC features include the following:
       (+) Full compliance with MultiMedia Card System Specification Version 4.2. Card support
           for three different databus modes: 1-bit (default), 4-bit and 8-bit
       (+) Full compatibility with previous versions of MultiMedia Cards (forward compatibility)
       (+) Full compliance with SD Memory Card Specifications Version 2.0
       (+) Full compliance with SD I/O Card Specification Version 2.0: card support for two
           different data bus modes: 1-bit (default) and 4-bit
       (+) Full support of the CE-ATA features (full compliance with CE-ATA digital protocol
           Rev1.1)
       (+) Data transfer up to 48 MHz for the 8 bit mode
       (+) Data and command output enable signals to control external bidirectional drivers
 
                         ##### How to use this driver #####
==============================================================================
  [..]
    This driver is a considered as a driver of service for external devices drivers 
    that interfaces with the SDMMC peripheral.
    According to the device used (SD card/ MMC card / SDMMC card ...), a set of APIs 
    is used in the device's driver to perform SDMMC operations and functionalities.
 
    This driver is almost transparent for the final user, it is only used to implement other
    functionalities of the external device.
 
  [..]
    (+) The SDMMC clock (SDMMCCLK = 48 MHz) is coming from a specific output (MSI, PLLUSB1CLK,
        PLLUSB2CLK). Before start working with SDMMC peripheral make sure that the
        PLL is well configured.
        The SDMMC peripheral uses two clock signals:
        (++) SDMMC adapter clock (SDMMCCLK = 48 MHz)
        (++) APB2 bus clock (PCLK2)
     
        -@@- PCLK2 and SDMMC_CK clock frequencies must respect the following condition:
             Frequency(PCLK2) >= (3 / 8 x Frequency(SDMMC_CK))

    (+) Enable/Disable peripheral clock using RCC peripheral macros related to SDMMC
        peripheral.

    (+) Enable the Power ON State using the SDIO_PowerState_ON() 
        function and disable it using the function SDIO_PowerState_OFF().
              
    (+) Enable/Disable the clock using the __SDIO_ENABLE()/__SDIO_DISABLE() macros.

    (+) Enable/Disable the peripheral interrupts using the macros __SDIO_ENABLE_IT() 
        and __SDIO_DISABLE_IT() if you need to use interrupt mode. 

    (+) When using the DMA mode 
        (++) Configure the DMA in the MSP layer of the external device
        (++) Active the needed channel Request 
        (++) Enable the DMA using __SDIO_DMA_ENABLE() macro or Disable it using the macro
             __SDIO_DMA_DISABLE().

    (+) To control the CPSM (Command Path State Machine) and send 
        commands to the card use the SDIO_SendCommand(), 
        SDIO_GetCommandResponse() and SDIO_GetResponse() functions. First, user has
        to fill the command structure (pointer to SDIO_CmdInitTypeDef) according 
        to the selected command to be sent.
        The parameters that should be filled are:
         (++) Command Argument
         (++) Command Index
         (++) Command Response type
         (++) Command Wait
         (++) CPSM Status (Enable or Disable).

        -@@- To check if the command is well received, read the SDIO_CMDRESP
            register using the SDIO_GetCommandResponse().
            The SDMMC responses registers (SDIO_RESP1 to SDIO_RESP2), use the
            SDIO_GetResponse() function.

    (+) To control the DPSM (Data Path State Machine) and send/receive 
         data to/from the card use the SDIO_DataConfig(), SDIO_GetDataCounter(), 
        SDIO_ReadFIFO(), SDIO_WriteFIFO() and SDIO_GetFIFOCount() functions.

  *** Read Operations ***
  =======================
  [..]
    (#) First, user has to fill the data structure (pointer to
        SDIO_DataInitTypeDef) according to the selected data type to be received.
        The parameters that should be filled are:
         (++) Data TimeOut
         (++) Data Length
         (++) Data Block size
         (++) Data Transfer direction: should be from card (To SDMMC)
         (++) Data Transfer mode
         (++) DPSM Status (Enable or Disable)
                                   
    (#) Configure the SDMMC resources to receive the data from the card
        according to selected transfer mode (Refer to Step 8, 9 and 10).

    (#) Send the selected Read command (refer to step 11).
                  
    (#) Use the SDIO flags/interrupts to check the transfer status.

  *** Write Operations ***
  ========================
  [..]
   (#) First, user has to fill the data structure (pointer to
       SDIO_DataInitTypeDef) according to the selected data type to be received.
       The parameters that should be filled are:
        (++) Data TimeOut
        (++) Data Length
        (++) Data Block size
        (++) Data Transfer direction:  should be to card (To CARD)
        (++) Data Transfer mode
        (++) DPSM Status (Enable or Disable)

   (#) Configure the SDMMC resources to send the data to the card according to 
       selected transfer mode.
                   
   (#) Send the selected Write command.
                  
   (#) Use the SDIO flags/interrupts to check the transfer status.
     
  *** Command management operations ***
  =====================================
  [..]
   (#) The commands used for Read/Write/Erase operations are managed in 
       separate functions. 
       Each function allows to send the needed command with the related argument,
       then check the response.
       By the same approach, you could implement a command and check the response.

Definition in file stm32f4xx_ll_sdmmc.c.