[1/3] dt-bindings: ROHM BU27010 RGBC + flickering sensor

Commit Message

Matti Vaittinen June 13, 2023, 10:19 a.m. UTC

The ROHM BU27010 is a sensor with 6 photodiodes (red, green, blue, clear,
IR and flickering detection) with five configurable channels. Red, green
and flickering detection being always available and two out of the rest
three (blue, clear, IR) can be selected to be simultaneously measured.
Typical application is adjusting LCD/OLED backlight of TVs, mobile phones
and tablet PCs.

Add binding document for ROHM BU27010.

Signed-off-by: Matti Vaittinen <[e-mail]>
---
 .../bindings/iio/light/rohm,bu27010.yaml      | 49 +++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/light/rohm,bu27010.yaml

Comments

Krzysztof Kozlowski June 13, 2023, 6:42 p.m. UTC | #1

On 13/06/2023 12:19, Matti Vaittinen wrote:
> The ROHM BU27010 is a sensor with 6 photodiodes (red, green, blue, clear,
> IR and flickering detection) with five configurable channels. Red, green
> and flickering detection being always available and two out of the rest
> three (blue, clear, IR) can be selected to be simultaneously measured.
> Typical application is adjusting LCD/OLED backlight of TVs, mobile phones
> and tablet PCs.

Please use subject prefixes matching the subsystem. You can get them for
example with `git log --oneline -- DIRECTORY_OR_FILE` on the directory
your patch is touching.
e.g.: "dt-bindings: iio:"


> 
> Add binding document for ROHM BU27010.
> 
> Signed-off-by: Matti Vaittinen <[e-mail]>
> ---
>  .../bindings/iio/light/rohm,bu27010.yaml      | 49 +++++++++++++++++++
>  1 file changed, 49 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/light/rohm,bu27010.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/light/rohm,bu27010.yaml b/Documentation/devicetree/bindings/iio/light/rohm,bu27010.yaml
> new file mode 100644
> index 000000000000..2bde9d2f1def
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/light/rohm,bu27010.yaml
> @@ -0,0 +1,49 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/light/rohm,bu27010.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: ROHM BU27010 color sensor
> +
> +maintainers:
> +  - Matti Vaittinen <[e-mail]>
> +
> +description: |
> +  The ROHM BU27010 is a sensor with 6 photodiodes (red, green, blue, clear,
> +  IR and flickering detection) with five configurable channels. Red, green
> +  and flickering detection being always available and two out of the rest
> +  three (blue, clear, IR) can be selected to be simultaneously measured.
> +  Typical application is adjusting LCD/OLED backlight of TVs, mobile phones
> +  and tablet PCs.
> +
> +properties:
> +  compatible:
> +    const: rohm,bu27010
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  vdd-supply: true

Isn't vdd-supply required for the hardware to work? How does it get the
power otherwise?

> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    i2c {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +
> +      light-sensor@38 {
> +        compatible = "rohm,bu27010";
> +        reg = <0x38>;
> +      };
> +    };
> +

Trailing blank line.

Best regards,
Krzysztof

Matti Vaittinen June 14, 2023, 5:32 a.m. UTC | #2

On 6/13/23 21:42, Krzysztof Kozlowski wrote:
> On 13/06/2023 12:19, Matti Vaittinen wrote:
>> The ROHM BU27010 is a sensor with 6 photodiodes (red, green, blue, clear,
>> IR and flickering detection) with five configurable channels. Red, green
>> and flickering detection being always available and two out of the rest
>> three (blue, clear, IR) can be selected to be simultaneously measured.
>> Typical application is adjusting LCD/OLED backlight of TVs, mobile phones
>> and tablet PCs.
> 
> Please use subject prefixes matching the subsystem. You can get them for
> example with `git log --oneline -- DIRECTORY_OR_FILE` on the directory
> your patch is touching.
> e.g.: "dt-bindings: iio:"
> 

Right, thanks!

