Line data    Source code

       1            1 : /**
       2              :  * @file drivers/stepper/stepper_drv84xx.h
       3              :  *
       4              :  * @brief Public API for DRV84XX Stepper Controller Specific Functions
       5              :  *
       6              :  */
       7              : 
       8              : /*
       9              :  * SPDX-FileCopyrightText: Copyright (c) 2024 Navimatix GmbH
      10              :  *
      11              :  * SPDX-License-Identifier: Apache-2.0
      12              :  */
      13              : 
      14              : #ifndef ZEPHYR_INCLUDE_DRIVERS_STEPPER_STEPPER_DRV84XX_H_
      15              : #define ZEPHYR_INCLUDE_DRIVERS_STEPPER_STEPPER_DRV84XX_H_
      16              : 
      17              : #include <stdint.h>
      18              : #include <zephyr/drivers/stepper.h>
      19              : 
      20              : #ifdef __cplusplus
      21              : extern "C" {
      22              : #endif
      23              : 
      24              : /**
      25              :  * @brief After microstep setter fails, attempt to recover into previous state.
      26              :  *
      27              :  * @param dev Pointer to the stepper motor controller instance
      28              :  *
      29              :  * @retval 0 Success
      30              :  * @retval <0 Error code dependent on the gpio controller of the microstep pins
      31              :  */
      32            1 : int drv84xx_microstep_recovery(const struct device *dev);
      33              : 
      34              : #ifdef __cplusplus
      35              : }
      36              : #endif
      37              : 
      38              : #endif /* ZEPHYR_INCLUDE_DRIVERS_STEPPER_STEPPER_DRV84XX_H_ */