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
cs35l56_hda_wait_dsp_ready(struct cs35l56_hda * cs35l56)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
cs35l56_hda_play(struct cs35l56_hda * cs35l56)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
cs35l56_hda_pause(struct cs35l56_hda * cs35l56)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
cs35l56_hda_playback_hook(struct device * dev,int action)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
cs35l56_hda_runtime_suspend(struct device * dev)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
cs35l56_hda_runtime_resume(struct device * dev)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
cs35l56_hda_mixer_info(struct snd_kcontrol * kcontrol,struct snd_ctl_elem_info * uinfo)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
cs35l56_hda_mixer_get(struct snd_kcontrol * kcontrol,struct snd_ctl_elem_value * ucontrol)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 ®_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
cs35l56_hda_mixer_put(struct snd_kcontrol * kcontrol,struct snd_ctl_elem_value * ucontrol)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
cs35l56_hda_posture_info(struct snd_kcontrol * kcontrol,struct snd_ctl_elem_info * uinfo)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
cs35l56_hda_posture_get(struct snd_kcontrol * kcontrol,struct snd_ctl_elem_value * ucontrol)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
cs35l56_hda_posture_put(struct snd_kcontrol * kcontrol,struct snd_ctl_elem_value * ucontrol)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
cs35l56_hda_vol_info(struct snd_kcontrol * kcontrol,struct snd_ctl_elem_info * uinfo)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
cs35l56_hda_vol_get(struct snd_kcontrol * kcontrol,struct snd_ctl_elem_value * ucontrol)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
cs35l56_hda_vol_put(struct snd_kcontrol * kcontrol,struct snd_ctl_elem_value * ucontrol)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
cs35l56_hda_create_controls(struct cs35l56_hda * cs35l56)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
cs35l56_hda_remove_controls(struct cs35l56_hda * cs35l56)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
cs35l56_hda_request_firmware_file(struct cs35l56_hda * cs35l56,const struct firmware ** firmware,char ** filename,const char * base_name,const char * system_name,const char * amp_name,const char * filetype)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
cs35l56_hda_request_firmware_files(struct cs35l56_hda * cs35l56,unsigned int preloaded_fw_ver,const struct firmware ** wmfw_firmware,char ** wmfw_filename,const struct firmware ** coeff_firmware,char ** coeff_filename)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
cs35l56_hda_apply_calibration(struct cs35l56_hda * cs35l56)530 static int cs35l56_hda_apply_calibration(struct cs35l56_hda *cs35l56)
531 {
532 int ret;
533
534 if (!cs35l56->base.cal_data_valid || cs35l56->base.secured)
535 return -EACCES;
536
537 ret = cs_amp_write_cal_coeffs(&cs35l56->cs_dsp,
538 &cs35l56_calibration_controls,
539 &cs35l56->base.cal_data);
540 if (ret < 0) {
541 dev_warn(cs35l56->base.dev, "Failed to write calibration: %d\n", ret);
542 return ret;
543 }
544
545 dev_info(cs35l56->base.dev, "Calibration applied\n");
546
547 return 0;
548 }
549
cs35l56_hda_fw_load(struct cs35l56_hda * cs35l56)550 static void cs35l56_hda_fw_load(struct cs35l56_hda *cs35l56)
551 {
552 const struct firmware *coeff_firmware __free(firmware) = NULL;
553 const struct firmware *wmfw_firmware __free(firmware) = NULL;
554 char *coeff_filename __free(kfree) = NULL;
555 char *wmfw_filename __free(kfree) = NULL;
556 unsigned int preloaded_fw_ver;
557 bool firmware_missing;
558 int ret;
559
560 /*
561 * Prepare for a new DSP power-up. If the DSP has had firmware
562 * downloaded previously then it needs to be powered down so that it
563 * can be updated.
564 */
565 if (cs35l56->base.fw_patched)
566 cs_dsp_power_down(&cs35l56->cs_dsp);
567
568 cs35l56->base.fw_patched = false;
569
570 PM_RUNTIME_ACQUIRE_IF_ENABLED(cs35l56->base.dev, pm);
571 ret = PM_RUNTIME_ACQUIRE_ERR(&pm);
572 if (ret < 0) {
573 dev_err(cs35l56->base.dev, "Failed to resume and get %d\n", ret);
574 return;
575 }
576
577 /*
578 * The firmware can only be upgraded if it is currently running
579 * from the built-in ROM. If not, the wmfw/bin must be for the
580 * version of firmware that is running on the chip.
581 */
582 ret = cs35l56_read_prot_status(&cs35l56->base, &firmware_missing, &preloaded_fw_ver);
583 if (ret)
584 return;
585
586 if (firmware_missing)
587 preloaded_fw_ver = 0;
588
589 cs35l56_hda_request_firmware_files(cs35l56, preloaded_fw_ver,
590 &wmfw_firmware, &wmfw_filename,
591 &coeff_firmware, &coeff_filename);
592
593 /* If the BIOS didn't patch the firmware a wmfw and bin file are mandatory */
594 if (firmware_missing) {
595 if (!wmfw_firmware) {
596 dev_err(cs35l56->base.dev, ".%s file required but not found\n", "wmfw");
597 return;
598 } else if (!coeff_firmware) {
599 dev_err(cs35l56->base.dev, ".%s file required but not found\n", "bin");
600 return;
601 }
602 }
603
604 guard(mutex)(&cs35l56->base.irq_lock);
605
606 /*
607 * If the firmware hasn't been patched it must be shutdown before
608 * doing a full patch and reset afterwards. If it is already
609 * running a patched version the firmware files only contain
610 * tunings and we can use the lower cost reinit sequence instead.
611 */
612 if (firmware_missing && (wmfw_firmware || coeff_firmware)) {
613 ret = cs35l56_firmware_shutdown(&cs35l56->base);
614 if (ret)
615 return;
616 }
617
618 ret = cs_dsp_power_up(&cs35l56->cs_dsp, wmfw_firmware, wmfw_filename,
619 coeff_firmware, coeff_filename, "misc");
620 if (ret) {
621 dev_dbg(cs35l56->base.dev, "%s: cs_dsp_power_up ret %d\n", __func__, ret);
622 return;
623 }
624
625 if (wmfw_filename)
626 dev_dbg(cs35l56->base.dev, "Loaded WMFW Firmware: %s\n", wmfw_filename);
627
628 if (coeff_filename)
629 dev_dbg(cs35l56->base.dev, "Loaded Coefficients: %s\n", coeff_filename);
630
631 /* If we downloaded firmware, reset the device and wait for it to boot */
632 if (firmware_missing && (wmfw_firmware || coeff_firmware)) {
633 cs35l56_system_reset(&cs35l56->base, false);
634 regcache_mark_dirty(cs35l56->base.regmap);
635 ret = cs35l56_wait_for_firmware_boot(&cs35l56->base);
636 if (ret)
637 goto err_powered_up;
638
639 regcache_cache_only(cs35l56->base.regmap, false);
640 }
641
642 /* Disable auto-hibernate so that runtime_pm has control */
643 ret = cs35l56_mbox_send(&cs35l56->base, CS35L56_MBOX_CMD_PREVENT_AUTO_HIBERNATE);
644 if (ret)
645 goto err_powered_up;
646
647 regcache_sync(cs35l56->base.regmap);
648
649 regmap_clear_bits(cs35l56->base.regmap,
650 cs35l56->base.fw_reg->prot_sts,
651 CS35L56_FIRMWARE_MISSING);
652 cs35l56->base.fw_patched = true;
653
654 ret = cs_dsp_run(&cs35l56->cs_dsp);
655 if (ret)
656 dev_dbg(cs35l56->base.dev, "%s: cs_dsp_run ret %d\n", __func__, ret);
657
658 /* Don't need to check return code, it's not fatal if this fails */
659 cs35l56_hda_apply_calibration(cs35l56);
660
661 ret = cs35l56_mbox_send(&cs35l56->base, CS35L56_MBOX_CMD_AUDIO_REINIT);
662 if (ret)
663 cs_dsp_stop(&cs35l56->cs_dsp);
664
665 cs35l56_log_tuning(&cs35l56->base, &cs35l56->cs_dsp);
666
667 err_powered_up:
668 if (!cs35l56->base.fw_patched)
669 cs_dsp_power_down(&cs35l56->cs_dsp);
670 }
671
cs35l56_hda_dsp_work(struct work_struct * work)672 static void cs35l56_hda_dsp_work(struct work_struct *work)
673 {
674 struct cs35l56_hda *cs35l56 = container_of(work, struct cs35l56_hda, dsp_work);
675
676 cs35l56_hda_fw_load(cs35l56);
677 }
678
cs35l56_hda_debugfs_calibrate_write(struct file * file,const char __user * from,size_t count,loff_t * ppos)679 static ssize_t cs35l56_hda_debugfs_calibrate_write(struct file *file,
680 const char __user *from,
681 size_t count, loff_t *ppos)
682 {
683 struct cs35l56_base *cs35l56_base = file->private_data;
684 ssize_t ret;
685
686 PM_RUNTIME_ACQUIRE_IF_ENABLED_AUTOSUSPEND(cs35l56_base->dev, pm);
687 ret = PM_RUNTIME_ACQUIRE_ERR(&pm);
688 if (ret)
689 return ret;
690
691 return cs35l56_calibrate_debugfs_write(cs35l56_base, from, count, ppos);
692 }
693
cs35l56_hda_debugfs_cal_temperature_write(struct file * file,const char __user * from,size_t count,loff_t * ppos)694 static ssize_t cs35l56_hda_debugfs_cal_temperature_write(struct file *file,
695 const char __user *from,
696 size_t count, loff_t *ppos)
697 {
698 struct cs35l56_base *cs35l56_base = file->private_data;
699 ssize_t ret;
700
701 PM_RUNTIME_ACQUIRE_IF_ENABLED_AUTOSUSPEND(cs35l56_base->dev, pm);
702 ret = PM_RUNTIME_ACQUIRE_ERR(&pm);
703 if (ret)
704 return ret;
705
706 return cs35l56_cal_ambient_debugfs_write(cs35l56_base, from, count, ppos);
707 }
708
cs35l56_hda_debugfs_cal_data_read(struct file * file,char __user * to,size_t count,loff_t * ppos)709 static ssize_t cs35l56_hda_debugfs_cal_data_read(struct file *file,
710 char __user *to,
711 size_t count, loff_t *ppos)
712 {
713 struct cs35l56_base *cs35l56_base = file->private_data;
714 ssize_t ret;
715
716 PM_RUNTIME_ACQUIRE_IF_ENABLED_AUTOSUSPEND(cs35l56_base->dev, pm);
717 ret = PM_RUNTIME_ACQUIRE_ERR(&pm);
718 if (ret)
719 return ret;
720
721 return cs35l56_cal_data_debugfs_read(cs35l56_base, to, count, ppos);
722 }
723
cs35l56_hda_debugfs_cal_data_write(struct file * file,const char __user * from,size_t count,loff_t * ppos)724 static ssize_t cs35l56_hda_debugfs_cal_data_write(struct file *file,
725 const char __user *from,
726 size_t count, loff_t *ppos)
727 {
728 struct cs35l56_base *cs35l56_base = file->private_data;
729 struct cs35l56_hda *cs35l56 = cs35l56_hda_from_base(cs35l56_base);
730 ssize_t ret;
731
732 ret = cs35l56_cal_data_debugfs_write(cs35l56_base, from, count, ppos);
733 if (ret == -ENODATA)
734 return count; /* Ignore writes of empty cal blobs */
735
736 if (ret < 0)
737 return ret;
738
739 PM_RUNTIME_ACQUIRE_IF_ENABLED_AUTOSUSPEND(cs35l56_base->dev, pm);
740 ret = PM_RUNTIME_ACQUIRE_ERR(&pm);
741 if (ret)
742 return ret;
743
744 ret = cs35l56_hda_apply_calibration(cs35l56);
745 if (ret == 0)
746 cs35l56_mbox_send(cs35l56_base, CS35L56_MBOX_CMD_AUDIO_REINIT);
747 else
748 count = -EIO;
749
750 return count;
751 }
752
753 static const struct cs35l56_cal_debugfs_fops cs35l56_hda_cal_debugfs_fops = {
754 .calibrate = {
755 .write = cs35l56_hda_debugfs_calibrate_write,
756 },
757 .cal_temperature = {
758 .write = cs35l56_hda_debugfs_cal_temperature_write,
759 },
760 .cal_data = {
761 .read = cs35l56_hda_debugfs_cal_data_read,
762 .write = cs35l56_hda_debugfs_cal_data_write,
763 },
764 };
765
cs35l56_hda_bind(struct device * dev,struct device * master,void * master_data)766 static int cs35l56_hda_bind(struct device *dev, struct device *master, void *master_data)
767 {
768 struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
769 struct hda_component_parent *parent = master_data;
770 struct hda_component *comp;
771
772 comp = hda_component_from_index(parent, cs35l56->index);
773 if (!comp)
774 return -EINVAL;
775
776 if (comp->dev)
777 return -EBUSY;
778
779 comp->dev = dev;
780 cs35l56->codec = parent->codec;
781 strscpy(comp->name, dev_name(dev), sizeof(comp->name));
782 comp->playback_hook = cs35l56_hda_playback_hook;
783
784 queue_work(system_long_wq, &cs35l56->dsp_work);
785
786 cs35l56_hda_create_controls(cs35l56);
787
788 #if IS_ENABLED(CONFIG_SND_DEBUG)
789 cs35l56->debugfs_root = debugfs_create_dir(dev_name(cs35l56->base.dev), sound_debugfs_root);
790 cs_dsp_init_debugfs(&cs35l56->cs_dsp, cs35l56->debugfs_root);
791 #endif
792
793 if (IS_ENABLED(CONFIG_SND_HDA_SCODEC_CS35L56_CAL_DEBUGFS))
794 cs35l56_create_cal_debugfs(&cs35l56->base, &cs35l56_hda_cal_debugfs_fops);
795
796 dev_dbg(cs35l56->base.dev, "Bound\n");
797
798 return 0;
799 }
800
cs35l56_hda_unbind(struct device * dev,struct device * master,void * master_data)801 static void cs35l56_hda_unbind(struct device *dev, struct device *master, void *master_data)
802 {
803 struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
804 struct hda_component_parent *parent = master_data;
805 struct hda_component *comp;
806
807 cancel_work_sync(&cs35l56->dsp_work);
808
809 cs35l56_remove_cal_debugfs(&cs35l56->base);
810 cs35l56_hda_remove_controls(cs35l56);
811
812 #if IS_ENABLED(CONFIG_SND_DEBUG)
813 cs_dsp_cleanup_debugfs(&cs35l56->cs_dsp);
814 debugfs_remove_recursive(cs35l56->debugfs_root);
815 #endif
816
817 if (cs35l56->base.fw_patched)
818 cs_dsp_power_down(&cs35l56->cs_dsp);
819
820 comp = hda_component_from_index(parent, cs35l56->index);
821 if (comp && (comp->dev == dev))
822 memset(comp, 0, sizeof(*comp));
823
824 cs35l56->codec = NULL;
825
826 dev_dbg(cs35l56->base.dev, "Unbound\n");
827 }
828
829 static const struct component_ops cs35l56_hda_comp_ops = {
830 .bind = cs35l56_hda_bind,
831 .unbind = cs35l56_hda_unbind,
832 };
833
cs35l56_hda_system_suspend(struct device * dev)834 static int cs35l56_hda_system_suspend(struct device *dev)
835 {
836 struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
837
838 cs35l56_hda_wait_dsp_ready(cs35l56);
839
840 if (cs35l56->playing)
841 cs35l56_hda_pause(cs35l56);
842
843 cs35l56->suspended = true;
844
845 /*
846 * The interrupt line is normally shared, but after we start suspending
847 * we can't check if our device is the source of an interrupt, and can't
848 * clear it. Prevent this race by temporarily disabling the parent irq
849 * until we reach _no_irq.
850 */
851 if (cs35l56->base.irq)
852 disable_irq(cs35l56->base.irq);
853
854 return pm_runtime_force_suspend(dev);
855 }
856
cs35l56_hda_system_suspend_late(struct device * dev)857 static int cs35l56_hda_system_suspend_late(struct device *dev)
858 {
859 struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
860
861 /*
862 * RESET is usually shared by all amps so it must not be asserted until
863 * all driver instances have done their suspend() stage.
864 */
865 if (cs35l56->base.reset_gpio) {
866 gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 0);
867 cs35l56_wait_min_reset_pulse();
868 }
869
870 return 0;
871 }
872
cs35l56_hda_system_suspend_no_irq(struct device * dev)873 static int cs35l56_hda_system_suspend_no_irq(struct device *dev)
874 {
875 struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
876
877 /* Handlers are now disabled so the parent IRQ can safely be re-enabled. */
878 if (cs35l56->base.irq)
879 enable_irq(cs35l56->base.irq);
880
881 return 0;
882 }
883
cs35l56_hda_system_resume_no_irq(struct device * dev)884 static int cs35l56_hda_system_resume_no_irq(struct device *dev)
885 {
886 struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
887
888 /*
889 * WAKE interrupts unmask if the CS35L56 hibernates, which can cause
890 * spurious interrupts, and the interrupt line is normally shared.
891 * We can't check if our device is the source of an interrupt, and can't
892 * clear it, until it has fully resumed. Prevent this race by temporarily
893 * disabling the parent irq until we complete resume().
894 */
895 if (cs35l56->base.irq)
896 disable_irq(cs35l56->base.irq);
897
898 return 0;
899 }
900
cs35l56_hda_system_resume_early(struct device * dev)901 static int cs35l56_hda_system_resume_early(struct device *dev)
902 {
903 struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
904
905 /* Ensure a spec-compliant RESET pulse. */
906 if (cs35l56->base.reset_gpio) {
907 gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 0);
908 cs35l56_wait_min_reset_pulse();
909
910 /* Release shared RESET before drivers start resume(). */
911 gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 1);
912 cs35l56_wait_control_port_ready();
913 }
914
915 return 0;
916 }
917
cs35l56_hda_system_resume(struct device * dev)918 static int cs35l56_hda_system_resume(struct device *dev)
919 {
920 struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
921 int ret;
922
923 /* Undo pm_runtime_force_suspend() before re-enabling the irq */
924 ret = pm_runtime_force_resume(dev);
925 if (cs35l56->base.irq)
926 enable_irq(cs35l56->base.irq);
927
928 if (ret)
929 return ret;
930
931 cs35l56->suspended = false;
932
933 if (!cs35l56->codec)
934 return 0;
935
936 ret = cs35l56_is_fw_reload_needed(&cs35l56->base);
937 dev_dbg(cs35l56->base.dev, "fw_reload_needed: %d\n", ret);
938 if (ret > 0)
939 queue_work(system_long_wq, &cs35l56->dsp_work);
940
941 if (cs35l56->playing)
942 cs35l56_hda_play(cs35l56);
943
944 return 0;
945 }
946
cs35l56_hda_fixup_yoga9(struct cs35l56_hda * cs35l56,int * bus_addr)947 static int cs35l56_hda_fixup_yoga9(struct cs35l56_hda *cs35l56, int *bus_addr)
948 {
949 /* The cirrus,dev-index property has the wrong values */
950 cs35l56->num_amps = 2;
951 switch (*bus_addr) {
952 case 0x30:
953 cs35l56->index = 1;
954 return 0;
955 case 0x31:
956 cs35l56->index = 0;
957 return 0;
958 default:
959 /* There is a pseudo-address for broadcast to both amps - ignore it */
960 dev_dbg(cs35l56->base.dev, "Ignoring I2C address %#x\n", *bus_addr);
961 return 0;
962 }
963 }
964
965 static const struct {
966 const char *sub;
967 int (*fixup_fn)(struct cs35l56_hda *cs35l56, int *bus_addr);
968 } cs35l56_hda_fixups[] = {
969 {
970 .sub = "17AA390B", /* Lenovo Yoga Book 9i GenX */
971 .fixup_fn = cs35l56_hda_fixup_yoga9,
972 },
973 };
974
cs35l56_hda_apply_platform_fixups(struct cs35l56_hda * cs35l56,const char * sub,int * bus_addr)975 static int cs35l56_hda_apply_platform_fixups(struct cs35l56_hda *cs35l56, const char *sub,
976 int *bus_addr)
977 {
978 int i;
979
980 if (IS_ERR(sub))
981 return 0;
982
983 for (i = 0; i < ARRAY_SIZE(cs35l56_hda_fixups); i++) {
984 if (strcasecmp(cs35l56_hda_fixups[i].sub, sub) == 0) {
985 dev_dbg(cs35l56->base.dev, "Applying fixup for %s\n",
986 cs35l56_hda_fixups[i].sub);
987 return (cs35l56_hda_fixups[i].fixup_fn)(cs35l56, bus_addr);
988 }
989 }
990
991 return 0;
992 }
993
cs35l56_hda_read_acpi(struct cs35l56_hda * cs35l56,int hid,int id)994 static int cs35l56_hda_read_acpi(struct cs35l56_hda *cs35l56, int hid, int id)
995 {
996 u32 values[HDA_MAX_COMPONENTS];
997 char hid_string[8];
998 struct acpi_device *adev;
999 const char *property;
1000 int i, ret;
1001
1002 /*
1003 * ACPI_COMPANION isn't available when this driver was instantiated by
1004 * the serial-multi-instantiate driver, so lookup the node by HID
1005 */
1006 if (!ACPI_COMPANION(cs35l56->base.dev)) {
1007 snprintf(hid_string, sizeof(hid_string), "CSC%04X", hid);
1008 adev = acpi_dev_get_first_match_dev(hid_string, NULL, -1);
1009 if (!adev) {
1010 dev_err(cs35l56->base.dev, "Failed to find an ACPI device for %s\n",
1011 dev_name(cs35l56->base.dev));
1012 return -ENODEV;
1013 }
1014 ACPI_COMPANION_SET(cs35l56->base.dev, adev);
1015 acpi_dev_put(adev);
1016 }
1017
1018 /* Initialize things that could be overwritten by a fixup */
1019 cs35l56->index = -1;
1020
1021 const char *sub __free(kfree) = acpi_get_subsystem_id(ACPI_HANDLE(cs35l56->base.dev));
1022
1023 ret = cs35l56_hda_apply_platform_fixups(cs35l56, sub, &id);
1024 if (ret)
1025 return ret;
1026
1027 if (cs35l56->index == -1) {
1028 property = "cirrus,dev-index";
1029 ret = device_property_count_u32(cs35l56->base.dev, property);
1030 if (ret <= 0)
1031 goto err;
1032
1033 if (ret > ARRAY_SIZE(values)) {
1034 ret = -EINVAL;
1035 goto err;
1036 }
1037 cs35l56->num_amps = ret;
1038
1039 ret = device_property_read_u32_array(cs35l56->base.dev, property, values,
1040 cs35l56->num_amps);
1041 if (ret)
1042 goto err;
1043
1044 for (i = 0; i < cs35l56->num_amps; i++) {
1045 if (values[i] == id) {
1046 cs35l56->index = i;
1047 break;
1048 }
1049 }
1050
1051 /*
1052 * It's not an error for the ID to be missing: for I2C there can be
1053 * an alias address that is not a real device. So reject silently.
1054 */
1055 if (cs35l56->index == -1) {
1056 dev_dbg(cs35l56->base.dev, "No index found in %s\n", property);
1057 ret = -ENODEV;
1058 goto err;
1059 }
1060 }
1061
1062 if (IS_ERR(sub)) {
1063 dev_info(cs35l56->base.dev,
1064 "Read ACPI _SUB failed(%ld): fallback to generic firmware\n",
1065 PTR_ERR(sub));
1066 } else {
1067 ret = cirrus_scodec_get_speaker_id(cs35l56->base.dev, cs35l56->index,
1068 cs35l56->num_amps, -1);
1069 if (ret == -ENOENT) {
1070 cs35l56->system_name = devm_kstrdup(cs35l56->base.dev, sub, GFP_KERNEL);
1071 } else if (ret >= 0) {
1072 cs35l56->system_name = devm_kasprintf(cs35l56->base.dev, GFP_KERNEL,
1073 "%s-spkid%d", sub, ret);
1074 } else {
1075 return ret;
1076 }
1077
1078 if (!cs35l56->system_name)
1079 return -ENOMEM;
1080 }
1081
1082 cs35l56->base.reset_gpio = devm_gpiod_get_index_optional(cs35l56->base.dev,
1083 "reset",
1084 cs35l56->index,
1085 GPIOD_OUT_LOW);
1086 if (IS_ERR(cs35l56->base.reset_gpio)) {
1087 ret = PTR_ERR(cs35l56->base.reset_gpio);
1088
1089 /*
1090 * If RESET is shared the first amp to probe will grab the reset
1091 * line and reset all the amps
1092 */
1093 if (ret != -EBUSY)
1094 return dev_err_probe(cs35l56->base.dev, ret, "Failed to get reset GPIO\n");
1095
1096 dev_info(cs35l56->base.dev, "Reset GPIO busy, assume shared reset\n");
1097 cs35l56->base.reset_gpio = NULL;
1098 }
1099
1100 return 0;
1101
1102 err:
1103 if (ret != -ENODEV)
1104 dev_err(cs35l56->base.dev, "Failed property %s: %d\n", property, ret);
1105
1106 return ret;
1107 }
1108
cs35l56_hda_common_probe(struct cs35l56_hda * cs35l56,int hid,int id)1109 int cs35l56_hda_common_probe(struct cs35l56_hda *cs35l56, int hid, int id)
1110 {
1111 int ret;
1112
1113 mutex_init(&cs35l56->base.irq_lock);
1114 dev_set_drvdata(cs35l56->base.dev, cs35l56);
1115
1116 INIT_WORK(&cs35l56->dsp_work, cs35l56_hda_dsp_work);
1117
1118 ret = cs35l56_hda_read_acpi(cs35l56, hid, id);
1119 if (ret)
1120 goto err;
1121
1122 cs35l56->amp_name = devm_kasprintf(cs35l56->base.dev, GFP_KERNEL, "AMP%d",
1123 cs35l56->index + 1);
1124 if (!cs35l56->amp_name) {
1125 ret = -ENOMEM;
1126 goto err;
1127 }
1128
1129 cs35l56->base.type = hid & 0xff;
1130 cs35l56->base.cal_index = cs35l56->index;
1131
1132 cs35l56_init_cs_dsp(&cs35l56->base, &cs35l56->cs_dsp);
1133
1134 if (cs35l56->base.reset_gpio) {
1135 dev_dbg(cs35l56->base.dev, "Hard reset\n");
1136
1137 /*
1138 * The GPIOD_OUT_LOW to *_gpiod_get_*() will be ignored if the
1139 * ACPI defines a different default state. So explicitly set low.
1140 */
1141 gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 0);
1142 cs35l56_wait_min_reset_pulse();
1143 gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 1);
1144 }
1145
1146 ret = cs35l56_hw_init(&cs35l56->base);
1147 if (ret < 0)
1148 goto err;
1149
1150 /* Reset the device and wait for it to boot */
1151 cs35l56_system_reset(&cs35l56->base, false);
1152 ret = cs35l56_wait_for_firmware_boot(&cs35l56->base);
1153 if (ret)
1154 goto err;
1155
1156 regcache_cache_only(cs35l56->base.regmap, false);
1157
1158 ret = cs35l56_set_patch(&cs35l56->base);
1159 if (ret)
1160 goto err;
1161
1162 regcache_mark_dirty(cs35l56->base.regmap);
1163 regcache_sync(cs35l56->base.regmap);
1164
1165 /* Disable auto-hibernate so that runtime_pm has control */
1166 ret = cs35l56_mbox_send(&cs35l56->base, CS35L56_MBOX_CMD_PREVENT_AUTO_HIBERNATE);
1167 if (ret)
1168 goto err;
1169
1170 ret = cs35l56_get_calibration(&cs35l56->base);
1171 if (ret)
1172 goto err;
1173
1174 ret = cs_dsp_halo_init(&cs35l56->cs_dsp);
1175 if (ret) {
1176 dev_err_probe(cs35l56->base.dev, ret, "cs_dsp_halo_init failed\n");
1177 goto err;
1178 }
1179
1180 dev_info(cs35l56->base.dev, "DSP system name: '%s', amp name: '%s'\n",
1181 cs35l56->system_name, cs35l56->amp_name);
1182
1183 regmap_multi_reg_write(cs35l56->base.regmap, cs35l56_hda_dai_config,
1184 ARRAY_SIZE(cs35l56_hda_dai_config));
1185
1186 /*
1187 * By default only enable one ASP1TXn, where n=amplifier index,
1188 * This prevents multiple amps trying to drive the same slot.
1189 */
1190 cs35l56->asp_tx_mask = BIT(cs35l56->index);
1191
1192 pm_runtime_set_autosuspend_delay(cs35l56->base.dev, 3000);
1193 pm_runtime_use_autosuspend(cs35l56->base.dev);
1194 pm_runtime_set_active(cs35l56->base.dev);
1195 pm_runtime_mark_last_busy(cs35l56->base.dev);
1196 pm_runtime_enable(cs35l56->base.dev);
1197
1198 cs35l56->base.init_done = true;
1199
1200 ret = component_add(cs35l56->base.dev, &cs35l56_hda_comp_ops);
1201 if (ret) {
1202 dev_err(cs35l56->base.dev, "Register component failed: %d\n", ret);
1203 goto pm_err;
1204 }
1205
1206 return 0;
1207
1208 pm_err:
1209 pm_runtime_disable(cs35l56->base.dev);
1210 cs_dsp_remove(&cs35l56->cs_dsp);
1211 err:
1212 gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 0);
1213
1214 return ret;
1215 }
1216 EXPORT_SYMBOL_NS_GPL(cs35l56_hda_common_probe, "SND_HDA_SCODEC_CS35L56");
1217
cs35l56_hda_remove(struct device * dev)1218 void cs35l56_hda_remove(struct device *dev)
1219 {
1220 struct cs35l56_hda *cs35l56 = dev_get_drvdata(dev);
1221
1222 component_del(cs35l56->base.dev, &cs35l56_hda_comp_ops);
1223
1224 pm_runtime_dont_use_autosuspend(cs35l56->base.dev);
1225 pm_runtime_get_sync(cs35l56->base.dev);
1226 pm_runtime_disable(cs35l56->base.dev);
1227
1228 cs_dsp_remove(&cs35l56->cs_dsp);
1229
1230 pm_runtime_put_noidle(cs35l56->base.dev);
1231
1232 gpiod_set_value_cansleep(cs35l56->base.reset_gpio, 0);
1233 }
1234 EXPORT_SYMBOL_NS_GPL(cs35l56_hda_remove, "SND_HDA_SCODEC_CS35L56");
1235
1236 const struct dev_pm_ops cs35l56_hda_pm_ops = {
1237 RUNTIME_PM_OPS(cs35l56_hda_runtime_suspend, cs35l56_hda_runtime_resume, NULL)
1238 SYSTEM_SLEEP_PM_OPS(cs35l56_hda_system_suspend, cs35l56_hda_system_resume)
1239 LATE_SYSTEM_SLEEP_PM_OPS(cs35l56_hda_system_suspend_late,
1240 cs35l56_hda_system_resume_early)
1241 NOIRQ_SYSTEM_SLEEP_PM_OPS(cs35l56_hda_system_suspend_no_irq,
1242 cs35l56_hda_system_resume_no_irq)
1243 };
1244 EXPORT_SYMBOL_NS_GPL(cs35l56_hda_pm_ops, "SND_HDA_SCODEC_CS35L56");
1245
1246 MODULE_DESCRIPTION("CS35L56 HDA Driver");
1247 MODULE_IMPORT_NS("FW_CS_DSP");
1248 MODULE_IMPORT_NS("SND_HDA_CIRRUS_SCODEC");
1249 MODULE_IMPORT_NS("SND_SOC_CS35L56_SHARED");
1250 MODULE_IMPORT_NS("SND_SOC_CS_AMP_LIB");
1251 MODULE_AUTHOR("Richard Fitzgerald <rf@opensource.cirrus.com>");
1252 MODULE_AUTHOR("Simon Trimmer <simont@opensource.cirrus.com>");
1253 MODULE_LICENSE("GPL");
1254 MODULE_FIRMWARE("cirrus/cs35l54-*.wmfw");
1255 MODULE_FIRMWARE("cirrus/cs35l54-*.bin");
1256 MODULE_FIRMWARE("cirrus/cs35l56-*.wmfw");
1257 MODULE_FIRMWARE("cirrus/cs35l56-*.bin");
1258