:orphan:
.. raw:: html
.. dtcompatible:: nxp,mcux-eqdc
.. _dtbinding_nxp_mcux_eqdc:
nxp,mcux-eqdc
#############
.. sidebar:: Overview
:Name: ``nxp,mcux-eqdc``
:Vendor: :ref:`NXP Semiconductors N.V. `
:Used in: :zephyr:board-catalog:`List of boards <#compatibles=nxp,mcux-eqdc>` using
this compatible
:Driver: :zephyr_file:`drivers/sensor/nxp/eqdc_mcux/eqdc_mcux.c`
Description
***********
.. code-block:: none
NXP MCUX Enhanced Quadrature Decoder (EQDC)
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
* - ``counts-per-revolution``
- ``int``
- .. code-block:: none
Number of encoder counts per full revolution (360 degrees).
This is used to convert position to angle. The value is scaled
internally by the count multiplier of the active decode mode, so the
effective modulus is (counts-per-revolution * multiplier - 1):
- Quadrature X4 (default): multiplier 4
- single-phase-mode: multiplier 1
This property is **required**.
Minimum value: ``1``
* - ``input-filter-count``
- ``int``
- .. code-block:: none
Input filter sample count
The Input Filter Sample Count represents the number of consecutive samples
that must agree, before the input filter accepts an input transition:
- A value of 0x0 represents 3 samples
- A value of 0x7 represents 10 samples
The value of the Input Filter Sample Count (FILT_CNT) affects the
input latency.
Default value: ``0``
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``, ``5``, ``6``, ``7``
* - ``input-filter-period``
- ``int``
- .. code-block:: none
The Input Filter Sample Period represents the sampling period
(in IPBus clock cycles) of the decoder input signals. Each input
is sampled multiple times at the rate specified by the Input Filter
Sample Period.
- If it is set to 0x0(default), then the input filter is bypassed.
The value of the Input Filter Sample Period (FILT_PER) affects the
input latency.
Default value: ``0``
Value range: ``0`` to ``255``
* - ``prescaler``
- ``int``
- .. code-block:: none
The Prescaler field is used to prescale the peripheral clock that
is used by the LASTEDGE and POSDPER counters as well as watchdog timer
and Input Filter.
The clock is prescaled by a value of 2^PRSC. For example:
prescaler = 0, divide by 1
prescaler = 1, divide by 2
...
prescaler = 15, divide by 32768
Default value: ``0``
Value range: ``0`` to ``15``
* - ``reverse-direction``
- ``boolean``
- .. code-block:: none
Selects the direction of the count and position counter initial value.
false: Count normally.
true: Count in the reverse direction.
* - ``single-phase-mode``
- ``boolean``
- .. code-block:: none
Bypass the quadrature decoder and use single-phase decode mode. A
transition on the PHASEA input generates a count; PHASEB and the
reverse-direction setting control the count direction. In this mode the
controller counts one edge per pulse (no X4 quadrature multiply), so
counts-per-revolution is the raw pulse count per revolution.
When unset (default), standard quadrature X4 decoding is used.
* - ``revolution-count-mode``
- ``int``
- .. code-block:: none
0: Use INDEX pulse to increment/decrement revolution counter.
1: Use modulus counting roll-over or roll-under events instead of the
INDEX pulse.
Default value: ``1``
Legal values: ``0``, ``1``
* - ``mux-states``
- ``phandle-array``
- .. code-block:: none
INPUTMUX routing for the EQDC PHASEA/PHASEB inputs. Each entry is
<&inputmuxN index connection> where:
- &inputmuxN is the INPUTMUX mux controller providing the route
- index is the INPUTMUX destination index
- connection is an inputmux_connection_t value from the NXP HAL
header fsl_inputmux_connections.h
Example (MCXA153: route TRIG_IN10 to EQDC PHASEA and TRIG_IN5 to
EQDC PHASEB via INPUTMUX0):
mux-states = <&inputmux0 0 0x37000022>, /* TrigIn10ToQdc0Phasea */
<&inputmux0 0 0x36c0001d>; /* TrigIn5ToQdc0Phaseb */
* - ``friendly-name``
- ``string``
- .. code-block:: none
Human readable string describing the sensor. It can be used to
distinguish multiple instances of the same model (e.g., lid accelerometer
vs. base accelerometer in a laptop) to a host operating system.
This property is defined in the Generic Sensor Property Usages of the HID
Usage Tables specification
(https://usb.org/sites/default/files/hut1_3_0.pdf, section 22.5).
* - ``pinctrl-0``
- ``phandles``
- .. code-block:: none
Pin configuration/s for the first state. Content is specific to the
selected pin controller driver implementation.
* - ``pinctrl-1``
- ``phandles``
- .. code-block:: none
Pin configuration/s for the second state. See pinctrl-0.
* - ``pinctrl-2``
- ``phandles``
- .. code-block:: none
Pin configuration/s for the third state. See pinctrl-0.
* - ``pinctrl-3``
- ``phandles``
- .. code-block:: none
Pin configuration/s for the fourth state. See pinctrl-0.
* - ``pinctrl-4``
- ``phandles``
- .. code-block:: none
Pin configuration/s for the fifth state. See pinctrl-0.
* - ``pinctrl-names``
- ``string-array``
- .. code-block:: none
Names for the provided states. The number of names needs to match the
number of states.
* - ``mux-controls``
- ``phandle-array``
- .. code-block:: none
List of MUX controller specifiers. Each entry is a phandle to a MUX
controller followed by #mux-control-cells addressing cells.
* - ``mux-control-names``
- ``string-array``
- .. code-block:: none
Optional names for the entries in "mux-controls"
* - ``mux-state-names``
- ``string-array``
- .. code-block:: none
Optional names for the entries in "mux-states"
.. 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 "nxp,mcux-eqdc" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``reg``
- ``array``
- .. code-block:: none
Information used to address the device. The value is specific to
the device (i.e. is different depending on the compatible
property).
The "reg" property is typically a sequence of (address, length) pairs.
Each pair is called a "register block". Values are
conventionally written in hex.
For details, see "2.3.6 reg" in Devicetree Specification v0.4.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``interrupts``
- ``array``
- .. code-block:: none
Information about interrupts generated by the device, encoded as an array
of one or more interrupt specifiers. The format of the data in this property
varies by where the device appears in the interrupt tree. Devices with the same
"interrupt-parent" will use the same format in their interrupts properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``status``
- ``string``
- .. code-block:: none
Indicates the operational status of the hardware or other
resource that the node represents. In particular:
- "okay" means the resource is operational and, for example,
can be used by device drivers
- "disabled" means the resource is not operational and the system
should treat it as if it is not present
For details, see "2.3.4 status" in Devicetree Specification v0.4.
Legal values: ``okay``, ``disabled``, ``reserved``, ``fail``, ``fail-sss``
See :ref:`zephyr:dt-important-props` for more information.
* - ``compatible``
- ``string-array``
- .. code-block:: none
This property is a list of strings that essentially define what
type of hardware or other resource this devicetree node
represents. Each device driver checks for specific compatible
property values to find the devicetree nodes that represent
resources that the driver should manage.
The recommended format is "vendor,device", The "vendor" part is
an abbreviated name of the vendor. The "device" is usually from
the datasheet.
The compatible property can have multiple values, ordered from
most- to least-specific. Having additional values is useful when the
device is a specific instance of a more general family, to allow the
system to match the most specific driver available.
For details, see "2.3.1 compatible" in Devicetree Specification v0.4.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg-names``
- ``string-array``
- .. code-block:: none
Optional names given to each register block in the "reg" property.
For example:
/ {
soc {
#address-cells = <1>;
#size-cells = <1>;
uart@1000 {
reg = <0x1000 0x2000>, <0x3000 0x4000>;
reg-names = "foo", "bar";
};
};
};
The uart@1000 node has two register blocks:
- one with base address 0x1000, size 0x2000, and name "foo"
- another with base address 0x3000, size 0x4000, and name "bar"
* - ``ranges``
- ``compound``
- .. code-block:: none
Information used to define a mapping (or translation) between the address
space of a bus (the "child address space") and the address space of the
bus node's parent (the "parent address space").
The "ranges" property is typically empty, or a sequence of triplets
(child bus address, parent bus address, length).
If the "ranges" property is empty, it specifies that the parent and child
address spaces are identical and no address translation is required.
If the "ranges" property is not present in a bus node, it is assumed that
no mapping exists between children of the node and the parent address space.
For details, see "2.3.8 ranges" in Devicetree Specification v0.4.
* - ``interrupts-extended``
- ``compound``
- .. code-block:: none
Extended interrupt specifier for device, used as an alternative to
the "interrupts" property.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``interrupt-names``
- ``string-array``
- .. code-block:: none
Optional names given to each interrupt generated by a device.
The interrupts themselves are defined in either "interrupts" or
"interrupts-extended" properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``interrupt-parent``
- ``phandle``
- .. code-block:: none
If present, this refers to the node which handles interrupts generated
by this device.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``label``
- ``string``
- .. code-block:: none
Human readable string describing the device. Use of this property is
deprecated except as needed on a case-by-case basis.
For details, see "4.1.2 Miscellaneous Properties" in Devicetree
Specification v0.4.
See :ref:`zephyr:dt-important-props` for more information.
* - ``clocks``
- ``phandle-array``
- .. code-block:: none
Information about the device's clock providers. In general, this property
should follow conventions established in the dt-schema binding:
https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/clock/clock.yaml
* - ``clock-names``
- ``string-array``
- .. code-block:: none
Optional names given to each clock provider in the "clocks" property.
* - ``#address-cells``
- ``int``
- .. code-block:: none
This property encodes the number of cells used by address fields
in "reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
* - ``#size-cells``
- ``int``
- .. code-block:: none
This property encodes the number of cells used by size fields in
"reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
* - ``dma-coherent``
- ``boolean``
- .. code-block:: none
Indicates that the device is capable of coherent DMA operations.
For details, see "2.3.10 dma-coherent" in Devicetree Specification v0.4.
* - ``dmas``
- ``phandle-array``
- .. code-block:: none
DMA channel specifiers relevant to the device.
* - ``dma-names``
- ``string-array``
- .. code-block:: none
Optional names given to the DMA channel specifiers in the "dmas" property.
* - ``io-channels``
- ``phandle-array``
- .. code-block:: none
IO channel specifiers relevant to the device.
* - ``io-channel-names``
- ``string-array``
- .. code-block:: none
Optional names given to the IO channel specifiers in the "io-channels" property.
* - ``mboxes``
- ``phandle-array``
- .. code-block:: none
Mailbox / IPM channel specifiers relevant to the device.
* - ``mbox-names``
- ``string-array``
- .. code-block:: none
Optional names given to the mbox specifiers in the "mboxes" property.
* - ``power-domains``
- ``phandle-array``
- .. code-block:: none
Power domain specifiers relevant to the device.
* - ``power-domain-names``
- ``string-array``
- .. code-block:: none
Optional names given to the power domain specifiers in the "power-domains" property.
* - ``#power-domain-cells``
- ``int``
- .. code-block:: none
Number of cells in power-domains property
* - ``hwlocks``
- ``phandle-array``
- .. code-block:: none
HW spinlock id relevant to the device.
* - ``hwlock-names``
- ``string-array``
- .. code-block:: none
Optional names given to the hwlock specifiers in the "hwlocks" property.
* - ``zephyr,deferred-init``
- ``boolean``
- .. code-block:: none
Do not initialize device automatically on boot. Device should be manually
initialized using device_init().
* - ``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.
* - ``zephyr,pm-device-runtime-auto``
- ``boolean``
- .. code-block:: none
Automatically configure the device for runtime power management after the
init function runs.
* - ``zephyr,disabling-power-states``
- ``phandles``
- .. code-block:: none
List of power states that will disable this device power.