2 * wm8960.c -- WM8960 ALSA SoC Audio driver
4 * Copyright 2007-11 Wolfson Microelectronics, plc
6 * Author: Liam Girdwood
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/init.h>
16 #include <linux/delay.h>
18 #include <linux/clk.h>
19 #include <linux/i2c.h>
20 #include <linux/slab.h>
21 #include <sound/core.h>
22 #include <sound/pcm.h>
23 #include <sound/pcm_params.h>
24 #include <sound/soc.h>
25 #include <sound/initval.h>
26 #include <sound/tlv.h>
27 #include <sound/wm8960.h>
32 #define WM8960_VMID_MASK 0x180
33 #define WM8960_VREF 0x40
36 #define WM8960_PWR2_LOUT1 0x40
37 #define WM8960_PWR2_ROUT1 0x20
38 #define WM8960_PWR2_OUT3 0x02
40 /* R28 - Anti-pop 1 */
41 #define WM8960_POBCTRL 0x80
42 #define WM8960_BUFDCOPEN 0x10
43 #define WM8960_BUFIOEN 0x08
44 #define WM8960_SOFT_ST 0x04
45 #define WM8960_HPSTBY 0x01
47 /* R29 - Anti-pop 2 */
48 #define WM8960_DISOP 0x40
49 #define WM8960_DRES_MASK 0x30
51 static bool is_pll_freq_available(unsigned int source, unsigned int target);
52 static int wm8960_set_pll(struct snd_soc_codec *codec,
53 unsigned int freq_in, unsigned int freq_out);
55 * wm8960 register cache
56 * We can't read the WM8960 register space when we are
57 * using 2 wire for device control, so we cache them instead.
59 static const struct reg_default wm8960_reg_defaults[] = {
113 static bool wm8960_volatile(struct device *dev, unsigned int reg)
125 struct regmap *regmap;
126 int (*set_bias_level)(struct snd_soc_codec *,
127 enum snd_soc_bias_level level);
128 struct snd_soc_dapm_widget *lout1;
129 struct snd_soc_dapm_widget *rout1;
130 struct snd_soc_dapm_widget *out3;
137 bool is_stream_in_use[2];
138 struct wm8960_data pdata;
141 #define wm8960_reset(c) regmap_write(c, WM8960_RESET, 0)
143 /* enumerated controls */
144 static const char *wm8960_polarity[] = {"No Inversion", "Left Inverted",
145 "Right Inverted", "Stereo Inversion"};
146 static const char *wm8960_3d_upper_cutoff[] = {"High", "Low"};
147 static const char *wm8960_3d_lower_cutoff[] = {"Low", "High"};
148 static const char *wm8960_alcfunc[] = {"Off", "Right", "Left", "Stereo"};
149 static const char *wm8960_alcmode[] = {"ALC", "Limiter"};
151 static const struct soc_enum wm8960_enum[] = {
152 SOC_ENUM_SINGLE(WM8960_DACCTL1, 5, 4, wm8960_polarity),
153 SOC_ENUM_SINGLE(WM8960_DACCTL2, 5, 4, wm8960_polarity),
154 SOC_ENUM_SINGLE(WM8960_3D, 6, 2, wm8960_3d_upper_cutoff),
155 SOC_ENUM_SINGLE(WM8960_3D, 5, 2, wm8960_3d_lower_cutoff),
156 SOC_ENUM_SINGLE(WM8960_ALC1, 7, 4, wm8960_alcfunc),
157 SOC_ENUM_SINGLE(WM8960_ALC3, 8, 2, wm8960_alcmode),
160 static const int deemph_settings[] = { 0, 32000, 44100, 48000 };
162 static int wm8960_set_deemph(struct snd_soc_codec *codec)
164 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
167 /* If we're using deemphasis select the nearest available sample
170 if (wm8960->deemph) {
172 for (i = 2; i < ARRAY_SIZE(deemph_settings); i++) {
173 if (abs(deemph_settings[i] - wm8960->lrclk) <
174 abs(deemph_settings[best] - wm8960->lrclk))
183 dev_dbg(codec->dev, "Set deemphasis %d\n", val);
185 return snd_soc_update_bits(codec, WM8960_DACCTL1,
189 static int wm8960_get_deemph(struct snd_kcontrol *kcontrol,
190 struct snd_ctl_elem_value *ucontrol)
192 struct snd_soc_codec *codec = snd_soc_kcontrol_codec(kcontrol);
193 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
195 ucontrol->value.integer.value[0] = wm8960->deemph;
199 static int wm8960_put_deemph(struct snd_kcontrol *kcontrol,
200 struct snd_ctl_elem_value *ucontrol)
202 struct snd_soc_codec *codec = snd_soc_kcontrol_codec(kcontrol);
203 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
204 unsigned int deemph = ucontrol->value.integer.value[0];
209 wm8960->deemph = deemph;
211 return wm8960_set_deemph(codec);
214 static const DECLARE_TLV_DB_SCALE(adc_tlv, -9750, 50, 1);
215 static const DECLARE_TLV_DB_SCALE(inpga_tlv, -1725, 75, 0);
216 static const DECLARE_TLV_DB_SCALE(dac_tlv, -12750, 50, 1);
217 static const DECLARE_TLV_DB_SCALE(bypass_tlv, -2100, 300, 0);
218 static const DECLARE_TLV_DB_SCALE(out_tlv, -12100, 100, 1);
219 static const DECLARE_TLV_DB_SCALE(lineinboost_tlv, -1500, 300, 1);
220 static const unsigned int micboost_tlv[] = {
221 TLV_DB_RANGE_HEAD(2),
222 0, 1, TLV_DB_SCALE_ITEM(0, 1300, 0),
223 2, 3, TLV_DB_SCALE_ITEM(2000, 900, 0),
226 static const struct snd_kcontrol_new wm8960_snd_controls[] = {
227 SOC_DOUBLE_R_TLV("Capture Volume", WM8960_LINVOL, WM8960_RINVOL,
228 0, 63, 0, inpga_tlv),
229 SOC_DOUBLE_R("Capture Volume ZC Switch", WM8960_LINVOL, WM8960_RINVOL,
231 SOC_DOUBLE_R("Capture Switch", WM8960_LINVOL, WM8960_RINVOL,
234 SOC_SINGLE_TLV("Right Input Boost Mixer RINPUT3 Volume",
235 WM8960_INBMIX1, 4, 7, 0, lineinboost_tlv),
236 SOC_SINGLE_TLV("Right Input Boost Mixer RINPUT2 Volume",
237 WM8960_INBMIX1, 1, 7, 0, lineinboost_tlv),
238 SOC_SINGLE_TLV("Left Input Boost Mixer LINPUT3 Volume",
239 WM8960_INBMIX2, 4, 7, 0, lineinboost_tlv),
240 SOC_SINGLE_TLV("Left Input Boost Mixer LINPUT2 Volume",
241 WM8960_INBMIX2, 1, 7, 0, lineinboost_tlv),
242 SOC_SINGLE_TLV("Right Input Boost Mixer RINPUT1 Volume",
243 WM8960_RINPATH, 4, 3, 0, micboost_tlv),
244 SOC_SINGLE_TLV("Left Input Boost Mixer LINPUT1 Volume",
245 WM8960_LINPATH, 4, 3, 0, micboost_tlv),
247 SOC_DOUBLE_R_TLV("Playback Volume", WM8960_LDAC, WM8960_RDAC,
250 SOC_DOUBLE_R_TLV("Headphone Playback Volume", WM8960_LOUT1, WM8960_ROUT1,
252 SOC_DOUBLE_R("Headphone Playback ZC Switch", WM8960_LOUT1, WM8960_ROUT1,
255 SOC_DOUBLE_R_TLV("Speaker Playback Volume", WM8960_LOUT2, WM8960_ROUT2,
257 SOC_DOUBLE_R("Speaker Playback ZC Switch", WM8960_LOUT2, WM8960_ROUT2,
259 SOC_SINGLE("Speaker DC Volume", WM8960_CLASSD3, 3, 5, 0),
260 SOC_SINGLE("Speaker AC Volume", WM8960_CLASSD3, 0, 5, 0),
262 SOC_SINGLE("PCM Playback -6dB Switch", WM8960_DACCTL1, 7, 1, 0),
263 SOC_ENUM("ADC Polarity", wm8960_enum[0]),
264 SOC_SINGLE("ADC High Pass Filter Switch", WM8960_DACCTL1, 0, 1, 0),
266 SOC_ENUM("DAC Polarity", wm8960_enum[1]),
267 SOC_SINGLE_BOOL_EXT("DAC Deemphasis Switch", 0,
268 wm8960_get_deemph, wm8960_put_deemph),
270 SOC_ENUM("3D Filter Upper Cut-Off", wm8960_enum[2]),
271 SOC_ENUM("3D Filter Lower Cut-Off", wm8960_enum[3]),
272 SOC_SINGLE("3D Volume", WM8960_3D, 1, 15, 0),
273 SOC_SINGLE("3D Switch", WM8960_3D, 0, 1, 0),
275 SOC_ENUM("ALC Function", wm8960_enum[4]),
276 SOC_SINGLE("ALC Max Gain", WM8960_ALC1, 4, 7, 0),
277 SOC_SINGLE("ALC Target", WM8960_ALC1, 0, 15, 1),
278 SOC_SINGLE("ALC Min Gain", WM8960_ALC2, 4, 7, 0),
279 SOC_SINGLE("ALC Hold Time", WM8960_ALC2, 0, 15, 0),
280 SOC_ENUM("ALC Mode", wm8960_enum[5]),
281 SOC_SINGLE("ALC Decay", WM8960_ALC3, 4, 15, 0),
282 SOC_SINGLE("ALC Attack", WM8960_ALC3, 0, 15, 0),
284 SOC_SINGLE("Noise Gate Threshold", WM8960_NOISEG, 3, 31, 0),
285 SOC_SINGLE("Noise Gate Switch", WM8960_NOISEG, 0, 1, 0),
287 SOC_DOUBLE_R_TLV("ADC PCM Capture Volume", WM8960_LADC, WM8960_RADC,
290 SOC_SINGLE_TLV("Left Output Mixer Boost Bypass Volume",
291 WM8960_BYPASS1, 4, 7, 1, bypass_tlv),
292 SOC_SINGLE_TLV("Left Output Mixer LINPUT3 Volume",
293 WM8960_LOUTMIX, 4, 7, 1, bypass_tlv),
294 SOC_SINGLE_TLV("Right Output Mixer Boost Bypass Volume",
295 WM8960_BYPASS2, 4, 7, 1, bypass_tlv),
296 SOC_SINGLE_TLV("Right Output Mixer RINPUT3 Volume",
297 WM8960_ROUTMIX, 4, 7, 1, bypass_tlv),
300 static const struct snd_kcontrol_new wm8960_lin_boost[] = {
301 SOC_DAPM_SINGLE("LINPUT2 Switch", WM8960_LINPATH, 6, 1, 0),
302 SOC_DAPM_SINGLE("LINPUT3 Switch", WM8960_LINPATH, 7, 1, 0),
303 SOC_DAPM_SINGLE("LINPUT1 Switch", WM8960_LINPATH, 8, 1, 0),
306 static const struct snd_kcontrol_new wm8960_lin[] = {
307 SOC_DAPM_SINGLE("Boost Switch", WM8960_LINPATH, 3, 1, 0),
310 static const struct snd_kcontrol_new wm8960_rin_boost[] = {
311 SOC_DAPM_SINGLE("RINPUT2 Switch", WM8960_RINPATH, 6, 1, 0),
312 SOC_DAPM_SINGLE("RINPUT3 Switch", WM8960_RINPATH, 7, 1, 0),
313 SOC_DAPM_SINGLE("RINPUT1 Switch", WM8960_RINPATH, 8, 1, 0),
316 static const struct snd_kcontrol_new wm8960_rin[] = {
317 SOC_DAPM_SINGLE("Boost Switch", WM8960_RINPATH, 3, 1, 0),
320 static const struct snd_kcontrol_new wm8960_loutput_mixer[] = {
321 SOC_DAPM_SINGLE("PCM Playback Switch", WM8960_LOUTMIX, 8, 1, 0),
322 SOC_DAPM_SINGLE("LINPUT3 Switch", WM8960_LOUTMIX, 7, 1, 0),
323 SOC_DAPM_SINGLE("Boost Bypass Switch", WM8960_BYPASS1, 7, 1, 0),
326 static const struct snd_kcontrol_new wm8960_routput_mixer[] = {
327 SOC_DAPM_SINGLE("PCM Playback Switch", WM8960_ROUTMIX, 8, 1, 0),
328 SOC_DAPM_SINGLE("RINPUT3 Switch", WM8960_ROUTMIX, 7, 1, 0),
329 SOC_DAPM_SINGLE("Boost Bypass Switch", WM8960_BYPASS2, 7, 1, 0),
332 static const struct snd_kcontrol_new wm8960_mono_out[] = {
333 SOC_DAPM_SINGLE("Left Switch", WM8960_MONOMIX1, 7, 1, 0),
334 SOC_DAPM_SINGLE("Right Switch", WM8960_MONOMIX2, 7, 1, 0),
337 static const struct snd_soc_dapm_widget wm8960_dapm_widgets[] = {
338 SND_SOC_DAPM_INPUT("LINPUT1"),
339 SND_SOC_DAPM_INPUT("RINPUT1"),
340 SND_SOC_DAPM_INPUT("LINPUT2"),
341 SND_SOC_DAPM_INPUT("RINPUT2"),
342 SND_SOC_DAPM_INPUT("LINPUT3"),
343 SND_SOC_DAPM_INPUT("RINPUT3"),
345 SND_SOC_DAPM_SUPPLY("MICB", WM8960_POWER1, 1, 0, NULL, 0),
347 SND_SOC_DAPM_MIXER("Left Boost Mixer", WM8960_POWER1, 5, 0,
348 wm8960_lin_boost, ARRAY_SIZE(wm8960_lin_boost)),
349 SND_SOC_DAPM_MIXER("Right Boost Mixer", WM8960_POWER1, 4, 0,
350 wm8960_rin_boost, ARRAY_SIZE(wm8960_rin_boost)),
352 SND_SOC_DAPM_MIXER("Left Input Mixer", WM8960_POWER3, 5, 0,
353 wm8960_lin, ARRAY_SIZE(wm8960_lin)),
354 SND_SOC_DAPM_MIXER("Right Input Mixer", WM8960_POWER3, 4, 0,
355 wm8960_rin, ARRAY_SIZE(wm8960_rin)),
357 SND_SOC_DAPM_ADC("Left ADC", "Capture", WM8960_POWER1, 3, 0),
358 SND_SOC_DAPM_ADC("Right ADC", "Capture", WM8960_POWER1, 2, 0),
360 SND_SOC_DAPM_DAC("Left DAC", "Playback", WM8960_POWER2, 8, 0),
361 SND_SOC_DAPM_DAC("Right DAC", "Playback", WM8960_POWER2, 7, 0),
363 SND_SOC_DAPM_MIXER("Left Output Mixer", WM8960_POWER3, 3, 0,
364 &wm8960_loutput_mixer[0],
365 ARRAY_SIZE(wm8960_loutput_mixer)),
366 SND_SOC_DAPM_MIXER("Right Output Mixer", WM8960_POWER3, 2, 0,
367 &wm8960_routput_mixer[0],
368 ARRAY_SIZE(wm8960_routput_mixer)),
370 SND_SOC_DAPM_PGA("LOUT1 PGA", WM8960_POWER2, 6, 0, NULL, 0),
371 SND_SOC_DAPM_PGA("ROUT1 PGA", WM8960_POWER2, 5, 0, NULL, 0),
373 SND_SOC_DAPM_PGA("Left Speaker PGA", WM8960_POWER2, 4, 0, NULL, 0),
374 SND_SOC_DAPM_PGA("Right Speaker PGA", WM8960_POWER2, 3, 0, NULL, 0),
376 SND_SOC_DAPM_PGA("Right Speaker Output", WM8960_CLASSD1, 7, 0, NULL, 0),
377 SND_SOC_DAPM_PGA("Left Speaker Output", WM8960_CLASSD1, 6, 0, NULL, 0),
379 SND_SOC_DAPM_OUTPUT("SPK_LP"),
380 SND_SOC_DAPM_OUTPUT("SPK_LN"),
381 SND_SOC_DAPM_OUTPUT("HP_L"),
382 SND_SOC_DAPM_OUTPUT("HP_R"),
383 SND_SOC_DAPM_OUTPUT("SPK_RP"),
384 SND_SOC_DAPM_OUTPUT("SPK_RN"),
385 SND_SOC_DAPM_OUTPUT("OUT3"),
388 static const struct snd_soc_dapm_widget wm8960_dapm_widgets_out3[] = {
389 SND_SOC_DAPM_MIXER("Mono Output Mixer", WM8960_POWER2, 1, 0,
391 ARRAY_SIZE(wm8960_mono_out)),
394 /* Represent OUT3 as a PGA so that it gets turned on with LOUT1/ROUT1 */
395 static const struct snd_soc_dapm_widget wm8960_dapm_widgets_capless[] = {
396 SND_SOC_DAPM_PGA("OUT3 VMID", WM8960_POWER2, 1, 0, NULL, 0),
399 static const struct snd_soc_dapm_route audio_paths[] = {
400 { "Left Boost Mixer", "LINPUT1 Switch", "LINPUT1" },
401 { "Left Boost Mixer", "LINPUT2 Switch", "LINPUT2" },
402 { "Left Boost Mixer", "LINPUT3 Switch", "LINPUT3" },
404 { "Left Input Mixer", "Boost Switch", "Left Boost Mixer", },
405 { "Left Input Mixer", NULL, "LINPUT1", }, /* Really Boost Switch */
406 { "Left Input Mixer", NULL, "LINPUT2" },
407 { "Left Input Mixer", NULL, "LINPUT3" },
409 { "Right Boost Mixer", "RINPUT1 Switch", "RINPUT1" },
410 { "Right Boost Mixer", "RINPUT2 Switch", "RINPUT2" },
411 { "Right Boost Mixer", "RINPUT3 Switch", "RINPUT3" },
413 { "Right Input Mixer", "Boost Switch", "Right Boost Mixer", },
414 { "Right Input Mixer", NULL, "RINPUT1", }, /* Really Boost Switch */
415 { "Right Input Mixer", NULL, "RINPUT2" },
416 { "Right Input Mixer", NULL, "RINPUT3" },
418 { "Left ADC", NULL, "Left Input Mixer" },
419 { "Right ADC", NULL, "Right Input Mixer" },
421 { "Left Output Mixer", "LINPUT3 Switch", "LINPUT3" },
422 { "Left Output Mixer", "Boost Bypass Switch", "Left Boost Mixer"} ,
423 { "Left Output Mixer", "PCM Playback Switch", "Left DAC" },
425 { "Right Output Mixer", "RINPUT3 Switch", "RINPUT3" },
426 { "Right Output Mixer", "Boost Bypass Switch", "Right Boost Mixer" } ,
427 { "Right Output Mixer", "PCM Playback Switch", "Right DAC" },
429 { "LOUT1 PGA", NULL, "Left Output Mixer" },
430 { "ROUT1 PGA", NULL, "Right Output Mixer" },
432 { "HP_L", NULL, "LOUT1 PGA" },
433 { "HP_R", NULL, "ROUT1 PGA" },
435 { "Left Speaker PGA", NULL, "Left Output Mixer" },
436 { "Right Speaker PGA", NULL, "Right Output Mixer" },
438 { "Left Speaker Output", NULL, "Left Speaker PGA" },
439 { "Right Speaker Output", NULL, "Right Speaker PGA" },
441 { "SPK_LN", NULL, "Left Speaker Output" },
442 { "SPK_LP", NULL, "Left Speaker Output" },
443 { "SPK_RN", NULL, "Right Speaker Output" },
444 { "SPK_RP", NULL, "Right Speaker Output" },
447 static const struct snd_soc_dapm_route audio_paths_out3[] = {
448 { "Mono Output Mixer", "Left Switch", "Left Output Mixer" },
449 { "Mono Output Mixer", "Right Switch", "Right Output Mixer" },
451 { "OUT3", NULL, "Mono Output Mixer", }
454 static const struct snd_soc_dapm_route audio_paths_capless[] = {
455 { "HP_L", NULL, "OUT3 VMID" },
456 { "HP_R", NULL, "OUT3 VMID" },
458 { "OUT3 VMID", NULL, "Left Output Mixer" },
459 { "OUT3 VMID", NULL, "Right Output Mixer" },
462 static int wm8960_add_widgets(struct snd_soc_codec *codec)
464 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
465 struct wm8960_data *pdata = &wm8960->pdata;
466 struct snd_soc_dapm_context *dapm = snd_soc_codec_get_dapm(codec);
467 struct snd_soc_dapm_widget *w;
469 snd_soc_dapm_new_controls(dapm, wm8960_dapm_widgets,
470 ARRAY_SIZE(wm8960_dapm_widgets));
472 snd_soc_dapm_add_routes(dapm, audio_paths, ARRAY_SIZE(audio_paths));
474 /* In capless mode OUT3 is used to provide VMID for the
475 * headphone outputs, otherwise it is used as a mono mixer.
477 if (pdata && pdata->capless) {
478 snd_soc_dapm_new_controls(dapm, wm8960_dapm_widgets_capless,
479 ARRAY_SIZE(wm8960_dapm_widgets_capless));
481 snd_soc_dapm_add_routes(dapm, audio_paths_capless,
482 ARRAY_SIZE(audio_paths_capless));
484 snd_soc_dapm_new_controls(dapm, wm8960_dapm_widgets_out3,
485 ARRAY_SIZE(wm8960_dapm_widgets_out3));
487 snd_soc_dapm_add_routes(dapm, audio_paths_out3,
488 ARRAY_SIZE(audio_paths_out3));
491 /* We need to power up the headphone output stage out of
492 * sequence for capless mode. To save scanning the widget
493 * list each time to find the desired power state do so now
494 * and save the result.
496 list_for_each_entry(w, &codec->component.card->widgets, list) {
499 if (strcmp(w->name, "LOUT1 PGA") == 0)
501 if (strcmp(w->name, "ROUT1 PGA") == 0)
503 if (strcmp(w->name, "OUT3 VMID") == 0)
510 static int wm8960_set_dai_fmt(struct snd_soc_dai *codec_dai,
513 struct snd_soc_codec *codec = codec_dai->codec;
516 /* set master/slave audio interface */
517 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
518 case SND_SOC_DAIFMT_CBM_CFM:
521 case SND_SOC_DAIFMT_CBS_CFS:
527 /* interface format */
528 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
529 case SND_SOC_DAIFMT_I2S:
532 case SND_SOC_DAIFMT_RIGHT_J:
534 case SND_SOC_DAIFMT_LEFT_J:
537 case SND_SOC_DAIFMT_DSP_A:
540 case SND_SOC_DAIFMT_DSP_B:
547 /* clock inversion */
548 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
549 case SND_SOC_DAIFMT_NB_NF:
551 case SND_SOC_DAIFMT_IB_IF:
554 case SND_SOC_DAIFMT_IB_NF:
557 case SND_SOC_DAIFMT_NB_IF:
565 snd_soc_write(codec, WM8960_IFACE1, iface);
584 /* -1 for reserved value */
585 static const int sysclk_divs[] = { 1, -1, 2, -1 };
587 /* Multiply 256 for internal 256 div */
588 static const int dac_divs[] = { 256, 384, 512, 768, 1024, 1408, 1536 };
590 /* Multiply 10 to eliminate decimials */
591 static const int bclk_divs[] = {
592 10, 15, 20, 30, 40, 55, 60, 80, 110,
593 120, 160, 220, 240, 320, 320, 320
596 static int wm8960_configure_clocking(struct snd_soc_codec *codec)
598 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
599 int sysclk, bclk, lrclk, freq_out, freq_in;
600 u16 iface1 = snd_soc_read(codec, WM8960_IFACE1);
603 if (!(iface1 & (1<<6))) {
605 "Codec is slave mode, no need to configure clock\n");
609 if (wm8960->clk_id != WM8960_SYSCLK_MCLK && !wm8960->freq_in) {
610 dev_err(codec->dev, "No MCLK configured\n");
614 freq_in = wm8960->freq_in;
616 lrclk = wm8960->lrclk;
618 * If it's sysclk auto mode, check if the MCLK can provide sysclk or
619 * not. If MCLK can provide sysclk, using MCLK to provide sysclk
620 * directly. Otherwise, auto select a available pll out frequency
623 if (wm8960->clk_id == WM8960_SYSCLK_AUTO) {
624 /* disable the PLL and using MCLK to provide sysclk */
625 wm8960_set_pll(codec, 0, 0);
627 } else if (wm8960->sysclk) {
628 freq_out = wm8960->sysclk;
630 dev_err(codec->dev, "No SYSCLK configured\n");
634 /* check if the sysclk frequency is available. */
635 for (i = 0; i < ARRAY_SIZE(sysclk_divs); ++i) {
636 if (sysclk_divs[i] == -1)
638 sysclk = freq_out / sysclk_divs[i];
639 for (j = 0; j < ARRAY_SIZE(dac_divs); ++j) {
640 if (sysclk == dac_divs[j] * lrclk) {
641 for (k = 0; k < ARRAY_SIZE(bclk_divs); ++k)
642 if (sysclk == bclk * bclk_divs[k] / 10)
644 if (k != ARRAY_SIZE(bclk_divs))
648 if (j != ARRAY_SIZE(dac_divs))
652 if (i != ARRAY_SIZE(sysclk_divs)) {
653 goto configure_clock;
654 } else if (wm8960->clk_id != WM8960_SYSCLK_AUTO) {
655 dev_err(codec->dev, "failed to configure clock\n");
658 /* get a available pll out frequency and set pll */
659 for (i = 0; i < ARRAY_SIZE(sysclk_divs); ++i) {
660 if (sysclk_divs[i] == -1)
662 for (j = 0; j < ARRAY_SIZE(dac_divs); ++j) {
663 sysclk = lrclk * dac_divs[j];
664 freq_out = sysclk * sysclk_divs[i];
666 for (k = 0; k < ARRAY_SIZE(bclk_divs); ++k) {
667 if (sysclk == bclk * bclk_divs[k] / 10 &&
668 is_pll_freq_available(freq_in, freq_out)) {
669 wm8960_set_pll(codec,
676 if (k != ARRAY_SIZE(bclk_divs))
679 if (j != ARRAY_SIZE(dac_divs))
683 if (i == ARRAY_SIZE(sysclk_divs)) {
684 dev_err(codec->dev, "failed to configure clock\n");
689 /* configure sysclk clock */
690 snd_soc_update_bits(codec, WM8960_CLOCK1, 3 << 1, i << 1);
692 /* configure frame clock */
693 snd_soc_update_bits(codec, WM8960_CLOCK1, 0x7 << 3, j << 3);
694 snd_soc_update_bits(codec, WM8960_CLOCK1, 0x7 << 6, j << 6);
696 /* configure bit clock */
697 snd_soc_update_bits(codec, WM8960_CLOCK2, 0xf, k);
702 static int wm8960_hw_params(struct snd_pcm_substream *substream,
703 struct snd_pcm_hw_params *params,
704 struct snd_soc_dai *dai)
706 struct snd_soc_codec *codec = dai->codec;
707 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
708 u16 iface = snd_soc_read(codec, WM8960_IFACE1) & 0xfff3;
709 bool tx = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
712 wm8960->bclk = snd_soc_params_to_bclk(params);
713 if (params_channels(params) == 1)
717 switch (params_width(params)) {
727 /* right justify mode does not support 32 word length */
728 if ((iface & 0x3) != 0) {
733 dev_err(codec->dev, "unsupported width %d\n",
734 params_width(params));
738 wm8960->lrclk = params_rate(params);
739 /* Update filters for the new rate */
741 wm8960_set_deemph(codec);
743 for (i = 0; i < ARRAY_SIZE(alc_rates); i++)
744 if (alc_rates[i].rate == params_rate(params))
745 snd_soc_update_bits(codec,
751 snd_soc_write(codec, WM8960_IFACE1, iface);
753 wm8960->is_stream_in_use[tx] = true;
755 if (snd_soc_codec_get_bias_level(codec) == SND_SOC_BIAS_ON &&
756 !wm8960->is_stream_in_use[!tx])
757 return wm8960_configure_clocking(codec);
762 static int wm8960_hw_free(struct snd_pcm_substream *substream,
763 struct snd_soc_dai *dai)
765 struct snd_soc_codec *codec = dai->codec;
766 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
767 bool tx = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
769 wm8960->is_stream_in_use[tx] = false;
774 static int wm8960_mute(struct snd_soc_dai *dai, int mute)
776 struct snd_soc_codec *codec = dai->codec;
779 snd_soc_update_bits(codec, WM8960_DACCTL1, 0x8, 0x8);
781 snd_soc_update_bits(codec, WM8960_DACCTL1, 0x8, 0);
785 static int wm8960_set_bias_level_out3(struct snd_soc_codec *codec,
786 enum snd_soc_bias_level level)
788 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
789 u16 pm2 = snd_soc_read(codec, WM8960_POWER2);
793 case SND_SOC_BIAS_ON:
796 case SND_SOC_BIAS_PREPARE:
797 switch (snd_soc_codec_get_bias_level(codec)) {
798 case SND_SOC_BIAS_STANDBY:
799 if (!IS_ERR(wm8960->mclk)) {
800 ret = clk_prepare_enable(wm8960->mclk);
803 "Failed to enable MCLK: %d\n",
809 ret = wm8960_configure_clocking(codec);
813 /* Set VMID to 2x50k */
814 snd_soc_update_bits(codec, WM8960_POWER1, 0x180, 0x80);
817 case SND_SOC_BIAS_ON:
819 * If it's sysclk auto mode, and the pll is enabled,
822 if (wm8960->clk_id == WM8960_SYSCLK_AUTO && (pm2 & 0x1))
823 wm8960_set_pll(codec, 0, 0);
825 if (!IS_ERR(wm8960->mclk))
826 clk_disable_unprepare(wm8960->mclk);
835 case SND_SOC_BIAS_STANDBY:
836 if (snd_soc_codec_get_bias_level(codec) == SND_SOC_BIAS_OFF) {
837 regcache_sync(wm8960->regmap);
839 /* Enable anti-pop features */
840 snd_soc_write(codec, WM8960_APOP1,
841 WM8960_POBCTRL | WM8960_SOFT_ST |
842 WM8960_BUFDCOPEN | WM8960_BUFIOEN);
844 /* Enable & ramp VMID at 2x50k */
845 snd_soc_update_bits(codec, WM8960_POWER1, 0x80, 0x80);
849 snd_soc_update_bits(codec, WM8960_POWER1, WM8960_VREF,
852 /* Disable anti-pop features */
853 snd_soc_write(codec, WM8960_APOP1, WM8960_BUFIOEN);
856 /* Set VMID to 2x250k */
857 snd_soc_update_bits(codec, WM8960_POWER1, 0x180, 0x100);
860 case SND_SOC_BIAS_OFF:
861 /* Enable anti-pop features */
862 snd_soc_write(codec, WM8960_APOP1,
863 WM8960_POBCTRL | WM8960_SOFT_ST |
864 WM8960_BUFDCOPEN | WM8960_BUFIOEN);
866 /* Disable VMID and VREF, let them discharge */
867 snd_soc_write(codec, WM8960_POWER1, 0);
875 static int wm8960_set_bias_level_capless(struct snd_soc_codec *codec,
876 enum snd_soc_bias_level level)
878 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
879 u16 pm2 = snd_soc_read(codec, WM8960_POWER2);
883 case SND_SOC_BIAS_ON:
886 case SND_SOC_BIAS_PREPARE:
887 switch (snd_soc_codec_get_bias_level(codec)) {
888 case SND_SOC_BIAS_STANDBY:
889 /* Enable anti pop mode */
890 snd_soc_update_bits(codec, WM8960_APOP1,
891 WM8960_POBCTRL | WM8960_SOFT_ST |
893 WM8960_POBCTRL | WM8960_SOFT_ST |
896 /* Enable LOUT1, ROUT1 and OUT3 if they're enabled */
898 if (wm8960->lout1 && wm8960->lout1->power)
899 reg |= WM8960_PWR2_LOUT1;
900 if (wm8960->rout1 && wm8960->rout1->power)
901 reg |= WM8960_PWR2_ROUT1;
902 if (wm8960->out3 && wm8960->out3->power)
903 reg |= WM8960_PWR2_OUT3;
904 snd_soc_update_bits(codec, WM8960_POWER2,
907 WM8960_PWR2_OUT3, reg);
909 /* Enable VMID at 2*50k */
910 snd_soc_update_bits(codec, WM8960_POWER1,
911 WM8960_VMID_MASK, 0x80);
917 snd_soc_update_bits(codec, WM8960_POWER1,
918 WM8960_VREF, WM8960_VREF);
922 if (!IS_ERR(wm8960->mclk)) {
923 ret = clk_prepare_enable(wm8960->mclk);
926 "Failed to enable MCLK: %d\n",
932 ret = wm8960_configure_clocking(codec);
938 case SND_SOC_BIAS_ON:
940 * If it's sysclk auto mode, and the pll is enabled,
943 if (wm8960->clk_id == WM8960_SYSCLK_AUTO && (pm2 & 0x1))
944 wm8960_set_pll(codec, 0, 0);
946 if (!IS_ERR(wm8960->mclk))
947 clk_disable_unprepare(wm8960->mclk);
949 /* Enable anti-pop mode */
950 snd_soc_update_bits(codec, WM8960_APOP1,
951 WM8960_POBCTRL | WM8960_SOFT_ST |
953 WM8960_POBCTRL | WM8960_SOFT_ST |
956 /* Disable VMID and VREF */
957 snd_soc_update_bits(codec, WM8960_POWER1,
958 WM8960_VREF | WM8960_VMID_MASK, 0);
961 case SND_SOC_BIAS_OFF:
962 regcache_sync(wm8960->regmap);
969 case SND_SOC_BIAS_STANDBY:
970 switch (snd_soc_codec_get_bias_level(codec)) {
971 case SND_SOC_BIAS_PREPARE:
972 /* Disable HP discharge */
973 snd_soc_update_bits(codec, WM8960_APOP2,
974 WM8960_DISOP | WM8960_DRES_MASK,
977 /* Disable anti-pop features */
978 snd_soc_update_bits(codec, WM8960_APOP1,
979 WM8960_POBCTRL | WM8960_SOFT_ST |
981 WM8960_POBCTRL | WM8960_SOFT_ST |
990 case SND_SOC_BIAS_OFF:
1004 static bool is_pll_freq_available(unsigned int source, unsigned int target)
1008 if (source == 0 || target == 0)
1011 /* Scale up target to PLL operating frequency */
1013 Ndiv = target / source;
1017 Ndiv = target / source;
1020 if ((Ndiv < 6) || (Ndiv > 12))
1026 /* The size in bits of the pll divide multiplied by 10
1027 * to allow rounding later */
1028 #define FIXED_PLL_SIZE ((1 << 24) * 10)
1030 static int pll_factors(unsigned int source, unsigned int target,
1031 struct _pll_div *pll_div)
1033 unsigned long long Kpart;
1034 unsigned int K, Ndiv, Nmod;
1036 pr_debug("WM8960 PLL: setting %dHz->%dHz\n", source, target);
1038 /* Scale up target to PLL operating frequency */
1041 Ndiv = target / source;
1044 pll_div->pre_div = 1;
1045 Ndiv = target / source;
1047 pll_div->pre_div = 0;
1049 if ((Ndiv < 6) || (Ndiv > 12)) {
1050 pr_err("WM8960 PLL: Unsupported N=%d\n", Ndiv);
1055 Nmod = target % source;
1056 Kpart = FIXED_PLL_SIZE * (long long)Nmod;
1058 do_div(Kpart, source);
1060 K = Kpart & 0xFFFFFFFF;
1062 /* Check if we need to round */
1066 /* Move down to proper range now rounding is done */
1071 pr_debug("WM8960 PLL: N=%x K=%x pre_div=%d\n",
1072 pll_div->n, pll_div->k, pll_div->pre_div);
1077 static int wm8960_set_pll(struct snd_soc_codec *codec,
1078 unsigned int freq_in, unsigned int freq_out)
1081 static struct _pll_div pll_div;
1084 if (freq_in && freq_out) {
1085 ret = pll_factors(freq_in, freq_out, &pll_div);
1090 /* Disable the PLL: even if we are changing the frequency the
1091 * PLL needs to be disabled while we do so. */
1092 snd_soc_update_bits(codec, WM8960_CLOCK1, 0x1, 0);
1093 snd_soc_update_bits(codec, WM8960_POWER2, 0x1, 0);
1095 if (!freq_in || !freq_out)
1098 reg = snd_soc_read(codec, WM8960_PLL1) & ~0x3f;
1099 reg |= pll_div.pre_div << 4;
1105 snd_soc_write(codec, WM8960_PLL2, (pll_div.k >> 16) & 0xff);
1106 snd_soc_write(codec, WM8960_PLL3, (pll_div.k >> 8) & 0xff);
1107 snd_soc_write(codec, WM8960_PLL4, pll_div.k & 0xff);
1109 snd_soc_write(codec, WM8960_PLL1, reg);
1112 snd_soc_update_bits(codec, WM8960_POWER2, 0x1, 0x1);
1114 snd_soc_update_bits(codec, WM8960_CLOCK1, 0x1, 0x1);
1119 static int wm8960_set_dai_pll(struct snd_soc_dai *codec_dai, int pll_id,
1120 int source, unsigned int freq_in, unsigned int freq_out)
1122 struct snd_soc_codec *codec = codec_dai->codec;
1123 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
1125 wm8960->freq_in = freq_in;
1127 if (pll_id == WM8960_SYSCLK_AUTO)
1130 return wm8960_set_pll(codec, freq_in, freq_out);
1133 static int wm8960_set_dai_clkdiv(struct snd_soc_dai *codec_dai,
1134 int div_id, int div)
1136 struct snd_soc_codec *codec = codec_dai->codec;
1140 case WM8960_SYSCLKDIV:
1141 reg = snd_soc_read(codec, WM8960_CLOCK1) & 0x1f9;
1142 snd_soc_write(codec, WM8960_CLOCK1, reg | div);
1145 reg = snd_soc_read(codec, WM8960_CLOCK1) & 0x1c7;
1146 snd_soc_write(codec, WM8960_CLOCK1, reg | div);
1148 case WM8960_OPCLKDIV:
1149 reg = snd_soc_read(codec, WM8960_PLL1) & 0x03f;
1150 snd_soc_write(codec, WM8960_PLL1, reg | div);
1152 case WM8960_DCLKDIV:
1153 reg = snd_soc_read(codec, WM8960_CLOCK2) & 0x03f;
1154 snd_soc_write(codec, WM8960_CLOCK2, reg | div);
1156 case WM8960_TOCLKSEL:
1157 reg = snd_soc_read(codec, WM8960_ADDCTL1) & 0x1fd;
1158 snd_soc_write(codec, WM8960_ADDCTL1, reg | div);
1167 static int wm8960_set_bias_level(struct snd_soc_codec *codec,
1168 enum snd_soc_bias_level level)
1170 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
1172 return wm8960->set_bias_level(codec, level);
1175 static int wm8960_set_dai_sysclk(struct snd_soc_dai *dai, int clk_id,
1176 unsigned int freq, int dir)
1178 struct snd_soc_codec *codec = dai->codec;
1179 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
1182 case WM8960_SYSCLK_MCLK:
1183 snd_soc_update_bits(codec, WM8960_CLOCK1,
1184 0x1, WM8960_SYSCLK_MCLK);
1186 case WM8960_SYSCLK_PLL:
1187 snd_soc_update_bits(codec, WM8960_CLOCK1,
1188 0x1, WM8960_SYSCLK_PLL);
1190 case WM8960_SYSCLK_AUTO:
1196 wm8960->sysclk = freq;
1197 wm8960->clk_id = clk_id;
1202 #define WM8960_RATES SNDRV_PCM_RATE_8000_48000
1204 #define WM8960_FORMATS \
1205 (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE | \
1206 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
1208 static const struct snd_soc_dai_ops wm8960_dai_ops = {
1209 .hw_params = wm8960_hw_params,
1210 .hw_free = wm8960_hw_free,
1211 .digital_mute = wm8960_mute,
1212 .set_fmt = wm8960_set_dai_fmt,
1213 .set_clkdiv = wm8960_set_dai_clkdiv,
1214 .set_pll = wm8960_set_dai_pll,
1215 .set_sysclk = wm8960_set_dai_sysclk,
1218 static struct snd_soc_dai_driver wm8960_dai = {
1219 .name = "wm8960-hifi",
1221 .stream_name = "Playback",
1224 .rates = WM8960_RATES,
1225 .formats = WM8960_FORMATS,},
1227 .stream_name = "Capture",
1230 .rates = WM8960_RATES,
1231 .formats = WM8960_FORMATS,},
1232 .ops = &wm8960_dai_ops,
1233 .symmetric_rates = 1,
1236 static int wm8960_probe(struct snd_soc_codec *codec)
1238 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
1239 struct wm8960_data *pdata = &wm8960->pdata;
1242 wm8960->set_bias_level = wm8960_set_bias_level_capless;
1244 wm8960->set_bias_level = wm8960_set_bias_level_out3;
1246 snd_soc_add_codec_controls(codec, wm8960_snd_controls,
1247 ARRAY_SIZE(wm8960_snd_controls));
1248 wm8960_add_widgets(codec);
1253 static struct snd_soc_codec_driver soc_codec_dev_wm8960 = {
1254 .probe = wm8960_probe,
1255 .set_bias_level = wm8960_set_bias_level,
1256 .suspend_bias_off = true,
1259 static const struct regmap_config wm8960_regmap = {
1262 .max_register = WM8960_PLL4,
1264 .reg_defaults = wm8960_reg_defaults,
1265 .num_reg_defaults = ARRAY_SIZE(wm8960_reg_defaults),
1266 .cache_type = REGCACHE_RBTREE,
1268 .volatile_reg = wm8960_volatile,
1271 static void wm8960_set_pdata_from_of(struct i2c_client *i2c,
1272 struct wm8960_data *pdata)
1274 const struct device_node *np = i2c->dev.of_node;
1276 if (of_property_read_bool(np, "wlf,capless"))
1277 pdata->capless = true;
1279 if (of_property_read_bool(np, "wlf,shared-lrclk"))
1280 pdata->shared_lrclk = true;
1283 static int wm8960_i2c_probe(struct i2c_client *i2c,
1284 const struct i2c_device_id *id)
1286 struct wm8960_data *pdata = dev_get_platdata(&i2c->dev);
1287 struct wm8960_priv *wm8960;
1290 wm8960 = devm_kzalloc(&i2c->dev, sizeof(struct wm8960_priv),
1295 wm8960->mclk = devm_clk_get(&i2c->dev, "mclk");
1296 if (IS_ERR(wm8960->mclk)) {
1297 if (PTR_ERR(wm8960->mclk) == -EPROBE_DEFER)
1298 return -EPROBE_DEFER;
1301 wm8960->regmap = devm_regmap_init_i2c(i2c, &wm8960_regmap);
1302 if (IS_ERR(wm8960->regmap))
1303 return PTR_ERR(wm8960->regmap);
1306 memcpy(&wm8960->pdata, pdata, sizeof(struct wm8960_data));
1307 else if (i2c->dev.of_node)
1308 wm8960_set_pdata_from_of(i2c, &wm8960->pdata);
1310 ret = wm8960_reset(wm8960->regmap);
1312 dev_err(&i2c->dev, "Failed to issue reset\n");
1316 if (wm8960->pdata.shared_lrclk) {
1317 ret = regmap_update_bits(wm8960->regmap, WM8960_ADDCTL2,
1320 dev_err(&i2c->dev, "Failed to enable LRCM: %d\n",
1326 /* Latch the update bits */
1327 regmap_update_bits(wm8960->regmap, WM8960_LINVOL, 0x100, 0x100);
1328 regmap_update_bits(wm8960->regmap, WM8960_RINVOL, 0x100, 0x100);
1329 regmap_update_bits(wm8960->regmap, WM8960_LADC, 0x100, 0x100);
1330 regmap_update_bits(wm8960->regmap, WM8960_RADC, 0x100, 0x100);
1331 regmap_update_bits(wm8960->regmap, WM8960_LDAC, 0x100, 0x100);
1332 regmap_update_bits(wm8960->regmap, WM8960_RDAC, 0x100, 0x100);
1333 regmap_update_bits(wm8960->regmap, WM8960_LOUT1, 0x100, 0x100);
1334 regmap_update_bits(wm8960->regmap, WM8960_ROUT1, 0x100, 0x100);
1335 regmap_update_bits(wm8960->regmap, WM8960_LOUT2, 0x100, 0x100);
1336 regmap_update_bits(wm8960->regmap, WM8960_ROUT2, 0x100, 0x100);
1338 i2c_set_clientdata(i2c, wm8960);
1340 ret = snd_soc_register_codec(&i2c->dev,
1341 &soc_codec_dev_wm8960, &wm8960_dai, 1);
1346 static int wm8960_i2c_remove(struct i2c_client *client)
1348 snd_soc_unregister_codec(&client->dev);
1352 static const struct i2c_device_id wm8960_i2c_id[] = {
1356 MODULE_DEVICE_TABLE(i2c, wm8960_i2c_id);
1358 static const struct of_device_id wm8960_of_match[] = {
1359 { .compatible = "wlf,wm8960", },
1362 MODULE_DEVICE_TABLE(of, wm8960_of_match);
1364 static struct i2c_driver wm8960_i2c_driver = {
1367 .of_match_table = wm8960_of_match,
1369 .probe = wm8960_i2c_probe,
1370 .remove = wm8960_i2c_remove,
1371 .id_table = wm8960_i2c_id,
1374 module_i2c_driver(wm8960_i2c_driver);
1376 MODULE_DESCRIPTION("ASoC WM8960 driver");
1377 MODULE_AUTHOR("Liam Girdwood");
1378 MODULE_LICENSE("GPL");