Re: [PATCH v2 2/2] ASoC: dt-bindings: renesas,rsnd: switch to yaml base Documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Thu, Aug 27, 2020 at 09:25:12AM +0900, Kuninori Morimoto wrote:
> From: Kuninori Morimoto <kuninori.morimoto.gx@xxxxxxxxxxx>
> 
> This patch switches from .txt base to .yaml base Document.
> It is still keeping detail explanations at .txt
> 
> Signed-off-by: Kuninori Morimoto <kuninori.morimoto.gx@xxxxxxxxxxx>
> ---
>  .../bindings/sound/renesas,rsnd.txt           | 520 ------------------
>  .../bindings/sound/renesas,rsnd.yaml          | 454 +++++++++++++++
>  2 files changed, 454 insertions(+), 520 deletions(-)
>  create mode 100644 Documentation/devicetree/bindings/sound/renesas,rsnd.yaml
> 
> diff --git a/Documentation/devicetree/bindings/sound/renesas,rsnd.txt b/Documentation/devicetree/bindings/sound/renesas,rsnd.txt
> index b39743d3f7c4..b731f16aea84 100644
> --- a/Documentation/devicetree/bindings/sound/renesas,rsnd.txt
> +++ b/Documentation/devicetree/bindings/sound/renesas,rsnd.txt
> @@ -253,523 +253,3 @@ This is example of TDM 6ch.
>  Driver can automatically switches TDM <-> stereo mode in this case.
>  
>  see "Example: simple sound card for TDM"
> -
> -=============================================
> -Required properties:
> -=============================================
> -
> -- compatible			: "renesas,rcar_sound-<soctype>", fallbacks
> -				  "renesas,rcar_sound-gen1" if generation1, and
> -				  "renesas,rcar_sound-gen2" if generation2 (or RZ/G1)
> -				  "renesas,rcar_sound-gen3" if generation3 (or RZ/G2)
> -				  Examples with soctypes are:
> -				    - "renesas,rcar_sound-r8a7742" (RZ/G1H)
> -				    - "renesas,rcar_sound-r8a7743" (RZ/G1M)
> -				    - "renesas,rcar_sound-r8a7744" (RZ/G1N)
> -				    - "renesas,rcar_sound-r8a7745" (RZ/G1E)
> -				    - "renesas,rcar_sound-r8a77470" (RZ/G1C)
> -				    - "renesas,rcar_sound-r8a774a1" (RZ/G2M)
> -				    - "renesas,rcar_sound-r8a774b1" (RZ/G2N)
> -				    - "renesas,rcar_sound-r8a774c0" (RZ/G2E)
> -				    - "renesas,rcar_sound-r8a774e1" (RZ/G2H)
> -				    - "renesas,rcar_sound-r8a7778" (R-Car M1A)
> -				    - "renesas,rcar_sound-r8a7779" (R-Car H1)
> -				    - "renesas,rcar_sound-r8a7790" (R-Car H2)
> -				    - "renesas,rcar_sound-r8a7791" (R-Car M2-W)
> -				    - "renesas,rcar_sound-r8a7793" (R-Car M2-N)
> -				    - "renesas,rcar_sound-r8a7794" (R-Car E2)
> -				    - "renesas,rcar_sound-r8a7795" (R-Car H3)
> -				    - "renesas,rcar_sound-r8a7796" (R-Car M3-W)
> -				    - "renesas,rcar_sound-r8a77965" (R-Car M3-N)
> -				    - "renesas,rcar_sound-r8a77990" (R-Car E3)
> -				    - "renesas,rcar_sound-r8a77995" (R-Car D3)
> -- reg				: Should contain the register physical address.
> -				  required register is
> -				   SRU/ADG/SSI      if generation1
> -				   SRU/ADG/SSIU/SSI/AUDIO-DMAC-periperi if generation2/generation3
> -				   Select extended AUDIO-DMAC-periperi address if SoC has it,
> -				   otherwise select normal AUDIO-DMAC-periperi address.
> -- reg-names			: Should contain the register names.
> -				   scu/adg/ssi	if generation1
> -				   scu/adg/ssiu/ssi/audmapp if generation2/generation3
> -- rcar_sound,ssi		: Should contain SSI feature.
> -				  The number of SSI subnode should be same as HW.
> -				  see below for detail.
> -- rcar_sound,ssiu		: Should contain SSIU feature.
> -				  The number of SSIU subnode should be same as HW.
> -				  see below for detail.
> -- rcar_sound,src		: Should contain SRC feature.
> -				  The number of SRC subnode should be same as HW.
> -				  see below for detail.
> -- rcar_sound,ctu		: Should contain CTU feature.
> -				  The number of CTU subnode should be same as HW.
> -				  see below for detail.
> -- rcar_sound,mix		: Should contain MIX feature.
> -				  The number of MIX subnode should be same as HW.
> -				  see below for detail.
> -- rcar_sound,dvc		: Should contain DVC feature.
> -				  The number of DVC subnode should be same as HW.
> -				  see below for detail.
> -- rcar_sound,dai		: DAI contents.
> -				  The number of DAI subnode should be same as HW.
> -				  see below for detail.
> -- #sound-dai-cells		: it must be 0 if your system is using single DAI
> -				  it must be 1 if your system is using multi  DAI
> -- clocks			: References to SSI/SRC/MIX/CTU/DVC/AUDIO_CLK clocks.
> -- clock-names			: List of necessary clock names.
> -				  "ssi-all", "ssi.X", "src.X", "mix.X", "ctu.X",
> -				  "dvc.X", "clk_a", "clk_b", "clk_c", "clk_i"
> -
> -Optional properties:
> -- #clock-cells			: it must be 0 if your system has audio_clkout
> -				  it must be 1 if your system has audio_clkout0/1/2/3
> -- clock-frequency		: for all audio_clkout0/1/2/3
> -- clkout-lr-asynchronous	: boolean property. it indicates that audio_clkoutn
> -				  is asynchronizes with lr-clock.
> -- resets			: References to SSI resets.
> -- reset-names			: List of valid reset names.
> -				  "ssi-all", "ssi.X"
> -
> -SSI subnode properties:
> -- interrupts			: Should contain SSI interrupt for PIO transfer
> -- shared-pin			: if shared clock pin
> -- pio-transfer			: use PIO transfer mode
> -- no-busif			: BUSIF is not ussed when [mem -> SSI] via DMA case
> -- dma				: Should contain Audio DMAC entry
> -- dma-names			: SSI  case "rx"  (=playback), "tx"  (=capture)
> -				  Deprecated: see SSIU subnode properties
> -				  SSIU case "rxu" (=playback), "txu" (=capture)
> -
> -SSIU subnode properties:
> -- dma				: Should contain Audio DMAC entry
> -- dma-names			: "rx" (=playback), "tx" (=capture)
> -
> -SRC subnode properties:
> -- dma				: Should contain Audio DMAC entry
> -- dma-names			: "rx" (=playback), "tx" (=capture)
> -
> -DVC subnode properties:
> -- dma				: Should contain Audio DMAC entry
> -- dma-names			: "tx" (=playback/capture)
> -
> -DAI subnode properties:
> -- playback			: list of playback modules
> -- capture			: list of capture  modules
> -
> -
> -=============================================
> -Example:
> -=============================================
> -
> -rcar_sound: sound@ec500000 {
> -	#sound-dai-cells = <1>;
> -	compatible = "renesas,rcar_sound-r8a7791", "renesas,rcar_sound-gen2";
> -	reg =	<0 0xec500000 0 0x1000>, /* SCU */
> -		<0 0xec5a0000 0 0x100>,  /* ADG */
> -		<0 0xec540000 0 0x1000>, /* SSIU */
> -		<0 0xec541000 0 0x1280>, /* SSI */
> -		<0 0xec740000 0 0x200>;  /* Audio DMAC peri peri*/
> -	reg-names = "scu", "adg", "ssiu", "ssi", "audmapp";
> -
> -	clocks = <&mstp10_clks R8A7790_CLK_SSI_ALL>,
> -		<&mstp10_clks R8A7790_CLK_SSI9>, <&mstp10_clks R8A7790_CLK_SSI8>,
> -		<&mstp10_clks R8A7790_CLK_SSI7>, <&mstp10_clks R8A7790_CLK_SSI6>,
> -		<&mstp10_clks R8A7790_CLK_SSI5>, <&mstp10_clks R8A7790_CLK_SSI4>,
> -		<&mstp10_clks R8A7790_CLK_SSI3>, <&mstp10_clks R8A7790_CLK_SSI2>,
> -		<&mstp10_clks R8A7790_CLK_SSI1>, <&mstp10_clks R8A7790_CLK_SSI0>,
> -		<&mstp10_clks R8A7790_CLK_SCU_SRC9>, <&mstp10_clks R8A7790_CLK_SCU_SRC8>,
> -		<&mstp10_clks R8A7790_CLK_SCU_SRC7>, <&mstp10_clks R8A7790_CLK_SCU_SRC6>,
> -		<&mstp10_clks R8A7790_CLK_SCU_SRC5>, <&mstp10_clks R8A7790_CLK_SCU_SRC4>,
> -		<&mstp10_clks R8A7790_CLK_SCU_SRC3>, <&mstp10_clks R8A7790_CLK_SCU_SRC2>,
> -		<&mstp10_clks R8A7790_CLK_SCU_SRC1>, <&mstp10_clks R8A7790_CLK_SCU_SRC0>,
> -		<&mstp10_clks R8A7790_CLK_SCU_DVC0>, <&mstp10_clks R8A7790_CLK_SCU_DVC1>,
> -		<&audio_clk_a>, <&audio_clk_b>, <&audio_clk_c>, <&m2_clk>;
> -	clock-names = "ssi-all",
> -			"ssi.9", "ssi.8", "ssi.7", "ssi.6", "ssi.5",
> -			"ssi.4", "ssi.3", "ssi.2", "ssi.1", "ssi.0",
> -			"src.9", "src.8", "src.7", "src.6", "src.5",
> -			"src.4", "src.3", "src.2", "src.1", "src.0",
> -			"dvc.0", "dvc.1",
> -			"clk_a", "clk_b", "clk_c", "clk_i";
> -
> -	rcar_sound,dvc {
> -		dvc0: dvc-0 {
> -			dmas = <&audma0 0xbc>;
> -			dma-names = "tx";
> -		};
> -		dvc1: dvc-1 {
> -			dmas = <&audma0 0xbe>;
> -			dma-names = "tx";
> -		};
> -	};
> -
> -	rcar_sound,mix {
> -		mix0: mix-0 { };
> -		mix1: mix-1 { };
> -	};
> -
> -	rcar_sound,ctu {
> -		ctu00: ctu-0 { };
> -		ctu01: ctu-1 { };
> -		ctu02: ctu-2 { };
> -		ctu03: ctu-3 { };
> -		ctu10: ctu-4 { };
> -		ctu11: ctu-5 { };
> -		ctu12: ctu-6 { };
> -		ctu13: ctu-7 { };
> -	};
> -
> -	rcar_sound,src {
> -		src0: src-0 {
> -			interrupts = <0 352 IRQ_TYPE_LEVEL_HIGH>;
> -			dmas = <&audma0 0x85>, <&audma1 0x9a>;
> -			dma-names = "rx", "tx";
> -		};
> -		src1: src-1 {
> -			interrupts = <0 353 IRQ_TYPE_LEVEL_HIGH>;
> -			dmas = <&audma0 0x87>, <&audma1 0x9c>;
> -			dma-names = "rx", "tx";
> -		};
> -		src2: src-2 {
> -			interrupts = <0 354 IRQ_TYPE_LEVEL_HIGH>;
> -			dmas = <&audma0 0x89>, <&audma1 0x9e>;
> -			dma-names = "rx", "tx";
> -		};
> -		src3: src-3 {
> -			interrupts = <0 355 IRQ_TYPE_LEVEL_HIGH>;
> -			dmas = <&audma0 0x8b>, <&audma1 0xa0>;
> -			dma-names = "rx", "tx";
> -		};
> -		src4: src-4 {
> -			interrupts = <0 356 IRQ_TYPE_LEVEL_HIGH>;
> -			dmas = <&audma0 0x8d>, <&audma1 0xb0>;
> -			dma-names = "rx", "tx";
> -		};
> -		src5: src-5 {
> -			interrupts = <0 357 IRQ_TYPE_LEVEL_HIGH>;
> -			dmas = <&audma0 0x8f>, <&audma1 0xb2>;
> -			dma-names = "rx", "tx";
> -		};
> -		src6: src-6 {
> -			interrupts = <0 358 IRQ_TYPE_LEVEL_HIGH>;
> -			dmas = <&audma0 0x91>, <&audma1 0xb4>;
> -			dma-names = "rx", "tx";
> -		};
> -		src7: src-7 {
> -			interrupts = <0 359 IRQ_TYPE_LEVEL_HIGH>;
> -			dmas = <&audma0 0x93>, <&audma1 0xb6>;
> -			dma-names = "rx", "tx";
> -		};
> -		src8: src-8 {
> -			interrupts = <0 360 IRQ_TYPE_LEVEL_HIGH>;
> -			dmas = <&audma0 0x95>, <&audma1 0xb8>;
> -			dma-names = "rx", "tx";
> -		};
> -		src9: src-9 {
> -			interrupts = <0 361 IRQ_TYPE_LEVEL_HIGH>;
> -			dmas = <&audma0 0x97>, <&audma1 0xba>;
> -			dma-names = "rx", "tx";
> -		};
> -	};
> -
> -	rcar_sound,ssiu {
> -		ssiu00: ssiu-0 {
> -			dmas = <&audma0 0x15>, <&audma1 0x16>;
> -			dma-names = "rx", "tx";
> -		};
> -		ssiu01: ssiu-1 {
> -			dmas = <&audma0 0x35>, <&audma1 0x36>;
> -			dma-names = "rx", "tx";
> -		};
> -
> -		...
> -
> -		ssiu95: ssiu-49 {
> -			dmas = <&audma0 0xA5>, <&audma1 0xA6>;
> -			dma-names = "rx", "tx";
> -		};
> -		ssiu96: ssiu-50 {
> -			dmas = <&audma0 0xA7>, <&audma1 0xA8>;
> -			dma-names = "rx", "tx";
> -		};
> -		ssiu97: ssiu-51 {
> -			dmas = <&audma0 0xA9>, <&audma1 0xAA>;
> -			dma-names = "rx", "tx";
> -		};
> -	};
> -
> -	rcar_sound,ssi {
> -		ssi0: ssi-0 {
> -			interrupts = <0 370 IRQ_TYPE_LEVEL_HIGH>;
> -			dmas = <&audma0 0x01>, <&audma1 0x02>;
> -			dma-names = "rx", "tx";
> -		};
> -		ssi1: ssi-1 {
> -			interrupts = <0 371 IRQ_TYPE_LEVEL_HIGH>;
> -			dmas = <&audma0 0x03>, <&audma1 0x04>;
> -			dma-names = "rx", "tx";
> -		};
> -
> -		...
> -
> -		ssi8: ssi-8 {
> -			interrupts = <0 378 IRQ_TYPE_LEVEL_HIGH>;
> -			dmas = <&audma0 0x11>, <&audma1 0x12>;
> -			dma-names = "rx", "tx";
> -		};
> -		ssi9: ssi-9 {
> -			interrupts = <0 379 IRQ_TYPE_LEVEL_HIGH>;
> -			dmas = <&audma0 0x13>, <&audma1 0x14>;
> -			dma-names = "rx", "tx";
> -		};
> -	};
> -
> -	rcar_sound,dai {
> -		dai0 {
> -			playback = <&ssi5 &src5>;
> -			capture  = <&ssi6>;
> -		};
> -		dai1 {
> -			playback = <&ssi3>;
> -		};
> -		dai2 {
> -			capture  = <&ssi4>;
> -		};
> -		dai3 {
> -			playback = <&ssi7>;
> -		};
> -		dai4 {
> -			capture  = <&ssi8>;
> -		};
> -	};
> -};
> -
> -=============================================
> -Example: simple sound card
> -=============================================
> -
> -	rsnd_ak4643: sound {
> -		compatible = "simple-audio-card";
> -
> -		simple-audio-card,format = "left_j";
> -		simple-audio-card,bitclock-master = <&sndcodec>;
> -		simple-audio-card,frame-master = <&sndcodec>;
> -
> -		sndcpu: simple-audio-card,cpu {
> -			sound-dai = <&rcar_sound>;
> -		};
> -
> -		sndcodec: simple-audio-card,codec {
> -			sound-dai = <&ak4643>;
> -			clocks = <&audio_clock>;
> -		};
> -	};
> -
> -&rcar_sound {
> -	pinctrl-0 = <&sound_pins &sound_clk_pins>;
> -	pinctrl-names = "default";
> -
> -	/* Single DAI */
> -	#sound-dai-cells = <0>;
> -
> -
> -	rcar_sound,dai {
> -		dai0 {
> -			playback = <&ssi0 &src2 &dvc0>;
> -			capture  = <&ssi1 &src3 &dvc1>;
> -		};
> -	};
> -};
> -
> -&ssi1 {
> -	shared-pin;
> -};
> -
> -=============================================
> -Example: simple sound card for Asynchronous mode
> -=============================================
> -
> -sound {
> -	compatible = "simple-scu-audio-card";
> -	...
> -	/*
> -	 * SRC Asynchronous mode setting
> -	 * Playback:
> -	 * All input data will be converted to 48kHz
> -	 * Capture:
> -	 * Inputed 48kHz data will be converted to
> -	 * system specified Hz
> -	 */
> -	simple-audio-card,convert-rate = <48000>;
> -	...
> -	simple-audio-card,cpu {
> -		sound-dai = <&rcar_sound>;
> -	};
> -	simple-audio-card,codec {
> -		...
> -	};
> -};
> -
> -=============================================
> -Example: simple sound card for channel convert
> -=============================================
> -
> -sound {
> -	compatible = "simple-scu-audio-card";
> -	...
> -	/*
> -	 * CTU setting
> -	 * All input data will be converted to 2ch
> -	 * as output data
> -	 */
> -	simple-audio-card,convert-channels = <2>;
> -	...
> -	simple-audio-card,cpu {
> -		sound-dai = <&rcar_sound>;
> -	};
> -	simple-audio-card,codec {
> -		...
> -	};
> -};
> -
> -=============================================
> -Example: simple sound card for MIXer
> -=============================================
> -
> -sound {
> -	compatible = "simple-scu-audio-card";
> -	...
> -	simple-audio-card,cpu@0 {
> -		sound-dai = <&rcar_sound 0>;
> -	};
> -	simple-audio-card,cpu@1 {
> -		sound-dai = <&rcar_sound 1>;
> -	};
> -	simple-audio-card,codec {
> -		...
> -	};
> -};
> -
> -&rcar_sound {
> -	...
> -	rcar_sound,dai {
> -		dai0 {
> -			playback = <&src1 &ctu02 &mix0 &dvc0 &ssi0>;
> -		};
> -		dai1 {
> -			playback = <&src2 &ctu03 &mix0 &dvc0 &ssi0>;
> -		};
> -	};
> -};
> -
> -=============================================
> -Example: simple sound card for TDM
> -=============================================
> -
> -rsnd_tdm: sound {
> -	compatible = "simple-audio-card";
> -
> -	simple-audio-card,format = "left_j";
> -	simple-audio-card,bitclock-master = <&sndcodec>;
> -	simple-audio-card,frame-master = <&sndcodec>;
> -
> -	sndcpu: simple-audio-card,cpu {
> -		sound-dai = <&rcar_sound>;
> -		dai-tdm-slot-num = <6>;
> -	};
> -
> -	sndcodec: simple-audio-card,codec {
> -		sound-dai = <&xxx>;
> -	};
> -};
> -
> -=============================================
> -Example: simple sound card for TDM Split
> -=============================================
> -
> -sound_card: sound {
> -	compatible = "audio-graph-scu-card";
> -	prefix = "xxxx";
> -	routing = "xxxx Playback", "DAI0 Playback",
> -		  "xxxx Playback", "DAI1 Playback",
> -		  "xxxx Playback", "DAI2 Playback",
> -		  "xxxx Playback", "DAI3 Playback";
> -	convert-channels = <8>; /* TDM Split */
> -
> -	dais = <&rsnd_port0     /* playback ch1/ch2 */
> -		&rsnd_port1     /* playback ch3/ch4 */
> -		&rsnd_port2     /* playback ch5/ch6 */
> -		&rsnd_port3     /* playback ch7/ch8 */
> -		>;
> -};
> -
> -audio-codec {
> -	...
> -	port {
> -		codec_0: endpoint@1 {
> -			remote-endpoint = <&rsnd_ep0>;
> -		};
> -		codec_1: endpoint@2 {
> -			remote-endpoint = <&rsnd_ep1>;
> -		};
> -		codec_2: endpoint@3 {
> -			remote-endpoint = <&rsnd_ep2>;
> -		};
> -		codec_3: endpoint@4 {
> -			remote-endpoint = <&rsnd_ep3>;
> -		};
> -	};
> -};
> -
> -&rcar_sound {
> -	...
> -	ports {
> -		rsnd_port0: port@0 {
> -			rsnd_ep0: endpoint {
> -				remote-endpoint = <&codec_0>;
> -				...
> -				playback = <&ssiu30 &ssi3>;
> -			};
> -		};
> -		rsnd_port1: port@1 {
> -			rsnd_ep1: endpoint {
> -				remote-endpoint = <&codec_1>;
> -				...
> -				playback = <&ssiu31 &ssi3>;
> -			};
> -		};
> -		rsnd_port2: port@2 {
> -			rsnd_ep2: endpoint {
> -				remote-endpoint = <&codec_2>;
> -				...
> -				playback = <&ssiu32 &ssi3>;
> -			};
> -		};
> -		rsnd_port3: port@3 {
> -			rsnd_ep3: endpoint {
> -				remote-endpoint = <&codec_3>;
> -				...
> -				playback = <&ssiu33 &ssi3>;
> -			};
> -		};
> -	};
> -};
> -
> -=============================================
> -Example: simple sound card for Multi channel
> -=============================================
> -
> -&rcar_sound {
> -	pinctrl-0 = <&sound_pins &sound_clk_pins>;
> -	pinctrl-names = "default";
> -
> -	/* Single DAI */
> -	#sound-dai-cells = <0>;
> -
> -
> -	rcar_sound,dai {
> -		dai0 {
> -			playback = <&ssi0 &ssi1 &ssi2 &src0 &dvc0>;
> -		};
> -	};
> -};
> diff --git a/Documentation/devicetree/bindings/sound/renesas,rsnd.yaml b/Documentation/devicetree/bindings/sound/renesas,rsnd.yaml
> new file mode 100644
> index 000000000000..3f37f314b580
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/sound/renesas,rsnd.yaml
> @@ -0,0 +1,454 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/sound/renesas,rsnd.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Renesas R-Car Sound Driver Device Tree Bindings
> +
> +maintainers:
> +  - Kuninori Morimoto <kuninori.morimoto.gx@xxxxxxxxxxx>
> +
> +properties:
> +
> +  compatible:
> +    oneOf:
> +      # for Gen1 SoC
> +      - items:
> +          - enum:
> +            - renesas,rcar_sound-r8a7778   # R-Car M1A
> +            - renesas,rcar_sound-r8a7779   # R-Car H1
> +          - enum:
> +            - renesas,rcar_sound-gen1
> +      # for Gen2 SoC
> +      - items:
> +          - enum:
> +              - renesas,rcar_sound-r8a7742   # RZ/G1H
> +              - renesas,rcar_sound-r8a7743   # RZ/G1M
> +              - renesas,rcar_sound-r8a7744   # RZ/G1N
> +              - renesas,rcar_sound-r8a7745   # RZ/G1E
> +              - renesas,rcar_sound-r8a77470  # RZ/G1C
> +              - renesas,rcar_sound-r8a7790   # R-Car H2
> +              - renesas,rcar_sound-r8a7791   # R-Car M2-W
> +              - renesas,rcar_sound-r8a7793   # R-Car M2-N
> +              - renesas,rcar_sound-r8a7794   # R-Car E2
> +          - enum:
> +              - renesas,rcar_sound-gen2
> +      # for Gen3 SoC
> +      - items:
> +          - enum:
> +              - renesas,rcar_sound-r8a774a1  # RZ/G2M
> +              - renesas,rcar_sound-r8a774b1  # RZ/G2N
> +              - renesas,rcar_sound-r8a774c0  # RZ/G2E
> +              - renesas,rcar_sound-r8a774e1  # RZ/G2H
> +              - renesas,rcar_sound-r8a7795   # R-Car H3
> +              - renesas,rcar_sound-r8a7796   # R-Car M3-W
> +              - renesas,rcar_sound-r8a77965  # R-Car M3-N
> +              - renesas,rcar_sound-r8a77990  # R-Car E3
> +              - renesas,rcar_sound-r8a77995  # R-Car D3
> +          - enum:
> +              - renesas,rcar_sound-gen3
> +      # for Generic
> +      - items:
> +          - enum:
> +              - renesas,rcar_sound-gen1
> +              - renesas,rcar_sound-gen2
> +              - renesas,rcar_sound-gen3
> +
> +  reg:
> +    minItems: 3 # Gen1
> +    maxItems: 5 # Gen2/Gen3
> +
> +  reg-names:
> +    description: |
> +      Should contain the register names.
> +      scu/adg/ssi              if generation1
> +      scu/adg/ssiu/ssi/audmapp if generation2/generation3

