diff mbox series

[1/1] dt-bindings: ata: ahci-fsl-qoriq: convert to yaml format

Message ID 20240617180241.901377-1-Frank.Li@nxp.com
State New
Headers show
Series [1/1] dt-bindings: ata: ahci-fsl-qoriq: convert to yaml format | expand

Commit Message

Frank Li June 17, 2024, 6:02 p.m. UTC 
Convert ahci-fsl-qoirq DT binding to yaml format.

Additional changes:
- Add reg-names list, ahci and sata-ecc
- Add fsl,ls1028a-ahci and fsl,lx2060a-ahci

Signed-off-by: Frank Li <Frank.Li@nxp.com>
---
 .../bindings/ata/ahci-fsl-qoriq.txt           | 21 -------
 .../devicetree/bindings/ata/fsl,ahci.yaml     | 58 +++++++++++++++++++
 2 files changed, 58 insertions(+), 21 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/ata/ahci-fsl-qoriq.txt
 create mode 100644 Documentation/devicetree/bindings/ata/fsl,ahci.yaml

Comments

Niklas Cassel June 17, 2024, 7:12 p.m. UTC | #1 
On Mon, Jun 17, 2024 at 02:02:40PM -0400, Frank Li wrote:
> Convert ahci-fsl-qoirq DT binding to yaml format.
> 
> Additional changes:
> - Add reg-names list, ahci and sata-ecc
> - Add fsl,ls1028a-ahci and fsl,lx2060a-ahci
> 
> Signed-off-by: Frank Li <Frank.Li@nxp.com>
> ---
>  .../bindings/ata/ahci-fsl-qoriq.txt           | 21 -------
>  .../devicetree/bindings/ata/fsl,ahci.yaml     | 58 +++++++++++++++++++
>  2 files changed, 58 insertions(+), 21 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/ata/ahci-fsl-qoriq.txt
>  create mode 100644 Documentation/devicetree/bindings/ata/fsl,ahci.yaml

Should this file perhaps be called:
fsl,qoriq-ahci.yaml ?

Would be nice with some input from DT maintainers on this.


Kind regards,
Niklas
Krzysztof Kozlowski June 18, 2024, 7:42 a.m. UTC | #2 
On 17/06/2024 21:12, Niklas Cassel wrote:
> On Mon, Jun 17, 2024 at 02:02:40PM -0400, Frank Li wrote:
>> Convert ahci-fsl-qoirq DT binding to yaml format.
>>
>> Additional changes:
>> - Add reg-names list, ahci and sata-ecc
>> - Add fsl,ls1028a-ahci and fsl,lx2060a-ahci
>>
>> Signed-off-by: Frank Li <Frank.Li@nxp.com>
>> ---
>>  .../bindings/ata/ahci-fsl-qoriq.txt           | 21 -------
>>  .../devicetree/bindings/ata/fsl,ahci.yaml     | 58 +++++++++++++++++++
>>  2 files changed, 58 insertions(+), 21 deletions(-)
>>  delete mode 100644 Documentation/devicetree/bindings/ata/ahci-fsl-qoriq.txt
>>  create mode 100644 Documentation/devicetree/bindings/ata/fsl,ahci.yaml
> 
> Should this file perhaps be called:
> fsl,qoriq-ahci.yaml ?
> 
> Would be nice with some input from DT maintainers on this.

This should be rather compatible.

Best regards,
Krzysztof
Krzysztof Kozlowski June 18, 2024, 7:42 a.m. UTC | #3 
On 17/06/2024 20:02, Frank Li wrote:
> Convert ahci-fsl-qoirq DT binding to yaml format.
> 
> Additional changes:
> - Add reg-names list, ahci and sata-ecc
> - Add fsl,ls1028a-ahci and fsl,lx2060a-ahci
> 

Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>

Best regards,
Krzysztof
Niklas Cassel June 18, 2024, 8:45 a.m. UTC | #4 
On Tue, Jun 18, 2024 at 09:42:03AM +0200, Krzysztof Kozlowski wrote:
> On 17/06/2024 21:12, Niklas Cassel wrote:
> > On Mon, Jun 17, 2024 at 02:02:40PM -0400, Frank Li wrote:
> >> Convert ahci-fsl-qoirq DT binding to yaml format.
> >>
> >> Additional changes:
> >> - Add reg-names list, ahci and sata-ecc
> >> - Add fsl,ls1028a-ahci and fsl,lx2060a-ahci
> >>
> >> Signed-off-by: Frank Li <Frank.Li@nxp.com>
> >> ---
> >>  .../bindings/ata/ahci-fsl-qoriq.txt           | 21 -------
> >>  .../devicetree/bindings/ata/fsl,ahci.yaml     | 58 +++++++++++++++++++
> >>  2 files changed, 58 insertions(+), 21 deletions(-)
> >>  delete mode 100644 Documentation/devicetree/bindings/ata/ahci-fsl-qoriq.txt
> >>  create mode 100644 Documentation/devicetree/bindings/ata/fsl,ahci.yaml
> > 
> > Should this file perhaps be called:
> > fsl,qoriq-ahci.yaml ?
> > 
> > Would be nice with some input from DT maintainers on this.
> 
> This should be rather compatible.

