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-r8a7742" (RZ/G1H)
267 - "renesas,rcar_sound-r8a7743" (RZ/G1M)
268 - "renesas,rcar_sound-r8a7744" (RZ/G1N)
269 - "renesas,rcar_sound-r8a7745" (RZ/G1E)
270 - "renesas,rcar_sound-r8a77470" (RZ/G1C)
271 - "renesas,rcar_sound-r8a774a1" (RZ/G2M)
272 - "renesas,rcar_sound-r8a774b1" (RZ/G2N)
273 - "renesas,rcar_sound-r8a774c0" (RZ/G2E)
274 - "renesas,rcar_sound-r8a774e1" (RZ/G2H)
275 - "renesas,rcar_sound-r8a7778" (R-Car M1A)
276 - "renesas,rcar_sound-r8a7779" (R-Car H1)
277 - "renesas,rcar_sound-r8a7790" (R-Car H2)
278 - "renesas,rcar_sound-r8a7791" (R-Car M2-W)
279 - "renesas,rcar_sound-r8a7793" (R-Car M2-N)
280 - "renesas,rcar_sound-r8a7794" (R-Car E2)
281 - "renesas,rcar_sound-r8a7795" (R-Car H3)
282 - "renesas,rcar_sound-r8a7796" (R-Car M3-W)
283 - "renesas,rcar_sound-r8a77965" (R-Car M3-N)
284 - "renesas,rcar_sound-r8a77990" (R-Car E3)
285 - "renesas,rcar_sound-r8a77995" (R-Car D3)
286 - reg : Should contain the register physical address.
288 SRU/ADG/SSI if generation1
289 SRU/ADG/SSIU/SSI/AUDIO-DMAC-periperi if generation2/generation3
290 Select extended AUDIO-DMAC-periperi address if SoC has it,
291 otherwise select normal AUDIO-DMAC-periperi address.
292 - reg-names : Should contain the register names.
293 scu/adg/ssi if generation1
294 scu/adg/ssiu/ssi/audmapp if generation2/generation3
295 - rcar_sound,ssi : Should contain SSI feature.
296 The number of SSI subnode should be same as HW.
297 see below for detail.
298 - rcar_sound,ssiu : Should contain SSIU feature.
299 The number of SSIU subnode should be same as HW.
300 see below for detail.
301 - rcar_sound,src : Should contain SRC feature.
302 The number of SRC subnode should be same as HW.
303 see below for detail.
304 - rcar_sound,ctu : Should contain CTU feature.
305 The number of CTU subnode should be same as HW.
306 see below for detail.
307 - rcar_sound,mix : Should contain MIX feature.
308 The number of MIX subnode should be same as HW.
309 see below for detail.
310 - rcar_sound,dvc : Should contain DVC feature.
311 The number of DVC subnode should be same as HW.
312 see below for detail.
313 - rcar_sound,dai : DAI contents.
314 The number of DAI subnode should be same as HW.
315 see below for detail.
316 - #sound-dai-cells : it must be 0 if your system is using single DAI
317 it must be 1 if your system is using multi DAI
318 - clocks : References to SSI/SRC/MIX/CTU/DVC/AUDIO_CLK clocks.
319 - clock-names : List of necessary clock names.
320 "ssi-all", "ssi.X", "src.X", "mix.X", "ctu.X",
321 "dvc.X", "clk_a", "clk_b", "clk_c", "clk_i"
324 - #clock-cells : it must be 0 if your system has audio_clkout
325 it must be 1 if your system has audio_clkout0/1/2/3
326 - clock-frequency : for all audio_clkout0/1/2/3
327 - clkout-lr-asynchronous : boolean property. it indicates that audio_clkoutn
328 is asynchronizes with lr-clock.
329 - resets : References to SSI resets.
330 - reset-names : List of valid reset names.
333 SSI subnode properties:
334 - interrupts : Should contain SSI interrupt for PIO transfer
335 - shared-pin : if shared clock pin
336 - pio-transfer : use PIO transfer mode
337 - no-busif : BUSIF is not ussed when [mem -> SSI] via DMA case
338 - dma : Should contain Audio DMAC entry
339 - dma-names : SSI case "rx" (=playback), "tx" (=capture)
340 Deprecated: see SSIU subnode properties
341 SSIU case "rxu" (=playback), "txu" (=capture)
343 SSIU subnode properties:
344 - dma : Should contain Audio DMAC entry
345 - dma-names : "rx" (=playback), "tx" (=capture)
347 SRC subnode properties:
348 - dma : Should contain Audio DMAC entry
349 - dma-names : "rx" (=playback), "tx" (=capture)
351 DVC subnode properties:
352 - dma : Should contain Audio DMAC entry
353 - dma-names : "tx" (=playback/capture)
355 DAI subnode properties:
356 - playback : list of playback modules
357 - capture : list of capture modules
360 =============================================
362 =============================================
364 rcar_sound: sound@ec500000 {
365 #sound-dai-cells = <1>;
366 compatible = "renesas,rcar_sound-r8a7791", "renesas,rcar_sound-gen2";
367 reg = <0 0xec500000 0 0x1000>, /* SCU */
368 <0 0xec5a0000 0 0x100>, /* ADG */
369 <0 0xec540000 0 0x1000>, /* SSIU */
370 <0 0xec541000 0 0x1280>, /* SSI */
371 <0 0xec740000 0 0x200>; /* Audio DMAC peri peri*/
372 reg-names = "scu", "adg", "ssiu", "ssi", "audmapp";
374 clocks = <&mstp10_clks R8A7790_CLK_SSI_ALL>,
375 <&mstp10_clks R8A7790_CLK_SSI9>, <&mstp10_clks R8A7790_CLK_SSI8>,
376 <&mstp10_clks R8A7790_CLK_SSI7>, <&mstp10_clks R8A7790_CLK_SSI6>,
377 <&mstp10_clks R8A7790_CLK_SSI5>, <&mstp10_clks R8A7790_CLK_SSI4>,
378 <&mstp10_clks R8A7790_CLK_SSI3>, <&mstp10_clks R8A7790_CLK_SSI2>,
379 <&mstp10_clks R8A7790_CLK_SSI1>, <&mstp10_clks R8A7790_CLK_SSI0>,
380 <&mstp10_clks R8A7790_CLK_SCU_SRC9>, <&mstp10_clks R8A7790_CLK_SCU_SRC8>,
381 <&mstp10_clks R8A7790_CLK_SCU_SRC7>, <&mstp10_clks R8A7790_CLK_SCU_SRC6>,
382 <&mstp10_clks R8A7790_CLK_SCU_SRC5>, <&mstp10_clks R8A7790_CLK_SCU_SRC4>,
383 <&mstp10_clks R8A7790_CLK_SCU_SRC3>, <&mstp10_clks R8A7790_CLK_SCU_SRC2>,
384 <&mstp10_clks R8A7790_CLK_SCU_SRC1>, <&mstp10_clks R8A7790_CLK_SCU_SRC0>,
385 <&mstp10_clks R8A7790_CLK_SCU_DVC0>, <&mstp10_clks R8A7790_CLK_SCU_DVC1>,
386 <&audio_clk_a>, <&audio_clk_b>, <&audio_clk_c>, <&m2_clk>;
387 clock-names = "ssi-all",
388 "ssi.9", "ssi.8", "ssi.7", "ssi.6", "ssi.5",
389 "ssi.4", "ssi.3", "ssi.2", "ssi.1", "ssi.0",
390 "src.9", "src.8", "src.7", "src.6", "src.5",
391 "src.4", "src.3", "src.2", "src.1", "src.0",
393 "clk_a", "clk_b", "clk_c", "clk_i";
397 dmas = <&audma0 0xbc>;
401 dmas = <&audma0 0xbe>;
424 interrupts = <0 352 IRQ_TYPE_LEVEL_HIGH>;
425 dmas = <&audma0 0x85>, <&audma1 0x9a>;
426 dma-names = "rx", "tx";
429 interrupts = <0 353 IRQ_TYPE_LEVEL_HIGH>;
430 dmas = <&audma0 0x87>, <&audma1 0x9c>;
431 dma-names = "rx", "tx";
434 interrupts = <0 354 IRQ_TYPE_LEVEL_HIGH>;
435 dmas = <&audma0 0x89>, <&audma1 0x9e>;
436 dma-names = "rx", "tx";
439 interrupts = <0 355 IRQ_TYPE_LEVEL_HIGH>;
440 dmas = <&audma0 0x8b>, <&audma1 0xa0>;
441 dma-names = "rx", "tx";
444 interrupts = <0 356 IRQ_TYPE_LEVEL_HIGH>;
445 dmas = <&audma0 0x8d>, <&audma1 0xb0>;
446 dma-names = "rx", "tx";
449 interrupts = <0 357 IRQ_TYPE_LEVEL_HIGH>;
450 dmas = <&audma0 0x8f>, <&audma1 0xb2>;
451 dma-names = "rx", "tx";
454 interrupts = <0 358 IRQ_TYPE_LEVEL_HIGH>;
455 dmas = <&audma0 0x91>, <&audma1 0xb4>;
456 dma-names = "rx", "tx";
459 interrupts = <0 359 IRQ_TYPE_LEVEL_HIGH>;
460 dmas = <&audma0 0x93>, <&audma1 0xb6>;
461 dma-names = "rx", "tx";
464 interrupts = <0 360 IRQ_TYPE_LEVEL_HIGH>;
465 dmas = <&audma0 0x95>, <&audma1 0xb8>;
466 dma-names = "rx", "tx";
469 interrupts = <0 361 IRQ_TYPE_LEVEL_HIGH>;
470 dmas = <&audma0 0x97>, <&audma1 0xba>;
471 dma-names = "rx", "tx";
477 dmas = <&audma0 0x15>, <&audma1 0x16>;
478 dma-names = "rx", "tx";
481 dmas = <&audma0 0x35>, <&audma1 0x36>;
482 dma-names = "rx", "tx";
488 dmas = <&audma0 0xA5>, <&audma1 0xA6>;
489 dma-names = "rx", "tx";
492 dmas = <&audma0 0xA7>, <&audma1 0xA8>;
493 dma-names = "rx", "tx";
496 dmas = <&audma0 0xA9>, <&audma1 0xAA>;
497 dma-names = "rx", "tx";
503 interrupts = <0 370 IRQ_TYPE_LEVEL_HIGH>;
504 dmas = <&audma0 0x01>, <&audma1 0x02>;
505 dma-names = "rx", "tx";
508 interrupts = <0 371 IRQ_TYPE_LEVEL_HIGH>;
509 dmas = <&audma0 0x03>, <&audma1 0x04>;
510 dma-names = "rx", "tx";
516 interrupts = <0 378 IRQ_TYPE_LEVEL_HIGH>;
517 dmas = <&audma0 0x11>, <&audma1 0x12>;
518 dma-names = "rx", "tx";
521 interrupts = <0 379 IRQ_TYPE_LEVEL_HIGH>;
522 dmas = <&audma0 0x13>, <&audma1 0x14>;
523 dma-names = "rx", "tx";
529 playback = <&ssi5 &src5>;
547 =============================================
548 Example: simple sound card
549 =============================================
552 compatible = "simple-audio-card";
554 simple-audio-card,format = "left_j";
555 simple-audio-card,bitclock-master = <&sndcodec>;
556 simple-audio-card,frame-master = <&sndcodec>;
558 sndcpu: simple-audio-card,cpu {
559 sound-dai = <&rcar_sound>;
562 sndcodec: simple-audio-card,codec {
563 sound-dai = <&ak4643>;
564 clocks = <&audio_clock>;
569 pinctrl-0 = <&sound_pins &sound_clk_pins>;
570 pinctrl-names = "default";
573 #sound-dai-cells = <0>;
578 playback = <&ssi0 &src2 &dvc0>;
579 capture = <&ssi1 &src3 &dvc1>;
588 =============================================
589 Example: simple sound card for Asynchronous mode
590 =============================================
593 compatible = "simple-scu-audio-card";
596 * SRC Asynchronous mode setting
598 * All input data will be converted to 48kHz
600 * Inputed 48kHz data will be converted to
601 * system specified Hz
603 simple-audio-card,convert-rate = <48000>;
605 simple-audio-card,cpu {
606 sound-dai = <&rcar_sound>;
608 simple-audio-card,codec {
613 =============================================
614 Example: simple sound card for channel convert
615 =============================================
618 compatible = "simple-scu-audio-card";
622 * All input data will be converted to 2ch
625 simple-audio-card,convert-channels = <2>;
627 simple-audio-card,cpu {
628 sound-dai = <&rcar_sound>;
630 simple-audio-card,codec {
635 =============================================
636 Example: simple sound card for MIXer
637 =============================================
640 compatible = "simple-scu-audio-card";
642 simple-audio-card,cpu@0 {
643 sound-dai = <&rcar_sound 0>;
645 simple-audio-card,cpu@1 {
646 sound-dai = <&rcar_sound 1>;
648 simple-audio-card,codec {
657 playback = <&src1 &ctu02 &mix0 &dvc0 &ssi0>;
660 playback = <&src2 &ctu03 &mix0 &dvc0 &ssi0>;
665 =============================================
666 Example: simple sound card for TDM
667 =============================================
670 compatible = "simple-audio-card";
672 simple-audio-card,format = "left_j";
673 simple-audio-card,bitclock-master = <&sndcodec>;
674 simple-audio-card,frame-master = <&sndcodec>;
676 sndcpu: simple-audio-card,cpu {
677 sound-dai = <&rcar_sound>;
678 dai-tdm-slot-num = <6>;
681 sndcodec: simple-audio-card,codec {
686 =============================================
687 Example: simple sound card for TDM Split
688 =============================================
691 compatible = "audio-graph-scu-card";
693 routing = "xxxx Playback", "DAI0 Playback",
694 "xxxx Playback", "DAI1 Playback",
695 "xxxx Playback", "DAI2 Playback",
696 "xxxx Playback", "DAI3 Playback";
697 convert-channels = <8>; /* TDM Split */
699 dais = <&rsnd_port0 /* playback ch1/ch2 */
700 &rsnd_port1 /* playback ch3/ch4 */
701 &rsnd_port2 /* playback ch5/ch6 */
702 &rsnd_port3 /* playback ch7/ch8 */
709 codec_0: endpoint@1 {
710 remote-endpoint = <&rsnd_ep0>;
712 codec_1: endpoint@2 {
713 remote-endpoint = <&rsnd_ep1>;
715 codec_2: endpoint@3 {
716 remote-endpoint = <&rsnd_ep2>;
718 codec_3: endpoint@4 {
719 remote-endpoint = <&rsnd_ep3>;
729 remote-endpoint = <&codec_0>;
731 playback = <&ssiu30 &ssi3>;
736 remote-endpoint = <&codec_1>;
738 playback = <&ssiu31 &ssi3>;
743 remote-endpoint = <&codec_2>;
745 playback = <&ssiu32 &ssi3>;
750 remote-endpoint = <&codec_3>;
752 playback = <&ssiu33 &ssi3>;
758 =============================================
759 Example: simple sound card for Multi channel
760 =============================================
763 pinctrl-0 = <&sound_pins &sound_clk_pins>;
764 pinctrl-names = "default";
767 #sound-dai-cells = <0>;
772 playback = <&ssi0 &ssi1 &ssi2 &src0 &dvc0>;