The schema describes this, no need to duplicate here.

> +    minItems: 3 # Gen1
> +    maxItems: 5 # Gen2/Gen3
> +    oneOf:
> +      # for Gen1
> +      - allOf:
> +        - items:

Don't need 'allOf' if only 1 entry.

> +            enum:
> +              - scu
> +              - adg
> +              - ssi
> +      # for Gen2/Gen3
> +      - allOf:
> +        - items:
> +            enum:
> +              - scu
> +              - adg
> +              - ssiu
> +              - ssi
> +              - audmapp

We'd normally define these with an if/then schema based on the 
compatibles.

> +
> +  "#sound-dai-cells":
> +    description: |
> +      it must be 0 if your system is using single DAI
> +      it must be 1 if your system is using multi  DAIs
> +    enum: [0, 1]
> +
> +  "#clock-cells":
> +    description: |
> +      it must be 0 if your system has audio_clkout
> +      it must be 1 if your system has audio_clkout0/1/2/3
> +    enum: [0, 1]
> +
> +  clock-frequency:
> +    description: for audio_clkout0/1/2/3
> +    $ref: /schemas/types.yaml#/definitions/uint32-array
> +
> +  clkout-lr-asynchronous:
> +    description: audio_clkoutn is asynchronizes with lr-clock.
> +    $ref: /schemas/types.yaml#/definitions/flag
> +
> +  power-domains: true
> +
> +  resets:
> +    description: References to SSI resets
> +    $ref: /schemas/types.yaml#/definitions/phandle-array

