Re: [PATCH] dt-bindings: hwlock: omap: Remove board-specific compatible from DT example

[Bjorn Andersson <bjorn.andersson@linaro.org>]

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
>