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