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 #4ef84e Wake-up pin management "part1"->"part2" : HAL_PWR_LP_SetConfigWakeupPin() activate "part2" "part2"-->"part1": hal_status note right:- Set wake-up polarity \n- Set wake-up source "part1"->"part2" : HAL_PWR_LP_GetConfigWakeupPin() note right:- Get wake-up polarity \n- Get wake-up source end deactivate "part2" group #lightblue Wake-up pin activation "part1"->"part2" : HAL_PWR_LP_EnableWakeupPin() activate "part2" "part1"->"part2" : HAL_PWR_LP_IsEnabledWakeupPin() note right: Enable wake-up pin "part2"-->"part1" : Wake-up pins is enabled deactivate "part2" "part1"->"part2" : HAL_PWR_LP_DisableWakeupPin() activate "part2" "part1"->"part2" : HAL_PWR_LP_IsEnabledWakeupPin() note right: Disable wake-up pin "part2"-->"part1" : Wake-up pins is 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 Vdd USB independent supply ¶

Called functions:

HAL_PWR_EnableVddUSBIndependentSupply()
HAL_PWR_IsEnabledVddUSBIndependentSupply()
HAL_PWR_DisableVddUSBIndependentSupply()
HAL_PWR_EnableIndependentVddIO2Supply()
HAL_PWR_IsEnabledVddIO2IndependentSupply()
HAL_PWR_DisableIndependentVddIO2Supply()
HAL_PWR_EnableVddAIndependentSupply()
HAL_PWR_IsEnabledVddAIndependentSupply()
HAL_PWR_DisableVddAIndependentSupply()

User application Vdd USB HS transceiver 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 group #lightblue Enter Stop modes "part1"->"part2" : HAL_PWR_ClearCorePendingEvent() note right: Clear Core pending event "part1"->"part2" : HAL_PWR_EnterStopMode() note right:- Set Stop x mode\n- WFE or WFI request end @enduml$

Called functions:

User application enter to standby mode ¶

Called functions:

User application core entering in deep sleep mode ¶

@startuml

hide footbox

participant "User Application" as part1

participant "PWR Driver" as part2

group #4ef84e 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 SmartRun domain mode ¶

$@startuml hide footbox participant "User Application" as part1 participant "PWR Driver" as part2 group #4ef84e SmartRun domain management "part1"->"part2" : HAL_PWR_LP_SetSmartRunDomainMode() note right:- Set Smart Run domain "part1"->"part2" : HAL_PWR_LP_GetSmartRunDomainMode() "part2"-->"part1" : Smart Run domain mode note right:- Get Smart Run domain mode end @enduml ## User application brownout domain mode @startuml hide footbox participant "User Application" as part1 participant "PWR Driver" as part2 group #4ef84e Brownout reset mode management "part1"->"part2" : HAL_PWR_LP_SetBrownoutResetMode() note right:- Set Brownout reset mode "part1"->"part2" : HAL_PWR_LP_GetBrownoutResetMode() "part2"-->"part1" : Brownout reset state note right:- Get Brownout reset mode configuration end @enduml ## User application stop 3 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 "HWR" as part5 == Initialization == group #LightGreen Initialization part1 -> part2 : HAL_Init() part1 -> part2 : Configure system clock(s) end == Low power wakeup management == group #LightGrey Low power wakeup management group #LightSkyBlue Wake-up pin(s) configuration(s) part1 -> part3 : HAL_PWR_LP_SetConfigWakeupPin() activate part3 note right: - Set wake-up polarity\n - Set wake-up source part3 --> part1 : hal_status deactivate part3 part1 -> part3 : HAL_PWR_LP_EnableWakeupPin() note right: Enable wake-up pin(s) end group #LightSkyBlue Enter Stop 3 Mode part1 -> part3 : HAL_PWR_EnterStopMode() note right: Enter Stop 3 Mode end group #LightSkyBlue Wakeup interrupt part5 -> part4 : Interrupt activate part4 part4 -> part3 : HAL_PWR_Stop3Wakeup_IRQHandler() deactivate part4 activate part3 note right: - Clear wakeup flag\n- Call user callback part3 -> part1 : HAL_PWR_Stop3WakeupCallback() deactivate part3 end end @enduml$

Called functions:

HAL_PWR_LP_SetSmartRunDomainState()
HAL_PWR_LP_GetSmartRunDomainState()

User application programmable voltage detector ¶

Called functions:

User application peripheral voltage monitoring ¶

@startuml

hide footbox

participant "User Application" as part1

participant "PWR Driver" as part2

group #lightblue PVM activation

"part1"->"part2" : HAL_PWR_EnableVoltageMonitor()

activate part2

note right :Enable PVM

"part1"->"part2" : HAL_PWR_DisableVoltageMonitor()

deactivate part2

note right :Disable PVM

end

@enduml

Called functions:

HAL_PWR_EnableVoltageMonitor()
HAL_PWR_DisableVoltageMonitor()

User application memory retention ¶

@startuml

hide footbox

participant "User Application" as part1

participant "PWR Driver" as part2

group #lightblue Memory retention activation

"part1"->"part2" : HAL_PWR_LP_EnableMemoryRetention()

activate part2

note right :Enable memory retention

"part1"->"part2" : HAL_PWR_LP_DisableMemoryRetention()

deactivate part2

note right :Disable memory retention

end

@enduml

Called functions:

User application memory page retention ¶

Called functions:

User application UCPD standby mode ¶

@startuml

hide footbox

participant "User Application" as part1

participant "PWR Driver" as part2

group #lightblue UCPD standby mode activation

"part1"->"part2" : HAL_PWR_LP_EnableUCPDRetention()

activate part2

note right :Enable UCPD Standby mode

"part1"->"part2" : HAL_PWR_LP_DisableUCPDRetention()

deactivate part2

note right :Disable UCPD Standby mode

end

@enduml

Called functions:

User application OTG HS PHY power in stop 2/3 and standby mode ¶

Called functions:

User application fast wake-up management ¶

@startuml

hide footbox

participant "User Application" as part1

participant "PWR Driver" as part2

group #lightblue Memory fast wake-up mode activation

"part1"->"part2" : HAL_PWR_LP_EnableMemoryFastWakeup()

activate part2

note right :Enable Memory fast wake-up

"part1"->"part2" : HAL_PWR_LP_DisableMemoryFastWakeup()

deactivate part2

note right :Disable memory fast wake-up

end

@enduml

Called functions:

User application dead battery ¶

@startuml

hide footbox

participant "User Application" as part1

participant "PWR Driver" as part2

group #lightblue Dead battery activation

"part1"->"part2" : HAL_PWR_LP_EnableUCPDDeadBattery()

activate part2

note right :Enable dead battery behavior

"part1"->"part2" : HAL_PWR_LP_DisableUCPDDeadBattery()

deactivate part2

note right :Disable dead battery behavior

end

@enduml

Called functions:

User application Backup domain control ¶

Called functions:

User application Power GPIO pull ¶

Called functions:

HAL_PWR_LP_SetConfigGPIOPull()
HAL_PWR_LP_GetConfigGPIOPull()
HAL_PWR_LP_EnableGPIOPull()
HAL_PWR_LP_IsEnabledGPIOPull()
HAL_PWR_LP_DisableGPIOPull()