2 * wm8978.c -- WM8978 ALSA SoC Audio Codec driver
4 * Copyright (C) 2009-2010 Guennadi Liakhovetski <g.liakhovetski@gmx.de>
5 * Copyright (C) 2007 Carlos Munoz <carlos@kenati.com>
6 * Copyright 2006-2009 Wolfson Microelectronics PLC.
7 * Based on wm8974 and wm8990 by Liam Girdwood <lrg@slimlogic.co.uk>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
14 #include <linux/module.h>
15 #include <linux/moduleparam.h>
16 #include <linux/kernel.h>
17 #include <linux/init.h>
18 #include <linux/delay.h>
20 #include <linux/i2c.h>
21 #include <linux/regmap.h>
22 #include <linux/slab.h>
23 #include <sound/core.h>
24 #include <sound/pcm.h>
25 #include <sound/pcm_params.h>
26 #include <sound/soc.h>
27 #include <sound/initval.h>
28 #include <sound/tlv.h>
29 #include <asm/div64.h>
33 static const struct reg_default wm8978_reg_defaults[] = {
93 static bool wm8978_volatile(struct device *dev, unsigned int reg)
95 return reg == WM8978_RESET;
98 /* codec private data */
100 struct regmap *regmap;
101 unsigned int f_pllout;
103 unsigned int f_256fs;
104 unsigned int f_opclk;
106 enum wm8978_sysclk_src sysclk;
109 static const char *wm8978_companding[] = {"Off", "NC", "u-law", "A-law"};
110 static const char *wm8978_eqmode[] = {"Capture", "Playback"};
111 static const char *wm8978_bw[] = {"Narrow", "Wide"};
112 static const char *wm8978_eq1[] = {"80Hz", "105Hz", "135Hz", "175Hz"};
113 static const char *wm8978_eq2[] = {"230Hz", "300Hz", "385Hz", "500Hz"};
114 static const char *wm8978_eq3[] = {"650Hz", "850Hz", "1.1kHz", "1.4kHz"};
115 static const char *wm8978_eq4[] = {"1.8kHz", "2.4kHz", "3.2kHz", "4.1kHz"};
116 static const char *wm8978_eq5[] = {"5.3kHz", "6.9kHz", "9kHz", "11.7kHz"};
117 static const char *wm8978_alc3[] = {"ALC", "Limiter"};
118 static const char *wm8978_alc1[] = {"Off", "Right", "Left", "Both"};
120 static const SOC_ENUM_SINGLE_DECL(adc_compand, WM8978_COMPANDING_CONTROL, 1,
122 static const SOC_ENUM_SINGLE_DECL(dac_compand, WM8978_COMPANDING_CONTROL, 3,
124 static const SOC_ENUM_SINGLE_DECL(eqmode, WM8978_EQ1, 8, wm8978_eqmode);
125 static const SOC_ENUM_SINGLE_DECL(eq1, WM8978_EQ1, 5, wm8978_eq1);
126 static const SOC_ENUM_SINGLE_DECL(eq2bw, WM8978_EQ2, 8, wm8978_bw);
127 static const SOC_ENUM_SINGLE_DECL(eq2, WM8978_EQ2, 5, wm8978_eq2);
128 static const SOC_ENUM_SINGLE_DECL(eq3bw, WM8978_EQ3, 8, wm8978_bw);
129 static const SOC_ENUM_SINGLE_DECL(eq3, WM8978_EQ3, 5, wm8978_eq3);
130 static const SOC_ENUM_SINGLE_DECL(eq4bw, WM8978_EQ4, 8, wm8978_bw);
131 static const SOC_ENUM_SINGLE_DECL(eq4, WM8978_EQ4, 5, wm8978_eq4);
132 static const SOC_ENUM_SINGLE_DECL(eq5, WM8978_EQ5, 5, wm8978_eq5);
133 static const SOC_ENUM_SINGLE_DECL(alc3, WM8978_ALC_CONTROL_3, 8, wm8978_alc3);
134 static const SOC_ENUM_SINGLE_DECL(alc1, WM8978_ALC_CONTROL_1, 7, wm8978_alc1);
136 static const DECLARE_TLV_DB_SCALE(digital_tlv, -12750, 50, 1);
137 static const DECLARE_TLV_DB_SCALE(eq_tlv, -1200, 100, 0);
138 static const DECLARE_TLV_DB_SCALE(inpga_tlv, -1200, 75, 0);
139 static const DECLARE_TLV_DB_SCALE(spk_tlv, -5700, 100, 0);
140 static const DECLARE_TLV_DB_SCALE(boost_tlv, -1500, 300, 1);
141 static const DECLARE_TLV_DB_SCALE(limiter_tlv, 0, 100, 0);
143 static const struct snd_kcontrol_new wm8978_snd_controls[] = {
145 SOC_SINGLE("Digital Loopback Switch",
146 WM8978_COMPANDING_CONTROL, 0, 1, 0),
148 SOC_ENUM("ADC Companding", adc_compand),
149 SOC_ENUM("DAC Companding", dac_compand),
151 SOC_DOUBLE("DAC Inversion Switch", WM8978_DAC_CONTROL, 0, 1, 1, 0),
153 SOC_DOUBLE_R_TLV("PCM Volume",
154 WM8978_LEFT_DAC_DIGITAL_VOLUME, WM8978_RIGHT_DAC_DIGITAL_VOLUME,
155 0, 255, 0, digital_tlv),
157 SOC_SINGLE("High Pass Filter Switch", WM8978_ADC_CONTROL, 8, 1, 0),
158 SOC_SINGLE("High Pass Cut Off", WM8978_ADC_CONTROL, 4, 7, 0),
159 SOC_DOUBLE("ADC Inversion Switch", WM8978_ADC_CONTROL, 0, 1, 1, 0),
161 SOC_DOUBLE_R_TLV("ADC Volume",
162 WM8978_LEFT_ADC_DIGITAL_VOLUME, WM8978_RIGHT_ADC_DIGITAL_VOLUME,
163 0, 255, 0, digital_tlv),
165 SOC_ENUM("Equaliser Function", eqmode),
166 SOC_ENUM("EQ1 Cut Off", eq1),
167 SOC_SINGLE_TLV("EQ1 Volume", WM8978_EQ1, 0, 24, 1, eq_tlv),
169 SOC_ENUM("Equaliser EQ2 Bandwidth", eq2bw),
170 SOC_ENUM("EQ2 Cut Off", eq2),
171 SOC_SINGLE_TLV("EQ2 Volume", WM8978_EQ2, 0, 24, 1, eq_tlv),
173 SOC_ENUM("Equaliser EQ3 Bandwidth", eq3bw),
174 SOC_ENUM("EQ3 Cut Off", eq3),
175 SOC_SINGLE_TLV("EQ3 Volume", WM8978_EQ3, 0, 24, 1, eq_tlv),
177 SOC_ENUM("Equaliser EQ4 Bandwidth", eq4bw),
178 SOC_ENUM("EQ4 Cut Off", eq4),
179 SOC_SINGLE_TLV("EQ4 Volume", WM8978_EQ4, 0, 24, 1, eq_tlv),
181 SOC_ENUM("EQ5 Cut Off", eq5),
182 SOC_SINGLE_TLV("EQ5 Volume", WM8978_EQ5, 0, 24, 1, eq_tlv),
184 SOC_SINGLE("DAC Playback Limiter Switch",
185 WM8978_DAC_LIMITER_1, 8, 1, 0),
186 SOC_SINGLE("DAC Playback Limiter Decay",
187 WM8978_DAC_LIMITER_1, 4, 15, 0),
188 SOC_SINGLE("DAC Playback Limiter Attack",
189 WM8978_DAC_LIMITER_1, 0, 15, 0),
191 SOC_SINGLE("DAC Playback Limiter Threshold",
192 WM8978_DAC_LIMITER_2, 4, 7, 0),
193 SOC_SINGLE_TLV("DAC Playback Limiter Volume",
194 WM8978_DAC_LIMITER_2, 0, 12, 0, limiter_tlv),
196 SOC_ENUM("ALC Enable Switch", alc1),
197 SOC_SINGLE("ALC Capture Min Gain", WM8978_ALC_CONTROL_1, 0, 7, 0),
198 SOC_SINGLE("ALC Capture Max Gain", WM8978_ALC_CONTROL_1, 3, 7, 0),
200 SOC_SINGLE("ALC Capture Hold", WM8978_ALC_CONTROL_2, 4, 10, 0),
201 SOC_SINGLE("ALC Capture Target", WM8978_ALC_CONTROL_2, 0, 15, 0),
203 SOC_ENUM("ALC Capture Mode", alc3),
204 SOC_SINGLE("ALC Capture Decay", WM8978_ALC_CONTROL_3, 4, 10, 0),
205 SOC_SINGLE("ALC Capture Attack", WM8978_ALC_CONTROL_3, 0, 10, 0),
207 SOC_SINGLE("ALC Capture Noise Gate Switch", WM8978_NOISE_GATE, 3, 1, 0),
208 SOC_SINGLE("ALC Capture Noise Gate Threshold",
209 WM8978_NOISE_GATE, 0, 7, 0),
211 SOC_DOUBLE_R("Capture PGA ZC Switch",
212 WM8978_LEFT_INP_PGA_CONTROL, WM8978_RIGHT_INP_PGA_CONTROL,
215 /* OUT1 - Headphones */
216 SOC_DOUBLE_R("Headphone Playback ZC Switch",
217 WM8978_LOUT1_HP_CONTROL, WM8978_ROUT1_HP_CONTROL, 7, 1, 0),
219 SOC_DOUBLE_R_TLV("Headphone Playback Volume",
220 WM8978_LOUT1_HP_CONTROL, WM8978_ROUT1_HP_CONTROL,
223 /* OUT2 - Speakers */
224 SOC_DOUBLE_R("Speaker Playback ZC Switch",
225 WM8978_LOUT2_SPK_CONTROL, WM8978_ROUT2_SPK_CONTROL, 7, 1, 0),
227 SOC_DOUBLE_R_TLV("Speaker Playback Volume",
228 WM8978_LOUT2_SPK_CONTROL, WM8978_ROUT2_SPK_CONTROL,
231 /* OUT3/4 - Line Output */
232 SOC_DOUBLE_R("Line Playback Switch",
233 WM8978_OUT3_MIXER_CONTROL, WM8978_OUT4_MIXER_CONTROL, 6, 1, 1),
235 /* Mixer #3: Boost (Input) mixer */
236 SOC_DOUBLE_R("PGA Boost (+20dB)",
237 WM8978_LEFT_ADC_BOOST_CONTROL, WM8978_RIGHT_ADC_BOOST_CONTROL,
239 SOC_DOUBLE_R_TLV("L2/R2 Boost Volume",
240 WM8978_LEFT_ADC_BOOST_CONTROL, WM8978_RIGHT_ADC_BOOST_CONTROL,
242 SOC_DOUBLE_R_TLV("Aux Boost Volume",
243 WM8978_LEFT_ADC_BOOST_CONTROL, WM8978_RIGHT_ADC_BOOST_CONTROL,
246 /* Input PGA volume */
247 SOC_DOUBLE_R_TLV("Input PGA Volume",
248 WM8978_LEFT_INP_PGA_CONTROL, WM8978_RIGHT_INP_PGA_CONTROL,
249 0, 63, 0, inpga_tlv),
252 SOC_DOUBLE_R("Headphone Switch",
253 WM8978_LOUT1_HP_CONTROL, WM8978_ROUT1_HP_CONTROL, 6, 1, 1),
256 SOC_DOUBLE_R("Speaker Switch",
257 WM8978_LOUT2_SPK_CONTROL, WM8978_ROUT2_SPK_CONTROL, 6, 1, 1),
259 /* DAC / ADC oversampling */
260 SOC_SINGLE("DAC 128x Oversampling Switch", WM8978_DAC_CONTROL,
262 SOC_SINGLE("ADC 128x Oversampling Switch", WM8978_ADC_CONTROL,
266 /* Mixer #1: Output (OUT1, OUT2) Mixer: mix AUX, Input mixer output and DAC */
267 static const struct snd_kcontrol_new wm8978_left_out_mixer[] = {
268 SOC_DAPM_SINGLE("Line Bypass Switch", WM8978_LEFT_MIXER_CONTROL, 1, 1, 0),
269 SOC_DAPM_SINGLE("Aux Playback Switch", WM8978_LEFT_MIXER_CONTROL, 5, 1, 0),
270 SOC_DAPM_SINGLE("PCM Playback Switch", WM8978_LEFT_MIXER_CONTROL, 0, 1, 0),
273 static const struct snd_kcontrol_new wm8978_right_out_mixer[] = {
274 SOC_DAPM_SINGLE("Line Bypass Switch", WM8978_RIGHT_MIXER_CONTROL, 1, 1, 0),
275 SOC_DAPM_SINGLE("Aux Playback Switch", WM8978_RIGHT_MIXER_CONTROL, 5, 1, 0),
276 SOC_DAPM_SINGLE("PCM Playback Switch", WM8978_RIGHT_MIXER_CONTROL, 0, 1, 0),
279 /* OUT3/OUT4 Mixer not implemented */
281 /* Mixer #2: Input PGA Mute */
282 static const struct snd_kcontrol_new wm8978_left_input_mixer[] = {
283 SOC_DAPM_SINGLE("L2 Switch", WM8978_INPUT_CONTROL, 2, 1, 0),
284 SOC_DAPM_SINGLE("MicN Switch", WM8978_INPUT_CONTROL, 1, 1, 0),
285 SOC_DAPM_SINGLE("MicP Switch", WM8978_INPUT_CONTROL, 0, 1, 0),
287 static const struct snd_kcontrol_new wm8978_right_input_mixer[] = {
288 SOC_DAPM_SINGLE("R2 Switch", WM8978_INPUT_CONTROL, 6, 1, 0),
289 SOC_DAPM_SINGLE("MicN Switch", WM8978_INPUT_CONTROL, 5, 1, 0),
290 SOC_DAPM_SINGLE("MicP Switch", WM8978_INPUT_CONTROL, 4, 1, 0),
293 static const struct snd_soc_dapm_widget wm8978_dapm_widgets[] = {
294 SND_SOC_DAPM_DAC("Left DAC", "Left HiFi Playback",
295 WM8978_POWER_MANAGEMENT_3, 0, 0),
296 SND_SOC_DAPM_DAC("Right DAC", "Right HiFi Playback",
297 WM8978_POWER_MANAGEMENT_3, 1, 0),
298 SND_SOC_DAPM_ADC("Left ADC", "Left HiFi Capture",
299 WM8978_POWER_MANAGEMENT_2, 0, 0),
300 SND_SOC_DAPM_ADC("Right ADC", "Right HiFi Capture",
301 WM8978_POWER_MANAGEMENT_2, 1, 0),
303 /* Mixer #1: OUT1,2 */
304 SOC_MIXER_ARRAY("Left Output Mixer", WM8978_POWER_MANAGEMENT_3,
305 2, 0, wm8978_left_out_mixer),
306 SOC_MIXER_ARRAY("Right Output Mixer", WM8978_POWER_MANAGEMENT_3,
307 3, 0, wm8978_right_out_mixer),
309 SOC_MIXER_ARRAY("Left Input Mixer", WM8978_POWER_MANAGEMENT_2,
310 2, 0, wm8978_left_input_mixer),
311 SOC_MIXER_ARRAY("Right Input Mixer", WM8978_POWER_MANAGEMENT_2,
312 3, 0, wm8978_right_input_mixer),
314 SND_SOC_DAPM_PGA("Left Boost Mixer", WM8978_POWER_MANAGEMENT_2,
316 SND_SOC_DAPM_PGA("Right Boost Mixer", WM8978_POWER_MANAGEMENT_2,
319 SND_SOC_DAPM_PGA("Left Capture PGA", WM8978_LEFT_INP_PGA_CONTROL,
321 SND_SOC_DAPM_PGA("Right Capture PGA", WM8978_RIGHT_INP_PGA_CONTROL,
324 SND_SOC_DAPM_PGA("Left Headphone Out", WM8978_POWER_MANAGEMENT_2,
326 SND_SOC_DAPM_PGA("Right Headphone Out", WM8978_POWER_MANAGEMENT_2,
329 SND_SOC_DAPM_PGA("Left Speaker Out", WM8978_POWER_MANAGEMENT_3,
331 SND_SOC_DAPM_PGA("Right Speaker Out", WM8978_POWER_MANAGEMENT_3,
334 SND_SOC_DAPM_MIXER("OUT4 VMID", WM8978_POWER_MANAGEMENT_3,
337 SND_SOC_DAPM_MICBIAS("Mic Bias", WM8978_POWER_MANAGEMENT_1, 4, 0),
339 SND_SOC_DAPM_INPUT("LMICN"),
340 SND_SOC_DAPM_INPUT("LMICP"),
341 SND_SOC_DAPM_INPUT("RMICN"),
342 SND_SOC_DAPM_INPUT("RMICP"),
343 SND_SOC_DAPM_INPUT("LAUX"),
344 SND_SOC_DAPM_INPUT("RAUX"),
345 SND_SOC_DAPM_INPUT("L2"),
346 SND_SOC_DAPM_INPUT("R2"),
347 SND_SOC_DAPM_OUTPUT("LHP"),
348 SND_SOC_DAPM_OUTPUT("RHP"),
349 SND_SOC_DAPM_OUTPUT("LSPK"),
350 SND_SOC_DAPM_OUTPUT("RSPK"),
353 static const struct snd_soc_dapm_route wm8978_dapm_routes[] = {
355 {"Right Output Mixer", "PCM Playback Switch", "Right DAC"},
356 {"Right Output Mixer", "Aux Playback Switch", "RAUX"},
357 {"Right Output Mixer", "Line Bypass Switch", "Right Boost Mixer"},
359 {"Left Output Mixer", "PCM Playback Switch", "Left DAC"},
360 {"Left Output Mixer", "Aux Playback Switch", "LAUX"},
361 {"Left Output Mixer", "Line Bypass Switch", "Left Boost Mixer"},
364 {"Right Headphone Out", NULL, "Right Output Mixer"},
365 {"RHP", NULL, "Right Headphone Out"},
367 {"Left Headphone Out", NULL, "Left Output Mixer"},
368 {"LHP", NULL, "Left Headphone Out"},
370 {"Right Speaker Out", NULL, "Right Output Mixer"},
371 {"RSPK", NULL, "Right Speaker Out"},
373 {"Left Speaker Out", NULL, "Left Output Mixer"},
374 {"LSPK", NULL, "Left Speaker Out"},
377 {"Right ADC", NULL, "Right Boost Mixer"},
379 {"Right Boost Mixer", NULL, "RAUX"},
380 {"Right Boost Mixer", NULL, "Right Capture PGA"},
381 {"Right Boost Mixer", NULL, "R2"},
383 {"Left ADC", NULL, "Left Boost Mixer"},
385 {"Left Boost Mixer", NULL, "LAUX"},
386 {"Left Boost Mixer", NULL, "Left Capture PGA"},
387 {"Left Boost Mixer", NULL, "L2"},
390 {"Right Capture PGA", NULL, "Right Input Mixer"},
391 {"Left Capture PGA", NULL, "Left Input Mixer"},
393 {"Right Input Mixer", "R2 Switch", "R2"},
394 {"Right Input Mixer", "MicN Switch", "RMICN"},
395 {"Right Input Mixer", "MicP Switch", "RMICP"},
397 {"Left Input Mixer", "L2 Switch", "L2"},
398 {"Left Input Mixer", "MicN Switch", "LMICN"},
399 {"Left Input Mixer", "MicP Switch", "LMICP"},
403 struct wm8978_pll_div {
409 #define FIXED_PLL_SIZE (1 << 24)
411 static void pll_factors(struct snd_soc_codec *codec,
412 struct wm8978_pll_div *pll_div, unsigned int target, unsigned int source)
415 unsigned int k, n_div, n_mod;
417 n_div = target / source;
421 n_div = target / source;
426 if (n_div < 6 || n_div > 12)
428 "WM8978 N value exceeds recommended range! N = %u\n",
432 n_mod = target - source * n_div;
433 k_part = FIXED_PLL_SIZE * (long long)n_mod + source / 2;
435 do_div(k_part, source);
437 k = k_part & 0xFFFFFFFF;
443 static const int mclk_numerator[] = {1, 3, 2, 3, 4, 6, 8, 12};
444 static const int mclk_denominator[] = {1, 2, 1, 1, 1, 1, 1, 1};
447 * find index >= idx, such that, for a given f_out,
448 * 3 * f_mclk / 4 <= f_PLLOUT < 13 * f_mclk / 4
449 * f_out can be f_256fs or f_opclk, currently only used for f_256fs. Can be
450 * generalised for f_opclk with suitable coefficient arrays, but currently
451 * the OPCLK divisor is calculated directly, not iteratively.
453 static int wm8978_enum_mclk(unsigned int f_out, unsigned int f_mclk,
454 unsigned int *f_pllout)
458 for (i = 0; i < ARRAY_SIZE(mclk_numerator); i++) {
459 unsigned int f_pllout_x4 = 4 * f_out * mclk_numerator[i] /
461 if (3 * f_mclk <= f_pllout_x4 && f_pllout_x4 < 13 * f_mclk) {
462 *f_pllout = f_pllout_x4 / 4;
471 * Calculate internal frequencies and dividers, according to Figure 40
472 * "PLL and Clock Select Circuit" in WM8978 datasheet Rev. 2.6
474 static int wm8978_configure_pll(struct snd_soc_codec *codec)
476 struct wm8978_priv *wm8978 = snd_soc_codec_get_drvdata(codec);
477 struct wm8978_pll_div pll_div;
478 unsigned int f_opclk = wm8978->f_opclk, f_mclk = wm8978->f_mclk,
479 f_256fs = wm8978->f_256fs;
486 unsigned int opclk_div;
487 /* Cannot set up MCLK divider now, do later */
488 wm8978->mclk_idx = -1;
491 * The user needs OPCLK. Choose OPCLKDIV to put
492 * 6 <= R = f2 / f1 < 13, 1 <= OPCLKDIV <= 4.
493 * f_opclk = f_mclk * prescale * R / 4 / OPCLKDIV, where
494 * prescale = 1, or prescale = 2. Prescale is calculated inside
495 * pll_factors(). We have to select f_PLLOUT, such that
496 * f_mclk * 3 / 4 <= f_PLLOUT < f_mclk * 13 / 4. Must be
497 * f_mclk * 3 / 16 <= f_opclk < f_mclk * 13 / 4.
499 if (16 * f_opclk < 3 * f_mclk || 4 * f_opclk >= 13 * f_mclk)
502 if (4 * f_opclk < 3 * f_mclk)
503 /* Have to use OPCLKDIV */
504 opclk_div = (3 * f_mclk / 4 + f_opclk - 1) / f_opclk;
508 dev_dbg(codec->dev, "%s: OPCLKDIV=%d\n", __func__, opclk_div);
510 snd_soc_update_bits(codec, WM8978_GPIO_CONTROL, 0x30,
511 (opclk_div - 1) << 4);
513 wm8978->f_pllout = f_opclk * opclk_div;
514 } else if (f_256fs) {
516 * Not using OPCLK, but PLL is used for the codec, choose R:
517 * 6 <= R = f2 / f1 < 13, to put 1 <= MCLKDIV <= 12.
518 * f_256fs = f_mclk * prescale * R / 4 / MCLKDIV, where
519 * prescale = 1, or prescale = 2. Prescale is calculated inside
520 * pll_factors(). We have to select f_PLLOUT, such that
521 * f_mclk * 3 / 4 <= f_PLLOUT < f_mclk * 13 / 4. Must be
522 * f_mclk * 3 / 48 <= f_256fs < f_mclk * 13 / 4. This means MCLK
523 * must be 3.781MHz <= f_MCLK <= 32.768MHz
525 int idx = wm8978_enum_mclk(f_256fs, f_mclk, &wm8978->f_pllout);
529 wm8978->mclk_idx = idx;
534 f2 = wm8978->f_pllout * 4;
536 dev_dbg(codec->dev, "%s: f_MCLK=%uHz, f_PLLOUT=%uHz\n", __func__,
537 wm8978->f_mclk, wm8978->f_pllout);
539 pll_factors(codec, &pll_div, f2, wm8978->f_mclk);
541 dev_dbg(codec->dev, "%s: calculated PLL N=0x%x, K=0x%x, div2=%d\n",
542 __func__, pll_div.n, pll_div.k, pll_div.div2);
544 /* Turn PLL off for configuration... */
545 snd_soc_update_bits(codec, WM8978_POWER_MANAGEMENT_1, 0x20, 0);
547 snd_soc_write(codec, WM8978_PLL_N, (pll_div.div2 << 4) | pll_div.n);
548 snd_soc_write(codec, WM8978_PLL_K1, pll_div.k >> 18);
549 snd_soc_write(codec, WM8978_PLL_K2, (pll_div.k >> 9) & 0x1ff);
550 snd_soc_write(codec, WM8978_PLL_K3, pll_div.k & 0x1ff);
552 /* ...and on again */
553 snd_soc_update_bits(codec, WM8978_POWER_MANAGEMENT_1, 0x20, 0x20);
556 /* Output PLL (OPCLK) to GPIO1 */
557 snd_soc_update_bits(codec, WM8978_GPIO_CONTROL, 7, 4);
563 * Configure WM8978 clock dividers.
565 static int wm8978_set_dai_clkdiv(struct snd_soc_dai *codec_dai,
568 struct snd_soc_codec *codec = codec_dai->codec;
569 struct wm8978_priv *wm8978 = snd_soc_codec_get_drvdata(codec);
573 case WM8978_OPCLKRATE:
574 wm8978->f_opclk = div;
578 * We know the MCLK frequency, the user has requested
579 * OPCLK, configure the PLL based on that and start it
580 * and OPCLK immediately. We will configure PLL to match
581 * user-requested OPCLK frquency as good as possible.
582 * In fact, it is likely, that matching the sampling
583 * rate, when it becomes known, is more important, and
584 * we will not be reconfiguring PLL then, because we
585 * must not interrupt OPCLK. But it should be fine,
586 * because typically the user will request OPCLK to run
587 * at 256fs or 512fs, and for these cases we will also
588 * find an exact MCLK divider configuration - it will
589 * be equal to or double the OPCLK divisor.
591 ret = wm8978_configure_pll(codec);
596 snd_soc_update_bits(codec, WM8978_CLOCKING, 0x1c, div);
602 dev_dbg(codec->dev, "%s: ID %d, value %u\n", __func__, div_id, div);
608 * @freq: when .set_pll() us not used, freq is codec MCLK input frequency
610 static int wm8978_set_dai_sysclk(struct snd_soc_dai *codec_dai, int clk_id,
611 unsigned int freq, int dir)
613 struct snd_soc_codec *codec = codec_dai->codec;
614 struct wm8978_priv *wm8978 = snd_soc_codec_get_drvdata(codec);
617 dev_dbg(codec->dev, "%s: ID %d, freq %u\n", __func__, clk_id, freq);
620 wm8978->f_mclk = freq;
622 /* Even if MCLK is used for system clock, might have to drive OPCLK */
624 ret = wm8978_configure_pll(codec);
626 /* Our sysclk is fixed to 256 * fs, will configure in .hw_params() */
629 wm8978->sysclk = clk_id;
632 if (wm8978->sysclk == WM8978_PLL && (!freq || clk_id == WM8978_MCLK)) {
633 /* Clock CODEC directly from MCLK */
634 snd_soc_update_bits(codec, WM8978_CLOCKING, 0x100, 0);
636 /* GPIO1 into default mode as input - before configuring PLL */
637 snd_soc_update_bits(codec, WM8978_GPIO_CONTROL, 7, 0);
640 snd_soc_update_bits(codec, WM8978_POWER_MANAGEMENT_1, 0x20, 0);
641 wm8978->sysclk = WM8978_MCLK;
642 wm8978->f_pllout = 0;
650 * Set ADC and Voice DAC format.
652 static int wm8978_set_dai_fmt(struct snd_soc_dai *codec_dai, unsigned int fmt)
654 struct snd_soc_codec *codec = codec_dai->codec;
656 * BCLK polarity mask = 0x100, LRC clock polarity mask = 0x80,
657 * Data Format mask = 0x18: all will be calculated anew
659 u16 iface = snd_soc_read(codec, WM8978_AUDIO_INTERFACE) & ~0x198;
660 u16 clk = snd_soc_read(codec, WM8978_CLOCKING);
662 dev_dbg(codec->dev, "%s\n", __func__);
664 /* set master/slave audio interface */
665 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
666 case SND_SOC_DAIFMT_CBM_CFM:
669 case SND_SOC_DAIFMT_CBS_CFS:
676 /* interface format */
677 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
678 case SND_SOC_DAIFMT_I2S:
681 case SND_SOC_DAIFMT_RIGHT_J:
683 case SND_SOC_DAIFMT_LEFT_J:
686 case SND_SOC_DAIFMT_DSP_A:
693 /* clock inversion */
694 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
695 case SND_SOC_DAIFMT_NB_NF:
697 case SND_SOC_DAIFMT_IB_IF:
700 case SND_SOC_DAIFMT_IB_NF:
703 case SND_SOC_DAIFMT_NB_IF:
710 snd_soc_write(codec, WM8978_AUDIO_INTERFACE, iface);
711 snd_soc_write(codec, WM8978_CLOCKING, clk);
717 * Set PCM DAI bit size and sample rate.
719 static int wm8978_hw_params(struct snd_pcm_substream *substream,
720 struct snd_pcm_hw_params *params,
721 struct snd_soc_dai *dai)
723 struct snd_soc_codec *codec = dai->codec;
724 struct wm8978_priv *wm8978 = snd_soc_codec_get_drvdata(codec);
725 /* Word length mask = 0x60 */
726 u16 iface_ctl = snd_soc_read(codec, WM8978_AUDIO_INTERFACE) & ~0x60;
727 /* Sampling rate mask = 0xe (for filters) */
728 u16 add_ctl = snd_soc_read(codec, WM8978_ADDITIONAL_CONTROL) & ~0xe;
729 u16 clking = snd_soc_read(codec, WM8978_CLOCKING);
730 enum wm8978_sysclk_src current_clk_id = clking & 0x100 ?
731 WM8978_PLL : WM8978_MCLK;
732 unsigned int f_sel, diff, diff_best = INT_MAX;
739 switch (params_format(params)) {
740 case SNDRV_PCM_FORMAT_S16_LE:
742 case SNDRV_PCM_FORMAT_S20_3LE:
745 case SNDRV_PCM_FORMAT_S24_LE:
748 case SNDRV_PCM_FORMAT_S32_LE:
753 /* filter coefficient */
754 switch (params_rate(params)) {
775 /* Sampling rate is known now, can configure the MCLK divider */
776 wm8978->f_256fs = params_rate(params) * 256;
778 if (wm8978->sysclk == WM8978_MCLK) {
779 wm8978->mclk_idx = -1;
780 f_sel = wm8978->f_mclk;
782 if (!wm8978->f_opclk) {
783 /* We only enter here, if OPCLK is not used */
784 int ret = wm8978_configure_pll(codec);
788 f_sel = wm8978->f_pllout;
791 if (wm8978->mclk_idx < 0) {
792 /* Either MCLK is used directly, or OPCLK is used */
793 if (f_sel < wm8978->f_256fs || f_sel > 12 * wm8978->f_256fs)
796 for (i = 0; i < ARRAY_SIZE(mclk_numerator); i++) {
797 diff = abs(wm8978->f_256fs * 3 -
798 f_sel * 3 * mclk_denominator[i] / mclk_numerator[i]);
800 if (diff < diff_best) {
809 /* OPCLK not used, codec driven by PLL */
810 best = wm8978->mclk_idx;
815 dev_warn(codec->dev, "Imprecise sampling rate: %uHz%s\n",
816 f_sel * mclk_denominator[best] / mclk_numerator[best] / 256,
817 wm8978->sysclk == WM8978_MCLK ?
818 ", consider using PLL" : "");
820 dev_dbg(codec->dev, "%s: fmt %d, rate %u, MCLK divisor #%d\n", __func__,
821 params_format(params), params_rate(params), best);
823 /* MCLK divisor mask = 0xe0 */
824 snd_soc_update_bits(codec, WM8978_CLOCKING, 0xe0, best << 5);
826 snd_soc_write(codec, WM8978_AUDIO_INTERFACE, iface_ctl);
827 snd_soc_write(codec, WM8978_ADDITIONAL_CONTROL, add_ctl);
829 if (wm8978->sysclk != current_clk_id) {
830 if (wm8978->sysclk == WM8978_PLL)
831 /* Run CODEC from PLL instead of MCLK */
832 snd_soc_update_bits(codec, WM8978_CLOCKING,
835 /* Clock CODEC directly from MCLK */
836 snd_soc_update_bits(codec, WM8978_CLOCKING, 0x100, 0);
842 static int wm8978_mute(struct snd_soc_dai *dai, int mute)
844 struct snd_soc_codec *codec = dai->codec;
846 dev_dbg(codec->dev, "%s: %d\n", __func__, mute);
849 snd_soc_update_bits(codec, WM8978_DAC_CONTROL, 0x40, 0x40);
851 snd_soc_update_bits(codec, WM8978_DAC_CONTROL, 0x40, 0);
856 static int wm8978_set_bias_level(struct snd_soc_codec *codec,
857 enum snd_soc_bias_level level)
859 u16 power1 = snd_soc_read(codec, WM8978_POWER_MANAGEMENT_1) & ~3;
862 case SND_SOC_BIAS_ON:
863 case SND_SOC_BIAS_PREPARE:
864 power1 |= 1; /* VMID 75k */
865 snd_soc_write(codec, WM8978_POWER_MANAGEMENT_1, power1);
867 case SND_SOC_BIAS_STANDBY:
868 /* bit 3: enable bias, bit 2: enable I/O tie off buffer */
871 if (codec->dapm.bias_level == SND_SOC_BIAS_OFF) {
872 /* Initial cap charge at VMID 5k */
873 snd_soc_write(codec, WM8978_POWER_MANAGEMENT_1,
878 power1 |= 0x2; /* VMID 500k */
879 snd_soc_write(codec, WM8978_POWER_MANAGEMENT_1, power1);
881 case SND_SOC_BIAS_OFF:
882 /* Preserve PLL - OPCLK may be used by someone */
883 snd_soc_update_bits(codec, WM8978_POWER_MANAGEMENT_1, ~0x20, 0);
884 snd_soc_write(codec, WM8978_POWER_MANAGEMENT_2, 0);
885 snd_soc_write(codec, WM8978_POWER_MANAGEMENT_3, 0);
889 dev_dbg(codec->dev, "%s: %d, %x\n", __func__, level, power1);
891 codec->dapm.bias_level = level;
895 #define WM8978_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE | \
896 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
898 static const struct snd_soc_dai_ops wm8978_dai_ops = {
899 .hw_params = wm8978_hw_params,
900 .digital_mute = wm8978_mute,
901 .set_fmt = wm8978_set_dai_fmt,
902 .set_clkdiv = wm8978_set_dai_clkdiv,
903 .set_sysclk = wm8978_set_dai_sysclk,
906 /* Also supports 12kHz */
907 static struct snd_soc_dai_driver wm8978_dai = {
908 .name = "wm8978-hifi",
910 .stream_name = "Playback",
913 .rates = SNDRV_PCM_RATE_8000_48000,
914 .formats = WM8978_FORMATS,
917 .stream_name = "Capture",
920 .rates = SNDRV_PCM_RATE_8000_48000,
921 .formats = WM8978_FORMATS,
923 .ops = &wm8978_dai_ops,
924 .symmetric_rates = 1,
927 static int wm8978_suspend(struct snd_soc_codec *codec)
929 struct wm8978_priv *wm8978 = snd_soc_codec_get_drvdata(codec);
931 wm8978_set_bias_level(codec, SND_SOC_BIAS_OFF);
932 /* Also switch PLL off */
933 snd_soc_write(codec, WM8978_POWER_MANAGEMENT_1, 0);
935 regcache_mark_dirty(wm8978->regmap);
940 static int wm8978_resume(struct snd_soc_codec *codec)
942 struct wm8978_priv *wm8978 = snd_soc_codec_get_drvdata(codec);
944 /* Sync reg_cache with the hardware */
945 regcache_sync(wm8978->regmap);
947 wm8978_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
949 if (wm8978->f_pllout)
951 snd_soc_update_bits(codec, WM8978_POWER_MANAGEMENT_1, 0x20, 0x20);
957 * These registers contain an "update" bit - bit 8. This means, for example,
958 * that one can write new DAC digital volume for both channels, but only when
959 * the update bit is set, will also the volume be updated - simultaneously for
962 static const int update_reg[] = {
963 WM8978_LEFT_DAC_DIGITAL_VOLUME,
964 WM8978_RIGHT_DAC_DIGITAL_VOLUME,
965 WM8978_LEFT_ADC_DIGITAL_VOLUME,
966 WM8978_RIGHT_ADC_DIGITAL_VOLUME,
967 WM8978_LEFT_INP_PGA_CONTROL,
968 WM8978_RIGHT_INP_PGA_CONTROL,
969 WM8978_LOUT1_HP_CONTROL,
970 WM8978_ROUT1_HP_CONTROL,
971 WM8978_LOUT2_SPK_CONTROL,
972 WM8978_ROUT2_SPK_CONTROL,
975 static int wm8978_probe(struct snd_soc_codec *codec)
977 struct wm8978_priv *wm8978 = snd_soc_codec_get_drvdata(codec);
981 * Set default system clock to PLL, it is more precise, this is also the
982 * default hardware setting
984 wm8978->sysclk = WM8978_PLL;
985 codec->control_data = wm8978->regmap;
986 ret = snd_soc_codec_set_cache_io(codec, 7, 9, SND_SOC_REGMAP);
988 dev_err(codec->dev, "Failed to set cache I/O: %d\n", ret);
993 * Set the update bit in all registers, that have one. This way all
994 * writes to those registers will also cause the update bit to be
997 for (i = 0; i < ARRAY_SIZE(update_reg); i++)
998 snd_soc_update_bits(codec, update_reg[i], 0x100, 0x100);
1000 wm8978_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
1005 /* power down chip */
1006 static int wm8978_remove(struct snd_soc_codec *codec)
1008 wm8978_set_bias_level(codec, SND_SOC_BIAS_OFF);
1012 static struct snd_soc_codec_driver soc_codec_dev_wm8978 = {
1013 .probe = wm8978_probe,
1014 .remove = wm8978_remove,
1015 .suspend = wm8978_suspend,
1016 .resume = wm8978_resume,
1017 .set_bias_level = wm8978_set_bias_level,
1019 .controls = wm8978_snd_controls,
1020 .num_controls = ARRAY_SIZE(wm8978_snd_controls),
1021 .dapm_widgets = wm8978_dapm_widgets,
1022 .num_dapm_widgets = ARRAY_SIZE(wm8978_dapm_widgets),
1023 .dapm_routes = wm8978_dapm_routes,
1024 .num_dapm_routes = ARRAY_SIZE(wm8978_dapm_routes),
1027 static const struct regmap_config wm8978_regmap_config = {
1031 .max_register = WM8978_MAX_REGISTER,
1032 .volatile_reg = wm8978_volatile,
1034 .cache_type = REGCACHE_RBTREE,
1035 .reg_defaults = wm8978_reg_defaults,
1036 .num_reg_defaults = ARRAY_SIZE(wm8978_reg_defaults),
1039 static int wm8978_i2c_probe(struct i2c_client *i2c,
1040 const struct i2c_device_id *id)
1042 struct wm8978_priv *wm8978;
1045 wm8978 = devm_kzalloc(&i2c->dev, sizeof(struct wm8978_priv),
1050 wm8978->regmap = devm_regmap_init_i2c(i2c, &wm8978_regmap_config);
1051 if (IS_ERR(wm8978->regmap)) {
1052 ret = PTR_ERR(wm8978->regmap);
1053 dev_err(&i2c->dev, "Failed to allocate regmap: %d\n", ret);
1057 i2c_set_clientdata(i2c, wm8978);
1059 /* Reset the codec */
1060 ret = regmap_write(wm8978->regmap, WM8978_RESET, 0);
1062 dev_err(&i2c->dev, "Failed to issue reset: %d\n", ret);
1066 ret = snd_soc_register_codec(&i2c->dev,
1067 &soc_codec_dev_wm8978, &wm8978_dai, 1);
1069 dev_err(&i2c->dev, "Failed to register CODEC: %d\n", ret);
1076 static int wm8978_i2c_remove(struct i2c_client *client)
1078 snd_soc_unregister_codec(&client->dev);
1083 static const struct i2c_device_id wm8978_i2c_id[] = {
1087 MODULE_DEVICE_TABLE(i2c, wm8978_i2c_id);
1089 static struct i2c_driver wm8978_i2c_driver = {
1092 .owner = THIS_MODULE,
1094 .probe = wm8978_i2c_probe,
1095 .remove = wm8978_i2c_remove,
1096 .id_table = wm8978_i2c_id,
1099 module_i2c_driver(wm8978_i2c_driver);
1101 MODULE_DESCRIPTION("ASoC WM8978 codec driver");
1102 MODULE_AUTHOR("Guennadi Liakhovetski <g.liakhovetski@gmx.de>");
1103 MODULE_LICENSE("GPL");