xref: /freebsd/sys/contrib/device-tree/Bindings/iio/adc/adi,ad7192.yaml (revision fe75646a0234a261c0013bf1840fdac4acaf0cec) 
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/iio/adc/adi,ad7192.yaml#
6$schema: http://devicetree.org/meta-schemas/core.yaml#
7
8title: Analog Devices AD7192 ADC device driver
9
10maintainers:
11  - Michael Hennerich <michael.hennerich@analog.com>
12
13description: |
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
18properties:
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
47  avdd-supply:
48    description: AVdd voltage supply
49
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
57
58  adi,refin2-pins-enable:
59    description: |
60      External reference applied between the P1/REFIN2(+) and P0/REFIN2(−) pins.
61    type: boolean
62
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
71
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
79
80  bipolar:
81    description: see Documentation/devicetree/bindings/iio/adc/adc.yaml
82    type: boolean
83
84required:
85  - compatible
86  - reg
87  - clocks
88  - clock-names
89  - interrupts
90  - dvdd-supply
91  - avdd-supply
92  - spi-cpol
93  - spi-cpha
94
95allOf:
96  - $ref: /schemas/spi/spi-peripheral-props.yaml#
97
98unevaluatedProperties: false
99
100examples:
101  - |
102    spi {
103        #address-cells = <1>;
104        #size-cells = <0>;
105
106        adc@0 {
107            compatible = "adi,ad7192";
108            reg = <0>;
109            spi-max-frequency = <1000000>;
110            spi-cpol;
111            spi-cpha;
112            clocks = <&ad7192_mclk>;
113            clock-names = "mclk";
114            interrupts = <25 0x2>;
115            interrupt-parent = <&gpio>;
116            dvdd-supply = <&dvdd>;
117            avdd-supply = <&avdd>;
118
119            adi,refin2-pins-enable;
120            adi,rejection-60-Hz-enable;
121            adi,buffer-enable;
122            adi,burnout-currents-enable;
123        };
124    };
125