michaelh/zephyr
1
0
Fork 0
Code Releases Activity

device: improve (z_)device_is_ready docs

Browse source 
Improve the documentation so that both z_device_is_ready and
device_is_ready are consistent with each other. Information about PM has
been removed since device_is_ready does not take into account the PM
status of a device.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2021-12-23 17:36:13 +01:00 • committed by Anas Nashif
commit 8d04deb2d9
1 changed files with 13 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

19
include/device.h
View file

@ -733,11 +733,19 @@ __syscall const struct device *device_get_binding(const char *name);
*/
size_t z_device_get_all_static(const struct device * *devices);
/** @brief Determine whether a device has been successfully initialized.
/**
* @brief Verify that a device is ready for use.
*
* This is the implementation underlying device_is_ready(), without the overhead
* of a syscall wrapper.
*
* @param dev pointer to the device in question.
*
* @return true if and only if the device is available for use.
* @retval true If the device is ready for use.
* @retval false If the device is not ready for use or if a NULL device pointer
* is passed as argument.
*
* @see device_is_ready()
*/
bool z_device_is_ready(const struct device *dev);
@ -748,13 +756,12 @@ bool z_device_is_ready(const struct device *dev);
*
* This can be used with device pointers captured from DEVICE_DT_GET(), which
* does not include the readiness checks of device_get_binding(). At minimum
* this means that the device has been successfully initialized, but it may
* take on further conditions (e.g. is not powered down).
* this means that the device has been successfully initialized.
*
* @param dev pointer to the device in question.
*
* @retval true if the device is ready for use.
* @retval false if the device is not ready for use or if a NULL device pointer
* @retval true If the device is ready for use.
* @retval false If the device is not ready for use or if a NULL device pointer
* is passed as argument.
*/
__syscall bool device_is_ready(const struct device *dev);