[PATCH] dt-bindings: pinctrl: k230: fix child node name patterns

[PATCH] dt-bindings: pinctrl: k230: fix child node name patterns

[Ze Huang]

Rename child node name patterns to align with conventions.

    uart0-pins      =>   uart0-cfg
        uart0-cfg            uart0-pins

This avoids potential confusion and improves consistency with existing
bindings like sophgo,sg2042-pinctrl and starfive,jh7110-aon-pinctrl.

Fixes: 561f3e9d21a1 ("dt-bindings: pinctrl: Add support for canaan,k230 SoC")
Signed-off-by: Ze Huang <huangze@whut.edu.cn>
---
 .../devicetree/bindings/pinctrl/canaan,k230-pinctrl.yaml          | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/devicetree/bindings/pinctrl/canaan,k230-pinctrl.yaml b/Documentation/devicetree/bindings/pinctrl/canaan,k230-pinctrl.yaml
index 0b462eb6dfe169a292bf716503c03d029f1ac7ee..f4e0da0bf7fa30af5132644109dbd371ddfc0228 100644
--- a/Documentation/devicetree/bindings/pinctrl/canaan,k230-pinctrl.yaml
+++ b/Documentation/devicetree/bindings/pinctrl/canaan,k230-pinctrl.yaml
@@ -22,7 +22,7 @@ properties:
     maxItems: 1
 
 patternProperties:
-  '-pins$':
+  '-cfg$':
     type: object
     additionalProperties: false
     description:
@@ -30,7 +30,7 @@ patternProperties:
       pinctrl groups available on the machine.
 
     patternProperties:
-      '-cfg$':
+      '-pins$':
         type: object
         allOf:
           - $ref: /schemas/pinctrl/pincfg-node.yaml
@@ -112,8 +112,8 @@ examples:
         compatible = "canaan,k230-pinctrl";
         reg = <0x91105000 0x100>;
 
