Commit 63d147d4 authored by Jonathan Cameron's avatar Jonathan Cameron
Browse files

dt-bindings:iio:magnetometer:asahi-kasei,ak8974: txt to yaml format conversion 



Simple conversion.  I have pruned descriptions that did not add much useful
detail.  Note that the mount-matrix description will form part of a generic
IIO binding.  No need to repeat that in every driver that uses it.

Signed-off-by: default avatarJonathan Cameron <Jonathan.Cameron@huawei.com>
Reviewed-by: default avatarLinus Walleij <linus.walleij@linaro.org>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20201031184854.745828-25-jic23@kernel.org
parent a7d6eb9d

Documentation/devicetree/bindings/iio/magnetometer/ak8974.txt

deleted100644 → 0
+0 −31
Original line number Diff line number Diff line 
* Asahi Kasei AK8974 magnetometer sensor



Required properties:



- compatible:

    * "asahi-kasei,ak8974"

    * "alps,hscdtd008a"

- reg : the I2C address of the magnetometer



Optional properties:



- avdd-supply: regulator supply for the analog voltage

  (see regulator/regulator.txt)

- dvdd-supply: regulator supply for the digital voltage

  (see regulator/regulator.txt)

- interrupts: data ready (DRDY) and interrupt (INT1) lines

  from the chip, the DRDY interrupt must be placed first.

  The interrupts can be triggered on rising or falling

  edges alike.

- mount-matrix: an optional 3x3 mounting rotation matrix



Example:



ak8974@f {

	compatible = "asahi-kasei,ak8974";

	reg = <0x0f>;

	avdd-supply = <&foo_reg>;

	dvdd-supply = <&bar_reg>;

	interrupts = <0 IRQ_TYPE_EDGE_RISING>,

		     <1 IRQ_TYPE_EDGE_RISING>;

};

Documentation/devicetree/bindings/iio/magnetometer/asahi-kasei,ak8974.yaml

0 → 100644
+57 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/iio/magnetometer/asahi-kasei,ak8974.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Asahi Kasei AK8974 magnetometer sensor



maintainers:

  - Linus Walleij <linus.walleij@linaro.org>



properties:

  compatible:

    enum:

      - alps,hscdtd008a

      - asahi-kasei,ak8974



  reg:

    maxItems: 1



  interrupts:

    minItems: 1

    maxItems: 2

    description: |

      Data ready (DRDY) and interrupt (INT1) lines from the chip. The DRDY

      interrupt must be placed first. The interrupts can be triggered on

      rising or falling edges.



  avdd-supply: true



  dvdd-supply: true



  mount-matrix: true



additionalProperties: false



required:

  - compatible

  - reg



examples:

  - |

    #include <dt-bindings/interrupt-controller/irq.h>

    i2c {

        #address-cells = <1>;

        #size-cells = <0>;



        magnetometer@f {

            compatible = "asahi-kasei,ak8974";

            reg = <0x0f>;

            avdd-supply = <&foo_reg>;

            dvdd-supply = <&bar_reg>;

            interrupts = <0 IRQ_TYPE_EDGE_RISING>,

                         <1 IRQ_TYPE_EDGE_RISING>;

        };

    };

...