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