:orphan:

.. raw:: html

    <!--
    FIXME: do not limit page width until content uses another representation
    format other than tables
    -->
    <style>.wy-nav-content { max-width: none; !important }</style>

.. dtcompatible:: adi,tmc2209
.. _dtbinding_adi_tmc2209:

adi,tmc2209
###########

.. sidebar:: Overview

   :Name: ``adi,tmc2209``
   :Vendor: :ref:`Analog Devices, Inc. <dt_vendor_adi>`
   :Used in: :zephyr:board-catalog:`List of boards <#compatibles=adi,tmc2209>` using
               this compatible
   :Driver: :zephyr_file:`drivers/stepper/adi_tmc/tmc22xx/tmc22xx.c`

Description
***********



.. code-block:: none

   Analog Devices TMC2209 stepper motor driver.

Examples
********

.. code-block:: dts

   tmc2209: tmc2209 {
       compatible = "adi,tmc2209";
       enable-gpios = <&gpio0 0 GPIO_ACTIVE_HIGH>;
       m0-gpios = <&gpio0 1 GPIO_ACTIVE_HIGH>;
       m1-gpios = <&gpio0 2 GPIO_ACTIVE_HIGH>;
   }


Properties
**********

.. tabs::

   .. group-tab:: Node specific properties

      Properties not inherited from the base binding file.

      .. list-table::
         :widths: 1 1 4
         :header-rows: 1

         * - Name
           - Type
           - Details

         * - ``step-width-ns``
           - ``int``
           - .. code-block:: none

                Minimum pulse width in nanoseconds for the step signal.



             Default value: ``100``

         * - ``dual-edge-step``
           - ``boolean``
           - .. code-block:: none

                If present, the stepper motor controller supports dual edge step signals.
                This means that the step signal can be toggled on both the rising and falling edge.



         * - ``micro-step-res``
           - ``int``
           - .. code-block:: none

                micro-step resolution to be set while initializing the device driver.



             Default value: ``1``

             Legal values: ``1``, ``2``, ``4``, ``8``, ``16``, ``32``, ``64``, ``128``, ``256``

         * - ``en-gpios``
           - ``phandle-array``
           - .. code-block:: none

                GPIO pins used to control the enable signal of the motor driver.



         * - ``m0-gpios``
           - ``phandle-array``
           - .. code-block:: none

                Microstep configuration pin 0.


         * - ``m1-gpios``
           - ``phandle-array``
           - .. code-block:: none

                Microstep configuration pin 1.




   .. group-tab:: Deprecated node specific properties

      Deprecated properties not inherited from the base binding file.

      (None)

   .. group-tab:: Base properties

      Properties inherited from the base binding file, which defines
      common properties that may be set on many nodes. Not all of these
      may apply to the "adi,tmc2209" compatible.

      (None)