HAL PKA Overview ¶
Introducing PKA ¶
- group PKA_Introduction
-
-
This introduction is under development.
-
Module and files ¶
The following diagram illustrates the PKA module and its associated files.
Component diagram ¶
The following diagram illustrates the software components involved in the PKA 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 Software Component Diagram
package "HAL" {
[HAL_PKA]
[HAL_SERVICE]
}
package "Low Layer" {
[LL_PKA]
[CMSIS]
[PKA Interrupt routine service]
}
package "HW" {
[STM32_HW]
}
[Appli] --> [HAL_PKA] : HAL PKA API
[Appli] <-- [HAL_PKA] : PKA callback
[HAL_PKA] --> [LL_PKA] : LL PKA API
[HAL_PKA] -r-> [HAL_SERVICE] : HAL_GetTick
[HAL_PKA] <-- [PKA Interrupt routine service]: HAL_IncTick()
[LL_PKA] --> [CMSIS]: PKA registers def
[STM32_HW] -u--> [PKA Interrupt routine service]: PKA_Irq
[STM32_HW] <-u-- [LL_PKA] : PKA registers R/W
@enduml](../../../../_images/plantuml-6f4f650ec04b0a872450c8fa791782c1aa69de99.png)
Configuration table ¶
The following table lists the configuration defines for the HAL PKA module, specifying their locations, default values, and descriptions:
- group PKA_Configuration_Table
-
¶
Configuration inside the PKA driver ¶
Config defines
Description
Default value
Note
PRODUCT
from IDE
NA
The selected device (ex stm32u5xx )
USE_ASSERT_DBG_PARAM
from IDE
None
Allows to use the assert check parameters.
USE_ASSERT_DBG_STATE
from IDE
None
Allows to use the assert check states.
USE_HAL_CHECK_PARAM
from hal_conf.h
0
Parameters run-time check.
USE_HAL_SECURE_CHECK_PARAM
from hal_conf.h
0
Parameters run-time check for sensitive APIs
USE_HAL_CHECK_PROCESS_STATE
from hal_conf.h
0
Allows to use the load and store exclusive.
USE_HAL_PKA_MODULE
from hal_conf.h
1
Allows to use HAL PKA module.
USE_HAL_PKA_CLK_ENABLE_MODEL
from hal_conf.h
HAL_CLK_ENABLE_NO
Allows to use the clock interface management for PKA.
USE_HAL_PKA_GET_LAST_ERRORS
from hal_conf.h
0
Allows to use error code mechanism.
USE_HAL_PKA_USER_DATA
from hal_conf.h
0
Allows to use user data.
USE_HAL_PKA_REGISTER_CALLBACKS
from hal_conf.h
0
Enable the register callbacks assert