2019-04-24 09:24:18

by Brian Masney

[permalink] [raw]
Subject: [PATCH v2 1/2] dt-bindings: iio: tsl2772: convert bindings to YAML format

Convert the tsl2772 device tree bindings to the new YAML format.

Signed-off-by: Brian Masney <[email protected]>
---
Changes since v1:
- Dropped description from reg and interrupts properties.
- Dropped $ref from led-max-microamp, vdd-supply, and vddio-supply.
- Changed 'tsl2772@39' in example to 'proximity-sensor@39'

.../devicetree/bindings/iio/light/tsl2772.txt | 42 ----------
.../bindings/iio/light/tsl2772.yaml | 80 +++++++++++++++++++
2 files changed, 80 insertions(+), 42 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/iio/light/tsl2772.txt
create mode 100644 Documentation/devicetree/bindings/iio/light/tsl2772.yaml

diff --git a/Documentation/devicetree/bindings/iio/light/tsl2772.txt b/Documentation/devicetree/bindings/iio/light/tsl2772.txt
deleted file mode 100644
index 1c5e6f17a1df..000000000000
--- a/Documentation/devicetree/bindings/iio/light/tsl2772.txt
+++ /dev/null
@@ -1,42 +0,0 @@
-* AMS/TAOS ALS and proximity sensor
-
-Required properties:
-
- - compatible: Should be one of
- "amstaos,tsl2571"
- "amstaos,tsl2671"
- "amstaos,tmd2671"
- "amstaos,tsl2771"
- "amstaos,tmd2771"
- "amstaos,tsl2572"
- "amstaos,tsl2672"
- "amstaos,tmd2672"
- "amstaos,tsl2772"
- "amstaos,tmd2772"
- "avago,apds9930"
- - reg: the I2C address of the device
-
-Optional properties:
-
- - amstaos,proximity-diodes - proximity diodes to enable. <0>, <1>, or <0 1>
- are the only valid values.
- - led-max-microamp - current for the proximity LED. Must be 100000, 50000,
- 25000, or 13000.
- - vdd-supply: phandle to the regulator that provides power to the sensor.
- - vddio-supply: phandle to the regulator that provides power to the bus.
- - interrupts: the sole interrupt generated by the device
-
- Refer to interrupt-controller/interrupts.txt for generic interrupt client
- node bindings.
-
-Example:
-
-tsl2772@39 {
- compatible = "amstaos,tsl2772";
- reg = <0x39>;
- interrupts-extended = <&msmgpio 61 IRQ_TYPE_EDGE_FALLING>;
- vdd-supply = <&pm8941_l17>;
- vddio-supply = <&pm8941_lvs1>;
- amstaos,proximity-diodes = <0>;
- led-max-microamp = <100000>;
-};
diff --git a/Documentation/devicetree/bindings/iio/light/tsl2772.yaml b/Documentation/devicetree/bindings/iio/light/tsl2772.yaml
new file mode 100644
index 000000000000..2ebc8d727f09
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/light/tsl2772.yaml
@@ -0,0 +1,80 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/light/tsl2772.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: AMS/TAOS Ambient Light Sensor (ALS) and Proximity Detector
+
+maintainers:
+ - Brian Masney <[email protected]>
+
+description: |
+ Ambient light sensing and proximity detection with an i2c interface.
+ https://ams.com/documents/20143/36005/TSL2772_DS000181_2-00.pdf
+
+properties:
+ compatible:
+ enum:
+ - amstaos,tsl2571
+ - amstaos,tsl2671
+ - amstaos,tmd2671
+ - amstaos,tsl2771
+ - amstaos,tmd2771
+ - amstaos,tsl2572
+ - amstaos,tsl2672
+ - amstaos,tmd2672
+ - amstaos,tsl2772
+ - amstaos,tmd2772
+ - avago,apds9930
+
+ reg:
+ maxItems: 1
+
+ amstaos,proximity-diodes:
+ description: Proximity diodes to enable
+ allOf:
+ - $ref: /schemas/types.yaml#/definitions/uint32-array
+ - minItems: 1
+ maxItems: 2
+ items:
+ minimum: 0
+ maximum: 1
+
+ interrupts:
+ maxItems: 1
+
+ led-max-microamp:
+ description: Current for the proximity LED
+ allOf:
+ - enum: [13000, 25000, 50000, 100000]
+
+ vdd-supply:
+ description: Regulator that provides power to the sensor
+
+ vddio-supply:
+ description: Regulator that provides power to the bus
+
+required:
+ - compatible
+ - reg
+
+examples:
+ - |
+ #include <dt-bindings/interrupt-controller/irq.h>
+
+ i2c {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ proximity-sensor@39 {
+ compatible = "amstaos,tsl2772";
+ reg = <0x39>;
+ interrupts-extended = <&msmgpio 61 IRQ_TYPE_EDGE_FALLING>;
+ vdd-supply = <&pm8941_l17>;
+ vddio-supply = <&pm8941_lvs1>;
+ amstaos,proximity-diodes = <0>;
+ led-max-microamp = <100000>;
+ };
+ };
+...
--
2.20.1


