: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:: allegro,a4979
.. _dtbinding_allegro_a4979:

allegro,a4979
#############

Vendor: :ref:`Allegro DVT <dt_vendor_allegro>`

.. note::

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

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



.. code-block:: none

   Allegro A4979 microstepping stepper motor driver.
   A4979 is a flexible microstepping motor driver with built-in translator for easy operation.
   It is designed to operate bipolar stepper motors in full-, half-, quarter-, and sixteenth-step
   modes.

   Example:
   a4979: a4979 {
       status = "okay";
       compatible = "allegro,a4979";
       micro-step-res = <2>;
       reset-gpios = <&gpiod 10 GPIO_ACTIVE_HIGH>;
       dir-gpios = <&gpiod 14 GPIO_ACTIVE_HIGH>;
       step-gpios = <&gpiod 15 GPIO_ACTIVE_HIGH>;
       en-gpios = <&gpiod 11 GPIO_ACTIVE_HIGH>;
       m0-gpios = <&gpiod 13 0>;
       m1-gpios = <&gpiod 12 0>;
       counter = <&counter5>;
   };

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

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

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

                Reset pin


             This property is **required**.

         * - ``invert-direction``
           - ``boolean``
           - .. code-block:: none

                Invert motor direction.



         * - ``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 "allegro,a4979" compatible.

      (None)