'resets' already has a type. Just need to know how many and what each 
one is.

> +
> +  reset-names:
> +    description: List of valid reset names.
> +    allOf:
> +      - items:
> +         oneOf:
> +           - pattern: '^ssi(-all|\.[0-9])$'

Just:

reset-names:
  maxItems: ??
  items:
    pattern: '^ssi(-all|\.[0-9])$'


> +
> +  clocks:
> +    description: References to SSI/SRC/MIX/CTU/DVC/AUDIO_CLK clocks.
> +    minItems:  1
> +    maxItems: 31
> +
> +  clock-names:
> +    description: List of necessary clock names.
> +    minItems:  1
> +    maxItems: 31
> +    allOf:
> +      - items:

Don't need 'allOf'.

> +         oneOf:
> +           - const:   ssi-all
> +           - pattern: '^ssi\.[0-9]$'
> +           - pattern: '^src\.[0-9]$'
> +           - pattern: '^mix\.[0-1]$'
> +           - pattern: '^ctu\.[0-1]$'
> +           - pattern: '^dvc\.[0-1]$'
> +           - pattern: '^clk_(a|b|c|i)$'
> +
> +  # For OF-graph
> +  port:
> +    description: OF-Graph subnode
> +    $ref: "audio-graph-card.yaml#/definitions/port"

