Skip to content

Commit 15c4138

Browse files
committed
doc: stepper: introduce stepper_drv api in documentation
add information about stepper_drv api and relevant functions in stepper documentation. rename zephyr,gpio-stepper to zephyr,h-bridge-stepper Signed-off-by: Jilay Pandya <[email protected]>
1 parent 6c26d1b commit 15c4138

File tree

1 file changed

+21
-12
lines changed

1 file changed

+21
-12
lines changed

doc/hardware/peripherals/stepper.rst

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,26 @@
33
Steppers
44
########
55

6-
The stepper driver API provides a set of functions for controlling and configuring stepper drivers.
6+
The stepper driver subsystem consists of two device driver APIs:
77

8-
Configure Stepper Driver
9-
========================
8+
Stepper Driver API
9+
==================
10+
11+
The stepper driver API provides a common interface for stepper drivers.
12+
13+
- Configure **micro-stepping resolution** using :c:func:`stepper_drv_set_micro_step_res`
14+
and :c:func:`stepper_drv_get_micro_step_res`.
15+
- **Enable** the stepper driver using :c:func:`stepper_drv_enable`.
16+
- **Disable** the stepper driver using :c:func:`stepper_drv_disable`.
17+
18+
Stepper API
19+
===========
20+
21+
The stepper API provides a common interface for stepper controllers.
1022

11-
- Configure **micro-stepping resolution** using :c:func:`stepper_set_micro_step_res`
12-
and :c:func:`stepper_get_micro_step_res`.
1323
- Configure **reference position** in microsteps using :c:func:`stepper_set_reference_position`
1424
and :c:func:`stepper_get_actual_position`.
1525
- Set **step interval** in nanoseconds between steps using :c:func:`stepper_set_microstep_interval`
16-
- **Enable** the stepper driver using :c:func:`stepper_enable`.
17-
- **Disable** the stepper driver using :c:func:`stepper_disable`.
18-
19-
Control Stepper
20-
===============
21-
2226
- **Move by** +/- micro-steps also known as **relative movement** using :c:func:`stepper_move_by`.
2327
- **Move to** a specific position also known as **absolute movement** using :c:func:`stepper_move_to`.
2428
- Run continuously with a **constant step interval** in a specific direction until
@@ -38,7 +42,7 @@ be used in a boards devicetree to configure a stepper driver to its initial stat
3842

3943
See examples in:
4044

41-
- :dtcompatible:`zephyr,gpio-stepper`
45+
- :dtcompatible:`zephyr,h-bridge-stepper`
4246
- :dtcompatible:`adi,tmc50xx`
4347

4448
Discord
@@ -48,6 +52,7 @@ Zephyr has a `stepper discord`_ channel for stepper related discussions, which
4852
is open to all.
4953

5054
.. _stepper-api-reference:
55+
.. _stepper-drv-api-reference:
5156

5257
Stepper API Test Suite
5358
======================
@@ -93,6 +98,10 @@ API Reference
9398

9499
A common set of functions which should be implemented by all stepper drivers.
95100

101+
.. doxygengroup:: stepper_drv_interface
102+
103+
A common set of functions which should be implemented by all stepper controllers.
104+
96105
.. doxygengroup:: stepper_interface
97106

98107
Stepper controller specific APIs

0 commit comments

Comments
 (0)