diff mbox series

[v5] dt-bindings: imx-pata: Convert to dtschema

Message ID 20240310171958.96388-1-animeshagarwal28@gmail.com (mailing list archive)
State New, archived
Headers show
Series [v5] dt-bindings: imx-pata: Convert to dtschema | expand

Commit Message

Animesh Agarwal March 10, 2024, 5:19 p.m. UTC
Convert the imx-pata bindings to DT schema.

Signed-off-by: Animesh Agarwal <animeshagarwal28@gmail.com>

---
Changes in v5:
- added oneOf in compatible property to allow the usage of imx27 alone.

Changes in v4:
- added fsl,imx31-pata in compatible property as enum
- imx31-pata was not listed in compatible in original txt binding
- adding imx31-pata in enum ensures the node compiles to imx31.dtsi

Changes in v3:
- added fsl,imx51-pata in compatible property as enum
- imx51-pata was not listed in compatible in original txt binding
- adding imx51-pata in enum ensures the node compiles to imx31.dtsi
- fsl,imx27-pata is added as a const to ensure it is present always

Changes in v2:
- fixed style issues
- compatible property now matches the examples
- fixed yamllint warnings/errors
---
 .../devicetree/bindings/ata/fsl,imx-pata.yaml | 43 +++++++++++++++++++
 .../devicetree/bindings/ata/imx-pata.txt      | 16 -------
 2 files changed, 43 insertions(+), 16 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/ata/fsl,imx-pata.yaml
 delete mode 100644 Documentation/devicetree/bindings/ata/imx-pata.txt

Comments

Krzysztof Kozlowski March 10, 2024, 5:25 p.m. UTC | #1
On 10/03/2024 18:19, Animesh Agarwal wrote:
> Convert the imx-pata bindings to DT schema.

Same commit msg, nothing changed.

> 
> Signed-off-by: Animesh Agarwal <animeshagarwal28@gmail.com>
> 
> ---
> Changes in v5:
> - added oneOf in compatible property to allow the usage of imx27 alone.
> 
> Changes in v4:
> - added fsl,imx31-pata in compatible property as enum
> - imx31-pata was not listed in compatible in original txt binding
> - adding imx31-pata in enum ensures the node compiles to imx31.dtsi
> 
> Changes in v3:
> - added fsl,imx51-pata in compatible property as enum
> - imx51-pata was not listed in compatible in original txt binding
> - adding imx51-pata in enum ensures the node compiles to imx31.dtsi
> - fsl,imx27-pata is added as a const to ensure it is present always
> 
> Changes in v2:
> - fixed style issues
> - compatible property now matches the examples
> - fixed yamllint warnings/errors
> ---
>  .../devicetree/bindings/ata/fsl,imx-pata.yaml | 43 +++++++++++++++++++
>  .../devicetree/bindings/ata/imx-pata.txt      | 16 -------
>  2 files changed, 43 insertions(+), 16 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/ata/fsl,imx-pata.yaml
>  delete mode 100644 Documentation/devicetree/bindings/ata/imx-pata.txt
> 
> diff --git a/Documentation/devicetree/bindings/ata/fsl,imx-pata.yaml b/Documentation/devicetree/bindings/ata/fsl,imx-pata.yaml
> new file mode 100644
> index 000000000000..85b18d26a834
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/ata/fsl,imx-pata.yaml
> @@ -0,0 +1,43 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/ata/fsl,imx-pata.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Freescale i.MX PATA Controller
> +
> +maintainers:
> +  - Animesh Agarwal <animeshagarwal28@gmail.com>
> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - items:
> +          - enum:
> +              - fsl,imx31-pata
> +              - fsl,imx51-pata
> +          - const: fsl,imx27-pata
> +      - items:

No need for items here, just const.

Best regards,
Krzysztof
Animesh Agarwal March 10, 2024, 5:31 p.m. UTC | #2
On Sun, Mar 10, 2024 at 10:55 PM Krzysztof Kozlowski
<krzysztof.kozlowski@linaro.org> wrote:
> Same commit msg, nothing changed.
Sorry, I will change the subject line of the commit message as well now.

> No need for items here, just const.
Ok, fixing it.

Thanks & Regards
Animesh Agarwal
Krzysztof Kozlowski March 10, 2024, 5:37 p.m. UTC | #3
On 10/03/2024 18:31, Animesh Agarwal wrote:
> On Sun, Mar 10, 2024 at 10:55 PM Krzysztof Kozlowski
> <krzysztof.kozlowski@linaro.org> wrote:
>> Same commit msg, nothing changed.
> Sorry, I will change the subject line of the commit message as well now.

I did not say about subject, but about commit message.

Best regards,
Krzysztof
Animesh Agarwal March 10, 2024, 5:51 p.m. UTC | #4
On Sun, Mar 10, 2024 at 11:08 PM Krzysztof Kozlowski
<krzysztof.kozlowski@linaro.org> wrote:
> I did not say about subject, but about commit message.
Ok, I'll add commit message above the change log.
Krzysztof Kozlowski March 10, 2024, 8:25 p.m. UTC | #5
On 10/03/2024 18:51, Animesh Agarwal wrote:
> On Sun, Mar 10, 2024 at 11:08 PM Krzysztof Kozlowski
> <krzysztof.kozlowski@linaro.org> wrote:
>> I did not say about subject, but about commit message.
> Ok, I'll add commit message above the change log.

What changelog? Read carefully what I asked you few versions ago:

