2 * ak4613.c -- Asahi Kasei ALSA Soc Audio driver
4 * Copyright (C) 2015 Renesas Electronics Corporation
5 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
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
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.
17 #include <linux/clk.h>
18 #include <linux/delay.h>
19 #include <linux/i2c.h>
20 #include <linux/slab.h>
21 #include <linux/of_device.h>
22 #include <linux/module.h>
23 #include <linux/regmap.h>
24 #include <sound/soc.h>
25 #include <sound/pcm_params.h>
26 #include <sound/tlv.h>
28 #define PW_MGMT1 0x00 /* Power Management 1 */
29 #define PW_MGMT2 0x01 /* Power Management 2 */
30 #define PW_MGMT3 0x02 /* Power Management 3 */
31 #define CTRL1 0x03 /* Control 1 */
32 #define CTRL2 0x04 /* Control 2 */
33 #define DEMP1 0x05 /* De-emphasis1 */
34 #define DEMP2 0x06 /* De-emphasis2 */
35 #define OFD 0x07 /* Overflow Detect */
36 #define ZRD 0x08 /* Zero Detect */
37 #define ICTRL 0x09 /* Input Control */
38 #define OCTRL 0x0a /* Output Control */
39 #define LOUT1 0x0b /* LOUT1 Volume Control */
40 #define ROUT1 0x0c /* ROUT1 Volume Control */
41 #define LOUT2 0x0d /* LOUT2 Volume Control */
42 #define ROUT2 0x0e /* ROUT2 Volume Control */
43 #define LOUT3 0x0f /* LOUT3 Volume Control */
44 #define ROUT3 0x10 /* ROUT3 Volume Control */
45 #define LOUT4 0x11 /* LOUT4 Volume Control */
46 #define ROUT4 0x12 /* ROUT4 Volume Control */
47 #define LOUT5 0x13 /* LOUT5 Volume Control */
48 #define ROUT5 0x14 /* ROUT5 Volume Control */
49 #define LOUT6 0x15 /* LOUT6 Volume Control */
50 #define ROUT6 0x16 /* ROUT6 Volume Control */
71 #define FMT_MASK (0xf8)
74 #define DFS_MASK (3 << 2)
75 #define DFS_NORMAL_SPEED (0 << 2)
76 #define DFS_DOUBLE_SPEED (1 << 2)
77 #define DFS_QUAD_SPEED (2 << 2)
80 #define ICTRL_MASK (0x3)
83 #define OCTRL_MASK (0x3F)
85 struct ak4613_formats
{
90 struct ak4613_interface
{
91 struct ak4613_formats capture
;
92 struct ak4613_formats playback
;
97 const struct ak4613_interface
*iface
;
98 struct snd_pcm_hw_constraint_list constraint
;
99 struct work_struct dummy_write_work
;
100 struct snd_soc_component
*component
;
115 * min : 0xFE : -127.0 dB
118 static const DECLARE_TLV_DB_SCALE(out_tlv
, -12750, 50, 1);
120 static const struct snd_kcontrol_new ak4613_snd_controls
[] = {
121 SOC_DOUBLE_R_TLV("Digital Playback Volume1", LOUT1
, ROUT1
,
122 0, 0xFF, 1, out_tlv
),
123 SOC_DOUBLE_R_TLV("Digital Playback Volume2", LOUT2
, ROUT2
,
124 0, 0xFF, 1, out_tlv
),
125 SOC_DOUBLE_R_TLV("Digital Playback Volume3", LOUT3
, ROUT3
,
126 0, 0xFF, 1, out_tlv
),
127 SOC_DOUBLE_R_TLV("Digital Playback Volume4", LOUT4
, ROUT4
,
128 0, 0xFF, 1, out_tlv
),
129 SOC_DOUBLE_R_TLV("Digital Playback Volume5", LOUT5
, ROUT5
,
130 0, 0xFF, 1, out_tlv
),
131 SOC_DOUBLE_R_TLV("Digital Playback Volume6", LOUT6
, ROUT6
,
132 0, 0xFF, 1, out_tlv
),
135 static const struct reg_default ak4613_reg
[] = {
136 { 0x0, 0x0f }, { 0x1, 0x07 }, { 0x2, 0x3f }, { 0x3, 0x20 },
137 { 0x4, 0x20 }, { 0x5, 0x55 }, { 0x6, 0x05 }, { 0x7, 0x07 },
138 { 0x8, 0x0f }, { 0x9, 0x07 }, { 0xa, 0x3f }, { 0xb, 0x00 },
139 { 0xc, 0x00 }, { 0xd, 0x00 }, { 0xe, 0x00 }, { 0xf, 0x00 },
140 { 0x10, 0x00 }, { 0x11, 0x00 }, { 0x12, 0x00 }, { 0x13, 0x00 },
141 { 0x14, 0x00 }, { 0x15, 0x00 }, { 0x16, 0x00 },
144 #define AUDIO_IFACE_TO_VAL(fmts) ((fmts - ak4613_iface) << 3)
145 #define AUDIO_IFACE(b, fmt) { b, SND_SOC_DAIFMT_##fmt }
146 static const struct ak4613_interface ak4613_iface
[] = {
147 /* capture */ /* playback */
148 /* [0] - [2] are not supported */
149 [3] = { AUDIO_IFACE(24, LEFT_J
), AUDIO_IFACE(24, LEFT_J
) },
150 [4] = { AUDIO_IFACE(24, I2S
), AUDIO_IFACE(24, I2S
) },
153 static const struct regmap_config ak4613_regmap_cfg
= {
156 .max_register
= 0x16,
157 .reg_defaults
= ak4613_reg
,
158 .num_reg_defaults
= ARRAY_SIZE(ak4613_reg
),
159 .cache_type
= REGCACHE_RBTREE
,
162 static const struct of_device_id ak4613_of_match
[] = {
163 { .compatible
= "asahi-kasei,ak4613", .data
= &ak4613_regmap_cfg
},
166 MODULE_DEVICE_TABLE(of
, ak4613_of_match
);
168 static const struct i2c_device_id ak4613_i2c_id
[] = {
169 { "ak4613", (kernel_ulong_t
)&ak4613_regmap_cfg
},
172 MODULE_DEVICE_TABLE(i2c
, ak4613_i2c_id
);
174 static const struct snd_soc_dapm_widget ak4613_dapm_widgets
[] = {
177 SND_SOC_DAPM_OUTPUT("LOUT1"),
178 SND_SOC_DAPM_OUTPUT("LOUT2"),
179 SND_SOC_DAPM_OUTPUT("LOUT3"),
180 SND_SOC_DAPM_OUTPUT("LOUT4"),
181 SND_SOC_DAPM_OUTPUT("LOUT5"),
182 SND_SOC_DAPM_OUTPUT("LOUT6"),
184 SND_SOC_DAPM_OUTPUT("ROUT1"),
185 SND_SOC_DAPM_OUTPUT("ROUT2"),
186 SND_SOC_DAPM_OUTPUT("ROUT3"),
187 SND_SOC_DAPM_OUTPUT("ROUT4"),
188 SND_SOC_DAPM_OUTPUT("ROUT5"),
189 SND_SOC_DAPM_OUTPUT("ROUT6"),
192 SND_SOC_DAPM_INPUT("LIN1"),
193 SND_SOC_DAPM_INPUT("LIN2"),
195 SND_SOC_DAPM_INPUT("RIN1"),
196 SND_SOC_DAPM_INPUT("RIN2"),
199 SND_SOC_DAPM_DAC("DAC1", NULL
, PW_MGMT3
, 0, 0),
200 SND_SOC_DAPM_DAC("DAC2", NULL
, PW_MGMT3
, 1, 0),
201 SND_SOC_DAPM_DAC("DAC3", NULL
, PW_MGMT3
, 2, 0),
202 SND_SOC_DAPM_DAC("DAC4", NULL
, PW_MGMT3
, 3, 0),
203 SND_SOC_DAPM_DAC("DAC5", NULL
, PW_MGMT3
, 4, 0),
204 SND_SOC_DAPM_DAC("DAC6", NULL
, PW_MGMT3
, 5, 0),
207 SND_SOC_DAPM_ADC("ADC1", NULL
, PW_MGMT2
, 0, 0),
208 SND_SOC_DAPM_ADC("ADC2", NULL
, PW_MGMT2
, 1, 0),
211 static const struct snd_soc_dapm_route ak4613_intercon
[] = {
212 {"LOUT1", NULL
, "DAC1"},
213 {"LOUT2", NULL
, "DAC2"},
214 {"LOUT3", NULL
, "DAC3"},
215 {"LOUT4", NULL
, "DAC4"},
216 {"LOUT5", NULL
, "DAC5"},
217 {"LOUT6", NULL
, "DAC6"},
219 {"ROUT1", NULL
, "DAC1"},
220 {"ROUT2", NULL
, "DAC2"},
221 {"ROUT3", NULL
, "DAC3"},
222 {"ROUT4", NULL
, "DAC4"},
223 {"ROUT5", NULL
, "DAC5"},
224 {"ROUT6", NULL
, "DAC6"},
226 {"DAC1", NULL
, "Playback"},
227 {"DAC2", NULL
, "Playback"},
228 {"DAC3", NULL
, "Playback"},
229 {"DAC4", NULL
, "Playback"},
230 {"DAC5", NULL
, "Playback"},
231 {"DAC6", NULL
, "Playback"},
233 {"Capture", NULL
, "ADC1"},
234 {"Capture", NULL
, "ADC2"},
236 {"ADC1", NULL
, "LIN1"},
237 {"ADC2", NULL
, "LIN2"},
239 {"ADC1", NULL
, "RIN1"},
240 {"ADC2", NULL
, "RIN2"},
243 static void ak4613_dai_shutdown(struct snd_pcm_substream
*substream
,
244 struct snd_soc_dai
*dai
)
246 struct snd_soc_component
*component
= dai
->component
;
247 struct ak4613_priv
*priv
= snd_soc_component_get_drvdata(component
);
248 struct device
*dev
= component
->dev
;
250 mutex_lock(&priv
->lock
);
253 dev_err(dev
, "unexpected counter error\n");
258 mutex_unlock(&priv
->lock
);
261 static void ak4613_hw_constraints(struct ak4613_priv
*priv
,
262 struct snd_pcm_runtime
*runtime
)
264 static const unsigned int ak4613_rates
[] = {
274 struct snd_pcm_hw_constraint_list
*constraint
= &priv
->constraint
;
278 constraint
->list
= ak4613_rates
;
279 constraint
->mask
= 0;
280 constraint
->count
= 0;
284 * Normal: [32kHz, 48kHz] : 256fs,384fs or 512fs
285 * Double: [64kHz, 96kHz] : 256fs
286 * Quad : [128kHz,192kHz]: 128fs
289 * Normal: [32kHz, 48kHz] : 256fs or 512fs
290 * Double: [64kHz, 96kHz] : 256fs
291 * Quad : [128kHz,192kHz]: 128fs
293 for (i
= 0; i
< ARRAY_SIZE(ak4613_rates
); i
++) {
294 /* minimum fs on each range */
295 fs
= (ak4613_rates
[i
] <= 96000) ? 256 : 128;
297 if (priv
->sysclk
>= ak4613_rates
[i
] * fs
)
298 constraint
->count
= i
+ 1;
301 snd_pcm_hw_constraint_list(runtime
, 0,
302 SNDRV_PCM_HW_PARAM_RATE
, constraint
);
305 static int ak4613_dai_startup(struct snd_pcm_substream
*substream
,
306 struct snd_soc_dai
*dai
)
308 struct snd_soc_component
*component
= dai
->component
;
309 struct ak4613_priv
*priv
= snd_soc_component_get_drvdata(component
);
313 ak4613_hw_constraints(priv
, substream
->runtime
);
318 static int ak4613_dai_set_sysclk(struct snd_soc_dai
*codec_dai
,
319 int clk_id
, unsigned int freq
, int dir
)
321 struct snd_soc_component
*component
= codec_dai
->component
;
322 struct ak4613_priv
*priv
= snd_soc_component_get_drvdata(component
);
329 static int ak4613_dai_set_fmt(struct snd_soc_dai
*dai
, unsigned int fmt
)
331 struct snd_soc_component
*component
= dai
->component
;
332 struct ak4613_priv
*priv
= snd_soc_component_get_drvdata(component
);
334 fmt
&= SND_SOC_DAIFMT_FORMAT_MASK
;
337 case SND_SOC_DAIFMT_LEFT_J
:
338 case SND_SOC_DAIFMT_I2S
:
348 static bool ak4613_dai_fmt_matching(const struct ak4613_interface
*iface
,
350 unsigned int fmt
, unsigned int width
)
352 const struct ak4613_formats
*fmts
;
354 fmts
= (is_play
) ? &iface
->playback
: &iface
->capture
;
356 if (fmts
->fmt
!= fmt
)
359 if (fmts
->width
!= width
)
365 static int ak4613_dai_hw_params(struct snd_pcm_substream
*substream
,
366 struct snd_pcm_hw_params
*params
,
367 struct snd_soc_dai
*dai
)
369 struct snd_soc_component
*component
= dai
->component
;
370 struct ak4613_priv
*priv
= snd_soc_component_get_drvdata(component
);
371 const struct ak4613_interface
*iface
;
372 struct device
*dev
= component
->dev
;
373 unsigned int width
= params_width(params
);
374 unsigned int fmt
= priv
->fmt
;
376 int is_play
= substream
->stream
== SNDRV_PCM_STREAM_PLAYBACK
;
380 rate
= params_rate(params
);
385 ctrl2
= DFS_NORMAL_SPEED
;
390 ctrl2
= DFS_DOUBLE_SPEED
;
394 ctrl2
= DFS_QUAD_SPEED
;
404 * It doesn't support TDM at this point
410 mutex_lock(&priv
->lock
);
412 if (ak4613_dai_fmt_matching(priv
->iface
, is_play
, fmt
, width
))
415 for (i
= ARRAY_SIZE(ak4613_iface
) - 1; i
>= 0; i
--) {
416 if (!ak4613_dai_fmt_matching(ak4613_iface
+ i
,
420 iface
= ak4613_iface
+ i
;
425 if ((priv
->iface
== NULL
) ||
426 (priv
->iface
== iface
)) {
430 mutex_unlock(&priv
->lock
);
435 fmt_ctrl
= AUDIO_IFACE_TO_VAL(iface
);
437 snd_soc_component_update_bits(component
, CTRL1
, FMT_MASK
, fmt_ctrl
);
438 snd_soc_component_update_bits(component
, CTRL2
, DFS_MASK
, ctrl2
);
440 snd_soc_component_update_bits(component
, ICTRL
, ICTRL_MASK
, priv
->ic
);
441 snd_soc_component_update_bits(component
, OCTRL
, OCTRL_MASK
, priv
->oc
);
445 dev_warn(dev
, "unsupported data width/format combination\n");
450 static int ak4613_set_bias_level(struct snd_soc_component
*component
,
451 enum snd_soc_bias_level level
)
456 case SND_SOC_BIAS_ON
:
459 case SND_SOC_BIAS_PREPARE
:
460 mgmt1
|= PMADC
| PMDAC
;
462 case SND_SOC_BIAS_STANDBY
:
465 case SND_SOC_BIAS_OFF
:
470 snd_soc_component_write(component
, PW_MGMT1
, mgmt1
);
475 static void ak4613_dummy_write(struct work_struct
*work
)
477 struct ak4613_priv
*priv
= container_of(work
,
480 struct snd_soc_component
*component
= priv
->component
;
485 * PW_MGMT1 / PW_MGMT3 needs dummy write at least after 5 LR clocks
489 * To avoid extra delay, we want to avoid preemption here,
490 * but we can't. Because it uses I2C access which is using IRQ
491 * and sleep. Thus, delay might be more than 5 LR clocks
493 * ak4613_dai_trigger()
495 udelay(5000000 / priv
->rate
);
497 snd_soc_component_read(component
, PW_MGMT1
, &mgmt1
);
498 snd_soc_component_read(component
, PW_MGMT3
, &mgmt3
);
500 snd_soc_component_write(component
, PW_MGMT1
, mgmt1
);
501 snd_soc_component_write(component
, PW_MGMT3
, mgmt3
);
504 static int ak4613_dai_trigger(struct snd_pcm_substream
*substream
, int cmd
,
505 struct snd_soc_dai
*dai
)
507 struct snd_soc_component
*component
= dai
->component
;
508 struct ak4613_priv
*priv
= snd_soc_component_get_drvdata(component
);
513 * PW_MGMT1 / PW_MGMT3 needs dummy write at least after 5 LR clocks
514 * from Power Down Release. Otherwise, Playback volume will be 0dB.
515 * To avoid complex multiple delay/dummy_write method from
516 * ak4613_set_bias_level() / SND_SOC_DAPM_DAC_E("DACx", ...),
519 * But, unfortunately, we can't "write" here because here is atomic
520 * context (It uses I2C access for writing).
521 * Thus, use schedule_work() to switching to normal context
526 * Calling ak4613_dummy_write() function might be delayed.
527 * In such case, ak4613 volume might be temporarily 0dB when
528 * beggining of playback.
530 * ak4613_dummy_write()
533 if ((cmd
!= SNDRV_PCM_TRIGGER_START
) &&
534 (cmd
!= SNDRV_PCM_TRIGGER_RESUME
))
537 if (substream
->stream
!= SNDRV_PCM_STREAM_PLAYBACK
)
540 priv
->component
= component
;
541 schedule_work(&priv
->dummy_write_work
);
546 static const struct snd_soc_dai_ops ak4613_dai_ops
= {
547 .startup
= ak4613_dai_startup
,
548 .shutdown
= ak4613_dai_shutdown
,
549 .set_sysclk
= ak4613_dai_set_sysclk
,
550 .set_fmt
= ak4613_dai_set_fmt
,
551 .trigger
= ak4613_dai_trigger
,
552 .hw_params
= ak4613_dai_hw_params
,
555 #define AK4613_PCM_RATE (SNDRV_PCM_RATE_32000 |\
556 SNDRV_PCM_RATE_44100 |\
557 SNDRV_PCM_RATE_48000 |\
558 SNDRV_PCM_RATE_64000 |\
559 SNDRV_PCM_RATE_88200 |\
560 SNDRV_PCM_RATE_96000 |\
561 SNDRV_PCM_RATE_176400 |\
562 SNDRV_PCM_RATE_192000)
563 #define AK4613_PCM_FMTBIT (SNDRV_PCM_FMTBIT_S24_LE)
565 static struct snd_soc_dai_driver ak4613_dai
= {
566 .name
= "ak4613-hifi",
568 .stream_name
= "Playback",
571 .rates
= AK4613_PCM_RATE
,
572 .formats
= AK4613_PCM_FMTBIT
,
575 .stream_name
= "Capture",
578 .rates
= AK4613_PCM_RATE
,
579 .formats
= AK4613_PCM_FMTBIT
,
581 .ops
= &ak4613_dai_ops
,
582 .symmetric_rates
= 1,
585 static int ak4613_suspend(struct snd_soc_component
*component
)
587 struct regmap
*regmap
= dev_get_regmap(component
->dev
, NULL
);
589 regcache_cache_only(regmap
, true);
590 regcache_mark_dirty(regmap
);
594 static int ak4613_resume(struct snd_soc_component
*component
)
596 struct regmap
*regmap
= dev_get_regmap(component
->dev
, NULL
);
598 regcache_cache_only(regmap
, false);
599 return regcache_sync(regmap
);
602 static const struct snd_soc_component_driver soc_component_dev_ak4613
= {
603 .suspend
= ak4613_suspend
,
604 .resume
= ak4613_resume
,
605 .set_bias_level
= ak4613_set_bias_level
,
606 .controls
= ak4613_snd_controls
,
607 .num_controls
= ARRAY_SIZE(ak4613_snd_controls
),
608 .dapm_widgets
= ak4613_dapm_widgets
,
609 .num_dapm_widgets
= ARRAY_SIZE(ak4613_dapm_widgets
),
610 .dapm_routes
= ak4613_intercon
,
611 .num_dapm_routes
= ARRAY_SIZE(ak4613_intercon
),
614 .non_legacy_dai_naming
= 1,
617 static void ak4613_parse_of(struct ak4613_priv
*priv
,
620 struct device_node
*np
= dev
->of_node
;
625 for (i
= 0; i
< 2; i
++) {
626 snprintf(prop
, sizeof(prop
), "asahi-kasei,in%d-single-end", i
+ 1);
627 if (!of_get_property(np
, prop
, NULL
))
632 for (i
= 0; i
< 6; i
++) {
633 snprintf(prop
, sizeof(prop
), "asahi-kasei,out%d-single-end", i
+ 1);
634 if (!of_get_property(np
, prop
, NULL
))
639 static int ak4613_i2c_probe(struct i2c_client
*i2c
,
640 const struct i2c_device_id
*id
)
642 struct device
*dev
= &i2c
->dev
;
643 struct device_node
*np
= dev
->of_node
;
644 const struct regmap_config
*regmap_cfg
;
645 struct regmap
*regmap
;
646 struct ak4613_priv
*priv
;
650 const struct of_device_id
*of_id
;
652 of_id
= of_match_device(ak4613_of_match
, dev
);
654 regmap_cfg
= of_id
->data
;
656 regmap_cfg
= (const struct regmap_config
*)id
->driver_data
;
662 priv
= devm_kzalloc(dev
, sizeof(*priv
), GFP_KERNEL
);
666 ak4613_parse_of(priv
, dev
);
671 INIT_WORK(&priv
->dummy_write_work
, ak4613_dummy_write
);
673 mutex_init(&priv
->lock
);
675 i2c_set_clientdata(i2c
, priv
);
677 regmap
= devm_regmap_init_i2c(i2c
, regmap_cfg
);
679 return PTR_ERR(regmap
);
681 return devm_snd_soc_register_component(dev
, &soc_component_dev_ak4613
,
685 static int ak4613_i2c_remove(struct i2c_client
*client
)
690 static struct i2c_driver ak4613_i2c_driver
= {
692 .name
= "ak4613-codec",
693 .of_match_table
= ak4613_of_match
,
695 .probe
= ak4613_i2c_probe
,
696 .remove
= ak4613_i2c_remove
,
697 .id_table
= ak4613_i2c_id
,
700 module_i2c_driver(ak4613_i2c_driver
);
702 MODULE_DESCRIPTION("Soc AK4613 driver");
703 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");
704 MODULE_LICENSE("GPL v2");