summaryrefslogtreecommitdiff
path: root/Documentation/devicetree/bindings/sound/sprd-sound.txt
blob: d2d63fd3300e0bc2b7c4cce4a8b6e72b2ef4d5d0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
* Spreadtrum Audio Devices

* MUST define a /sprd-audio-devices node
  and, all sprd audio devices child node should be contain in it.

Required /sprd-audio-devices Specific Properties:

- compatible : "sprd,sound"

* SPRD-CODEC

Required SoC Specific Properties:
- compatible : "sprd,sprd-codec-v1"
or,
- compatible : "sprd,sprd-codec-v3"

Required Board Specific Properties:
- sprd,audio_power_ver : Which audio power version supported.
	* <1> : Tiger serial project;
	* <3> : Shark serial project;
- sprd,hp_pa_ver : Which internal headphone pa supported. (only sprd-codec-v3 option)
	* <0> or null: default version of headphone pa;
	* <1> : version 2 of headphone pa. (Dolphin serial project);
- sprd,ap_irq : Which IRQ number of codec ap part.
- sprd,dp_irq : Which IRQ number of codec dp part.

Optional Board Specific Properties:
- reg: physical base address of the controller and length of memory mapped
  region.(not check now)
- sprd,def_da_fs : set default playback sample rate.

* VBC

Required SoC Specific Properties:
- compatible : "sprd,vbc-r1p0"
or,
- compatible : "sprd,vbc-r2p0"

Required Board Specific Properties:

Optional Board Specific Properties:
- reg: physical base address of the controller and length of memory mapped
  region.(not check now)

* I2S

Required SoC Specific Properties:
- compatible : "sprd,i2s"

Required Board Specific Properties:
- sprd,hw_port : Which i2s hardware port.
- sprd,base : <physical base address, virtual base address>.
- sprd,dma_rx_no : Which i2s RX DMA number.
- sprd,dma_tx_no : Which i2s TX DMA number.

Optional Board Specific Properties:
- reg: physical base address of the controller and length of memory mapped
  region.(not check now)
- sprd,config : phandle of i2s configure.
	(* if this option is null, will use i2s configure default)
	+ child node
	*- sprd,def_pcm_config : empty property; define use default pcm configure;
		(* if this option is null, will use i2s configure default)
	*- sprd,slave_timeout : set the slave timeout value;
	*- sprd,byte_per_chan : set the bytes per channel;
	*- sprd,slave_mode : set is slave mode;
	*- sprd,lsb : set is LSB mode;
	*- sprd,lrck : set is LRCK mode;
	*- sprd,low_for_left : set is Low for Left mode;
	*- sprd,clk_inv : set is CLK invert;
	*- sprd,i2s_compatible : set is compatible standard I2S mode;
	*- sprd,pcm_short_frame : set is PCM short frame mode;
	*- sprd,pcm_slot : set support PCM slot;
	*- sprd,tx_watermark : set the TX watermark;
	*- sprd,rx_watermark : set the RX watermark;
(** i2s default configure **)
/* default i2s config */
const static struct i2s_config def_i2s_config = {
	.hw_port = 0,
	.fs = 32000,
	.slave_timeout = 0xF11,
	.bus_type = I2S_BUS,
	.byte_per_chan = I2S_BPCH_16,
	.mode = I2S_SLAVE,
	.lsb = I2S_MSB,
	.rtx_mode = I2S_RX_MODE,
	.sync_mode = I2S_LRCK,
	.lrck_inv = I2S_L_LEFT,
	.clk_inv = I2S_CLK_N,
	.i2s_bus_mode = I2S_MSBJUSTFIED,
	.tx_watermark = 12,
	.rx_watermark = 20,
};
(** pcm default configure **)
/* default pcm config */
const static struct i2s_config def_pcm_config = {
	.hw_port = 0,
	.fs = 8000,
	.slave_timeout = 0xF11,
	.bus_type = PCM_BUS,
	.byte_per_chan = I2S_BPCH_16,
	.mode = I2S_MASTER,
	.lsb = I2S_LSB,
	.rtx_mode = I2S_RTX_MODE,
	.sync_mode = I2S_LRCK,
	.lrck_inv = I2S_L_LEFT,
	.clk_inv = I2S_CLK_N,
	.pcm_bus_mode = I2S_SHORT_FRAME,
	.pcm_slot = 0x1,
	.pcm_cycle = 1,
	.tx_watermark = 12,
	.rx_watermark = 20,
};

* VBC Sound Card

