diff mbox series

[1/2] dt-bindings: rockchip-thermal: Support the RK3568 SoC compatible

Message ID 20210421200445.32977-1-ezequiel@collabora.com (mailing list archive)
State New
Delegated to: Daniel Lezcano
Headers show
Series [1/2] dt-bindings: rockchip-thermal: Support the RK3568 SoC compatible | expand

Commit Message

Ezequiel Garcia April 21, 2021, 8:04 p.m. UTC
Add a new compatible for the thermal sensor device on RK3568 SoCs.

Signed-off-by: Ezequiel Garcia <ezequiel@collabora.com>
---
 Documentation/devicetree/bindings/thermal/rockchip-thermal.txt | 1 +
 1 file changed, 1 insertion(+)

Comments

Johan Jonker April 21, 2021, 8:46 p.m. UTC | #1
On 4/21/21 10:04 PM, Ezequiel Garcia wrote:
> Add a new compatible for the thermal sensor device on RK3568 SoCs.
> 
> Signed-off-by: Ezequiel Garcia <ezequiel@collabora.com>
> ---
>  Documentation/devicetree/bindings/thermal/rockchip-thermal.txt | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> index 7f94669e9ebe..346e466c2006 100644
> --- a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> +++ b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> @@ -9,6 +9,7 @@ Required properties:
>     "rockchip,rk3328-tsadc": found on RK3328 SoCs
>     "rockchip,rk3368-tsadc": found on RK3368 SoCs
>     "rockchip,rk3399-tsadc": found on RK3399 SoCs

> +   "rockchip,rk3568-tsadc": found on RK3568 SoCs

This is still a text document.
rob+dt has now scripts that check for undocumented compatibility
strings, so first convert rockchip-thermal.txt to YAML and then add this
in a separated patch.

Johan

>  - reg : physical base address of the controller and length of memory mapped
>  	region.
>  - interrupts : The interrupt number to the cpu. The interrupt specifier format
>
Ezequiel Garcia April 21, 2021, 9:06 p.m. UTC | #2
On Wed, 2021-04-21 at 22:46 +0200, Johan Jonker wrote:
> On 4/21/21 10:04 PM, Ezequiel Garcia wrote:
> > Add a new compatible for the thermal sensor device on RK3568 SoCs.
> > 
> > Signed-off-by: Ezequiel Garcia <ezequiel@collabora.com>
> > ---
> >  Documentation/devicetree/bindings/thermal/rockchip-thermal.txt | 1 +
> >  1 file changed, 1 insertion(+)
> > 
> > diff --git a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> > index 7f94669e9ebe..346e466c2006 100644
> > --- a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> > +++ b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> > @@ -9,6 +9,7 @@ Required properties:
> >     "rockchip,rk3328-tsadc": found on RK3328 SoCs
> >     "rockchip,rk3368-tsadc": found on RK3368 SoCs
> >     "rockchip,rk3399-tsadc": found on RK3399 SoCs
> 
> > +   "rockchip,rk3568-tsadc": found on RK3568 SoCs
> 
> This is still a text document.
> rob+dt has now scripts that check for undocumented compatibility
> strings, so first convert rockchip-thermal.txt to YAML and then add this
> in a separated patch.
> 

Is it a showstopper to convert devicetree bindings to YAML for driver submission?

Thanks,
Ezequiel
Johan Jonker April 21, 2021, 9:25 p.m. UTC | #3
On 4/21/21 11:06 PM, Ezequiel Garcia wrote:
> On Wed, 2021-04-21 at 22:46 +0200, Johan Jonker wrote:
>> On 4/21/21 10:04 PM, Ezequiel Garcia wrote:
>>> Add a new compatible for the thermal sensor device on RK3568 SoCs.
>>>
>>> Signed-off-by: Ezequiel Garcia <ezequiel@collabora.com>
>>> ---
>>>  Documentation/devicetree/bindings/thermal/rockchip-thermal.txt | 1 +
>>>  1 file changed, 1 insertion(+)
>>>
>>> diff --git a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
>>> index 7f94669e9ebe..346e466c2006 100644
>>> --- a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
>>> +++ b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
>>> @@ -9,6 +9,7 @@ Required properties:
>>>     "rockchip,rk3328-tsadc": found on RK3328 SoCs
>>>     "rockchip,rk3368-tsadc": found on RK3368 SoCs
>>>     "rockchip,rk3399-tsadc": found on RK3399 SoCs
>>
>>> +   "rockchip,rk3568-tsadc": found on RK3568 SoCs
>>
>> This is still a text document.
>> rob+dt has now scripts that check for undocumented compatibility
>> strings, so first convert rockchip-thermal.txt to YAML and then add this
>> in a separated patch.
>>
> 
> Is it a showstopper to convert devicetree bindings to YAML for driver submission?

