Kuninori Morimoto | fa558c2 | 2013-11-20 15:25:02 +0900 | [diff] [blame] | 1 | Simple-Card: |
| 2 | |
Jyri Sarha | b3ca11f | 2014-03-24 12:15:25 +0200 | [diff] [blame] | 3 | Simple-Card specifies audio DAI connections of SoC <-> codec. |
Kuninori Morimoto | fa558c2 | 2013-11-20 15:25:02 +0900 | [diff] [blame] | 4 | |
| 5 | Required properties: |
| 6 | |
| 7 | - compatible : "simple-audio-card" |
| 8 | |
| 9 | Optional properties: |
| 10 | |
Xiubo Li | 6684134 | 2014-02-08 15:59:55 +0800 | [diff] [blame] | 11 | - simple-audio-card,name : User specified audio sound card name, one string |
| 12 | property. |
Xiubo Li | 6684134 | 2014-02-08 15:59:55 +0800 | [diff] [blame] | 13 | - simple-audio-card,widgets : Please refer to widgets.txt. |
Xiubo Li | 8c0b823 | 2014-01-07 09:15:16 +0800 | [diff] [blame] | 14 | - simple-audio-card,routing : A list of the connections between audio components. |
Xiubo Li | d4c2209 | 2013-12-23 12:57:01 +0800 | [diff] [blame] | 15 | Each entry is a pair of strings, the first being the |
| 16 | connection's sink, the second being the connection's |
| 17 | source. |
Andrew Lunn | 2942a0e | 2014-05-22 17:31:49 +0200 | [diff] [blame] | 18 | - simple-audio-card,mclk-fs : Multiplication factor between stream rate and codec |
Arnaud Pouliquen | 85a4bfd | 2015-06-05 10:19:05 +0200 | [diff] [blame] | 19 | mclk. When defined, mclk-fs property defined in |
| 20 | dai-link sub nodes are ignored. |
Dylan Reid | 872bbb3 | 2014-10-03 10:06:08 -0700 | [diff] [blame] | 21 | - simple-audio-card,hp-det-gpio : Reference to GPIO that signals when |
Dylan Reid | 3fe2403 | 2014-10-01 14:25:20 -0700 | [diff] [blame] | 22 | headphones are attached. |
Dylan Reid | 872bbb3 | 2014-10-03 10:06:08 -0700 | [diff] [blame] | 23 | - simple-audio-card,mic-det-gpio : Reference to GPIO that signals when |
Dylan Reid | 3fe2403 | 2014-10-01 14:25:20 -0700 | [diff] [blame] | 24 | a microphone is attached. |
Andrew Lunn | 2942a0e | 2014-05-22 17:31:49 +0200 | [diff] [blame] | 25 | |
Jyri Sarha | b3ca11f | 2014-03-24 12:15:25 +0200 | [diff] [blame] | 26 | Optional subnodes: |
Xiubo Li | d4c2209 | 2013-12-23 12:57:01 +0800 | [diff] [blame] | 27 | |
Jyri Sarha | b3ca11f | 2014-03-24 12:15:25 +0200 | [diff] [blame] | 28 | - simple-audio-card,dai-link : Container for dai-link level |
| 29 | properties and the CPU and CODEC |
| 30 | sub-nodes. This container may be |
| 31 | omitted when the card has only one |
| 32 | DAI link. See the examples and the |
| 33 | section bellow. |
Kuninori Morimoto | fa558c2 | 2013-11-20 15:25:02 +0900 | [diff] [blame] | 34 | |
Jyri Sarha | b3ca11f | 2014-03-24 12:15:25 +0200 | [diff] [blame] | 35 | Dai-link subnode properties and subnodes: |
Jean-Francois Moine | 015f630 | 2014-03-20 11:04:16 +0100 | [diff] [blame] | 36 | |
Jyri Sarha | b3ca11f | 2014-03-24 12:15:25 +0200 | [diff] [blame] | 37 | If dai-link subnode is omitted and the subnode properties are directly |
| 38 | under "sound"-node the subnode property and subnode names have to be |
| 39 | prefixed with "simple-audio-card,"-prefix. |
| 40 | |
| 41 | Required dai-link subnodes: |
| 42 | |
| 43 | - cpu : CPU sub-node |
| 44 | - codec : CODEC sub-node |
| 45 | |
| 46 | Optional dai-link subnode properties: |
| 47 | |
| 48 | - format : CPU/CODEC common audio format. |
| 49 | "i2s", "right_j", "left_j" , "dsp_a" |
| 50 | "dsp_b", "ac97", "pdm", "msb", "lsb" |
| 51 | - frame-master : Indicates dai-link frame master. |
| 52 | phandle to a cpu or codec subnode. |
| 53 | - bitclock-master : Indicates dai-link bit clock master. |
| 54 | phandle to a cpu or codec subnode. |
| 55 | - bitclock-inversion : bool property. Add this if the |
| 56 | dai-link uses bit clock inversion. |
| 57 | - frame-inversion : bool property. Add this if the |
| 58 | dai-link uses frame clock inversion. |
Arnaud Pouliquen | 85a4bfd | 2015-06-05 10:19:05 +0200 | [diff] [blame] | 59 | - mclk-fs : Multiplication factor between stream |
| 60 | rate and codec mclk, applied only for |
| 61 | the dai-link. |
Jyri Sarha | b3ca11f | 2014-03-24 12:15:25 +0200 | [diff] [blame] | 62 | |
| 63 | For backward compatibility the frame-master and bitclock-master |
| 64 | properties can be used as booleans in codec subnode to indicate if the |
| 65 | codec is the dai-link frame or bit clock master. In this case there |
| 66 | should be no dai-link node, the same properties should not be present |
| 67 | at sound-node level, and the bitclock-inversion and frame-inversion |
| 68 | properties should also be placed in the codec node if needed. |
Kuninori Morimoto | fa558c2 | 2013-11-20 15:25:02 +0900 | [diff] [blame] | 69 | |
| 70 | Required CPU/CODEC subnodes properties: |
| 71 | |
| 72 | - sound-dai : phandle and port of CPU/CODEC |
| 73 | |
| 74 | Optional CPU/CODEC subnodes properties: |
| 75 | |
Jyri Sarha | b3ca11f | 2014-03-24 12:15:25 +0200 | [diff] [blame] | 76 | - dai-tdm-slot-num : Please refer to tdm-slot.txt. |
| 77 | - dai-tdm-slot-width : Please refer to tdm-slot.txt. |
Kuninori Morimoto | fa558c2 | 2013-11-20 15:25:02 +0900 | [diff] [blame] | 78 | - clocks / system-clock-frequency : specify subnode's clock if needed. |
| 79 | it can be specified via "clocks" if system has |
| 80 | clock node (= common clock), or "system-clock-frequency" |
| 81 | (if system doens't support common clock) |
Jyri Sarha | f991180 | 2015-01-13 21:16:34 +0200 | [diff] [blame] | 82 | If a clock is specified, it is |
| 83 | enabled with clk_prepare_enable() |
| 84 | in dai startup() and disabled with |
| 85 | clk_disable_unprepare() in dai |
| 86 | shutdown(). |
Kuninori Morimoto | fa558c2 | 2013-11-20 15:25:02 +0900 | [diff] [blame] | 87 | |
Jean-Francois Moine | 015f630 | 2014-03-20 11:04:16 +0100 | [diff] [blame] | 88 | Example 1 - single DAI link: |
Kuninori Morimoto | fa558c2 | 2013-11-20 15:25:02 +0900 | [diff] [blame] | 89 | |
| 90 | sound { |
| 91 | compatible = "simple-audio-card"; |
Xiubo Li | 6684134 | 2014-02-08 15:59:55 +0800 | [diff] [blame] | 92 | simple-audio-card,name = "VF610-Tower-Sound-Card"; |
Kuninori Morimoto | fa558c2 | 2013-11-20 15:25:02 +0900 | [diff] [blame] | 93 | simple-audio-card,format = "left_j"; |
Jyri Sarha | b3ca11f | 2014-03-24 12:15:25 +0200 | [diff] [blame] | 94 | simple-audio-card,bitclock-master = <&dailink0_master>; |
| 95 | simple-audio-card,frame-master = <&dailink0_master>; |
Xiubo Li | 6684134 | 2014-02-08 15:59:55 +0800 | [diff] [blame] | 96 | simple-audio-card,widgets = |
| 97 | "Microphone", "Microphone Jack", |
| 98 | "Headphone", "Headphone Jack", |
| 99 | "Speaker", "External Speaker"; |
Xiubo Li | bb651b3 | 2014-01-10 13:17:27 +0800 | [diff] [blame] | 100 | simple-audio-card,routing = |
Xiubo Li | 6684134 | 2014-02-08 15:59:55 +0800 | [diff] [blame] | 101 | "MIC_IN", "Microphone Jack", |
Xiubo Li | d4c2209 | 2013-12-23 12:57:01 +0800 | [diff] [blame] | 102 | "Headphone Jack", "HP_OUT", |
Xiubo Li | 6684134 | 2014-02-08 15:59:55 +0800 | [diff] [blame] | 103 | "External Speaker", "LINE_OUT"; |
Kuninori Morimoto | fa558c2 | 2013-11-20 15:25:02 +0900 | [diff] [blame] | 104 | |
Kuninori Morimoto | fa558c2 | 2013-11-20 15:25:02 +0900 | [diff] [blame] | 105 | simple-audio-card,cpu { |
| 106 | sound-dai = <&sh_fsi2 0>; |
| 107 | }; |
| 108 | |
Jyri Sarha | b3ca11f | 2014-03-24 12:15:25 +0200 | [diff] [blame] | 109 | dailink0_master: simple-audio-card,codec { |
Kuninori Morimoto | fa558c2 | 2013-11-20 15:25:02 +0900 | [diff] [blame] | 110 | sound-dai = <&ak4648>; |
Kuninori Morimoto | fa558c2 | 2013-11-20 15:25:02 +0900 | [diff] [blame] | 111 | clocks = <&osc>; |
| 112 | }; |
| 113 | }; |
| 114 | |
| 115 | &i2c0 { |
| 116 | ak4648: ak4648@12 { |
| 117 | #sound-dai-cells = <0>; |
| 118 | compatible = "asahi-kasei,ak4648"; |
| 119 | reg = <0x12>; |
| 120 | }; |
| 121 | }; |
| 122 | |
| 123 | sh_fsi2: sh_fsi2@ec230000 { |
| 124 | #sound-dai-cells = <1>; |
| 125 | compatible = "renesas,sh_fsi2"; |
| 126 | reg = <0xec230000 0x400>; |
| 127 | interrupt-parent = <&gic>; |
| 128 | interrupts = <0 146 0x4>; |
| 129 | }; |
Jean-Francois Moine | 015f630 | 2014-03-20 11:04:16 +0100 | [diff] [blame] | 130 | |
| 131 | Example 2 - many DAI links: |
| 132 | |
| 133 | sound { |
| 134 | compatible = "simple-audio-card"; |
| 135 | simple-audio-card,name = "Cubox Audio"; |
Jean-Francois Moine | 015f630 | 2014-03-20 11:04:16 +0100 | [diff] [blame] | 136 | |
| 137 | simple-audio-card,dai-link@0 { /* I2S - HDMI */ |
Jyri Sarha | b3ca11f | 2014-03-24 12:15:25 +0200 | [diff] [blame] | 138 | format = "i2s"; |
| 139 | cpu { |
Jean-Francois Moine | 015f630 | 2014-03-20 11:04:16 +0100 | [diff] [blame] | 140 | sound-dai = <&audio1 0>; |
| 141 | }; |
Jyri Sarha | b3ca11f | 2014-03-24 12:15:25 +0200 | [diff] [blame] | 142 | codec { |
Jean-Francois Moine | 015f630 | 2014-03-20 11:04:16 +0100 | [diff] [blame] | 143 | sound-dai = <&tda998x 0>; |
| 144 | }; |
| 145 | }; |
| 146 | |
| 147 | simple-audio-card,dai-link@1 { /* S/PDIF - HDMI */ |
Jyri Sarha | b3ca11f | 2014-03-24 12:15:25 +0200 | [diff] [blame] | 148 | cpu { |
Jean-Francois Moine | 015f630 | 2014-03-20 11:04:16 +0100 | [diff] [blame] | 149 | sound-dai = <&audio1 1>; |
| 150 | }; |
Jyri Sarha | b3ca11f | 2014-03-24 12:15:25 +0200 | [diff] [blame] | 151 | codec { |
Jean-Francois Moine | 015f630 | 2014-03-20 11:04:16 +0100 | [diff] [blame] | 152 | sound-dai = <&tda998x 1>; |
| 153 | }; |
| 154 | }; |
| 155 | |
| 156 | simple-audio-card,dai-link@2 { /* S/PDIF - S/PDIF */ |
Jyri Sarha | b3ca11f | 2014-03-24 12:15:25 +0200 | [diff] [blame] | 157 | cpu { |
Jean-Francois Moine | 015f630 | 2014-03-20 11:04:16 +0100 | [diff] [blame] | 158 | sound-dai = <&audio1 1>; |
| 159 | }; |
Jyri Sarha | b3ca11f | 2014-03-24 12:15:25 +0200 | [diff] [blame] | 160 | codec { |
Jean-Francois Moine | 015f630 | 2014-03-20 11:04:16 +0100 | [diff] [blame] | 161 | sound-dai = <&spdif_codec>; |
| 162 | }; |
| 163 | }; |
| 164 | }; |