Required SoC Specific Properties:
- compatible : "sprd,vbc-r1p0-sprd-codec-v1"
or,
- compatible : "sprd,vbc-r2p0-sprd-codec-v3"
- sprd,model : what's name of this sound card;
- sprd,pcm : phandle of the platform;
- sprd,codec : phandle of the codec;

Required Board Specific Properties:

Optional Board Specific Properties:

* I2S Sound Card

Required SoC Specific Properties:
- compatible : "sprd,i2s-null-codec"
- sprd,model : what's name of this sound card;
- sprd,i2s : phandle list of the cpu dai(i2s);
- sprd,pcm : phandle of the platform;
- sprd,codec : phandle of the codec;

Required Board Specific Properties:

Optional Board Specific Properties:


Example:

- SoC Specific Portion:

/ {
        sprd-audio-devices {
                compatible = "sprd,sound";
                #address-cells = <1>;
                #size-cells = <1>;

                /* 1. codecs */
                sprd_codec_v3: sprd-codec-v3 {
                        compatible = "sprd,sprd-codec-v3";
                        status = "disable";
                        sprd,def_da_fs = <44100>;
                        sprd,ap_irq = <164>;
                        sprd,dp_irq = <52>;
                };

                sprd_codec_v1: sprd-codec-v1 {
                        compatible = "sprd,sprd-codec-v1";
                        status = "disable";
                        sprd,def_da_fs = <44100>;
                        sprd,ap_irq = <103>;
                        sprd,dp_irq = <63>;
                };

                null_codec: null-codec {
                        compatible = "sprd,null-codec";
                };

                /* 2. cpu-dais */
                vbc_r2p0: vbc-r2p0 {
                        compatible = "sprd,vbc-r2p0";
                        status = "disable";
                };

                vbc_r1p0: vbc-r1p0 {
                        compatible = "sprd,vbc-r1p0";
                        status = "disable";
                };

                vaudio: vaudio {
                        compatible = "sprd,vaudio";
                };

                pcm_def_config: bt-i2s-config {
                        sprd,def_pcm_config;
                };

                i2s_def_config: fm-i2s-config {
                };

                i2s0: i2s@0 {
                        compatible = "sprd,i2s";
                        status = "disable";
                        sprd,hw_port = <0>;
                        sprd,base = <0x70D00000 0xF537C000>;
                        sprd,dma_rx_no = <3>;
                        sprd,dma_tx_no = <4>;
                };

                i2s1: i2s@1 {
                        compatible = "sprd,i2s";
                        status = "disable";
                        sprd,hw_port = <1>;
                        sprd,base = <0x70E00000 0xF5380000>;
                        sprd,dma_rx_no = <5>;
                        sprd,dma_tx_no = <6>;
                };

                i2s2: i2s@2 {
                        compatible = "sprd,i2s";
                        status = "disable";
                        sprd,hw_port = <2>;
                        sprd,base = <0x70F00000 0xF5382000>;
                        sprd,dma_rx_no = <7>;
                        sprd,dma_tx_no = <8>;
                };

                i2s3: i2s@3 {
                        compatible = "sprd,i2s";
                        status = "disable";
                        sprd,hw_port = <3>;
                        sprd,base = <0x71000000 0xF5384000>;
                        sprd,dma_rx_no = <9>;
                        sprd,dma_tx_no = <10>;
                };

                /* 3. platform */
                sprd_pcm: sprd-pcm-audio {
                        compatible = "sprd,sprd-pcm";
                };

                /* 4. machine */
                vbc_sound: sound@0 {
                        compatible = "sprd,vbc-r2p0-sprd-codec-v3";
                        sprd,model = "sprdphone";
                        sprd,vaudio = <&vaudio>;
                        sprd,vbc = <&vbc_r2p0>;
                        sprd,codec = <&sprd_codec_v3>;
                        sprd,pcm = <&sprd_pcm>;
                };

                i2s_sound: sound@1 {
                        compatible = "sprd,i2s-null-codec";
                        sprd,model = "all-i2s";
                        sprd,i2s = <&i2s0>, <&i2s1>, <&i2s2>, <&i2s3>;
                        sprd,codec = <&null_codec>;
                        sprd,pcm = <&sprd_pcm>;
                };

        };

};

Board Specific:

&vbc_r2p0 {
        status = "okay";
};

&sprd_codec_v3 {
        status = "okay";
        sprd,audio_power_ver = <3>;
        sprd,hp_pa_ver = <1>;
        sprd,ap_irq = <166>;
};

&i2s0 {
        status = "okay";
};

&i2s1 {
        status = "okay";
};

&i2s_sound {
        sprd,i2s = <&i2s0>, <&i2s1>;
};