xref: /linux/Documentation/devicetree/bindings/iio/common.yaml (revision a1c613ae4c322ddd58d5a8539dbfba2a0380a8c0)
1445b16fbSGuido Günther# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
2445b16fbSGuido Günther%YAML 1.2
3445b16fbSGuido Günther---
4445b16fbSGuido Günther$id: http://devicetree.org/schemas/iio/common.yaml#
5445b16fbSGuido Günther$schema: http://devicetree.org/meta-schemas/core.yaml#
6445b16fbSGuido Günther
7445b16fbSGuido Günthertitle: Common properties for iio sensors
8445b16fbSGuido Günther
9445b16fbSGuido Günthermaintainers:
10445b16fbSGuido Günther  - Jonathan Cameron <jic23@kernel.org>
11445b16fbSGuido Günther  - Guido Günther <agx@sigxcpu.org>
12445b16fbSGuido Günther
13445b16fbSGuido Güntherdescription: |
14445b16fbSGuido Günther  This document defines device tree properties common to several iio
15*47aab533SBjorn Helgaas  sensors. It doesn't constitute a device tree binding specification by itself but
16445b16fbSGuido Günther  is meant to be referenced by device tree bindings.
17445b16fbSGuido Günther
18445b16fbSGuido Günther  When referenced from sensor tree bindings the properties defined in this
19445b16fbSGuido Günther  document are defined as follows. The sensor tree bindings are responsible for
20445b16fbSGuido Günther  defining whether each property is required or optional.
21445b16fbSGuido Günther
22445b16fbSGuido Güntherproperties:
23445b16fbSGuido Günther  proximity-near-level:
24445b16fbSGuido Günther    $ref: /schemas/types.yaml#/definitions/uint32
25445b16fbSGuido Günther    description: |
26445b16fbSGuido Günther      For proximity sensors whether an object can be considered near to the
27445b16fbSGuido Günther      device depends on parameters like sensor position, covering glass and
28445b16fbSGuido Günther      aperture. This value gives an indication to userspace for which
29445b16fbSGuido Günther      sensor readings this is the case.
30445b16fbSGuido Günther
31445b16fbSGuido Günther      Raw proximity values equal or above this level should be
32445b16fbSGuido Günther      considered 'near' to the device (an object is near to the
33445b16fbSGuido Günther      sensor).
34445b16fbSGuido Günther
356a0e321eSRob HerringadditionalProperties: true
366a0e321eSRob Herring
37445b16fbSGuido Günther...
38