Documentation/devicetree/bindings/iio/magnetometer/ti,tmag5273.yaml

# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/iio/magnetometer/ti,tmag5273.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: TI TMAG5273 Low-Power Linear 3D Hall-Effect Sensor

maintainers:
  - Gerald Loacker <gerald.loacker@wolfvision.net>

description:
  The TI TMAG5273 is a low-power linear 3D Hall-effect sensor. This device
  integrates three independent Hall-effect sensors in the X, Y, and Z axes.
  The device has an integrated temperature sensor available. The TMAG5273
  can be configured through the I2C interface to enable any combination of
  magnetic axes and temperature measurements. An integrated angle calculation
  engine (CORDIC) provides full 360° angular position information for both
  on-axis and off-axis angle measurement topologies. The angle calculation is
  performed using two user-selected magnetic axes.

properties:
  compatible:
    const: ti,tmag5273

  reg:
    maxItems: 1

  "#io-channel-cells":
    const: 1

  ti,angle-measurement:
    $ref: /schemas/types.yaml#/definitions/string
    description:
      Enables angle measurement in the selected plane.
      If not specified, "x-y" will be anables as default.
    enum:
      - off
      - x-y
      - y-z
      - x-z

  vcc-supply:
    description:
      A regulator providing 1.7 V to 3.6 V supply voltage on the VCC pin,
      typically 3.3 V.

  interrupts:
    description:
      The low active interrupt can be configured to be fixed width or latched.
      Interrupt events can be configured to be generated from magnetic
      thresholds or when a conversion is completed.
    maxItems: 1

required:
  - compatible
  - reg

additionalProperties: false

examples:
  - |
    i2c {
        #address-cells = <1>;
        #size-cells = <0>;

        magnetometer@35 {
            compatible = "ti,tmag5273";
            reg = <0x35>;
            #io-channel-cells = <1>;
            ti,angle-measurement = "x-z";
            vcc-supply = <&vcc3v3>;
        };
    };
...