diff mbox series

[v5,1/3] dt-bindings: thermal: sophgo,cv1800-thermal: Add Sophgo CV1800 thermal

Message ID 20241014073813.23984-2-heylenay@4d2.org (mailing list archive)
State New
Delegated to: Daniel Lezcano
Headers show
Series riscv: sophgo: add thermal sensor support for cv180x/sg200x SoCs | expand

Commit Message

Haylen Chu Oct. 14, 2024, 7:38 a.m. UTC
Add devicetree binding documentation for thermal sensors integrated in
Sophgo CV1800 SoCs.

Signed-off-by: Haylen Chu <heylenay@4d2.org>
---
 .../thermal/sophgo,cv1800-thermal.yaml        | 57 +++++++++++++++++++
 1 file changed, 57 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml

Comments

Krzysztof Kozlowski Oct. 15, 2024, 5:52 a.m. UTC | #1
On Mon, Oct 14, 2024 at 07:38:11AM +0000, Haylen Chu wrote:
> Add devicetree binding documentation for thermal sensors integrated in
> Sophgo CV1800 SoCs.
> 
> Signed-off-by: Haylen Chu <heylenay@4d2.org>
> ---
>  .../thermal/sophgo,cv1800-thermal.yaml        | 57 +++++++++++++++++++
>  1 file changed, 57 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml
> 
> diff --git a/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml b/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml
> new file mode 100644
> index 000000000000..14abeb7a272a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml
> @@ -0,0 +1,57 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/thermal/sophgo,cv1800-thermal.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Sophgo CV1800 on-SoC Thermal Sensor
> +
> +maintainers:
> +  - Haylen Chu <heylenay@4d2.org>
> +
> +description: Sophgo CV1800 on-SoC thermal sensor
> +
> +$ref: thermal-sensor.yaml#
> +
> +properties:
> +  compatible:
> +    enum:
> +      - sophgo,cv1800-thermal

Not much improved, judging by other patches there is no "CV1800" SoC,
but that's a family name.  Otherwise please point us to bindings or DTS
using this SoC.

Best regards,
Krzysztof
Krzysztof Kozlowski Oct. 15, 2024, 5:55 a.m. UTC | #2
On Mon, Oct 14, 2024 at 07:38:11AM +0000, Haylen Chu wrote:
> Add devicetree binding documentation for thermal sensors integrated in
> Sophgo CV1800 SoCs.
> 
> Signed-off-by: Haylen Chu <heylenay@4d2.org>
> ---
>  .../thermal/sophgo,cv1800-thermal.yaml        | 57 +++++++++++++++++++
>  1 file changed, 57 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml
> 
> diff --git a/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml b/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml
> new file mode 100644
> index 000000000000..14abeb7a272a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml
> @@ -0,0 +1,57 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/thermal/sophgo,cv1800-thermal.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Sophgo CV1800 on-SoC Thermal Sensor
> +
> +maintainers:
> +  - Haylen Chu <heylenay@4d2.org>
> +
> +description: Sophgo CV1800 on-SoC thermal sensor
> +
> +$ref: thermal-sensor.yaml#
> +
> +properties:
> +  compatible:
> +    enum:
> +      - sophgo,cv1800-thermal
> +
> +  reg:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  sample-rate-hz:
> +    minimum: 1
> +    maximum: 1908
> +    default: 1

1. Why this is a property of a board?
2. I do not see this property defined in any common schema and I am not
sure if it even should. Sample rate appears from time to time, but not
in context of thermal sensors, so this should have vendor prefix.

Best regards,
Krzysztof
Haylen Chu Oct. 15, 2024, 1:07 p.m. UTC | #3
On Tue, Oct 15, 2024 at 07:52:33AM +0200, Krzysztof Kozlowski wrote:
> On Mon, Oct 14, 2024 at 07:38:11AM +0000, Haylen Chu wrote:
> > Add devicetree binding documentation for thermal sensors integrated in
> > Sophgo CV1800 SoCs.
> > 
> > Signed-off-by: Haylen Chu <heylenay@4d2.org>
> > ---
> >  .../thermal/sophgo,cv1800-thermal.yaml        | 57 +++++++++++++++++++
> >  1 file changed, 57 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml b/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml
> > new file mode 100644
> > index 000000000000..14abeb7a272a
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml
> > @@ -0,0 +1,57 @@
> > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/thermal/sophgo,cv1800-thermal.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Sophgo CV1800 on-SoC Thermal Sensor
> > +
> > +maintainers:
> > +  - Haylen Chu <heylenay@4d2.org>
> > +
> > +description: Sophgo CV1800 on-SoC thermal sensor
> > +
> > +$ref: thermal-sensor.yaml#
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - sophgo,cv1800-thermal
> 
> Not much improved, judging by other patches there is no "CV1800" SoC,
> but that's a family name.  Otherwise please point us to bindings or DTS
> using this SoC.

