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-r8a77470" (RZ/G1C)
270 - "renesas,rcar_sound-r8a774a1" (RZ/G2M)
271 - "renesas,rcar_sound-r8a774c0" (RZ/G2E)
272 - "renesas,rcar_sound-r8a7778" (R-Car M1A)
273 - "renesas,rcar_sound-r8a7779" (R-Car H1)
274 - "renesas,rcar_sound-r8a7790" (R-Car H2)
275 - "renesas,rcar_sound-r8a7791" (R-Car M2-W)
276 - "renesas,rcar_sound-r8a7793" (R-Car M2-N)
277 - "renesas,rcar_sound-r8a7794" (R-Car E2)
278 - "renesas,rcar_sound-r8a7795" (R-Car H3)
279 - "renesas,rcar_sound-r8a7796" (R-Car M3-W)
280 - "renesas,rcar_sound-r8a77965" (R-Car M3-N)
281 - "renesas,rcar_sound-r8a77990" (R-Car E3)
282 - "renesas,rcar_sound-r8a77995" (R-Car D3)
283 - reg : Should contain the register physical address.
285 SRU/ADG/SSI if generation1
286 SRU/ADG/SSIU/SSI/AUDIO-DMAC-periperi if generation2/generation3
287 Select extended AUDIO-DMAC-periperi address if SoC has it,
288 otherwise select normal AUDIO-DMAC-periperi address.
289 - reg-names : Should contain the register names.
290 scu/adg/ssi if generation1
291 scu/adg/ssiu/ssi/audmapp if generation2/generation3
292 - rcar_sound,ssi : Should contain SSI feature.
293 The number of SSI subnode should be same as HW.
294 see below for detail.
295 - rcar_sound,ssiu : Should contain SSIU feature.
296 The number of SSIU subnode should be same as HW.
297 see below for detail.
298 - rcar_sound,src : Should contain SRC feature.
299 The number of SRC subnode should be same as HW.
300 see below for detail.
301 - rcar_sound,ctu : Should contain CTU feature.
302 The number of CTU subnode should be same as HW.
303 see below for detail.
304 - rcar_sound,mix : Should contain MIX feature.
305 The number of MIX subnode should be same as HW.
306 see below for detail.
307 - rcar_sound,dvc : Should contain DVC feature.
308 The number of DVC subnode should be same as HW.
309 see below for detail.
310 - rcar_sound,dai : DAI contents.
311 The number of DAI subnode should be same as HW.
312 see below for detail.
313 - #sound-dai-cells : it must be 0 if your system is using single DAI
314 it must be 1 if your system is using multi DAI
315 - clocks : References to SSI/SRC/MIX/CTU/DVC/AUDIO_CLK clocks.
316 - clock-names : List of necessary clock names.
317 "ssi-all", "ssi.X", "src.X", "mix.X", "ctu.X",
318 "dvc.X", "clk_a", "clk_b", "clk_c", "clk_i"
321 - #clock-cells : it must be 0 if your system has audio_clkout
322 it must be 1 if your system has audio_clkout0/1/2/3
323 - clock-frequency : for all audio_clkout0/1/2/3
324 - clkout-lr-asynchronous : boolean property. it indicates that audio_clkoutn
325 is asynchronizes with lr-clock.
326 - resets : References to SSI resets.
327 - reset-names : List of valid reset names.
330 SSI subnode properties:
331 - interrupts : Should contain SSI interrupt for PIO transfer
332 - shared-pin : if shared clock pin
333 - pio-transfer : use PIO transfer mode
334 - no-busif : BUSIF is not ussed when [mem -> SSI] via DMA case
335 - dma : Should contain Audio DMAC entry
336 - dma-names : SSI case "rx" (=playback), "tx" (=capture)
337 Deprecated: see SSIU subnode properties
338 SSIU case "rxu" (=playback), "txu" (=capture)
340 SSIU subnode properties:
341 - dma : Should contain Audio DMAC entry
342 - dma-names : "rx" (=playback), "tx" (=capture)
344 SRC subnode properties:
345 - dma : Should contain Audio DMAC entry
346 - dma-names : "rx" (=playback), "tx" (=capture)
348 DVC subnode properties:
349 - dma : Should contain Audio DMAC entry
350 - dma-names : "tx" (=playback/capture)
352 DAI subnode properties:
353 - playback : list of playback modules
354 - capture : list of capture modules
357 =============================================
359 =============================================
361 rcar_sound: sound@ec500000 {
362 #sound-dai-cells = <1>;
363 compatible = "renesas,rcar_sound-r8a7791", "renesas,rcar_sound-gen2";
364 reg = <0 0xec500000 0 0x1000>, /* SCU */
365 <0 0xec5a0000 0 0x100>, /* ADG */
366 <0 0xec540000 0 0x1000>, /* SSIU */
367 <0 0xec541000 0 0x1280>, /* SSI */
368 <0 0xec740000 0 0x200>; /* Audio DMAC peri peri*/
369 reg-names = "scu", "adg", "ssiu", "ssi", "audmapp";
371 clocks = <&mstp10_clks R8A7790_CLK_SSI_ALL>,
372 <&mstp10_clks R8A7790_CLK_SSI9>, <&mstp10_clks R8A7790_CLK_SSI8>,
373 <&mstp10_clks R8A7790_CLK_SSI7>, <&mstp10_clks R8A7790_CLK_SSI6>,
374 <&mstp10_clks R8A7790_CLK_SSI5>, <&mstp10_clks R8A7790_CLK_SSI4>,
375 <&mstp10_clks R8A7790_CLK_SSI3>, <&mstp10_clks R8A7790_CLK_SSI2>,
376 <&mstp10_clks R8A7790_CLK_SSI1>, <&mstp10_clks R8A7790_CLK_SSI0>,
377 <&mstp10_clks R8A7790_CLK_SCU_SRC9>, <&mstp10_clks R8A7790_CLK_SCU_SRC8>,
378 <&mstp10_clks R8A7790_CLK_SCU_SRC7>, <&mstp10_clks R8A7790_CLK_SCU_SRC6>,
379 <&mstp10_clks R8A7790_CLK_SCU_SRC5>, <&mstp10_clks R8A7790_CLK_SCU_SRC4>,
380 <&mstp10_clks R8A7790_CLK_SCU_SRC3>, <&mstp10_clks R8A7790_CLK_SCU_SRC2>,
381 <&mstp10_clks R8A7790_CLK_SCU_SRC1>, <&mstp10_clks R8A7790_CLK_SCU_SRC0>,
382 <&mstp10_clks R8A7790_CLK_SCU_DVC0>, <&mstp10_clks R8A7790_CLK_SCU_DVC1>,
383 <&audio_clk_a>, <&audio_clk_b>, <&audio_clk_c>, <&m2_clk>;
384 clock-names = "ssi-all",
385 "ssi.9", "ssi.8", "ssi.7", "ssi.6", "ssi.5",
386 "ssi.4", "ssi.3", "ssi.2", "ssi.1", "ssi.0",
387 "src.9", "src.8", "src.7", "src.6", "src.5",
388 "src.4", "src.3", "src.2", "src.1", "src.0",
390 "clk_a", "clk_b", "clk_c", "clk_i";
394 dmas = <&audma0 0xbc>;
398 dmas = <&audma0 0xbe>;
421 interrupts = <0 352 IRQ_TYPE_LEVEL_HIGH>;
422 dmas = <&audma0 0x85>, <&audma1 0x9a>;
423 dma-names = "rx", "tx";
426 interrupts = <0 353 IRQ_TYPE_LEVEL_HIGH>;
427 dmas = <&audma0 0x87>, <&audma1 0x9c>;
428 dma-names = "rx", "tx";
431 interrupts = <0 354 IRQ_TYPE_LEVEL_HIGH>;
432 dmas = <&audma0 0x89>, <&audma1 0x9e>;
433 dma-names = "rx", "tx";
436 interrupts = <0 355 IRQ_TYPE_LEVEL_HIGH>;
437 dmas = <&audma0 0x8b>, <&audma1 0xa0>;
438 dma-names = "rx", "tx";
441 interrupts = <0 356 IRQ_TYPE_LEVEL_HIGH>;
442 dmas = <&audma0 0x8d>, <&audma1 0xb0>;
443 dma-names = "rx", "tx";
446 interrupts = <0 357 IRQ_TYPE_LEVEL_HIGH>;
447 dmas = <&audma0 0x8f>, <&audma1 0xb2>;
448 dma-names = "rx", "tx";
451 interrupts = <0 358 IRQ_TYPE_LEVEL_HIGH>;
452 dmas = <&audma0 0x91>, <&audma1 0xb4>;
453 dma-names = "rx", "tx";
456 interrupts = <0 359 IRQ_TYPE_LEVEL_HIGH>;
457 dmas = <&audma0 0x93>, <&audma1 0xb6>;
458 dma-names = "rx", "tx";
461 interrupts = <0 360 IRQ_TYPE_LEVEL_HIGH>;
462 dmas = <&audma0 0x95>, <&audma1 0xb8>;
463 dma-names = "rx", "tx";
466 interrupts = <0 361 IRQ_TYPE_LEVEL_HIGH>;
467 dmas = <&audma0 0x97>, <&audma1 0xba>;
468 dma-names = "rx", "tx";
474 dmas = <&audma0 0x15>, <&audma1 0x16>;
475 dma-names = "rx", "tx";
478 dmas = <&audma0 0x35>, <&audma1 0x36>;
479 dma-names = "rx", "tx";
485 dmas = <&audma0 0xA5>, <&audma1 0xA6>;
486 dma-names = "rx", "tx";
489 dmas = <&audma0 0xA7>, <&audma1 0xA8>;
490 dma-names = "rx", "tx";
493 dmas = <&audma0 0xA9>, <&audma1 0xAA>;
494 dma-names = "rx", "tx";
500 interrupts = <0 370 IRQ_TYPE_LEVEL_HIGH>;
501 dmas = <&audma0 0x01>, <&audma1 0x02>;
502 dma-names = "rx", "tx";
505 interrupts = <0 371 IRQ_TYPE_LEVEL_HIGH>;
506 dmas = <&audma0 0x03>, <&audma1 0x04>;
507 dma-names = "rx", "tx";
513 interrupts = <0 378 IRQ_TYPE_LEVEL_HIGH>;
514 dmas = <&audma0 0x11>, <&audma1 0x12>;
515 dma-names = "rx", "tx";
518 interrupts = <0 379 IRQ_TYPE_LEVEL_HIGH>;
519 dmas = <&audma0 0x13>, <&audma1 0x14>;
520 dma-names = "rx", "tx";
526 playback = <&ssi5 &src5>;
544 =============================================
545 Example: simple sound card
546 =============================================
549 compatible = "simple-audio-card";
551 simple-audio-card,format = "left_j";
552 simple-audio-card,bitclock-master = <&sndcodec>;
553 simple-audio-card,frame-master = <&sndcodec>;
555 sndcpu: simple-audio-card,cpu {
556 sound-dai = <&rcar_sound>;
559 sndcodec: simple-audio-card,codec {
560 sound-dai = <&ak4643>;
561 clocks = <&audio_clock>;
566 pinctrl-0 = <&sound_pins &sound_clk_pins>;
567 pinctrl-names = "default";
570 #sound-dai-cells = <0>;
575 playback = <&ssi0 &src2 &dvc0>;
576 capture = <&ssi1 &src3 &dvc1>;
585 =============================================
586 Example: simple sound card for Asynchronous mode
587 =============================================
590 compatible = "simple-scu-audio-card";
593 * SRC Asynchronous mode setting
595 * All input data will be converted to 48kHz
597 * Inputed 48kHz data will be converted to
598 * system specified Hz
600 simple-audio-card,convert-rate = <48000>;
602 simple-audio-card,cpu {
603 sound-dai = <&rcar_sound>;
605 simple-audio-card,codec {
610 =============================================
611 Example: simple sound card for channel convert
612 =============================================
615 compatible = "simple-scu-audio-card";
619 * All input data will be converted to 2ch
622 simple-audio-card,convert-channels = <2>;
624 simple-audio-card,cpu {
625 sound-dai = <&rcar_sound>;
627 simple-audio-card,codec {
632 =============================================
633 Example: simple sound card for MIXer
634 =============================================
637 compatible = "simple-scu-audio-card";
639 simple-audio-card,cpu@0 {
640 sound-dai = <&rcar_sound 0>;
642 simple-audio-card,cpu@1 {
643 sound-dai = <&rcar_sound 1>;
645 simple-audio-card,codec {
654 playback = <&src1 &ctu02 &mix0 &dvc0 &ssi0>;
657 playback = <&src2 &ctu03 &mix0 &dvc0 &ssi0>;
662 =============================================
663 Example: simple sound card for TDM
664 =============================================
667 compatible = "simple-audio-card";
669 simple-audio-card,format = "left_j";
670 simple-audio-card,bitclock-master = <&sndcodec>;
671 simple-audio-card,frame-master = <&sndcodec>;
673 sndcpu: simple-audio-card,cpu {
674 sound-dai = <&rcar_sound>;
675 dai-tdm-slot-num = <6>;
678 sndcodec: simple-audio-card,codec {
683 =============================================
684 Example: simple sound card for TDM Split
685 =============================================
688 compatible = "audio-graph-scu-card";
690 routing = "xxxx Playback", "DAI0 Playback",
691 "xxxx Playback", "DAI1 Playback",
692 "xxxx Playback", "DAI2 Playback",
693 "xxxx Playback", "DAI3 Playback";
694 convert-channels = <8>; /* TDM Split */
696 dais = <&rsnd_port0 /* playback ch1/ch2 */
697 &rsnd_port1 /* playback ch3/ch4 */
698 &rsnd_port2 /* playback ch5/ch6 */
699 &rsnd_port3 /* playback ch7/ch8 */
706 codec_0: endpoint@1 {
707 remote-endpoint = <&rsnd_ep0>;
709 codec_1: endpoint@2 {
710 remote-endpoint = <&rsnd_ep1>;
712 codec_2: endpoint@3 {
713 remote-endpoint = <&rsnd_ep2>;
715 codec_3: endpoint@4 {
716 remote-endpoint = <&rsnd_ep3>;
726 remote-endpoint = <&codec_0>;
728 playback = <&ssiu30 &ssi3>;
733 remote-endpoint = <&codec_1>;
735 playback = <&ssiu31 &ssi3>;
740 remote-endpoint = <&codec_2>;
742 playback = <&ssiu32 &ssi3>;
747 remote-endpoint = <&codec_3>;
749 playback = <&ssiu33 &ssi3>;
755 =============================================
756 Example: simple sound card for Multi channel
757 =============================================
760 pinctrl-0 = <&sound_pins &sound_clk_pins>;
761 pinctrl-names = "default";
764 #sound-dai-cells = <0>;
769 playback = <&ssi0 &ssi1 &ssi2 &src0 &dvc0>;