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