xref: /openbmc/linux/sound/soc/codecs/ak4613.c (revision bc5aa3a0)
1 /*
2  * ak4613.c  --  Asahi Kasei ALSA Soc Audio driver
3  *
4  * Copyright (C) 2015 Renesas Electronics Corporation
5  * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
6  *
7  * Based on ak4642.c by Kuninori Morimoto
8  * Based on wm8731.c by Richard Purdie
9  * Based on ak4535.c by Richard Purdie
10  * Based on wm8753.c by Liam Girdwood
11  *
12  * This program is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License version 2 as
14  * published by the Free Software Foundation.
15  */
16 
17 #include <linux/clk.h>
18 #include <linux/i2c.h>
19 #include <linux/slab.h>
20 #include <linux/of_device.h>
21 #include <linux/module.h>
22 #include <linux/regmap.h>
23 #include <sound/soc.h>
24 #include <sound/pcm_params.h>
25 #include <sound/tlv.h>
26 
27 #define PW_MGMT1	0x00 /* Power Management 1 */
28 #define PW_MGMT2	0x01 /* Power Management 2 */
29 #define PW_MGMT3	0x02 /* Power Management 3 */
30 #define CTRL1		0x03 /* Control 1 */
31 #define CTRL2		0x04 /* Control 2 */
32 #define DEMP1		0x05 /* De-emphasis1 */
33 #define DEMP2		0x06 /* De-emphasis2 */
34 #define OFD		0x07 /* Overflow Detect */
35 #define ZRD		0x08 /* Zero Detect */
36 #define ICTRL		0x09 /* Input Control */
37 #define OCTRL		0x0a /* Output Control */
38 #define LOUT1		0x0b /* LOUT1 Volume Control */
39 #define ROUT1		0x0c /* ROUT1 Volume Control */
40 #define LOUT2		0x0d /* LOUT2 Volume Control */
41 #define ROUT2		0x0e /* ROUT2 Volume Control */
42 #define LOUT3		0x0f /* LOUT3 Volume Control */
43 #define ROUT3		0x10 /* ROUT3 Volume Control */
44 #define LOUT4		0x11 /* LOUT4 Volume Control */
45 #define ROUT4		0x12 /* ROUT4 Volume Control */
46 #define LOUT5		0x13 /* LOUT5 Volume Control */
47 #define ROUT5		0x14 /* ROUT5 Volume Control */
48 #define LOUT6		0x15 /* LOUT6 Volume Control */
49 #define ROUT6		0x16 /* ROUT6 Volume Control */
50 
51 /* PW_MGMT1 */
52 #define RSTN		BIT(0)
53 #define PMDAC		BIT(1)
54 #define PMADC		BIT(2)
55 #define PMVR		BIT(3)
56 
57 /* PW_MGMT2 */
58 #define PMAD_ALL	0x7
59 
60 /* PW_MGMT3 */
61 #define PMDA_ALL	0x3f
62 
63 /* CTRL1 */
64 #define DIF0		BIT(3)
65 #define DIF1		BIT(4)
66 #define DIF2		BIT(5)
67 #define TDM0		BIT(6)
68 #define TDM1		BIT(7)
69 #define NO_FMT		(0xff)
70 #define FMT_MASK	(0xf8)
71 
72 /* CTRL2 */
73 #define DFS_MASK		(3 << 2)
74 #define DFS_NORMAL_SPEED	(0 << 2)
75 #define DFS_DOUBLE_SPEED	(1 << 2)
76 #define DFS_QUAD_SPEED		(2 << 2)
77 
78 struct ak4613_formats {
79 	unsigned int width;
80 	unsigned int fmt;
81 };
82 
83 struct ak4613_interface {
84 	struct ak4613_formats capture;
85 	struct ak4613_formats playback;
86 };
87 
88 struct ak4613_priv {
89 	struct mutex lock;
90 	const struct ak4613_interface *iface;
91 
92 	unsigned int fmt;
93 	u8 oc;
94 	u8 ic;
95 	int cnt;
96 };
97 
98 /*
99  * Playback Volume
100  *
101  * max : 0x00 : 0 dB
102  *       ( 0.5 dB step )
103  * min : 0xFE : -127.0 dB
104  * mute: 0xFF
105  */
106 static const DECLARE_TLV_DB_SCALE(out_tlv, -12750, 50, 1);
107 
108 static const struct snd_kcontrol_new ak4613_snd_controls[] = {
109 	SOC_DOUBLE_R_TLV("Digital Playback Volume1", LOUT1, ROUT1,
110 			 0, 0xFF, 1, out_tlv),
111 	SOC_DOUBLE_R_TLV("Digital Playback Volume2", LOUT2, ROUT2,
112 			 0, 0xFF, 1, out_tlv),
113 	SOC_DOUBLE_R_TLV("Digital Playback Volume3", LOUT3, ROUT3,
114 			 0, 0xFF, 1, out_tlv),
115 	SOC_DOUBLE_R_TLV("Digital Playback Volume4", LOUT4, ROUT4,
116 			 0, 0xFF, 1, out_tlv),
117 	SOC_DOUBLE_R_TLV("Digital Playback Volume5", LOUT5, ROUT5,
118 			 0, 0xFF, 1, out_tlv),
119 	SOC_DOUBLE_R_TLV("Digital Playback Volume6", LOUT6, ROUT6,
120 			 0, 0xFF, 1, out_tlv),
121 };
122 
123 static const struct reg_default ak4613_reg[] = {
124 	{ 0x0,  0x0f }, { 0x1,  0x07 }, { 0x2,  0x3f }, { 0x3,  0x20 },
125 	{ 0x4,  0x20 }, { 0x5,  0x55 }, { 0x6,  0x05 }, { 0x7,  0x07 },
126 	{ 0x8,  0x0f }, { 0x9,  0x07 }, { 0xa,  0x3f }, { 0xb,  0x00 },
127 	{ 0xc,  0x00 }, { 0xd,  0x00 }, { 0xe,  0x00 }, { 0xf,  0x00 },
128 	{ 0x10, 0x00 }, { 0x11, 0x00 }, { 0x12, 0x00 }, { 0x13, 0x00 },
129 	{ 0x14, 0x00 }, { 0x15, 0x00 }, { 0x16, 0x00 },
130 };
131 
132 #define AUDIO_IFACE_TO_VAL(fmts) ((fmts - ak4613_iface) << 3)
133 #define AUDIO_IFACE(b, fmt) { b, SND_SOC_DAIFMT_##fmt }
134 static const struct ak4613_interface ak4613_iface[] = {
135 	/* capture */				/* playback */
136 	[0] = {	AUDIO_IFACE(24, LEFT_J),	AUDIO_IFACE(16, RIGHT_J) },
137 	[1] = {	AUDIO_IFACE(24, LEFT_J),	AUDIO_IFACE(20, RIGHT_J) },
138 	[2] = {	AUDIO_IFACE(24, LEFT_J),	AUDIO_IFACE(24, RIGHT_J) },
139 	[3] = {	AUDIO_IFACE(24, LEFT_J),	AUDIO_IFACE(24, LEFT_J) },
140 	[4] = {	AUDIO_IFACE(24, I2S),		AUDIO_IFACE(24, I2S) },
141 };
142 
143 static const struct regmap_config ak4613_regmap_cfg = {
144 	.reg_bits		= 8,
145 	.val_bits		= 8,
146 	.max_register		= 0x16,
147 	.reg_defaults		= ak4613_reg,
148 	.num_reg_defaults	= ARRAY_SIZE(ak4613_reg),
149 	.cache_type		= REGCACHE_RBTREE,
150 };
151 
152 static const struct of_device_id ak4613_of_match[] = {
153 	{ .compatible = "asahi-kasei,ak4613",	.data = &ak4613_regmap_cfg },
154 	{},
155 };
156 MODULE_DEVICE_TABLE(of, ak4613_of_match);
157 
158 static const struct i2c_device_id ak4613_i2c_id[] = {
159 	{ "ak4613", (kernel_ulong_t)&ak4613_regmap_cfg },
160 	{ }
161 };
162 MODULE_DEVICE_TABLE(i2c, ak4613_i2c_id);
163 
164 static const struct snd_soc_dapm_widget ak4613_dapm_widgets[] = {
165 
166 	/* Outputs */
167 	SND_SOC_DAPM_OUTPUT("LOUT1"),
168 	SND_SOC_DAPM_OUTPUT("LOUT2"),
169 	SND_SOC_DAPM_OUTPUT("LOUT3"),
170 	SND_SOC_DAPM_OUTPUT("LOUT4"),
171 	SND_SOC_DAPM_OUTPUT("LOUT5"),
172 	SND_SOC_DAPM_OUTPUT("LOUT6"),
173 
174 	SND_SOC_DAPM_OUTPUT("ROUT1"),
175 	SND_SOC_DAPM_OUTPUT("ROUT2"),
176 	SND_SOC_DAPM_OUTPUT("ROUT3"),
177 	SND_SOC_DAPM_OUTPUT("ROUT4"),
178 	SND_SOC_DAPM_OUTPUT("ROUT5"),
179 	SND_SOC_DAPM_OUTPUT("ROUT6"),
180 
181 	/* Inputs */
182 	SND_SOC_DAPM_INPUT("LIN1"),
183 	SND_SOC_DAPM_INPUT("LIN2"),
184 
185 	SND_SOC_DAPM_INPUT("RIN1"),
186 	SND_SOC_DAPM_INPUT("RIN2"),
187 
188 	/* DAC */
189 	SND_SOC_DAPM_DAC("DAC1", NULL, PW_MGMT3, 0, 0),
190 	SND_SOC_DAPM_DAC("DAC2", NULL, PW_MGMT3, 1, 0),
191 	SND_SOC_DAPM_DAC("DAC3", NULL, PW_MGMT3, 2, 0),
192 	SND_SOC_DAPM_DAC("DAC4", NULL, PW_MGMT3, 3, 0),
193 	SND_SOC_DAPM_DAC("DAC5", NULL, PW_MGMT3, 4, 0),
194 	SND_SOC_DAPM_DAC("DAC6", NULL, PW_MGMT3, 5, 0),
195 
196 	/* ADC */
197 	SND_SOC_DAPM_ADC("ADC1", NULL, PW_MGMT2, 0, 0),
198 	SND_SOC_DAPM_ADC("ADC2", NULL, PW_MGMT2, 1, 0),
199 };
200 
201 static const struct snd_soc_dapm_route ak4613_intercon[] = {
202 	{"LOUT1", NULL, "DAC1"},
203 	{"LOUT2", NULL, "DAC2"},
204 	{"LOUT3", NULL, "DAC3"},
205 	{"LOUT4", NULL, "DAC4"},
206 	{"LOUT5", NULL, "DAC5"},
207 	{"LOUT6", NULL, "DAC6"},
208 
209 	{"ROUT1", NULL, "DAC1"},
210 	{"ROUT2", NULL, "DAC2"},
211 	{"ROUT3", NULL, "DAC3"},
212 	{"ROUT4", NULL, "DAC4"},
213 	{"ROUT5", NULL, "DAC5"},
214 	{"ROUT6", NULL, "DAC6"},
215 
216 	{"DAC1", NULL, "Playback"},
217 	{"DAC2", NULL, "Playback"},
218 	{"DAC3", NULL, "Playback"},
219 	{"DAC4", NULL, "Playback"},
220 	{"DAC5", NULL, "Playback"},
221 	{"DAC6", NULL, "Playback"},
222 
223 	{"Capture", NULL, "ADC1"},
224 	{"Capture", NULL, "ADC2"},
225 
226 	{"ADC1", NULL, "LIN1"},
227 	{"ADC2", NULL, "LIN2"},
228 
229 	{"ADC1", NULL, "RIN1"},
230 	{"ADC2", NULL, "RIN2"},
231 };
232 
233 static void ak4613_dai_shutdown(struct snd_pcm_substream *substream,
234 			       struct snd_soc_dai *dai)
235 {
236 	struct snd_soc_codec *codec = dai->codec;
237 	struct ak4613_priv *priv = snd_soc_codec_get_drvdata(codec);
238 	struct device *dev = codec->dev;
239 
240 	mutex_lock(&priv->lock);
241 	priv->cnt--;
242 	if (priv->cnt < 0) {
243 		dev_err(dev, "unexpected counter error\n");
244 		priv->cnt = 0;
245 	}
246 	if (!priv->cnt)
247 		priv->iface = NULL;
248 	mutex_unlock(&priv->lock);
249 }
250 
251 static int ak4613_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt)
252 {
253 	struct snd_soc_codec *codec = dai->codec;
254 	struct ak4613_priv *priv = snd_soc_codec_get_drvdata(codec);
255 
256 	fmt &= SND_SOC_DAIFMT_FORMAT_MASK;
257 
258 	switch (fmt) {
259 	case SND_SOC_DAIFMT_RIGHT_J:
260 	case SND_SOC_DAIFMT_LEFT_J:
261 	case SND_SOC_DAIFMT_I2S:
262 		priv->fmt = fmt;
263 
264 		break;
265 	default:
266 		return -EINVAL;
267 	}
268 
269 	return 0;
270 }
271 
272 static bool ak4613_dai_fmt_matching(const struct ak4613_interface *iface,
273 				    int is_play,
274 				    unsigned int fmt, unsigned int width)
275 {
276 	const struct ak4613_formats *fmts;
277 
278 	fmts = (is_play) ? &iface->playback : &iface->capture;
279 
280 	if (fmts->fmt != fmt)
281 		return false;
282 
283 	if (fmt == SND_SOC_DAIFMT_RIGHT_J) {
284 		if (fmts->width != width)
285 			return false;
286 	} else {
287 		if (fmts->width < width)
288 			return false;
289 	}
290 
291 	return true;
292 }
293 
294 static int ak4613_dai_hw_params(struct snd_pcm_substream *substream,
295 				struct snd_pcm_hw_params *params,
296 				struct snd_soc_dai *dai)
297 {
298 	struct snd_soc_codec *codec = dai->codec;
299 	struct ak4613_priv *priv = snd_soc_codec_get_drvdata(codec);
300 	const struct ak4613_interface *iface;
301 	struct device *dev = codec->dev;
302 	unsigned int width = params_width(params);
303 	unsigned int fmt = priv->fmt;
304 	unsigned int rate;
305 	int is_play = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
306 	int i, ret;
307 	u8 fmt_ctrl, ctrl2;
308 
309 	rate = params_rate(params);
310 	switch (rate) {
311 	case 32000:
312 	case 44100:
313 	case 48000:
314 		ctrl2 = DFS_NORMAL_SPEED;
315 		break;
316 	case 88200:
317 	case 96000:
318 		ctrl2 = DFS_DOUBLE_SPEED;
319 		break;
320 	case 176400:
321 	case 192000:
322 		ctrl2 = DFS_QUAD_SPEED;
323 		break;
324 	default:
325 		return -EINVAL;
326 	}
327 
328 	/*
329 	 * FIXME
330 	 *
331 	 * It doesn't support TDM at this point
332 	 */
333 	fmt_ctrl = NO_FMT;
334 	ret = -EINVAL;
335 	iface = NULL;
336 
337 	mutex_lock(&priv->lock);
338 	if (priv->iface) {
339 		if (ak4613_dai_fmt_matching(priv->iface, is_play, fmt, width))
340 			iface = priv->iface;
341 	} else {
342 		for (i = ARRAY_SIZE(ak4613_iface); i >= 0; i--) {
343 			if (!ak4613_dai_fmt_matching(ak4613_iface + i,
344 						     is_play,
345 						     fmt, width))
346 				continue;
347 			iface = ak4613_iface + i;
348 			break;
349 		}
350 	}
351 
352 	if ((priv->iface == NULL) ||
353 	    (priv->iface == iface)) {
354 		priv->iface = iface;
355 		priv->cnt++;
356 		ret = 0;
357 	}
358 	mutex_unlock(&priv->lock);
359 
360 	if (ret < 0)
361 		goto hw_params_end;
362 
363 	fmt_ctrl = AUDIO_IFACE_TO_VAL(iface);
364 
365 	snd_soc_update_bits(codec, CTRL1, FMT_MASK, fmt_ctrl);
366 	snd_soc_update_bits(codec, CTRL2, DFS_MASK, ctrl2);
367 
368 	snd_soc_write(codec, ICTRL, priv->ic);
369 	snd_soc_write(codec, OCTRL, priv->oc);
370 
371 hw_params_end:
372 	if (ret < 0)
373 		dev_warn(dev, "unsupported data width/format combination\n");
374 
375 	return ret;
376 }
377 
378 static int ak4613_set_bias_level(struct snd_soc_codec *codec,
379 				 enum snd_soc_bias_level level)
380 {
381 	u8 mgmt1 = 0;
382 
383 	switch (level) {
384 	case SND_SOC_BIAS_ON:
385 		mgmt1 |= RSTN;
386 		/* fall through */
387 	case SND_SOC_BIAS_PREPARE:
388 		mgmt1 |= PMADC | PMDAC;
389 		/* fall through */
390 	case SND_SOC_BIAS_STANDBY:
391 		mgmt1 |= PMVR;
392 		/* fall through */
393 	case SND_SOC_BIAS_OFF:
394 	default:
395 		break;
396 	}
397 
398 	snd_soc_write(codec, PW_MGMT1, mgmt1);
399 
400 	return 0;
401 }
402 
403 static const struct snd_soc_dai_ops ak4613_dai_ops = {
404 	.shutdown	= ak4613_dai_shutdown,
405 	.set_fmt	= ak4613_dai_set_fmt,
406 	.hw_params	= ak4613_dai_hw_params,
407 };
408 
409 #define AK4613_PCM_RATE		(SNDRV_PCM_RATE_32000  |\
410 				 SNDRV_PCM_RATE_44100  |\
411 				 SNDRV_PCM_RATE_48000  |\
412 				 SNDRV_PCM_RATE_64000  |\
413 				 SNDRV_PCM_RATE_88200  |\
414 				 SNDRV_PCM_RATE_96000  |\
415 				 SNDRV_PCM_RATE_176400 |\
416 				 SNDRV_PCM_RATE_192000)
417 #define AK4613_PCM_FMTBIT	(SNDRV_PCM_FMTBIT_S16_LE |\
418 				 SNDRV_PCM_FMTBIT_S24_LE)
419 
420 static struct snd_soc_dai_driver ak4613_dai = {
421 	.name = "ak4613-hifi",
422 	.playback = {
423 		.stream_name	= "Playback",
424 		.channels_min	= 2,
425 		.channels_max	= 2,
426 		.rates		= AK4613_PCM_RATE,
427 		.formats	= AK4613_PCM_FMTBIT,
428 	},
429 	.capture = {
430 		.stream_name	= "Capture",
431 		.channels_min	= 2,
432 		.channels_max	= 2,
433 		.rates		= AK4613_PCM_RATE,
434 		.formats	= AK4613_PCM_FMTBIT,
435 	},
436 	.ops = &ak4613_dai_ops,
437 	.symmetric_rates = 1,
438 };
439 
440 static int ak4613_suspend(struct snd_soc_codec *codec)
441 {
442 	struct regmap *regmap = dev_get_regmap(codec->dev, NULL);
443 
444 	regcache_cache_only(regmap, true);
445 	regcache_mark_dirty(regmap);
446 	return 0;
447 }
448 
449 static int ak4613_resume(struct snd_soc_codec *codec)
450 {
451 	struct regmap *regmap = dev_get_regmap(codec->dev, NULL);
452 
453 	regcache_cache_only(regmap, false);
454 	return regcache_sync(regmap);
455 }
456 
457 static struct snd_soc_codec_driver soc_codec_dev_ak4613 = {
458 	.suspend		= ak4613_suspend,
459 	.resume			= ak4613_resume,
460 	.set_bias_level		= ak4613_set_bias_level,
461 	.controls		= ak4613_snd_controls,
462 	.num_controls		= ARRAY_SIZE(ak4613_snd_controls),
463 	.dapm_widgets		= ak4613_dapm_widgets,
464 	.num_dapm_widgets	= ARRAY_SIZE(ak4613_dapm_widgets),
465 	.dapm_routes		= ak4613_intercon,
466 	.num_dapm_routes	= ARRAY_SIZE(ak4613_intercon),
467 };
468 
469 static void ak4613_parse_of(struct ak4613_priv *priv,
470 			    struct device *dev)
471 {
472 	struct device_node *np = dev->of_node;
473 	char prop[32];
474 	int i;
475 
476 	/* Input 1 - 2 */
477 	for (i = 0; i < 2; i++) {
478 		snprintf(prop, sizeof(prop), "asahi-kasei,in%d-single-end", i + 1);
479 		if (!of_get_property(np, prop, NULL))
480 			priv->ic |= 1 << i;
481 	}
482 
483 	/* Output 1 - 6 */
484 	for (i = 0; i < 6; i++) {
485 		snprintf(prop, sizeof(prop), "asahi-kasei,out%d-single-end", i + 1);
486 		if (!of_get_property(np, prop, NULL))
487 			priv->oc |= 1 << i;
488 	}
489 }
490 
491 static int ak4613_i2c_probe(struct i2c_client *i2c,
492 			    const struct i2c_device_id *id)
493 {
494 	struct device *dev = &i2c->dev;
495 	struct device_node *np = dev->of_node;
496 	const struct regmap_config *regmap_cfg;
497 	struct regmap *regmap;
498 	struct ak4613_priv *priv;
499 
500 	regmap_cfg = NULL;
501 	if (np) {
502 		const struct of_device_id *of_id;
503 
504 		of_id = of_match_device(ak4613_of_match, dev);
505 		if (of_id)
506 			regmap_cfg = of_id->data;
507 	} else {
508 		regmap_cfg = (const struct regmap_config *)id->driver_data;
509 	}
510 
511 	if (!regmap_cfg)
512 		return -EINVAL;
513 
514 	priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
515 	if (!priv)
516 		return -ENOMEM;
517 
518 	ak4613_parse_of(priv, dev);
519 
520 	priv->iface		= NULL;
521 	priv->cnt		= 0;
522 
523 	mutex_init(&priv->lock);
524 
525 	i2c_set_clientdata(i2c, priv);
526 
527 	regmap = devm_regmap_init_i2c(i2c, regmap_cfg);
528 	if (IS_ERR(regmap))
529 		return PTR_ERR(regmap);
530 
531 	return snd_soc_register_codec(dev, &soc_codec_dev_ak4613,
532 				      &ak4613_dai, 1);
533 }
534 
535 static int ak4613_i2c_remove(struct i2c_client *client)
536 {
537 	snd_soc_unregister_codec(&client->dev);
538 	return 0;
539 }
540 
541 static struct i2c_driver ak4613_i2c_driver = {
542 	.driver = {
543 		.name = "ak4613-codec",
544 		.of_match_table = ak4613_of_match,
545 	},
546 	.probe		= ak4613_i2c_probe,
547 	.remove		= ak4613_i2c_remove,
548 	.id_table	= ak4613_i2c_id,
549 };
550 
551 module_i2c_driver(ak4613_i2c_driver);
552 
553 MODULE_DESCRIPTION("Soc AK4613 driver");
554 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");
555 MODULE_LICENSE("GPL v2");
556