:orphan:
.. raw:: html
.. _dtbinding_we_wsen_itds_2533020201601_i2c:
we,wsen-itds-2533020201601 (on i2c bus)
#######################################
Vendor: :ref:`Würth Elektronik GmbH. `
.. note::
An implementation of a driver matching this compatible is available in
:zephyr_file:`drivers/sensor/wsen/wsen_itds_2533020201601/wsen_itds_2533020201601.c`.
Description
***********
.. code-block:: none
Würth Elektronik WSEN-ITDS-2533020201601 acceleration sensor with
integrated temperature sensor (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.
* - ``events-interrupt-gpios``
- ``phandle-array``
- .. code-block:: none
Events Interrupt pin (Tap, Freefall, .. etc) (INT0 Pin).
Interrupts are active high by default.
* - ``drdy-interrupt-gpios``
- ``phandle-array``
- .. code-block:: none
DRDY Interrupt pin (INT1 Pin).
Interrupts are active high by default.
* - ``odr``
- ``string``
- .. code-block:: none
Output data rate in Hz Note that the available output data rates depend on the selected operating mode. In high performance mode the output data rate of the sensor can be configured between 12.5 Hz and 1600 Hz. In normal/low power mode the output data rate of the sensor can be configured between 1.6 Hz and 200 Hz. Consult the ITDS user manual for more information. Also note that the minimum ODR required for using the tap recognition functionality is 400 Hz.
This property is **required**.
Legal values: ``'1.6'``, ``'12.5'``, ``'25'``, ``'50'``, ``'100'``, ``'200'``, ``'400'``, ``'800'``, ``'1600'``
* - ``op-mode``
- ``string``
- .. code-block:: none
Operating mode of the sensor.
This property is **required**.
Legal values: ``'low-power/normal'``, ``'high-perf'``, ``'single-conversion'``
* - ``power-mode``
- ``string``
- .. code-block:: none
Power mode of the sensor.
This property is **required**.
Legal values: ``'low-power'``, ``'normal'``
* - ``range``
- ``int``
- .. code-block:: none
Range (full scale) in g. Defaults to 2, which is the configuration at power-up.
Default value: ``2``
Legal values: ``16``, ``8``, ``4``, ``2``
* - ``low-noise``
- ``boolean``
- .. code-block:: none
Enables low-noise mode.
* - ``tap-mode``
- ``int``
- .. code-block:: none
Tap mode (only single tap or single and double tap). Defaults to 0, which is the configuration at power-up.
Legal values: ``0``, ``1``
* - ``tap-threshold``
- ``array``
- .. code-block:: none
Tap X/Y/Z axis thresholds (unsigned 5-bit, ranging from 0x00 to 0x1F).
Defaults to "<0>, <0>, <0>", which is the configuration at power-up.
Thresholds for tap recognition on the X/Y/Z axes corresponding to a
2g full-scale range. Setting a threshold to zero disables tap
detection on the corresponding axis.
Example:
tap-threshold = <0>, <6>, <10>
This disables tap recognition on X axis and sets thresholds for Y and Z
as follows: Y = 6 \* 2g/32 = 375mg and Z = 10 \* 2g/32 = 625mg.
Default value: ``[0, 0, 0]``
* - ``tap-shock``
- ``int``
- .. code-block:: none
Maximum duration of over-threshold event when detecting taps (unsigned
2-bit, ranging from 0x0 to 0x3). Defaults to zero, which is the
configuration at power-up.
A value of 0 corresponds to 4 \* 1/ODR and 1 LSB = 8 \* 1/ODR.
* - ``tap-latency``
- ``int``
- .. code-block:: none
Maximum duration time gap for double-tap recognition (unsigned 4-bit,
ranging from 0x0 to 0xF). Defaults to zero, which is the
configuration at power-up.
A value of 0 corresponds to 16 \* 1/ODR and 1 LSB = 32 \* 1/ODR.
* - ``tap-quiet``
- ``int``
- .. code-block:: none
Expected quiet time for double-tap recognition (unsigned 2-bit, ranging
from 0x0 to 0x3). This defines the time after the first detected tap in
which there must not be any over-threshold event. Defaults to zero, which
is the configuration at power-up.
A value of 0 corresponds to 2 \* 1/ODR and 1 LSB = 4 \* 1/ODR.
* - ``freefall-duration``
- ``int``
- .. code-block:: none
Minimum duration of free-fall event (unsigned 6-bit, ranging from 0x0
to 0x3F). Defaults to 0, which is the configuration at power-up.
1 LSB = 1 \* 1/ODR.
* - ``freefall-threshold``
- ``int``
- .. code-block:: none
Free-fall threshold (amplitude of the "free-fall zone" around zero-g
level where the accelerations of all axes are small enough to generate
the free-fall interrupt). Defaults to 0x5, which is the configuration
at power-up.
Multiply by 31.25mg to get the used threshold.
Default value: ``5``
Legal values: ``5``, ``7``, ``8``, ``10``, ``11``, ``13``, ``15``, ``16``
* - ``delta-duration``
- ``int``
- .. code-block:: none
Wake-up duration, i.e. minimum duration of wake-up event to be
recognized (unsigned 2-bit, ranging from 0x0 to 0x3).
Defaults to 0, which is the configuration at power-up.
1 LSB = 1 \* 1/ODR
Legal values: ``0``, ``1``, ``2``, ``3``
* - ``delta-threshold``
- ``int``
- .. code-block:: none
Wake-up threshold (unsigned 6-bit, ranging from 0x0 to 0x3F).
The threshold value is applicable to both positive and negative
acceleration data. A wake-up event is recognized, if at least
one of the acceleration axis values exceeds the threshold value.
Defaults to 0, which is the configuration at power-up.
1 LSB = 1/64 of measurement range (full scale).
* - ``delta-offsets``
- ``array``
- .. code-block:: none
Wake-up X/Y/Z axis offsets (signed 8-bit, ranging from -128 to 127).
Defaults to "<0>, <0>, <0>", which is the configuration at power-up.
The weight of the offsets depends on the delta-offset-weight property.
E.g. for delta-offset-weight=<1>, an offset value of 0x40 corresponds
to approximately 1g.
Default value: ``[0, 0, 0]``
* - ``delta-offset-weight``
- ``int``
- .. code-block:: none
Wake-up offset weight (0 or 1).
Weight of the offsets specified in the delta-offsets property.
Defaults to 0, which is the configuration at power-up.
A value of 0 corresponds to 0.977 mg/LSB, a value of 1
corresponds to 15.6 mg/LSB.
Legal values: ``0``, ``1``
.. 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 "we,wsen-itds-2533020201601" 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 the hardware or other
resource that the node represents. In particular:
- "okay" means the resource is operational and, for example,
can be used by device drivers
- "disabled" means the resource is not operational and the system
should treat it as if it is not present
For details, see "2.3.4 status" in Devicetree Specification v0.4.
Legal values: ``'ok'``, ``'okay'``, ``'disabled'``, ``'reserved'``, ``'fail'``, ``'fail-sss'``
See :ref:`zephyr:dt-important-props` for more information.
* - ``compatible``
- ``string-array``
- .. code-block:: none
This property is a list of strings that essentially define what
type of hardware or other resource this devicetree node
represents. Each device driver checks for specific compatible
property values to find the devicetree nodes that represent
resources that the driver should manage.
The recommended format is "vendor,device", The "vendor" part is
an abbreviated name of the vendor. The "device" is usually from
the datasheet.
The compatible property can have multiple values, ordered from
most- to least-specific. Having additional values is useful when the
device is a specific instance of a more general family, to allow the
system to match the most specific driver available.
For details, see "2.3.1 compatible" in Devicetree Specification v0.4.
This property is **required**.
See :ref:`zephyr:dt-important-props` for more information.
* - ``reg-names``
- ``string-array``
- .. code-block:: none
Optional names given to each register block in the "reg" property.
For example:
/ {
soc {
#address-cells = <1>;
#size-cells = <1>;
uart@1000 {
reg = <0x1000 0x2000>, <0x3000 0x4000>;
reg-names = "foo", "bar";
};
};
};
The uart@1000 node has two register blocks:
- one with base address 0x1000, size 0x2000, and name "foo"
- another with base address 0x3000, size 0x4000, and name "bar"
* - ``interrupts``
- ``array``
- .. code-block:: none
Information about interrupts generated by the device, encoded as an array
of one or more interrupt specifiers. The format of the data in this property
varies by where the device appears in the interrupt tree. Devices with the same
"interrupt-parent" will use the same format in their interrupts properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
See :ref:`zephyr:dt-important-props` for more information.
* - ``interrupts-extended``
- ``compound``
- .. code-block:: none
Extended interrupt specifier for device, used as an alternative to
the "interrupts" property.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``interrupt-names``
- ``string-array``
- .. code-block:: none
Optional names given to each interrupt generated by a device.
The interrupts themselves are defined in either "interrupts" or
"interrupts-extended" properties.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``interrupt-parent``
- ``phandle``
- .. code-block:: none
If present, this refers to the node which handles interrupts generated
by this device.
For details, see "2.4 Interrupts and Interrupt Mapping" in
Devicetree Specification v0.4.
* - ``label``
- ``string``
- .. code-block:: none
Human readable string describing the device. Use of this property is
deprecated except as needed on a case-by-case basis.
For details, see "4.1.2 Miscellaneous Properties" in Devicetree
Specification v0.4.
See :ref:`zephyr:dt-important-props` for more information.
* - ``clocks``
- ``phandle-array``
- .. code-block:: none
Information about the device's clock providers. In general, this property
should follow conventions established in the dt-schema binding:
https://github.com/devicetree-org/dt-schema/blob/main/dtschema/schemas/clock/clock.yaml
* - ``clock-names``
- ``string-array``
- .. code-block:: none
Optional names given to each clock provider in the "clocks" property.
* - ``#address-cells``
- ``int``
- .. code-block:: none
This property encodes the number of cells used by address fields
in "reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
* - ``#size-cells``
- ``int``
- .. code-block:: none
This property encodes the number of cells used by size fields in
"reg" properties in this node's children.
For details, see "2.3.5 #address-cells and #size-cells" in Devicetree
Specification v0.4.
* - ``dmas``
- ``phandle-array``
- .. code-block:: none
DMA channel specifiers relevant to the device.
* - ``dma-names``
- ``string-array``
- .. code-block:: none
Optional names given to the DMA channel specifiers in the "dmas" property.
* - ``io-channels``
- ``phandle-array``
- .. code-block:: none
IO channel specifiers relevant to the device.
* - ``io-channel-names``
- ``string-array``
- .. code-block:: none
Optional names given to the IO channel specifiers in the "io-channels" property.
* - ``mboxes``
- ``phandle-array``
- .. code-block:: none
Mailbox / IPM channel specifiers relevant to the device.
* - ``mbox-names``
- ``string-array``
- .. code-block:: none
Optional names given to the mbox specifiers in the "mboxes" property.
* - ``power-domains``
- ``phandle-array``
- .. code-block:: none
Power domain specifiers relevant to the device.
* - ``power-domain-names``
- ``string-array``
- .. code-block:: none
Optional names given to the power domain specifiers in the "power-domains" property.
* - ``#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.