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