diff mbox series

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

Message ID 20240207180142.79625-3-charles.perry@savoirfairelinux.com
State New
Headers
Series fpga: xilinx-selectmap: add new driver |

Commit Message

Charles Perry Feb. 7, 2024, 6:01 p.m. UTC 
  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(-)

Comments

Krzysztof Kozlowski Feb. 11, 2024, 3:39 p.m. UTC | #1 
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
Charles Perry Feb. 13, 2024, 9:40 p.m. UTC | #2 
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
Rob Herring Feb. 15, 2024, 1:32 p.m. UTC | #3 
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
Charles Perry Feb. 15, 2024, 7:42 p.m. UTC | #4 
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
diff mbox series

Patch

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>;
       };
     };