"Please explain the differences done during conversion in the commit
msg. There was no imx51 compatible in the binding before."


The differences from conversion. There was some binding in TXT and you
convert to different format. You introduce changes beyond pure
conversion, so this must be explained. Again: explain what changes are
you making *to the binding*, which are not pure conversion, and why you
are making them.

Best regards,
Krzysztof
Animesh Agarwal March 11, 2024, 3:18 a.m. UTC | #6
On Mon, Mar 11, 2024 at 1:55 AM Krzysztof Kozlowski
<krzysztof.kozlowski@linaro.org> wrote:
> What changelog? Read carefully what I asked you few versions ago:
Below the sign off I have added changes done in all the versions
before and explained why imx51-pata was added.

> "Please explain the differences done during conversion in the commit
> msg. There was no imx51 compatible in the binding before."

""
Changes in v4:
- added fsl,imx31-pata in compatible property as enum
- imx31-pata was not listed in compatible in original txt binding
- adding imx31-pata in enum ensures the node compiles to imx31.dtsi
Changes in v3:
- added fsl,imx51-pata in compatible property as enum
- imx51-pata was not listed in compatible in original txt binding
- adding imx51-pata in enum ensures the node compiles to imx51.dtsi
- fsl,imx27-pata is added as a const to ensure it is present always
""
Aren't these lines enough for the said explanation?

Thanks & Regards
Animesh
Krzysztof Kozlowski March 11, 2024, 6:26 a.m. UTC | #7
On 11/03/2024 04:18, Animesh Agarwal wrote:
> On Mon, Mar 11, 2024 at 1:55 AM Krzysztof Kozlowski
> <krzysztof.kozlowski@linaro.org> wrote:
>> What changelog? Read carefully what I asked you few versions ago:
> Below the sign off I have added changes done in all the versions
> before and explained why imx51-pata was added.
> 
>> "Please explain the differences done during conversion in the commit
>> msg. There was no imx51 compatible in the binding before."
> 
> ""
> Changes in v4:
> - added fsl,imx31-pata in compatible property as enum
> - imx31-pata was not listed in compatible in original txt binding
> - adding imx31-pata in enum ensures the node compiles to imx31.dtsi
> Changes in v3:
> - added fsl,imx51-pata in compatible property as enum
> - imx51-pata was not listed in compatible in original txt binding
> - adding imx51-pata in enum ensures the node compiles to imx51.dtsi
> - fsl,imx27-pata is added as a const to ensure it is present always
> ""
> Aren't these lines enough for the said explanation?

This is changelog, not commit msg. I did not ask to explain differences
from pure conversion in changelog.

Best regards,
Krzysztof
Animesh Agarwal March 11, 2024, 11:11 a.m. UTC | #8
On Mon, Mar 11, 2024 at 11:56 AM Krzysztof Kozlowski
<krzysztof.kozlowski@linaro.org> wrote:
> This is changelog, not commit msg. I did not ask to explain differences
> from pure conversion in changelog.

Thank you for clarifying your expectations regarding the commit
message and changelog distinction. I apologize for the confusion.
I understand now that the information provided in the changelog
regarding the differences between versions does not suffice as a
replacement for a comprehensive explanation within the commit message
itself.

Moving forward, I will ensure that the commit messages contain
detailed explanations of the changes made during the pure conversion.

Thank you for your patience and continued guidance.

Best regards,
Animesh
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/ata/fsl,imx-pata.yaml b/Documentation/devicetree/bindings/ata/fsl,imx-pata.yaml
new file mode 100644
index 000000000000..85b18d26a834
--- /dev/null
+++ b/Documentation/devicetree/bindings/ata/fsl,imx-pata.yaml
@@ -0,0 +1,43 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/ata/fsl,imx-pata.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Freescale i.MX PATA Controller
+
+maintainers:
+  - Animesh Agarwal <animeshagarwal28@gmail.com>
+
+properties:
+  compatible:
+    oneOf:
+      - items:
+          - enum:
+              - fsl,imx31-pata
+              - fsl,imx51-pata
+          - const: fsl,imx27-pata
+      - items:
+          - const: fsl,imx27-pata
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    items:
+      - description: PATA Controller interrupts
+
+  clocks:
+    items:
+      - description: PATA Controller clocks
+
+additionalProperties: false
+
+examples:
+  - |
+    pata: pata@83fe0000 {
+        compatible = "fsl,imx51-pata","fsl,imx27-pata";
+        reg = <0x83fe0000 0x4000>;
+        interrupts = <70>;
+        clocks = <&clks 161>;
+    };
diff --git a/Documentation/devicetree/bindings/ata/imx-pata.txt b/Documentation/devicetree/bindings/ata/imx-pata.txt
deleted file mode 100644
index f1172f00188a..000000000000
--- a/Documentation/devicetree/bindings/ata/imx-pata.txt
+++ /dev/null
@@ -1,16 +0,0 @@ 
-* Freescale i.MX PATA Controller
-
-Required properties:
-- compatible: "fsl,imx27-pata"
-- reg: Address range of the PATA Controller
-- interrupts: The interrupt of the PATA Controller
-- clocks: the clocks for the PATA Controller
-
-Example:
-
-	pata: pata@83fe0000 {
-		compatible = "fsl,imx51-pata", "fsl,imx27-pata";
-		reg = <0x83fe0000 0x4000>;
-		interrupts = <70>;
-		clocks = <&clks 161>;
-	};