STM32H7Pxx HAL Drivers
HAL SD Overview ¶
Introducing SD ¶
- group SD_Introduction
-
The SD Hardware Abstraction Layer provides a high-level interface to the STM32 SDMMC peripheral for communicating with Secure Digital (SD) and microSD memory cards.
This HAL driver is built on top of the SDMMC core layer and simplifies peripheral initialization, device identification, configuration, and transition to the transfer state.
It supports the main data operations required by storage applications, including single-block and multi-block read/write transfers, erase control, transfer abort management, and access to device status and configuration information.
The driver supports polling, interrupt, DMA, and, when enabled, linked-list or double-buffer DMA transfer modes, allowing the application to balance CPU load, throughput, and responsiveness.
It also provides services to manage device insertion and removal events, configure transfer timing and, when available, FIFO threshold parameters.
This abstraction layer improves portability across STM32 devices embedding the SDMMC peripheral and eases the integration of SD storage into embedded applications.
Module and files ¶
The following diagram illustrates the SD module and its associated files.
Component diagram ¶
The following diagram illustrates the software components involved in the SD module. It shows the interactions between the user application, HAL drivers, low-level drivers, and the hardware components.
![@startuml
!$use_sd_core = 1
!$use_sd_ll = 1
!$use_sd_hal = 1
!$use_api_itf = 1
!$use_hal_itf = 1
!$use_ll_itf = 1
!$use_core_itf = 1
!$use_sd_isr = 1
!$use_hal_service = 1
!$use_hal_rcc = 1
!$use_hal_dma = 0
!$use_ll_rcc = 0
!$sd = "SD"
!$sd_lc = "sd"
!$hal_api_itf = "HAL " + $sd + " API"
!$appli_itf = "User Callback"
!$sd_name = "HAL_"+$sd
!$sd_ISR = $sd+" ISR"
!$core_sd = $sd_lc+"_core"
!$core_dlyb = "dlyb"+"_core"
!$hal_dma_itf = "HAL_DMA_StartDirectXfer()\nHAL_DMA_Abort_IT"
!$hal_rcc_itf = "\n\t\t\t\tHAL_RCC_"+$sd+"_EnableClock()"
!$hal_sd_itf = "DMA CallBacks\nDMA Half transfer complete CallBack\nError CallBacks"
!$hal_generic_itf = "HAL_GetTick()"
!$core_sd_itf = "core " + $sd +" API"
!$core_dlyb_itf = "core " + "DLYB" +" API"
!$sd_xIRQ = $sd+"x_IRQ"
<style>
componentDiagram {
arrow {
FontSize 8
}
interface {
FontSize 8
}
}
</style>
title $sd Software Component Diagram
Package "Application Layer" #DarkMagenta {
component [Appli]
interface "$appli_itf" as APPLI_Interface
[Appli] -r- APPLI_Interface
}
package "HAL" #DarkOrange {
[$sd_name]
!if ($use_hal_dma == 1)
interface "$hal_sd_itf" as HAL_SD_Interface
[$sd_name] -d- HAL_SD_Interface
!endif
interface "$hal_api_itf" as HAL_SD_APPLI_Interface
[$sd_name] -u- HAL_SD_APPLI_Interface
!if ($use_hal_service == 1)
[HAL_SERVICE]
interface "$hal_generic_itf" as HAL_Service_Interface
[HAL_SERVICE] -r- HAL_Service_Interface
[$sd_name] -l-( HAL_Service_Interface
!endif
!if ($use_hal_dma == 1)
[HAL_DMA]
interface "$hal_dma_itf" as HAL_DMA_Interface
[HAL_DMA] -u- HAL_DMA_Interface
[HAL_DMA] -u-( HAL_SD_Interface
[$sd_name] --( HAL_DMA_Interface
!endif
!if ($use_hal_rcc == 1)
[HAL_RCC]
interface "$hal_rcc_itf" as HAL_RCC_Interface
[HAL_RCC] -l- HAL_RCC_Interface
[$sd_name] -r-( HAL_RCC_Interface
!endif
}
[Appli] -d-( HAL_SD_APPLI_Interface
[$sd_name] -u-( APPLI_Interface
package "Low Layer" #Technology {
!if ($use_sd_ll == 1)
[$core_sd]
interface "$core_sd_itf" as LL_sd_Interface
[$core_sd] -u- LL_SD_Interface
[$core_dlyb]
interface "$core_dlyb_itf" as LL_DLYB_Interface
[$core_dlyb] -u- LL_DLYB_Interface
!endif
!if ($use_sd_isr == 1)
interface "$sd_ISR" as SD_ISR
[$sd_ISR] -U- SD_ISR
[$sd_ISR]
!endif
[CMSIS-Devices]
!if ($use_ll_rcc == 1)
[LL_RCC]
interface "LL RCC API" as LL_RCC_API
[LL_RCC] -u- LL_RCC_API
[HAL_RCC] -d-(LL_RCC_API
!endif
!if ($use_hal_dma == 1)
[DMA ISR]
interface "DMA ISR" as DMA_ISR
[DMA ISR] -u- DMA_ISR
!endif
}
package "HW" #LightCyan {
[STM32_HW]
!if ($use_sd_isr == 1)
interface "$sd_xIRQ" as SDx_IRQ
[STM32_HW] -u- SDx_IRQ
!endif
!if ($use_hal_dma == 1)
interface "DMAx_IRQ_Ch" as DMA_IRQ_CH
[STM32_HW] -u- DMA_IRQ_CH
[DMA ISR] -d-( DMA_IRQ_CH
[HAL_DMA] --( DMA_ISR
!endif
}
!if ($use_sd_ll == 1)
[$sd_name] -d-( LL_SD_Interface
[$sd_name] -d-( LL_DLYB_Interface
[$core_sd] .r.> [CMSIS-Devices]: $sd register def
[$core_dlyb] .r.> [CMSIS-Devices]: DLYB register def
[STM32_HW] <.u. [$core_sd] : $sd registers R/W
[STM32_HW] <.u. [$core_dlyb] : $sd registers R/W
!else
[$sd_name] .d.> [CMSIS-Devices]: $sd register def
[STM32_HW] <.l. [$sd_name] : $sd registers R/W
!endif
!if ($use_sd_isr == 1)
[$sd_ISR] -d-( SDx_IRQ
[$sd_name] -d-( SD_ISR
!endif
!if ($use_ll_rcc == 1)
[STM32_HW] <.u. [LL_RCC] : RCC registers R/W
!endif
@enduml](../../../../_images/plantuml-f6705edf3fc9b5fb74e0679ca869c1a886154851.png)
Configuration table ¶
The following table lists the configuration defines for the HAL SD module, specifying their locations, default values, and descriptions:
- group SD_Configuration_Table
-
¶
Configuration inside the SD 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 run-time checks parameters.
USE_HAL_SD_AUTO_DETECTION_FREQUENCY
from hal_conf.h
0
Allows to Enable/Disable SD Custom Frequency.
USE_HAL_SD_REGISTER_CALLBACKS
from hal_conf.h
0
Allows to provide specific callback functions.
USE_HAL_SD_LINKEDLIST
from hal_conf.h
1
Allows to use the SD in linked-list mode.
USE_HAL_SD_GET_CID
from hal_conf.h
1
Allows to get card identification information.
USE_HAL_SD_GET_LAST_ERRORS
from hal_conf.h
1
Allows to get last errors codes.
USE_HAL_SD_USER_DATA
from hal_conf.h
0
Allows to Enable/Disable user data.
USE_HAL_SD_CLK_ENABLE_MODEL
from hal_conf.h
HAL_CLK_ENABLE_NO
Allows to enable the clock model for the SD.
USE_HAL_SD_GET_SPEC_VERSION
from hal_conf.h
1
Allows to get the SD Card version.