Something like this should work (at the top-level):

allOf:
  - $ref: "audio-graph-card.yaml#

> +
> +  # For multi OF-graph
> +  ports:
> +    description: multi OF-Graph subnode
> +    $ref: "audio-graph-card.yaml#/definitions/ports"
> +
> +# use patternProperties to avoid naming "xxx,yyy"
> +patternProperties:
> +  "^rcar_sound,dvc$":

None of these are patterns.

> +    description: DVC subnode.
> +    type: object
> +    patternProperties:
> +      "^dvc-[0-1]$":
> +        type: object
> +        properties:
> +          dmas:
> +            maxItems: 1
> +          dma-names:
> +            const: "tx"
> +        required:
> +          - dmas
> +          - dma-names
> +    additionalProperties: false
> +
> +  "^rcar_sound,mix$":
> +    description: MIX subnode.
> +    type: object
> +    patternProperties:
> +      "^mix-[0-1]$":
> +        type: object
> +        # no propaties
> +    additionalProperties: false
> +
> +  "^rcar_sound,ctu$":
> +    description: CTU subnode.
> +    type: object
> +    patternProperties:
> +      "^ctu-[0-7]$":
> +        type: object
> +        # no propaties
> +    additionalProperties: false
> +
> +  "^rcar_sound,src$":
> +    description: SRC subnode.
> +    type: object
> +    patternProperties:
> +      "^src-[0-9]$":
> +        type: object
> +        properties:
> +          interrupts:
> +            maxItems: 1
> +          dmas:
> +            maxItems: 2
> +          dma-names:
> +            allOf:
> +              - items:
> +                  enum:
> +                    - tx
> +                    - rx
> +        allOf:
> +          - if:
> +              properties:
> +                status:
> +                  const: "ok"
> +            then:
> +              required:
> +                - interrupts
> +                - dmas
> +                - dma-names
> +    additionalProperties: false
> +
> +  "^rcar_sound,ssiu$":
> +    description: SSIU subnode.
> +    type: object
> +    patternProperties:
> +      "^ssiu-[0-9]+$":
> +        type: object
> +        properties:
> +          dmas:
> +            maxItems: 2
> +          dma-names:
> +            allOf:
> +              - items:
> +                  enum:
> +                    - tx
> +                    - rx
> +        required:
> +          - dmas
> +          - dma-names
> +    additionalProperties: false
> +
> +  "^rcar_sound,ssi$":
> +    description: SSI subnode.
> +    type: object
> +    patternProperties:
> +      "^ssi-[0-9]$":
> +        type: object
> +        properties:
> +          interrupts:
> +            maxItems: 1
> +          dmas:
> +            minItems: 2
> +            maxItems: 4
> +          dma-names:
> +            allOf:
> +              - items:
> +                  enum:
> +                    - tx
> +                    - rx
> +                    - txu # if no ssiu node
> +                    - rxu # if no ssiu node
> +
> +          shared-pin:
> +            description: shared clock pin
> +            $ref: /schemas/types.yaml#/definitions/flag
> +          pio-transfer:
> +            description: PIO transfer mode
> +            $ref: /schemas/types.yaml#/definitions/flag
> +          no-busif:
> +            description: BUSIF is not used when [mem -> SSI] via DMA case
> +            $ref: /schemas/types.yaml#/definitions/flag
> +        required:
> +          - interrupts
> +          - dmas
> +          - dma-names
> +    additionalProperties: false
> +
> +  # For DAI base
> +  "^rcar_sound,dai$":
> +    description: DAI subnode.
> +    type: object
> +    patternProperties:
> +      "^dai([0-9]+)?$":
> +        type: object
> +        properties:
> +          playback:
> +            $ref: /schemas/types.yaml#/definitions/phandle-array
> +          capture:
> +            $ref: /schemas/types.yaml#/definitions/phandle-array
> +        anyOf:
> +          - required:
> +              - playback
> +          - required:
> +              - capture
> +    additionalProperties: false
> +
> +required:
> +  - compatible
> +  - reg
> +  - reg-names
> +  - clocks
> +  - clock-names
> +  - "#sound-dai-cells"
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    rcar_sound: sound@ec500000 {
> +        #sound-dai-cells = <1>;
> +        compatible = "renesas,rcar_sound-r8a7790", "renesas,rcar_sound-gen2";
> +        reg = <0xec500000 0x1000>, /* SCU  */
> +              <0xec5a0000 0x100>,  /* ADG  */
> +              <0xec540000 0x1000>, /* SSIU */
> +              <0xec541000 0x1280>, /* SSI  */
> +              <0xec740000 0x200>;  /* Audio DMAC peri peri*/
> +        reg-names = "scu", "adg", "ssiu", "ssi", "audmapp";
> +
> +        clocks = <&mstp10_clks 1005>,                      /* SSI-ALL    */
> +                 <&mstp10_clks 1006>, <&mstp10_clks 1007>, /* SSI9, SSI8 */
> +                 <&mstp10_clks 1008>, <&mstp10_clks 1009>, /* SSI7, SSI6 */
> +                 <&mstp10_clks 1010>, <&mstp10_clks 1011>, /* SSI5, SSI4 */
> +                 <&mstp10_clks 1012>, <&mstp10_clks 1013>, /* SSI3, SSI2 */
> +                 <&mstp10_clks 1014>, <&mstp10_clks 1015>, /* SSI1, SSI0 */
> +                 <&mstp10_clks 1022>, <&mstp10_clks 1023>, /* SRC9, SRC8 */
> +                 <&mstp10_clks 1024>, <&mstp10_clks 1025>, /* SRC7, SRC6 */
> +                 <&mstp10_clks 1026>, <&mstp10_clks 1027>, /* SRC5, SRC4 */
> +                 <&mstp10_clks 1028>, <&mstp10_clks 1029>, /* SRC3, SRC2 */
> +                 <&mstp10_clks 1030>, <&mstp10_clks 1031>, /* SRC1, SRC0 */
> +                 <&mstp10_clks 1020>, <&mstp10_clks 1021>, /* MIX1, MIX0 */
> +                 <&mstp10_clks 1020>, <&mstp10_clks 1021>, /* CTU1, CTU0 */
> +                 <&mstp10_clks 1019>, <&mstp10_clks 1018>, /* DVC0, DVC1 */
> +                 <&audio_clk_a>, <&audio_clk_b>,           /* CLKA, CLKB */
> +                 <&audio_clk_c>, <&audio_clk_i>;           /* CLKC, CLKI */
> +
> +        clock-names = "ssi-all",
> +                      "ssi.9", "ssi.8",
> +                      "ssi.7", "ssi.6",
> +                      "ssi.5", "ssi.4",
> +                      "ssi.3", "ssi.2",
> +                      "ssi.1", "ssi.0",
> +                      "src.9", "src.8",
> +                      "src.7", "src.6",
> +                      "src.5", "src.4",
> +                      "src.3", "src.2",
> +                      "src.1", "src.0",
> +                      "mix.1", "mix.0",
> +                      "ctu.1", "ctu.0",
> +                      "dvc.0", "dvc.1",
> +                      "clk_a", "clk_b",
> +                      "clk_c", "clk_i";
> +
> +        rcar_sound,dvc {
> +               dvc0: dvc-0 {
> +                    dmas = <&audma0 0xbc>;
> +                    dma-names = "tx";
> +               };
> +               dvc1: dvc-1 {
> +                    dmas = <&audma0 0xbe>;
> +                    dma-names = "tx";
> +               };
> +        };
> +
> +        rcar_sound,mix {
> +            mix0: mix-0 { };
> +            mix1: mix-1 { };
> +        };
> +
> +        rcar_sound,ctu {
> +            ctu00: ctu-0 { };
> +            ctu01: ctu-1 { };
> +            ctu02: ctu-2 { };
> +            ctu03: ctu-3 { };
> +            ctu10: ctu-4 { };
> +            ctu11: ctu-5 { };
> +            ctu12: ctu-6 { };
> +            ctu13: ctu-7 { };
> +        };
> +
> +        rcar_sound,src {
> +            src0: src-0 {
> +                status = "disabled";
> +            };
> +            src1: src-1 {
> +                interrupts = <0 353 0>;
> +                dmas = <&audma0 0x87>, <&audma1 0x9c>;
> +                dma-names = "rx", "tx";
> +            };
> +            /* skip after src-2 */
> +        };
> +
> +        rcar_sound,ssiu {
> +            ssiu00: ssiu-0 {
> +                dmas = <&audma0 0x15>, <&audma1 0x16>;
> +                dma-names = "rx", "tx";
> +            };
> +            ssiu01: ssiu-1 {
> +                dmas = <&audma0 0x35>, <&audma1 0x36>;
> +                dma-names = "rx", "tx";
> +            };
> +            /* skip after ssiu-2 */
> +        };
> +
> +        rcar_sound,ssi {
> +            ssi0: ssi-0 {
> +                interrupts = <0 370 1>;
> +                dmas = <&audma0 0x01>, <&audma1 0x02>;
> +                dma-names = "rx", "tx";
> +            };
> +            ssi1: ssi-1 {
> +                interrupts = <0 371 1>;
> +                dmas = <&audma0 0x03>, <&audma1 0x04>;
> +                dma-names = "rx", "tx";
> +            };
> +            /* skip other ssi-2 */
> +        };
> +
> +        /* DAI base */
> +        rcar_sound,dai {
> +            dai0 {
> +                playback = <&ssi5 &src5>;
> +                capture  = <&ssi6>;
> +            };
> +            dai1 {
> +                playback = <&ssi3>;
> +            };
> +            dai2 {
> +                capture  = <&ssi4>;
> +            };
> +            dai3 {
> +                playback = <&ssi7>;
> +            };
> +            dai4 {
> +                capture  = <&ssi8>;
> +            };
> +        };
> +
> +        /* assume audio-graph */
> +        port {
> +            rsnd_endpoint: endpoint {
> +                remote-endpoint = <&codec_endpoint>;
> +
> +                dai-format = "left_j";
> +                bitclock-master = <&rsnd_endpoint0>;
> +                frame-master = <&rsnd_endpoint0>;
> +
> +                playback = <&ssi0 &src0 &dvc0>;
> +                capture  = <&ssi1 &src1 &dvc1>;
> +            };
> +        };
> +    };
> +
> +
> +    /* assume audio-graph */
> +    codec {
> +        port {
> +            codec_endpoint: endpoint {
> +                remote-endpoint = <&rsnd_endpoint>;
> +            };
> +        };
> +    };
> -- 
> 2.25.1
> 



[Index of Archives]     [Device Tree Compilter]     [Device Tree Spec]     [Linux Driver Backports]     [Video for Linux]     [Linux USB Devel]     [Linux PCI Devel]     [Linux Audio Users]     [Linux Kernel]     [Linux SCSI]     [XFree86]     [Yosemite Backpacking]


  Powered by Linux