1Renesas R-Car sound 2 3============================================= 4* Modules 5============================================= 6 7Renesas R-Car sound is constructed from below modules 8(for Gen2 or later) 9 10 SCU : Sampling Rate Converter Unit 11 - SRC : Sampling Rate Converter 12 - CMD 13 - CTU : Channel Transfer Unit 14 - MIX : Mixer 15 - DVC : Digital Volume and Mute Function 16 SSIU : Serial Sound Interface Unit 17 SSI : Serial Sound Interface 18 19See detail of each module's channels, connection, limitation on datasheet 20 21============================================= 22* Multi channel 23============================================= 24 25Multi channel is supported by Multi-SSI, or TDM-SSI. 26 27 Multi-SSI : 6ch case, you can use stereo x 3 SSI 28 TDM-SSI : 6ch case, you can use TDM 29 30============================================= 31* Enable/Disable each modules 32============================================= 33 34See datasheet to check SRC/CTU/MIX/DVC connect-limitation. 35DT controls enabling/disabling module. 36${LINUX}/arch/arm/boot/dts/r8a7790-lager.dts can be good example. 37This is example of 38 39Playback: [MEM] -> [SRC2] -> [DVC0] -> [SSIU0/SSI0] -> [codec] 40Capture: [MEM] <- [DVC1] <- [SRC3] <- [SSIU1/SSI1] <- [codec] 41 42 &rcar_sound { 43 ... 44 rcar_sound,dai { 45 dai0 { 46 playback = <&ssi0 &src2 &dvc0>; 47 capture = <&ssi1 &src3 &dvc1>; 48 }; 49 }; 50 }; 51 52You can use below. 53${LINUX}/arch/arm/boot/dts/r8a7790.dts can be good example. 54 55 &src0 &ctu00 &mix0 &dvc0 &ssi0 56 &src1 &ctu01 &mix1 &dvc1 &ssi1 57 &src2 &ctu02 &ssi2 58 &src3 &ctu03 &ssi3 59 &src4 &ssi4 60 &src5 &ctu10 &ssi5 61 &src6 &ctu11 &ssi6 62 &src7 &ctu12 &ssi7 63 &src8 &ctu13 &ssi8 64 &src9 &ssi9 65 66============================================= 67* SRC (Sampling Rate Converter) 68============================================= 69 70 [xx]Hz [yy]Hz 71 ------> [SRC] ------> 72 73SRC can convert [xx]Hz to [yy]Hz. Then, it has below 2 modes 74 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 81 82------------------ 83** Asynchronous mode 84------------------ 85 86You need to use "simple-scu-audio-card" sound card for it. 87example) 88 89 sound { 90 compatible = "simple-scu-audio-card"; 91 ... 92 /* 93 * SRC Asynchronous mode setting 94 * Playback: 95 * All input data will be converted to 48kHz 96 * Capture: 97 * Inputed 48kHz data will be converted to 98 * system specified Hz 99 */ 100 simple-audio-card,convert-rate = <48000>; 101 ... 102 simple-audio-card,cpu { 103 sound-dai = <&rcar_sound>; 104 }; 105 simple-audio-card,codec { 106 ... 107 }; 108 }; 109 110------------------ 111** Synchronous mode 112------------------ 113 114 > amixer set "SRC Out Rate" on 115 > aplay xxxx.wav 116 > amixer set "SRC Out Rate" 48000 117 > amixer set "SRC Out Rate" 44100 118 119============================================= 120* CTU (Channel Transfer Unit) 121============================================= 122 123 [xx]ch [yy]ch 124 ------> [CTU] --------> 125 126CTU can convert [xx]ch to [yy]ch, or exchange outputed channel. 127CTU conversion needs matrix settings. 128For more detail information, see below 129 130 Renesas R-Car datasheet 131 - Sampling Rate Converter Unit (SCU) 132 - SCU Operation 133 - CMD Block 134 - Functional Blocks in CMD 135 136 Renesas R-Car datasheet 137 - Sampling Rate Converter Unit (SCU) 138 - Register Description 139 - CTUn Scale Value exx Register (CTUn_SVxxR) 140 141 ${LINUX}/sound/soc/sh/rcar/ctu.c 142 - comment of header 143 144You need to use "simple-scu-audio-card" sound card for it. 145example) 146 147 sound { 148 compatible = "simple-scu-audio-card"; 149 ... 150 /* 151 * CTU setting 152 * All input data will be converted to 2ch 153 * as output data 154 */ 155 simple-audio-card,convert-channels = <2>; 156 ... 157 simple-audio-card,cpu { 158 sound-dai = <&rcar_sound>; 159 }; 160 simple-audio-card,codec { 161 ... 162 }; 163 }; 164 165Ex) Exchange output channel 166 Input -> Output 167 1ch -> 0ch 168 0ch -> 1ch 169 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) 173 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 178 179 example of changing connection 180 amixer set "CTU Reset" on 181 amixer set "CTU Pass" 2,1 182 183============================================= 184* MIX (Mixer) 185============================================= 186 187MIX merges 2 sounds path. You can see 2 sound interface on system, 188and these sounds will be merged by MIX. 189 190 aplay -D plughw:0,0 xxxx.wav & 191 aplay -D plughw:0,1 yyyy.wav 192 193You need to use "simple-scu-audio-card" sound card for it. 194Ex) 195 [MEM] -> [SRC1] -> [CTU02] -+-> [MIX0] -> [DVC0] -> [SSI0] 196 | 197 [MEM] -> [SRC2] -> [CTU03] -+ 198 199 sound { 200 compatible = "simple-scu-audio-card"; 201 ... 202 simple-audio-card,cpu-0 { 203 sound-dai = <&rcar_sound 0>; 204 }; 205 simple-audio-card,cpu-1 { 206 sound-dai = <&rcar_sound 1>; 207 }; 208 simple-audio-card,codec { 209 ... 210 }; 211 }; 212 213 &rcar_sound { 214 ... 215 rcar_sound,dai { 216 dai0 { 217 playback = <&src1 &ctu02 &mix0 &dvc0 &ssi0>; 218 }; 219 dai1 { 220 playback = <&src2 &ctu03 &mix0 &dvc0 &ssi0>; 221 }; 222 }; 223 }; 224 225============================================= 226* DVC (Digital Volume and Mute Function) 227============================================= 228 229DVC controls Playback/Capture volume. 230 231Playback Volume 232 amixer set "DVC Out" 100% 233 234Capture Volume 235 amixer set "DVC In" 100% 236 237Playback Mute 238 amixer set "DVC Out Mute" on 239 240Capture Mute 241 amixer set "DVC In Mute" on 242 243Volume Ramp 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 247 aplay xxx.wav & 248 amixer set "DVC Out" 80% // Volume Down 249 amixer set "DVC Out" 100% // Volume Up 250 251============================================= 252* SSIU (Serial Sound Interface Unit) 253============================================= 254 255There is no DT settings for SSIU, because SSIU will be automatically 256selected via SSI. 257SSIU can avoid some under/over run error, because it has some buffer. 258But you can't use it if SSI was PIO mode. 259In DMA mode, you can select not to use SSIU by using "no-busif" on DT. 260 261 &ssi0 { 262 no-busif; 263 }; 264 265============================================= 266* SSI (Serial Sound Interface) 267============================================= 268 269** PIO mode 270 271You can use PIO mode which is for connection check by using. 272Note: The system will drop non-SSI modules in PIO mode 273even though if DT is selecting other modules. 274 275 &ssi0 { 276 pio-transfer 277 }; 278 279** DMA mode without SSIU 280 281You can use DMA without SSIU. 282Note: under/over run, or noise are likely to occur 283 284 &ssi0 { 285 no-busif; 286 }; 287 288** PIN sharing 289 290Each SSI can share WS pin. It is based on platform. 291This is example if SSI1 want to share WS pin with SSI0 292 293 &ssi1 { 294 shared-pin; 295 }; 296 297** Multi-SSI 298 299You can use Multi-SSI. 300This is example of SSI0/SSI1/SSI2 (= for 6ch) 301 302 &rcar_sound { 303 ... 304 rcar_sound,dai { 305 dai0 { 306 playback = <&ssi0 &ssi1 &ssi2 &src0 &dvc0>; 307 }; 308 }; 309 }; 310 311** TDM-SSI 312 313You can use TDM with SSI. 314This is example of TDM 6ch. 315Driver can automatically switches TDM <-> stereo mode in this case. 316 317 rsnd_tdm: sound { 318 compatible = "simple-audio-card"; 319 ... 320 simple-audio-card,cpu { 321 /* system can use TDM 6ch */ 322 dai-tdm-slot-num = <6>; 323 sound-dai = <&rcar_sound>; 324 }; 325 simple-audio-card,codec { 326 ... 327 }; 328 }; 329 330 331============================================= 332Required properties: 333============================================= 334 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. 348 required register is 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" 375 376Optional properties: 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. 384 "ssi-all", "ssi.X" 385 386SSI 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) 394 395SRC subnode properties: 396- dma : Should contain Audio DMAC entry 397- dma-names : "rx" (=playback), "tx" (=capture) 398 399DVC subnode properties: 400- dma : Should contain Audio DMAC entry 401- dma-names : "tx" (=playback/capture) 402 403DAI subnode properties: 404- playback : list of playback modules 405- capture : list of capture modules 406 407 408============================================= 409Example: 410============================================= 411 412rcar_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"; 421 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", 440 "dvc.0", "dvc.1", 441 "clk_a", "clk_b", "clk_c", "clk_i"; 442 443 rcar_sound,dvc { 444 dvc0: dvc-0 { 445 dmas = <&audma0 0xbc>; 446 dma-names = "tx"; 447 }; 448 dvc1: dvc-1 { 449 dmas = <&audma0 0xbe>; 450 dma-names = "tx"; 451 }; 452 }; 453 454 rcar_sound,mix { 455 mix0: mix-0 { }; 456 mix1: mix-1 { }; 457 }; 458 459 rcar_sound,ctu { 460 ctu00: ctu-0 { }; 461 ctu01: ctu-1 { }; 462 ctu02: ctu-2 { }; 463 ctu03: ctu-3 { }; 464 ctu10: ctu-4 { }; 465 ctu11: ctu-5 { }; 466 ctu12: ctu-6 { }; 467 ctu13: ctu-7 { }; 468 }; 469 470 rcar_sound,src { 471 src0: src-0 { 472 interrupts = <0 352 IRQ_TYPE_LEVEL_HIGH>; 473 dmas = <&audma0 0x85>, <&audma1 0x9a>; 474 dma-names = "rx", "tx"; 475 }; 476 src1: src-1 { 477 interrupts = <0 353 IRQ_TYPE_LEVEL_HIGH>; 478 dmas = <&audma0 0x87>, <&audma1 0x9c>; 479 dma-names = "rx", "tx"; 480 }; 481 src2: src-2 { 482 interrupts = <0 354 IRQ_TYPE_LEVEL_HIGH>; 483 dmas = <&audma0 0x89>, <&audma1 0x9e>; 484 dma-names = "rx", "tx"; 485 }; 486 src3: src-3 { 487 interrupts = <0 355 IRQ_TYPE_LEVEL_HIGH>; 488 dmas = <&audma0 0x8b>, <&audma1 0xa0>; 489 dma-names = "rx", "tx"; 490 }; 491 src4: src-4 { 492 interrupts = <0 356 IRQ_TYPE_LEVEL_HIGH>; 493 dmas = <&audma0 0x8d>, <&audma1 0xb0>; 494 dma-names = "rx", "tx"; 495 }; 496 src5: src-5 { 497 interrupts = <0 357 IRQ_TYPE_LEVEL_HIGH>; 498 dmas = <&audma0 0x8f>, <&audma1 0xb2>; 499 dma-names = "rx", "tx"; 500 }; 501 src6: src-6 { 502 interrupts = <0 358 IRQ_TYPE_LEVEL_HIGH>; 503 dmas = <&audma0 0x91>, <&audma1 0xb4>; 504 dma-names = "rx", "tx"; 505 }; 506 src7: src-7 { 507 interrupts = <0 359 IRQ_TYPE_LEVEL_HIGH>; 508 dmas = <&audma0 0x93>, <&audma1 0xb6>; 509 dma-names = "rx", "tx"; 510 }; 511 src8: src-8 { 512 interrupts = <0 360 IRQ_TYPE_LEVEL_HIGH>; 513 dmas = <&audma0 0x95>, <&audma1 0xb8>; 514 dma-names = "rx", "tx"; 515 }; 516 src9: src-9 { 517 interrupts = <0 361 IRQ_TYPE_LEVEL_HIGH>; 518 dmas = <&audma0 0x97>, <&audma1 0xba>; 519 dma-names = "rx", "tx"; 520 }; 521 }; 522 523 rcar_sound,ssi { 524 ssi0: ssi-0 { 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"; 528 }; 529 ssi1: ssi-1 { 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"; 533 }; 534 ssi2: ssi-2 { 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"; 538 }; 539 ssi3: ssi-3 { 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"; 543 }; 544 ssi4: ssi-4 { 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"; 548 }; 549 ssi5: ssi-5 { 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"; 553 }; 554 ssi6: ssi-6 { 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"; 558 }; 559 ssi7: ssi-7 { 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"; 563 }; 564 ssi8: ssi-8 { 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"; 568 }; 569 ssi9: ssi-9 { 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"; 573 }; 574 }; 575 576 rcar_sound,dai { 577 dai0 { 578 playback = <&ssi5 &src5>; 579 capture = <&ssi6>; 580 }; 581 dai1 { 582 playback = <&ssi3>; 583 }; 584 dai2 { 585 capture = <&ssi4>; 586 }; 587 dai3 { 588 playback = <&ssi7>; 589 }; 590 dai4 { 591 capture = <&ssi8>; 592 }; 593 }; 594}; 595 596============================================= 597Example: simple sound card 598============================================= 599 600 rsnd_ak4643: sound { 601 compatible = "simple-audio-card"; 602 603 simple-audio-card,format = "left_j"; 604 simple-audio-card,bitclock-master = <&sndcodec>; 605 simple-audio-card,frame-master = <&sndcodec>; 606 607 sndcpu: simple-audio-card,cpu { 608 sound-dai = <&rcar_sound>; 609 }; 610 611 sndcodec: simple-audio-card,codec { 612 sound-dai = <&ak4643>; 613 clocks = <&audio_clock>; 614 }; 615 }; 616 617&rcar_sound { 618 pinctrl-0 = <&sound_pins &sound_clk_pins>; 619 pinctrl-names = "default"; 620 621 /* Single DAI */ 622 #sound-dai-cells = <0>; 623 624 625 rcar_sound,dai { 626 dai0 { 627 playback = <&ssi0 &src2 &dvc0>; 628 capture = <&ssi1 &src3 &dvc1>; 629 }; 630 }; 631}; 632 633&ssi1 { 634 shared-pin; 635}; 636 637============================================= 638Example: simple sound card for TDM 639============================================= 640 641 rsnd_tdm: sound { 642 compatible = "simple-audio-card"; 643 644 simple-audio-card,format = "left_j"; 645 simple-audio-card,bitclock-master = <&sndcodec>; 646 simple-audio-card,frame-master = <&sndcodec>; 647 648 sndcpu: simple-audio-card,cpu { 649 sound-dai = <&rcar_sound>; 650 dai-tdm-slot-num = <6>; 651 }; 652 653 sndcodec: simple-audio-card,codec { 654 sound-dai = <&xxx>; 655 }; 656 }; 657 658============================================= 659Example: simple sound card for Multi channel 660============================================= 661 662&rcar_sound { 663 pinctrl-0 = <&sound_pins &sound_clk_pins>; 664 pinctrl-names = "default"; 665 666 /* Single DAI */ 667 #sound-dai-cells = <0>; 668 669 670 rcar_sound,dai { 671 dai0 { 672 playback = <&ssi0 &ssi1 &ssi2 &src0 &dvc0>; 673 }; 674 }; 675}; 676