3 =============================================
5 =============================================
7 Renesas R-Car and RZ/G sound is constructed from below modules
10 SCU : Sampling Rate Converter Unit
11 - SRC : Sampling Rate Converter
13 - CTU : Channel Transfer Unit
15 - DVC : Digital Volume and Mute Function
16 SSIU : Serial Sound Interface Unit
17 SSI : Serial Sound Interface
19 See detail of each module's channels, connection, limitation on datasheet
21 =============================================
23 =============================================
25 Multi channel is supported by Multi-SSI, or TDM-SSI.
27 Multi-SSI : 6ch case, you can use stereo x 3 SSI
28 TDM-SSI : 6ch case, you can use TDM
30 =============================================
31 * Enable/Disable each modules
32 =============================================
34 See datasheet to check SRC/CTU/MIX/DVC connect-limitation.
35 DT controls enabling/disabling module.
36 ${LINUX}/arch/arm/boot/dts/r8a7790-lager.dts can be good example.
39 Playback: [MEM] -> [SRC2] -> [DVC0] -> [SSIU0/SSI0] -> [codec]
40 Capture: [MEM] <- [DVC1] <- [SRC3] <- [SSIU1/SSI1] <- [codec]
42 see "Example: simple sound card"
45 ${LINUX}/arch/arm/boot/dts/r8a7790.dts can be good example.
47 &src0 &ctu00 &mix0 &dvc0 &ssi0
48 &src1 &ctu01 &mix1 &dvc1 &ssi1
58 =============================================
59 * SRC (Sampling Rate Converter)
60 =============================================
65 SRC can convert [xx]Hz to [yy]Hz. Then, it has below 2 modes
67 Asynchronous mode: input data / output data are based on different clocks.
68 you can use this mode on Playback / Capture
69 Synchronous mode: input data / output data are based on same clocks.
70 This mode will be used if system doesn't have its input clock,
71 for example digital TV case.
72 you can use this mode on Playback
78 You need to use "simple-scu-audio-card" or "audio-graph-scu-card" for it.
79 see "Example: simple sound card for Asynchronous mode"
85 > amixer set "SRC Out Rate" on
87 > amixer set "SRC Out Rate" 48000
88 > amixer set "SRC Out Rate" 44100
90 =============================================
91 * CTU (Channel Transfer Unit)
92 =============================================
95 ------> [CTU] -------->
97 CTU can convert [xx]ch to [yy]ch, or exchange outputed channel.
98 CTU conversion needs matrix settings.
99 For more detail information, see below
101 Renesas R-Car datasheet
102 - Sampling Rate Converter Unit (SCU)
105 - Functional Blocks in CMD
107 Renesas R-Car datasheet
108 - Sampling Rate Converter Unit (SCU)
109 - Register Description
110 - CTUn Scale Value exx Register (CTUn_SVxxR)
112 ${LINUX}/sound/soc/sh/rcar/ctu.c
115 You need to use "simple-scu-audio-card" or "audio-graph-scu-card" for it.
116 see "Example: simple sound card for channel convert"
118 Ex) Exchange output channel
123 example of using matrix
124 output 0ch = (input 0ch x 0) + (input 1ch x 1)
125 output 1ch = (input 0ch x 1) + (input 1ch x 0)
127 amixer set "CTU Reset" on
128 amixer set "CTU Pass" 9,10
129 amixer set "CTU SV0" 0,4194304
130 amixer set "CTU SV1" 4194304,0
132 example of changing connection
133 amixer set "CTU Reset" on
134 amixer set "CTU Pass" 2,1
136 =============================================
138 =============================================
140 MIX merges 2 sounds path. You can see 2 sound interface on system,
141 and these sounds will be merged by MIX.
143 aplay -D plughw:0,0 xxxx.wav &
144 aplay -D plughw:0,1 yyyy.wav
146 You need to use "simple-scu-audio-card" or "audio-graph-scu-card" for it.
148 [MEM] -> [SRC1] -> [CTU02] -+-> [MIX0] -> [DVC0] -> [SSI0]
150 [MEM] -> [SRC2] -> [CTU03] -+
152 see "Example: simple sound card for MIXer"
154 =============================================
155 * DVC (Digital Volume and Mute Function)
156 =============================================
158 DVC controls Playback/Capture volume.
161 amixer set "DVC Out" 100%
164 amixer set "DVC In" 100%
167 amixer set "DVC Out Mute" on
170 amixer set "DVC In Mute" on
173 amixer set "DVC Out Ramp Up Rate" "0.125 dB/64 steps"
174 amixer set "DVC Out Ramp Down Rate" "0.125 dB/512 steps"
175 amixer set "DVC Out Ramp" on
177 amixer set "DVC Out" 80% // Volume Down
178 amixer set "DVC Out" 100% // Volume Up
180 =============================================
181 * SSIU (Serial Sound Interface Unit)
182 =============================================
184 SSIU can avoid some under/over run error, because it has some buffer.
185 But you can't use it if SSI was PIO mode.
186 In DMA mode, you can select not to use SSIU by using "no-busif" via SSI.
188 SSIU handles BUSIF which will be used for TDM Split mode.
189 This driver is assuming that audio-graph card will be used.
191 TDM Split mode merges 4 sounds. You can see 4 sound interface on system,
192 and these sounds will be merged SSIU/SSI.
194 aplay -D plughw:0,0 xxxx.wav &
195 aplay -D plughw:0,1 xxxx.wav &
196 aplay -D plughw:0,2 xxxx.wav &
197 aplay -D plughw:0,3 xxxx.wav
200 [MEM] -> [SSIU 30] -+-> [SSIU 3] --> [Codec]
202 [MEM] -> [SSIU 31] -+
204 [MEM] -> [SSIU 32] -+
206 [MEM] -> [SSIU 33] -+
208 see "Example: simple sound card for TDM Split"
210 =============================================
211 * SSI (Serial Sound Interface)
212 =============================================
216 You can use PIO mode which is for connection check by using.
217 Note: The system will drop non-SSI modules in PIO mode
218 even though if DT is selecting other modules.
224 ** DMA mode without SSIU
226 You can use DMA without SSIU.
227 Note: under/over run, or noise are likely to occur
235 Each SSI can share WS pin. It is based on platform.
236 This is example if SSI1 want to share WS pin with SSI0
244 You can use Multi-SSI.
245 This is example of SSI0/SSI1/SSI2 (= for 6ch)
247 see "Example: simple sound card for Multi channel"
251 You can use TDM with SSI.
252 This is example of TDM 6ch.
253 Driver can automatically switches TDM <-> stereo mode in this case.
255 see "Example: simple sound card for TDM"
257 =============================================
259 =============================================
261 - compatible : "renesas,rcar_sound-<soctype>", fallbacks
262 "renesas,rcar_sound-gen1" if generation1, and
263 "renesas,rcar_sound-gen2" if generation2 (or RZ/G1)
264 "renesas,rcar_sound-gen3" if generation3 (or RZ/G2)
265 Examples with soctypes are:
266 - "renesas,rcar_sound-r8a7743" (RZ/G1M)
267 - "renesas,rcar_sound-r8a7744" (RZ/G1N)
268 - "renesas,rcar_sound-r8a7745" (RZ/G1E)
269 - "renesas,rcar_sound-r8a774a1" (RZ/G2M)
270 - "renesas,rcar_sound-r8a774c0" (RZ/G2E)
271 - "renesas,rcar_sound-r8a7778" (R-Car M1A)
272 - "renesas,rcar_sound-r8a7779" (R-Car H1)
273 - "renesas,rcar_sound-r8a7790" (R-Car H2)
274 - "renesas,rcar_sound-r8a7791" (R-Car M2-W)
275 - "renesas,rcar_sound-r8a7793" (R-Car M2-N)
276 - "renesas,rcar_sound-r8a7794" (R-Car E2)
277 - "renesas,rcar_sound-r8a7795" (R-Car H3)
278 - "renesas,rcar_sound-r8a7796" (R-Car M3-W)
279 - "renesas,rcar_sound-r8a77965" (R-Car M3-N)
280 - "renesas,rcar_sound-r8a77990" (R-Car E3)
281 - "renesas,rcar_sound-r8a77995" (R-Car D3)
282 - reg : Should contain the register physical address.
284 SRU/ADG/SSI if generation1
285 SRU/ADG/SSIU/SSI if generation2
286 - rcar_sound,ssi : Should contain SSI feature.
287 The number of SSI subnode should be same as HW.
288 see below for detail.
289 - rcar_sound,ssiu : Should contain SSIU feature.
290 The number of SSIU subnode should be same as HW.
291 see below for detail.
292 - rcar_sound,src : Should contain SRC feature.
293 The number of SRC subnode should be same as HW.
294 see below for detail.
295 - rcar_sound,ctu : Should contain CTU feature.
296 The number of CTU subnode should be same as HW.
297 see below for detail.
298 - rcar_sound,mix : Should contain MIX feature.
299 The number of MIX subnode should be same as HW.
300 see below for detail.
301 - rcar_sound,dvc : Should contain DVC feature.
302 The number of DVC subnode should be same as HW.
303 see below for detail.
304 - rcar_sound,dai : DAI contents.
305 The number of DAI subnode should be same as HW.
306 see below for detail.
307 - #sound-dai-cells : it must be 0 if your system is using single DAI
308 it must be 1 if your system is using multi DAI
309 - clocks : References to SSI/SRC/MIX/CTU/DVC/AUDIO_CLK clocks.
310 - clock-names : List of necessary clock names.
311 "ssi-all", "ssi.X", "src.X", "mix.X", "ctu.X",
312 "dvc.X", "clk_a", "clk_b", "clk_c", "clk_i"
315 - #clock-cells : it must be 0 if your system has audio_clkout
316 it must be 1 if your system has audio_clkout0/1/2/3
317 - clock-frequency : for all audio_clkout0/1/2/3
318 - clkout-lr-asynchronous : boolean property. it indicates that audio_clkoutn
319 is asynchronizes with lr-clock.
320 - resets : References to SSI resets.
321 - reset-names : List of valid reset names.
324 SSI subnode properties:
325 - interrupts : Should contain SSI interrupt for PIO transfer
326 - shared-pin : if shared clock pin
327 - pio-transfer : use PIO transfer mode
328 - no-busif : BUSIF is not ussed when [mem -> SSI] via DMA case
329 - dma : Should contain Audio DMAC entry
330 - dma-names : SSI case "rx" (=playback), "tx" (=capture)
331 Deprecated: see SSIU subnode properties
332 SSIU case "rxu" (=playback), "txu" (=capture)
334 SSIU subnode properties:
335 - dma : Should contain Audio DMAC entry
336 - dma-names : "rx" (=playback), "tx" (=capture)
338 SRC subnode properties:
339 - dma : Should contain Audio DMAC entry
340 - dma-names : "rx" (=playback), "tx" (=capture)
342 DVC subnode properties:
343 - dma : Should contain Audio DMAC entry
344 - dma-names : "tx" (=playback/capture)
346 DAI subnode properties:
347 - playback : list of playback modules
348 - capture : list of capture modules
351 =============================================
353 =============================================
355 rcar_sound: sound@ec500000 {
356 #sound-dai-cells = <1>;
357 compatible = "renesas,rcar_sound-r8a7791", "renesas,rcar_sound-gen2";
358 reg = <0 0xec500000 0 0x1000>, /* SCU */
359 <0 0xec5a0000 0 0x100>, /* ADG */
360 <0 0xec540000 0 0x1000>, /* SSIU */
361 <0 0xec541000 0 0x1280>, /* SSI */
362 <0 0xec740000 0 0x200>; /* Audio DMAC peri peri*/
363 reg-names = "scu", "adg", "ssiu", "ssi", "audmapp";
365 clocks = <&mstp10_clks R8A7790_CLK_SSI_ALL>,
366 <&mstp10_clks R8A7790_CLK_SSI9>, <&mstp10_clks R8A7790_CLK_SSI8>,
367 <&mstp10_clks R8A7790_CLK_SSI7>, <&mstp10_clks R8A7790_CLK_SSI6>,
368 <&mstp10_clks R8A7790_CLK_SSI5>, <&mstp10_clks R8A7790_CLK_SSI4>,
369 <&mstp10_clks R8A7790_CLK_SSI3>, <&mstp10_clks R8A7790_CLK_SSI2>,
370 <&mstp10_clks R8A7790_CLK_SSI1>, <&mstp10_clks R8A7790_CLK_SSI0>,
371 <&mstp10_clks R8A7790_CLK_SCU_SRC9>, <&mstp10_clks R8A7790_CLK_SCU_SRC8>,
372 <&mstp10_clks R8A7790_CLK_SCU_SRC7>, <&mstp10_clks R8A7790_CLK_SCU_SRC6>,
373 <&mstp10_clks R8A7790_CLK_SCU_SRC5>, <&mstp10_clks R8A7790_CLK_SCU_SRC4>,
374 <&mstp10_clks R8A7790_CLK_SCU_SRC3>, <&mstp10_clks R8A7790_CLK_SCU_SRC2>,
375 <&mstp10_clks R8A7790_CLK_SCU_SRC1>, <&mstp10_clks R8A7790_CLK_SCU_SRC0>,
376 <&mstp10_clks R8A7790_CLK_SCU_DVC0>, <&mstp10_clks R8A7790_CLK_SCU_DVC1>,
377 <&audio_clk_a>, <&audio_clk_b>, <&audio_clk_c>, <&m2_clk>;
378 clock-names = "ssi-all",
379 "ssi.9", "ssi.8", "ssi.7", "ssi.6", "ssi.5",
380 "ssi.4", "ssi.3", "ssi.2", "ssi.1", "ssi.0",
381 "src.9", "src.8", "src.7", "src.6", "src.5",
382 "src.4", "src.3", "src.2", "src.1", "src.0",
384 "clk_a", "clk_b", "clk_c", "clk_i";
388 dmas = <&audma0 0xbc>;
392 dmas = <&audma0 0xbe>;
415 interrupts = <0 352 IRQ_TYPE_LEVEL_HIGH>;
416 dmas = <&audma0 0x85>, <&audma1 0x9a>;
417 dma-names = "rx", "tx";
420 interrupts = <0 353 IRQ_TYPE_LEVEL_HIGH>;
421 dmas = <&audma0 0x87>, <&audma1 0x9c>;
422 dma-names = "rx", "tx";
425 interrupts = <0 354 IRQ_TYPE_LEVEL_HIGH>;
426 dmas = <&audma0 0x89>, <&audma1 0x9e>;
427 dma-names = "rx", "tx";
430 interrupts = <0 355 IRQ_TYPE_LEVEL_HIGH>;
431 dmas = <&audma0 0x8b>, <&audma1 0xa0>;
432 dma-names = "rx", "tx";
435 interrupts = <0 356 IRQ_TYPE_LEVEL_HIGH>;
436 dmas = <&audma0 0x8d>, <&audma1 0xb0>;
437 dma-names = "rx", "tx";
440 interrupts = <0 357 IRQ_TYPE_LEVEL_HIGH>;
441 dmas = <&audma0 0x8f>, <&audma1 0xb2>;
442 dma-names = "rx", "tx";
445 interrupts = <0 358 IRQ_TYPE_LEVEL_HIGH>;
446 dmas = <&audma0 0x91>, <&audma1 0xb4>;
447 dma-names = "rx", "tx";
450 interrupts = <0 359 IRQ_TYPE_LEVEL_HIGH>;
451 dmas = <&audma0 0x93>, <&audma1 0xb6>;
452 dma-names = "rx", "tx";
455 interrupts = <0 360 IRQ_TYPE_LEVEL_HIGH>;
456 dmas = <&audma0 0x95>, <&audma1 0xb8>;
457 dma-names = "rx", "tx";
460 interrupts = <0 361 IRQ_TYPE_LEVEL_HIGH>;
461 dmas = <&audma0 0x97>, <&audma1 0xba>;
462 dma-names = "rx", "tx";
468 dmas = <&audma0 0x15>, <&audma1 0x16>;
469 dma-names = "rx", "tx";
472 dmas = <&audma0 0x35>, <&audma1 0x36>;
473 dma-names = "rx", "tx";
479 dmas = <&audma0 0xA5>, <&audma1 0xA6>;
480 dma-names = "rx", "tx";
483 dmas = <&audma0 0xA7>, <&audma1 0xA8>;
484 dma-names = "rx", "tx";
487 dmas = <&audma0 0xA9>, <&audma1 0xAA>;
488 dma-names = "rx", "tx";
494 interrupts = <0 370 IRQ_TYPE_LEVEL_HIGH>;
495 dmas = <&audma0 0x01>, <&audma1 0x02>;
496 dma-names = "rx", "tx";
499 interrupts = <0 371 IRQ_TYPE_LEVEL_HIGH>;
500 dmas = <&audma0 0x03>, <&audma1 0x04>;
501 dma-names = "rx", "tx";
507 interrupts = <0 378 IRQ_TYPE_LEVEL_HIGH>;
508 dmas = <&audma0 0x11>, <&audma1 0x12>;
509 dma-names = "rx", "tx";
512 interrupts = <0 379 IRQ_TYPE_LEVEL_HIGH>;
513 dmas = <&audma0 0x13>, <&audma1 0x14>;
514 dma-names = "rx", "tx";
520 playback = <&ssi5 &src5>;
538 =============================================
539 Example: simple sound card
540 =============================================
543 compatible = "simple-audio-card";
545 simple-audio-card,format = "left_j";
546 simple-audio-card,bitclock-master = <&sndcodec>;
547 simple-audio-card,frame-master = <&sndcodec>;
549 sndcpu: simple-audio-card,cpu {
550 sound-dai = <&rcar_sound>;
553 sndcodec: simple-audio-card,codec {
554 sound-dai = <&ak4643>;
555 clocks = <&audio_clock>;
560 pinctrl-0 = <&sound_pins &sound_clk_pins>;
561 pinctrl-names = "default";
564 #sound-dai-cells = <0>;
569 playback = <&ssi0 &src2 &dvc0>;
570 capture = <&ssi1 &src3 &dvc1>;
579 =============================================
580 Example: simple sound card for Asynchronous mode
581 =============================================
584 compatible = "simple-scu-audio-card";
587 * SRC Asynchronous mode setting
589 * All input data will be converted to 48kHz
591 * Inputed 48kHz data will be converted to
592 * system specified Hz
594 simple-audio-card,convert-rate = <48000>;
596 simple-audio-card,cpu {
597 sound-dai = <&rcar_sound>;
599 simple-audio-card,codec {
604 =============================================
605 Example: simple sound card for channel convert
606 =============================================
609 compatible = "simple-scu-audio-card";
613 * All input data will be converted to 2ch
616 simple-audio-card,convert-channels = <2>;
618 simple-audio-card,cpu {
619 sound-dai = <&rcar_sound>;
621 simple-audio-card,codec {
626 =============================================
627 Example: simple sound card for MIXer
628 =============================================
631 compatible = "simple-scu-audio-card";
633 simple-audio-card,cpu@0 {
634 sound-dai = <&rcar_sound 0>;
636 simple-audio-card,cpu@1 {
637 sound-dai = <&rcar_sound 1>;
639 simple-audio-card,codec {
648 playback = <&src1 &ctu02 &mix0 &dvc0 &ssi0>;
651 playback = <&src2 &ctu03 &mix0 &dvc0 &ssi0>;
656 =============================================
657 Example: simple sound card for TDM
658 =============================================
661 compatible = "simple-audio-card";
663 simple-audio-card,format = "left_j";
664 simple-audio-card,bitclock-master = <&sndcodec>;
665 simple-audio-card,frame-master = <&sndcodec>;
667 sndcpu: simple-audio-card,cpu {
668 sound-dai = <&rcar_sound>;
669 dai-tdm-slot-num = <6>;
672 sndcodec: simple-audio-card,codec {
677 =============================================
678 Example: simple sound card for TDM Split
679 =============================================
682 compatible = "audio-graph-scu-card";
684 routing = "xxxx Playback", "DAI0 Playback",
685 "xxxx Playback", "DAI1 Playback",
686 "xxxx Playback", "DAI2 Playback",
687 "xxxx Playback", "DAI3 Playback";
688 convert-channels = <8>; /* TDM Split */
690 dais = <&rsnd_port0 /* playback ch1/ch2 */
691 &rsnd_port1 /* playback ch3/ch4 */
692 &rsnd_port2 /* playback ch5/ch6 */
693 &rsnd_port3 /* playback ch7/ch8 */
700 codec_0: endpoint@1 {
701 remote-endpoint = <&rsnd_ep0>;
703 codec_1: endpoint@2 {
704 remote-endpoint = <&rsnd_ep1>;
706 codec_2: endpoint@3 {
707 remote-endpoint = <&rsnd_ep2>;
709 codec_3: endpoint@4 {
710 remote-endpoint = <&rsnd_ep3>;
720 remote-endpoint = <&codec_0>;
722 playback = <&ssiu30 &ssi3>;
727 remote-endpoint = <&codec_1>;
729 playback = <&ssiu31 &ssi3>;
734 remote-endpoint = <&codec_2>;
736 playback = <&ssiu32 &ssi3>;
741 remote-endpoint = <&codec_3>;
743 playback = <&ssiu33 &ssi3>;
749 =============================================
750 Example: simple sound card for Multi channel
751 =============================================
754 pinctrl-0 = <&sound_pins &sound_clk_pins>;
755 pinctrl-names = "default";
758 #sound-dai-cells = <0>;
763 playback = <&ssi0 &ssi1 &ssi2 &src0 &dvc0>;