diff mbox series

dt-bindings: serial: convert st,asc to DT schema

Message ID 20240225100336.34122-1-rgallaispou@gmail.com
State Superseded
Headers show
Series dt-bindings: serial: convert st,asc to DT schema | expand

Commit Message

Raphael Gallais-Pou Feb. 25, 2024, 10:03 a.m. UTC
Converts st,asc binding to DT schema format and update example.

Signed-off-by: Raphael Gallais-Pou <rgallaispou@gmail.com>
---
 .../devicetree/bindings/serial/st,asc.yaml    | 57 +++++++++++++++++++
 .../devicetree/bindings/serial/st-asc.txt     | 18 ------
 2 files changed, 57 insertions(+), 18 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/serial/st,asc.yaml
 delete mode 100644 Documentation/devicetree/bindings/serial/st-asc.txt

Comments

Krzysztof Kozlowski Feb. 25, 2024, 3:42 p.m. UTC | #1
On 25/02/2024 11:03, Raphael Gallais-Pou wrote:
> Converts st,asc binding to DT schema format and update example.
> 
> Signed-off-by: Raphael Gallais-Pou <rgallaispou@gmail.com>
> ---
>  .../devicetree/bindings/serial/st,asc.yaml    | 57 +++++++++++++++++++
>  .../devicetree/bindings/serial/st-asc.txt     | 18 ------
>  2 files changed, 57 insertions(+), 18 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/serial/st,asc.yaml
>  delete mode 100644 Documentation/devicetree/bindings/serial/st-asc.txt
> 
> diff --git a/Documentation/devicetree/bindings/serial/st,asc.yaml b/Documentation/devicetree/bindings/serial/st,asc.yaml
> new file mode 100644
> index 000000000000..b26e1d247346
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/serial/st,asc.yaml
> @@ -0,0 +1,57 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/serial/st,asc.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: STMicroelectronics STi SoCs Serial Port
> +
> +maintainers:
> +  - Patrice Chotard <patrice.chotard@foss.st.com>
> +
> +allOf:
> +  - $ref: serial.yaml#
> +
> +properties:
> +  compatible:
> +    const: st,asc
> +
> +  reg:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  clocks:
> +    maxItems: 1

This wasn't here before and your commit msg does not explain it.

> +
> +  uart-has-rtscts: true

Drop, not needed.

> +
> +  st,hw-flow-ctrl:
> +    description: When set, enable hardware flow control.
> +    type: boolean
> +
> +  st,force-m1:
> +    description: When set, force asc to be in Mode-1. This is recommended for
> +      high bit rates above 19.2K.
> +    type: boolean
> +
> +required:
> +  - compatible
> +  - reg
> +  - interrupts
> +  - clocks

Also something new.




Best regards,
Krzysztof
Raphael Gallais-Pou Feb. 26, 2024, 7:38 a.m. UTC | #2
Hi Krzysztof,


Le 25/02/2024 à 16:42, Krzysztof Kozlowski a écrit :
> On 25/02/2024 11:03, Raphael Gallais-Pou wrote:
>> Converts st,asc binding to DT schema format and update example.
>>
>> Signed-off-by: Raphael Gallais-Pou <rgallaispou@gmail.com>
>> ---
>>   .../devicetree/bindings/serial/st,asc.yaml    | 57 +++++++++++++++++++
>>   .../devicetree/bindings/serial/st-asc.txt     | 18 ------
>>   2 files changed, 57 insertions(+), 18 deletions(-)
>>   create mode 100644 Documentation/devicetree/bindings/serial/st,asc.yaml
>>   delete mode 100644 Documentation/devicetree/bindings/serial/st-asc.txt
>>
>> diff --git a/Documentation/devicetree/bindings/serial/st,asc.yaml b/Documentation/devicetree/bindings/serial/st,asc.yaml
>> new file mode 100644
>> index 000000000000..b26e1d247346
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/serial/st,asc.yaml
>> @@ -0,0 +1,57 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/serial/st,asc.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: STMicroelectronics STi SoCs Serial Port
>> +
>> +maintainers:
>> +  - Patrice Chotard <patrice.chotard@foss.st.com>
>> +
>> +allOf:
>> +  - $ref: serial.yaml#
>> +
>> +properties:
>> +  compatible:
>> +    const: st,asc
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  interrupts:
>> +    maxItems: 1
>> +
>> +  clocks:
>> +    maxItems: 1
> 
> This wasn't here before and your commit msg does not explain it.

Looking at the device-tree I found that every instance of this device 
refers to a phandle of a clock.

Moreover in the driver of the device, the probe fails if it does not 
find a clock, hence this addition.

cf. drivers/tty/serial/st-asc.c:701
> 
>> +
>> +  uart-has-rtscts: true
> 
> Drop, not needed.