2019-04-24 09:23:59

by Brian Masney

[permalink] [raw]
Subject: [PATCH v2 2/2] dt-bindings: iio: tsl2583: convert bindings to YAML format

Convert the tsl2583 device tree bindings to the new YAML format.

Signed-off-by: Brian Masney <[email protected]>
---
Changes since v1:
- Dropped description from reg and interrupts properties.
- Dropped $ref from vcc-supply property.
- Changed 'tsl2581@29' in example to 'als-sensor@29'

I can no longer find the data sheet for this device linked on AMS's
site. The datasheet is still on Digikey [1], however I didn't include it
in the binding document since I assume that we should only link to the
manufacturer's website.
https://media.digikey.com/pdf/Data%20Sheets/Austriamicrosystems%20PDFs/TSL2581,83.pdf

.../devicetree/bindings/iio/light/tsl2583.txt | 25 ----------
.../bindings/iio/light/tsl2583.yaml | 46 +++++++++++++++++++
2 files changed, 46 insertions(+), 25 deletions(-)
delete mode 100644 Documentation/devicetree/bindings/iio/light/tsl2583.txt
create mode 100644 Documentation/devicetree/bindings/iio/light/tsl2583.yaml

diff --git a/Documentation/devicetree/bindings/iio/light/tsl2583.txt b/Documentation/devicetree/bindings/iio/light/tsl2583.txt
deleted file mode 100644
index 059dffa1829a..000000000000
--- a/Documentation/devicetree/bindings/iio/light/tsl2583.txt
+++ /dev/null
@@ -1,25 +0,0 @@
-* TAOS TSL 2580/2581/2583 ALS sensor
-
-Required properties:
-
- - compatible: Should be one of
- "amstaos,tsl2580"
- "amstaos,tsl2581"
- "amstaos,tsl2583"
- - reg: the I2C address of the device
-
-Optional properties:
-
- - interrupts: the sole interrupt generated by the device
-
- Refer to interrupt-controller/interrupts.txt for generic interrupt client
- node bindings.
-
- - vcc-supply: phandle to the regulator that provides power to the sensor.
-
-Example:
-
-tsl2581@29 {
- compatible = "amstaos,tsl2581";
- reg = <0x29>;
-};
diff --git a/Documentation/devicetree/bindings/iio/light/tsl2583.yaml b/Documentation/devicetree/bindings/iio/light/tsl2583.yaml
new file mode 100644
index 000000000000..6989a8a54c5c
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/light/tsl2583.yaml
@@ -0,0 +1,46 @@
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/light/tsl2583.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: AMS/TAOS Ambient Light Sensor (ALS)
+
+maintainers:
+ - Brian Masney <[email protected]>
+
+description: |
+ Ambient light sensing with an i2c interface.
+
+properties:
+ compatible:
+ enum:
+ - amstaos,tsl2580
+ - amstaos,tsl2581
+ - amstaos,tsl2583
+
+ reg:
+ maxItems: 1
+
+ interrupts:
+ maxItems: 1
+
+ vcc-supply:
+ description: Regulator that provides power to the sensor
+
+required:
+ - compatible
+ - reg
+
+examples:
+ - |
+ i2c {
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ als-sensor@29 {
+ compatible = "amstaos,tsl2581";
+ reg = <0x29>;
+ };
+ };
+...
--
2.20.1

2019-04-24 12:29:35

by Brian Masney

[permalink] [raw]
Subject: Re: [PATCH v2 1/2] dt-bindings: iio: tsl2772: convert bindings to YAML format

On Wed, Apr 24, 2019 at 05:22:37AM -0400, Brian Masney wrote:
> Convert the tsl2772 device tree bindings to the new YAML format.
>
> Signed-off-by: Brian Masney <[email protected]>
> ---
> Changes since v1:
> - Dropped description from reg and interrupts properties.
> - Dropped $ref from led-max-microamp, vdd-supply, and vddio-supply.
> - Changed 'tsl2772@39' in example to 'proximity-sensor@39'

