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: Guido Günther <[email protected]>
---
.../devicetree/bindings/iio/common.yaml | 35 +++++++++++++++++++
1 file changed, 35 insertions(+)
create mode 100644 Documentation/devicetree/bindings/iio/common.yaml
diff --git a/Documentation/devicetree/bindings/iio/common.yaml b/Documentation/devicetree/bindings/iio/common.yaml
new file mode 100644
index 000000000000..97ffcb77043d
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/common.yaml
@@ -0,0 +1,35 @@
+# 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 <[email protected]>
+ - Guido Günther <[email protected]>
+
+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).
+
+...
--
2.23.0
On Sun, 5 Apr 2020 15:50:29 +0200
Guido Günther <[email protected]> wrote:
> 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: Guido Günther <[email protected]>
This works for me. However, I would like to give time for Rob and
others to comment on the syntax, naming etc of this file.
Thanks,
Jonathan
> ---
> .../devicetree/bindings/iio/common.yaml | 35 +++++++++++++++++++
> 1 file changed, 35 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/iio/common.yaml
>
> diff --git a/Documentation/devicetree/bindings/iio/common.yaml b/Documentation/devicetree/bindings/iio/common.yaml
> new file mode 100644
> index 000000000000..97ffcb77043d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/common.yaml
> @@ -0,0 +1,35 @@
> +# 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 <[email protected]>
> + - Guido Günther <[email protected]>
> +
> +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).
> +
> +...
On Sun, 5 Apr 2020 15:50:29 +0200, =?UTF-8?q?Guido=20G=C3=BCnther?= wrote:
> 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: Guido G?nther <[email protected]>
> ---
> .../devicetree/bindings/iio/common.yaml | 35 +++++++++++++++++++
> 1 file changed, 35 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/iio/common.yaml
>
Reviewed-by: Rob Herring <[email protected]>
On Tue, 14 Apr 2020 16:49:23 -0500
Rob Herring <[email protected]> wrote:
> On Sun, 5 Apr 2020 15:50:29 +0200, =?UTF-8?q?Guido=20G=C3=BCnther?= wrote:
> > 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: Guido Günther <[email protected]>
> > ---
> > .../devicetree/bindings/iio/common.yaml | 35 +++++++++++++++++++
> > 1 file changed, 35 insertions(+)
> > create mode 100644 Documentation/devicetree/bindings/iio/common.yaml
> >
>
> Reviewed-by: Rob Herring <[email protected]>
Applied to the togreg branch of iio.git and pushed out as testing.
Thanks
Jonathan