: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:: ti,drv8424
.. _dtbinding_ti_drv8424:

ti,drv8424
##########

Vendor: :ref:`Texas Instruments <dt_vendor_ti>`

.. note::

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

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



.. code-block:: none

   TI DRV8424 stepper motor driver.
   SAFETY:
   The counter needs to support both set_top_value functionalities: Setting a new top value and
   attaching an ISR to the turnaround.
   SAFETY:
   The step gpio pin needs to be connected directly to the SOC GPIO controller, connecting the
   pin to a controller connected via a bus such as i2c or others will lead to undefined behaviour.

   Example:
   drv8424: drv8424 {
     status = "okay";
     compatible = "ti,drv8424";

     dir-gpios = <&arduino_header 18 0>;
     step-gpios = <&arduino_header 19 0>;
     sleep-gpios = <&arduino_header 15 GPIO_ACTIVE_LOW>;
     en-gpios  = <&arduino_header 14 0>;
     m0-gpios = <&mikroe_stepper_gpios 0 0>;
     m1-gpios = <&mikroe_stepper_gpios 1 0>;
     counter = <&counter2>;
   };

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

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

                Fault pin.


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

                Sleep pin (active low).


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

                Microstep configuration pin 0.


             This property is **required**.

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

                Microstep configuration pin 1.


             This property is **required**.

         * - ``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 "ti,drv8424" compatible.

      (None)