st,lis2dh (on spi bus)

Vendor: STMicroelectronics N.V.

Note

An implementation of a driver matching this compatible is available in drivers/sensor/st/lis2dh/lis2dh.c.

Description

STMicroelectronics LIS2DH 3-axis accelerometer accessed through SPI bus

Properties

Node specific properties

Properties not inherited from the base binding file.

Name

Type

Details

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.

irq-gpios

phandle-array

 
The INT1 and (optional) INT2 signal connections.  These signals
are active-high as produced by the sensor.

int1-gpio-config

int

 
Select the interrupt configuration for INT1 gpio.

The default of 0 is the most common situation to avoid multiple interrupts
to be triggered by same event.

- 0 # LIS2DH_DT_GPIO_INT_EDGE_BOTH
- 1 # LIS2DH_DT_GPIO_INT_EDGE_RISING
- 2 # LIS2DH_DT_GPIO_INT_EDGE_FALLING
- 3 # LIS2DH_DT_GPIO_INT_LEVEL_HIGH
- 4 # LIS2DH_DT_GPIO_INT_LEVEL_LOW

Legal values: 0, 1, 2, 3, 4

int2-gpio-config

int

 
Select the interrupt configuration for INT2 gpio.

The default of 0 is the most common situation to avoid multiple interrupts
to be triggered by same event.

- 0 # LIS2DH_DT_GPIO_INT_EDGE_BOTH
- 1 # LIS2DH_DT_GPIO_INT_EDGE_RISING
- 2 # LIS2DH_DT_GPIO_INT_EDGE_FALLING
- 3 # LIS2DH_DT_GPIO_INT_LEVEL_HIGH
- 4 # LIS2DH_DT_GPIO_INT_LEVEL_LOW

Legal values: 0, 1, 2, 3, 4

disconnect-sdo-sa0-pull-up

boolean

 
Indicates the device driver should disconnect SDO/SA0 pull-up
during device initialization (e.g. to save current
leakage). Note that only subset of devices supported by this
binding have SDO/SA0 pull-up (e.g. LIS2DH12, LIS3DH).

anym-on-int1

boolean

 
Indicates that the device driver should use interrupt 1
for any movement. This is for boards that only have one
interrupt line connected from the sensor to the processor.

anym-no-latch

boolean

 
Disable the latching of interrupts for any movement.

anym-mode

int

 
Select the interrupt mode for any movement.

The default of 0 is the power-on-reset value.

- 0 # LIS2DH_DT_ANYM_OR_COMBINATION
- 1 # LIS2DH_DT_ANYM_6D_MOVEMENT
- 2 # LIS2DH_DT_ANYM_AND_COMBINATION
- 3 # LIS2DH_DT_ANYM_6D_POSITION

Legal values: 0, 1, 2, 3

friendly-name

string

 
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).

Deprecated node specific properties

Deprecated properties not inherited from the base binding file.

(None)

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,lis2dh” compatible.

Name

Type

Details

reg

array

 
register space

This property is required.

See Important properties for more information.

status

string

 
indicates the operational status of a device

Legal values: 'ok', 'okay', 'disabled', 'reserved', 'fail', 'fail-sss'

See Important properties for more information.

compatible

string-array

 
compatible strings

This property is required.

See Important properties for more information.

reg-names

string-array

 
name of each register space

interrupts

array

 
interrupts for device

See Important properties for more information.

interrupts-extended

compound

 
extended interrupt specifier for device

interrupt-names

string-array

 
name of each interrupt

interrupt-parent

phandle

 
phandle to interrupt controller node

label

string

 
Human readable string describing the device (used as device_get_binding() argument)

See Important properties for more information.

This property is deprecated.

clocks

phandle-array

 
Clock gate information

clock-names

string-array

 
name of each clock

#address-cells

int

 
number of address cells in reg property

#size-cells

int

 
number of size cells in reg property

dmas

phandle-array

 
DMA channels specifiers

dma-names

string-array

 
Provided names of DMA channel specifiers

io-channels

phandle-array

 
IO channels specifiers

io-channel-names

string-array

 
Provided names of IO channel specifiers

mboxes

phandle-array

 
mailbox / IPM channels specifiers

mbox-names

string-array

 
Provided names of mailbox / IPM channel specifiers

power-domains

phandle-array

 
Power domain specifiers

power-domain-names

string-array

 
Provided names of power domain specifiers

#power-domain-cells

int

 
Number of cells in power-domains property

zephyr,deferred-init

boolean

 
Do not initialize device automatically on boot. Device should be manually
initialized using device_init().

wakeup-source

boolean

 
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

 
Automatically configure the device for runtime power management after the
init function runs.

zephyr,disabling-power-states

phandles

 
List of power states that will disable this device power.