Unverified Commit f4ee8a88 authored by Chaitanya Sabnis's avatar Chaitanya Sabnis Committed by Mark Brown
Browse files

ASoC: dt-bindings: hisilicon: Convert hi6210 I2S to dt-schema



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: default avatarChaitanya Sabnis <chaitanya.msabnis@gmail.com>
Reviewed-by: default avatarRob Herring (Arm) <robh@kernel.org>
Link: https://patch.msgid.link/20260327092106.4233-1-chaitanya.msabnis@gmail.com


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent 9a52d1b7
Loading
Loading
Loading
Loading
+0 −42
Original line number Diff line number Diff line
* 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 */
+80 −0
Original line number Diff line number Diff line
# 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>;
    };