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

#include "stm32f4xx_hal.h"

Include dependency graph for stm32f4xx_hal_mmc.c:

Macros
#define	MMC_VOLTAGE_RANGE EMMC_HIGH_VOLTAGE_RANGE

#define	MMC_EXT_CSD_PWR_CL_26_INDEX 203

#define	MMC_EXT_CSD_PWR_CL_52_INDEX 202

#define	MMC_EXT_CSD_PWR_CL_DDR_52_INDEX 239

#define	MMC_EXT_CSD_PWR_CL_26_POS 24

#define	MMC_EXT_CSD_PWR_CL_52_POS 16

#define	MMC_EXT_CSD_PWR_CL_DDR_52_POS 24

#define	MMC_INIT_FREQ 400000U /* Initialization phase : 400 kHz max */

Functions
static uint32_t	MMC_InitCard (MMC_HandleTypeDef *hmmc)
	Initializes the mmc card.

static uint32_t	MMC_PowerON (MMC_HandleTypeDef *hmmc)
	Enquires cards about their operating voltage and configures clock controls and stores MMC information that will be needed in future in the MMC handle.

static uint32_t	MMC_SendStatus (MMC_HandleTypeDef hmmc, uint32_t pCardStatus)
	Returns the current card's status.

static uint32_t	MMC_ReadExtCSD (MMC_HandleTypeDef hmmc, uint32_t pFieldData, uint16_t FieldIndex, uint32_t Timeout)
	Reads extended CSD register to get the sectors number of the device.

static void	MMC_PowerOFF (MMC_HandleTypeDef *hmmc)
	Turns the SDIO output signals off.

static void	MMC_Write_IT (MMC_HandleTypeDef *hmmc)
	Wrap up writing in non-blocking mode.

static void	MMC_Read_IT (MMC_HandleTypeDef *hmmc)
	Wrap up reading in non-blocking mode.

static void	MMC_DMATransmitCplt (DMA_HandleTypeDef *hdma)
	DMA MMC transmit process complete callback.

static void	MMC_DMAReceiveCplt (DMA_HandleTypeDef *hdma)
	DMA MMC receive process complete callback.

static void	MMC_DMAError (DMA_HandleTypeDef *hdma)
	DMA MMC communication error callback.

static void	MMC_DMATxAbort (DMA_HandleTypeDef *hdma)
	DMA MMC Tx Abort callback.

static void	MMC_DMARxAbort (DMA_HandleTypeDef *hdma)
	DMA MMC Rx Abort callback.

static uint32_t	MMC_PwrClassUpdate (MMC_HandleTypeDef *hmmc, uint32_t Wide)
	Update the power class of the device.

HAL_StatusTypeDef	HAL_MMC_Init (MMC_HandleTypeDef *hmmc)
	Initializes the MMC according to the specified parameters in the MMC_HandleTypeDef and create the associated handle.

HAL_StatusTypeDef	HAL_MMC_InitCard (MMC_HandleTypeDef *hmmc)
	Initializes the MMC Card.

HAL_StatusTypeDef	HAL_MMC_DeInit (MMC_HandleTypeDef *hmmc)
	De-Initializes the MMC card.

void	HAL_MMC_MspInit (MMC_HandleTypeDef *hmmc)
	Initializes the MMC MSP.

void	HAL_MMC_MspDeInit (MMC_HandleTypeDef *hmmc)
	De-Initialize MMC MSP.

