[PATCH V2] dt-bindings: hwlock: omap: Remove redundant binding example

[PATCH V2] dt-bindings: hwlock: omap: Remove redundant binding example

[Sinthu Raja]

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 and should represent the particular
binding. Also, the file includes two similar examples, but with a different
compatible. So, drop the entire second example

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

Changes in V2:
Addressed review comments, that includes dropping the redundant example,
updates to commit message and $subject.

V1: https://lore.kernel.org/all/20210917094740.18891-1-sinthu.raja@ti.com/

 .../bindings/hwlock/ti,omap-hwspinlock.yaml   | 32 +------------------
 1 file changed, 1 insertion(+), 31 deletions(-)

diff --git a/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml b/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
index ae1b37dbee75..4feebd90bff1 100644
--- a/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
+++ b/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
@@ -40,38 +40,8 @@ examples:
 
   - |
     /* OMAP4 SoCs */
-    hwspinlock: spinlock@4a0f6000 {
+    spinlock@4a0f6000 {
         compatible = "ti,omap4-hwspinlock";
         reg = <0x4a0f6000 0x1000>;
         #hwlock-cells = <1>;
     };
-
-  - |
-    / {
-        /* K3 AM65x SoCs */
-        model = "Texas Instruments K3 AM654 SoC";
-        compatible = "ti,am654-evm", "ti,am654";
-        #address-cells = <2>;
-        #size-cells = <2>;
-
-        bus@100000 {
-            compatible = "simple-bus";
-            #address-cells = <2>;
-            #size-cells = <2>;
-            ranges = <0x00 0x00100000 0x00 0x00100000 0x00 0x00020000>, /* ctrl mmr */
-                     <0x00 0x30800000 0x00 0x30800000 0x00 0x0bc00000>; /* Main NavSS */
-
-            bus@30800000 {
-                compatible = "simple-mfd";
-                #address-cells = <2>;
-                #size-cells = <2>;
-                ranges = <0x00 0x30800000 0x00 0x30800000 0x00 0x0bc00000>;
-
-                spinlock@30e00000 {
-                    compatible = "ti,am654-hwspinlock";
-                    reg = <0x00 0x30e00000 0x00 0x1000>;
-                    #hwlock-cells = <1>;
-                };
-            };
-        };
-    };
-- 
2.31.1

Re: [PATCH V2] dt-bindings: hwlock: omap: Remove redundant binding example

[Nishanth Menon]

On 22:38-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 and should represent the particular
> binding. Also, the file includes two similar examples, but with a different
> compatible. So, drop the entire second example
> 
> Fixes: d8db9dc34871 ("dt-bindings: hwlock: omap: Convert binding to YAML")

Since we are cleaning up, You should probably drop the fixes. Esp when
adding fixes, checkout the specific commit and attempt to git am this
patch.. you would notice it wont apply.. and per stable rules, it is
probably too trivial to backport to so many stable kernels.

The later commit 891adc1303fe ("dt-bindings: hwlock: omap:
Fix warnings with k3.yaml") attempted to fixup by making it
board-specific, which was'nt solving the underlying problem either as
this patch is doing..


Also it would be nice if you could attribute this to Bjorn by adding:
Suggested-by: Bjorn Andersson <bjorn.andersson@linaro.org>

> Signed-off-by: Sinthu Raja <sinthu.raja@ti.com>

> ---
> 
> Changes in V2:
> Addressed review comments, that includes dropping the redundant example,
> updates to commit message and $subject.


I like this version much better. Thanks Bjorn for pointing the same out,
the yaml is much cleaner now and easier to maintain.

> 
> V1: https://lore.kernel.org/all/20210917094740.18891-1-sinthu.raja@ti.com/
> 
>  .../bindings/hwlock/ti,omap-hwspinlock.yaml   | 32 +------------------
>  1 file changed, 1 insertion(+), 31 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml b/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
> index ae1b37dbee75..4feebd90bff1 100644
> --- a/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
> +++ b/Documentation/devicetree/bindings/hwlock/ti,omap-hwspinlock.yaml
> @@ -40,38 +40,8 @@ examples:
>  
>    - |
>      /* OMAP4 SoCs */

^^ Drop this?
> -    hwspinlock: spinlock@4a0f6000 {
> +    spinlock@4a0f6000 {
>          compatible = "ti,omap4-hwspinlock";
>          reg = <0x4a0f6000 0x1000>;
>          #hwlock-cells = <1>;
>      };
> -
> -  - |
> -    / {
> -        /* K3 AM65x SoCs */
> -        model = "Texas Instruments K3 AM654 SoC";
> -        compatible = "ti,am654-evm", "ti,am654";
> -        #address-cells = <2>;
> -        #size-cells = <2>;
> -
> -        bus@100000 {
> -            compatible = "simple-bus";
> -            #address-cells = <2>;
> -            #size-cells = <2>;
> -            ranges = <0x00 0x00100000 0x00 0x00100000 0x00 0x00020000>, /* ctrl mmr */
> -                     <0x00 0x30800000 0x00 0x30800000 0x00 0x0bc00000>; /* Main NavSS */
> -
> -            bus@30800000 {
> -                compatible = "simple-mfd";
> -                #address-cells = <2>;
> -                #size-cells = <2>;
> -                ranges = <0x00 0x30800000 0x00 0x30800000 0x00 0x0bc00000>;
> -
> -                spinlock@30e00000 {
> -                    compatible = "ti,am654-hwspinlock";
> -                    reg = <0x00 0x30e00000 0x00 0x1000>;
> -                    #hwlock-cells = <1>;
> -                };
> -            };
> -        };
> -    };
> -- 
> 2.31.1
> 


-- 
Regards,
Nishanth Menon
Key (0xDDB5849D1736249D)/Fingerprint: F8A2 8693 54EB 8232 17A3  1A34 DDB5 849D 1736 249D