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