"cv1800" is referenced in the clock binding[1] and usb binding[2]. I
don't think there are other CV1800 SoC variants. Usage of "CV1800"
should be specific and unambiguous.

Best regards,
Haylen Chu

[1]: https://elixir.bootlin.com/linux/v6.11.3/source/Documentation/devicetree/bindings/clock/sophgo,cv1800-clk.yaml
[2]: https://elixir.bootlin.com/linux/v6.11.3/source/Documentation/devicetree/bindings/usb/dwc2.yaml#L62
Haylen Chu Oct. 15, 2024, 1:20 p.m. UTC | #4
On Tue, Oct 15, 2024 at 07:55:10AM +0200, Krzysztof Kozlowski wrote:
> On Mon, Oct 14, 2024 at 07:38:11AM +0000, Haylen Chu wrote:
> > Add devicetree binding documentation for thermal sensors integrated in
> > Sophgo CV1800 SoCs.
> > 
> > Signed-off-by: Haylen Chu <heylenay@4d2.org>
> > ---
> >  .../thermal/sophgo,cv1800-thermal.yaml        | 57 +++++++++++++++++++
> >  1 file changed, 57 insertions(+)
> >  create mode 100644 Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml
> > 
> > diff --git a/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml b/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml
> > new file mode 100644
> > index 000000000000..14abeb7a272a
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml
> > @@ -0,0 +1,57 @@
> > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/thermal/sophgo,cv1800-thermal.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Sophgo CV1800 on-SoC Thermal Sensor
> > +
> > +maintainers:
> > +  - Haylen Chu <heylenay@4d2.org>
> > +
> > +description: Sophgo CV1800 on-SoC thermal sensor
> > +
> > +$ref: thermal-sensor.yaml#
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - sophgo,cv1800-thermal
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  clocks:
> > +    maxItems: 1
> > +
> > +  interrupts:
> > +    maxItems: 1
> > +
> > +  sample-rate-hz:
> > +    minimum: 1
> > +    maximum: 1908
> > +    default: 1
> 
> 1. Why this is a property of a board?
> 2. I do not see this property defined in any common schema and I am not
> sure if it even should. Sample rate appears from time to time, but not
> in context of thermal sensors, so this should have vendor prefix.

Thanks, I decide to remove this property.

Best regards,
Haylen Chu
Krzysztof Kozlowski Oct. 15, 2024, 1:34 p.m. UTC | #5
On 15/10/2024 15:07, Haylen Chu wrote:
> On Tue, Oct 15, 2024 at 07:52:33AM +0200, Krzysztof Kozlowski wrote:
>> On Mon, Oct 14, 2024 at 07:38:11AM +0000, Haylen Chu wrote:
>>> Add devicetree binding documentation for thermal sensors integrated in
>>> Sophgo CV1800 SoCs.
>>>
>>> Signed-off-by: Haylen Chu <heylenay@4d2.org>
>>> ---
>>>  .../thermal/sophgo,cv1800-thermal.yaml        | 57 +++++++++++++++++++
>>>  1 file changed, 57 insertions(+)
>>>  create mode 100644 Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml
>>>
>>> diff --git a/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml b/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml
>>> new file mode 100644
>>> index 000000000000..14abeb7a272a
>>> --- /dev/null
>>> +++ b/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml
>>> @@ -0,0 +1,57 @@
>>> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
>>> +%YAML 1.2
>>> +---
>>> +$id: http://devicetree.org/schemas/thermal/sophgo,cv1800-thermal.yaml#
>>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>>> +
>>> +title: Sophgo CV1800 on-SoC Thermal Sensor
>>> +
>>> +maintainers:
>>> +  - Haylen Chu <heylenay@4d2.org>
>>> +
>>> +description: Sophgo CV1800 on-SoC thermal sensor
>>> +
>>> +$ref: thermal-sensor.yaml#
>>> +
>>> +properties:
>>> +  compatible:
>>> +    enum:
>>> +      - sophgo,cv1800-thermal
>>
>> Not much improved, judging by other patches there is no "CV1800" SoC,
>> but that's a family name.  Otherwise please point us to bindings or DTS
>> using this SoC.
> 
> "cv1800" is referenced in the clock binding[1] and usb binding[2]. I
> don't think there are other CV1800 SoC variants. Usage of "CV1800"

There are. git grep cv1800

> should be specific and unambiguous.

And other places have different name.

