18c2ecf20Sopenharmony_ci# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
28c2ecf20Sopenharmony_ci%YAML 1.2
38c2ecf20Sopenharmony_ci---
48c2ecf20Sopenharmony_ci$id: http://devicetree.org/schemas/iio/common.yaml#
58c2ecf20Sopenharmony_ci$schema: http://devicetree.org/meta-schemas/core.yaml#
68c2ecf20Sopenharmony_ci
78c2ecf20Sopenharmony_cititle: Common properties for iio sensors
88c2ecf20Sopenharmony_ci
98c2ecf20Sopenharmony_cimaintainers:
108c2ecf20Sopenharmony_ci  - Jonathan Cameron <jic23@kernel.org>
118c2ecf20Sopenharmony_ci  - Guido Günther <agx@sigxcpu.org>
128c2ecf20Sopenharmony_ci
138c2ecf20Sopenharmony_cidescription: |
148c2ecf20Sopenharmony_ci  This document defines device tree properties common to several iio
158c2ecf20Sopenharmony_ci  sensors. It doesn't constitue a device tree binding specification by itself but
168c2ecf20Sopenharmony_ci  is meant to be referenced by device tree bindings.
178c2ecf20Sopenharmony_ci
188c2ecf20Sopenharmony_ci  When referenced from sensor tree bindings the properties defined in this
198c2ecf20Sopenharmony_ci  document are defined as follows. The sensor tree bindings are responsible for
208c2ecf20Sopenharmony_ci  defining whether each property is required or optional.
218c2ecf20Sopenharmony_ci
228c2ecf20Sopenharmony_ciproperties:
238c2ecf20Sopenharmony_ci  proximity-near-level:
248c2ecf20Sopenharmony_ci    $ref: /schemas/types.yaml#/definitions/uint32
258c2ecf20Sopenharmony_ci    description: |
268c2ecf20Sopenharmony_ci      For proximity sensors whether an object can be considered near to the
278c2ecf20Sopenharmony_ci      device depends on parameters like sensor position, covering glass and
288c2ecf20Sopenharmony_ci      aperture. This value gives an indication to userspace for which
298c2ecf20Sopenharmony_ci      sensor readings this is the case.
308c2ecf20Sopenharmony_ci
318c2ecf20Sopenharmony_ci      Raw proximity values equal or above this level should be
328c2ecf20Sopenharmony_ci      considered 'near' to the device (an object is near to the
338c2ecf20Sopenharmony_ci      sensor).
348c2ecf20Sopenharmony_ci
358c2ecf20Sopenharmony_ciadditionalProperties: true
368c2ecf20Sopenharmony_ci
378c2ecf20Sopenharmony_ci...
38