iio/adc/adc.yaml

1 # SPDX-License-Identifier: GPL-2.0
3 ---
5 $schema: http://devicetree.org/meta-schemas/core.yaml#
7 title: IIO Common Properties for ADC Channels
10   - Jonathan Cameron <jic23@kernel.org>
13   A few properties are defined in a common way ADC channels.
17     pattern: "^channel(@[0-9a-f]+)?$"
19       A channel index should match reg.
25     description: Unique name to identify which channel this is.
29     description: If provided, the channel is to be used in bipolar mode.
31   diff-channels:
32     $ref: /schemas/types.yaml#/definitions/uint32-array
41   single-channel:
44       When devices combine single-ended and differential channels, allow the
45       channel for a single element to be specified, independent of reg (as for
46       differential channels). If this and diff-channels are not present reg
49   common-mode-channel:
53       single-ended or pseudo-differential inputs. This property can be used
54       in addition to single-channel to signal software that this channel is
57       The input pair is specified by setting single-channel to the positive
58       input pin and common-mode-channel to the negative pin.
60   settling-time-us:
62       Time between enabling the channel and first stable readings.
64   oversampling-ratio:
67       Oversampling is used as replacement of or addition to the low-pass filter.
73   - oneOf:
74       - required:
75           - reg
76           - diff-channels
77       - required:
78           - reg
79           - single-channel
80   - required:
81       - reg