michaelh/zephyr
1
0
Fork 0
Code Releases Activity

pm: device_runtime: Document isr and pre-kernel functions

Browse source 
Add notes for APIs that are allowed to be called from ISRs and
pre-kernel.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
This commit is contained in:
Flavio Ceolin 2021-05-20 15:16:46 -07:00 • committed by Anas Nashif
commit b1564c35d2
1 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
include/pm/device_runtime.h
View file

@ -32,6 +32,8 @@ extern "C" {
* The device might be asynchronously suspended if runtime PM is enabled * The device might be asynchronously suspended if runtime PM is enabled
* when the device is not use. * when the device is not use.
* *
* @funcprops \pre_kernel_ok
*
* @param dev Pointer to device structure of the specific device driver * @param dev Pointer to device structure of the specific device driver
* the caller is interested in. * the caller is interested in.
*/ */
@ -43,6 +45,8 @@ void pm_device_enable(const struct device *dev);
* Called by a device driver to disable device runtime power management. * Called by a device driver to disable device runtime power management.
* The device might be asynchronously resumed if runtime PM is disabled * The device might be asynchronously resumed if runtime PM is disabled
* *
* @funcprops \pre_kernel_ok
*
* @param dev Pointer to device structure of the specific device driver * @param dev Pointer to device structure of the specific device driver
* the caller is interested in. * the caller is interested in.
*/ */
@ -55,6 +59,8 @@ void pm_device_disable(const struct device *dev);
* This API will asynchronously bring the device to resume state * This API will asynchronously bring the device to resume state
* if it not already in active state. * if it not already in active state.
* *
* @funcprops \isr_ok, \pre_kernel_ok
*
* @param dev Pointer to device structure of the specific device driver * @param dev Pointer to device structure of the specific device driver
* the caller is interested in. * the caller is interested in.
* @retval 0 If successfully queued the Async request. If queued, * @retval 0 If successfully queued the Async request. If queued,
@ -86,6 +92,8 @@ int pm_device_get_sync(const struct device *dev);
* This API asynchronously put the device to suspend state if * This API asynchronously put the device to suspend state if
* it not already in suspended state. * it not already in suspended state.
* *
* @funcprops \isr_ok, \pre_kernel_ok
*
* @param dev Pointer to device structure of the specific device driver * @param dev Pointer to device structure of the specific device driver
* the caller is interested in. * the caller is interested in.
* @retval 0 If successfully queued the Async request. If queued, * @retval 0 If successfully queued the Async request. If queued,