pixart,pat9136 (on spi bus)

Vendor: PixArt Imaging Inc.

Note

An implementation of a driver matching this compatible is available in drivers/sensor/pixart/pat9136/pat9136.c.

Description

PAT9136 optical flow sensor

Properties

Properties not inherited from the base binding file.

Name

Type

Details

resolution

int

 
The resolution of the sensor which indirectly results in counts per inch
(CPI), following the formula CPI = (1 + resolution) * 100.
Valid range is 0 to 199.
Default is value set during Performance Optimization Settings.

Default value: 19

int-gpios

phandle-array

 
The INT signal default configuration is active-low. The
property value should ensure the flags properly describe the
signal that is presented to the driver.

backup-timer-ms

int

 
The back-up timer in milliseconds used to ensure sensor interaction
even if no motion is present, when Data-Ready streaming trigger is
configured.
Default is 1000X the fastest frame rate (20,000 fps).

Default value: 50

cooldown-timer-ms

int

 
The cooldown timer in milliseconds used to prevent flooding the system
with interrupts (potentially at max 20,000 fps) while Data-Ready
streaming trigger is configured.
Default is 200X the fastest frame rate (20,000 fps).
Must be less than backup-timer-ms.

Default value: 10

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

spi-max-frequency

int

 
Maximum clock frequency of device's SPI interface in Hz

This property is required.

duplex

int

 
Duplex mode, full or half. By default it's always full duplex thus 0
as this is, by far, the most common mode.
Use the macros not the actual enum value, here is the concordance
list (see dt-bindings/spi/spi.h)
  0    SPI_FULL_DUPLEX
  2048 SPI_HALF_DUPLEX

Legal values: 0, 2048

frame-format

int

 
Motorola or TI frame format. By default it's always Motorola's,
thus 0 as this is, by far, the most common format.
Use the macros not the actual enum value, here is the concordance
list (see dt-bindings/spi/spi.h)
  0     SPI_FRAME_FORMAT_MOTOROLA
  32768 SPI_FRAME_FORMAT_TI

Legal values: 0, 32768

spi-cpol

boolean

 
SPI clock polarity which indicates the clock idle state.
If it is used, the clock idle state is logic high; otherwise, low.

spi-cpha

boolean

 
SPI clock phase that indicates on which edge data is sampled.
If it is used, data is sampled on the second edge; otherwise, on the first edge.

spi-hold-cs

boolean

 
In some cases, it is necessary for the master to manage SPI chip select
under software control, so that multiple spi transactions can be performed
without releasing it. A typical use case is variable length SPI packets
where the first spi transaction reads the length and the second spi transaction
reads length bytes.

supply-gpios

phandle-array

 
GPIO specifier that controls power to the device.

This property should be provided when the device has a dedicated
switch that controls power to the device.  The supply state is
entirely the responsibility of the device driver.

Contrast with vin-supply.

vin-supply

phandle

 
Reference to the regulator that controls power to the device.
The referenced devicetree node must have a regulator compatible.

This property should be provided when device power is supplied
by a shared regulator.  The supply state is dependent on the
request status of all devices fed by the regulator.

Contrast with supply-gpios.  If both properties are provided
then the regulator must be requested before the supply GPIOS is
set to an active state, and the supply GPIOS must be set to an
inactive state before releasing the regulator.