1 // SPDX-License-Identifier: GPL-2.0-only
3 // Driver for Cirrus Logic CS35L56 smart amp
5 // Copyright (C) 2023 Cirrus Logic, Inc. and
6 // Cirrus Logic International Semiconductor Ltd.
8 #include <linux/acpi.h>
9 #include <linux/completion.h>
10 #include <linux/debugfs.h>
11 #include <linux/delay.h>
12 #include <linux/err.h>
13 #include <linux/gpio/consumer.h>
14 #include <linux/interrupt.h>
15 #include <linux/math.h>
16 #include <linux/module.h>
18 #include <linux/pm_runtime.h>
19 #include <linux/property.h>
20 #include <linux/regmap.h>
21 #include <linux/regulator/consumer.h>
22 #include <linux/slab.h>
23 #include <linux/soundwire/sdw.h>
24 #include <linux/types.h>
25 #include <linux/workqueue.h>
26 #include <sound/cs-amp-lib.h>
27 #include <sound/pcm.h>
28 #include <sound/pcm_params.h>
29 #include <sound/soc.h>
30 #include <sound/soc-dapm.h>
31 #include <sound/tlv.h>
36 static int cs35l56_dsp_event(struct snd_soc_dapm_widget *w,
37 struct snd_kcontrol *kcontrol, int event);
39 static void cs35l56_wait_dsp_ready(struct cs35l56_private *cs35l56)
41 /* Wait for patching to complete */
42 flush_work(&cs35l56->dsp_work);
45 static int cs35l56_dspwait_get_volsw(struct snd_kcontrol *kcontrol,
46 struct snd_ctl_elem_value *ucontrol)
48 struct snd_soc_component *component = snd_kcontrol_chip(kcontrol);
49 struct cs35l56_private *cs35l56 = snd_soc_component_get_drvdata(component);
51 cs35l56_wait_dsp_ready(cs35l56);
52 return snd_soc_get_volsw(kcontrol, ucontrol);
55 static int cs35l56_dspwait_put_volsw(struct snd_kcontrol *kcontrol,
56 struct snd_ctl_elem_value *ucontrol)
58 struct snd_soc_component *component = snd_kcontrol_chip(kcontrol);
59 struct cs35l56_private *cs35l56 = snd_soc_component_get_drvdata(component);
61 cs35l56_wait_dsp_ready(cs35l56);
62 return snd_soc_put_volsw(kcontrol, ucontrol);
65 static const unsigned short cs35l56_asp1_mixer_regs[] = {
66 CS35L56_ASP1TX1_INPUT, CS35L56_ASP1TX2_INPUT,
67 CS35L56_ASP1TX3_INPUT, CS35L56_ASP1TX4_INPUT,
70 static const char * const cs35l56_asp1_mux_control_names[] = {
71 "ASP1 TX1 Source", "ASP1 TX2 Source", "ASP1 TX3 Source", "ASP1 TX4 Source"
74 static int cs35l56_sync_asp1_mixer_widgets_with_firmware(struct cs35l56_private *cs35l56)
76 struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(cs35l56->component);
77 const char *prefix = cs35l56->component->name_prefix;
78 char full_name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
80 struct snd_kcontrol *kcontrol;
85 if (cs35l56->asp1_mixer_widgets_initialized)
89 * Resume so we can read the registers from silicon if the regmap
90 * cache has not yet been populated.
92 ret = pm_runtime_resume_and_get(cs35l56->base.dev);
96 /* Wait for firmware download and reboot */
97 cs35l56_wait_dsp_ready(cs35l56);
99 ret = regmap_bulk_read(cs35l56->base.regmap, CS35L56_ASP1TX1_INPUT,
100 val, ARRAY_SIZE(val));
102 pm_runtime_mark_last_busy(cs35l56->base.dev);
103 pm_runtime_put_autosuspend(cs35l56->base.dev);
106 dev_err(cs35l56->base.dev, "Failed to read ASP1 mixer regs: %d\n", ret);
110 for (i = 0; i < ARRAY_SIZE(cs35l56_asp1_mux_control_names); ++i) {
111 name = cs35l56_asp1_mux_control_names[i];
114 snprintf(full_name, sizeof(full_name), "%s %s", prefix, name);
118 kcontrol = snd_soc_card_get_kcontrol_locked(dapm->card, name);
120 dev_warn(cs35l56->base.dev, "Could not find control %s\n", name);
124 e = (struct soc_enum *)kcontrol->private_value;
125 item = snd_soc_enum_val_to_item(e, val[i] & CS35L56_ASP_TXn_SRC_MASK);
126 snd_soc_dapm_mux_update_power(dapm, kcontrol, item, e, NULL);
129 cs35l56->asp1_mixer_widgets_initialized = true;
134 static int cs35l56_dspwait_asp1tx_get(struct snd_kcontrol *kcontrol,
135 struct snd_ctl_elem_value *ucontrol)
137 struct snd_soc_component *component = snd_soc_dapm_kcontrol_component(kcontrol);
138 struct cs35l56_private *cs35l56 = snd_soc_component_get_drvdata(component);
139 struct soc_enum *e = (struct soc_enum *)kcontrol->private_value;
140 int index = e->shift_l;
141 unsigned int addr, val;
144 ret = cs35l56_sync_asp1_mixer_widgets_with_firmware(cs35l56);
148 addr = cs35l56_asp1_mixer_regs[index];
149 ret = regmap_read(cs35l56->base.regmap, addr, &val);
153 val &= CS35L56_ASP_TXn_SRC_MASK;
154 ucontrol->value.enumerated.item[0] = snd_soc_enum_val_to_item(e, val);
159 static int cs35l56_dspwait_asp1tx_put(struct snd_kcontrol *kcontrol,
160 struct snd_ctl_elem_value *ucontrol)
162 struct snd_soc_component *component = snd_soc_dapm_kcontrol_component(kcontrol);
163 struct snd_soc_dapm_context *dapm = snd_soc_dapm_kcontrol_dapm(kcontrol);
164 struct cs35l56_private *cs35l56 = snd_soc_component_get_drvdata(component);
165 struct soc_enum *e = (struct soc_enum *)kcontrol->private_value;
166 int item = ucontrol->value.enumerated.item[0];
167 int index = e->shift_l;
168 unsigned int addr, val;
172 ret = cs35l56_sync_asp1_mixer_widgets_with_firmware(cs35l56);
176 addr = cs35l56_asp1_mixer_regs[index];
177 val = snd_soc_enum_item_to_val(e, item);
179 ret = regmap_update_bits_check(cs35l56->base.regmap, addr,
180 CS35L56_ASP_TXn_SRC_MASK, val, &changed);
185 snd_soc_dapm_mux_update_power(dapm, kcontrol, item, e, NULL);
190 static DECLARE_TLV_DB_SCALE(vol_tlv, -10000, 25, 0);
192 static const struct snd_kcontrol_new cs35l56_controls[] = {
193 SOC_SINGLE_EXT("Speaker Switch",
194 CS35L56_MAIN_RENDER_USER_MUTE, 0, 1, 1,
195 cs35l56_dspwait_get_volsw, cs35l56_dspwait_put_volsw),
196 SOC_SINGLE_S_EXT_TLV("Speaker Volume",
197 CS35L56_MAIN_RENDER_USER_VOLUME,
199 cs35l56_dspwait_get_volsw,
200 cs35l56_dspwait_put_volsw,
202 SOC_SINGLE_EXT("Posture Number", CS35L56_MAIN_POSTURE_NUMBER,
204 cs35l56_dspwait_get_volsw, cs35l56_dspwait_put_volsw),
207 static SOC_VALUE_ENUM_SINGLE_DECL(cs35l56_asp1tx1_enum,
210 cs35l56_tx_input_texts,
211 cs35l56_tx_input_values);
213 static const struct snd_kcontrol_new asp1_tx1_mux =
214 SOC_DAPM_ENUM_EXT("ASP1TX1 SRC", cs35l56_asp1tx1_enum,
215 cs35l56_dspwait_asp1tx_get, cs35l56_dspwait_asp1tx_put);
217 static SOC_VALUE_ENUM_SINGLE_DECL(cs35l56_asp1tx2_enum,
220 cs35l56_tx_input_texts,
221 cs35l56_tx_input_values);
223 static const struct snd_kcontrol_new asp1_tx2_mux =
224 SOC_DAPM_ENUM_EXT("ASP1TX2 SRC", cs35l56_asp1tx2_enum,
225 cs35l56_dspwait_asp1tx_get, cs35l56_dspwait_asp1tx_put);
227 static SOC_VALUE_ENUM_SINGLE_DECL(cs35l56_asp1tx3_enum,
230 cs35l56_tx_input_texts,
231 cs35l56_tx_input_values);
233 static const struct snd_kcontrol_new asp1_tx3_mux =
234 SOC_DAPM_ENUM_EXT("ASP1TX3 SRC", cs35l56_asp1tx3_enum,
235 cs35l56_dspwait_asp1tx_get, cs35l56_dspwait_asp1tx_put);
237 static SOC_VALUE_ENUM_SINGLE_DECL(cs35l56_asp1tx4_enum,
240 cs35l56_tx_input_texts,
241 cs35l56_tx_input_values);
243 static const struct snd_kcontrol_new asp1_tx4_mux =
244 SOC_DAPM_ENUM_EXT("ASP1TX4 SRC", cs35l56_asp1tx4_enum,
245 cs35l56_dspwait_asp1tx_get, cs35l56_dspwait_asp1tx_put);
247 static SOC_VALUE_ENUM_SINGLE_DECL(cs35l56_sdw1tx1_enum,
248 CS35L56_SWIRE_DP3_CH1_INPUT,
249 0, CS35L56_SWIRETXn_SRC_MASK,
250 cs35l56_tx_input_texts,
251 cs35l56_tx_input_values);
253 static const struct snd_kcontrol_new sdw1_tx1_mux =
254 SOC_DAPM_ENUM("SDW1TX1 SRC", cs35l56_sdw1tx1_enum);
256 static SOC_VALUE_ENUM_SINGLE_DECL(cs35l56_sdw1tx2_enum,
257 CS35L56_SWIRE_DP3_CH2_INPUT,
258 0, CS35L56_SWIRETXn_SRC_MASK,
259 cs35l56_tx_input_texts,
260 cs35l56_tx_input_values);
262 static const struct snd_kcontrol_new sdw1_tx2_mux =
263 SOC_DAPM_ENUM("SDW1TX2 SRC", cs35l56_sdw1tx2_enum);
265 static SOC_VALUE_ENUM_SINGLE_DECL(cs35l56_sdw1tx3_enum,
266 CS35L56_SWIRE_DP3_CH3_INPUT,
267 0, CS35L56_SWIRETXn_SRC_MASK,
268 cs35l56_tx_input_texts,
269 cs35l56_tx_input_values);
271 static const struct snd_kcontrol_new sdw1_tx3_mux =
272 SOC_DAPM_ENUM("SDW1TX3 SRC", cs35l56_sdw1tx3_enum);
274 static SOC_VALUE_ENUM_SINGLE_DECL(cs35l56_sdw1tx4_enum,
275 CS35L56_SWIRE_DP3_CH4_INPUT,
276 0, CS35L56_SWIRETXn_SRC_MASK,
277 cs35l56_tx_input_texts,
278 cs35l56_tx_input_values);
280 static const struct snd_kcontrol_new sdw1_tx4_mux =
281 SOC_DAPM_ENUM("SDW1TX4 SRC", cs35l56_sdw1tx4_enum);
283 static int cs35l56_asp1_cfg_event(struct snd_soc_dapm_widget *w,
284 struct snd_kcontrol *kcontrol, int event)
286 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
287 struct cs35l56_private *cs35l56 = snd_soc_component_get_drvdata(component);
290 case SND_SOC_DAPM_PRE_PMU:
291 /* Override register values set by firmware boot */
292 return cs35l56_force_sync_asp1_registers_from_cache(&cs35l56->base);
298 static int cs35l56_play_event(struct snd_soc_dapm_widget *w,
299 struct snd_kcontrol *kcontrol, int event)
301 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
302 struct cs35l56_private *cs35l56 = snd_soc_component_get_drvdata(component);
306 dev_dbg(cs35l56->base.dev, "play: %d\n", event);
309 case SND_SOC_DAPM_PRE_PMU:
310 /* Don't wait for ACK, we check in POST_PMU that it completed */
311 return regmap_write(cs35l56->base.regmap, CS35L56_DSP_VIRTUAL1_MBOX_1,
312 CS35L56_MBOX_CMD_AUDIO_PLAY);
313 case SND_SOC_DAPM_POST_PMU:
314 /* Wait for firmware to enter PS0 power state */
315 ret = regmap_read_poll_timeout(cs35l56->base.regmap,
316 CS35L56_TRANSDUCER_ACTUAL_PS,
317 val, (val == CS35L56_PS0),
319 CS35L56_PS0_TIMEOUT_US);
321 dev_err(cs35l56->base.dev, "PS0 wait failed: %d\n", ret);
323 case SND_SOC_DAPM_POST_PMD:
324 return cs35l56_mbox_send(&cs35l56->base, CS35L56_MBOX_CMD_AUDIO_PAUSE);
330 static const struct snd_soc_dapm_widget cs35l56_dapm_widgets[] = {
331 SND_SOC_DAPM_REGULATOR_SUPPLY("VDD_B", 0, 0),
332 SND_SOC_DAPM_REGULATOR_SUPPLY("VDD_AMP", 0, 0),
334 SND_SOC_DAPM_SUPPLY("ASP1 CFG", SND_SOC_NOPM, 0, 0, cs35l56_asp1_cfg_event,
335 SND_SOC_DAPM_PRE_PMU),
337 SND_SOC_DAPM_SUPPLY("PLAY", SND_SOC_NOPM, 0, 0, cs35l56_play_event,
338 SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_POST_PMD),
340 SND_SOC_DAPM_OUT_DRV("AMP", SND_SOC_NOPM, 0, 0, NULL, 0),
341 SND_SOC_DAPM_OUTPUT("SPK"),
343 SND_SOC_DAPM_PGA_E("DSP1", SND_SOC_NOPM, 0, 0, NULL, 0, cs35l56_dsp_event,
344 SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD),
346 SND_SOC_DAPM_AIF_IN("ASP1RX1", NULL, 0, CS35L56_ASP1_ENABLES1,
347 CS35L56_ASP_RX1_EN_SHIFT, 0),
348 SND_SOC_DAPM_AIF_IN("ASP1RX2", NULL, 1, CS35L56_ASP1_ENABLES1,
349 CS35L56_ASP_RX2_EN_SHIFT, 0),
350 SND_SOC_DAPM_AIF_OUT("ASP1TX1", NULL, 0, CS35L56_ASP1_ENABLES1,
351 CS35L56_ASP_TX1_EN_SHIFT, 0),
352 SND_SOC_DAPM_AIF_OUT("ASP1TX2", NULL, 1, CS35L56_ASP1_ENABLES1,
353 CS35L56_ASP_TX2_EN_SHIFT, 0),
354 SND_SOC_DAPM_AIF_OUT("ASP1TX3", NULL, 2, CS35L56_ASP1_ENABLES1,
355 CS35L56_ASP_TX3_EN_SHIFT, 0),
356 SND_SOC_DAPM_AIF_OUT("ASP1TX4", NULL, 3, CS35L56_ASP1_ENABLES1,
357 CS35L56_ASP_TX4_EN_SHIFT, 0),
359 SND_SOC_DAPM_MUX("ASP1 TX1 Source", SND_SOC_NOPM, 0, 0, &asp1_tx1_mux),
360 SND_SOC_DAPM_MUX("ASP1 TX2 Source", SND_SOC_NOPM, 0, 0, &asp1_tx2_mux),
361 SND_SOC_DAPM_MUX("ASP1 TX3 Source", SND_SOC_NOPM, 0, 0, &asp1_tx3_mux),
362 SND_SOC_DAPM_MUX("ASP1 TX4 Source", SND_SOC_NOPM, 0, 0, &asp1_tx4_mux),
364 SND_SOC_DAPM_MUX("SDW1 TX1 Source", SND_SOC_NOPM, 0, 0, &sdw1_tx1_mux),
365 SND_SOC_DAPM_MUX("SDW1 TX2 Source", SND_SOC_NOPM, 0, 0, &sdw1_tx2_mux),
366 SND_SOC_DAPM_MUX("SDW1 TX3 Source", SND_SOC_NOPM, 0, 0, &sdw1_tx3_mux),
367 SND_SOC_DAPM_MUX("SDW1 TX4 Source", SND_SOC_NOPM, 0, 0, &sdw1_tx4_mux),
369 SND_SOC_DAPM_SIGGEN("VMON ADC"),
370 SND_SOC_DAPM_SIGGEN("IMON ADC"),
371 SND_SOC_DAPM_SIGGEN("ERRVOL ADC"),
372 SND_SOC_DAPM_SIGGEN("CLASSH ADC"),
373 SND_SOC_DAPM_SIGGEN("VDDBMON ADC"),
374 SND_SOC_DAPM_SIGGEN("VBSTMON ADC"),
375 SND_SOC_DAPM_SIGGEN("TEMPMON ADC"),
378 #define CS35L56_SRC_ROUTE(name) \
379 { name" Source", "ASP1RX1", "ASP1RX1" }, \
380 { name" Source", "ASP1RX2", "ASP1RX2" }, \
381 { name" Source", "VMON", "VMON ADC" }, \
382 { name" Source", "IMON", "IMON ADC" }, \
383 { name" Source", "ERRVOL", "ERRVOL ADC" }, \
384 { name" Source", "CLASSH", "CLASSH ADC" }, \
385 { name" Source", "VDDBMON", "VDDBMON ADC" }, \
386 { name" Source", "VBSTMON", "VBSTMON ADC" }, \
387 { name" Source", "DSP1TX1", "DSP1" }, \
388 { name" Source", "DSP1TX2", "DSP1" }, \
389 { name" Source", "DSP1TX3", "DSP1" }, \
390 { name" Source", "DSP1TX4", "DSP1" }, \
391 { name" Source", "DSP1TX5", "DSP1" }, \
392 { name" Source", "DSP1TX6", "DSP1" }, \
393 { name" Source", "DSP1TX7", "DSP1" }, \
394 { name" Source", "DSP1TX8", "DSP1" }, \
395 { name" Source", "TEMPMON", "TEMPMON ADC" }, \
396 { name" Source", "INTERPOLATOR", "AMP" }, \
397 { name" Source", "SDW1RX1", "SDW1 Playback" }, \
398 { name" Source", "SDW1RX2", "SDW1 Playback" },
400 static const struct snd_soc_dapm_route cs35l56_audio_map[] = {
401 { "AMP", NULL, "VDD_B" },
402 { "AMP", NULL, "VDD_AMP" },
404 { "ASP1 Playback", NULL, "ASP1 CFG" },
405 { "ASP1 Capture", NULL, "ASP1 CFG" },
407 { "ASP1 Playback", NULL, "PLAY" },
408 { "SDW1 Playback", NULL, "PLAY" },
410 { "ASP1RX1", NULL, "ASP1 Playback" },
411 { "ASP1RX2", NULL, "ASP1 Playback" },
412 { "DSP1", NULL, "ASP1RX1" },
413 { "DSP1", NULL, "ASP1RX2" },
414 { "DSP1", NULL, "SDW1 Playback" },
415 { "AMP", NULL, "DSP1" },
416 { "SPK", NULL, "AMP" },
418 CS35L56_SRC_ROUTE("ASP1 TX1")
419 CS35L56_SRC_ROUTE("ASP1 TX2")
420 CS35L56_SRC_ROUTE("ASP1 TX3")
421 CS35L56_SRC_ROUTE("ASP1 TX4")
423 { "ASP1TX1", NULL, "ASP1 TX1 Source" },
424 { "ASP1TX2", NULL, "ASP1 TX2 Source" },
425 { "ASP1TX3", NULL, "ASP1 TX3 Source" },
426 { "ASP1TX4", NULL, "ASP1 TX4 Source" },
427 { "ASP1 Capture", NULL, "ASP1TX1" },
428 { "ASP1 Capture", NULL, "ASP1TX2" },
429 { "ASP1 Capture", NULL, "ASP1TX3" },
430 { "ASP1 Capture", NULL, "ASP1TX4" },
432 CS35L56_SRC_ROUTE("SDW1 TX1")
433 CS35L56_SRC_ROUTE("SDW1 TX2")
434 CS35L56_SRC_ROUTE("SDW1 TX3")
435 CS35L56_SRC_ROUTE("SDW1 TX4")
436 { "SDW1 Capture", NULL, "SDW1 TX1 Source" },
437 { "SDW1 Capture", NULL, "SDW1 TX2 Source" },
438 { "SDW1 Capture", NULL, "SDW1 TX3 Source" },
439 { "SDW1 Capture", NULL, "SDW1 TX4 Source" },
442 static int cs35l56_dsp_event(struct snd_soc_dapm_widget *w,
443 struct snd_kcontrol *kcontrol, int event)
445 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
446 struct cs35l56_private *cs35l56 = snd_soc_component_get_drvdata(component);
448 dev_dbg(cs35l56->base.dev, "%s: %d\n", __func__, event);
450 return wm_adsp_event(w, kcontrol, event);
453 static int cs35l56_asp_dai_set_fmt(struct snd_soc_dai *codec_dai, unsigned int fmt)
455 struct cs35l56_private *cs35l56 = snd_soc_component_get_drvdata(codec_dai->component);
459 dev_dbg(cs35l56->base.dev, "%s: %#x\n", __func__, fmt);
461 ret = cs35l56_init_asp1_regs_for_driver_control(&cs35l56->base);
465 switch (fmt & SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) {
466 case SND_SOC_DAIFMT_CBC_CFC:
469 dev_err(cs35l56->base.dev, "Unsupported clock source mode\n");
473 switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
474 case SND_SOC_DAIFMT_DSP_A:
475 val = CS35L56_ASP_FMT_DSP_A << CS35L56_ASP_FMT_SHIFT;
476 cs35l56->tdm_mode = true;
478 case SND_SOC_DAIFMT_I2S:
479 val = CS35L56_ASP_FMT_I2S << CS35L56_ASP_FMT_SHIFT;
480 cs35l56->tdm_mode = false;
483 dev_err(cs35l56->base.dev, "Unsupported DAI format\n");
487 switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
488 case SND_SOC_DAIFMT_NB_IF:
489 val |= CS35L56_ASP_FSYNC_INV_MASK;
491 case SND_SOC_DAIFMT_IB_NF:
492 val |= CS35L56_ASP_BCLK_INV_MASK;
494 case SND_SOC_DAIFMT_IB_IF:
495 val |= CS35L56_ASP_BCLK_INV_MASK | CS35L56_ASP_FSYNC_INV_MASK;
497 case SND_SOC_DAIFMT_NB_NF:
500 dev_err(cs35l56->base.dev, "Invalid clock invert\n");
504 regmap_update_bits(cs35l56->base.regmap,
505 CS35L56_ASP1_CONTROL2,
506 CS35L56_ASP_FMT_MASK |
507 CS35L56_ASP_BCLK_INV_MASK | CS35L56_ASP_FSYNC_INV_MASK,
510 /* Hi-Z DOUT in unused slots and when all TX are disabled */
511 regmap_update_bits(cs35l56->base.regmap, CS35L56_ASP1_CONTROL3,
512 CS35L56_ASP1_DOUT_HIZ_CTRL_MASK,
513 CS35L56_ASP_UNUSED_HIZ_OFF_HIZ);
518 static unsigned int cs35l56_make_tdm_config_word(unsigned int reg_val, unsigned long mask)
520 unsigned int channel_shift;
523 /* Enable consecutive TX1..TXn for each of the slots set in mask */
525 for_each_set_bit(bit_num, &mask, 32) {
526 reg_val &= ~(0x3f << channel_shift);
527 reg_val |= bit_num << channel_shift;
534 static int cs35l56_asp_dai_set_tdm_slot(struct snd_soc_dai *dai, unsigned int tx_mask,
535 unsigned int rx_mask, int slots, int slot_width)
537 struct cs35l56_private *cs35l56 = snd_soc_component_get_drvdata(dai->component);
540 ret = cs35l56_init_asp1_regs_for_driver_control(&cs35l56->base);
544 if ((slots == 0) || (slot_width == 0)) {
545 dev_dbg(cs35l56->base.dev, "tdm config cleared\n");
546 cs35l56->asp_slot_width = 0;
547 cs35l56->asp_slot_count = 0;
551 if (slot_width > (CS35L56_ASP_RX_WIDTH_MASK >> CS35L56_ASP_RX_WIDTH_SHIFT)) {
552 dev_err(cs35l56->base.dev, "tdm invalid slot width %d\n", slot_width);
556 /* More than 32 slots would give an unsupportable BCLK frequency */
558 dev_err(cs35l56->base.dev, "tdm invalid slot count %d\n", slots);
562 cs35l56->asp_slot_width = (u8)slot_width;
563 cs35l56->asp_slot_count = (u8)slots;
565 // Note: rx/tx is from point of view of the CPU end
567 tx_mask = 0x3; // ASPRX1/RX2 in slots 0 and 1
570 rx_mask = 0xf; // ASPTX1..TX4 in slots 0..3
572 /* Default unused slots to 63 */
573 regmap_write(cs35l56->base.regmap, CS35L56_ASP1_FRAME_CONTROL1,
574 cs35l56_make_tdm_config_word(0x3f3f3f3f, rx_mask));
575 regmap_write(cs35l56->base.regmap, CS35L56_ASP1_FRAME_CONTROL5,
576 cs35l56_make_tdm_config_word(0x3f3f3f, tx_mask));
578 dev_dbg(cs35l56->base.dev, "tdm slot width: %u count: %u tx_mask: %#x rx_mask: %#x\n",
579 cs35l56->asp_slot_width, cs35l56->asp_slot_count, tx_mask, rx_mask);
584 static int cs35l56_asp_dai_hw_params(struct snd_pcm_substream *substream,
585 struct snd_pcm_hw_params *params,
586 struct snd_soc_dai *dai)
588 struct cs35l56_private *cs35l56 = snd_soc_component_get_drvdata(dai->component);
589 unsigned int rate = params_rate(params);
590 u8 asp_width, asp_wl;
593 ret = cs35l56_init_asp1_regs_for_driver_control(&cs35l56->base);
597 asp_wl = params_width(params);
598 if (cs35l56->asp_slot_width)
599 asp_width = cs35l56->asp_slot_width;
603 dev_dbg(cs35l56->base.dev, "%s: wl=%d, width=%d, rate=%d",
604 __func__, asp_wl, asp_width, rate);
606 if (!cs35l56->sysclk_set) {
607 unsigned int slots = cs35l56->asp_slot_count;
608 unsigned int bclk_freq;
612 slots = params_channels(params);
614 /* I2S always has an even number of slots */
615 if (!cs35l56->tdm_mode)
616 slots = round_up(slots, 2);
619 bclk_freq = asp_width * slots * rate;
620 freq_id = cs35l56_get_bclk_freq_id(bclk_freq);
622 dev_err(cs35l56->base.dev, "%s: Invalid BCLK %u\n", __func__, bclk_freq);
626 regmap_update_bits(cs35l56->base.regmap, CS35L56_ASP1_CONTROL1,
627 CS35L56_ASP_BCLK_FREQ_MASK,
628 freq_id << CS35L56_ASP_BCLK_FREQ_SHIFT);
631 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
632 regmap_update_bits(cs35l56->base.regmap, CS35L56_ASP1_CONTROL2,
633 CS35L56_ASP_RX_WIDTH_MASK, asp_width <<
634 CS35L56_ASP_RX_WIDTH_SHIFT);
635 regmap_update_bits(cs35l56->base.regmap, CS35L56_ASP1_DATA_CONTROL5,
636 CS35L56_ASP_RX_WL_MASK, asp_wl);
638 regmap_update_bits(cs35l56->base.regmap, CS35L56_ASP1_CONTROL2,
639 CS35L56_ASP_TX_WIDTH_MASK, asp_width <<
640 CS35L56_ASP_TX_WIDTH_SHIFT);
641 regmap_update_bits(cs35l56->base.regmap, CS35L56_ASP1_DATA_CONTROL1,
642 CS35L56_ASP_TX_WL_MASK, asp_wl);
648 static int cs35l56_asp_dai_set_sysclk(struct snd_soc_dai *dai,
649 int clk_id, unsigned int freq, int dir)
651 struct cs35l56_private *cs35l56 = snd_soc_component_get_drvdata(dai->component);
654 ret = cs35l56_init_asp1_regs_for_driver_control(&cs35l56->base);
659 cs35l56->sysclk_set = false;
663 freq_id = cs35l56_get_bclk_freq_id(freq);
667 regmap_update_bits(cs35l56->base.regmap, CS35L56_ASP1_CONTROL1,
668 CS35L56_ASP_BCLK_FREQ_MASK,
669 freq_id << CS35L56_ASP_BCLK_FREQ_SHIFT);
670 cs35l56->sysclk_set = true;
675 static const struct snd_soc_dai_ops cs35l56_ops = {
676 .set_fmt = cs35l56_asp_dai_set_fmt,
677 .set_tdm_slot = cs35l56_asp_dai_set_tdm_slot,
678 .hw_params = cs35l56_asp_dai_hw_params,
679 .set_sysclk = cs35l56_asp_dai_set_sysclk,
682 static void cs35l56_sdw_dai_shutdown(struct snd_pcm_substream *substream,
683 struct snd_soc_dai *dai)
685 snd_soc_dai_set_dma_data(dai, substream, NULL);
688 static int cs35l56_sdw_dai_set_tdm_slot(struct snd_soc_dai *dai, unsigned int tx_mask,
689 unsigned int rx_mask, int slots, int slot_width)
691 struct cs35l56_private *cs35l56 = snd_soc_component_get_drvdata(dai->component);
693 /* rx/tx are from point of view of the CPU end so opposite to our rx/tx */
694 cs35l56->rx_mask = tx_mask;
695 cs35l56->tx_mask = rx_mask;
700 static int cs35l56_sdw_dai_hw_params(struct snd_pcm_substream *substream,
701 struct snd_pcm_hw_params *params,
702 struct snd_soc_dai *dai)
704 struct cs35l56_private *cs35l56 = snd_soc_component_get_drvdata(dai->component);
705 struct sdw_stream_runtime *sdw_stream = snd_soc_dai_get_dma_data(dai, substream);
706 struct sdw_stream_config sconfig;
707 struct sdw_port_config pconfig;
710 dev_dbg(cs35l56->base.dev, "%s: rate %d\n", __func__, params_rate(params));
712 if (!cs35l56->base.init_done)
718 memset(&sconfig, 0, sizeof(sconfig));
719 memset(&pconfig, 0, sizeof(pconfig));
721 sconfig.frame_rate = params_rate(params);
722 sconfig.bps = snd_pcm_format_width(params_format(params));
724 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
725 sconfig.direction = SDW_DATA_DIR_RX;
726 pconfig.num = CS35L56_SDW1_PLAYBACK_PORT;
727 pconfig.ch_mask = cs35l56->rx_mask;
729 sconfig.direction = SDW_DATA_DIR_TX;
730 pconfig.num = CS35L56_SDW1_CAPTURE_PORT;
731 pconfig.ch_mask = cs35l56->tx_mask;
734 if (pconfig.ch_mask == 0) {
735 sconfig.ch_count = params_channels(params);
736 pconfig.ch_mask = GENMASK(sconfig.ch_count - 1, 0);
738 sconfig.ch_count = hweight32(pconfig.ch_mask);
741 ret = sdw_stream_add_slave(cs35l56->sdw_peripheral, &sconfig, &pconfig,
744 dev_err(dai->dev, "Failed to add sdw stream: %d\n", ret);
751 static int cs35l56_sdw_dai_hw_free(struct snd_pcm_substream *substream,
752 struct snd_soc_dai *dai)
754 struct cs35l56_private *cs35l56 = snd_soc_component_get_drvdata(dai->component);
755 struct sdw_stream_runtime *sdw_stream = snd_soc_dai_get_dma_data(dai, substream);
757 if (!cs35l56->sdw_peripheral)
760 sdw_stream_remove_slave(cs35l56->sdw_peripheral, sdw_stream);
765 static int cs35l56_sdw_dai_set_stream(struct snd_soc_dai *dai,
766 void *sdw_stream, int direction)
768 snd_soc_dai_dma_data_set(dai, direction, sdw_stream);
773 static const struct snd_soc_dai_ops cs35l56_sdw_dai_ops = {
774 .set_tdm_slot = cs35l56_sdw_dai_set_tdm_slot,
775 .shutdown = cs35l56_sdw_dai_shutdown,
776 .hw_params = cs35l56_sdw_dai_hw_params,
777 .hw_free = cs35l56_sdw_dai_hw_free,
778 .set_stream = cs35l56_sdw_dai_set_stream,
781 static struct snd_soc_dai_driver cs35l56_dai[] = {
783 .name = "cs35l56-asp1",
786 .stream_name = "ASP1 Playback",
789 .rates = CS35L56_RATES,
790 .formats = CS35L56_RX_FORMATS,
793 .stream_name = "ASP1 Capture",
796 .rates = CS35L56_RATES,
797 .formats = CS35L56_TX_FORMATS,
801 .symmetric_sample_bits = 1,
804 .name = "cs35l56-sdw1",
807 .stream_name = "SDW1 Playback",
810 .rates = CS35L56_RATES,
811 .formats = CS35L56_RX_FORMATS,
814 .stream_name = "SDW1 Capture",
817 .rates = CS35L56_RATES,
818 .formats = CS35L56_TX_FORMATS,
821 .ops = &cs35l56_sdw_dai_ops,
825 static int cs35l56_write_cal(struct cs35l56_private *cs35l56)
829 if (cs35l56->base.secured || !cs35l56->base.cal_data_valid)
832 ret = wm_adsp_run(&cs35l56->dsp);
836 ret = cs_amp_write_cal_coeffs(&cs35l56->dsp.cs_dsp,
837 &cs35l56_calibration_controls,
838 &cs35l56->base.cal_data);
840 wm_adsp_stop(&cs35l56->dsp);
843 dev_info(cs35l56->base.dev, "Calibration applied\n");
848 static void cs35l56_reinit_patch(struct cs35l56_private *cs35l56)
852 /* Use wm_adsp to load and apply the firmware patch and coefficient files */
853 ret = wm_adsp_power_up(&cs35l56->dsp, true);
855 dev_dbg(cs35l56->base.dev, "%s: wm_adsp_power_up ret %d\n", __func__, ret);
859 cs35l56_write_cal(cs35l56);
861 /* Always REINIT after applying patch or coefficients */
862 cs35l56_mbox_send(&cs35l56->base, CS35L56_MBOX_CMD_AUDIO_REINIT);
865 static void cs35l56_patch(struct cs35l56_private *cs35l56, bool firmware_missing)
870 * Disable SoundWire interrupts to prevent race with IRQ work.
871 * Setting sdw_irq_no_unmask prevents the handler re-enabling
872 * the SoundWire interrupt.
874 if (cs35l56->sdw_peripheral) {
875 cs35l56->sdw_irq_no_unmask = true;
876 flush_work(&cs35l56->sdw_irq_work);
877 sdw_write_no_pm(cs35l56->sdw_peripheral, CS35L56_SDW_GEN_INT_MASK_1, 0);
878 sdw_read_no_pm(cs35l56->sdw_peripheral, CS35L56_SDW_GEN_INT_STAT_1);
879 sdw_write_no_pm(cs35l56->sdw_peripheral, CS35L56_SDW_GEN_INT_STAT_1, 0xFF);
880 flush_work(&cs35l56->sdw_irq_work);
883 ret = cs35l56_firmware_shutdown(&cs35l56->base);
888 * Use wm_adsp to load and apply the firmware patch and coefficient files,
889 * but only if firmware is missing. If firmware is already patched just
890 * power-up wm_adsp without downloading firmware.
892 ret = wm_adsp_power_up(&cs35l56->dsp, !!firmware_missing);
894 dev_dbg(cs35l56->base.dev, "%s: wm_adsp_power_up ret %d\n", __func__, ret);
898 mutex_lock(&cs35l56->base.irq_lock);
900 reinit_completion(&cs35l56->init_completion);
902 cs35l56->soft_resetting = true;
903 cs35l56_system_reset(&cs35l56->base, !!cs35l56->sdw_peripheral);
905 if (cs35l56->sdw_peripheral) {
907 * The system-reset causes the CS35L56 to detach from the bus.
908 * Wait for the manager to re-enumerate the CS35L56 and
909 * cs35l56_init() to run again.
911 if (!wait_for_completion_timeout(&cs35l56->init_completion,
912 msecs_to_jiffies(5000))) {
913 dev_err(cs35l56->base.dev, "%s: init_completion timed out (SDW)\n",
917 } else if (cs35l56_init(cs35l56)) {
921 regmap_clear_bits(cs35l56->base.regmap, CS35L56_PROTECTION_STATUS,
922 CS35L56_FIRMWARE_MISSING);
923 cs35l56->base.fw_patched = true;
925 if (cs35l56_write_cal(cs35l56) == 0)
926 cs35l56_mbox_send(&cs35l56->base, CS35L56_MBOX_CMD_AUDIO_REINIT);
929 mutex_unlock(&cs35l56->base.irq_lock);
931 /* Re-enable SoundWire interrupts */
932 if (cs35l56->sdw_peripheral) {
933 cs35l56->sdw_irq_no_unmask = false;
934 sdw_write_no_pm(cs35l56->sdw_peripheral, CS35L56_SDW_GEN_INT_MASK_1,
935 CS35L56_SDW_INT_MASK_CODEC_IRQ);
939 static void cs35l56_dsp_work(struct work_struct *work)
941 struct cs35l56_private *cs35l56 = container_of(work,
942 struct cs35l56_private,
944 unsigned int firmware_version;
945 bool firmware_missing;
948 if (!cs35l56->base.init_done)
951 pm_runtime_get_sync(cs35l56->base.dev);
953 ret = cs35l56_read_prot_status(&cs35l56->base, &firmware_missing, &firmware_version);
957 /* Populate fw file qualifier with the revision and security state */
958 kfree(cs35l56->dsp.fwf_name);
959 if (firmware_missing) {
960 cs35l56->dsp.fwf_name = kasprintf(GFP_KERNEL, "%02x-dsp1", cs35l56->base.rev);
962 /* Firmware files must match the running firmware version */
963 cs35l56->dsp.fwf_name = kasprintf(GFP_KERNEL,
966 cs35l56->base.secured ? "-s" : "",
970 if (!cs35l56->dsp.fwf_name)
973 dev_dbg(cs35l56->base.dev, "DSP fwf name: '%s' system name: '%s'\n",
974 cs35l56->dsp.fwf_name, cs35l56->dsp.system_name);
977 * The firmware cannot be patched if it is already running from
978 * patch RAM. In this case the firmware files are versioned to
979 * match the running firmware version and will only contain
980 * tunings. We do not need to shutdown the firmware to apply
981 * tunings so can use the lower cost reinit sequence instead.
983 if (!firmware_missing)
984 cs35l56_reinit_patch(cs35l56);
986 cs35l56_patch(cs35l56, firmware_missing);
989 pm_runtime_mark_last_busy(cs35l56->base.dev);
990 pm_runtime_put_autosuspend(cs35l56->base.dev);
993 static int cs35l56_component_probe(struct snd_soc_component *component)
995 struct cs35l56_private *cs35l56 = snd_soc_component_get_drvdata(component);
996 struct dentry *debugfs_root = component->debugfs_root;
997 unsigned short vendor, device;
999 BUILD_BUG_ON(ARRAY_SIZE(cs35l56_tx_input_texts) != ARRAY_SIZE(cs35l56_tx_input_values));
1001 if (!cs35l56->dsp.system_name &&
1002 (snd_soc_card_get_pci_ssid(component->card, &vendor, &device) == 0)) {
1003 /* Append a speaker qualifier if there is a speaker ID */
1004 if (cs35l56->speaker_id >= 0) {
1005 cs35l56->dsp.system_name = devm_kasprintf(cs35l56->base.dev,
1009 cs35l56->speaker_id);
1011 cs35l56->dsp.system_name = devm_kasprintf(cs35l56->base.dev,
1016 if (!cs35l56->dsp.system_name)
1020 if (!wait_for_completion_timeout(&cs35l56->init_completion,
1021 msecs_to_jiffies(5000))) {
1022 dev_err(cs35l56->base.dev, "%s: init_completion timed out\n", __func__);
1026 cs35l56->dsp.part = kasprintf(GFP_KERNEL, "cs35l%02x", cs35l56->base.type);
1027 if (!cs35l56->dsp.part)
1030 cs35l56->component = component;
1031 wm_adsp2_component_probe(&cs35l56->dsp, component);
1033 debugfs_create_bool("init_done", 0444, debugfs_root, &cs35l56->base.init_done);
1034 debugfs_create_bool("can_hibernate", 0444, debugfs_root, &cs35l56->base.can_hibernate);
1035 debugfs_create_bool("fw_patched", 0444, debugfs_root, &cs35l56->base.fw_patched);
1038 * The widgets for the ASP1TX mixer can't be initialized
1039 * until the firmware has been downloaded and rebooted.
1041 regcache_drop_region(cs35l56->base.regmap, CS35L56_ASP1TX1_INPUT, CS35L56_ASP1TX4_INPUT);
1042 cs35l56->asp1_mixer_widgets_initialized = false;
1044 queue_work(cs35l56->dsp_wq, &cs35l56->dsp_work);
1049 static void cs35l56_component_remove(struct snd_soc_component *component)
1051 struct cs35l56_private *cs35l56 = snd_soc_component_get_drvdata(component);
1053 cancel_work_sync(&cs35l56->dsp_work);
1055 if (cs35l56->dsp.cs_dsp.booted)
1056 wm_adsp_power_down(&cs35l56->dsp);
1058 wm_adsp2_component_remove(&cs35l56->dsp, component);
1060 kfree(cs35l56->dsp.part);
1061 cs35l56->dsp.part = NULL;
1063 kfree(cs35l56->dsp.fwf_name);
1064 cs35l56->dsp.fwf_name = NULL;
1066 cs35l56->component = NULL;
1069 static int cs35l56_set_bias_level(struct snd_soc_component *component,
1070 enum snd_soc_bias_level level)
1072 struct cs35l56_private *cs35l56 = snd_soc_component_get_drvdata(component);
1075 case SND_SOC_BIAS_STANDBY:
1077 * Wait for patching to complete when transitioning from
1078 * BIAS_OFF to BIAS_STANDBY
1080 if (snd_soc_component_get_bias_level(component) == SND_SOC_BIAS_OFF)
1081 cs35l56_wait_dsp_ready(cs35l56);
1091 static const struct snd_soc_component_driver soc_component_dev_cs35l56 = {
1092 .probe = cs35l56_component_probe,
1093 .remove = cs35l56_component_remove,
1095 .dapm_widgets = cs35l56_dapm_widgets,
1096 .num_dapm_widgets = ARRAY_SIZE(cs35l56_dapm_widgets),
1097 .dapm_routes = cs35l56_audio_map,
1098 .num_dapm_routes = ARRAY_SIZE(cs35l56_audio_map),
1099 .controls = cs35l56_controls,
1100 .num_controls = ARRAY_SIZE(cs35l56_controls),
1102 .set_bias_level = cs35l56_set_bias_level,
1104 .suspend_bias_off = 1, /* see cs35l56_system_resume() */
1107 static int __maybe_unused cs35l56_runtime_suspend_i2c_spi(struct device *dev)
1109 struct cs35l56_private *cs35l56 = dev_get_drvdata(dev);
1111 return cs35l56_runtime_suspend_common(&cs35l56->base);
1114 static int __maybe_unused cs35l56_runtime_resume_i2c_spi(struct device *dev)
1116 struct cs35l56_private *cs35l56 = dev_get_drvdata(dev);
1118 return cs35l56_runtime_resume_common(&cs35l56->base, false);
1121 int cs35l56_system_suspend(struct device *dev)
1123 struct cs35l56_private *cs35l56 = dev_get_drvdata(dev);
1125 dev_dbg(dev, "system_suspend\n");
1127 if (cs35l56->component)
1128 flush_work(&cs35l56->dsp_work);
1131 * The interrupt line is normally shared, but after we start suspending
1132 * we can't check if our device is the source of an interrupt, and can't
1133 * clear it. Prevent this race by temporarily disabling the parent irq
1134 * until we reach _no_irq.
1136 if (cs35l56->base.irq)
1137 disable_irq(cs35l56->base.irq);
1139 return pm_runtime_force_suspend(dev);
1141 EXPORT_SYMBOL_GPL(cs35l56_system_suspend);
1143 int cs35l56_system_suspend_late(struct device *dev)
1145 struct cs35l56_private *cs35l56 = dev_get_drvdata(dev);
1147 dev_dbg(dev, "system_suspend_late\n");
1150 * Assert RESET before removing supplies.
1151 * RESET is usually shared by all amps so it must not be asserted until
1152 * all driver instances have done their suspend() stage.
1154 if (cs35l56->base.reset_gpio) {
1155 gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 0);
1156 cs35l56_wait_min_reset_pulse();
1159 regulator_bulk_disable(ARRAY_SIZE(cs35l56->supplies), cs35l56->supplies);
1163 EXPORT_SYMBOL_GPL(cs35l56_system_suspend_late);
1165 int cs35l56_system_suspend_no_irq(struct device *dev)
1167 struct cs35l56_private *cs35l56 = dev_get_drvdata(dev);
1169 dev_dbg(dev, "system_suspend_no_irq\n");
1171 /* Handlers are now disabled so the parent IRQ can safely be re-enabled. */
1172 if (cs35l56->base.irq)
1173 enable_irq(cs35l56->base.irq);
1177 EXPORT_SYMBOL_GPL(cs35l56_system_suspend_no_irq);
1179 int cs35l56_system_resume_no_irq(struct device *dev)
1181 struct cs35l56_private *cs35l56 = dev_get_drvdata(dev);
1183 dev_dbg(dev, "system_resume_no_irq\n");
1186 * WAKE interrupts unmask if the CS35L56 hibernates, which can cause
1187 * spurious interrupts, and the interrupt line is normally shared.
1188 * We can't check if our device is the source of an interrupt, and can't
1189 * clear it, until it has fully resumed. Prevent this race by temporarily
1190 * disabling the parent irq until we complete resume().
1192 if (cs35l56->base.irq)
1193 disable_irq(cs35l56->base.irq);
1197 EXPORT_SYMBOL_GPL(cs35l56_system_resume_no_irq);
1199 int cs35l56_system_resume_early(struct device *dev)
1201 struct cs35l56_private *cs35l56 = dev_get_drvdata(dev);
1204 dev_dbg(dev, "system_resume_early\n");
1206 /* Ensure a spec-compliant RESET pulse. */
1207 if (cs35l56->base.reset_gpio) {
1208 gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 0);
1209 cs35l56_wait_min_reset_pulse();
1212 /* Enable supplies before releasing RESET. */
1213 ret = regulator_bulk_enable(ARRAY_SIZE(cs35l56->supplies), cs35l56->supplies);
1215 dev_err(dev, "system_resume_early failed to enable supplies: %d\n", ret);
1219 /* Release shared RESET before drivers start resume(). */
1220 gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 1);
1224 EXPORT_SYMBOL_GPL(cs35l56_system_resume_early);
1226 int cs35l56_system_resume(struct device *dev)
1228 struct cs35l56_private *cs35l56 = dev_get_drvdata(dev);
1231 dev_dbg(dev, "system_resume\n");
1234 * We might have done a hard reset or the CS35L56 was power-cycled
1235 * so wait for control port to be ready.
1237 cs35l56_wait_control_port_ready();
1239 /* Undo pm_runtime_force_suspend() before re-enabling the irq */
1240 ret = pm_runtime_force_resume(dev);
1241 if (cs35l56->base.irq)
1242 enable_irq(cs35l56->base.irq);
1247 /* Firmware won't have been loaded if the component hasn't probed */
1248 if (!cs35l56->component)
1251 ret = cs35l56_is_fw_reload_needed(&cs35l56->base);
1252 dev_dbg(cs35l56->base.dev, "fw_reload_needed: %d\n", ret);
1256 cs35l56->base.fw_patched = false;
1257 wm_adsp_power_down(&cs35l56->dsp);
1258 queue_work(cs35l56->dsp_wq, &cs35l56->dsp_work);
1261 * suspend_bias_off ensures we are now in BIAS_OFF so there will be
1262 * a BIAS_OFF->BIAS_STANDBY transition to complete dsp patching.
1267 EXPORT_SYMBOL_GPL(cs35l56_system_resume);
1269 static int cs35l56_dsp_init(struct cs35l56_private *cs35l56)
1271 struct wm_adsp *dsp;
1274 cs35l56->dsp_wq = create_singlethread_workqueue("cs35l56-dsp");
1275 if (!cs35l56->dsp_wq)
1278 INIT_WORK(&cs35l56->dsp_work, cs35l56_dsp_work);
1280 dsp = &cs35l56->dsp;
1281 cs35l56_init_cs_dsp(&cs35l56->base, &dsp->cs_dsp);
1284 * dsp->part is filled in later as it is based on the DEVID. In a
1285 * SoundWire system that cannot be read until enumeration has occurred
1286 * and the device has attached.
1289 dsp->wmfw_optional = true;
1291 dev_dbg(cs35l56->base.dev, "DSP system name: '%s'\n", dsp->system_name);
1293 ret = wm_halo_init(dsp);
1295 dev_err(cs35l56->base.dev, "wm_halo_init failed\n");
1302 static int cs35l56_get_firmware_uid(struct cs35l56_private *cs35l56)
1304 struct device *dev = cs35l56->base.dev;
1308 ret = device_property_read_string(dev, "cirrus,firmware-uid", &prop);
1309 /* If bad sw node property, return 0 and fallback to legacy firmware path */
1313 /* Append a speaker qualifier if there is a speaker ID */
1314 if (cs35l56->speaker_id >= 0)
1315 cs35l56->dsp.system_name = devm_kasprintf(dev, GFP_KERNEL, "%s-spkid%d",
1316 prop, cs35l56->speaker_id);
1318 cs35l56->dsp.system_name = devm_kstrdup(dev, prop, GFP_KERNEL);
1320 if (cs35l56->dsp.system_name == NULL)
1323 dev_dbg(dev, "Firmware UID: %s\n", cs35l56->dsp.system_name);
1329 * Some SoundWire laptops have a spk-id-gpios property but it points to
1330 * the wrong ACPI Device node so can't be used to get the GPIO. Try to
1331 * find the SDCA node containing the GpioIo resource and add a GPIO
1334 static const struct acpi_gpio_params cs35l56_af01_first_gpio = { 0, 0, false };
1335 static const struct acpi_gpio_mapping cs35l56_af01_spkid_gpios_mapping[] = {
1336 { "spk-id-gpios", &cs35l56_af01_first_gpio, 1 },
1340 static void cs35l56_acpi_dev_release_driver_gpios(void *adev)
1342 acpi_dev_remove_driver_gpios(adev);
1345 static int cs35l56_try_get_broken_sdca_spkid_gpio(struct cs35l56_private *cs35l56)
1347 struct fwnode_handle *af01_fwnode;
1348 const union acpi_object *obj;
1349 struct gpio_desc *desc;
1352 /* Find the SDCA node containing the GpioIo */
1353 af01_fwnode = device_get_named_child_node(cs35l56->base.dev, "AF01");
1355 dev_dbg(cs35l56->base.dev, "No AF01 node\n");
1359 ret = acpi_dev_get_property(ACPI_COMPANION(cs35l56->base.dev),
1360 "spk-id-gpios", ACPI_TYPE_PACKAGE, &obj);
1362 dev_dbg(cs35l56->base.dev, "Could not get spk-id-gpios package: %d\n", ret);
1363 fwnode_handle_put(af01_fwnode);
1367 /* The broken properties we can handle are a 4-element package (one GPIO) */
1368 if (obj->package.count != 4) {
1369 dev_warn(cs35l56->base.dev, "Unexpected spk-id element count %d\n",
1370 obj->package.count);
1371 fwnode_handle_put(af01_fwnode);
1375 /* Add a GPIO mapping if it doesn't already have one */
1376 if (!fwnode_property_present(af01_fwnode, "spk-id-gpios")) {
1377 struct acpi_device *adev = to_acpi_device_node(af01_fwnode);
1380 * Can't use devm_acpi_dev_add_driver_gpios() because the
1381 * mapping isn't being added to the node pointed to by
1384 ret = acpi_dev_add_driver_gpios(adev, cs35l56_af01_spkid_gpios_mapping);
1386 fwnode_handle_put(af01_fwnode);
1387 return dev_err_probe(cs35l56->base.dev, ret,
1388 "Failed to add gpio mapping to AF01\n");
1391 ret = devm_add_action_or_reset(cs35l56->base.dev,
1392 cs35l56_acpi_dev_release_driver_gpios,
1395 fwnode_handle_put(af01_fwnode);
1399 dev_dbg(cs35l56->base.dev, "Added spk-id-gpios mapping to AF01\n");
1402 desc = fwnode_gpiod_get_index(af01_fwnode, "spk-id", 0, GPIOD_IN, NULL);
1404 fwnode_handle_put(af01_fwnode);
1405 ret = PTR_ERR(desc);
1406 return dev_err_probe(cs35l56->base.dev, ret, "Get GPIO from AF01 failed\n");
1409 ret = gpiod_get_value_cansleep(desc);
1413 fwnode_handle_put(af01_fwnode);
1414 dev_err_probe(cs35l56->base.dev, ret, "Error reading spk-id GPIO\n");
1418 fwnode_handle_put(af01_fwnode);
1420 dev_info(cs35l56->base.dev, "Got spk-id from AF01\n");
1425 int cs35l56_common_probe(struct cs35l56_private *cs35l56)
1429 init_completion(&cs35l56->init_completion);
1430 mutex_init(&cs35l56->base.irq_lock);
1431 cs35l56->base.cal_index = -1;
1432 cs35l56->speaker_id = -ENOENT;
1434 /* Assume that the firmware owns ASP1 until we know different */
1435 cs35l56->base.fw_owns_asp1 = true;
1437 dev_set_drvdata(cs35l56->base.dev, cs35l56);
1439 cs35l56_fill_supply_names(cs35l56->supplies);
1440 ret = devm_regulator_bulk_get(cs35l56->base.dev, ARRAY_SIZE(cs35l56->supplies),
1443 return dev_err_probe(cs35l56->base.dev, ret, "Failed to request supplies\n");
1445 /* Reset could be controlled by the BIOS or shared by multiple amps */
1446 cs35l56->base.reset_gpio = devm_gpiod_get_optional(cs35l56->base.dev, "reset",
1448 if (IS_ERR(cs35l56->base.reset_gpio)) {
1449 ret = PTR_ERR(cs35l56->base.reset_gpio);
1451 * If RESET is shared the first amp to probe will grab the reset
1452 * line and reset all the amps
1455 return dev_err_probe(cs35l56->base.dev, ret, "Failed to get reset GPIO\n");
1457 dev_info(cs35l56->base.dev, "Reset GPIO busy, assume shared reset\n");
1458 cs35l56->base.reset_gpio = NULL;
1461 ret = regulator_bulk_enable(ARRAY_SIZE(cs35l56->supplies), cs35l56->supplies);
1463 return dev_err_probe(cs35l56->base.dev, ret, "Failed to enable supplies\n");
1465 if (cs35l56->base.reset_gpio) {
1466 /* ACPI can override GPIOD_OUT_LOW flag so force it to start low */
1467 gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 0);
1468 cs35l56_wait_min_reset_pulse();
1469 gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 1);
1472 ret = cs35l56_get_speaker_id(&cs35l56->base);
1473 if (ACPI_COMPANION(cs35l56->base.dev) && cs35l56->sdw_peripheral && (ret == -ENOENT))
1474 ret = cs35l56_try_get_broken_sdca_spkid_gpio(cs35l56);
1476 if ((ret < 0) && (ret != -ENOENT))
1479 cs35l56->speaker_id = ret;
1481 ret = cs35l56_get_firmware_uid(cs35l56);
1485 ret = cs35l56_dsp_init(cs35l56);
1487 dev_err_probe(cs35l56->base.dev, ret, "DSP init failed\n");
1491 ret = devm_snd_soc_register_component(cs35l56->base.dev,
1492 &soc_component_dev_cs35l56,
1493 cs35l56_dai, ARRAY_SIZE(cs35l56_dai));
1495 dev_err_probe(cs35l56->base.dev, ret, "Register codec failed\n");
1502 gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 0);
1503 regulator_bulk_disable(ARRAY_SIZE(cs35l56->supplies), cs35l56->supplies);
1507 EXPORT_SYMBOL_NS_GPL(cs35l56_common_probe, SND_SOC_CS35L56_CORE);
1509 int cs35l56_init(struct cs35l56_private *cs35l56)
1514 * Check whether the actions associated with soft reset or one time
1515 * init need to be performed.
1517 if (cs35l56->soft_resetting)
1518 goto post_soft_reset;
1520 if (cs35l56->base.init_done)
1523 pm_runtime_set_autosuspend_delay(cs35l56->base.dev, 100);
1524 pm_runtime_use_autosuspend(cs35l56->base.dev);
1525 pm_runtime_set_active(cs35l56->base.dev);
1526 pm_runtime_enable(cs35l56->base.dev);
1528 ret = cs35l56_hw_init(&cs35l56->base);
1532 ret = cs35l56_set_patch(&cs35l56->base);
1536 ret = cs35l56_get_calibration(&cs35l56->base);
1540 if (!cs35l56->base.reset_gpio) {
1541 dev_dbg(cs35l56->base.dev, "No reset gpio: using soft reset\n");
1542 cs35l56->soft_resetting = true;
1543 cs35l56_system_reset(&cs35l56->base, !!cs35l56->sdw_peripheral);
1544 if (cs35l56->sdw_peripheral) {
1545 /* Keep alive while we wait for re-enumeration */
1546 pm_runtime_get_noresume(cs35l56->base.dev);
1552 if (cs35l56->soft_resetting) {
1553 cs35l56->soft_resetting = false;
1555 /* Done re-enumerating after one-time init so release the keep-alive */
1556 if (cs35l56->sdw_peripheral && !cs35l56->base.init_done)
1557 pm_runtime_put_noidle(cs35l56->base.dev);
1559 regcache_mark_dirty(cs35l56->base.regmap);
1560 ret = cs35l56_wait_for_firmware_boot(&cs35l56->base);
1564 dev_dbg(cs35l56->base.dev, "Firmware rebooted after soft reset\n");
1566 regcache_cache_only(cs35l56->base.regmap, false);
1569 /* Disable auto-hibernate so that runtime_pm has control */
1570 ret = cs35l56_mbox_send(&cs35l56->base, CS35L56_MBOX_CMD_PREVENT_AUTO_HIBERNATE);
1574 /* Registers could be dirty after soft reset or SoundWire enumeration */
1575 regcache_sync(cs35l56->base.regmap);
1577 /* Set ASP1 DOUT to high-impedance when it is not transmitting audio data. */
1578 ret = regmap_set_bits(cs35l56->base.regmap, CS35L56_ASP1_CONTROL3,
1579 CS35L56_ASP1_DOUT_HIZ_CTRL_MASK);
1581 return dev_err_probe(cs35l56->base.dev, ret, "Failed to write ASP1_CONTROL3\n");
1583 cs35l56->base.init_done = true;
1584 complete(&cs35l56->init_completion);
1588 EXPORT_SYMBOL_NS_GPL(cs35l56_init, SND_SOC_CS35L56_CORE);
1590 void cs35l56_remove(struct cs35l56_private *cs35l56)
1592 cs35l56->base.init_done = false;
1595 * WAKE IRQs unmask if CS35L56 hibernates so free the handler to
1596 * prevent it racing with remove().
1598 if (cs35l56->base.irq)
1599 devm_free_irq(cs35l56->base.dev, cs35l56->base.irq, &cs35l56->base);
1601 flush_workqueue(cs35l56->dsp_wq);
1602 destroy_workqueue(cs35l56->dsp_wq);
1604 pm_runtime_dont_use_autosuspend(cs35l56->base.dev);
1605 pm_runtime_suspend(cs35l56->base.dev);
1606 pm_runtime_disable(cs35l56->base.dev);
1608 regcache_cache_only(cs35l56->base.regmap, true);
1610 gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 0);
1611 regulator_bulk_disable(ARRAY_SIZE(cs35l56->supplies), cs35l56->supplies);
1613 EXPORT_SYMBOL_NS_GPL(cs35l56_remove, SND_SOC_CS35L56_CORE);
1615 #if IS_ENABLED(CONFIG_SND_SOC_CS35L56_I2C) || IS_ENABLED(CONFIG_SND_SOC_CS35L56_SPI)
1616 EXPORT_NS_GPL_DEV_PM_OPS(cs35l56_pm_ops_i2c_spi, SND_SOC_CS35L56_CORE) = {
1617 SET_RUNTIME_PM_OPS(cs35l56_runtime_suspend_i2c_spi, cs35l56_runtime_resume_i2c_spi, NULL)
1618 SYSTEM_SLEEP_PM_OPS(cs35l56_system_suspend, cs35l56_system_resume)
1619 LATE_SYSTEM_SLEEP_PM_OPS(cs35l56_system_suspend_late, cs35l56_system_resume_early)
1620 NOIRQ_SYSTEM_SLEEP_PM_OPS(cs35l56_system_suspend_no_irq, cs35l56_system_resume_no_irq)
1624 MODULE_DESCRIPTION("ASoC CS35L56 driver");
1625 MODULE_IMPORT_NS(SND_SOC_CS35L56_SHARED);
1626 MODULE_IMPORT_NS(SND_SOC_CS_AMP_LIB);
1627 MODULE_AUTHOR("Richard Fitzgerald <rf@opensource.cirrus.com>");
1628 MODULE_AUTHOR("Simon Trimmer <simont@opensource.cirrus.com>");
1629 MODULE_LICENSE("GPL");