676ec42e143819665215bf79ffad2b2c148690f8
[linux-2.6-block.git] / Documentation / devicetree / bindings / iio / adc / adi,ad7192.yaml
1 # SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2 # Copyright 2019 Analog Devices Inc.
3 %YAML 1.2
4 ---
5 $id: http://devicetree.org/schemas/bindings/iio/adc/adi,ad7192.yaml#
6 $schema: http://devicetree.org/meta-schemas/core.yaml#
7
8 title: Analog Devices AD7192 ADC device driver
9
10 maintainers:
11   - Michael Hennerich <michael.hennerich@analog.com>
12
13 description: |
14   Bindings for the Analog Devices AD7192 ADC device. Datasheet can be
15   found here:
16   https://www.analog.com/media/en/technical-documentation/data-sheets/AD7192.pdf
17
18 properties:
19   compatible:
20     enum:
21       - adi,ad7190
22       - adi,ad7192
23       - adi,ad7193
24       - adi,ad7195
25
26   reg:
27     maxItems: 1
28
29   spi-cpol: true
30
31   spi-cpha: true
32
33   clocks:
34     maxItems: 1
35     description: phandle to the master clock (mclk)
36
37   clock-names:
38     items:
39       - const: mclk
40
41   interrupts:
42     maxItems: 1
43
44   dvdd-supply:
45     description: DVdd voltage supply
46     items:
47       - const: dvdd
48
49   avdd-supply:
50     description: AVdd voltage supply
51     items:
52       - const: avdd
53
54   adi,rejection-60-Hz-enable:
55     description: |
56       This bit enables a notch at 60 Hz when the first notch of the sinc
57       filter is at 50 Hz. When REJ60 is set, a filter notch is placed at
58       60 Hz when the sinc filter first notch is at 50 Hz. This allows
59       simultaneous 50 Hz/ 60 Hz rejection.
60     type: boolean
61
62   adi,refin2-pins-enable:
63     description: |
64       External reference applied between the P1/REFIN2(+) and P0/REFIN2(−) pins.
65     type: boolean
66
67   adi,buffer-enable:
68     description: |
69       Enables the buffer on the analog inputs. If cleared, the analog inputs
70       are unbuffered, lowering the power consumption of the device. If this
71       bit is set, the analog inputs are buffered, allowing the user to place
72       source impedances on the front end without contributing gain errors to
73       the system.
74     type: boolean
75
76   adi,burnout-currents-enable:
77     description: |
78       When this bit is set to 1, the 500 nA current sources in the signal
79       path are enabled. When BURN = 0, the burnout currents are disabled.
80       The burnout currents can be enabled only when the buffer is active
81       and when chop is disabled.
82     type: boolean
83
84   bipolar:
85     description: see Documentation/devicetree/bindings/iio/adc/adc.txt
86     type: boolean
87
88 required:
89   - compatible
90   - reg
91   - clocks
92   - clock-names
93   - interrupts
94   - dvdd-supply
95   - avdd-supply
96   - spi-cpol
97   - spi-cpha
98
99 examples:
100   - |
101     spi0 {
102       adc@0 {
103         compatible = "adi,ad7192";
104         reg = <0>;
105         spi-max-frequency = <1000000>;
106         spi-cpol;
107         spi-cpha;
108         clocks = <&ad7192_mclk>;
109         clock-names = "mclk";
110         #interrupt-cells = <2>;
111         interrupts = <25 0x2>;
112         interrupt-parent = <&gpio>;
113         dvdd-supply = <&dvdd>;
114         avdd-supply = <&avdd>;
115
116         adi,refin2-pins-enable;
117         adi,rejection-60-Hz-enable;
118         adi,buffer-enable;
119         adi,burnout-currents-enable;
120         };
121     };