Documentation/devicetree/bindings/iio/adc/st,spear600-adc.yaml

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

title: ST SPEAr ADC device driver

maintainers:
  - Jonathan Cameron <jic23@kernel.org>

description: |
  Integrated ADC inside the ST SPEAr SoC, SPEAr600, supporting
  10-bit resolution. Datasheet can be found here:
  https://www.st.com/resource/en/datasheet/spear600.pdf

properties:
  compatible:
    enum:
      - st,spear600-adc

  reg:
    maxItems: 1

  interrupts:
    maxItems: 1

  sampling-frequency:
    $ref: /schemas/types.yaml#/definitions/uint32
    minimum: 2500000
    maximum: 20000000
    description:
      Default sampling frequency of the ADC in Hz.

  vref-external:
    $ref: /schemas/types.yaml#/definitions/uint32
    minimum: 1000
    maximum: 2800
    description:
      External voltage reference in milli-volts. If omitted the internal voltage
      reference will be used.

  average-samples:
    $ref: /schemas/types.yaml#/definitions/uint32
    minimum: 0
    maximum: 15
    default: 0
    description:
      Number of samples to generate an average value. If omitted, single data
      conversion will be used.

required:
  - compatible
  - reg
  - interrupts
  - sampling-frequency

additionalProperties: false

examples:
  - |
    adc@d8200000 {
        compatible = "st,spear600-adc";
        reg = <0xd8200000 0x1000>;
        interrupt-parent = <&vic1>;
        interrupts = <6>;
        sampling-frequency = <5000000>;
        vref-external = <2500>;	/* 2.5V VRef */
    };