84 lines · yaml
1# SPDX-License-Identifier: GPL-2.02%YAML 1.23---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 Channels8 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: 123 24 label:25 description: Unique name to identify which channel this is.26 27 bipolar:28 $ref: /schemas/types.yaml#/definitions/flag29 description: If provided, the channel is to be used in bipolar mode.30 31 diff-channels:32 $ref: /schemas/types.yaml#/definitions/uint32-array33 maxItems: 234 minItems: 235 description:36 Many ADCs have dual Muxes to allow different input pins to be routed37 to both the positive and negative inputs of a differential ADC.38 The first value specifies the positive input pin, the second39 specifies the negative input pin.40 41 single-channel:42 $ref: /schemas/types.yaml#/definitions/uint3243 description:44 When devices combine single-ended and differential channels, allow the45 channel for a single element to be specified, independent of reg (as for46 differential channels). If this and diff-channels are not present reg47 shall be used instead.48 49 common-mode-channel:50 $ref: /schemas/types.yaml#/definitions/uint3251 description:52 Some ADCs have differential input pins that can be used to measure53 single-ended or pseudo-differential inputs. This property can be used54 in addition to single-channel to signal software that this channel is55 not differential but still specify two inputs.56 57 The input pair is specified by setting single-channel to the positive58 input pin and common-mode-channel to the negative pin.59 60 settling-time-us:61 description:62 Time between enabling the channel and first stable readings.63 64 oversampling-ratio:65 $ref: /schemas/types.yaml#/definitions/uint3266 description:67 Oversampling is used as replacement of or addition to the low-pass filter.68 In some cases, the desired filtering characteristics are a function the69 device design and can interact with other characteristics such as70 settling time.71 72anyOf:73 - oneOf:74 - required:75 - reg76 - diff-channels77 - required:78 - reg79 - single-channel80 - required:81 - reg82 83additionalProperties: true84