dt-bindings: iio: magnetometer: ak8975: convert format to yaml, add maintainer

Converts documentation from txt format to yaml.

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>
This commit is contained in:
Jonathan Albrieux 2020-05-28 16:58:47 +02:00 committed by Jonathan Cameron
parent ba13993c50
commit 7e000fbff7
2 changed files with 76 additions and 37 deletions

View File

@ -1,37 +0,0 @@
* AsahiKASEI AK8975 magnetometer sensor
Required properties:
- compatible : should be "asahi-kasei,ak8975".
- reg : the I2C address of the magnetometer.
Optional properties:
- 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>;
interrupt-parent = <&gpio6>;
interrupts = <15 IRQ_TYPE_EDGE_RISING>;
vdd-supply = <&ldo_3v3_gnss>;
mount-matrix = "-0.984807753012208", /* x0 */
"0", /* y0 */
"-0.173648177666930", /* z0 */
"0", /* x1 */
"-1", /* y1 */
"0", /* z1 */
"-0.173648177666930", /* x2 */
"0", /* y2 */
"0.984807753012208"; /* z2 */
};

View File

@ -0,0 +1,76 @@
# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/iio/magnetometer/asahi-kasei,ak8975.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#
title: AsahiKASEI AK8975 magnetometer sensor
maintainers:
- Jonathan Albrieux <jonathan.albrieux@gmail.com>
properties:
compatible:
oneOf:
- enum:
- asahi-kasei,ak8975
- asahi-kasei,ak8963
- asahi-kasei,ak09911
- asahi-kasei,ak09912
- enum:
- ak8975
- ak8963
- ak09911
- ak09912
deprecated: true
reg:
maxItems: 1
gpios:
maxItems: 1
description: |
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:
maxItems: 1
description: interrupt for DRDY pin. Triggered on rising edge.
vdd-supply:
description: |
an optional regulator that needs to be on to provide VDD power to
the sensor.
mount-matrix:
description: an optional 3x3 mounting rotation matrix.
required:
- compatible
- reg
examples:
- |
#include <dt-bindings/interrupt-controller/irq.h>
i2c {
#address-cells = <1>;
#size-cells = <0>;
magnetometer@c {
compatible = "asahi-kasei,ak8975";
reg = <0x0c>;
interrupt-parent = <&gpio6>;
interrupts = <15 IRQ_TYPE_EDGE_RISING>;
vdd-supply = <&ldo_3v3_gnss>;
mount-matrix = "-0.984807753012208", /* x0 */
"0", /* y0 */
"-0.173648177666930", /* z0 */
"0", /* x1 */
"-1", /* y1 */
"0", /* z1 */
"-0.173648177666930", /* x2 */
"0", /* y2 */
"0.984807753012208"; /* z2 */
};
};