[PATCH v3] ASoC: dt-bindings: hisilicon: Convert hi6210 I2S to dt-schema

[PATCH v3] ASoC: dt-bindings: hisilicon: Convert hi6210 I2S to dt-schema

[Chaitanya Sabnis]

Convert the Hisilicon hi6210 I2S controller hardware binding from
legacy plain text to modern YAML dt-schema format.

During the conversion, the order of the dma-names properties in the
example was corrected to "tx", "rx" to match the official property
description, resolving a contradiction in the original text binding.

Signed-off-by: Chaitanya Sabnis  <chaitanya.msabnis@gmail.com>
---
 .../bindings/sound/hisilicon,hi6210-i2s.txt   | 42 ----------
 .../bindings/sound/hisilicon,hi6210-i2s.yaml  | 80 +++++++++++++++++++
 2 files changed, 80 insertions(+), 42 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/sound/hisilicon,hi6210-i2s.txt
 create mode 100644 Documentation/devicetree/bindings/sound/hisilicon,hi6210-i2s.yaml

diff --git a/Documentation/devicetree/bindings/sound/hisilicon,hi6210-i2s.txt b/Documentation/devicetree/bindings/sound/hisilicon,hi6210-i2s.txt
deleted file mode 100644
index 7a296784eb37..000000000000
--- a/Documentation/devicetree/bindings/sound/hisilicon,hi6210-i2s.txt
+++ /dev/null
@@ -1,42 +0,0 @@
-* Hisilicon 6210 i2s controller
-
-Required properties:
-
-- compatible: should be one of the following:
-   - "hisilicon,hi6210-i2s"
-- reg: physical base address of the i2s controller unit and length of
-   memory mapped region.
-- interrupts: should contain the i2s interrupt.
-- clocks: a list of phandle + clock-specifier pairs, one for each entry
-  in clock-names.
-- clock-names: should contain following:
-   - "dacodec"
-   - "i2s-base"
-- dmas: DMA specifiers for tx dma. See the DMA client binding,
-  Documentation/devicetree/bindings/dma/dma.txt
-- dma-names: should be "tx" and "rx"
-- hisilicon,sysctrl-syscon: phandle to sysctrl syscon
-- #sound-dai-cells: Should be set to 1 (for multi-dai)
-   - The dai cell indexes reference the following interfaces:
-       0: S2 interface
-       (Currently that is the only one available, but more may be
-        supported in the future)
-
-Example for the hi6210 i2s controller:
-
-i2s0: i2s@f7118000{
-	compatible = "hisilicon,hi6210-i2s";
-	reg = <0x0 0xf7118000 0x0 0x8000>; /* i2s unit */
-	interrupts = <GIC_SPI 123 IRQ_TYPE_LEVEL_HIGH>; /* 155 "DigACodec_intr"-32 */
-	clocks = <&sys_ctrl HI6220_DACODEC_PCLK>,
-		 <&sys_ctrl HI6220_BBPPLL0_DIV>;
-	clock-names = "dacodec", "i2s-base";
-	dmas = <&dma0 15 &dma0 14>;
-	dma-names = "rx", "tx";
-	hisilicon,sysctrl-syscon = <&sys_ctrl>;
-	#sound-dai-cells = <1>;
-};
-
-Then when referencing the i2s controller:
-	sound-dai = <&i2s0 0>; /* index 0 => S2 interface */
-
diff --git a/Documentation/devicetree/bindings/sound/hisilicon,hi6210-i2s.yaml b/Documentation/devicetree/bindings/sound/hisilicon,hi6210-i2s.yaml
new file mode 100644
index 000000000000..5171f984630b
--- /dev/null
+++ b/Documentation/devicetree/bindings/sound/hisilicon,hi6210-i2s.yaml
@@ -0,0 +1,80 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/sound/hisilicon,hi6210-i2s.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: HiSilicon hi6210 I2S controller
+
+maintainers:
+  - John Stultz <john.stultz@linaro.org>
+
+allOf:
+  - $ref: dai-common.yaml#
+
+properties:
+  compatible:
+    const: hisilicon,hi6210-i2s
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    maxItems: 2
+
+  clock-names:
+    items:
+      - const: dacodec
+      - const: i2s-base
+
+  dmas:
+    maxItems: 2
+
+  dma-names:
+    items:
+      - const: tx
+      - const: rx
+
+  hisilicon,sysctrl-syscon:
+    $ref: /schemas/types.yaml#/definitions/phandle
+    description: phandle to sysctrl syscon
+
+  "#sound-dai-cells":
+    const: 1
+    description: |
+      The dai cell indexes reference the following interfaces:
+        0: S2 interface
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+  - clock-names
+  - dmas
+  - dma-names
+  - hisilicon,sysctrl-syscon
+  - "#sound-dai-cells"
+
+unevaluatedProperties: false
+
+examples:
+  - |
+    #include <dt-bindings/interrupt-controller/arm-gic.h>
+    #include <dt-bindings/clock/hi6220-clock.h>
+
+    i2s@f7118000 {
+        compatible = "hisilicon,hi6210-i2s";
+        reg = <0xf7118000 0x8000>;
+        interrupts = <GIC_SPI 123 IRQ_TYPE_LEVEL_HIGH>;
+        clocks = <&sys_ctrl HI6220_DACODEC_PCLK>,
+                 <&sys_ctrl HI6220_BBPPLL0_DIV>;
+        clock-names = "dacodec", "i2s-base";
+        dmas = <&dma0 14>, <&dma0 15>;
+        dma-names = "tx", "rx";
+        hisilicon,sysctrl-syscon = <&sys_ctrl>;
+        #sound-dai-cells = <1>;
+    };
-- 
2.43.0

