michaelh/zephyr
1
0
Fork 0
Code Releases Activity

device: deprecate (z_)device_usable_check

Browse source 
The functionality provided by device_usable_check is already provided by
device_is_ready. The (z_)device_usable_check APIs have been
re-implemented using the (z_)device_is_ready APIs and have been marked
as deprecated.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
This commit is contained in:
Gerard Marull-Paretas 2021-12-23 17:25:34 +01:00 • committed by Anas Nashif
commit 0b0435a96c
2 changed files with 33 additions and 40 deletions
Download patch file Download diff file Expand all files Collapse all files

65
include/device.h
View file

@ -741,38 +741,6 @@ size_t z_device_get_all_static(const struct device * *devices);
*/ */
bool z_device_is_ready(const struct device *dev); bool z_device_is_ready(const struct device *dev);
/** @brief Determine whether a device is ready for use
*
* This is the implementation underlying `device_usable_check()`, without the
* overhead of a syscall wrapper.
*
* @param dev pointer to the device in question.
*
* @return a non-positive integer as documented in device_usable_check().
*/
static inline int z_device_usable_check(const struct device *dev)
{
return z_device_is_ready(dev) ? 0 : -ENODEV;
}
/** @brief Determine whether a device is ready for use.
*
* This checks whether a device can be used, returning 0 if it can, and
* distinct error values that identify the reason if it cannot.
*
* @retval 0 if the device is usable.
* @retval -ENODEV if the device has not been initialized, the device pointer
* is NULL or the initialization failed.
* @retval other negative error codes to indicate additional conditions that
* make the device unusable.
*/
__syscall int device_usable_check(const struct device *dev);
static inline int z_impl_device_usable_check(const struct device *dev)
{
return z_device_usable_check(dev);
}
/** @brief Verify that a device is ready for use. /** @brief Verify that a device is ready for use.
* *
* Indicates whether the provided device pointer is for a device known to be * Indicates whether the provided device pointer is for a device known to be
@ -796,6 +764,39 @@ static inline bool z_impl_device_is_ready(const struct device *dev)
return z_device_is_ready(dev); return z_device_is_ready(dev);
} }
/**
* @brief Determine whether a device is ready for use
*
* This is equivalent to device_usable_check(), without the overhead of a
* syscall wrapper.
*
* @deprecated Use z_device_is_ready() instead.
*
* @param dev Device instance.
*
* @retval 0 If device is usable.
* @retval -ENODEV If device is not usable.
*/
__deprecated static inline int z_device_usable_check(const struct device *dev)
{
return z_device_is_ready(dev) ? 0 : -ENODEV;
}
/**
* @brief Determine whether a device is ready for use
*
* @deprecated Use device_is_ready() instead.
*
* @param dev Device instance.
*
* @retval 0 If device is usable.
* @retval -ENODEV If device is not usable.
*/
__deprecated static inline int device_usable_check(const struct device *dev)
{
return device_is_ready(dev) ? 0 : -ENODEV;
}
/** /**
* @} * @}
*/ */

8
kernel/device.c
View file

@ -134,14 +134,6 @@ static inline const struct device *z_vrfy_device_get_binding(const char *name)
} }
#include <syscalls/device_get_binding_mrsh.c> #include <syscalls/device_get_binding_mrsh.c>
static inline int z_vrfy_device_usable_check(const struct device *dev)
{
Z_OOPS(Z_SYSCALL_OBJ_INIT(dev, K_OBJ_ANY));
return z_impl_device_usable_check(dev);
}
#include <syscalls/device_usable_check_mrsh.c>
static inline bool z_vrfy_device_is_ready(const struct device *dev) static inline bool z_vrfy_device_is_ready(const struct device *dev)
{ {
Z_OOPS(Z_SYSCALL_OBJ_INIT(dev, K_OBJ_ANY)); Z_OOPS(Z_SYSCALL_OBJ_INIT(dev, K_OBJ_ANY));