You now that hardware best, so try to fix the documents as well.
The new norm is YAML, so aim for that.
Try to submit a complete package of YAML, driver (and dts nodes) for review.
New nodes should not generate more notifications then we already have.

Johan
> 
> Thanks,
> Ezequiel
>
Ezequiel Garcia April 21, 2021, 9:56 p.m. UTC | #4
On Wed, 2021-04-21 at 23:25 +0200, Johan Jonker wrote:
> On 4/21/21 11:06 PM, Ezequiel Garcia wrote:
> > On Wed, 2021-04-21 at 22:46 +0200, Johan Jonker wrote:
> > > On 4/21/21 10:04 PM, Ezequiel Garcia wrote:
> > > > Add a new compatible for the thermal sensor device on RK3568 SoCs.
> > > > 
> > > > Signed-off-by: Ezequiel Garcia <ezequiel@collabora.com>
> > > > ---
> > > >  Documentation/devicetree/bindings/thermal/rockchip-thermal.txt | 1 +
> > > >  1 file changed, 1 insertion(+)
> > > > 
> > > > diff --git a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> > > > index 7f94669e9ebe..346e466c2006 100644
> > > > --- a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> > > > +++ b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> > > > @@ -9,6 +9,7 @@ Required properties:
> > > >     "rockchip,rk3328-tsadc": found on RK3328 SoCs
> > > >     "rockchip,rk3368-tsadc": found on RK3368 SoCs
> > > >     "rockchip,rk3399-tsadc": found on RK3399 SoCs
> > > 
> > > > +   "rockchip,rk3568-tsadc": found on RK3568 SoCs
> > > 
> > > This is still a text document.
> > > rob+dt has now scripts that check for undocumented compatibility
> > > strings, so first convert rockchip-thermal.txt to YAML and then add this
> > > in a separated patch.
> > > 
> > 
> > Is it a showstopper to convert devicetree bindings to YAML for driver submission?
> 
> You now that hardware best, so try to fix the documents as well.

Well, not really. I'm just forward porting the driver from downstream kernels,
so we can support this new SoC. Not really a hardware _expert_ for all the
devices I plan to be pushing.

> The new norm is YAML, so aim for that.

I am aware of that. In fact, at Collabora we encourage all the kernel
developers to convert to YAML, if/when possible.

> Try to submit a complete package of YAML, driver (and dts nodes) for review.

The devicetree for RK3566 and RK3568 is under discussion, in fact it was submitted today.
Rockhip is leading that, and doing a great job already :)

Meanwhile, I'd like to merge the small drivers (thermal, pmic, dwmac, io-domains and so on),
so they are ready when the devicetree lands.

Most if not all of these devices just need a new compatible string. It would really delay
things if I aim to convert all those bindings docs to YAML first, so let's please avoid that...
... unless it's a new hard-rule that DT maintainers have agreed on.

Having said that, if you want to help the RK3568 bringup adventure,
converting the bindings to YAML, that would be really appreciated! Of course, I know
you've converted plenty of them already, and I already appreciate that :)

