:orphan:
.. raw:: html
.. _dtbinding_cirque_pinnacle_i2c:
cirque,pinnacle (on i2c bus)
############################
Vendor: :ref:`Cirque Corporation `
.. note::
An implementation of a driver matching this compatible is available in
:zephyr_file:`drivers/input/input_pinnacle.c`.
Description
***********
.. code-block:: none
Cirque Pinnacle 1CA027 ASIC trackpad connected through I2C
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
* - ``supply-gpios``
- ``phandle-array``
- .. code-block:: none
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``
- .. code-block:: none
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.
* - ``data-ready-gpios``
- ``phandle-array``
- .. code-block:: none
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``
- .. code-block:: none
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``
- .. code-block:: none
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``
- .. code-block:: none
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``
- .. code-block:: none
In the absolute mode enable clipping of reported coordinates which are
outside of the active range.
* - ``active-range-x-min``
- ``int``
- .. code-block:: none
The minimum X value which can be reported.
Default value: ``128``
* - ``active-range-x-max``
- ``int``
- .. code-block:: none
The maximum X value which can be reported.
Default value: ``1920``
* - ``active-range-y-min``
- ``int``
- .. code-block:: none
The minimum Y value which can be reported.
Default value: ``64``
* - ``active-range-y-max``
- ``int``
- .. code-block:: none
The maximum Y value which can be reported.
Default value: ``1472``
* - ``scaling-enable``
- ``boolean``
- .. code-block:: none
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``
- .. code-block:: none
Resolution for the X axis.
Default value: ``1024``
* - ``scaling-y-resolution``
- ``int``
- .. code-block:: none
Resolution for the Y axis.
Default value: ``1024``
* - ``invert-x``
- ``boolean``
- .. code-block:: none
In the absolute mode invert X coordinate.
* - ``invert-y``
- ``boolean``
- .. code-block:: none
In the absolute mode invert Y coordinate.
* - ``primary-tap-enable``
- ``boolean``
- .. code-block:: none
In the relative mode enable the primary tap.
* - ``swap-xy``
- ``boolean``
- .. code-block:: none
In the relative mode swap X and Y coordinates. This is equivalent for
rotating coordinates by 90 degrees.
.. 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 "cirque,pinnacle" compatible.
.. list-table::
:widths: 1 1 4
:header-rows: 1
* - Name
- Type
- Details
* - ``reg``
- ``array``
- .. code-block:: none
device address on i2c bus
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``status``
- ``string``
- .. code-block:: none
indicates the operational status of a device
Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``
See :ref:`zephyr:dt-important-props` for more information.
* - ``compatible``
- ``string-array``
- .. code-block:: none
compatible strings
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg-names``
- ``string-array``
- .. code-block:: none
name of each register space
* - ``interrupts``
- ``array``
- .. code-block:: none
interrupts for device
See :ref:`zephyr:dt-important-props` for more information.
* - ``interrupts-extended``
- ``compound``
- .. code-block:: none
extended interrupt specifier for device
* - ``interrupt-names``
- ``string-array``
- .. code-block:: none
name of each interrupt
* - ``interrupt-parent``
- ``phandle``
- .. code-block:: none
phandle to interrupt controller node
* - ``label``
- ``string``
- .. code-block:: none
Human readable string describing the device (used as device_get_binding() argument)
See :ref:`zephyr:dt-important-props` for more information.
This property is **deprecated**.
* - ``clocks``
- ``phandle-array``
- .. code-block:: none
Clock gate information
* - ``clock-names``
- ``string-array``
- .. code-block:: none
name of each clock
* - ``#address-cells``
- ``int``
- .. code-block:: none
number of address cells in reg property
* - ``#size-cells``
- ``int``
- .. code-block:: none
number of size cells in reg property
* - ``dmas``
- ``phandle-array``
- .. code-block:: none
DMA channels specifiers
* - ``dma-names``
- ``string-array``
- .. code-block:: none
Provided names of DMA channel specifiers
* - ``io-channels``
- ``phandle-array``
- .. code-block:: none
IO channels specifiers
* - ``io-channel-names``
- ``string-array``
- .. code-block:: none
Provided names of IO channel specifiers
* - ``mboxes``
- ``phandle-array``
- .. code-block:: none
mailbox / IPM channels specifiers
* - ``mbox-names``
- ``string-array``
- .. code-block:: none
Provided names of mailbox / IPM channel specifiers
* - ``power-domains``
- ``phandle-array``
- .. code-block:: none
Power domain specifiers
* - ``power-domain-names``
- ``string-array``
- .. code-block:: none
Provided names of power domain specifiers
* - ``#power-domain-cells``
- ``int``
- .. code-block:: none
Number of cells in power-domains 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.