treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / Documentation / devicetree / bindings / iio / adc / adi,ad7192.yaml
blob567a33a83dce8b210d69d0291a0eb5bf2a15309d
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#
8 title: Analog Devices AD7192 ADC device driver
10 maintainers:
11   - Michael Hennerich <michael.hennerich@analog.com>
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
18 properties:
19   compatible:
20     enum:
21       - adi,ad7190
22       - adi,ad7192
23       - adi,ad7193
24       - adi,ad7195
26   reg:
27     maxItems: 1
29   spi-cpol: true
31   spi-cpha: true
33   clocks:
34     maxItems: 1
35     description: phandle to the master clock (mclk)
37   clock-names:
38     items:
39       - const: mclk
41   interrupts:
42     maxItems: 1
44   dvdd-supply:
45     description: DVdd voltage supply
47   avdd-supply:
48     description: AVdd voltage supply
50   adi,rejection-60-Hz-enable:
51     description: |
52       This bit enables a notch at 60 Hz when the first notch of the sinc
53       filter is at 50 Hz. When REJ60 is set, a filter notch is placed at
54       60 Hz when the sinc filter first notch is at 50 Hz. This allows
55       simultaneous 50 Hz/ 60 Hz rejection.
56     type: boolean
58   adi,refin2-pins-enable:
59     description: |
60       External reference applied between the P1/REFIN2(+) and P0/REFIN2(−) pins.
61     type: boolean
63   adi,buffer-enable:
64     description: |
65       Enables the buffer on the analog inputs. If cleared, the analog inputs
66       are unbuffered, lowering the power consumption of the device. If this
67       bit is set, the analog inputs are buffered, allowing the user to place
68       source impedances on the front end without contributing gain errors to
69       the system.
70     type: boolean
72   adi,burnout-currents-enable:
73     description: |
74       When this bit is set to 1, the 500 nA current sources in the signal
75       path are enabled. When BURN = 0, the burnout currents are disabled.
76       The burnout currents can be enabled only when the buffer is active
77       and when chop is disabled.
78     type: boolean
80   bipolar:
81     description: see Documentation/devicetree/bindings/iio/adc/adc.txt
82     type: boolean
84 required:
85   - compatible
86   - reg
87   - clocks
88   - clock-names
89   - interrupts
90   - dvdd-supply
91   - avdd-supply
92   - spi-cpol
93   - spi-cpha
95 examples:
96   - |
97     spi0 {
98       #address-cells = <1>;
99       #size-cells = <0>;
101       adc@0 {
102         compatible = "adi,ad7192";
103         reg = <0>;
104         spi-max-frequency = <1000000>;
105         spi-cpol;
106         spi-cpha;
107         clocks = <&ad7192_mclk>;
108         clock-names = "mclk";
109         #interrupt-cells = <2>;
110         interrupts = <25 0x2>;
111         interrupt-parent = <&gpio>;
112         dvdd-supply = <&dvdd>;
113         avdd-supply = <&avdd>;
115         adi,refin2-pins-enable;
116         adi,rejection-60-Hz-enable;
117         adi,buffer-enable;
118         adi,burnout-currents-enable;
119         };
120     };