xref: /linux/sound/hda/codecs/side-codecs/cs35l56_hda.c (revision 1fd1dc41724319406b0aff221a352a400b0ddfc5)
1 // SPDX-License-Identifier: GPL-2.0-only
2 //
3 // HDA audio driver for Cirrus Logic CS35L56 smart amp
4 //
5 // Copyright (C) 2023 Cirrus Logic, Inc. and
6 //                    Cirrus Logic International Semiconductor Ltd.
7 //
8 
9 #include <linux/acpi.h>
10 #include <linux/debugfs.h>
11 #include <linux/gpio/consumer.h>
12 #include <linux/module.h>
13 #include <linux/pm_runtime.h>
14 #include <linux/regmap.h>
15 #include <linux/slab.h>
16 #include <sound/core.h>
17 #include <sound/cs-amp-lib.h>
18 #include <sound/hda_codec.h>
19 #include <sound/tlv.h>
20 #include "cirrus_scodec.h"
21 #include "cs35l56_hda.h"
22 #include "hda_component.h"
23 #include "../generic.h"
24 
25  /*
26   * The cs35l56_hda_dai_config[] reg sequence configures the device as
27   *  ASP1_BCLK_FREQ = 3.072 MHz
28   *  ASP1_RX_WIDTH = 32 cycles per slot, ASP1_TX_WIDTH = 32 cycles per slot, ASP1_FMT = I2S
29   *  ASP1_DOUT_HIZ_CONTROL = Hi-Z during unused timeslots
30   *  ASP1_RX_WL = 24 bits per sample
31   *  ASP1_TX_WL = 24 bits per sample
32   *  ASP1_RXn_EN 1..3 and ASP1_TXn_EN 1..4 disabled
33   *
34   * Override any Windows-specific mixer settings applied by the firmware.
35   */
36 static const struct reg_sequence cs35l56_hda_dai_config[] = {
37 	{ CS35L56_ASP1_CONTROL1,	0x00000021 },
38 	{ CS35L56_ASP1_CONTROL2,	0x20200200 },
39 	{ CS35L56_ASP1_CONTROL3,	0x00000003 },
40 	{ CS35L56_ASP1_FRAME_CONTROL1,	0x03020100 },
41 	{ CS35L56_ASP1_FRAME_CONTROL5,	0x00020100 },
42 	{ CS35L56_ASP1_DATA_CONTROL5,	0x00000018 },
43 	{ CS35L56_ASP1_DATA_CONTROL1,	0x00000018 },
44 	{ CS35L56_ASP1_ENABLES1,	0x00000000 },
45 	{ CS35L56_ASP1TX1_INPUT,	0x00000018 },
46 	{ CS35L56_ASP1TX2_INPUT,	0x00000019 },
47 	{ CS35L56_ASP1TX3_INPUT,	0x00000020 },
48 	{ CS35L56_ASP1TX4_INPUT,	0x00000028 },
49 
50 };
51 
52 static void cs35l56_hda_wait_dsp_ready(struct cs35l56_hda *cs35l56)
53 {
54 	/* Wait for patching to complete */
55 	flush_work(&cs35l56->dsp_work);
56 }
57 
58 static void cs35l56_hda_play(struct cs35l56_hda *cs35l56)
59 {
60 	unsigned int val;
61 	int ret;
62 
63 	cs35l56_hda_wait_dsp_ready(cs35l56);
64 
65 	pm_runtime_get_sync(cs35l56->base.dev);
66 	ret = cs35l56_mbox_send(&cs35l56->base, CS35L56_MBOX_CMD_AUDIO_PLAY);
67 	if (ret == 0) {
68 		/* Wait for firmware to enter PS0 power state */
69 		ret = regmap_read_poll_timeout(cs35l56->base.regmap,
70 					       cs35l56->base.fw_reg->transducer_actual_ps,
71 					       val, (val == CS35L56_PS0),
72 					       CS35L56_PS0_POLL_US,
73 					       CS35L56_PS0_TIMEOUT_US);
74 		if (ret)
75 			dev_warn(cs35l56->base.dev, "PS0 wait failed: %d\n", ret);
76 	}
77 	regmap_set_bits(cs35l56->base.regmap, CS35L56_ASP1_ENABLES1,
78 			BIT(CS35L56_ASP_RX1_EN_SHIFT) | BIT(CS35L56_ASP_RX2_EN_SHIFT) |
79 			cs35l56->asp_tx_mask);
80 	cs35l56->playing = true;
81 }
82 
83 static void cs35l56_hda_pause(struct cs35l56_hda *cs35l56)
84 {
85 	cs35l56->playing = false;
86 	cs35l56_mbox_send(&cs35l56->base, CS35L56_MBOX_CMD_AUDIO_PAUSE);
87 	regmap_clear_bits(cs35l56->base.regmap, CS35L56_ASP1_ENABLES1,
88 			  BIT(CS35L56_ASP_RX1_EN_SHIFT) | BIT(CS35L56_ASP_RX2_EN_SHIFT) |
89 			  BIT(CS35L56_ASP_TX1_EN_SHIFT) | BIT(CS35L56_ASP_TX2_EN_SHIFT) |
90 			  BIT(CS35L56_ASP_TX3_EN_SHIFT) | BIT(CS35L56_ASP_TX4_EN_SHIFT));
91 
92 	pm_runtime_put_autosuspend(cs35l56->base.dev);
93 }
94 
95 static void cs35l56_hda_playback_hook(struct device *dev, int action)
96 {
97 	struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
98 
99 	dev_dbg(cs35l56->base.dev, "%s()%d: action: %d\n", __func__, __LINE__, action);
100 
101 	switch (action) {
102 	case HDA_GEN_PCM_ACT_PREPARE:
103 		if (cs35l56->playing)
104 			break;
105 
106 		/* If we're suspended: flag that resume should start playback */
107 		if (cs35l56->suspended) {
108 			cs35l56->playing = true;
109 			break;
110 		}
111 
112 		cs35l56_hda_play(cs35l56);
113 		break;
114 	case HDA_GEN_PCM_ACT_CLEANUP:
115 		if (!cs35l56->playing)
116 			break;
117 
118 		cs35l56_hda_pause(cs35l56);
119 		break;
120 	default:
121 		break;
122 	}
123 }
124 
125 static int cs35l56_hda_runtime_suspend(struct device *dev)
126 {
127 	struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
128 
129 	if (cs35l56->cs_dsp.booted)
130 		cs_dsp_stop(&cs35l56->cs_dsp);
131 
132 	return cs35l56_runtime_suspend_common(&cs35l56->base);
133 }
134 
135 static int cs35l56_hda_runtime_resume(struct device *dev)
136 {
137 	struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
138 	int ret;
139 
140 	ret = cs35l56_runtime_resume_common(&cs35l56->base, false);
141 	if (ret < 0)
142 		return ret;
143 
144 	if (cs35l56->cs_dsp.booted) {
145 		ret = cs_dsp_run(&cs35l56->cs_dsp);
146 		if (ret) {
147 			dev_dbg(cs35l56->base.dev, "%s: cs_dsp_run ret %d\n", __func__, ret);
148 			goto err;
149 		}
150 	}
151 
152 	return 0;
153 
154 err:
155 	cs35l56_mbox_send(&cs35l56->base, CS35L56_MBOX_CMD_ALLOW_AUTO_HIBERNATE);
156 	regmap_write(cs35l56->base.regmap, CS35L56_DSP_VIRTUAL1_MBOX_1,
157 		     CS35L56_MBOX_CMD_HIBERNATE_NOW);
158 
159 	regcache_cache_only(cs35l56->base.regmap, true);
160 
161 	return ret;
162 }
163 
164 static int cs35l56_hda_mixer_info(struct snd_kcontrol *kcontrol,
165 				  struct snd_ctl_elem_info *uinfo)
166 {
167 	uinfo->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
168 	uinfo->count = 1;
169 	uinfo->value.enumerated.items = CS35L56_NUM_INPUT_SRC;
170 	if (uinfo->value.enumerated.item >= CS35L56_NUM_INPUT_SRC)
171 		uinfo->value.enumerated.item = CS35L56_NUM_INPUT_SRC - 1;
172 	strscpy(uinfo->value.enumerated.name, cs35l56_tx_input_texts[uinfo->value.enumerated.item],
173 		sizeof(uinfo->value.enumerated.name));
174 
175 	return 0;
176 }
177 
178 static int cs35l56_hda_mixer_get(struct snd_kcontrol *kcontrol,
179 				 struct snd_ctl_elem_value *ucontrol)
180 {
181 	struct cs35l56_hda *cs35l56 = snd_kcontrol_chip(kcontrol);
182 	unsigned int reg_val;
183 	int i;
184 
185 	cs35l56_hda_wait_dsp_ready(cs35l56);
186 
187 	regmap_read(cs35l56->base.regmap, kcontrol->private_value, &reg_val);
188 	reg_val &= CS35L56_ASP_TXn_SRC_MASK;
189 
190 	for (i = 0; i < CS35L56_NUM_INPUT_SRC; ++i) {
191 		if (cs35l56_tx_input_values[i] == reg_val) {
192 			ucontrol->value.enumerated.item[0] = i;
193 			break;
194 		}
195 	}
196 
197 	return 0;
198 }
199 
200 static int cs35l56_hda_mixer_put(struct snd_kcontrol *kcontrol,
201 				 struct snd_ctl_elem_value *ucontrol)
202 {
203 	struct cs35l56_hda *cs35l56 = snd_kcontrol_chip(kcontrol);
204 	unsigned int item = ucontrol->value.enumerated.item[0];
205 	bool changed;
206 
207 	if (item >= CS35L56_NUM_INPUT_SRC)
208 		return -EINVAL;
209 
210 	cs35l56_hda_wait_dsp_ready(cs35l56);
211 
212 	regmap_update_bits_check(cs35l56->base.regmap, kcontrol->private_value,
213 				 CS35L56_INPUT_MASK, cs35l56_tx_input_values[item],
214 				 &changed);
215 
216 	return changed;
217 }
218 
219 static int cs35l56_hda_posture_info(struct snd_kcontrol *kcontrol,
220 				    struct snd_ctl_elem_info *uinfo)
221 {
222 	uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
223 	uinfo->count = 1;
224 	uinfo->value.integer.min = CS35L56_MAIN_POSTURE_MIN;
225 	uinfo->value.integer.max = CS35L56_MAIN_POSTURE_MAX;
226 	return 0;
227 }
228 
229 static int cs35l56_hda_posture_get(struct snd_kcontrol *kcontrol,
230 				   struct snd_ctl_elem_value *ucontrol)
231 {
232 	struct cs35l56_hda *cs35l56 = snd_kcontrol_chip(kcontrol);
233 	unsigned int pos;
234 	int ret;
235 
236 	cs35l56_hda_wait_dsp_ready(cs35l56);
237 
238 	ret = regmap_read(cs35l56->base.regmap,
239 			  cs35l56->base.fw_reg->posture_number, &pos);
240 	if (ret)
241 		return ret;
242 
243 	ucontrol->value.integer.value[0] = pos;
244 
245 	return 0;
246 }
247 
248 static int cs35l56_hda_posture_put(struct snd_kcontrol *kcontrol,
249 				   struct snd_ctl_elem_value *ucontrol)
250 {
251 	struct cs35l56_hda *cs35l56 = snd_kcontrol_chip(kcontrol);
252 	long pos = ucontrol->value.integer.value[0];
253 	bool changed;
254 	int ret;
255 
256 	if ((pos < CS35L56_MAIN_POSTURE_MIN) ||
257 	    (pos > CS35L56_MAIN_POSTURE_MAX))
258 		return -EINVAL;
259 
260 	cs35l56_hda_wait_dsp_ready(cs35l56);
261 
262 	ret = regmap_update_bits_check(cs35l56->base.regmap, cs35l56->base.fw_reg->posture_number,
263 				       CS35L56_MAIN_POSTURE_MASK, pos, &changed);
264 	if (ret)
265 		return ret;
266 
267 	return changed;
268 }
269 
270 static const struct {
271 	const char *name;
272 	unsigned int reg;
273 } cs35l56_hda_mixer_controls[] = {
274 	{ "ASP1 TX1 Source", CS35L56_ASP1TX1_INPUT },
275 	{ "ASP1 TX2 Source", CS35L56_ASP1TX2_INPUT },
276 	{ "ASP1 TX3 Source", CS35L56_ASP1TX3_INPUT },
277 	{ "ASP1 TX4 Source", CS35L56_ASP1TX4_INPUT },
278 };
279 
280 static const DECLARE_TLV_DB_SCALE(cs35l56_hda_vol_tlv, -10000, 25, 0);
281 
282 static int cs35l56_hda_vol_info(struct snd_kcontrol *kcontrol,
283 				struct snd_ctl_elem_info *uinfo)
284 {
285 	uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
286 	uinfo->count = 1;
287 	uinfo->value.integer.step = 1;
288 	uinfo->value.integer.min = 0;
289 	uinfo->value.integer.max = CS35L56_MAIN_RENDER_USER_VOLUME_MAX -
290 				   CS35L56_MAIN_RENDER_USER_VOLUME_MIN;
291 
292 	return 0;
293 }
294 
295 static int cs35l56_hda_vol_get(struct snd_kcontrol *kcontrol,
296 			       struct snd_ctl_elem_value *ucontrol)
297 {
298 	struct cs35l56_hda *cs35l56 = snd_kcontrol_chip(kcontrol);
299 	unsigned int raw_vol;
300 	int vol;
301 	int ret;
302 
303 	cs35l56_hda_wait_dsp_ready(cs35l56);
304 
305 	ret = regmap_read(cs35l56->base.regmap, cs35l56->base.fw_reg->user_volume, &raw_vol);
306 
307 	if (ret)
308 		return ret;
309 
310 	vol = (s16)(raw_vol & 0xFFFF);
311 	vol >>= CS35L56_MAIN_RENDER_USER_VOLUME_SHIFT;
312 
313 	if (vol & BIT(CS35L56_MAIN_RENDER_USER_VOLUME_SIGNBIT))
314 		vol |= ~((int)(BIT(CS35L56_MAIN_RENDER_USER_VOLUME_SIGNBIT) - 1));
315 
316 	ucontrol->value.integer.value[0] = vol - CS35L56_MAIN_RENDER_USER_VOLUME_MIN;
317 
318 	return 0;
319 }
320 
321 static int cs35l56_hda_vol_put(struct snd_kcontrol *kcontrol,
322 			       struct snd_ctl_elem_value *ucontrol)
323 {
324 	struct cs35l56_hda *cs35l56 = snd_kcontrol_chip(kcontrol);
325 	long vol = ucontrol->value.integer.value[0];
326 	unsigned int raw_vol;
327 	bool changed;
328 	int ret;
329 
330 	if ((vol < 0) || (vol > (CS35L56_MAIN_RENDER_USER_VOLUME_MAX -
331 				 CS35L56_MAIN_RENDER_USER_VOLUME_MIN)))
332 		return -EINVAL;
333 
334 	raw_vol = (vol + CS35L56_MAIN_RENDER_USER_VOLUME_MIN) <<
335 		  CS35L56_MAIN_RENDER_USER_VOLUME_SHIFT;
336 
337 	cs35l56_hda_wait_dsp_ready(cs35l56);
338 
339 	ret = regmap_update_bits_check(cs35l56->base.regmap, cs35l56->base.fw_reg->user_volume,
340 				       CS35L56_MAIN_RENDER_USER_VOLUME_MASK, raw_vol, &changed);
341 	if (ret)
342 		return ret;
343 
344 	return changed;
345 }
346 
347 static void cs35l56_hda_create_controls(struct cs35l56_hda *cs35l56)
348 {
349 	struct snd_kcontrol_new ctl_template = {
350 		.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
351 		.access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
352 		.info = cs35l56_hda_posture_info,
353 		.get = cs35l56_hda_posture_get,
354 		.put = cs35l56_hda_posture_put,
355 	};
356 	char name[64];
357 	int i;
358 
359 	snprintf(name, sizeof(name), "%s Posture Number", cs35l56->amp_name);
360 	ctl_template.name = name;
361 	cs35l56->posture_ctl = snd_ctl_new1(&ctl_template, cs35l56);
362 	if (snd_ctl_add(cs35l56->codec->card, cs35l56->posture_ctl))
363 		dev_err(cs35l56->base.dev, "Failed to add KControl: %s\n", ctl_template.name);
364 
365 	/* Mixer controls */
366 	ctl_template.info = cs35l56_hda_mixer_info;
367 	ctl_template.get = cs35l56_hda_mixer_get;
368 	ctl_template.put = cs35l56_hda_mixer_put;
369 
370 	BUILD_BUG_ON(ARRAY_SIZE(cs35l56->mixer_ctl) != ARRAY_SIZE(cs35l56_hda_mixer_controls));
371 
372 	for (i = 0; i < ARRAY_SIZE(cs35l56_hda_mixer_controls); ++i) {
373 		snprintf(name, sizeof(name), "%s %s", cs35l56->amp_name,
374 			 cs35l56_hda_mixer_controls[i].name);
375 		ctl_template.private_value = cs35l56_hda_mixer_controls[i].reg;
376 		cs35l56->mixer_ctl[i] = snd_ctl_new1(&ctl_template, cs35l56);
377 		if (snd_ctl_add(cs35l56->codec->card, cs35l56->mixer_ctl[i])) {
378 			dev_err(cs35l56->base.dev, "Failed to add KControl: %s\n",
379 				ctl_template.name);
380 		}
381 	}
382 
383 	ctl_template.info = cs35l56_hda_vol_info;
384 	ctl_template.get = cs35l56_hda_vol_get;
385 	ctl_template.put = cs35l56_hda_vol_put;
386 	ctl_template.access = (SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_TLV_READ);
387 	ctl_template.tlv.p = cs35l56_hda_vol_tlv;
388 	snprintf(name, sizeof(name), "%s Speaker Playback Volume", cs35l56->amp_name);
389 	ctl_template.name = name;
390 	cs35l56->volume_ctl = snd_ctl_new1(&ctl_template, cs35l56);
391 	if (snd_ctl_add(cs35l56->codec->card, cs35l56->volume_ctl))
392 		dev_err(cs35l56->base.dev, "Failed to add KControl: %s\n", ctl_template.name);
393 }
394 
395 static void cs35l56_hda_remove_controls(struct cs35l56_hda *cs35l56)
396 {
397 	int i;
398 
399 	for (i = ARRAY_SIZE(cs35l56->mixer_ctl) - 1; i >= 0; i--)
400 		snd_ctl_remove(cs35l56->codec->card, cs35l56->mixer_ctl[i]);
401 
402 	snd_ctl_remove(cs35l56->codec->card, cs35l56->posture_ctl);
403 	snd_ctl_remove(cs35l56->codec->card, cs35l56->volume_ctl);
404 }
405 
406 static int cs35l56_hda_request_firmware_file(struct cs35l56_hda *cs35l56,
407 					     const struct firmware **firmware, char **filename,
408 					     const char *base_name, const char *system_name,
409 					     const char *amp_name,
410 					     const char *filetype)
411 {
412 	char *s, c;
413 	int ret = 0;
414 
415 	if (system_name && amp_name)
416 		*filename = kasprintf(GFP_KERNEL, "%s-%s-%s.%s", base_name,
417 				      system_name, amp_name, filetype);
418 	else if (system_name)
419 		*filename = kasprintf(GFP_KERNEL, "%s-%s.%s", base_name,
420 				      system_name, filetype);
421 	else
422 		*filename = kasprintf(GFP_KERNEL, "%s.%s", base_name, filetype);
423 
424 	if (!*filename)
425 		return -ENOMEM;
426 
427 	/*
428 	 * Make sure that filename is lower-case and any non alpha-numeric
429 	 * characters except full stop and forward slash are replaced with
430 	 * hyphens.
431 	 */
432 	s = *filename;
433 	while (*s) {
434 		c = *s;
435 		if (isalnum(c))
436 			*s = tolower(c);
437 		else if (c != '.' && c != '/')
438 			*s = '-';
439 		s++;
440 	}
441 
442 	ret = firmware_request_nowarn(firmware, *filename, cs35l56->base.dev);
443 	if (ret) {
444 		dev_dbg(cs35l56->base.dev, "Failed to request '%s'\n", *filename);
445 		kfree(*filename);
446 		*filename = NULL;
447 		return ret;
448 	}
449 
450 	dev_dbg(cs35l56->base.dev, "Found '%s'\n", *filename);
451 
452 	return 0;
453 }
454 
455 static void cs35l56_hda_request_firmware_files(struct cs35l56_hda *cs35l56,
456 					       unsigned int preloaded_fw_ver,
457 					       const struct firmware **wmfw_firmware,
458 					       char **wmfw_filename,
459 					       const struct firmware **coeff_firmware,
460 					       char **coeff_filename)
461 {
462 	const char *system_name = cs35l56->system_name;
463 	const char *amp_name = cs35l56->amp_name;
464 	char base_name[37];
465 	int ret;
466 
467 	if (preloaded_fw_ver) {
468 		snprintf(base_name, sizeof(base_name),
469 			 "cirrus/cs35l%02x-%02x%s-%06x-dsp1-misc",
470 			 cs35l56->base.type,
471 			 cs35l56->base.rev,
472 			 cs35l56->base.secured ? "-s" : "",
473 			 preloaded_fw_ver & 0xffffff);
474 	} else {
475 		snprintf(base_name, sizeof(base_name),
476 			 "cirrus/cs35l%02x-%02x%s-dsp1-misc",
477 			 cs35l56->base.type,
478 			 cs35l56->base.rev,
479 			 cs35l56->base.secured ? "-s" : "");
480 	}
481 
482 	if (system_name && amp_name) {
483 		if (!cs35l56_hda_request_firmware_file(cs35l56, wmfw_firmware, wmfw_filename,
484 						       base_name, system_name, amp_name, "wmfw")) {
485 			cs35l56_hda_request_firmware_file(cs35l56, coeff_firmware, coeff_filename,
486 							  base_name, system_name, amp_name, "bin");
487 			return;
488 		}
489 	}
490 
491 	if (system_name) {
492 		if (!cs35l56_hda_request_firmware_file(cs35l56, wmfw_firmware, wmfw_filename,
493 						       base_name, system_name, NULL, "wmfw")) {
494 			if (amp_name)
495 				cs35l56_hda_request_firmware_file(cs35l56,
496 								  coeff_firmware, coeff_filename,
497 								  base_name, system_name,
498 								  amp_name, "bin");
499 			if (!*coeff_firmware)
500 				cs35l56_hda_request_firmware_file(cs35l56,
501 								  coeff_firmware, coeff_filename,
502 								  base_name, system_name,
503 								  NULL, "bin");
504 			return;
505 		}
506 
507 		/*
508 		 * Check for system-specific bin files without wmfw before
509 		 * falling back to generic firmware
510 		 */
511 		if (amp_name)
512 			cs35l56_hda_request_firmware_file(cs35l56, coeff_firmware, coeff_filename,
513 							  base_name, system_name, amp_name, "bin");
514 		if (!*coeff_firmware)
515 			cs35l56_hda_request_firmware_file(cs35l56, coeff_firmware, coeff_filename,
516 							  base_name, system_name, NULL, "bin");
517 
518 		if (*coeff_firmware)
519 			return;
520 	}
521 
522 	ret = cs35l56_hda_request_firmware_file(cs35l56, wmfw_firmware, wmfw_filename,
523 						base_name, NULL, NULL, "wmfw");
524 	if (!ret) {
525 		cs35l56_hda_request_firmware_file(cs35l56, coeff_firmware, coeff_filename,
526 						  base_name, NULL, NULL, "bin");
527 		return;
528 	}
529 
530 	if (!*coeff_firmware)
531 		cs35l56_hda_request_firmware_file(cs35l56, coeff_firmware, coeff_filename,
532 						  base_name, NULL, NULL, "bin");
533 }
534 
535 static void cs35l56_hda_release_firmware_files(const struct firmware *wmfw_firmware,
536 					       char *wmfw_filename,
537 					       const struct firmware *coeff_firmware,
538 					       char *coeff_filename)
539 {
540 	release_firmware(wmfw_firmware);
541 	kfree(wmfw_filename);
542 
543 	release_firmware(coeff_firmware);
544 	kfree(coeff_filename);
545 }
546 
547 static int cs35l56_hda_apply_calibration(struct cs35l56_hda *cs35l56)
548 {
549 	int ret;
550 
551 	if (!cs35l56->base.cal_data_valid || cs35l56->base.secured)
552 		return -EACCES;
553 
554 	ret = cs_amp_write_cal_coeffs(&cs35l56->cs_dsp,
555 				      &cs35l56_calibration_controls,
556 				      &cs35l56->base.cal_data);
557 	if (ret < 0) {
558 		dev_warn(cs35l56->base.dev, "Failed to write calibration: %d\n", ret);
559 		return ret;
560 	}
561 
562 	dev_info(cs35l56->base.dev, "Calibration applied\n");
563 
564 	return 0;
565 }
566 
567 static void cs35l56_hda_fw_load(struct cs35l56_hda *cs35l56)
568 {
569 	const struct firmware *coeff_firmware = NULL;
570 	const struct firmware *wmfw_firmware = NULL;
571 	char *coeff_filename = NULL;
572 	char *wmfw_filename = NULL;
573 	unsigned int preloaded_fw_ver;
574 	bool firmware_missing;
575 	int ret;
576 
577 	/*
578 	 * Prepare for a new DSP power-up. If the DSP has had firmware
579 	 * downloaded previously then it needs to be powered down so that it
580 	 * can be updated.
581 	 */
582 	if (cs35l56->base.fw_patched)
583 		cs_dsp_power_down(&cs35l56->cs_dsp);
584 
585 	cs35l56->base.fw_patched = false;
586 
587 	PM_RUNTIME_ACQUIRE_IF_ENABLED(cs35l56->base.dev, pm);
588 	ret = PM_RUNTIME_ACQUIRE_ERR(&pm);
589 	if (ret < 0) {
590 		dev_err(cs35l56->base.dev, "Failed to resume and get %d\n", ret);
591 		return;
592 	}
593 
594 	/*
595 	 * The firmware can only be upgraded if it is currently running
596 	 * from the built-in ROM. If not, the wmfw/bin must be for the
597 	 * version of firmware that is running on the chip.
598 	 */
599 	ret = cs35l56_read_prot_status(&cs35l56->base, &firmware_missing, &preloaded_fw_ver);
600 	if (ret)
601 		return;
602 
603 	if (firmware_missing)
604 		preloaded_fw_ver = 0;
605 
606 	cs35l56_hda_request_firmware_files(cs35l56, preloaded_fw_ver,
607 					   &wmfw_firmware, &wmfw_filename,
608 					   &coeff_firmware, &coeff_filename);
609 
610 	/*
611 	 * If the BIOS didn't patch the firmware a bin file is mandatory to
612 	 * enable the ASP·
613 	 */
614 	if (!coeff_firmware && firmware_missing) {
615 		dev_err(cs35l56->base.dev, ".bin file required but not found\n");
616 		goto err_fw_release;
617 	}
618 
619 	mutex_lock(&cs35l56->base.irq_lock);
620 
621 	/*
622 	 * If the firmware hasn't been patched it must be shutdown before
623 	 * doing a full patch and reset afterwards. If it is already
624 	 * running a patched version the firmware files only contain
625 	 * tunings and we can use the lower cost reinit sequence instead.
626 	 */
627 	if (firmware_missing && (wmfw_firmware || coeff_firmware)) {
628 		ret = cs35l56_firmware_shutdown(&cs35l56->base);
629 		if (ret)
630 			goto err;
631 	}
632 
633 	ret = cs_dsp_power_up(&cs35l56->cs_dsp, wmfw_firmware, wmfw_filename,
634 			      coeff_firmware, coeff_filename, "misc");
635 	if (ret) {
636 		dev_dbg(cs35l56->base.dev, "%s: cs_dsp_power_up ret %d\n", __func__, ret);
637 		goto err;
638 	}
639 
640 	if (wmfw_filename)
641 		dev_dbg(cs35l56->base.dev, "Loaded WMFW Firmware: %s\n", wmfw_filename);
642 
643 	if (coeff_filename)
644 		dev_dbg(cs35l56->base.dev, "Loaded Coefficients: %s\n", coeff_filename);
645 
646 	/* If we downloaded firmware, reset the device and wait for it to boot */
647 	if (firmware_missing && (wmfw_firmware || coeff_firmware)) {
648 		cs35l56_system_reset(&cs35l56->base, false);
649 		regcache_mark_dirty(cs35l56->base.regmap);
650 		ret = cs35l56_wait_for_firmware_boot(&cs35l56->base);
651 		if (ret)
652 			goto err_powered_up;
653 
654 		regcache_cache_only(cs35l56->base.regmap, false);
655 	}
656 
657 	/* Disable auto-hibernate so that runtime_pm has control */
658 	ret = cs35l56_mbox_send(&cs35l56->base, CS35L56_MBOX_CMD_PREVENT_AUTO_HIBERNATE);
659 	if (ret)
660 		goto err_powered_up;
661 
662 	regcache_sync(cs35l56->base.regmap);
663 
664 	regmap_clear_bits(cs35l56->base.regmap,
665 			  cs35l56->base.fw_reg->prot_sts,
666 			  CS35L56_FIRMWARE_MISSING);
667 	cs35l56->base.fw_patched = true;
668 
669 	ret = cs_dsp_run(&cs35l56->cs_dsp);
670 	if (ret)
671 		dev_dbg(cs35l56->base.dev, "%s: cs_dsp_run ret %d\n", __func__, ret);
672 
673 	/* Don't need to check return code, it's not fatal if this fails */
674 	cs35l56_hda_apply_calibration(cs35l56);
675 
676 	ret = cs35l56_mbox_send(&cs35l56->base, CS35L56_MBOX_CMD_AUDIO_REINIT);
677 	if (ret)
678 		cs_dsp_stop(&cs35l56->cs_dsp);
679 
680 	cs35l56_log_tuning(&cs35l56->base, &cs35l56->cs_dsp);
681 
682 err_powered_up:
683 	if (!cs35l56->base.fw_patched)
684 		cs_dsp_power_down(&cs35l56->cs_dsp);
685 err:
686 	mutex_unlock(&cs35l56->base.irq_lock);
687 err_fw_release:
688 	cs35l56_hda_release_firmware_files(wmfw_firmware, wmfw_filename,
689 					   coeff_firmware, coeff_filename);
690 }
691 
692 static void cs35l56_hda_dsp_work(struct work_struct *work)
693 {
694 	struct cs35l56_hda *cs35l56 = container_of(work, struct cs35l56_hda, dsp_work);
695 
696 	cs35l56_hda_fw_load(cs35l56);
697 }
698 
699 static ssize_t cs35l56_hda_debugfs_calibrate_write(struct file *file,
700 						   const char __user *from,
701 						   size_t count, loff_t *ppos)
702 {
703 	struct cs35l56_base *cs35l56_base = file->private_data;
704 	ssize_t ret;
705 
706 	PM_RUNTIME_ACQUIRE_IF_ENABLED_AUTOSUSPEND(cs35l56_base->dev, pm);
707 	ret = PM_RUNTIME_ACQUIRE_ERR(&pm);
708 	if (ret)
709 		return ret;
710 
711 	return cs35l56_calibrate_debugfs_write(cs35l56_base, from, count, ppos);
712 }
713 
714 static ssize_t cs35l56_hda_debugfs_cal_temperature_write(struct file *file,
715 							 const char __user *from,
716 							 size_t count, loff_t *ppos)
717 {
718 	struct cs35l56_base *cs35l56_base = file->private_data;
719 	ssize_t ret;
720 
721 	PM_RUNTIME_ACQUIRE_IF_ENABLED_AUTOSUSPEND(cs35l56_base->dev, pm);
722 	ret = PM_RUNTIME_ACQUIRE_ERR(&pm);
723 	if (ret)
724 		return ret;
725 
726 	return cs35l56_cal_ambient_debugfs_write(cs35l56_base, from, count, ppos);
727 }
728 
729 static ssize_t cs35l56_hda_debugfs_cal_data_read(struct file *file,
730 						 char __user *to,
731 						 size_t count, loff_t *ppos)
732 {
733 	struct cs35l56_base *cs35l56_base = file->private_data;
734 	ssize_t ret;
735 
736 	PM_RUNTIME_ACQUIRE_IF_ENABLED_AUTOSUSPEND(cs35l56_base->dev, pm);
737 	ret = PM_RUNTIME_ACQUIRE_ERR(&pm);
738 	if (ret)
739 		return ret;
740 
741 	return cs35l56_cal_data_debugfs_read(cs35l56_base, to, count, ppos);
742 }
743 
744 static ssize_t cs35l56_hda_debugfs_cal_data_write(struct file *file,
745 						  const char __user *from,
746 						  size_t count, loff_t *ppos)
747 {
748 	struct cs35l56_base *cs35l56_base = file->private_data;
749 	struct cs35l56_hda *cs35l56 = cs35l56_hda_from_base(cs35l56_base);
750 	ssize_t ret;
751 
752 	ret = cs35l56_cal_data_debugfs_write(cs35l56_base, from, count, ppos);
753 	if (ret == -ENODATA)
754 		return count;	/* Ignore writes of empty cal blobs */
755 
756 	if (ret < 0)
757 		return ret;
758 
759 	PM_RUNTIME_ACQUIRE_IF_ENABLED_AUTOSUSPEND(cs35l56_base->dev, pm);
760 	ret = PM_RUNTIME_ACQUIRE_ERR(&pm);
761 	if (ret)
762 		return ret;
763 
764 	ret = cs35l56_hda_apply_calibration(cs35l56);
765 	if (ret == 0)
766 		cs35l56_mbox_send(cs35l56_base, CS35L56_MBOX_CMD_AUDIO_REINIT);
767 	else
768 		count = -EIO;
769 
770 	return count;
771 }
772 
773 static const struct cs35l56_cal_debugfs_fops cs35l56_hda_cal_debugfs_fops = {
774 	.calibrate = {
775 		.write = cs35l56_hda_debugfs_calibrate_write,
776 	},
777 	.cal_temperature = {
778 		.write = cs35l56_hda_debugfs_cal_temperature_write,
779 	},
780 	.cal_data = {
781 		.read = cs35l56_hda_debugfs_cal_data_read,
782 		.write = cs35l56_hda_debugfs_cal_data_write,
783 	},
784 };
785 
786 static int cs35l56_hda_bind(struct device *dev, struct device *master, void *master_data)
787 {
788 	struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
789 	struct hda_component_parent *parent = master_data;
790 	struct hda_component *comp;
791 
792 	comp = hda_component_from_index(parent, cs35l56->index);
793 	if (!comp)
794 		return -EINVAL;
795 
796 	if (comp->dev)
797 		return -EBUSY;
798 
799 	comp->dev = dev;
800 	cs35l56->codec = parent->codec;
801 	strscpy(comp->name, dev_name(dev), sizeof(comp->name));
802 	comp->playback_hook = cs35l56_hda_playback_hook;
803 
804 	queue_work(system_long_wq, &cs35l56->dsp_work);
805 
806 	cs35l56_hda_create_controls(cs35l56);
807 
808 #if IS_ENABLED(CONFIG_SND_DEBUG)
809 	cs35l56->debugfs_root = debugfs_create_dir(dev_name(cs35l56->base.dev), sound_debugfs_root);
810 	cs_dsp_init_debugfs(&cs35l56->cs_dsp, cs35l56->debugfs_root);
811 #endif
812 
813 	if (IS_ENABLED(CONFIG_SND_HDA_SCODEC_CS35L56_CAL_DEBUGFS))
814 		cs35l56_create_cal_debugfs(&cs35l56->base, &cs35l56_hda_cal_debugfs_fops);
815 
816 	dev_dbg(cs35l56->base.dev, "Bound\n");
817 
818 	return 0;
819 }
820 
821 static void cs35l56_hda_unbind(struct device *dev, struct device *master, void *master_data)
822 {
823 	struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
824 	struct hda_component_parent *parent = master_data;
825 	struct hda_component *comp;
826 
827 	cancel_work_sync(&cs35l56->dsp_work);
828 
829 	cs35l56_remove_cal_debugfs(&cs35l56->base);
830 	cs35l56_hda_remove_controls(cs35l56);
831 
832 #if IS_ENABLED(CONFIG_SND_DEBUG)
833 	cs_dsp_cleanup_debugfs(&cs35l56->cs_dsp);
834 	debugfs_remove_recursive(cs35l56->debugfs_root);
835 #endif
836 
837 	if (cs35l56->base.fw_patched)
838 		cs_dsp_power_down(&cs35l56->cs_dsp);
839 
840 	comp = hda_component_from_index(parent, cs35l56->index);
841 	if (comp && (comp->dev == dev))
842 		memset(comp, 0, sizeof(*comp));
843 
844 	cs35l56->codec = NULL;
845 
846 	dev_dbg(cs35l56->base.dev, "Unbound\n");
847 }
848 
849 static const struct component_ops cs35l56_hda_comp_ops = {
850 	.bind = cs35l56_hda_bind,
851 	.unbind = cs35l56_hda_unbind,
852 };
853 
854 static int cs35l56_hda_system_suspend(struct device *dev)
855 {
856 	struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
857 
858 	cs35l56_hda_wait_dsp_ready(cs35l56);
859 
860 	if (cs35l56->playing)
861 		cs35l56_hda_pause(cs35l56);
862 
863 	cs35l56->suspended = true;
864 
865 	/*
866 	 * The interrupt line is normally shared, but after we start suspending
867 	 * we can't check if our device is the source of an interrupt, and can't
868 	 * clear it. Prevent this race by temporarily disabling the parent irq
869 	 * until we reach _no_irq.
870 	 */
871 	if (cs35l56->base.irq)
872 		disable_irq(cs35l56->base.irq);
873 
874 	return pm_runtime_force_suspend(dev);
875 }
876 
877 static int cs35l56_hda_system_suspend_late(struct device *dev)
878 {
879 	struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
880 
881 	/*
882 	 * RESET is usually shared by all amps so it must not be asserted until
883 	 * all driver instances have done their suspend() stage.
884 	 */
885 	if (cs35l56->base.reset_gpio) {
886 		gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 0);
887 		cs35l56_wait_min_reset_pulse();
888 	}
889 
890 	return 0;
891 }
892 
893 static int cs35l56_hda_system_suspend_no_irq(struct device *dev)
894 {
895 	struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
896 
897 	/* Handlers are now disabled so the parent IRQ can safely be re-enabled. */
898 	if (cs35l56->base.irq)
899 		enable_irq(cs35l56->base.irq);
900 
901 	return 0;
902 }
903 
904 static int cs35l56_hda_system_resume_no_irq(struct device *dev)
905 {
906 	struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
907 
908 	/*
909 	 * WAKE interrupts unmask if the CS35L56 hibernates, which can cause
910 	 * spurious interrupts, and the interrupt line is normally shared.
911 	 * We can't check if our device is the source of an interrupt, and can't
912 	 * clear it, until it has fully resumed. Prevent this race by temporarily
913 	 * disabling the parent irq until we complete resume().
914 	 */
915 	if (cs35l56->base.irq)
916 		disable_irq(cs35l56->base.irq);
917 
918 	return 0;
919 }
920 
921 static int cs35l56_hda_system_resume_early(struct device *dev)
922 {
923 	struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
924 
925 	/* Ensure a spec-compliant RESET pulse. */
926 	if (cs35l56->base.reset_gpio) {
927 		gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 0);
928 		cs35l56_wait_min_reset_pulse();
929 
930 		/* Release shared RESET before drivers start resume(). */
931 		gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 1);
932 		cs35l56_wait_control_port_ready();
933 	}
934 
935 	return 0;
936 }
937 
938 static int cs35l56_hda_system_resume(struct device *dev)
939 {
940 	struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
941 	int ret;
942 
943 	/* Undo pm_runtime_force_suspend() before re-enabling the irq */
944 	ret = pm_runtime_force_resume(dev);
945 	if (cs35l56->base.irq)
946 		enable_irq(cs35l56->base.irq);
947 
948 	if (ret)
949 		return ret;
950 
951 	cs35l56->suspended = false;
952 
953 	if (!cs35l56->codec)
954 		return 0;
955 
956 	ret = cs35l56_is_fw_reload_needed(&cs35l56->base);
957 	dev_dbg(cs35l56->base.dev, "fw_reload_needed: %d\n", ret);
958 	if (ret > 0)
959 		queue_work(system_long_wq, &cs35l56->dsp_work);
960 
961 	if (cs35l56->playing)
962 		cs35l56_hda_play(cs35l56);
963 
964 	return 0;
965 }
966 
967 static int cs35l56_hda_fixup_yoga9(struct cs35l56_hda *cs35l56, int *bus_addr)
968 {
969 	/* The cirrus,dev-index property has the wrong values */
970 	switch (*bus_addr) {
971 	case 0x30:
972 		cs35l56->index = 1;
973 		return 0;
974 	case 0x31:
975 		cs35l56->index = 0;
976 		return 0;
977 	default:
978 		/* There is a pseudo-address for broadcast to both amps - ignore it */
979 		dev_dbg(cs35l56->base.dev, "Ignoring I2C address %#x\n", *bus_addr);
980 		return 0;
981 	}
982 }
983 
984 static const struct {
985 	const char *sub;
986 	int (*fixup_fn)(struct cs35l56_hda *cs35l56, int *bus_addr);
987 } cs35l56_hda_fixups[] = {
988 	{
989 		.sub = "17AA390B", /* Lenovo Yoga Book 9i GenX */
990 		.fixup_fn = cs35l56_hda_fixup_yoga9,
991 	},
992 };
993 
994 static int cs35l56_hda_apply_platform_fixups(struct cs35l56_hda *cs35l56, const char *sub,
995 					     int *bus_addr)
996 {
997 	int i;
998 
999 	if (IS_ERR(sub))
1000 		return 0;
1001 
1002 	for (i = 0; i < ARRAY_SIZE(cs35l56_hda_fixups); i++) {
1003 		if (strcasecmp(cs35l56_hda_fixups[i].sub, sub) == 0) {
1004 			dev_dbg(cs35l56->base.dev, "Applying fixup for %s\n",
1005 				cs35l56_hda_fixups[i].sub);
1006 			return (cs35l56_hda_fixups[i].fixup_fn)(cs35l56, bus_addr);
1007 		}
1008 	}
1009 
1010 	return 0;
1011 }
1012 
1013 static int cs35l56_hda_read_acpi(struct cs35l56_hda *cs35l56, int hid, int id)
1014 {
1015 	u32 values[HDA_MAX_COMPONENTS];
1016 	char hid_string[8];
1017 	struct acpi_device *adev;
1018 	const char *property, *sub;
1019 	size_t nval;
1020 	int i, ret;
1021 
1022 	/*
1023 	 * ACPI_COMPANION isn't available when this driver was instantiated by
1024 	 * the serial-multi-instantiate driver, so lookup the node by HID
1025 	 */
1026 	if (!ACPI_COMPANION(cs35l56->base.dev)) {
1027 		snprintf(hid_string, sizeof(hid_string), "CSC%04X", hid);
1028 		adev = acpi_dev_get_first_match_dev(hid_string, NULL, -1);
1029 		if (!adev) {
1030 			dev_err(cs35l56->base.dev, "Failed to find an ACPI device for %s\n",
1031 				dev_name(cs35l56->base.dev));
1032 			return -ENODEV;
1033 		}
1034 		ACPI_COMPANION_SET(cs35l56->base.dev, adev);
1035 	}
1036 
1037 	/* Initialize things that could be overwritten by a fixup */
1038 	cs35l56->index = -1;
1039 
1040 	sub = acpi_get_subsystem_id(ACPI_HANDLE(cs35l56->base.dev));
1041 	ret = cs35l56_hda_apply_platform_fixups(cs35l56, sub, &id);
1042 	if (ret)
1043 		return ret;
1044 
1045 	if (cs35l56->index == -1) {
1046 		property = "cirrus,dev-index";
1047 		ret = device_property_count_u32(cs35l56->base.dev, property);
1048 		if (ret <= 0)
1049 			goto err;
1050 
1051 		if (ret > ARRAY_SIZE(values)) {
1052 			ret = -EINVAL;
1053 			goto err;
1054 		}
1055 		nval = ret;
1056 
1057 		ret = device_property_read_u32_array(cs35l56->base.dev, property, values, nval);
1058 		if (ret)
1059 			goto err;
1060 
1061 		for (i = 0; i < nval; i++) {
1062 			if (values[i] == id) {
1063 				cs35l56->index = i;
1064 				break;
1065 			}
1066 		}
1067 
1068 		/*
1069 		 * It's not an error for the ID to be missing: for I2C there can be
1070 		 * an alias address that is not a real device. So reject silently.
1071 		 */
1072 		if (cs35l56->index == -1) {
1073 			dev_dbg(cs35l56->base.dev, "No index found in %s\n", property);
1074 			ret = -ENODEV;
1075 			goto err;
1076 		}
1077 	}
1078 
1079 	if (IS_ERR(sub)) {
1080 		dev_info(cs35l56->base.dev,
1081 			 "Read ACPI _SUB failed(%ld): fallback to generic firmware\n",
1082 			 PTR_ERR(sub));
1083 	} else {
1084 		ret = cirrus_scodec_get_speaker_id(cs35l56->base.dev, cs35l56->index, nval, -1);
1085 		if (ret == -ENOENT) {
1086 			cs35l56->system_name = sub;
1087 		} else if (ret >= 0) {
1088 			cs35l56->system_name = kasprintf(GFP_KERNEL, "%s-spkid%d", sub, ret);
1089 			kfree(sub);
1090 			if (!cs35l56->system_name)
1091 				return -ENOMEM;
1092 		} else {
1093 			return ret;
1094 		}
1095 	}
1096 
1097 	cs35l56->base.reset_gpio = devm_gpiod_get_index_optional(cs35l56->base.dev,
1098 								 "reset",
1099 								 cs35l56->index,
1100 								 GPIOD_OUT_LOW);
1101 	if (IS_ERR(cs35l56->base.reset_gpio)) {
1102 		ret = PTR_ERR(cs35l56->base.reset_gpio);
1103 
1104 		/*
1105 		 * If RESET is shared the first amp to probe will grab the reset
1106 		 * line and reset all the amps
1107 		 */
1108 		if (ret != -EBUSY)
1109 			return dev_err_probe(cs35l56->base.dev, ret, "Failed to get reset GPIO\n");
1110 
1111 		dev_info(cs35l56->base.dev, "Reset GPIO busy, assume shared reset\n");
1112 		cs35l56->base.reset_gpio = NULL;
1113 	}
1114 
1115 	return 0;
1116 
1117 err:
1118 	if (ret != -ENODEV)
1119 		dev_err(cs35l56->base.dev, "Failed property %s: %d\n", property, ret);
1120 
1121 	return ret;
1122 }
1123 
1124 int cs35l56_hda_common_probe(struct cs35l56_hda *cs35l56, int hid, int id)
1125 {
1126 	int ret;
1127 
1128 	mutex_init(&cs35l56->base.irq_lock);
1129 	dev_set_drvdata(cs35l56->base.dev, cs35l56);
1130 
1131 	INIT_WORK(&cs35l56->dsp_work, cs35l56_hda_dsp_work);
1132 
1133 	ret = cs35l56_hda_read_acpi(cs35l56, hid, id);
1134 	if (ret)
1135 		goto err;
1136 
1137 	cs35l56->amp_name = devm_kasprintf(cs35l56->base.dev, GFP_KERNEL, "AMP%d",
1138 					   cs35l56->index + 1);
1139 	if (!cs35l56->amp_name) {
1140 		ret = -ENOMEM;
1141 		goto err;
1142 	}
1143 
1144 	cs35l56->base.type = hid & 0xff;
1145 	cs35l56->base.cal_index = cs35l56->index;
1146 
1147 	cs35l56_init_cs_dsp(&cs35l56->base, &cs35l56->cs_dsp);
1148 
1149 	if (cs35l56->base.reset_gpio) {
1150 		dev_dbg(cs35l56->base.dev, "Hard reset\n");
1151 
1152 		/*
1153 		 * The GPIOD_OUT_LOW to *_gpiod_get_*() will be ignored if the
1154 		 * ACPI defines a different default state. So explicitly set low.
1155 		 */
1156 		gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 0);
1157 		cs35l56_wait_min_reset_pulse();
1158 		gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 1);
1159 	}
1160 
1161 	ret = cs35l56_hw_init(&cs35l56->base);
1162 	if (ret < 0)
1163 		goto err;
1164 
1165 	/* Reset the device and wait for it to boot */
1166 	cs35l56_system_reset(&cs35l56->base, false);
1167 	ret = cs35l56_wait_for_firmware_boot(&cs35l56->base);
1168 	if (ret)
1169 		goto err;
1170 
1171 	regcache_cache_only(cs35l56->base.regmap, false);
1172 
1173 	ret = cs35l56_set_patch(&cs35l56->base);
1174 	if (ret)
1175 		goto err;
1176 
1177 	regcache_mark_dirty(cs35l56->base.regmap);
1178 	regcache_sync(cs35l56->base.regmap);
1179 
1180 	/* Disable auto-hibernate so that runtime_pm has control */
1181 	ret = cs35l56_mbox_send(&cs35l56->base, CS35L56_MBOX_CMD_PREVENT_AUTO_HIBERNATE);
1182 	if (ret)
1183 		goto err;
1184 
1185 	ret = cs35l56_get_calibration(&cs35l56->base);
1186 	if (ret)
1187 		goto err;
1188 
1189 	ret = cs_dsp_halo_init(&cs35l56->cs_dsp);
1190 	if (ret) {
1191 		dev_err_probe(cs35l56->base.dev, ret, "cs_dsp_halo_init failed\n");
1192 		goto err;
1193 	}
1194 
1195 	dev_info(cs35l56->base.dev, "DSP system name: '%s', amp name: '%s'\n",
1196 		 cs35l56->system_name, cs35l56->amp_name);
1197 
1198 	regmap_multi_reg_write(cs35l56->base.regmap, cs35l56_hda_dai_config,
1199 			       ARRAY_SIZE(cs35l56_hda_dai_config));
1200 
1201 	/*
1202 	 * By default only enable one ASP1TXn, where n=amplifier index,
1203 	 * This prevents multiple amps trying to drive the same slot.
1204 	 */
1205 	cs35l56->asp_tx_mask = BIT(cs35l56->index);
1206 
1207 	pm_runtime_set_autosuspend_delay(cs35l56->base.dev, 3000);
1208 	pm_runtime_use_autosuspend(cs35l56->base.dev);
1209 	pm_runtime_set_active(cs35l56->base.dev);
1210 	pm_runtime_mark_last_busy(cs35l56->base.dev);
1211 	pm_runtime_enable(cs35l56->base.dev);
1212 
1213 	cs35l56->base.init_done = true;
1214 
1215 	ret = component_add(cs35l56->base.dev, &cs35l56_hda_comp_ops);
1216 	if (ret) {
1217 		dev_err(cs35l56->base.dev, "Register component failed: %d\n", ret);
1218 		goto pm_err;
1219 	}
1220 
1221 	return 0;
1222 
1223 pm_err:
1224 	pm_runtime_disable(cs35l56->base.dev);
1225 	cs_dsp_remove(&cs35l56->cs_dsp);
1226 err:
1227 	gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 0);
1228 
1229 	return ret;
1230 }
1231 EXPORT_SYMBOL_NS_GPL(cs35l56_hda_common_probe, "SND_HDA_SCODEC_CS35L56");
1232 
1233 void cs35l56_hda_remove(struct device *dev)
1234 {
1235 	struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
1236 
1237 	component_del(cs35l56->base.dev, &cs35l56_hda_comp_ops);
1238 
1239 	pm_runtime_dont_use_autosuspend(cs35l56->base.dev);
1240 	pm_runtime_get_sync(cs35l56->base.dev);
1241 	pm_runtime_disable(cs35l56->base.dev);
1242 
1243 	cs_dsp_remove(&cs35l56->cs_dsp);
1244 
1245 	kfree(cs35l56->system_name);
1246 	pm_runtime_put_noidle(cs35l56->base.dev);
1247 
1248 	gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 0);
1249 }
1250 EXPORT_SYMBOL_NS_GPL(cs35l56_hda_remove, "SND_HDA_SCODEC_CS35L56");
1251 
1252 const struct dev_pm_ops cs35l56_hda_pm_ops = {
1253 	RUNTIME_PM_OPS(cs35l56_hda_runtime_suspend, cs35l56_hda_runtime_resume, NULL)
1254 	SYSTEM_SLEEP_PM_OPS(cs35l56_hda_system_suspend, cs35l56_hda_system_resume)
1255 	LATE_SYSTEM_SLEEP_PM_OPS(cs35l56_hda_system_suspend_late,
1256 				 cs35l56_hda_system_resume_early)
1257 	NOIRQ_SYSTEM_SLEEP_PM_OPS(cs35l56_hda_system_suspend_no_irq,
1258 				  cs35l56_hda_system_resume_no_irq)
1259 };
1260 EXPORT_SYMBOL_NS_GPL(cs35l56_hda_pm_ops, "SND_HDA_SCODEC_CS35L56");
1261 
1262 MODULE_DESCRIPTION("CS35L56 HDA Driver");
1263 MODULE_IMPORT_NS("FW_CS_DSP");
1264 MODULE_IMPORT_NS("SND_HDA_CIRRUS_SCODEC");
1265 MODULE_IMPORT_NS("SND_SOC_CS35L56_SHARED");
1266 MODULE_IMPORT_NS("SND_SOC_CS_AMP_LIB");
1267 MODULE_AUTHOR("Richard Fitzgerald <rf@opensource.cirrus.com>");
1268 MODULE_AUTHOR("Simon Trimmer <simont@opensource.cirrus.com>");
1269 MODULE_LICENSE("GPL");
1270 MODULE_FIRMWARE("cirrus/cs35l54-*.wmfw");
1271 MODULE_FIRMWARE("cirrus/cs35l54-*.bin");
1272 MODULE_FIRMWARE("cirrus/cs35l56-*.wmfw");
1273 MODULE_FIRMWARE("cirrus/cs35l56-*.bin");
1274