[1/2] dt-bindings: i3c: Fix silvaco,i3c-master compatible string

Message ID 20231016152450.2850498-1-Frank.Li@nxp.com
State New
Headers
Series [1/2] dt-bindings: i3c: Fix silvaco,i3c-master compatible string |

Commit Message

Frank Li Oct. 16, 2023, 3:24 p.m. UTC
  In driver, compatible string is silvaco,i3c-master instead of
silvaco,i3c-master-v1.

Signed-off-by: Frank Li <Frank.Li@nxp.com>
---
 Documentation/devicetree/bindings/i3c/silvaco,i3c-master.yaml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
  

Comments

Conor Dooley Oct. 16, 2023, 5:30 p.m. UTC | #1
On Mon, Oct 16, 2023 at 11:24:49AM -0400, Frank Li wrote:
> In driver, compatible string is silvaco,i3c-master instead of
> silvaco,i3c-master-v1.

And what makes the driver right & the binding wrong? AFAICT, this is an
IP sold by silvaco & the -v1 suffix was explicitly requested during
review of the binding.

Thanks,
Conor.

> 
> Signed-off-by: Frank Li <Frank.Li@nxp.com>
> ---
>  Documentation/devicetree/bindings/i3c/silvaco,i3c-master.yaml | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/i3c/silvaco,i3c-master.yaml b/Documentation/devicetree/bindings/i3c/silvaco,i3c-master.yaml
> index 133855f11b4f..19e3f75eb45c 100644
> --- a/Documentation/devicetree/bindings/i3c/silvaco,i3c-master.yaml
> +++ b/Documentation/devicetree/bindings/i3c/silvaco,i3c-master.yaml
> @@ -14,7 +14,7 @@ allOf:
>  
>  properties:
>    compatible:
> -    const: silvaco,i3c-master-v1
> +    const: silvaco,i3c-master
>  
>    reg:
>      maxItems: 1
> @@ -49,7 +49,7 @@ unevaluatedProperties: false
>  examples:
>    - |
>      i3c-master@a0000000 {
> -        compatible = "silvaco,i3c-master-v1";
> +        compatible = "silvaco,i3c-master";
>          clocks = <&zynqmp_clk 71>, <&fclk>, <&sclk>;
>          clock-names = "pclk", "fast_clk", "slow_clk";
>          interrupt-parent = <&gic>;
> -- 
> 2.34.1
>
  
Frank Li Oct. 16, 2023, 7:32 p.m. UTC | #2
On Mon, Oct 16, 2023 at 06:30:11PM +0100, Conor Dooley wrote:
> On Mon, Oct 16, 2023 at 11:24:49AM -0400, Frank Li wrote:
> > In driver, compatible string is silvaco,i3c-master instead of
> > silvaco,i3c-master-v1.
> 
> And what makes the driver right & the binding wrong? AFAICT, this is an
> IP sold by silvaco & the -v1 suffix was explicitly requested during
> review of the binding.

The driver existed for the long time. DTS files already use
silvaco,i3c-master.

There are two options, one change doc, the other change dts and drivers.
I think change doc is easiest ways.

If there are v2 in future, we can added silvaco,i3c-master-v2 in future.

If everyone prefer change drivers and dts, I can work on new patch. Just
break back compatiblity.

Frank

> 
> Thanks,
> Conor.
> 
> > 
> > Signed-off-by: Frank Li <Frank.Li@nxp.com>
> > ---
> >  Documentation/devicetree/bindings/i3c/silvaco,i3c-master.yaml | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> > 
> > diff --git a/Documentation/devicetree/bindings/i3c/silvaco,i3c-master.yaml b/Documentation/devicetree/bindings/i3c/silvaco,i3c-master.yaml
> > index 133855f11b4f..19e3f75eb45c 100644
> > --- a/Documentation/devicetree/bindings/i3c/silvaco,i3c-master.yaml
> > +++ b/Documentation/devicetree/bindings/i3c/silvaco,i3c-master.yaml
> > @@ -14,7 +14,7 @@ allOf:
> >  
> >  properties:
> >    compatible:
> > -    const: silvaco,i3c-master-v1
> > +    const: silvaco,i3c-master
> >  
> >    reg:
> >      maxItems: 1
> > @@ -49,7 +49,7 @@ unevaluatedProperties: false
> >  examples:
> >    - |
> >      i3c-master@a0000000 {
> > -        compatible = "silvaco,i3c-master-v1";
> > +        compatible = "silvaco,i3c-master";
> >          clocks = <&zynqmp_clk 71>, <&fclk>, <&sclk>;
> >          clock-names = "pclk", "fast_clk", "slow_clk";
> >          interrupt-parent = <&gic>;
> > -- 
> > 2.34.1
> >
  
Krzysztof Kozlowski Oct. 16, 2023, 7:57 p.m. UTC | #3
On 16/10/2023 21:32, Frank Li wrote:
> On Mon, Oct 16, 2023 at 06:30:11PM +0100, Conor Dooley wrote:
>> On Mon, Oct 16, 2023 at 11:24:49AM -0400, Frank Li wrote:
>>> In driver, compatible string is silvaco,i3c-master instead of
>>> silvaco,i3c-master-v1.
>>
>> And what makes the driver right & the binding wrong? AFAICT, this is an
>> IP sold by silvaco & the -v1 suffix was explicitly requested during
>> review of the binding.
> 
> The driver existed for the long time. DTS files already use
> silvaco,i3c-master.
> 
> There are two options, one change doc, the other change dts and drivers.
> I think change doc is easiest ways.
> 
> If there are v2 in future, we can added silvaco,i3c-master-v2 in future.
> 
> If everyone prefer change drivers and dts, I can work on new patch. Just
> break back compatiblity.

No, because Rob explicitly pointed out too generic name.
https://lore.kernel.org/all/20210111200821.GA2978830@robh.at.kernel.org/

Is it some way to avoid implementing feedback or how does it work?

Best regards,
Krzysztof
  
Frank Li Oct. 16, 2023, 8:10 p.m. UTC | #4
On Mon, Oct 16, 2023 at 09:57:18PM +0200, Krzysztof Kozlowski wrote:
> On 16/10/2023 21:32, Frank Li wrote:
> > On Mon, Oct 16, 2023 at 06:30:11PM +0100, Conor Dooley wrote:
> >> On Mon, Oct 16, 2023 at 11:24:49AM -0400, Frank Li wrote:
> >>> In driver, compatible string is silvaco,i3c-master instead of
> >>> silvaco,i3c-master-v1.
> >>
> >> And what makes the driver right & the binding wrong? AFAICT, this is an
> >> IP sold by silvaco & the -v1 suffix was explicitly requested during
> >> review of the binding.
> > 
> > The driver existed for the long time. DTS files already use
> > silvaco,i3c-master.
> > 
> > There are two options, one change doc, the other change dts and drivers.
> > I think change doc is easiest ways.
> > 
> > If there are v2 in future, we can added silvaco,i3c-master-v2 in future.
> > 
> > If everyone prefer change drivers and dts, I can work on new patch. Just
> > break back compatiblity.
> 
> No, because Rob explicitly pointed out too generic name.
> https://lore.kernel.org/all/20210111200821.GA2978830@robh.at.kernel.org/
> 
> Is it some way to avoid implementing feedback or how does it work?

Downstream use silvaco,i3c-master to match driver. Anyways, miss match
happened.

option 1: fix doc
option 2: fix driver and dts

what do you perfer? 

> 
> Best regards,
> Krzysztof
>
  
Krzysztof Kozlowski Oct. 16, 2023, 8:43 p.m. UTC | #5
On 16/10/2023 22:10, Frank Li wrote:
> On Mon, Oct 16, 2023 at 09:57:18PM +0200, Krzysztof Kozlowski wrote:
>> On 16/10/2023 21:32, Frank Li wrote:
>>> On Mon, Oct 16, 2023 at 06:30:11PM +0100, Conor Dooley wrote:
>>>> On Mon, Oct 16, 2023 at 11:24:49AM -0400, Frank Li wrote:
>>>>> In driver, compatible string is silvaco,i3c-master instead of
>>>>> silvaco,i3c-master-v1.
>>>>
>>>> And what makes the driver right & the binding wrong? AFAICT, this is an
>>>> IP sold by silvaco & the -v1 suffix was explicitly requested during
>>>> review of the binding.
>>>
>>> The driver existed for the long time. DTS files already use
>>> silvaco,i3c-master.
>>>
>>> There are two options, one change doc, the other change dts and drivers.
>>> I think change doc is easiest ways.
>>>
>>> If there are v2 in future, we can added silvaco,i3c-master-v2 in future.
>>>
>>> If everyone prefer change drivers and dts, I can work on new patch. Just
>>> break back compatiblity.
>>
>> No, because Rob explicitly pointed out too generic name.
>> https://lore.kernel.org/all/20210111200821.GA2978830@robh.at.kernel.org/
>>
>> Is it some way to avoid implementing feedback or how does it work?
> 
> Downstream use silvaco,i3c-master to match driver. Anyways, miss match

Too bad for downstream.

> happened.
> 
> option 1: fix doc
> option 2: fix driver and dts
> 
> what do you perfer? 

Fix driver and dts, keep existing compatible as deprecated.

Best regards,
Krzysztof
  
Miquel Raynal Oct. 17, 2023, 2:15 p.m. UTC | #6
Hi Krzysztof,

krzysztof.kozlowski@linaro.org wrote on Mon, 16 Oct 2023 22:43:28 +0200:

> On 16/10/2023 22:10, Frank Li wrote:
> > On Mon, Oct 16, 2023 at 09:57:18PM +0200, Krzysztof Kozlowski wrote:  
> >> On 16/10/2023 21:32, Frank Li wrote:  
> >>> On Mon, Oct 16, 2023 at 06:30:11PM +0100, Conor Dooley wrote:  
> >>>> On Mon, Oct 16, 2023 at 11:24:49AM -0400, Frank Li wrote:  
> >>>>> In driver, compatible string is silvaco,i3c-master instead of
> >>>>> silvaco,i3c-master-v1.  
> >>>>
> >>>> And what makes the driver right & the binding wrong? AFAICT, this is an
> >>>> IP sold by silvaco & the -v1 suffix was explicitly requested during
> >>>> review of the binding.  
> >>>
> >>> The driver existed for the long time. DTS files already use
> >>> silvaco,i3c-master.
> >>>
> >>> There are two options, one change doc, the other change dts and drivers.
> >>> I think change doc is easiest ways.
> >>>
> >>> If there are v2 in future, we can added silvaco,i3c-master-v2 in future.
> >>>
> >>> If everyone prefer change drivers and dts, I can work on new patch. Just
> >>> break back compatiblity.  
> >>
> >> No, because Rob explicitly pointed out too generic name.
> >> https://lore.kernel.org/all/20210111200821.GA2978830@robh.at.kernel.org/
> >>
> >> Is it some way to avoid implementing feedback or how does it work?  

Not at all, it's my (faithful) fault, I did update the bindings upon
Rob request and apparently kept the previous string in the driver.

After thinking again I would drop silvaco,i3c-master entirely from the
driver, it was never intended to keep it.

Thanks,
Miquèl
  

Patch

diff --git a/Documentation/devicetree/bindings/i3c/silvaco,i3c-master.yaml b/Documentation/devicetree/bindings/i3c/silvaco,i3c-master.yaml
index 133855f11b4f..19e3f75eb45c 100644
--- a/Documentation/devicetree/bindings/i3c/silvaco,i3c-master.yaml
+++ b/Documentation/devicetree/bindings/i3c/silvaco,i3c-master.yaml
@@ -14,7 +14,7 @@  allOf:
 
 properties:
   compatible:
-    const: silvaco,i3c-master-v1
+    const: silvaco,i3c-master
 
   reg:
     maxItems: 1
@@ -49,7 +49,7 @@  unevaluatedProperties: false
 examples:
   - |
     i3c-master@a0000000 {
-        compatible = "silvaco,i3c-master-v1";
+        compatible = "silvaco,i3c-master";
         clocks = <&zynqmp_clk 71>, <&fclk>, <&sclk>;
         clock-names = "pclk", "fast_clk", "slow_clk";
         interrupt-parent = <&gic>;