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 list at the bottom of the left panel and select the desired version.

cirque,pinnacle (on spi bus)

Vendor: Cirque Corporation

Description

Cirque Pinnacle 1CA027 ASIC trackpad connected through SPI

Properties

Properties not inherited from the base binding file.

Name

Type

Details

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.

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.

data-ready-gpios

phandle-array

Data Ready (DR) GPIO pin. The DR pin is connected to Pinnacle HW_DR
which is active high when SW_DR or SW_CC are asserted. If connected
directly, the MCU pin should be configured as active low.

sensitivity

string

ADC attenuation, 1x is the most sensitive and 4x is the least sensitive.

Default value: 4x

Legal values: '1x', '2x', '3x', '4x'

data-mode

string

Data output mode in which position is reported. In the relative mode
each position is reported as relative to the last position. In the
absolute mode absolute coordinates are reported.

Default value: relative

Legal values: 'absolute', 'relative'

idle-packets-count

int

The number of empty packets where both X and Y are set to 0. They are
started to be sent when a finger presence is detected missing (no touch
detected) every 10 ms. They are stopped to be sent when a finger presence
it detected. An application can count these packets in order to detect
taps. When set to 0, no empty packets are sent. Supported values from 0
to 255.

clipping-enable

boolean

In the absolute mode enable clipping of reported coordinates which are
outside of the active range.

active-range-x-min

int

The minimum X value which can be reported.

Default value: 128

active-range-x-max

int

The maximum X value which can be reported.

Default value: 1920

active-range-y-min

int

The minimum Y value which can be reported.

Default value: 64

active-range-y-max

int

The maximum Y value which can be reported.

Default value: 1472

scaling-enable

boolean

In the absolute mode enable scaling of coordinates according to
the specified resolution for X and Y axises. The scaling is applied only
when the clipping is enabled.

scaling-x-resolution

int

Resolution for the X axis.

Default value: 1024

scaling-y-resolution

int

Resolution for the Y axis.

Default value: 1024

invert-x

boolean

In the absolute mode invert X coordinate.

invert-y

boolean

In the absolute mode invert Y coordinate.

primary-tap-enable

boolean

In the relative mode enable the primary tap.

swap-xy

boolean

In the relative mode swap X and Y coordinates. This is equivalent for
rotating coordinates by 90 degrees.