Merge remote-tracking branches 'regulator/fix/88pm800', 'regulator/fix/max8973',...
[linux-drm-fsl-dcu.git] / Documentation / devicetree / bindings / sound / renesas,rsnd.txt
1 Renesas R-Car sound
2
3 Required properties:
4 - compatible                    : "renesas,rcar_sound-<soctype>", fallbacks
5                                   "renesas,rcar_sound-gen1" if generation1, and
6                                   "renesas,rcar_sound-gen2" if generation2
7                                   Examples with soctypes are:
8                                     - "renesas,rcar_sound-r8a7778" (R-Car M1A)
9                                     - "renesas,rcar_sound-r8a7790" (R-Car H2)
10                                     - "renesas,rcar_sound-r8a7791" (R-Car M2-W)
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
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.
21 - rcar_sound,dvc                : Should contain DVC feature.
22                                   The number of DVC subnode should be same as HW.
23                                   see below for detail.
24 - rcar_sound,dai                : DAI contents.
25                                   The number of DAI subnode should be same as HW.
26                                   see below for detail.
27
28 SSI subnode properties:
29 - interrupts                    : Should contain SSI interrupt for PIO transfer
30 - shared-pin                    : if shared clock pin
31 - pio-transfer                  : use PIO transfer mode
32 - no-busif                      : BUSIF is not ussed when [mem -> SSI] via DMA case
33 - dma                           : Should contain Audio DMAC entry
34 - dma-names                     : SSI  case "rx"  (=playback), "tx"  (=capture)
35                                   SSIU case "rxu" (=playback), "txu" (=capture)
36
37 SRC subnode properties:
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)
44
45 DAI subnode properties:
46 - playback                      : list of playback modules
47 - capture                       : list of capture  modules
48
49 Example:
50
51 rcar_sound: sound@ec500000 {
52         #sound-dai-cells = <1>;
53         compatible = "renesas,rcar_sound-r8a7791", "renesas,rcar_sound-gen2";
54         reg =   <0 0xec500000 0 0x1000>, /* SCU */
55                 <0 0xec5a0000 0 0x100>,  /* ADG */
56                 <0 0xec540000 0 0x1000>, /* SSIU */
57                 <0 0xec541000 0 0x1280>, /* SSI */
58                 <0 0xec740000 0 0x200>;  /* Audio DMAC peri peri*/
59         reg-names = "scu", "adg", "ssiu", "ssi", "audmapp";
60
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
82         rcar_sound,dvc {
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                 };
91         };
92
93         rcar_sound,src {
94                 src0: src@0 {
95                         interrupts = <0 352 IRQ_TYPE_LEVEL_HIGH>;
96                         dmas = <&audma0 0x85>, <&audma1 0x9a>;
97                         dma-names = "rx", "tx";
98                 };
99                 src1: src@1 {
100                         interrupts = <0 353 IRQ_TYPE_LEVEL_HIGH>;
101                         dmas = <&audma0 0x87>, <&audma1 0x9c>;
102                         dma-names = "rx", "tx";
103                 };
104                 src2: src@2 {
105                         interrupts = <0 354 IRQ_TYPE_LEVEL_HIGH>;
106                         dmas = <&audma0 0x89>, <&audma1 0x9e>;
107                         dma-names = "rx", "tx";
108                 };
109                 src3: src@3 {
110                         interrupts = <0 355 IRQ_TYPE_LEVEL_HIGH>;
111                         dmas = <&audma0 0x8b>, <&audma1 0xa0>;
112                         dma-names = "rx", "tx";
113                 };
114                 src4: src@4 {
115                         interrupts = <0 356 IRQ_TYPE_LEVEL_HIGH>;
116                         dmas = <&audma0 0x8d>, <&audma1 0xb0>;
117                         dma-names = "rx", "tx";
118                 };
119                 src5: src@5 {
120                         interrupts = <0 357 IRQ_TYPE_LEVEL_HIGH>;
121                         dmas = <&audma0 0x8f>, <&audma1 0xb2>;
122                         dma-names = "rx", "tx";
123                 };
124                 src6: src@6 {
125                         interrupts = <0 358 IRQ_TYPE_LEVEL_HIGH>;
126                         dmas = <&audma0 0x91>, <&audma1 0xb4>;
127                         dma-names = "rx", "tx";
128                 };
129                 src7: src@7 {
130                         interrupts = <0 359 IRQ_TYPE_LEVEL_HIGH>;
131                         dmas = <&audma0 0x93>, <&audma1 0xb6>;
132                         dma-names = "rx", "tx";
133                 };
134                 src8: src@8 {
135                         interrupts = <0 360 IRQ_TYPE_LEVEL_HIGH>;
136                         dmas = <&audma0 0x95>, <&audma1 0xb8>;
137                         dma-names = "rx", "tx";
138                 };
139                 src9: src@9 {
140                         interrupts = <0 361 IRQ_TYPE_LEVEL_HIGH>;
141                         dmas = <&audma0 0x97>, <&audma1 0xba>;
142                         dma-names = "rx", "tx";
143                 };
144         };
145
146         rcar_sound,ssi {
147                 ssi0: ssi@0 {
148                         interrupts = <0 370 IRQ_TYPE_LEVEL_HIGH>;
149                         dmas = <&audma0 0x01>, <&audma1 0x02>, <&audma0 0x15>, <&audma1 0x16>;
150                         dma-names = "rx", "tx", "rxu", "txu";
151                 };
152                 ssi1: ssi@1 {
153                         interrupts = <0 371 IRQ_TYPE_LEVEL_HIGH>;
154                         dmas = <&audma0 0x03>, <&audma1 0x04>, <&audma0 0x49>, <&audma1 0x4a>;
155                         dma-names = "rx", "tx", "rxu", "txu";
156                 };
157                 ssi2: ssi@2 {
158                         interrupts = <0 372 IRQ_TYPE_LEVEL_HIGH>;
159                         dmas = <&audma0 0x05>, <&audma1 0x06>, <&audma0 0x63>, <&audma1 0x64>;
160                         dma-names = "rx", "tx", "rxu", "txu";
161                 };
162                 ssi3: ssi@3 {
163                         interrupts = <0 373 IRQ_TYPE_LEVEL_HIGH>;
164                         dmas = <&audma0 0x07>, <&audma1 0x08>, <&audma0 0x6f>, <&audma1 0x70>;
165                         dma-names = "rx", "tx", "rxu", "txu";
166                 };
167                 ssi4: ssi@4 {
168                         interrupts = <0 374 IRQ_TYPE_LEVEL_HIGH>;
169                         dmas = <&audma0 0x09>, <&audma1 0x0a>, <&audma0 0x71>, <&audma1 0x72>;
170                         dma-names = "rx", "tx", "rxu", "txu";
171                 };
172                 ssi5: ssi@5 {
173                         interrupts = <0 375 IRQ_TYPE_LEVEL_HIGH>;
174                         dmas = <&audma0 0x0b>, <&audma1 0x0c>, <&audma0 0x73>, <&audma1 0x74>;
175                         dma-names = "rx", "tx", "rxu", "txu";
176                 };
177                 ssi6: ssi@6 {
178                         interrupts = <0 376 IRQ_TYPE_LEVEL_HIGH>;
179                         dmas = <&audma0 0x0d>, <&audma1 0x0e>, <&audma0 0x75>, <&audma1 0x76>;
180                         dma-names = "rx", "tx", "rxu", "txu";
181                 };
182                 ssi7: ssi@7 {
183                         interrupts = <0 377 IRQ_TYPE_LEVEL_HIGH>;
184                         dmas = <&audma0 0x0f>, <&audma1 0x10>, <&audma0 0x79>, <&audma1 0x7a>;
185                         dma-names = "rx", "tx", "rxu", "txu";
186                 };
187                 ssi8: ssi@8 {
188                         interrupts = <0 378 IRQ_TYPE_LEVEL_HIGH>;
189                         dmas = <&audma0 0x11>, <&audma1 0x12>, <&audma0 0x7b>, <&audma1 0x7c>;
190                         dma-names = "rx", "tx", "rxu", "txu";
191                 };
192                 ssi9: ssi@9 {
193                         interrupts = <0 379 IRQ_TYPE_LEVEL_HIGH>;
194                         dmas = <&audma0 0x13>, <&audma1 0x14>, <&audma0 0x7d>, <&audma1 0x7e>;
195                         dma-names = "rx", "tx", "rxu", "txu";
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 };