Re: [PATCH v3] ASoC: dt-bindings: hisilicon: Convert hi6210 I2S to dt-schema

[Rob Herring]

On Fri, Mar 27, 2026 at 02:51:06PM +0530, Chaitanya Sabnis wrote:
> Convert the Hisilicon hi6210 I2S controller hardware binding from
> legacy plain text to modern YAML dt-schema format.
> 
> During the conversion, the order of the dma-names properties in the
> example was corrected to "tx", "rx" to match the official property
> description, resolving a contradiction in the original text binding.
> 
> Signed-off-by: Chaitanya Sabnis  <chaitanya.msabnis@gmail.com>
> ---
>  .../bindings/sound/hisilicon,hi6210-i2s.txt   | 42 ----------
>  .../bindings/sound/hisilicon,hi6210-i2s.yaml  | 80 +++++++++++++++++++
>  2 files changed, 80 insertions(+), 42 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/sound/hisilicon,hi6210-i2s.txt
>  create mode 100644 Documentation/devicetree/bindings/sound/hisilicon,hi6210-i2s.yaml
> 
> diff --git a/Documentation/devicetree/bindings/sound/hisilicon,hi6210-i2s.txt b/Documentation/devicetree/bindings/sound/hisilicon,hi6210-i2s.txt
> deleted file mode 100644
> index 7a296784eb37..000000000000
> --- a/Documentation/devicetree/bindings/sound/hisilicon,hi6210-i2s.txt
> +++ /dev/null
> @@ -1,42 +0,0 @@
> -* Hisilicon 6210 i2s controller
> -
> -Required properties:
> -
> -- compatible: should be one of the following:
> -   - "hisilicon,hi6210-i2s"
> -- reg: physical base address of the i2s controller unit and length of
> -   memory mapped region.
> -- interrupts: should contain the i2s interrupt.
> -- clocks: a list of phandle + clock-specifier pairs, one for each entry
> -  in clock-names.
> -- clock-names: should contain following:
> -   - "dacodec"
> -   - "i2s-base"
> -- dmas: DMA specifiers for tx dma. See the DMA client binding,
> -  Documentation/devicetree/bindings/dma/dma.txt
> -- dma-names: should be "tx" and "rx"
> -- hisilicon,sysctrl-syscon: phandle to sysctrl syscon
> -- #sound-dai-cells: Should be set to 1 (for multi-dai)
> -   - The dai cell indexes reference the following interfaces:
> -       0: S2 interface
> -       (Currently that is the only one available, but more may be
> -        supported in the future)
> -
> -Example for the hi6210 i2s controller:
> -
> -i2s0: i2s@f7118000{
> -	compatible = "hisilicon,hi6210-i2s";
> -	reg = <0x0 0xf7118000 0x0 0x8000>; /* i2s unit */
> -	interrupts = <GIC_SPI 123 IRQ_TYPE_LEVEL_HIGH>; /* 155 "DigACodec_intr"-32 */
> -	clocks = <&sys_ctrl HI6220_DACODEC_PCLK>,
> -		 <&sys_ctrl HI6220_BBPPLL0_DIV>;
> -	clock-names = "dacodec", "i2s-base";
> -	dmas = <&dma0 15 &dma0 14>;
> -	dma-names = "rx", "tx";
> -	hisilicon,sysctrl-syscon = <&sys_ctrl>;
> -	#sound-dai-cells = <1>;
> -};
> -
> -Then when referencing the i2s controller:
> -	sound-dai = <&i2s0 0>; /* index 0 => S2 interface */
> -
> diff --git a/Documentation/devicetree/bindings/sound/hisilicon,hi6210-i2s.yaml b/Documentation/devicetree/bindings/sound/hisilicon,hi6210-i2s.yaml
> new file mode 100644
> index 000000000000..5171f984630b
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/hisilicon,hi6210-i2s.yaml
> @@ -0,0 +1,80 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/hisilicon,hi6210-i2s.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: HiSilicon hi6210 I2S controller
> +
> +maintainers:
> +  - John Stultz <john.stultz@linaro.org>

That email hasn't worked for years. I would suggest putting the 
HiSilicon maintainer down for anything HiSilicon related.

With that,

Reviewed-by: Rob Herring (Arm) <robh@kernel.org>