[v1,1/2] dt-bindings: iio: light: Avago APDS9306
Commit Message
v0 -> v1
- Squashing Avago (Broadcom) APDS9300 and APDS9960 schemas into one as
they look similar
- Adding support for APDS9306 in the same schema file
- Adding mandatory interrupt property requirement for APDS9960 as per the
driver's probe method which fails if interrupt bindings are not defined.
Both APDS9300 and APDS9306 (this patch set) supports sensors with and
without hardware interrupt bindings
- In the device tree example, replacing interrupt type number with macro
from irq.h
- Updated the vin to vdd which is the same for all the three sensors
- Used proper "Datasheet:" tags
Signed-off-by: Subhajit Ghosh <subhajit.ghosh@tweaklogic.com>
---
.../bindings/iio/light/avago,apds9300.yaml | 35 ++++++++++++---
.../bindings/iio/light/avago,apds9960.yaml | 44 -------------------
2 files changed, 30 insertions(+), 49 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/iio/light/avago,apds9960.yaml
Comments
Yo,
On Fri, Oct 27, 2023 at 01:05:31AM +1030, Subhajit Ghosh wrote:
Missing a commit message.
> v0 -> v1
> - Squashing Avago (Broadcom) APDS9300 and APDS9960 schemas into one as
> they look similar
> - Adding support for APDS9306 in the same schema file
> - Adding mandatory interrupt property requirement for APDS9960 as per the
> driver's probe method which fails if interrupt bindings are not defined.
I know this is in the changelog, and not the commit message, so you're
saying what you changed and not the reasoning for doing something, but
it'd be good to mention why the interrupt is required for this one device
only in the commit message (and since this is a binding, that
explanation needs to be something rooted in how the hardware works).
> Both APDS9300 and APDS9306 (this patch set) supports sensors with and
> without hardware interrupt bindings
> - In the device tree example, replacing interrupt type number with macro
> from irq.h
> - Updated the vin to vdd which is the same for all the three sensors
> - Used proper "Datasheet:" tags
This all goes below the --- line.
Cheers,
Conor.
> Signed-off-by: Subhajit Ghosh <subhajit.ghosh@tweaklogic.com>
> ---
> .../bindings/iio/light/avago,apds9300.yaml | 35 ++++++++++++---
> .../bindings/iio/light/avago,apds9960.yaml | 44 -------------------
> 2 files changed, 30 insertions(+), 49 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/iio/light/avago,apds9960.yaml
>
> diff --git a/Documentation/devicetree/bindings/iio/light/avago,apds9300.yaml b/Documentation/devicetree/bindings/iio/light/avago,apds9300.yaml
> index 206af44f2c43..7a24a97d0594 100644
> --- a/Documentation/devicetree/bindings/iio/light/avago,apds9300.yaml
> +++ b/Documentation/devicetree/bindings/iio/light/avago,apds9300.yaml
> @@ -4,17 +4,26 @@
> $id: http://devicetree.org/schemas/iio/light/avago,apds9300.yaml#
> $schema: http://devicetree.org/meta-schemas/core.yaml#
>
> -title: Avago APDS9300 ambient light sensor
> +title: Avago Gesture, RGB, ALS and Proximity sensors
>
> maintainers:
> - Jonathan Cameron <jic23@kernel.org>
> + - Matt Ranostay <matt@ranostay.sg>
> + - Subhajit Ghosh <subhajit.ghosh@tweaklogic.com>
>
> description: |
> - Datasheet at https://www.avagotech.com/docs/AV02-1077EN
> + Avago (Broadcom) optical and proximity sensors with I2C interfaces.
> + Datasheet: https://docs.broadcom.com/doc/AV02-1077EN
> + Datasheet: https://docs.broadcom.com/doc/AV02-4191EN
> + Datasheet: https://docs.broadcom.com/doc/AV02-4755EN
>
> properties:
> compatible:
> - const: avago,apds9300
> + oneOf:
> + - enum:
> + - avago,apds9300
> + - avago,apds9306
> + - avago,apds9960
>
> reg:
> maxItems: 1
> @@ -22,14 +31,30 @@ properties:
> interrupts:
> maxItems: 1
>
> -additionalProperties: false
> + vdd-supply: true
>
> required:
> - compatible
> - reg
>
> +allOf:
> + - $ref: ../common.yaml#
> + - if:
> + properties:
> + compatible:
> + contains:
> + enum:
> + - avago,apds9960
> + then:
> + required:
> + - interrupts
> +
> +additionalProperties: false
> +
> examples:
> - |
> + #include <dt-bindings/interrupt-controller/irq.h>
> +
> i2c {
> #address-cells = <1>;
> #size-cells = <0>;
> @@ -38,7 +63,7 @@ examples:
> compatible = "avago,apds9300";
> reg = <0x39>;
> interrupt-parent = <&gpio2>;
> - interrupts = <29 8>;
> + interrupts = <29 IRQ_TYPE_EDGE_FALLING>;
> };
> };
> ...
> diff --git a/Documentation/devicetree/bindings/iio/light/avago,apds9960.yaml b/Documentation/devicetree/bindings/iio/light/avago,apds9960.yaml
> deleted file mode 100644
> index f06e0fda5629..000000000000
> --- a/Documentation/devicetree/bindings/iio/light/avago,apds9960.yaml
> +++ /dev/null
> @@ -1,44 +0,0 @@
> -# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> -%YAML 1.2
> ----
> -$id: http://devicetree.org/schemas/iio/light/avago,apds9960.yaml#
> -$schema: http://devicetree.org/meta-schemas/core.yaml#
> -
> -title: Avago APDS9960 gesture/RGB/ALS/proximity sensor
> -
> -maintainers:
> - - Matt Ranostay <matt.ranostay@konsulko.com>
> -
> -description: |
> - Datasheet at https://www.avagotech.com/docs/AV02-4191EN
> -
> -properties:
> - compatible:
> - const: avago,apds9960
> -
> - reg:
> - maxItems: 1
> -
> - interrupts:
> - maxItems: 1
> -
> -additionalProperties: false
> -
> -required:
> - - compatible
> - - reg
> -
> -examples:
> - - |
> - i2c {
> - #address-cells = <1>;
> - #size-cells = <0>;
> -
> - light-sensor@39 {
> - compatible = "avago,apds9960";
> - reg = <0x39>;
> - interrupt-parent = <&gpio1>;
> - interrupts = <16 1>;
> - };
> - };
> -...
> --
> 2.34.1
>
@@ -4,17 +4,26 @@
$id: http://devicetree.org/schemas/iio/light/avago,apds9300.yaml#
$schema: http://devicetree.org/meta-schemas/core.yaml#
-title: Avago APDS9300 ambient light sensor
+title: Avago Gesture, RGB, ALS and Proximity sensors
maintainers:
- Jonathan Cameron <jic23@kernel.org>
+ - Matt Ranostay <matt@ranostay.sg>
+ - Subhajit Ghosh <subhajit.ghosh@tweaklogic.com>
description: |
- Datasheet at https://www.avagotech.com/docs/AV02-1077EN
+ Avago (Broadcom) optical and proximity sensors with I2C interfaces.
+ Datasheet: https://docs.broadcom.com/doc/AV02-1077EN
+ Datasheet: https://docs.broadcom.com/doc/AV02-4191EN
+ Datasheet: https://docs.broadcom.com/doc/AV02-4755EN
properties:
compatible:
- const: avago,apds9300
+ oneOf:
+ - enum:
+ - avago,apds9300
+ - avago,apds9306
+ - avago,apds9960
reg:
maxItems: 1
@@ -22,14 +31,30 @@ properties:
interrupts:
maxItems: 1
-additionalProperties: false
+ vdd-supply: true
required:
- compatible
- reg
+allOf:
+ - $ref: ../common.yaml#
+ - if:
+ properties:
+ compatible:
+ contains:
+ enum:
+ - avago,apds9960
+ then:
+ required:
+ - interrupts
+
+additionalProperties: false
+
examples:
- |
+ #include <dt-bindings/interrupt-controller/irq.h>
+
i2c {
#address-cells = <1>;
#size-cells = <0>;
@@ -38,7 +63,7 @@ examples:
compatible = "avago,apds9300";
reg = <0x39>;
interrupt-parent = <&gpio2>;
- interrupts = <29 8>;
+ interrupts = <29 IRQ_TYPE_EDGE_FALLING>;
};
};
...
deleted file mode 100644
@@ -1,44 +0,0 @@
-# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
-%YAML 1.2
----
-$id: http://devicetree.org/schemas/iio/light/avago,apds9960.yaml#
-$schema: http://devicetree.org/meta-schemas/core.yaml#
-
-title: Avago APDS9960 gesture/RGB/ALS/proximity sensor
-
-maintainers:
- - Matt Ranostay <matt.ranostay@konsulko.com>
-
-description: |
- Datasheet at https://www.avagotech.com/docs/AV02-4191EN
-
-properties:
- compatible:
- const: avago,apds9960
-
- reg:
- maxItems: 1
-
- interrupts:
- maxItems: 1
-
-additionalProperties: false
-
-required:
- - compatible
- - reg
-
-examples:
- - |
- i2c {
- #address-cells = <1>;
- #size-cells = <0>;
-
- light-sensor@39 {
- compatible = "avago,apds9960";
- reg = <0x39>;
- interrupt-parent = <&gpio1>;
- interrupts = <16 1>;
- };
- };
-...