Skip to content

Commit aa2a0fb

Browse files
jilaypandyanashif
authored andcommitted
doc: migration_guide: address stepper split
add entry for splitting stepper api in migration-guide-4.4 Signed-off-by: Jilay Pandya <[email protected]>
1 parent 8395626 commit aa2a0fb

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

doc/releases/migration-guide-4.4.rst

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,44 @@ Stepper
157157
* For :dtcompatible:`adi,tmc2209`, the property ``msx-gpios`` is now replaced by ``m0-gpios`` and
158158
``m1-gpios`` for consistency with other step/dir stepper drivers.
159159

160+
* Since :github:`91979`, All stepper-drv driver APIs have been refactored out of the stepper API.
161+
The following APIs have been moved from :c:group:`stepper_interface` to :c:group:`stepper_drv_interface`:
162+
163+
* :c:func:`stepper_enable` is replaced by :c:func:`stepper_drv_enable`.
164+
* :c:func:`stepper_disable` is replaced by :c:func:`stepper_drv_disable`.
165+
* :c:func:`stepper_set_micro_step_res` is replaced by :c:func:`stepper_drv_set_micro_step_res`.
166+
* :c:func:`stepper_get_micro_step_res` is replaced by :c:func:`stepper_drv_get_micro_step_res`.
167+
168+
* :c:enum:`stepper_micro_step_resolution` is replaced by :c:enum:`stepper_drv_micro_step_resolution`.
169+
* ``STEPPER_DRV_EVENT_STALL_DETECTED`` and ``STEPPER_DRV_EVENT_FAULT_DETECTED`` events have been
170+
refactored to :c:enum:`stepper_drv_event`.
171+
172+
* :dtcompatible:`zephyr,gpio-step-dir-stepper` implements :c:group:`stepper_interface` for
173+
controlling stepper motors via GPIO step and direction signals. Refer to
174+
:ref:`stepper-individual-controller-driver` for more details.
175+
176+
* ``step-gpios``, ``dir-gpios``, ``invert-direction`` and ``counter`` properties are removed
177+
from :dtcompatible:`adi,tmc2209`, :dtcompatible:`ti,drv84xx` and :dtcompatible:`allegro,a4979`,
178+
these are now are implemented by :dtcompatible:`zephyr,gpio-step-dir-stepper`.
179+
* :c:func:`stepper_move_by`, :c:func:`stepper_move_to`, :c:func:`stepper_run`,
180+
:c:func:`stepper_stop`, :c:func:`stepper_is_moving`, :c:func:`stepper_set_microstep_interval`
181+
and :c:func:`stepper_set_event_callback` APIs are removed from :dtcompatible:`adi,tmc2209`,
182+
:dtcompatible:`ti,drv84xx` and :dtcompatible:`allegro,a4979`.
183+
* :dtcompatible:`adi,tmc2209`, :dtcompatible:`ti,drv84xx` and :dtcompatible:`allegro,a4979`
184+
implement :c:group:`stepper_drv_interface`.
185+
186+
* :c:func:`stepper_enable`, :c:func:`stepper_disable`, :c:func:`stepper_set_micro_step_res` and
187+
:c:func:`stepper_get_micro_step_res` APIs are removed from :dtcompatible:`zephyr,h-bridge-stepper`.
188+
* ``en-gpios`` property is removed from :dtcompatible:`zephyr,h-bridge-stepper`.
189+
* ``micro-step-res`` property is replaced by ``lut-step-gap`` property in
190+
:dtcompatible:`zephyr,h-bridge-stepper`.
191+
192+
* :dtcompatible:`adi,tmc50xx` and :dtcompatible:`adi,tmc51xx` devices are now modeled as MFDs.
193+
* :dtcompatible:`adi,tmc50xx-stepper` and :dtcompatible:`adi,tmc51xx-stepper` drivers implement
194+
:c:group:`stepper_interface`.
195+
* :dtcompatible:`adi,tmc50xx-stepper-drv` and :dtcompatible:`adi,tmc51xx-stepper-drv` drivers implement
196+
:c:group:`stepper_drv_interface`.
197+
160198
USB
161199
===
162200

0 commit comments

Comments
 (0)