: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:: zephyr,gpio-stepper
.. _dtbinding_zephyr_gpio_stepper:

zephyr,gpio-stepper
###################

Vendor: :ref:`Zephyr-specific binding <dt_vendor_zephyr>`

.. note::

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

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



.. code-block:: none

   GPIO Stepper Controller for darlington transistor arrays or dual H-bridge

   Example:
     /* Lead A is connected Lead C and Lead B is connected to Lead D*/
     stepper: stepper {
         compatible = "zephyr,gpio-stepper";
         gpios = <&gpioa 9 GPIO_ACTIVE_HIGH>,  /* Lead A1/A */
                 <&gpioc 7 GPIO_ACTIVE_HIGH>,  /* Lead B1/B */
                 <&gpiob 0 GPIO_ACTIVE_HIGH>,  /* Lead A2/C */
                 <&gpioa 7 GPIO_ACTIVE_HIGH>;  /* Lead B2/D */
     };

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

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

                The gpio pin array on which the stepper inputs are to be connected



             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 "zephyr,gpio-stepper" compatible.

      (None)