Considering that you gave your Reviewed-by tag, I interpret this sentence
as that you are happy with the filename used (fsl,ahci.yaml) in this patch.


Kind regards,
Niklas
Krzysztof Kozlowski June 18, 2024, 9:13 a.m. UTC | #5 
On 18/06/2024 10:45, Niklas Cassel wrote:
> On Tue, Jun 18, 2024 at 09:42:03AM +0200, Krzysztof Kozlowski wrote:
>> On 17/06/2024 21:12, Niklas Cassel wrote:
>>> On Mon, Jun 17, 2024 at 02:02:40PM -0400, Frank Li wrote:
>>>> Convert ahci-fsl-qoirq DT binding to yaml format.
>>>>
>>>> Additional changes:
>>>> - Add reg-names list, ahci and sata-ecc
>>>> - Add fsl,ls1028a-ahci and fsl,lx2060a-ahci
>>>>
>>>> Signed-off-by: Frank Li <Frank.Li@nxp.com>
>>>> ---
>>>>  .../bindings/ata/ahci-fsl-qoriq.txt           | 21 -------
>>>>  .../devicetree/bindings/ata/fsl,ahci.yaml     | 58 +++++++++++++++++++
>>>>  2 files changed, 58 insertions(+), 21 deletions(-)
>>>>  delete mode 100644 Documentation/devicetree/bindings/ata/ahci-fsl-qoriq.txt
>>>>  create mode 100644 Documentation/devicetree/bindings/ata/fsl,ahci.yaml
>>>
>>> Should this file perhaps be called:
>>> fsl,qoriq-ahci.yaml ?
>>>
>>> Would be nice with some input from DT maintainers on this.
>>
>> This should be rather compatible.
> 
> Considering that you gave your Reviewed-by tag, I interpret this sentence
> as that you are happy with the filename used (fsl,ahci.yaml) in this patch.
> 

Yes, maybe indeed fsl,qoriq-ahci or compatible-based would be better,
but probably I provided a bit different review on other patch, so don't
want to block useful conversion.

Best regards,
Krzysztof
Niklas Cassel June 18, 2024, 9:44 a.m. UTC | #6 
On Mon, Jun 17, 2024 at 02:02:40PM -0400, Frank Li wrote:
> Convert ahci-fsl-qoirq DT binding to yaml format.
> 
> Additional changes:
> - Add reg-names list, ahci and sata-ecc
> - Add fsl,ls1028a-ahci and fsl,lx2060a-ahci
> 
> Signed-off-by: Frank Li <Frank.Li@nxp.com>
> ---
>  .../bindings/ata/ahci-fsl-qoriq.txt           | 21 -------
>  .../devicetree/bindings/ata/fsl,ahci.yaml     | 58 +++++++++++++++++++
>  2 files changed, 58 insertions(+), 21 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/ata/ahci-fsl-qoriq.txt
>  create mode 100644 Documentation/devicetree/bindings/ata/fsl,ahci.yaml
> 
> diff --git a/Documentation/devicetree/bindings/ata/ahci-fsl-qoriq.txt b/Documentation/devicetree/bindings/ata/ahci-fsl-qoriq.txt
> deleted file mode 100644
> index 7c3ca0e13de05..0000000000000
> --- a/Documentation/devicetree/bindings/ata/ahci-fsl-qoriq.txt
> +++ /dev/null
> @@ -1,21 +0,0 @@
> -Binding for Freescale QorIQ AHCI SATA Controller
> -
> -Required properties:
> -  - reg: Physical base address and size of the controller's register area.
> -  - compatible: Compatibility string. Must be 'fsl,<chip>-ahci', where
> -    chip could be ls1021a, ls1043a, ls1046a, ls1088a, ls2080a etc.
> -  - clocks: Input clock specifier. Refer to common clock bindings.
> -  - interrupts: Interrupt specifier. Refer to interrupt binding.
> -
> -Optional properties:
> -  - dma-coherent: Enable AHCI coherent DMA operation.
> -  - reg-names: register area names when there are more than 1 register area.
> -
> -Examples:
> -	sata@3200000 {
> -		compatible = "fsl,ls1021a-ahci";
> -		reg = <0x0 0x3200000 0x0 0x10000>;
> -		interrupts = <GIC_SPI 101 IRQ_TYPE_LEVEL_HIGH>;
> -		clocks = <&platform_clk 1>;
> -		dma-coherent;
> -	};
> diff --git a/Documentation/devicetree/bindings/ata/fsl,ahci.yaml b/Documentation/devicetree/bindings/ata/fsl,ahci.yaml
> new file mode 100644
> index 0000000000000..162b3bb5427ed
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/ata/fsl,ahci.yaml
> @@ -0,0 +1,58 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/ata/fsl,ahci.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Freescale QorIQ AHCI SATA Controller
> +
> +maintainers:
> +  - Frank Li <Frank.Li@nxp.com>
> +
> +properties:
> +  compatible:
> +    enum:
> +      - fsl,ls1021a-ahci
> +      - fsl,ls1043a-ahci
> +      - fsl,ls1028a-ahci
> +      - fsl,ls1088a-ahci
> +      - fsl,ls2080a-ahci
> +      - fsl,lx2160a-ahci
> +
> +  reg:
> +    minItems: 1
> +    maxItems: 2
> +
> +  reg-names:
> +    items:
> +      - const: ahci
> +      - const: sata-ecc
> +    minItems: 1
> +
> +  clocks:
> +    maxItems: 1
> +
> +  interrupts:
> +    maxItems: 1
> +
> +  dma-coherent: true
> +
> +required:
> +  - compatible
> +  - reg
> +  - clocks
> +  - interrupts
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +
> +    sata@3200000 {
> +        compatible = "fsl,ls1021a-ahci";
> +        reg = <0x3200000 0x10000>;
> +        interrupts = <GIC_SPI 101 IRQ_TYPE_LEVEL_HIGH>;
> +        clocks = <&platform_clk 1>;
> +        dma-coherent;
> +    };
> -- 
> 2.34.1
> 

