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