diff mbox series

[v3,1/3] dt-bindings: i2c: dw: Document compatible thead,th1520-i2c

Message ID 20240618-i2c-th1520-v3-1-3042590a16b1@bootlin.com (mailing list archive)
State Handled Elsewhere
Delegated to: Conor Dooley
Headers show
Series Add I2C support on TH1520 | expand

Checks

Context Check Description
conchuod/vmtest-fixes-PR fail merge-conflict

Commit Message

Thomas Bonnefille June 18, 2024, 7:42 a.m. UTC
Add documentation for compatible string thead,th1520-i2c which can be
used specifically for the TH1520 SoC.

Signed-off-by: Thomas Bonnefille <thomas.bonnefille@bootlin.com>
Acked-by: Conor Dooley <conor.dooley@microchip.com>
---
 Documentation/devicetree/bindings/i2c/snps,designware-i2c.yaml | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Jarkko Nikula June 19, 2024, 6:40 a.m. UTC | #1
Hi

On 6/18/24 10:42 AM, Thomas Bonnefille wrote:
> Add documentation for compatible string thead,th1520-i2c which can be
> used specifically for the TH1520 SoC.
> 
> Signed-off-by: Thomas Bonnefille <thomas.bonnefille@bootlin.com>
> Acked-by: Conor Dooley <conor.dooley@microchip.com>
> ---
>   Documentation/devicetree/bindings/i2c/snps,designware-i2c.yaml | 4 ++++
>   1 file changed, 4 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/i2c/snps,designware-i2c.yaml b/Documentation/devicetree/bindings/i2c/snps,designware-i2c.yaml
> index d9293c57f573..60035a787e5c 100644
> --- a/Documentation/devicetree/bindings/i2c/snps,designware-i2c.yaml
> +++ b/Documentation/devicetree/bindings/i2c/snps,designware-i2c.yaml
> @@ -33,6 +33,10 @@ properties:
>             - const: snps,designware-i2c
>         - description: Baikal-T1 SoC System I2C controller
>           const: baikal,bt1-sys-i2c
> +      - description: T-HEAD TH1520 SoCs I2C controller
> +        items:
> +          - const: thead,th1520-i2c
> +          - const: snps,designware-i2c
>   

Your comment below makes me thinking is this change needed? So is it 
enough to specify "snps,designware-i2c" for the compatible string in 
patch 2/3?

"It appears that the TH1520 I2C is already supported in the upstream 
kernel through the Synopsis Designware I2C adapter driver."
Icenowy Zheng June 19, 2024, 7:37 a.m. UTC | #2
在 2024-06-19星期三的 09:40 +0300,Jarkko Nikula写道:
> 
> Your comment below makes me thinking is this change needed? So is it 
> enough to specify "snps,designware-i2c" for the compatible string in 
> patch 2/3?

I think it's a common practice to have a SoC-specific compatible along
with the specific compatible, in case any silicon quirk is found.

> 
> "It appears that the TH1520 I2C is already supported in the upstream 
> kernel through the Synopsis Designware I2C adapter driver."
Krzysztof Kozlowski June 19, 2024, 7:39 a.m. UTC | #3
On 19/06/2024 08:40, Jarkko Nikula wrote:
> Hi
> 
> On 6/18/24 10:42 AM, Thomas Bonnefille wrote:
>> Add documentation for compatible string thead,th1520-i2c which can be
>> used specifically for the TH1520 SoC.
>>
>> Signed-off-by: Thomas Bonnefille <thomas.bonnefille@bootlin.com>
>> Acked-by: Conor Dooley <conor.dooley@microchip.com>
>> ---
>>   Documentation/devicetree/bindings/i2c/snps,designware-i2c.yaml | 4 ++++
>>   1 file changed, 4 insertions(+)
>>
>> diff --git a/Documentation/devicetree/bindings/i2c/snps,designware-i2c.yaml b/Documentation/devicetree/bindings/i2c/snps,designware-i2c.yaml
>> index d9293c57f573..60035a787e5c 100644
>> --- a/Documentation/devicetree/bindings/i2c/snps,designware-i2c.yaml
>> +++ b/Documentation/devicetree/bindings/i2c/snps,designware-i2c.yaml
>> @@ -33,6 +33,10 @@ properties:
>>             - const: snps,designware-i2c
>>         - description: Baikal-T1 SoC System I2C controller
>>           const: baikal,bt1-sys-i2c
>> +      - description: T-HEAD TH1520 SoCs I2C controller
>> +        items:
>> +          - const: thead,th1520-i2c
>> +          - const: snps,designware-i2c
>>   
> 
> Your comment below makes me thinking is this change needed? So is it 
> enough to specify "snps,designware-i2c" for the compatible string in 
> patch 2/3?

SoC specific compatible is always required (see writing bindings doc).

Best regards,
Krzysztof
Jarkko Nikula June 19, 2024, 1:42 p.m. UTC | #4
On 6/19/24 10:39 AM, Krzysztof Kozlowski wrote:
> On 19/06/2024 08:40, Jarkko Nikula wrote:
>> Hi
>>
>> On 6/18/24 10:42 AM, Thomas Bonnefille wrote:
>>> Add documentation for compatible string thead,th1520-i2c which can be
>>> used specifically for the TH1520 SoC.
>>>
>>> Signed-off-by: Thomas Bonnefille <thomas.bonnefille@bootlin.com>
>>> Acked-by: Conor Dooley <conor.dooley@microchip.com>
>>> ---
>>>    Documentation/devicetree/bindings/i2c/snps,designware-i2c.yaml | 4 ++++
>>>    1 file changed, 4 insertions(+)
>>>
>>> diff --git a/Documentation/devicetree/bindings/i2c/snps,designware-i2c.yaml b/Documentation/devicetree/bindings/i2c/snps,designware-i2c.yaml
>>> index d9293c57f573..60035a787e5c 100644
>>> --- a/Documentation/devicetree/bindings/i2c/snps,designware-i2c.yaml
>>> +++ b/Documentation/devicetree/bindings/i2c/snps,designware-i2c.yaml
>>> @@ -33,6 +33,10 @@ properties:
>>>              - const: snps,designware-i2c
>>>          - description: Baikal-T1 SoC System I2C controller
>>>            const: baikal,bt1-sys-i2c
>>> +      - description: T-HEAD TH1520 SoCs I2C controller
>>> +        items:
>>> +          - const: thead,th1520-i2c
>>> +          - const: snps,designware-i2c
>>>    
>>
>> Your comment below makes me thinking is this change needed? So is it
>> enough to specify "snps,designware-i2c" for the compatible string in
>> patch 2/3?
> 
> SoC specific compatible is always required (see writing bindings doc).
> 
Fair enough.

Reviewed-by: Jarkko Nikula <jarkko.nikula@linux.intel.com>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/i2c/snps,designware-i2c.yaml b/Documentation/devicetree/bindings/i2c/snps,designware-i2c.yaml
index d9293c57f573..60035a787e5c 100644
--- a/Documentation/devicetree/bindings/i2c/snps,designware-i2c.yaml
+++ b/Documentation/devicetree/bindings/i2c/snps,designware-i2c.yaml
@@ -33,6 +33,10 @@  properties:
           - const: snps,designware-i2c
       - description: Baikal-T1 SoC System I2C controller
         const: baikal,bt1-sys-i2c
+      - description: T-HEAD TH1520 SoCs I2C controller
+        items:
+          - const: thead,th1520-i2c
+          - const: snps,designware-i2c
 
   reg:
     minItems: 1