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