> +examples:
> + - |
> + #include <dt-bindings/interrupt-controller/irq.h>
> +
> + i2c {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + proximity-sensor@39 {

I didn't think of this until after I sent out that patch, but I think
this example should be 'als-proximity-sensor@39' instead of
'proximity-sensor@39'.

Brian

2019-04-24 15:50:09

by Rob Herring

[permalink] [raw]
Subject: Re: [PATCH v2 1/2] dt-bindings: iio: tsl2772: convert bindings to YAML format

On Wed, Apr 24, 2019 at 4:22 AM Brian Masney <[email protected]> wrote:
>
> Convert the tsl2772 device tree bindings to the new YAML format.
>
> Signed-off-by: Brian Masney <[email protected]>
> ---
> Changes since v1:
> - Dropped description from reg and interrupts properties.
> - Dropped $ref from led-max-microamp, vdd-supply, and vddio-supply.
> - Changed 'tsl2772@39' in example to 'proximity-sensor@39'
>
> .../devicetree/bindings/iio/light/tsl2772.txt | 42 ----------
> .../bindings/iio/light/tsl2772.yaml | 80 +++++++++++++++++++
> 2 files changed, 80 insertions(+), 42 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/iio/light/tsl2772.txt
> create mode 100644 Documentation/devicetree/bindings/iio/light/tsl2772.yaml
>
> diff --git a/Documentation/devicetree/bindings/iio/light/tsl2772.txt b/Documentation/devicetree/bindings/iio/light/tsl2772.txt
> deleted file mode 100644
> index 1c5e6f17a1df..000000000000
> --- a/Documentation/devicetree/bindings/iio/light/tsl2772.txt
> +++ /dev/null
> @@ -1,42 +0,0 @@
> -* AMS/TAOS ALS and proximity sensor
> -
> -Required properties:
> -
> - - compatible: Should be one of
> - "amstaos,tsl2571"
> - "amstaos,tsl2671"
> - "amstaos,tmd2671"
> - "amstaos,tsl2771"
> - "amstaos,tmd2771"
> - "amstaos,tsl2572"
> - "amstaos,tsl2672"
> - "amstaos,tmd2672"
> - "amstaos,tsl2772"
> - "amstaos,tmd2772"
> - "avago,apds9930"
> - - reg: the I2C address of the device
> -
> -Optional properties:
> -
> - - amstaos,proximity-diodes - proximity diodes to enable. <0>, <1>, or <0 1>
> - are the only valid values.
> - - led-max-microamp - current for the proximity LED. Must be 100000, 50000,
> - 25000, or 13000.
> - - vdd-supply: phandle to the regulator that provides power to the sensor.
> - - vddio-supply: phandle to the regulator that provides power to the bus.
> - - interrupts: the sole interrupt generated by the device
> -
> - Refer to interrupt-controller/interrupts.txt for generic interrupt client
> - node bindings.
> -
> -Example:
> -
> -tsl2772@39 {
> - compatible = "amstaos,tsl2772";
> - reg = <0x39>;
> - interrupts-extended = <&msmgpio 61 IRQ_TYPE_EDGE_FALLING>;
> - vdd-supply = <&pm8941_l17>;
> - vddio-supply = <&pm8941_lvs1>;
> - amstaos,proximity-diodes = <0>;
> - led-max-microamp = <100000>;
> -};
> diff --git a/Documentation/devicetree/bindings/iio/light/tsl2772.yaml b/Documentation/devicetree/bindings/iio/light/tsl2772.yaml
> new file mode 100644
> index 000000000000..2ebc8d727f09
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/light/tsl2772.yaml
> @@ -0,0 +1,80 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/light/tsl2772.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: AMS/TAOS Ambient Light Sensor (ALS) and Proximity Detector
> +
> +maintainers:
> + - Brian Masney <[email protected]>
> +
> +description: |
> + Ambient light sensing and proximity detection with an i2c interface.
> + https://ams.com/documents/20143/36005/TSL2772_DS000181_2-00.pdf
> +
> +properties:
> + compatible:
> + enum:
> + - amstaos,tsl2571
> + - amstaos,tsl2671
> + - amstaos,tmd2671
> + - amstaos,tsl2771
> + - amstaos,tmd2771
> + - amstaos,tsl2572
> + - amstaos,tsl2672
> + - amstaos,tmd2672
> + - amstaos,tsl2772
> + - amstaos,tmd2772
> + - avago,apds9930
> +
> + reg:
> + maxItems: 1
> +
> + amstaos,proximity-diodes:
> + description: Proximity diodes to enable
> + allOf:
> + - $ref: /schemas/types.yaml#/definitions/uint32-array
> + - minItems: 1
> + maxItems: 2
> + items:
> + minimum: 0
> + maximum: 1
> +
> + interrupts:
> + maxItems: 1
> +
> + led-max-microamp:
> + description: Current for the proximity LED
> + allOf:

No need for the allOf here with only one entry.

> + - enum: [13000, 25000, 50000, 100000]

2019-04-24 16:02:20

by Rob Herring

[permalink] [raw]
Subject: Re: [PATCH v2 2/2] dt-bindings: iio: tsl2583: convert bindings to YAML format

On Wed, Apr 24, 2019 at 4:22 AM Brian Masney <[email protected]> wrote:
>
> Convert the tsl2583 device tree bindings to the new YAML format.
>
> Signed-off-by: Brian Masney <[email protected]>
> ---
> Changes since v1:
> - Dropped description from reg and interrupts properties.
> - Dropped $ref from vcc-supply property.
> - Changed 'tsl2581@29' in example to 'als-sensor@29'
>
> I can no longer find the data sheet for this device linked on AMS's
> site. The datasheet is still on Digikey [1], however I didn't include it
> in the binding document since I assume that we should only link to the
> manufacturer's website.
> https://media.digikey.com/pdf/Data%20Sheets/Austriamicrosystems%20PDFs/TSL2581,83.pdf
>
> .../devicetree/bindings/iio/light/tsl2583.txt | 25 ----------
> .../bindings/iio/light/tsl2583.yaml | 46 +++++++++++++++++++
> 2 files changed, 46 insertions(+), 25 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/iio/light/tsl2583.txt
> create mode 100644 Documentation/devicetree/bindings/iio/light/tsl2583.yaml
>
> diff --git a/Documentation/devicetree/bindings/iio/light/tsl2583.txt b/Documentation/devicetree/bindings/iio/light/tsl2583.txt
> deleted file mode 100644
> index 059dffa1829a..000000000000
> --- a/Documentation/devicetree/bindings/iio/light/tsl2583.txt
> +++ /dev/null
> @@ -1,25 +0,0 @@
> -* TAOS TSL 2580/2581/2583 ALS sensor
> -
> -Required properties:
> -
> - - compatible: Should be one of
> - "amstaos,tsl2580"
> - "amstaos,tsl2581"
> - "amstaos,tsl2583"
> - - reg: the I2C address of the device
> -
> -Optional properties:
> -
> - - interrupts: the sole interrupt generated by the device
> -
> - Refer to interrupt-controller/interrupts.txt for generic interrupt client
> - node bindings.
> -
> - - vcc-supply: phandle to the regulator that provides power to the sensor.
> -
> -Example:
> -
> -tsl2581@29 {
> - compatible = "amstaos,tsl2581";
> - reg = <0x29>;
> -};
> diff --git a/Documentation/devicetree/bindings/iio/light/tsl2583.yaml b/Documentation/devicetree/bindings/iio/light/tsl2583.yaml
> new file mode 100644
> index 000000000000..6989a8a54c5c
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/light/tsl2583.yaml
> @@ -0,0 +1,46 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/light/tsl2583.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: AMS/TAOS Ambient Light Sensor (ALS)
> +
> +maintainers:
> + - Brian Masney <[email protected]>
> +
> +description: |
> + Ambient light sensing with an i2c interface.
> +
> +properties:
> + compatible:
> + enum:
> + - amstaos,tsl2580
> + - amstaos,tsl2581
> + - amstaos,tsl2583
> +
> + reg:
> + maxItems: 1
> +
> + interrupts:
> + maxItems: 1
> +
> + vcc-supply:
> + description: Regulator that provides power to the sensor
> +
> +required:
> + - compatible
> + - reg
> +
> +examples:
> + - |
> + i2c {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + als-sensor@29 {

light-sensor@29

With that,

Reviewed-by: Rob Herring <[email protected]>

2019-04-24 21:32:54

by Rob Herring

[permalink] [raw]
Subject: Re: [PATCH v2 1/2] dt-bindings: iio: tsl2772: convert bindings to YAML format

On Wed, Apr 24, 2019 at 7:26 AM Brian Masney <[email protected]> wrote:
>
> On Wed, Apr 24, 2019 at 05:22:37AM -0400, Brian Masney wrote:
> > Convert the tsl2772 device tree bindings to the new YAML format.
> >
> > Signed-off-by: Brian Masney <[email protected]>
> > ---
> > Changes since v1:
> > - Dropped description from reg and interrupts properties.
> > - Dropped $ref from led-max-microamp, vdd-supply, and vddio-supply.
> > - Changed 'tsl2772@39' in example to 'proximity-sensor@39'
>
> > +examples:
> > + - |
> > + #include <dt-bindings/interrupt-controller/irq.h>
> > +
> > + i2c {
> > + #address-cells = <1>;
> > + #size-cells = <0>;
> > +
> > + proximity-sensor@39 {
>
> I didn't think of this until after I sent out that patch, but I think
> this example should be 'als-proximity-sensor@39' instead of
> 'proximity-sensor@39'.

I'd just do 'sensor@39' in that case. We normally use light-sensor for
ALS devices, but we haven't been real consistent here.

Rob