drivers: stepper: introduce step_dir api

introduce step_dir api which is to be implemented by
the step_dir stepper drivers

Add fault handling in drv84xx using a fault cb mechanism

With the introduction of the step-dir api,different motion
controllers to consume various step-dir drivers allowing
for further upstream as well as downstream stepper motion
controllers to be implemented

Signed-off-by: Jilay Pandya <[email protected]>

Author: jilaypandya

drivers/stepper/CMakeLists.txt

@@ -7,12 +7,17 @@ zephyr_syscall_header(${ZEPHYR_BASE}/include/zephyr/drivers/stepper.h)
 add_subdirectory_ifdef(CONFIG_STEPPER_ADI_TMC adi_tmc)
 add_subdirectory_ifdef(CONFIG_STEPPER_ALLEGRO allegro)
 add_subdirectory_ifdef(CONFIG_STEPPER_TI ti)
+# zephyr-keep-sorted-stop
+
+# zephyr-keep-sorted-start
+add_subdirectory_ifdef(CONFIG_STEPPER_TIMING_SOURCES stepper_timing_sources)
 add_subdirectory_ifdef(CONFIG_STEP_DIR_STEPPER step_dir)
 # zephyr-keep-sorted-stop
 
 zephyr_library()
 zephyr_library_property(ALLOW_EMPTY TRUE)
 
 zephyr_library_sources_ifdef(CONFIG_FAKE_STEPPER fake_stepper_controller.c)
-zephyr_library_sources_ifdef(CONFIG_GPIO_STEPPER gpio_stepper_controller.c)
+zephyr_library_sources_ifdef(CONFIG_GPIO_STEPPER gpio_stepper_driver.c)
+zephyr_library_sources_ifdef(CONFIG_ZEPHYR_STEPPER_MOTION_CONTROL zephyr_stepper_motion_controller.c)
 zephyr_library_sources_ifdef(CONFIG_STEPPER_SHELL stepper_shell.c)

drivers/stepper/Kconfig

@@ -27,12 +27,17 @@ config STEPPER_SHELL
 comment "Stepper Driver Common"
 
 rsource "step_dir/Kconfig"
+rsource "stepper_timing_sources/Kconfig"
 
 comment "Stepper Drivers"
 
 # zephyr-keep-sorted-start
 rsource "Kconfig.fake"
 rsource "Kconfig.gpio"
+rsource "Kconfig.zephyr_stepper_motion_controller"
+# zephyr-keep-sorted-stop
+
+# zephyr-keep-sorted-start
 rsource "adi_tmc/Kconfig"
 rsource "allegro/Kconfig"
 rsource "ti/Kconfig"

drivers/stepper/Kconfig.gpio

@@ -5,4 +5,5 @@
 config GPIO_STEPPER
 	bool "Activate driver for gpio stepper control"
 	depends on DT_HAS_ZEPHYR_GPIO_STEPPER_ENABLED
+	select STEP_DIR_STEPPER
 	default y

drivers/stepper/Kconfig.stepper_event_template

@@ -1,18 +1,18 @@
 # Copyright (c) 2024 Fabian Blatz <[email protected]>
 # SPDX-License-Identifier: Apache-2.0
 
-config STEPPER_$(module)_GENERATE_ISR_SAFE_EVENTS
+config $(module)_GENERATE_ISR_SAFE_EVENTS
 	bool "$(module-str) guarantee non ISR callbacks upon stepper events"
 	help
 	  Enable the dispatch of stepper generated events via
 	  a message queue to guarantee that the event handler
 	  code is not run inside of an ISR. Can be disabled, but
 	  then registered stepper event callback must be ISR safe.
 
-config STEPPER_$(module)_EVENT_QUEUE_LEN
+config $(module)_EVENT_QUEUE_LEN
 	int "$(module-str) maximum number of pending stepper events"
 	default 4
-	depends on STEPPER_$(module)_GENERATE_ISR_SAFE_EVENTS
+	depends on $(module)_GENERATE_ISR_SAFE_EVENTS
 	help
 	  The maximum number of stepper events that can be pending before new events
 	  are dropped.

drivers/stepper/Kconfig.zephyr_stepper_motion_controller

@@ -0,0 +1,14 @@
+# SPDX-FileCopyrightText: Copyright (c) 2025 Jilay Sandeep Pandya
+# SPDX-License-Identifier: Apache-2.0
+
+config ZEPHYR_STEPPER_MOTION_CONTROL
+	bool "Zephyr CPU based Stepper motion control"
+	depends on DT_HAS_ZEPHYR_STEPPER_MOTION_CONTROL_ENABLED
+	select STEPPER_TIMING_SOURCES
+	default y
+
+
+module = ZEPHYR_STEPPER_MOTION_CONTROL
+module-str = zephyr_stepper_motion_control
+
+rsource "Kconfig.stepper_event_template"

