diff mbox series

[v4,2/5] dt-bindings: iio: Introduce common properties for iio sensors

Message ID 8b91f0b7fa76ca4b2f3cdc251411829f71f8d810.1586094535.git.agx@sigxcpu.org (mailing list archive)
State New, archived
Headers show
Series iio: vcnl4000: Export near level property for proximity sensor | expand

Commit Message

Guido Günther April 5, 2020, 1:50 p.m. UTC
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 <agx@sigxcpu.org>
---
 .../devicetree/bindings/iio/common.yaml       | 35 +++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/common.yaml

Comments

Jonathan Cameron April 12, 2020, 11:28 a.m. UTC | #1
On Sun,  5 Apr 2020 15:50:29 +0200
Guido Günther <agx@sigxcpu.org> 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 <agx@sigxcpu.org>
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 <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).
> +
> +...
Rob Herring (Arm) April 14, 2020, 9:49 p.m. UTC | #2
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 <agx@sigxcpu.org>
> ---
>  .../devicetree/bindings/iio/common.yaml       | 35 +++++++++++++++++++
>  1 file changed, 35 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/common.yaml
> 

Reviewed-by: Rob Herring <robh@kernel.org>
Jonathan Cameron April 18, 2020, 6:03 p.m. UTC | #3
On Tue, 14 Apr 2020 16:49:23 -0500
Rob Herring <robh@kernel.org> 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 <agx@sigxcpu.org>
> > ---
> >  .../devicetree/bindings/iio/common.yaml       | 35 +++++++++++++++++++
> >  1 file changed, 35 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/iio/common.yaml
> >   
> 
> Reviewed-by: Rob Herring <robh@kernel.org>

Applied to the togreg branch of iio.git and pushed out as testing.

Thanks

Jonathan
diff mbox series

Patch

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 <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).
+
+...