xref: /linux/Documentation/devicetree/bindings/iio/adc/adc.yaml (revision 249ebf3f65f8530beb2cbfb91bff1d83ba88d23c)
1# SPDX-License-Identifier: GPL-2.0
2%YAML 1.2
3---
4$id: http://devicetree.org/schemas/iio/adc/adc.yaml#
5$schema: http://devicetree.org/meta-schemas/core.yaml#
6
7title: IIO Common Properties for ADC Channels
8
9maintainers:
10  - Jonathan Cameron <jic23@kernel.org>
11
12description:
13  A few properties are defined in a common way ADC channels.
14
15properties:
16  $nodename:
17    pattern: "^channel(@[0-9a-f]+)?$"
18    description:
19      A channel index should match reg.
20
21  reg:
22    maxItems: 1
23
24  label:
25    description: Unique name to identify which channel this is.
26
27  bipolar:
28    $ref: /schemas/types.yaml#/definitions/flag
29    description: If provided, the channel is to be used in bipolar mode.
30
31  diff-channels:
32    $ref: /schemas/types.yaml#/definitions/uint32-array
33    maxItems: 2
34    minItems: 2
35    description:
36      Many ADCs have dual Muxes to allow different input pins to be routed
37      to both the positive and negative inputs of a differential ADC.
38      The first value specifies the positive input pin, the second
39      specifies the negative input pin.
40
41  settling-time-us:
42    description:
43      Time between enabling the channel and first stable readings.
44
45  oversampling-ratio:
46    $ref: /schemas/types.yaml#/definitions/uint32
47    description:
48      Oversampling is used as replacement of or addition to the low-pass filter.
49      In some cases, the desired filtering characteristics are a function the
50      device design and can interact with other characteristics such as
51      settling time.
52
53additionalProperties: true
54