Commit 445b16fb authored by Guido Günther's avatar Guido Günther Committed by Jonathan Cameron
Browse files

dt-bindings: iio: Introduce common properties for iio sensors 



Introduce a file for common properties of iio sensors. So far this
contains the new proximity-near-level property for proximity sensors
that indicates when an object should be considered near.

Signed-off-by: default avatarGuido Günther <agx@sigxcpu.org>
Signed-off-by: default avatarJonathan Cameron <Jonathan.Cameron@huawei.com>
parent c194e238

Documentation/devicetree/bindings/iio/common.yaml

0 → 100644
+35 −0
Original line number Diff line number Diff line 
# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)

%YAML 1.2

---

$id: http://devicetree.org/schemas/iio/common.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Common properties for iio sensors



maintainers:

  - Jonathan Cameron <jic23@kernel.org>

  - Guido Günther <agx@sigxcpu.org>



description: |

  This document defines device tree properties common to several iio

  sensors. It doesn't constitue a device tree binding specification by itself but

  is meant to be referenced by device tree bindings.



  When referenced from sensor tree bindings the properties defined in this

  document are defined as follows. The sensor tree bindings are responsible for

  defining whether each property is required or optional.



properties:

  proximity-near-level:

    $ref: /schemas/types.yaml#/definitions/uint32

    description: |

      For proximity sensors whether an object can be considered near to the

      device depends on parameters like sensor position, covering glass and

      aperture. This value gives an indication to userspace for which

      sensor readings this is the case.



      Raw proximity values equal or above this level should be

      considered 'near' to the device (an object is near to the

      sensor).



...