Thanks,
Ezequiel
Johan Jonker April 21, 2021, 10:12 p.m. UTC | #5
On 4/21/21 11:56 PM, Ezequiel Garcia wrote:
> On Wed, 2021-04-21 at 23:25 +0200, Johan Jonker wrote:
>> On 4/21/21 11:06 PM, Ezequiel Garcia wrote:
>>> On Wed, 2021-04-21 at 22:46 +0200, Johan Jonker wrote:
>>>> On 4/21/21 10:04 PM, Ezequiel Garcia wrote:
>>>>> Add a new compatible for the thermal sensor device on RK3568 SoCs.
>>>>>
>>>>> Signed-off-by: Ezequiel Garcia <ezequiel@collabora.com>
>>>>> ---
>>>>>  Documentation/devicetree/bindings/thermal/rockchip-thermal.txt | 1 +
>>>>>  1 file changed, 1 insertion(+)
>>>>>
>>>>> diff --git a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
>>>>> index 7f94669e9ebe..346e466c2006 100644
>>>>> --- a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
>>>>> +++ b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
>>>>> @@ -9,6 +9,7 @@ Required properties:
>>>>>     "rockchip,rk3328-tsadc": found on RK3328 SoCs
>>>>>     "rockchip,rk3368-tsadc": found on RK3368 SoCs
>>>>>     "rockchip,rk3399-tsadc": found on RK3399 SoCs
>>>>
>>>>> +   "rockchip,rk3568-tsadc": found on RK3568 SoCs
>>>>
>>>> This is still a text document.
>>>> rob+dt has now scripts that check for undocumented compatibility
>>>> strings, so first convert rockchip-thermal.txt to YAML and then add this
>>>> in a separated patch.
>>>>
>>>
>>> Is it a showstopper to convert devicetree bindings to YAML for driver submission?
>>
>> You now that hardware best, so try to fix the documents as well.
> 
> Well, not really. I'm just forward porting the driver from downstream kernels,
> so we can support this new SoC. Not really a hardware _expert_ for all the
> devices I plan to be pushing.
> 
>> The new norm is YAML, so aim for that.
> 
> I am aware of that. In fact, at Collabora we encourage all the kernel
> developers to convert to YAML, if/when possible.
> 
>> Try to submit a complete package of YAML, driver (and dts nodes) for review.
> 
> The devicetree for RK3566 and RK3568 is under discussion, in fact it was submitted today.
> Rockhip is leading that, and doing a great job already :)
> 
> Meanwhile, I'd like to merge the small drivers (thermal, pmic, dwmac, io-domains and so on),
> so they are ready when the devicetree lands.
> 

> Most if not all of these devices just need a new compatible string. It would really delay
> things if I aim to convert all those bindings docs to YAML first, so let's please avoid that...
> ... unless it's a new hard-rule that DT maintainers have agreed on.

Every driver group has it's own delay time, so better do it right in one
run.
Mostly people tend to 'forget' documentation and then someone else has
to clean up the mess. So I propose that the person that submits a new
driver also fixes the documentation. The norm is now YAML, so this serie
has more work then other, so be it. Others can help you with it if you ask.

Johan

> 
> Having said that, if you want to help the RK3568 bringup adventure,
> converting the bindings to YAML, that would be really appreciated! Of course, I know
> you've converted plenty of them already, and I already appreciate that :)
> 
> Thanks,
> Ezequiel
>
Heiko Stuebner April 22, 2021, 6:20 p.m. UTC | #6
Hi,

Am Donnerstag, 22. April 2021, 00:12:45 CEST schrieb Johan Jonker:
> On 4/21/21 11:56 PM, Ezequiel Garcia wrote:
> > On Wed, 2021-04-21 at 23:25 +0200, Johan Jonker wrote:
> >> On 4/21/21 11:06 PM, Ezequiel Garcia wrote:
> >>> On Wed, 2021-04-21 at 22:46 +0200, Johan Jonker wrote:
> >>>> On 4/21/21 10:04 PM, Ezequiel Garcia wrote:
> >>>>> Add a new compatible for the thermal sensor device on RK3568 SoCs.
> >>>>>
> >>>>> Signed-off-by: Ezequiel Garcia <ezequiel@collabora.com>
> >>>>> ---
> >>>>>  Documentation/devicetree/bindings/thermal/rockchip-thermal.txt | 1 +
> >>>>>  1 file changed, 1 insertion(+)
> >>>>>
> >>>>> diff --git a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> >>>>> index 7f94669e9ebe..346e466c2006 100644
> >>>>> --- a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> >>>>> +++ b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> >>>>> @@ -9,6 +9,7 @@ Required properties:
> >>>>>     "rockchip,rk3328-tsadc": found on RK3328 SoCs
> >>>>>     "rockchip,rk3368-tsadc": found on RK3368 SoCs
> >>>>>     "rockchip,rk3399-tsadc": found on RK3399 SoCs
> >>>>
> >>>>> +   "rockchip,rk3568-tsadc": found on RK3568 SoCs
> >>>>
> >>>> This is still a text document.
> >>>> rob+dt has now scripts that check for undocumented compatibility
> >>>> strings, so first convert rockchip-thermal.txt to YAML and then add this
> >>>> in a separated patch.
> >>>>
> >>>
> >>> Is it a showstopper to convert devicetree bindings to YAML for driver submission?
> >>
> >> You now that hardware best, so try to fix the documents as well.
> > 
> > Well, not really. I'm just forward porting the driver from downstream kernels,
> > so we can support this new SoC. Not really a hardware _expert_ for all the
> > devices I plan to be pushing.
> > 
> >> The new norm is YAML, so aim for that.
> > 
> > I am aware of that. In fact, at Collabora we encourage all the kernel
> > developers to convert to YAML, if/when possible.
> > 
> >> Try to submit a complete package of YAML, driver (and dts nodes) for review.
> > 
> > The devicetree for RK3566 and RK3568 is under discussion, in fact it was submitted today.
> > Rockhip is leading that, and doing a great job already :)
> > 
> > Meanwhile, I'd like to merge the small drivers (thermal, pmic, dwmac, io-domains and so on),
> > so they are ready when the devicetree lands.
> > 
> 
> > Most if not all of these devices just need a new compatible string. It would really delay
> > things if I aim to convert all those bindings docs to YAML first, so let's please avoid that...
> > ... unless it's a new hard-rule that DT maintainers have agreed on.
> 
> Every driver group has it's own delay time, so better do it right in one
> run.
> Mostly people tend to 'forget' documentation and then someone else has
> to clean up the mess. So I propose that the person that submits a new
> driver also fixes the documentation. The norm is now YAML, so this serie
> has more work then other, so be it. Others can help you with it if you ask.

