st,lsm9ds1_mag (on i2c bus)
Vendor: STMicroelectronics
Note
An implementation of a driver matching this compatible is available in drivers/sensor/st/lsm9ds1_mag/lsm9ds1_mag.c.
Description
STMicroelectronics LSM9DS1 9-axis IMU (Inertial Measurement Unit) sensor
accessed through I2C bus.
This binding describes only the magnetometer.
When setting the mag-range and mag-odr properties in
a .dts or .dtsi file you may include lsm9ds1.h and use the macros
defined here.
Example:
#include <zephyr/dt-bindings/sensor/lsm9ds1.h>
lsm9ds1_mag: lsm9ds1_mag@0 {
...
mag-range = <LSM9DS1_DT_FS_4Ga>;
mag-odr = <LSM9DS1_MAG_MP_40Hz>;
};
Properties
Properties not inherited from the base binding file.
Name |
Type |
Details |
|---|---|---|
|
|
Range of the magnetometer in gauss. Default is power-up configuration.
- 0 # LSM9DS1_DT_FS_4Ga (0.14 mgauss/LSB)
- 1 # LSM9DS1_DT_FS_8Ga (0.29 mgauss/LSB)
- 2 # LSM9DS1_DT_FS_12Ga (0.43 mgauss/LSB)
- 3 # LSM9DS1_DT_FS_16Ga (0.58 mgauss/LSB)
Legal values: |
|
|
Specify the default output data rate of the magnetometer (samples/second).
Default is power-up configuration.
- 0xC0 # LSM9DS1_MAG_POWER_DOWN
- 0x00 # LSM9DS1_MAG_LP_0Hz625
- 0x01 # LSM9DS1_MAG_LP_1Hz25
- 0x02 # LSM9DS1_MAG_LP_2Hz5
- 0x03 # LSM9DS1_MAG_LP_5Hz
- 0x04 # LSM9DS1_MAG_LP_10Hz
- 0x05 # LSM9DS1_MAG_LP_20Hz
- 0x06 # LSM9DS1_MAG_LP_40Hz
- 0x07 # LSM9DS1_MAG_LP_80Hz
- 0x10 # LSM9DS1_MAG_MP_0Hz625
- 0x11 # LSM9DS1_MAG_MP_1Hz25
- 0x12 # LSM9DS1_MAG_MP_2Hz5
- 0x13 # LSM9DS1_MAG_MP_5Hz
- 0x14 # LSM9DS1_MAG_MP_10Hz
- 0x15 # LSM9DS1_MAG_MP_20Hz
- 0x16 # LSM9DS1_MAG_MP_40Hz
- 0x17 # LSM9DS1_MAG_MP_80Hz
- 0x20 # LSM9DS1_MAG_HP_0Hz625
- 0x21 # LSM9DS1_MAG_HP_1Hz25
- 0x22 # LSM9DS1_MAG_HP_2Hz5
- 0x23 # LSM9DS1_MAG_HP_5Hz
- 0x24 # LSM9DS1_MAG_HP_10Hz
- 0x25 # LSM9DS1_MAG_HP_20Hz
- 0x26 # LSM9DS1_MAG_HP_40Hz
- 0x27 # LSM9DS1_MAG_HP_80Hz
- 0x30 # LSM9DS1_MAG_UHP_0Hz625
- 0x31 # LSM9DS1_MAG_UHP_1Hz25
- 0x32 # LSM9DS1_MAG_UHP_2Hz5
- 0x33 # LSM9DS1_MAG_UHP_5Hz
- 0x34 # LSM9DS1_MAG_UHP_10Hz
- 0x35 # LSM9DS1_MAG_UHP_20Hz
- 0x36 # LSM9DS1_MAG_UHP_40Hz
- 0x37 # LSM9DS1_MAG_UHP_80Hz
- 0x38 # LSM9DS1_MAG_UHP_155Hz
- 0x28 # LSM9DS1_MAG_HP_300Hz
- 0x18 # LSM9DS1_MAG_MP_560Hz
- 0x08 # LSM9DS1_MAG_LP_1000Hz
- 0x70 # LSM9DS1_MAG_ONE_SHOT
Legal values: |
|
|
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).
|
|
|
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.
|
|
|
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.
|
Deprecated properties not inherited from the base binding file.
(None)
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,lsm9ds1_mag” compatible.
Name |
Type |
Details |
|---|---|---|
|
|
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: See Important properties for more information. |
|
|
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 Important properties for more information. |
|
|
Information used to address the device. The value is specific to
the device (i.e. is different depending on the compatible
property).
The "reg" property is typically a sequence of (address, length) pairs.
Each pair is called a "register block". Values are
conventionally written in hex.
For details, see "2.3.6 reg" in Devicetree Specification v0.4.
This property is required. See Important properties for more information. |
|
|
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"
|
|
|
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 Important properties for more information. |
|
|
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.
|
|
|
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.
|
|
|
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.
|
|
|
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 Important properties for more information. |
|
|
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
|
|
|
Optional names given to each clock provider in the "clocks" property.
|
|
|
This property encodes the number of <u32> 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.
|
|
|
This property encodes the number of <u32> 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.
|
|
|
DMA channel specifiers relevant to the device.
|
|
|
Optional names given to the DMA channel specifiers in the "dmas" property.
|
|
|
IO channel specifiers relevant to the device.
|
|
|
Optional names given to the IO channel specifiers in the "io-channels" property.
|
|
|
Mailbox / IPM channel specifiers relevant to the device.
|
|
|
Optional names given to the mbox specifiers in the "mboxes" property.
|
|
|
Power domain specifiers relevant to the device.
|
|
|
Optional names given to the power domain specifiers in the "power-domains" property.
|
|
|
Number of cells in power-domains property
|
|
|
Do not initialize device automatically on boot. Device should be manually
initialized using device_init().
|
|
|
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.
|
|
|
Automatically configure the device for runtime power management after the
init function runs.
|
|
|
List of power states that will disable this device power.
|