Unverified Commit 129a5d48 authored by Paul Cercueil's avatar Paul Cercueil Committed by Mark Brown
Browse files

ASoC: Convert jz4740-i2s doc to YAML 



Convert the textual binding documentation for the AIC (AC97/I2S
Controller) of Ingenic SoCs to a YAML schema, and add the new compatible
strings in the process.

Signed-off-by: default avatarPaul Cercueil <paul@crapouillou.net>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Link: https://lore.kernel.org/r/20200306222931.39664-1-paul@crapouillou.net


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

Documentation/devicetree/bindings/sound/ingenic,aic.yaml

0 → 100644
+92 −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/ingenic,aic.yaml#

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



title: Ingenic SoCs AC97 / I2S Controller (AIC) DT bindings



maintainers:

  - Paul Cercueil <paul@crapouillou.net>



properties:

  $nodename:

    pattern: '^audio-controller@'



  compatible:

    oneOf:

      - enum:

        - ingenic,jz4740-i2s

        - ingenic,jz4760-i2s

        - ingenic,jz4770-i2s

        - ingenic,jz4780-i2s

      - items:

        - const: ingenic,jz4725b-i2s

        - const: ingenic,jz4740-i2s



  '#sound-dai-cells':

    const: 0



  reg:

    maxItems: 1



  interrupts:

    maxItems: 1



  clocks:

    items:

      - description: AIC clock

      - description: I2S clock

      - description: EXT clock

      - description: PLL/2 clock



  clock-names:

    items:

      - const: aic

      - const: i2s

      - const: ext

      - const: pll half



  dmas:

    items:

      - description: DMA controller phandle and request line for I2S RX

      - description: DMA controller phandle and request line for I2S TX



  dma-names:

    items:

      - const: rx

      - const: tx



additionalProperties: false



required:

  - compatible

  - reg

  - interrupts

  - clocks

  - clock-names

  - dmas

  - dma-names

  - '#sound-dai-cells'



examples:

  - |

    #include <dt-bindings/clock/jz4740-cgu.h>

    aic: audio-controller@10020000 {

      compatible = "ingenic,jz4740-i2s";

      reg = <0x10020000 0x38>;



      #sound-dai-cells = <0>;



      interrupt-parent = <&intc>;

      interrupts = <18>;



      clocks = <&cgu JZ4740_CLK_AIC>,

               <&cgu JZ4740_CLK_I2S>,

               <&cgu JZ4740_CLK_EXT>,

               <&cgu JZ4740_CLK_PLL_HALF>;

      clock-names = "aic", "i2s", "ext", "pll half";



      dmas = <&dmac 25 0xffffffff>, <&dmac 24 0xffffffff>;

      dma-names = "rx", "tx";

    };

Documentation/devicetree/bindings/sound/ingenic,jz4740-i2s.txt

deleted100644 → 0
+0 −23
Original line number Diff line number Diff line 
Ingenic JZ4740 I2S controller



Required properties:

- compatible : "ingenic,jz4740-i2s" or "ingenic,jz4780-i2s"

- reg : I2S registers location and length

- clocks : AIC and I2S PLL clock specifiers.

- clock-names: "aic" and "i2s"

- dmas: DMA controller phandle and DMA request line for I2S Tx and Rx channels

- dma-names: Must be "tx" and "rx"



Example:



i2s: i2s@10020000 {

	compatible = "ingenic,jz4740-i2s";

	reg = <0x10020000 0x94>;



	clocks = <&cgu JZ4740_CLK_AIC>, <&cgu JZ4740_CLK_I2SPLL>;

	clock-names = "aic", "i2s";



	dmas = <&dma 2>, <&dma 3>;

	dma-names = "tx", "rx";



};