HAL_StatusTypeDef	HAL_MMC_ReadBlocks (MMC_HandleTypeDef hmmc, 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_MMC_WriteBlocks (MMC_HandleTypeDef hmmc, 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_MMC_ReadBlocks_IT (MMC_HandleTypeDef hmmc, 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_MMC_WriteBlocks_IT (MMC_HandleTypeDef hmmc, 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_MMC_ReadBlocks_DMA (MMC_HandleTypeDef hmmc, 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_MMC_WriteBlocks_DMA (MMC_HandleTypeDef hmmc, 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_MMC_Erase (MMC_HandleTypeDef *hmmc, uint32_t BlockStartAdd, uint32_t BlockEndAdd)
	Erases the specified memory area of the given MMC card.

void	HAL_MMC_IRQHandler (MMC_HandleTypeDef *hmmc)
	This function handles MMC card interrupt request.

HAL_MMC_StateTypeDef	HAL_MMC_GetState (MMC_HandleTypeDef *hmmc)
	return the MMC state

uint32_t	HAL_MMC_GetError (MMC_HandleTypeDef *hmmc)
	Return the MMC error code.

void	HAL_MMC_TxCpltCallback (MMC_HandleTypeDef *hmmc)
	Tx Transfer completed callbacks.

void	HAL_MMC_RxCpltCallback (MMC_HandleTypeDef *hmmc)
	Rx Transfer completed callbacks.

void	HAL_MMC_ErrorCallback (MMC_HandleTypeDef *hmmc)
	MMC error callbacks.

void	HAL_MMC_AbortCallback (MMC_HandleTypeDef *hmmc)
	MMC Abort callbacks.

HAL_StatusTypeDef	HAL_MMC_GetCardCID (MMC_HandleTypeDef hmmc, HAL_MMC_CardCIDTypeDef pCID)
	Returns information the information of the card which are stored on the CID register.

HAL_StatusTypeDef	HAL_MMC_GetCardCSD (MMC_HandleTypeDef hmmc, HAL_MMC_CardCSDTypeDef pCSD)
	Returns information the information of the card which are stored on the CSD register.

HAL_StatusTypeDef	HAL_MMC_GetCardInfo (MMC_HandleTypeDef hmmc, HAL_MMC_CardInfoTypeDef pCardInfo)
	Gets the MMC card info.

HAL_StatusTypeDef	HAL_MMC_GetCardExtCSD (MMC_HandleTypeDef hmmc, uint32_t pExtCSD, uint32_t Timeout)
	Returns information the information of the card which are stored on the Extended CSD register.

HAL_StatusTypeDef	HAL_MMC_ConfigWideBusOperation (MMC_HandleTypeDef *hmmc, uint32_t WideMode)
	Enables wide bus operation for the requested card if supported by card.

HAL_MMC_CardStateTypeDef	HAL_MMC_GetCardState (MMC_HandleTypeDef *hmmc)
	Gets the current mmc card data state.

HAL_StatusTypeDef	HAL_MMC_Abort (MMC_HandleTypeDef *hmmc)
	Abort the current transfer and disable the MMC.

HAL_StatusTypeDef	HAL_MMC_Abort_IT (MMC_HandleTypeDef *hmmc)
	Abort the current transfer and disable the MMC (IT mode).

Detailed Description

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

Author

MCD Application Team

Initialization and de-initialization functions
IO operation functions
Peripheral Control functions
MMC card Control 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 (SDMMC and GPIO) are performed by
  the user in HAL_MMC_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 SDMMC memories which uses the HAL
  SDMMC driver functions to interface with MMC and eMMC cards devices.
  It is used as follows:

  (#)Initialize the SDMMC low level resources by implement the HAL_MMC_MspInit() API:
      (##) Enable the SDMMC interface clock using __HAL_RCC_SDMMC_CLK_ENABLE();
      (##) SDMMC pins configuration for MMC card
          (+++) Enable the clock for the SDMMC GPIOs using the functions __HAL_RCC_GPIOx_CLK_ENABLE();
          (+++) Configure these SDMMC 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_MMC_ReadBlocks_DMA()
           and HAL_MMC_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 SDMMC and DMA interrupt priorities using function HAL_NVIC_SetPriority();
                DMA priority is superior to SDMMC's priority
          (+++) Enable the NVIC DMA and SDMMC IRQs using function HAL_NVIC_EnableIRQ()
          (+++) SDMMC interrupts are managed using the macros __HAL_MMC_ENABLE_IT() 
                and __HAL_MMC_DISABLE_IT() inside the communication process.
          (+++) SDMMC interrupts pending bits are managed using the macros __HAL_MMC_GET_IT()
                and __HAL_MMC_CLEAR_IT()
      (##) NVIC configuration if you need to use interrupt process (HAL_MMC_ReadBlocks_IT()
           and HAL_MMC_WriteBlocks_IT() APIs).
          (+++) Configure the SDMMC interrupt priorities using function HAL_NVIC_SetPriority();
          (+++) Enable the NVIC SDMMC IRQs using function HAL_NVIC_EnableIRQ()
          (+++) SDMMC interrupts are managed using the macros __HAL_MMC_ENABLE_IT()
                and __HAL_MMC_DISABLE_IT() inside the communication process.
          (+++) SDMMC interrupts pending bits are managed using the macros __HAL_MMC_GET_IT()
                and __HAL_MMC_CLEAR_IT()
  (#) At this stage, you can perform MMC read/write/erase operations after MMC card initialization


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

  (#) Initialize the SDMMC peripheral interface with default configuration.
      The initialization process is done at 400KHz. You can change or adapt
      this frequency by adjusting the "ClockDiv" field.
      The MMC Card frequency (SDMMC_CK) is computed as follows:

         SDMMC_CK = SDMMCCLK / (ClockDiv + 2)

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

      This phase of initialization is done through SDMMC_Init() and
      SDMMC_PowerState_ON() SDMMC low level APIs.

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

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

  (#) Configure the MMC 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 MMC Card standard, make sure that the
      SDMMC_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 SDMMC
      peripheral in bypass mode. Refer to the corresponding reference manual
      for more details.

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

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

*** MMC Card Read operation ***
==============================
[..]
  (+) You can read from MMC card in polling mode by using function HAL_MMC_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_MMC_GetCardState() function for MMC card state.

  (+) You can read from MMC card in DMA mode by using function HAL_MMC_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_MMC_GetCardState() function for MMC card state.
      You could also check the DMA transfer process through the MMC Rx interrupt event.

  (+) You can read from MMC card in Interrupt mode by using function HAL_MMC_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_MMC_GetCardState() function for MMC card state.
      You could also check the IT transfer process through the MMC Rx interrupt event.

*** MMC Card Write operation ***
===============================
[..]
  (+) You can write to MMC card in polling mode by using function HAL_MMC_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_MMC_GetCardState() function for MMC card state.

  (+) You can write to MMC card in DMA mode by using function HAL_MMC_WriteBlocks_DMA().
      This function support only 512-bytes block length (the block size should be
      chosen as 512 byte).
      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_MMC_GetCardState() function for MMC card state.
      You could also check the DMA transfer process through the MMC Tx interrupt event.  

  (+) You can write to MMC card in Interrupt mode by using function HAL_MMC_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_MMC_GetCardState() function for MMC card state.
      You could also check the IT transfer process through the MMC Tx interrupt event.

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

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

*** MMC card CID register ***
============================
[..]
  (+) The HAL_MMC_GetCardCID() API allows to get the parameters of the CID register.
      Some of the CID parameters are useful for card initialization and identification.

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

  (+) __HAL_MMC_ENABLE : Enable the MMC device
  (+) __HAL_MMC_DISABLE : Disable the MMC device
  (+) __HAL_MMC_DMA_ENABLE: Enable the SDMMC DMA transfer
  (+) __HAL_MMC_DMA_DISABLE: Disable the SDMMC DMA transfer
  (+) __HAL_MMC_ENABLE_IT: Enable the MMC device interrupt
  (+) __HAL_MMC_DISABLE_IT: Disable the MMC device interrupt
  (+) __HAL_MMC_GET_FLAG:Check whether the specified MMC flag is set or not
  (+) __HAL_MMC_CLEAR_FLAG: Clear the MMC's pending flags

[..]
  (@) You can refer to the MMC HAL driver header file for more useful macros

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

  Use Functions HAL_MMC_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    : MMC MspInit.
    (+) MspDeInitCallback  : MMC MspDeInit.
  This function takes as parameters the HAL peripheral handle, the Callback ID
  and a pointer to the user callback function.

  Use function HAL_MMC_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    : MMC MspInit.
    (+) MspDeInitCallback  : MMC MspDeInit.
  This function) takes as parameters the HAL peripheral handle and the Callback ID.

  By default, after the HAL_MMC_Init and if the state is HAL_MMC_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_MMC_Init
  and  HAL_MMC_DeInit only when these callbacks are null (not registered beforehand).
  If not, MspInit or MspDeInit are not null, the HAL_MMC_Init and HAL_MMC_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_MMC_RegisterCallback before calling HAL_MMC_DeInit
  or HAL_MMC_Init function.

  When The compilation define USE_HAL_MMC_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_mmc.c.

Macros

Functions

Detailed Description