nxp,fxos8700 (on spi bus)

Vendor: NXP Semiconductors

Description

FXOS8700 6-axis accelerometer/magnetometer sensor

Properties

Properties not inherited from the base binding file.

Name

Type

Details

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.

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.

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

reset-gpios

phandle-array

RST pin
This pin defaults to active high when consumed by the sensor.
The property value should ensure the flags properly describe
the signal that is presented to the driver.

int1-gpios

phandle-array

INT1 pin
This pin defaults to active low when produced by the sensor.
The property value should ensure the flags properly describe
the signal that is presented to the driver.

int2-gpios

phandle-array

INT2 pin
This pin defaults to active low when produced by the sensor.
The property value should ensure the flags properly describe
the signal that is presented to the driver.

range

int

Range in g

Default value: 8

Legal values: 8, 4, 2

power-mode

int

Power mode

Legal values: 0, 1, 2, 3

pulse-cfg

int

Pulse configuration register

Default value: 63

pulse-thsx

int

Pulse X-axis threshold
Threshold to start the pulse-event detection procedure on the X-axis.
Threshold values for each axis are unsigned 7-bit numbers with a fixed
resolution of 0.063 g/LSB, corresponding to an 8g acceleration
full-scale range.

Default value: 32

pulse-thsy

int

Pulse Y-axis threshold
Threshold to start the pulse-event detection procedure on the Y-axis.
Threshold values for each axis are unsigned 7-bit numbers with a fixed
resolution of 0.063 g/LSB, corresponding to an 8g acceleration
full-scale range.

Default value: 32

pulse-thsz

int

Pulse Z-axis threshold
Threshold to start the pulse-event detection procedure on the Z-axis.
Threshold values for each axis are unsigned 7-bit numbers with a fixed
resolution of 0.063 g/LSB, corresponding to an 8g acceleration
full-scale range.

Default value: 64

pulse-tmlt

int

Pulse time limit
The maximum time interval that can elapse between the start of the
acceleration on the selected channel exceeding the specified threshold
and the end when the channel acceleration goes back below the specified
threshold. The resolution depends upon the sample rate (ODR) and the
high-pass filter configuration (HP_FILTER_CUTOFF[pls_hpf_en]). For
ODR=800 Hz and pls_hpf_en=0, the resolution is 0.625 ms/LSB.

Default value: 24

pulse-ltcy

int

Pulse latency
The time interval that starts after the first pulse detection where the
pulse-detection function ignores the start of a new pulse. The
resolution depends upon the sample rate (ODR) and the high-pass filter
configuration (HP_FILTER_CUTOFF[pls_hpf_en]). For ODR=800 Hz and
pls_hpf_en=0, the resolution is 1.25 ms/LSB.

Default value: 40

pulse-wind

int

Pulse window
The maximum interval of time that can elapse after the end of the
latency interval in which the start of the second pulse event must be
detected provided the device has been configured for double pulse
detection. The detected second pulse width must be shorter than the
time limit constraint specified by the PULSE_TMLT register, but the end
of the double pulse need not finish within the time specified by the
PULSE_WIND register. The resolution depends upon the sample rate (ODR)
and the high-pass filter configuration (HP_FILTER_CUTOFF[pls_hpf_en]).
For ODR=800 Hz and pls_hpf_en=0, the resolution is 1.25 ms/LSB.

Default value: 60

mag-vecm-cfg

int

Magnetic vector-magnitude configuration register

Default value: 78

mag-vecm-ths-msb

int

Magnetic vector-magnitude threshold most significant byte.
Resolution is 0.1 uT/LSB.

mag-vecm-ths-lsb

int

Magnetic vector-magnitude threshold least significant byte.
Resolution is 0.1 uT/LSB.

Default value: 90