3 =============================================
5 =============================================
7 Renesas R-Car 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]
46 playback = <&ssi0 &src2 &dvc0>;
47 capture = <&ssi1 &src3 &dvc1>;
53 ${LINUX}/arch/arm/boot/dts/r8a7790.dts can be good example.
55 &src0 &ctu00 &mix0 &dvc0 &ssi0
56 &src1 &ctu01 &mix1 &dvc1 &ssi1
66 =============================================
67 * SRC (Sampling Rate Converter)
68 =============================================
73 SRC can convert [xx]Hz to [yy]Hz. Then, it has below 2 modes
75 Asynchronous mode: input data / output data are based on different clocks.
76 you can use this mode on Playback / Capture
77 Synchronous mode: input data / output data are based on same clocks.
78 This mode will be used if system doesn't have its input clock,
79 for example digital TV case.
80 you can use this mode on Playback
86 You need to use "simple-scu-audio-card" sound card for it.
90 compatible = "simple-scu-audio-card";
93 * SRC Asynchronous mode setting
95 * All input data will be converted to 48kHz
97 * Inputed 48kHz data will be converted to
100 simple-audio-card,convert-rate = <48000>;
102 simple-audio-card,cpu {
103 sound-dai = <&rcar_sound>;
105 simple-audio-card,codec {
114 > amixer set "SRC Out Rate" on
116 > amixer set "SRC Out Rate" 48000
117 > amixer set "SRC Out Rate" 44100
119 =============================================
120 * CTU (Channel Transfer Unit)
121 =============================================
124 ------> [CTU] -------->
126 CTU can convert [xx]ch to [yy]ch, or exchange outputed channel.
127 CTU conversion needs matrix settings.
128 For more detail information, see below
130 Renesas R-Car datasheet
131 - Sampling Rate Converter Unit (SCU)
134 - Functional Blocks in CMD
136 Renesas R-Car datasheet
137 - Sampling Rate Converter Unit (SCU)
138 - Register Description
139 - CTUn Scale Value exx Register (CTUn_SVxxR)
141 ${LINUX}/sound/soc/sh/rcar/ctu.c
144 You need to use "simple-scu-audio-card" sound card for it.
148 compatible = "simple-scu-audio-card";
152 * All input data will be converted to 2ch
155 simple-audio-card,convert-channels = <2>;
157 simple-audio-card,cpu {
158 sound-dai = <&rcar_sound>;
160 simple-audio-card,codec {
165 Ex) Exchange output channel
170 example of using matrix
171 output 0ch = (input 0ch x 0) + (input 1ch x 1)
172 output 1ch = (input 0ch x 1) + (input 1ch x 0)
174 amixer set "CTU Reset" on
175 amixer set "CTU Pass" 9,10
176 amixer set "CTU SV0" 0,4194304
177 amixer set "CTU SV1" 4194304,0
179 example of changing connection
180 amixer set "CTU Reset" on
181 amixer set "CTU Pass" 2,1
183 =============================================
185 =============================================
187 MIX merges 2 sounds path. You can see 2 sound interface on system,
188 and these sounds will be merged by MIX.
190 aplay -D plughw:0,0 xxxx.wav &
191 aplay -D plughw:0,1 yyyy.wav
193 You need to use "simple-scu-audio-card" sound card for it.
195 [MEM] -> [SRC1] -> [CTU02] -+-> [MIX0] -> [DVC0] -> [SSI0]
197 [MEM] -> [SRC2] -> [CTU03] -+
200 compatible = "simple-scu-audio-card";
202 simple-audio-card,cpu-0 {
203 sound-dai = <&rcar_sound 0>;
205 simple-audio-card,cpu-1 {
206 sound-dai = <&rcar_sound 1>;
208 simple-audio-card,codec {
217 playback = <&src1 &ctu02 &mix0 &dvc0 &ssi0>;
220 playback = <&src2 &ctu03 &mix0 &dvc0 &ssi0>;
225 =============================================
226 * DVC (Digital Volume and Mute Function)
227 =============================================
229 DVC controls Playback/Capture volume.
232 amixer set "DVC Out" 100%
235 amixer set "DVC In" 100%
238 amixer set "DVC Out Mute" on
241 amixer set "DVC In Mute" on
244 amixer set "DVC Out Ramp Up Rate" "0.125 dB/64 steps"
245 amixer set "DVC Out Ramp Down Rate" "0.125 dB/512 steps"
246 amixer set "DVC Out Ramp" on
248 amixer set "DVC Out" 80% // Volume Down
249 amixer set "DVC Out" 100% // Volume Up
251 =============================================
252 * SSIU (Serial Sound Interface Unit)
253 =============================================
255 There is no DT settings for SSIU, because SSIU will be automatically
257 SSIU can avoid some under/over run error, because it has some buffer.
258 But you can't use it if SSI was PIO mode.
259 In DMA mode, you can select not to use SSIU by using "no-busif" on DT.
265 =============================================
266 * SSI (Serial Sound Interface)
267 =============================================
271 You can use PIO mode which is for connection check by using.
272 Note: The system will drop non-SSI modules in PIO mode
273 even though if DT is selecting other modules.
279 ** DMA mode without SSIU
281 You can use DMA without SSIU.
282 Note: under/over run, or noise are likely to occur
290 Each SSI can share WS pin. It is based on platform.
291 This is example if SSI1 want to share WS pin with SSI0
299 You can use Multi-SSI.
300 This is example of SSI0/SSI1/SSI2 (= for 6ch)
306 playback = <&ssi0 &ssi1 &ssi2 &src0 &dvc0>;
313 You can use TDM with SSI.
314 This is example of TDM 6ch.
315 Driver can automatically switches TDM <-> stereo mode in this case.
318 compatible = "simple-audio-card";
320 simple-audio-card,cpu {
321 /* system can use TDM 6ch */
322 dai-tdm-slot-num = <6>;
323 sound-dai = <&rcar_sound>;
325 simple-audio-card,codec {
331 =============================================
333 =============================================
335 - compatible : "renesas,rcar_sound-<soctype>", fallbacks
336 "renesas,rcar_sound-gen1" if generation1, and
337 "renesas,rcar_sound-gen2" if generation2
338 "renesas,rcar_sound-gen3" if generation3
339 Examples with soctypes are:
340 - "renesas,rcar_sound-r8a7778" (R-Car M1A)
341 - "renesas,rcar_sound-r8a7779" (R-Car H1)
342 - "renesas,rcar_sound-r8a7790" (R-Car H2)
343 - "renesas,rcar_sound-r8a7791" (R-Car M2-W)
344 - "renesas,rcar_sound-r8a7793" (R-Car M2-N)
345 - "renesas,rcar_sound-r8a7794" (R-Car E2)
346 - "renesas,rcar_sound-r8a7795" (R-Car H3)
347 - reg : Should contain the register physical address.
349 SRU/ADG/SSI if generation1
350 SRU/ADG/SSIU/SSI if generation2
351 - rcar_sound,ssi : Should contain SSI feature.
352 The number of SSI subnode should be same as HW.
353 see below for detail.
354 - rcar_sound,src : Should contain SRC feature.
355 The number of SRC subnode should be same as HW.
356 see below for detail.
357 - rcar_sound,ctu : Should contain CTU feature.
358 The number of CTU subnode should be same as HW.
359 see below for detail.
360 - rcar_sound,mix : Should contain MIX feature.
361 The number of MIX subnode should be same as HW.
362 see below for detail.
363 - rcar_sound,dvc : Should contain DVC feature.
364 The number of DVC subnode should be same as HW.
365 see below for detail.
366 - rcar_sound,dai : DAI contents.
367 The number of DAI subnode should be same as HW.
368 see below for detail.
369 - #sound-dai-cells : it must be 0 if your system is using single DAI
370 it must be 1 if your system is using multi DAI
371 - clocks : References to SSI/SRC/MIX/CTU/DVC/AUDIO_CLK clocks.
372 - clock-names : List of necessary clock names.
373 "ssi-all", "ssi.X", "src.X", "mix.X", "ctu.X",
374 "dvc.X", "clk_a", "clk_b", "clk_c", "clk_i"
377 - #clock-cells : it must be 0 if your system has audio_clkout
378 it must be 1 if your system has audio_clkout0/1/2/3
379 - clock-frequency : for all audio_clkout0/1/2/3
380 - clkout-lr-asynchronous : boolean property. it indicates that audio_clkoutn
381 is asynchronizes with lr-clock.
382 - resets : References to SSI resets.
383 - reset-names : List of valid reset names.
386 SSI subnode properties:
387 - interrupts : Should contain SSI interrupt for PIO transfer
388 - shared-pin : if shared clock pin
389 - pio-transfer : use PIO transfer mode
390 - no-busif : BUSIF is not ussed when [mem -> SSI] via DMA case
391 - dma : Should contain Audio DMAC entry
392 - dma-names : SSI case "rx" (=playback), "tx" (=capture)
393 SSIU case "rxu" (=playback), "txu" (=capture)
395 SRC subnode properties:
396 - dma : Should contain Audio DMAC entry
397 - dma-names : "rx" (=playback), "tx" (=capture)
399 DVC subnode properties:
400 - dma : Should contain Audio DMAC entry
401 - dma-names : "tx" (=playback/capture)
403 DAI subnode properties:
404 - playback : list of playback modules
405 - capture : list of capture modules
408 =============================================
410 =============================================
412 rcar_sound: sound@ec500000 {
413 #sound-dai-cells = <1>;
414 compatible = "renesas,rcar_sound-r8a7791", "renesas,rcar_sound-gen2";
415 reg = <0 0xec500000 0 0x1000>, /* SCU */
416 <0 0xec5a0000 0 0x100>, /* ADG */
417 <0 0xec540000 0 0x1000>, /* SSIU */
418 <0 0xec541000 0 0x1280>, /* SSI */
419 <0 0xec740000 0 0x200>; /* Audio DMAC peri peri*/
420 reg-names = "scu", "adg", "ssiu", "ssi", "audmapp";
422 clocks = <&mstp10_clks R8A7790_CLK_SSI_ALL>,
423 <&mstp10_clks R8A7790_CLK_SSI9>, <&mstp10_clks R8A7790_CLK_SSI8>,
424 <&mstp10_clks R8A7790_CLK_SSI7>, <&mstp10_clks R8A7790_CLK_SSI6>,
425 <&mstp10_clks R8A7790_CLK_SSI5>, <&mstp10_clks R8A7790_CLK_SSI4>,
426 <&mstp10_clks R8A7790_CLK_SSI3>, <&mstp10_clks R8A7790_CLK_SSI2>,
427 <&mstp10_clks R8A7790_CLK_SSI1>, <&mstp10_clks R8A7790_CLK_SSI0>,
428 <&mstp10_clks R8A7790_CLK_SCU_SRC9>, <&mstp10_clks R8A7790_CLK_SCU_SRC8>,
429 <&mstp10_clks R8A7790_CLK_SCU_SRC7>, <&mstp10_clks R8A7790_CLK_SCU_SRC6>,
430 <&mstp10_clks R8A7790_CLK_SCU_SRC5>, <&mstp10_clks R8A7790_CLK_SCU_SRC4>,
431 <&mstp10_clks R8A7790_CLK_SCU_SRC3>, <&mstp10_clks R8A7790_CLK_SCU_SRC2>,
432 <&mstp10_clks R8A7790_CLK_SCU_SRC1>, <&mstp10_clks R8A7790_CLK_SCU_SRC0>,
433 <&mstp10_clks R8A7790_CLK_SCU_DVC0>, <&mstp10_clks R8A7790_CLK_SCU_DVC1>,
434 <&audio_clk_a>, <&audio_clk_b>, <&audio_clk_c>, <&m2_clk>;
435 clock-names = "ssi-all",
436 "ssi.9", "ssi.8", "ssi.7", "ssi.6", "ssi.5",
437 "ssi.4", "ssi.3", "ssi.2", "ssi.1", "ssi.0",
438 "src.9", "src.8", "src.7", "src.6", "src.5",
439 "src.4", "src.3", "src.2", "src.1", "src.0",
441 "clk_a", "clk_b", "clk_c", "clk_i";
445 dmas = <&audma0 0xbc>;
449 dmas = <&audma0 0xbe>;
472 interrupts = <0 352 IRQ_TYPE_LEVEL_HIGH>;
473 dmas = <&audma0 0x85>, <&audma1 0x9a>;
474 dma-names = "rx", "tx";
477 interrupts = <0 353 IRQ_TYPE_LEVEL_HIGH>;
478 dmas = <&audma0 0x87>, <&audma1 0x9c>;
479 dma-names = "rx", "tx";
482 interrupts = <0 354 IRQ_TYPE_LEVEL_HIGH>;
483 dmas = <&audma0 0x89>, <&audma1 0x9e>;
484 dma-names = "rx", "tx";
487 interrupts = <0 355 IRQ_TYPE_LEVEL_HIGH>;
488 dmas = <&audma0 0x8b>, <&audma1 0xa0>;
489 dma-names = "rx", "tx";
492 interrupts = <0 356 IRQ_TYPE_LEVEL_HIGH>;
493 dmas = <&audma0 0x8d>, <&audma1 0xb0>;
494 dma-names = "rx", "tx";
497 interrupts = <0 357 IRQ_TYPE_LEVEL_HIGH>;
498 dmas = <&audma0 0x8f>, <&audma1 0xb2>;
499 dma-names = "rx", "tx";
502 interrupts = <0 358 IRQ_TYPE_LEVEL_HIGH>;
503 dmas = <&audma0 0x91>, <&audma1 0xb4>;
504 dma-names = "rx", "tx";
507 interrupts = <0 359 IRQ_TYPE_LEVEL_HIGH>;
508 dmas = <&audma0 0x93>, <&audma1 0xb6>;
509 dma-names = "rx", "tx";
512 interrupts = <0 360 IRQ_TYPE_LEVEL_HIGH>;
513 dmas = <&audma0 0x95>, <&audma1 0xb8>;
514 dma-names = "rx", "tx";
517 interrupts = <0 361 IRQ_TYPE_LEVEL_HIGH>;
518 dmas = <&audma0 0x97>, <&audma1 0xba>;
519 dma-names = "rx", "tx";
525 interrupts = <0 370 IRQ_TYPE_LEVEL_HIGH>;
526 dmas = <&audma0 0x01>, <&audma1 0x02>, <&audma0 0x15>, <&audma1 0x16>;
527 dma-names = "rx", "tx", "rxu", "txu";
530 interrupts = <0 371 IRQ_TYPE_LEVEL_HIGH>;
531 dmas = <&audma0 0x03>, <&audma1 0x04>, <&audma0 0x49>, <&audma1 0x4a>;
532 dma-names = "rx", "tx", "rxu", "txu";
535 interrupts = <0 372 IRQ_TYPE_LEVEL_HIGH>;
536 dmas = <&audma0 0x05>, <&audma1 0x06>, <&audma0 0x63>, <&audma1 0x64>;
537 dma-names = "rx", "tx", "rxu", "txu";
540 interrupts = <0 373 IRQ_TYPE_LEVEL_HIGH>;
541 dmas = <&audma0 0x07>, <&audma1 0x08>, <&audma0 0x6f>, <&audma1 0x70>;
542 dma-names = "rx", "tx", "rxu", "txu";
545 interrupts = <0 374 IRQ_TYPE_LEVEL_HIGH>;
546 dmas = <&audma0 0x09>, <&audma1 0x0a>, <&audma0 0x71>, <&audma1 0x72>;
547 dma-names = "rx", "tx", "rxu", "txu";
550 interrupts = <0 375 IRQ_TYPE_LEVEL_HIGH>;
551 dmas = <&audma0 0x0b>, <&audma1 0x0c>, <&audma0 0x73>, <&audma1 0x74>;
552 dma-names = "rx", "tx", "rxu", "txu";
555 interrupts = <0 376 IRQ_TYPE_LEVEL_HIGH>;
556 dmas = <&audma0 0x0d>, <&audma1 0x0e>, <&audma0 0x75>, <&audma1 0x76>;
557 dma-names = "rx", "tx", "rxu", "txu";
560 interrupts = <0 377 IRQ_TYPE_LEVEL_HIGH>;
561 dmas = <&audma0 0x0f>, <&audma1 0x10>, <&audma0 0x79>, <&audma1 0x7a>;
562 dma-names = "rx", "tx", "rxu", "txu";
565 interrupts = <0 378 IRQ_TYPE_LEVEL_HIGH>;
566 dmas = <&audma0 0x11>, <&audma1 0x12>, <&audma0 0x7b>, <&audma1 0x7c>;
567 dma-names = "rx", "tx", "rxu", "txu";
570 interrupts = <0 379 IRQ_TYPE_LEVEL_HIGH>;
571 dmas = <&audma0 0x13>, <&audma1 0x14>, <&audma0 0x7d>, <&audma1 0x7e>;
572 dma-names = "rx", "tx", "rxu", "txu";
578 playback = <&ssi5 &src5>;
596 =============================================
597 Example: simple sound card
598 =============================================
601 compatible = "simple-audio-card";
603 simple-audio-card,format = "left_j";
604 simple-audio-card,bitclock-master = <&sndcodec>;
605 simple-audio-card,frame-master = <&sndcodec>;
607 sndcpu: simple-audio-card,cpu {
608 sound-dai = <&rcar_sound>;
611 sndcodec: simple-audio-card,codec {
612 sound-dai = <&ak4643>;
613 clocks = <&audio_clock>;
618 pinctrl-0 = <&sound_pins &sound_clk_pins>;
619 pinctrl-names = "default";
622 #sound-dai-cells = <0>;
627 playback = <&ssi0 &src2 &dvc0>;
628 capture = <&ssi1 &src3 &dvc1>;
637 =============================================
638 Example: simple sound card for TDM
639 =============================================
642 compatible = "simple-audio-card";
644 simple-audio-card,format = "left_j";
645 simple-audio-card,bitclock-master = <&sndcodec>;
646 simple-audio-card,frame-master = <&sndcodec>;
648 sndcpu: simple-audio-card,cpu {
649 sound-dai = <&rcar_sound>;
650 dai-tdm-slot-num = <6>;
653 sndcodec: simple-audio-card,codec {
658 =============================================
659 Example: simple sound card for Multi channel
660 =============================================
663 pinctrl-0 = <&sound_pins &sound_clk_pins>;
664 pinctrl-names = "default";
667 #sound-dai-cells = <0>;
672 playback = <&ssi0 &ssi1 &ssi2 &src0 &dvc0>;