:orphan:
.. raw:: html
.. _dtbinding_st_iis2dlpc_i2c:
st,iis2dlpc (on i2c bus)
########################
Vendor: :ref:`STMicroelectronics `
Description
***********
.. code-block:: none
STMicroelectronics IIS2DLPC accelerometer accessed through I2C bus
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.
* - ``drdy-gpios``
- ``phandle-array``
- .. code-block:: none
DRDY pin
This pin defaults to active high when produced by the sensor.
The property value should ensure the flags properly describe
the signal that is presented to the driver.
* - ``drdy-int``
- ``int``
- .. code-block:: none
Select DRDY pin number (1 or 2).
This number represents which of the two interrupt pins
(INT1 or INT2) the drdy line is attached to. This property is not
mandatory and if not present it defaults to 1 which is the
configuration at power-up.
- 1 # drdy is generated from INT1
- 2 # drdy is generated from INT2
Default value: ``1``
Legal values: ``1``, ``2``
* - ``range``
- ``int``
- .. code-block:: none
Range in g. Default is power-up configuration.
- 16 # 16g (1.952 mg/LSB)
- 8 # 8g (0.976 mg/LSB)
- 4 # 4g (0.488 mg/LSB)
- 2 # 2g (0.244 mg/LSB)
Default value: ``2``
Legal values: ``16``, ``8``, ``4``, ``2``
* - ``power-mode``
- ``int``
- .. code-block:: none
Specify the sensor power mode. Default is power-up configuration.
- 0 # IIS2DLPC_DT_LP_M1
- 1 # IIS2DLPC_DT_LP_M2
- 2 # IIS2DLPC_DT_LP_M3
- 3 # IIS2DLPC_DT_LP_M4
- 4 # IIS2DLPC_DT_HP_MODE
Legal values: ``0``, ``1``, ``2``, ``3``, ``4``
* - ``tap-mode``
- ``int``
- .. code-block:: none
Tap mode. Default is power-up configuration.
- 0 # IIS2DLPC_DT_SINGLE_TAP
- 1 # IIS2DLPC_DT_SINGLE_DOUBLE_TAP
Legal values: ``0``, ``1``
* - ``tap-threshold``
- ``array``
- .. code-block:: none
Tap X/Y/Z axes threshold. Default is power-up configuration.
(X/Y/Z values range from 0x00 to 0x1F)
Thresholds to start the tap-event detection procedure on the X/Y/Z axes.
Threshold values for each axis are unsigned 5-bit corresponding
to a 2g acceleration full-scale range. A threshold value equal to zero
corresponds to disable the tap detection on that axis.
For example, if you want to set the threshold for X to 12, for Z to 14
and want to disable tap detection on Y, you should specify in Device Tree
tap-threshold = <12>, <0>, <14>
which is equivalent to X = 12 * 2g/32 = 750mg and Z = 14 * 2g/32 = 875mg.
Default value: ``[0, 0, 0]``
* - ``tap-shock``
- ``int``
- .. code-block:: none
Tap shock value. Default is power-up configuration.
(values range from 0x0 to 0x3)
This register represents the maximum time of an over-threshold signal
detection to be recognized as a tap event. Where 0 equals 4*1/ODR and
1LSB = 8*1/ODR.
* - ``tap-latency``
- ``int``
- .. code-block:: none
Tap latency. Default is power-up configuration.
(values range from 0x0 to 0xF)
When double-tap recognition is enabled, this register expresses the
maximum time between two successive detected taps to determine a
double-tap event. Where 0 equals 16*1/ODR and 1LSB = 32*1/ODR.
* - ``tap-quiet``
- ``int``
- .. code-block:: none
Expected quiet time after a tap detection. Default is power-up configuration.
(values range from 0x0 to 0x3)
This register represents the time after the first detected tap in which
there must not be any overthreshold event. Where 0 equals 2*1/ODR
and 1LSB = 4*1/ODR.
* - ``friendly-name``
- ``string``
- .. code-block:: none
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).
.. 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 "st,iis2dlpc" 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:`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:`dt-important-props` for more information.
* - ``compatible``
- ``string-array``
- .. code-block:: none
compatible strings
This property is **required**.
See :ref:`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:`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:`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
* - ``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.
* - ``power-domain``
- ``phandle``
- .. code-block:: none
Power domain the device belongs to.
The device will be notified when the power domain it belongs to is either
suspended or resumed.
* - ``zephyr,pm-device-runtime-auto``
- ``boolean``
- .. code-block:: none
Automatically configure the device for runtime power management after the
init function runs.