xref: /openbmc/linux/sound/soc/codecs/wm_adsp.c (revision cd99b9eb)
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 	ret = cs_dsp_coeff_write_ctrl(cs_ctl, 0, buf, len);
691 	if (ret < 0)
692 		return ret;
693 
694 	if (ret == 0 || (cs_ctl->flags & WMFW_CTL_FLAG_SYS))
695 		return 0;
696 
697 	ctl = cs_ctl->priv;
698 
699 	return snd_soc_component_notify_control(dsp->component, ctl->name);
700 }
701 EXPORT_SYMBOL_GPL(wm_adsp_write_ctl);
702 
703 int wm_adsp_read_ctl(struct wm_adsp *dsp, const char *name, int type,
704 		     unsigned int alg, void *buf, size_t len)
705 {
706 	return cs_dsp_coeff_read_ctrl(cs_dsp_get_ctl(&dsp->cs_dsp, name, type, alg),
707 				      0, buf, len);
708 }
709 EXPORT_SYMBOL_GPL(wm_adsp_read_ctl);
710 
711 static void wm_adsp_release_firmware_files(struct wm_adsp *dsp,
712 					   const struct firmware *wmfw_firmware,
713 					   char *wmfw_filename,
714 					   const struct firmware *coeff_firmware,
715 					   char *coeff_filename)
716 {
717 	if (wmfw_firmware)
718 		release_firmware(wmfw_firmware);
719 	kfree(wmfw_filename);
720 
721 	if (coeff_firmware)
722 		release_firmware(coeff_firmware);
723 	kfree(coeff_filename);
724 }
725 
726 static int wm_adsp_request_firmware_file(struct wm_adsp *dsp,
727 					 const struct firmware **firmware, char **filename,
728 					 const char *dir, const char *system_name,
729 					 const char *asoc_component_prefix,
730 					 const char *filetype)
731 {
732 	struct cs_dsp *cs_dsp = &dsp->cs_dsp;
733 	char *s, c;
734 	int ret = 0;
735 
736 	if (system_name && asoc_component_prefix)
737 		*filename = kasprintf(GFP_KERNEL, "%s%s-%s-%s-%s-%s.%s", dir, dsp->part,
738 				      dsp->fwf_name, wm_adsp_fw[dsp->fw].file, system_name,
739 				      asoc_component_prefix, filetype);
740 	else if (system_name)
741 		*filename = kasprintf(GFP_KERNEL, "%s%s-%s-%s-%s.%s", dir, dsp->part,
742 				      dsp->fwf_name, wm_adsp_fw[dsp->fw].file, system_name,
743 				      filetype);
744 	else
745 		*filename = kasprintf(GFP_KERNEL, "%s%s-%s-%s.%s", dir, dsp->part, dsp->fwf_name,
746 				      wm_adsp_fw[dsp->fw].file, filetype);
747 
748 	if (*filename == NULL)
749 		return -ENOMEM;
750 
751 	/*
752 	 * Make sure that filename is lower-case and any non alpha-numeric
753 	 * characters except full stop and forward slash are replaced with
754 	 * hyphens.
755 	 */
756 	s = *filename;
757 	while (*s) {
758 		c = *s;
759 		if (isalnum(c))
760 			*s = tolower(c);
761 		else if ((c != '.') && (c != '/'))
762 			*s = '-';
763 		s++;
764 	}
765 
766 	ret = firmware_request_nowarn(firmware, *filename, cs_dsp->dev);
767 	if (ret != 0) {
768 		adsp_dbg(dsp, "Failed to request '%s'\n", *filename);
769 		kfree(*filename);
770 		*filename = NULL;
771 	} else {
772 		adsp_dbg(dsp, "Found '%s'\n", *filename);
773 	}
774 
775 	return ret;
776 }
777 
778 static const char *cirrus_dir = "cirrus/";
779 static int wm_adsp_request_firmware_files(struct wm_adsp *dsp,
780 					  const struct firmware **wmfw_firmware,
781 					  char **wmfw_filename,
782 					  const struct firmware **coeff_firmware,
783 					  char **coeff_filename)
784 {
785 	const char *system_name = dsp->system_name;
786 	const char *asoc_component_prefix = dsp->component->name_prefix;
787 	int ret = 0;
788 
789 	if (system_name && asoc_component_prefix) {
790 		if (!wm_adsp_request_firmware_file(dsp, wmfw_firmware, wmfw_filename,
791 						   cirrus_dir, system_name,
792 						   asoc_component_prefix, "wmfw")) {
793 			wm_adsp_request_firmware_file(dsp, coeff_firmware, coeff_filename,
794 						      cirrus_dir, system_name,
795 						      asoc_component_prefix, "bin");
796 			return 0;
797 		}
798 	}
799 
800 	if (system_name) {
801 		if (!wm_adsp_request_firmware_file(dsp, wmfw_firmware, wmfw_filename,
802 						   cirrus_dir, system_name,
803 						   NULL, "wmfw")) {
804 			if (asoc_component_prefix)
805 				wm_adsp_request_firmware_file(dsp, coeff_firmware, coeff_filename,
806 							      cirrus_dir, system_name,
807 							      asoc_component_prefix, "bin");
808 
809 			if (!*coeff_firmware)
810 				wm_adsp_request_firmware_file(dsp, coeff_firmware, coeff_filename,
811 							      cirrus_dir, system_name,
812 							      NULL, "bin");
813 			return 0;
814 		}
815 	}
816 
817 	if (!wm_adsp_request_firmware_file(dsp, wmfw_firmware, wmfw_filename,
818 					   "", NULL, NULL, "wmfw")) {
819 		wm_adsp_request_firmware_file(dsp, coeff_firmware, coeff_filename,
820 					      "", NULL, NULL, "bin");
821 		return 0;
822 	}
823 
824 	ret = wm_adsp_request_firmware_file(dsp, wmfw_firmware, wmfw_filename,
825 					    cirrus_dir, NULL, NULL, "wmfw");
826 	if (!ret) {
827 		wm_adsp_request_firmware_file(dsp, coeff_firmware, coeff_filename,
828 					      cirrus_dir, NULL, NULL, "bin");
829 		return 0;
830 	}
831 
832 	if (dsp->wmfw_optional) {
833 		if (system_name) {
834 			if (asoc_component_prefix)
835 				wm_adsp_request_firmware_file(dsp, coeff_firmware, coeff_filename,
836 							      cirrus_dir, system_name,
837 							      asoc_component_prefix, "bin");
838 
839 			if (!*coeff_firmware)
840 				wm_adsp_request_firmware_file(dsp, coeff_firmware, coeff_filename,
841 							      cirrus_dir, system_name,
842 							      NULL, "bin");
843 		}
844 
845 		if (!*coeff_firmware)
846 			wm_adsp_request_firmware_file(dsp, coeff_firmware, coeff_filename,
847 						      "", NULL, NULL, "bin");
848 
849 		if (!*coeff_firmware)
850 			wm_adsp_request_firmware_file(dsp, coeff_firmware, coeff_filename,
851 						      cirrus_dir, NULL, NULL, "bin");
852 
853 		return 0;
854 	}
855 
856 	adsp_err(dsp, "Failed to request firmware <%s>%s-%s-%s<-%s<%s>>.wmfw\n",
857 		 cirrus_dir, dsp->part, dsp->fwf_name, wm_adsp_fw[dsp->fw].file,
858 		 system_name, asoc_component_prefix);
859 
860 	return -ENOENT;
861 }
862 
863 static int wm_adsp_common_init(struct wm_adsp *dsp)
864 {
865 	char *p;
866 
867 	INIT_LIST_HEAD(&dsp->compr_list);
868 	INIT_LIST_HEAD(&dsp->buffer_list);
869 
870 	if (!dsp->fwf_name) {
871 		p = devm_kstrdup(dsp->cs_dsp.dev, dsp->cs_dsp.name, GFP_KERNEL);
872 		if (!p)
873 			return -ENOMEM;
874 
875 		dsp->fwf_name = p;
876 		for (; *p != 0; ++p)
877 			*p = tolower(*p);
878 	}
879 
880 	return 0;
881 }
882 
883 int wm_adsp1_init(struct wm_adsp *dsp)
884 {
885 	int ret;
886 
887 	dsp->cs_dsp.client_ops = &wm_adsp1_client_ops;
888 
889 	ret = cs_dsp_adsp1_init(&dsp->cs_dsp);
890 	if (ret)
891 		return ret;
892 
893 	return wm_adsp_common_init(dsp);
894 }
895 EXPORT_SYMBOL_GPL(wm_adsp1_init);
896 
897 int wm_adsp1_event(struct snd_soc_dapm_widget *w,
898 		   struct snd_kcontrol *kcontrol,
899 		   int event)
900 {
901 	struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
902 	struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
903 	struct wm_adsp *dsp = &dsps[w->shift];
904 	int ret = 0;
905 	char *wmfw_filename = NULL;
906 	const struct firmware *wmfw_firmware = NULL;
907 	char *coeff_filename = NULL;
908 	const struct firmware *coeff_firmware = NULL;
909 
910 	dsp->component = component;
911 
912 	switch (event) {
913 	case SND_SOC_DAPM_POST_PMU:
914 		ret = wm_adsp_request_firmware_files(dsp,
915 						     &wmfw_firmware, &wmfw_filename,
916 						     &coeff_firmware, &coeff_filename);
917 		if (ret)
918 			break;
919 
920 		ret = cs_dsp_adsp1_power_up(&dsp->cs_dsp,
921 					    wmfw_firmware, wmfw_filename,
922 					    coeff_firmware, coeff_filename,
923 					    wm_adsp_fw_text[dsp->fw]);
924 
925 		wm_adsp_release_firmware_files(dsp,
926 					       wmfw_firmware, wmfw_filename,
927 					       coeff_firmware, coeff_filename);
928 		break;
929 	case SND_SOC_DAPM_PRE_PMD:
930 		cs_dsp_adsp1_power_down(&dsp->cs_dsp);
931 		break;
932 	default:
933 		break;
934 	}
935 
936 	return ret;
937 }
938 EXPORT_SYMBOL_GPL(wm_adsp1_event);
939 
940 int wm_adsp2_set_dspclk(struct snd_soc_dapm_widget *w, unsigned int freq)
941 {
942 	struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
943 	struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
944 	struct wm_adsp *dsp = &dsps[w->shift];
945 
946 	return cs_dsp_set_dspclk(&dsp->cs_dsp, freq);
947 }
948 EXPORT_SYMBOL_GPL(wm_adsp2_set_dspclk);
949 
950 int wm_adsp2_preloader_get(struct snd_kcontrol *kcontrol,
951 			   struct snd_ctl_elem_value *ucontrol)
952 {
953 	struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
954 	struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
955 	struct soc_mixer_control *mc =
956 		(struct soc_mixer_control *)kcontrol->private_value;
957 	struct wm_adsp *dsp = &dsps[mc->shift - 1];
958 
959 	ucontrol->value.integer.value[0] = dsp->preloaded;
960 
961 	return 0;
962 }
963 EXPORT_SYMBOL_GPL(wm_adsp2_preloader_get);
964 
965 int wm_adsp2_preloader_put(struct snd_kcontrol *kcontrol,
966 			   struct snd_ctl_elem_value *ucontrol)
967 {
968 	struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
969 	struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
970 	struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(component);
971 	struct soc_mixer_control *mc =
972 		(struct soc_mixer_control *)kcontrol->private_value;
973 	struct wm_adsp *dsp = &dsps[mc->shift - 1];
974 	char preload[32];
975 
976 	if (dsp->preloaded == ucontrol->value.integer.value[0])
977 		return 0;
978 
979 	snprintf(preload, ARRAY_SIZE(preload), "%s Preload", dsp->cs_dsp.name);
980 
981 	if (ucontrol->value.integer.value[0] || dsp->toggle_preload)
982 		snd_soc_component_force_enable_pin(component, preload);
983 	else
984 		snd_soc_component_disable_pin(component, preload);
985 
986 	snd_soc_dapm_sync(dapm);
987 
988 	flush_work(&dsp->boot_work);
989 
990 	dsp->preloaded = ucontrol->value.integer.value[0];
991 
992 	if (dsp->toggle_preload) {
993 		snd_soc_component_disable_pin(component, preload);
994 		snd_soc_dapm_sync(dapm);
995 	}
996 
997 	return 1;
998 }
999 EXPORT_SYMBOL_GPL(wm_adsp2_preloader_put);
1000 
1001 int wm_adsp_power_up(struct wm_adsp *dsp, bool load_firmware)
1002 {
1003 	int ret = 0;
1004 	char *wmfw_filename = NULL;
1005 	const struct firmware *wmfw_firmware = NULL;
1006 	char *coeff_filename = NULL;
1007 	const struct firmware *coeff_firmware = NULL;
1008 
1009 	if (load_firmware) {
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 
1017 	ret = cs_dsp_power_up(&dsp->cs_dsp,
1018 			      wmfw_firmware, wmfw_filename,
1019 			      coeff_firmware, coeff_filename,
1020 			      wm_adsp_fw_text[dsp->fw]);
1021 
1022 	wm_adsp_release_firmware_files(dsp,
1023 				       wmfw_firmware, wmfw_filename,
1024 				       coeff_firmware, coeff_filename);
1025 
1026 	return ret;
1027 }
1028 EXPORT_SYMBOL_GPL(wm_adsp_power_up);
1029 
1030 void wm_adsp_power_down(struct wm_adsp *dsp)
1031 {
1032 	cs_dsp_power_down(&dsp->cs_dsp);
1033 }
1034 EXPORT_SYMBOL_GPL(wm_adsp_power_down);
1035 
1036 static void wm_adsp_boot_work(struct work_struct *work)
1037 {
1038 	struct wm_adsp *dsp = container_of(work,
1039 					   struct wm_adsp,
1040 					   boot_work);
1041 
1042 	wm_adsp_power_up(dsp, true);
1043 }
1044 
1045 int wm_adsp_early_event(struct snd_soc_dapm_widget *w,
1046 			struct snd_kcontrol *kcontrol, int event)
1047 {
1048 	struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
1049 	struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
1050 	struct wm_adsp *dsp = &dsps[w->shift];
1051 
1052 	switch (event) {
1053 	case SND_SOC_DAPM_PRE_PMU:
1054 		queue_work(system_unbound_wq, &dsp->boot_work);
1055 		break;
1056 	case SND_SOC_DAPM_PRE_PMD:
1057 		wm_adsp_power_down(dsp);
1058 		break;
1059 	default:
1060 		break;
1061 	}
1062 
1063 	return 0;
1064 }
1065 EXPORT_SYMBOL_GPL(wm_adsp_early_event);
1066 
1067 static int wm_adsp_pre_run(struct cs_dsp *cs_dsp)
1068 {
1069 	struct wm_adsp *dsp = container_of(cs_dsp, struct wm_adsp, cs_dsp);
1070 
1071 	if (!dsp->pre_run)
1072 		return 0;
1073 
1074 	return (*dsp->pre_run)(dsp);
1075 }
1076 
1077 static int wm_adsp_event_post_run(struct cs_dsp *cs_dsp)
1078 {
1079 	struct wm_adsp *dsp = container_of(cs_dsp, struct wm_adsp, cs_dsp);
1080 
1081 	if (wm_adsp_fw[dsp->fw].num_caps != 0)
1082 		return wm_adsp_buffer_init(dsp);
1083 
1084 	return 0;
1085 }
1086 
1087 static void wm_adsp_event_post_stop(struct cs_dsp *cs_dsp)
1088 {
1089 	struct wm_adsp *dsp = container_of(cs_dsp, struct wm_adsp, cs_dsp);
1090 
1091 	if (wm_adsp_fw[dsp->fw].num_caps != 0)
1092 		wm_adsp_buffer_free(dsp);
1093 
1094 	dsp->fatal_error = false;
1095 }
1096 
1097 int wm_adsp_event(struct snd_soc_dapm_widget *w,
1098 		  struct snd_kcontrol *kcontrol, int event)
1099 {
1100 	struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
1101 	struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
1102 	struct wm_adsp *dsp = &dsps[w->shift];
1103 	int ret = 0;
1104 
1105 	switch (event) {
1106 	case SND_SOC_DAPM_POST_PMU:
1107 		flush_work(&dsp->boot_work);
1108 		ret = cs_dsp_run(&dsp->cs_dsp);
1109 		break;
1110 	case SND_SOC_DAPM_PRE_PMD:
1111 		cs_dsp_stop(&dsp->cs_dsp);
1112 		break;
1113 	default:
1114 		break;
1115 	}
1116 
1117 	return ret;
1118 }
1119 EXPORT_SYMBOL_GPL(wm_adsp_event);
1120 
1121 int wm_adsp2_component_probe(struct wm_adsp *dsp, struct snd_soc_component *component)
1122 {
1123 	char preload[32];
1124 
1125 	if (!dsp->cs_dsp.no_core_startstop) {
1126 		snprintf(preload, ARRAY_SIZE(preload), "%s Preload", dsp->cs_dsp.name);
1127 		snd_soc_component_disable_pin(component, preload);
1128 	}
1129 
1130 	cs_dsp_init_debugfs(&dsp->cs_dsp, component->debugfs_root);
1131 
1132 	dsp->component = component;
1133 
1134 	return 0;
1135 }
1136 EXPORT_SYMBOL_GPL(wm_adsp2_component_probe);
1137 
1138 int wm_adsp2_component_remove(struct wm_adsp *dsp, struct snd_soc_component *component)
1139 {
1140 	cs_dsp_cleanup_debugfs(&dsp->cs_dsp);
1141 
1142 	return 0;
1143 }
1144 EXPORT_SYMBOL_GPL(wm_adsp2_component_remove);
1145 
1146 int wm_adsp2_init(struct wm_adsp *dsp)
1147 {
1148 	int ret;
1149 
1150 	INIT_WORK(&dsp->boot_work, wm_adsp_boot_work);
1151 
1152 	dsp->sys_config_size = sizeof(struct wm_adsp_system_config_xm_hdr);
1153 	dsp->cs_dsp.client_ops = &wm_adsp2_client_ops;
1154 
1155 	ret = cs_dsp_adsp2_init(&dsp->cs_dsp);
1156 	if (ret)
1157 		return ret;
1158 
1159 	return wm_adsp_common_init(dsp);
1160 }
1161 EXPORT_SYMBOL_GPL(wm_adsp2_init);
1162 
1163 int wm_halo_init(struct wm_adsp *dsp)
1164 {
1165 	int ret;
1166 
1167 	INIT_WORK(&dsp->boot_work, wm_adsp_boot_work);
1168 
1169 	dsp->sys_config_size = sizeof(struct wm_halo_system_config_xm_hdr);
1170 	dsp->cs_dsp.client_ops = &wm_adsp2_client_ops;
1171 
1172 	ret = cs_dsp_halo_init(&dsp->cs_dsp);
1173 	if (ret)
1174 		return ret;
1175 
1176 	return wm_adsp_common_init(dsp);
1177 }
1178 EXPORT_SYMBOL_GPL(wm_halo_init);
1179 
1180 void wm_adsp2_remove(struct wm_adsp *dsp)
1181 {
1182 	cs_dsp_remove(&dsp->cs_dsp);
1183 }
1184 EXPORT_SYMBOL_GPL(wm_adsp2_remove);
1185 
1186 static inline int wm_adsp_compr_attached(struct wm_adsp_compr *compr)
1187 {
1188 	return compr->buf != NULL;
1189 }
1190 
1191 static int wm_adsp_compr_attach(struct wm_adsp_compr *compr)
1192 {
1193 	struct wm_adsp_compr_buf *buf = NULL, *tmp;
1194 
1195 	if (compr->dsp->fatal_error)
1196 		return -EINVAL;
1197 
1198 	list_for_each_entry(tmp, &compr->dsp->buffer_list, list) {
1199 		if (!tmp->name || !strcmp(compr->name, tmp->name)) {
1200 			buf = tmp;
1201 			break;
1202 		}
1203 	}
1204 
1205 	if (!buf)
1206 		return -EINVAL;
1207 
1208 	compr->buf = buf;
1209 	buf->compr = compr;
1210 
1211 	return 0;
1212 }
1213 
1214 static void wm_adsp_compr_detach(struct wm_adsp_compr *compr)
1215 {
1216 	if (!compr)
1217 		return;
1218 
1219 	/* Wake the poll so it can see buffer is no longer attached */
1220 	if (compr->stream)
1221 		snd_compr_fragment_elapsed(compr->stream);
1222 
1223 	if (wm_adsp_compr_attached(compr)) {
1224 		compr->buf->compr = NULL;
1225 		compr->buf = NULL;
1226 	}
1227 }
1228 
1229 int wm_adsp_compr_open(struct wm_adsp *dsp, struct snd_compr_stream *stream)
1230 {
1231 	struct wm_adsp_compr *compr, *tmp;
1232 	struct snd_soc_pcm_runtime *rtd = stream->private_data;
1233 	int ret = 0;
1234 
1235 	mutex_lock(&dsp->cs_dsp.pwr_lock);
1236 
1237 	if (wm_adsp_fw[dsp->fw].num_caps == 0) {
1238 		adsp_err(dsp, "%s: Firmware does not support compressed API\n",
1239 			 asoc_rtd_to_codec(rtd, 0)->name);
1240 		ret = -ENXIO;
1241 		goto out;
1242 	}
1243 
1244 	if (wm_adsp_fw[dsp->fw].compr_direction != stream->direction) {
1245 		adsp_err(dsp, "%s: Firmware does not support stream direction\n",
1246 			 asoc_rtd_to_codec(rtd, 0)->name);
1247 		ret = -EINVAL;
1248 		goto out;
1249 	}
1250 
1251 	list_for_each_entry(tmp, &dsp->compr_list, list) {
1252 		if (!strcmp(tmp->name, asoc_rtd_to_codec(rtd, 0)->name)) {
1253 			adsp_err(dsp, "%s: Only a single stream supported per dai\n",
1254 				 asoc_rtd_to_codec(rtd, 0)->name);
1255 			ret = -EBUSY;
1256 			goto out;
1257 		}
1258 	}
1259 
1260 	compr = kzalloc(sizeof(*compr), GFP_KERNEL);
1261 	if (!compr) {
1262 		ret = -ENOMEM;
1263 		goto out;
1264 	}
1265 
1266 	compr->dsp = dsp;
1267 	compr->stream = stream;
1268 	compr->name = asoc_rtd_to_codec(rtd, 0)->name;
1269 
1270 	list_add_tail(&compr->list, &dsp->compr_list);
1271 
1272 	stream->runtime->private_data = compr;
1273 
1274 out:
1275 	mutex_unlock(&dsp->cs_dsp.pwr_lock);
1276 
1277 	return ret;
1278 }
1279 EXPORT_SYMBOL_GPL(wm_adsp_compr_open);
1280 
1281 int wm_adsp_compr_free(struct snd_soc_component *component,
1282 		       struct snd_compr_stream *stream)
1283 {
1284 	struct wm_adsp_compr *compr = stream->runtime->private_data;
1285 	struct wm_adsp *dsp = compr->dsp;
1286 
1287 	mutex_lock(&dsp->cs_dsp.pwr_lock);
1288 
1289 	wm_adsp_compr_detach(compr);
1290 	list_del(&compr->list);
1291 
1292 	kfree(compr->raw_buf);
1293 	kfree(compr);
1294 
1295 	mutex_unlock(&dsp->cs_dsp.pwr_lock);
1296 
1297 	return 0;
1298 }
1299 EXPORT_SYMBOL_GPL(wm_adsp_compr_free);
1300 
1301 static int wm_adsp_compr_check_params(struct snd_compr_stream *stream,
1302 				      struct snd_compr_params *params)
1303 {
1304 	struct wm_adsp_compr *compr = stream->runtime->private_data;
1305 	struct wm_adsp *dsp = compr->dsp;
1306 	const struct wm_adsp_fw_caps *caps;
1307 	const struct snd_codec_desc *desc;
1308 	int i, j;
1309 
1310 	if (params->buffer.fragment_size < WM_ADSP_MIN_FRAGMENT_SIZE ||
1311 	    params->buffer.fragment_size > WM_ADSP_MAX_FRAGMENT_SIZE ||
1312 	    params->buffer.fragments < WM_ADSP_MIN_FRAGMENTS ||
1313 	    params->buffer.fragments > WM_ADSP_MAX_FRAGMENTS ||
1314 	    params->buffer.fragment_size % CS_DSP_DATA_WORD_SIZE) {
1315 		compr_err(compr, "Invalid buffer fragsize=%d fragments=%d\n",
1316 			  params->buffer.fragment_size,
1317 			  params->buffer.fragments);
1318 
1319 		return -EINVAL;
1320 	}
1321 
1322 	for (i = 0; i < wm_adsp_fw[dsp->fw].num_caps; i++) {
1323 		caps = &wm_adsp_fw[dsp->fw].caps[i];
1324 		desc = &caps->desc;
1325 
1326 		if (caps->id != params->codec.id)
1327 			continue;
1328 
1329 		if (stream->direction == SND_COMPRESS_PLAYBACK) {
1330 			if (desc->max_ch < params->codec.ch_out)
1331 				continue;
1332 		} else {
1333 			if (desc->max_ch < params->codec.ch_in)
1334 				continue;
1335 		}
1336 
1337 		if (!(desc->formats & (1 << params->codec.format)))
1338 			continue;
1339 
1340 		for (j = 0; j < desc->num_sample_rates; ++j)
1341 			if (desc->sample_rates[j] == params->codec.sample_rate)
1342 				return 0;
1343 	}
1344 
1345 	compr_err(compr, "Invalid params id=%u ch=%u,%u rate=%u fmt=%u\n",
1346 		  params->codec.id, params->codec.ch_in, params->codec.ch_out,
1347 		  params->codec.sample_rate, params->codec.format);
1348 	return -EINVAL;
1349 }
1350 
1351 static inline unsigned int wm_adsp_compr_frag_words(struct wm_adsp_compr *compr)
1352 {
1353 	return compr->size.fragment_size / CS_DSP_DATA_WORD_SIZE;
1354 }
1355 
1356 int wm_adsp_compr_set_params(struct snd_soc_component *component,
1357 			     struct snd_compr_stream *stream,
1358 			     struct snd_compr_params *params)
1359 {
1360 	struct wm_adsp_compr *compr = stream->runtime->private_data;
1361 	unsigned int size;
1362 	int ret;
1363 
1364 	ret = wm_adsp_compr_check_params(stream, params);
1365 	if (ret)
1366 		return ret;
1367 
1368 	compr->size = params->buffer;
1369 
1370 	compr_dbg(compr, "fragment_size=%d fragments=%d\n",
1371 		  compr->size.fragment_size, compr->size.fragments);
1372 
1373 	size = wm_adsp_compr_frag_words(compr) * sizeof(*compr->raw_buf);
1374 	compr->raw_buf = kmalloc(size, GFP_DMA | GFP_KERNEL);
1375 	if (!compr->raw_buf)
1376 		return -ENOMEM;
1377 
1378 	compr->sample_rate = params->codec.sample_rate;
1379 
1380 	return 0;
1381 }
1382 EXPORT_SYMBOL_GPL(wm_adsp_compr_set_params);
1383 
1384 int wm_adsp_compr_get_caps(struct snd_soc_component *component,
1385 			   struct snd_compr_stream *stream,
1386 			   struct snd_compr_caps *caps)
1387 {
1388 	struct wm_adsp_compr *compr = stream->runtime->private_data;
1389 	int fw = compr->dsp->fw;
1390 	int i;
1391 
1392 	if (wm_adsp_fw[fw].caps) {
1393 		for (i = 0; i < wm_adsp_fw[fw].num_caps; i++)
1394 			caps->codecs[i] = wm_adsp_fw[fw].caps[i].id;
1395 
1396 		caps->num_codecs = i;
1397 		caps->direction = wm_adsp_fw[fw].compr_direction;
1398 
1399 		caps->min_fragment_size = WM_ADSP_MIN_FRAGMENT_SIZE;
1400 		caps->max_fragment_size = WM_ADSP_MAX_FRAGMENT_SIZE;
1401 		caps->min_fragments = WM_ADSP_MIN_FRAGMENTS;
1402 		caps->max_fragments = WM_ADSP_MAX_FRAGMENTS;
1403 	}
1404 
1405 	return 0;
1406 }
1407 EXPORT_SYMBOL_GPL(wm_adsp_compr_get_caps);
1408 
1409 static inline int wm_adsp_buffer_read(struct wm_adsp_compr_buf *buf,
1410 				      unsigned int field_offset, u32 *data)
1411 {
1412 	return cs_dsp_read_data_word(&buf->dsp->cs_dsp, buf->host_buf_mem_type,
1413 				     buf->host_buf_ptr + field_offset, data);
1414 }
1415 
1416 static inline int wm_adsp_buffer_write(struct wm_adsp_compr_buf *buf,
1417 				       unsigned int field_offset, u32 data)
1418 {
1419 	return cs_dsp_write_data_word(&buf->dsp->cs_dsp, buf->host_buf_mem_type,
1420 				      buf->host_buf_ptr + field_offset,
1421 				      data);
1422 }
1423 
1424 static int wm_adsp_buffer_populate(struct wm_adsp_compr_buf *buf)
1425 {
1426 	const struct wm_adsp_fw_caps *caps = wm_adsp_fw[buf->dsp->fw].caps;
1427 	struct wm_adsp_buffer_region *region;
1428 	u32 offset = 0;
1429 	int i, ret;
1430 
1431 	buf->regions = kcalloc(caps->num_regions, sizeof(*buf->regions),
1432 			       GFP_KERNEL);
1433 	if (!buf->regions)
1434 		return -ENOMEM;
1435 
1436 	for (i = 0; i < caps->num_regions; ++i) {
1437 		region = &buf->regions[i];
1438 
1439 		region->offset = offset;
1440 		region->mem_type = caps->region_defs[i].mem_type;
1441 
1442 		ret = wm_adsp_buffer_read(buf, caps->region_defs[i].base_offset,
1443 					  &region->base_addr);
1444 		if (ret < 0)
1445 			return ret;
1446 
1447 		ret = wm_adsp_buffer_read(buf, caps->region_defs[i].size_offset,
1448 					  &offset);
1449 		if (ret < 0)
1450 			return ret;
1451 
1452 		region->cumulative_size = offset;
1453 
1454 		compr_dbg(buf,
1455 			  "region=%d type=%d base=%08x off=%08x size=%08x\n",
1456 			  i, region->mem_type, region->base_addr,
1457 			  region->offset, region->cumulative_size);
1458 	}
1459 
1460 	return 0;
1461 }
1462 
1463 static void wm_adsp_buffer_clear(struct wm_adsp_compr_buf *buf)
1464 {
1465 	buf->irq_count = 0xFFFFFFFF;
1466 	buf->read_index = -1;
1467 	buf->avail = 0;
1468 }
1469 
1470 static struct wm_adsp_compr_buf *wm_adsp_buffer_alloc(struct wm_adsp *dsp)
1471 {
1472 	struct wm_adsp_compr_buf *buf;
1473 
1474 	buf = kzalloc(sizeof(*buf), GFP_KERNEL);
1475 	if (!buf)
1476 		return NULL;
1477 
1478 	buf->dsp = dsp;
1479 
1480 	wm_adsp_buffer_clear(buf);
1481 
1482 	return buf;
1483 }
1484 
1485 static int wm_adsp_buffer_parse_legacy(struct wm_adsp *dsp)
1486 {
1487 	struct cs_dsp_alg_region *alg_region;
1488 	struct wm_adsp_compr_buf *buf;
1489 	u32 xmalg, addr, magic;
1490 	int i, ret;
1491 
1492 	alg_region = cs_dsp_find_alg_region(&dsp->cs_dsp, WMFW_ADSP2_XM, dsp->cs_dsp.fw_id);
1493 	if (!alg_region) {
1494 		adsp_err(dsp, "No algorithm region found\n");
1495 		return -EINVAL;
1496 	}
1497 
1498 	xmalg = dsp->sys_config_size / sizeof(__be32);
1499 
1500 	addr = alg_region->base + xmalg + ALG_XM_FIELD(magic);
1501 	ret = cs_dsp_read_data_word(&dsp->cs_dsp, WMFW_ADSP2_XM, addr, &magic);
1502 	if (ret < 0)
1503 		return ret;
1504 
1505 	if (magic != WM_ADSP_ALG_XM_STRUCT_MAGIC)
1506 		return -ENODEV;
1507 
1508 	buf = wm_adsp_buffer_alloc(dsp);
1509 	if (!buf)
1510 		return -ENOMEM;
1511 
1512 	addr = alg_region->base + xmalg + ALG_XM_FIELD(host_buf_ptr);
1513 	for (i = 0; i < 5; ++i) {
1514 		ret = cs_dsp_read_data_word(&dsp->cs_dsp, WMFW_ADSP2_XM, addr,
1515 					    &buf->host_buf_ptr);
1516 		if (ret < 0)
1517 			goto err;
1518 
1519 		if (buf->host_buf_ptr)
1520 			break;
1521 
1522 		usleep_range(1000, 2000);
1523 	}
1524 
1525 	if (!buf->host_buf_ptr) {
1526 		ret = -EIO;
1527 		goto err;
1528 	}
1529 
1530 	buf->host_buf_mem_type = WMFW_ADSP2_XM;
1531 
1532 	ret = wm_adsp_buffer_populate(buf);
1533 	if (ret < 0)
1534 		goto err;
1535 
1536 	list_add_tail(&buf->list, &dsp->buffer_list);
1537 
1538 	compr_dbg(buf, "legacy host_buf_ptr=%x\n", buf->host_buf_ptr);
1539 
1540 	return 0;
1541 
1542 err:
1543 	kfree(buf);
1544 
1545 	return ret;
1546 }
1547 
1548 static int wm_adsp_buffer_parse_coeff(struct cs_dsp_coeff_ctl *cs_ctl)
1549 {
1550 	struct wm_adsp_host_buf_coeff_v1 coeff_v1;
1551 	struct wm_adsp_compr_buf *buf;
1552 	struct wm_adsp *dsp = container_of(cs_ctl->dsp, struct wm_adsp, cs_dsp);
1553 	unsigned int version = 0;
1554 	int ret, i;
1555 
1556 	for (i = 0; i < 5; ++i) {
1557 		ret = cs_dsp_coeff_read_ctrl(cs_ctl, 0, &coeff_v1,
1558 					     min(cs_ctl->len, sizeof(coeff_v1)));
1559 		if (ret < 0)
1560 			return ret;
1561 
1562 		if (coeff_v1.host_buf_ptr)
1563 			break;
1564 
1565 		usleep_range(1000, 2000);
1566 	}
1567 
1568 	if (!coeff_v1.host_buf_ptr) {
1569 		adsp_err(dsp, "Failed to acquire host buffer\n");
1570 		return -EIO;
1571 	}
1572 
1573 	buf = wm_adsp_buffer_alloc(dsp);
1574 	if (!buf)
1575 		return -ENOMEM;
1576 
1577 	buf->host_buf_mem_type = cs_ctl->alg_region.type;
1578 	buf->host_buf_ptr = be32_to_cpu(coeff_v1.host_buf_ptr);
1579 
1580 	ret = wm_adsp_buffer_populate(buf);
1581 	if (ret < 0)
1582 		goto err;
1583 
1584 	/*
1585 	 * v0 host_buffer coefficients didn't have versioning, so if the
1586 	 * control is one word, assume version 0.
1587 	 */
1588 	if (cs_ctl->len == 4)
1589 		goto done;
1590 
1591 	version = be32_to_cpu(coeff_v1.versions) & HOST_BUF_COEFF_COMPAT_VER_MASK;
1592 	version >>= HOST_BUF_COEFF_COMPAT_VER_SHIFT;
1593 
1594 	if (version > HOST_BUF_COEFF_SUPPORTED_COMPAT_VER) {
1595 		adsp_err(dsp,
1596 			 "Host buffer coeff ver %u > supported version %u\n",
1597 			 version, HOST_BUF_COEFF_SUPPORTED_COMPAT_VER);
1598 		ret = -EINVAL;
1599 		goto err;
1600 	}
1601 
1602 	cs_dsp_remove_padding((u32 *)&coeff_v1.name, ARRAY_SIZE(coeff_v1.name));
1603 
1604 	buf->name = kasprintf(GFP_KERNEL, "%s-dsp-%s", dsp->part,
1605 			      (char *)&coeff_v1.name);
1606 
1607 done:
1608 	list_add_tail(&buf->list, &dsp->buffer_list);
1609 
1610 	compr_dbg(buf, "host_buf_ptr=%x coeff version %u\n",
1611 		  buf->host_buf_ptr, version);
1612 
1613 	return version;
1614 
1615 err:
1616 	kfree(buf);
1617 
1618 	return ret;
1619 }
1620 
1621 static int wm_adsp_buffer_init(struct wm_adsp *dsp)
1622 {
1623 	struct cs_dsp_coeff_ctl *cs_ctl;
1624 	int ret;
1625 
1626 	list_for_each_entry(cs_ctl, &dsp->cs_dsp.ctl_list, list) {
1627 		if (cs_ctl->type != WMFW_CTL_TYPE_HOST_BUFFER)
1628 			continue;
1629 
1630 		if (!cs_ctl->enabled)
1631 			continue;
1632 
1633 		ret = wm_adsp_buffer_parse_coeff(cs_ctl);
1634 		if (ret < 0) {
1635 			adsp_err(dsp, "Failed to parse coeff: %d\n", ret);
1636 			goto error;
1637 		} else if (ret == 0) {
1638 			/* Only one buffer supported for version 0 */
1639 			return 0;
1640 		}
1641 	}
1642 
1643 	if (list_empty(&dsp->buffer_list)) {
1644 		/* Fall back to legacy support */
1645 		ret = wm_adsp_buffer_parse_legacy(dsp);
1646 		if (ret == -ENODEV)
1647 			adsp_info(dsp, "Legacy support not available\n");
1648 		else if (ret)
1649 			adsp_warn(dsp, "Failed to parse legacy: %d\n", ret);
1650 	}
1651 
1652 	return 0;
1653 
1654 error:
1655 	wm_adsp_buffer_free(dsp);
1656 	return ret;
1657 }
1658 
1659 static int wm_adsp_buffer_free(struct wm_adsp *dsp)
1660 {
1661 	struct wm_adsp_compr_buf *buf, *tmp;
1662 
1663 	list_for_each_entry_safe(buf, tmp, &dsp->buffer_list, list) {
1664 		wm_adsp_compr_detach(buf->compr);
1665 
1666 		kfree(buf->name);
1667 		kfree(buf->regions);
1668 		list_del(&buf->list);
1669 		kfree(buf);
1670 	}
1671 
1672 	return 0;
1673 }
1674 
1675 static int wm_adsp_buffer_get_error(struct wm_adsp_compr_buf *buf)
1676 {
1677 	int ret;
1678 
1679 	ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(error), &buf->error);
1680 	if (ret < 0) {
1681 		compr_err(buf, "Failed to check buffer error: %d\n", ret);
1682 		return ret;
1683 	}
1684 	if (buf->error != 0) {
1685 		compr_err(buf, "Buffer error occurred: %d\n", buf->error);
1686 		return -EIO;
1687 	}
1688 
1689 	return 0;
1690 }
1691 
1692 int wm_adsp_compr_trigger(struct snd_soc_component *component,
1693 			  struct snd_compr_stream *stream, int cmd)
1694 {
1695 	struct wm_adsp_compr *compr = stream->runtime->private_data;
1696 	struct wm_adsp *dsp = compr->dsp;
1697 	int ret = 0;
1698 
1699 	compr_dbg(compr, "Trigger: %d\n", cmd);
1700 
1701 	mutex_lock(&dsp->cs_dsp.pwr_lock);
1702 
1703 	switch (cmd) {
1704 	case SNDRV_PCM_TRIGGER_START:
1705 		if (!wm_adsp_compr_attached(compr)) {
1706 			ret = wm_adsp_compr_attach(compr);
1707 			if (ret < 0) {
1708 				compr_err(compr, "Failed to link buffer and stream: %d\n",
1709 					  ret);
1710 				break;
1711 			}
1712 		}
1713 
1714 		ret = wm_adsp_buffer_get_error(compr->buf);
1715 		if (ret < 0)
1716 			break;
1717 
1718 		/* Trigger the IRQ at one fragment of data */
1719 		ret = wm_adsp_buffer_write(compr->buf,
1720 					   HOST_BUFFER_FIELD(high_water_mark),
1721 					   wm_adsp_compr_frag_words(compr));
1722 		if (ret < 0) {
1723 			compr_err(compr, "Failed to set high water mark: %d\n",
1724 				  ret);
1725 			break;
1726 		}
1727 		break;
1728 	case SNDRV_PCM_TRIGGER_STOP:
1729 		if (wm_adsp_compr_attached(compr))
1730 			wm_adsp_buffer_clear(compr->buf);
1731 		break;
1732 	default:
1733 		ret = -EINVAL;
1734 		break;
1735 	}
1736 
1737 	mutex_unlock(&dsp->cs_dsp.pwr_lock);
1738 
1739 	return ret;
1740 }
1741 EXPORT_SYMBOL_GPL(wm_adsp_compr_trigger);
1742 
1743 static inline int wm_adsp_buffer_size(struct wm_adsp_compr_buf *buf)
1744 {
1745 	int last_region = wm_adsp_fw[buf->dsp->fw].caps->num_regions - 1;
1746 
1747 	return buf->regions[last_region].cumulative_size;
1748 }
1749 
1750 static int wm_adsp_buffer_update_avail(struct wm_adsp_compr_buf *buf)
1751 {
1752 	u32 next_read_index, next_write_index;
1753 	int write_index, read_index, avail;
1754 	int ret;
1755 
1756 	/* Only sync read index if we haven't already read a valid index */
1757 	if (buf->read_index < 0) {
1758 		ret = wm_adsp_buffer_read(buf,
1759 				HOST_BUFFER_FIELD(next_read_index),
1760 				&next_read_index);
1761 		if (ret < 0)
1762 			return ret;
1763 
1764 		read_index = sign_extend32(next_read_index, 23);
1765 
1766 		if (read_index < 0) {
1767 			compr_dbg(buf, "Avail check on unstarted stream\n");
1768 			return 0;
1769 		}
1770 
1771 		buf->read_index = read_index;
1772 	}
1773 
1774 	ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(next_write_index),
1775 			&next_write_index);
1776 	if (ret < 0)
1777 		return ret;
1778 
1779 	write_index = sign_extend32(next_write_index, 23);
1780 
1781 	avail = write_index - buf->read_index;
1782 	if (avail < 0)
1783 		avail += wm_adsp_buffer_size(buf);
1784 
1785 	compr_dbg(buf, "readindex=0x%x, writeindex=0x%x, avail=%d\n",
1786 		  buf->read_index, write_index, avail * CS_DSP_DATA_WORD_SIZE);
1787 
1788 	buf->avail = avail;
1789 
1790 	return 0;
1791 }
1792 
1793 int wm_adsp_compr_handle_irq(struct wm_adsp *dsp)
1794 {
1795 	struct wm_adsp_compr_buf *buf;
1796 	struct wm_adsp_compr *compr;
1797 	int ret = 0;
1798 
1799 	mutex_lock(&dsp->cs_dsp.pwr_lock);
1800 
1801 	if (list_empty(&dsp->buffer_list)) {
1802 		ret = -ENODEV;
1803 		goto out;
1804 	}
1805 
1806 	adsp_dbg(dsp, "Handling buffer IRQ\n");
1807 
1808 	list_for_each_entry(buf, &dsp->buffer_list, list) {
1809 		compr = buf->compr;
1810 
1811 		ret = wm_adsp_buffer_get_error(buf);
1812 		if (ret < 0)
1813 			goto out_notify; /* Wake poll to report error */
1814 
1815 		ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(irq_count),
1816 					  &buf->irq_count);
1817 		if (ret < 0) {
1818 			compr_err(buf, "Failed to get irq_count: %d\n", ret);
1819 			goto out;
1820 		}
1821 
1822 		ret = wm_adsp_buffer_update_avail(buf);
1823 		if (ret < 0) {
1824 			compr_err(buf, "Error reading avail: %d\n", ret);
1825 			goto out;
1826 		}
1827 
1828 		if (wm_adsp_fw[dsp->fw].voice_trigger && buf->irq_count == 2)
1829 			ret = WM_ADSP_COMPR_VOICE_TRIGGER;
1830 
1831 out_notify:
1832 		if (compr && compr->stream)
1833 			snd_compr_fragment_elapsed(compr->stream);
1834 	}
1835 
1836 out:
1837 	mutex_unlock(&dsp->cs_dsp.pwr_lock);
1838 
1839 	return ret;
1840 }
1841 EXPORT_SYMBOL_GPL(wm_adsp_compr_handle_irq);
1842 
1843 static int wm_adsp_buffer_reenable_irq(struct wm_adsp_compr_buf *buf)
1844 {
1845 	if (buf->irq_count & 0x01)
1846 		return 0;
1847 
1848 	compr_dbg(buf, "Enable IRQ(0x%x) for next fragment\n", buf->irq_count);
1849 
1850 	buf->irq_count |= 0x01;
1851 
1852 	return wm_adsp_buffer_write(buf, HOST_BUFFER_FIELD(irq_ack),
1853 				    buf->irq_count);
1854 }
1855 
1856 int wm_adsp_compr_pointer(struct snd_soc_component *component,
1857 			  struct snd_compr_stream *stream,
1858 			  struct snd_compr_tstamp *tstamp)
1859 {
1860 	struct wm_adsp_compr *compr = stream->runtime->private_data;
1861 	struct wm_adsp *dsp = compr->dsp;
1862 	struct wm_adsp_compr_buf *buf;
1863 	int ret = 0;
1864 
1865 	compr_dbg(compr, "Pointer request\n");
1866 
1867 	mutex_lock(&dsp->cs_dsp.pwr_lock);
1868 
1869 	buf = compr->buf;
1870 
1871 	if (dsp->fatal_error || !buf || buf->error) {
1872 		snd_compr_stop_error(stream, SNDRV_PCM_STATE_XRUN);
1873 		ret = -EIO;
1874 		goto out;
1875 	}
1876 
1877 	if (buf->avail < wm_adsp_compr_frag_words(compr)) {
1878 		ret = wm_adsp_buffer_update_avail(buf);
1879 		if (ret < 0) {
1880 			compr_err(compr, "Error reading avail: %d\n", ret);
1881 			goto out;
1882 		}
1883 
1884 		/*
1885 		 * If we really have less than 1 fragment available tell the
1886 		 * DSP to inform us once a whole fragment is available.
1887 		 */
1888 		if (buf->avail < wm_adsp_compr_frag_words(compr)) {
1889 			ret = wm_adsp_buffer_get_error(buf);
1890 			if (ret < 0) {
1891 				if (buf->error)
1892 					snd_compr_stop_error(stream,
1893 							SNDRV_PCM_STATE_XRUN);
1894 				goto out;
1895 			}
1896 
1897 			ret = wm_adsp_buffer_reenable_irq(buf);
1898 			if (ret < 0) {
1899 				compr_err(compr, "Failed to re-enable buffer IRQ: %d\n",
1900 					  ret);
1901 				goto out;
1902 			}
1903 		}
1904 	}
1905 
1906 	tstamp->copied_total = compr->copied_total;
1907 	tstamp->copied_total += buf->avail * CS_DSP_DATA_WORD_SIZE;
1908 	tstamp->sampling_rate = compr->sample_rate;
1909 
1910 out:
1911 	mutex_unlock(&dsp->cs_dsp.pwr_lock);
1912 
1913 	return ret;
1914 }
1915 EXPORT_SYMBOL_GPL(wm_adsp_compr_pointer);
1916 
1917 static int wm_adsp_buffer_capture_block(struct wm_adsp_compr *compr, int target)
1918 {
1919 	struct wm_adsp_compr_buf *buf = compr->buf;
1920 	unsigned int adsp_addr;
1921 	int mem_type, nwords, max_read;
1922 	int i, ret;
1923 
1924 	/* Calculate read parameters */
1925 	for (i = 0; i < wm_adsp_fw[buf->dsp->fw].caps->num_regions; ++i)
1926 		if (buf->read_index < buf->regions[i].cumulative_size)
1927 			break;
1928 
1929 	if (i == wm_adsp_fw[buf->dsp->fw].caps->num_regions)
1930 		return -EINVAL;
1931 
1932 	mem_type = buf->regions[i].mem_type;
1933 	adsp_addr = buf->regions[i].base_addr +
1934 		    (buf->read_index - buf->regions[i].offset);
1935 
1936 	max_read = wm_adsp_compr_frag_words(compr);
1937 	nwords = buf->regions[i].cumulative_size - buf->read_index;
1938 
1939 	if (nwords > target)
1940 		nwords = target;
1941 	if (nwords > buf->avail)
1942 		nwords = buf->avail;
1943 	if (nwords > max_read)
1944 		nwords = max_read;
1945 	if (!nwords)
1946 		return 0;
1947 
1948 	/* Read data from DSP */
1949 	ret = cs_dsp_read_raw_data_block(&buf->dsp->cs_dsp, mem_type, adsp_addr,
1950 					 nwords, (__be32 *)compr->raw_buf);
1951 	if (ret < 0)
1952 		return ret;
1953 
1954 	cs_dsp_remove_padding(compr->raw_buf, nwords);
1955 
1956 	/* update read index to account for words read */
1957 	buf->read_index += nwords;
1958 	if (buf->read_index == wm_adsp_buffer_size(buf))
1959 		buf->read_index = 0;
1960 
1961 	ret = wm_adsp_buffer_write(buf, HOST_BUFFER_FIELD(next_read_index),
1962 				   buf->read_index);
1963 	if (ret < 0)
1964 		return ret;
1965 
1966 	/* update avail to account for words read */
1967 	buf->avail -= nwords;
1968 
1969 	return nwords;
1970 }
1971 
1972 static int wm_adsp_compr_read(struct wm_adsp_compr *compr,
1973 			      char __user *buf, size_t count)
1974 {
1975 	struct wm_adsp *dsp = compr->dsp;
1976 	int ntotal = 0;
1977 	int nwords, nbytes;
1978 
1979 	compr_dbg(compr, "Requested read of %zu bytes\n", count);
1980 
1981 	if (dsp->fatal_error || !compr->buf || compr->buf->error) {
1982 		snd_compr_stop_error(compr->stream, SNDRV_PCM_STATE_XRUN);
1983 		return -EIO;
1984 	}
1985 
1986 	count /= CS_DSP_DATA_WORD_SIZE;
1987 
1988 	do {
1989 		nwords = wm_adsp_buffer_capture_block(compr, count);
1990 		if (nwords < 0) {
1991 			compr_err(compr, "Failed to capture block: %d\n",
1992 				  nwords);
1993 			return nwords;
1994 		}
1995 
1996 		nbytes = nwords * CS_DSP_DATA_WORD_SIZE;
1997 
1998 		compr_dbg(compr, "Read %d bytes\n", nbytes);
1999 
2000 		if (copy_to_user(buf + ntotal, compr->raw_buf, nbytes)) {
2001 			compr_err(compr, "Failed to copy data to user: %d, %d\n",
2002 				  ntotal, nbytes);
2003 			return -EFAULT;
2004 		}
2005 
2006 		count -= nwords;
2007 		ntotal += nbytes;
2008 	} while (nwords > 0 && count > 0);
2009 
2010 	compr->copied_total += ntotal;
2011 
2012 	return ntotal;
2013 }
2014 
2015 int wm_adsp_compr_copy(struct snd_soc_component *component,
2016 		       struct snd_compr_stream *stream, char __user *buf,
2017 		       size_t count)
2018 {
2019 	struct wm_adsp_compr *compr = stream->runtime->private_data;
2020 	struct wm_adsp *dsp = compr->dsp;
2021 	int ret;
2022 
2023 	mutex_lock(&dsp->cs_dsp.pwr_lock);
2024 
2025 	if (stream->direction == SND_COMPRESS_CAPTURE)
2026 		ret = wm_adsp_compr_read(compr, buf, count);
2027 	else
2028 		ret = -ENOTSUPP;
2029 
2030 	mutex_unlock(&dsp->cs_dsp.pwr_lock);
2031 
2032 	return ret;
2033 }
2034 EXPORT_SYMBOL_GPL(wm_adsp_compr_copy);
2035 
2036 static void wm_adsp_fatal_error(struct cs_dsp *cs_dsp)
2037 {
2038 	struct wm_adsp *dsp = container_of(cs_dsp, struct wm_adsp, cs_dsp);
2039 	struct wm_adsp_compr *compr;
2040 
2041 	dsp->fatal_error = true;
2042 
2043 	list_for_each_entry(compr, &dsp->compr_list, list) {
2044 		if (compr->stream)
2045 			snd_compr_fragment_elapsed(compr->stream);
2046 	}
2047 }
2048 
2049 irqreturn_t wm_adsp2_bus_error(int irq, void *data)
2050 {
2051 	struct wm_adsp *dsp = (struct wm_adsp *)data;
2052 
2053 	cs_dsp_adsp2_bus_error(&dsp->cs_dsp);
2054 
2055 	return IRQ_HANDLED;
2056 }
2057 EXPORT_SYMBOL_GPL(wm_adsp2_bus_error);
2058 
2059 irqreturn_t wm_halo_bus_error(int irq, void *data)
2060 {
2061 	struct wm_adsp *dsp = (struct wm_adsp *)data;
2062 
2063 	cs_dsp_halo_bus_error(&dsp->cs_dsp);
2064 
2065 	return IRQ_HANDLED;
2066 }
2067 EXPORT_SYMBOL_GPL(wm_halo_bus_error);
2068 
2069 irqreturn_t wm_halo_wdt_expire(int irq, void *data)
2070 {
2071 	struct wm_adsp *dsp = data;
2072 
2073 	cs_dsp_halo_wdt_expire(&dsp->cs_dsp);
2074 
2075 	return IRQ_HANDLED;
2076 }
2077 EXPORT_SYMBOL_GPL(wm_halo_wdt_expire);
2078 
2079 static const struct cs_dsp_client_ops wm_adsp1_client_ops = {
2080 	.control_add = wm_adsp_control_add,
2081 	.control_remove = wm_adsp_control_remove,
2082 };
2083 
2084 static const struct cs_dsp_client_ops wm_adsp2_client_ops = {
2085 	.control_add = wm_adsp_control_add,
2086 	.control_remove = wm_adsp_control_remove,
2087 	.pre_run = wm_adsp_pre_run,
2088 	.post_run = wm_adsp_event_post_run,
2089 	.post_stop = wm_adsp_event_post_stop,
2090 	.watchdog_expired = wm_adsp_fatal_error,
2091 };
2092 
2093 MODULE_LICENSE("GPL v2");
2094 MODULE_IMPORT_NS(FW_CS_DSP);
2095