[PATCH v3 2/5] dt-bindings: fpga: xlnx,fpga-slave-serial: rename gpios

Charles Perry posted 5 patches 2 years ago
There is a newer version of this series
[PATCH v3 2/5] dt-bindings: fpga: xlnx,fpga-slave-serial: rename gpios
Posted by Charles Perry 2 years ago
By convention, gpio consumer names should not contain underscores
(prog_b here) and shouldn't contain active low suffixes (-b here).

Signed-off-by: Charles Perry <charles.perry@savoirfairelinux.com>
---
 .../bindings/fpga/xlnx,fpga-slave-serial.yaml        | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/Documentation/devicetree/bindings/fpga/xlnx,fpga-slave-serial.yaml b/Documentation/devicetree/bindings/fpga/xlnx,fpga-slave-serial.yaml
index 614d86ad825f3..650a4d8792b64 100644
--- a/Documentation/devicetree/bindings/fpga/xlnx,fpga-slave-serial.yaml
+++ b/Documentation/devicetree/bindings/fpga/xlnx,fpga-slave-serial.yaml
@@ -36,7 +36,7 @@ properties:
   reg:
     maxItems: 1
 
-  prog_b-gpios:
+  prog-gpios:
     description:
       config pin (referred to as PROGRAM_B in the manual)
     maxItems: 1
@@ -46,7 +46,7 @@ properties:
       config status pin (referred to as DONE in the manual)
     maxItems: 1
 
-  init-b-gpios:
+  init-gpios:
     description:
       initialization status and configuration error pin
       (referred to as INIT_B in the manual)
@@ -55,9 +55,9 @@ properties:
 required:
   - compatible
   - reg
-  - prog_b-gpios
+  - prog-gpios
   - done-gpios
-  - init-b-gpios
+  - init-gpios
 
 additionalProperties: false
 
@@ -72,8 +72,8 @@ examples:
         spi-max-frequency = <60000000>;
         spi-cpha;
         reg = <0>;
-        prog_b-gpios = <&gpio0 29 GPIO_ACTIVE_LOW>;
-        init-b-gpios = <&gpio0 28 GPIO_ACTIVE_LOW>;
+        prog-gpios = <&gpio0 29 GPIO_ACTIVE_LOW>;
+        init-gpios = <&gpio0 28 GPIO_ACTIVE_LOW>;
         done-gpios = <&gpio0 9 GPIO_ACTIVE_HIGH>;
       };
     };
-- 
2.43.0
Re: [PATCH v3 2/5] dt-bindings: fpga: xlnx,fpga-slave-serial: rename gpios
Posted by Rob Herring 1 year, 12 months ago
On Wed, Feb 07, 2024 at 01:01:25PM -0500, Charles Perry wrote:
> By convention, gpio consumer names should not contain underscores
> (prog_b here) and shouldn't contain active low suffixes (-b here).

Yes, that is the preference, but we are stuck with supporting the old 
name. It is not worth it to carry both in the binding and kernel.

Rob
Re: [PATCH v3 2/5] dt-bindings: fpga: xlnx,fpga-slave-serial: rename gpios
Posted by Charles Perry 1 year, 11 months ago
On Feb 15, 2024, at 8:32 AM, Rob Herring robh@kernel.org wrote:
> On Wed, Feb 07, 2024 at 01:01:25PM -0500, Charles Perry wrote:
>> By convention, gpio consumer names should not contain underscores
>> (prog_b here) and shouldn't contain active low suffixes (-b here).
> 
> Yes, that is the preference, but we are stuck with supporting the old
> name. It is not worth it to carry both in the binding and kernel.
> 
> Rob

Ok, I'll go back to "prog_b", "init-b" and drop patch 2 and 3 for v4.

Regards,
Charles
Re: [PATCH v3 2/5] dt-bindings: fpga: xlnx,fpga-slave-serial: rename gpios
Posted by Krzysztof Kozlowski 1 year, 12 months ago
On 07/02/2024 19:01, Charles Perry wrote:
> By convention, gpio consumer names should not contain underscores
> (prog_b here) and shouldn't contain active low suffixes (-b here).
> 
> Signed-off-by: Charles Perry <charles.perry@savoirfairelinux.com>
> ---
>  .../bindings/fpga/xlnx,fpga-slave-serial.yaml        | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/fpga/xlnx,fpga-slave-serial.yaml b/Documentation/devicetree/bindings/fpga/xlnx,fpga-slave-serial.yaml
> index 614d86ad825f3..650a4d8792b64 100644
> --- a/Documentation/devicetree/bindings/fpga/xlnx,fpga-slave-serial.yaml
> +++ b/Documentation/devicetree/bindings/fpga/xlnx,fpga-slave-serial.yaml
> @@ -36,7 +36,7 @@ properties:
>    reg:
>      maxItems: 1
>  
> -  prog_b-gpios:
> +  prog-gpios:

Please deprecate old property and add allOf excluding the usage of both.
Driver still parses old property, so we should have it documented.

https://lore.kernel.org/all/20230118163208.GA117919-robh@kernel.org/

Best regards,
Krzysztof
Re: [PATCH v3 2/5] dt-bindings: fpga: xlnx,fpga-slave-serial: rename gpios
Posted by Charles Perry 1 year, 12 months ago
On Feb 11, 2024, at 10:39 AM, Krzysztof Kozlowski krzysztof.kozlowski@linaro.org wrote:
> On 07/02/2024 19:01, Charles Perry wrote:
>> By convention, gpio consumer names should not contain underscores
>> (prog_b here) and shouldn't contain active low suffixes (-b here).
>> 
>> Signed-off-by: Charles Perry <charles.perry@savoirfairelinux.com>
>> ---
>>  .../bindings/fpga/xlnx,fpga-slave-serial.yaml        | 12 ++++++------
>>  1 file changed, 6 insertions(+), 6 deletions(-)
>> 
>> diff --git a/Documentation/devicetree/bindings/fpga/xlnx,fpga-slave-serial.yaml
>> b/Documentation/devicetree/bindings/fpga/xlnx,fpga-slave-serial.yaml
>> index 614d86ad825f3..650a4d8792b64 100644
>> --- a/Documentation/devicetree/bindings/fpga/xlnx,fpga-slave-serial.yaml
>> +++ b/Documentation/devicetree/bindings/fpga/xlnx,fpga-slave-serial.yaml
>> @@ -36,7 +36,7 @@ properties:
>>    reg:
>>      maxItems: 1
>>  
>> -  prog_b-gpios:
>> +  prog-gpios:
> 
> Please deprecate old property and add allOf excluding the usage of both.
> Driver still parses old property, so we should have it documented.
> 
> https://lore.kernel.org/all/20230118163208.GA117919-robh@kernel.org/
> 
> Best regards,
> Krzysztof

Ok. Thank you for the example.

Regards,
Charles