> 
>>
>> Add binding document for ROHM BU27010.
>>
>> Signed-off-by: Matti Vaittinen <[e-mail]>
>> ---
>>   .../bindings/iio/light/rohm,bu27010.yaml      | 49 +++++++++++++++++++
>>   1 file changed, 49 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/iio/light/rohm,bu27010.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/iio/light/rohm,bu27010.yaml b/Documentation/devicetree/bindings/iio/light/rohm,bu27010.yaml
>> new file mode 100644
>> index 000000000000..2bde9d2f1def
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/iio/light/rohm,bu27010.yaml
>> @@ -0,0 +1,49 @@
>> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/iio/light/rohm,bu27010.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: ROHM BU27010 color sensor
>> +
>> +maintainers:
>> +  - Matti Vaittinen <[e-mail]>
>> +
>> +description: |
>> +  The ROHM BU27010 is a sensor with 6 photodiodes (red, green, blue, clear,
>> +  IR and flickering detection) with five configurable channels. Red, green
>> +  and flickering detection being always available and two out of the rest
>> +  three (blue, clear, IR) can be selected to be simultaneously measured.
>> +  Typical application is adjusting LCD/OLED backlight of TVs, mobile phones
>> +  and tablet PCs.
>> +
>> +properties:
>> +  compatible:
>> +    const: rohm,bu27010
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  interrupts:
>> +    maxItems: 1
>> +
>> +  vdd-supply: true
> 
> Isn't vdd-supply required for the hardware to work? How does it get the
> power otherwise?

The BU27010 works by magic smoke. When smoke leaks out the sensor no 
longer works.

Ehh, I think you are right. My thinking was that it is not uncommon for 
people to not have all fixed regulators present in device-tree. But I 
agree, this does not mean we should encourage that. I'll add supply to 
the list of the required properties.

> 
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +
>> +additionalProperties: false
>> +
>> +examples:
>> +  - |
>> +    i2c {
>> +      #address-cells = <1>;
>> +      #size-cells = <0>;
>> +
>> +      light-sensor@38 {
>> +        compatible = "rohm,bu27010";
>> +        reg = <0x38>;
>> +      };
>> +    };
>> +
> 
> Trailing blank line.

Indeed. Thanks.

Yours,
	-- Matti

Krzysztof Kozlowski June 14, 2023, 6:36 a.m. UTC | #3

On 14/06/2023 07:32, Matti Vaittinen wrote:
>>> +properties:
>>> +  compatible:
>>> +    const: rohm,bu27010
>>> +
>>> +  reg:
>>> +    maxItems: 1
>>> +
>>> +  interrupts:
>>> +    maxItems: 1
>>> +
>>> +  vdd-supply: true
>>
>> Isn't vdd-supply required for the hardware to work? How does it get the
>> power otherwise?
> 
> The BU27010 works by magic smoke. When smoke leaks out the sensor no 
> longer works.
> 
> Ehh, I think you are right. My thinking was that it is not uncommon for 
> people to not have all fixed regulators present in device-tree. But I 
> agree, this does not mean we should encourage that. I'll add supply to 
> the list of the required properties.
> 
If the device actually requires a regulator, it should be required by
the bindings, even if it leads to dummies or fixed regulators on the
board DTS.

Best regards,
Krzysztof

Patch

diff --git a/Documentation/devicetree/bindings/iio/light/rohm,bu27010.yaml b/Documentation/devicetree/bindings/iio/light/rohm,bu27010.yaml
new file mode 100644
index 000000000000..2bde9d2f1def
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/light/rohm,bu27010.yaml
@@ -0,0 +1,49 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/light/rohm,bu27010.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ROHM BU27010 color sensor
+
+maintainers:
+  - Matti Vaittinen <[e-mail]>
+
+description: |
+  The ROHM BU27010 is a sensor with 6 photodiodes (red, green, blue, clear,
+  IR and flickering detection) with five configurable channels. Red, green
+  and flickering detection being always available and two out of the rest
+  three (blue, clear, IR) can be selected to be simultaneously measured.
+  Typical application is adjusting LCD/OLED backlight of TVs, mobile phones
+  and tablet PCs.
+
+properties:
+  compatible:
+    const: rohm,bu27010
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  vdd-supply: true
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c {
+      #address-cells = <1>;
+      #size-cells = <0>;
+
+      light-sensor@38 {
+        compatible = "rohm,bu27010";
+        reg = <0x38>;
+      };
+    };
+