HAL PWR Use Cases ¶

User application Wake-up pin ¶

$@startuml hide footbox participant "User Application" as part1 participant "PWR Driver" as part2 group Wake-up management group #lightgreen Wake-up pin management "part1"->"part2" : HAL_PWR_LP_SetConfigWakeupPin() note right: Set wake-up polarity \nSet wake-up pull. activate "part2" "part2"-->"part1": hal_status deactivate "part2" "part1"->"part2" : HAL_PWR_LP_GetConfigWakeupPin() note right: Get wake-up polarity \nGet wake-up pull. activate "part2" "part2"-->"part1": Wakeup pin configuration deactivate "part2" end group #lightblue Wake-up pin activation "part1"->"part2" : HAL_PWR_LP_EnableWakeupPin() note right: Enable wake-up pin. "part1"->"part2" : HAL_PWR_LP_IsEnabledWakeupPin() activate "part2" "part2"-->"part1" : Wake-up pins enabled deactivate "part2" "part1"->"part2" : HAL_PWR_LP_DisableWakeupPin() note right: Disable wake-up pin. "part1"->"part2" : HAL_PWR_LP_IsEnabledWakeupPin() activate "part2" "part2"-->"part1" : Wake-up pins disabled deactivate "part2" end end @enduml$

Called functions:

User application RTC domain write protection ¶

Called functions:

User application enter to sleep mode ¶

@startuml
hide footbox
participant "User Application" as part1
participant "PWR Driver" as part2

group #lightblue Enter Sleep mode
"part1"->"part2" : HAL_PWR_ClearCorePendingEvent()
note right: Clear Core pending event.
"part1"->"part2" : HAL_PWR_EnterSleepMode()
note right: WFE or WFI request.
end
@enduml

Called functions:

User application enter to stop mode ¶

$@startuml hide footbox participant "User Application" as part1 participant "PWR Driver" as part2 activate part1 group #lightblue Enter Stop modes "part1"->"part2" : HAL_PWR_ClearCorePendingEvent() note right: Clear Core pending event. "part1"->"part2" : HAL_PWR_EnterStopMode() note right: Enter in Stop x mode\nWFE or WFI request. deactivate part1 activate part2 ... end @enduml$

Called functions:

User application enter to standby mode ¶

@startuml
hide footbox
participant "User Application" as part1
participant "PWR Driver" as part2

activate part1
group #lightblue Enter Standby mode
"part1"->"part2" : HAL_PWR_LP_CleanWakeupSource(uint32_t wakeup_source)
note right: Clean wake-up source flags.
"part1"->"part2" : HAL_PWR_EnterStandbyMode()
deactivate part1
activate part2
...
end
@enduml

Called functions:

HAL_PWR_EnterStandbyMode()

User application core entering in deep sleep mode ¶

@startuml
hide footbox
participant "User Application" as part1
participant "PWR Driver" as part2

group #lightgreen Core sleep mode management
"part1"->"part2" : HAL_PWR_SetCoreSleepMode()
note right: Set core sleep mode.
"part1"->"part2" : HAL_PWR_GetCoreSleepMode()
"part2"-->"part1" : Core sleep mode state
note right: Get core sleep mode configuration.
end
@enduml

Called functions:

User application core sleep on exit ¶

Called functions:

User application core send event on pending ¶

Called functions:

User application programmable voltage detector ¶

Called functions: - HAL_PWR_EnableProgrammableVoltageDetector() - HAL_PWR_IsEnabledProgrammableVoltageDetector() - HAL_PWR_DisableProgrammableVoltageDetector() - HAL_PWR_GetProgrammableVoltageDetectorOutput()

User application memory retention ¶

Called functions:

User application memory page retention ¶

Called functions:

User application Power IO Retention ¶

Called functions:

User application privilege configuration ¶

$@startuml hide footbox participant "User Application" as part1 participant "PWR Driver" as part2 group Privilege attribute group #lightsalmon Set privilege attribute when the CPU is not in privileged mode "part1"->"part2" : HAL_PWR_SetPrivAttr(HAL_PWR_ITEM_..., HAL_PWR_PRIV) activate "part2" "part2"-->"part1": HAL_ERROR note right: Set PWR item privilege attribute is not allowed\nwhen CPU is not in privilege mode. deactivate "part2" end group #lightgreen Set privilege attribute to PRIV when the CPU is in privileged mode "part1"->"part2" : HAL_PWR_SetPrivAttr(HAL_PWR_ITEM_..., HAL_PWR_PRIV) note right: Set PWR item privilege attribute. activate "part2" "part2"-->"part1": HAL_OK deactivate "part2" "part1"->"part2" : HAL_PWR_GetPrivAttr(HAL_PWR_ITEM_...) note right: Get PWR item privilege attribute. activate "part2" "part2"-->"part1": HAL_PWR_PRIV deactivate "part2" end group #lightblue Set privilege attribute to NPRIV when the CPU is in privileged mode "part1"->"part2" : HAL_PWR_SetPrivAttr(HAL_PWR_ITEM_..., HAL_PWR_NPRIV) note right: Set PWR item privilege attribute. activate "part2" "part2"-->"part1": HAL_OK deactivate "part2" "part1"->"part2" : HAL_PWR_GetPrivAttr(HAL_PWR_ITEM_...) note right: Get PWR item privilege attribute. activate "part2" "part2"-->"part1": HAL_PWR_NPRIV deactivate "part2" end end @enduml$

Called functions: - HAL_PWR_SetPrivAttr() - HAL_PWR_GetPrivAttr()