michaelh/zephyr
1
0
Fork 0
Code Releases Activity

pm: device: improve pm_device_busy* APIs docs

Browse source 
Make the API docs more concise.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2021-10-29 11:59:41 +02:00 • committed by Carles Cufí
commit b51b85f3e7
1 changed files with 17 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

37
include/pm/device.h
View file

@ -185,45 +185,42 @@ int pm_device_state_get(const struct device *dev,
#if defined(CONFIG_PM_DEVICE) || defined(__DOXYGEN__) #if defined(CONFIG_PM_DEVICE) || defined(__DOXYGEN__)
/** /**
* @brief Indicate that the device is in the middle of a transaction * @brief Mark a device as busy.
* *
* Called by a device driver to indicate that it is in the middle of a * Devices marked as busy will not be suspended when the system goes into
* transaction. * low-power states. This can be useful if, for example, the device is in the
* middle of a transaction.
* *
* @param dev Pointer to device structure of the driver instance. * @param dev Device instance.
*
* @see pm_device_busy_clear()
*/ */
void pm_device_busy_set(const struct device *dev); void pm_device_busy_set(const struct device *dev);
/** /**
* @brief Indicate that the device has completed its transaction * @brief Clear a device busy status.
* *
* Called by a device driver to indicate the end of a transaction. * @param dev Device instance.
* *
* @param dev Pointer to device structure of the driver instance. * @see pm_device_busy_set()
*/ */
void pm_device_busy_clear(const struct device *dev); void pm_device_busy_clear(const struct device *dev);
/** /**
* @brief Check if any device is in the middle of a transaction * @brief Check if any device is busy.
* *
* Called by an application to see if any device is in the middle * @retval false If no device is busy
* of a critical transaction that cannot be interrupted. * @retval true If one or more devices are busy
*
* @retval false if no device is busy
* @retval true if any device is busy
*/ */
bool pm_device_is_any_busy(void); bool pm_device_is_any_busy(void);
/** /**
* @brief Check if a specific device is in the middle of a transaction * @brief Check if a device is busy.
* *
* Called by an application to see if a particular device is in the * @param dev Device instance.
* middle of a critical transaction that cannot be interrupted.
* *
* @param dev Pointer to device structure of the specific device driver * @retval false If the device is not busy
* the caller is interested in. * @retval true If the device is busy
* @retval false if the device is not busy
* @retval true if the device is busy
*/ */
bool pm_device_is_busy(const struct device *dev); bool pm_device_is_busy(const struct device *dev);
#else #else