personally I feel this approach being a bit too strict.

While it is definitly cool to convert everything to a yaml base in a
hopefully short time, being overly strict can also stiffle participation.

This is especially true if a series only adds a single compatible to an
already existing binding. So depending on the time constraints of the
contributor they might very well refrain from submitting another version.

In then end though, it's Rob's decision on how strict this conversion
is to be taken.


Heiko
Daniel Lezcano April 22, 2021, 7:09 p.m. UTC | #7
On 22/04/2021 20:20, Heiko Stübner wrote:
> Hi,
> 
> Am Donnerstag, 22. April 2021, 00:12:45 CEST schrieb Johan Jonker:
>> On 4/21/21 11:56 PM, Ezequiel Garcia wrote:
>>> On Wed, 2021-04-21 at 23:25 +0200, Johan Jonker wrote:
>>>> On 4/21/21 11:06 PM, Ezequiel Garcia wrote:
>>>>> On Wed, 2021-04-21 at 22:46 +0200, Johan Jonker wrote:
>>>>>> On 4/21/21 10:04 PM, Ezequiel Garcia wrote:
>>>>>>> Add a new compatible for the thermal sensor device on RK3568 SoCs.
>>>>>>>
>>>>>>> Signed-off-by: Ezequiel Garcia <ezequiel@collabora.com>
>>>>>>> ---
>>>>>>>  Documentation/devicetree/bindings/thermal/rockchip-thermal.txt | 1 +
>>>>>>>  1 file changed, 1 insertion(+)
>>>>>>>
>>>>>>> diff --git a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
>>>>>>> index 7f94669e9ebe..346e466c2006 100644
>>>>>>> --- a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
>>>>>>> +++ b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
>>>>>>> @@ -9,6 +9,7 @@ Required properties:
>>>>>>>     "rockchip,rk3328-tsadc": found on RK3328 SoCs
>>>>>>>     "rockchip,rk3368-tsadc": found on RK3368 SoCs
>>>>>>>     "rockchip,rk3399-tsadc": found on RK3399 SoCs
>>>>>>
>>>>>>> +   "rockchip,rk3568-tsadc": found on RK3568 SoCs
>>>>>>
>>>>>> This is still a text document.
>>>>>> rob+dt has now scripts that check for undocumented compatibility
>>>>>> strings, so first convert rockchip-thermal.txt to YAML and then add this
>>>>>> in a separated patch.
>>>>>>
>>>>>
>>>>> Is it a showstopper to convert devicetree bindings to YAML for driver submission?
>>>>
>>>> You now that hardware best, so try to fix the documents as well.
>>>
>>> Well, not really. I'm just forward porting the driver from downstream kernels,
>>> so we can support this new SoC. Not really a hardware _expert_ for all the
>>> devices I plan to be pushing.
>>>
>>>> The new norm is YAML, so aim for that.
>>>
>>> I am aware of that. In fact, at Collabora we encourage all the kernel
>>> developers to convert to YAML, if/when possible.
>>>
>>>> Try to submit a complete package of YAML, driver (and dts nodes) for review.
>>>
>>> The devicetree for RK3566 and RK3568 is under discussion, in fact it was submitted today.
>>> Rockhip is leading that, and doing a great job already :)
>>>
>>> Meanwhile, I'd like to merge the small drivers (thermal, pmic, dwmac, io-domains and so on),
>>> so they are ready when the devicetree lands.
>>>
>>
>>> Most if not all of these devices just need a new compatible string. It would really delay
>>> things if I aim to convert all those bindings docs to YAML first, so let's please avoid that...
>>> ... unless it's a new hard-rule that DT maintainers have agreed on.
>>
>> Every driver group has it's own delay time, so better do it right in one
>> run.
>> Mostly people tend to 'forget' documentation and then someone else has
>> to clean up the mess. So I propose that the person that submits a new
>> driver also fixes the documentation. The norm is now YAML, so this serie
>> has more work then other, so be it. Others can help you with it if you ask.
> 
> personally I feel this approach being a bit too strict.
> 
> While it is definitly cool to convert everything to a yaml base in a
> hopefully short time, being overly strict can also stiffle participation.

