xref: /linux/Documentation/devicetree/bindings/iio/adc/adi,ltc2378.yaml (revision 93e4b3076b5f2d853462b9777d083c77fc0b7b23)

# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
%YAML 1.2
---
$id: http://devicetree.org/schemas/iio/adc/adi,ltc2378.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#

title: Analog Devices LTC2378 and similar Analog to Digital Converters

maintainers:
  - Marcelo Schmitt <marcelo.schmitt@analog.com>

description: |
  Analog Devices LTC2378 series of ADCs.
  Specifications can be found at:
    https://www.analog.com/media/en/technical-documentation/data-sheets/233818fa.pdf
    https://www.analog.com/media/en/technical-documentation/data-sheets/236416fa.pdf
    https://www.analog.com/media/en/technical-documentation/data-sheets/236418f.pdf
    https://www.analog.com/media/en/technical-documentation/data-sheets/236716fa.pdf
    https://www.analog.com/media/en/technical-documentation/data-sheets/236718f.pdf
    https://www.analog.com/media/en/technical-documentation/data-sheets/236816f.pdf
    https://www.analog.com/media/en/technical-documentation/data-sheets/236818f.pdf
    https://www.analog.com/media/en/technical-documentation/data-sheets/236918fa.pdf
    https://www.analog.com/media/en/technical-documentation/data-sheets/237016fa.pdf
    https://www.analog.com/media/en/technical-documentation/data-sheets/237616fa.pdf
    https://www.analog.com/media/en/technical-documentation/data-sheets/237618fa.pdf
    https://www.analog.com/media/en/technical-documentation/data-sheets/237620fb.pdf
    https://www.analog.com/media/en/technical-documentation/data-sheets/237716fa.pdf
    https://www.analog.com/media/en/technical-documentation/data-sheets/237718fa.pdf
    https://www.analog.com/media/en/technical-documentation/data-sheets/237720fb.pdf
    https://www.analog.com/media/en/technical-documentation/data-sheets/237816fa.pdf
    https://www.analog.com/media/en/technical-documentation/data-sheets/237818fa.pdf
    https://www.analog.com/media/en/technical-documentation/data-sheets/237820fb.pdf
    https://www.analog.com/media/en/technical-documentation/data-sheets/237918fb.pdf
    https://www.analog.com/media/en/technical-documentation/data-sheets/238016fb.pdf

$ref: /schemas/spi/spi-peripheral-props.yaml#

properties:
  compatible:
    oneOf:
      # Single compatible string match.
      - enum:
          - adi,ltc2338-18
          - adi,ltc2364-16
          - adi,ltc2364-18
          - adi,ltc2376-16
          - adi,ltc2376-18
          - adi,ltc2376-20

      # Low sample rate fallback for 16-bit unipolar sensors.
      - items:
          - enum:
              - adi,ltc2370-16 # 2 MSPS
              - adi,ltc2368-16 # 1 MSPS
              - adi,ltc2367-16 # 500 kSPS
          - const: adi,ltc2364-16 # fallback (250 kSPS)

      # Low sample rate fallback for 18-bit unipolar sensors.
      - items:
          - enum:
              - adi,ltc2369-18 # 1.6 MSPS
              - adi,ltc2368-18 # 1 MSPS
              - adi,ltc2367-18 # 500 kSPS
          - const: adi,ltc2364-18 # fallback (250 kSPS)

      # Low sample rate fallback for 16-bit bipolar sensors.
      - items:
          - enum:
              - adi,ltc2380-16 # 2 MSPS
              - adi,ltc2378-16 # 1 MSPS
              - adi,ltc2377-16 # 500 kSPS
          - const: adi,ltc2376-16 # fallback (250 kSPS)

      # Low sample rate fallback for 18-bit bipolar sensors.
      - items:
          - enum:
              - adi,ltc2379-18 # 1.6 MSPS
              - adi,ltc2378-18 # 1 MSPS
              - adi,ltc2377-18 # 500 kSPS
          - const: adi,ltc2376-18 # fallback (250 kSPS)

      # Low sample rate fallback for 20-bit bipolar sensors.
      - items:
          - enum:
              - adi,ltc2378-20 # 1 MSPS
              - adi,ltc2377-20 # 500 kSPS
          - const: adi,ltc2376-20 # fallback (250 kSPS)

  reg:
    maxItems: 1

  spi-max-frequency:
    maximum: 100000000

  vdd-supply:
    description: A 2.5V supply that powers the chip (VDD).

  ovdd-supply:
    description:
      A 1.71V to 5.25V supply that sets the logic level for digital interface.

  ref-supply:
    description:
      Voltage reference input that determines the scale of ADC conversions.

  refin-supply:
    description:
      Alternative voltage reference input.

  cnv-gpios:
    description:
      When provided, this property indicates the GPIO that is connected to the
      CNV pin.
    maxItems: 1

  pwms:
    description: PWM signal connected to the CNV pin.
    maxItems: 1

  interrupts:
    description:
      Interrupt for signaling the completion of conversion results. The active
      low signal provided on the BUSY pin asserts when ADC conversions finish.
    maxItems: 1

required:
  - compatible
  - reg
  - vdd-supply
  - ovdd-supply

allOf:
  # Except for LTC2338, all designs require a voltage reference input
  - if:
      properties:
        compatible:
          not:
            contains:
              enum:
                - adi,ltc2338-18
    then:
      required:
        - ref-supply
      properties:
        refin-supply: false
    else:
      properties:
        ref-supply: false

unevaluatedProperties: false

examples:
  - |
    #include <dt-bindings/gpio/gpio.h>
    #include <dt-bindings/interrupt-controller/irq.h>
    spi {
        #address-cells = <1>;
        #size-cells = <0>;
        adc@0 {
            compatible = "adi,ltc2378-20", "adi,ltc2376-20";
            reg = <0>;
            spi-max-frequency = <71000000>;
            vdd-supply = <&supply_2_5V>;
            ovdd-supply = <&supply_3_3V>;
            ref-supply = <&supply_5V>;
            cnv-gpios = <&gpio0 88 GPIO_ACTIVE_HIGH>;
            interrupts = <7 IRQ_TYPE_EDGE_FALLING>;
            interrupt-parent = <&gpio>;
        };
    };