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