xref: /OK3568_Linux_fs/kernel/Documentation/devicetree/bindings/iio/magnetometer/asahi-kasei,ak8975.yaml (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2*4882a593Smuzhiyun%YAML 1.2
3*4882a593Smuzhiyun---
4*4882a593Smuzhiyun$id: http://devicetree.org/schemas/iio/magnetometer/asahi-kasei,ak8975.yaml#
5*4882a593Smuzhiyun$schema: http://devicetree.org/meta-schemas/core.yaml#
6*4882a593Smuzhiyun
7*4882a593Smuzhiyuntitle: AsahiKASEI AK8975 magnetometer sensor
8*4882a593Smuzhiyun
9*4882a593Smuzhiyunmaintainers:
10*4882a593Smuzhiyun  - Jonathan Albrieux <jonathan.albrieux@gmail.com>
11*4882a593Smuzhiyun
12*4882a593Smuzhiyunproperties:
13*4882a593Smuzhiyun  compatible:
14*4882a593Smuzhiyun    oneOf:
15*4882a593Smuzhiyun      - enum:
16*4882a593Smuzhiyun          - asahi-kasei,ak8975
17*4882a593Smuzhiyun          - asahi-kasei,ak8963
18*4882a593Smuzhiyun          - asahi-kasei,ak09911
19*4882a593Smuzhiyun          - asahi-kasei,ak09912
20*4882a593Smuzhiyun      - enum:
21*4882a593Smuzhiyun          - ak8975
22*4882a593Smuzhiyun          - ak8963
23*4882a593Smuzhiyun          - ak09911
24*4882a593Smuzhiyun          - ak09912
25*4882a593Smuzhiyun        deprecated: true
26*4882a593Smuzhiyun
27*4882a593Smuzhiyun  reg:
28*4882a593Smuzhiyun    maxItems: 1
29*4882a593Smuzhiyun
30*4882a593Smuzhiyun  gpios:
31*4882a593Smuzhiyun    maxItems: 1
32*4882a593Smuzhiyun    description: |
33*4882a593Smuzhiyun      AK8975 has a "Data ready" pin (DRDY) which informs that data
34*4882a593Smuzhiyun      is ready to be read and is possible to listen on it. If used,
35*4882a593Smuzhiyun      this should be active high. Prefer interrupt over this.
36*4882a593Smuzhiyun
37*4882a593Smuzhiyun  interrupts:
38*4882a593Smuzhiyun    maxItems: 1
39*4882a593Smuzhiyun    description: interrupt for DRDY pin. Triggered on rising edge.
40*4882a593Smuzhiyun
41*4882a593Smuzhiyun  vdd-supply:
42*4882a593Smuzhiyun    description: |
43*4882a593Smuzhiyun      an optional regulator that needs to be on to provide VDD power to
44*4882a593Smuzhiyun      the sensor.
45*4882a593Smuzhiyun
46*4882a593Smuzhiyun  mount-matrix:
47*4882a593Smuzhiyun    description: an optional 3x3 mounting rotation matrix.
48*4882a593Smuzhiyun
49*4882a593Smuzhiyun  reset-gpios:
50*4882a593Smuzhiyun    description: |
51*4882a593Smuzhiyun      an optional pin needed for AK09911 to set the reset state. This should
52*4882a593Smuzhiyun      be usually active low
53*4882a593Smuzhiyun
54*4882a593Smuzhiyunrequired:
55*4882a593Smuzhiyun  - compatible
56*4882a593Smuzhiyun  - reg
57*4882a593Smuzhiyun
58*4882a593SmuzhiyunadditionalProperties: false
59*4882a593Smuzhiyun
60*4882a593Smuzhiyunexamples:
61*4882a593Smuzhiyun  - |
62*4882a593Smuzhiyun    #include <dt-bindings/interrupt-controller/irq.h>
63*4882a593Smuzhiyun    #include <dt-bindings/gpio/gpio.h>
64*4882a593Smuzhiyun    i2c {
65*4882a593Smuzhiyun        #address-cells = <1>;
66*4882a593Smuzhiyun        #size-cells = <0>;
67*4882a593Smuzhiyun
68*4882a593Smuzhiyun        magnetometer@c {
69*4882a593Smuzhiyun            compatible = "asahi-kasei,ak8975";
70*4882a593Smuzhiyun            reg = <0x0c>;
71*4882a593Smuzhiyun            interrupt-parent = <&gpio6>;
72*4882a593Smuzhiyun            interrupts = <15 IRQ_TYPE_EDGE_RISING>;
73*4882a593Smuzhiyun            vdd-supply = <&ldo_3v3_gnss>;
74*4882a593Smuzhiyun            reset-gpios = <&msmgpio 111 GPIO_ACTIVE_LOW>;
75*4882a593Smuzhiyun            mount-matrix = "-0.984807753012208",  /* x0 */
76*4882a593Smuzhiyun                           "0",                   /* y0 */
77*4882a593Smuzhiyun                           "-0.173648177666930",  /* z0 */
78*4882a593Smuzhiyun                           "0",                   /* x1 */
79*4882a593Smuzhiyun                           "-1",                  /* y1 */
80*4882a593Smuzhiyun                           "0",                   /* z1 */
81*4882a593Smuzhiyun                           "-0.173648177666930",  /* x2 */
82*4882a593Smuzhiyun                           "0",                   /* y2 */
83*4882a593Smuzhiyun                           "0.984807753012208";   /* z2 */
84*4882a593Smuzhiyun        };
85*4882a593Smuzhiyun    };
86