GNU Linux-libre 6.8.9-gnu
[releases.git] / Documentation / devicetree / bindings / iio / adc / adi,ad7949.yaml
1 # SPDX-License-Identifier: GPL-2.0
2 %YAML 1.2
3 ---
4 $id: http://devicetree.org/schemas/iio/adc/adi,ad7949.yaml#
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
6
7 title: Analog Devices AD7949/AD7682/AD7689 analog to digital converters
8
9 maintainers:
10   - Charles-Antoine Couret <charles-antoine.couret@essensium.com>
11
12 description: |
13   Specifications on the converters can be found at:
14     AD7949:
15       https://www.analog.com/media/en/technical-documentation/data-sheets/AD7949.pdf
16     AD7682/AD7698:
17       https://www.analog.com/media/en/technical-documentation/data-sheets/AD7682_7689.pdf
18
19 properties:
20   compatible:
21     enum:
22       - adi,ad7682
23       - adi,ad7689
24       - adi,ad7949
25
26   reg:
27     maxItems: 1
28
29   vrefin-supply:
30     description:
31       Buffered ADC reference voltage supply.
32
33   vref-supply:
34     description:
35       Unbuffered ADC reference voltage supply.
36
37   adi,internal-ref-microvolt:
38     description: |
39       Internal reference voltage selection in microvolts.
40
41       If no internal reference is specified, the channel will default to the
42       external reference defined by vrefin-supply (or vref-supply).
43       vrefin-supply will take precedence over vref-supply if both are defined.
44
45       If no supplies are defined, the reference selection will default to
46       4096mV internal reference.
47
48     enum: [2500000, 4096000]
49     default: 4096000
50
51
52   '#io-channel-cells':
53     const: 1
54
55   '#address-cells':
56     const: 1
57
58   '#size-cells':
59     const: 0
60
61 required:
62   - compatible
63   - reg
64
65 allOf:
66   - $ref: /schemas/spi/spi-peripheral-props.yaml#
67
68 unevaluatedProperties: false
69
70 examples:
71   - |
72     spi {
73         #address-cells = <1>;
74         #size-cells = <0>;
75
76         adc@0 {
77             #address-cells = <1>;
78             #size-cells = <0>;
79
80             compatible = "adi,ad7949";
81             reg = <0>;
82             vref-supply = <&vdd_supply>;
83         };
84
85         adc@1 {
86             #address-cells = <1>;
87             #size-cells = <0>;
88
89             compatible = "adi,ad7949";
90             reg = <1>;
91             vrefin-supply = <&vdd_supply>;
92         };
93
94         adc@2 {
95             #address-cells = <1>;
96             #size-cells = <0>;
97
98             compatible = "adi,ad7949";
99             reg = <2>;
100             adi,internal-ref-microvolt = <4096000>;
101         };
102     };
103 ...