drivers/stepper/adi_tmc/tmc22xx.c

@@ -19,11 +19,10 @@ struct tmc22xx_config {
 };
 
 struct tmc22xx_data {
-	struct step_dir_stepper_common_data common;
 	enum stepper_micro_step_resolution resolution;
 };
 
-STEP_DIR_STEPPER_STRUCT_CHECK(struct tmc22xx_config, struct tmc22xx_data);
+STEP_DIR_STEPPER_STRUCT_CHECK(struct tmc22xx_config);
 
 static int tmc22xx_stepper_enable(const struct device *dev)
 {
@@ -147,18 +146,11 @@ static int tmc22xx_stepper_init(const struct device *dev)
 	return 0;
 }
 
-static DEVICE_API(stepper, tmc22xx_stepper_api) = {
+static DEVICE_API(step_dir, tmc22xx_stepper_api) = {
 	.enable = tmc22xx_stepper_enable,
 	.disable = tmc22xx_stepper_disable,
-	.move_by = step_dir_stepper_common_move_by,
-	.is_moving = step_dir_stepper_common_is_moving,
-	.set_reference_position = step_dir_stepper_common_set_reference_position,
-	.get_actual_position = step_dir_stepper_common_get_actual_position,
-	.move_to = step_dir_stepper_common_move_to,
-	.set_microstep_interval = step_dir_stepper_common_set_microstep_interval,
-	.run = step_dir_stepper_common_run,
-	.stop = step_dir_stepper_common_stop,
-	.set_event_callback = step_dir_stepper_common_set_event_callback,
+	.step = step_dir_stepper_common_step,
+	.set_direction = step_dir_stepper_common_set_direction,
 	.set_micro_step_res = tmc22xx_stepper_set_micro_step_res,
 	.get_micro_step_res = tmc22xx_stepper_get_micro_step_res,
 };
@@ -183,7 +175,6 @@ static DEVICE_API(stepper, tmc22xx_stepper_api) = {
 		(.msx_pins = tmc22xx_stepper_msx_pins_##inst))					   \
 	};                                                                                         \
 	static struct tmc22xx_data tmc22xx_data_##inst = {                                         \
-		.common = STEP_DIR_STEPPER_DT_INST_COMMON_DATA_INIT(inst),                         \
 		.resolution = DT_INST_PROP(inst, micro_step_res),                                  \
 	};                                                                                         \
 	DEVICE_DT_INST_DEFINE(inst, tmc22xx_stepper_init, NULL, &tmc22xx_data_##inst,              \

drivers/stepper/allegro/a4979.c

@@ -22,11 +22,10 @@ struct a4979_config {
 };
 
 struct a4979_data {
-	const struct step_dir_stepper_common_data common;
 	enum stepper_micro_step_resolution micro_step_res;
 };
 
-STEP_DIR_STEPPER_STRUCT_CHECK(struct a4979_config, struct a4979_data);
+STEP_DIR_STEPPER_STRUCT_CHECK(struct a4979_config);
 
 static int a4979_set_microstep_pin(const struct device *dev, const struct gpio_dt_spec *pin,
 				   int value)
@@ -222,20 +221,13 @@ static int a4979_init(const struct device *dev)
 	return 0;
 }
 
-static DEVICE_API(stepper, a4979_stepper_api) = {
+static DEVICE_API(step_dir, a4979_stepper_api) = {
 	.enable = a4979_stepper_enable,
 	.disable = a4979_stepper_disable,
-	.move_by = step_dir_stepper_common_move_by,
-	.move_to = step_dir_stepper_common_move_to,
-	.is_moving = step_dir_stepper_common_is_moving,
-	.set_reference_position = step_dir_stepper_common_set_reference_position,
-	.get_actual_position = step_dir_stepper_common_get_actual_position,
-	.set_microstep_interval = step_dir_stepper_common_set_microstep_interval,
-	.run = step_dir_stepper_common_run,
-	.stop = step_dir_stepper_common_stop,
 	.set_micro_step_res = a4979_stepper_set_micro_step_res,
 	.get_micro_step_res = a4979_stepper_get_micro_step_res,
-	.set_event_callback = step_dir_stepper_common_set_event_callback,
+	.step = step_dir_stepper_common_step,
+	.set_direction = step_dir_stepper_common_set_direction,
 };
 
 #define A4979_DEVICE(inst)                                                                         \
@@ -249,7 +241,6 @@ static DEVICE_API(stepper, a4979_stepper_api) = {
 	};                                                                                         \
                                                                                                    \
 	static struct a4979_data a4979_data_##inst = {                                             \
-		.common = STEP_DIR_STEPPER_DT_INST_COMMON_DATA_INIT(inst),                         \
 		.micro_step_res = DT_INST_PROP(inst, micro_step_res),                              \
 	};                                                                                         \
                                                                                                    \