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