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/platform_device.h>
22 #include <sound/core.h>
23 #include <sound/pcm.h>
24 #include <sound/pcm_params.h>
25 #include <sound/soc.h>
26 #include <sound/soc-dapm.h>
27 #include <sound/initval.h>
28 #include <sound/tlv.h>
29 #include <asm/div64.h>
33 static struct snd_soc_codec
*wm8978_codec
;
35 /* wm8978 register cache. Note that register 0 is not included in the cache. */
36 static const u16 wm8978_reg
[WM8978_CACHEREGNUM
] = {
37 0x0000, 0x0000, 0x0000, 0x0000, /* 0x00...0x03 */
38 0x0050, 0x0000, 0x0140, 0x0000, /* 0x04...0x07 */
39 0x0000, 0x0000, 0x0000, 0x00ff, /* 0x08...0x0b */
40 0x00ff, 0x0000, 0x0100, 0x00ff, /* 0x0c...0x0f */
41 0x00ff, 0x0000, 0x012c, 0x002c, /* 0x10...0x13 */
42 0x002c, 0x002c, 0x002c, 0x0000, /* 0x14...0x17 */
43 0x0032, 0x0000, 0x0000, 0x0000, /* 0x18...0x1b */
44 0x0000, 0x0000, 0x0000, 0x0000, /* 0x1c...0x1f */
45 0x0038, 0x000b, 0x0032, 0x0000, /* 0x20...0x23 */
46 0x0008, 0x000c, 0x0093, 0x00e9, /* 0x24...0x27 */
47 0x0000, 0x0000, 0x0000, 0x0000, /* 0x28...0x2b */
48 0x0033, 0x0010, 0x0010, 0x0100, /* 0x2c...0x2f */
49 0x0100, 0x0002, 0x0001, 0x0001, /* 0x30...0x33 */
50 0x0039, 0x0039, 0x0039, 0x0039, /* 0x34...0x37 */
51 0x0001, 0x0001, /* 0x38...0x3b */
54 /* codec private data */
56 struct snd_soc_codec codec
;
57 unsigned int f_pllout
;
61 enum wm8978_sysclk_src sysclk
;
62 u16 reg_cache
[WM8978_CACHEREGNUM
];
65 static const char *wm8978_companding
[] = {"Off", "NC", "u-law", "A-law"};
66 static const char *wm8978_eqmode
[] = {"Capture", "Playback"};
67 static const char *wm8978_bw
[] = {"Narrow", "Wide"};
68 static const char *wm8978_eq1
[] = {"80Hz", "105Hz", "135Hz", "175Hz"};
69 static const char *wm8978_eq2
[] = {"230Hz", "300Hz", "385Hz", "500Hz"};
70 static const char *wm8978_eq3
[] = {"650Hz", "850Hz", "1.1kHz", "1.4kHz"};
71 static const char *wm8978_eq4
[] = {"1.8kHz", "2.4kHz", "3.2kHz", "4.1kHz"};
72 static const char *wm8978_eq5
[] = {"5.3kHz", "6.9kHz", "9kHz", "11.7kHz"};
73 static const char *wm8978_alc3
[] = {"ALC", "Limiter"};
74 static const char *wm8978_alc1
[] = {"Off", "Right", "Left", "Both"};
76 static const SOC_ENUM_SINGLE_DECL(adc_compand
, WM8978_COMPANDING_CONTROL
, 1,
78 static const SOC_ENUM_SINGLE_DECL(dac_compand
, WM8978_COMPANDING_CONTROL
, 3,
80 static const SOC_ENUM_SINGLE_DECL(eqmode
, WM8978_EQ1
, 8, wm8978_eqmode
);
81 static const SOC_ENUM_SINGLE_DECL(eq1
, WM8978_EQ1
, 5, wm8978_eq1
);
82 static const SOC_ENUM_SINGLE_DECL(eq2bw
, WM8978_EQ2
, 8, wm8978_bw
);
83 static const SOC_ENUM_SINGLE_DECL(eq2
, WM8978_EQ2
, 5, wm8978_eq2
);
84 static const SOC_ENUM_SINGLE_DECL(eq3bw
, WM8978_EQ3
, 8, wm8978_bw
);
85 static const SOC_ENUM_SINGLE_DECL(eq3
, WM8978_EQ3
, 5, wm8978_eq3
);
86 static const SOC_ENUM_SINGLE_DECL(eq4bw
, WM8978_EQ4
, 8, wm8978_bw
);
87 static const SOC_ENUM_SINGLE_DECL(eq4
, WM8978_EQ4
, 5, wm8978_eq4
);
88 static const SOC_ENUM_SINGLE_DECL(eq5
, WM8978_EQ5
, 5, wm8978_eq5
);
89 static const SOC_ENUM_SINGLE_DECL(alc3
, WM8978_ALC_CONTROL_3
, 8, wm8978_alc3
);
90 static const SOC_ENUM_SINGLE_DECL(alc1
, WM8978_ALC_CONTROL_1
, 7, wm8978_alc1
);
92 static const DECLARE_TLV_DB_SCALE(digital_tlv
, -12750, 50, 1);
93 static const DECLARE_TLV_DB_SCALE(eq_tlv
, -1200, 100, 0);
94 static const DECLARE_TLV_DB_SCALE(inpga_tlv
, -1200, 75, 0);
95 static const DECLARE_TLV_DB_SCALE(spk_tlv
, -5700, 100, 0);
96 static const DECLARE_TLV_DB_SCALE(boost_tlv
, -1500, 300, 1);
98 static const struct snd_kcontrol_new wm8978_snd_controls
[] = {
100 SOC_SINGLE("Digital Loopback Switch",
101 WM8978_COMPANDING_CONTROL
, 0, 1, 0),
103 SOC_ENUM("ADC Companding", adc_compand
),
104 SOC_ENUM("DAC Companding", dac_compand
),
106 SOC_DOUBLE("DAC Inversion Switch", WM8978_DAC_CONTROL
, 0, 1, 1, 0),
108 SOC_DOUBLE_R_TLV("PCM Volume",
109 WM8978_LEFT_DAC_DIGITAL_VOLUME
, WM8978_RIGHT_DAC_DIGITAL_VOLUME
,
110 0, 255, 0, digital_tlv
),
112 SOC_SINGLE("High Pass Filter Switch", WM8978_ADC_CONTROL
, 8, 1, 0),
113 SOC_SINGLE("High Pass Cut Off", WM8978_ADC_CONTROL
, 4, 7, 0),
114 SOC_DOUBLE("ADC Inversion Switch", WM8978_ADC_CONTROL
, 0, 1, 1, 0),
116 SOC_DOUBLE_R_TLV("ADC Volume",
117 WM8978_LEFT_ADC_DIGITAL_VOLUME
, WM8978_RIGHT_ADC_DIGITAL_VOLUME
,
118 0, 255, 0, digital_tlv
),
120 SOC_ENUM("Equaliser Function", eqmode
),
121 SOC_ENUM("EQ1 Cut Off", eq1
),
122 SOC_SINGLE_TLV("EQ1 Volume", WM8978_EQ1
, 0, 24, 1, eq_tlv
),
124 SOC_ENUM("Equaliser EQ2 Bandwith", eq2bw
),
125 SOC_ENUM("EQ2 Cut Off", eq2
),
126 SOC_SINGLE_TLV("EQ2 Volume", WM8978_EQ2
, 0, 24, 1, eq_tlv
),
128 SOC_ENUM("Equaliser EQ3 Bandwith", eq3bw
),
129 SOC_ENUM("EQ3 Cut Off", eq3
),
130 SOC_SINGLE_TLV("EQ3 Volume", WM8978_EQ3
, 0, 24, 1, eq_tlv
),
132 SOC_ENUM("Equaliser EQ4 Bandwith", eq4bw
),
133 SOC_ENUM("EQ4 Cut Off", eq4
),
134 SOC_SINGLE_TLV("EQ4 Volume", WM8978_EQ4
, 0, 24, 1, eq_tlv
),
136 SOC_ENUM("EQ5 Cut Off", eq5
),
137 SOC_SINGLE_TLV("EQ5 Volume", WM8978_EQ5
, 0, 24, 1, eq_tlv
),
139 SOC_SINGLE("DAC Playback Limiter Switch",
140 WM8978_DAC_LIMITER_1
, 8, 1, 0),
141 SOC_SINGLE("DAC Playback Limiter Decay",
142 WM8978_DAC_LIMITER_1
, 4, 15, 0),
143 SOC_SINGLE("DAC Playback Limiter Attack",
144 WM8978_DAC_LIMITER_1
, 0, 15, 0),
146 SOC_SINGLE("DAC Playback Limiter Threshold",
147 WM8978_DAC_LIMITER_2
, 4, 7, 0),
148 SOC_SINGLE("DAC Playback Limiter Boost",
149 WM8978_DAC_LIMITER_2
, 0, 15, 0),
151 SOC_ENUM("ALC Enable Switch", alc1
),
152 SOC_SINGLE("ALC Capture Min Gain", WM8978_ALC_CONTROL_1
, 0, 7, 0),
153 SOC_SINGLE("ALC Capture Max Gain", WM8978_ALC_CONTROL_1
, 3, 7, 0),
155 SOC_SINGLE("ALC Capture Hold", WM8978_ALC_CONTROL_2
, 4, 7, 0),
156 SOC_SINGLE("ALC Capture Target", WM8978_ALC_CONTROL_2
, 0, 15, 0),
158 SOC_ENUM("ALC Capture Mode", alc3
),
159 SOC_SINGLE("ALC Capture Decay", WM8978_ALC_CONTROL_3
, 4, 15, 0),
160 SOC_SINGLE("ALC Capture Attack", WM8978_ALC_CONTROL_3
, 0, 15, 0),
162 SOC_SINGLE("ALC Capture Noise Gate Switch", WM8978_NOISE_GATE
, 3, 1, 0),
163 SOC_SINGLE("ALC Capture Noise Gate Threshold",
164 WM8978_NOISE_GATE
, 0, 7, 0),
166 SOC_DOUBLE_R("Capture PGA ZC Switch",
167 WM8978_LEFT_INP_PGA_CONTROL
, WM8978_RIGHT_INP_PGA_CONTROL
,
170 /* OUT1 - Headphones */
171 SOC_DOUBLE_R("Headphone Playback ZC Switch",
172 WM8978_LOUT1_HP_CONTROL
, WM8978_ROUT1_HP_CONTROL
, 7, 1, 0),
174 SOC_DOUBLE_R_TLV("Headphone Playback Volume",
175 WM8978_LOUT1_HP_CONTROL
, WM8978_ROUT1_HP_CONTROL
,
178 /* OUT2 - Speakers */
179 SOC_DOUBLE_R("Speaker Playback ZC Switch",
180 WM8978_LOUT2_SPK_CONTROL
, WM8978_ROUT2_SPK_CONTROL
, 7, 1, 0),
182 SOC_DOUBLE_R_TLV("Speaker Playback Volume",
183 WM8978_LOUT2_SPK_CONTROL
, WM8978_ROUT2_SPK_CONTROL
,
186 /* OUT3/4 - Line Output */
187 SOC_DOUBLE_R("Line Playback Switch",
188 WM8978_OUT3_MIXER_CONTROL
, WM8978_OUT4_MIXER_CONTROL
, 6, 1, 1),
190 /* Mixer #3: Boost (Input) mixer */
191 SOC_DOUBLE_R("PGA Boost (+20dB)",
192 WM8978_LEFT_ADC_BOOST_CONTROL
, WM8978_RIGHT_ADC_BOOST_CONTROL
,
194 SOC_DOUBLE_R_TLV("L2/R2 Boost Volume",
195 WM8978_LEFT_ADC_BOOST_CONTROL
, WM8978_RIGHT_ADC_BOOST_CONTROL
,
197 SOC_DOUBLE_R_TLV("Aux Boost Volume",
198 WM8978_LEFT_ADC_BOOST_CONTROL
, WM8978_RIGHT_ADC_BOOST_CONTROL
,
201 /* Input PGA volume */
202 SOC_DOUBLE_R_TLV("Input PGA Volume",
203 WM8978_LEFT_INP_PGA_CONTROL
, WM8978_RIGHT_INP_PGA_CONTROL
,
204 0, 63, 0, inpga_tlv
),
207 SOC_DOUBLE_R("Headphone Switch",
208 WM8978_LOUT1_HP_CONTROL
, WM8978_ROUT1_HP_CONTROL
, 6, 1, 1),
211 SOC_DOUBLE_R("Speaker Switch",
212 WM8978_LOUT2_SPK_CONTROL
, WM8978_ROUT2_SPK_CONTROL
, 6, 1, 1),
214 /* DAC / ADC oversampling */
215 SOC_SINGLE("DAC 128x Oversampling Switch", WM8978_DAC_CONTROL
, 8, 1, 0),
216 SOC_SINGLE("ADC 128x Oversampling Switch", WM8978_ADC_CONTROL
, 8, 1, 0),
219 /* Mixer #1: Output (OUT1, OUT2) Mixer: mix AUX, Input mixer output and DAC */
220 static const struct snd_kcontrol_new wm8978_left_out_mixer
[] = {
221 SOC_DAPM_SINGLE("Line Bypass Switch", WM8978_LEFT_MIXER_CONTROL
, 1, 1, 0),
222 SOC_DAPM_SINGLE("Aux Playback Switch", WM8978_LEFT_MIXER_CONTROL
, 5, 1, 0),
223 SOC_DAPM_SINGLE("PCM Playback Switch", WM8978_LEFT_MIXER_CONTROL
, 0, 1, 0),
226 static const struct snd_kcontrol_new wm8978_right_out_mixer
[] = {
227 SOC_DAPM_SINGLE("Line Bypass Switch", WM8978_RIGHT_MIXER_CONTROL
, 1, 1, 0),
228 SOC_DAPM_SINGLE("Aux Playback Switch", WM8978_RIGHT_MIXER_CONTROL
, 5, 1, 0),
229 SOC_DAPM_SINGLE("PCM Playback Switch", WM8978_RIGHT_MIXER_CONTROL
, 0, 1, 0),
232 /* OUT3/OUT4 Mixer not implemented */
234 /* Mixer #2: Input PGA Mute */
235 static const struct snd_kcontrol_new wm8978_left_input_mixer
[] = {
236 SOC_DAPM_SINGLE("L2 Switch", WM8978_INPUT_CONTROL
, 2, 1, 0),
237 SOC_DAPM_SINGLE("MicN Switch", WM8978_INPUT_CONTROL
, 1, 1, 0),
238 SOC_DAPM_SINGLE("MicP Switch", WM8978_INPUT_CONTROL
, 0, 1, 0),
240 static const struct snd_kcontrol_new wm8978_right_input_mixer
[] = {
241 SOC_DAPM_SINGLE("R2 Switch", WM8978_INPUT_CONTROL
, 6, 1, 0),
242 SOC_DAPM_SINGLE("MicN Switch", WM8978_INPUT_CONTROL
, 5, 1, 0),
243 SOC_DAPM_SINGLE("MicP Switch", WM8978_INPUT_CONTROL
, 4, 1, 0),
246 static const struct snd_soc_dapm_widget wm8978_dapm_widgets
[] = {
247 SND_SOC_DAPM_DAC("Left DAC", "Left HiFi Playback",
248 WM8978_POWER_MANAGEMENT_3
, 0, 0),
249 SND_SOC_DAPM_DAC("Right DAC", "Right HiFi Playback",
250 WM8978_POWER_MANAGEMENT_3
, 1, 0),
251 SND_SOC_DAPM_ADC("Left ADC", "Left HiFi Capture",
252 WM8978_POWER_MANAGEMENT_2
, 0, 0),
253 SND_SOC_DAPM_ADC("Right ADC", "Right HiFi Capture",
254 WM8978_POWER_MANAGEMENT_2
, 1, 0),
256 /* Mixer #1: OUT1,2 */
257 SOC_MIXER_ARRAY("Left Output Mixer", WM8978_POWER_MANAGEMENT_3
,
258 2, 0, wm8978_left_out_mixer
),
259 SOC_MIXER_ARRAY("Right Output Mixer", WM8978_POWER_MANAGEMENT_3
,
260 3, 0, wm8978_right_out_mixer
),
262 SOC_MIXER_ARRAY("Left Input Mixer", WM8978_POWER_MANAGEMENT_2
,
263 2, 0, wm8978_left_input_mixer
),
264 SOC_MIXER_ARRAY("Right Input Mixer", WM8978_POWER_MANAGEMENT_2
,
265 3, 0, wm8978_right_input_mixer
),
267 SND_SOC_DAPM_PGA("Left Boost Mixer", WM8978_POWER_MANAGEMENT_2
,
269 SND_SOC_DAPM_PGA("Right Boost Mixer", WM8978_POWER_MANAGEMENT_2
,
272 SND_SOC_DAPM_PGA("Left Capture PGA", WM8978_LEFT_INP_PGA_CONTROL
,
274 SND_SOC_DAPM_PGA("Right Capture PGA", WM8978_RIGHT_INP_PGA_CONTROL
,
277 SND_SOC_DAPM_PGA("Left Headphone Out", WM8978_POWER_MANAGEMENT_2
,
279 SND_SOC_DAPM_PGA("Right Headphone Out", WM8978_POWER_MANAGEMENT_2
,
282 SND_SOC_DAPM_PGA("Left Speaker Out", WM8978_POWER_MANAGEMENT_3
,
284 SND_SOC_DAPM_PGA("Right Speaker Out", WM8978_POWER_MANAGEMENT_3
,
287 SND_SOC_DAPM_MIXER("OUT4 VMID", WM8978_POWER_MANAGEMENT_3
,
290 SND_SOC_DAPM_MICBIAS("Mic Bias", WM8978_POWER_MANAGEMENT_1
, 4, 0),
292 SND_SOC_DAPM_INPUT("LMICN"),
293 SND_SOC_DAPM_INPUT("LMICP"),
294 SND_SOC_DAPM_INPUT("RMICN"),
295 SND_SOC_DAPM_INPUT("RMICP"),
296 SND_SOC_DAPM_INPUT("LAUX"),
297 SND_SOC_DAPM_INPUT("RAUX"),
298 SND_SOC_DAPM_INPUT("L2"),
299 SND_SOC_DAPM_INPUT("R2"),
300 SND_SOC_DAPM_OUTPUT("LHP"),
301 SND_SOC_DAPM_OUTPUT("RHP"),
302 SND_SOC_DAPM_OUTPUT("LSPK"),
303 SND_SOC_DAPM_OUTPUT("RSPK"),
306 static const struct snd_soc_dapm_route audio_map
[] = {
308 {"Right Output Mixer", "PCM Playback Switch", "Right DAC"},
309 {"Right Output Mixer", "Aux Playback Switch", "RAUX"},
310 {"Right Output Mixer", "Line Bypass Switch", "Right Boost Mixer"},
312 {"Left Output Mixer", "PCM Playback Switch", "Left DAC"},
313 {"Left Output Mixer", "Aux Playback Switch", "LAUX"},
314 {"Left Output Mixer", "Line Bypass Switch", "Left Boost Mixer"},
317 {"Right Headphone Out", NULL
, "Right Output Mixer"},
318 {"RHP", NULL
, "Right Headphone Out"},
320 {"Left Headphone Out", NULL
, "Left Output Mixer"},
321 {"LHP", NULL
, "Left Headphone Out"},
323 {"Right Speaker Out", NULL
, "Right Output Mixer"},
324 {"RSPK", NULL
, "Right Speaker Out"},
326 {"Left Speaker Out", NULL
, "Left Output Mixer"},
327 {"LSPK", NULL
, "Left Speaker Out"},
330 {"Right ADC", NULL
, "Right Boost Mixer"},
332 {"Right Boost Mixer", NULL
, "RAUX"},
333 {"Right Boost Mixer", NULL
, "Right Capture PGA"},
334 {"Right Boost Mixer", NULL
, "R2"},
336 {"Left ADC", NULL
, "Left Boost Mixer"},
338 {"Left Boost Mixer", NULL
, "LAUX"},
339 {"Left Boost Mixer", NULL
, "Left Capture PGA"},
340 {"Left Boost Mixer", NULL
, "L2"},
343 {"Right Capture PGA", NULL
, "Right Input Mixer"},
344 {"Left Capture PGA", NULL
, "Left Input Mixer"},
346 {"Right Input Mixer", "R2 Switch", "R2"},
347 {"Right Input Mixer", "MicN Switch", "RMICN"},
348 {"Right Input Mixer", "MicP Switch", "RMICP"},
350 {"Left Input Mixer", "L2 Switch", "L2"},
351 {"Left Input Mixer", "MicN Switch", "LMICN"},
352 {"Left Input Mixer", "MicP Switch", "LMICP"},
355 static int wm8978_add_widgets(struct snd_soc_codec
*codec
)
357 snd_soc_dapm_new_controls(codec
, wm8978_dapm_widgets
,
358 ARRAY_SIZE(wm8978_dapm_widgets
));
360 /* set up the WM8978 audio map */
361 snd_soc_dapm_add_routes(codec
, audio_map
, ARRAY_SIZE(audio_map
));
367 struct wm8978_pll_div
{
373 #define FIXED_PLL_SIZE (1 << 24)
375 static void pll_factors(struct wm8978_pll_div
*pll_div
, unsigned int target
,
379 unsigned int k
, n_div
, n_mod
;
381 n_div
= target
/ source
;
385 n_div
= target
/ source
;
390 if (n_div
< 6 || n_div
> 12)
391 dev_warn(wm8978_codec
->dev
,
392 "WM8978 N value exceeds recommended range! N = %u\n",
396 n_mod
= target
- source
* n_div
;
397 k_part
= FIXED_PLL_SIZE
* (long long)n_mod
+ source
/ 2;
399 do_div(k_part
, source
);
401 k
= k_part
& 0xFFFFFFFF;
406 * Calculate internal frequencies and dividers, according to Figure 40
407 * "PLL and Clock Select Circuit" in WM8978 datasheet Rev. 2.6
409 static int wm8978_configure_pll(struct snd_soc_codec
*codec
)
411 struct wm8978_priv
*wm8978
= codec
->private_data
;
412 struct wm8978_pll_div pll_div
;
413 unsigned int f_opclk
= wm8978
->f_opclk
, f_mclk
= wm8978
->f_mclk
,
414 f_256fs
= wm8978
->f_256fs
;
415 unsigned int f2
, opclk_div
;
422 * The user needs OPCLK. Choose OPCLKDIV to put
423 * 6 <= R = f2 / f1 < 13, 1 <= OPCLKDIV <= 4.
424 * f_opclk = f_mclk * prescale * R / 4 / OPCLKDIV, where
425 * prescale = 1, or prescale = 2. Prescale is calculated inside
426 * pll_factors(). We have to select f_PLLOUT, such that
427 * f_mclk * 3 / 4 <= f_PLLOUT < f_mclk * 13 / 4. Must be
428 * f_mclk * 3 / 16 <= f_opclk < f_mclk * 13 / 4.
430 if (16 * f_opclk
< 3 * f_mclk
|| 4 * f_opclk
>= 13 * f_mclk
)
433 if (4 * f_opclk
< 3 * f_mclk
)
434 /* Have to use OPCLKDIV */
435 opclk_div
= (3 * f_mclk
/ 4 + f_opclk
- 1) / f_opclk
;
439 dev_dbg(codec
->dev
, "%s: OPCLKDIV=%d\n", __func__
, opclk_div
);
441 snd_soc_update_bits(codec
, WM8978_GPIO_CONTROL
, 0x30,
442 (opclk_div
- 1) << 4);
444 wm8978
->f_pllout
= f_opclk
* opclk_div
;
445 } else if (f_256fs
) {
447 * Not using OPCLK, choose R:
448 * 6 <= R = f2 / f1 < 13, to put 1 <= MCLKDIV <= 12.
449 * f_256fs = f_mclk * prescale * R / 4 / MCLKDIV, where
450 * prescale = 1, or prescale = 2. Prescale is calculated inside
451 * pll_factors(). We have to select f_PLLOUT, such that
452 * f_mclk * 3 / 4 <= f_PLLOUT < f_mclk * 13 / 4. Must be
453 * f_mclk * 3 / 48 <= f_256fs < f_mclk * 13 / 4. This means MCLK
454 * must be 3.781MHz <= f_MCLK <= 32.768MHz
456 if (48 * f_256fs
< 3 * f_mclk
|| 4 * f_256fs
>= 13 * f_mclk
)
460 * MCLKDIV will be selected in .hw_params(), just choose a
463 if (4 * f_256fs
< 3 * f_mclk
)
464 /* Will have to use MCLKDIV */
465 wm8978
->f_pllout
= wm8978
->f_mclk
* 3 / 4;
467 wm8978
->f_pllout
= f_256fs
;
469 /* GPIO1 into default mode as input - before configuring PLL */
470 snd_soc_update_bits(codec
, WM8978_GPIO_CONTROL
, 7, 0);
475 f2
= wm8978
->f_pllout
* 4;
477 dev_dbg(codec
->dev
, "%s: f_MCLK=%uHz, f_PLLOUT=%uHz\n", __func__
,
478 wm8978
->f_mclk
, wm8978
->f_pllout
);
480 pll_factors(&pll_div
, f2
, wm8978
->f_mclk
);
482 dev_dbg(codec
->dev
, "%s: calculated PLL N=0x%x, K=0x%x, div2=%d\n",
483 __func__
, pll_div
.n
, pll_div
.k
, pll_div
.div2
);
485 /* Turn PLL off for configuration... */
486 snd_soc_update_bits(codec
, WM8978_POWER_MANAGEMENT_1
, 0x20, 0);
488 snd_soc_write(codec
, WM8978_PLL_N
, (pll_div
.div2
<< 4) | pll_div
.n
);
489 snd_soc_write(codec
, WM8978_PLL_K1
, pll_div
.k
>> 18);
490 snd_soc_write(codec
, WM8978_PLL_K2
, (pll_div
.k
>> 9) & 0x1ff);
491 snd_soc_write(codec
, WM8978_PLL_K3
, pll_div
.k
& 0x1ff);
493 /* ...and on again */
494 snd_soc_update_bits(codec
, WM8978_POWER_MANAGEMENT_1
, 0x20, 0x20);
497 /* Output PLL (OPCLK) to GPIO1 */
498 snd_soc_update_bits(codec
, WM8978_GPIO_CONTROL
, 7, 4);
504 * Configure WM8978 clock dividers.
506 static int wm8978_set_dai_clkdiv(struct snd_soc_dai
*codec_dai
,
509 struct snd_soc_codec
*codec
= codec_dai
->codec
;
510 struct wm8978_priv
*wm8978
= codec
->private_data
;
514 case WM8978_OPCLKRATE
:
515 wm8978
->f_opclk
= div
;
518 ret
= wm8978_configure_pll(codec
);
523 snd_soc_update_bits(codec
, WM8978_CLOCKING
, 0x1c, div
);
529 dev_dbg(codec
->dev
, "%s: ID %d, value %u\n", __func__
, div_id
, div
);
535 * @freq: when .set_pll() us not used, freq is codec MCLK input frequency
537 static int wm8978_set_dai_sysclk(struct snd_soc_dai
*codec_dai
, int clk_id
,
538 unsigned int freq
, int dir
)
540 struct snd_soc_codec
*codec
= codec_dai
->codec
;
541 struct wm8978_priv
*wm8978
= codec
->private_data
;
544 dev_dbg(codec
->dev
, "%s: ID %d, freq %u\n", __func__
, clk_id
, freq
);
547 wm8978
->f_mclk
= freq
;
549 /* Even if MCLK is used for system clock, might have to drive OPCLK */
551 ret
= wm8978_configure_pll(codec
);
553 /* Our sysclk is fixed to 256 * fs, will configure in .hw_params() */
556 wm8978
->sysclk
= clk_id
;
559 if (wm8978
->sysclk
== WM8978_PLL
&& (!freq
|| clk_id
== WM8978_MCLK
)) {
560 /* Clock CODEC directly from MCLK */
561 snd_soc_update_bits(codec
, WM8978_CLOCKING
, 0x100, 0);
563 /* GPIO1 into default mode as input - before configuring PLL */
564 snd_soc_update_bits(codec
, WM8978_GPIO_CONTROL
, 7, 0);
567 snd_soc_update_bits(codec
, WM8978_POWER_MANAGEMENT_1
, 0x20, 0);
568 wm8978
->sysclk
= WM8978_MCLK
;
569 wm8978
->f_pllout
= 0;
577 * Set ADC and Voice DAC format.
579 static int wm8978_set_dai_fmt(struct snd_soc_dai
*codec_dai
, unsigned int fmt
)
581 struct snd_soc_codec
*codec
= codec_dai
->codec
;
583 * BCLK polarity mask = 0x100, LRC clock polarity mask = 0x80,
584 * Data Format mask = 0x18: all will be calculated anew
586 u16 iface
= snd_soc_read(codec
, WM8978_AUDIO_INTERFACE
) & ~0x198;
587 u16 clk
= snd_soc_read(codec
, WM8978_CLOCKING
);
589 dev_dbg(codec
->dev
, "%s\n", __func__
);
591 /* set master/slave audio interface */
592 switch (fmt
& SND_SOC_DAIFMT_MASTER_MASK
) {
593 case SND_SOC_DAIFMT_CBM_CFM
:
596 case SND_SOC_DAIFMT_CBS_CFS
:
603 /* interface format */
604 switch (fmt
& SND_SOC_DAIFMT_FORMAT_MASK
) {
605 case SND_SOC_DAIFMT_I2S
:
608 case SND_SOC_DAIFMT_RIGHT_J
:
610 case SND_SOC_DAIFMT_LEFT_J
:
613 case SND_SOC_DAIFMT_DSP_A
:
620 /* clock inversion */
621 switch (fmt
& SND_SOC_DAIFMT_INV_MASK
) {
622 case SND_SOC_DAIFMT_NB_NF
:
624 case SND_SOC_DAIFMT_IB_IF
:
627 case SND_SOC_DAIFMT_IB_NF
:
630 case SND_SOC_DAIFMT_NB_IF
:
637 snd_soc_write(codec
, WM8978_AUDIO_INTERFACE
, iface
);
638 snd_soc_write(codec
, WM8978_CLOCKING
, clk
);
644 static const int mclk_numerator
[] = {1, 3, 2, 3, 4, 6, 8, 12};
645 static const int mclk_denominator
[] = {1, 2, 1, 1, 1, 1, 1, 1};
648 * Set PCM DAI bit size and sample rate.
650 static int wm8978_hw_params(struct snd_pcm_substream
*substream
,
651 struct snd_pcm_hw_params
*params
,
652 struct snd_soc_dai
*dai
)
654 struct snd_soc_pcm_runtime
*rtd
= substream
->private_data
;
655 struct snd_soc_device
*socdev
= rtd
->socdev
;
656 struct snd_soc_codec
*codec
= socdev
->card
->codec
;
657 struct wm8978_priv
*wm8978
= codec
->private_data
;
658 /* Word length mask = 0x60 */
659 u16 iface_ctl
= snd_soc_read(codec
, WM8978_AUDIO_INTERFACE
) & ~0x60;
660 /* Sampling rate mask = 0xe (for filters) */
661 u16 add_ctl
= snd_soc_read(codec
, WM8978_ADDITIONAL_CONTROL
) & ~0xe;
662 u16 clking
= snd_soc_read(codec
, WM8978_CLOCKING
);
663 enum wm8978_sysclk_src current_clk_id
= clking
& 0x100 ?
664 WM8978_PLL
: WM8978_MCLK
;
665 unsigned int f_sel
, diff
, diff_best
= INT_MAX
;
672 switch (params_format(params
)) {
673 case SNDRV_PCM_FORMAT_S16_LE
:
675 case SNDRV_PCM_FORMAT_S20_3LE
:
678 case SNDRV_PCM_FORMAT_S24_LE
:
681 case SNDRV_PCM_FORMAT_S32_LE
:
686 /* filter coefficient */
687 switch (params_rate(params
)) {
708 /* Sampling rate is known now, can configure the MCLK divider */
709 wm8978
->f_256fs
= params_rate(params
) * 256;
711 if (wm8978
->sysclk
== WM8978_MCLK
) {
712 f_sel
= wm8978
->f_mclk
;
714 if (!wm8978
->f_pllout
) {
715 int ret
= wm8978_configure_pll(codec
);
719 f_sel
= wm8978
->f_pllout
;
723 * In some cases it is possible to reconfigure PLL to a higher frequency
724 * by raising OPCLKDIV, but normally OPCLK is configured to 256 * fs or
725 * 512 * fs, so, we should be fine.
727 if (f_sel
< wm8978
->f_256fs
|| f_sel
> 12 * wm8978
->f_256fs
)
730 for (i
= 0; i
< ARRAY_SIZE(mclk_numerator
); i
++) {
731 diff
= abs(wm8978
->f_256fs
* 3 -
732 f_sel
* 3 * mclk_denominator
[i
] / mclk_numerator
[i
]);
734 if (diff
< diff_best
) {
744 dev_warn(codec
->dev
, "Imprecise clock: %u%s\n",
745 f_sel
* mclk_denominator
[best
] / mclk_numerator
[best
],
746 wm8978
->sysclk
== WM8978_MCLK
?
747 ", consider using PLL" : "");
749 dev_dbg(codec
->dev
, "%s: fmt %d, rate %u, MCLK divisor #%d\n", __func__
,
750 params_format(params
), params_rate(params
), best
);
752 /* MCLK divisor mask = 0xe0 */
753 snd_soc_update_bits(codec
, WM8978_CLOCKING
, 0xe0, best
<< 5);
755 snd_soc_write(codec
, WM8978_AUDIO_INTERFACE
, iface_ctl
);
756 snd_soc_write(codec
, WM8978_ADDITIONAL_CONTROL
, add_ctl
);
758 if (wm8978
->sysclk
!= current_clk_id
) {
759 if (wm8978
->sysclk
== WM8978_PLL
)
760 /* Run CODEC from PLL instead of MCLK */
761 snd_soc_update_bits(codec
, WM8978_CLOCKING
,
764 /* Clock CODEC directly from MCLK */
765 snd_soc_update_bits(codec
, WM8978_CLOCKING
, 0x100, 0);
771 static int wm8978_mute(struct snd_soc_dai
*dai
, int mute
)
773 struct snd_soc_codec
*codec
= dai
->codec
;
775 dev_dbg(codec
->dev
, "%s: %d\n", __func__
, mute
);
778 snd_soc_update_bits(codec
, WM8978_DAC_CONTROL
, 0x40, 0x40);
780 snd_soc_update_bits(codec
, WM8978_DAC_CONTROL
, 0x40, 0);
785 static int wm8978_set_bias_level(struct snd_soc_codec
*codec
,
786 enum snd_soc_bias_level level
)
788 u16 power1
= snd_soc_read(codec
, WM8978_POWER_MANAGEMENT_1
) & ~3;
791 case SND_SOC_BIAS_ON
:
792 case SND_SOC_BIAS_PREPARE
:
793 power1
|= 1; /* VMID 75k */
794 snd_soc_write(codec
, WM8978_POWER_MANAGEMENT_1
, power1
);
796 case SND_SOC_BIAS_STANDBY
:
797 /* bit 3: enable bias, bit 2: enable I/O tie off buffer */
800 if (codec
->bias_level
== SND_SOC_BIAS_OFF
) {
801 /* Initial cap charge at VMID 5k */
802 snd_soc_write(codec
, WM8978_POWER_MANAGEMENT_1
,
807 power1
|= 0x2; /* VMID 500k */
808 snd_soc_write(codec
, WM8978_POWER_MANAGEMENT_1
, power1
);
810 case SND_SOC_BIAS_OFF
:
811 /* Preserve PLL - OPCLK may be used by someone */
812 snd_soc_update_bits(codec
, WM8978_POWER_MANAGEMENT_1
, ~0x20, 0);
813 snd_soc_write(codec
, WM8978_POWER_MANAGEMENT_2
, 0);
814 snd_soc_write(codec
, WM8978_POWER_MANAGEMENT_3
, 0);
818 dev_dbg(codec
->dev
, "%s: %d, %x\n", __func__
, level
, power1
);
820 codec
->bias_level
= level
;
824 #define WM8978_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE | \
825 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
827 static struct snd_soc_dai_ops wm8978_dai_ops
= {
828 .hw_params
= wm8978_hw_params
,
829 .digital_mute
= wm8978_mute
,
830 .set_fmt
= wm8978_set_dai_fmt
,
831 .set_clkdiv
= wm8978_set_dai_clkdiv
,
832 .set_sysclk
= wm8978_set_dai_sysclk
,
835 /* Also supports 12kHz */
836 struct snd_soc_dai wm8978_dai
= {
837 .name
= "WM8978 HiFi",
840 .stream_name
= "Playback",
843 .rates
= SNDRV_PCM_RATE_8000_48000
,
844 .formats
= WM8978_FORMATS
,
847 .stream_name
= "Capture",
850 .rates
= SNDRV_PCM_RATE_8000_48000
,
851 .formats
= WM8978_FORMATS
,
853 .ops
= &wm8978_dai_ops
,
855 EXPORT_SYMBOL_GPL(wm8978_dai
);
857 static int wm8978_suspend(struct platform_device
*pdev
, pm_message_t state
)
859 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
860 struct snd_soc_codec
*codec
= socdev
->card
->codec
;
862 wm8978_set_bias_level(codec
, SND_SOC_BIAS_OFF
);
863 /* Also switch PLL off */
864 snd_soc_write(codec
, WM8978_POWER_MANAGEMENT_1
, 0);
869 static int wm8978_resume(struct platform_device
*pdev
)
871 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
872 struct snd_soc_codec
*codec
= socdev
->card
->codec
;
873 struct wm8978_priv
*wm8978
= codec
->private_data
;
875 u16
*cache
= codec
->reg_cache
;
877 /* Sync reg_cache with the hardware */
878 for (i
= 0; i
< ARRAY_SIZE(wm8978_reg
); i
++) {
879 if (i
== WM8978_RESET
)
881 if (cache
[i
] != wm8978_reg
[i
])
882 snd_soc_write(codec
, i
, cache
[i
]);
885 wm8978_set_bias_level(codec
, SND_SOC_BIAS_STANDBY
);
887 if (wm8978
->f_pllout
)
889 snd_soc_update_bits(codec
, WM8978_POWER_MANAGEMENT_1
, 0x20, 0x20);
894 static int wm8978_probe(struct platform_device
*pdev
)
896 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
897 struct snd_soc_codec
*codec
;
900 if (wm8978_codec
== NULL
) {
901 dev_err(&pdev
->dev
, "Codec device not registered\n");
905 socdev
->card
->codec
= wm8978_codec
;
906 codec
= wm8978_codec
;
909 ret
= snd_soc_new_pcms(socdev
, SNDRV_DEFAULT_IDX1
, SNDRV_DEFAULT_STR1
);
911 dev_err(codec
->dev
, "failed to create pcms: %d\n", ret
);
915 snd_soc_add_controls(codec
, wm8978_snd_controls
,
916 ARRAY_SIZE(wm8978_snd_controls
));
917 wm8978_add_widgets(codec
);
923 /* power down chip */
924 static int wm8978_remove(struct platform_device
*pdev
)
926 struct snd_soc_device
*socdev
= platform_get_drvdata(pdev
);
928 snd_soc_free_pcms(socdev
);
929 snd_soc_dapm_free(socdev
);
934 struct snd_soc_codec_device soc_codec_dev_wm8978
= {
935 .probe
= wm8978_probe
,
936 .remove
= wm8978_remove
,
937 .suspend
= wm8978_suspend
,
938 .resume
= wm8978_resume
,
940 EXPORT_SYMBOL_GPL(soc_codec_dev_wm8978
);
943 * These registers contain an "update" bit - bit 8. This means, for example,
944 * that one can write new DAC digital volume for both channels, but only when
945 * the update bit is set, will also the volume be updated - simultaneously for
948 static const int update_reg
[] = {
949 WM8978_LEFT_DAC_DIGITAL_VOLUME
,
950 WM8978_RIGHT_DAC_DIGITAL_VOLUME
,
951 WM8978_LEFT_ADC_DIGITAL_VOLUME
,
952 WM8978_RIGHT_ADC_DIGITAL_VOLUME
,
953 WM8978_LEFT_INP_PGA_CONTROL
,
954 WM8978_RIGHT_INP_PGA_CONTROL
,
955 WM8978_LOUT1_HP_CONTROL
,
956 WM8978_ROUT1_HP_CONTROL
,
957 WM8978_LOUT2_SPK_CONTROL
,
958 WM8978_ROUT2_SPK_CONTROL
,
961 static __devinit
int wm8978_register(struct wm8978_priv
*wm8978
)
964 struct snd_soc_codec
*codec
= &wm8978
->codec
;
967 dev_err(codec
->dev
, "Another WM8978 is registered\n");
972 * Set default system clock to PLL, it is more precise, this is also the
973 * default hardware setting
975 wm8978
->sysclk
= WM8978_PLL
;
977 mutex_init(&codec
->mutex
);
978 INIT_LIST_HEAD(&codec
->dapm_widgets
);
979 INIT_LIST_HEAD(&codec
->dapm_paths
);
981 codec
->private_data
= wm8978
;
982 codec
->name
= "WM8978";
983 codec
->owner
= THIS_MODULE
;
984 codec
->bias_level
= SND_SOC_BIAS_OFF
;
985 codec
->set_bias_level
= wm8978_set_bias_level
;
986 codec
->dai
= &wm8978_dai
;
988 codec
->reg_cache_size
= WM8978_CACHEREGNUM
;
989 codec
->reg_cache
= &wm8978
->reg_cache
;
991 ret
= snd_soc_codec_set_cache_io(codec
, 7, 9, SND_SOC_I2C
);
993 dev_err(codec
->dev
, "Failed to set cache I/O: %d\n", ret
);
997 memcpy(codec
->reg_cache
, wm8978_reg
, sizeof(wm8978_reg
));
1000 * Set the update bit in all registers, that have one. This way all
1001 * writes to those registers will also cause the update bit to be
1004 for (i
= 0; i
< ARRAY_SIZE(update_reg
); i
++)
1005 ((u16
*)codec
->reg_cache
)[update_reg
[i
]] |= 0x100;
1007 /* Reset the codec */
1008 ret
= snd_soc_write(codec
, WM8978_RESET
, 0);
1010 dev_err(codec
->dev
, "Failed to issue reset\n");
1014 wm8978_dai
.dev
= codec
->dev
;
1016 wm8978_set_bias_level(codec
, SND_SOC_BIAS_STANDBY
);
1018 wm8978_codec
= codec
;
1020 ret
= snd_soc_register_codec(codec
);
1022 dev_err(codec
->dev
, "Failed to register codec: %d\n", ret
);
1026 ret
= snd_soc_register_dai(&wm8978_dai
);
1028 dev_err(codec
->dev
, "Failed to register DAI: %d\n", ret
);
1035 snd_soc_unregister_codec(codec
);
1041 static __devexit
void wm8978_unregister(struct wm8978_priv
*wm8978
)
1043 wm8978_set_bias_level(&wm8978
->codec
, SND_SOC_BIAS_OFF
);
1044 snd_soc_unregister_dai(&wm8978_dai
);
1045 snd_soc_unregister_codec(&wm8978
->codec
);
1047 wm8978_codec
= NULL
;
1050 static __devinit
int wm8978_i2c_probe(struct i2c_client
*i2c
,
1051 const struct i2c_device_id
*id
)
1053 struct wm8978_priv
*wm8978
;
1054 struct snd_soc_codec
*codec
;
1056 wm8978
= kzalloc(sizeof(struct wm8978_priv
), GFP_KERNEL
);
1060 codec
= &wm8978
->codec
;
1061 codec
->hw_write
= (hw_write_t
)i2c_master_send
;
1063 i2c_set_clientdata(i2c
, wm8978
);
1064 codec
->control_data
= i2c
;
1066 codec
->dev
= &i2c
->dev
;
1068 return wm8978_register(wm8978
);
1071 static __devexit
int wm8978_i2c_remove(struct i2c_client
*client
)
1073 struct wm8978_priv
*wm8978
= i2c_get_clientdata(client
);
1074 wm8978_unregister(wm8978
);
1078 static const struct i2c_device_id wm8978_i2c_id
[] = {
1082 MODULE_DEVICE_TABLE(i2c
, wm8978_i2c_id
);
1084 static struct i2c_driver wm8978_i2c_driver
= {
1087 .owner
= THIS_MODULE
,
1089 .probe
= wm8978_i2c_probe
,
1090 .remove
= __devexit_p(wm8978_i2c_remove
),
1091 .id_table
= wm8978_i2c_id
,
1094 static int __init
wm8978_modinit(void)
1096 return i2c_add_driver(&wm8978_i2c_driver
);
1098 module_init(wm8978_modinit
);
1100 static void __exit
wm8978_exit(void)
1102 i2c_del_driver(&wm8978_i2c_driver
);
1104 module_exit(wm8978_exit
);
1106 MODULE_DESCRIPTION("ASoC WM8978 codec driver");
1107 MODULE_AUTHOR("Guennadi Liakhovetski <g.liakhovetski@gmx.de>");
1108 MODULE_LICENSE("GPL");