162306a36Sopenharmony_ci# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
262306a36Sopenharmony_ci%YAML 1.2
362306a36Sopenharmony_ci---
462306a36Sopenharmony_ci$id: http://devicetree.org/schemas/iio/common.yaml#
562306a36Sopenharmony_ci$schema: http://devicetree.org/meta-schemas/core.yaml#
662306a36Sopenharmony_ci
762306a36Sopenharmony_cititle: Common properties for iio sensors
862306a36Sopenharmony_ci
962306a36Sopenharmony_cimaintainers:
1062306a36Sopenharmony_ci  - Jonathan Cameron <jic23@kernel.org>
1162306a36Sopenharmony_ci  - Guido Günther <agx@sigxcpu.org>
1262306a36Sopenharmony_ci
1362306a36Sopenharmony_cidescription: |
1462306a36Sopenharmony_ci  This document defines device tree properties common to several iio
1562306a36Sopenharmony_ci  sensors. It doesn't constitute a device tree binding specification by itself but
1662306a36Sopenharmony_ci  is meant to be referenced by device tree bindings.
1762306a36Sopenharmony_ci
1862306a36Sopenharmony_ci  When referenced from sensor tree bindings the properties defined in this
1962306a36Sopenharmony_ci  document are defined as follows. The sensor tree bindings are responsible for
2062306a36Sopenharmony_ci  defining whether each property is required or optional.
2162306a36Sopenharmony_ci
2262306a36Sopenharmony_ciproperties:
2362306a36Sopenharmony_ci  proximity-near-level:
2462306a36Sopenharmony_ci    $ref: /schemas/types.yaml#/definitions/uint32
2562306a36Sopenharmony_ci    description: |
2662306a36Sopenharmony_ci      For proximity sensors whether an object can be considered near to the
2762306a36Sopenharmony_ci      device depends on parameters like sensor position, covering glass and
2862306a36Sopenharmony_ci      aperture. This value gives an indication to userspace for which
2962306a36Sopenharmony_ci      sensor readings this is the case.
3062306a36Sopenharmony_ci
3162306a36Sopenharmony_ci      Raw proximity values equal or above this level should be
3262306a36Sopenharmony_ci      considered 'near' to the device (an object is near to the
3362306a36Sopenharmony_ci      sensor).
3462306a36Sopenharmony_ci
3562306a36Sopenharmony_ciadditionalProperties: true
3662306a36Sopenharmony_ci
3762306a36Sopenharmony_ci...
38