1// SPDX-License-Identifier: GPL-2.0
2/*
3 * ALSA SoC Texas Instruments TAS6424 Quad-Channel Audio Amplifier
4 *
5 * Copyright (C) 2016-2017 Texas Instruments Incorporated - https://www.ti.com/
6 * Author: Andreas Dannenberg <dannenberg@ti.com>
7 * Andrew F. Davis <afd@ti.com>
8 */
9
10#include <linux/module.h>
11#include <linux/errno.h>
12#include <linux/device.h>
13#include <linux/i2c.h>
14#include <linux/regmap.h>
15#include <linux/slab.h>
16#include <linux/regulator/consumer.h>
17#include <linux/delay.h>
18#include <linux/gpio/consumer.h>
19
20#include <sound/pcm.h>
21#include <sound/pcm_params.h>
22#include <sound/soc.h>
23#include <sound/soc-dapm.h>
24#include <sound/tlv.h>
25
26#include "tas6424.h"
27
28/* Define how often to check (and clear) the fault status register (in ms) */
29#define TAS6424_FAULT_CHECK_INTERVAL 200
30
31static const char * const tas6424_supply_names[] = {
32 "dvdd", /* Digital power supply. Connect to 3.3-V supply. */
33 "vbat", /* Supply used for higher voltage analog circuits. */
34 "pvdd", /* Class-D amp output FETs supply. */
35};
36#define TAS6424_NUM_SUPPLIES ARRAY_SIZE(tas6424_supply_names)
37
38struct tas6424_data {
39 struct device *dev;
40 struct regmap *regmap;
41 struct regulator_bulk_data supplies[TAS6424_NUM_SUPPLIES];
42 struct delayed_work fault_check_work;
43 unsigned int last_cfault;
44 unsigned int last_fault1;
45 unsigned int last_fault2;
46 unsigned int last_warn;
47 struct gpio_desc *standby_gpio;
48 struct gpio_desc *mute_gpio;
49};
50
51/*
52 * DAC digital volumes. From -103.5 to 24 dB in 0.5 dB steps. Note that
53 * setting the gain below -100 dB (register value <0x7) is effectively a MUTE
54 * as per device datasheet.
55 */
56static DECLARE_TLV_DB_SCALE(dac_tlv, -10350, 50, 0);
57
58static const struct snd_kcontrol_new tas6424_snd_controls[] = {
59 SOC_SINGLE_TLV("Speaker Driver CH1 Playback Volume",
60 TAS6424_CH1_VOL_CTRL, 0, 0xff, 0, dac_tlv),
61 SOC_SINGLE_TLV("Speaker Driver CH2 Playback Volume",
62 TAS6424_CH2_VOL_CTRL, 0, 0xff, 0, dac_tlv),
63 SOC_SINGLE_TLV("Speaker Driver CH3 Playback Volume",
64 TAS6424_CH3_VOL_CTRL, 0, 0xff, 0, dac_tlv),
65 SOC_SINGLE_TLV("Speaker Driver CH4 Playback Volume",
66 TAS6424_CH4_VOL_CTRL, 0, 0xff, 0, dac_tlv),
67 SOC_SINGLE_STROBE("Auto Diagnostics Switch", TAS6424_DC_DIAG_CTRL1,
68 TAS6424_LDGBYPASS_SHIFT, 1),
69};
70
71static int tas6424_dac_event(struct snd_soc_dapm_widget *w,
72 struct snd_kcontrol *kcontrol, int event)
73{
74 struct snd_soc_component *component = snd_soc_dapm_to_component(dapm: w->dapm);
75 struct tas6424_data *tas6424 = snd_soc_component_get_drvdata(c: component);
76
77 dev_dbg(component->dev, "%s() event=0x%0x\n", __func__, event);
78
79 if (event & SND_SOC_DAPM_POST_PMU) {
80 /* Observe codec shutdown-to-active time */
81 msleep(msecs: 12);
82
83 /* Turn on TAS6424 periodic fault checking/handling */
84 tas6424->last_fault1 = 0;
85 tas6424->last_fault2 = 0;
86 tas6424->last_warn = 0;
87 schedule_delayed_work(dwork: &tas6424->fault_check_work,
88 delay: msecs_to_jiffies(TAS6424_FAULT_CHECK_INTERVAL));
89 } else if (event & SND_SOC_DAPM_PRE_PMD) {
90 /* Disable TAS6424 periodic fault checking/handling */
91 cancel_delayed_work_sync(dwork: &tas6424->fault_check_work);
92 }
93
94 return 0;
95}
96
97static const struct snd_soc_dapm_widget tas6424_dapm_widgets[] = {
98 SND_SOC_DAPM_AIF_IN("DAC IN", "Playback", 0, SND_SOC_NOPM, 0, 0),
99 SND_SOC_DAPM_DAC_E("DAC", NULL, SND_SOC_NOPM, 0, 0, tas6424_dac_event,
100 SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD),
101 SND_SOC_DAPM_OUTPUT("OUT")
102};
103
104static const struct snd_soc_dapm_route tas6424_audio_map[] = {
105 { "DAC", NULL, "DAC IN" },
106 { "OUT", NULL, "DAC" },
107};
108
109static int tas6424_hw_params(struct snd_pcm_substream *substream,
110 struct snd_pcm_hw_params *params,
111 struct snd_soc_dai *dai)
112{
113 struct snd_soc_component *component = dai->component;
114 unsigned int rate = params_rate(p: params);
115 unsigned int width = params_width(p: params);
116 u8 sap_ctrl = 0;
117
118 dev_dbg(component->dev, "%s() rate=%u width=%u\n", __func__, rate, width);
119
120 switch (rate) {
121 case 44100:
122 sap_ctrl |= TAS6424_SAP_RATE_44100;
123 break;
124 case 48000:
125 sap_ctrl |= TAS6424_SAP_RATE_48000;
126 break;
127 case 96000:
128 sap_ctrl |= TAS6424_SAP_RATE_96000;
129 break;
130 default:
131 dev_err(component->dev, "unsupported sample rate: %u\n", rate);
132 return -EINVAL;
133 }
134
135 switch (width) {
136 case 16:
137 sap_ctrl |= TAS6424_SAP_TDM_SLOT_SZ_16;
138 break;
139 case 24:
140 break;
141 default:
142 dev_err(component->dev, "unsupported sample width: %u\n", width);
143 return -EINVAL;
144 }
145
146 snd_soc_component_update_bits(component, TAS6424_SAP_CTRL,
147 TAS6424_SAP_RATE_MASK |
148 TAS6424_SAP_TDM_SLOT_SZ_16,
149 val: sap_ctrl);
150
151 return 0;
152}
153
154static int tas6424_set_dai_fmt(struct snd_soc_dai *dai, unsigned int fmt)
155{
156 struct snd_soc_component *component = dai->component;
157 u8 serial_format = 0;
158
159 dev_dbg(component->dev, "%s() fmt=0x%0x\n", __func__, fmt);
160
161 /* clock masters */
162 switch (fmt & SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) {
163 case SND_SOC_DAIFMT_CBC_CFC:
164 break;
165 default:
166 dev_err(component->dev, "Invalid DAI clocking\n");
167 return -EINVAL;
168 }
169
170 /* signal polarity */
171 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
172 case SND_SOC_DAIFMT_NB_NF:
173 break;
174 default:
175 dev_err(component->dev, "Invalid DAI clock signal polarity\n");
176 return -EINVAL;
177 }
178
179 /* interface format */
180 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
181 case SND_SOC_DAIFMT_I2S:
182 serial_format |= TAS6424_SAP_I2S;
183 break;
184 case SND_SOC_DAIFMT_DSP_A:
185 serial_format |= TAS6424_SAP_DSP;
186 break;
187 case SND_SOC_DAIFMT_DSP_B:
188 /*
189 * We can use the fact that the TAS6424 does not care about the
190 * LRCLK duty cycle during TDM to receive DSP_B formatted data
191 * in LEFTJ mode (no delaying of the 1st data bit).
192 */
193 serial_format |= TAS6424_SAP_LEFTJ;
194 break;
195 case SND_SOC_DAIFMT_LEFT_J:
196 serial_format |= TAS6424_SAP_LEFTJ;
197 break;
198 default:
199 dev_err(component->dev, "Invalid DAI interface format\n");
200 return -EINVAL;
201 }
202
203 snd_soc_component_update_bits(component, TAS6424_SAP_CTRL,
204 TAS6424_SAP_FMT_MASK, val: serial_format);
205
206 return 0;
207}
208
209static int tas6424_set_dai_tdm_slot(struct snd_soc_dai *dai,
210 unsigned int tx_mask, unsigned int rx_mask,
211 int slots, int slot_width)
212{
213 struct snd_soc_component *component = dai->component;
214 unsigned int first_slot, last_slot;
215 bool sap_tdm_slot_last;
216
217 dev_dbg(component->dev, "%s() tx_mask=%d rx_mask=%d\n", __func__,
218 tx_mask, rx_mask);
219
220 if (!tx_mask || !rx_mask)
221 return 0; /* nothing needed to disable TDM mode */
222
223 /*
224 * Determine the first slot and last slot that is being requested so
225 * we'll be able to more easily enforce certain constraints as the
226 * TAS6424's TDM interface is not fully configurable.
227 */
228 first_slot = __ffs(tx_mask);
229 last_slot = __fls(word: rx_mask);
230
231 if (last_slot - first_slot != 4) {
232 dev_err(component->dev, "tdm mask must cover 4 contiguous slots\n");
233 return -EINVAL;
234 }
235
236 switch (first_slot) {
237 case 0:
238 sap_tdm_slot_last = false;
239 break;
240 case 4:
241 sap_tdm_slot_last = true;
242 break;
243 default:
244 dev_err(component->dev, "tdm mask must start at slot 0 or 4\n");
245 return -EINVAL;
246 }
247
248 snd_soc_component_update_bits(component, TAS6424_SAP_CTRL, TAS6424_SAP_TDM_SLOT_LAST,
249 val: sap_tdm_slot_last ? TAS6424_SAP_TDM_SLOT_LAST : 0);
250
251 return 0;
252}
253
254static int tas6424_mute(struct snd_soc_dai *dai, int mute, int direction)
255{
256 struct snd_soc_component *component = dai->component;
257 struct tas6424_data *tas6424 = snd_soc_component_get_drvdata(c: component);
258 unsigned int val;
259
260 dev_dbg(component->dev, "%s() mute=%d\n", __func__, mute);
261
262 if (tas6424->mute_gpio) {
263 gpiod_set_value_cansleep(desc: tas6424->mute_gpio, value: mute);
264 return 0;
265 }
266
267 if (mute)
268 val = TAS6424_ALL_STATE_MUTE;
269 else
270 val = TAS6424_ALL_STATE_PLAY;
271
272 snd_soc_component_write(component, TAS6424_CH_STATE_CTRL, val);
273
274 return 0;
275}
276
277static int tas6424_power_off(struct snd_soc_component *component)
278{
279 struct tas6424_data *tas6424 = snd_soc_component_get_drvdata(c: component);
280 int ret;
281
282 snd_soc_component_write(component, TAS6424_CH_STATE_CTRL, TAS6424_ALL_STATE_HIZ);
283
284 regcache_cache_only(map: tas6424->regmap, enable: true);
285 regcache_mark_dirty(map: tas6424->regmap);
286
287 ret = regulator_bulk_disable(ARRAY_SIZE(tas6424->supplies),
288 consumers: tas6424->supplies);
289 if (ret < 0) {
290 dev_err(component->dev, "failed to disable supplies: %d\n", ret);
291 return ret;
292 }
293
294 return 0;
295}
296
297static int tas6424_power_on(struct snd_soc_component *component)
298{
299 struct tas6424_data *tas6424 = snd_soc_component_get_drvdata(c: component);
300 int ret;
301 u8 chan_states;
302 int no_auto_diags = 0;
303 unsigned int reg_val;
304
305 if (!regmap_read(map: tas6424->regmap, TAS6424_DC_DIAG_CTRL1, val: &reg_val))
306 no_auto_diags = reg_val & TAS6424_LDGBYPASS_MASK;
307
308 ret = regulator_bulk_enable(ARRAY_SIZE(tas6424->supplies),
309 consumers: tas6424->supplies);
310 if (ret < 0) {
311 dev_err(component->dev, "failed to enable supplies: %d\n", ret);
312 return ret;
313 }
314
315 regcache_cache_only(map: tas6424->regmap, enable: false);
316
317 ret = regcache_sync(map: tas6424->regmap);
318 if (ret < 0) {
319 dev_err(component->dev, "failed to sync regcache: %d\n", ret);
320 return ret;
321 }
322
323 if (tas6424->mute_gpio) {
324 gpiod_set_value_cansleep(desc: tas6424->mute_gpio, value: 0);
325 /*
326 * channels are muted via the mute pin. Don't also mute
327 * them via the registers so that subsequent register
328 * access is not necessary to un-mute the channels
329 */
330 chan_states = TAS6424_ALL_STATE_PLAY;
331 } else {
332 chan_states = TAS6424_ALL_STATE_MUTE;
333 }
334 snd_soc_component_write(component, TAS6424_CH_STATE_CTRL, val: chan_states);
335
336 /* any time we come out of HIZ, the output channels automatically run DC
337 * load diagnostics if autodiagnotics are enabled. wait here until this
338 * completes.
339 */
340 if (!no_auto_diags)
341 msleep(msecs: 230);
342
343 return 0;
344}
345
346static int tas6424_set_bias_level(struct snd_soc_component *component,
347 enum snd_soc_bias_level level)
348{
349 struct snd_soc_dapm_context *dapm = snd_soc_component_to_dapm(component);
350
351 dev_dbg(component->dev, "%s() level=%d\n", __func__, level);
352
353 switch (level) {
354 case SND_SOC_BIAS_ON:
355 case SND_SOC_BIAS_PREPARE:
356 break;
357 case SND_SOC_BIAS_STANDBY:
358 if (snd_soc_dapm_get_bias_level(dapm) == SND_SOC_BIAS_OFF)
359 tas6424_power_on(component);
360 break;
361 case SND_SOC_BIAS_OFF:
362 tas6424_power_off(component);
363 break;
364 }
365
366 return 0;
367}
368
369static const struct snd_soc_component_driver soc_codec_dev_tas6424 = {
370 .set_bias_level = tas6424_set_bias_level,
371 .controls = tas6424_snd_controls,
372 .num_controls = ARRAY_SIZE(tas6424_snd_controls),
373 .dapm_widgets = tas6424_dapm_widgets,
374 .num_dapm_widgets = ARRAY_SIZE(tas6424_dapm_widgets),
375 .dapm_routes = tas6424_audio_map,
376 .num_dapm_routes = ARRAY_SIZE(tas6424_audio_map),
377 .use_pmdown_time = 1,
378 .endianness = 1,
379};
380
381static const struct snd_soc_dai_ops tas6424_speaker_dai_ops = {
382 .hw_params = tas6424_hw_params,
383 .set_fmt = tas6424_set_dai_fmt,
384 .set_tdm_slot = tas6424_set_dai_tdm_slot,
385 .mute_stream = tas6424_mute,
386 .no_capture_mute = 1,
387};
388
389static struct snd_soc_dai_driver tas6424_dai[] = {
390 {
391 .name = "tas6424-amplifier",
392 .playback = {
393 .stream_name = "Playback",
394 .channels_min = 1,
395 .channels_max = 4,
396 .rates = TAS6424_RATES,
397 .formats = TAS6424_FORMATS,
398 },
399 .ops = &tas6424_speaker_dai_ops,
400 },
401};
402
403static void tas6424_fault_check_work(struct work_struct *work)
404{
405 struct tas6424_data *tas6424 = container_of(work, struct tas6424_data,
406 fault_check_work.work);
407 struct device *dev = tas6424->dev;
408 unsigned int reg;
409 int ret;
410
411 ret = regmap_read(map: tas6424->regmap, TAS6424_CHANNEL_FAULT, val: &reg);
412 if (ret < 0) {
413 dev_err(dev, "failed to read CHANNEL_FAULT register: %d\n", ret);
414 goto out;
415 }
416
417 if (!reg) {
418 tas6424->last_cfault = reg;
419 goto check_global_fault1_reg;
420 }
421
422 /*
423 * Only flag errors once for a given occurrence. This is needed as
424 * the TAS6424 will take time clearing the fault condition internally
425 * during which we don't want to bombard the system with the same
426 * error message over and over.
427 */
428 if ((reg & TAS6424_FAULT_OC_CH1) && !(tas6424->last_cfault & TAS6424_FAULT_OC_CH1))
429 dev_crit(dev, "experienced a channel 1 overcurrent fault\n");
430
431 if ((reg & TAS6424_FAULT_OC_CH2) && !(tas6424->last_cfault & TAS6424_FAULT_OC_CH2))
432 dev_crit(dev, "experienced a channel 2 overcurrent fault\n");
433
434 if ((reg & TAS6424_FAULT_OC_CH3) && !(tas6424->last_cfault & TAS6424_FAULT_OC_CH3))
435 dev_crit(dev, "experienced a channel 3 overcurrent fault\n");
436
437 if ((reg & TAS6424_FAULT_OC_CH4) && !(tas6424->last_cfault & TAS6424_FAULT_OC_CH4))
438 dev_crit(dev, "experienced a channel 4 overcurrent fault\n");
439
440 if ((reg & TAS6424_FAULT_DC_CH1) && !(tas6424->last_cfault & TAS6424_FAULT_DC_CH1))
441 dev_crit(dev, "experienced a channel 1 DC fault\n");
442
443 if ((reg & TAS6424_FAULT_DC_CH2) && !(tas6424->last_cfault & TAS6424_FAULT_DC_CH2))
444 dev_crit(dev, "experienced a channel 2 DC fault\n");
445
446 if ((reg & TAS6424_FAULT_DC_CH3) && !(tas6424->last_cfault & TAS6424_FAULT_DC_CH3))
447 dev_crit(dev, "experienced a channel 3 DC fault\n");
448
449 if ((reg & TAS6424_FAULT_DC_CH4) && !(tas6424->last_cfault & TAS6424_FAULT_DC_CH4))
450 dev_crit(dev, "experienced a channel 4 DC fault\n");
451
452 /* Store current fault1 value so we can detect any changes next time */
453 tas6424->last_cfault = reg;
454
455check_global_fault1_reg:
456 ret = regmap_read(map: tas6424->regmap, TAS6424_GLOB_FAULT1, val: &reg);
457 if (ret < 0) {
458 dev_err(dev, "failed to read GLOB_FAULT1 register: %d\n", ret);
459 goto out;
460 }
461
462 /*
463 * Ignore any clock faults as there is no clean way to check for them.
464 * We would need to start checking for those faults *after* the SAIF
465 * stream has been setup, and stop checking *before* the stream is
466 * stopped to avoid any false-positives. However there are no
467 * appropriate hooks to monitor these events.
468 */
469 reg &= TAS6424_FAULT_PVDD_OV |
470 TAS6424_FAULT_VBAT_OV |
471 TAS6424_FAULT_PVDD_UV |
472 TAS6424_FAULT_VBAT_UV;
473
474 if (!reg) {
475 tas6424->last_fault1 = reg;
476 goto check_global_fault2_reg;
477 }
478
479 if ((reg & TAS6424_FAULT_PVDD_OV) && !(tas6424->last_fault1 & TAS6424_FAULT_PVDD_OV))
480 dev_crit(dev, "experienced a PVDD overvoltage fault\n");
481
482 if ((reg & TAS6424_FAULT_VBAT_OV) && !(tas6424->last_fault1 & TAS6424_FAULT_VBAT_OV))
483 dev_crit(dev, "experienced a VBAT overvoltage fault\n");
484
485 if ((reg & TAS6424_FAULT_PVDD_UV) && !(tas6424->last_fault1 & TAS6424_FAULT_PVDD_UV))
486 dev_crit(dev, "experienced a PVDD undervoltage fault\n");
487
488 if ((reg & TAS6424_FAULT_VBAT_UV) && !(tas6424->last_fault1 & TAS6424_FAULT_VBAT_UV))
489 dev_crit(dev, "experienced a VBAT undervoltage fault\n");
490
491 /* Store current fault1 value so we can detect any changes next time */
492 tas6424->last_fault1 = reg;
493
494check_global_fault2_reg:
495 ret = regmap_read(map: tas6424->regmap, TAS6424_GLOB_FAULT2, val: &reg);
496 if (ret < 0) {
497 dev_err(dev, "failed to read GLOB_FAULT2 register: %d\n", ret);
498 goto out;
499 }
500
501 reg &= TAS6424_FAULT_OTSD |
502 TAS6424_FAULT_OTSD_CH1 |
503 TAS6424_FAULT_OTSD_CH2 |
504 TAS6424_FAULT_OTSD_CH3 |
505 TAS6424_FAULT_OTSD_CH4;
506
507 if (!reg) {
508 tas6424->last_fault2 = reg;
509 goto check_warn_reg;
510 }
511
512 if ((reg & TAS6424_FAULT_OTSD) && !(tas6424->last_fault2 & TAS6424_FAULT_OTSD))
513 dev_crit(dev, "experienced a global overtemp shutdown\n");
514
515 if ((reg & TAS6424_FAULT_OTSD_CH1) && !(tas6424->last_fault2 & TAS6424_FAULT_OTSD_CH1))
516 dev_crit(dev, "experienced an overtemp shutdown on CH1\n");
517
518 if ((reg & TAS6424_FAULT_OTSD_CH2) && !(tas6424->last_fault2 & TAS6424_FAULT_OTSD_CH2))
519 dev_crit(dev, "experienced an overtemp shutdown on CH2\n");
520
521 if ((reg & TAS6424_FAULT_OTSD_CH3) && !(tas6424->last_fault2 & TAS6424_FAULT_OTSD_CH3))
522 dev_crit(dev, "experienced an overtemp shutdown on CH3\n");
523
524 if ((reg & TAS6424_FAULT_OTSD_CH4) && !(tas6424->last_fault2 & TAS6424_FAULT_OTSD_CH4))
525 dev_crit(dev, "experienced an overtemp shutdown on CH4\n");
526
527 /* Store current fault2 value so we can detect any changes next time */
528 tas6424->last_fault2 = reg;
529
530check_warn_reg:
531 ret = regmap_read(map: tas6424->regmap, TAS6424_WARN, val: &reg);
532 if (ret < 0) {
533 dev_err(dev, "failed to read WARN register: %d\n", ret);
534 goto out;
535 }
536
537 reg &= TAS6424_WARN_VDD_UV |
538 TAS6424_WARN_VDD_POR |
539 TAS6424_WARN_VDD_OTW |
540 TAS6424_WARN_VDD_OTW_CH1 |
541 TAS6424_WARN_VDD_OTW_CH2 |
542 TAS6424_WARN_VDD_OTW_CH3 |
543 TAS6424_WARN_VDD_OTW_CH4;
544
545 if (!reg) {
546 tas6424->last_warn = reg;
547 goto out;
548 }
549
550 if ((reg & TAS6424_WARN_VDD_UV) && !(tas6424->last_warn & TAS6424_WARN_VDD_UV))
551 dev_warn(dev, "experienced a VDD under voltage condition\n");
552
553 if ((reg & TAS6424_WARN_VDD_POR) && !(tas6424->last_warn & TAS6424_WARN_VDD_POR))
554 dev_warn(dev, "experienced a VDD POR condition\n");
555
556 if ((reg & TAS6424_WARN_VDD_OTW) && !(tas6424->last_warn & TAS6424_WARN_VDD_OTW))
557 dev_warn(dev, "experienced a global overtemp warning\n");
558
559 if ((reg & TAS6424_WARN_VDD_OTW_CH1) && !(tas6424->last_warn & TAS6424_WARN_VDD_OTW_CH1))
560 dev_warn(dev, "experienced an overtemp warning on CH1\n");
561
562 if ((reg & TAS6424_WARN_VDD_OTW_CH2) && !(tas6424->last_warn & TAS6424_WARN_VDD_OTW_CH2))
563 dev_warn(dev, "experienced an overtemp warning on CH2\n");
564
565 if ((reg & TAS6424_WARN_VDD_OTW_CH3) && !(tas6424->last_warn & TAS6424_WARN_VDD_OTW_CH3))
566 dev_warn(dev, "experienced an overtemp warning on CH3\n");
567
568 if ((reg & TAS6424_WARN_VDD_OTW_CH4) && !(tas6424->last_warn & TAS6424_WARN_VDD_OTW_CH4))
569 dev_warn(dev, "experienced an overtemp warning on CH4\n");
570
571 /* Store current warn value so we can detect any changes next time */
572 tas6424->last_warn = reg;
573
574 /* Clear any warnings by toggling the CLEAR_FAULT control bit */
575 ret = regmap_write_bits(map: tas6424->regmap, TAS6424_MISC_CTRL3,
576 TAS6424_CLEAR_FAULT, TAS6424_CLEAR_FAULT);
577 if (ret < 0)
578 dev_err(dev, "failed to write MISC_CTRL3 register: %d\n", ret);
579
580 ret = regmap_write_bits(map: tas6424->regmap, TAS6424_MISC_CTRL3,
581 TAS6424_CLEAR_FAULT, val: 0);
582 if (ret < 0)
583 dev_err(dev, "failed to write MISC_CTRL3 register: %d\n", ret);
584
585out:
586 /* Schedule the next fault check at the specified interval */
587 schedule_delayed_work(dwork: &tas6424->fault_check_work,
588 delay: msecs_to_jiffies(TAS6424_FAULT_CHECK_INTERVAL));
589}
590
591static const struct reg_default tas6424_reg_defaults[] = {
592 { TAS6424_MODE_CTRL, 0x00 },
593 { TAS6424_MISC_CTRL1, 0x32 },
594 { TAS6424_MISC_CTRL2, 0x62 },
595 { TAS6424_SAP_CTRL, 0x04 },
596 { TAS6424_CH_STATE_CTRL, 0x55 },
597 { TAS6424_CH1_VOL_CTRL, 0xcf },
598 { TAS6424_CH2_VOL_CTRL, 0xcf },
599 { TAS6424_CH3_VOL_CTRL, 0xcf },
600 { TAS6424_CH4_VOL_CTRL, 0xcf },
601 { TAS6424_DC_DIAG_CTRL1, 0x00 },
602 { TAS6424_DC_DIAG_CTRL2, 0x11 },
603 { TAS6424_DC_DIAG_CTRL3, 0x11 },
604 { TAS6424_PIN_CTRL, 0xff },
605 { TAS6424_AC_DIAG_CTRL1, 0x00 },
606 { TAS6424_MISC_CTRL3, 0x00 },
607 { TAS6424_CLIP_CTRL, 0x01 },
608 { TAS6424_CLIP_WINDOW, 0x14 },
609 { TAS6424_CLIP_WARN, 0x00 },
610 { TAS6424_CBC_STAT, 0x00 },
611 { TAS6424_MISC_CTRL4, 0x40 },
612};
613
614static bool tas6424_is_writable_reg(struct device *dev, unsigned int reg)
615{
616 switch (reg) {
617 case TAS6424_MODE_CTRL:
618 case TAS6424_MISC_CTRL1:
619 case TAS6424_MISC_CTRL2:
620 case TAS6424_SAP_CTRL:
621 case TAS6424_CH_STATE_CTRL:
622 case TAS6424_CH1_VOL_CTRL:
623 case TAS6424_CH2_VOL_CTRL:
624 case TAS6424_CH3_VOL_CTRL:
625 case TAS6424_CH4_VOL_CTRL:
626 case TAS6424_DC_DIAG_CTRL1:
627 case TAS6424_DC_DIAG_CTRL2:
628 case TAS6424_DC_DIAG_CTRL3:
629 case TAS6424_PIN_CTRL:
630 case TAS6424_AC_DIAG_CTRL1:
631 case TAS6424_MISC_CTRL3:
632 case TAS6424_CLIP_CTRL:
633 case TAS6424_CLIP_WINDOW:
634 case TAS6424_CLIP_WARN:
635 case TAS6424_CBC_STAT:
636 case TAS6424_MISC_CTRL4:
637 return true;
638 default:
639 return false;
640 }
641}
642
643static bool tas6424_is_volatile_reg(struct device *dev, unsigned int reg)
644{
645 switch (reg) {
646 case TAS6424_DC_LOAD_DIAG_REP12:
647 case TAS6424_DC_LOAD_DIAG_REP34:
648 case TAS6424_DC_LOAD_DIAG_REPLO:
649 case TAS6424_CHANNEL_STATE:
650 case TAS6424_CHANNEL_FAULT:
651 case TAS6424_GLOB_FAULT1:
652 case TAS6424_GLOB_FAULT2:
653 case TAS6424_WARN:
654 case TAS6424_AC_LOAD_DIAG_REP1:
655 case TAS6424_AC_LOAD_DIAG_REP2:
656 case TAS6424_AC_LOAD_DIAG_REP3:
657 case TAS6424_AC_LOAD_DIAG_REP4:
658 return true;
659 default:
660 return false;
661 }
662}
663
664static const struct regmap_config tas6424_regmap_config = {
665 .reg_bits = 8,
666 .val_bits = 8,
667
668 .writeable_reg = tas6424_is_writable_reg,
669 .volatile_reg = tas6424_is_volatile_reg,
670
671 .max_register = TAS6424_MAX,
672 .reg_defaults = tas6424_reg_defaults,
673 .num_reg_defaults = ARRAY_SIZE(tas6424_reg_defaults),
674 .cache_type = REGCACHE_RBTREE,
675};
676
677#if IS_ENABLED(CONFIG_OF)
678static const struct of_device_id tas6424_of_ids[] = {
679 { .compatible = "ti,tas6424", },
680 { },
681};
682MODULE_DEVICE_TABLE(of, tas6424_of_ids);
683#endif
684
685static int tas6424_i2c_probe(struct i2c_client *client)
686{
687 struct device *dev = &client->dev;
688 struct tas6424_data *tas6424;
689 int ret;
690 int i;
691
692 tas6424 = devm_kzalloc(dev, size: sizeof(*tas6424), GFP_KERNEL);
693 if (!tas6424)
694 return -ENOMEM;
695 dev_set_drvdata(dev, data: tas6424);
696
697 tas6424->dev = dev;
698
699 tas6424->regmap = devm_regmap_init_i2c(client, &tas6424_regmap_config);
700 if (IS_ERR(ptr: tas6424->regmap)) {
701 ret = PTR_ERR(ptr: tas6424->regmap);
702 dev_err(dev, "unable to allocate register map: %d\n", ret);
703 return ret;
704 }
705
706 /*
707 * Get control of the standby pin and set it LOW to take the codec
708 * out of the stand-by mode.
709 * Note: The actual pin polarity is taken care of in the GPIO lib
710 * according the polarity specified in the DTS.
711 */
712 tas6424->standby_gpio = devm_gpiod_get_optional(dev, con_id: "standby",
713 flags: GPIOD_OUT_LOW);
714 if (IS_ERR(ptr: tas6424->standby_gpio)) {
715 if (PTR_ERR(ptr: tas6424->standby_gpio) == -EPROBE_DEFER)
716 return -EPROBE_DEFER;
717 dev_info(dev, "failed to get standby GPIO: %ld\n",
718 PTR_ERR(tas6424->standby_gpio));
719 tas6424->standby_gpio = NULL;
720 }
721
722 /*
723 * Get control of the mute pin and set it HIGH in order to start with
724 * all the output muted.
725 * Note: The actual pin polarity is taken care of in the GPIO lib
726 * according the polarity specified in the DTS.
727 */
728 tas6424->mute_gpio = devm_gpiod_get_optional(dev, con_id: "mute",
729 flags: GPIOD_OUT_HIGH);
730 if (IS_ERR(ptr: tas6424->mute_gpio)) {
731 if (PTR_ERR(ptr: tas6424->mute_gpio) == -EPROBE_DEFER)
732 return -EPROBE_DEFER;
733 dev_info(dev, "failed to get nmute GPIO: %ld\n",
734 PTR_ERR(tas6424->mute_gpio));
735 tas6424->mute_gpio = NULL;
736 }
737
738 for (i = 0; i < ARRAY_SIZE(tas6424->supplies); i++)
739 tas6424->supplies[i].supply = tas6424_supply_names[i];
740 ret = devm_regulator_bulk_get(dev, ARRAY_SIZE(tas6424->supplies),
741 consumers: tas6424->supplies);
742 if (ret) {
743 dev_err(dev, "unable to request supplies: %d\n", ret);
744 return ret;
745 }
746
747 ret = regulator_bulk_enable(ARRAY_SIZE(tas6424->supplies),
748 consumers: tas6424->supplies);
749 if (ret) {
750 dev_err(dev, "unable to enable supplies: %d\n", ret);
751 return ret;
752 }
753
754 /* Reset device to establish well-defined startup state */
755 ret = regmap_update_bits(map: tas6424->regmap, TAS6424_MODE_CTRL,
756 TAS6424_RESET, TAS6424_RESET);
757 if (ret) {
758 dev_err(dev, "unable to reset device: %d\n", ret);
759 goto disable_regs;
760 }
761
762 INIT_DELAYED_WORK(&tas6424->fault_check_work, tas6424_fault_check_work);
763
764 ret = devm_snd_soc_register_component(dev, component_driver: &soc_codec_dev_tas6424,
765 dai_drv: tas6424_dai, ARRAY_SIZE(tas6424_dai));
766 if (ret < 0) {
767 dev_err(dev, "unable to register codec: %d\n", ret);
768 goto disable_regs;
769 }
770
771 return 0;
772
773disable_regs:
774 regulator_bulk_disable(ARRAY_SIZE(tas6424->supplies), consumers: tas6424->supplies);
775 return ret;
776}
777
778static void tas6424_i2c_remove(struct i2c_client *client)
779{
780 struct device *dev = &client->dev;
781 struct tas6424_data *tas6424 = dev_get_drvdata(dev);
782 int ret;
783
784 cancel_delayed_work_sync(dwork: &tas6424->fault_check_work);
785
786 /* put the codec in stand-by */
787 if (tas6424->standby_gpio)
788 gpiod_set_value_cansleep(desc: tas6424->standby_gpio, value: 1);
789
790 ret = regulator_bulk_disable(ARRAY_SIZE(tas6424->supplies),
791 consumers: tas6424->supplies);
792 if (ret < 0)
793 dev_err(dev, "unable to disable supplies: %d\n", ret);
794}
795
796static const struct i2c_device_id tas6424_i2c_ids[] = {
797 { "tas6424" },
798 { }
799};
800MODULE_DEVICE_TABLE(i2c, tas6424_i2c_ids);
801
802static struct i2c_driver tas6424_i2c_driver = {
803 .driver = {
804 .name = "tas6424",
805 .of_match_table = of_match_ptr(tas6424_of_ids),
806 },
807 .probe = tas6424_i2c_probe,
808 .remove = tas6424_i2c_remove,
809 .id_table = tas6424_i2c_ids,
810};
811module_i2c_driver(tas6424_i2c_driver);
812
813MODULE_AUTHOR("Andreas Dannenberg <dannenberg@ti.com>");
814MODULE_AUTHOR("Andrew F. Davis <afd@ti.com>");
815MODULE_DESCRIPTION("TAS6424 Audio amplifier driver");
816MODULE_LICENSE("GPL v2");
817

source code of linux/sound/soc/codecs/tas6424.c