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 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, -9700, 50, 0);
215 static const DECLARE_TLV_DB_SCALE(dac_tlv, -12700, 50, 1);
216 static const DECLARE_TLV_DB_SCALE(bypass_tlv, -2100, 300, 0);
217 static const DECLARE_TLV_DB_SCALE(out_tlv, -12100, 100, 1);
218 static const DECLARE_TLV_DB_SCALE(boost_tlv, -1200, 300, 1);
220 static const struct snd_kcontrol_new wm8960_snd_controls[] = {
221 SOC_DOUBLE_R_TLV("Capture Volume", WM8960_LINVOL, WM8960_RINVOL,
223 SOC_DOUBLE_R("Capture Volume ZC Switch", WM8960_LINVOL, WM8960_RINVOL,
225 SOC_DOUBLE_R("Capture Switch", WM8960_LINVOL, WM8960_RINVOL,
228 SOC_SINGLE_TLV("Right Input Boost Mixer RINPUT3 Volume",
229 WM8960_INBMIX1, 4, 7, 0, boost_tlv),
230 SOC_SINGLE_TLV("Right Input Boost Mixer RINPUT2 Volume",
231 WM8960_INBMIX1, 1, 7, 0, boost_tlv),
232 SOC_SINGLE_TLV("Left Input Boost Mixer LINPUT3 Volume",
233 WM8960_INBMIX2, 4, 7, 0, boost_tlv),
234 SOC_SINGLE_TLV("Left Input Boost Mixer LINPUT2 Volume",
235 WM8960_INBMIX2, 1, 7, 0, boost_tlv),
237 SOC_DOUBLE_R_TLV("Playback Volume", WM8960_LDAC, WM8960_RDAC,
240 SOC_DOUBLE_R_TLV("Headphone Playback Volume", WM8960_LOUT1, WM8960_ROUT1,
242 SOC_DOUBLE_R("Headphone Playback ZC Switch", WM8960_LOUT1, WM8960_ROUT1,
245 SOC_DOUBLE_R_TLV("Speaker Playback Volume", WM8960_LOUT2, WM8960_ROUT2,
247 SOC_DOUBLE_R("Speaker Playback ZC Switch", WM8960_LOUT2, WM8960_ROUT2,
249 SOC_SINGLE("Speaker DC Volume", WM8960_CLASSD3, 3, 5, 0),
250 SOC_SINGLE("Speaker AC Volume", WM8960_CLASSD3, 0, 5, 0),
252 SOC_SINGLE("PCM Playback -6dB Switch", WM8960_DACCTL1, 7, 1, 0),
253 SOC_ENUM("ADC Polarity", wm8960_enum[0]),
254 SOC_SINGLE("ADC High Pass Filter Switch", WM8960_DACCTL1, 0, 1, 0),
256 SOC_ENUM("DAC Polarity", wm8960_enum[1]),
257 SOC_SINGLE_BOOL_EXT("DAC Deemphasis Switch", 0,
258 wm8960_get_deemph, wm8960_put_deemph),
260 SOC_ENUM("3D Filter Upper Cut-Off", wm8960_enum[2]),
261 SOC_ENUM("3D Filter Lower Cut-Off", wm8960_enum[3]),
262 SOC_SINGLE("3D Volume", WM8960_3D, 1, 15, 0),
263 SOC_SINGLE("3D Switch", WM8960_3D, 0, 1, 0),
265 SOC_ENUM("ALC Function", wm8960_enum[4]),
266 SOC_SINGLE("ALC Max Gain", WM8960_ALC1, 4, 7, 0),
267 SOC_SINGLE("ALC Target", WM8960_ALC1, 0, 15, 1),
268 SOC_SINGLE("ALC Min Gain", WM8960_ALC2, 4, 7, 0),
269 SOC_SINGLE("ALC Hold Time", WM8960_ALC2, 0, 15, 0),
270 SOC_ENUM("ALC Mode", wm8960_enum[5]),
271 SOC_SINGLE("ALC Decay", WM8960_ALC3, 4, 15, 0),
272 SOC_SINGLE("ALC Attack", WM8960_ALC3, 0, 15, 0),
274 SOC_SINGLE("Noise Gate Threshold", WM8960_NOISEG, 3, 31, 0),
275 SOC_SINGLE("Noise Gate Switch", WM8960_NOISEG, 0, 1, 0),
277 SOC_DOUBLE_R_TLV("ADC PCM Capture Volume", WM8960_LADC, WM8960_RADC,
280 SOC_SINGLE_TLV("Left Output Mixer Boost Bypass Volume",
281 WM8960_BYPASS1, 4, 7, 1, bypass_tlv),
282 SOC_SINGLE_TLV("Left Output Mixer LINPUT3 Volume",
283 WM8960_LOUTMIX, 4, 7, 1, bypass_tlv),
284 SOC_SINGLE_TLV("Right Output Mixer Boost Bypass Volume",
285 WM8960_BYPASS2, 4, 7, 1, bypass_tlv),
286 SOC_SINGLE_TLV("Right Output Mixer RINPUT3 Volume",
287 WM8960_ROUTMIX, 4, 7, 1, bypass_tlv),
290 static const struct snd_kcontrol_new wm8960_lin_boost[] = {
291 SOC_DAPM_SINGLE("LINPUT2 Switch", WM8960_LINPATH, 6, 1, 0),
292 SOC_DAPM_SINGLE("LINPUT3 Switch", WM8960_LINPATH, 7, 1, 0),
293 SOC_DAPM_SINGLE("LINPUT1 Switch", WM8960_LINPATH, 8, 1, 0),
296 static const struct snd_kcontrol_new wm8960_lin[] = {
297 SOC_DAPM_SINGLE("Boost Switch", WM8960_LINPATH, 3, 1, 0),
300 static const struct snd_kcontrol_new wm8960_rin_boost[] = {
301 SOC_DAPM_SINGLE("RINPUT2 Switch", WM8960_RINPATH, 6, 1, 0),
302 SOC_DAPM_SINGLE("RINPUT3 Switch", WM8960_RINPATH, 7, 1, 0),
303 SOC_DAPM_SINGLE("RINPUT1 Switch", WM8960_RINPATH, 8, 1, 0),
306 static const struct snd_kcontrol_new wm8960_rin[] = {
307 SOC_DAPM_SINGLE("Boost Switch", WM8960_RINPATH, 3, 1, 0),
310 static const struct snd_kcontrol_new wm8960_loutput_mixer[] = {
311 SOC_DAPM_SINGLE("PCM Playback Switch", WM8960_LOUTMIX, 8, 1, 0),
312 SOC_DAPM_SINGLE("LINPUT3 Switch", WM8960_LOUTMIX, 7, 1, 0),
313 SOC_DAPM_SINGLE("Boost Bypass Switch", WM8960_BYPASS1, 7, 1, 0),
316 static const struct snd_kcontrol_new wm8960_routput_mixer[] = {
317 SOC_DAPM_SINGLE("PCM Playback Switch", WM8960_ROUTMIX, 8, 1, 0),
318 SOC_DAPM_SINGLE("RINPUT3 Switch", WM8960_ROUTMIX, 7, 1, 0),
319 SOC_DAPM_SINGLE("Boost Bypass Switch", WM8960_BYPASS2, 7, 1, 0),
322 static const struct snd_kcontrol_new wm8960_mono_out[] = {
323 SOC_DAPM_SINGLE("Left Switch", WM8960_MONOMIX1, 7, 1, 0),
324 SOC_DAPM_SINGLE("Right Switch", WM8960_MONOMIX2, 7, 1, 0),
327 static const struct snd_soc_dapm_widget wm8960_dapm_widgets[] = {
328 SND_SOC_DAPM_INPUT("LINPUT1"),
329 SND_SOC_DAPM_INPUT("RINPUT1"),
330 SND_SOC_DAPM_INPUT("LINPUT2"),
331 SND_SOC_DAPM_INPUT("RINPUT2"),
332 SND_SOC_DAPM_INPUT("LINPUT3"),
333 SND_SOC_DAPM_INPUT("RINPUT3"),
335 SND_SOC_DAPM_SUPPLY("MICB", WM8960_POWER1, 1, 0, NULL, 0),
337 SND_SOC_DAPM_MIXER("Left Boost Mixer", WM8960_POWER1, 5, 0,
338 wm8960_lin_boost, ARRAY_SIZE(wm8960_lin_boost)),
339 SND_SOC_DAPM_MIXER("Right Boost Mixer", WM8960_POWER1, 4, 0,
340 wm8960_rin_boost, ARRAY_SIZE(wm8960_rin_boost)),
342 SND_SOC_DAPM_MIXER("Left Input Mixer", WM8960_POWER3, 5, 0,
343 wm8960_lin, ARRAY_SIZE(wm8960_lin)),
344 SND_SOC_DAPM_MIXER("Right Input Mixer", WM8960_POWER3, 4, 0,
345 wm8960_rin, ARRAY_SIZE(wm8960_rin)),
347 SND_SOC_DAPM_ADC("Left ADC", "Capture", WM8960_POWER1, 3, 0),
348 SND_SOC_DAPM_ADC("Right ADC", "Capture", WM8960_POWER1, 2, 0),
350 SND_SOC_DAPM_DAC("Left DAC", "Playback", WM8960_POWER2, 8, 0),
351 SND_SOC_DAPM_DAC("Right DAC", "Playback", WM8960_POWER2, 7, 0),
353 SND_SOC_DAPM_MIXER("Left Output Mixer", WM8960_POWER3, 3, 0,
354 &wm8960_loutput_mixer[0],
355 ARRAY_SIZE(wm8960_loutput_mixer)),
356 SND_SOC_DAPM_MIXER("Right Output Mixer", WM8960_POWER3, 2, 0,
357 &wm8960_routput_mixer[0],
358 ARRAY_SIZE(wm8960_routput_mixer)),
360 SND_SOC_DAPM_PGA("LOUT1 PGA", WM8960_POWER2, 6, 0, NULL, 0),
361 SND_SOC_DAPM_PGA("ROUT1 PGA", WM8960_POWER2, 5, 0, NULL, 0),
363 SND_SOC_DAPM_PGA("Left Speaker PGA", WM8960_POWER2, 4, 0, NULL, 0),
364 SND_SOC_DAPM_PGA("Right Speaker PGA", WM8960_POWER2, 3, 0, NULL, 0),
366 SND_SOC_DAPM_PGA("Right Speaker Output", WM8960_CLASSD1, 7, 0, NULL, 0),
367 SND_SOC_DAPM_PGA("Left Speaker Output", WM8960_CLASSD1, 6, 0, NULL, 0),
369 SND_SOC_DAPM_OUTPUT("SPK_LP"),
370 SND_SOC_DAPM_OUTPUT("SPK_LN"),
371 SND_SOC_DAPM_OUTPUT("HP_L"),
372 SND_SOC_DAPM_OUTPUT("HP_R"),
373 SND_SOC_DAPM_OUTPUT("SPK_RP"),
374 SND_SOC_DAPM_OUTPUT("SPK_RN"),
375 SND_SOC_DAPM_OUTPUT("OUT3"),
378 static const struct snd_soc_dapm_widget wm8960_dapm_widgets_out3[] = {
379 SND_SOC_DAPM_MIXER("Mono Output Mixer", WM8960_POWER2, 1, 0,
381 ARRAY_SIZE(wm8960_mono_out)),
384 /* Represent OUT3 as a PGA so that it gets turned on with LOUT1/ROUT1 */
385 static const struct snd_soc_dapm_widget wm8960_dapm_widgets_capless[] = {
386 SND_SOC_DAPM_PGA("OUT3 VMID", WM8960_POWER2, 1, 0, NULL, 0),
389 static const struct snd_soc_dapm_route audio_paths[] = {
390 { "Left Boost Mixer", "LINPUT1 Switch", "LINPUT1" },
391 { "Left Boost Mixer", "LINPUT2 Switch", "LINPUT2" },
392 { "Left Boost Mixer", "LINPUT3 Switch", "LINPUT3" },
394 { "Left Input Mixer", "Boost Switch", "Left Boost Mixer", },
395 { "Left Input Mixer", NULL, "LINPUT1", }, /* Really Boost Switch */
396 { "Left Input Mixer", NULL, "LINPUT2" },
397 { "Left Input Mixer", NULL, "LINPUT3" },
399 { "Right Boost Mixer", "RINPUT1 Switch", "RINPUT1" },
400 { "Right Boost Mixer", "RINPUT2 Switch", "RINPUT2" },
401 { "Right Boost Mixer", "RINPUT3 Switch", "RINPUT3" },
403 { "Right Input Mixer", "Boost Switch", "Right Boost Mixer", },
404 { "Right Input Mixer", NULL, "RINPUT1", }, /* Really Boost Switch */
405 { "Right Input Mixer", NULL, "RINPUT2" },
406 { "Right Input Mixer", NULL, "RINPUT3" },
408 { "Left ADC", NULL, "Left Input Mixer" },
409 { "Right ADC", NULL, "Right Input Mixer" },
411 { "Left Output Mixer", "LINPUT3 Switch", "LINPUT3" },
412 { "Left Output Mixer", "Boost Bypass Switch", "Left Boost Mixer"} ,
413 { "Left Output Mixer", "PCM Playback Switch", "Left DAC" },
415 { "Right Output Mixer", "RINPUT3 Switch", "RINPUT3" },
416 { "Right Output Mixer", "Boost Bypass Switch", "Right Boost Mixer" } ,
417 { "Right Output Mixer", "PCM Playback Switch", "Right DAC" },
419 { "LOUT1 PGA", NULL, "Left Output Mixer" },
420 { "ROUT1 PGA", NULL, "Right Output Mixer" },
422 { "HP_L", NULL, "LOUT1 PGA" },
423 { "HP_R", NULL, "ROUT1 PGA" },
425 { "Left Speaker PGA", NULL, "Left Output Mixer" },
426 { "Right Speaker PGA", NULL, "Right Output Mixer" },
428 { "Left Speaker Output", NULL, "Left Speaker PGA" },
429 { "Right Speaker Output", NULL, "Right Speaker PGA" },
431 { "SPK_LN", NULL, "Left Speaker Output" },
432 { "SPK_LP", NULL, "Left Speaker Output" },
433 { "SPK_RN", NULL, "Right Speaker Output" },
434 { "SPK_RP", NULL, "Right Speaker Output" },
437 static const struct snd_soc_dapm_route audio_paths_out3[] = {
438 { "Mono Output Mixer", "Left Switch", "Left Output Mixer" },
439 { "Mono Output Mixer", "Right Switch", "Right Output Mixer" },
441 { "OUT3", NULL, "Mono Output Mixer", }
444 static const struct snd_soc_dapm_route audio_paths_capless[] = {
445 { "HP_L", NULL, "OUT3 VMID" },
446 { "HP_R", NULL, "OUT3 VMID" },
448 { "OUT3 VMID", NULL, "Left Output Mixer" },
449 { "OUT3 VMID", NULL, "Right Output Mixer" },
452 static int wm8960_add_widgets(struct snd_soc_codec *codec)
454 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
455 struct wm8960_data *pdata = &wm8960->pdata;
456 struct snd_soc_dapm_context *dapm = snd_soc_codec_get_dapm(codec);
457 struct snd_soc_dapm_widget *w;
459 snd_soc_dapm_new_controls(dapm, wm8960_dapm_widgets,
460 ARRAY_SIZE(wm8960_dapm_widgets));
462 snd_soc_dapm_add_routes(dapm, audio_paths, ARRAY_SIZE(audio_paths));
464 /* In capless mode OUT3 is used to provide VMID for the
465 * headphone outputs, otherwise it is used as a mono mixer.
467 if (pdata && pdata->capless) {
468 snd_soc_dapm_new_controls(dapm, wm8960_dapm_widgets_capless,
469 ARRAY_SIZE(wm8960_dapm_widgets_capless));
471 snd_soc_dapm_add_routes(dapm, audio_paths_capless,
472 ARRAY_SIZE(audio_paths_capless));
474 snd_soc_dapm_new_controls(dapm, wm8960_dapm_widgets_out3,
475 ARRAY_SIZE(wm8960_dapm_widgets_out3));
477 snd_soc_dapm_add_routes(dapm, audio_paths_out3,
478 ARRAY_SIZE(audio_paths_out3));
481 /* We need to power up the headphone output stage out of
482 * sequence for capless mode. To save scanning the widget
483 * list each time to find the desired power state do so now
484 * and save the result.
486 list_for_each_entry(w, &codec->component.card->widgets, list) {
489 if (strcmp(w->name, "LOUT1 PGA") == 0)
491 if (strcmp(w->name, "ROUT1 PGA") == 0)
493 if (strcmp(w->name, "OUT3 VMID") == 0)
500 static int wm8960_set_dai_fmt(struct snd_soc_dai *codec_dai,
503 struct snd_soc_codec *codec = codec_dai->codec;
506 /* set master/slave audio interface */
507 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
508 case SND_SOC_DAIFMT_CBM_CFM:
511 case SND_SOC_DAIFMT_CBS_CFS:
517 /* interface format */
518 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
519 case SND_SOC_DAIFMT_I2S:
522 case SND_SOC_DAIFMT_RIGHT_J:
524 case SND_SOC_DAIFMT_LEFT_J:
527 case SND_SOC_DAIFMT_DSP_A:
530 case SND_SOC_DAIFMT_DSP_B:
537 /* clock inversion */
538 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
539 case SND_SOC_DAIFMT_NB_NF:
541 case SND_SOC_DAIFMT_IB_IF:
544 case SND_SOC_DAIFMT_IB_NF:
547 case SND_SOC_DAIFMT_NB_IF:
555 snd_soc_write(codec, WM8960_IFACE1, iface);
574 /* -1 for reserved value */
575 static const int sysclk_divs[] = { 1, -1, 2, -1 };
577 /* Multiply 256 for internal 256 div */
578 static const int dac_divs[] = { 256, 384, 512, 768, 1024, 1408, 1536 };
580 /* Multiply 10 to eliminate decimials */
581 static const int bclk_divs[] = {
582 10, 15, 20, 30, 40, 55, 60, 80, 110,
583 120, 160, 220, 240, 320, 320, 320
586 static int wm8960_configure_clocking(struct snd_soc_codec *codec)
588 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
589 int sysclk, bclk, lrclk, freq_out, freq_in;
590 u16 iface1 = snd_soc_read(codec, WM8960_IFACE1);
593 if (!(iface1 & (1<<6))) {
595 "Codec is slave mode, no need to configure clock\n");
599 if (wm8960->clk_id != WM8960_SYSCLK_MCLK && !wm8960->freq_in) {
600 dev_err(codec->dev, "No MCLK configured\n");
604 freq_in = wm8960->freq_in;
606 lrclk = wm8960->lrclk;
608 * If it's sysclk auto mode, check if the MCLK can provide sysclk or
609 * not. If MCLK can provide sysclk, using MCLK to provide sysclk
610 * directly. Otherwise, auto select a available pll out frequency
613 if (wm8960->clk_id == WM8960_SYSCLK_AUTO) {
614 /* disable the PLL and using MCLK to provide sysclk */
615 wm8960_set_pll(codec, 0, 0);
617 } else if (wm8960->sysclk) {
618 freq_out = wm8960->sysclk;
620 dev_err(codec->dev, "No SYSCLK configured\n");
624 /* check if the sysclk frequency is available. */
625 for (i = 0; i < ARRAY_SIZE(sysclk_divs); ++i) {
626 if (sysclk_divs[i] == -1)
628 sysclk = freq_out / sysclk_divs[i];
629 for (j = 0; j < ARRAY_SIZE(dac_divs); ++j) {
630 if (sysclk == dac_divs[j] * lrclk) {
631 for (k = 0; k < ARRAY_SIZE(bclk_divs); ++k)
632 if (sysclk == bclk * bclk_divs[k] / 10)
634 if (k != ARRAY_SIZE(bclk_divs))
638 if (j != ARRAY_SIZE(dac_divs))
642 if (i != ARRAY_SIZE(sysclk_divs)) {
643 goto configure_clock;
644 } else if (wm8960->clk_id != WM8960_SYSCLK_AUTO) {
645 dev_err(codec->dev, "failed to configure clock\n");
648 /* get a available pll out frequency and set pll */
649 for (i = 0; i < ARRAY_SIZE(sysclk_divs); ++i) {
650 if (sysclk_divs[i] == -1)
652 for (j = 0; j < ARRAY_SIZE(dac_divs); ++j) {
653 sysclk = lrclk * dac_divs[j];
654 freq_out = sysclk * sysclk_divs[i];
656 for (k = 0; k < ARRAY_SIZE(bclk_divs); ++k) {
657 if (sysclk == bclk * bclk_divs[k] / 10 &&
658 is_pll_freq_available(freq_in, freq_out)) {
659 wm8960_set_pll(codec,
666 if (k != ARRAY_SIZE(bclk_divs))
669 if (j != ARRAY_SIZE(dac_divs))
673 if (i == ARRAY_SIZE(sysclk_divs)) {
674 dev_err(codec->dev, "failed to configure clock\n");
679 /* configure sysclk clock */
680 snd_soc_update_bits(codec, WM8960_CLOCK1, 3 << 1, i << 1);
682 /* configure frame clock */
683 snd_soc_update_bits(codec, WM8960_CLOCK1, 0x7 << 3, j << 3);
684 snd_soc_update_bits(codec, WM8960_CLOCK1, 0x7 << 6, j << 6);
686 /* configure bit clock */
687 snd_soc_update_bits(codec, WM8960_CLOCK2, 0xf, k);
692 static int wm8960_hw_params(struct snd_pcm_substream *substream,
693 struct snd_pcm_hw_params *params,
694 struct snd_soc_dai *dai)
696 struct snd_soc_codec *codec = dai->codec;
697 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
698 u16 iface = snd_soc_read(codec, WM8960_IFACE1) & 0xfff3;
699 bool tx = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
702 wm8960->bclk = snd_soc_params_to_bclk(params);
703 if (params_channels(params) == 1)
707 switch (params_width(params)) {
717 /* right justify mode does not support 32 word length */
718 if ((iface & 0x3) != 0) {
723 dev_err(codec->dev, "unsupported width %d\n",
724 params_width(params));
728 wm8960->lrclk = params_rate(params);
729 /* Update filters for the new rate */
731 wm8960_set_deemph(codec);
733 for (i = 0; i < ARRAY_SIZE(alc_rates); i++)
734 if (alc_rates[i].rate == params_rate(params))
735 snd_soc_update_bits(codec,
741 snd_soc_write(codec, WM8960_IFACE1, iface);
743 wm8960->is_stream_in_use[tx] = true;
745 if (snd_soc_codec_get_bias_level(codec) == SND_SOC_BIAS_ON &&
746 !wm8960->is_stream_in_use[!tx])
747 return wm8960_configure_clocking(codec);
752 static int wm8960_hw_free(struct snd_pcm_substream *substream,
753 struct snd_soc_dai *dai)
755 struct snd_soc_codec *codec = dai->codec;
756 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
757 bool tx = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
759 wm8960->is_stream_in_use[tx] = false;
764 static int wm8960_mute(struct snd_soc_dai *dai, int mute)
766 struct snd_soc_codec *codec = dai->codec;
769 snd_soc_update_bits(codec, WM8960_DACCTL1, 0x8, 0x8);
771 snd_soc_update_bits(codec, WM8960_DACCTL1, 0x8, 0);
775 static int wm8960_set_bias_level_out3(struct snd_soc_codec *codec,
776 enum snd_soc_bias_level level)
778 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
779 u16 pm2 = snd_soc_read(codec, WM8960_POWER2);
783 case SND_SOC_BIAS_ON:
786 case SND_SOC_BIAS_PREPARE:
787 switch (snd_soc_codec_get_bias_level(codec)) {
788 case SND_SOC_BIAS_STANDBY:
789 if (!IS_ERR(wm8960->mclk)) {
790 ret = clk_prepare_enable(wm8960->mclk);
793 "Failed to enable MCLK: %d\n",
799 ret = wm8960_configure_clocking(codec);
803 /* Set VMID to 2x50k */
804 snd_soc_update_bits(codec, WM8960_POWER1, 0x180, 0x80);
807 case SND_SOC_BIAS_ON:
809 * If it's sysclk auto mode, and the pll is enabled,
812 if (wm8960->clk_id == WM8960_SYSCLK_AUTO && (pm2 & 0x1))
813 wm8960_set_pll(codec, 0, 0);
815 if (!IS_ERR(wm8960->mclk))
816 clk_disable_unprepare(wm8960->mclk);
825 case SND_SOC_BIAS_STANDBY:
826 if (snd_soc_codec_get_bias_level(codec) == SND_SOC_BIAS_OFF) {
827 regcache_sync(wm8960->regmap);
829 /* Enable anti-pop features */
830 snd_soc_write(codec, WM8960_APOP1,
831 WM8960_POBCTRL | WM8960_SOFT_ST |
832 WM8960_BUFDCOPEN | WM8960_BUFIOEN);
834 /* Enable & ramp VMID at 2x50k */
835 snd_soc_update_bits(codec, WM8960_POWER1, 0x80, 0x80);
839 snd_soc_update_bits(codec, WM8960_POWER1, WM8960_VREF,
842 /* Disable anti-pop features */
843 snd_soc_write(codec, WM8960_APOP1, WM8960_BUFIOEN);
846 /* Set VMID to 2x250k */
847 snd_soc_update_bits(codec, WM8960_POWER1, 0x180, 0x100);
850 case SND_SOC_BIAS_OFF:
851 /* Enable anti-pop features */
852 snd_soc_write(codec, WM8960_APOP1,
853 WM8960_POBCTRL | WM8960_SOFT_ST |
854 WM8960_BUFDCOPEN | WM8960_BUFIOEN);
856 /* Disable VMID and VREF, let them discharge */
857 snd_soc_write(codec, WM8960_POWER1, 0);
865 static int wm8960_set_bias_level_capless(struct snd_soc_codec *codec,
866 enum snd_soc_bias_level level)
868 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
869 u16 pm2 = snd_soc_read(codec, WM8960_POWER2);
873 case SND_SOC_BIAS_ON:
876 case SND_SOC_BIAS_PREPARE:
877 switch (snd_soc_codec_get_bias_level(codec)) {
878 case SND_SOC_BIAS_STANDBY:
879 /* Enable anti pop mode */
880 snd_soc_update_bits(codec, WM8960_APOP1,
881 WM8960_POBCTRL | WM8960_SOFT_ST |
883 WM8960_POBCTRL | WM8960_SOFT_ST |
886 /* Enable LOUT1, ROUT1 and OUT3 if they're enabled */
888 if (wm8960->lout1 && wm8960->lout1->power)
889 reg |= WM8960_PWR2_LOUT1;
890 if (wm8960->rout1 && wm8960->rout1->power)
891 reg |= WM8960_PWR2_ROUT1;
892 if (wm8960->out3 && wm8960->out3->power)
893 reg |= WM8960_PWR2_OUT3;
894 snd_soc_update_bits(codec, WM8960_POWER2,
897 WM8960_PWR2_OUT3, reg);
899 /* Enable VMID at 2*50k */
900 snd_soc_update_bits(codec, WM8960_POWER1,
901 WM8960_VMID_MASK, 0x80);
907 snd_soc_update_bits(codec, WM8960_POWER1,
908 WM8960_VREF, WM8960_VREF);
912 if (!IS_ERR(wm8960->mclk)) {
913 ret = clk_prepare_enable(wm8960->mclk);
916 "Failed to enable MCLK: %d\n",
922 ret = wm8960_configure_clocking(codec);
928 case SND_SOC_BIAS_ON:
930 * If it's sysclk auto mode, and the pll is enabled,
933 if (wm8960->clk_id == WM8960_SYSCLK_AUTO && (pm2 & 0x1))
934 wm8960_set_pll(codec, 0, 0);
936 if (!IS_ERR(wm8960->mclk))
937 clk_disable_unprepare(wm8960->mclk);
939 /* Enable anti-pop mode */
940 snd_soc_update_bits(codec, WM8960_APOP1,
941 WM8960_POBCTRL | WM8960_SOFT_ST |
943 WM8960_POBCTRL | WM8960_SOFT_ST |
946 /* Disable VMID and VREF */
947 snd_soc_update_bits(codec, WM8960_POWER1,
948 WM8960_VREF | WM8960_VMID_MASK, 0);
951 case SND_SOC_BIAS_OFF:
952 regcache_sync(wm8960->regmap);
959 case SND_SOC_BIAS_STANDBY:
960 switch (snd_soc_codec_get_bias_level(codec)) {
961 case SND_SOC_BIAS_PREPARE:
962 /* Disable HP discharge */
963 snd_soc_update_bits(codec, WM8960_APOP2,
964 WM8960_DISOP | WM8960_DRES_MASK,
967 /* Disable anti-pop features */
968 snd_soc_update_bits(codec, WM8960_APOP1,
969 WM8960_POBCTRL | WM8960_SOFT_ST |
971 WM8960_POBCTRL | WM8960_SOFT_ST |
980 case SND_SOC_BIAS_OFF:
994 static bool is_pll_freq_available(unsigned int source, unsigned int target)
998 if (source == 0 || target == 0)
1001 /* Scale up target to PLL operating frequency */
1003 Ndiv = target / source;
1007 Ndiv = target / source;
1010 if ((Ndiv < 6) || (Ndiv > 12))
1016 /* The size in bits of the pll divide multiplied by 10
1017 * to allow rounding later */
1018 #define FIXED_PLL_SIZE ((1 << 24) * 10)
1020 static int pll_factors(unsigned int source, unsigned int target,
1021 struct _pll_div *pll_div)
1023 unsigned long long Kpart;
1024 unsigned int K, Ndiv, Nmod;
1026 pr_debug("WM8960 PLL: setting %dHz->%dHz\n", source, target);
1028 /* Scale up target to PLL operating frequency */
1031 Ndiv = target / source;
1034 pll_div->pre_div = 1;
1035 Ndiv = target / source;
1037 pll_div->pre_div = 0;
1039 if ((Ndiv < 6) || (Ndiv > 12)) {
1040 pr_err("WM8960 PLL: Unsupported N=%d\n", Ndiv);
1045 Nmod = target % source;
1046 Kpart = FIXED_PLL_SIZE * (long long)Nmod;
1048 do_div(Kpart, source);
1050 K = Kpart & 0xFFFFFFFF;
1052 /* Check if we need to round */
1056 /* Move down to proper range now rounding is done */
1061 pr_debug("WM8960 PLL: N=%x K=%x pre_div=%d\n",
1062 pll_div->n, pll_div->k, pll_div->pre_div);
1067 static int wm8960_set_pll(struct snd_soc_codec *codec,
1068 unsigned int freq_in, unsigned int freq_out)
1071 static struct _pll_div pll_div;
1074 if (freq_in && freq_out) {
1075 ret = pll_factors(freq_in, freq_out, &pll_div);
1080 /* Disable the PLL: even if we are changing the frequency the
1081 * PLL needs to be disabled while we do so. */
1082 snd_soc_update_bits(codec, WM8960_CLOCK1, 0x1, 0);
1083 snd_soc_update_bits(codec, WM8960_POWER2, 0x1, 0);
1085 if (!freq_in || !freq_out)
1088 reg = snd_soc_read(codec, WM8960_PLL1) & ~0x3f;
1089 reg |= pll_div.pre_div << 4;
1095 snd_soc_write(codec, WM8960_PLL2, (pll_div.k >> 16) & 0xff);
1096 snd_soc_write(codec, WM8960_PLL3, (pll_div.k >> 8) & 0xff);
1097 snd_soc_write(codec, WM8960_PLL4, pll_div.k & 0xff);
1099 snd_soc_write(codec, WM8960_PLL1, reg);
1102 snd_soc_update_bits(codec, WM8960_POWER2, 0x1, 0x1);
1104 snd_soc_update_bits(codec, WM8960_CLOCK1, 0x1, 0x1);
1109 static int wm8960_set_dai_pll(struct snd_soc_dai *codec_dai, int pll_id,
1110 int source, unsigned int freq_in, unsigned int freq_out)
1112 struct snd_soc_codec *codec = codec_dai->codec;
1113 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
1115 wm8960->freq_in = freq_in;
1117 if (pll_id == WM8960_SYSCLK_AUTO)
1120 return wm8960_set_pll(codec, freq_in, freq_out);
1123 static int wm8960_set_dai_clkdiv(struct snd_soc_dai *codec_dai,
1124 int div_id, int div)
1126 struct snd_soc_codec *codec = codec_dai->codec;
1130 case WM8960_SYSCLKDIV:
1131 reg = snd_soc_read(codec, WM8960_CLOCK1) & 0x1f9;
1132 snd_soc_write(codec, WM8960_CLOCK1, reg | div);
1135 reg = snd_soc_read(codec, WM8960_CLOCK1) & 0x1c7;
1136 snd_soc_write(codec, WM8960_CLOCK1, reg | div);
1138 case WM8960_OPCLKDIV:
1139 reg = snd_soc_read(codec, WM8960_PLL1) & 0x03f;
1140 snd_soc_write(codec, WM8960_PLL1, reg | div);
1142 case WM8960_DCLKDIV:
1143 reg = snd_soc_read(codec, WM8960_CLOCK2) & 0x03f;
1144 snd_soc_write(codec, WM8960_CLOCK2, reg | div);
1146 case WM8960_TOCLKSEL:
1147 reg = snd_soc_read(codec, WM8960_ADDCTL1) & 0x1fd;
1148 snd_soc_write(codec, WM8960_ADDCTL1, reg | div);
1157 static int wm8960_set_bias_level(struct snd_soc_codec *codec,
1158 enum snd_soc_bias_level level)
1160 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
1162 return wm8960->set_bias_level(codec, level);
1165 static int wm8960_set_dai_sysclk(struct snd_soc_dai *dai, int clk_id,
1166 unsigned int freq, int dir)
1168 struct snd_soc_codec *codec = dai->codec;
1169 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
1172 case WM8960_SYSCLK_MCLK:
1173 snd_soc_update_bits(codec, WM8960_CLOCK1,
1174 0x1, WM8960_SYSCLK_MCLK);
1176 case WM8960_SYSCLK_PLL:
1177 snd_soc_update_bits(codec, WM8960_CLOCK1,
1178 0x1, WM8960_SYSCLK_PLL);
1180 case WM8960_SYSCLK_AUTO:
1186 wm8960->sysclk = freq;
1187 wm8960->clk_id = clk_id;
1192 #define WM8960_RATES SNDRV_PCM_RATE_8000_48000
1194 #define WM8960_FORMATS \
1195 (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE | \
1196 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
1198 static const struct snd_soc_dai_ops wm8960_dai_ops = {
1199 .hw_params = wm8960_hw_params,
1200 .hw_free = wm8960_hw_free,
1201 .digital_mute = wm8960_mute,
1202 .set_fmt = wm8960_set_dai_fmt,
1203 .set_clkdiv = wm8960_set_dai_clkdiv,
1204 .set_pll = wm8960_set_dai_pll,
1205 .set_sysclk = wm8960_set_dai_sysclk,
1208 static struct snd_soc_dai_driver wm8960_dai = {
1209 .name = "wm8960-hifi",
1211 .stream_name = "Playback",
1214 .rates = WM8960_RATES,
1215 .formats = WM8960_FORMATS,},
1217 .stream_name = "Capture",
1220 .rates = WM8960_RATES,
1221 .formats = WM8960_FORMATS,},
1222 .ops = &wm8960_dai_ops,
1223 .symmetric_rates = 1,
1226 static int wm8960_probe(struct snd_soc_codec *codec)
1228 struct wm8960_priv *wm8960 = snd_soc_codec_get_drvdata(codec);
1229 struct wm8960_data *pdata = &wm8960->pdata;
1232 wm8960->set_bias_level = wm8960_set_bias_level_capless;
1234 wm8960->set_bias_level = wm8960_set_bias_level_out3;
1236 snd_soc_add_codec_controls(codec, wm8960_snd_controls,
1237 ARRAY_SIZE(wm8960_snd_controls));
1238 wm8960_add_widgets(codec);
1243 static struct snd_soc_codec_driver soc_codec_dev_wm8960 = {
1244 .probe = wm8960_probe,
1245 .set_bias_level = wm8960_set_bias_level,
1246 .suspend_bias_off = true,
1249 static const struct regmap_config wm8960_regmap = {
1252 .max_register = WM8960_PLL4,
1254 .reg_defaults = wm8960_reg_defaults,
1255 .num_reg_defaults = ARRAY_SIZE(wm8960_reg_defaults),
1256 .cache_type = REGCACHE_RBTREE,
1258 .volatile_reg = wm8960_volatile,
1261 static void wm8960_set_pdata_from_of(struct i2c_client *i2c,
1262 struct wm8960_data *pdata)
1264 const struct device_node *np = i2c->dev.of_node;
1266 if (of_property_read_bool(np, "wlf,capless"))
1267 pdata->capless = true;
1269 if (of_property_read_bool(np, "wlf,shared-lrclk"))
1270 pdata->shared_lrclk = true;
1273 static int wm8960_i2c_probe(struct i2c_client *i2c,
1274 const struct i2c_device_id *id)
1276 struct wm8960_data *pdata = dev_get_platdata(&i2c->dev);
1277 struct wm8960_priv *wm8960;
1280 wm8960 = devm_kzalloc(&i2c->dev, sizeof(struct wm8960_priv),
1285 wm8960->mclk = devm_clk_get(&i2c->dev, "mclk");
1286 if (IS_ERR(wm8960->mclk)) {
1287 if (PTR_ERR(wm8960->mclk) == -EPROBE_DEFER)
1288 return -EPROBE_DEFER;
1291 wm8960->regmap = devm_regmap_init_i2c(i2c, &wm8960_regmap);
1292 if (IS_ERR(wm8960->regmap))
1293 return PTR_ERR(wm8960->regmap);
1296 memcpy(&wm8960->pdata, pdata, sizeof(struct wm8960_data));
1297 else if (i2c->dev.of_node)
1298 wm8960_set_pdata_from_of(i2c, &wm8960->pdata);
1300 ret = wm8960_reset(wm8960->regmap);
1302 dev_err(&i2c->dev, "Failed to issue reset\n");
1306 if (wm8960->pdata.shared_lrclk) {
1307 ret = regmap_update_bits(wm8960->regmap, WM8960_ADDCTL2,
1310 dev_err(&i2c->dev, "Failed to enable LRCM: %d\n",
1316 /* Latch the update bits */
1317 regmap_update_bits(wm8960->regmap, WM8960_LINVOL, 0x100, 0x100);
1318 regmap_update_bits(wm8960->regmap, WM8960_RINVOL, 0x100, 0x100);
1319 regmap_update_bits(wm8960->regmap, WM8960_LADC, 0x100, 0x100);
1320 regmap_update_bits(wm8960->regmap, WM8960_RADC, 0x100, 0x100);
1321 regmap_update_bits(wm8960->regmap, WM8960_LDAC, 0x100, 0x100);
1322 regmap_update_bits(wm8960->regmap, WM8960_RDAC, 0x100, 0x100);
1323 regmap_update_bits(wm8960->regmap, WM8960_LOUT1, 0x100, 0x100);
1324 regmap_update_bits(wm8960->regmap, WM8960_ROUT1, 0x100, 0x100);
1325 regmap_update_bits(wm8960->regmap, WM8960_LOUT2, 0x100, 0x100);
1326 regmap_update_bits(wm8960->regmap, WM8960_ROUT2, 0x100, 0x100);
1328 i2c_set_clientdata(i2c, wm8960);
1330 ret = snd_soc_register_codec(&i2c->dev,
1331 &soc_codec_dev_wm8960, &wm8960_dai, 1);
1336 static int wm8960_i2c_remove(struct i2c_client *client)
1338 snd_soc_unregister_codec(&client->dev);
1342 static const struct i2c_device_id wm8960_i2c_id[] = {
1346 MODULE_DEVICE_TABLE(i2c, wm8960_i2c_id);
1348 static const struct of_device_id wm8960_of_match[] = {
1349 { .compatible = "wlf,wm8960", },
1352 MODULE_DEVICE_TABLE(of, wm8960_of_match);
1354 static struct i2c_driver wm8960_i2c_driver = {
1357 .of_match_table = wm8960_of_match,
1359 .probe = wm8960_i2c_probe,
1360 .remove = wm8960_i2c_remove,
1361 .id_table = wm8960_i2c_id,
1364 module_i2c_driver(wm8960_i2c_driver);
1366 MODULE_DESCRIPTION("ASoC WM8960 driver");
1367 MODULE_AUTHOR("Liam Girdwood");
1368 MODULE_LICENSE("GPL");