^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) # SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) %YAML 1.2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) ---
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) $id: http://devicetree.org/schemas/iio/common.yaml#
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) $schema: http://devicetree.org/meta-schemas/core.yaml#
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) title: Common properties for iio sensors
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) maintainers:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) - Jonathan Cameron <jic23@kernel.org>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) - Guido Günther <agx@sigxcpu.org>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) description: |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) This document defines device tree properties common to several iio
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) sensors. It doesn't constitue a device tree binding specification by itself but
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) is meant to be referenced by device tree bindings.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) When referenced from sensor tree bindings the properties defined in this
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) document are defined as follows. The sensor tree bindings are responsible for
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) defining whether each property is required or optional.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) properties:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) proximity-near-level:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) $ref: /schemas/types.yaml#/definitions/uint32
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) description: |
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) For proximity sensors whether an object can be considered near to the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) device depends on parameters like sensor position, covering glass and
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) aperture. This value gives an indication to userspace for which
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) sensor readings this is the case.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) Raw proximity values equal or above this level should be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) considered 'near' to the device (an object is near to the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) sensor).
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) additionalProperties: true
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) ...