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 regulator voltage scaling range ¶

Called functions:

User application regulator supply ¶

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 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_SetProgrammableVoltageDetectorLevel() - HAL_PWR_GetProgrammableVoltageDetectorLevel() - HAL_PWR_EnableProgrammableVoltageDetector() - HAL_PWR_IsEnabledProgrammableVoltageDetector() - HAL_PWR_DisableProgrammableVoltageDetector() - HAL_PWR_GetProgrammableVoltageDetectorOutput()

User application analog voltage detector ¶

Called functions: - HAL_PWR_SetAnalogVoltageDetectorLevel() - HAL_PWR_GetAnalogVoltageDetectorLevel() - HAL_PWR_EnableAnalogVoltageDetector() - HAL_PWR_IsEnabledAnalogVoltageDetector() - HAL_PWR_DisableAnalogVoltageDetector() - HAL_PWR_GetAnalogVoltageDetectorOutput()

User application memory retention ¶

Called functions:

User application UCPD standby mode ¶

Called functions:

User application Battery charging control ¶

Called functions:

User application dead battery ¶

Called functions:

User application Power GPIO pull for peripheral ¶

$@startuml hide footbox participant "User Application" as part1 participant "PWR Driver" as part2 group PWR GPIO peripheral pull group #lightgreen Power GPIO management "part1"->"part2" : HAL_PWR_LP_SetConfigPeriphGPIOPull() note right:Set PWR GPIO pull for peripheral in standby\nand shutdown mode. "part1"->"part2" : HAL_PWR_LP_GetConfigPeriphGPIOPull() activate "part2" "part2"-->"part1": PWR GPIO peripheral pull configuration note right:Get PWR GPIO peripheral pull config. deactivate "part2" end group #lightblue PWR GPIO pull activation "part1"->"part2" : HAL_PWR_LP_EnableGPIOPull() note right: Enable PWR GPIO pull. "part1"->"part2" : HAL_PWR_LP_IsEnabledGPIOPull() activate "part2" "part2"-->"part1" : PWR GPIO pull enabled deactivate "part2" "part1"->"part2" : HAL_PWR_LP_DisableGPIOPull() note right: Disable PWR GPIO pull. "part1"->"part2" : HAL_PWR_LP_IsEnabledGPIOPull() activate "part2" "part2"-->"part1" : PWR GPIO pull disabled deactivate "part2" end end @enduml$

Called functions:

User application Stop wake-up on handler mode ¶

$@startuml hide footbox participant "User Application" as part1 participant "System" as part2 participant "PWR Driver" as part3 participant "NVIC" as part4 participant "HW" as part5 group #Yellow Initialization part1->part2 : HAL_Init() part1->part2 : Configure system clock(s) end group #lightgray Low power wakeup management group #SkyBlue Wakeup configurations part1->part3 : HAL_PWR_LP_SetConfigWakeupPin() activate "part3" "part3"-->"part1" : hal_status_t note right : - Set wakeup pin(s) polarity \n- Set wakeup pin(s) pull. deactivate "part3" part1->part3 : HAL_PWR_LP_EnableWakeupPin() note right : - Enable wakeup pin(s). end group #lightSalmon Enter low power Stop mode part1->part3 : HAL_PWR_EnterStopMode() note right : - Enter Stop mode. end group #SkyBlue Wakeup interrupt handler part4<-part5 : Interrupt activate part4 part4->part3 : HAL_PWR_WakeupPin_IRQHandler() deactivate part4 activate part3 note right : - Clear wakeup flag(s) \n- Call user callback. part3->part1 : HAL_PWR_WakeupPinCallback() deactivate part3 end end @enduml$

Called functions: - HAL_PWR_LP_SetConfigWakeupPin() - HAL_PWR_LP_EnableWakeupPin() - HAL_PWR_EnterStopMode() - HAL_PWR_WakeupPinCallback()