Best regards,
Krzysztof
Haylen Chu Oct. 16, 2024, 11:53 a.m. UTC | #6
On Tue, Oct 15, 2024 at 03:34:39PM +0200, Krzysztof Kozlowski wrote:
> On 15/10/2024 15:07, Haylen Chu wrote:
> > On Tue, Oct 15, 2024 at 07:52:33AM +0200, Krzysztof Kozlowski wrote:
> >> On Mon, Oct 14, 2024 at 07:38:11AM +0000, Haylen Chu wrote:
> >>> Add devicetree binding documentation for thermal sensors integrated in
> >>> Sophgo CV1800 SoCs.
> >>>
> >>> Signed-off-by: Haylen Chu <heylenay@4d2.org>
> >>> ---
> >>>  .../thermal/sophgo,cv1800-thermal.yaml        | 57 +++++++++++++++++++
> >>>  1 file changed, 57 insertions(+)
> >>>  create mode 100644 Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml
> >>>
> >>> diff --git a/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml b/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml
> >>> new file mode 100644
> >>> index 000000000000..14abeb7a272a
> >>> --- /dev/null
> >>> +++ b/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml
> >>> @@ -0,0 +1,57 @@
> >>> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> >>> +%YAML 1.2
> >>> +---
> >>> +$id: http://devicetree.org/schemas/thermal/sophgo,cv1800-thermal.yaml#
> >>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> >>> +
> >>> +title: Sophgo CV1800 on-SoC Thermal Sensor
> >>> +
> >>> +maintainers:
> >>> +  - Haylen Chu <heylenay@4d2.org>
> >>> +
> >>> +description: Sophgo CV1800 on-SoC thermal sensor
> >>> +
> >>> +$ref: thermal-sensor.yaml#
> >>> +
> >>> +properties:
> >>> +  compatible:
> >>> +    enum:
> >>> +      - sophgo,cv1800-thermal
> >>
> >> Not much improved, judging by other patches there is no "CV1800" SoC,
> >> but that's a family name.  Otherwise please point us to bindings or DTS
> >> using this SoC.
> > 
> > "cv1800" is referenced in the clock binding[1] and usb binding[2]. I
> > don't think there are other CV1800 SoC variants. Usage of "CV1800"
> 
> There are. git grep cv1800
> 
> > should be specific and unambiguous.
> 
> And other places have different name.

Okay, will use cv1800b in the next revision instead. Thanks.

Best regards,
Haylen Chu
Krzysztof Kozlowski Oct. 16, 2024, 12:03 p.m. UTC | #7
On 16/10/2024 13:53, Haylen Chu wrote:
>>>>> +
>>>>> +properties:
>>>>> +  compatible:
>>>>> +    enum:
>>>>> +      - sophgo,cv1800-thermal
>>>>
>>>> Not much improved, judging by other patches there is no "CV1800" SoC,
>>>> but that's a family name.  Otherwise please point us to bindings or DTS
>>>> using this SoC.
>>>
>>> "cv1800" is referenced in the clock binding[1] and usb binding[2]. I
>>> don't think there are other CV1800 SoC variants. Usage of "CV1800"
>>
>> There are. git grep cv1800
>>
>>> should be specific and unambiguous.
>>
>> And other places have different name.
> 
> Okay, will use cv1800b in the next revision instead. Thanks.

Just to clarify: I assume the name of the SoC is cv1800b.

Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml b/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml
new file mode 100644
index 000000000000..14abeb7a272a
--- /dev/null
+++ b/Documentation/devicetree/bindings/thermal/sophgo,cv1800-thermal.yaml
@@ -0,0 +1,57 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/thermal/sophgo,cv1800-thermal.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Sophgo CV1800 on-SoC Thermal Sensor
+
+maintainers:
+  - Haylen Chu <heylenay@4d2.org>
+
+description: Sophgo CV1800 on-SoC thermal sensor
+
+$ref: thermal-sensor.yaml#
+
+properties:
+  compatible:
+    enum:
+      - sophgo,cv1800-thermal
+
+  reg:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  sample-rate-hz:
+    minimum: 1
+    maximum: 1908
+    default: 1
+
+  '#thermal-sensor-cells':
+    const: 0
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - interrupts
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/sophgo,cv1800.h>
+    #include <dt-bindings/interrupt-controller/irq.h>
+    thermal-sensor@30e0000 {
+        compatible = "sophgo,cv1800-thermal";
+        reg = <0x30e0000 0x100>;
+        clocks = <&clk CLK_TEMPSEN>;
+        interrupts = <16 IRQ_TYPE_LEVEL_HIGH>;
+        #thermal-sensor-cells = <0>;
+    };
+...