adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

drivers: stepper: api: add -ECANCELED error code for move operations

Browse source 
If the stepper is not enabled, calling any of the move operations
shall return -ECANCELED

Signed-off-by: Jilay Pandya <jilay.pandya@outlook.com>
This commit is contained in:
Jilay Pandya 2024-12-19 20:52:06 +01:00 committed by Benjamin Cabé
parent 857e5793f1
commit 24914d7489
1 changed files with 3 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
include/zephyr/drivers/stepper.h
View file

@ -233,6 +233,7 @@ static inline int z_impl_stepper_enable(const struct device *dev, const bool ena
* @param dev pointer to the stepper motor controller instance
* @param micro_steps target micro_steps to be moved from the current position
*
* @retval -ECANCELED If the stepper is disabled
* @retval -EIO General input / output error
* @retval 0 Success
*/
@ -374,6 +375,7 @@ static inline int z_impl_stepper_get_actual_position(const struct device *dev, i
* @param dev pointer to the stepper motor controller instance
* @param micro_steps target position to set in micro_steps
*
* @retval -ECANCELED If the stepper is disabled
* @retval -EIO General input / output error
* @retval -ENOSYS If not implemented by device driver
* @retval 0 Success
@ -425,6 +427,7 @@ static inline int z_impl_stepper_is_moving(const struct device *dev, bool *is_mo
* - > 0: Run the stepper with the given velocity in a given direction
* - 0: Stop the stepper
*
* @retval -ECANCELED If the stepper is disabled
* @retval -EIO General input / output error
* @retval -ENOSYS If not implemented by device driver
* @retval 0 Success