xref: /openbmc/linux/sound/soc/codecs/wm8728.c (revision 588b48ca)
1 /*
2  * wm8728.c  --  WM8728 ALSA SoC Audio driver
3  *
4  * Copyright 2008 Wolfson Microelectronics plc
5  *
6  * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
7  *
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.
11  */
12 
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/init.h>
16 #include <linux/delay.h>
17 #include <linux/pm.h>
18 #include <linux/i2c.h>
19 #include <linux/platform_device.h>
20 #include <linux/regmap.h>
21 #include <linux/spi/spi.h>
22 #include <linux/slab.h>
23 #include <linux/of_device.h>
24 #include <sound/core.h>
25 #include <sound/pcm.h>
26 #include <sound/pcm_params.h>
27 #include <sound/soc.h>
28 #include <sound/initval.h>
29 #include <sound/tlv.h>
30 
31 #include "wm8728.h"
32 
33 /*
34  * We can't read the WM8728 register space so we cache them instead.
35  * Note that the defaults here aren't the physical defaults, we latch
36  * the volume update bits, mute the output and enable infinite zero
37  * detect.
38  */
39 static const struct reg_default wm8728_reg_defaults[] = {
40 	{ 0, 0x1ff },
41 	{ 1, 0x1ff },
42 	{ 2, 0x001 },
43 	{ 3, 0x100 },
44 };
45 
46 /* codec private data */
47 struct wm8728_priv {
48 	struct regmap *regmap;
49 };
50 
51 static const DECLARE_TLV_DB_SCALE(wm8728_tlv, -12750, 50, 1);
52 
53 static const struct snd_kcontrol_new wm8728_snd_controls[] = {
54 
55 SOC_DOUBLE_R_TLV("Digital Playback Volume", WM8728_DACLVOL, WM8728_DACRVOL,
56 		 0, 255, 0, wm8728_tlv),
57 
58 SOC_SINGLE("Deemphasis", WM8728_DACCTL, 1, 1, 0),
59 };
60 
61 /*
62  * DAPM controls.
63  */
64 static const struct snd_soc_dapm_widget wm8728_dapm_widgets[] = {
65 SND_SOC_DAPM_DAC("DAC", "HiFi Playback", SND_SOC_NOPM, 0, 0),
66 SND_SOC_DAPM_OUTPUT("VOUTL"),
67 SND_SOC_DAPM_OUTPUT("VOUTR"),
68 };
69 
70 static const struct snd_soc_dapm_route wm8728_intercon[] = {
71 	{"VOUTL", NULL, "DAC"},
72 	{"VOUTR", NULL, "DAC"},
73 };
74 
75 static int wm8728_mute(struct snd_soc_dai *dai, int mute)
76 {
77 	struct snd_soc_codec *codec = dai->codec;
78 	u16 mute_reg = snd_soc_read(codec, WM8728_DACCTL);
79 
80 	if (mute)
81 		snd_soc_write(codec, WM8728_DACCTL, mute_reg | 1);
82 	else
83 		snd_soc_write(codec, WM8728_DACCTL, mute_reg & ~1);
84 
85 	return 0;
86 }
87 
88 static int wm8728_hw_params(struct snd_pcm_substream *substream,
89 	struct snd_pcm_hw_params *params,
90 	struct snd_soc_dai *dai)
91 {
92 	struct snd_soc_codec *codec = dai->codec;
93 	u16 dac = snd_soc_read(codec, WM8728_DACCTL);
94 
95 	dac &= ~0x18;
96 
97 	switch (params_width(params)) {
98 	case 16:
99 		break;
100 	case 20:
101 		dac |= 0x10;
102 		break;
103 	case 24:
104 		dac |= 0x08;
105 		break;
106 	default:
107 		return -EINVAL;
108 	}
109 
110 	snd_soc_write(codec, WM8728_DACCTL, dac);
111 
112 	return 0;
113 }
114 
115 static int wm8728_set_dai_fmt(struct snd_soc_dai *codec_dai,
116 		unsigned int fmt)
117 {
118 	struct snd_soc_codec *codec = codec_dai->codec;
119 	u16 iface = snd_soc_read(codec, WM8728_IFCTL);
120 
121 	/* Currently only I2S is supported by the driver, though the
122 	 * hardware is more flexible.
123 	 */
124 	switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
125 	case SND_SOC_DAIFMT_I2S:
126 		iface |= 1;
127 		break;
128 	default:
129 		return -EINVAL;
130 	}
131 
132 	/* The hardware only support full slave mode */
133 	switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
134 	case SND_SOC_DAIFMT_CBS_CFS:
135 		break;
136 	default:
137 		return -EINVAL;
138 	}
139 
140 	switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
141 	case SND_SOC_DAIFMT_NB_NF:
142 		iface &= ~0x22;
143 		break;
144 	case SND_SOC_DAIFMT_IB_NF:
145 		iface |=  0x20;
146 		iface &= ~0x02;
147 		break;
148 	case SND_SOC_DAIFMT_NB_IF:
149 		iface |= 0x02;
150 		iface &= ~0x20;
151 		break;
152 	case SND_SOC_DAIFMT_IB_IF:
153 		iface |= 0x22;
154 		break;
155 	default:
156 		return -EINVAL;
157 	}
158 
159 	snd_soc_write(codec, WM8728_IFCTL, iface);
160 	return 0;
161 }
162 
163 static int wm8728_set_bias_level(struct snd_soc_codec *codec,
164 				 enum snd_soc_bias_level level)
165 {
166 	struct wm8728_priv *wm8728 = snd_soc_codec_get_drvdata(codec);
167 	u16 reg;
168 
169 	switch (level) {
170 	case SND_SOC_BIAS_ON:
171 	case SND_SOC_BIAS_PREPARE:
172 	case SND_SOC_BIAS_STANDBY:
173 		if (codec->dapm.bias_level == SND_SOC_BIAS_OFF) {
174 			/* Power everything up... */
175 			reg = snd_soc_read(codec, WM8728_DACCTL);
176 			snd_soc_write(codec, WM8728_DACCTL, reg & ~0x4);
177 
178 			/* ..then sync in the register cache. */
179 			regcache_sync(wm8728->regmap);
180 		}
181 		break;
182 
183 	case SND_SOC_BIAS_OFF:
184 		reg = snd_soc_read(codec, WM8728_DACCTL);
185 		snd_soc_write(codec, WM8728_DACCTL, reg | 0x4);
186 		break;
187 	}
188 	codec->dapm.bias_level = level;
189 	return 0;
190 }
191 
192 #define WM8728_RATES (SNDRV_PCM_RATE_8000_192000)
193 
194 #define WM8728_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE |\
195 	SNDRV_PCM_FMTBIT_S24_LE)
196 
197 static const struct snd_soc_dai_ops wm8728_dai_ops = {
198 	.hw_params	= wm8728_hw_params,
199 	.digital_mute	= wm8728_mute,
200 	.set_fmt	= wm8728_set_dai_fmt,
201 };
202 
203 static struct snd_soc_dai_driver wm8728_dai = {
204 	.name = "wm8728-hifi",
205 	.playback = {
206 		.stream_name = "Playback",
207 		.channels_min = 2,
208 		.channels_max = 2,
209 		.rates = WM8728_RATES,
210 		.formats = WM8728_FORMATS,
211 	},
212 	.ops = &wm8728_dai_ops,
213 };
214 
215 static int wm8728_suspend(struct snd_soc_codec *codec)
216 {
217 	wm8728_set_bias_level(codec, SND_SOC_BIAS_OFF);
218 
219 	return 0;
220 }
221 
222 static int wm8728_resume(struct snd_soc_codec *codec)
223 {
224 	wm8728_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
225 
226 	return 0;
227 }
228 
229 static int wm8728_probe(struct snd_soc_codec *codec)
230 {
231 	/* power on device */
232 	wm8728_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
233 
234 	return 0;
235 }
236 
237 static int wm8728_remove(struct snd_soc_codec *codec)
238 {
239 	wm8728_set_bias_level(codec, SND_SOC_BIAS_OFF);
240 	return 0;
241 }
242 
243 static struct snd_soc_codec_driver soc_codec_dev_wm8728 = {
244 	.probe =	wm8728_probe,
245 	.remove =	wm8728_remove,
246 	.suspend =	wm8728_suspend,
247 	.resume =	wm8728_resume,
248 	.set_bias_level = wm8728_set_bias_level,
249 	.controls = wm8728_snd_controls,
250 	.num_controls = ARRAY_SIZE(wm8728_snd_controls),
251 	.dapm_widgets = wm8728_dapm_widgets,
252 	.num_dapm_widgets = ARRAY_SIZE(wm8728_dapm_widgets),
253 	.dapm_routes = wm8728_intercon,
254 	.num_dapm_routes = ARRAY_SIZE(wm8728_intercon),
255 };
256 
257 static const struct of_device_id wm8728_of_match[] = {
258 	{ .compatible = "wlf,wm8728", },
259 	{ }
260 };
261 MODULE_DEVICE_TABLE(of, wm8728_of_match);
262 
263 static const struct regmap_config wm8728_regmap = {
264 	.reg_bits = 7,
265 	.val_bits = 9,
266 	.max_register = WM8728_IFCTL,
267 
268 	.reg_defaults = wm8728_reg_defaults,
269 	.num_reg_defaults = ARRAY_SIZE(wm8728_reg_defaults),
270 	.cache_type = REGCACHE_RBTREE,
271 };
272 
273 #if defined(CONFIG_SPI_MASTER)
274 static int wm8728_spi_probe(struct spi_device *spi)
275 {
276 	struct wm8728_priv *wm8728;
277 	int ret;
278 
279 	wm8728 = devm_kzalloc(&spi->dev, sizeof(struct wm8728_priv),
280 			      GFP_KERNEL);
281 	if (wm8728 == NULL)
282 		return -ENOMEM;
283 
284 	wm8728->regmap = devm_regmap_init_spi(spi, &wm8728_regmap);
285 	if (IS_ERR(wm8728->regmap))
286 		return PTR_ERR(wm8728->regmap);
287 
288 	spi_set_drvdata(spi, wm8728);
289 
290 	ret = snd_soc_register_codec(&spi->dev,
291 			&soc_codec_dev_wm8728, &wm8728_dai, 1);
292 
293 	return ret;
294 }
295 
296 static int wm8728_spi_remove(struct spi_device *spi)
297 {
298 	snd_soc_unregister_codec(&spi->dev);
299 
300 	return 0;
301 }
302 
303 static struct spi_driver wm8728_spi_driver = {
304 	.driver = {
305 		.name	= "wm8728",
306 		.owner	= THIS_MODULE,
307 		.of_match_table = wm8728_of_match,
308 	},
309 	.probe		= wm8728_spi_probe,
310 	.remove		= wm8728_spi_remove,
311 };
312 #endif /* CONFIG_SPI_MASTER */
313 
314 #if IS_ENABLED(CONFIG_I2C)
315 static int wm8728_i2c_probe(struct i2c_client *i2c,
316 			    const struct i2c_device_id *id)
317 {
318 	struct wm8728_priv *wm8728;
319 	int ret;
320 
321 	wm8728 = devm_kzalloc(&i2c->dev, sizeof(struct wm8728_priv),
322 			      GFP_KERNEL);
323 	if (wm8728 == NULL)
324 		return -ENOMEM;
325 
326 	wm8728->regmap = devm_regmap_init_i2c(i2c, &wm8728_regmap);
327 	if (IS_ERR(wm8728->regmap))
328 		return PTR_ERR(wm8728->regmap);
329 
330 	i2c_set_clientdata(i2c, wm8728);
331 
332 	ret =  snd_soc_register_codec(&i2c->dev,
333 			&soc_codec_dev_wm8728, &wm8728_dai, 1);
334 
335 	return ret;
336 }
337 
338 static int wm8728_i2c_remove(struct i2c_client *client)
339 {
340 	snd_soc_unregister_codec(&client->dev);
341 	return 0;
342 }
343 
344 static const struct i2c_device_id wm8728_i2c_id[] = {
345 	{ "wm8728", 0 },
346 	{ }
347 };
348 MODULE_DEVICE_TABLE(i2c, wm8728_i2c_id);
349 
350 static struct i2c_driver wm8728_i2c_driver = {
351 	.driver = {
352 		.name = "wm8728",
353 		.owner = THIS_MODULE,
354 		.of_match_table = wm8728_of_match,
355 	},
356 	.probe =    wm8728_i2c_probe,
357 	.remove =   wm8728_i2c_remove,
358 	.id_table = wm8728_i2c_id,
359 };
360 #endif
361 
362 static int __init wm8728_modinit(void)
363 {
364 	int ret = 0;
365 #if IS_ENABLED(CONFIG_I2C)
366 	ret = i2c_add_driver(&wm8728_i2c_driver);
367 	if (ret != 0) {
368 		printk(KERN_ERR "Failed to register wm8728 I2C driver: %d\n",
369 		       ret);
370 	}
371 #endif
372 #if defined(CONFIG_SPI_MASTER)
373 	ret = spi_register_driver(&wm8728_spi_driver);
374 	if (ret != 0) {
375 		printk(KERN_ERR "Failed to register wm8728 SPI driver: %d\n",
376 		       ret);
377 	}
378 #endif
379 	return ret;
380 }
381 module_init(wm8728_modinit);
382 
383 static void __exit wm8728_exit(void)
384 {
385 #if IS_ENABLED(CONFIG_I2C)
386 	i2c_del_driver(&wm8728_i2c_driver);
387 #endif
388 #if defined(CONFIG_SPI_MASTER)
389 	spi_unregister_driver(&wm8728_spi_driver);
390 #endif
391 }
392 module_exit(wm8728_exit);
393 
394 MODULE_DESCRIPTION("ASoC WM8728 driver");
395 MODULE_AUTHOR("Mark Brown <broonie@opensource.wolfsonmicro.com>");
396 MODULE_LICENSE("GPL");
397