HAL Q Overview ¶
Introducing Q ¶
- group Q_Introduction
-
-
This introduction is under development.
-
Module and files ¶
The following diagram illustrates the Q module and its associated files.
Component diagram ¶
The following diagram illustrates the software components involved in the Q 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 Q Software Component Diagram
package "HAL" {
[HAL_Q]
[HAL_SD]
[HAL_MMC]
[HAL_DMA]
}
package "Low Layer" {
[CMSIS]
[LL_DMA]
[SDMMC_CORE]
[SDMMC Interrupt routine service]
[DMA Interrupt routine service]
}
package "HW" {
[STM32_HW]
}
[Appli] --> [HAL_Q] : HAL Q API
[Appli] <-- [HAL_Q] : Status Q API
[Appli] --> [HAL_DMA] : HAL DMA API
[Appli] <-- [HAL_DMA] : DMA callback
[Appli] --> [HAL_SD] : HAL SD API
[Appli] <-- [HAL_SD] : SD callback
[Appli] --> [HAL_MMC] : HAL MMC API
[Appli] <-- [HAL_MMC] : MMC callback
[HAL_SD] <-- [SDMMC_CORE]
[HAL_MMC] <-- [SDMMC_CORE]
[HAL_DMA] <-- [LL_DMA]
[HAL_SD] <-- [SDMMC Interrupt routine service]
[HAL_MMC] <-- [SDMMC Interrupt routine service]
[HAL_DMA] <-d- [DMA Interrupt routine service]
[STM32_HW] -u--> [SDMMC Interrupt routine service]: SDMMC Irq
[STM32_HW] -u--> [DMA Interrupt routine service] : DMA Channel Irq
[LL_DMA] --> [CMSIS]:DMA register def
[SDMMC_CORE] --> [CMSIS]:SDMMC register def
[STM32_HW] <-u-- [LL_DMA] : DMA registers R/W
[STM32_HW] <-u-- [SDMMC_CORE] : SDMMC registers R/W
@enduml](../../../../_images/plantuml-df61116f4c6968323adecb53135cf06a32f8d175.png)
Configuration table ¶
The following table lists the configuration defines for the HAL Q module, specifying their locations, default values, and descriptions:
- group Q_Configuration_Table
-
¶
Configuration inside the Q module ¶
Config defines
Description
Default value
Note
USE_ASSERT_DBG_PARAM
from IDE
None
When defined, enable the params assert.
USE_HAL_CHECK_PARAM
from hal_conf.h
0U
It allows to use the run-time checks on parameters.
USE_HAL_{PPP}_LINKEDLIST
from hal_conf.h
0U
It allows to use the PPP in linked-list mode.
USE_HAL_Q_CIRCULAR_LINK
from hal_ppp.h
0U
It allows to use circular link queue.