: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
###########

Vendor: :ref:`Analog Devices, Inc. <dt_vendor_adi>`

.. note::

   An implementation of a driver matching this compatible is available in
   :zephyr_file:`drivers/stepper/adi_tmc/adi_tmc22xx_stepper_controller.c`.

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



.. code-block:: none

   Analog Devices TMC2209 stepper motor driver.

   Example:
   tmc2209: tmc2209 {
       compatible = "adi,tmc2209";
       enable-gpios = <&gpio0 0 GPIO_ACTIVE_HIGH>;
       msx-gpios = <&gpio0 1 GPIO_ACTIVE_HIGH>,
                   <&gpio0 2 GPIO_ACTIVE_HIGH>;
       step-gpios = <&gpio0 3 GPIO_ACTIVE_HIGH>;
       dir-gpios = <&gpio0 4 GPIO_ACTIVE_HIGH>;
       dual-edge-step;
   }

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

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

                An array of GPIO pins for configuring the microstep resolution of the driver.
                The pins should be listed in the following order:
                - MS1
                - MS2



         * - ``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.



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

                The GPIO pins used to send step signals to the stepper motor.



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

                The GPIO pins used to send direction signals to the stepper motor.
                Pin will be driven high for forward direction and low for reverse direction.



         * - ``counter``
           - ``phandle``
           - .. code-block:: none

                Counter used for generating step-accurate pulse signals.




   .. 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)