1 // SPDX-License-Identifier: GPL-2.0
3 // Driver for the Texas Instruments TAS2562 CODEC
4 // Copyright (C) 2019 Texas Instruments Inc.
7 #include <linux/module.h>
8 #include <linux/errno.h>
9 #include <linux/device.h>
10 #include <linux/i2c.h>
11 #include <linux/pm_runtime.h>
12 #include <linux/regmap.h>
13 #include <linux/slab.h>
14 #include <linux/gpio/consumer.h>
15 #include <linux/regulator/consumer.h>
16 #include <linux/delay.h>
18 #include <sound/pcm.h>
19 #include <sound/pcm_params.h>
20 #include <sound/soc.h>
21 #include <sound/soc-dapm.h>
22 #include <sound/tlv.h>
26 #define TAS2562_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S24_LE |\
27 SNDRV_PCM_FORMAT_S32_LE)
29 /* DVC equation involves floating point math
30 * round(10^(volume in dB/20)*2^30)
31 * so create a lookup table for 2dB step
33 static const unsigned int float_vol_db_lookup[] = {
34 0x00000d43, 0x000010b2, 0x00001505, 0x00001a67, 0x00002151,
35 0x000029f1, 0x000034cd, 0x00004279, 0x000053af, 0x0000695b,
36 0x0000695b, 0x0000a6fa, 0x0000d236, 0x000108a4, 0x00014d2a,
37 0x0001a36e, 0x00021008, 0x000298c0, 0x000344df, 0x00041d8f,
38 0x00052e5a, 0x000685c8, 0x00083621, 0x000a566d, 0x000d03a7,
39 0x0010624d, 0x0014a050, 0x0019f786, 0x0020b0bc, 0x0029279d,
40 0x0033cf8d, 0x004139d3, 0x00521d50, 0x00676044, 0x0082248a,
41 0x00a3d70a, 0x00ce4328, 0x0103ab3d, 0x0146e75d, 0x019b8c27,
42 0x02061b89, 0x028c423f, 0x03352529, 0x0409c2b0, 0x05156d68,
43 0x080e9f96, 0x0a24b062, 0x0cc509ab, 0x10137987, 0x143d1362,
44 0x197a967f, 0x2013739e, 0x28619ae9, 0x32d64617, 0x40000000
48 struct snd_soc_component *component;
49 struct gpio_desc *sdz_gpio;
50 struct regmap *regmap;
52 struct i2c_client *client;
58 static int tas2562_set_bias_level(struct snd_soc_component *component,
59 enum snd_soc_bias_level level)
61 struct tas2562_data *tas2562 =
62 snd_soc_component_get_drvdata(component);
66 snd_soc_component_update_bits(component,
68 TAS2562_MODE_MASK, TAS2562_ACTIVE);
70 case SND_SOC_BIAS_STANDBY:
71 case SND_SOC_BIAS_PREPARE:
72 snd_soc_component_update_bits(component,
74 TAS2562_MODE_MASK, TAS2562_MUTE);
76 case SND_SOC_BIAS_OFF:
77 snd_soc_component_update_bits(component,
79 TAS2562_MODE_MASK, TAS2562_SHUTDOWN);
84 "wrong power level setting %d\n", level);
91 static int tas2562_set_samplerate(struct tas2562_data *tas2562, int samplerate)
98 ramp_rate = TAS2562_TDM_CFG0_RAMPRATE_44_1;
99 samp_rate = TAS2562_TDM_CFG0_SAMPRATE_7305_8KHZ;
103 samp_rate = TAS2562_TDM_CFG0_SAMPRATE_7305_8KHZ;
106 ramp_rate = TAS2562_TDM_CFG0_RAMPRATE_44_1;
107 samp_rate = TAS2562_TDM_CFG0_SAMPRATE_14_7_16KHZ;
111 samp_rate = TAS2562_TDM_CFG0_SAMPRATE_14_7_16KHZ;
114 ramp_rate = TAS2562_TDM_CFG0_RAMPRATE_44_1;
115 samp_rate = TAS2562_TDM_CFG0_SAMPRATE_22_05_24KHZ;
119 samp_rate = TAS2562_TDM_CFG0_SAMPRATE_22_05_24KHZ;
122 ramp_rate = TAS2562_TDM_CFG0_RAMPRATE_44_1;
123 samp_rate = TAS2562_TDM_CFG0_SAMPRATE_29_4_32KHZ;
127 samp_rate = TAS2562_TDM_CFG0_SAMPRATE_29_4_32KHZ;
130 ramp_rate = TAS2562_TDM_CFG0_RAMPRATE_44_1;
131 samp_rate = TAS2562_TDM_CFG0_SAMPRATE_44_1_48KHZ;
135 samp_rate = TAS2562_TDM_CFG0_SAMPRATE_44_1_48KHZ;
138 ramp_rate = TAS2562_TDM_CFG0_RAMPRATE_44_1;
139 samp_rate = TAS2562_TDM_CFG0_SAMPRATE_88_2_96KHZ;
143 samp_rate = TAS2562_TDM_CFG0_SAMPRATE_88_2_96KHZ;
146 ramp_rate = TAS2562_TDM_CFG0_RAMPRATE_44_1;
147 samp_rate = TAS2562_TDM_CFG0_SAMPRATE_176_4_192KHZ;
151 samp_rate = TAS2562_TDM_CFG0_SAMPRATE_176_4_192KHZ;
154 dev_info(tas2562->dev, "%s, unsupported sample rate, %d\n",
155 __func__, samplerate);
159 snd_soc_component_update_bits(tas2562->component, TAS2562_TDM_CFG0,
160 TAS2562_TDM_CFG0_RAMPRATE_MASK, ramp_rate);
161 snd_soc_component_update_bits(tas2562->component, TAS2562_TDM_CFG0,
162 TAS2562_TDM_CFG0_SAMPRATE_MASK, samp_rate);
167 static int tas2562_set_dai_tdm_slot(struct snd_soc_dai *dai,
168 unsigned int tx_mask, unsigned int rx_mask,
169 int slots, int slot_width)
171 struct snd_soc_component *component = dai->component;
172 struct tas2562_data *tas2562 = snd_soc_component_get_drvdata(component);
175 switch (slot_width) {
177 ret = snd_soc_component_update_bits(component,
179 TAS2562_TDM_CFG2_RXLEN_MASK,
180 TAS2562_TDM_CFG2_RXLEN_16B);
183 ret = snd_soc_component_update_bits(component,
185 TAS2562_TDM_CFG2_RXLEN_MASK,
186 TAS2562_TDM_CFG2_RXLEN_24B);
189 ret = snd_soc_component_update_bits(component,
191 TAS2562_TDM_CFG2_RXLEN_MASK,
192 TAS2562_TDM_CFG2_RXLEN_32B);
196 /* Do not change slot width */
199 dev_err(tas2562->dev, "slot width not supported");
209 static int tas2562_set_bitwidth(struct tas2562_data *tas2562, int bitwidth)
214 case SNDRV_PCM_FORMAT_S16_LE:
215 snd_soc_component_update_bits(tas2562->component,
217 TAS2562_TDM_CFG2_RXWLEN_MASK,
218 TAS2562_TDM_CFG2_RXWLEN_16B);
219 tas2562->v_sense_slot = tas2562->i_sense_slot + 2;
221 case SNDRV_PCM_FORMAT_S24_LE:
222 snd_soc_component_update_bits(tas2562->component,
224 TAS2562_TDM_CFG2_RXWLEN_MASK,
225 TAS2562_TDM_CFG2_RXWLEN_24B);
226 tas2562->v_sense_slot = tas2562->i_sense_slot + 4;
228 case SNDRV_PCM_FORMAT_S32_LE:
229 snd_soc_component_update_bits(tas2562->component,
231 TAS2562_TDM_CFG2_RXWLEN_MASK,
232 TAS2562_TDM_CFG2_RXWLEN_32B);
233 tas2562->v_sense_slot = tas2562->i_sense_slot + 4;
237 dev_info(tas2562->dev, "Unsupported bitwidth format\n");
241 ret = snd_soc_component_update_bits(tas2562->component,
243 TAS2562_TDM_CFG5_VSNS_EN | TAS2562_TDM_CFG5_VSNS_SLOT_MASK,
244 TAS2562_TDM_CFG5_VSNS_EN | tas2562->v_sense_slot);
248 ret = snd_soc_component_update_bits(tas2562->component,
250 TAS2562_TDM_CFG6_ISNS_EN | TAS2562_TDM_CFG6_ISNS_SLOT_MASK,
251 TAS2562_TDM_CFG6_ISNS_EN | tas2562->i_sense_slot);
258 static int tas2562_hw_params(struct snd_pcm_substream *substream,
259 struct snd_pcm_hw_params *params,
260 struct snd_soc_dai *dai)
262 struct snd_soc_component *component = dai->component;
263 struct tas2562_data *tas2562 = snd_soc_component_get_drvdata(component);
266 ret = tas2562_set_bitwidth(tas2562, params_format(params));
268 dev_err(tas2562->dev, "set bitwidth failed, %d\n", ret);
272 ret = tas2562_set_samplerate(tas2562, params_rate(params));
274 dev_err(tas2562->dev, "set bitwidth failed, %d\n", ret);
279 static int tas2562_set_dai_fmt(struct snd_soc_dai *dai, unsigned int fmt)
281 struct snd_soc_component *component = dai->component;
282 struct tas2562_data *tas2562 = snd_soc_component_get_drvdata(component);
283 u8 tdm_rx_start_slot = 0, asi_cfg_1 = 0;
286 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
287 case SND_SOC_DAIFMT_NB_NF:
290 case SND_SOC_DAIFMT_IB_NF:
291 asi_cfg_1 |= TAS2562_TDM_CFG1_RX_FALLING;
294 dev_err(tas2562->dev, "ASI format Inverse is not found\n");
298 ret = snd_soc_component_update_bits(component, TAS2562_TDM_CFG1,
299 TAS2562_TDM_CFG1_RX_EDGE_MASK,
302 dev_err(tas2562->dev, "Failed to set RX edge\n");
306 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
307 case (SND_SOC_DAIFMT_I2S):
308 case (SND_SOC_DAIFMT_DSP_A):
309 case (SND_SOC_DAIFMT_DSP_B):
310 tdm_rx_start_slot = BIT(1);
312 case (SND_SOC_DAIFMT_LEFT_J):
313 tdm_rx_start_slot = 0;
316 dev_err(tas2562->dev, "DAI Format is not found, fmt=0x%x\n",
322 ret = snd_soc_component_update_bits(component, TAS2562_TDM_CFG1,
323 TAS2562_TDM_CFG1_RX_OFFSET_MASK,
332 static int tas2562_mute(struct snd_soc_dai *dai, int mute)
334 struct snd_soc_component *component = dai->component;
336 return snd_soc_component_update_bits(component, TAS2562_PWR_CTRL,
338 mute ? TAS2562_MUTE : 0);
341 static int tas2562_codec_probe(struct snd_soc_component *component)
343 struct tas2562_data *tas2562 = snd_soc_component_get_drvdata(component);
346 tas2562->component = component;
348 if (tas2562->sdz_gpio)
349 gpiod_set_value_cansleep(tas2562->sdz_gpio, 1);
351 ret = snd_soc_component_update_bits(component, TAS2562_PWR_CTRL,
352 TAS2562_MODE_MASK, TAS2562_MUTE);
360 static int tas2562_suspend(struct snd_soc_component *component)
362 struct tas2562_data *tas2562 = snd_soc_component_get_drvdata(component);
364 regcache_cache_only(tas2562->regmap, true);
365 regcache_mark_dirty(tas2562->regmap);
367 if (tas2562->sdz_gpio)
368 gpiod_set_value_cansleep(tas2562->sdz_gpio, 0);
373 static int tas2562_resume(struct snd_soc_component *component)
375 struct tas2562_data *tas2562 = snd_soc_component_get_drvdata(component);
377 if (tas2562->sdz_gpio)
378 gpiod_set_value_cansleep(tas2562->sdz_gpio, 1);
380 regcache_cache_only(tas2562->regmap, false);
382 return regcache_sync(tas2562->regmap);
385 #define tas2562_suspend NULL
386 #define tas2562_resume NULL
389 static const char * const tas2562_ASI1_src[] = {
390 "I2C offset", "Left", "Right", "LeftRightDiv2",
393 static SOC_ENUM_SINGLE_DECL(tas2562_ASI1_src_enum, TAS2562_TDM_CFG2, 4,
396 static const struct snd_kcontrol_new tas2562_asi1_mux =
397 SOC_DAPM_ENUM("ASI1 Source", tas2562_ASI1_src_enum);
399 static int tas2562_dac_event(struct snd_soc_dapm_widget *w,
400 struct snd_kcontrol *kcontrol, int event)
402 struct snd_soc_component *component =
403 snd_soc_dapm_to_component(w->dapm);
404 struct tas2562_data *tas2562 = snd_soc_component_get_drvdata(component);
408 case SND_SOC_DAPM_POST_PMU:
409 ret = snd_soc_component_update_bits(component,
416 case SND_SOC_DAPM_PRE_PMD:
417 ret = snd_soc_component_update_bits(component,
425 dev_err(tas2562->dev, "Not supported evevt\n");
436 static int tas2562_volume_control_get(struct snd_kcontrol *kcontrol,
437 struct snd_ctl_elem_value *ucontrol)
439 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
440 struct tas2562_data *tas2562 = snd_soc_component_get_drvdata(component);
442 ucontrol->value.integer.value[0] = tas2562->volume_lvl;
446 static int tas2562_volume_control_put(struct snd_kcontrol *kcontrol,
447 struct snd_ctl_elem_value *ucontrol)
449 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
450 struct tas2562_data *tas2562 = snd_soc_component_get_drvdata(component);
454 reg_val = float_vol_db_lookup[ucontrol->value.integer.value[0]/2];
455 ret = snd_soc_component_write(component, TAS2562_DVC_CFG4,
459 ret = snd_soc_component_write(component, TAS2562_DVC_CFG3,
460 ((reg_val >> 8) & 0xff));
463 ret = snd_soc_component_write(component, TAS2562_DVC_CFG2,
464 ((reg_val >> 16) & 0xff));
467 ret = snd_soc_component_write(component, TAS2562_DVC_CFG1,
468 ((reg_val >> 24) & 0xff));
472 tas2562->volume_lvl = ucontrol->value.integer.value[0];
477 /* Digital Volume Control. From 0 dB to -110 dB in 1 dB steps */
478 static const DECLARE_TLV_DB_SCALE(dvc_tlv, -11000, 100, 0);
480 static DECLARE_TLV_DB_SCALE(tas2562_dac_tlv, 850, 50, 0);
482 static const struct snd_kcontrol_new isense_switch =
483 SOC_DAPM_SINGLE("Switch", TAS2562_PWR_CTRL, TAS2562_ISENSE_POWER_EN,
486 static const struct snd_kcontrol_new vsense_switch =
487 SOC_DAPM_SINGLE("Switch", TAS2562_PWR_CTRL, TAS2562_VSENSE_POWER_EN,
490 static const struct snd_kcontrol_new tas2562_snd_controls[] = {
491 SOC_SINGLE_TLV("Amp Gain Volume", TAS2562_PB_CFG1, 0, 0x1c, 0,
494 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
495 .name = "Digital Volume Control",
498 .access = SNDRV_CTL_ELEM_ACCESS_TLV_READ | SNDRV_CTL_ELEM_ACCESS_READWRITE,
499 .info = snd_soc_info_volsw,
500 .get = tas2562_volume_control_get,
501 .put = tas2562_volume_control_put,
502 .private_value = SOC_SINGLE_VALUE(TAS2562_DVC_CFG1, 0, 110, 0, 0) ,
506 static const struct snd_soc_dapm_widget tas2562_dapm_widgets[] = {
507 SND_SOC_DAPM_AIF_IN("ASI1", "ASI1 Playback", 0, SND_SOC_NOPM, 0, 0),
508 SND_SOC_DAPM_MUX("ASI1 Sel", SND_SOC_NOPM, 0, 0, &tas2562_asi1_mux),
509 SND_SOC_DAPM_DAC_E("DAC", NULL, SND_SOC_NOPM, 0, 0, tas2562_dac_event,
510 SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD),
511 SND_SOC_DAPM_SWITCH("ISENSE", TAS2562_PWR_CTRL, 3, 1, &isense_switch),
512 SND_SOC_DAPM_SWITCH("VSENSE", TAS2562_PWR_CTRL, 2, 1, &vsense_switch),
513 SND_SOC_DAPM_SIGGEN("VMON"),
514 SND_SOC_DAPM_SIGGEN("IMON"),
515 SND_SOC_DAPM_OUTPUT("OUT"),
518 static const struct snd_soc_dapm_route tas2562_audio_map[] = {
519 {"ASI1 Sel", "I2C offset", "ASI1"},
520 {"ASI1 Sel", "Left", "ASI1"},
521 {"ASI1 Sel", "Right", "ASI1"},
522 {"ASI1 Sel", "LeftRightDiv2", "ASI1"},
523 { "DAC", NULL, "ASI1 Sel" },
524 { "OUT", NULL, "DAC" },
525 {"ISENSE", "Switch", "IMON"},
526 {"VSENSE", "Switch", "VMON"},
529 static const struct snd_soc_component_driver soc_component_dev_tas2562 = {
530 .probe = tas2562_codec_probe,
531 .suspend = tas2562_suspend,
532 .resume = tas2562_resume,
533 .set_bias_level = tas2562_set_bias_level,
534 .controls = tas2562_snd_controls,
535 .num_controls = ARRAY_SIZE(tas2562_snd_controls),
536 .dapm_widgets = tas2562_dapm_widgets,
537 .num_dapm_widgets = ARRAY_SIZE(tas2562_dapm_widgets),
538 .dapm_routes = tas2562_audio_map,
539 .num_dapm_routes = ARRAY_SIZE(tas2562_audio_map),
541 .use_pmdown_time = 1,
543 .non_legacy_dai_naming = 1,
546 static const struct snd_soc_dai_ops tas2562_speaker_dai_ops = {
547 .hw_params = tas2562_hw_params,
548 .set_fmt = tas2562_set_dai_fmt,
549 .set_tdm_slot = tas2562_set_dai_tdm_slot,
550 .digital_mute = tas2562_mute,
553 static struct snd_soc_dai_driver tas2562_dai[] = {
555 .name = "tas2562-amplifier",
558 .stream_name = "ASI1 Playback",
561 .rates = SNDRV_PCM_RATE_8000_192000,
562 .formats = TAS2562_FORMATS,
565 .stream_name = "ASI1 Capture",
568 .rates = SNDRV_PCM_RATE_8000_192000,
569 .formats = TAS2562_FORMATS,
571 .ops = &tas2562_speaker_dai_ops,
575 static const struct regmap_range_cfg tas2562_ranges[] = {
578 .range_max = 5 * 128,
579 .selector_reg = TAS2562_PAGE_CTRL,
580 .selector_mask = 0xff,
587 static const struct reg_default tas2562_reg_defaults[] = {
588 { TAS2562_PAGE_CTRL, 0x00 },
589 { TAS2562_SW_RESET, 0x00 },
590 { TAS2562_PWR_CTRL, 0x0e },
591 { TAS2562_PB_CFG1, 0x20 },
592 { TAS2562_TDM_CFG0, 0x09 },
593 { TAS2562_TDM_CFG1, 0x02 },
594 { TAS2562_DVC_CFG1, 0x40 },
595 { TAS2562_DVC_CFG2, 0x40 },
596 { TAS2562_DVC_CFG3, 0x00 },
597 { TAS2562_DVC_CFG4, 0x00 },
600 static const struct regmap_config tas2562_regmap_config = {
604 .max_register = 5 * 128,
605 .cache_type = REGCACHE_RBTREE,
606 .reg_defaults = tas2562_reg_defaults,
607 .num_reg_defaults = ARRAY_SIZE(tas2562_reg_defaults),
608 .ranges = tas2562_ranges,
609 .num_ranges = ARRAY_SIZE(tas2562_ranges),
612 static int tas2562_parse_dt(struct tas2562_data *tas2562)
614 struct device *dev = tas2562->dev;
617 tas2562->sdz_gpio = devm_gpiod_get_optional(dev, "shut-down-gpio",
619 if (IS_ERR(tas2562->sdz_gpio)) {
620 if (PTR_ERR(tas2562->sdz_gpio) == -EPROBE_DEFER) {
621 tas2562->sdz_gpio = NULL;
622 return -EPROBE_DEFER;
626 ret = fwnode_property_read_u32(dev->fwnode, "ti,imon-slot-no",
627 &tas2562->i_sense_slot);
629 dev_err(dev, "Looking up %s property failed %d\n",
630 "ti,imon-slot-no", ret);
635 static int tas2562_probe(struct i2c_client *client,
636 const struct i2c_device_id *id)
638 struct device *dev = &client->dev;
639 struct tas2562_data *data;
642 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
646 data->client = client;
647 data->dev = &client->dev;
649 tas2562_parse_dt(data);
651 data->regmap = devm_regmap_init_i2c(client, &tas2562_regmap_config);
652 if (IS_ERR(data->regmap)) {
653 ret = PTR_ERR(data->regmap);
654 dev_err(dev, "failed to allocate register map: %d\n", ret);
658 dev_set_drvdata(&client->dev, data);
660 return devm_snd_soc_register_component(dev, &soc_component_dev_tas2562,
662 ARRAY_SIZE(tas2562_dai));
666 static const struct i2c_device_id tas2562_id[] = {
670 MODULE_DEVICE_TABLE(i2c, tas2562_id);
672 static const struct of_device_id tas2562_of_match[] = {
673 { .compatible = "ti,tas2562", },
676 MODULE_DEVICE_TABLE(of, tas2562_of_match);
678 static struct i2c_driver tas2562_i2c_driver = {
681 .of_match_table = of_match_ptr(tas2562_of_match),
683 .probe = tas2562_probe,
684 .id_table = tas2562_id,
687 module_i2c_driver(tas2562_i2c_driver);
689 MODULE_AUTHOR("Dan Murphy <dmurphy@ti.com>");
690 MODULE_DESCRIPTION("TAS2562 Audio amplifier driver");
691 MODULE_LICENSE("GPL");