pixart,pmw3610 (on spi bus)

Vendor: PixArt Imaging Inc.

Note

An implementation of a driver matching this compatible is available in drivers/input/input_pmw3610.c.

Description

PMW3610 Low Power Laser Mouse Sensor

Properties

Properties not inherited from the base binding file.

Name

Type

Details

motion-gpios

phandle-array

 
GPIO connected to the motion pin, active low.

This property is required.

reset-gpios

phandle-array

 
GPIO connected to the reset pin, active low.

zephyr,axis-x

int

 
The input code for the X axis to report for the device, typically any of
INPUT_REL_*. No report produced for the device X axis if unspecified.

This property is required.

zephyr,axis-y

int

 
The input code for the Y axis to report for the device, typically any of
INPUT_REL_*. No report produced for the device Y axis if unspecified.

This property is required.

res-cpi

int

 
CPI resolution for the sensor, range from 200 to 3200, rounded down to
the closest supported value in increments of 200. This can also be
changed in runtime using the pmw3610_set_resolution() API.

invert-x

boolean

 
Invert X axis values.

invert-y

boolean

 
Invert Y axis values.

force-awake

boolean

 
Initialize the sensor in "force awake" mode. This can also be enabled or
disabled in runtime by the application using the pmw3610_force_awake()
API.

smart-mode

boolean

 
Enable the "smart mode" algorithm as described in the device datasheet.
This should improve sensor tracking across a wider range of surfaces.

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.