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-r8a774b1" (RZ/G2N)
272 - "renesas,rcar_sound-r8a774c0" (RZ/G2E)
273 - "renesas,rcar_sound-r8a7778" (R-Car M1A)
274 - "renesas,rcar_sound-r8a7779" (R-Car H1)
275 - "renesas,rcar_sound-r8a7790" (R-Car H2)
276 - "renesas,rcar_sound-r8a7791" (R-Car M2-W)
277 - "renesas,rcar_sound-r8a7793" (R-Car M2-N)
278 - "renesas,rcar_sound-r8a7794" (R-Car E2)
279 - "renesas,rcar_sound-r8a7795" (R-Car H3)
280 - "renesas,rcar_sound-r8a7796" (R-Car M3-W)
281 - "renesas,rcar_sound-r8a77965" (R-Car M3-N)
282 - "renesas,rcar_sound-r8a77990" (R-Car E3)
283 - "renesas,rcar_sound-r8a77995" (R-Car D3)
284 - reg : Should contain the register physical address.
286 SRU/ADG/SSI if generation1
287 SRU/ADG/SSIU/SSI/AUDIO-DMAC-periperi if generation2/generation3
288 Select extended AUDIO-DMAC-periperi address if SoC has it,
289 otherwise select normal AUDIO-DMAC-periperi address.
290 - reg-names : Should contain the register names.
291 scu/adg/ssi if generation1
292 scu/adg/ssiu/ssi/audmapp if generation2/generation3
293 - rcar_sound,ssi : Should contain SSI feature.
294 The number of SSI subnode should be same as HW.
295 see below for detail.
296 - rcar_sound,ssiu : Should contain SSIU feature.
297 The number of SSIU subnode should be same as HW.
298 see below for detail.
299 - rcar_sound,src : Should contain SRC feature.
300 The number of SRC subnode should be same as HW.
301 see below for detail.
302 - rcar_sound,ctu : Should contain CTU feature.
303 The number of CTU subnode should be same as HW.
304 see below for detail.
305 - rcar_sound,mix : Should contain MIX feature.
306 The number of MIX subnode should be same as HW.
307 see below for detail.
308 - rcar_sound,dvc : Should contain DVC feature.
309 The number of DVC subnode should be same as HW.
310 see below for detail.
311 - rcar_sound,dai : DAI contents.
312 The number of DAI subnode should be same as HW.
313 see below for detail.
314 - #sound-dai-cells : it must be 0 if your system is using single DAI
315 it must be 1 if your system is using multi DAI
316 - clocks : References to SSI/SRC/MIX/CTU/DVC/AUDIO_CLK clocks.
317 - clock-names : List of necessary clock names.
318 "ssi-all", "ssi.X", "src.X", "mix.X", "ctu.X",
319 "dvc.X", "clk_a", "clk_b", "clk_c", "clk_i"
322 - #clock-cells : it must be 0 if your system has audio_clkout
323 it must be 1 if your system has audio_clkout0/1/2/3
324 - clock-frequency : for all audio_clkout0/1/2/3
325 - clkout-lr-asynchronous : boolean property. it indicates that audio_clkoutn
326 is asynchronizes with lr-clock.
327 - resets : References to SSI resets.
328 - reset-names : List of valid reset names.
331 SSI subnode properties:
332 - interrupts : Should contain SSI interrupt for PIO transfer
333 - shared-pin : if shared clock pin
334 - pio-transfer : use PIO transfer mode
335 - no-busif : BUSIF is not ussed when [mem -> SSI] via DMA case
336 - dma : Should contain Audio DMAC entry
337 - dma-names : SSI case "rx" (=playback), "tx" (=capture)
338 Deprecated: see SSIU subnode properties
339 SSIU case "rxu" (=playback), "txu" (=capture)
341 SSIU subnode properties:
342 - dma : Should contain Audio DMAC entry
343 - dma-names : "rx" (=playback), "tx" (=capture)
345 SRC subnode properties:
346 - dma : Should contain Audio DMAC entry
347 - dma-names : "rx" (=playback), "tx" (=capture)
349 DVC subnode properties:
350 - dma : Should contain Audio DMAC entry
351 - dma-names : "tx" (=playback/capture)
353 DAI subnode properties:
354 - playback : list of playback modules
355 - capture : list of capture modules
358 =============================================
360 =============================================
362 rcar_sound: sound@ec500000 {
363 #sound-dai-cells = <1>;
364 compatible = "renesas,rcar_sound-r8a7791", "renesas,rcar_sound-gen2";
365 reg = <0 0xec500000 0 0x1000>, /* SCU */
366 <0 0xec5a0000 0 0x100>, /* ADG */
367 <0 0xec540000 0 0x1000>, /* SSIU */
368 <0 0xec541000 0 0x1280>, /* SSI */
369 <0 0xec740000 0 0x200>; /* Audio DMAC peri peri*/
370 reg-names = "scu", "adg", "ssiu", "ssi", "audmapp";
372 clocks = <&mstp10_clks R8A7790_CLK_SSI_ALL>,
373 <&mstp10_clks R8A7790_CLK_SSI9>, <&mstp10_clks R8A7790_CLK_SSI8>,
374 <&mstp10_clks R8A7790_CLK_SSI7>, <&mstp10_clks R8A7790_CLK_SSI6>,
375 <&mstp10_clks R8A7790_CLK_SSI5>, <&mstp10_clks R8A7790_CLK_SSI4>,
376 <&mstp10_clks R8A7790_CLK_SSI3>, <&mstp10_clks R8A7790_CLK_SSI2>,
377 <&mstp10_clks R8A7790_CLK_SSI1>, <&mstp10_clks R8A7790_CLK_SSI0>,
378 <&mstp10_clks R8A7790_CLK_SCU_SRC9>, <&mstp10_clks R8A7790_CLK_SCU_SRC8>,
379 <&mstp10_clks R8A7790_CLK_SCU_SRC7>, <&mstp10_clks R8A7790_CLK_SCU_SRC6>,
380 <&mstp10_clks R8A7790_CLK_SCU_SRC5>, <&mstp10_clks R8A7790_CLK_SCU_SRC4>,
381 <&mstp10_clks R8A7790_CLK_SCU_SRC3>, <&mstp10_clks R8A7790_CLK_SCU_SRC2>,
382 <&mstp10_clks R8A7790_CLK_SCU_SRC1>, <&mstp10_clks R8A7790_CLK_SCU_SRC0>,
383 <&mstp10_clks R8A7790_CLK_SCU_DVC0>, <&mstp10_clks R8A7790_CLK_SCU_DVC1>,
384 <&audio_clk_a>, <&audio_clk_b>, <&audio_clk_c>, <&m2_clk>;
385 clock-names = "ssi-all",
386 "ssi.9", "ssi.8", "ssi.7", "ssi.6", "ssi.5",
387 "ssi.4", "ssi.3", "ssi.2", "ssi.1", "ssi.0",
388 "src.9", "src.8", "src.7", "src.6", "src.5",
389 "src.4", "src.3", "src.2", "src.1", "src.0",
391 "clk_a", "clk_b", "clk_c", "clk_i";
395 dmas = <&audma0 0xbc>;
399 dmas = <&audma0 0xbe>;
422 interrupts = <0 352 IRQ_TYPE_LEVEL_HIGH>;
423 dmas = <&audma0 0x85>, <&audma1 0x9a>;
424 dma-names = "rx", "tx";
427 interrupts = <0 353 IRQ_TYPE_LEVEL_HIGH>;
428 dmas = <&audma0 0x87>, <&audma1 0x9c>;
429 dma-names = "rx", "tx";
432 interrupts = <0 354 IRQ_TYPE_LEVEL_HIGH>;
433 dmas = <&audma0 0x89>, <&audma1 0x9e>;
434 dma-names = "rx", "tx";
437 interrupts = <0 355 IRQ_TYPE_LEVEL_HIGH>;
438 dmas = <&audma0 0x8b>, <&audma1 0xa0>;
439 dma-names = "rx", "tx";
442 interrupts = <0 356 IRQ_TYPE_LEVEL_HIGH>;
443 dmas = <&audma0 0x8d>, <&audma1 0xb0>;
444 dma-names = "rx", "tx";
447 interrupts = <0 357 IRQ_TYPE_LEVEL_HIGH>;
448 dmas = <&audma0 0x8f>, <&audma1 0xb2>;
449 dma-names = "rx", "tx";
452 interrupts = <0 358 IRQ_TYPE_LEVEL_HIGH>;
453 dmas = <&audma0 0x91>, <&audma1 0xb4>;
454 dma-names = "rx", "tx";
457 interrupts = <0 359 IRQ_TYPE_LEVEL_HIGH>;
458 dmas = <&audma0 0x93>, <&audma1 0xb6>;
459 dma-names = "rx", "tx";
462 interrupts = <0 360 IRQ_TYPE_LEVEL_HIGH>;
463 dmas = <&audma0 0x95>, <&audma1 0xb8>;
464 dma-names = "rx", "tx";
467 interrupts = <0 361 IRQ_TYPE_LEVEL_HIGH>;
468 dmas = <&audma0 0x97>, <&audma1 0xba>;
469 dma-names = "rx", "tx";
475 dmas = <&audma0 0x15>, <&audma1 0x16>;
476 dma-names = "rx", "tx";
479 dmas = <&audma0 0x35>, <&audma1 0x36>;
480 dma-names = "rx", "tx";
486 dmas = <&audma0 0xA5>, <&audma1 0xA6>;
487 dma-names = "rx", "tx";
490 dmas = <&audma0 0xA7>, <&audma1 0xA8>;
491 dma-names = "rx", "tx";
494 dmas = <&audma0 0xA9>, <&audma1 0xAA>;
495 dma-names = "rx", "tx";
501 interrupts = <0 370 IRQ_TYPE_LEVEL_HIGH>;
502 dmas = <&audma0 0x01>, <&audma1 0x02>;
503 dma-names = "rx", "tx";
506 interrupts = <0 371 IRQ_TYPE_LEVEL_HIGH>;
507 dmas = <&audma0 0x03>, <&audma1 0x04>;
508 dma-names = "rx", "tx";
514 interrupts = <0 378 IRQ_TYPE_LEVEL_HIGH>;
515 dmas = <&audma0 0x11>, <&audma1 0x12>;
516 dma-names = "rx", "tx";
519 interrupts = <0 379 IRQ_TYPE_LEVEL_HIGH>;
520 dmas = <&audma0 0x13>, <&audma1 0x14>;
521 dma-names = "rx", "tx";
527 playback = <&ssi5 &src5>;
545 =============================================
546 Example: simple sound card
547 =============================================
550 compatible = "simple-audio-card";
552 simple-audio-card,format = "left_j";
553 simple-audio-card,bitclock-master = <&sndcodec>;
554 simple-audio-card,frame-master = <&sndcodec>;
556 sndcpu: simple-audio-card,cpu {
557 sound-dai = <&rcar_sound>;
560 sndcodec: simple-audio-card,codec {
561 sound-dai = <&ak4643>;
562 clocks = <&audio_clock>;
567 pinctrl-0 = <&sound_pins &sound_clk_pins>;
568 pinctrl-names = "default";
571 #sound-dai-cells = <0>;
576 playback = <&ssi0 &src2 &dvc0>;
577 capture = <&ssi1 &src3 &dvc1>;
586 =============================================
587 Example: simple sound card for Asynchronous mode
588 =============================================
591 compatible = "simple-scu-audio-card";
594 * SRC Asynchronous mode setting
596 * All input data will be converted to 48kHz
598 * Inputed 48kHz data will be converted to
599 * system specified Hz
601 simple-audio-card,convert-rate = <48000>;
603 simple-audio-card,cpu {
604 sound-dai = <&rcar_sound>;
606 simple-audio-card,codec {
611 =============================================
612 Example: simple sound card for channel convert
613 =============================================
616 compatible = "simple-scu-audio-card";
620 * All input data will be converted to 2ch
623 simple-audio-card,convert-channels = <2>;
625 simple-audio-card,cpu {
626 sound-dai = <&rcar_sound>;
628 simple-audio-card,codec {
633 =============================================
634 Example: simple sound card for MIXer
635 =============================================
638 compatible = "simple-scu-audio-card";
640 simple-audio-card,cpu@0 {
641 sound-dai = <&rcar_sound 0>;
643 simple-audio-card,cpu@1 {
644 sound-dai = <&rcar_sound 1>;
646 simple-audio-card,codec {
655 playback = <&src1 &ctu02 &mix0 &dvc0 &ssi0>;
658 playback = <&src2 &ctu03 &mix0 &dvc0 &ssi0>;
663 =============================================
664 Example: simple sound card for TDM
665 =============================================
668 compatible = "simple-audio-card";
670 simple-audio-card,format = "left_j";
671 simple-audio-card,bitclock-master = <&sndcodec>;
672 simple-audio-card,frame-master = <&sndcodec>;
674 sndcpu: simple-audio-card,cpu {
675 sound-dai = <&rcar_sound>;
676 dai-tdm-slot-num = <6>;
679 sndcodec: simple-audio-card,codec {
684 =============================================
685 Example: simple sound card for TDM Split
686 =============================================
689 compatible = "audio-graph-scu-card";
691 routing = "xxxx Playback", "DAI0 Playback",
692 "xxxx Playback", "DAI1 Playback",
693 "xxxx Playback", "DAI2 Playback",
694 "xxxx Playback", "DAI3 Playback";
695 convert-channels = <8>; /* TDM Split */
697 dais = <&rsnd_port0 /* playback ch1/ch2 */
698 &rsnd_port1 /* playback ch3/ch4 */
699 &rsnd_port2 /* playback ch5/ch6 */
700 &rsnd_port3 /* playback ch7/ch8 */
707 codec_0: endpoint@1 {
708 remote-endpoint = <&rsnd_ep0>;
710 codec_1: endpoint@2 {
711 remote-endpoint = <&rsnd_ep1>;
713 codec_2: endpoint@3 {
714 remote-endpoint = <&rsnd_ep2>;
716 codec_3: endpoint@4 {
717 remote-endpoint = <&rsnd_ep3>;
727 remote-endpoint = <&codec_0>;
729 playback = <&ssiu30 &ssi3>;
734 remote-endpoint = <&codec_1>;
736 playback = <&ssiu31 &ssi3>;
741 remote-endpoint = <&codec_2>;
743 playback = <&ssiu32 &ssi3>;
748 remote-endpoint = <&codec_3>;
750 playback = <&ssiu33 &ssi3>;
756 =============================================
757 Example: simple sound card for Multi channel
758 =============================================
761 pinctrl-0 = <&sound_pins &sound_clk_pins>;
762 pinctrl-names = "default";
765 #sound-dai-cells = <0>;
770 playback = <&ssi0 &ssi1 &ssi2 &src0 &dvc0>;