xref: /openbmc/linux/sound/soc/codecs/wm8940.c (revision 75f25bd3)
1 /*
2  * wm8940.c  --  WM8940 ALSA Soc Audio driver
3  *
4  * Author: Jonathan Cameron <jic23@cam.ac.uk>
5  *
6  * Based on wm8510.c
7  *    Copyright  2006 Wolfson Microelectronics PLC.
8  *    Author:  Liam Girdwood <lrg@slimlogic.co.uk>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License version 2 as
12  * published by the Free Software Foundation.
13  *
14  * Not currently handled:
15  * Notch filter control
16  * AUXMode (inverting vs mixer)
17  * No means to obtain current gain if alc enabled.
18  * No use made of gpio
19  * Fast VMID discharge for power down
20  * Soft Start
21  * DLR and ALR Swaps not enabled
22  * Digital Sidetone not supported
23  */
24 #include <linux/module.h>
25 #include <linux/moduleparam.h>
26 #include <linux/kernel.h>
27 #include <linux/init.h>
28 #include <linux/delay.h>
29 #include <linux/pm.h>
30 #include <linux/i2c.h>
31 #include <linux/platform_device.h>
32 #include <linux/spi/spi.h>
33 #include <linux/slab.h>
34 #include <sound/core.h>
35 #include <sound/pcm.h>
36 #include <sound/pcm_params.h>
37 #include <sound/soc.h>
38 #include <sound/initval.h>
39 #include <sound/tlv.h>
40 
41 #include "wm8940.h"
42 
43 struct wm8940_priv {
44 	unsigned int sysclk;
45 	enum snd_soc_control_type control_type;
46 	void *control_data;
47 };
48 
49 static u16 wm8940_reg_defaults[] = {
50 	0x8940, /* Soft Reset */
51 	0x0000, /* Power 1 */
52 	0x0000, /* Power 2 */
53 	0x0000, /* Power 3 */
54 	0x0010, /* Interface Control */
55 	0x0000, /* Companding Control */
56 	0x0140, /* Clock Control */
57 	0x0000, /* Additional Controls */
58 	0x0000, /* GPIO Control */
59 	0x0002, /* Auto Increment Control */
60 	0x0000, /* DAC Control */
61 	0x00FF, /* DAC Volume */
62 	0,
63 	0,
64 	0x0100, /* ADC Control */
65 	0x00FF, /* ADC Volume */
66 	0x0000, /* Notch Filter 1 Control 1 */
67 	0x0000, /* Notch Filter 1 Control 2 */
68 	0x0000, /* Notch Filter 2 Control 1 */
69 	0x0000, /* Notch Filter 2 Control 2 */
70 	0x0000, /* Notch Filter 3 Control 1 */
71 	0x0000, /* Notch Filter 3 Control 2 */
72 	0x0000, /* Notch Filter 4 Control 1 */
73 	0x0000, /* Notch Filter 4 Control 2 */
74 	0x0032, /* DAC Limit Control 1 */
75 	0x0000, /* DAC Limit Control 2 */
76 	0,
77 	0,
78 	0,
79 	0,
80 	0,
81 	0,
82 	0x0038, /* ALC Control 1 */
83 	0x000B, /* ALC Control 2 */
84 	0x0032, /* ALC Control 3 */
85 	0x0000, /* Noise Gate */
86 	0x0041, /* PLLN */
87 	0x000C, /* PLLK1 */
88 	0x0093, /* PLLK2 */
89 	0x00E9, /* PLLK3 */
90 	0,
91 	0,
92 	0x0030, /* ALC Control 4 */
93 	0,
94 	0x0002, /* Input Control */
95 	0x0050, /* PGA Gain */
96 	0,
97 	0x0002, /* ADC Boost Control */
98 	0,
99 	0x0002, /* Output Control */
100 	0x0000, /* Speaker Mixer Control */
101 	0,
102 	0,
103 	0,
104 	0x0079, /* Speaker Volume */
105 	0,
106 	0x0000, /* Mono Mixer Control */
107 };
108 
109 static const char *wm8940_companding[] = { "Off", "NC", "u-law", "A-law" };
110 static const struct soc_enum wm8940_adc_companding_enum
111 = SOC_ENUM_SINGLE(WM8940_COMPANDINGCTL, 1, 4, wm8940_companding);
112 static const struct soc_enum wm8940_dac_companding_enum
113 = SOC_ENUM_SINGLE(WM8940_COMPANDINGCTL, 3, 4, wm8940_companding);
114 
115 static const char *wm8940_alc_mode_text[] = {"ALC", "Limiter"};
116 static const struct soc_enum wm8940_alc_mode_enum
117 = SOC_ENUM_SINGLE(WM8940_ALC3, 8, 2, wm8940_alc_mode_text);
118 
119 static const char *wm8940_mic_bias_level_text[] = {"0.9", "0.65"};
120 static const struct soc_enum wm8940_mic_bias_level_enum
121 = SOC_ENUM_SINGLE(WM8940_INPUTCTL, 8, 2, wm8940_mic_bias_level_text);
122 
123 static const char *wm8940_filter_mode_text[] = {"Audio", "Application"};
124 static const struct soc_enum wm8940_filter_mode_enum
125 = SOC_ENUM_SINGLE(WM8940_ADC, 7, 2, wm8940_filter_mode_text);
126 
127 static DECLARE_TLV_DB_SCALE(wm8940_spk_vol_tlv, -5700, 100, 1);
128 static DECLARE_TLV_DB_SCALE(wm8940_att_tlv, -1000, 1000, 0);
129 static DECLARE_TLV_DB_SCALE(wm8940_pga_vol_tlv, -1200, 75, 0);
130 static DECLARE_TLV_DB_SCALE(wm8940_alc_min_tlv, -1200, 600, 0);
131 static DECLARE_TLV_DB_SCALE(wm8940_alc_max_tlv, 675, 600, 0);
132 static DECLARE_TLV_DB_SCALE(wm8940_alc_tar_tlv, -2250, 50, 0);
133 static DECLARE_TLV_DB_SCALE(wm8940_lim_boost_tlv, 0, 100, 0);
134 static DECLARE_TLV_DB_SCALE(wm8940_lim_thresh_tlv, -600, 100, 0);
135 static DECLARE_TLV_DB_SCALE(wm8940_adc_tlv, -12750, 50, 1);
136 static DECLARE_TLV_DB_SCALE(wm8940_capture_boost_vol_tlv, 0, 2000, 0);
137 
138 static const struct snd_kcontrol_new wm8940_snd_controls[] = {
139 	SOC_SINGLE("Digital Loopback Switch", WM8940_COMPANDINGCTL,
140 		   6, 1, 0),
141 	SOC_ENUM("DAC Companding", wm8940_dac_companding_enum),
142 	SOC_ENUM("ADC Companding", wm8940_adc_companding_enum),
143 
144 	SOC_ENUM("ALC Mode", wm8940_alc_mode_enum),
145 	SOC_SINGLE("ALC Switch", WM8940_ALC1, 8, 1, 0),
146 	SOC_SINGLE_TLV("ALC Capture Max Gain", WM8940_ALC1,
147 		       3, 7, 1, wm8940_alc_max_tlv),
148 	SOC_SINGLE_TLV("ALC Capture Min Gain", WM8940_ALC1,
149 		       0, 7, 0, wm8940_alc_min_tlv),
150 	SOC_SINGLE_TLV("ALC Capture Target", WM8940_ALC2,
151 		       0, 14, 0, wm8940_alc_tar_tlv),
152 	SOC_SINGLE("ALC Capture Hold", WM8940_ALC2, 4, 10, 0),
153 	SOC_SINGLE("ALC Capture Decay", WM8940_ALC3, 4, 10, 0),
154 	SOC_SINGLE("ALC Capture Attach", WM8940_ALC3, 0, 10, 0),
155 	SOC_SINGLE("ALC ZC Switch", WM8940_ALC4, 1, 1, 0),
156 	SOC_SINGLE("ALC Capture Noise Gate Switch", WM8940_NOISEGATE,
157 		   3, 1, 0),
158 	SOC_SINGLE("ALC Capture Noise Gate Threshold", WM8940_NOISEGATE,
159 		   0, 7, 0),
160 
161 	SOC_SINGLE("DAC Playback Limiter Switch", WM8940_DACLIM1, 8, 1, 0),
162 	SOC_SINGLE("DAC Playback Limiter Attack", WM8940_DACLIM1, 0, 9, 0),
163 	SOC_SINGLE("DAC Playback Limiter Decay", WM8940_DACLIM1, 4, 11, 0),
164 	SOC_SINGLE_TLV("DAC Playback Limiter Threshold", WM8940_DACLIM2,
165 		       4, 9, 1, wm8940_lim_thresh_tlv),
166 	SOC_SINGLE_TLV("DAC Playback Limiter Boost", WM8940_DACLIM2,
167 		       0, 12, 0, wm8940_lim_boost_tlv),
168 
169 	SOC_SINGLE("Capture PGA ZC Switch", WM8940_PGAGAIN, 7, 1, 0),
170 	SOC_SINGLE_TLV("Capture PGA Volume", WM8940_PGAGAIN,
171 		       0, 63, 0, wm8940_pga_vol_tlv),
172 	SOC_SINGLE_TLV("Digital Playback Volume", WM8940_DACVOL,
173 		       0, 255, 0, wm8940_adc_tlv),
174 	SOC_SINGLE_TLV("Digital Capture Volume", WM8940_ADCVOL,
175 		       0, 255, 0, wm8940_adc_tlv),
176 	SOC_ENUM("Mic Bias Level", wm8940_mic_bias_level_enum),
177 	SOC_SINGLE_TLV("Capture Boost Volue", WM8940_ADCBOOST,
178 		       8, 1, 0, wm8940_capture_boost_vol_tlv),
179 	SOC_SINGLE_TLV("Speaker Playback Volume", WM8940_SPKVOL,
180 		       0, 63, 0, wm8940_spk_vol_tlv),
181 	SOC_SINGLE("Speaker Playback Switch", WM8940_SPKVOL,  6, 1, 1),
182 
183 	SOC_SINGLE_TLV("Speaker Mixer Line Bypass Volume", WM8940_SPKVOL,
184 		       8, 1, 1, wm8940_att_tlv),
185 	SOC_SINGLE("Speaker Playback ZC Switch", WM8940_SPKVOL, 7, 1, 0),
186 
187 	SOC_SINGLE("Mono Out Switch", WM8940_MONOMIX, 6, 1, 1),
188 	SOC_SINGLE_TLV("Mono Mixer Line Bypass Volume", WM8940_MONOMIX,
189 		       7, 1, 1, wm8940_att_tlv),
190 
191 	SOC_SINGLE("High Pass Filter Switch", WM8940_ADC, 8, 1, 0),
192 	SOC_ENUM("High Pass Filter Mode", wm8940_filter_mode_enum),
193 	SOC_SINGLE("High Pass Filter Cut Off", WM8940_ADC, 4, 7, 0),
194 	SOC_SINGLE("ADC Inversion Switch", WM8940_ADC, 0, 1, 0),
195 	SOC_SINGLE("DAC Inversion Switch", WM8940_DAC, 0, 1, 0),
196 	SOC_SINGLE("DAC Auto Mute Switch", WM8940_DAC, 2, 1, 0),
197 	SOC_SINGLE("ZC Timeout Clock Switch", WM8940_ADDCNTRL, 0, 1, 0),
198 };
199 
200 static const struct snd_kcontrol_new wm8940_speaker_mixer_controls[] = {
201 	SOC_DAPM_SINGLE("Line Bypass Switch", WM8940_SPKMIX, 1, 1, 0),
202 	SOC_DAPM_SINGLE("Aux Playback Switch", WM8940_SPKMIX, 5, 1, 0),
203 	SOC_DAPM_SINGLE("PCM Playback Switch", WM8940_SPKMIX, 0, 1, 0),
204 };
205 
206 static const struct snd_kcontrol_new wm8940_mono_mixer_controls[] = {
207 	SOC_DAPM_SINGLE("Line Bypass Switch", WM8940_MONOMIX, 1, 1, 0),
208 	SOC_DAPM_SINGLE("Aux Playback Switch", WM8940_MONOMIX, 2, 1, 0),
209 	SOC_DAPM_SINGLE("PCM Playback Switch", WM8940_MONOMIX, 0, 1, 0),
210 };
211 
212 static DECLARE_TLV_DB_SCALE(wm8940_boost_vol_tlv, -1500, 300, 1);
213 static const struct snd_kcontrol_new wm8940_input_boost_controls[] = {
214 	SOC_DAPM_SINGLE("Mic PGA Switch", WM8940_PGAGAIN, 6, 1, 1),
215 	SOC_DAPM_SINGLE_TLV("Aux Volume", WM8940_ADCBOOST,
216 			    0, 7, 0, wm8940_boost_vol_tlv),
217 	SOC_DAPM_SINGLE_TLV("Mic Volume", WM8940_ADCBOOST,
218 			    4, 7, 0, wm8940_boost_vol_tlv),
219 };
220 
221 static const struct snd_kcontrol_new wm8940_micpga_controls[] = {
222 	SOC_DAPM_SINGLE("AUX Switch", WM8940_INPUTCTL, 2, 1, 0),
223 	SOC_DAPM_SINGLE("MICP Switch", WM8940_INPUTCTL, 0, 1, 0),
224 	SOC_DAPM_SINGLE("MICN Switch", WM8940_INPUTCTL, 1, 1, 0),
225 };
226 
227 static const struct snd_soc_dapm_widget wm8940_dapm_widgets[] = {
228 	SND_SOC_DAPM_MIXER("Speaker Mixer", WM8940_POWER3, 2, 0,
229 			   &wm8940_speaker_mixer_controls[0],
230 			   ARRAY_SIZE(wm8940_speaker_mixer_controls)),
231 	SND_SOC_DAPM_MIXER("Mono Mixer", WM8940_POWER3, 3, 0,
232 			   &wm8940_mono_mixer_controls[0],
233 			   ARRAY_SIZE(wm8940_mono_mixer_controls)),
234 	SND_SOC_DAPM_DAC("DAC", "HiFi Playback", WM8940_POWER3, 0, 0),
235 
236 	SND_SOC_DAPM_PGA("SpkN Out", WM8940_POWER3, 5, 0, NULL, 0),
237 	SND_SOC_DAPM_PGA("SpkP Out", WM8940_POWER3, 6, 0, NULL, 0),
238 	SND_SOC_DAPM_PGA("Mono Out", WM8940_POWER3, 7, 0, NULL, 0),
239 	SND_SOC_DAPM_OUTPUT("MONOOUT"),
240 	SND_SOC_DAPM_OUTPUT("SPKOUTP"),
241 	SND_SOC_DAPM_OUTPUT("SPKOUTN"),
242 
243 	SND_SOC_DAPM_PGA("Aux Input", WM8940_POWER1, 6, 0, NULL, 0),
244 	SND_SOC_DAPM_ADC("ADC", "HiFi Capture", WM8940_POWER2, 0, 0),
245 	SND_SOC_DAPM_MIXER("Mic PGA", WM8940_POWER2, 2, 0,
246 			   &wm8940_micpga_controls[0],
247 			   ARRAY_SIZE(wm8940_micpga_controls)),
248 	SND_SOC_DAPM_MIXER("Boost Mixer", WM8940_POWER2, 4, 0,
249 			   &wm8940_input_boost_controls[0],
250 			   ARRAY_SIZE(wm8940_input_boost_controls)),
251 	SND_SOC_DAPM_MICBIAS("Mic Bias", WM8940_POWER1, 4, 0),
252 
253 	SND_SOC_DAPM_INPUT("MICN"),
254 	SND_SOC_DAPM_INPUT("MICP"),
255 	SND_SOC_DAPM_INPUT("AUX"),
256 };
257 
258 static const struct snd_soc_dapm_route audio_map[] = {
259 	/* Mono output mixer */
260 	{"Mono Mixer", "PCM Playback Switch", "DAC"},
261 	{"Mono Mixer", "Aux Playback Switch", "Aux Input"},
262 	{"Mono Mixer", "Line Bypass Switch", "Boost Mixer"},
263 
264 	/* Speaker output mixer */
265 	{"Speaker Mixer", "PCM Playback Switch", "DAC"},
266 	{"Speaker Mixer", "Aux Playback Switch", "Aux Input"},
267 	{"Speaker Mixer", "Line Bypass Switch", "Boost Mixer"},
268 
269 	/* Outputs */
270 	{"Mono Out", NULL, "Mono Mixer"},
271 	{"MONOOUT", NULL, "Mono Out"},
272 	{"SpkN Out", NULL, "Speaker Mixer"},
273 	{"SpkP Out", NULL, "Speaker Mixer"},
274 	{"SPKOUTN", NULL, "SpkN Out"},
275 	{"SPKOUTP", NULL, "SpkP Out"},
276 
277 	/*  Microphone PGA */
278 	{"Mic PGA", "MICN Switch", "MICN"},
279 	{"Mic PGA", "MICP Switch", "MICP"},
280 	{"Mic PGA", "AUX Switch", "AUX"},
281 
282 	/* Boost Mixer */
283 	{"Boost Mixer", "Mic PGA Switch", "Mic PGA"},
284 	{"Boost Mixer", "Mic Volume",  "MICP"},
285 	{"Boost Mixer", "Aux Volume", "Aux Input"},
286 
287 	{"ADC", NULL, "Boost Mixer"},
288 };
289 
290 static int wm8940_add_widgets(struct snd_soc_codec *codec)
291 {
292 	struct snd_soc_dapm_context *dapm = &codec->dapm;
293 	int ret;
294 
295 	ret = snd_soc_dapm_new_controls(dapm, wm8940_dapm_widgets,
296 					ARRAY_SIZE(wm8940_dapm_widgets));
297 	if (ret)
298 		goto error_ret;
299 	ret = snd_soc_dapm_add_routes(dapm, audio_map, ARRAY_SIZE(audio_map));
300 
301 error_ret:
302 	return ret;
303 }
304 
305 #define wm8940_reset(c) snd_soc_write(c, WM8940_SOFTRESET, 0);
306 
307 static int wm8940_set_dai_fmt(struct snd_soc_dai *codec_dai,
308 			      unsigned int fmt)
309 {
310 	struct snd_soc_codec *codec = codec_dai->codec;
311 	u16 iface = snd_soc_read(codec, WM8940_IFACE) & 0xFE67;
312 	u16 clk = snd_soc_read(codec, WM8940_CLOCK) & 0x1fe;
313 
314 	switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
315 	case SND_SOC_DAIFMT_CBM_CFM:
316 		clk |= 1;
317 		break;
318 	case SND_SOC_DAIFMT_CBS_CFS:
319 		break;
320 	default:
321 		return -EINVAL;
322 	}
323 	snd_soc_write(codec, WM8940_CLOCK, clk);
324 
325 	switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
326 	case SND_SOC_DAIFMT_I2S:
327 		iface |= (2 << 3);
328 		break;
329 	case SND_SOC_DAIFMT_LEFT_J:
330 		iface |= (1 << 3);
331 		break;
332 	case SND_SOC_DAIFMT_RIGHT_J:
333 		break;
334 	case SND_SOC_DAIFMT_DSP_A:
335 		iface |= (3 << 3);
336 		break;
337 	case SND_SOC_DAIFMT_DSP_B:
338 		iface |= (3 << 3) | (1 << 7);
339 		break;
340 	}
341 
342 	switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
343 	case SND_SOC_DAIFMT_NB_NF:
344 		break;
345 	case SND_SOC_DAIFMT_NB_IF:
346 		iface |= (1 << 7);
347 		break;
348 	case SND_SOC_DAIFMT_IB_NF:
349 		iface |= (1 << 8);
350 		break;
351 	case SND_SOC_DAIFMT_IB_IF:
352 		iface |= (1 << 8) | (1 << 7);
353 		break;
354 	}
355 
356 	snd_soc_write(codec, WM8940_IFACE, iface);
357 
358 	return 0;
359 }
360 
361 static int wm8940_i2s_hw_params(struct snd_pcm_substream *substream,
362 				struct snd_pcm_hw_params *params,
363 				struct snd_soc_dai *dai)
364 {
365 	struct snd_soc_pcm_runtime *rtd = substream->private_data;
366 	struct snd_soc_codec *codec = rtd->codec;
367 	u16 iface = snd_soc_read(codec, WM8940_IFACE) & 0xFD9F;
368 	u16 addcntrl = snd_soc_read(codec, WM8940_ADDCNTRL) & 0xFFF1;
369 	u16 companding =  snd_soc_read(codec,
370 						WM8940_COMPANDINGCTL) & 0xFFDF;
371 	int ret;
372 
373 	/* LoutR control */
374 	if (substream->stream == SNDRV_PCM_STREAM_CAPTURE
375 	    && params_channels(params) == 2)
376 		iface |= (1 << 9);
377 
378 	switch (params_rate(params)) {
379 	case 8000:
380 		addcntrl |= (0x5 << 1);
381 		break;
382 	case 11025:
383 		addcntrl |= (0x4 << 1);
384 		break;
385 	case 16000:
386 		addcntrl |= (0x3 << 1);
387 		break;
388 	case 22050:
389 		addcntrl |= (0x2 << 1);
390 		break;
391 	case 32000:
392 		addcntrl |= (0x1 << 1);
393 		break;
394 	case 44100:
395 	case 48000:
396 		break;
397 	}
398 	ret = snd_soc_write(codec, WM8940_ADDCNTRL, addcntrl);
399 	if (ret)
400 		goto error_ret;
401 
402 	switch (params_format(params)) {
403 	case SNDRV_PCM_FORMAT_S8:
404 		companding = companding | (1 << 5);
405 		break;
406 	case SNDRV_PCM_FORMAT_S16_LE:
407 		break;
408 	case SNDRV_PCM_FORMAT_S20_3LE:
409 		iface |= (1 << 5);
410 		break;
411 	case SNDRV_PCM_FORMAT_S24_LE:
412 		iface |= (2 << 5);
413 		break;
414 	case SNDRV_PCM_FORMAT_S32_LE:
415 		iface |= (3 << 5);
416 		break;
417 	}
418 	ret = snd_soc_write(codec, WM8940_COMPANDINGCTL, companding);
419 	if (ret)
420 		goto error_ret;
421 	ret = snd_soc_write(codec, WM8940_IFACE, iface);
422 
423 error_ret:
424 	return ret;
425 }
426 
427 static int wm8940_mute(struct snd_soc_dai *dai, int mute)
428 {
429 	struct snd_soc_codec *codec = dai->codec;
430 	u16 mute_reg = snd_soc_read(codec, WM8940_DAC) & 0xffbf;
431 
432 	if (mute)
433 		mute_reg |= 0x40;
434 
435 	return snd_soc_write(codec, WM8940_DAC, mute_reg);
436 }
437 
438 static int wm8940_set_bias_level(struct snd_soc_codec *codec,
439 				 enum snd_soc_bias_level level)
440 {
441 	u16 val;
442 	u16 pwr_reg = snd_soc_read(codec, WM8940_POWER1) & 0x1F0;
443 	int ret = 0;
444 
445 	switch (level) {
446 	case SND_SOC_BIAS_ON:
447 		/* ensure bufioen and biasen */
448 		pwr_reg |= (1 << 2) | (1 << 3);
449 		/* Enable thermal shutdown */
450 		val = snd_soc_read(codec, WM8940_OUTPUTCTL);
451 		ret = snd_soc_write(codec, WM8940_OUTPUTCTL, val | 0x2);
452 		if (ret)
453 			break;
454 		/* set vmid to 75k */
455 		ret = snd_soc_write(codec, WM8940_POWER1, pwr_reg | 0x1);
456 		break;
457 	case SND_SOC_BIAS_PREPARE:
458 		/* ensure bufioen and biasen */
459 		pwr_reg |= (1 << 2) | (1 << 3);
460 		ret = snd_soc_write(codec, WM8940_POWER1, pwr_reg | 0x1);
461 		break;
462 	case SND_SOC_BIAS_STANDBY:
463 		/* ensure bufioen and biasen */
464 		pwr_reg |= (1 << 2) | (1 << 3);
465 		/* set vmid to 300k for standby */
466 		ret = snd_soc_write(codec, WM8940_POWER1, pwr_reg | 0x2);
467 		break;
468 	case SND_SOC_BIAS_OFF:
469 		ret = snd_soc_write(codec, WM8940_POWER1, pwr_reg);
470 		break;
471 	}
472 
473 	return ret;
474 }
475 
476 struct pll_ {
477 	unsigned int pre_scale:2;
478 	unsigned int n:4;
479 	unsigned int k;
480 };
481 
482 static struct pll_ pll_div;
483 
484 /* The size in bits of the pll divide multiplied by 10
485  * to allow rounding later */
486 #define FIXED_PLL_SIZE ((1 << 24) * 10)
487 static void pll_factors(unsigned int target, unsigned int source)
488 {
489 	unsigned long long Kpart;
490 	unsigned int K, Ndiv, Nmod;
491 	/* The left shift ist to avoid accuracy loss when right shifting */
492 	Ndiv = target / source;
493 
494 	if (Ndiv > 12) {
495 		source <<= 1;
496 		/* Multiply by 2 */
497 		pll_div.pre_scale = 0;
498 		Ndiv = target / source;
499 	} else if (Ndiv < 3) {
500 		source >>= 2;
501 		/* Divide by 4 */
502 		pll_div.pre_scale = 3;
503 		Ndiv = target / source;
504 	} else if (Ndiv < 6) {
505 		source >>= 1;
506 		/* divide by 2 */
507 		pll_div.pre_scale = 2;
508 		Ndiv = target / source;
509 	} else
510 		pll_div.pre_scale = 1;
511 
512 	if ((Ndiv < 6) || (Ndiv > 12))
513 		printk(KERN_WARNING
514 			"WM8940 N value %d outwith recommended range!d\n",
515 			Ndiv);
516 
517 	pll_div.n = Ndiv;
518 	Nmod = target % source;
519 	Kpart = FIXED_PLL_SIZE * (long long)Nmod;
520 
521 	do_div(Kpart, source);
522 
523 	K = Kpart & 0xFFFFFFFF;
524 
525 	/* Check if we need to round */
526 	if ((K % 10) >= 5)
527 		K += 5;
528 
529 	/* Move down to proper range now rounding is done */
530 	K /= 10;
531 
532 	pll_div.k = K;
533 }
534 
535 /* Untested at the moment */
536 static int wm8940_set_dai_pll(struct snd_soc_dai *codec_dai, int pll_id,
537 		int source, unsigned int freq_in, unsigned int freq_out)
538 {
539 	struct snd_soc_codec *codec = codec_dai->codec;
540 	u16 reg;
541 
542 	/* Turn off PLL */
543 	reg = snd_soc_read(codec, WM8940_POWER1);
544 	snd_soc_write(codec, WM8940_POWER1, reg & 0x1df);
545 
546 	if (freq_in == 0 || freq_out == 0) {
547 		/* Clock CODEC directly from MCLK */
548 		reg = snd_soc_read(codec, WM8940_CLOCK);
549 		snd_soc_write(codec, WM8940_CLOCK, reg & 0x0ff);
550 		/* Pll power down */
551 		snd_soc_write(codec, WM8940_PLLN, (1 << 7));
552 		return 0;
553 	}
554 
555 	/* Pll is followed by a frequency divide by 4 */
556 	pll_factors(freq_out*4, freq_in);
557 	if (pll_div.k)
558 		snd_soc_write(codec, WM8940_PLLN,
559 			     (pll_div.pre_scale << 4) | pll_div.n | (1 << 6));
560 	else /* No factional component */
561 		snd_soc_write(codec, WM8940_PLLN,
562 			     (pll_div.pre_scale << 4) | pll_div.n);
563 	snd_soc_write(codec, WM8940_PLLK1, pll_div.k >> 18);
564 	snd_soc_write(codec, WM8940_PLLK2, (pll_div.k >> 9) & 0x1ff);
565 	snd_soc_write(codec, WM8940_PLLK3, pll_div.k & 0x1ff);
566 	/* Enable the PLL */
567 	reg = snd_soc_read(codec, WM8940_POWER1);
568 	snd_soc_write(codec, WM8940_POWER1, reg | 0x020);
569 
570 	/* Run CODEC from PLL instead of MCLK */
571 	reg = snd_soc_read(codec, WM8940_CLOCK);
572 	snd_soc_write(codec, WM8940_CLOCK, reg | 0x100);
573 
574 	return 0;
575 }
576 
577 static int wm8940_set_dai_sysclk(struct snd_soc_dai *codec_dai,
578 				 int clk_id, unsigned int freq, int dir)
579 {
580 	struct snd_soc_codec *codec = codec_dai->codec;
581 	struct wm8940_priv *wm8940 = snd_soc_codec_get_drvdata(codec);
582 
583 	switch (freq) {
584 	case 11289600:
585 	case 12000000:
586 	case 12288000:
587 	case 16934400:
588 	case 18432000:
589 		wm8940->sysclk = freq;
590 		return 0;
591 	}
592 	return -EINVAL;
593 }
594 
595 static int wm8940_set_dai_clkdiv(struct snd_soc_dai *codec_dai,
596 				 int div_id, int div)
597 {
598 	struct snd_soc_codec *codec = codec_dai->codec;
599 	u16 reg;
600 	int ret = 0;
601 
602 	switch (div_id) {
603 	case WM8940_BCLKDIV:
604 		reg = snd_soc_read(codec, WM8940_CLOCK) & 0xFFEF3;
605 		ret = snd_soc_write(codec, WM8940_CLOCK, reg | (div << 2));
606 		break;
607 	case WM8940_MCLKDIV:
608 		reg = snd_soc_read(codec, WM8940_CLOCK) & 0xFF1F;
609 		ret = snd_soc_write(codec, WM8940_CLOCK, reg | (div << 5));
610 		break;
611 	case WM8940_OPCLKDIV:
612 		reg = snd_soc_read(codec, WM8940_ADDCNTRL) & 0xFFCF;
613 		ret = snd_soc_write(codec, WM8940_ADDCNTRL, reg | (div << 4));
614 		break;
615 	}
616 	return ret;
617 }
618 
619 #define WM8940_RATES SNDRV_PCM_RATE_8000_48000
620 
621 #define WM8940_FORMATS (SNDRV_PCM_FMTBIT_S8 |				\
622 			SNDRV_PCM_FMTBIT_S16_LE |			\
623 			SNDRV_PCM_FMTBIT_S20_3LE |			\
624 			SNDRV_PCM_FMTBIT_S24_LE |			\
625 			SNDRV_PCM_FMTBIT_S32_LE)
626 
627 static struct snd_soc_dai_ops wm8940_dai_ops = {
628 	.hw_params = wm8940_i2s_hw_params,
629 	.set_sysclk = wm8940_set_dai_sysclk,
630 	.digital_mute = wm8940_mute,
631 	.set_fmt = wm8940_set_dai_fmt,
632 	.set_clkdiv = wm8940_set_dai_clkdiv,
633 	.set_pll = wm8940_set_dai_pll,
634 };
635 
636 static struct snd_soc_dai_driver wm8940_dai = {
637 	.name = "wm8940-hifi",
638 	.playback = {
639 		.stream_name = "Playback",
640 		.channels_min = 1,
641 		.channels_max = 2,
642 		.rates = WM8940_RATES,
643 		.formats = WM8940_FORMATS,
644 	},
645 	.capture = {
646 		.stream_name = "Capture",
647 		.channels_min = 1,
648 		.channels_max = 2,
649 		.rates = WM8940_RATES,
650 		.formats = WM8940_FORMATS,
651 	},
652 	.ops = &wm8940_dai_ops,
653 	.symmetric_rates = 1,
654 };
655 
656 static int wm8940_suspend(struct snd_soc_codec *codec, pm_message_t state)
657 {
658 	return wm8940_set_bias_level(codec, SND_SOC_BIAS_OFF);
659 }
660 
661 static int wm8940_resume(struct snd_soc_codec *codec)
662 {
663 	int i;
664 	int ret;
665 	u8 data[3];
666 	u16 *cache = codec->reg_cache;
667 
668 	/* Sync reg_cache with the hardware
669 	 * Could use auto incremented writes to speed this up
670 	 */
671 	for (i = 0; i < ARRAY_SIZE(wm8940_reg_defaults); i++) {
672 		data[0] = i;
673 		data[1] = (cache[i] & 0xFF00) >> 8;
674 		data[2] = cache[i] & 0x00FF;
675 		ret = codec->hw_write(codec->control_data, data, 3);
676 		if (ret < 0)
677 			goto error_ret;
678 		else if (ret != 3) {
679 			ret = -EIO;
680 			goto error_ret;
681 		}
682 	}
683 	ret = wm8940_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
684 
685 error_ret:
686 	return ret;
687 }
688 
689 static int wm8940_probe(struct snd_soc_codec *codec)
690 {
691 	struct wm8940_priv *wm8940 = snd_soc_codec_get_drvdata(codec);
692 	struct wm8940_setup_data *pdata = codec->dev->platform_data;
693 	int ret;
694 	u16 reg;
695 
696 	codec->control_data = wm8940->control_data;
697 	ret = snd_soc_codec_set_cache_io(codec, 8, 16, wm8940->control_type);
698 	if (ret < 0) {
699 		dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
700 		return ret;
701 	}
702 
703 	ret = wm8940_reset(codec);
704 	if (ret < 0) {
705 		dev_err(codec->dev, "Failed to issue reset\n");
706 		return ret;
707 	}
708 
709 	wm8940_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
710 
711 	ret = snd_soc_write(codec, WM8940_POWER1, 0x180);
712 	if (ret < 0)
713 		return ret;
714 
715 	if (!pdata)
716 		dev_warn(codec->dev, "No platform data supplied\n");
717 	else {
718 		reg = snd_soc_read(codec, WM8940_OUTPUTCTL);
719 		ret = snd_soc_write(codec, WM8940_OUTPUTCTL, reg | pdata->vroi);
720 		if (ret < 0)
721 			return ret;
722 	}
723 
724 	ret = snd_soc_add_controls(codec, wm8940_snd_controls,
725 			     ARRAY_SIZE(wm8940_snd_controls));
726 	if (ret)
727 		return ret;
728 	ret = wm8940_add_widgets(codec);
729 	return ret;
730 }
731 
732 static int wm8940_remove(struct snd_soc_codec *codec)
733 {
734 	wm8940_set_bias_level(codec, SND_SOC_BIAS_OFF);
735 	return 0;
736 }
737 
738 static struct snd_soc_codec_driver soc_codec_dev_wm8940 = {
739 	.probe =	wm8940_probe,
740 	.remove =	wm8940_remove,
741 	.suspend =	wm8940_suspend,
742 	.resume =	wm8940_resume,
743 	.set_bias_level = wm8940_set_bias_level,
744 	.reg_cache_size = ARRAY_SIZE(wm8940_reg_defaults),
745 	.reg_word_size = sizeof(u16),
746 	.reg_cache_default = wm8940_reg_defaults,
747 };
748 
749 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
750 static __devinit int wm8940_i2c_probe(struct i2c_client *i2c,
751 				      const struct i2c_device_id *id)
752 {
753 	struct wm8940_priv *wm8940;
754 	int ret;
755 
756 	wm8940 = kzalloc(sizeof(struct wm8940_priv), GFP_KERNEL);
757 	if (wm8940 == NULL)
758 		return -ENOMEM;
759 
760 	i2c_set_clientdata(i2c, wm8940);
761 	wm8940->control_data = i2c;
762 	wm8940->control_type = SND_SOC_I2C;
763 
764 	ret = snd_soc_register_codec(&i2c->dev,
765 			&soc_codec_dev_wm8940, &wm8940_dai, 1);
766 	if (ret < 0)
767 		kfree(wm8940);
768 	return ret;
769 }
770 
771 static __devexit int wm8940_i2c_remove(struct i2c_client *client)
772 {
773 	snd_soc_unregister_codec(&client->dev);
774 	kfree(i2c_get_clientdata(client));
775 	return 0;
776 }
777 
778 static const struct i2c_device_id wm8940_i2c_id[] = {
779 	{ "wm8940", 0 },
780 	{ }
781 };
782 MODULE_DEVICE_TABLE(i2c, wm8940_i2c_id);
783 
784 static struct i2c_driver wm8940_i2c_driver = {
785 	.driver = {
786 		.name = "wm8940-codec",
787 		.owner = THIS_MODULE,
788 	},
789 	.probe =    wm8940_i2c_probe,
790 	.remove =   __devexit_p(wm8940_i2c_remove),
791 	.id_table = wm8940_i2c_id,
792 };
793 #endif
794 
795 static int __init wm8940_modinit(void)
796 {
797 	int ret = 0;
798 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
799 	ret = i2c_add_driver(&wm8940_i2c_driver);
800 	if (ret != 0) {
801 		printk(KERN_ERR "Failed to register wm8940 I2C driver: %d\n",
802 		       ret);
803 	}
804 #endif
805 	return ret;
806 }
807 module_init(wm8940_modinit);
808 
809 static void __exit wm8940_exit(void)
810 {
811 #if defined(CONFIG_I2C) || defined(CONFIG_I2C_MODULE)
812 	i2c_del_driver(&wm8940_i2c_driver);
813 #endif
814 }
815 module_exit(wm8940_exit);
816 
817 MODULE_DESCRIPTION("ASoC WM8940 driver");
818 MODULE_AUTHOR("Jonathan Cameron");
819 MODULE_LICENSE("GPL");
820