[deliverable/linux.git] / Documentation / devicetree / bindings / sound / renesas,rsnd.txt

Renesas R-Car sound

Required properties:
- compatible			: "renesas,rcar_sound-<soctype>", fallbacks
				  "renesas,rcar_sound-gen1" if generation1, and
				  "renesas,rcar_sound-gen2" if generation2
				  Examples with soctypes are:
				    - "renesas,rcar_sound-r8a7778" (R-Car M1A)
				    - "renesas,rcar_sound-r8a7790" (R-Car H2)
				    - "renesas,rcar_sound-r8a7791" (R-Car M2-W)
- reg				: Should contain the register physical address.
				  required register is
				   SRU/ADG/SSI      if generation1
				   SRU/ADG/SSIU/SSI if generation2
- rcar_sound,ssi		: Should contain SSI feature.
				  The number of SSI 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,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.

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)
				  SSIU case "rxu" (=playback), "txu" (=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,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,ssi {
		ssi0: ssi@0 {
			interrupts = <0 370 IRQ_TYPE_LEVEL_HIGH>;
			dmas = <&audma0 0x01>, <&audma1 0x02>, <&audma0 0x15>, <&audma1 0x16>;
			dma-names = "rx", "tx", "rxu", "txu";
		};
		ssi1: ssi@1 {
			interrupts = <0 371 IRQ_TYPE_LEVEL_HIGH>;
			dmas = <&audma0 0x03>, <&audma1 0x04>, <&audma0 0x49>, <&audma1 0x4a>;
			dma-names = "rx", "tx", "rxu", "txu";
		};
		ssi2: ssi@2 {
			interrupts = <0 372 IRQ_TYPE_LEVEL_HIGH>;
			dmas = <&audma0 0x05>, <&audma1 0x06>, <&audma0 0x63>, <&audma1 0x64>;
			dma-names = "rx", "tx", "rxu", "txu";
		};
		ssi3: ssi@3 {
			interrupts = <0 373 IRQ_TYPE_LEVEL_HIGH>;
			dmas = <&audma0 0x07>, <&audma1 0x08>, <&audma0 0x6f>, <&audma1 0x70>;
			dma-names = "rx", "tx", "rxu", "txu";
		};
		ssi4: ssi@4 {
			interrupts = <0 374 IRQ_TYPE_LEVEL_HIGH>;
			dmas = <&audma0 0x09>, <&audma1 0x0a>, <&audma0 0x71>, <&audma1 0x72>;
			dma-names = "rx", "tx", "rxu", "txu";
		};
		ssi5: ssi@5 {
			interrupts = <0 375 IRQ_TYPE_LEVEL_HIGH>;
			dmas = <&audma0 0x0b>, <&audma1 0x0c>, <&audma0 0x73>, <&audma1 0x74>;
			dma-names = "rx", "tx", "rxu", "txu";
		};
		ssi6: ssi@6 {
			interrupts = <0 376 IRQ_TYPE_LEVEL_HIGH>;
			dmas = <&audma0 0x0d>, <&audma1 0x0e>, <&audma0 0x75>, <&audma1 0x76>;
			dma-names = "rx", "tx", "rxu", "txu";
		};
		ssi7: ssi@7 {
			interrupts = <0 377 IRQ_TYPE_LEVEL_HIGH>;
			dmas = <&audma0 0x0f>, <&audma1 0x10>, <&audma0 0x79>, <&audma1 0x7a>;
			dma-names = "rx", "tx", "rxu", "txu";
		};
		ssi8: ssi@8 {
			interrupts = <0 378 IRQ_TYPE_LEVEL_HIGH>;
			dmas = <&audma0 0x11>, <&audma1 0x12>, <&audma0 0x7b>, <&audma1 0x7c>;
			dma-names = "rx", "tx", "rxu", "txu";
		};
		ssi9: ssi@9 {
			interrupts = <0 379 IRQ_TYPE_LEVEL_HIGH>;
			dmas = <&audma0 0x13>, <&audma1 0x14>, <&audma0 0x7d>, <&audma1 0x7e>;
			dma-names = "rx", "tx", "rxu", "txu";
		};
	};

	rcar_sound,dai {
		dai0 {
			playback = <&ssi5 &src5>;
			capture  = <&ssi6>;
		};
		dai1 {
			playback = <&ssi3>;
		};
		dai2 {
			capture  = <&ssi4>;
		};
		dai3 {
			playback = <&ssi7>;
		};
		dai4 {
			capture  = <&ssi8>;
		};
	};
};
Commit	Line	Data
90e8e50f KM	1	Renesas R-Car sound
	2
	3	Required properties:
