: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-steppers
.. _dtbinding_zephyr_gpio_stepper:

zephyr,gpio-steppers
####################

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 cluster for darlington transistor arrays or dual H-bridge

   Example:
     /* Lead A is connected Lead C and Lead B is connected to Lead D*/
     stepper {
         compatible = "zephyr,gpio-steppers";
         motor: motor {
             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
**********

Top level properties
====================

No top-level properties.

Child node properties
=====================

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