-        uart2-pins {
-            uart2-pins-cfg {
+        uart2-cfg {
+            uart2-pins {
                 pinmux = <0x503>, /* uart2 txd */
                          <0x603>; /* uart2 rxd */
                 slew-rate = <0>;

---
base-commit: 0a4b866d08c6adaea2f4592d31edac6deeb4dcbd
change-id: 20250526-k230-binding-fix-3125ff43f930

Best regards,
-- 
Ze Huang <huangze@whut.edu.cn>

Re: [PATCH] dt-bindings: pinctrl: k230: fix child node name patterns

[Conor Dooley]

[-- Attachment #1: Type: text/plain, Size: 2304 bytes --]

On Tue, May 27, 2025 at 12:23:35AM +0800, Ze Huang wrote:
> Rename child node name patterns to align with conventions.
> 
>     uart0-pins      =>   uart0-cfg
>         uart0-cfg            uart0-pins
> 
> This avoids potential confusion and improves consistency with existing
> bindings like sophgo,sg2042-pinctrl and starfive,jh7110-aon-pinctrl.
> 
> Fixes: 561f3e9d21a1 ("dt-bindings: pinctrl: Add support for canaan,k230 SoC")

You're changing something merged in October of last year, which is an
ABI break, for what seems like a cosmetic change to me. What makes this
worth it? Consistency with some devices by other vendors isn't a strong
argument I don't think.

> Signed-off-by: Ze Huang <huangze@whut.edu.cn>
> ---
>  .../devicetree/bindings/pinctrl/canaan,k230-pinctrl.yaml          | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/pinctrl/canaan,k230-pinctrl.yaml b/Documentation/devicetree/bindings/pinctrl/canaan,k230-pinctrl.yaml
> index 0b462eb6dfe169a292bf716503c03d029f1ac7ee..f4e0da0bf7fa30af5132644109dbd371ddfc0228 100644
> --- a/Documentation/devicetree/bindings/pinctrl/canaan,k230-pinctrl.yaml
> +++ b/Documentation/devicetree/bindings/pinctrl/canaan,k230-pinctrl.yaml
> @@ -22,7 +22,7 @@ properties:
>      maxItems: 1
>  
>  patternProperties:
> -  '-pins$':
> +  '-cfg$':
>      type: object
>      additionalProperties: false
>      description:
> @@ -30,7 +30,7 @@ patternProperties:
>        pinctrl groups available on the machine.
>  
>      patternProperties:
> -      '-cfg$':
> +      '-pins$':
>          type: object
>          allOf:
>            - $ref: /schemas/pinctrl/pincfg-node.yaml
> @@ -112,8 +112,8 @@ examples:
>          compatible = "canaan,k230-pinctrl";
>          reg = <0x91105000 0x100>;
>  
> -        uart2-pins {
> -            uart2-pins-cfg {
> +        uart2-cfg {
> +            uart2-pins {
>                  pinmux = <0x503>, /* uart2 txd */
>                           <0x603>; /* uart2 rxd */
>                  slew-rate = <0>;
> 
> ---
> base-commit: 0a4b866d08c6adaea2f4592d31edac6deeb4dcbd
> change-id: 20250526-k230-binding-fix-3125ff43f930
> 
> Best regards,
> -- 
> Ze Huang <huangze@whut.edu.cn>
> 

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH] dt-bindings: pinctrl: k230: fix child node name patterns

[Ze Huang]

On 5/27/25 10:36 PM, Conor Dooley wrote:
> On Tue, May 27, 2025 at 12:23:35AM +0800, Ze Huang wrote:
>> Rename child node name patterns to align with conventions.
>>
>>      uart0-pins      =>   uart0-cfg
>>          uart0-cfg            uart0-pins
>>
>> This avoids potential confusion and improves consistency with existing
>> bindings like sophgo,sg2042-pinctrl and starfive,jh7110-aon-pinctrl.
>>
>> Fixes: 561f3e9d21a1 ("dt-bindings: pinctrl: Add support for canaan,k230 SoC")
> You're changing something merged in October of last year, which is an
> ABI break, for what seems like a cosmetic change to me. What makes this
> worth it? Consistency with some devices by other vendors isn't a strong
> argument I don't think.

Thanks for the feedback.

You're right - this change would introduce an ABI break just for naming
consistency, there’s no strong functional benefit.

>> Signed-off-by: Ze Huang <huangze@whut.edu.cn>
>> ---
>>   .../devicetree/bindings/pinctrl/canaan,k230-pinctrl.yaml          | 8 ++++----
>>   1 file changed, 4 insertions(+), 4 deletions(-)
>>
>> diff --git a/Documentation/devicetree/bindings/pinctrl/canaan,k230-pinctrl.yaml b/Documentation/devicetree/bindings/pinctrl/canaan,k230-pinctrl.yaml
>> index 0b462eb6dfe169a292bf716503c03d029f1ac7ee..f4e0da0bf7fa30af5132644109dbd371ddfc0228 100644
>> --- a/Documentation/devicetree/bindings/pinctrl/canaan,k230-pinctrl.yaml
>> +++ b/Documentation/devicetree/bindings/pinctrl/canaan,k230-pinctrl.yaml
>> @@ -22,7 +22,7 @@ properties:
>>       maxItems: 1
>>   
>>   patternProperties:
>> -  '-pins$':
>> +  '-cfg$':
>>       type: object
>>       additionalProperties: false
>>       description:
>> @@ -30,7 +30,7 @@ patternProperties:
>>         pinctrl groups available on the machine.
>>   
>>       patternProperties:
>> -      '-cfg$':
>> +      '-pins$':
>>           type: object
>>           allOf:
>>             - $ref: /schemas/pinctrl/pincfg-node.yaml
>> @@ -112,8 +112,8 @@ examples:
>>           compatible = "canaan,k230-pinctrl";
>>           reg = <0x91105000 0x100>;
>>   
>> -        uart2-pins {
>> -            uart2-pins-cfg {
>> +        uart2-cfg {
>> +            uart2-pins {
>>                   pinmux = <0x503>, /* uart2 txd */
>>                            <0x603>; /* uart2 rxd */
>>                   slew-rate = <0>;
>>
>> ---
>> base-commit: 0a4b866d08c6adaea2f4592d31edac6deeb4dcbd
>> change-id: 20250526-k230-binding-fix-3125ff43f930
>>
>> Best regards,
>> -- 
>> Ze Huang <huangze@whut.edu.cn>
>>