summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorJonathan Albrieux <jonathan.albrieux@gmail.com>2020-05-28 16:56:04 +0200
committerJonathan Cameron <Jonathan.Cameron@huawei.com>2020-06-14 11:49:25 +0100
commitba13993c50f73f2adb9199cf854926a6a4998b1b (patch)
treed8154829b9e2ca248cba56602feee4329fc66325 /Documentation
parent603375df11bea12a779e54e4690cd6370f169620 (diff)
downloadlinux-ba13993c50f73f2adb9199cf854926a6a4998b1b.tar.gz
linux-ba13993c50f73f2adb9199cf854926a6a4998b1b.tar.bz2
linux-ba13993c50f73f2adb9199cf854926a6a4998b1b.zip
dt-bindings: iio: magnetometer: ak8975: reword gpios, add interrupts, fix style
Reword gpios documentation, add interrupt documentation and fix styles. Update example to use interrupts instead of gpios. Signed-off-by: Jonathan Albrieux <jonathan.albrieux@gmail.com> Reviewed-by: Rob Herring <robh@kernel.org> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt19
1 files changed, 13 insertions, 6 deletions
diff --git a/Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt b/Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt
index aa67ceb0d4e0..0576b9df0bf2 100644
--- a/Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt
+++ b/Documentation/devicetree/bindings/iio/magnetometer/ak8975.txt
@@ -2,21 +2,28 @@
Required properties:
- - compatible : should be "asahi-kasei,ak8975"
- - reg : the I2C address of the magnetometer
+ - compatible : should be "asahi-kasei,ak8975".
+ - reg : the I2C address of the magnetometer.
Optional properties:
- - gpios : should be device tree identifier of the magnetometer DRDY pin
- - vdd-supply: an optional regulator that needs to be on to provide VDD
- - mount-matrix: an optional 3x3 mounting rotation matrix
+ - gpios : AK8975 has a "Data ready" pin (DRDY) which informs that data
+ is ready to be read and is possible to listen on it. If used,
+ this should be active high. Prefer interrupt over this.
+
+ - interrupts : interrupt for DRDY pin. Triggered on rising edge.
+
+ - vdd-supply: an optional regulator that needs to be on to provide VDD.
+
+ - mount-matrix: an optional 3x3 mounting rotation matrix.
Example:
ak8975@c {
compatible = "asahi-kasei,ak8975";
reg = <0x0c>;
- gpios = <&gpj0 7 0>;
+ interrupt-parent = <&gpio6>;
+ interrupts = <15 IRQ_TYPE_EDGE_RISING>;
vdd-supply = <&ldo_3v3_gnss>;
mount-matrix = "-0.984807753012208", /* x0 */
"0", /* y0 */