Stepper Hardware Driver Driver Backend API

Data Structures
struct	stepper_driver_api
	Driver Operations Stepper Hardware Driver driver operations More...

Typedefs
typedef int(*	stepper_enable_t) (const struct device *dev)
	Callback API to enable the stepper hardware driver.
typedef int(*	stepper_disable_t) (const struct device *dev)
	Callback API to disable the stepper hardware driver.
typedef int(*	stepper_set_micro_step_res_t) (const struct device *dev, const enum stepper_micro_step_resolution resolution)
	Callback API to set the stepper micro-step resolution.
typedef int(*	stepper_get_micro_step_res_t) (const struct device *dev, enum stepper_micro_step_resolution *resolution)
	Callback API to get the stepper micro-step resolution.
typedef int(*	stepper_set_event_cb_t) (const struct device *dev, stepper_event_cb_t callback, void *user_data)
	Callback API to set the event callback function.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a Stepper Hardware Driver driver.

Typedef Documentation

stepper_disable_t

typedef int(* stepper_disable_t) (const struct device *dev)

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

Callback API to disable the stepper hardware driver.

See stepper_disable() for argument description.

stepper_enable_t

typedef int(* stepper_enable_t) (const struct device *dev)

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

Callback API to enable the stepper hardware driver.

See stepper_enable() for argument description.

stepper_get_micro_step_res_t

typedef int(* stepper_get_micro_step_res_t) (const struct device *dev, enum stepper_micro_step_resolution *resolution)

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

Callback API to get the stepper micro-step resolution.

See stepper_get_micro_step_res() for argument description.

stepper_set_event_cb_t

typedef int(* stepper_set_event_cb_t) (const struct device *dev, stepper_event_cb_t callback, void *user_data)

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

Callback API to set the event callback function.

See stepper_set_event_cb() for argument description.

stepper_set_micro_step_res_t

typedef int(* stepper_set_micro_step_res_t) (const struct device *dev, const enum stepper_micro_step_resolution resolution)

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

Callback API to set the stepper micro-step resolution.

See stepper_set_micro_step_res() for argument description.