# Copyright (c) 2019, Peter Bigot Consulting, LLC
# SPDX-License-Identifier: Apache-2.0

description: |
    Description for a voltage divider, with optional ability to measure
    resistance of the upper leg.

compatible: "voltage-divider"

include: base.yaml

properties:
  io-channels:
    required: true
    description: |
      Channels available with this divider configuration.

  output-ohms:
    type: int
    required: true
    description: |
      Resistance of the lower leg of the voltage divider

  full-ohms:
    type: int
    description: |
      Resistance of the full path through the voltage divider.

      If absent or zero the driver assumes that the upper leg is a
      resistance-based sensor.

  power-gpios:
    type: phandle-array
    description: |
      Control power to the voltage divider inputs.

      If present the corresponding GPIO must be set to an active level
      to enable the divider input.

  power-on-sample-delay-us:
    type: int
    default: 100
    description: |
      Duration to delay sampling after enabling the circuitry with
      `power-gpios`. In most cases the switched voltage rail will
      require some non-zero time to settle to its final value. The
      default value of 100us should be sufficient in most situations.
