xref: /linux/Documentation/devicetree/bindings/iio/proximity/ams,as3935.yaml (revision 42874e4eb35bdfc54f8514685e50434098ba4f6c) 
1# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/iio/proximity/ams,as3935.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: Austrian Microsystems AS3935 Franklin lightning sensor
8
9maintainers:
10  - Matt Ranostay <matt.ranostay@konsulko.com>
11
12description:
13  This lightning distance sensor uses an I2C or SPI interface. The
14  binding currently only covers the SPI option.
15
16properties:
17  compatible:
18    const: ams,as3935
19
20  reg:
21    maxItems: 1
22
23  spi-max-frequency:
24    maximum: 2000000
25
26  spi-cpha: true
27
28  interrupts:
29    maxItems: 1
30
31  ams,tuning-capacitor-pf:
32    $ref: /schemas/types.yaml#/definitions/uint32
33    description:
34      Calibration tuning capacitor stepping value. This will require using
35      the calibration data from the manufacturer.
36    minimum: 0
37    maximum: 120
38
39  ams,nflwdth:
40    $ref: /schemas/types.yaml#/definitions/uint32
41    description:
42      Set the noise and watchdog threshold register on startup. This will
43      need to set according to the noise from the MCU board, and possibly
44      the local environment. Refer to the datasheet for the threshold settings.
45
46required:
47  - compatible
48  - reg
49  - spi-cpha
50  - interrupts
51
52allOf:
53  - $ref: /schemas/spi/spi-peripheral-props.yaml#
54
55unevaluatedProperties: false
56
57examples:
58  - |
59    spi {
60        #address-cells = <1>;
61        #size-cells = <0>;
62
63        lightning@0 {
64            compatible = "ams,as3935";
65            reg = <0>;
66            spi-max-frequency = <400000>;
67            spi-cpha;
68            interrupt-parent = <&gpio1>;
69            interrupts = <16 1>;
70            ams,tuning-capacitor-pf = <80>;
71            ams,nflwdth = <0x44>;
72        };
73    };
74...
75