AD7768 upstream

Documentation/devicetree/bindings/iio/adc/adi,ad7768.yaml

@@ -0,0 +1,290 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/adi,ad7768.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Analog Devices AD7768 and AD7768-4 ADC
+
+maintainers:
+  - Janani Sunil <janani.sunil@analog.com>
+
+description: |
+  The AD7768 is a 8-channel, 24-bit simultaneous sampling ADC with configurable
+  power and performance modes. The AD7768-4 is a 4-channel version.
+
+  Datasheet at:
+    https://www.analog.com/media/en/technical-documentation/data-sheets/ad7768.pdf
+
+properties:
+  compatible:
+    enum:
+      - adi,ad7768
+      - adi,ad7768-4
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+    description: Master clock (MCLK)
+
+  avdd-supply:
+    description: Analog power supply AVDD1 (4.5V to 5.5V)
+
+  avss-supply:
+    description: Analog ground/negative supply AVSS (0V to -2.75V)
+
+  dvdd-supply:
+    description: Analog power supply AVDD2 (2.0V to 5.5V)
+
+  iovdd-supply:
+    description: Digital I/O power supply (1.8V or 2.25V to 3.6V)
+
+  vref-supply:
+    description: ADC reference voltage supply
+
+  resets:
+    maxItems: 1
+    description: |
+      Reset control
+  reset-names:
+    const: reset
+
+  reset-gpios:
+    maxItems: 1
+    description: |
+      GPIO reset pin.
+      Either resets or reset-gpios should be specified, not both.
+  adi,data-lines-number:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    enum: [1, 2, 4, 8]
+    description: |
+      Number of data output lines used for serial interface.
+      AD7768: supports 1, 2, 8 lines
+      AD7768-4: supports 1, 4 lines
+
+  adi,common-mode-output:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    enum: [0, 1, 2, 3]
+    description: |
+      Common mode voltage output selection:
+        0 - (AVDD - AVSS) / 2
+        1 - 1.65V
+        2 - 2.5V
+        3 - 2.14V
+
+  adi,vcm-power-down:
+    type: boolean
+    description: Power down the common mode output buffer
+
+  adi,power-mode:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    enum: [0, 1, 2]
+    description: |
+      Power mode selection:
+        0 - Low power mode
+        1 - Median mode
+        2 - Fast mode
+
+  io-backends:
+    $ref: /schemas/types.yaml#/definitions/phandle
+    description: |
+      Phandle to an IIO backend device (e.g., AXI ADC) used for
+      high-speed data capture and DMA operations.
+
+  '#address-cells':
+    const: 1
+
+  '#size-cells':
+    const: 0
+
+patternProperties:
+  "^channel@[0-7]$":
+    type: object
+    description: |
+      Represents the external channels which are connected to the device.
+      AD7768 supports channels 0-7, AD7768-4 supports channels 0-3.
+
+    properties:
+      reg:
+        minimum: 0
+        maximum: 7
+        description: The channel number
+
+      adi,ch-mode:
+        $ref: /schemas/types.yaml#/definitions/uint32
+        minimum: 0
+        maximum: 1
+        description: |
+          Channel mode selection. The AD7768 supports two independent
+          configuration profiles (Mode A and Mode B) for filter and
+          decimation settings. Each channel can be assigned to either mode:
+            0 - Channel uses Mode A filter and decimation settings
+            1 - Channel uses Mode B filter and decimation settings
+
+      adi,prebuf-pos-en:
+        type: boolean
+        description: Enable positive input precharge buffer
+
+      adi,prebuf-neg-en:
+        type: boolean
+        description: Enable negative input precharge buffer
+
+      adi,refbuf-pos-en:
+        type: boolean
+        description: Enable positive reference buffer
+
+      adi,refbuf-neg-en:
+        type: boolean
+        description: Enable negative reference buffer
+
+    required:
+      - reg
+      - adi,ch-mode
+
+    additionalProperties: false
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - avdd-supply
+  - avss-supply
+  - dvdd-supply
+  - iovdd-supply
+  - vref-supply
+  - adi,data-lines-number
+  - adi,common-mode-output
+  - adi,power-mode
+  - io-backends
+
+allOf:
+  - $ref: /schemas/spi/spi-peripheral-props.yaml#
+  - if:
+      properties:
+        compatible:
+          contains:
+            const: adi,ad7768-4
+    then:
+      properties:
+        adi,data-lines-number:
+          enum: [1, 4]
+      patternProperties:
+        "^channel@[0-3]$":
+          properties:
+            reg:
+              maximum: 3
+    else:
+      properties:
+        adi,data-lines-number:
+          enum: [1, 2, 8]
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/iio/adc/adi,ad7768.h>
+    #include <dt-bindings/gpio/gpio.h>
+    #include <dt-bindings/interrupt-controller/irq.h>
+
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        adc@0 {
+            compatible = "adi,ad7768";
+            reg = <0>;
+            spi-max-frequency = <1000000>;
+
+            avdd-supply = <&avdd_regulator>;
+            avss-supply = <&avss_regulator>;
+            dvdd-supply = <&dvdd_regulator>;
+            iovdd-supply = <&iovdd_regulator>;
+            vref-supply = <&vref_regulator>;
+            reset-gpios = <&gpio0 86 GPIO_ACTIVE_HIGH>;
+
+            clocks = <&ad7768_mclk>;
+
+            adi,data-lines-number = <8>;
+            adi,common-mode-output = <AD7768_2P5_V>;
+            adi,vcm-power-down;
+            adi,power-mode = <AD7768_POWER_MODE_MEDIAN>;
+
+            io-backends = <&iio_backend>;
+
+            #address-cells = <1>;
+            #size-cells = <0>;
+
+            channel@0 {
+                reg = <0>;
+                adi,ch-mode = <0>;
+                adi,prebuf-pos-en;
+                adi,refbuf-pos-en;
+            };
+
+            channel@1 {
+                reg = <1>;
+                adi,ch-mode = <1>;
+                adi,prebuf-pos-en;
+                adi,prebuf-neg-en;
+                adi,refbuf-pos-en;
+                adi,refbuf-neg-en;
+            };
+
+            channel@7 {
+                reg = <7>;
+                adi,ch-mode = <1>;
+                adi,prebuf-pos-en;
+                adi,refbuf-pos-en;
+            };
+        };
+    };
+
+  - |
+    #include <dt-bindings/iio/adc/adi,ad7768.h>
+    #include <dt-bindings/gpio/gpio.h>
+
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        adc@1 {
+            compatible = "adi,ad7768-4";
+            reg = <1>;
+            spi-max-frequency = <1000000>;
+
+            avdd-supply = <&avdd_regulator>;
+            avss-supply = <&avss_regulator>;
+            dvdd-supply = <&dvdd_regulator>;
+            iovdd-supply = <&iovdd_regulator>;
+            vref-supply = <&vref_regulator>;
+            reset-gpios = <&gpio0 87 GPIO_ACTIVE_LOW>;
+
+            clocks = <&ad7768_mclk>;
+
+            adi,data-lines-number = <4>;
+            adi,common-mode-output = <AD7768_2P14_V>;
+            adi,power-mode = <AD7768_POWER_MODE_FAST>;
+
+            io-backends = <&iio_backend>;
+
+            #address-cells = <1>;
+            #size-cells = <0>;
+
+            channel@0 {
+                reg = <0>;
+                adi,ch-mode = <0>;
+                adi,prebuf-pos-en;
+                adi,refbuf-pos-en;
+            };
+
+            channel@3 {
+                reg = <3>;
+                adi,ch-mode = <1>;
+                adi,prebuf-pos-en;
+                adi,refbuf-pos-en;
+            };
+        };
+    };
+...