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