diff mbox series

dt-bindings: hwlock: omap: Remove board-specific compatible from DT example

Message ID 20210917094740.18891-1-sinthu.raja@ti.com (mailing list archive)
State Changes Requested
Headers show
Series dt-bindings: hwlock: omap: Remove board-specific compatible from DT example | expand

Commit Message

Sinthu Raja Sept. 17, 2021, 9:47 a.m. UTC
From: Sinthu Raja <sinthu.raja@ti.com>

The example includes a board-specific compatible property, this is
wrong as the example should be board agnostic. Replace the same with a
generic soc node.

Fixes: d8db9dc34871 ("dt-bindings: hwlock: omap: Convert binding to YAML")
Signed-off-by: Sinthu Raja <sinthu.raja@ti.com>
---

This patch was triggered by discussions in [1].

When applying the patch, if you could provide an immutable tag for the
bindings, it would help line things up for new platforms to be added for
us. See [2] for the context

[1] https://lore.kernel.org/all/20210818074030.1877-1-sinthu.raja@ti.com/
[2] https://lore.kernel.org/linux-arm-kernel/20210125141642.4yybjnklk3qsqjdy@steersman/

 .../devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml        | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

Comments

Nishanth Menon Sept. 17, 2021, 2:44 p.m. UTC | #1
On 15:17-20210917, Sinthu Raja wrote:
> From: Sinthu Raja <sinthu.raja@ti.com>
> 
> The example includes a board-specific compatible property, this is
> wrong as the example should be board agnostic. Replace the same with a
> generic soc node.
> 
> Fixes: d8db9dc34871 ("dt-bindings: hwlock: omap: Convert binding to YAML")
> Signed-off-by: Sinthu Raja <sinthu.raja@ti.com>
> ---
> 
> This patch was triggered by discussions in [1].
> 
> When applying the patch, if you could provide an immutable tag for the
> bindings, it would help line things up for new platforms to be added for
> us. See [2] for the context


Aah yes, thanks.. Bjorn.. once Rob acks ofcourse (since this is
bindings).

Reviewed-by: Nishanth Menon <nm@ti.com>


