| Tom Rini | 53633a8 | 2024-02-29 12:33:36 -0500 | [diff] [blame] | 1 | # SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) |
| 2 | %YAML 1.2 |
| 3 | --- |
| 4 | $id: http://devicetree.org/schemas/iio/magnetometer/ti,tmag5273.yaml# |
| 5 | $schema: http://devicetree.org/meta-schemas/core.yaml# |
| 6 | |
| 7 | title: TI TMAG5273 Low-Power Linear 3D Hall-Effect Sensor |
| 8 | |
| 9 | maintainers: |
| 10 | - Gerald Loacker <gerald.loacker@wolfvision.net> |
| 11 | |
| 12 | description: |
| 13 | The TI TMAG5273 is a low-power linear 3D Hall-effect sensor. This device |
| 14 | integrates three independent Hall-effect sensors in the X, Y, and Z axes. |
| 15 | The device has an integrated temperature sensor available. The TMAG5273 |
| 16 | can be configured through the I2C interface to enable any combination of |
| 17 | magnetic axes and temperature measurements. An integrated angle calculation |
| 18 | engine (CORDIC) provides full 360° angular position information for both |
| 19 | on-axis and off-axis angle measurement topologies. The angle calculation is |
| 20 | performed using two user-selected magnetic axes. |
| 21 | |
| 22 | properties: |
| 23 | compatible: |
| 24 | const: ti,tmag5273 |
| 25 | |
| 26 | reg: |
| 27 | maxItems: 1 |
| 28 | |
| 29 | "#io-channel-cells": |
| 30 | const: 1 |
| 31 | |
| 32 | ti,angle-measurement: |
| 33 | $ref: /schemas/types.yaml#/definitions/string |
| 34 | description: |
| 35 | Enables angle measurement in the selected plane. |
| 36 | If not specified, "x-y" will be anables as default. |
| 37 | enum: |
| 38 | - off |
| 39 | - x-y |
| 40 | - y-z |
| 41 | - x-z |
| 42 | |
| 43 | vcc-supply: |
| 44 | description: |
| 45 | A regulator providing 1.7 V to 3.6 V supply voltage on the VCC pin, |
| 46 | typically 3.3 V. |
| 47 | |
| 48 | interrupts: |
| 49 | description: |
| 50 | The low active interrupt can be configured to be fixed width or latched. |
| 51 | Interrupt events can be configured to be generated from magnetic |
| 52 | thresholds or when a conversion is completed. |
| 53 | maxItems: 1 |
| 54 | |
| 55 | required: |
| 56 | - compatible |
| 57 | - reg |
| 58 | |
| 59 | additionalProperties: false |
| 60 | |
| 61 | examples: |
| 62 | - | |
| 63 | i2c { |
| 64 | #address-cells = <1>; |
| 65 | #size-cells = <0>; |
| 66 | |
| 67 | magnetometer@35 { |
| 68 | compatible = "ti,tmag5273"; |
| 69 | reg = <0x35>; |
| 70 | #io-channel-cells = <1>; |
| 71 | ti,angle-measurement = "x-z"; |
| 72 | vcc-supply = <&vcc3v3>; |
| 73 | }; |
| 74 | }; |
| 75 | ... |