56ba98ac GU	4	- compatible : "renesas,rcar_sound-<soctype>", fallbacks
56ba98ac GU	5	"renesas,rcar_sound-gen1" if generation1, and
90e8e50f	6	"renesas,rcar_sound-gen2" if generation2
56ba98ac	7	Examples with soctypes are:
7667f716	8	- "renesas,rcar_sound-r8a7778" (R-Car M1A)
56ba98ac GU	9	- "renesas,rcar_sound-r8a7790" (R-Car H2)
56ba98ac GU	10	- "renesas,rcar_sound-r8a7791" (R-Car M2-W)
90e8e50f KM	11	- reg : Should contain the register physical address.
	12	required register is
	13	SRU/ADG/SSI if generation1
	14	SRU/ADG/SSIU/SSI if generation2
8bab0dd5 KM	15	- rcar_sound,ssi : Should contain SSI feature.
	16	The number of SSI subnode should be same as HW.
	17	see below for detail.
	18	- rcar_sound,src : Should contain SRC feature.
	19	The number of SRC subnode should be same as HW.
	20	see below for detail.
34cb6123 KM	21	- rcar_sound,dvc : Should contain DVC feature.
	22	The number of DVC subnode should be same as HW.
	23	see below for detail.
8bab0dd5 KM	24	- rcar_sound,dai : DAI contents.
	25	The number of DAI subnode should be same as HW.
	26	see below for detail.
90e8e50f KM	27
	28	SSI subnode properties:
	29	- interrupts : Should contain SSI interrupt for PIO transfer
	30	- shared-pin : if shared clock pin
199e7688	31	- pio-transfer : use PIO transfer mode
d9288d0b	32	- no-busif : BUSIF is not ussed when [mem -> SSI] via DMA case
e80a2fb1 KM	33	- dma : Should contain Audio DMAC entry
	34	- dma-names : SSI case "rx" (=playback), "tx" (=capture)
	35	SSIU case "rxu" (=playback), "txu" (=capture)
90e8e50f	36
8bab0dd5	37	SRC subnode properties:
e80a2fb1 KM	38	- dma : Should contain Audio DMAC entry
	39	- dma-names : "rx" (=playback), "tx" (=capture)
	40
	41	DVC subnode properties:
	42	- dma : Should contain Audio DMAC entry
	43	- dma-names : "tx" (=playback/capture)
8bab0dd5	44
90e8e50f KM	45	DAI subnode properties:
	46	- playback : list of playback modules
	47	- capture : list of capture modules
	48
	49	Example:
	50
