HAL MMC Overview

Introducing MMC

group MMC_Introduction

  • This introduction is under development.

Module and files

The following diagram illustrates the MMC module and its associated files.

Module and files diagram

Component diagram

The following diagram illustrates the software components involved in the MMC module. It shows the interactions between the user application, HAL drivers, low-level drivers, and the hardware components.

@startuml

<style>

componentDiagram {

   arrow {

      FontSize 8

   }

}

</style>



title MMC Software Component Diagram



package "HAL" {

    [HAL_MMC]

    [HAL_Q]

}



package "Low Layer" {

    [SDMMC_CORE]

    [DLYB_CORE]

    [CMSIS]

    [SDMMC Interrupt routine service]

}



package "HW" {

    [STM32_HW]

}



[Appli] --> [HAL_MMC] : HAL MMC API

[Appli] <-- [HAL_MMC] : Status MMC API 



[Appli] <-- [HAL_Q] : Status Q APIs

[Appli] --> [HAL_Q] : SD Transfer Linked-List management



[HAL_MMC] <-- [SDMMC_CORE]

[HAL_MMC] <-- [DLYB_CORE]





[SDMMC_CORE] --> [CMSIS]:SDMMC register def

[DLYB_CORE] --> [CMSIS]:DLYB register def

[STM32_HW] <-u-- [SDMMC_CORE] : SDMMC registers R/W

[HAL_MMC] <-- [SDMMC Interrupt routine service]

[STM32_HW] -u--> [SDMMC Interrupt routine service]: SDMMC Irq



@enduml

Configuration table

The following table lists the configuration defines for the HAL MMC module, specifying their locations, default values, and descriptions:

group MMC_Configuration_Table

Configuration inside the MMC driver

Config defines

Description

Default value

Note

USE_ASSERT_DBG_PARAM

from the IDE

NONE

Allows to use the assert checks parameters.

USE_ASSERT_DBG_STATE

from the IDE

NONE

Allows to use the assert checks states.

USE_HAL_CHECK_PARAM

from hal_conf.h

0

Allows to use the runtime checks parameters.

USE_HAL_MMC_AUTO_DETECTION_FREQUENCY

from hal_conf.h

0

Allows to Enable/Disable MMC Custom Frequency.

USE_HAL_MMC_REGISTER_CALLBACKS

from hal_conf.h

0

Allows to provide specific callback functions.

USE_HAL_MMC_LINKEDLIST

from hal_conf.h

1

Allows to use the MMC in linked-list mode.

USE_HAL_MMC_GET_CID

from hal_conf.h

1

Allows to get MMC Card identification.

USE_HAL_MMC_GET_SPEC_VERSION

from hal_conf.h

1

Allows to get the MMC Card version.

USE_HAL_MMC_GET_LAST_ERRORS

from hal_conf.h

1

Allows to get last errors codes.

USE_HAL_MMC_USER_DATA

from hal_conf.h

0

Allows to enable/disable user data.

USE_HAL_MMC_CLK_ENABLE_MODEL

from hal_conf.h

HAL_CLK_ENABLE_NO

Allows to enable the clock model for the MMC.

USE_HAL_MMC_RPMB_FEATURE

from hal_conf.h

0

Allows to enable the RPMB feature for the MMC.