st,lsm6dso (on spi bus)

Vendor: STMicroelectronics

Note

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

Description

STMicroelectronics LSM6DSO 6-axis IMU (Inertial Measurement Unit) sensor
accessed through SPI bus

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

 
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.

int-pin

int

 
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.

Default value: 1

Legal values: 1, 2

accel-pm

int

 
Specify the accelerometer power mode.
Default is power-up configuration.

- 0 # LSM6DSO_DT_XL_HP_MODE
- 1 # LSM6DSO_DT_XL_LP_NORMAL_MODE
- 2 # LSM6DSO_DT_XL_ULP_MODE

Legal values: 0, 1, 2

accel-range

int

 
Range in g. Default is power-up configuration.

- 0 # LSM6DSO_DT_FS_2G  (0.061 mg/LSB) (LSM6DSO32 will be double these values)
- 1 # LSM6DSO_DT_FS_16G (0.488 mg/LSB)
- 2 # LSM6DSO_DT_FS_4G  (0.122 mg/LSB)
- 3 # LSM6DSO_DT_FS_8G  (0.244 mg/LSB)

Legal values: 0, 1, 2, 3

accel-odr

int

 
Specify the default accelerometer output data rate expressed in samples per second (Hz).
Default is power-up configuration.

- 0  # LSM6DSO_DT_ODR_OFF
- 1  # LSM6DSO_DT_ODR_12Hz5
- 2  # LSM6DSO_DT_ODR_26H
- 3  # LSM6DSO_DT_ODR_52Hz
- 4  # LSM6DSO_DT_ODR_104Hz
- 5  # LSM6DSO_DT_ODR_208Hz
- 6  # LSM6DSO_DT_ODR_417Hz
- 7  # LSM6DSO_DT_ODR_833Hz
- 8  # LSM6DSO_DT_ODR_1667Hz
- 9  # LSM6DSO_DT_ODR_3333Hz
- 10 # LSM6DSO_DT_ODR_6667Hz
- 11 # LSM6DSO_DT_ODR_1Hz6

Legal values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11

gyro-pm

int

 
Specify the gyrometer power mode.
Default is power-up configuration.

- 0 # LSM6DSO_DT_GY_HP_MODE
- 1 # LSM6DSO_DT_GY_NORMAL_MODE

Legal values: 0, 1

gyro-range

int

 
Range in dps. Default is power-up configuration.

- 0 # LSM6DSO_DT_FS_250DPS  (8.75 mdps/LSB)
- 1 # LSM6DSO_DT_FS_125DPS  (4.375 mdps/LSB)
- 2 # LSM6DSO_DT_FS_500DPS  (17.50 mdps/LSB)
- 4 # LSM6DSO_DT_FS_1000DPS (35 mdps/LSB)
- 6 # LSM6DSO_DT_FS_2000DPS (70 mdps/LSB)

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

gyro-odr

int

 
Specify the default gyro output data rate expressed in samples per second (Hz).
Default is power-up configuration.

- 0  # LSM6DSO_DT_ODR_OFF
- 1  # LSM6DSO_DT_ODR_12Hz5
- 2  # LSM6DSO_DT_ODR_26H
- 3  # LSM6DSO_DT_ODR_52Hz
- 4  # LSM6DSO_DT_ODR_104Hz
- 5  # LSM6DSO_DT_ODR_208Hz
- 6  # LSM6DSO_DT_ODR_417Hz
- 7  # LSM6DSO_DT_ODR_833Hz
- 8  # LSM6DSO_DT_ODR_1667Hz
- 9  # LSM6DSO_DT_ODR_3333Hz
- 10 # LSM6DSO_DT_ODR_6667Hz

Legal values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10

drdy-pulsed

boolean

 
Selects the pulsed mode for data-ready interrupt when enabled,
and the latched mode when disabled.

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