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