+1
Rob Herring April 30, 2021, 3:14 p.m. UTC | #8
On Wed, Apr 21, 2021 at 10:46:37PM +0200, Johan Jonker wrote:
> On 4/21/21 10:04 PM, Ezequiel Garcia wrote:
> > Add a new compatible for the thermal sensor device on RK3568 SoCs.
> > 
> > Signed-off-by: Ezequiel Garcia <ezequiel@collabora.com>
> > ---
> >  Documentation/devicetree/bindings/thermal/rockchip-thermal.txt | 1 +
> >  1 file changed, 1 insertion(+)
> > 
> > diff --git a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> > index 7f94669e9ebe..346e466c2006 100644
> > --- a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> > +++ b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
> > @@ -9,6 +9,7 @@ Required properties:
> >     "rockchip,rk3328-tsadc": found on RK3328 SoCs
> >     "rockchip,rk3368-tsadc": found on RK3368 SoCs
> >     "rockchip,rk3399-tsadc": found on RK3399 SoCs
> 
> > +   "rockchip,rk3568-tsadc": found on RK3568 SoCs
> 
> This is still a text document.
> rob+dt has now scripts that check for undocumented compatibility
> strings, so first convert rockchip-thermal.txt to YAML and then add this
> in a separated patch.

Thanks for pushing on this, but for now at least, simple compatible 
additions are fine. If changes would complicate the conversion to 
schema, then we should convert it first. For example, if the new 
compatible was accompanied with differing clocks, irqs, resets, etc., 
then we should convert (or consider a separate schema).

In parallel though, we do want to get platforms to 0 undocumented (by 
schema) compatibles. And then 0 warnings after that...

Rob
Rob Herring April 30, 2021, 3:15 p.m. UTC | #9
On Wed, 21 Apr 2021 17:04:44 -0300, Ezequiel Garcia wrote:
> Add a new compatible for the thermal sensor device on RK3568 SoCs.
> 
> Signed-off-by: Ezequiel Garcia <ezequiel@collabora.com>
> ---
>  Documentation/devicetree/bindings/thermal/rockchip-thermal.txt | 1 +
>  1 file changed, 1 insertion(+)
> 

Acked-by: Rob Herring <robh@kernel.org>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
index 7f94669e9ebe..346e466c2006 100644
--- a/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
+++ b/Documentation/devicetree/bindings/thermal/rockchip-thermal.txt
@@ -9,6 +9,7 @@  Required properties:
    "rockchip,rk3328-tsadc": found on RK3328 SoCs
    "rockchip,rk3368-tsadc": found on RK3368 SoCs
    "rockchip,rk3399-tsadc": found on RK3399 SoCs
+   "rockchip,rk3568-tsadc": found on RK3568 SoCs
 - reg : physical base address of the controller and length of memory mapped
 	region.
 - interrupts : The interrupt number to the cpu. The interrupt specifier format