michaelh/zephyr
1
0
Fork 0
Code Releases Activity

power: constraints: Update constraint documentation

Browse source 
Align documentation with constraint API changes.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
This commit is contained in:
Flavio Ceolin 2021-01-25 20:47:22 -08:00 • committed by Anas Nashif
commit 7f56bd415f
1 changed files with 6 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

8
include/power/power.h
View file

@ -161,19 +161,21 @@ void pm_dump_debug_info(void);
#endif /* CONFIG_PM_DEBUG */
/**
* @brief Disable particular power state
* @brief Set a constraint for a power state
*
* @details Disabled state cannot be selected by the Zephyr power
* management policies. Application defined policy should
* use the @ref pm_constraint_get function to
* check if given state is enabled and could be used.
*
* @note This API is refcount
*
* @param [in] state Power state to be disabled.
*/
void pm_constraint_set(enum pm_state state);
/**
* @brief Enable particular power state
* @brief Release a constraint for a power state
*
* @details Enabled state can be selected by the Zephyr power
* management policies. Application defined policy should
@ -181,6 +183,8 @@ void pm_constraint_set(enum pm_state state);
* check if given state is enabled and could be used.
* By default all power states are enabled.
*
* @note This API is refcount
*
* @param [in] state Power state to be enabled.
*/
void pm_constraint_release(enum pm_state state);