This is the documentation for the latest (main) development branch of Zephyr. If you are looking for the documentation of previous releases, use the drop-down menu on the left and select the desired version.

bosch,bmi08x-accel (on spi bus)

Vendor: Bosch Sensortec GmbH

Description

BMI08X Accel inertial measurement unit

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.

int-gpios

phandle-array

This property specifies the connection for INT, because the
Zephyr driver maps all interrupts to INT.  The signal defaults
to output low when produced by the sensor.

int1-map-io

int

Bit[0]: Map Interrupt A to INT1, Accel Data Ready
Bit[1]: Map Interrupt B to INT1
Bit[2]: Map Interrupt C to INT1

int2-map-io

int

Bit[0]: Map Interrupt A to INT2, Accel Data Ready
Bit[1]: Map Interrupt B to INT2
Bit[2]: Map Interrupt C to INT2

int1-conf-io

int

Bit[0]: reserved
Bit[1]: if set to 1, INT1 is active high, otherwise it's active low
Bit[2]: if set to 1, INT1 is open-drain, otherwise it's push-pull
Bit[3]: if set to 1, enable INT1 as an output pin
Bit[4]: if set to 1, enable INT1 as an input pin
Bit[7:5] : reserved

int2-conf-io

int

Bit[0]: reserved
Bit[1]: if set to 1, INT2 is active high, otherwise it's active low
Bit[2]: if set to 1, INT2 is open-drain, otherwise it's push-pull
Bit[3]: if set to 1, enable INT2 as an output pin
Bit[4]: if set to 1, enable INT2 as an input pin
Bit[7:5] : reserved

accel-hz

string

Default frequency of accelerometer. (Unit - Hz)

This property is required.

Legal values: '12.5', '25', '50', '100', '200', '400', '800', '1600'

accel-fs

int

Default full scale of accelerometer. (Unit - g)

This property is required.

Legal values: 2, 3, 4, 6, 8, 12, 16, 24

data-sync

phandle

Enables data sync if defined. This is to point to the bmi08x-gyro definition
that is within the same IC as the bmi08x-accel.

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