Unverified Commit a206376b authored by Vincenzo Frascino's avatar Vincenzo Frascino Committed by Mark Brown
Browse files

ASoC: dt-bindings: xlnx,i2s: Convert to json-schema 



Convert the Xilinx I2S device tree binding documentation to json-schema.

Reviewed-by: default avatarRob Herring (Arm) <robh@kernel.org>
Signed-off-by: default avatarVincenzo Frascino <vincenzo.frascino@arm.com>
Link: https://patch.msgid.link/20250226122325.2014547-2-vincenzo.frascino@arm.com


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent dc64e1b9

Documentation/devicetree/bindings/sound/xlnx,i2s.txt

deleted100644 → 0
+0 −28
Original line number Diff line number Diff line 
Device-Tree bindings for Xilinx I2S PL block



The IP supports I2S based playback/capture audio



Required property:

 - compatible: "xlnx,i2s-transmitter-1.0" for playback and

	       "xlnx,i2s-receiver-1.0" for capture



Required property common to both I2S playback and capture:

 - reg: Base address and size of the IP core instance.

 - xlnx,dwidth: sample data width. Can be any of 16, 24.

 - xlnx,num-channels: Number of I2S streams. Can be any of 1, 2, 3, 4.

		      supported channels = 2 * xlnx,num-channels



Example:



	i2s_receiver@a0080000 {

		compatible = "xlnx,i2s-receiver-1.0";

		reg = <0x0 0xa0080000 0x0 0x10000>;

		xlnx,dwidth = <0x18>;

		xlnx,num-channels = <1>;

	};

	i2s_transmitter@a0090000 {

		compatible = "xlnx,i2s-transmitter-1.0";

		reg = <0x0 0xa0090000 0x0 0x10000>;

		xlnx,dwidth = <0x18>;

		xlnx,num-channels = <1>;

	};

Documentation/devicetree/bindings/sound/xlnx,i2s.yaml

0 → 100644
+65 −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/xlnx,i2s.yaml#

$schema: http://devicetree.org/meta-schemas/core.yaml#



title: Xilinx I2S PL block



description:

  The IP supports I2S based playback/capture audio.



maintainers:

  - Vincenzo Frascino <vincenzo.frascino@arm.com>



allOf:

  - $ref: dai-common.yaml#



properties:

  compatible:

    enum:

      - xlnx,i2s-receiver-1.0

      - xlnx,i2s-transmitter-1.0



  reg:

    maxItems: 1



  xlnx,dwidth:

    $ref: /schemas/types.yaml#/definitions/uint32

    enum:

      - 16

      - 24

    description: |

      Sample data width.



  xlnx,num-channels:

    $ref: /schemas/types.yaml#/definitions/uint32

    minimum: 1

    maximum: 4

    description: |

      Number of I2S streams.



required:

  - compatible

  - reg

  - xlnx,dwidth

  - xlnx,num-channels



additionalProperties: false



examples:

  - |

    i2s@a0080000 {

      compatible = "xlnx,i2s-receiver-1.0";

      reg = <0xa0080000 0x10000>;

      xlnx,dwidth = <0x18>;

      xlnx,num-channels = <1>;

    };

    i2s@a0090000 {

      compatible = "xlnx,i2s-transmitter-1.0";

      reg = <0xa0090000 0x10000>;

      xlnx,dwidth = <0x18>;

      xlnx,num-channels = <1>;

    };



...