2 * tas5720.c - ALSA SoC Texas Instruments TAS5720 Mono Audio Amplifier
4 * Copyright (C)2015-2016 Texas Instruments Incorporated - http://www.ti.com
6 * Author: Andreas Dannenberg <dannenberg@ti.com>
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * version 2 as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License for more details.
18 #include <linux/module.h>
19 #include <linux/errno.h>
20 #include <linux/device.h>
21 #include <linux/i2c.h>
22 #include <linux/pm_runtime.h>
23 #include <linux/regmap.h>
24 #include <linux/slab.h>
25 #include <linux/regulator/consumer.h>
26 #include <linux/delay.h>
28 #include <sound/pcm.h>
29 #include <sound/pcm_params.h>
30 #include <sound/soc.h>
31 #include <sound/soc-dapm.h>
32 #include <sound/tlv.h>
36 /* Define how often to check (and clear) the fault status register (in ms) */
37 #define TAS5720_FAULT_CHECK_INTERVAL 200
44 static const char * const tas5720_supply_names[] = {
45 "dvdd", /* Digital power supply. Connect to 3.3-V supply. */
46 "pvdd", /* Class-D amp and analog power supply (connected). */
49 #define TAS5720_NUM_SUPPLIES ARRAY_SIZE(tas5720_supply_names)
52 struct snd_soc_component *component;
53 struct regmap *regmap;
54 struct i2c_client *tas5720_client;
55 enum tas572x_type devtype;
56 struct regulator_bulk_data supplies[TAS5720_NUM_SUPPLIES];
57 struct delayed_work fault_check_work;
58 unsigned int last_fault;
61 static int tas5720_hw_params(struct snd_pcm_substream *substream,
62 struct snd_pcm_hw_params *params,
63 struct snd_soc_dai *dai)
65 struct snd_soc_component *component = dai->component;
66 unsigned int rate = params_rate(params);
80 dev_err(component->dev, "unsupported sample rate: %u\n", rate);
84 ret = snd_soc_component_update_bits(component, TAS5720_DIGITAL_CTRL1_REG,
85 TAS5720_SSZ_DS, ssz_ds);
87 dev_err(component->dev, "error setting sample rate: %d\n", ret);
94 static int tas5720_set_dai_fmt(struct snd_soc_dai *dai, unsigned int fmt)
96 struct snd_soc_component *component = dai->component;
100 if ((fmt & SND_SOC_DAIFMT_MASTER_MASK) != SND_SOC_DAIFMT_CBS_CFS) {
101 dev_vdbg(component->dev, "DAI Format master is not found\n");
105 switch (fmt & (SND_SOC_DAIFMT_FORMAT_MASK |
106 SND_SOC_DAIFMT_INV_MASK)) {
107 case (SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_NB_NF):
108 /* 1st data bit occur one BCLK cycle after the frame sync */
109 serial_format = TAS5720_SAIF_I2S;
111 case (SND_SOC_DAIFMT_DSP_A | SND_SOC_DAIFMT_NB_NF):
113 * Note that although the TAS5720 does not have a dedicated DSP
114 * mode it doesn't care about the LRCLK duty cycle during TDM
115 * operation. Therefore we can use the device's I2S mode with
116 * its delaying of the 1st data bit to receive DSP_A formatted
117 * data. See device datasheet for additional details.
119 serial_format = TAS5720_SAIF_I2S;
121 case (SND_SOC_DAIFMT_DSP_B | SND_SOC_DAIFMT_NB_NF):
123 * Similar to DSP_A, we can use the fact that the TAS5720 does
124 * not care about the LRCLK duty cycle during TDM to receive
125 * DSP_B formatted data in LEFTJ mode (no delaying of the 1st
128 serial_format = TAS5720_SAIF_LEFTJ;
130 case (SND_SOC_DAIFMT_LEFT_J | SND_SOC_DAIFMT_NB_NF):
131 /* No delay after the frame sync */
132 serial_format = TAS5720_SAIF_LEFTJ;
135 dev_vdbg(component->dev, "DAI Format is not found\n");
139 ret = snd_soc_component_update_bits(component, TAS5720_DIGITAL_CTRL1_REG,
140 TAS5720_SAIF_FORMAT_MASK,
143 dev_err(component->dev, "error setting SAIF format: %d\n", ret);
150 static int tas5720_set_dai_tdm_slot(struct snd_soc_dai *dai,
151 unsigned int tx_mask, unsigned int rx_mask,
152 int slots, int slot_width)
154 struct snd_soc_component *component = dai->component;
155 struct tas5720_data *tas5720 = snd_soc_component_get_drvdata(component);
156 unsigned int first_slot;
160 dev_err(component->dev, "tx masks must not be 0\n");
165 * Determine the first slot that is being requested. We will only
166 * use the first slot that is found since the TAS5720 is a mono
169 first_slot = __ffs(tx_mask);
171 if (first_slot > 7) {
172 dev_err(component->dev, "slot selection out of bounds (%u)\n",
177 /* Enable manual TDM slot selection (instead of I2C ID based) */
178 ret = snd_soc_component_update_bits(component, TAS5720_DIGITAL_CTRL1_REG,
179 TAS5720_TDM_CFG_SRC, TAS5720_TDM_CFG_SRC);
181 goto error_snd_soc_component_update_bits;
183 /* Configure the TDM slot to process audio from */
184 ret = snd_soc_component_update_bits(component, TAS5720_DIGITAL_CTRL2_REG,
185 TAS5720_TDM_SLOT_SEL_MASK, first_slot);
187 goto error_snd_soc_component_update_bits;
189 /* Configure TDM slot width. This is only applicable to TAS5722. */
190 switch (tas5720->devtype) {
192 ret = snd_soc_component_update_bits(component, TAS5722_DIGITAL_CTRL2_REG,
193 TAS5722_TDM_SLOT_16B,
195 TAS5722_TDM_SLOT_16B : 0);
197 goto error_snd_soc_component_update_bits;
205 error_snd_soc_component_update_bits:
206 dev_err(component->dev, "error configuring TDM mode: %d\n", ret);
210 static int tas5720_mute(struct snd_soc_dai *dai, int mute)
212 struct snd_soc_component *component = dai->component;
215 ret = snd_soc_component_update_bits(component, TAS5720_DIGITAL_CTRL2_REG,
216 TAS5720_MUTE, mute ? TAS5720_MUTE : 0);
218 dev_err(component->dev, "error (un-)muting device: %d\n", ret);
225 static void tas5720_fault_check_work(struct work_struct *work)
227 struct tas5720_data *tas5720 = container_of(work, struct tas5720_data,
228 fault_check_work.work);
229 struct device *dev = tas5720->component->dev;
230 unsigned int curr_fault;
233 ret = regmap_read(tas5720->regmap, TAS5720_FAULT_REG, &curr_fault);
235 dev_err(dev, "failed to read FAULT register: %d\n", ret);
239 /* Check/handle all errors except SAIF clock errors */
240 curr_fault &= TAS5720_OCE | TAS5720_DCE | TAS5720_OTE;
243 * Only flag errors once for a given occurrence. This is needed as
244 * the TAS5720 will take time clearing the fault condition internally
245 * during which we don't want to bombard the system with the same
246 * error message over and over.
248 if ((curr_fault & TAS5720_OCE) && !(tas5720->last_fault & TAS5720_OCE))
249 dev_crit(dev, "experienced an over current hardware fault\n");
251 if ((curr_fault & TAS5720_DCE) && !(tas5720->last_fault & TAS5720_DCE))
252 dev_crit(dev, "experienced a DC detection fault\n");
254 if ((curr_fault & TAS5720_OTE) && !(tas5720->last_fault & TAS5720_OTE))
255 dev_crit(dev, "experienced an over temperature fault\n");
257 /* Store current fault value so we can detect any changes next time */
258 tas5720->last_fault = curr_fault;
264 * Periodically toggle SDZ (shutdown bit) H->L->H to clear any latching
265 * faults as long as a fault condition persists. Always going through
266 * the full sequence no matter the first return value to minimizes
267 * chances for the device to end up in shutdown mode.
269 ret = regmap_write_bits(tas5720->regmap, TAS5720_POWER_CTRL_REG,
272 dev_err(dev, "failed to write POWER_CTRL register: %d\n", ret);
274 ret = regmap_write_bits(tas5720->regmap, TAS5720_POWER_CTRL_REG,
275 TAS5720_SDZ, TAS5720_SDZ);
277 dev_err(dev, "failed to write POWER_CTRL register: %d\n", ret);
280 /* Schedule the next fault check at the specified interval */
281 schedule_delayed_work(&tas5720->fault_check_work,
282 msecs_to_jiffies(TAS5720_FAULT_CHECK_INTERVAL));
285 static int tas5720_codec_probe(struct snd_soc_component *component)
287 struct tas5720_data *tas5720 = snd_soc_component_get_drvdata(component);
288 unsigned int device_id, expected_device_id;
291 tas5720->component = component;
293 ret = regulator_bulk_enable(ARRAY_SIZE(tas5720->supplies),
296 dev_err(component->dev, "failed to enable supplies: %d\n", ret);
301 * Take a liberal approach to checking the device ID to allow the
302 * driver to be used even if the device ID does not match, however
303 * issue a warning if there is a mismatch.
305 ret = regmap_read(tas5720->regmap, TAS5720_DEVICE_ID_REG, &device_id);
307 dev_err(component->dev, "failed to read device ID register: %d\n",
312 switch (tas5720->devtype) {
314 expected_device_id = TAS5720_DEVICE_ID;
317 expected_device_id = TAS5722_DEVICE_ID;
320 dev_err(component->dev, "unexpected private driver data\n");
324 if (device_id != expected_device_id)
325 dev_warn(component->dev, "wrong device ID. expected: %u read: %u\n",
326 expected_device_id, device_id);
328 /* Set device to mute */
329 ret = snd_soc_component_update_bits(component, TAS5720_DIGITAL_CTRL2_REG,
330 TAS5720_MUTE, TAS5720_MUTE);
332 goto error_snd_soc_component_update_bits;
335 * Enter shutdown mode - our default when not playing audio - to
336 * minimize current consumption. On the TAS5720 there is no real down
337 * side doing so as all device registers are preserved and the wakeup
338 * of the codec is rather quick which we do using a dapm widget.
340 ret = snd_soc_component_update_bits(component, TAS5720_POWER_CTRL_REG,
343 goto error_snd_soc_component_update_bits;
345 INIT_DELAYED_WORK(&tas5720->fault_check_work, tas5720_fault_check_work);
349 error_snd_soc_component_update_bits:
350 dev_err(component->dev, "error configuring device registers: %d\n", ret);
353 regulator_bulk_disable(ARRAY_SIZE(tas5720->supplies),
358 static void tas5720_codec_remove(struct snd_soc_component *component)
360 struct tas5720_data *tas5720 = snd_soc_component_get_drvdata(component);
363 cancel_delayed_work_sync(&tas5720->fault_check_work);
365 ret = regulator_bulk_disable(ARRAY_SIZE(tas5720->supplies),
368 dev_err(component->dev, "failed to disable supplies: %d\n", ret);
371 static int tas5720_dac_event(struct snd_soc_dapm_widget *w,
372 struct snd_kcontrol *kcontrol, int event)
374 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
375 struct tas5720_data *tas5720 = snd_soc_component_get_drvdata(component);
378 if (event & SND_SOC_DAPM_POST_PMU) {
379 /* Take TAS5720 out of shutdown mode */
380 ret = snd_soc_component_update_bits(component, TAS5720_POWER_CTRL_REG,
381 TAS5720_SDZ, TAS5720_SDZ);
383 dev_err(component->dev, "error waking component: %d\n", ret);
388 * Observe codec shutdown-to-active time. The datasheet only
389 * lists a nominal value however just use-it as-is without
390 * additional padding to minimize the delay introduced in
391 * starting to play audio (actually there is other setup done
392 * by the ASoC framework that will provide additional delays,
393 * so we should always be safe).
397 /* Turn on TAS5720 periodic fault checking/handling */
398 tas5720->last_fault = 0;
399 schedule_delayed_work(&tas5720->fault_check_work,
400 msecs_to_jiffies(TAS5720_FAULT_CHECK_INTERVAL));
401 } else if (event & SND_SOC_DAPM_PRE_PMD) {
402 /* Disable TAS5720 periodic fault checking/handling */
403 cancel_delayed_work_sync(&tas5720->fault_check_work);
405 /* Place TAS5720 in shutdown mode to minimize current draw */
406 ret = snd_soc_component_update_bits(component, TAS5720_POWER_CTRL_REG,
409 dev_err(component->dev, "error shutting down component: %d\n",
419 static int tas5720_suspend(struct snd_soc_component *component)
421 struct tas5720_data *tas5720 = snd_soc_component_get_drvdata(component);
424 regcache_cache_only(tas5720->regmap, true);
425 regcache_mark_dirty(tas5720->regmap);
427 ret = regulator_bulk_disable(ARRAY_SIZE(tas5720->supplies),
430 dev_err(component->dev, "failed to disable supplies: %d\n", ret);
435 static int tas5720_resume(struct snd_soc_component *component)
437 struct tas5720_data *tas5720 = snd_soc_component_get_drvdata(component);
440 ret = regulator_bulk_enable(ARRAY_SIZE(tas5720->supplies),
443 dev_err(component->dev, "failed to enable supplies: %d\n", ret);
447 regcache_cache_only(tas5720->regmap, false);
449 ret = regcache_sync(tas5720->regmap);
451 dev_err(component->dev, "failed to sync regcache: %d\n", ret);
458 #define tas5720_suspend NULL
459 #define tas5720_resume NULL
462 static bool tas5720_is_volatile_reg(struct device *dev, unsigned int reg)
465 case TAS5720_DEVICE_ID_REG:
466 case TAS5720_FAULT_REG:
473 static const struct regmap_config tas5720_regmap_config = {
477 .max_register = TAS5720_MAX_REG,
478 .cache_type = REGCACHE_RBTREE,
479 .volatile_reg = tas5720_is_volatile_reg,
482 static const struct regmap_config tas5722_regmap_config = {
486 .max_register = TAS5722_MAX_REG,
487 .cache_type = REGCACHE_RBTREE,
488 .volatile_reg = tas5720_is_volatile_reg,
492 * DAC analog gain. There are four discrete values to select from, ranging
493 * from 19.2 dB to 26.3dB.
495 static const DECLARE_TLV_DB_RANGE(dac_analog_tlv,
496 0x0, 0x0, TLV_DB_SCALE_ITEM(1920, 0, 0),
497 0x1, 0x1, TLV_DB_SCALE_ITEM(2070, 0, 0),
498 0x2, 0x2, TLV_DB_SCALE_ITEM(2350, 0, 0),
499 0x3, 0x3, TLV_DB_SCALE_ITEM(2630, 0, 0),
503 * DAC digital volumes. From -103.5 to 24 dB in 0.5 dB or 0.25 dB steps
504 * depending on the device. Note that setting the gain below -100 dB
505 * (register value <0x7) is effectively a MUTE as per device datasheet.
507 * Note that for the TAS5722 the digital volume controls are actually split
508 * over two registers, so we need custom getters/setters for access.
510 static DECLARE_TLV_DB_SCALE(tas5720_dac_tlv, -10350, 50, 0);
511 static DECLARE_TLV_DB_SCALE(tas5722_dac_tlv, -10350, 25, 0);
513 static int tas5722_volume_get(struct snd_kcontrol *kcontrol,
514 struct snd_ctl_elem_value *ucontrol)
516 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
519 snd_soc_component_read(component, TAS5720_VOLUME_CTRL_REG, &val);
520 ucontrol->value.integer.value[0] = val << 1;
522 snd_soc_component_read(component, TAS5722_DIGITAL_CTRL2_REG, &val);
523 ucontrol->value.integer.value[0] |= val & TAS5722_VOL_CONTROL_LSB;
528 static int tas5722_volume_set(struct snd_kcontrol *kcontrol,
529 struct snd_ctl_elem_value *ucontrol)
531 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
532 unsigned int sel = ucontrol->value.integer.value[0];
534 snd_soc_component_write(component, TAS5720_VOLUME_CTRL_REG, sel >> 1);
535 snd_soc_component_update_bits(component, TAS5722_DIGITAL_CTRL2_REG,
536 TAS5722_VOL_CONTROL_LSB, sel);
541 static const struct snd_kcontrol_new tas5720_snd_controls[] = {
542 SOC_SINGLE_TLV("Speaker Driver Playback Volume",
543 TAS5720_VOLUME_CTRL_REG, 0, 0xff, 0, tas5720_dac_tlv),
544 SOC_SINGLE_TLV("Speaker Driver Analog Gain", TAS5720_ANALOG_CTRL_REG,
545 TAS5720_ANALOG_GAIN_SHIFT, 3, 0, dac_analog_tlv),
548 static const struct snd_kcontrol_new tas5722_snd_controls[] = {
549 SOC_SINGLE_EXT_TLV("Speaker Driver Playback Volume",
551 tas5722_volume_get, tas5722_volume_set,
553 SOC_SINGLE_TLV("Speaker Driver Analog Gain", TAS5720_ANALOG_CTRL_REG,
554 TAS5720_ANALOG_GAIN_SHIFT, 3, 0, dac_analog_tlv),
557 static const struct snd_soc_dapm_widget tas5720_dapm_widgets[] = {
558 SND_SOC_DAPM_AIF_IN("DAC IN", "Playback", 0, SND_SOC_NOPM, 0, 0),
559 SND_SOC_DAPM_DAC_E("DAC", NULL, SND_SOC_NOPM, 0, 0, tas5720_dac_event,
560 SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD),
561 SND_SOC_DAPM_OUTPUT("OUT")
564 static const struct snd_soc_dapm_route tas5720_audio_map[] = {
565 { "DAC", NULL, "DAC IN" },
566 { "OUT", NULL, "DAC" },
569 static const struct snd_soc_component_driver soc_component_dev_tas5720 = {
570 .probe = tas5720_codec_probe,
571 .remove = tas5720_codec_remove,
572 .suspend = tas5720_suspend,
573 .resume = tas5720_resume,
574 .controls = tas5720_snd_controls,
575 .num_controls = ARRAY_SIZE(tas5720_snd_controls),
576 .dapm_widgets = tas5720_dapm_widgets,
577 .num_dapm_widgets = ARRAY_SIZE(tas5720_dapm_widgets),
578 .dapm_routes = tas5720_audio_map,
579 .num_dapm_routes = ARRAY_SIZE(tas5720_audio_map),
581 .use_pmdown_time = 1,
583 .non_legacy_dai_naming = 1,
586 static const struct snd_soc_component_driver soc_component_dev_tas5722 = {
587 .probe = tas5720_codec_probe,
588 .remove = tas5720_codec_remove,
589 .suspend = tas5720_suspend,
590 .resume = tas5720_resume,
591 .controls = tas5722_snd_controls,
592 .num_controls = ARRAY_SIZE(tas5722_snd_controls),
593 .dapm_widgets = tas5720_dapm_widgets,
594 .num_dapm_widgets = ARRAY_SIZE(tas5720_dapm_widgets),
595 .dapm_routes = tas5720_audio_map,
596 .num_dapm_routes = ARRAY_SIZE(tas5720_audio_map),
598 .use_pmdown_time = 1,
600 .non_legacy_dai_naming = 1,
603 /* PCM rates supported by the TAS5720 driver */
604 #define TAS5720_RATES (SNDRV_PCM_RATE_44100 | SNDRV_PCM_RATE_48000 |\
605 SNDRV_PCM_RATE_88200 | SNDRV_PCM_RATE_96000)
607 /* Formats supported by TAS5720 driver */
608 #define TAS5720_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S18_3LE |\
609 SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S24_LE)
611 static const struct snd_soc_dai_ops tas5720_speaker_dai_ops = {
612 .hw_params = tas5720_hw_params,
613 .set_fmt = tas5720_set_dai_fmt,
614 .set_tdm_slot = tas5720_set_dai_tdm_slot,
615 .digital_mute = tas5720_mute,
619 * TAS5720 DAI structure
621 * Note that were are advertising .playback.channels_max = 2 despite this being
622 * a mono amplifier. The reason for that is that some serial ports such as TI's
623 * McASP module have a minimum number of channels (2) that they can output.
624 * Advertising more channels than we have will allow us to interface with such
625 * a serial port without really any negative side effects as the TAS5720 will
626 * simply ignore any extra channel(s) asides from the one channel that is
627 * configured to be played back.
629 static struct snd_soc_dai_driver tas5720_dai[] = {
631 .name = "tas5720-amplifier",
633 .stream_name = "Playback",
636 .rates = TAS5720_RATES,
637 .formats = TAS5720_FORMATS,
639 .ops = &tas5720_speaker_dai_ops,
643 static int tas5720_probe(struct i2c_client *client,
644 const struct i2c_device_id *id)
646 struct device *dev = &client->dev;
647 struct tas5720_data *data;
648 const struct regmap_config *regmap_config;
652 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
656 data->tas5720_client = client;
657 data->devtype = id->driver_data;
659 switch (id->driver_data) {
661 regmap_config = &tas5720_regmap_config;
664 regmap_config = &tas5722_regmap_config;
667 dev_err(dev, "unexpected private driver data\n");
670 data->regmap = devm_regmap_init_i2c(client, regmap_config);
671 if (IS_ERR(data->regmap)) {
672 ret = PTR_ERR(data->regmap);
673 dev_err(dev, "failed to allocate register map: %d\n", ret);
677 for (i = 0; i < ARRAY_SIZE(data->supplies); i++)
678 data->supplies[i].supply = tas5720_supply_names[i];
680 ret = devm_regulator_bulk_get(dev, ARRAY_SIZE(data->supplies),
683 dev_err(dev, "failed to request supplies: %d\n", ret);
687 dev_set_drvdata(dev, data);
689 switch (id->driver_data) {
691 ret = devm_snd_soc_register_component(&client->dev,
692 &soc_component_dev_tas5720,
694 ARRAY_SIZE(tas5720_dai));
697 ret = devm_snd_soc_register_component(&client->dev,
698 &soc_component_dev_tas5722,
700 ARRAY_SIZE(tas5720_dai));
703 dev_err(dev, "unexpected private driver data\n");
707 dev_err(dev, "failed to register component: %d\n", ret);
714 static const struct i2c_device_id tas5720_id[] = {
715 { "tas5720", TAS5720 },
716 { "tas5722", TAS5722 },
719 MODULE_DEVICE_TABLE(i2c, tas5720_id);
721 #if IS_ENABLED(CONFIG_OF)
722 static const struct of_device_id tas5720_of_match[] = {
723 { .compatible = "ti,tas5720", },
724 { .compatible = "ti,tas5722", },
727 MODULE_DEVICE_TABLE(of, tas5720_of_match);
730 static struct i2c_driver tas5720_i2c_driver = {
733 .of_match_table = of_match_ptr(tas5720_of_match),
735 .probe = tas5720_probe,
736 .id_table = tas5720_id,
739 module_i2c_driver(tas5720_i2c_driver);
741 MODULE_AUTHOR("Andreas Dannenberg <dannenberg@ti.com>");
742 MODULE_DESCRIPTION("TAS5720 Audio amplifier driver");
743 MODULE_LICENSE("GPL");