2 * wm8711.c -- WM8711 ALSA SoC Audio driver
4 * Copyright 2006 Wolfson Microelectronics
6 * Author: Mike Arthur <Mike.Arthur@wolfsonmicro.com>
8 * Based on wm8731.c by Richard Purdie
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
15 #include <linux/module.h>
16 #include <linux/moduleparam.h>
17 #include <linux/init.h>
18 #include <linux/delay.h>
20 #include <linux/i2c.h>
21 #include <linux/regmap.h>
22 #include <linux/spi/spi.h>
23 #include <linux/slab.h>
24 #include <linux/of_device.h>
25 #include <sound/core.h>
26 #include <sound/pcm.h>
27 #include <sound/pcm_params.h>
28 #include <sound/soc.h>
29 #include <sound/tlv.h>
30 #include <sound/initval.h>
34 /* codec private data */
36 struct regmap *regmap;
41 * wm8711 register cache
42 * We can't read the WM8711 register space when we are
43 * using 2 wire for device control, so we cache them instead.
44 * There is no point in caching the reset register
46 static const struct reg_default wm8711_reg_defaults[] = {
47 { 0, 0x0079 }, { 1, 0x0079 }, { 2, 0x000a }, { 3, 0x0008 },
48 { 4, 0x009f }, { 5, 0x000a }, { 6, 0x0000 }, { 7, 0x0000 },
51 static bool wm8711_volatile(struct device *dev, unsigned int reg)
61 #define wm8711_reset(c) snd_soc_component_write(c, WM8711_RESET, 0)
63 static const DECLARE_TLV_DB_SCALE(out_tlv, -12100, 100, 1);
65 static const struct snd_kcontrol_new wm8711_snd_controls[] = {
67 SOC_DOUBLE_R_TLV("Master Playback Volume", WM8711_LOUT1V, WM8711_ROUT1V,
69 SOC_DOUBLE_R("Master Playback ZC Switch", WM8711_LOUT1V, WM8711_ROUT1V,
75 static const struct snd_kcontrol_new wm8711_output_mixer_controls[] = {
76 SOC_DAPM_SINGLE("Line Bypass Switch", WM8711_APANA, 3, 1, 0),
77 SOC_DAPM_SINGLE("HiFi Playback Switch", WM8711_APANA, 4, 1, 0),
80 static const struct snd_soc_dapm_widget wm8711_dapm_widgets[] = {
81 SND_SOC_DAPM_MIXER("Output Mixer", WM8711_PWR, 4, 1,
82 &wm8711_output_mixer_controls[0],
83 ARRAY_SIZE(wm8711_output_mixer_controls)),
84 SND_SOC_DAPM_DAC("DAC", "HiFi Playback", WM8711_PWR, 3, 1),
85 SND_SOC_DAPM_OUTPUT("LOUT"),
86 SND_SOC_DAPM_OUTPUT("LHPOUT"),
87 SND_SOC_DAPM_OUTPUT("ROUT"),
88 SND_SOC_DAPM_OUTPUT("RHPOUT"),
91 static const struct snd_soc_dapm_route wm8711_intercon[] = {
93 {"Output Mixer", "Line Bypass Switch", "Line Input"},
94 {"Output Mixer", "HiFi Playback Switch", "DAC"},
97 {"RHPOUT", NULL, "Output Mixer"},
98 {"ROUT", NULL, "Output Mixer"},
99 {"LHPOUT", NULL, "Output Mixer"},
100 {"LOUT", NULL, "Output Mixer"},
112 /* codec mclk clock divider coefficients */
113 static const struct _coeff_div coeff_div[] = {
115 {12288000, 48000, 256, 0x0, 0x0, 0x0},
116 {18432000, 48000, 384, 0x0, 0x1, 0x0},
117 {12000000, 48000, 250, 0x0, 0x0, 0x1},
120 {12288000, 32000, 384, 0x6, 0x0, 0x0},
121 {18432000, 32000, 576, 0x6, 0x1, 0x0},
122 {12000000, 32000, 375, 0x6, 0x0, 0x1},
125 {12288000, 8000, 1536, 0x3, 0x0, 0x0},
126 {18432000, 8000, 2304, 0x3, 0x1, 0x0},
127 {11289600, 8000, 1408, 0xb, 0x0, 0x0},
128 {16934400, 8000, 2112, 0xb, 0x1, 0x0},
129 {12000000, 8000, 1500, 0x3, 0x0, 0x1},
132 {12288000, 96000, 128, 0x7, 0x0, 0x0},
133 {18432000, 96000, 192, 0x7, 0x1, 0x0},
134 {12000000, 96000, 125, 0x7, 0x0, 0x1},
137 {11289600, 44100, 256, 0x8, 0x0, 0x0},
138 {16934400, 44100, 384, 0x8, 0x1, 0x0},
139 {12000000, 44100, 272, 0x8, 0x1, 0x1},
142 {11289600, 88200, 128, 0xf, 0x0, 0x0},
143 {16934400, 88200, 192, 0xf, 0x1, 0x0},
144 {12000000, 88200, 136, 0xf, 0x1, 0x1},
147 static inline int get_coeff(int mclk, int rate)
151 for (i = 0; i < ARRAY_SIZE(coeff_div); i++) {
152 if (coeff_div[i].rate == rate && coeff_div[i].mclk == mclk)
158 static int wm8711_hw_params(struct snd_pcm_substream *substream,
159 struct snd_pcm_hw_params *params,
160 struct snd_soc_dai *dai)
162 struct snd_soc_component *component = dai->component;
163 struct wm8711_priv *wm8711 = snd_soc_component_get_drvdata(component);
164 u16 iface = snd_soc_component_read32(component, WM8711_IFACE) & 0xfff3;
165 int i = get_coeff(wm8711->sysclk, params_rate(params));
166 u16 srate = (coeff_div[i].sr << 2) |
167 (coeff_div[i].bosr << 1) | coeff_div[i].usb;
169 snd_soc_component_write(component, WM8711_SRATE, srate);
172 switch (params_width(params)) {
183 snd_soc_component_write(component, WM8711_IFACE, iface);
187 static int wm8711_pcm_prepare(struct snd_pcm_substream *substream,
188 struct snd_soc_dai *dai)
190 struct snd_soc_component *component = dai->component;
193 snd_soc_component_write(component, WM8711_ACTIVE, 0x0001);
198 static void wm8711_shutdown(struct snd_pcm_substream *substream,
199 struct snd_soc_dai *dai)
201 struct snd_soc_component *component = dai->component;
204 if (!snd_soc_component_is_active(component)) {
206 snd_soc_component_write(component, WM8711_ACTIVE, 0x0);
210 static int wm8711_mute(struct snd_soc_dai *dai, int mute)
212 struct snd_soc_component *component = dai->component;
213 u16 mute_reg = snd_soc_component_read32(component, WM8711_APDIGI) & 0xfff7;
216 snd_soc_component_write(component, WM8711_APDIGI, mute_reg | 0x8);
218 snd_soc_component_write(component, WM8711_APDIGI, mute_reg);
223 static int wm8711_set_dai_sysclk(struct snd_soc_dai *codec_dai,
224 int clk_id, unsigned int freq, int dir)
226 struct snd_soc_component *component = codec_dai->component;
227 struct wm8711_priv *wm8711 = snd_soc_component_get_drvdata(component);
235 wm8711->sysclk = freq;
241 static int wm8711_set_dai_fmt(struct snd_soc_dai *codec_dai,
244 struct snd_soc_component *component = codec_dai->component;
245 u16 iface = snd_soc_component_read32(component, WM8711_IFACE) & 0x000c;
247 /* set master/slave audio interface */
248 switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
249 case SND_SOC_DAIFMT_CBM_CFM:
252 case SND_SOC_DAIFMT_CBS_CFS:
258 /* interface format */
259 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
260 case SND_SOC_DAIFMT_I2S:
263 case SND_SOC_DAIFMT_RIGHT_J:
265 case SND_SOC_DAIFMT_LEFT_J:
268 case SND_SOC_DAIFMT_DSP_A:
271 case SND_SOC_DAIFMT_DSP_B:
278 /* clock inversion */
279 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
280 case SND_SOC_DAIFMT_NB_NF:
282 case SND_SOC_DAIFMT_IB_IF:
285 case SND_SOC_DAIFMT_IB_NF:
288 case SND_SOC_DAIFMT_NB_IF:
296 snd_soc_component_write(component, WM8711_IFACE, iface);
300 static int wm8711_set_bias_level(struct snd_soc_component *component,
301 enum snd_soc_bias_level level)
303 struct wm8711_priv *wm8711 = snd_soc_component_get_drvdata(component);
304 u16 reg = snd_soc_component_read32(component, WM8711_PWR) & 0xff7f;
307 case SND_SOC_BIAS_ON:
308 snd_soc_component_write(component, WM8711_PWR, reg);
310 case SND_SOC_BIAS_PREPARE:
312 case SND_SOC_BIAS_STANDBY:
313 if (snd_soc_component_get_bias_level(component) == SND_SOC_BIAS_OFF)
314 regcache_sync(wm8711->regmap);
316 snd_soc_component_write(component, WM8711_PWR, reg | 0x0040);
318 case SND_SOC_BIAS_OFF:
319 snd_soc_component_write(component, WM8711_ACTIVE, 0x0);
320 snd_soc_component_write(component, WM8711_PWR, 0xffff);
326 #define WM8711_RATES SNDRV_PCM_RATE_8000_96000
328 #define WM8711_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
329 SNDRV_PCM_FMTBIT_S24_LE)
331 static const struct snd_soc_dai_ops wm8711_ops = {
332 .prepare = wm8711_pcm_prepare,
333 .hw_params = wm8711_hw_params,
334 .shutdown = wm8711_shutdown,
335 .digital_mute = wm8711_mute,
336 .set_sysclk = wm8711_set_dai_sysclk,
337 .set_fmt = wm8711_set_dai_fmt,
340 static struct snd_soc_dai_driver wm8711_dai = {
341 .name = "wm8711-hifi",
343 .stream_name = "Playback",
346 .rates = WM8711_RATES,
347 .formats = WM8711_FORMATS,
352 static int wm8711_probe(struct snd_soc_component *component)
356 ret = wm8711_reset(component);
358 dev_err(component->dev, "Failed to issue reset\n");
362 /* Latch the update bits */
363 snd_soc_component_update_bits(component, WM8711_LOUT1V, 0x0100, 0x0100);
364 snd_soc_component_update_bits(component, WM8711_ROUT1V, 0x0100, 0x0100);
370 static const struct snd_soc_component_driver soc_component_dev_wm8711 = {
371 .probe = wm8711_probe,
372 .set_bias_level = wm8711_set_bias_level,
373 .controls = wm8711_snd_controls,
374 .num_controls = ARRAY_SIZE(wm8711_snd_controls),
375 .dapm_widgets = wm8711_dapm_widgets,
376 .num_dapm_widgets = ARRAY_SIZE(wm8711_dapm_widgets),
377 .dapm_routes = wm8711_intercon,
378 .num_dapm_routes = ARRAY_SIZE(wm8711_intercon),
379 .suspend_bias_off = 1,
381 .use_pmdown_time = 1,
383 .non_legacy_dai_naming = 1,
386 static const struct of_device_id wm8711_of_match[] = {
387 { .compatible = "wlf,wm8711", },
390 MODULE_DEVICE_TABLE(of, wm8711_of_match);
392 static const struct regmap_config wm8711_regmap = {
395 .max_register = WM8711_RESET,
397 .reg_defaults = wm8711_reg_defaults,
398 .num_reg_defaults = ARRAY_SIZE(wm8711_reg_defaults),
399 .cache_type = REGCACHE_RBTREE,
401 .volatile_reg = wm8711_volatile,
404 #if defined(CONFIG_SPI_MASTER)
405 static int wm8711_spi_probe(struct spi_device *spi)
407 struct wm8711_priv *wm8711;
410 wm8711 = devm_kzalloc(&spi->dev, sizeof(struct wm8711_priv),
415 wm8711->regmap = devm_regmap_init_spi(spi, &wm8711_regmap);
416 if (IS_ERR(wm8711->regmap))
417 return PTR_ERR(wm8711->regmap);
419 spi_set_drvdata(spi, wm8711);
421 ret = devm_snd_soc_register_component(&spi->dev,
422 &soc_component_dev_wm8711, &wm8711_dai, 1);
427 static struct spi_driver wm8711_spi_driver = {
430 .of_match_table = wm8711_of_match,
432 .probe = wm8711_spi_probe,
434 #endif /* CONFIG_SPI_MASTER */
436 #if IS_ENABLED(CONFIG_I2C)
437 static int wm8711_i2c_probe(struct i2c_client *client,
438 const struct i2c_device_id *id)
440 struct wm8711_priv *wm8711;
443 wm8711 = devm_kzalloc(&client->dev, sizeof(struct wm8711_priv),
448 wm8711->regmap = devm_regmap_init_i2c(client, &wm8711_regmap);
449 if (IS_ERR(wm8711->regmap))
450 return PTR_ERR(wm8711->regmap);
452 i2c_set_clientdata(client, wm8711);
454 ret = devm_snd_soc_register_component(&client->dev,
455 &soc_component_dev_wm8711, &wm8711_dai, 1);
460 static const struct i2c_device_id wm8711_i2c_id[] = {
464 MODULE_DEVICE_TABLE(i2c, wm8711_i2c_id);
466 static struct i2c_driver wm8711_i2c_driver = {
469 .of_match_table = wm8711_of_match,
471 .probe = wm8711_i2c_probe,
472 .id_table = wm8711_i2c_id,
476 static int __init wm8711_modinit(void)
479 #if IS_ENABLED(CONFIG_I2C)
480 ret = i2c_add_driver(&wm8711_i2c_driver);
482 printk(KERN_ERR "Failed to register WM8711 I2C driver: %d\n",
486 #if defined(CONFIG_SPI_MASTER)
487 ret = spi_register_driver(&wm8711_spi_driver);
489 printk(KERN_ERR "Failed to register WM8711 SPI driver: %d\n",
495 module_init(wm8711_modinit);
497 static void __exit wm8711_exit(void)
499 #if IS_ENABLED(CONFIG_I2C)
500 i2c_del_driver(&wm8711_i2c_driver);
502 #if defined(CONFIG_SPI_MASTER)
503 spi_unregister_driver(&wm8711_spi_driver);
506 module_exit(wm8711_exit);
508 MODULE_DESCRIPTION("ASoC WM8711 driver");
509 MODULE_AUTHOR("Mike Arthur");
510 MODULE_LICENSE("GPL");