:orphan: .. raw:: html .. dtcompatible:: gpio-qdec .. _dtbinding_gpio_qdec: gpio-qdec ######### Vendor: :ref:`Generic or vendor-independent ` Description *********** .. code-block:: none GPIO based QDEC input device Implement an input device generating relative axis event reports for a rotary encoder connected to two GPIOs. The driver is normally idling until it sees a transition on any of the encoder signal lines, then switches to polling mode and samples the two signal lines periodically to track the encoder position, and goes back to idling after the specified timeout. Example configuration: #include qdec { compatible = "gpio-qdec"; gpios = <&gpio0 14 (GPIO_PULL_UP | GPIO_ACTIVE_HIGH)>, <&gpio0 13 (GPIO_PULL_UP | GPIO_ACTIVE_HIGH)>; steps-per-period = <4>; zephyr,axis = ; sample-time-us = <2000>; idle-timeout-ms = <200>; }; 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 GPIO for the A and B encoder signals. This property is **required**. * - ``led-gpios`` - ``phandle-array`` - .. code-block:: none GPIOs for LED or other components needed for sensing the AB signals. * - ``led-pre-us`` - ``int`` - .. code-block:: none Time between enabling the led-gpios output pins and reading the encoder state on the input pins, meant to give the state detector (such a phototransistor) time to settle to right state. Required if led-gpios and idle-poll-time-us are specified, can be explicitly set to 0 for no delay. * - ``steps-per-period`` - ``int`` - .. code-block:: none How many steps to count before reporting an input event. This property is **required**. * - ``zephyr,axis`` - ``int`` - .. code-block:: none The input code for the axis to report for the device, typically any of INPUT_REL_*. This property is **required**. * - ``sample-time-us`` - ``int`` - .. code-block:: none How often to sample the A and B signal lines when tracking the encoder movement. This property is **required**. * - ``idle-poll-time-us`` - ``int`` - .. code-block:: none How often to sample the A and B signal while idling. If unset then the driver will use the GPIO interrupt to exit idle state, and any GPIO specified in led-gpios will be enabled all the time. If non zero, then the driver will poll every idle-poll-time-us microseconds while idle, and only activate led-gpios before sampling the encoder state. * - ``idle-timeout-ms`` - ``int`` - .. code-block:: none Timeout for the last detected transition before stopping the sampling timer and going back to idle state. This property is **required**. .. 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 "gpio-qdec" compatible. .. list-table:: :widths: 1 1 4 :header-rows: 1 * - Name - Type - Details * - ``status`` - ``string`` - .. code-block:: none indicates the operational status of a device Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'`` See :ref:`zephyr:dt-important-props` for more information. * - ``compatible`` - ``string-array`` - .. code-block:: none compatible strings This property is **required**. See :ref:`zephyr:dt-important-props` for more information. * - ``reg`` - ``array`` - .. code-block:: none register space See :ref:`zephyr:dt-important-props` for more information. * - ``reg-names`` - ``string-array`` - .. code-block:: none name of each register space * - ``interrupts`` - ``array`` - .. code-block:: none interrupts for device See :ref:`zephyr:dt-important-props` for more information. * - ``interrupts-extended`` - ``compound`` - .. code-block:: none extended interrupt specifier for device * - ``interrupt-names`` - ``string-array`` - .. code-block:: none name of each interrupt * - ``interrupt-parent`` - ``phandle`` - .. code-block:: none phandle to interrupt controller node * - ``label`` - ``string`` - .. code-block:: none Human readable string describing the device (used as device_get_binding() argument) See :ref:`zephyr:dt-important-props` for more information. This property is **deprecated**. * - ``clocks`` - ``phandle-array`` - .. code-block:: none Clock gate information * - ``clock-names`` - ``string-array`` - .. code-block:: none name of each clock * - ``#address-cells`` - ``int`` - .. code-block:: none number of address cells in reg property * - ``#size-cells`` - ``int`` - .. code-block:: none number of size cells in reg property * - ``dmas`` - ``phandle-array`` - .. code-block:: none DMA channels specifiers * - ``dma-names`` - ``string-array`` - .. code-block:: none Provided names of DMA channel specifiers * - ``io-channels`` - ``phandle-array`` - .. code-block:: none IO channels specifiers * - ``io-channel-names`` - ``string-array`` - .. code-block:: none Provided names of IO channel specifiers * - ``mboxes`` - ``phandle-array`` - .. code-block:: none mailbox / IPM channels specifiers * - ``mbox-names`` - ``string-array`` - .. code-block:: none Provided names of mailbox / IPM channel specifiers * - ``wakeup-source`` - ``boolean`` - .. code-block:: none Property to identify that a device can be used as wake up source. When this property is provided a specific flag is set into the device that tells the system that the device is capable of wake up the system. Wake up capable devices are disabled (interruptions will not wake up the system) by default but they can be enabled at runtime if necessary. * - ``power-domain`` - ``phandle`` - .. code-block:: none Power domain the device belongs to. The device will be notified when the power domain it belongs to is either suspended or resumed. * - ``zephyr,pm-device-runtime-auto`` - ``boolean`` - .. code-block:: none Automatically configure the device for runtime power management after the init function runs.