Ack
> 
>> +
>> +  st,hw-flow-ctrl:
>> +    description: When set, enable hardware flow control.
>> +    type: boolean
>> +
>> +  st,force-m1:
>> +    description: When set, force asc to be in Mode-1. This is recommended for
>> +      high bit rates above 19.2K.
>> +    type: boolean
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - interrupts
>> +  - clocks
> 
> Also something new.

This is linked to the addition above.

If you agree with this change I will send a v2 explaining this.

Regards,
Raphaël
> 
> 
> 
> 
> Best regards,
> Krzysztof
>
Krzysztof Kozlowski Feb. 26, 2024, 8:09 a.m. UTC | #3
On 26/02/2024 08:38, Raphaël Gallais-Pou wrote:
>>> +
>>> +allOf:
>>> +  - $ref: serial.yaml#
>>> +
>>> +properties:
>>> +  compatible:
>>> +    const: st,asc
>>> +
>>> +  reg:
>>> +    maxItems: 1
>>> +
>>> +  interrupts:
>>> +    maxItems: 1
>>> +
>>> +  clocks:
>>> +    maxItems: 1
>>
>> This wasn't here before and your commit msg does not explain it.
> 
> Looking at the device-tree I found that every instance of this device 
> refers to a phandle of a clock.
> 
> Moreover in the driver of the device, the probe fails if it does not 
> find a clock, hence this addition.
> 
> cf. drivers/tty/serial/st-asc.c:701

Commit msg should explain differences from pure conversion and the
reason behind. Otherwise how can we know why you did it?


Best regards,
Krzysztof
Raphael Gallais-Pou Feb. 26, 2024, 10:08 a.m. UTC | #4
Le 26/02/2024 à 09:09, Krzysztof Kozlowski a écrit :
> On 26/02/2024 08:38, Raphaël Gallais-Pou wrote:
>>>> +
>>>> +allOf:
>>>> +  - $ref: serial.yaml#
>>>> +
>>>> +properties:
>>>> +  compatible:
>>>> +    const: st,asc
>>>> +
>>>> +  reg:
>>>> +    maxItems: 1
>>>> +
>>>> +  interrupts:
>>>> +    maxItems: 1
>>>> +
>>>> +  clocks:
>>>> +    maxItems: 1
>>>
>>> This wasn't here before and your commit msg does not explain it.
>>
>> Looking at the device-tree I found that every instance of this device
>> refers to a phandle of a clock.
>>
>> Moreover in the driver of the device, the probe fails if it does not
>> find a clock, hence this addition.
>>
>> cf. drivers/tty/serial/st-asc.c:701
> 
> Commit msg should explain differences from pure conversion and the
> reason behind. Otherwise how can we know why you did it?

Indeed, I will change the commit log.

Regards,
Raphaël
> 
> 
> Best regards,
> Krzysztof
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/serial/st,asc.yaml b/Documentation/devicetree/bindings/serial/st,asc.yaml
new file mode 100644
index 000000000000..b26e1d247346
--- /dev/null
+++ b/Documentation/devicetree/bindings/serial/st,asc.yaml
@@ -0,0 +1,57 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/serial/st,asc.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: STMicroelectronics STi SoCs Serial Port
+
+maintainers:
+  - Patrice Chotard <patrice.chotard@foss.st.com>
+
+allOf:
+  - $ref: serial.yaml#
+
+properties:
+  compatible:
+    const: st,asc
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  uart-has-rtscts: true
+
+  st,hw-flow-ctrl:
+    description: When set, enable hardware flow control.
+    type: boolean
+
+  st,force-m1:
+    description: When set, force asc to be in Mode-1. This is recommended for
+      high bit rates above 19.2K.
+    type: boolean
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/clock/stih407-clks.h>
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    serial@9830000 {
+        compatible = "st,asc";
+        reg = <0x9830000 0x2c>;
+        interrupts = <GIC_SPI 122 IRQ_TYPE_LEVEL_HIGH>;
+        clocks = <&clk_s_c0_flexgen CLK_EXT2F_A9>;
+    };
+...
diff --git a/Documentation/devicetree/bindings/serial/st-asc.txt b/Documentation/devicetree/bindings/serial/st-asc.txt
deleted file mode 100644
index a1b9b6f3490a..000000000000
--- a/Documentation/devicetree/bindings/serial/st-asc.txt
+++ /dev/null
@@ -1,18 +0,0 @@ 
-*st-asc(Serial Port)
-
-Required properties:
-- compatible : Should be "st,asc".
-- reg, reg-names, interrupts, interrupt-names	: Standard way to define device
-			resources with names. look in
-			Documentation/devicetree/bindings/resource-names.txt
-
-Optional properties:
-- st,hw-flow-ctrl	bool flag to enable hardware flow control.
-- st,force-m1		bool flat to force asc to be in Mode-1 recommended
-			for high bit rates (above 19.2K)
-Example:
-serial@fe440000{
-    compatible    = "st,asc";
-    reg         = <0xfe440000 0x2c>;
-    interrupts     =  <0 209 0>;
-};