162306a36Sopenharmony_ci# SPDX-License-Identifier: GPL-2.0
262306a36Sopenharmony_ci%YAML 1.2
362306a36Sopenharmony_ci---
462306a36Sopenharmony_ci$id: http://devicetree.org/schemas/iio/adc/adc.yaml#
562306a36Sopenharmony_ci$schema: http://devicetree.org/meta-schemas/core.yaml#
662306a36Sopenharmony_ci
762306a36Sopenharmony_cititle: IIO Common Properties for ADC Channels
862306a36Sopenharmony_ci
962306a36Sopenharmony_cimaintainers:
1062306a36Sopenharmony_ci  - Jonathan Cameron <jic23@kernel.org>
1162306a36Sopenharmony_ci
1262306a36Sopenharmony_cidescription:
1362306a36Sopenharmony_ci  A few properties are defined in a common way ADC channels.
1462306a36Sopenharmony_ci
1562306a36Sopenharmony_ciproperties:
1662306a36Sopenharmony_ci  $nodename:
1762306a36Sopenharmony_ci    pattern: "^channel(@[0-9a-f]+)?$"
1862306a36Sopenharmony_ci    description:
1962306a36Sopenharmony_ci      A channel index should match reg.
2062306a36Sopenharmony_ci
2162306a36Sopenharmony_ci  reg:
2262306a36Sopenharmony_ci    maxItems: 1
2362306a36Sopenharmony_ci
2462306a36Sopenharmony_ci  label:
2562306a36Sopenharmony_ci    $ref: /schemas/types.yaml#/definitions/string
2662306a36Sopenharmony_ci    description: Unique name to identify which channel this is.
2762306a36Sopenharmony_ci
2862306a36Sopenharmony_ci  bipolar:
2962306a36Sopenharmony_ci    $ref: /schemas/types.yaml#/definitions/flag
3062306a36Sopenharmony_ci    description: If provided, the channel is to be used in bipolar mode.
3162306a36Sopenharmony_ci
3262306a36Sopenharmony_ci  diff-channels:
3362306a36Sopenharmony_ci    $ref: /schemas/types.yaml#/definitions/uint32-array
3462306a36Sopenharmony_ci    maxItems: 2
3562306a36Sopenharmony_ci    minItems: 2
3662306a36Sopenharmony_ci    description:
3762306a36Sopenharmony_ci      Many ADCs have dual Muxes to allow different input pins to be routed
3862306a36Sopenharmony_ci      to both the positive and negative inputs of a differential ADC.
3962306a36Sopenharmony_ci      The first value specifies the positive input pin, the second
4062306a36Sopenharmony_ci      specifies the negative input pin.
4162306a36Sopenharmony_ci
4262306a36Sopenharmony_ci  settling-time-us:
4362306a36Sopenharmony_ci    description:
4462306a36Sopenharmony_ci      Time between enabling the channel and first stable readings.
4562306a36Sopenharmony_ci
4662306a36Sopenharmony_ci  oversampling-ratio:
4762306a36Sopenharmony_ci    $ref: /schemas/types.yaml#/definitions/uint32
4862306a36Sopenharmony_ci    description:
4962306a36Sopenharmony_ci      Oversampling is used as replacement of or addition to the low-pass filter.
5062306a36Sopenharmony_ci      In some cases, the desired filtering characteristics are a function the
5162306a36Sopenharmony_ci      device design and can interact with other characteristics such as
5262306a36Sopenharmony_ci      settling time.
5362306a36Sopenharmony_ci
5462306a36Sopenharmony_ciadditionalProperties: true
55