596f74ec	51	rcar_sound: sound@ec500000 {
90e8e50f	52	#sound-dai-cells = <1>;
56ba98ac	53	compatible = "renesas,rcar_sound-r8a7791", "renesas,rcar_sound-gen2";
90e8e50f KM	54	reg = <0 0xec500000 0 0x1000>, /* SCU */
	55	<0 0xec5a0000 0 0x100>, /* ADG */
	56	<0 0xec540000 0 0x1000>, /* SSIU */
d3b1c0ba KM	57	<0 0xec541000 0 0x1280>, /* SSI */
	58	<0 0xec740000 0 0x200>; /* Audio DMAC peri peri*/
	59	reg-names = "scu", "adg", "ssiu", "ssi", "audmapp";
90e8e50f	60
bb02714f KM	61	clocks = <&mstp10_clks R8A7790_CLK_SSI_ALL>,
	62	<&mstp10_clks R8A7790_CLK_SSI9>, <&mstp10_clks R8A7790_CLK_SSI8>,
	63	<&mstp10_clks R8A7790_CLK_SSI7>, <&mstp10_clks R8A7790_CLK_SSI6>,
	64	<&mstp10_clks R8A7790_CLK_SSI5>, <&mstp10_clks R8A7790_CLK_SSI4>,
	65	<&mstp10_clks R8A7790_CLK_SSI3>, <&mstp10_clks R8A7790_CLK_SSI2>,
	66	<&mstp10_clks R8A7790_CLK_SSI1>, <&mstp10_clks R8A7790_CLK_SSI0>,
	67	<&mstp10_clks R8A7790_CLK_SCU_SRC9>, <&mstp10_clks R8A7790_CLK_SCU_SRC8>,
	68	<&mstp10_clks R8A7790_CLK_SCU_SRC7>, <&mstp10_clks R8A7790_CLK_SCU_SRC6>,
	69	<&mstp10_clks R8A7790_CLK_SCU_SRC5>, <&mstp10_clks R8A7790_CLK_SCU_SRC4>,
	70	<&mstp10_clks R8A7790_CLK_SCU_SRC3>, <&mstp10_clks R8A7790_CLK_SCU_SRC2>,
	71	<&mstp10_clks R8A7790_CLK_SCU_SRC1>, <&mstp10_clks R8A7790_CLK_SCU_SRC0>,
	72	<&mstp10_clks R8A7790_CLK_SCU_DVC0>, <&mstp10_clks R8A7790_CLK_SCU_DVC1>,
	73	<&audio_clk_a>, <&audio_clk_b>, <&audio_clk_c>, <&m2_clk>;
	74	clock-names = "ssi-all",
	75	"ssi.9", "ssi.8", "ssi.7", "ssi.6", "ssi.5",
	76	"ssi.4", "ssi.3", "ssi.2", "ssi.1", "ssi.0",
	77	"src.9", "src.8", "src.7", "src.6", "src.5",
	78	"src.4", "src.3", "src.2", "src.1", "src.0",
	79	"dvc.0", "dvc.1",
	80	"clk_a", "clk_b", "clk_c", "clk_i";
	81
34cb6123	82	rcar_sound,dvc {
e80a2fb1 KM	83	dvc0: dvc@0 {
	84	dmas = <&audma0 0xbc>;
	85	dma-names = "tx";
	86	};
	87	dvc1: dvc@1 {
	88	dmas = <&audma0 0xbe>;
	89	dma-names = "tx";
	90	};
34cb6123 KM	91	};
34cb6123 KM	92
90e8e50f	93	rcar_sound,src {
5cf4f686 KM	94	src0: src@0 {
5cf4f686 KM	95	interrupts = <0 352 IRQ_TYPE_LEVEL_HIGH>;
e80a2fb1 KM	96	dmas = <&audma0 0x85>, <&audma1 0x9a>;
e80a2fb1 KM	97	dma-names = "rx", "tx";
5cf4f686 KM	98	};
	99	src1: src@1 {
	100	interrupts = <0 353 IRQ_TYPE_LEVEL_HIGH>;
e80a2fb1 KM	101	dmas = <&audma0 0x87>, <&audma1 0x9c>;
e80a2fb1 KM	102	dma-names = "rx", "tx";
5cf4f686 KM	103	};
	104	src2: src@2 {
	105	interrupts = <0 354 IRQ_TYPE_LEVEL_HIGH>;
e80a2fb1 KM	106	dmas = <&audma0 0x89>, <&audma1 0x9e>;
e80a2fb1 KM	107	dma-names = "rx", "tx";
5cf4f686 KM	108	};
	109	src3: src@3 {
	110	interrupts = <0 355 IRQ_TYPE_LEVEL_HIGH>;
e80a2fb1 KM	111	dmas = <&audma0 0x8b>, <&audma1 0xa0>;
e80a2fb1 KM	112	dma-names = "rx", "tx";
5cf4f686 KM	113	};
	114	src4: src@4 {
	115	interrupts = <0 356 IRQ_TYPE_LEVEL_HIGH>;
e80a2fb1 KM	116	dmas = <&audma0 0x8d>, <&audma1 0xb0>;
e80a2fb1 KM	117	dma-names = "rx", "tx";
5cf4f686 KM	118	};
	119	src5: src@5 {
	120	interrupts = <0 357 IRQ_TYPE_LEVEL_HIGH>;
e80a2fb1 KM	121	dmas = <&audma0 0x8f>, <&audma1 0xb2>;
e80a2fb1 KM	122	dma-names = "rx", "tx";
5cf4f686 KM	123	};
	124	src6: src@6 {
	125	interrupts = <0 358 IRQ_TYPE_LEVEL_HIGH>;
e80a2fb1 KM	126	dmas = <&audma0 0x91>, <&audma1 0xb4>;
e80a2fb1 KM	127	dma-names = "rx", "tx";
5cf4f686 KM	128	};
	129	src7: src@7 {
	130	interrupts = <0 359 IRQ_TYPE_LEVEL_HIGH>;
e80a2fb1 KM	131	dmas = <&audma0 0x93>, <&audma1 0xb6>;
e80a2fb1 KM	132	dma-names = "rx", "tx";
5cf4f686 KM	133	};
	134	src8: src@8 {
	135	interrupts = <0 360 IRQ_TYPE_LEVEL_HIGH>;
e80a2fb1 KM	136	dmas = <&audma0 0x95>, <&audma1 0xb8>;
e80a2fb1 KM	137	dma-names = "rx", "tx";
5cf4f686 KM	138	};
	139	src9: src@9 {
	140	interrupts = <0 361 IRQ_TYPE_LEVEL_HIGH>;
e80a2fb1 KM	141	dmas = <&audma0 0x97>, <&audma1 0xba>;
e80a2fb1 KM	142	dma-names = "rx", "tx";
5cf4f686	143	};
90e8e50f KM	144	};
	145
	146	rcar_sound,ssi {
	147	ssi0: ssi@0 {
	148	interrupts = <0 370 IRQ_TYPE_LEVEL_HIGH>;
e80a2fb1 KM	149	dmas = <&audma0 0x01>, <&audma1 0x02>, <&audma0 0x15>, <&audma1 0x16>;
e80a2fb1 KM	150	dma-names = "rx", "tx", "rxu", "txu";
90e8e50f KM	151	};
	152	ssi1: ssi@1 {
	153	interrupts = <0 371 IRQ_TYPE_LEVEL_HIGH>;
e80a2fb1 KM	154	dmas = <&audma0 0x03>, <&audma1 0x04>, <&audma0 0x49>, <&audma1 0x4a>;
e80a2fb1 KM	155	dma-names = "rx", "tx", "rxu", "txu";
90e8e50f KM	156	};
	157	ssi2: ssi@2 {
	158	interrupts = <0 372 IRQ_TYPE_LEVEL_HIGH>;
e80a2fb1 KM	159	dmas = <&audma0 0x05>, <&audma1 0x06>, <&audma0 0x63>, <&audma1 0x64>;
e80a2fb1 KM	160	dma-names = "rx", "tx", "rxu", "txu";
90e8e50f KM	161	};
	162	ssi3: ssi@3 {
	163	interrupts = <0 373 IRQ_TYPE_LEVEL_HIGH>;
e80a2fb1 KM	164	dmas = <&audma0 0x07>, <&audma1 0x08>, <&audma0 0x6f>, <&audma1 0x70>;
e80a2fb1 KM	165	dma-names = "rx", "tx", "rxu", "txu";
90e8e50f KM	166	};
	167	ssi4: ssi@4 {
	168	interrupts = <0 374 IRQ_TYPE_LEVEL_HIGH>;
e80a2fb1 KM	169	dmas = <&audma0 0x09>, <&audma1 0x0a>, <&audma0 0x71>, <&audma1 0x72>;
e80a2fb1 KM	170	dma-names = "rx", "tx", "rxu", "txu";
90e8e50f KM	171	};
	172	ssi5: ssi@5 {
	173	interrupts = <0 375 IRQ_TYPE_LEVEL_HIGH>;
e80a2fb1 KM	174	dmas = <&audma0 0x0b>, <&audma1 0x0c>, <&audma0 0x73>, <&audma1 0x74>;
e80a2fb1 KM	175	dma-names = "rx", "tx", "rxu", "txu";
90e8e50f KM	176	};
	177	ssi6: ssi@6 {
	178	interrupts = <0 376 IRQ_TYPE_LEVEL_HIGH>;
e80a2fb1 KM	179	dmas = <&audma0 0x0d>, <&audma1 0x0e>, <&audma0 0x75>, <&audma1 0x76>;
e80a2fb1 KM	180	dma-names = "rx", "tx", "rxu", "txu";
90e8e50f KM	181	};
	182	ssi7: ssi@7 {
	183	interrupts = <0 377 IRQ_TYPE_LEVEL_HIGH>;
e80a2fb1 KM	184	dmas = <&audma0 0x0f>, <&audma1 0x10>, <&audma0 0x79>, <&audma1 0x7a>;
e80a2fb1 KM	185	dma-names = "rx", "tx", "rxu", "txu";
90e8e50f KM	186	};
	187	ssi8: ssi@8 {
	188	interrupts = <0 378 IRQ_TYPE_LEVEL_HIGH>;
e80a2fb1 KM	189	dmas = <&audma0 0x11>, <&audma1 0x12>, <&audma0 0x7b>, <&audma1 0x7c>;
e80a2fb1 KM	190	dma-names = "rx", "tx", "rxu", "txu";
90e8e50f KM	191	};
	192	ssi9: ssi@9 {
	193	interrupts = <0 379 IRQ_TYPE_LEVEL_HIGH>;
e80a2fb1 KM	194	dmas = <&audma0 0x13>, <&audma1 0x14>, <&audma0 0x7d>, <&audma1 0x7e>;
e80a2fb1 KM	195	dma-names = "rx", "tx", "rxu", "txu";
90e8e50f KM	196	};
	197	};
	198
	199	rcar_sound,dai {
	200	dai0 {
	201	playback = <&ssi5 &src5>;
	202	capture = <&ssi6>;
	203	};
	204	dai1 {
	205	playback = <&ssi3>;
	206	};
	207	dai2 {
	208	capture = <&ssi4>;
	209	};
	210	dai3 {
	211	playback = <&ssi7>;
	212	};
	213	dai4 {
	214	capture = <&ssi8>;
	215	};
	216	};
	217	};