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 unsigned int first_slot;
159 dev_err(component->dev, "tx masks must not be 0\n");
164 * Determine the first slot that is being requested. We will only
165 * use the first slot that is found since the TAS5720 is a mono
168 first_slot = __ffs(tx_mask);
170 if (first_slot > 7) {
171 dev_err(component->dev, "slot selection out of bounds (%u)\n",
176 /* Enable manual TDM slot selection (instead of I2C ID based) */
177 ret = snd_soc_component_update_bits(component, TAS5720_DIGITAL_CTRL1_REG,
178 TAS5720_TDM_CFG_SRC, TAS5720_TDM_CFG_SRC);
180 goto error_snd_soc_component_update_bits;
182 /* Configure the TDM slot to process audio from */
183 ret = snd_soc_component_update_bits(component, TAS5720_DIGITAL_CTRL2_REG,
184 TAS5720_TDM_SLOT_SEL_MASK, first_slot);
186 goto error_snd_soc_component_update_bits;
190 error_snd_soc_component_update_bits:
191 dev_err(component->dev, "error configuring TDM mode: %d\n", ret);
195 static int tas5720_mute(struct snd_soc_dai *dai, int mute)
197 struct snd_soc_component *component = dai->component;
200 ret = snd_soc_component_update_bits(component, TAS5720_DIGITAL_CTRL2_REG,
201 TAS5720_MUTE, mute ? TAS5720_MUTE : 0);
203 dev_err(component->dev, "error (un-)muting device: %d\n", ret);
210 static void tas5720_fault_check_work(struct work_struct *work)
212 struct tas5720_data *tas5720 = container_of(work, struct tas5720_data,
213 fault_check_work.work);
214 struct device *dev = tas5720->component->dev;
215 unsigned int curr_fault;
218 ret = regmap_read(tas5720->regmap, TAS5720_FAULT_REG, &curr_fault);
220 dev_err(dev, "failed to read FAULT register: %d\n", ret);
224 /* Check/handle all errors except SAIF clock errors */
225 curr_fault &= TAS5720_OCE | TAS5720_DCE | TAS5720_OTE;
228 * Only flag errors once for a given occurrence. This is needed as
229 * the TAS5720 will take time clearing the fault condition internally
230 * during which we don't want to bombard the system with the same
231 * error message over and over.
233 if ((curr_fault & TAS5720_OCE) && !(tas5720->last_fault & TAS5720_OCE))
234 dev_crit(dev, "experienced an over current hardware fault\n");
236 if ((curr_fault & TAS5720_DCE) && !(tas5720->last_fault & TAS5720_DCE))
237 dev_crit(dev, "experienced a DC detection fault\n");
239 if ((curr_fault & TAS5720_OTE) && !(tas5720->last_fault & TAS5720_OTE))
240 dev_crit(dev, "experienced an over temperature fault\n");
242 /* Store current fault value so we can detect any changes next time */
243 tas5720->last_fault = curr_fault;
249 * Periodically toggle SDZ (shutdown bit) H->L->H to clear any latching
250 * faults as long as a fault condition persists. Always going through
251 * the full sequence no matter the first return value to minimizes
252 * chances for the device to end up in shutdown mode.
254 ret = regmap_write_bits(tas5720->regmap, TAS5720_POWER_CTRL_REG,
257 dev_err(dev, "failed to write POWER_CTRL register: %d\n", ret);
259 ret = regmap_write_bits(tas5720->regmap, TAS5720_POWER_CTRL_REG,
260 TAS5720_SDZ, TAS5720_SDZ);
262 dev_err(dev, "failed to write POWER_CTRL register: %d\n", ret);
265 /* Schedule the next fault check at the specified interval */
266 schedule_delayed_work(&tas5720->fault_check_work,
267 msecs_to_jiffies(TAS5720_FAULT_CHECK_INTERVAL));
270 static int tas5720_codec_probe(struct snd_soc_component *component)
272 struct tas5720_data *tas5720 = snd_soc_component_get_drvdata(component);
273 unsigned int device_id, expected_device_id;
276 tas5720->component = component;
278 ret = regulator_bulk_enable(ARRAY_SIZE(tas5720->supplies),
281 dev_err(component->dev, "failed to enable supplies: %d\n", ret);
286 * Take a liberal approach to checking the device ID to allow the
287 * driver to be used even if the device ID does not match, however
288 * issue a warning if there is a mismatch.
290 ret = regmap_read(tas5720->regmap, TAS5720_DEVICE_ID_REG, &device_id);
292 dev_err(component->dev, "failed to read device ID register: %d\n",
297 switch (tas5720->devtype) {
299 expected_device_id = TAS5720_DEVICE_ID;
302 expected_device_id = TAS5722_DEVICE_ID;
305 dev_err(component->dev, "unexpected private driver data\n");
309 if (device_id != expected_device_id)
310 dev_warn(component->dev, "wrong device ID. expected: %u read: %u\n",
311 expected_device_id, device_id);
313 /* Set device to mute */
314 ret = snd_soc_component_update_bits(component, TAS5720_DIGITAL_CTRL2_REG,
315 TAS5720_MUTE, TAS5720_MUTE);
317 goto error_snd_soc_component_update_bits;
320 * Enter shutdown mode - our default when not playing audio - to
321 * minimize current consumption. On the TAS5720 there is no real down
322 * side doing so as all device registers are preserved and the wakeup
323 * of the codec is rather quick which we do using a dapm widget.
325 ret = snd_soc_component_update_bits(component, TAS5720_POWER_CTRL_REG,
328 goto error_snd_soc_component_update_bits;
330 INIT_DELAYED_WORK(&tas5720->fault_check_work, tas5720_fault_check_work);
334 error_snd_soc_component_update_bits:
335 dev_err(component->dev, "error configuring device registers: %d\n", ret);
338 regulator_bulk_disable(ARRAY_SIZE(tas5720->supplies),
343 static void tas5720_codec_remove(struct snd_soc_component *component)
345 struct tas5720_data *tas5720 = snd_soc_component_get_drvdata(component);
348 cancel_delayed_work_sync(&tas5720->fault_check_work);
350 ret = regulator_bulk_disable(ARRAY_SIZE(tas5720->supplies),
353 dev_err(component->dev, "failed to disable supplies: %d\n", ret);
356 static int tas5720_dac_event(struct snd_soc_dapm_widget *w,
357 struct snd_kcontrol *kcontrol, int event)
359 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
360 struct tas5720_data *tas5720 = snd_soc_component_get_drvdata(component);
363 if (event & SND_SOC_DAPM_POST_PMU) {
364 /* Take TAS5720 out of shutdown mode */
365 ret = snd_soc_component_update_bits(component, TAS5720_POWER_CTRL_REG,
366 TAS5720_SDZ, TAS5720_SDZ);
368 dev_err(component->dev, "error waking component: %d\n", ret);
373 * Observe codec shutdown-to-active time. The datasheet only
374 * lists a nominal value however just use-it as-is without
375 * additional padding to minimize the delay introduced in
376 * starting to play audio (actually there is other setup done
377 * by the ASoC framework that will provide additional delays,
378 * so we should always be safe).
382 /* Turn on TAS5720 periodic fault checking/handling */
383 tas5720->last_fault = 0;
384 schedule_delayed_work(&tas5720->fault_check_work,
385 msecs_to_jiffies(TAS5720_FAULT_CHECK_INTERVAL));
386 } else if (event & SND_SOC_DAPM_PRE_PMD) {
387 /* Disable TAS5720 periodic fault checking/handling */
388 cancel_delayed_work_sync(&tas5720->fault_check_work);
390 /* Place TAS5720 in shutdown mode to minimize current draw */
391 ret = snd_soc_component_update_bits(component, TAS5720_POWER_CTRL_REG,
394 dev_err(component->dev, "error shutting down component: %d\n",
404 static int tas5720_suspend(struct snd_soc_component *component)
406 struct tas5720_data *tas5720 = snd_soc_component_get_drvdata(component);
409 regcache_cache_only(tas5720->regmap, true);
410 regcache_mark_dirty(tas5720->regmap);
412 ret = regulator_bulk_disable(ARRAY_SIZE(tas5720->supplies),
415 dev_err(component->dev, "failed to disable supplies: %d\n", ret);
420 static int tas5720_resume(struct snd_soc_component *component)
422 struct tas5720_data *tas5720 = snd_soc_component_get_drvdata(component);
425 ret = regulator_bulk_enable(ARRAY_SIZE(tas5720->supplies),
428 dev_err(component->dev, "failed to enable supplies: %d\n", ret);
432 regcache_cache_only(tas5720->regmap, false);
434 ret = regcache_sync(tas5720->regmap);
436 dev_err(component->dev, "failed to sync regcache: %d\n", ret);
443 #define tas5720_suspend NULL
444 #define tas5720_resume NULL
447 static bool tas5720_is_volatile_reg(struct device *dev, unsigned int reg)
450 case TAS5720_DEVICE_ID_REG:
451 case TAS5720_FAULT_REG:
458 static const struct regmap_config tas5720_regmap_config = {
462 .max_register = TAS5720_MAX_REG,
463 .cache_type = REGCACHE_RBTREE,
464 .volatile_reg = tas5720_is_volatile_reg,
467 static const struct regmap_config tas5722_regmap_config = {
471 .max_register = TAS5722_MAX_REG,
472 .cache_type = REGCACHE_RBTREE,
473 .volatile_reg = tas5720_is_volatile_reg,
477 * DAC analog gain. There are four discrete values to select from, ranging
478 * from 19.2 dB to 26.3dB.
480 static const DECLARE_TLV_DB_RANGE(dac_analog_tlv,
481 0x0, 0x0, TLV_DB_SCALE_ITEM(1920, 0, 0),
482 0x1, 0x1, TLV_DB_SCALE_ITEM(2070, 0, 0),
483 0x2, 0x2, TLV_DB_SCALE_ITEM(2350, 0, 0),
484 0x3, 0x3, TLV_DB_SCALE_ITEM(2630, 0, 0),
488 * DAC digital volumes. From -103.5 to 24 dB in 0.5 dB steps. Note that
489 * setting the gain below -100 dB (register value <0x7) is effectively a MUTE
490 * as per device datasheet.
492 static DECLARE_TLV_DB_SCALE(dac_tlv, -10350, 50, 0);
494 static const struct snd_kcontrol_new tas5720_snd_controls[] = {
495 SOC_SINGLE_TLV("Speaker Driver Playback Volume",
496 TAS5720_VOLUME_CTRL_REG, 0, 0xff, 0, dac_tlv),
497 SOC_SINGLE_TLV("Speaker Driver Analog Gain", TAS5720_ANALOG_CTRL_REG,
498 TAS5720_ANALOG_GAIN_SHIFT, 3, 0, dac_analog_tlv),
501 static const struct snd_soc_dapm_widget tas5720_dapm_widgets[] = {
502 SND_SOC_DAPM_AIF_IN("DAC IN", "Playback", 0, SND_SOC_NOPM, 0, 0),
503 SND_SOC_DAPM_DAC_E("DAC", NULL, SND_SOC_NOPM, 0, 0, tas5720_dac_event,
504 SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD),
505 SND_SOC_DAPM_OUTPUT("OUT")
508 static const struct snd_soc_dapm_route tas5720_audio_map[] = {
509 { "DAC", NULL, "DAC IN" },
510 { "OUT", NULL, "DAC" },
513 static const struct snd_soc_component_driver soc_component_dev_tas5720 = {
514 .probe = tas5720_codec_probe,
515 .remove = tas5720_codec_remove,
516 .suspend = tas5720_suspend,
517 .resume = tas5720_resume,
518 .controls = tas5720_snd_controls,
519 .num_controls = ARRAY_SIZE(tas5720_snd_controls),
520 .dapm_widgets = tas5720_dapm_widgets,
521 .num_dapm_widgets = ARRAY_SIZE(tas5720_dapm_widgets),
522 .dapm_routes = tas5720_audio_map,
523 .num_dapm_routes = ARRAY_SIZE(tas5720_audio_map),
525 .use_pmdown_time = 1,
527 .non_legacy_dai_naming = 1,
530 /* PCM rates supported by the TAS5720 driver */
531 #define TAS5720_RATES (SNDRV_PCM_RATE_44100 | SNDRV_PCM_RATE_48000 |\
532 SNDRV_PCM_RATE_88200 | SNDRV_PCM_RATE_96000)
534 /* Formats supported by TAS5720 driver */
535 #define TAS5720_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S18_3LE |\
536 SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S24_LE)
538 static const struct snd_soc_dai_ops tas5720_speaker_dai_ops = {
539 .hw_params = tas5720_hw_params,
540 .set_fmt = tas5720_set_dai_fmt,
541 .set_tdm_slot = tas5720_set_dai_tdm_slot,
542 .digital_mute = tas5720_mute,
546 * TAS5720 DAI structure
548 * Note that were are advertising .playback.channels_max = 2 despite this being
549 * a mono amplifier. The reason for that is that some serial ports such as TI's
550 * McASP module have a minimum number of channels (2) that they can output.
551 * Advertising more channels than we have will allow us to interface with such
552 * a serial port without really any negative side effects as the TAS5720 will
553 * simply ignore any extra channel(s) asides from the one channel that is
554 * configured to be played back.
556 static struct snd_soc_dai_driver tas5720_dai[] = {
558 .name = "tas5720-amplifier",
560 .stream_name = "Playback",
563 .rates = TAS5720_RATES,
564 .formats = TAS5720_FORMATS,
566 .ops = &tas5720_speaker_dai_ops,
570 static int tas5720_probe(struct i2c_client *client,
571 const struct i2c_device_id *id)
573 struct device *dev = &client->dev;
574 struct tas5720_data *data;
575 const struct regmap_config *regmap_config;
579 data = devm_kzalloc(dev, sizeof(*data), GFP_KERNEL);
583 data->tas5720_client = client;
584 data->devtype = id->driver_data;
586 switch (id->driver_data) {
588 regmap_config = &tas5720_regmap_config;
591 regmap_config = &tas5722_regmap_config;
594 dev_err(dev, "unexpected private driver data\n");
597 data->regmap = devm_regmap_init_i2c(client, regmap_config);
598 if (IS_ERR(data->regmap)) {
599 ret = PTR_ERR(data->regmap);
600 dev_err(dev, "failed to allocate register map: %d\n", ret);
604 for (i = 0; i < ARRAY_SIZE(data->supplies); i++)
605 data->supplies[i].supply = tas5720_supply_names[i];
607 ret = devm_regulator_bulk_get(dev, ARRAY_SIZE(data->supplies),
610 dev_err(dev, "failed to request supplies: %d\n", ret);
614 dev_set_drvdata(dev, data);
616 ret = devm_snd_soc_register_component(&client->dev,
617 &soc_component_dev_tas5720,
618 tas5720_dai, ARRAY_SIZE(tas5720_dai));
620 dev_err(dev, "failed to register component: %d\n", ret);
627 static const struct i2c_device_id tas5720_id[] = {
628 { "tas5720", TAS5720 },
629 { "tas5722", TAS5722 },
632 MODULE_DEVICE_TABLE(i2c, tas5720_id);
634 #if IS_ENABLED(CONFIG_OF)
635 static const struct of_device_id tas5720_of_match[] = {
636 { .compatible = "ti,tas5720", },
637 { .compatible = "ti,tas5722", },
640 MODULE_DEVICE_TABLE(of, tas5720_of_match);
643 static struct i2c_driver tas5720_i2c_driver = {
646 .of_match_table = of_match_ptr(tas5720_of_match),
648 .probe = tas5720_probe,
649 .id_table = tas5720_id,
652 module_i2c_driver(tas5720_i2c_driver);
654 MODULE_AUTHOR("Andreas Dannenberg <dannenberg@ti.com>");
655 MODULE_DESCRIPTION("TAS5720 Audio amplifier driver");
656 MODULE_LICENSE("GPL");