> 
> [1] https://lore.kernel.org/all/20210818074030.1877-1-sinthu.raja@ti.com/
> [2] https://lore.kernel.org/linux-arm-kernel/20210125141642.4yybjnklk3qsqjdy@steersman/
> 
>  .../devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml        | 4 +---
>  1 file changed, 1 insertion(+), 3 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml b/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
> index ae1b37dbee75..d56dc1bebdc6 100644
> --- a/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
> +++ b/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
> @@ -47,10 +47,8 @@ examples:
>      };
>  
>    - |
> -    / {
> +    soc {
>          /* K3 AM65x SoCs */
> -        model = "Texas Instruments K3 AM654 SoC";
> -        compatible = "ti,am654-evm", "ti,am654";
>          #address-cells = <2>;
>          #size-cells = <2>;
>  
> -- 
> 2.32.0
>
Bjorn Andersson Sept. 17, 2021, 3:12 p.m. UTC | #2
On Fri 17 Sep 04:47 CDT 2021, Sinthu Raja wrote:

> From: Sinthu Raja <sinthu.raja@ti.com>
> 
> The example includes a board-specific compatible property, this is
> wrong as the example should be board agnostic. Replace the same with a
> generic soc node.
> 

I do think your fix is correct in that it results in a proper tree, but
the examples are not supposed to describe the node in a fully described
DT tree, but rather just show an example of the particular binding.

I therefor think that it would be appropriate to reduce that second
example to just:

spinlock@30e00000 {
  compatible = "ti,am654-hwspinlock";
  reg = <0x30e00000 0x1000>;
  #hwlock-cells = <1>;
};

Because the rest has nothing to do with this binding.

That said, this example is now the same example as the first one, just
with different compatible, so I think we should drop the entire second
example instead.


PS. While we're doing that, we should also remove the "hwspinlock: "
label from the first example.

Regards,
Bjorn

> Fixes: d8db9dc34871 ("dt-bindings: hwlock: omap: Convert binding to YAML")
> Signed-off-by: Sinthu Raja <sinthu.raja@ti.com>
> ---
> 
> This patch was triggered by discussions in [1].
> 
> When applying the patch, if you could provide an immutable tag for the
> bindings, it would help line things up for new platforms to be added for
> us. See [2] for the context
> 
> [1] https://lore.kernel.org/all/20210818074030.1877-1-sinthu.raja@ti.com/
> [2] https://lore.kernel.org/linux-arm-kernel/20210125141642.4yybjnklk3qsqjdy@steersman/
> 
>  .../devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml        | 4 +---
>  1 file changed, 1 insertion(+), 3 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml b/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
> index ae1b37dbee75..d56dc1bebdc6 100644
> --- a/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
> +++ b/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
> @@ -47,10 +47,8 @@ examples:
>      };
>  
>    - |
> -    / {
> +    soc {
>          /* K3 AM65x SoCs */
> -        model = "Texas Instruments K3 AM654 SoC";
> -        compatible = "ti,am654-evm", "ti,am654";
>          #address-cells = <2>;
>          #size-cells = <2>;
>  
> -- 
> 2.32.0
>
Suman Anna Sept. 20, 2021, 9:14 p.m. UTC | #3
On 9/17/21 9:44 AM, Nishanth Menon wrote:
> On 15:17-20210917, Sinthu Raja wrote:
>> From: Sinthu Raja <sinthu.raja@ti.com>
>>
>> The example includes a board-specific compatible property, this is
>> wrong as the example should be board agnostic. Replace the same with a
>> generic soc node.
>>
>> Fixes: d8db9dc34871 ("dt-bindings: hwlock: omap: Convert binding to YAML")
>> Signed-off-by: Sinthu Raja <sinthu.raja@ti.com>
>> ---
>>
>> This patch was triggered by discussions in [1].
>>
>> When applying the patch, if you could provide an immutable tag for the
>> bindings, it would help line things up for new platforms to be added for
>> us. See [2] for the context
> 
> 
> Aah yes, thanks.. Bjorn.. once Rob acks ofcourse (since this is
> bindings).

Hmm, I don't think an immutable tag is needed for this patch. This is just
cleanup, what is your exact dependency here?

The relevant HwSpinlock dts nodes are all upstream on all applicable platforms
already.

regards
Suman


> 
> Reviewed-by: Nishanth Menon <nm@ti.com>
> 
> 
>>
>> [1] https://lore.kernel.org/all/20210818074030.1877-1-sinthu.raja@ti.com/
>> [2] https://lore.kernel.org/linux-arm-kernel/20210125141642.4yybjnklk3qsqjdy@steersman/
>>
>>  .../devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml        | 4 +---
>>  1 file changed, 1 insertion(+), 3 deletions(-)
>>
>> diff --git a/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml b/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
>> index ae1b37dbee75..d56dc1bebdc6 100644
>> --- a/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
>> +++ b/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
>> @@ -47,10 +47,8 @@ examples:
>>      };
>>  
>>    - |
>> -    / {
>> +    soc {
>>          /* K3 AM65x SoCs */
>> -        model = "Texas Instruments K3 AM654 SoC";
>> -        compatible = "ti,am654-evm", "ti,am654";
>>          #address-cells = <2>;
>>          #size-cells = <2>;
>>  
>> -- 
>> 2.32.0
>>
>
Bjorn Andersson Sept. 20, 2021, 10:01 p.m. UTC | #4
On Mon 20 Sep 16:14 CDT 2021, Suman Anna wrote:

> On 9/17/21 9:44 AM, Nishanth Menon wrote:
> > On 15:17-20210917, Sinthu Raja wrote:
> >> From: Sinthu Raja <sinthu.raja@ti.com>
> >>
> >> The example includes a board-specific compatible property, this is
> >> wrong as the example should be board agnostic. Replace the same with a
> >> generic soc node.
> >>
> >> Fixes: d8db9dc34871 ("dt-bindings: hwlock: omap: Convert binding to YAML")
> >> Signed-off-by: Sinthu Raja <sinthu.raja@ti.com>
> >> ---
> >>
> >> This patch was triggered by discussions in [1].
> >>
> >> When applying the patch, if you could provide an immutable tag for the
> >> bindings, it would help line things up for new platforms to be added for
> >> us. See [2] for the context
> > 
> > 
> > Aah yes, thanks.. Bjorn.. once Rob acks ofcourse (since this is
> > bindings).
> 
> Hmm, I don't think an immutable tag is needed for this patch. This is just
> cleanup, what is your exact dependency here?
> 
> The relevant HwSpinlock dts nodes are all upstream on all applicable platforms
> already.
> 

I agree and in general I think it's better to do DT validation against
linux-next, as you would otherwise miss out on any newly introduced
issues from inherited bindings etc.

Regards,
Bjorn

> regards
> Suman
> 
> 
> > 
> > Reviewed-by: Nishanth Menon <nm@ti.com>
> > 
> > 
> >>
> >> [1] https://lore.kernel.org/all/20210818074030.1877-1-sinthu.raja@ti.com/
> >> [2] https://lore.kernel.org/linux-arm-kernel/20210125141642.4yybjnklk3qsqjdy@steersman/
> >>
> >>  .../devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml        | 4 +---
> >>  1 file changed, 1 insertion(+), 3 deletions(-)
> >>
> >> diff --git a/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml b/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
> >> index ae1b37dbee75..d56dc1bebdc6 100644
> >> --- a/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
> >> +++ b/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
> >> @@ -47,10 +47,8 @@ examples:
> >>      };
> >>  
> >>    - |
> >> -    / {
> >> +    soc {
> >>          /* K3 AM65x SoCs */
> >> -        model = "Texas Instruments K3 AM654 SoC";
> >> -        compatible = "ti,am654-evm", "ti,am654";
> >>          #address-cells = <2>;
> >>          #size-cells = <2>;
> >>  
> >> -- 
> >> 2.32.0
> >>
> > 
>
Nishanth Menon Sept. 22, 2021, 9 p.m. UTC | #5
On 17:01-20210920, Bjorn Andersson wrote:
> On Mon 20 Sep 16:14 CDT 2021, Suman Anna wrote:
> 
> > On 9/17/21 9:44 AM, Nishanth Menon wrote:
> > > On 15:17-20210917, Sinthu Raja wrote:
> > >> From: Sinthu Raja <sinthu.raja@ti.com>
> > >>
> > >> The example includes a board-specific compatible property, this is
> > >> wrong as the example should be board agnostic. Replace the same with a
> > >> generic soc node.
> > >>
> > >> Fixes: d8db9dc34871 ("dt-bindings: hwlock: omap: Convert binding to YAML")
> > >> Signed-off-by: Sinthu Raja <sinthu.raja@ti.com>
> > >> ---
> > >>
> > >> This patch was triggered by discussions in [1].
> > >>
> > >> When applying the patch, if you could provide an immutable tag for the
> > >> bindings, it would help line things up for new platforms to be added for
> > >> us. See [2] for the context
> > > 
> > > 
> > > Aah yes, thanks.. Bjorn.. once Rob acks ofcourse (since this is
> > > bindings).
> > 
> > Hmm, I don't think an immutable tag is needed for this patch. This is just
> > cleanup, what is your exact dependency here?
> > 
> > The relevant HwSpinlock dts nodes are all upstream on all applicable platforms
> > already.
> > 
> 
> I agree and in general I think it's better to do DT validation against
> linux-next, as you would otherwise miss out on any newly introduced
> issues from inherited bindings etc.


I agree that an immutable commit is not needed on this specific patch.
The updated revision[1] posted had already dropped that request.

On the other hand, series[2] makes Rob's checks fail (as it runs on
rc1) - and helps keep everyone sane by getting an immutable commit
merged in allowing for follow on patches to stay clean.

NOTE: I do test patches for both checks and functionality to the best I
can on both rc1 (my tree)[3] and on linux-next on the day I pick the
patches up.

[1] https://lore.kernel.org/all/20210920123152.32751-1-sinthu.raja@ti.com/
[2] https://lore.kernel.org/all/20210917095426.19277-1-sinthu.raja@ti.com/
[3] https://git.kernel.org/pub/scm/linux/kernel/git/nmenon/linux.git/tree/
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml b/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
index ae1b37dbee75..d56dc1bebdc6 100644
--- a/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
+++ b/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
@@ -47,10 +47,8 @@  examples:
     };
 
   - |
-    / {
+    soc {
         /* K3 AM65x SoCs */
-        model = "Texas Instruments K3 AM654 SoC";
-        compatible = "ti,am654-evm", "ti,am654";
         #address-cells = <2>;
         #size-cells = <2>;