diff mbox series

[v3] dt-bindings: i2c: i2c-wmt: Convert to YAML

Message ID 20250506-vt8500-i2c-binding-v3-1-401c3e090a88@gmail.com
State New
Headers show
Series [v3] dt-bindings: i2c: i2c-wmt: Convert to YAML | expand

Commit Message

Alexey Charkov May 6, 2025, 10:38 a.m. UTC 
Rewrite the textual description for the WonderMedia I2C controller
as YAML schema, and switch the filename to follow the compatible
string.

The controller only supports two bus speeds (100kHz and 400kHz)
so restrict clock-frequency values accordingly.

Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Signed-off-by: Alexey Charkov <alchark@gmail.com>
---
Changes in v3:
- Re-added the part updating MAINTAINERS by Andi's request
- Link to v2: https://lore.kernel.org/r/20250430-vt8500-i2c-binding-v2-1-0cf22d0c2d42@gmail.com

Changes in v2:
- Added Krzysztof's review tag (thanks Krzysztof)
- Dropped the update to MAINTAINERS for now to reduce merge conflicts
  across different trees
- Split out the i2c binding separately from the big series affecting
  multiple subsystems unnecessarily (thanks Rob)
- Link to v1: https://lore.kernel.org/all/20250416-wmt-updates-v1-1-f9af689cdfc2@gmail.com/
---
 Documentation/devicetree/bindings/i2c/i2c-wmt.txt  | 24 -----------
 .../devicetree/bindings/i2c/wm,wm8505-i2c.yaml     | 47 ++++++++++++++++++++++
 MAINTAINERS                                        |  2 +-
 3 files changed, 48 insertions(+), 25 deletions(-)


---
base-commit: 0a00723f4c2d0b273edd0737f236f103164a08eb
change-id: 20250430-vt8500-i2c-binding-5b397b570387

Best regards,

Comments

Andi Shyti May 8, 2025, 10:31 a.m. UTC | #1 
Hi Alexey,

> index 16037aaa770fc35efb45fc26555afaa5102e2640..4d18afdaf12bf6a5956793814f8db39b34074a12 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -3464,7 +3464,7 @@ M:	Krzysztof Kozlowski <krzk@kernel.org>
>  L:	linux-arm-kernel@lists.infradead.org (moderated for non-subscribers)
>  S:	Odd Fixes
>  F:	Documentation/devicetree/bindings/hwinfo/via,vt8500-scc-id.yaml
> -F:	Documentation/devicetree/bindings/i2c/i2c-wmt.txt
> +F:	Documentation/devicetree/bindings/i2c/wm,wm8505-i2c.yaml

this has caused some conflict. You are based on -next but i2c
hasn't received some of these changes, yet.

Anyway, I fixed the conflict and merged to i2c/i2c-host. Let's
see how it goes, but I believe we will receive some complaints in
the next days.

Andi
Andi Shyti May 8, 2025, 12:42 p.m. UTC | #2 
On Thu, May 08, 2025 at 12:33:21PM +0200, Krzysztof Kozlowski wrote:
> On 08/05/2025 12:31, Andi Shyti wrote:
> >> index 16037aaa770fc35efb45fc26555afaa5102e2640..4d18afdaf12bf6a5956793814f8db39b34074a12 100644
> >> --- a/MAINTAINERS
> >> +++ b/MAINTAINERS
> >> @@ -3464,7 +3464,7 @@ M:	Krzysztof Kozlowski <krzk@kernel.org>
> >>  L:	linux-arm-kernel@lists.infradead.org (moderated for non-subscribers)
> >>  S:	Odd Fixes
> >>  F:	Documentation/devicetree/bindings/hwinfo/via,vt8500-scc-id.yaml
> >> -F:	Documentation/devicetree/bindings/i2c/i2c-wmt.txt
> >> +F:	Documentation/devicetree/bindings/i2c/wm,wm8505-i2c.yaml
> > 
> > this has caused some conflict. You are based on -next but i2c
> > hasn't received some of these changes, yet.
> > 
> > Anyway, I fixed the conflict and merged to i2c/i2c-host. Let's
> > see how it goes, but I believe we will receive some complaints in
> > the next days.
> Yes, few trees will have similar conflicts here. Expect them also when
> you send your pull to Linus. Conflicts should be trivial, though.

Thanks for confirming this, Krzysztof!

Andi
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/i2c/i2c-wmt.txt b/Documentation/devicetree/bindings/i2c/i2c-wmt.txt
deleted file mode 100644
index 94a425eaa6c78bc9e3136ae7055b51635baf16ca..0000000000000000000000000000000000000000
--- a/Documentation/devicetree/bindings/i2c/i2c-wmt.txt
+++ /dev/null
@@ -1,24 +0,0 @@ 
-* Wondermedia I2C Controller
-
-Required properties :
-
- - compatible : should be "wm,wm8505-i2c"
- - reg : Offset and length of the register set for the device
- - interrupts : <IRQ> where IRQ is the interrupt number
- - clocks : phandle to the I2C clock source
-
-Optional properties :
-
- - clock-frequency : desired I2C bus clock frequency in Hz.
-	Valid values are 100000 and 400000.
-	Default to 100000 if not specified, or invalid value.
-
-Example :
-
-	i2c_0: i2c@d8280000 {
-		compatible = "wm,wm8505-i2c";
-		reg = <0xd8280000 0x1000>;
-		interrupts = <19>;
-		clocks = <&clki2c0>;
-		clock-frequency = <400000>;
-	};
diff --git a/Documentation/devicetree/bindings/i2c/wm,wm8505-i2c.yaml b/Documentation/devicetree/bindings/i2c/wm,wm8505-i2c.yaml
new file mode 100644
index 0000000000000000000000000000000000000000..e498ce47b885203fcfe233b946f987abdac6784a
--- /dev/null
+++ b/Documentation/devicetree/bindings/i2c/wm,wm8505-i2c.yaml
@@ -0,0 +1,47 @@ 
+# SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/i2c/wm,wm8505-i2c.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: I2C Controller on WonderMedia WM8505 and related SoCs
+
+maintainers:
+  - Alexey Charkov <alchark@gmail.com>
+
+allOf:
+  - $ref: /schemas/i2c/i2c-controller.yaml#
+
+properties:
+  compatible:
+    const: wm,wm8505-i2c
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    maxItems: 1
+
+  clock-frequency:
+    enum: [100000, 400000]
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    i2c_0: i2c@d8280000 {
+        compatible = "wm,wm8505-i2c";
+        reg = <0xd8280000 0x1000>;
+        interrupts = <19>;
+        clocks = <&clki2c0>;
+        clock-frequency = <400000>;
+    };
diff --git a/MAINTAINERS b/MAINTAINERS
index 16037aaa770fc35efb45fc26555afaa5102e2640..4d18afdaf12bf6a5956793814f8db39b34074a12 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -3464,7 +3464,7 @@  M:	Krzysztof Kozlowski <krzk@kernel.org>
 L:	linux-arm-kernel@lists.infradead.org (moderated for non-subscribers)
 S:	Odd Fixes
 F:	Documentation/devicetree/bindings/hwinfo/via,vt8500-scc-id.yaml
-F:	Documentation/devicetree/bindings/i2c/i2c-wmt.txt
+F:	Documentation/devicetree/bindings/i2c/wm,wm8505-i2c.yaml
 F:	Documentation/devicetree/bindings/interrupt-controller/via,vt8500-intc.yaml
 F:	Documentation/devicetree/bindings/pwm/via,vt8500-pwm.yaml
 F:	arch/arm/boot/dts/vt8500/