doc: peripherals: stepper: stepper_set_event_callback function

- Add missing SPDX headers - Document set_event_callback function in steppers.rst - Use the correct dtcompatible in release notes - Rename tests from stepper_api to gpio_steppers Signed-off-by: Jilay Pandya <[email protected]>
zephyrproject-rtos · Oct 30, 2024 · b067e13 · b067e13
1 parent cdf2f9a
commit b067e13
Show file tree

Hide file tree

Showing 10 changed files with 13 additions and 13 deletions.
diff --git a/doc/hardware/peripherals/stepper.rst b/doc/hardware/peripherals/stepper.rst
@@ -24,6 +24,7 @@ Control Stepper
 - Run continuously with a **constant velocity** in a specific direction until
   a stop is detected using :c:func:`stepper_enable_constant_velocity_mode`.
 - Check if the stepper is **moving** using :c:func:`stepper_is_moving`.
+- Register a **event callback** using :c:func:`stepper_set_event_callback`.
 
 Device Tree
 ===========
@@ -36,6 +37,7 @@ be used in a boards devicetree to configure a stepper driver to its initial stat
 
 See examples in:
 
+- :dtcompatible:`zephyr,gpio-steppers`
 - :dtcompatible:`adi,tmc5041`
 
 Discord

diff --git a/doc/releases/release-notes-4.0.rst b/doc/releases/release-notes-4.0.rst
@@ -334,7 +334,7 @@ Drivers and Sensors
   * Introduced stepper shell commands for controlling and configuring
     stepper motors with :kconfig:option:`CONFIG_STEPPER_SHELL`
   * Added support for ADI TMC5041 (:dtcompatible:`adi,tmc5041`)
-  * Added support for gpio-stepper-controller (:dtcompatible:`gpio-stepper-controller`)
+  * Added support for gpio-stepper-controller (:dtcompatible:`zephyr,gpio-steppers`)
   * Added stepper api test-suite
   * Added stepper shell test-suite
 

diff --git a/...rivers/stepper/stepper_api/CMakeLists.txt → ...vers/stepper/gpio_steppers/CMakeLists.txt b/...rivers/stepper/stepper_api/CMakeLists.txt → ...vers/stepper/gpio_steppers/CMakeLists.txt
@@ -1,10 +1,8 @@
-# Copyright (c) 2024 Jilay Sandeep Pandya
+# SPDX-FileCopyrightText: Copyright (c) 2024 Jilay Sandeep Pandya
 # SPDX-License-Identifier: Apache-2.0
 
 cmake_minimum_required(VERSION 3.20.0)
-
 find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
-project(stepper_api)
-target_sources(app PRIVATE
-	src/main.c
-)
+project(gpio_steppers)
+
+target_sources(app PRIVATE src/main.c)
diff --git a/...per/stepper_api/boards/nucleo_g071rb.conf → ...r/gpio_steppers/boards/nucleo_g071rb.conf b/...per/stepper_api/boards/nucleo_g071rb.conf → ...r/gpio_steppers/boards/nucleo_g071rb.conf
@@ -1,4 +1,4 @@
-# Copyright (c) 2024 Jilay Sandeep Pandya
+# SPDX-FileCopyrightText: Copyright (c) 2024 Jilay Sandeep Pandya
 # SPDX-License-Identifier: Apache-2.0
 
 CONFIG_GPIO=y

diff --git a/.../stepper_api/boards/nucleo_g071rb.overlay → ...pio_steppers/boards/nucleo_g071rb.overlay b/.../stepper_api/boards/nucleo_g071rb.overlay → ...pio_steppers/boards/nucleo_g071rb.overlay
diff --git a/...epper/stepper_api/boards/qemu_x86_64.conf → ...per/gpio_steppers/boards/qemu_x86_64.conf b/...epper/stepper_api/boards/qemu_x86_64.conf → ...per/gpio_steppers/boards/qemu_x86_64.conf
@@ -1,4 +1,4 @@
-# Copyright (c) 2024 Jilay Sandeep Pandya
+# SPDX-FileCopyrightText: Copyright (c) 2024 Jilay Sandeep Pandya
 # SPDX-License-Identifier: Apache-2.0
 
 CONFIG_GPIO=y

diff --git a/...er/stepper_api/boards/qemu_x86_64.overlay → .../gpio_steppers/boards/qemu_x86_64.overlay b/...er/stepper_api/boards/qemu_x86_64.overlay → .../gpio_steppers/boards/qemu_x86_64.overlay
diff --git a/tests/drivers/stepper/stepper_api/prj.conf → tests/drivers/stepper/gpio_steppers/prj.conf b/tests/drivers/stepper/stepper_api/prj.conf → tests/drivers/stepper/gpio_steppers/prj.conf
@@ -1,4 +1,4 @@
-# Copyright (c) 2024 Jilay Sandeep Pandya
+# SPDX-FileCopyrightText: Copyright (c) 2024 Jilay Sandeep Pandya
 # SPDX-License-Identifier: Apache-2.0
 
 CONFIG_ZTEST=y

diff --git a/tests/drivers/stepper/stepper_api/src/main.c → .../drivers/stepper/gpio_steppers/src/main.c b/tests/drivers/stepper/stepper_api/src/main.c → .../drivers/stepper/gpio_steppers/src/main.c
@@ -1,5 +1,5 @@
 /*
- * Copyright 2024 Jilay Sandeep Pandya
+ * SPDX-FileCopyrightText: Copyright (c) 2024 Jilay Sandeep Pandya
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -17,7 +17,7 @@ struct k_poll_event stepper_event;
 void *user_data_received;
 
 static void stepper_print_event_callback(const struct device *dev, enum stepper_event event,
-					void *user_data)
+					 void *user_data)
 {
 	user_data_received = user_data;
 	switch (event) {

diff --git a/...drivers/stepper/stepper_api/testcase.yaml → ...ivers/stepper/gpio_steppers/testcase.yaml b/...drivers/stepper/stepper_api/testcase.yaml → ...ivers/stepper/gpio_steppers/testcase.yaml
@@ -1,4 +1,4 @@
-# Copyright (c) 2024 Jilay Sandeep Pandya
+# SPDX-FileCopyrightText: Copyright (c) 2024 Jilay Sandeep Pandya
 # SPDX-License-Identifier: Apache-2.0
 
 tests: