michaelh/zephyr
1
0
Fork 0
Code Releases Activity

pm: policy: Fix API documentation

Browse source 
pm_policy_next_state was not properly documented.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
This commit is contained in:
Flavio Ceolin 2021-06-14 10:18:55 -07:00 • committed by Anas Nashif
commit dc411a3a8b
1 changed files with 9 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

10
include/pm/policy.h
View file

@ -14,7 +14,15 @@ extern "C" {
#endif #endif
/** /**
* @brief Function to get the next PM state based on the ticks * @brief Function to get the next PM state
*
* This function is called by the power subsystem when the system is
* idle and returns the most appropriate state based on the number of
* ticks to the next event.
*
* @param ticks The number of ticks to the next scheduled event.
*
* @return The power state the system should use.
*/ */
struct pm_state_info pm_policy_next_state(int32_t ticks); struct pm_state_info pm_policy_next_state(int32_t ticks);