This is the documentation for the latest (main) development branch of Zephyr. If you are looking for the documentation of previous releases, use the drop-down menu on the left and select the desired version.

nxp,mcux-qdec

Vendor: NXP Semiconductors

Description

NXP MCUX QDEC

Properties

Properties not inherited from the base binding file.

Name

Type

Details

counts-per-revolution

int

This is a number that is used to determine how many revolutions
were done based on the current counter's value.

This property is required.

single-phase-mode

boolean

Bypass the quadrature decoder. A positive transition of the PHASEA input
generates a count signal. The PHASEB input and the REV bit control the
counter direction.

filter-count

int

The number of consecutive samples that must agree prior to the input
filter accepting an input transition. A value of 0 represents 3
samples. A value of 7 represents 10 samples.

Legal values: 0, 1, 2, 3, 4, 5, 6, 7

filter-sample-period

int

The sampling period (in IPBus clock cycles) of the decoder input signals.
Each input is sampled multiple times at the rate specified by the Filter
Sample Period. If FILT_PER is 0 (default), then the input filter is
bypassed. Bypassing the digital filter enables the position/position
difference counters to operate with count rates up to the IPBus
frequency. Turning on the input filter introduces a latency of:
((FILT_CNT + 3) * FILT_PER) FILT clock cycles + 2 IPBus clock periods.

xbar

phandle

The xbar phandle.

This property is required.

pinctrl-0

phandles

Pin configuration/s for the first state. Content is specific to the
selected pin controller driver implementation.

pinctrl-1

phandles

Pin configuration/s for the second state. See pinctrl-0.

pinctrl-2

phandles

Pin configuration/s for the third state. See pinctrl-0.

pinctrl-3

phandles

Pin configuration/s for the fourth state. See pinctrl-0.

pinctrl-4

phandles

Pin configuration/s for the fifth state. See pinctrl-0.

pinctrl-names

string-array

Names for the provided states. The number of names needs to match the
number of states.

friendly-name

string

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