Applied:
https://git.kernel.org/pub/scm/linux/kernel/git/libata/linux.git/log/?h=for-6.11
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/ata/ahci-fsl-qoriq.txt b/Documentation/devicetree/bindings/ata/ahci-fsl-qoriq.txt
deleted file mode 100644
index 7c3ca0e13de05..0000000000000
--- a/Documentation/devicetree/bindings/ata/ahci-fsl-qoriq.txt
+++ /dev/null
@@ -1,21 +0,0 @@ 
-Binding for Freescale QorIQ AHCI SATA Controller
-
-Required properties:
-  - reg: Physical base address and size of the controller's register area.
-  - compatible: Compatibility string. Must be 'fsl,<chip>-ahci', where
-    chip could be ls1021a, ls1043a, ls1046a, ls1088a, ls2080a etc.
-  - clocks: Input clock specifier. Refer to common clock bindings.
-  - interrupts: Interrupt specifier. Refer to interrupt binding.
-
-Optional properties:
-  - dma-coherent: Enable AHCI coherent DMA operation.
-  - reg-names: register area names when there are more than 1 register area.
-
-Examples:
-	sata@3200000 {
-		compatible = "fsl,ls1021a-ahci";
-		reg = <0x0 0x3200000 0x0 0x10000>;
-		interrupts = <GIC_SPI 101 IRQ_TYPE_LEVEL_HIGH>;
-		clocks = <&platform_clk 1>;
-		dma-coherent;
-	};
diff --git a/Documentation/devicetree/bindings/ata/fsl,ahci.yaml b/Documentation/devicetree/bindings/ata/fsl,ahci.yaml
new file mode 100644
index 0000000000000..162b3bb5427ed
--- /dev/null
+++ b/Documentation/devicetree/bindings/ata/fsl,ahci.yaml
@@ -0,0 +1,58 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/ata/fsl,ahci.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Freescale QorIQ AHCI SATA Controller
+
+maintainers:
+  - Frank Li <Frank.Li@nxp.com>
+
+properties:
+  compatible:
+    enum:
+      - fsl,ls1021a-ahci
+      - fsl,ls1043a-ahci
+      - fsl,ls1028a-ahci
+      - fsl,ls1088a-ahci
+      - fsl,ls2080a-ahci
+      - fsl,lx2160a-ahci
+
+  reg:
+    minItems: 1
+    maxItems: 2
+
+  reg-names:
+    items:
+      - const: ahci
+      - const: sata-ecc
+    minItems: 1
+
+  clocks:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  dma-coherent: true
+
+required:
+  - compatible
+  - reg
+  - clocks
+  - interrupts
+
+additionalProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+
+    sata@3200000 {
+        compatible = "fsl,ls1021a-ahci";
+        reg = <0x3200000 0x10000>;
+        interrupts = <GIC_SPI 101 IRQ_TYPE_LEVEL_HIGH>;
+        clocks = <&platform_clk 1>;
+        dma-coherent;
+    };