diff mbox series

dt-bindings: mmc: ti-omap: convert text based binding to json schema

Message ID 20250510-ti-omap-v1-1-588b0ccb1823@gmail.com
State New
Headers show
Series dt-bindings: mmc: ti-omap: convert text based binding to json schema | expand

Commit Message

Charan Pedumuru May 10, 2025, 4:37 p.m. UTC
Convert TI MMC host controller binding to YAML format. It's a
straight-forward conversion of the typical mmc host controller.

Signed-off-by: Charan Pedumuru <charan.pedumuru@gmail.com>
---
 Documentation/devicetree/bindings/mmc/ti-omap.txt  | 26 ---------
 Documentation/devicetree/bindings/mmc/ti-omap.yaml | 61 ++++++++++++++++++++++
 2 files changed, 61 insertions(+), 26 deletions(-)


---
base-commit: 3e039dcc9c1320c0d33ddd51c372dcc91d3ea3c7
change-id: 20250502-ti-omap-12655fa9db3e

Best regards,

Comments

Krzysztof Kozlowski May 11, 2025, 8:18 p.m. UTC | #1
On 10/05/2025 19:20, Charan Pedumuru wrote:
> 
> 
> On 10-05-2025 22:07, Charan Pedumuru wrote:
>> Convert TI MMC host controller binding to YAML format. It's a
>> straight-forward conversion of the typical mmc host controller.


Not really - you added properties.


>>
>> Signed-off-by: Charan Pedumuru <charan.pedumuru@gmail.com>
>> ---
>>  Documentation/devicetree/bindings/mmc/ti-omap.txt  | 26 ---------
>>  Documentation/devicetree/bindings/mmc/ti-omap.yaml | 61 ++++++++++++++++++++++
>>  2 files changed, 61 insertions(+), 26 deletions(-)
>>
>> diff --git a/Documentation/devicetree/bindings/mmc/ti-omap.txt b/Documentation/devicetree/bindings/mmc/ti-omap.txt
>> deleted file mode 100644
>> index 02fd31cf361d6ed893ec2f9eb8368b358ab2bae1..0000000000000000000000000000000000000000
>> --- a/Documentation/devicetree/bindings/mmc/ti-omap.txt
>> +++ /dev/null
>> @@ -1,26 +0,0 @@
>> -* TI MMC host controller for OMAP1 and 2420
>> -

...

>> -	};
>> diff --git a/Documentation/devicetree/bindings/mmc/ti-omap.yaml b/Documentation/devicetree/bindings/mmc/ti-omap.yaml


Filename based on the compatible. Didn't you get exactly such feedback
already?

>> new file mode 100644
>> index 0000000000000000000000000000000000000000..3660f54550e0ee46d3a7cfa3f531d95802f1e2fb
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/mmc/ti-omap.yaml
>> @@ -0,0 +1,61 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/mmc/ti-omap.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: TI MMC host controller for OMAP1 and 2420
>> +
>> +description:
>> +  The MMC Host controller for TI OMAP1 and 2420 family provides
>> +  an interface for MMC, SD and SDIO types of memory cards.
>> +
>> +allOf:
>> +  - $ref: mmc-controller.yaml
>> +
>> +maintainers:
>> +  - Ulf Hansson <ulf.hansson@linaro.org>


No, this is supposed someone responsible for the device, not subsystem
maintainer.

>> +
>> +properties:
>> +  compatible:
>> +    const: ti,omap2420-mmc
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +  interrupts:
>> +    maxItems: 1
>> +
>> +  dmas:
>> +    maxItems: 2
>> +
>> +  dma-names:
>> +    items:
>> +      - const: tx
>> +      - const: rx
>> +
>> +  ti,hwmods:
>> +    items:
>> +      pattern: "^msdi[0-9]+$"

Missing type: string-array
min/maxItems?

>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +  - interrupts
>> +  - dmas
>> +  - dma-names

That's a change - binding did not mention it, did not make it required.
Every change should be explain in commit msg.

>> +  - ti,hwmods
>> +
>> +unevaluatedProperties: false
>> +
>> +examples:
>> +  - |
>> +    mmc@4809c000 {
>> +        compatible = "ti,omap2420-mmc";
>> +        ti,hwmods = "msdi1";
>> +        reg = <0x4809c000 0x80>;
>> +        interrupts = <83>;
> 
> Forgot to include irq interrupt-controller header and use it for the interrupts, will change in next revision.

Header does not look like used...

> 
> 
>> +        dmas = <&sdma 61 &sdma 62>;

But here you need two <> phandles.

>> +        dma-names = "tx", "rx";
>> +    };
>> +...
>>
>> ---
>> base-commit: 3e039dcc9c1320c0d33ddd51c372dcc91d3ea3c7
>> change-id: 20250502-ti-omap-12655fa9db3e
>>
>> Best regards,
> 


Best regards,
Krzysztof
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/mmc/ti-omap.txt b/Documentation/devicetree/bindings/mmc/ti-omap.txt
deleted file mode 100644
index 02fd31cf361d6ed893ec2f9eb8368b358ab2bae1..0000000000000000000000000000000000000000
--- a/Documentation/devicetree/bindings/mmc/ti-omap.txt
+++ /dev/null
@@ -1,26 +0,0 @@ 
-* TI MMC host controller for OMAP1 and 2420
-
-The MMC Host Controller on TI OMAP1 and 2420 family provides
-an interface for MMC, SD, and SDIO types of memory cards.
-
-This file documents differences between the core properties described
-by mmc.txt and the properties used by the omap mmc driver.
-
-Note that this driver will not work with omap2430 or later omaps,
-please see the omap hsmmc driver for the current omaps.
-
-Required properties:
-- compatible: Must be "ti,omap2420-mmc", for OMAP2420 controllers
-- ti,hwmods: For 2420, must be "msdi<n>", where n is controller
-  instance starting 1
-
-Examples:
-
-	msdi1: mmc@4809c000 {
-		compatible = "ti,omap2420-mmc";
-		ti,hwmods = "msdi1";
-		reg = <0x4809c000 0x80>;
-		interrupts = <83>;
-		dmas = <&sdma 61 &sdma 62>;
-		dma-names = "tx", "rx";
-	};
diff --git a/Documentation/devicetree/bindings/mmc/ti-omap.yaml b/Documentation/devicetree/bindings/mmc/ti-omap.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..3660f54550e0ee46d3a7cfa3f531d95802f1e2fb
--- /dev/null
+++ b/Documentation/devicetree/bindings/mmc/ti-omap.yaml
@@ -0,0 +1,61 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/mmc/ti-omap.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: TI MMC host controller for OMAP1 and 2420
+
+description:
+  The MMC Host controller for TI OMAP1 and 2420 family provides
+  an interface for MMC, SD and SDIO types of memory cards.
+
+allOf:
+  - $ref: mmc-controller.yaml
+
+maintainers:
+  - Ulf Hansson <ulf.hansson@linaro.org>
+
+properties:
+  compatible:
+    const: ti,omap2420-mmc
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  dmas:
+    maxItems: 2
+
+  dma-names:
+    items:
+      - const: tx
+      - const: rx
+
+  ti,hwmods:
+    items:
+      pattern: "^msdi[0-9]+$"
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - dmas
+  - dma-names
+  - ti,hwmods
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    mmc@4809c000 {
+        compatible = "ti,omap2420-mmc";
+        ti,hwmods = "msdi1";
+        reg = <0x4809c000 0x80>;
+        interrupts = <83>;
+        dmas = <&sdma 61 &sdma 62>;
+        dma-names = "tx", "rx";
+    };
+...