Driver Operations Stepper Hardware Driver driver operations More...

#include <zephyr/drivers/stepper/stepper.h>

Data Fields
stepper_enable_t	enable
	REQ Enable stepper hardware driver.
stepper_disable_t	disable
	REQ Disable stepper hardware driver.
stepper_set_micro_step_res_t	set_micro_step_res
	REQ Set the micro-step resolution in stepper hardware driver.
stepper_get_micro_step_res_t	get_micro_step_res
	REQ Get the micro-step resolution in stepper hardware driver.
stepper_set_event_cb_t	set_event_cb
	OPT Set the callback function to be called when a stepper_event occurs.

Detailed Description

Driver Operations Stepper Hardware Driver driver operations

This is the driver API structure any Stepper Hardware Driver driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also: DEVICE_DT_INST_DEFINE(); DEVICE_DT_DEFINE(); DEVICE_API()

Field Documentation

◆ disable

stepper_disable_t stepper_driver_api::disable

REQ Disable stepper hardware driver.

◆ enable

stepper_enable_t stepper_driver_api::enable

REQ Enable stepper hardware driver.

◆ get_micro_step_res

stepper_get_micro_step_res_t stepper_driver_api::get_micro_step_res

REQ Get the micro-step resolution in stepper hardware driver.

◆ set_event_cb

stepper_set_event_cb_t stepper_driver_api::set_event_cb

OPT Set the callback function to be called when a stepper_event occurs.

◆ set_micro_step_res

stepper_set_micro_step_res_t stepper_driver_api::set_micro_step_res

REQ Set the micro-step resolution in stepper hardware driver.

The documentation for this struct was generated from the following file:

zephyr/drivers/stepper/stepper.h