xref: /linux/sound/soc/codecs/wm_adsp.c (revision 88c4aff39452d7f0ab59f13730182a43bc7257c6)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * wm_adsp.c  --  Wolfson ADSP support
4  *
5  * Copyright 2012 Wolfson Microelectronics plc
6  *
7  * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
8  */
9 
10 #include <kunit/static_stub.h>
11 #include <kunit/visibility.h>
12 #include <linux/array_size.h>
13 #include <linux/cleanup.h>
14 #include <linux/ctype.h>
15 #include <linux/module.h>
16 #include <linux/moduleparam.h>
17 #include <linux/init.h>
18 #include <linux/delay.h>
19 #include <linux/firmware.h>
20 #include <linux/list.h>
21 #include <linux/pm.h>
22 #include <linux/regmap.h>
23 #include <linux/regulator/consumer.h>
24 #include <linux/slab.h>
25 #include <linux/string.h>
26 #include <linux/workqueue.h>
27 #include <linux/debugfs.h>
28 #include <sound/core.h>
29 #include <sound/pcm.h>
30 #include <sound/pcm_params.h>
31 #include <sound/soc.h>
32 #include <sound/jack.h>
33 #include <sound/initval.h>
34 #include <sound/tlv.h>
35 
36 #include "wm_adsp.h"
37 
38 #define adsp_crit(_dsp, fmt, ...) \
39 	dev_crit(_dsp->cs_dsp.dev, "%s: " fmt, _dsp->cs_dsp.name, ##__VA_ARGS__)
40 #define adsp_err(_dsp, fmt, ...) \
41 	dev_err(_dsp->cs_dsp.dev, "%s: " fmt, _dsp->cs_dsp.name, ##__VA_ARGS__)
42 #define adsp_warn(_dsp, fmt, ...) \
43 	dev_warn(_dsp->cs_dsp.dev, "%s: " fmt, _dsp->cs_dsp.name, ##__VA_ARGS__)
44 #define adsp_info(_dsp, fmt, ...) \
45 	dev_info(_dsp->cs_dsp.dev, "%s: " fmt, _dsp->cs_dsp.name, ##__VA_ARGS__)
46 #define adsp_dbg(_dsp, fmt, ...) \
47 	dev_dbg(_dsp->cs_dsp.dev, "%s: " fmt, _dsp->cs_dsp.name, ##__VA_ARGS__)
48 
49 #define compr_err(_obj, fmt, ...) \
50 	adsp_err(_obj->dsp, "%s: " fmt, _obj->name ? _obj->name : "legacy", \
51 		 ##__VA_ARGS__)
52 #define compr_dbg(_obj, fmt, ...) \
53 	adsp_dbg(_obj->dsp, "%s: " fmt, _obj->name ? _obj->name : "legacy", \
54 		 ##__VA_ARGS__)
55 
56 #define ADSP_MAX_STD_CTRL_SIZE               512
57 
58 static const struct cs_dsp_client_ops wm_adsp1_client_ops;
59 static const struct cs_dsp_client_ops wm_adsp2_client_ops;
60 
61 #define WM_ADSP_FW_MBC_VSS  0
62 #define WM_ADSP_FW_HIFI     1
63 #define WM_ADSP_FW_TX       2
64 #define WM_ADSP_FW_TX_SPK   3
65 #define WM_ADSP_FW_RX       4
66 #define WM_ADSP_FW_RX_ANC   5
67 #define WM_ADSP_FW_CTRL     6
68 #define WM_ADSP_FW_ASR      7
69 #define WM_ADSP_FW_TRACE    8
70 #define WM_ADSP_FW_SPK_PROT 9
71 #define WM_ADSP_FW_SPK_CALI 10
72 #define WM_ADSP_FW_SPK_DIAG 11
73 #define WM_ADSP_FW_MISC     12
74 
75 #define WM_ADSP_NUM_FW      13
76 
77 static const char * const wm_adsp_fw_text[WM_ADSP_NUM_FW] = {
78 	[WM_ADSP_FW_MBC_VSS] =  "MBC/VSS",
79 	[WM_ADSP_FW_HIFI] =     "MasterHiFi",
80 	[WM_ADSP_FW_TX] =       "Tx",
81 	[WM_ADSP_FW_TX_SPK] =   "Tx Speaker",
82 	[WM_ADSP_FW_RX] =       "Rx",
83 	[WM_ADSP_FW_RX_ANC] =   "Rx ANC",
84 	[WM_ADSP_FW_CTRL] =     "Voice Ctrl",
85 	[WM_ADSP_FW_ASR] =      "ASR Assist",
86 	[WM_ADSP_FW_TRACE] =    "Dbg Trace",
87 	[WM_ADSP_FW_SPK_PROT] = "Protection",
88 	[WM_ADSP_FW_SPK_CALI] = "Calibration",
89 	[WM_ADSP_FW_SPK_DIAG] = "Diagnostic",
90 	[WM_ADSP_FW_MISC] =     "Misc",
91 };
92 
93 struct wm_adsp_system_config_xm_hdr {
94 	__be32 sys_enable;
95 	__be32 fw_id;
96 	__be32 fw_rev;
97 	__be32 boot_status;
98 	__be32 watchdog;
99 	__be32 dma_buffer_size;
100 	__be32 rdma[6];
101 	__be32 wdma[8];
102 	__be32 build_job_name[3];
103 	__be32 build_job_number;
104 } __packed;
105 
106 struct wm_halo_system_config_xm_hdr {
107 	__be32 halo_heartbeat;
108 	__be32 build_job_name[3];
109 	__be32 build_job_number;
110 } __packed;
111 
112 struct wm_adsp_alg_xm_struct {
113 	__be32 magic;
114 	__be32 smoothing;
115 	__be32 threshold;
116 	__be32 host_buf_ptr;
117 	__be32 start_seq;
118 	__be32 high_water_mark;
119 	__be32 low_water_mark;
120 	__be64 smoothed_power;
121 } __packed;
122 
123 struct wm_adsp_host_buf_coeff_v1 {
124 	__be32 host_buf_ptr;		/* Host buffer pointer */
125 	__be32 versions;		/* Version numbers */
126 	__be32 name[4];			/* The buffer name */
127 } __packed;
128 
129 struct wm_adsp_buffer {
130 	__be32 buf1_base;		/* Base addr of first buffer area */
131 	__be32 buf1_size;		/* Size of buf1 area in DSP words */
132 	__be32 buf2_base;		/* Base addr of 2nd buffer area */
133 	__be32 buf1_buf2_size;		/* Size of buf1+buf2 in DSP words */
134 	__be32 buf3_base;		/* Base addr of buf3 area */
135 	__be32 buf_total_size;		/* Size of buf1+buf2+buf3 in DSP words */
136 	__be32 high_water_mark;		/* Point at which IRQ is asserted */
137 	__be32 irq_count;		/* bits 1-31 count IRQ assertions */
138 	__be32 irq_ack;			/* acked IRQ count, bit 0 enables IRQ */
139 	__be32 next_write_index;	/* word index of next write */
140 	__be32 next_read_index;		/* word index of next read */
141 	__be32 error;			/* error if any */
142 	__be32 oldest_block_index;	/* word index of oldest surviving */
143 	__be32 requested_rewind;	/* how many blocks rewind was done */
144 	__be32 reserved_space;		/* internal */
145 	__be32 min_free;		/* min free space since stream start */
146 	__be32 blocks_written[2];	/* total blocks written (64 bit) */
147 	__be32 words_written[2];	/* total words written (64 bit) */
148 } __packed;
149 
150 struct wm_adsp_compr;
151 
152 struct wm_adsp_compr_buf {
153 	struct list_head list;
154 	struct wm_adsp *dsp;
155 	struct wm_adsp_compr *compr;
156 
157 	struct wm_adsp_buffer_region *regions;
158 	u32 host_buf_ptr;
159 
160 	u32 error;
161 	u32 irq_count;
162 	int read_index;
163 	int avail;
164 	int host_buf_mem_type;
165 
166 	char *name;
167 };
168 
169 struct wm_adsp_compr {
170 	struct list_head list;
171 	struct wm_adsp *dsp;
172 	struct wm_adsp_compr_buf *buf;
173 
174 	struct snd_compr_stream *stream;
175 	struct snd_compressed_buffer size;
176 
177 	u32 *raw_buf;
178 	u64 copied_total;
179 
180 	unsigned int sample_rate;
181 
182 	const char *name;
183 };
184 
185 #define WM_ADSP_MIN_FRAGMENTS          1
186 #define WM_ADSP_MAX_FRAGMENTS          256
187 #define WM_ADSP_MIN_FRAGMENT_SIZE      (16 * CS_DSP_DATA_WORD_SIZE)
188 #define WM_ADSP_MAX_FRAGMENT_SIZE      (4096 * CS_DSP_DATA_WORD_SIZE)
189 
190 #define WM_ADSP_ALG_XM_STRUCT_MAGIC    0x49aec7
191 
192 #define HOST_BUFFER_FIELD(field) \
193 	(offsetof(struct wm_adsp_buffer, field) / sizeof(__be32))
194 
195 #define ALG_XM_FIELD(field) \
196 	(offsetof(struct wm_adsp_alg_xm_struct, field) / sizeof(__be32))
197 
198 #define HOST_BUF_COEFF_SUPPORTED_COMPAT_VER	1
199 
200 #define HOST_BUF_COEFF_COMPAT_VER_MASK		0xFF00
201 #define HOST_BUF_COEFF_COMPAT_VER_SHIFT		8
202 
203 static int wm_adsp_buffer_init(struct wm_adsp *dsp);
204 static int wm_adsp_buffer_free(struct wm_adsp *dsp);
205 
206 struct wm_adsp_buffer_region {
207 	unsigned int offset;
208 	unsigned int cumulative_size;
209 	unsigned int mem_type;
210 	unsigned int base_addr;
211 };
212 
213 struct wm_adsp_buffer_region_def {
214 	unsigned int mem_type;
215 	unsigned int base_offset;
216 	unsigned int size_offset;
217 };
218 
219 static const struct wm_adsp_buffer_region_def default_regions[] = {
220 	{
221 		.mem_type = WMFW_ADSP2_XM,
222 		.base_offset = HOST_BUFFER_FIELD(buf1_base),
223 		.size_offset = HOST_BUFFER_FIELD(buf1_size),
224 	},
225 	{
226 		.mem_type = WMFW_ADSP2_XM,
227 		.base_offset = HOST_BUFFER_FIELD(buf2_base),
228 		.size_offset = HOST_BUFFER_FIELD(buf1_buf2_size),
229 	},
230 	{
231 		.mem_type = WMFW_ADSP2_YM,
232 		.base_offset = HOST_BUFFER_FIELD(buf3_base),
233 		.size_offset = HOST_BUFFER_FIELD(buf_total_size),
234 	},
235 };
236 
237 struct wm_adsp_fw_caps {
238 	u32 id;
239 	struct snd_codec_desc desc;
240 	int num_regions;
241 	const struct wm_adsp_buffer_region_def *region_defs;
242 };
243 
244 static const struct wm_adsp_fw_caps ctrl_caps[] = {
245 	{
246 		.id = SND_AUDIOCODEC_BESPOKE,
247 		.desc = {
248 			.max_ch = 8,
249 			.sample_rates = { 16000 },
250 			.num_sample_rates = 1,
251 			.formats = SNDRV_PCM_FMTBIT_S16_LE,
252 		},
253 		.num_regions = ARRAY_SIZE(default_regions),
254 		.region_defs = default_regions,
255 	},
256 };
257 
258 static const struct wm_adsp_fw_caps trace_caps[] = {
259 	{
260 		.id = SND_AUDIOCODEC_BESPOKE,
261 		.desc = {
262 			.max_ch = 8,
263 			.sample_rates = {
264 				4000, 8000, 11025, 12000, 16000, 22050,
265 				24000, 32000, 44100, 48000, 64000, 88200,
266 				96000, 176400, 192000
267 			},
268 			.num_sample_rates = 15,
269 			.formats = SNDRV_PCM_FMTBIT_S16_LE,
270 		},
271 		.num_regions = ARRAY_SIZE(default_regions),
272 		.region_defs = default_regions,
273 	},
274 };
275 
276 static const struct {
277 	const char *file;
278 	int compr_direction;
279 	int num_caps;
280 	const struct wm_adsp_fw_caps *caps;
281 	bool voice_trigger;
282 } wm_adsp_fw[WM_ADSP_NUM_FW] = {
283 	[WM_ADSP_FW_MBC_VSS] =  { .file = "mbc-vss" },
284 	[WM_ADSP_FW_HIFI] =     { .file = "hifi" },
285 	[WM_ADSP_FW_TX] =       { .file = "tx" },
286 	[WM_ADSP_FW_TX_SPK] =   { .file = "tx-spk" },
287 	[WM_ADSP_FW_RX] =       { .file = "rx" },
288 	[WM_ADSP_FW_RX_ANC] =   { .file = "rx-anc" },
289 	[WM_ADSP_FW_CTRL] =     {
290 		.file = "ctrl",
291 		.compr_direction = SND_COMPRESS_CAPTURE,
292 		.num_caps = ARRAY_SIZE(ctrl_caps),
293 		.caps = ctrl_caps,
294 		.voice_trigger = true,
295 	},
296 	[WM_ADSP_FW_ASR] =      { .file = "asr" },
297 	[WM_ADSP_FW_TRACE] =    {
298 		.file = "trace",
299 		.compr_direction = SND_COMPRESS_CAPTURE,
300 		.num_caps = ARRAY_SIZE(trace_caps),
301 		.caps = trace_caps,
302 	},
303 	[WM_ADSP_FW_SPK_PROT] = {
304 		.file = "spk-prot",
305 		.compr_direction = SND_COMPRESS_CAPTURE,
306 		.num_caps = ARRAY_SIZE(trace_caps),
307 		.caps = trace_caps,
308 	},
309 	[WM_ADSP_FW_SPK_CALI] = { .file = "spk-cali" },
310 	[WM_ADSP_FW_SPK_DIAG] = { .file = "spk-diag" },
311 	[WM_ADSP_FW_MISC] =     { .file = "misc" },
312 };
313 
314 struct wm_coeff_ctl {
315 	const char *name;
316 	struct cs_dsp_coeff_ctl *cs_ctl;
317 	struct soc_bytes_ext bytes_ext;
318 	struct work_struct work;
319 };
320 
321 #if IS_ENABLED(CONFIG_KUNIT)
322 const char *wm_adsp_get_fwf_name_by_index(int index)
323 {
324 	if (index < ARRAY_SIZE(wm_adsp_fw))
325 		return wm_adsp_fw[index].file;
326 
327 	return NULL;
328 }
329 EXPORT_SYMBOL_IF_KUNIT(wm_adsp_get_fwf_name_by_index);
330 #endif
331 
332 int wm_adsp_fw_get(struct snd_kcontrol *kcontrol,
333 		   struct snd_ctl_elem_value *ucontrol)
334 {
335 	struct snd_soc_component *component = snd_kcontrol_chip(kcontrol);
336 	struct soc_enum *e = (struct soc_enum *)kcontrol->private_value;
337 	struct wm_adsp *dsp = snd_soc_component_get_drvdata(component);
338 
339 	ucontrol->value.enumerated.item[0] = dsp[e->shift_l].fw;
340 
341 	return 0;
342 }
343 EXPORT_SYMBOL_GPL(wm_adsp_fw_get);
344 
345 int wm_adsp_fw_put(struct snd_kcontrol *kcontrol,
346 		   struct snd_ctl_elem_value *ucontrol)
347 {
348 	struct snd_soc_component *component = snd_kcontrol_chip(kcontrol);
349 	struct soc_enum *e = (struct soc_enum *)kcontrol->private_value;
350 	struct wm_adsp *dsp = snd_soc_component_get_drvdata(component);
351 
352 	if (ucontrol->value.enumerated.item[0] == dsp[e->shift_l].fw)
353 		return 0;
354 
355 	if (ucontrol->value.enumerated.item[0] >= WM_ADSP_NUM_FW)
356 		return -EINVAL;
357 
358 	guard(mutex)(&dsp[e->shift_l].cs_dsp.pwr_lock);
359 
360 	if (dsp[e->shift_l].cs_dsp.booted || !list_empty(&dsp[e->shift_l].compr_list))
361 		return -EBUSY;
362 	else
363 		dsp[e->shift_l].fw = ucontrol->value.enumerated.item[0];
364 
365 	return 1;
366 }
367 EXPORT_SYMBOL_GPL(wm_adsp_fw_put);
368 
369 const struct soc_enum wm_adsp_fw_enum[] = {
370 	SOC_ENUM_SINGLE(0, 0, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
371 	SOC_ENUM_SINGLE(0, 1, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
372 	SOC_ENUM_SINGLE(0, 2, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
373 	SOC_ENUM_SINGLE(0, 3, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
374 	SOC_ENUM_SINGLE(0, 4, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
375 	SOC_ENUM_SINGLE(0, 5, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
376 	SOC_ENUM_SINGLE(0, 6, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
377 };
378 EXPORT_SYMBOL_GPL(wm_adsp_fw_enum);
379 
380 static inline struct wm_coeff_ctl *bytes_ext_to_ctl(struct soc_bytes_ext *ext)
381 {
382 	return container_of(ext, struct wm_coeff_ctl, bytes_ext);
383 }
384 
385 static int wm_coeff_info(struct snd_kcontrol *kctl,
386 			 struct snd_ctl_elem_info *uinfo)
387 {
388 	struct soc_bytes_ext *bytes_ext =
389 		(struct soc_bytes_ext *)kctl->private_value;
390 	struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
391 	struct cs_dsp_coeff_ctl *cs_ctl = ctl->cs_ctl;
392 
393 	switch (cs_ctl->type) {
394 	case WMFW_CTL_TYPE_ACKED:
395 		uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
396 		uinfo->value.integer.min = CS_DSP_ACKED_CTL_MIN_VALUE;
397 		uinfo->value.integer.max = CS_DSP_ACKED_CTL_MAX_VALUE;
398 		uinfo->value.integer.step = 1;
399 		uinfo->count = 1;
400 		break;
401 	default:
402 		uinfo->type = SNDRV_CTL_ELEM_TYPE_BYTES;
403 		uinfo->count = cs_ctl->len;
404 		break;
405 	}
406 
407 	return 0;
408 }
409 
410 static int wm_coeff_put(struct snd_kcontrol *kctl,
411 			struct snd_ctl_elem_value *ucontrol)
412 {
413 	struct soc_bytes_ext *bytes_ext =
414 		(struct soc_bytes_ext *)kctl->private_value;
415 	struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
416 	struct cs_dsp_coeff_ctl *cs_ctl = ctl->cs_ctl;
417 	char *p = ucontrol->value.bytes.data;
418 
419 	return cs_dsp_coeff_lock_and_write_ctrl(cs_ctl, 0, p, cs_ctl->len);
420 }
421 
422 static int wm_coeff_tlv_put(struct snd_kcontrol *kctl,
423 			    const unsigned int __user *bytes, unsigned int size)
424 {
425 	struct soc_bytes_ext *bytes_ext =
426 		(struct soc_bytes_ext *)kctl->private_value;
427 	struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
428 	struct cs_dsp_coeff_ctl *cs_ctl = ctl->cs_ctl;
429 	void *scratch __free(kvfree) = vmemdup_user(bytes, size);
430 
431 	if (IS_ERR(scratch))
432 		return PTR_ERR(scratch);
433 
434 	return cs_dsp_coeff_lock_and_write_ctrl(cs_ctl, 0, scratch, size);
435 }
436 
437 static int wm_coeff_put_acked(struct snd_kcontrol *kctl,
438 			      struct snd_ctl_elem_value *ucontrol)
439 {
440 	struct soc_bytes_ext *bytes_ext =
441 		(struct soc_bytes_ext *)kctl->private_value;
442 	struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
443 	struct cs_dsp_coeff_ctl *cs_ctl = ctl->cs_ctl;
444 	unsigned int val = ucontrol->value.integer.value[0];
445 	int ret;
446 
447 	if (val == 0)
448 		return 0;	/* 0 means no event */
449 
450 	guard(mutex)(&cs_ctl->dsp->pwr_lock);
451 
452 	if (cs_ctl->enabled)
453 		ret = cs_dsp_coeff_write_acked_control(cs_ctl, val);
454 	else
455 		ret = -EPERM;
456 
457 	if (ret < 0)
458 		return ret;
459 
460 	return 1;
461 }
462 
463 static int wm_coeff_get(struct snd_kcontrol *kctl,
464 			struct snd_ctl_elem_value *ucontrol)
465 {
466 	struct soc_bytes_ext *bytes_ext =
467 		(struct soc_bytes_ext *)kctl->private_value;
468 	struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
469 	struct cs_dsp_coeff_ctl *cs_ctl = ctl->cs_ctl;
470 	char *p = ucontrol->value.bytes.data;
471 
472 	return cs_dsp_coeff_lock_and_read_ctrl(cs_ctl, 0, p, cs_ctl->len);
473 }
474 
475 static int wm_coeff_tlv_get(struct snd_kcontrol *kctl,
476 			    unsigned int __user *bytes, unsigned int size)
477 {
478 	struct soc_bytes_ext *bytes_ext =
479 		(struct soc_bytes_ext *)kctl->private_value;
480 	struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
481 	struct cs_dsp_coeff_ctl *cs_ctl = ctl->cs_ctl;
482 	int ret = 0;
483 
484 	guard(mutex)(&cs_ctl->dsp->pwr_lock);
485 
486 	ret = cs_dsp_coeff_read_ctrl(cs_ctl, 0, cs_ctl->cache, size);
487 
488 	if (!ret && copy_to_user(bytes, cs_ctl->cache, size))
489 		ret = -EFAULT;
490 
491 	return ret;
492 }
493 
494 static int wm_coeff_get_acked(struct snd_kcontrol *kcontrol,
495 			      struct snd_ctl_elem_value *ucontrol)
496 {
497 	/*
498 	 * Although it's not useful to read an acked control, we must satisfy
499 	 * user-side assumptions that all controls are readable and that a
500 	 * write of the same value should be filtered out (it's valid to send
501 	 * the same event number again to the firmware). We therefore return 0,
502 	 * meaning "no event" so valid event numbers will always be a change
503 	 */
504 	ucontrol->value.integer.value[0] = 0;
505 
506 	return 0;
507 }
508 
509 static unsigned int wmfw_convert_flags(unsigned int in, unsigned int len)
510 {
511 	unsigned int out, rd, wr, vol;
512 
513 	if (len > ADSP_MAX_STD_CTRL_SIZE) {
514 		rd = SNDRV_CTL_ELEM_ACCESS_TLV_READ;
515 		wr = SNDRV_CTL_ELEM_ACCESS_TLV_WRITE;
516 		vol = SNDRV_CTL_ELEM_ACCESS_VOLATILE;
517 
518 		out = SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
519 	} else {
520 		rd = SNDRV_CTL_ELEM_ACCESS_READ;
521 		wr = SNDRV_CTL_ELEM_ACCESS_WRITE;
522 		vol = SNDRV_CTL_ELEM_ACCESS_VOLATILE;
523 
524 		out = 0;
525 	}
526 
527 	if (in) {
528 		out |= rd;
529 		if (in & WMFW_CTL_FLAG_WRITEABLE)
530 			out |= wr;
531 		if (in & WMFW_CTL_FLAG_VOLATILE)
532 			out |= vol;
533 	} else {
534 		out |= rd | wr | vol;
535 	}
536 
537 	return out;
538 }
539 
540 static void wm_adsp_ctl_work(struct work_struct *work)
541 {
542 	struct wm_coeff_ctl *ctl = container_of(work,
543 						struct wm_coeff_ctl,
544 						work);
545 	struct cs_dsp_coeff_ctl *cs_ctl = ctl->cs_ctl;
546 	struct wm_adsp *dsp = container_of(cs_ctl->dsp,
547 					   struct wm_adsp,
548 					   cs_dsp);
549 	struct snd_kcontrol_new *kcontrol;
550 
551 	kcontrol = kzalloc_obj(*kcontrol);
552 	if (!kcontrol)
553 		return;
554 
555 	kcontrol->name = ctl->name;
556 	kcontrol->info = wm_coeff_info;
557 	kcontrol->iface = SNDRV_CTL_ELEM_IFACE_MIXER;
558 	kcontrol->tlv.c = snd_soc_bytes_tlv_callback;
559 	kcontrol->private_value = (unsigned long)&ctl->bytes_ext;
560 	kcontrol->access = wmfw_convert_flags(cs_ctl->flags, cs_ctl->len);
561 
562 	switch (cs_ctl->type) {
563 	case WMFW_CTL_TYPE_ACKED:
564 		kcontrol->get = wm_coeff_get_acked;
565 		kcontrol->put = wm_coeff_put_acked;
566 		break;
567 	default:
568 		if (kcontrol->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
569 			ctl->bytes_ext.max = cs_ctl->len;
570 			ctl->bytes_ext.get = wm_coeff_tlv_get;
571 			ctl->bytes_ext.put = wm_coeff_tlv_put;
572 		} else {
573 			kcontrol->get = wm_coeff_get;
574 			kcontrol->put = wm_coeff_put;
575 		}
576 		break;
577 	}
578 
579 	snd_soc_add_component_controls(dsp->component, kcontrol, 1);
580 
581 	kfree(kcontrol);
582 }
583 
584 int wm_adsp_control_add(struct cs_dsp_coeff_ctl *cs_ctl)
585 {
586 	struct wm_adsp *dsp = container_of(cs_ctl->dsp, struct wm_adsp, cs_dsp);
587 	struct cs_dsp *cs_dsp = &dsp->cs_dsp;
588 	struct wm_coeff_ctl *ctl;
589 	char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
590 	const char *region_name;
591 	int ret;
592 
593 	if (cs_ctl->flags & WMFW_CTL_FLAG_SYS)
594 		return 0;
595 
596 	region_name = cs_dsp_mem_region_name(cs_ctl->alg_region.type);
597 	if (!region_name) {
598 		adsp_err(dsp, "Unknown region type: %d\n", cs_ctl->alg_region.type);
599 		return -EINVAL;
600 	}
601 
602 	switch (cs_dsp->wmfw_ver) {
603 	case 0:
604 	case 1:
605 		ret = scnprintf(name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN,
606 				"%s %s %x", cs_dsp->name, region_name,
607 				cs_ctl->alg_region.alg);
608 		break;
609 	case 2:
610 		ret = scnprintf(name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN,
611 				"%s%c %.12s %x", cs_dsp->name, *region_name,
612 				wm_adsp_fw_text[dsp->fw], cs_ctl->alg_region.alg);
613 		break;
614 	default:
615 		ret = scnprintf(name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN,
616 				"%s %.12s %x", cs_dsp->name,
617 				wm_adsp_fw_text[dsp->fw], cs_ctl->alg_region.alg);
618 		break;
619 	}
620 
621 	if (cs_ctl->subname) {
622 		int avail = SNDRV_CTL_ELEM_ID_NAME_MAXLEN - ret - 2;
623 		int skip = 0;
624 
625 		if (dsp->component->name_prefix)
626 			avail -= strlen(dsp->component->name_prefix) + 1;
627 
628 		/* Truncate the subname from the start if it is too long */
629 		if (cs_ctl->subname_len > avail)
630 			skip = cs_ctl->subname_len - avail;
631 
632 		snprintf(name + ret, SNDRV_CTL_ELEM_ID_NAME_MAXLEN - ret,
633 			 " %.*s", cs_ctl->subname_len - skip, cs_ctl->subname + skip);
634 	}
635 
636 	ctl = kzalloc_obj(*ctl);
637 	if (!ctl)
638 		return -ENOMEM;
639 	ctl->cs_ctl = cs_ctl;
640 
641 	ctl->name = kmemdup(name, strlen(name) + 1, GFP_KERNEL);
642 	if (!ctl->name) {
643 		ret = -ENOMEM;
644 		goto err_ctl;
645 	}
646 
647 	cs_ctl->priv = ctl;
648 
649 	INIT_WORK(&ctl->work, wm_adsp_ctl_work);
650 	schedule_work(&ctl->work);
651 
652 	return 0;
653 
654 err_ctl:
655 	kfree(ctl);
656 
657 	return ret;
658 }
659 EXPORT_SYMBOL_GPL(wm_adsp_control_add);
660 
661 static int wm_adsp_control_add_cb(struct cs_dsp_coeff_ctl *cs_ctl)
662 {
663 	struct wm_adsp *dsp = container_of(cs_ctl->dsp, struct wm_adsp, cs_dsp);
664 
665 	if (dsp->control_add)
666 		return (dsp->control_add)(dsp, cs_ctl);
667 	else
668 		return wm_adsp_control_add(cs_ctl);
669 }
670 
671 static void wm_adsp_control_remove(struct cs_dsp_coeff_ctl *cs_ctl)
672 {
673 	struct wm_coeff_ctl *ctl = cs_ctl->priv;
674 
675 	if (!ctl)
676 		return;
677 
678 	cancel_work_sync(&ctl->work);
679 
680 	kfree(ctl->name);
681 	kfree(ctl);
682 }
683 
684 int wm_adsp_write_ctl(struct wm_adsp *dsp, const char *name, int type,
685 		      unsigned int alg, void *buf, size_t len)
686 {
687 	struct cs_dsp_coeff_ctl *cs_ctl;
688 	int ret;
689 
690 	guard(mutex)(&dsp->cs_dsp.pwr_lock);
691 	cs_ctl = cs_dsp_get_ctl(&dsp->cs_dsp, name, type, alg);
692 	ret = cs_dsp_coeff_write_ctrl(cs_ctl, 0, buf, len);
693 
694 	if (ret < 0)
695 		return ret;
696 
697 	return 0;
698 }
699 EXPORT_SYMBOL_GPL(wm_adsp_write_ctl);
700 
701 int wm_adsp_read_ctl(struct wm_adsp *dsp, const char *name, int type,
702 		     unsigned int alg, void *buf, size_t len)
703 {
704 	guard(mutex)(&dsp->cs_dsp.pwr_lock);
705 
706 	return cs_dsp_coeff_read_ctrl(cs_dsp_get_ctl(&dsp->cs_dsp, name, type, alg),
707 				     0, buf, len);
708 }
709 EXPORT_SYMBOL_GPL(wm_adsp_read_ctl);
710 
711 VISIBLE_IF_KUNIT void wm_adsp_release_firmware_files(struct wm_adsp_fw_files *fw)
712 {
713 	KUNIT_STATIC_STUB_REDIRECT(wm_adsp_release_firmware_files, fw);
714 
715 	release_firmware(fw->wmfw.firmware);
716 	kfree(fw->wmfw.filename);
717 
718 	release_firmware(fw->coeff.firmware);
719 	kfree(fw->coeff.filename);
720 }
721 EXPORT_SYMBOL_IF_KUNIT(wm_adsp_release_firmware_files);
722 
723 VISIBLE_IF_KUNIT int wm_adsp_firmware_request(const struct firmware **firmware,
724 					      const char *filename,
725 					      struct device *dev)
726 {
727 	KUNIT_STATIC_STUB_REDIRECT(wm_adsp_firmware_request, firmware, filename, dev);
728 
729 	return firmware_request_nowarn(firmware, filename, dev);
730 }
731 EXPORT_SYMBOL_IF_KUNIT(wm_adsp_firmware_request);
732 
733 static int wm_adsp_request_firmware_file(struct wm_adsp *dsp,
734 					 struct wm_adsp_fw_file *fw,
735 					 const char *dir, const char *system_name,
736 					 const char *asoc_component_prefix,
737 					 const char *filetype)
738 {
739 	struct cs_dsp *cs_dsp = &dsp->cs_dsp;
740 	const char *fwf;
741 	char *s, c;
742 	int ret;
743 
744 	if (dsp->fwf_name)
745 		fwf = dsp->fwf_name;
746 	else
747 		fwf = dsp->cs_dsp.name;
748 
749 	if (system_name && asoc_component_prefix)
750 		fw->filename = kasprintf(GFP_KERNEL, "%s%s-%s-%s-%s-%s.%s", dir, dsp->part,
751 					 fwf, wm_adsp_fw[dsp->fw].file, system_name,
752 					 asoc_component_prefix, filetype);
753 	else if (system_name)
754 		fw->filename = kasprintf(GFP_KERNEL, "%s%s-%s-%s-%s.%s", dir, dsp->part,
755 					 fwf, wm_adsp_fw[dsp->fw].file, system_name,
756 					 filetype);
757 	else
758 		fw->filename = kasprintf(GFP_KERNEL, "%s%s-%s-%s.%s", dir, dsp->part, fwf,
759 					 wm_adsp_fw[dsp->fw].file, filetype);
760 
761 	if (!fw->filename)
762 		return -ENOMEM;
763 
764 	/*
765 	 * Make sure that filename after dir is lower-case and any non-alpha-numeric
766 	 * characters except full-stop are replaced with hyphens.
767 	 */
768 	s = fw->filename + strlen(dir);
769 	while (*s) {
770 		c = *s;
771 		if (isalnum(c))
772 			*s = tolower(c);
773 		else if (c != '.')
774 			*s = '-';
775 		s++;
776 	}
777 
778 	adsp_dbg(dsp, "Try '%s'\n", fw->filename);
779 	ret = wm_adsp_firmware_request(&fw->firmware, fw->filename, cs_dsp->dev);
780 	if (ret < 0) {
781 		if (ret != -ENOENT)
782 			adsp_dbg(dsp, "Failed to request '%s': %d\n", fw->filename, ret);
783 
784 		kfree(fw->filename);
785 		fw->filename = NULL;
786 		if (ret != -ENOENT)
787 			return ret;
788 	} else {
789 		adsp_dbg(dsp, "Found '%s'\n", fw->filename);
790 	}
791 
792 	return 0;
793 }
794 
795 static const char * const cirrus_dir = "cirrus/";
796 VISIBLE_IF_KUNIT int wm_adsp_request_firmware_files(struct wm_adsp *dsp,
797 						    struct wm_adsp_fw_files *fw)
798 {
799 	const char *system_name = dsp->system_name;
800 	const char *suffix = dsp->component->name_prefix;
801 	bool require_bin_suffix = false;
802 	int ret = 0;
803 
804 	if (dsp->fwf_suffix)
805 		suffix = dsp->fwf_suffix;
806 
807 	if (system_name) {
808 		ret = wm_adsp_request_firmware_file(dsp, &fw->wmfw,
809 						    cirrus_dir, system_name,
810 						    suffix, "wmfw");
811 		if (ret < 0)
812 			goto err;
813 
814 		if (suffix) {
815 			if (fw->wmfw.firmware) {
816 				require_bin_suffix = true;
817 			} else {
818 				/* Fallback to name without suffix */
819 				ret = wm_adsp_request_firmware_file(dsp, &fw->wmfw,
820 								    cirrus_dir, system_name,
821 								    NULL, "wmfw");
822 				if (ret < 0)
823 					goto err;
824 			}
825 		}
826 
827 		/* Look for matching .bin file */
828 		if (fw->wmfw.firmware || dsp->wmfw_optional) {
829 			ret = wm_adsp_request_firmware_file(dsp, &fw->coeff,
830 							    cirrus_dir, system_name,
831 							    suffix, "bin");
832 			if (ret < 0)
833 				goto err;
834 
835 			if (suffix && !fw->coeff.firmware && !require_bin_suffix) {
836 				/* Fallback to name without suffix */
837 				ret = wm_adsp_request_firmware_file(dsp,
838 								    &fw->coeff,
839 								    cirrus_dir, system_name,
840 								    NULL, "bin");
841 				if (ret < 0)
842 					goto err;
843 			}
844 		}
845 
846 		if (fw->wmfw.firmware || (dsp->wmfw_optional && fw->coeff.firmware))
847 			return 0;
848 	}
849 
850 	/* Check legacy location */
851 	ret = wm_adsp_request_firmware_file(dsp, &fw->wmfw, "", NULL, NULL, "wmfw");
852 	if (ret < 0)
853 		goto err;
854 
855 	if (fw->wmfw.firmware) {
856 		ret = wm_adsp_request_firmware_file(dsp, &fw->coeff, "", NULL, NULL, "bin");
857 		if (ret < 0)
858 			goto err;
859 
860 		return 0;
861 	}
862 
863 	/* Fall back to generic wmfw and optional matching bin */
864 	ret = wm_adsp_request_firmware_file(dsp, &fw->wmfw,
865 					    cirrus_dir, NULL, NULL, "wmfw");
866 	if (ret < 0)
867 		goto err;
868 
869 	if (fw->wmfw.firmware || dsp->wmfw_optional) {
870 		ret = wm_adsp_request_firmware_file(dsp, &fw->coeff,
871 						    cirrus_dir, NULL, NULL, "bin");
872 		if (ret < 0)
873 			goto err;
874 
875 		return 0;
876 	}
877 
878 	adsp_err(dsp, "Failed to request firmware <%s>%s-%s-%s<-%s<%s>>.wmfw\n",
879 		 cirrus_dir, dsp->part,
880 		 dsp->fwf_name ? dsp->fwf_name : dsp->cs_dsp.name,
881 		 wm_adsp_fw[dsp->fw].file, system_name, suffix);
882 
883 	ret = -ENOENT;
884 err:
885 	wm_adsp_release_firmware_files(fw);
886 
887 	return ret;
888 }
889 EXPORT_SYMBOL_IF_KUNIT(wm_adsp_request_firmware_files);
890 
891 static int wm_adsp_common_init(struct wm_adsp *dsp)
892 {
893 	INIT_LIST_HEAD(&dsp->compr_list);
894 	INIT_LIST_HEAD(&dsp->buffer_list);
895 
896 	return 0;
897 }
898 
899 int wm_adsp1_init(struct wm_adsp *dsp)
900 {
901 	int ret;
902 
903 	dsp->cs_dsp.client_ops = &wm_adsp1_client_ops;
904 
905 	ret = cs_dsp_adsp1_init(&dsp->cs_dsp);
906 	if (ret)
907 		return ret;
908 
909 	return wm_adsp_common_init(dsp);
910 }
911 EXPORT_SYMBOL_GPL(wm_adsp1_init);
912 
913 int wm_adsp1_event(struct snd_soc_dapm_widget *w,
914 		   struct snd_kcontrol *kcontrol,
915 		   int event)
916 {
917 	struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
918 	struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
919 	struct wm_adsp *dsp = &dsps[w->shift];
920 	struct wm_adsp_fw_files fw = { 0 };
921 	int ret = 0;
922 
923 	dsp->component = component;
924 
925 	switch (event) {
926 	case SND_SOC_DAPM_POST_PMU:
927 		ret = wm_adsp_request_firmware_files(dsp, &fw);
928 		if (ret)
929 			break;
930 
931 		ret = cs_dsp_adsp1_power_up(&dsp->cs_dsp,
932 					    fw.wmfw.firmware, fw.wmfw.filename,
933 					    fw.coeff.firmware, fw.coeff.filename,
934 					    wm_adsp_fw_text[dsp->fw]);
935 
936 		wm_adsp_release_firmware_files(&fw);
937 		break;
938 	case SND_SOC_DAPM_PRE_PMD:
939 		cs_dsp_adsp1_power_down(&dsp->cs_dsp);
940 		break;
941 	default:
942 		break;
943 	}
944 
945 	return ret;
946 }
947 EXPORT_SYMBOL_GPL(wm_adsp1_event);
948 
949 int wm_adsp2_set_dspclk(struct snd_soc_dapm_widget *w, unsigned int freq)
950 {
951 	struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
952 	struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
953 	struct wm_adsp *dsp = &dsps[w->shift];
954 
955 	return cs_dsp_set_dspclk(&dsp->cs_dsp, freq);
956 }
957 EXPORT_SYMBOL_GPL(wm_adsp2_set_dspclk);
958 
959 int wm_adsp2_preloader_get(struct snd_kcontrol *kcontrol,
960 			   struct snd_ctl_elem_value *ucontrol)
961 {
962 	struct snd_soc_component *component = snd_kcontrol_chip(kcontrol);
963 	struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
964 	struct soc_mixer_control *mc =
965 		(struct soc_mixer_control *)kcontrol->private_value;
966 	struct wm_adsp *dsp = &dsps[mc->shift - 1];
967 
968 	ucontrol->value.integer.value[0] = dsp->preloaded;
969 
970 	return 0;
971 }
972 EXPORT_SYMBOL_GPL(wm_adsp2_preloader_get);
973 
974 int wm_adsp2_preloader_put(struct snd_kcontrol *kcontrol,
975 			   struct snd_ctl_elem_value *ucontrol)
976 {
977 	struct snd_soc_component *component = snd_kcontrol_chip(kcontrol);
978 	struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
979 	struct snd_soc_dapm_context *dapm = snd_soc_component_to_dapm(component);
980 	struct soc_mixer_control *mc =
981 		(struct soc_mixer_control *)kcontrol->private_value;
982 	struct wm_adsp *dsp = &dsps[mc->shift - 1];
983 	char preload[32];
984 
985 	if (dsp->preloaded == ucontrol->value.integer.value[0])
986 		return 0;
987 
988 	snprintf(preload, ARRAY_SIZE(preload), "%s Preload", dsp->cs_dsp.name);
989 
990 	if (ucontrol->value.integer.value[0] || dsp->toggle_preload)
991 		snd_soc_dapm_force_enable_pin(dapm, preload);
992 	else
993 		snd_soc_dapm_disable_pin(dapm, preload);
994 
995 	snd_soc_dapm_sync(dapm);
996 
997 	flush_work(&dsp->boot_work);
998 
999 	dsp->preloaded = ucontrol->value.integer.value[0];
1000 
1001 	if (dsp->toggle_preload) {
1002 		snd_soc_dapm_disable_pin(dapm, preload);
1003 		snd_soc_dapm_sync(dapm);
1004 	}
1005 
1006 	return 1;
1007 }
1008 EXPORT_SYMBOL_GPL(wm_adsp2_preloader_put);
1009 
1010 int wm_adsp_power_up(struct wm_adsp *dsp, bool load_firmware)
1011 {
1012 	struct wm_adsp_fw_files fw = { 0 };
1013 	int ret = 0;
1014 
1015 	if (load_firmware) {
1016 		ret = wm_adsp_request_firmware_files(dsp, &fw);
1017 		if (ret)
1018 			return ret;
1019 	}
1020 
1021 	if (dsp->bin_mandatory && !fw.coeff.firmware) {
1022 		ret = -ENOENT;
1023 		goto err;
1024 	}
1025 
1026 	ret = cs_dsp_power_up(&dsp->cs_dsp,
1027 			      fw.wmfw.firmware, fw.wmfw.filename,
1028 			      fw.coeff.firmware, fw.coeff.filename,
1029 			      wm_adsp_fw_text[dsp->fw]);
1030 
1031 err:
1032 	wm_adsp_release_firmware_files(&fw);
1033 
1034 	return ret;
1035 }
1036 EXPORT_SYMBOL_GPL(wm_adsp_power_up);
1037 
1038 void wm_adsp_power_down(struct wm_adsp *dsp)
1039 {
1040 	cs_dsp_power_down(&dsp->cs_dsp);
1041 }
1042 EXPORT_SYMBOL_GPL(wm_adsp_power_down);
1043 
1044 static void wm_adsp_boot_work(struct work_struct *work)
1045 {
1046 	struct wm_adsp *dsp = container_of(work,
1047 					   struct wm_adsp,
1048 					   boot_work);
1049 
1050 	wm_adsp_power_up(dsp, true);
1051 }
1052 
1053 int wm_adsp_early_event(struct snd_soc_dapm_widget *w,
1054 			struct snd_kcontrol *kcontrol, int event)
1055 {
1056 	struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
1057 	struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
1058 	struct wm_adsp *dsp = &dsps[w->shift];
1059 
1060 	switch (event) {
1061 	case SND_SOC_DAPM_PRE_PMU:
1062 		queue_work(system_dfl_wq, &dsp->boot_work);
1063 		break;
1064 	case SND_SOC_DAPM_PRE_PMD:
1065 		wm_adsp_power_down(dsp);
1066 		break;
1067 	default:
1068 		break;
1069 	}
1070 
1071 	return 0;
1072 }
1073 EXPORT_SYMBOL_GPL(wm_adsp_early_event);
1074 
1075 static int wm_adsp_pre_run(struct cs_dsp *cs_dsp)
1076 {
1077 	struct wm_adsp *dsp = container_of(cs_dsp, struct wm_adsp, cs_dsp);
1078 
1079 	if (!dsp->pre_run)
1080 		return 0;
1081 
1082 	return (*dsp->pre_run)(dsp);
1083 }
1084 
1085 static int wm_adsp_event_post_run(struct cs_dsp *cs_dsp)
1086 {
1087 	struct wm_adsp *dsp = container_of(cs_dsp, struct wm_adsp, cs_dsp);
1088 
1089 	if (wm_adsp_fw[dsp->fw].num_caps != 0)
1090 		return wm_adsp_buffer_init(dsp);
1091 
1092 	return 0;
1093 }
1094 
1095 static void wm_adsp_event_post_stop(struct cs_dsp *cs_dsp)
1096 {
1097 	struct wm_adsp *dsp = container_of(cs_dsp, struct wm_adsp, cs_dsp);
1098 
1099 	if (wm_adsp_fw[dsp->fw].num_caps != 0)
1100 		wm_adsp_buffer_free(dsp);
1101 
1102 	dsp->fatal_error = false;
1103 }
1104 
1105 int wm_adsp_run(struct wm_adsp *dsp)
1106 {
1107 	flush_work(&dsp->boot_work);
1108 
1109 	return cs_dsp_run(&dsp->cs_dsp);
1110 }
1111 EXPORT_SYMBOL_GPL(wm_adsp_run);
1112 
1113 void wm_adsp_stop(struct wm_adsp *dsp)
1114 {
1115 	cs_dsp_stop(&dsp->cs_dsp);
1116 }
1117 EXPORT_SYMBOL_GPL(wm_adsp_stop);
1118 
1119 void wm_adsp_hibernate(struct wm_adsp *dsp, bool hibernate)
1120 {
1121 	cs_dsp_hibernate(&dsp->cs_dsp, hibernate);
1122 }
1123 EXPORT_SYMBOL_GPL(wm_adsp_hibernate);
1124 
1125 int wm_adsp_event(struct snd_soc_dapm_widget *w,
1126 		  struct snd_kcontrol *kcontrol, int event)
1127 {
1128 	struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
1129 	struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
1130 	struct wm_adsp *dsp = &dsps[w->shift];
1131 
1132 	switch (event) {
1133 	case SND_SOC_DAPM_POST_PMU:
1134 		return wm_adsp_run(dsp);
1135 	case SND_SOC_DAPM_PRE_PMD:
1136 		wm_adsp_stop(dsp);
1137 		return 0;
1138 	default:
1139 		return 0;
1140 	}
1141 }
1142 EXPORT_SYMBOL_GPL(wm_adsp_event);
1143 
1144 int wm_adsp2_component_probe(struct wm_adsp *dsp, struct snd_soc_component *component)
1145 {
1146 	struct snd_soc_dapm_context *dapm = snd_soc_component_to_dapm(component);
1147 	char preload[32];
1148 
1149 	if (!dsp->cs_dsp.no_core_startstop) {
1150 		snprintf(preload, ARRAY_SIZE(preload), "%s Preload", dsp->cs_dsp.name);
1151 		snd_soc_dapm_disable_pin(dapm, preload);
1152 	}
1153 
1154 	cs_dsp_init_debugfs(&dsp->cs_dsp, component->debugfs_root);
1155 
1156 	dsp->component = component;
1157 
1158 	return 0;
1159 }
1160 EXPORT_SYMBOL_GPL(wm_adsp2_component_probe);
1161 
1162 int wm_adsp2_component_remove(struct wm_adsp *dsp, struct snd_soc_component *component)
1163 {
1164 	if (!dsp)
1165 		return 0;
1166 
1167 	if (!dsp->component)
1168 		return 0;
1169 
1170 	cs_dsp_cleanup_debugfs(&dsp->cs_dsp);
1171 	dsp->component = NULL;
1172 
1173 	return 0;
1174 }
1175 EXPORT_SYMBOL_GPL(wm_adsp2_component_remove);
1176 
1177 int wm_adsp2_init(struct wm_adsp *dsp)
1178 {
1179 	int ret;
1180 
1181 	INIT_WORK(&dsp->boot_work, wm_adsp_boot_work);
1182 
1183 	dsp->sys_config_size = sizeof(struct wm_adsp_system_config_xm_hdr);
1184 	dsp->cs_dsp.client_ops = &wm_adsp2_client_ops;
1185 
1186 	ret = cs_dsp_adsp2_init(&dsp->cs_dsp);
1187 	if (ret)
1188 		return ret;
1189 
1190 	return wm_adsp_common_init(dsp);
1191 }
1192 EXPORT_SYMBOL_GPL(wm_adsp2_init);
1193 
1194 int wm_halo_init(struct wm_adsp *dsp)
1195 {
1196 	int ret;
1197 
1198 	INIT_WORK(&dsp->boot_work, wm_adsp_boot_work);
1199 
1200 	dsp->sys_config_size = sizeof(struct wm_halo_system_config_xm_hdr);
1201 	dsp->cs_dsp.client_ops = &wm_adsp2_client_ops;
1202 
1203 	ret = cs_dsp_halo_init(&dsp->cs_dsp);
1204 	if (ret)
1205 		return ret;
1206 
1207 	return wm_adsp_common_init(dsp);
1208 }
1209 EXPORT_SYMBOL_GPL(wm_halo_init);
1210 
1211 void wm_adsp2_remove(struct wm_adsp *dsp)
1212 {
1213 	cs_dsp_remove(&dsp->cs_dsp);
1214 }
1215 EXPORT_SYMBOL_GPL(wm_adsp2_remove);
1216 
1217 static inline int wm_adsp_compr_attached(struct wm_adsp_compr *compr)
1218 {
1219 	return compr->buf != NULL;
1220 }
1221 
1222 static int wm_adsp_compr_attach(struct wm_adsp_compr *compr)
1223 {
1224 	struct wm_adsp_compr_buf *buf = NULL, *tmp;
1225 
1226 	if (compr->dsp->fatal_error)
1227 		return -EINVAL;
1228 
1229 	list_for_each_entry(tmp, &compr->dsp->buffer_list, list) {
1230 		if (!tmp->name || !strcmp(compr->name, tmp->name)) {
1231 			buf = tmp;
1232 			break;
1233 		}
1234 	}
1235 
1236 	if (!buf)
1237 		return -EINVAL;
1238 
1239 	compr->buf = buf;
1240 	buf->compr = compr;
1241 
1242 	return 0;
1243 }
1244 
1245 static void wm_adsp_compr_detach(struct wm_adsp_compr *compr)
1246 {
1247 	if (!compr)
1248 		return;
1249 
1250 	/* Wake the poll so it can see buffer is no longer attached */
1251 	if (compr->stream)
1252 		snd_compr_fragment_elapsed(compr->stream);
1253 
1254 	if (wm_adsp_compr_attached(compr)) {
1255 		compr->buf->compr = NULL;
1256 		compr->buf = NULL;
1257 	}
1258 }
1259 
1260 int wm_adsp_compr_open(struct wm_adsp *dsp, struct snd_compr_stream *stream)
1261 {
1262 	struct wm_adsp_compr *compr, *tmp;
1263 	struct snd_soc_pcm_runtime *rtd = stream->private_data;
1264 
1265 	guard(mutex)(&dsp->cs_dsp.pwr_lock);
1266 
1267 	if (wm_adsp_fw[dsp->fw].num_caps == 0) {
1268 		adsp_err(dsp, "%s: Firmware does not support compressed API\n",
1269 			 snd_soc_rtd_to_codec(rtd, 0)->name);
1270 		return -ENXIO;
1271 	}
1272 
1273 	if (wm_adsp_fw[dsp->fw].compr_direction != stream->direction) {
1274 		adsp_err(dsp, "%s: Firmware does not support stream direction\n",
1275 			 snd_soc_rtd_to_codec(rtd, 0)->name);
1276 		return -EINVAL;
1277 	}
1278 
1279 	list_for_each_entry(tmp, &dsp->compr_list, list) {
1280 		if (!strcmp(tmp->name, snd_soc_rtd_to_codec(rtd, 0)->name)) {
1281 			adsp_err(dsp, "%s: Only a single stream supported per dai\n",
1282 				 snd_soc_rtd_to_codec(rtd, 0)->name);
1283 			return -EBUSY;
1284 		}
1285 	}
1286 
1287 	compr = kzalloc_obj(*compr);
1288 	if (!compr)
1289 		return -ENOMEM;
1290 
1291 	compr->dsp = dsp;
1292 	compr->stream = stream;
1293 	compr->name = snd_soc_rtd_to_codec(rtd, 0)->name;
1294 
1295 	list_add_tail(&compr->list, &dsp->compr_list);
1296 
1297 	stream->runtime->private_data = compr;
1298 
1299 	return 0;
1300 }
1301 EXPORT_SYMBOL_GPL(wm_adsp_compr_open);
1302 
1303 int wm_adsp_compr_free(struct snd_soc_component *component,
1304 		       struct snd_compr_stream *stream)
1305 {
1306 	struct wm_adsp_compr *compr = stream->runtime->private_data;
1307 	struct wm_adsp *dsp = compr->dsp;
1308 
1309 	guard(mutex)(&dsp->cs_dsp.pwr_lock);
1310 
1311 	wm_adsp_compr_detach(compr);
1312 	list_del(&compr->list);
1313 
1314 	kfree(compr->raw_buf);
1315 	kfree(compr);
1316 
1317 	return 0;
1318 }
1319 EXPORT_SYMBOL_GPL(wm_adsp_compr_free);
1320 
1321 static int wm_adsp_compr_check_params(struct snd_compr_stream *stream,
1322 				      struct snd_compr_params *params)
1323 {
1324 	struct wm_adsp_compr *compr = stream->runtime->private_data;
1325 	struct wm_adsp *dsp = compr->dsp;
1326 	const struct wm_adsp_fw_caps *caps;
1327 	const struct snd_codec_desc *desc;
1328 	int i, j;
1329 
1330 	if (params->buffer.fragment_size < WM_ADSP_MIN_FRAGMENT_SIZE ||
1331 	    params->buffer.fragment_size > WM_ADSP_MAX_FRAGMENT_SIZE ||
1332 	    params->buffer.fragments < WM_ADSP_MIN_FRAGMENTS ||
1333 	    params->buffer.fragments > WM_ADSP_MAX_FRAGMENTS ||
1334 	    params->buffer.fragment_size % CS_DSP_DATA_WORD_SIZE) {
1335 		compr_err(compr, "Invalid buffer fragsize=%d fragments=%d\n",
1336 			  params->buffer.fragment_size,
1337 			  params->buffer.fragments);
1338 
1339 		return -EINVAL;
1340 	}
1341 
1342 	for (i = 0; i < wm_adsp_fw[dsp->fw].num_caps; i++) {
1343 		caps = &wm_adsp_fw[dsp->fw].caps[i];
1344 		desc = &caps->desc;
1345 
1346 		if (caps->id != params->codec.id)
1347 			continue;
1348 
1349 		if (stream->direction == SND_COMPRESS_PLAYBACK) {
1350 			if (desc->max_ch < params->codec.ch_out)
1351 				continue;
1352 		} else {
1353 			if (desc->max_ch < params->codec.ch_in)
1354 				continue;
1355 		}
1356 
1357 		if (!(desc->formats & (1 << params->codec.format)))
1358 			continue;
1359 
1360 		for (j = 0; j < desc->num_sample_rates; ++j)
1361 			if (desc->sample_rates[j] == params->codec.sample_rate)
1362 				return 0;
1363 	}
1364 
1365 	compr_err(compr, "Invalid params id=%u ch=%u,%u rate=%u fmt=%u\n",
1366 		  params->codec.id, params->codec.ch_in, params->codec.ch_out,
1367 		  params->codec.sample_rate, params->codec.format);
1368 	return -EINVAL;
1369 }
1370 
1371 static inline unsigned int wm_adsp_compr_frag_words(struct wm_adsp_compr *compr)
1372 {
1373 	return compr->size.fragment_size / CS_DSP_DATA_WORD_SIZE;
1374 }
1375 
1376 int wm_adsp_compr_set_params(struct snd_soc_component *component,
1377 			     struct snd_compr_stream *stream,
1378 			     struct snd_compr_params *params)
1379 {
1380 	struct wm_adsp_compr *compr = stream->runtime->private_data;
1381 	unsigned int size;
1382 	int ret;
1383 
1384 	ret = wm_adsp_compr_check_params(stream, params);
1385 	if (ret)
1386 		return ret;
1387 
1388 	compr->size = params->buffer;
1389 
1390 	compr_dbg(compr, "fragment_size=%d fragments=%d\n",
1391 		  compr->size.fragment_size, compr->size.fragments);
1392 
1393 	size = wm_adsp_compr_frag_words(compr) * sizeof(*compr->raw_buf);
1394 	compr->raw_buf = kmalloc(size, GFP_DMA | GFP_KERNEL);
1395 	if (!compr->raw_buf)
1396 		return -ENOMEM;
1397 
1398 	compr->sample_rate = params->codec.sample_rate;
1399 
1400 	return 0;
1401 }
1402 EXPORT_SYMBOL_GPL(wm_adsp_compr_set_params);
1403 
1404 int wm_adsp_compr_get_caps(struct snd_soc_component *component,
1405 			   struct snd_compr_stream *stream,
1406 			   struct snd_compr_caps *caps)
1407 {
1408 	struct wm_adsp_compr *compr = stream->runtime->private_data;
1409 	int fw = compr->dsp->fw;
1410 	int i;
1411 
1412 	if (wm_adsp_fw[fw].caps) {
1413 		for (i = 0; i < wm_adsp_fw[fw].num_caps; i++)
1414 			caps->codecs[i] = wm_adsp_fw[fw].caps[i].id;
1415 
1416 		caps->num_codecs = i;
1417 		caps->direction = wm_adsp_fw[fw].compr_direction;
1418 
1419 		caps->min_fragment_size = WM_ADSP_MIN_FRAGMENT_SIZE;
1420 		caps->max_fragment_size = WM_ADSP_MAX_FRAGMENT_SIZE;
1421 		caps->min_fragments = WM_ADSP_MIN_FRAGMENTS;
1422 		caps->max_fragments = WM_ADSP_MAX_FRAGMENTS;
1423 	}
1424 
1425 	return 0;
1426 }
1427 EXPORT_SYMBOL_GPL(wm_adsp_compr_get_caps);
1428 
1429 static inline int wm_adsp_buffer_read(struct wm_adsp_compr_buf *buf,
1430 				      unsigned int field_offset, u32 *data)
1431 {
1432 	return cs_dsp_read_data_word(&buf->dsp->cs_dsp, buf->host_buf_mem_type,
1433 				     buf->host_buf_ptr + field_offset, data);
1434 }
1435 
1436 static inline int wm_adsp_buffer_write(struct wm_adsp_compr_buf *buf,
1437 				       unsigned int field_offset, u32 data)
1438 {
1439 	return cs_dsp_write_data_word(&buf->dsp->cs_dsp, buf->host_buf_mem_type,
1440 				      buf->host_buf_ptr + field_offset,
1441 				      data);
1442 }
1443 
1444 static int wm_adsp_buffer_populate(struct wm_adsp_compr_buf *buf)
1445 {
1446 	const struct wm_adsp_fw_caps *caps = wm_adsp_fw[buf->dsp->fw].caps;
1447 	struct wm_adsp_buffer_region *region;
1448 	u32 offset = 0;
1449 	int i, ret;
1450 
1451 	buf->regions = kzalloc_objs(*buf->regions, caps->num_regions);
1452 	if (!buf->regions)
1453 		return -ENOMEM;
1454 
1455 	for (i = 0; i < caps->num_regions; ++i) {
1456 		region = &buf->regions[i];
1457 
1458 		region->offset = offset;
1459 		region->mem_type = caps->region_defs[i].mem_type;
1460 
1461 		ret = wm_adsp_buffer_read(buf, caps->region_defs[i].base_offset,
1462 					  &region->base_addr);
1463 		if (ret < 0)
1464 			goto err;
1465 
1466 		ret = wm_adsp_buffer_read(buf, caps->region_defs[i].size_offset,
1467 					  &offset);
1468 		if (ret < 0)
1469 			goto err;
1470 
1471 		region->cumulative_size = offset;
1472 
1473 		compr_dbg(buf,
1474 			  "region=%d type=%d base=%08x off=%08x size=%08x\n",
1475 			  i, region->mem_type, region->base_addr,
1476 			  region->offset, region->cumulative_size);
1477 	}
1478 
1479 	return 0;
1480 
1481 err:
1482 	kfree(buf->regions);
1483 	return ret;
1484 }
1485 
1486 static void wm_adsp_buffer_clear(struct wm_adsp_compr_buf *buf)
1487 {
1488 	buf->irq_count = 0xFFFFFFFF;
1489 	buf->read_index = -1;
1490 	buf->avail = 0;
1491 }
1492 
1493 static struct wm_adsp_compr_buf *wm_adsp_buffer_alloc(struct wm_adsp *dsp)
1494 {
1495 	struct wm_adsp_compr_buf *buf;
1496 
1497 	buf = kzalloc_obj(*buf);
1498 	if (!buf)
1499 		return NULL;
1500 
1501 	buf->dsp = dsp;
1502 
1503 	wm_adsp_buffer_clear(buf);
1504 
1505 	return buf;
1506 }
1507 
1508 static int wm_adsp_buffer_parse_legacy(struct wm_adsp *dsp)
1509 {
1510 	struct cs_dsp_alg_region *alg_region;
1511 	struct wm_adsp_compr_buf *buf;
1512 	u32 xmalg, addr, magic;
1513 	int i, ret;
1514 
1515 	alg_region = cs_dsp_find_alg_region(&dsp->cs_dsp, WMFW_ADSP2_XM, dsp->cs_dsp.fw_id);
1516 	if (!alg_region) {
1517 		adsp_err(dsp, "No algorithm region found\n");
1518 		return -EINVAL;
1519 	}
1520 
1521 	xmalg = dsp->sys_config_size / sizeof(__be32);
1522 
1523 	addr = alg_region->base + xmalg + ALG_XM_FIELD(magic);
1524 	ret = cs_dsp_read_data_word(&dsp->cs_dsp, WMFW_ADSP2_XM, addr, &magic);
1525 	if (ret < 0)
1526 		return ret;
1527 
1528 	if (magic != WM_ADSP_ALG_XM_STRUCT_MAGIC)
1529 		return -ENODEV;
1530 
1531 	buf = wm_adsp_buffer_alloc(dsp);
1532 	if (!buf)
1533 		return -ENOMEM;
1534 
1535 	addr = alg_region->base + xmalg + ALG_XM_FIELD(host_buf_ptr);
1536 	for (i = 0; i < 5; ++i) {
1537 		ret = cs_dsp_read_data_word(&dsp->cs_dsp, WMFW_ADSP2_XM, addr,
1538 					    &buf->host_buf_ptr);
1539 		if (ret < 0)
1540 			goto err;
1541 
1542 		if (buf->host_buf_ptr)
1543 			break;
1544 
1545 		usleep_range(1000, 2000);
1546 	}
1547 
1548 	if (!buf->host_buf_ptr) {
1549 		ret = -EIO;
1550 		goto err;
1551 	}
1552 
1553 	buf->host_buf_mem_type = WMFW_ADSP2_XM;
1554 
1555 	ret = wm_adsp_buffer_populate(buf);
1556 	if (ret < 0)
1557 		goto err;
1558 
1559 	list_add_tail(&buf->list, &dsp->buffer_list);
1560 
1561 	compr_dbg(buf, "legacy host_buf_ptr=%x\n", buf->host_buf_ptr);
1562 
1563 	return 0;
1564 
1565 err:
1566 	kfree(buf);
1567 
1568 	return ret;
1569 }
1570 
1571 static int wm_adsp_buffer_parse_coeff(struct cs_dsp_coeff_ctl *cs_ctl)
1572 {
1573 	struct wm_adsp_host_buf_coeff_v1 coeff_v1;
1574 	struct wm_adsp_compr_buf *buf;
1575 	struct wm_adsp *dsp = container_of(cs_ctl->dsp, struct wm_adsp, cs_dsp);
1576 	unsigned int version = 0;
1577 	int ret, i;
1578 
1579 	for (i = 0; i < 5; ++i) {
1580 		ret = cs_dsp_coeff_read_ctrl(cs_ctl, 0, &coeff_v1,
1581 					     min((size_t)cs_ctl->len, sizeof(coeff_v1)));
1582 		if (ret < 0)
1583 			return ret;
1584 
1585 		if (coeff_v1.host_buf_ptr)
1586 			break;
1587 
1588 		usleep_range(1000, 2000);
1589 	}
1590 
1591 	if (!coeff_v1.host_buf_ptr) {
1592 		adsp_err(dsp, "Failed to acquire host buffer\n");
1593 		return -EIO;
1594 	}
1595 
1596 	buf = wm_adsp_buffer_alloc(dsp);
1597 	if (!buf)
1598 		return -ENOMEM;
1599 
1600 	buf->host_buf_mem_type = cs_ctl->alg_region.type;
1601 	buf->host_buf_ptr = be32_to_cpu(coeff_v1.host_buf_ptr);
1602 
1603 	ret = wm_adsp_buffer_populate(buf);
1604 	if (ret < 0)
1605 		goto err;
1606 
1607 	/*
1608 	 * v0 host_buffer coefficients didn't have versioning, so if the
1609 	 * control is one word, assume version 0.
1610 	 */
1611 	if (cs_ctl->len == 4)
1612 		goto done;
1613 
1614 	version = be32_to_cpu(coeff_v1.versions) & HOST_BUF_COEFF_COMPAT_VER_MASK;
1615 	version >>= HOST_BUF_COEFF_COMPAT_VER_SHIFT;
1616 
1617 	if (version > HOST_BUF_COEFF_SUPPORTED_COMPAT_VER) {
1618 		adsp_err(dsp,
1619 			 "Host buffer coeff ver %u > supported version %u\n",
1620 			 version, HOST_BUF_COEFF_SUPPORTED_COMPAT_VER);
1621 		ret = -EINVAL;
1622 		goto err;
1623 	}
1624 
1625 	cs_dsp_remove_padding((u32 *)&coeff_v1.name, ARRAY_SIZE(coeff_v1.name));
1626 
1627 	buf->name = kasprintf(GFP_KERNEL, "%s-dsp-%s", dsp->part,
1628 			      (char *)&coeff_v1.name);
1629 
1630 done:
1631 	list_add_tail(&buf->list, &dsp->buffer_list);
1632 
1633 	compr_dbg(buf, "host_buf_ptr=%x coeff version %u\n",
1634 		  buf->host_buf_ptr, version);
1635 
1636 	return version;
1637 
1638 err:
1639 	kfree(buf);
1640 
1641 	return ret;
1642 }
1643 
1644 static int wm_adsp_buffer_init(struct wm_adsp *dsp)
1645 {
1646 	struct cs_dsp_coeff_ctl *cs_ctl;
1647 	int ret;
1648 
1649 	list_for_each_entry(cs_ctl, &dsp->cs_dsp.ctl_list, list) {
1650 		if (cs_ctl->type != WMFW_CTL_TYPE_HOST_BUFFER)
1651 			continue;
1652 
1653 		if (!cs_ctl->enabled)
1654 			continue;
1655 
1656 		ret = wm_adsp_buffer_parse_coeff(cs_ctl);
1657 		if (ret < 0) {
1658 			adsp_err(dsp, "Failed to parse coeff: %d\n", ret);
1659 			goto error;
1660 		} else if (ret == 0) {
1661 			/* Only one buffer supported for version 0 */
1662 			return 0;
1663 		}
1664 	}
1665 
1666 	if (list_empty(&dsp->buffer_list)) {
1667 		/* Fall back to legacy support */
1668 		ret = wm_adsp_buffer_parse_legacy(dsp);
1669 		if (ret == -ENODEV)
1670 			adsp_info(dsp, "Legacy support not available\n");
1671 		else if (ret)
1672 			adsp_warn(dsp, "Failed to parse legacy: %d\n", ret);
1673 	}
1674 
1675 	return 0;
1676 
1677 error:
1678 	wm_adsp_buffer_free(dsp);
1679 	return ret;
1680 }
1681 
1682 static int wm_adsp_buffer_free(struct wm_adsp *dsp)
1683 {
1684 	struct wm_adsp_compr_buf *buf, *tmp;
1685 
1686 	list_for_each_entry_safe(buf, tmp, &dsp->buffer_list, list) {
1687 		wm_adsp_compr_detach(buf->compr);
1688 
1689 		kfree(buf->name);
1690 		kfree(buf->regions);
1691 		list_del(&buf->list);
1692 		kfree(buf);
1693 	}
1694 
1695 	return 0;
1696 }
1697 
1698 static int wm_adsp_buffer_get_error(struct wm_adsp_compr_buf *buf)
1699 {
1700 	int ret;
1701 
1702 	ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(error), &buf->error);
1703 	if (ret < 0) {
1704 		compr_err(buf, "Failed to check buffer error: %d\n", ret);
1705 		return ret;
1706 	}
1707 	if (buf->error != 0) {
1708 		compr_err(buf, "Buffer error occurred: %d\n", buf->error);
1709 		return -EIO;
1710 	}
1711 
1712 	return 0;
1713 }
1714 
1715 int wm_adsp_compr_trigger(struct snd_soc_component *component,
1716 			  struct snd_compr_stream *stream, int cmd)
1717 {
1718 	struct wm_adsp_compr *compr = stream->runtime->private_data;
1719 	struct wm_adsp *dsp = compr->dsp;
1720 	int ret = 0;
1721 
1722 	compr_dbg(compr, "Trigger: %d\n", cmd);
1723 
1724 	guard(mutex)(&dsp->cs_dsp.pwr_lock);
1725 
1726 	switch (cmd) {
1727 	case SNDRV_PCM_TRIGGER_START:
1728 		if (!wm_adsp_compr_attached(compr)) {
1729 			ret = wm_adsp_compr_attach(compr);
1730 			if (ret < 0) {
1731 				compr_err(compr, "Failed to link buffer and stream: %d\n",
1732 					  ret);
1733 				break;
1734 			}
1735 		}
1736 
1737 		ret = wm_adsp_buffer_get_error(compr->buf);
1738 		if (ret < 0)
1739 			break;
1740 
1741 		/* Trigger the IRQ at one fragment of data */
1742 		ret = wm_adsp_buffer_write(compr->buf,
1743 					   HOST_BUFFER_FIELD(high_water_mark),
1744 					   wm_adsp_compr_frag_words(compr));
1745 		if (ret < 0) {
1746 			compr_err(compr, "Failed to set high water mark: %d\n",
1747 				  ret);
1748 			break;
1749 		}
1750 		break;
1751 	case SNDRV_PCM_TRIGGER_STOP:
1752 		if (wm_adsp_compr_attached(compr))
1753 			wm_adsp_buffer_clear(compr->buf);
1754 		break;
1755 	default:
1756 		ret = -EINVAL;
1757 		break;
1758 	}
1759 
1760 	return ret;
1761 }
1762 EXPORT_SYMBOL_GPL(wm_adsp_compr_trigger);
1763 
1764 static inline int wm_adsp_buffer_size(struct wm_adsp_compr_buf *buf)
1765 {
1766 	int last_region = wm_adsp_fw[buf->dsp->fw].caps->num_regions - 1;
1767 
1768 	return buf->regions[last_region].cumulative_size;
1769 }
1770 
1771 static int wm_adsp_buffer_update_avail(struct wm_adsp_compr_buf *buf)
1772 {
1773 	u32 next_read_index, next_write_index;
1774 	int write_index, read_index, avail;
1775 	int ret;
1776 
1777 	/* Only sync read index if we haven't already read a valid index */
1778 	if (buf->read_index < 0) {
1779 		ret = wm_adsp_buffer_read(buf,
1780 				HOST_BUFFER_FIELD(next_read_index),
1781 				&next_read_index);
1782 		if (ret < 0)
1783 			return ret;
1784 
1785 		read_index = sign_extend32(next_read_index, 23);
1786 
1787 		if (read_index < 0) {
1788 			compr_dbg(buf, "Avail check on unstarted stream\n");
1789 			return 0;
1790 		}
1791 
1792 		buf->read_index = read_index;
1793 	}
1794 
1795 	ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(next_write_index),
1796 			&next_write_index);
1797 	if (ret < 0)
1798 		return ret;
1799 
1800 	write_index = sign_extend32(next_write_index, 23);
1801 
1802 	avail = write_index - buf->read_index;
1803 	if (avail < 0)
1804 		avail += wm_adsp_buffer_size(buf);
1805 
1806 	compr_dbg(buf, "readindex=0x%x, writeindex=0x%x, avail=%d\n",
1807 		  buf->read_index, write_index, avail * CS_DSP_DATA_WORD_SIZE);
1808 
1809 	buf->avail = avail;
1810 
1811 	return 0;
1812 }
1813 
1814 int wm_adsp_compr_handle_irq(struct wm_adsp *dsp)
1815 {
1816 	struct wm_adsp_compr_buf *buf;
1817 	struct wm_adsp_compr *compr;
1818 	int ret = 0;
1819 
1820 	mutex_lock(&dsp->cs_dsp.pwr_lock);
1821 
1822 	if (list_empty(&dsp->buffer_list)) {
1823 		ret = -ENODEV;
1824 		goto out;
1825 	}
1826 
1827 	adsp_dbg(dsp, "Handling buffer IRQ\n");
1828 
1829 	list_for_each_entry(buf, &dsp->buffer_list, list) {
1830 		compr = buf->compr;
1831 
1832 		ret = wm_adsp_buffer_get_error(buf);
1833 		if (ret < 0)
1834 			goto out_notify; /* Wake poll to report error */
1835 
1836 		ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(irq_count),
1837 					  &buf->irq_count);
1838 		if (ret < 0) {
1839 			compr_err(buf, "Failed to get irq_count: %d\n", ret);
1840 			goto out;
1841 		}
1842 
1843 		ret = wm_adsp_buffer_update_avail(buf);
1844 		if (ret < 0) {
1845 			compr_err(buf, "Error reading avail: %d\n", ret);
1846 			goto out;
1847 		}
1848 
1849 		if (wm_adsp_fw[dsp->fw].voice_trigger && buf->irq_count == 2)
1850 			ret = WM_ADSP_COMPR_VOICE_TRIGGER;
1851 
1852 out_notify:
1853 		if (compr && compr->stream)
1854 			snd_compr_fragment_elapsed(compr->stream);
1855 	}
1856 
1857 out:
1858 	mutex_unlock(&dsp->cs_dsp.pwr_lock);
1859 
1860 	return ret;
1861 }
1862 EXPORT_SYMBOL_GPL(wm_adsp_compr_handle_irq);
1863 
1864 static int wm_adsp_buffer_reenable_irq(struct wm_adsp_compr_buf *buf)
1865 {
1866 	if (buf->irq_count & 0x01)
1867 		return 0;
1868 
1869 	compr_dbg(buf, "Enable IRQ(0x%x) for next fragment\n", buf->irq_count);
1870 
1871 	buf->irq_count |= 0x01;
1872 
1873 	return wm_adsp_buffer_write(buf, HOST_BUFFER_FIELD(irq_ack),
1874 				    buf->irq_count);
1875 }
1876 
1877 int wm_adsp_compr_pointer(struct snd_soc_component *component,
1878 			  struct snd_compr_stream *stream,
1879 			  struct snd_compr_tstamp64 *tstamp)
1880 {
1881 	struct wm_adsp_compr *compr = stream->runtime->private_data;
1882 	struct wm_adsp *dsp = compr->dsp;
1883 	struct wm_adsp_compr_buf *buf;
1884 	int ret = 0;
1885 
1886 	compr_dbg(compr, "Pointer request\n");
1887 
1888 	guard(mutex)(&dsp->cs_dsp.pwr_lock);
1889 
1890 	buf = compr->buf;
1891 
1892 	if (dsp->fatal_error || !buf || buf->error) {
1893 		snd_compr_stop_error(stream, SNDRV_PCM_STATE_XRUN);
1894 		return -EIO;
1895 	}
1896 
1897 	if (buf->avail < wm_adsp_compr_frag_words(compr)) {
1898 		ret = wm_adsp_buffer_update_avail(buf);
1899 		if (ret < 0) {
1900 			compr_err(compr, "Error reading avail: %d\n", ret);
1901 			return ret;
1902 		}
1903 
1904 		/*
1905 		 * If we really have less than 1 fragment available tell the
1906 		 * DSP to inform us once a whole fragment is available.
1907 		 */
1908 		if (buf->avail < wm_adsp_compr_frag_words(compr)) {
1909 			ret = wm_adsp_buffer_get_error(buf);
1910 			if (ret < 0) {
1911 				if (buf->error)
1912 					snd_compr_stop_error(stream,
1913 							SNDRV_PCM_STATE_XRUN);
1914 				return ret;
1915 			}
1916 
1917 			ret = wm_adsp_buffer_reenable_irq(buf);
1918 			if (ret < 0) {
1919 				compr_err(compr, "Failed to re-enable buffer IRQ: %d\n",
1920 					  ret);
1921 				return ret;
1922 			}
1923 		}
1924 	}
1925 
1926 	tstamp->copied_total = compr->copied_total;
1927 	tstamp->copied_total += buf->avail * CS_DSP_DATA_WORD_SIZE;
1928 	tstamp->sampling_rate = compr->sample_rate;
1929 
1930 	return ret;
1931 }
1932 EXPORT_SYMBOL_GPL(wm_adsp_compr_pointer);
1933 
1934 static int wm_adsp_buffer_capture_block(struct wm_adsp_compr *compr, int target)
1935 {
1936 	struct wm_adsp_compr_buf *buf = compr->buf;
1937 	unsigned int adsp_addr;
1938 	int mem_type, nwords, max_read;
1939 	int i, ret;
1940 
1941 	/* Calculate read parameters */
1942 	for (i = 0; i < wm_adsp_fw[buf->dsp->fw].caps->num_regions; ++i)
1943 		if (buf->read_index < buf->regions[i].cumulative_size)
1944 			break;
1945 
1946 	if (i == wm_adsp_fw[buf->dsp->fw].caps->num_regions)
1947 		return -EINVAL;
1948 
1949 	mem_type = buf->regions[i].mem_type;
1950 	adsp_addr = buf->regions[i].base_addr +
1951 		    (buf->read_index - buf->regions[i].offset);
1952 
1953 	max_read = wm_adsp_compr_frag_words(compr);
1954 	nwords = buf->regions[i].cumulative_size - buf->read_index;
1955 
1956 	if (nwords > target)
1957 		nwords = target;
1958 	if (nwords > buf->avail)
1959 		nwords = buf->avail;
1960 	if (nwords > max_read)
1961 		nwords = max_read;
1962 	if (!nwords)
1963 		return 0;
1964 
1965 	/* Read data from DSP */
1966 	ret = cs_dsp_read_raw_data_block(&buf->dsp->cs_dsp, mem_type, adsp_addr,
1967 					 nwords, (__be32 *)compr->raw_buf);
1968 	if (ret < 0)
1969 		return ret;
1970 
1971 	cs_dsp_remove_padding(compr->raw_buf, nwords);
1972 
1973 	/* update read index to account for words read */
1974 	buf->read_index += nwords;
1975 	if (buf->read_index == wm_adsp_buffer_size(buf))
1976 		buf->read_index = 0;
1977 
1978 	ret = wm_adsp_buffer_write(buf, HOST_BUFFER_FIELD(next_read_index),
1979 				   buf->read_index);
1980 	if (ret < 0)
1981 		return ret;
1982 
1983 	/* update avail to account for words read */
1984 	buf->avail -= nwords;
1985 
1986 	return nwords;
1987 }
1988 
1989 static int wm_adsp_compr_read(struct wm_adsp_compr *compr,
1990 			      char __user *buf, size_t count)
1991 {
1992 	struct wm_adsp *dsp = compr->dsp;
1993 	int ntotal = 0;
1994 	int nwords, nbytes;
1995 
1996 	compr_dbg(compr, "Requested read of %zu bytes\n", count);
1997 
1998 	if (dsp->fatal_error || !compr->buf || compr->buf->error) {
1999 		snd_compr_stop_error(compr->stream, SNDRV_PCM_STATE_XRUN);
2000 		return -EIO;
2001 	}
2002 
2003 	count /= CS_DSP_DATA_WORD_SIZE;
2004 
2005 	do {
2006 		nwords = wm_adsp_buffer_capture_block(compr, count);
2007 		if (nwords < 0) {
2008 			compr_err(compr, "Failed to capture block: %d\n",
2009 				  nwords);
2010 			return nwords;
2011 		}
2012 
2013 		nbytes = nwords * CS_DSP_DATA_WORD_SIZE;
2014 
2015 		compr_dbg(compr, "Read %d bytes\n", nbytes);
2016 
2017 		if (copy_to_user(buf + ntotal, compr->raw_buf, nbytes)) {
2018 			compr_err(compr, "Failed to copy data to user: %d, %d\n",
2019 				  ntotal, nbytes);
2020 			return -EFAULT;
2021 		}
2022 
2023 		count -= nwords;
2024 		ntotal += nbytes;
2025 	} while (nwords > 0 && count > 0);
2026 
2027 	compr->copied_total += ntotal;
2028 
2029 	return ntotal;
2030 }
2031 
2032 int wm_adsp_compr_copy(struct snd_soc_component *component,
2033 		       struct snd_compr_stream *stream, char __user *buf,
2034 		       size_t count)
2035 {
2036 	struct wm_adsp_compr *compr = stream->runtime->private_data;
2037 	struct wm_adsp *dsp = compr->dsp;
2038 	int ret;
2039 
2040 	guard(mutex)(&dsp->cs_dsp.pwr_lock);
2041 
2042 	if (stream->direction == SND_COMPRESS_CAPTURE)
2043 		ret = wm_adsp_compr_read(compr, buf, count);
2044 	else
2045 		ret = -ENOTSUPP;
2046 
2047 	return ret;
2048 }
2049 EXPORT_SYMBOL_GPL(wm_adsp_compr_copy);
2050 
2051 static void wm_adsp_fatal_error(struct cs_dsp *cs_dsp)
2052 {
2053 	struct wm_adsp *dsp = container_of(cs_dsp, struct wm_adsp, cs_dsp);
2054 	struct wm_adsp_compr *compr;
2055 
2056 	dsp->fatal_error = true;
2057 
2058 	list_for_each_entry(compr, &dsp->compr_list, list) {
2059 		if (compr->stream)
2060 			snd_compr_fragment_elapsed(compr->stream);
2061 	}
2062 }
2063 
2064 irqreturn_t wm_adsp2_bus_error(int irq, void *data)
2065 {
2066 	struct wm_adsp *dsp = (struct wm_adsp *)data;
2067 
2068 	cs_dsp_adsp2_bus_error(&dsp->cs_dsp);
2069 
2070 	return IRQ_HANDLED;
2071 }
2072 EXPORT_SYMBOL_GPL(wm_adsp2_bus_error);
2073 
2074 irqreturn_t wm_halo_bus_error(int irq, void *data)
2075 {
2076 	struct wm_adsp *dsp = (struct wm_adsp *)data;
2077 
2078 	cs_dsp_halo_bus_error(&dsp->cs_dsp);
2079 
2080 	return IRQ_HANDLED;
2081 }
2082 EXPORT_SYMBOL_GPL(wm_halo_bus_error);
2083 
2084 irqreturn_t wm_halo_wdt_expire(int irq, void *data)
2085 {
2086 	struct wm_adsp *dsp = data;
2087 
2088 	cs_dsp_halo_wdt_expire(&dsp->cs_dsp);
2089 
2090 	return IRQ_HANDLED;
2091 }
2092 EXPORT_SYMBOL_GPL(wm_halo_wdt_expire);
2093 
2094 static const struct cs_dsp_client_ops wm_adsp1_client_ops = {
2095 	.control_add = wm_adsp_control_add_cb,
2096 	.control_remove = wm_adsp_control_remove,
2097 };
2098 
2099 static const struct cs_dsp_client_ops wm_adsp2_client_ops = {
2100 	.control_add = wm_adsp_control_add_cb,
2101 	.control_remove = wm_adsp_control_remove,
2102 	.pre_run = wm_adsp_pre_run,
2103 	.post_run = wm_adsp_event_post_run,
2104 	.post_stop = wm_adsp_event_post_stop,
2105 	.watchdog_expired = wm_adsp_fatal_error,
2106 };
2107 
2108 MODULE_DESCRIPTION("Cirrus Logic ASoC DSP Support");
2109 MODULE_LICENSE("GPL v2");
2110 MODULE_IMPORT_NS("FW_CS_DSP");
2111