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