xref: /openbmc/linux/sound/soc/codecs/wm_adsp.c (revision 0547dece8dcbb80983b3c37ad20ceca76a1f06a5)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * wm_adsp.c  --  Wolfson ADSP support
4  *
5  * Copyright 2012 Wolfson Microelectronics plc
6  *
7  * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
8  */
9 
10 #include <linux/ctype.h>
11 #include <linux/module.h>
12 #include <linux/moduleparam.h>
13 #include <linux/init.h>
14 #include <linux/delay.h>
15 #include <linux/firmware.h>
16 #include <linux/list.h>
17 #include <linux/pm.h>
18 #include <linux/pm_runtime.h>
19 #include <linux/regmap.h>
20 #include <linux/regulator/consumer.h>
21 #include <linux/slab.h>
22 #include <linux/vmalloc.h>
23 #include <linux/workqueue.h>
24 #include <linux/debugfs.h>
25 #include <sound/core.h>
26 #include <sound/pcm.h>
27 #include <sound/pcm_params.h>
28 #include <sound/soc.h>
29 #include <sound/jack.h>
30 #include <sound/initval.h>
31 #include <sound/tlv.h>
32 
33 #include "wm_adsp.h"
34 
35 #define adsp_crit(_dsp, fmt, ...) \
36 	dev_crit(_dsp->dev, "%s: " fmt, _dsp->name, ##__VA_ARGS__)
37 #define adsp_err(_dsp, fmt, ...) \
38 	dev_err(_dsp->dev, "%s: " fmt, _dsp->name, ##__VA_ARGS__)
39 #define adsp_warn(_dsp, fmt, ...) \
40 	dev_warn(_dsp->dev, "%s: " fmt, _dsp->name, ##__VA_ARGS__)
41 #define adsp_info(_dsp, fmt, ...) \
42 	dev_info(_dsp->dev, "%s: " fmt, _dsp->name, ##__VA_ARGS__)
43 #define adsp_dbg(_dsp, fmt, ...) \
44 	dev_dbg(_dsp->dev, "%s: " fmt, _dsp->name, ##__VA_ARGS__)
45 
46 #define compr_err(_obj, fmt, ...) \
47 	adsp_err(_obj->dsp, "%s: " fmt, _obj->name ? _obj->name : "legacy", \
48 		 ##__VA_ARGS__)
49 #define compr_dbg(_obj, fmt, ...) \
50 	adsp_dbg(_obj->dsp, "%s: " fmt, _obj->name ? _obj->name : "legacy", \
51 		 ##__VA_ARGS__)
52 
53 #define ADSP1_CONTROL_1                   0x00
54 #define ADSP1_CONTROL_2                   0x02
55 #define ADSP1_CONTROL_3                   0x03
56 #define ADSP1_CONTROL_4                   0x04
57 #define ADSP1_CONTROL_5                   0x06
58 #define ADSP1_CONTROL_6                   0x07
59 #define ADSP1_CONTROL_7                   0x08
60 #define ADSP1_CONTROL_8                   0x09
61 #define ADSP1_CONTROL_9                   0x0A
62 #define ADSP1_CONTROL_10                  0x0B
63 #define ADSP1_CONTROL_11                  0x0C
64 #define ADSP1_CONTROL_12                  0x0D
65 #define ADSP1_CONTROL_13                  0x0F
66 #define ADSP1_CONTROL_14                  0x10
67 #define ADSP1_CONTROL_15                  0x11
68 #define ADSP1_CONTROL_16                  0x12
69 #define ADSP1_CONTROL_17                  0x13
70 #define ADSP1_CONTROL_18                  0x14
71 #define ADSP1_CONTROL_19                  0x16
72 #define ADSP1_CONTROL_20                  0x17
73 #define ADSP1_CONTROL_21                  0x18
74 #define ADSP1_CONTROL_22                  0x1A
75 #define ADSP1_CONTROL_23                  0x1B
76 #define ADSP1_CONTROL_24                  0x1C
77 #define ADSP1_CONTROL_25                  0x1E
78 #define ADSP1_CONTROL_26                  0x20
79 #define ADSP1_CONTROL_27                  0x21
80 #define ADSP1_CONTROL_28                  0x22
81 #define ADSP1_CONTROL_29                  0x23
82 #define ADSP1_CONTROL_30                  0x24
83 #define ADSP1_CONTROL_31                  0x26
84 
85 /*
86  * ADSP1 Control 19
87  */
88 #define ADSP1_WDMA_BUFFER_LENGTH_MASK     0x00FF  /* DSP1_WDMA_BUFFER_LENGTH - [7:0] */
89 #define ADSP1_WDMA_BUFFER_LENGTH_SHIFT         0  /* DSP1_WDMA_BUFFER_LENGTH - [7:0] */
90 #define ADSP1_WDMA_BUFFER_LENGTH_WIDTH         8  /* DSP1_WDMA_BUFFER_LENGTH - [7:0] */
91 
92 
93 /*
94  * ADSP1 Control 30
95  */
96 #define ADSP1_DBG_CLK_ENA                 0x0008  /* DSP1_DBG_CLK_ENA */
97 #define ADSP1_DBG_CLK_ENA_MASK            0x0008  /* DSP1_DBG_CLK_ENA */
98 #define ADSP1_DBG_CLK_ENA_SHIFT                3  /* DSP1_DBG_CLK_ENA */
99 #define ADSP1_DBG_CLK_ENA_WIDTH                1  /* DSP1_DBG_CLK_ENA */
100 #define ADSP1_SYS_ENA                     0x0004  /* DSP1_SYS_ENA */
101 #define ADSP1_SYS_ENA_MASK                0x0004  /* DSP1_SYS_ENA */
102 #define ADSP1_SYS_ENA_SHIFT                    2  /* DSP1_SYS_ENA */
103 #define ADSP1_SYS_ENA_WIDTH                    1  /* DSP1_SYS_ENA */
104 #define ADSP1_CORE_ENA                    0x0002  /* DSP1_CORE_ENA */
105 #define ADSP1_CORE_ENA_MASK               0x0002  /* DSP1_CORE_ENA */
106 #define ADSP1_CORE_ENA_SHIFT                   1  /* DSP1_CORE_ENA */
107 #define ADSP1_CORE_ENA_WIDTH                   1  /* DSP1_CORE_ENA */
108 #define ADSP1_START                       0x0001  /* DSP1_START */
109 #define ADSP1_START_MASK                  0x0001  /* DSP1_START */
110 #define ADSP1_START_SHIFT                      0  /* DSP1_START */
111 #define ADSP1_START_WIDTH                      1  /* DSP1_START */
112 
113 /*
114  * ADSP1 Control 31
115  */
116 #define ADSP1_CLK_SEL_MASK                0x0007  /* CLK_SEL_ENA */
117 #define ADSP1_CLK_SEL_SHIFT                    0  /* CLK_SEL_ENA */
118 #define ADSP1_CLK_SEL_WIDTH                    3  /* CLK_SEL_ENA */
119 
120 #define ADSP2_CONTROL                     0x0
121 #define ADSP2_CLOCKING                    0x1
122 #define ADSP2V2_CLOCKING                  0x2
123 #define ADSP2_STATUS1                     0x4
124 #define ADSP2_WDMA_CONFIG_1               0x30
125 #define ADSP2_WDMA_CONFIG_2               0x31
126 #define ADSP2V2_WDMA_CONFIG_2             0x32
127 #define ADSP2_RDMA_CONFIG_1               0x34
128 
129 #define ADSP2_SCRATCH0                    0x40
130 #define ADSP2_SCRATCH1                    0x41
131 #define ADSP2_SCRATCH2                    0x42
132 #define ADSP2_SCRATCH3                    0x43
133 
134 #define ADSP2V2_SCRATCH0_1                0x40
135 #define ADSP2V2_SCRATCH2_3                0x42
136 
137 /*
138  * ADSP2 Control
139  */
140 
141 #define ADSP2_MEM_ENA                     0x0010  /* DSP1_MEM_ENA */
142 #define ADSP2_MEM_ENA_MASK                0x0010  /* DSP1_MEM_ENA */
143 #define ADSP2_MEM_ENA_SHIFT                    4  /* DSP1_MEM_ENA */
144 #define ADSP2_MEM_ENA_WIDTH                    1  /* DSP1_MEM_ENA */
145 #define ADSP2_SYS_ENA                     0x0004  /* DSP1_SYS_ENA */
146 #define ADSP2_SYS_ENA_MASK                0x0004  /* DSP1_SYS_ENA */
147 #define ADSP2_SYS_ENA_SHIFT                    2  /* DSP1_SYS_ENA */
148 #define ADSP2_SYS_ENA_WIDTH                    1  /* DSP1_SYS_ENA */
149 #define ADSP2_CORE_ENA                    0x0002  /* DSP1_CORE_ENA */
150 #define ADSP2_CORE_ENA_MASK               0x0002  /* DSP1_CORE_ENA */
151 #define ADSP2_CORE_ENA_SHIFT                   1  /* DSP1_CORE_ENA */
152 #define ADSP2_CORE_ENA_WIDTH                   1  /* DSP1_CORE_ENA */
153 #define ADSP2_START                       0x0001  /* DSP1_START */
154 #define ADSP2_START_MASK                  0x0001  /* DSP1_START */
155 #define ADSP2_START_SHIFT                      0  /* DSP1_START */
156 #define ADSP2_START_WIDTH                      1  /* DSP1_START */
157 
158 /*
159  * ADSP2 clocking
160  */
161 #define ADSP2_CLK_SEL_MASK                0x0007  /* CLK_SEL_ENA */
162 #define ADSP2_CLK_SEL_SHIFT                    0  /* CLK_SEL_ENA */
163 #define ADSP2_CLK_SEL_WIDTH                    3  /* CLK_SEL_ENA */
164 
165 /*
166  * ADSP2V2 clocking
167  */
168 #define ADSP2V2_CLK_SEL_MASK             0x70000  /* CLK_SEL_ENA */
169 #define ADSP2V2_CLK_SEL_SHIFT                 16  /* CLK_SEL_ENA */
170 #define ADSP2V2_CLK_SEL_WIDTH                  3  /* CLK_SEL_ENA */
171 
172 #define ADSP2V2_RATE_MASK                 0x7800  /* DSP_RATE */
173 #define ADSP2V2_RATE_SHIFT                    11  /* DSP_RATE */
174 #define ADSP2V2_RATE_WIDTH                     4  /* DSP_RATE */
175 
176 /*
177  * ADSP2 Status 1
178  */
179 #define ADSP2_RAM_RDY                     0x0001
180 #define ADSP2_RAM_RDY_MASK                0x0001
181 #define ADSP2_RAM_RDY_SHIFT                    0
182 #define ADSP2_RAM_RDY_WIDTH                    1
183 
184 /*
185  * ADSP2 Lock support
186  */
187 #define ADSP2_LOCK_CODE_0                    0x5555
188 #define ADSP2_LOCK_CODE_1                    0xAAAA
189 
190 #define ADSP2_WATCHDOG                       0x0A
191 #define ADSP2_BUS_ERR_ADDR                   0x52
192 #define ADSP2_REGION_LOCK_STATUS             0x64
193 #define ADSP2_LOCK_REGION_1_LOCK_REGION_0    0x66
194 #define ADSP2_LOCK_REGION_3_LOCK_REGION_2    0x68
195 #define ADSP2_LOCK_REGION_5_LOCK_REGION_4    0x6A
196 #define ADSP2_LOCK_REGION_7_LOCK_REGION_6    0x6C
197 #define ADSP2_LOCK_REGION_9_LOCK_REGION_8    0x6E
198 #define ADSP2_LOCK_REGION_CTRL               0x7A
199 #define ADSP2_PMEM_ERR_ADDR_XMEM_ERR_ADDR    0x7C
200 
201 #define ADSP2_REGION_LOCK_ERR_MASK           0x8000
202 #define ADSP2_ADDR_ERR_MASK                  0x4000
203 #define ADSP2_WDT_TIMEOUT_STS_MASK           0x2000
204 #define ADSP2_CTRL_ERR_PAUSE_ENA             0x0002
205 #define ADSP2_CTRL_ERR_EINT                  0x0001
206 
207 #define ADSP2_BUS_ERR_ADDR_MASK              0x00FFFFFF
208 #define ADSP2_XMEM_ERR_ADDR_MASK             0x0000FFFF
209 #define ADSP2_PMEM_ERR_ADDR_MASK             0x7FFF0000
210 #define ADSP2_PMEM_ERR_ADDR_SHIFT            16
211 #define ADSP2_WDT_ENA_MASK                   0xFFFFFFFD
212 
213 #define ADSP2_LOCK_REGION_SHIFT              16
214 
215 #define ADSP_MAX_STD_CTRL_SIZE               512
216 
217 #define WM_ADSP_ACKED_CTL_TIMEOUT_MS         100
218 #define WM_ADSP_ACKED_CTL_N_QUICKPOLLS       10
219 #define WM_ADSP_ACKED_CTL_MIN_VALUE          0
220 #define WM_ADSP_ACKED_CTL_MAX_VALUE          0xFFFFFF
221 
222 /*
223  * Event control messages
224  */
225 #define WM_ADSP_FW_EVENT_SHUTDOWN            0x000001
226 
227 /*
228  * HALO system info
229  */
230 #define HALO_AHBM_WINDOW_DEBUG_0             0x02040
231 #define HALO_AHBM_WINDOW_DEBUG_1             0x02044
232 
233 /*
234  * HALO core
235  */
236 #define HALO_SCRATCH1                        0x005c0
237 #define HALO_SCRATCH2                        0x005c8
238 #define HALO_SCRATCH3                        0x005d0
239 #define HALO_SCRATCH4                        0x005d8
240 #define HALO_CCM_CORE_CONTROL                0x41000
241 #define HALO_CORE_SOFT_RESET                 0x00010
242 #define HALO_WDT_CONTROL                     0x47000
243 
244 /*
245  * HALO MPU banks
246  */
247 #define HALO_MPU_XMEM_ACCESS_0               0x43000
248 #define HALO_MPU_YMEM_ACCESS_0               0x43004
249 #define HALO_MPU_WINDOW_ACCESS_0             0x43008
250 #define HALO_MPU_XREG_ACCESS_0               0x4300C
251 #define HALO_MPU_YREG_ACCESS_0               0x43014
252 #define HALO_MPU_XMEM_ACCESS_1               0x43018
253 #define HALO_MPU_YMEM_ACCESS_1               0x4301C
254 #define HALO_MPU_WINDOW_ACCESS_1             0x43020
255 #define HALO_MPU_XREG_ACCESS_1               0x43024
256 #define HALO_MPU_YREG_ACCESS_1               0x4302C
257 #define HALO_MPU_XMEM_ACCESS_2               0x43030
258 #define HALO_MPU_YMEM_ACCESS_2               0x43034
259 #define HALO_MPU_WINDOW_ACCESS_2             0x43038
260 #define HALO_MPU_XREG_ACCESS_2               0x4303C
261 #define HALO_MPU_YREG_ACCESS_2               0x43044
262 #define HALO_MPU_XMEM_ACCESS_3               0x43048
263 #define HALO_MPU_YMEM_ACCESS_3               0x4304C
264 #define HALO_MPU_WINDOW_ACCESS_3             0x43050
265 #define HALO_MPU_XREG_ACCESS_3               0x43054
266 #define HALO_MPU_YREG_ACCESS_3               0x4305C
267 #define HALO_MPU_XM_VIO_ADDR                 0x43100
268 #define HALO_MPU_XM_VIO_STATUS               0x43104
269 #define HALO_MPU_YM_VIO_ADDR                 0x43108
270 #define HALO_MPU_YM_VIO_STATUS               0x4310C
271 #define HALO_MPU_PM_VIO_ADDR                 0x43110
272 #define HALO_MPU_PM_VIO_STATUS               0x43114
273 #define HALO_MPU_LOCK_CONFIG                 0x43140
274 
275 /*
276  * HALO_AHBM_WINDOW_DEBUG_1
277  */
278 #define HALO_AHBM_CORE_ERR_ADDR_MASK         0x0fffff00
279 #define HALO_AHBM_CORE_ERR_ADDR_SHIFT                 8
280 #define HALO_AHBM_FLAGS_ERR_MASK             0x000000ff
281 
282 /*
283  * HALO_CCM_CORE_CONTROL
284  */
285 #define HALO_CORE_EN                        0x00000001
286 
287 /*
288  * HALO_CORE_SOFT_RESET
289  */
290 #define HALO_CORE_SOFT_RESET_MASK           0x00000001
291 
292 /*
293  * HALO_WDT_CONTROL
294  */
295 #define HALO_WDT_EN_MASK                    0x00000001
296 
297 /*
298  * HALO_MPU_?M_VIO_STATUS
299  */
300 #define HALO_MPU_VIO_STS_MASK               0x007e0000
301 #define HALO_MPU_VIO_STS_SHIFT                      17
302 #define HALO_MPU_VIO_ERR_WR_MASK            0x00008000
303 #define HALO_MPU_VIO_ERR_SRC_MASK           0x00007fff
304 #define HALO_MPU_VIO_ERR_SRC_SHIFT                   0
305 
306 static struct wm_adsp_ops wm_adsp1_ops;
307 static struct wm_adsp_ops wm_adsp2_ops[];
308 static struct wm_adsp_ops wm_halo_ops;
309 
310 struct wm_adsp_buf {
311 	struct list_head list;
312 	void *buf;
313 };
314 
315 static struct wm_adsp_buf *wm_adsp_buf_alloc(const void *src, size_t len,
316 					     struct list_head *list)
317 {
318 	struct wm_adsp_buf *buf = kzalloc(sizeof(*buf), GFP_KERNEL);
319 
320 	if (buf == NULL)
321 		return NULL;
322 
323 	buf->buf = vmalloc(len);
324 	if (!buf->buf) {
325 		kfree(buf);
326 		return NULL;
327 	}
328 	memcpy(buf->buf, src, len);
329 
330 	if (list)
331 		list_add_tail(&buf->list, list);
332 
333 	return buf;
334 }
335 
336 static void wm_adsp_buf_free(struct list_head *list)
337 {
338 	while (!list_empty(list)) {
339 		struct wm_adsp_buf *buf = list_first_entry(list,
340 							   struct wm_adsp_buf,
341 							   list);
342 		list_del(&buf->list);
343 		vfree(buf->buf);
344 		kfree(buf);
345 	}
346 }
347 
348 #define WM_ADSP_FW_MBC_VSS  0
349 #define WM_ADSP_FW_HIFI     1
350 #define WM_ADSP_FW_TX       2
351 #define WM_ADSP_FW_TX_SPK   3
352 #define WM_ADSP_FW_RX       4
353 #define WM_ADSP_FW_RX_ANC   5
354 #define WM_ADSP_FW_CTRL     6
355 #define WM_ADSP_FW_ASR      7
356 #define WM_ADSP_FW_TRACE    8
357 #define WM_ADSP_FW_SPK_PROT 9
358 #define WM_ADSP_FW_SPK_CALI 10
359 #define WM_ADSP_FW_SPK_DIAG 11
360 #define WM_ADSP_FW_MISC     12
361 
362 #define WM_ADSP_NUM_FW      13
363 
364 static const char *wm_adsp_fw_text[WM_ADSP_NUM_FW] = {
365 	[WM_ADSP_FW_MBC_VSS] =  "MBC/VSS",
366 	[WM_ADSP_FW_HIFI] =     "MasterHiFi",
367 	[WM_ADSP_FW_TX] =       "Tx",
368 	[WM_ADSP_FW_TX_SPK] =   "Tx Speaker",
369 	[WM_ADSP_FW_RX] =       "Rx",
370 	[WM_ADSP_FW_RX_ANC] =   "Rx ANC",
371 	[WM_ADSP_FW_CTRL] =     "Voice Ctrl",
372 	[WM_ADSP_FW_ASR] =      "ASR Assist",
373 	[WM_ADSP_FW_TRACE] =    "Dbg Trace",
374 	[WM_ADSP_FW_SPK_PROT] = "Protection",
375 	[WM_ADSP_FW_SPK_CALI] = "Calibration",
376 	[WM_ADSP_FW_SPK_DIAG] = "Diagnostic",
377 	[WM_ADSP_FW_MISC] =     "Misc",
378 };
379 
380 struct wm_adsp_system_config_xm_hdr {
381 	__be32 sys_enable;
382 	__be32 fw_id;
383 	__be32 fw_rev;
384 	__be32 boot_status;
385 	__be32 watchdog;
386 	__be32 dma_buffer_size;
387 	__be32 rdma[6];
388 	__be32 wdma[8];
389 	__be32 build_job_name[3];
390 	__be32 build_job_number;
391 };
392 
393 struct wm_halo_system_config_xm_hdr {
394 	__be32 halo_heartbeat;
395 	__be32 build_job_name[3];
396 	__be32 build_job_number;
397 };
398 
399 struct wm_adsp_alg_xm_struct {
400 	__be32 magic;
401 	__be32 smoothing;
402 	__be32 threshold;
403 	__be32 host_buf_ptr;
404 	__be32 start_seq;
405 	__be32 high_water_mark;
406 	__be32 low_water_mark;
407 	__be64 smoothed_power;
408 };
409 
410 struct wm_adsp_host_buf_coeff_v1 {
411 	__be32 host_buf_ptr;		/* Host buffer pointer */
412 	__be32 versions;		/* Version numbers */
413 	__be32 name[4];			/* The buffer name */
414 };
415 
416 struct wm_adsp_buffer {
417 	__be32 buf1_base;		/* Base addr of first buffer area */
418 	__be32 buf1_size;		/* Size of buf1 area in DSP words */
419 	__be32 buf2_base;		/* Base addr of 2nd buffer area */
420 	__be32 buf1_buf2_size;		/* Size of buf1+buf2 in DSP words */
421 	__be32 buf3_base;		/* Base addr of buf3 area */
422 	__be32 buf_total_size;		/* Size of buf1+buf2+buf3 in DSP words */
423 	__be32 high_water_mark;		/* Point at which IRQ is asserted */
424 	__be32 irq_count;		/* bits 1-31 count IRQ assertions */
425 	__be32 irq_ack;			/* acked IRQ count, bit 0 enables IRQ */
426 	__be32 next_write_index;	/* word index of next write */
427 	__be32 next_read_index;		/* word index of next read */
428 	__be32 error;			/* error if any */
429 	__be32 oldest_block_index;	/* word index of oldest surviving */
430 	__be32 requested_rewind;	/* how many blocks rewind was done */
431 	__be32 reserved_space;		/* internal */
432 	__be32 min_free;		/* min free space since stream start */
433 	__be32 blocks_written[2];	/* total blocks written (64 bit) */
434 	__be32 words_written[2];	/* total words written (64 bit) */
435 };
436 
437 struct wm_adsp_compr;
438 
439 struct wm_adsp_compr_buf {
440 	struct list_head list;
441 	struct wm_adsp *dsp;
442 	struct wm_adsp_compr *compr;
443 
444 	struct wm_adsp_buffer_region *regions;
445 	u32 host_buf_ptr;
446 
447 	u32 error;
448 	u32 irq_count;
449 	int read_index;
450 	int avail;
451 	int host_buf_mem_type;
452 
453 	char *name;
454 };
455 
456 struct wm_adsp_compr {
457 	struct list_head list;
458 	struct wm_adsp *dsp;
459 	struct wm_adsp_compr_buf *buf;
460 
461 	struct snd_compr_stream *stream;
462 	struct snd_compressed_buffer size;
463 
464 	u32 *raw_buf;
465 	unsigned int copied_total;
466 
467 	unsigned int sample_rate;
468 
469 	const char *name;
470 };
471 
472 #define WM_ADSP_DATA_WORD_SIZE         3
473 
474 #define WM_ADSP_MIN_FRAGMENTS          1
475 #define WM_ADSP_MAX_FRAGMENTS          256
476 #define WM_ADSP_MIN_FRAGMENT_SIZE      (64 * WM_ADSP_DATA_WORD_SIZE)
477 #define WM_ADSP_MAX_FRAGMENT_SIZE      (4096 * WM_ADSP_DATA_WORD_SIZE)
478 
479 #define WM_ADSP_ALG_XM_STRUCT_MAGIC    0x49aec7
480 
481 #define HOST_BUFFER_FIELD(field) \
482 	(offsetof(struct wm_adsp_buffer, field) / sizeof(__be32))
483 
484 #define ALG_XM_FIELD(field) \
485 	(offsetof(struct wm_adsp_alg_xm_struct, field) / sizeof(__be32))
486 
487 #define HOST_BUF_COEFF_SUPPORTED_COMPAT_VER	1
488 
489 #define HOST_BUF_COEFF_COMPAT_VER_MASK		0xFF00
490 #define HOST_BUF_COEFF_COMPAT_VER_SHIFT		8
491 
492 static int wm_adsp_buffer_init(struct wm_adsp *dsp);
493 static int wm_adsp_buffer_free(struct wm_adsp *dsp);
494 
495 struct wm_adsp_buffer_region {
496 	unsigned int offset;
497 	unsigned int cumulative_size;
498 	unsigned int mem_type;
499 	unsigned int base_addr;
500 };
501 
502 struct wm_adsp_buffer_region_def {
503 	unsigned int mem_type;
504 	unsigned int base_offset;
505 	unsigned int size_offset;
506 };
507 
508 static const struct wm_adsp_buffer_region_def default_regions[] = {
509 	{
510 		.mem_type = WMFW_ADSP2_XM,
511 		.base_offset = HOST_BUFFER_FIELD(buf1_base),
512 		.size_offset = HOST_BUFFER_FIELD(buf1_size),
513 	},
514 	{
515 		.mem_type = WMFW_ADSP2_XM,
516 		.base_offset = HOST_BUFFER_FIELD(buf2_base),
517 		.size_offset = HOST_BUFFER_FIELD(buf1_buf2_size),
518 	},
519 	{
520 		.mem_type = WMFW_ADSP2_YM,
521 		.base_offset = HOST_BUFFER_FIELD(buf3_base),
522 		.size_offset = HOST_BUFFER_FIELD(buf_total_size),
523 	},
524 };
525 
526 struct wm_adsp_fw_caps {
527 	u32 id;
528 	struct snd_codec_desc desc;
529 	int num_regions;
530 	const struct wm_adsp_buffer_region_def *region_defs;
531 };
532 
533 static const struct wm_adsp_fw_caps ctrl_caps[] = {
534 	{
535 		.id = SND_AUDIOCODEC_BESPOKE,
536 		.desc = {
537 			.max_ch = 8,
538 			.sample_rates = { 16000 },
539 			.num_sample_rates = 1,
540 			.formats = SNDRV_PCM_FMTBIT_S16_LE,
541 		},
542 		.num_regions = ARRAY_SIZE(default_regions),
543 		.region_defs = default_regions,
544 	},
545 };
546 
547 static const struct wm_adsp_fw_caps trace_caps[] = {
548 	{
549 		.id = SND_AUDIOCODEC_BESPOKE,
550 		.desc = {
551 			.max_ch = 8,
552 			.sample_rates = {
553 				4000, 8000, 11025, 12000, 16000, 22050,
554 				24000, 32000, 44100, 48000, 64000, 88200,
555 				96000, 176400, 192000
556 			},
557 			.num_sample_rates = 15,
558 			.formats = SNDRV_PCM_FMTBIT_S16_LE,
559 		},
560 		.num_regions = ARRAY_SIZE(default_regions),
561 		.region_defs = default_regions,
562 	},
563 };
564 
565 static const struct {
566 	const char *file;
567 	int compr_direction;
568 	int num_caps;
569 	const struct wm_adsp_fw_caps *caps;
570 	bool voice_trigger;
571 } wm_adsp_fw[WM_ADSP_NUM_FW] = {
572 	[WM_ADSP_FW_MBC_VSS] =  { .file = "mbc-vss" },
573 	[WM_ADSP_FW_HIFI] =     { .file = "hifi" },
574 	[WM_ADSP_FW_TX] =       { .file = "tx" },
575 	[WM_ADSP_FW_TX_SPK] =   { .file = "tx-spk" },
576 	[WM_ADSP_FW_RX] =       { .file = "rx" },
577 	[WM_ADSP_FW_RX_ANC] =   { .file = "rx-anc" },
578 	[WM_ADSP_FW_CTRL] =     {
579 		.file = "ctrl",
580 		.compr_direction = SND_COMPRESS_CAPTURE,
581 		.num_caps = ARRAY_SIZE(ctrl_caps),
582 		.caps = ctrl_caps,
583 		.voice_trigger = true,
584 	},
585 	[WM_ADSP_FW_ASR] =      { .file = "asr" },
586 	[WM_ADSP_FW_TRACE] =    {
587 		.file = "trace",
588 		.compr_direction = SND_COMPRESS_CAPTURE,
589 		.num_caps = ARRAY_SIZE(trace_caps),
590 		.caps = trace_caps,
591 	},
592 	[WM_ADSP_FW_SPK_PROT] = { .file = "spk-prot" },
593 	[WM_ADSP_FW_SPK_CALI] = { .file = "spk-cali" },
594 	[WM_ADSP_FW_SPK_DIAG] = { .file = "spk-diag" },
595 	[WM_ADSP_FW_MISC] =     { .file = "misc" },
596 };
597 
598 struct wm_coeff_ctl_ops {
599 	int (*xget)(struct snd_kcontrol *kcontrol,
600 		    struct snd_ctl_elem_value *ucontrol);
601 	int (*xput)(struct snd_kcontrol *kcontrol,
602 		    struct snd_ctl_elem_value *ucontrol);
603 };
604 
605 struct wm_coeff_ctl {
606 	const char *name;
607 	const char *fw_name;
608 	/* Subname is needed to match with firmware */
609 	const char *subname;
610 	unsigned int subname_len;
611 	struct wm_adsp_alg_region alg_region;
612 	struct wm_coeff_ctl_ops ops;
613 	struct wm_adsp *dsp;
614 	unsigned int enabled:1;
615 	struct list_head list;
616 	void *cache;
617 	unsigned int offset;
618 	size_t len;
619 	unsigned int set:1;
620 	struct soc_bytes_ext bytes_ext;
621 	unsigned int flags;
622 	snd_ctl_elem_type_t type;
623 };
624 
625 static const char *wm_adsp_mem_region_name(unsigned int type)
626 {
627 	switch (type) {
628 	case WMFW_ADSP1_PM:
629 		return "PM";
630 	case WMFW_HALO_PM_PACKED:
631 		return "PM_PACKED";
632 	case WMFW_ADSP1_DM:
633 		return "DM";
634 	case WMFW_ADSP2_XM:
635 		return "XM";
636 	case WMFW_HALO_XM_PACKED:
637 		return "XM_PACKED";
638 	case WMFW_ADSP2_YM:
639 		return "YM";
640 	case WMFW_HALO_YM_PACKED:
641 		return "YM_PACKED";
642 	case WMFW_ADSP1_ZM:
643 		return "ZM";
644 	default:
645 		return NULL;
646 	}
647 }
648 
649 #ifdef CONFIG_DEBUG_FS
650 static void wm_adsp_debugfs_save_wmfwname(struct wm_adsp *dsp, const char *s)
651 {
652 	char *tmp = kasprintf(GFP_KERNEL, "%s\n", s);
653 
654 	kfree(dsp->wmfw_file_name);
655 	dsp->wmfw_file_name = tmp;
656 }
657 
658 static void wm_adsp_debugfs_save_binname(struct wm_adsp *dsp, const char *s)
659 {
660 	char *tmp = kasprintf(GFP_KERNEL, "%s\n", s);
661 
662 	kfree(dsp->bin_file_name);
663 	dsp->bin_file_name = tmp;
664 }
665 
666 static void wm_adsp_debugfs_clear(struct wm_adsp *dsp)
667 {
668 	kfree(dsp->wmfw_file_name);
669 	kfree(dsp->bin_file_name);
670 	dsp->wmfw_file_name = NULL;
671 	dsp->bin_file_name = NULL;
672 }
673 
674 static ssize_t wm_adsp_debugfs_wmfw_read(struct file *file,
675 					 char __user *user_buf,
676 					 size_t count, loff_t *ppos)
677 {
678 	struct wm_adsp *dsp = file->private_data;
679 	ssize_t ret;
680 
681 	mutex_lock(&dsp->pwr_lock);
682 
683 	if (!dsp->wmfw_file_name || !dsp->booted)
684 		ret = 0;
685 	else
686 		ret = simple_read_from_buffer(user_buf, count, ppos,
687 					      dsp->wmfw_file_name,
688 					      strlen(dsp->wmfw_file_name));
689 
690 	mutex_unlock(&dsp->pwr_lock);
691 	return ret;
692 }
693 
694 static ssize_t wm_adsp_debugfs_bin_read(struct file *file,
695 					char __user *user_buf,
696 					size_t count, loff_t *ppos)
697 {
698 	struct wm_adsp *dsp = file->private_data;
699 	ssize_t ret;
700 
701 	mutex_lock(&dsp->pwr_lock);
702 
703 	if (!dsp->bin_file_name || !dsp->booted)
704 		ret = 0;
705 	else
706 		ret = simple_read_from_buffer(user_buf, count, ppos,
707 					      dsp->bin_file_name,
708 					      strlen(dsp->bin_file_name));
709 
710 	mutex_unlock(&dsp->pwr_lock);
711 	return ret;
712 }
713 
714 static const struct {
715 	const char *name;
716 	const struct file_operations fops;
717 } wm_adsp_debugfs_fops[] = {
718 	{
719 		.name = "wmfw_file_name",
720 		.fops = {
721 			.open = simple_open,
722 			.read = wm_adsp_debugfs_wmfw_read,
723 		},
724 	},
725 	{
726 		.name = "bin_file_name",
727 		.fops = {
728 			.open = simple_open,
729 			.read = wm_adsp_debugfs_bin_read,
730 		},
731 	},
732 };
733 
734 static void wm_adsp2_init_debugfs(struct wm_adsp *dsp,
735 				  struct snd_soc_component *component)
736 {
737 	struct dentry *root = NULL;
738 	int i;
739 
740 	root = debugfs_create_dir(dsp->name, component->debugfs_root);
741 
742 	debugfs_create_bool("booted", 0444, root, &dsp->booted);
743 	debugfs_create_bool("running", 0444, root, &dsp->running);
744 	debugfs_create_x32("fw_id", 0444, root, &dsp->fw_id);
745 	debugfs_create_x32("fw_version", 0444, root, &dsp->fw_id_version);
746 
747 	for (i = 0; i < ARRAY_SIZE(wm_adsp_debugfs_fops); ++i)
748 		debugfs_create_file(wm_adsp_debugfs_fops[i].name, 0444, root,
749 				    dsp, &wm_adsp_debugfs_fops[i].fops);
750 
751 	dsp->debugfs_root = root;
752 }
753 
754 static void wm_adsp2_cleanup_debugfs(struct wm_adsp *dsp)
755 {
756 	wm_adsp_debugfs_clear(dsp);
757 	debugfs_remove_recursive(dsp->debugfs_root);
758 }
759 #else
760 static inline void wm_adsp2_init_debugfs(struct wm_adsp *dsp,
761 					 struct snd_soc_component *component)
762 {
763 }
764 
765 static inline void wm_adsp2_cleanup_debugfs(struct wm_adsp *dsp)
766 {
767 }
768 
769 static inline void wm_adsp_debugfs_save_wmfwname(struct wm_adsp *dsp,
770 						 const char *s)
771 {
772 }
773 
774 static inline void wm_adsp_debugfs_save_binname(struct wm_adsp *dsp,
775 						const char *s)
776 {
777 }
778 
779 static inline void wm_adsp_debugfs_clear(struct wm_adsp *dsp)
780 {
781 }
782 #endif
783 
784 int wm_adsp_fw_get(struct snd_kcontrol *kcontrol,
785 		   struct snd_ctl_elem_value *ucontrol)
786 {
787 	struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
788 	struct soc_enum *e = (struct soc_enum *)kcontrol->private_value;
789 	struct wm_adsp *dsp = snd_soc_component_get_drvdata(component);
790 
791 	ucontrol->value.enumerated.item[0] = dsp[e->shift_l].fw;
792 
793 	return 0;
794 }
795 EXPORT_SYMBOL_GPL(wm_adsp_fw_get);
796 
797 int wm_adsp_fw_put(struct snd_kcontrol *kcontrol,
798 		   struct snd_ctl_elem_value *ucontrol)
799 {
800 	struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
801 	struct soc_enum *e = (struct soc_enum *)kcontrol->private_value;
802 	struct wm_adsp *dsp = snd_soc_component_get_drvdata(component);
803 	int ret = 0;
804 
805 	if (ucontrol->value.enumerated.item[0] == dsp[e->shift_l].fw)
806 		return 0;
807 
808 	if (ucontrol->value.enumerated.item[0] >= WM_ADSP_NUM_FW)
809 		return -EINVAL;
810 
811 	mutex_lock(&dsp[e->shift_l].pwr_lock);
812 
813 	if (dsp[e->shift_l].booted || !list_empty(&dsp[e->shift_l].compr_list))
814 		ret = -EBUSY;
815 	else
816 		dsp[e->shift_l].fw = ucontrol->value.enumerated.item[0];
817 
818 	mutex_unlock(&dsp[e->shift_l].pwr_lock);
819 
820 	return ret;
821 }
822 EXPORT_SYMBOL_GPL(wm_adsp_fw_put);
823 
824 const struct soc_enum wm_adsp_fw_enum[] = {
825 	SOC_ENUM_SINGLE(0, 0, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
826 	SOC_ENUM_SINGLE(0, 1, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
827 	SOC_ENUM_SINGLE(0, 2, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
828 	SOC_ENUM_SINGLE(0, 3, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
829 	SOC_ENUM_SINGLE(0, 4, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
830 	SOC_ENUM_SINGLE(0, 5, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
831 	SOC_ENUM_SINGLE(0, 6, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
832 };
833 EXPORT_SYMBOL_GPL(wm_adsp_fw_enum);
834 
835 static struct wm_adsp_region const *wm_adsp_find_region(struct wm_adsp *dsp,
836 							int type)
837 {
838 	int i;
839 
840 	for (i = 0; i < dsp->num_mems; i++)
841 		if (dsp->mem[i].type == type)
842 			return &dsp->mem[i];
843 
844 	return NULL;
845 }
846 
847 static unsigned int wm_adsp_region_to_reg(struct wm_adsp_region const *mem,
848 					  unsigned int offset)
849 {
850 	switch (mem->type) {
851 	case WMFW_ADSP1_PM:
852 		return mem->base + (offset * 3);
853 	case WMFW_ADSP1_DM:
854 	case WMFW_ADSP2_XM:
855 	case WMFW_ADSP2_YM:
856 	case WMFW_ADSP1_ZM:
857 		return mem->base + (offset * 2);
858 	default:
859 		WARN(1, "Unknown memory region type");
860 		return offset;
861 	}
862 }
863 
864 static unsigned int wm_halo_region_to_reg(struct wm_adsp_region const *mem,
865 					  unsigned int offset)
866 {
867 	switch (mem->type) {
868 	case WMFW_ADSP2_XM:
869 	case WMFW_ADSP2_YM:
870 		return mem->base + (offset * 4);
871 	case WMFW_HALO_XM_PACKED:
872 	case WMFW_HALO_YM_PACKED:
873 		return (mem->base + (offset * 3)) & ~0x3;
874 	case WMFW_HALO_PM_PACKED:
875 		return mem->base + (offset * 5);
876 	default:
877 		WARN(1, "Unknown memory region type");
878 		return offset;
879 	}
880 }
881 
882 static void wm_adsp_read_fw_status(struct wm_adsp *dsp,
883 				   int noffs, unsigned int *offs)
884 {
885 	unsigned int i;
886 	int ret;
887 
888 	for (i = 0; i < noffs; ++i) {
889 		ret = regmap_read(dsp->regmap, dsp->base + offs[i], &offs[i]);
890 		if (ret) {
891 			adsp_err(dsp, "Failed to read SCRATCH%u: %d\n", i, ret);
892 			return;
893 		}
894 	}
895 }
896 
897 static void wm_adsp2_show_fw_status(struct wm_adsp *dsp)
898 {
899 	unsigned int offs[] = {
900 		ADSP2_SCRATCH0, ADSP2_SCRATCH1, ADSP2_SCRATCH2, ADSP2_SCRATCH3,
901 	};
902 
903 	wm_adsp_read_fw_status(dsp, ARRAY_SIZE(offs), offs);
904 
905 	adsp_dbg(dsp, "FW SCRATCH 0:0x%x 1:0x%x 2:0x%x 3:0x%x\n",
906 		 offs[0], offs[1], offs[2], offs[3]);
907 }
908 
909 static void wm_adsp2v2_show_fw_status(struct wm_adsp *dsp)
910 {
911 	unsigned int offs[] = { ADSP2V2_SCRATCH0_1, ADSP2V2_SCRATCH2_3 };
912 
913 	wm_adsp_read_fw_status(dsp, ARRAY_SIZE(offs), offs);
914 
915 	adsp_dbg(dsp, "FW SCRATCH 0:0x%x 1:0x%x 2:0x%x 3:0x%x\n",
916 		 offs[0] & 0xFFFF, offs[0] >> 16,
917 		 offs[1] & 0xFFFF, offs[1] >> 16);
918 }
919 
920 static void wm_halo_show_fw_status(struct wm_adsp *dsp)
921 {
922 	unsigned int offs[] = {
923 		HALO_SCRATCH1, HALO_SCRATCH2, HALO_SCRATCH3, HALO_SCRATCH4,
924 	};
925 
926 	wm_adsp_read_fw_status(dsp, ARRAY_SIZE(offs), offs);
927 
928 	adsp_dbg(dsp, "FW SCRATCH 0:0x%x 1:0x%x 2:0x%x 3:0x%x\n",
929 		 offs[0], offs[1], offs[2], offs[3]);
930 }
931 
932 static inline struct wm_coeff_ctl *bytes_ext_to_ctl(struct soc_bytes_ext *ext)
933 {
934 	return container_of(ext, struct wm_coeff_ctl, bytes_ext);
935 }
936 
937 static int wm_coeff_base_reg(struct wm_coeff_ctl *ctl, unsigned int *reg)
938 {
939 	const struct wm_adsp_alg_region *alg_region = &ctl->alg_region;
940 	struct wm_adsp *dsp = ctl->dsp;
941 	const struct wm_adsp_region *mem;
942 
943 	mem = wm_adsp_find_region(dsp, alg_region->type);
944 	if (!mem) {
945 		adsp_err(dsp, "No base for region %x\n",
946 			 alg_region->type);
947 		return -EINVAL;
948 	}
949 
950 	*reg = dsp->ops->region_to_reg(mem, ctl->alg_region.base + ctl->offset);
951 
952 	return 0;
953 }
954 
955 static int wm_coeff_info(struct snd_kcontrol *kctl,
956 			 struct snd_ctl_elem_info *uinfo)
957 {
958 	struct soc_bytes_ext *bytes_ext =
959 		(struct soc_bytes_ext *)kctl->private_value;
960 	struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
961 
962 	switch (ctl->type) {
963 	case WMFW_CTL_TYPE_ACKED:
964 		uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
965 		uinfo->value.integer.min = WM_ADSP_ACKED_CTL_MIN_VALUE;
966 		uinfo->value.integer.max = WM_ADSP_ACKED_CTL_MAX_VALUE;
967 		uinfo->value.integer.step = 1;
968 		uinfo->count = 1;
969 		break;
970 	default:
971 		uinfo->type = SNDRV_CTL_ELEM_TYPE_BYTES;
972 		uinfo->count = ctl->len;
973 		break;
974 	}
975 
976 	return 0;
977 }
978 
979 static int wm_coeff_write_acked_control(struct wm_coeff_ctl *ctl,
980 					unsigned int event_id)
981 {
982 	struct wm_adsp *dsp = ctl->dsp;
983 	__be32 val = cpu_to_be32(event_id);
984 	unsigned int reg;
985 	int i, ret;
986 
987 	ret = wm_coeff_base_reg(ctl, &reg);
988 	if (ret)
989 		return ret;
990 
991 	adsp_dbg(dsp, "Sending 0x%x to acked control alg 0x%x %s:0x%x\n",
992 		 event_id, ctl->alg_region.alg,
993 		 wm_adsp_mem_region_name(ctl->alg_region.type), ctl->offset);
994 
995 	ret = regmap_raw_write(dsp->regmap, reg, &val, sizeof(val));
996 	if (ret) {
997 		adsp_err(dsp, "Failed to write %x: %d\n", reg, ret);
998 		return ret;
999 	}
1000 
1001 	/*
1002 	 * Poll for ack, we initially poll at ~1ms intervals for firmwares
1003 	 * that respond quickly, then go to ~10ms polls. A firmware is unlikely
1004 	 * to ack instantly so we do the first 1ms delay before reading the
1005 	 * control to avoid a pointless bus transaction
1006 	 */
1007 	for (i = 0; i < WM_ADSP_ACKED_CTL_TIMEOUT_MS;) {
1008 		switch (i) {
1009 		case 0 ... WM_ADSP_ACKED_CTL_N_QUICKPOLLS - 1:
1010 			usleep_range(1000, 2000);
1011 			i++;
1012 			break;
1013 		default:
1014 			usleep_range(10000, 20000);
1015 			i += 10;
1016 			break;
1017 		}
1018 
1019 		ret = regmap_raw_read(dsp->regmap, reg, &val, sizeof(val));
1020 		if (ret) {
1021 			adsp_err(dsp, "Failed to read %x: %d\n", reg, ret);
1022 			return ret;
1023 		}
1024 
1025 		if (val == 0) {
1026 			adsp_dbg(dsp, "Acked control ACKED at poll %u\n", i);
1027 			return 0;
1028 		}
1029 	}
1030 
1031 	adsp_warn(dsp, "Acked control @0x%x alg:0x%x %s:0x%x timed out\n",
1032 		  reg, ctl->alg_region.alg,
1033 		  wm_adsp_mem_region_name(ctl->alg_region.type),
1034 		  ctl->offset);
1035 
1036 	return -ETIMEDOUT;
1037 }
1038 
1039 static int wm_coeff_write_ctrl_raw(struct wm_coeff_ctl *ctl,
1040 				   const void *buf, size_t len)
1041 {
1042 	struct wm_adsp *dsp = ctl->dsp;
1043 	void *scratch;
1044 	int ret;
1045 	unsigned int reg;
1046 
1047 	ret = wm_coeff_base_reg(ctl, &reg);
1048 	if (ret)
1049 		return ret;
1050 
1051 	scratch = kmemdup(buf, len, GFP_KERNEL | GFP_DMA);
1052 	if (!scratch)
1053 		return -ENOMEM;
1054 
1055 	ret = regmap_raw_write(dsp->regmap, reg, scratch,
1056 			       len);
1057 	if (ret) {
1058 		adsp_err(dsp, "Failed to write %zu bytes to %x: %d\n",
1059 			 len, reg, ret);
1060 		kfree(scratch);
1061 		return ret;
1062 	}
1063 	adsp_dbg(dsp, "Wrote %zu bytes to %x\n", len, reg);
1064 
1065 	kfree(scratch);
1066 
1067 	return 0;
1068 }
1069 
1070 static int wm_coeff_write_ctrl(struct wm_coeff_ctl *ctl,
1071 			       const void *buf, size_t len)
1072 {
1073 	int ret = 0;
1074 
1075 	if (ctl->flags & WMFW_CTL_FLAG_VOLATILE)
1076 		ret = -EPERM;
1077 	else if (buf != ctl->cache)
1078 		memcpy(ctl->cache, buf, len);
1079 
1080 	ctl->set = 1;
1081 	if (ctl->enabled && ctl->dsp->running)
1082 		ret = wm_coeff_write_ctrl_raw(ctl, buf, len);
1083 
1084 	return ret;
1085 }
1086 
1087 static int wm_coeff_put(struct snd_kcontrol *kctl,
1088 			struct snd_ctl_elem_value *ucontrol)
1089 {
1090 	struct soc_bytes_ext *bytes_ext =
1091 		(struct soc_bytes_ext *)kctl->private_value;
1092 	struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
1093 	char *p = ucontrol->value.bytes.data;
1094 	int ret = 0;
1095 
1096 	mutex_lock(&ctl->dsp->pwr_lock);
1097 	ret = wm_coeff_write_ctrl(ctl, p, ctl->len);
1098 	mutex_unlock(&ctl->dsp->pwr_lock);
1099 
1100 	return ret;
1101 }
1102 
1103 static int wm_coeff_tlv_put(struct snd_kcontrol *kctl,
1104 			    const unsigned int __user *bytes, unsigned int size)
1105 {
1106 	struct soc_bytes_ext *bytes_ext =
1107 		(struct soc_bytes_ext *)kctl->private_value;
1108 	struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
1109 	int ret = 0;
1110 
1111 	mutex_lock(&ctl->dsp->pwr_lock);
1112 
1113 	if (copy_from_user(ctl->cache, bytes, size))
1114 		ret = -EFAULT;
1115 	else
1116 		ret = wm_coeff_write_ctrl(ctl, ctl->cache, size);
1117 
1118 	mutex_unlock(&ctl->dsp->pwr_lock);
1119 
1120 	return ret;
1121 }
1122 
1123 static int wm_coeff_put_acked(struct snd_kcontrol *kctl,
1124 			      struct snd_ctl_elem_value *ucontrol)
1125 {
1126 	struct soc_bytes_ext *bytes_ext =
1127 		(struct soc_bytes_ext *)kctl->private_value;
1128 	struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
1129 	unsigned int val = ucontrol->value.integer.value[0];
1130 	int ret;
1131 
1132 	if (val == 0)
1133 		return 0;	/* 0 means no event */
1134 
1135 	mutex_lock(&ctl->dsp->pwr_lock);
1136 
1137 	if (ctl->enabled && ctl->dsp->running)
1138 		ret = wm_coeff_write_acked_control(ctl, val);
1139 	else
1140 		ret = -EPERM;
1141 
1142 	mutex_unlock(&ctl->dsp->pwr_lock);
1143 
1144 	return ret;
1145 }
1146 
1147 static int wm_coeff_read_ctrl_raw(struct wm_coeff_ctl *ctl,
1148 				  void *buf, size_t len)
1149 {
1150 	struct wm_adsp *dsp = ctl->dsp;
1151 	void *scratch;
1152 	int ret;
1153 	unsigned int reg;
1154 
1155 	ret = wm_coeff_base_reg(ctl, &reg);
1156 	if (ret)
1157 		return ret;
1158 
1159 	scratch = kmalloc(len, GFP_KERNEL | GFP_DMA);
1160 	if (!scratch)
1161 		return -ENOMEM;
1162 
1163 	ret = regmap_raw_read(dsp->regmap, reg, scratch, len);
1164 	if (ret) {
1165 		adsp_err(dsp, "Failed to read %zu bytes from %x: %d\n",
1166 			 len, reg, ret);
1167 		kfree(scratch);
1168 		return ret;
1169 	}
1170 	adsp_dbg(dsp, "Read %zu bytes from %x\n", len, reg);
1171 
1172 	memcpy(buf, scratch, len);
1173 	kfree(scratch);
1174 
1175 	return 0;
1176 }
1177 
1178 static int wm_coeff_read_ctrl(struct wm_coeff_ctl *ctl, void *buf, size_t len)
1179 {
1180 	int ret = 0;
1181 
1182 	if (ctl->flags & WMFW_CTL_FLAG_VOLATILE) {
1183 		if (ctl->enabled && ctl->dsp->running)
1184 			return wm_coeff_read_ctrl_raw(ctl, buf, len);
1185 		else
1186 			return -EPERM;
1187 	} else {
1188 		if (!ctl->flags && ctl->enabled && ctl->dsp->running)
1189 			ret = wm_coeff_read_ctrl_raw(ctl, ctl->cache, ctl->len);
1190 
1191 		if (buf != ctl->cache)
1192 			memcpy(buf, ctl->cache, len);
1193 	}
1194 
1195 	return ret;
1196 }
1197 
1198 static int wm_coeff_get(struct snd_kcontrol *kctl,
1199 			struct snd_ctl_elem_value *ucontrol)
1200 {
1201 	struct soc_bytes_ext *bytes_ext =
1202 		(struct soc_bytes_ext *)kctl->private_value;
1203 	struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
1204 	char *p = ucontrol->value.bytes.data;
1205 	int ret;
1206 
1207 	mutex_lock(&ctl->dsp->pwr_lock);
1208 	ret = wm_coeff_read_ctrl(ctl, p, ctl->len);
1209 	mutex_unlock(&ctl->dsp->pwr_lock);
1210 
1211 	return ret;
1212 }
1213 
1214 static int wm_coeff_tlv_get(struct snd_kcontrol *kctl,
1215 			    unsigned int __user *bytes, unsigned int size)
1216 {
1217 	struct soc_bytes_ext *bytes_ext =
1218 		(struct soc_bytes_ext *)kctl->private_value;
1219 	struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
1220 	int ret = 0;
1221 
1222 	mutex_lock(&ctl->dsp->pwr_lock);
1223 
1224 	ret = wm_coeff_read_ctrl_raw(ctl, ctl->cache, size);
1225 
1226 	if (!ret && copy_to_user(bytes, ctl->cache, size))
1227 		ret = -EFAULT;
1228 
1229 	mutex_unlock(&ctl->dsp->pwr_lock);
1230 
1231 	return ret;
1232 }
1233 
1234 static int wm_coeff_get_acked(struct snd_kcontrol *kcontrol,
1235 			      struct snd_ctl_elem_value *ucontrol)
1236 {
1237 	/*
1238 	 * Although it's not useful to read an acked control, we must satisfy
1239 	 * user-side assumptions that all controls are readable and that a
1240 	 * write of the same value should be filtered out (it's valid to send
1241 	 * the same event number again to the firmware). We therefore return 0,
1242 	 * meaning "no event" so valid event numbers will always be a change
1243 	 */
1244 	ucontrol->value.integer.value[0] = 0;
1245 
1246 	return 0;
1247 }
1248 
1249 struct wmfw_ctl_work {
1250 	struct wm_adsp *dsp;
1251 	struct wm_coeff_ctl *ctl;
1252 	struct work_struct work;
1253 };
1254 
1255 static unsigned int wmfw_convert_flags(unsigned int in, unsigned int len)
1256 {
1257 	unsigned int out, rd, wr, vol;
1258 
1259 	if (len > ADSP_MAX_STD_CTRL_SIZE) {
1260 		rd = SNDRV_CTL_ELEM_ACCESS_TLV_READ;
1261 		wr = SNDRV_CTL_ELEM_ACCESS_TLV_WRITE;
1262 		vol = SNDRV_CTL_ELEM_ACCESS_VOLATILE;
1263 
1264 		out = SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1265 	} else {
1266 		rd = SNDRV_CTL_ELEM_ACCESS_READ;
1267 		wr = SNDRV_CTL_ELEM_ACCESS_WRITE;
1268 		vol = SNDRV_CTL_ELEM_ACCESS_VOLATILE;
1269 
1270 		out = 0;
1271 	}
1272 
1273 	if (in) {
1274 		out |= rd;
1275 		if (in & WMFW_CTL_FLAG_WRITEABLE)
1276 			out |= wr;
1277 		if (in & WMFW_CTL_FLAG_VOLATILE)
1278 			out |= vol;
1279 	} else {
1280 		out |= rd | wr | vol;
1281 	}
1282 
1283 	return out;
1284 }
1285 
1286 static int wmfw_add_ctl(struct wm_adsp *dsp, struct wm_coeff_ctl *ctl)
1287 {
1288 	struct snd_kcontrol_new *kcontrol;
1289 	int ret;
1290 
1291 	if (!ctl || !ctl->name)
1292 		return -EINVAL;
1293 
1294 	kcontrol = kzalloc(sizeof(*kcontrol), GFP_KERNEL);
1295 	if (!kcontrol)
1296 		return -ENOMEM;
1297 
1298 	kcontrol->name = ctl->name;
1299 	kcontrol->info = wm_coeff_info;
1300 	kcontrol->iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1301 	kcontrol->tlv.c = snd_soc_bytes_tlv_callback;
1302 	kcontrol->private_value = (unsigned long)&ctl->bytes_ext;
1303 	kcontrol->access = wmfw_convert_flags(ctl->flags, ctl->len);
1304 
1305 	switch (ctl->type) {
1306 	case WMFW_CTL_TYPE_ACKED:
1307 		kcontrol->get = wm_coeff_get_acked;
1308 		kcontrol->put = wm_coeff_put_acked;
1309 		break;
1310 	default:
1311 		if (kcontrol->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
1312 			ctl->bytes_ext.max = ctl->len;
1313 			ctl->bytes_ext.get = wm_coeff_tlv_get;
1314 			ctl->bytes_ext.put = wm_coeff_tlv_put;
1315 		} else {
1316 			kcontrol->get = wm_coeff_get;
1317 			kcontrol->put = wm_coeff_put;
1318 		}
1319 		break;
1320 	}
1321 
1322 	ret = snd_soc_add_component_controls(dsp->component, kcontrol, 1);
1323 	if (ret < 0)
1324 		goto err_kcontrol;
1325 
1326 	kfree(kcontrol);
1327 
1328 	return 0;
1329 
1330 err_kcontrol:
1331 	kfree(kcontrol);
1332 	return ret;
1333 }
1334 
1335 static int wm_coeff_init_control_caches(struct wm_adsp *dsp)
1336 {
1337 	struct wm_coeff_ctl *ctl;
1338 	int ret;
1339 
1340 	list_for_each_entry(ctl, &dsp->ctl_list, list) {
1341 		if (!ctl->enabled || ctl->set)
1342 			continue;
1343 		if (ctl->flags & WMFW_CTL_FLAG_VOLATILE)
1344 			continue;
1345 
1346 		/*
1347 		 * For readable controls populate the cache from the DSP memory.
1348 		 * For non-readable controls the cache was zero-filled when
1349 		 * created so we don't need to do anything.
1350 		 */
1351 		if (!ctl->flags || (ctl->flags & WMFW_CTL_FLAG_READABLE)) {
1352 			ret = wm_coeff_read_ctrl_raw(ctl, ctl->cache, ctl->len);
1353 			if (ret < 0)
1354 				return ret;
1355 		}
1356 	}
1357 
1358 	return 0;
1359 }
1360 
1361 static int wm_coeff_sync_controls(struct wm_adsp *dsp)
1362 {
1363 	struct wm_coeff_ctl *ctl;
1364 	int ret;
1365 
1366 	list_for_each_entry(ctl, &dsp->ctl_list, list) {
1367 		if (!ctl->enabled)
1368 			continue;
1369 		if (ctl->set && !(ctl->flags & WMFW_CTL_FLAG_VOLATILE)) {
1370 			ret = wm_coeff_write_ctrl_raw(ctl, ctl->cache,
1371 						      ctl->len);
1372 			if (ret < 0)
1373 				return ret;
1374 		}
1375 	}
1376 
1377 	return 0;
1378 }
1379 
1380 static void wm_adsp_signal_event_controls(struct wm_adsp *dsp,
1381 					  unsigned int event)
1382 {
1383 	struct wm_coeff_ctl *ctl;
1384 	int ret;
1385 
1386 	list_for_each_entry(ctl, &dsp->ctl_list, list) {
1387 		if (ctl->type != WMFW_CTL_TYPE_HOSTEVENT)
1388 			continue;
1389 
1390 		if (!ctl->enabled)
1391 			continue;
1392 
1393 		ret = wm_coeff_write_acked_control(ctl, event);
1394 		if (ret)
1395 			adsp_warn(dsp,
1396 				  "Failed to send 0x%x event to alg 0x%x (%d)\n",
1397 				  event, ctl->alg_region.alg, ret);
1398 	}
1399 }
1400 
1401 static void wm_adsp_ctl_work(struct work_struct *work)
1402 {
1403 	struct wmfw_ctl_work *ctl_work = container_of(work,
1404 						      struct wmfw_ctl_work,
1405 						      work);
1406 
1407 	wmfw_add_ctl(ctl_work->dsp, ctl_work->ctl);
1408 	kfree(ctl_work);
1409 }
1410 
1411 static void wm_adsp_free_ctl_blk(struct wm_coeff_ctl *ctl)
1412 {
1413 	kfree(ctl->cache);
1414 	kfree(ctl->name);
1415 	kfree(ctl->subname);
1416 	kfree(ctl);
1417 }
1418 
1419 static int wm_adsp_create_control(struct wm_adsp *dsp,
1420 				  const struct wm_adsp_alg_region *alg_region,
1421 				  unsigned int offset, unsigned int len,
1422 				  const char *subname, unsigned int subname_len,
1423 				  unsigned int flags, snd_ctl_elem_type_t type)
1424 {
1425 	struct wm_coeff_ctl *ctl;
1426 	struct wmfw_ctl_work *ctl_work;
1427 	char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
1428 	const char *region_name;
1429 	int ret;
1430 
1431 	region_name = wm_adsp_mem_region_name(alg_region->type);
1432 	if (!region_name) {
1433 		adsp_err(dsp, "Unknown region type: %d\n", alg_region->type);
1434 		return -EINVAL;
1435 	}
1436 
1437 	switch (dsp->fw_ver) {
1438 	case 0:
1439 	case 1:
1440 		snprintf(name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN, "%s %s %x",
1441 			 dsp->name, region_name, alg_region->alg);
1442 		subname = NULL; /* don't append subname */
1443 		break;
1444 	case 2:
1445 		ret = scnprintf(name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN,
1446 				"%s%c %.12s %x", dsp->name, *region_name,
1447 				wm_adsp_fw_text[dsp->fw], alg_region->alg);
1448 		break;
1449 	default:
1450 		ret = scnprintf(name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN,
1451 				"%s %.12s %x", dsp->name,
1452 				wm_adsp_fw_text[dsp->fw], alg_region->alg);
1453 		break;
1454 	}
1455 
1456 	if (subname) {
1457 		int avail = SNDRV_CTL_ELEM_ID_NAME_MAXLEN - ret - 2;
1458 		int skip = 0;
1459 
1460 		if (dsp->component->name_prefix)
1461 			avail -= strlen(dsp->component->name_prefix) + 1;
1462 
1463 		/* Truncate the subname from the start if it is too long */
1464 		if (subname_len > avail)
1465 			skip = subname_len - avail;
1466 
1467 		snprintf(name + ret, SNDRV_CTL_ELEM_ID_NAME_MAXLEN - ret,
1468 			 " %.*s", subname_len - skip, subname + skip);
1469 	}
1470 
1471 	list_for_each_entry(ctl, &dsp->ctl_list, list) {
1472 		if (!strcmp(ctl->name, name)) {
1473 			if (!ctl->enabled)
1474 				ctl->enabled = 1;
1475 			return 0;
1476 		}
1477 	}
1478 
1479 	ctl = kzalloc(sizeof(*ctl), GFP_KERNEL);
1480 	if (!ctl)
1481 		return -ENOMEM;
1482 	ctl->fw_name = wm_adsp_fw_text[dsp->fw];
1483 	ctl->alg_region = *alg_region;
1484 	ctl->name = kmemdup(name, strlen(name) + 1, GFP_KERNEL);
1485 	if (!ctl->name) {
1486 		ret = -ENOMEM;
1487 		goto err_ctl;
1488 	}
1489 	if (subname) {
1490 		ctl->subname_len = subname_len;
1491 		ctl->subname = kmemdup(subname,
1492 				       strlen(subname) + 1, GFP_KERNEL);
1493 		if (!ctl->subname) {
1494 			ret = -ENOMEM;
1495 			goto err_ctl_name;
1496 		}
1497 	}
1498 	ctl->enabled = 1;
1499 	ctl->set = 0;
1500 	ctl->ops.xget = wm_coeff_get;
1501 	ctl->ops.xput = wm_coeff_put;
1502 	ctl->dsp = dsp;
1503 
1504 	ctl->flags = flags;
1505 	ctl->type = type;
1506 	ctl->offset = offset;
1507 	ctl->len = len;
1508 	ctl->cache = kzalloc(ctl->len, GFP_KERNEL);
1509 	if (!ctl->cache) {
1510 		ret = -ENOMEM;
1511 		goto err_ctl_subname;
1512 	}
1513 
1514 	list_add(&ctl->list, &dsp->ctl_list);
1515 
1516 	if (flags & WMFW_CTL_FLAG_SYS)
1517 		return 0;
1518 
1519 	ctl_work = kzalloc(sizeof(*ctl_work), GFP_KERNEL);
1520 	if (!ctl_work) {
1521 		ret = -ENOMEM;
1522 		goto err_list_del;
1523 	}
1524 
1525 	ctl_work->dsp = dsp;
1526 	ctl_work->ctl = ctl;
1527 	INIT_WORK(&ctl_work->work, wm_adsp_ctl_work);
1528 	schedule_work(&ctl_work->work);
1529 
1530 	return 0;
1531 
1532 err_list_del:
1533 	list_del(&ctl->list);
1534 	kfree(ctl->cache);
1535 err_ctl_subname:
1536 	kfree(ctl->subname);
1537 err_ctl_name:
1538 	kfree(ctl->name);
1539 err_ctl:
1540 	kfree(ctl);
1541 
1542 	return ret;
1543 }
1544 
1545 struct wm_coeff_parsed_alg {
1546 	int id;
1547 	const u8 *name;
1548 	int name_len;
1549 	int ncoeff;
1550 };
1551 
1552 struct wm_coeff_parsed_coeff {
1553 	int offset;
1554 	int mem_type;
1555 	const u8 *name;
1556 	int name_len;
1557 	snd_ctl_elem_type_t ctl_type;
1558 	int flags;
1559 	int len;
1560 };
1561 
1562 static int wm_coeff_parse_string(int bytes, const u8 **pos, const u8 **str)
1563 {
1564 	int length;
1565 
1566 	switch (bytes) {
1567 	case 1:
1568 		length = **pos;
1569 		break;
1570 	case 2:
1571 		length = le16_to_cpu(*((__le16 *)*pos));
1572 		break;
1573 	default:
1574 		return 0;
1575 	}
1576 
1577 	if (str)
1578 		*str = *pos + bytes;
1579 
1580 	*pos += ((length + bytes) + 3) & ~0x03;
1581 
1582 	return length;
1583 }
1584 
1585 static int wm_coeff_parse_int(int bytes, const u8 **pos)
1586 {
1587 	int val = 0;
1588 
1589 	switch (bytes) {
1590 	case 2:
1591 		val = le16_to_cpu(*((__le16 *)*pos));
1592 		break;
1593 	case 4:
1594 		val = le32_to_cpu(*((__le32 *)*pos));
1595 		break;
1596 	default:
1597 		break;
1598 	}
1599 
1600 	*pos += bytes;
1601 
1602 	return val;
1603 }
1604 
1605 static inline void wm_coeff_parse_alg(struct wm_adsp *dsp, const u8 **data,
1606 				      struct wm_coeff_parsed_alg *blk)
1607 {
1608 	const struct wmfw_adsp_alg_data *raw;
1609 
1610 	switch (dsp->fw_ver) {
1611 	case 0:
1612 	case 1:
1613 		raw = (const struct wmfw_adsp_alg_data *)*data;
1614 		*data = raw->data;
1615 
1616 		blk->id = le32_to_cpu(raw->id);
1617 		blk->name = raw->name;
1618 		blk->name_len = strlen(raw->name);
1619 		blk->ncoeff = le32_to_cpu(raw->ncoeff);
1620 		break;
1621 	default:
1622 		blk->id = wm_coeff_parse_int(sizeof(raw->id), data);
1623 		blk->name_len = wm_coeff_parse_string(sizeof(u8), data,
1624 						      &blk->name);
1625 		wm_coeff_parse_string(sizeof(u16), data, NULL);
1626 		blk->ncoeff = wm_coeff_parse_int(sizeof(raw->ncoeff), data);
1627 		break;
1628 	}
1629 
1630 	adsp_dbg(dsp, "Algorithm ID: %#x\n", blk->id);
1631 	adsp_dbg(dsp, "Algorithm name: %.*s\n", blk->name_len, blk->name);
1632 	adsp_dbg(dsp, "# of coefficient descriptors: %#x\n", blk->ncoeff);
1633 }
1634 
1635 static inline void wm_coeff_parse_coeff(struct wm_adsp *dsp, const u8 **data,
1636 					struct wm_coeff_parsed_coeff *blk)
1637 {
1638 	const struct wmfw_adsp_coeff_data *raw;
1639 	const u8 *tmp;
1640 	int length;
1641 
1642 	switch (dsp->fw_ver) {
1643 	case 0:
1644 	case 1:
1645 		raw = (const struct wmfw_adsp_coeff_data *)*data;
1646 		*data = *data + sizeof(raw->hdr) + le32_to_cpu(raw->hdr.size);
1647 
1648 		blk->offset = le16_to_cpu(raw->hdr.offset);
1649 		blk->mem_type = le16_to_cpu(raw->hdr.type);
1650 		blk->name = raw->name;
1651 		blk->name_len = strlen(raw->name);
1652 		blk->ctl_type = (__force snd_ctl_elem_type_t)le16_to_cpu(raw->ctl_type);
1653 		blk->flags = le16_to_cpu(raw->flags);
1654 		blk->len = le32_to_cpu(raw->len);
1655 		break;
1656 	default:
1657 		tmp = *data;
1658 		blk->offset = wm_coeff_parse_int(sizeof(raw->hdr.offset), &tmp);
1659 		blk->mem_type = wm_coeff_parse_int(sizeof(raw->hdr.type), &tmp);
1660 		length = wm_coeff_parse_int(sizeof(raw->hdr.size), &tmp);
1661 		blk->name_len = wm_coeff_parse_string(sizeof(u8), &tmp,
1662 						      &blk->name);
1663 		wm_coeff_parse_string(sizeof(u8), &tmp, NULL);
1664 		wm_coeff_parse_string(sizeof(u16), &tmp, NULL);
1665 		blk->ctl_type =
1666 			(__force snd_ctl_elem_type_t)wm_coeff_parse_int(sizeof(raw->ctl_type),
1667 									&tmp);
1668 		blk->flags = wm_coeff_parse_int(sizeof(raw->flags), &tmp);
1669 		blk->len = wm_coeff_parse_int(sizeof(raw->len), &tmp);
1670 
1671 		*data = *data + sizeof(raw->hdr) + length;
1672 		break;
1673 	}
1674 
1675 	adsp_dbg(dsp, "\tCoefficient type: %#x\n", blk->mem_type);
1676 	adsp_dbg(dsp, "\tCoefficient offset: %#x\n", blk->offset);
1677 	adsp_dbg(dsp, "\tCoefficient name: %.*s\n", blk->name_len, blk->name);
1678 	adsp_dbg(dsp, "\tCoefficient flags: %#x\n", blk->flags);
1679 	adsp_dbg(dsp, "\tALSA control type: %#x\n", blk->ctl_type);
1680 	adsp_dbg(dsp, "\tALSA control len: %#x\n", blk->len);
1681 }
1682 
1683 static int wm_adsp_check_coeff_flags(struct wm_adsp *dsp,
1684 				const struct wm_coeff_parsed_coeff *coeff_blk,
1685 				unsigned int f_required,
1686 				unsigned int f_illegal)
1687 {
1688 	if ((coeff_blk->flags & f_illegal) ||
1689 	    ((coeff_blk->flags & f_required) != f_required)) {
1690 		adsp_err(dsp, "Illegal flags 0x%x for control type 0x%x\n",
1691 			 coeff_blk->flags, coeff_blk->ctl_type);
1692 		return -EINVAL;
1693 	}
1694 
1695 	return 0;
1696 }
1697 
1698 static int wm_adsp_parse_coeff(struct wm_adsp *dsp,
1699 			       const struct wmfw_region *region)
1700 {
1701 	struct wm_adsp_alg_region alg_region = {};
1702 	struct wm_coeff_parsed_alg alg_blk;
1703 	struct wm_coeff_parsed_coeff coeff_blk;
1704 	const u8 *data = region->data;
1705 	int i, ret;
1706 
1707 	wm_coeff_parse_alg(dsp, &data, &alg_blk);
1708 	for (i = 0; i < alg_blk.ncoeff; i++) {
1709 		wm_coeff_parse_coeff(dsp, &data, &coeff_blk);
1710 
1711 		switch (coeff_blk.ctl_type) {
1712 		case SNDRV_CTL_ELEM_TYPE_BYTES:
1713 			break;
1714 		case WMFW_CTL_TYPE_ACKED:
1715 			if (coeff_blk.flags & WMFW_CTL_FLAG_SYS)
1716 				continue;	/* ignore */
1717 
1718 			ret = wm_adsp_check_coeff_flags(dsp, &coeff_blk,
1719 						WMFW_CTL_FLAG_VOLATILE |
1720 						WMFW_CTL_FLAG_WRITEABLE |
1721 						WMFW_CTL_FLAG_READABLE,
1722 						0);
1723 			if (ret)
1724 				return -EINVAL;
1725 			break;
1726 		case WMFW_CTL_TYPE_HOSTEVENT:
1727 			ret = wm_adsp_check_coeff_flags(dsp, &coeff_blk,
1728 						WMFW_CTL_FLAG_SYS |
1729 						WMFW_CTL_FLAG_VOLATILE |
1730 						WMFW_CTL_FLAG_WRITEABLE |
1731 						WMFW_CTL_FLAG_READABLE,
1732 						0);
1733 			if (ret)
1734 				return -EINVAL;
1735 			break;
1736 		case WMFW_CTL_TYPE_HOST_BUFFER:
1737 			ret = wm_adsp_check_coeff_flags(dsp, &coeff_blk,
1738 						WMFW_CTL_FLAG_SYS |
1739 						WMFW_CTL_FLAG_VOLATILE |
1740 						WMFW_CTL_FLAG_READABLE,
1741 						0);
1742 			if (ret)
1743 				return -EINVAL;
1744 			break;
1745 		default:
1746 			adsp_err(dsp, "Unknown control type: %d\n",
1747 				 coeff_blk.ctl_type);
1748 			return -EINVAL;
1749 		}
1750 
1751 		alg_region.type = coeff_blk.mem_type;
1752 		alg_region.alg = alg_blk.id;
1753 
1754 		ret = wm_adsp_create_control(dsp, &alg_region,
1755 					     coeff_blk.offset,
1756 					     coeff_blk.len,
1757 					     coeff_blk.name,
1758 					     coeff_blk.name_len,
1759 					     coeff_blk.flags,
1760 					     coeff_blk.ctl_type);
1761 		if (ret < 0)
1762 			adsp_err(dsp, "Failed to create control: %.*s, %d\n",
1763 				 coeff_blk.name_len, coeff_blk.name, ret);
1764 	}
1765 
1766 	return 0;
1767 }
1768 
1769 static unsigned int wm_adsp1_parse_sizes(struct wm_adsp *dsp,
1770 					 const char * const file,
1771 					 unsigned int pos,
1772 					 const struct firmware *firmware)
1773 {
1774 	const struct wmfw_adsp1_sizes *adsp1_sizes;
1775 
1776 	adsp1_sizes = (void *)&firmware->data[pos];
1777 
1778 	adsp_dbg(dsp, "%s: %d DM, %d PM, %d ZM\n", file,
1779 		 le32_to_cpu(adsp1_sizes->dm), le32_to_cpu(adsp1_sizes->pm),
1780 		 le32_to_cpu(adsp1_sizes->zm));
1781 
1782 	return pos + sizeof(*adsp1_sizes);
1783 }
1784 
1785 static unsigned int wm_adsp2_parse_sizes(struct wm_adsp *dsp,
1786 					 const char * const file,
1787 					 unsigned int pos,
1788 					 const struct firmware *firmware)
1789 {
1790 	const struct wmfw_adsp2_sizes *adsp2_sizes;
1791 
1792 	adsp2_sizes = (void *)&firmware->data[pos];
1793 
1794 	adsp_dbg(dsp, "%s: %d XM, %d YM %d PM, %d ZM\n", file,
1795 		 le32_to_cpu(adsp2_sizes->xm), le32_to_cpu(adsp2_sizes->ym),
1796 		 le32_to_cpu(adsp2_sizes->pm), le32_to_cpu(adsp2_sizes->zm));
1797 
1798 	return pos + sizeof(*adsp2_sizes);
1799 }
1800 
1801 static bool wm_adsp_validate_version(struct wm_adsp *dsp, unsigned int version)
1802 {
1803 	switch (version) {
1804 	case 0:
1805 		adsp_warn(dsp, "Deprecated file format %d\n", version);
1806 		return true;
1807 	case 1:
1808 	case 2:
1809 		return true;
1810 	default:
1811 		return false;
1812 	}
1813 }
1814 
1815 static bool wm_halo_validate_version(struct wm_adsp *dsp, unsigned int version)
1816 {
1817 	switch (version) {
1818 	case 3:
1819 		return true;
1820 	default:
1821 		return false;
1822 	}
1823 }
1824 
1825 static int wm_adsp_load(struct wm_adsp *dsp)
1826 {
1827 	LIST_HEAD(buf_list);
1828 	const struct firmware *firmware;
1829 	struct regmap *regmap = dsp->regmap;
1830 	unsigned int pos = 0;
1831 	const struct wmfw_header *header;
1832 	const struct wmfw_adsp1_sizes *adsp1_sizes;
1833 	const struct wmfw_footer *footer;
1834 	const struct wmfw_region *region;
1835 	const struct wm_adsp_region *mem;
1836 	const char *region_name;
1837 	char *file, *text = NULL;
1838 	struct wm_adsp_buf *buf;
1839 	unsigned int reg;
1840 	int regions = 0;
1841 	int ret, offset, type;
1842 
1843 	file = kzalloc(PAGE_SIZE, GFP_KERNEL);
1844 	if (file == NULL)
1845 		return -ENOMEM;
1846 
1847 	snprintf(file, PAGE_SIZE, "%s-%s-%s.wmfw", dsp->part, dsp->fwf_name,
1848 		 wm_adsp_fw[dsp->fw].file);
1849 	file[PAGE_SIZE - 1] = '\0';
1850 
1851 	ret = request_firmware(&firmware, file, dsp->dev);
1852 	if (ret != 0) {
1853 		adsp_err(dsp, "Failed to request '%s'\n", file);
1854 		goto out;
1855 	}
1856 	ret = -EINVAL;
1857 
1858 	pos = sizeof(*header) + sizeof(*adsp1_sizes) + sizeof(*footer);
1859 	if (pos >= firmware->size) {
1860 		adsp_err(dsp, "%s: file too short, %zu bytes\n",
1861 			 file, firmware->size);
1862 		goto out_fw;
1863 	}
1864 
1865 	header = (void *)&firmware->data[0];
1866 
1867 	if (memcmp(&header->magic[0], "WMFW", 4) != 0) {
1868 		adsp_err(dsp, "%s: invalid magic\n", file);
1869 		goto out_fw;
1870 	}
1871 
1872 	if (!dsp->ops->validate_version(dsp, header->ver)) {
1873 		adsp_err(dsp, "%s: unknown file format %d\n",
1874 			 file, header->ver);
1875 		goto out_fw;
1876 	}
1877 
1878 	adsp_info(dsp, "Firmware version: %d\n", header->ver);
1879 	dsp->fw_ver = header->ver;
1880 
1881 	if (header->core != dsp->type) {
1882 		adsp_err(dsp, "%s: invalid core %d != %d\n",
1883 			 file, header->core, dsp->type);
1884 		goto out_fw;
1885 	}
1886 
1887 	pos = sizeof(*header);
1888 	pos = dsp->ops->parse_sizes(dsp, file, pos, firmware);
1889 
1890 	footer = (void *)&firmware->data[pos];
1891 	pos += sizeof(*footer);
1892 
1893 	if (le32_to_cpu(header->len) != pos) {
1894 		adsp_err(dsp, "%s: unexpected header length %d\n",
1895 			 file, le32_to_cpu(header->len));
1896 		goto out_fw;
1897 	}
1898 
1899 	adsp_dbg(dsp, "%s: timestamp %llu\n", file,
1900 		 le64_to_cpu(footer->timestamp));
1901 
1902 	while (pos < firmware->size &&
1903 	       sizeof(*region) < firmware->size - pos) {
1904 		region = (void *)&(firmware->data[pos]);
1905 		region_name = "Unknown";
1906 		reg = 0;
1907 		text = NULL;
1908 		offset = le32_to_cpu(region->offset) & 0xffffff;
1909 		type = be32_to_cpu(region->type) & 0xff;
1910 
1911 		switch (type) {
1912 		case WMFW_NAME_TEXT:
1913 			region_name = "Firmware name";
1914 			text = kzalloc(le32_to_cpu(region->len) + 1,
1915 				       GFP_KERNEL);
1916 			break;
1917 		case WMFW_ALGORITHM_DATA:
1918 			region_name = "Algorithm";
1919 			ret = wm_adsp_parse_coeff(dsp, region);
1920 			if (ret != 0)
1921 				goto out_fw;
1922 			break;
1923 		case WMFW_INFO_TEXT:
1924 			region_name = "Information";
1925 			text = kzalloc(le32_to_cpu(region->len) + 1,
1926 				       GFP_KERNEL);
1927 			break;
1928 		case WMFW_ABSOLUTE:
1929 			region_name = "Absolute";
1930 			reg = offset;
1931 			break;
1932 		case WMFW_ADSP1_PM:
1933 		case WMFW_ADSP1_DM:
1934 		case WMFW_ADSP2_XM:
1935 		case WMFW_ADSP2_YM:
1936 		case WMFW_ADSP1_ZM:
1937 		case WMFW_HALO_PM_PACKED:
1938 		case WMFW_HALO_XM_PACKED:
1939 		case WMFW_HALO_YM_PACKED:
1940 			mem = wm_adsp_find_region(dsp, type);
1941 			if (!mem) {
1942 				adsp_err(dsp, "No region of type: %x\n", type);
1943 				ret = -EINVAL;
1944 				goto out_fw;
1945 			}
1946 
1947 			region_name = wm_adsp_mem_region_name(type);
1948 			reg = dsp->ops->region_to_reg(mem, offset);
1949 			break;
1950 		default:
1951 			adsp_warn(dsp,
1952 				  "%s.%d: Unknown region type %x at %d(%x)\n",
1953 				  file, regions, type, pos, pos);
1954 			break;
1955 		}
1956 
1957 		adsp_dbg(dsp, "%s.%d: %d bytes at %d in %s\n", file,
1958 			 regions, le32_to_cpu(region->len), offset,
1959 			 region_name);
1960 
1961 		if (le32_to_cpu(region->len) >
1962 		    firmware->size - pos - sizeof(*region)) {
1963 			adsp_err(dsp,
1964 				 "%s.%d: %s region len %d bytes exceeds file length %zu\n",
1965 				 file, regions, region_name,
1966 				 le32_to_cpu(region->len), firmware->size);
1967 			ret = -EINVAL;
1968 			goto out_fw;
1969 		}
1970 
1971 		if (text) {
1972 			memcpy(text, region->data, le32_to_cpu(region->len));
1973 			adsp_info(dsp, "%s: %s\n", file, text);
1974 			kfree(text);
1975 			text = NULL;
1976 		}
1977 
1978 		if (reg) {
1979 			buf = wm_adsp_buf_alloc(region->data,
1980 						le32_to_cpu(region->len),
1981 						&buf_list);
1982 			if (!buf) {
1983 				adsp_err(dsp, "Out of memory\n");
1984 				ret = -ENOMEM;
1985 				goto out_fw;
1986 			}
1987 
1988 			ret = regmap_raw_write_async(regmap, reg, buf->buf,
1989 						     le32_to_cpu(region->len));
1990 			if (ret != 0) {
1991 				adsp_err(dsp,
1992 					"%s.%d: Failed to write %d bytes at %d in %s: %d\n",
1993 					file, regions,
1994 					le32_to_cpu(region->len), offset,
1995 					region_name, ret);
1996 				goto out_fw;
1997 			}
1998 		}
1999 
2000 		pos += le32_to_cpu(region->len) + sizeof(*region);
2001 		regions++;
2002 	}
2003 
2004 	ret = regmap_async_complete(regmap);
2005 	if (ret != 0) {
2006 		adsp_err(dsp, "Failed to complete async write: %d\n", ret);
2007 		goto out_fw;
2008 	}
2009 
2010 	if (pos > firmware->size)
2011 		adsp_warn(dsp, "%s.%d: %zu bytes at end of file\n",
2012 			  file, regions, pos - firmware->size);
2013 
2014 	wm_adsp_debugfs_save_wmfwname(dsp, file);
2015 
2016 out_fw:
2017 	regmap_async_complete(regmap);
2018 	wm_adsp_buf_free(&buf_list);
2019 	release_firmware(firmware);
2020 	kfree(text);
2021 out:
2022 	kfree(file);
2023 
2024 	return ret;
2025 }
2026 
2027 /*
2028  * Find wm_coeff_ctl with input name as its subname
2029  * If not found, return NULL
2030  */
2031 static struct wm_coeff_ctl *wm_adsp_get_ctl(struct wm_adsp *dsp,
2032 					     const char *name, int type,
2033 					     unsigned int alg)
2034 {
2035 	struct wm_coeff_ctl *pos, *rslt = NULL;
2036 
2037 	list_for_each_entry(pos, &dsp->ctl_list, list) {
2038 		if (!pos->subname)
2039 			continue;
2040 		if (strncmp(pos->subname, name, pos->subname_len) == 0 &&
2041 				pos->alg_region.alg == alg &&
2042 				pos->alg_region.type == type) {
2043 			rslt = pos;
2044 			break;
2045 		}
2046 	}
2047 
2048 	return rslt;
2049 }
2050 
2051 int wm_adsp_write_ctl(struct wm_adsp *dsp, const char *name, int type,
2052 		      unsigned int alg, void *buf, size_t len)
2053 {
2054 	struct wm_coeff_ctl *ctl;
2055 	struct snd_kcontrol *kcontrol;
2056 	char ctl_name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
2057 	int ret;
2058 
2059 	ctl = wm_adsp_get_ctl(dsp, name, type, alg);
2060 	if (!ctl)
2061 		return -EINVAL;
2062 
2063 	if (len > ctl->len)
2064 		return -EINVAL;
2065 
2066 	ret = wm_coeff_write_ctrl(ctl, buf, len);
2067 	if (ret)
2068 		return ret;
2069 
2070 	if (ctl->flags & WMFW_CTL_FLAG_SYS)
2071 		return 0;
2072 
2073 	if (dsp->component->name_prefix)
2074 		snprintf(ctl_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN, "%s %s",
2075 			 dsp->component->name_prefix, ctl->name);
2076 	else
2077 		snprintf(ctl_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN, "%s",
2078 			 ctl->name);
2079 
2080 	kcontrol = snd_soc_card_get_kcontrol(dsp->component->card, ctl_name);
2081 	if (!kcontrol) {
2082 		adsp_err(dsp, "Can't find kcontrol %s\n", ctl_name);
2083 		return -EINVAL;
2084 	}
2085 
2086 	snd_ctl_notify(dsp->component->card->snd_card,
2087 		       SNDRV_CTL_EVENT_MASK_VALUE, &kcontrol->id);
2088 
2089 	return ret;
2090 }
2091 EXPORT_SYMBOL_GPL(wm_adsp_write_ctl);
2092 
2093 int wm_adsp_read_ctl(struct wm_adsp *dsp, const char *name, int type,
2094 		     unsigned int alg, void *buf, size_t len)
2095 {
2096 	struct wm_coeff_ctl *ctl;
2097 
2098 	ctl = wm_adsp_get_ctl(dsp, name, type, alg);
2099 	if (!ctl)
2100 		return -EINVAL;
2101 
2102 	if (len > ctl->len)
2103 		return -EINVAL;
2104 
2105 	return wm_coeff_read_ctrl(ctl, buf, len);
2106 }
2107 EXPORT_SYMBOL_GPL(wm_adsp_read_ctl);
2108 
2109 static void wm_adsp_ctl_fixup_base(struct wm_adsp *dsp,
2110 				  const struct wm_adsp_alg_region *alg_region)
2111 {
2112 	struct wm_coeff_ctl *ctl;
2113 
2114 	list_for_each_entry(ctl, &dsp->ctl_list, list) {
2115 		if (ctl->fw_name == wm_adsp_fw_text[dsp->fw] &&
2116 		    alg_region->alg == ctl->alg_region.alg &&
2117 		    alg_region->type == ctl->alg_region.type) {
2118 			ctl->alg_region.base = alg_region->base;
2119 		}
2120 	}
2121 }
2122 
2123 static void *wm_adsp_read_algs(struct wm_adsp *dsp, size_t n_algs,
2124 			       const struct wm_adsp_region *mem,
2125 			       unsigned int pos, unsigned int len)
2126 {
2127 	void *alg;
2128 	unsigned int reg;
2129 	int ret;
2130 	__be32 val;
2131 
2132 	if (n_algs == 0) {
2133 		adsp_err(dsp, "No algorithms\n");
2134 		return ERR_PTR(-EINVAL);
2135 	}
2136 
2137 	if (n_algs > 1024) {
2138 		adsp_err(dsp, "Algorithm count %zx excessive\n", n_algs);
2139 		return ERR_PTR(-EINVAL);
2140 	}
2141 
2142 	/* Read the terminator first to validate the length */
2143 	reg = dsp->ops->region_to_reg(mem, pos + len);
2144 
2145 	ret = regmap_raw_read(dsp->regmap, reg, &val, sizeof(val));
2146 	if (ret != 0) {
2147 		adsp_err(dsp, "Failed to read algorithm list end: %d\n",
2148 			ret);
2149 		return ERR_PTR(ret);
2150 	}
2151 
2152 	if (be32_to_cpu(val) != 0xbedead)
2153 		adsp_warn(dsp, "Algorithm list end %x 0x%x != 0xbedead\n",
2154 			  reg, be32_to_cpu(val));
2155 
2156 	/* Convert length from DSP words to bytes */
2157 	len *= sizeof(u32);
2158 
2159 	alg = kzalloc(len, GFP_KERNEL | GFP_DMA);
2160 	if (!alg)
2161 		return ERR_PTR(-ENOMEM);
2162 
2163 	reg = dsp->ops->region_to_reg(mem, pos);
2164 
2165 	ret = regmap_raw_read(dsp->regmap, reg, alg, len);
2166 	if (ret != 0) {
2167 		adsp_err(dsp, "Failed to read algorithm list: %d\n", ret);
2168 		kfree(alg);
2169 		return ERR_PTR(ret);
2170 	}
2171 
2172 	return alg;
2173 }
2174 
2175 static struct wm_adsp_alg_region *
2176 	wm_adsp_find_alg_region(struct wm_adsp *dsp, int type, unsigned int id)
2177 {
2178 	struct wm_adsp_alg_region *alg_region;
2179 
2180 	list_for_each_entry(alg_region, &dsp->alg_regions, list) {
2181 		if (id == alg_region->alg && type == alg_region->type)
2182 			return alg_region;
2183 	}
2184 
2185 	return NULL;
2186 }
2187 
2188 static struct wm_adsp_alg_region *wm_adsp_create_region(struct wm_adsp *dsp,
2189 							int type, __be32 id,
2190 							__be32 base)
2191 {
2192 	struct wm_adsp_alg_region *alg_region;
2193 
2194 	alg_region = kzalloc(sizeof(*alg_region), GFP_KERNEL);
2195 	if (!alg_region)
2196 		return ERR_PTR(-ENOMEM);
2197 
2198 	alg_region->type = type;
2199 	alg_region->alg = be32_to_cpu(id);
2200 	alg_region->base = be32_to_cpu(base);
2201 
2202 	list_add_tail(&alg_region->list, &dsp->alg_regions);
2203 
2204 	if (dsp->fw_ver > 0)
2205 		wm_adsp_ctl_fixup_base(dsp, alg_region);
2206 
2207 	return alg_region;
2208 }
2209 
2210 static void wm_adsp_free_alg_regions(struct wm_adsp *dsp)
2211 {
2212 	struct wm_adsp_alg_region *alg_region;
2213 
2214 	while (!list_empty(&dsp->alg_regions)) {
2215 		alg_region = list_first_entry(&dsp->alg_regions,
2216 					      struct wm_adsp_alg_region,
2217 					      list);
2218 		list_del(&alg_region->list);
2219 		kfree(alg_region);
2220 	}
2221 }
2222 
2223 static void wmfw_parse_id_header(struct wm_adsp *dsp,
2224 				 struct wmfw_id_hdr *fw, int nalgs)
2225 {
2226 	dsp->fw_id = be32_to_cpu(fw->id);
2227 	dsp->fw_id_version = be32_to_cpu(fw->ver);
2228 
2229 	adsp_info(dsp, "Firmware: %x v%d.%d.%d, %d algorithms\n",
2230 		  dsp->fw_id, (dsp->fw_id_version & 0xff0000) >> 16,
2231 		  (dsp->fw_id_version & 0xff00) >> 8, dsp->fw_id_version & 0xff,
2232 		  nalgs);
2233 }
2234 
2235 static void wmfw_v3_parse_id_header(struct wm_adsp *dsp,
2236 				    struct wmfw_v3_id_hdr *fw, int nalgs)
2237 {
2238 	dsp->fw_id = be32_to_cpu(fw->id);
2239 	dsp->fw_id_version = be32_to_cpu(fw->ver);
2240 	dsp->fw_vendor_id = be32_to_cpu(fw->vendor_id);
2241 
2242 	adsp_info(dsp, "Firmware: %x vendor: 0x%x v%d.%d.%d, %d algorithms\n",
2243 		  dsp->fw_id, dsp->fw_vendor_id,
2244 		  (dsp->fw_id_version & 0xff0000) >> 16,
2245 		  (dsp->fw_id_version & 0xff00) >> 8, dsp->fw_id_version & 0xff,
2246 		  nalgs);
2247 }
2248 
2249 static int wm_adsp_create_regions(struct wm_adsp *dsp, __be32 id, int nregions,
2250 				int *type, __be32 *base)
2251 {
2252 	struct wm_adsp_alg_region *alg_region;
2253 	int i;
2254 
2255 	for (i = 0; i < nregions; i++) {
2256 		alg_region = wm_adsp_create_region(dsp, type[i], id, base[i]);
2257 		if (IS_ERR(alg_region))
2258 			return PTR_ERR(alg_region);
2259 	}
2260 
2261 	return 0;
2262 }
2263 
2264 static int wm_adsp1_setup_algs(struct wm_adsp *dsp)
2265 {
2266 	struct wmfw_adsp1_id_hdr adsp1_id;
2267 	struct wmfw_adsp1_alg_hdr *adsp1_alg;
2268 	struct wm_adsp_alg_region *alg_region;
2269 	const struct wm_adsp_region *mem;
2270 	unsigned int pos, len;
2271 	size_t n_algs;
2272 	int i, ret;
2273 
2274 	mem = wm_adsp_find_region(dsp, WMFW_ADSP1_DM);
2275 	if (WARN_ON(!mem))
2276 		return -EINVAL;
2277 
2278 	ret = regmap_raw_read(dsp->regmap, mem->base, &adsp1_id,
2279 			      sizeof(adsp1_id));
2280 	if (ret != 0) {
2281 		adsp_err(dsp, "Failed to read algorithm info: %d\n",
2282 			 ret);
2283 		return ret;
2284 	}
2285 
2286 	n_algs = be32_to_cpu(adsp1_id.n_algs);
2287 
2288 	wmfw_parse_id_header(dsp, &adsp1_id.fw, n_algs);
2289 
2290 	alg_region = wm_adsp_create_region(dsp, WMFW_ADSP1_ZM,
2291 					   adsp1_id.fw.id, adsp1_id.zm);
2292 	if (IS_ERR(alg_region))
2293 		return PTR_ERR(alg_region);
2294 
2295 	alg_region = wm_adsp_create_region(dsp, WMFW_ADSP1_DM,
2296 					   adsp1_id.fw.id, adsp1_id.dm);
2297 	if (IS_ERR(alg_region))
2298 		return PTR_ERR(alg_region);
2299 
2300 	/* Calculate offset and length in DSP words */
2301 	pos = sizeof(adsp1_id) / sizeof(u32);
2302 	len = (sizeof(*adsp1_alg) * n_algs) / sizeof(u32);
2303 
2304 	adsp1_alg = wm_adsp_read_algs(dsp, n_algs, mem, pos, len);
2305 	if (IS_ERR(adsp1_alg))
2306 		return PTR_ERR(adsp1_alg);
2307 
2308 	for (i = 0; i < n_algs; i++) {
2309 		adsp_info(dsp, "%d: ID %x v%d.%d.%d DM@%x ZM@%x\n",
2310 			  i, be32_to_cpu(adsp1_alg[i].alg.id),
2311 			  (be32_to_cpu(adsp1_alg[i].alg.ver) & 0xff0000) >> 16,
2312 			  (be32_to_cpu(adsp1_alg[i].alg.ver) & 0xff00) >> 8,
2313 			  be32_to_cpu(adsp1_alg[i].alg.ver) & 0xff,
2314 			  be32_to_cpu(adsp1_alg[i].dm),
2315 			  be32_to_cpu(adsp1_alg[i].zm));
2316 
2317 		alg_region = wm_adsp_create_region(dsp, WMFW_ADSP1_DM,
2318 						   adsp1_alg[i].alg.id,
2319 						   adsp1_alg[i].dm);
2320 		if (IS_ERR(alg_region)) {
2321 			ret = PTR_ERR(alg_region);
2322 			goto out;
2323 		}
2324 		if (dsp->fw_ver == 0) {
2325 			if (i + 1 < n_algs) {
2326 				len = be32_to_cpu(adsp1_alg[i + 1].dm);
2327 				len -= be32_to_cpu(adsp1_alg[i].dm);
2328 				len *= 4;
2329 				wm_adsp_create_control(dsp, alg_region, 0,
2330 						     len, NULL, 0, 0,
2331 						     SNDRV_CTL_ELEM_TYPE_BYTES);
2332 			} else {
2333 				adsp_warn(dsp, "Missing length info for region DM with ID %x\n",
2334 					  be32_to_cpu(adsp1_alg[i].alg.id));
2335 			}
2336 		}
2337 
2338 		alg_region = wm_adsp_create_region(dsp, WMFW_ADSP1_ZM,
2339 						   adsp1_alg[i].alg.id,
2340 						   adsp1_alg[i].zm);
2341 		if (IS_ERR(alg_region)) {
2342 			ret = PTR_ERR(alg_region);
2343 			goto out;
2344 		}
2345 		if (dsp->fw_ver == 0) {
2346 			if (i + 1 < n_algs) {
2347 				len = be32_to_cpu(adsp1_alg[i + 1].zm);
2348 				len -= be32_to_cpu(adsp1_alg[i].zm);
2349 				len *= 4;
2350 				wm_adsp_create_control(dsp, alg_region, 0,
2351 						     len, NULL, 0, 0,
2352 						     SNDRV_CTL_ELEM_TYPE_BYTES);
2353 			} else {
2354 				adsp_warn(dsp, "Missing length info for region ZM with ID %x\n",
2355 					  be32_to_cpu(adsp1_alg[i].alg.id));
2356 			}
2357 		}
2358 	}
2359 
2360 out:
2361 	kfree(adsp1_alg);
2362 	return ret;
2363 }
2364 
2365 static int wm_adsp2_setup_algs(struct wm_adsp *dsp)
2366 {
2367 	struct wmfw_adsp2_id_hdr adsp2_id;
2368 	struct wmfw_adsp2_alg_hdr *adsp2_alg;
2369 	struct wm_adsp_alg_region *alg_region;
2370 	const struct wm_adsp_region *mem;
2371 	unsigned int pos, len;
2372 	size_t n_algs;
2373 	int i, ret;
2374 
2375 	mem = wm_adsp_find_region(dsp, WMFW_ADSP2_XM);
2376 	if (WARN_ON(!mem))
2377 		return -EINVAL;
2378 
2379 	ret = regmap_raw_read(dsp->regmap, mem->base, &adsp2_id,
2380 			      sizeof(adsp2_id));
2381 	if (ret != 0) {
2382 		adsp_err(dsp, "Failed to read algorithm info: %d\n",
2383 			 ret);
2384 		return ret;
2385 	}
2386 
2387 	n_algs = be32_to_cpu(adsp2_id.n_algs);
2388 
2389 	wmfw_parse_id_header(dsp, &adsp2_id.fw, n_algs);
2390 
2391 	alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_XM,
2392 					   adsp2_id.fw.id, adsp2_id.xm);
2393 	if (IS_ERR(alg_region))
2394 		return PTR_ERR(alg_region);
2395 
2396 	alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_YM,
2397 					   adsp2_id.fw.id, adsp2_id.ym);
2398 	if (IS_ERR(alg_region))
2399 		return PTR_ERR(alg_region);
2400 
2401 	alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_ZM,
2402 					   adsp2_id.fw.id, adsp2_id.zm);
2403 	if (IS_ERR(alg_region))
2404 		return PTR_ERR(alg_region);
2405 
2406 	/* Calculate offset and length in DSP words */
2407 	pos = sizeof(adsp2_id) / sizeof(u32);
2408 	len = (sizeof(*adsp2_alg) * n_algs) / sizeof(u32);
2409 
2410 	adsp2_alg = wm_adsp_read_algs(dsp, n_algs, mem, pos, len);
2411 	if (IS_ERR(adsp2_alg))
2412 		return PTR_ERR(adsp2_alg);
2413 
2414 	for (i = 0; i < n_algs; i++) {
2415 		adsp_info(dsp,
2416 			  "%d: ID %x v%d.%d.%d XM@%x YM@%x ZM@%x\n",
2417 			  i, be32_to_cpu(adsp2_alg[i].alg.id),
2418 			  (be32_to_cpu(adsp2_alg[i].alg.ver) & 0xff0000) >> 16,
2419 			  (be32_to_cpu(adsp2_alg[i].alg.ver) & 0xff00) >> 8,
2420 			  be32_to_cpu(adsp2_alg[i].alg.ver) & 0xff,
2421 			  be32_to_cpu(adsp2_alg[i].xm),
2422 			  be32_to_cpu(adsp2_alg[i].ym),
2423 			  be32_to_cpu(adsp2_alg[i].zm));
2424 
2425 		alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_XM,
2426 						   adsp2_alg[i].alg.id,
2427 						   adsp2_alg[i].xm);
2428 		if (IS_ERR(alg_region)) {
2429 			ret = PTR_ERR(alg_region);
2430 			goto out;
2431 		}
2432 		if (dsp->fw_ver == 0) {
2433 			if (i + 1 < n_algs) {
2434 				len = be32_to_cpu(adsp2_alg[i + 1].xm);
2435 				len -= be32_to_cpu(adsp2_alg[i].xm);
2436 				len *= 4;
2437 				wm_adsp_create_control(dsp, alg_region, 0,
2438 						     len, NULL, 0, 0,
2439 						     SNDRV_CTL_ELEM_TYPE_BYTES);
2440 			} else {
2441 				adsp_warn(dsp, "Missing length info for region XM with ID %x\n",
2442 					  be32_to_cpu(adsp2_alg[i].alg.id));
2443 			}
2444 		}
2445 
2446 		alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_YM,
2447 						   adsp2_alg[i].alg.id,
2448 						   adsp2_alg[i].ym);
2449 		if (IS_ERR(alg_region)) {
2450 			ret = PTR_ERR(alg_region);
2451 			goto out;
2452 		}
2453 		if (dsp->fw_ver == 0) {
2454 			if (i + 1 < n_algs) {
2455 				len = be32_to_cpu(adsp2_alg[i + 1].ym);
2456 				len -= be32_to_cpu(adsp2_alg[i].ym);
2457 				len *= 4;
2458 				wm_adsp_create_control(dsp, alg_region, 0,
2459 						     len, NULL, 0, 0,
2460 						     SNDRV_CTL_ELEM_TYPE_BYTES);
2461 			} else {
2462 				adsp_warn(dsp, "Missing length info for region YM with ID %x\n",
2463 					  be32_to_cpu(adsp2_alg[i].alg.id));
2464 			}
2465 		}
2466 
2467 		alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_ZM,
2468 						   adsp2_alg[i].alg.id,
2469 						   adsp2_alg[i].zm);
2470 		if (IS_ERR(alg_region)) {
2471 			ret = PTR_ERR(alg_region);
2472 			goto out;
2473 		}
2474 		if (dsp->fw_ver == 0) {
2475 			if (i + 1 < n_algs) {
2476 				len = be32_to_cpu(adsp2_alg[i + 1].zm);
2477 				len -= be32_to_cpu(adsp2_alg[i].zm);
2478 				len *= 4;
2479 				wm_adsp_create_control(dsp, alg_region, 0,
2480 						     len, NULL, 0, 0,
2481 						     SNDRV_CTL_ELEM_TYPE_BYTES);
2482 			} else {
2483 				adsp_warn(dsp, "Missing length info for region ZM with ID %x\n",
2484 					  be32_to_cpu(adsp2_alg[i].alg.id));
2485 			}
2486 		}
2487 	}
2488 
2489 out:
2490 	kfree(adsp2_alg);
2491 	return ret;
2492 }
2493 
2494 static int wm_halo_create_regions(struct wm_adsp *dsp, __be32 id,
2495 				  __be32 xm_base, __be32 ym_base)
2496 {
2497 	int types[] = {
2498 		WMFW_ADSP2_XM, WMFW_HALO_XM_PACKED,
2499 		WMFW_ADSP2_YM, WMFW_HALO_YM_PACKED
2500 	};
2501 	__be32 bases[] = { xm_base, xm_base, ym_base, ym_base };
2502 
2503 	return wm_adsp_create_regions(dsp, id, ARRAY_SIZE(types), types, bases);
2504 }
2505 
2506 static int wm_halo_setup_algs(struct wm_adsp *dsp)
2507 {
2508 	struct wmfw_halo_id_hdr halo_id;
2509 	struct wmfw_halo_alg_hdr *halo_alg;
2510 	const struct wm_adsp_region *mem;
2511 	unsigned int pos, len;
2512 	size_t n_algs;
2513 	int i, ret;
2514 
2515 	mem = wm_adsp_find_region(dsp, WMFW_ADSP2_XM);
2516 	if (WARN_ON(!mem))
2517 		return -EINVAL;
2518 
2519 	ret = regmap_raw_read(dsp->regmap, mem->base, &halo_id,
2520 			      sizeof(halo_id));
2521 	if (ret != 0) {
2522 		adsp_err(dsp, "Failed to read algorithm info: %d\n",
2523 			 ret);
2524 		return ret;
2525 	}
2526 
2527 	n_algs = be32_to_cpu(halo_id.n_algs);
2528 
2529 	wmfw_v3_parse_id_header(dsp, &halo_id.fw, n_algs);
2530 
2531 	ret = wm_halo_create_regions(dsp, halo_id.fw.id,
2532 				     halo_id.xm_base, halo_id.ym_base);
2533 	if (ret)
2534 		return ret;
2535 
2536 	/* Calculate offset and length in DSP words */
2537 	pos = sizeof(halo_id) / sizeof(u32);
2538 	len = (sizeof(*halo_alg) * n_algs) / sizeof(u32);
2539 
2540 	halo_alg = wm_adsp_read_algs(dsp, n_algs, mem, pos, len);
2541 	if (IS_ERR(halo_alg))
2542 		return PTR_ERR(halo_alg);
2543 
2544 	for (i = 0; i < n_algs; i++) {
2545 		adsp_info(dsp,
2546 			  "%d: ID %x v%d.%d.%d XM@%x YM@%x\n",
2547 			  i, be32_to_cpu(halo_alg[i].alg.id),
2548 			  (be32_to_cpu(halo_alg[i].alg.ver) & 0xff0000) >> 16,
2549 			  (be32_to_cpu(halo_alg[i].alg.ver) & 0xff00) >> 8,
2550 			  be32_to_cpu(halo_alg[i].alg.ver) & 0xff,
2551 			  be32_to_cpu(halo_alg[i].xm_base),
2552 			  be32_to_cpu(halo_alg[i].ym_base));
2553 
2554 		ret = wm_halo_create_regions(dsp, halo_alg[i].alg.id,
2555 					     halo_alg[i].xm_base,
2556 					     halo_alg[i].ym_base);
2557 		if (ret)
2558 			goto out;
2559 	}
2560 
2561 out:
2562 	kfree(halo_alg);
2563 	return ret;
2564 }
2565 
2566 static int wm_adsp_load_coeff(struct wm_adsp *dsp)
2567 {
2568 	LIST_HEAD(buf_list);
2569 	struct regmap *regmap = dsp->regmap;
2570 	struct wmfw_coeff_hdr *hdr;
2571 	struct wmfw_coeff_item *blk;
2572 	const struct firmware *firmware;
2573 	const struct wm_adsp_region *mem;
2574 	struct wm_adsp_alg_region *alg_region;
2575 	const char *region_name;
2576 	int ret, pos, blocks, type, offset, reg;
2577 	char *file;
2578 	struct wm_adsp_buf *buf;
2579 
2580 	file = kzalloc(PAGE_SIZE, GFP_KERNEL);
2581 	if (file == NULL)
2582 		return -ENOMEM;
2583 
2584 	snprintf(file, PAGE_SIZE, "%s-%s-%s.bin", dsp->part, dsp->fwf_name,
2585 		 wm_adsp_fw[dsp->fw].file);
2586 	file[PAGE_SIZE - 1] = '\0';
2587 
2588 	ret = request_firmware(&firmware, file, dsp->dev);
2589 	if (ret != 0) {
2590 		adsp_warn(dsp, "Failed to request '%s'\n", file);
2591 		ret = 0;
2592 		goto out;
2593 	}
2594 	ret = -EINVAL;
2595 
2596 	if (sizeof(*hdr) >= firmware->size) {
2597 		adsp_err(dsp, "%s: file too short, %zu bytes\n",
2598 			file, firmware->size);
2599 		goto out_fw;
2600 	}
2601 
2602 	hdr = (void *)&firmware->data[0];
2603 	if (memcmp(hdr->magic, "WMDR", 4) != 0) {
2604 		adsp_err(dsp, "%s: invalid magic\n", file);
2605 		goto out_fw;
2606 	}
2607 
2608 	switch (be32_to_cpu(hdr->rev) & 0xff) {
2609 	case 1:
2610 		break;
2611 	default:
2612 		adsp_err(dsp, "%s: Unsupported coefficient file format %d\n",
2613 			 file, be32_to_cpu(hdr->rev) & 0xff);
2614 		ret = -EINVAL;
2615 		goto out_fw;
2616 	}
2617 
2618 	adsp_dbg(dsp, "%s: v%d.%d.%d\n", file,
2619 		(le32_to_cpu(hdr->ver) >> 16) & 0xff,
2620 		(le32_to_cpu(hdr->ver) >>  8) & 0xff,
2621 		le32_to_cpu(hdr->ver) & 0xff);
2622 
2623 	pos = le32_to_cpu(hdr->len);
2624 
2625 	blocks = 0;
2626 	while (pos < firmware->size &&
2627 	       sizeof(*blk) < firmware->size - pos) {
2628 		blk = (void *)(&firmware->data[pos]);
2629 
2630 		type = le16_to_cpu(blk->type);
2631 		offset = le16_to_cpu(blk->offset);
2632 
2633 		adsp_dbg(dsp, "%s.%d: %x v%d.%d.%d\n",
2634 			 file, blocks, le32_to_cpu(blk->id),
2635 			 (le32_to_cpu(blk->ver) >> 16) & 0xff,
2636 			 (le32_to_cpu(blk->ver) >>  8) & 0xff,
2637 			 le32_to_cpu(blk->ver) & 0xff);
2638 		adsp_dbg(dsp, "%s.%d: %d bytes at 0x%x in %x\n",
2639 			 file, blocks, le32_to_cpu(blk->len), offset, type);
2640 
2641 		reg = 0;
2642 		region_name = "Unknown";
2643 		switch (type) {
2644 		case (WMFW_NAME_TEXT << 8):
2645 		case (WMFW_INFO_TEXT << 8):
2646 		case (WMFW_METADATA << 8):
2647 			break;
2648 		case (WMFW_ABSOLUTE << 8):
2649 			/*
2650 			 * Old files may use this for global
2651 			 * coefficients.
2652 			 */
2653 			if (le32_to_cpu(blk->id) == dsp->fw_id &&
2654 			    offset == 0) {
2655 				region_name = "global coefficients";
2656 				mem = wm_adsp_find_region(dsp, type);
2657 				if (!mem) {
2658 					adsp_err(dsp, "No ZM\n");
2659 					break;
2660 				}
2661 				reg = dsp->ops->region_to_reg(mem, 0);
2662 
2663 			} else {
2664 				region_name = "register";
2665 				reg = offset;
2666 			}
2667 			break;
2668 
2669 		case WMFW_ADSP1_DM:
2670 		case WMFW_ADSP1_ZM:
2671 		case WMFW_ADSP2_XM:
2672 		case WMFW_ADSP2_YM:
2673 		case WMFW_HALO_XM_PACKED:
2674 		case WMFW_HALO_YM_PACKED:
2675 		case WMFW_HALO_PM_PACKED:
2676 			adsp_dbg(dsp, "%s.%d: %d bytes in %x for %x\n",
2677 				 file, blocks, le32_to_cpu(blk->len),
2678 				 type, le32_to_cpu(blk->id));
2679 
2680 			mem = wm_adsp_find_region(dsp, type);
2681 			if (!mem) {
2682 				adsp_err(dsp, "No base for region %x\n", type);
2683 				break;
2684 			}
2685 
2686 			alg_region = wm_adsp_find_alg_region(dsp, type,
2687 						le32_to_cpu(blk->id));
2688 			if (alg_region) {
2689 				reg = alg_region->base;
2690 				reg = dsp->ops->region_to_reg(mem, reg);
2691 				reg += offset;
2692 			} else {
2693 				adsp_err(dsp, "No %x for algorithm %x\n",
2694 					 type, le32_to_cpu(blk->id));
2695 			}
2696 			break;
2697 
2698 		default:
2699 			adsp_err(dsp, "%s.%d: Unknown region type %x at %d\n",
2700 				 file, blocks, type, pos);
2701 			break;
2702 		}
2703 
2704 		if (reg) {
2705 			if (le32_to_cpu(blk->len) >
2706 			    firmware->size - pos - sizeof(*blk)) {
2707 				adsp_err(dsp,
2708 					 "%s.%d: %s region len %d bytes exceeds file length %zu\n",
2709 					 file, blocks, region_name,
2710 					 le32_to_cpu(blk->len),
2711 					 firmware->size);
2712 				ret = -EINVAL;
2713 				goto out_fw;
2714 			}
2715 
2716 			buf = wm_adsp_buf_alloc(blk->data,
2717 						le32_to_cpu(blk->len),
2718 						&buf_list);
2719 			if (!buf) {
2720 				adsp_err(dsp, "Out of memory\n");
2721 				ret = -ENOMEM;
2722 				goto out_fw;
2723 			}
2724 
2725 			adsp_dbg(dsp, "%s.%d: Writing %d bytes at %x\n",
2726 				 file, blocks, le32_to_cpu(blk->len),
2727 				 reg);
2728 			ret = regmap_raw_write_async(regmap, reg, buf->buf,
2729 						     le32_to_cpu(blk->len));
2730 			if (ret != 0) {
2731 				adsp_err(dsp,
2732 					"%s.%d: Failed to write to %x in %s: %d\n",
2733 					file, blocks, reg, region_name, ret);
2734 			}
2735 		}
2736 
2737 		pos += (le32_to_cpu(blk->len) + sizeof(*blk) + 3) & ~0x03;
2738 		blocks++;
2739 	}
2740 
2741 	ret = regmap_async_complete(regmap);
2742 	if (ret != 0)
2743 		adsp_err(dsp, "Failed to complete async write: %d\n", ret);
2744 
2745 	if (pos > firmware->size)
2746 		adsp_warn(dsp, "%s.%d: %zu bytes at end of file\n",
2747 			  file, blocks, pos - firmware->size);
2748 
2749 	wm_adsp_debugfs_save_binname(dsp, file);
2750 
2751 out_fw:
2752 	regmap_async_complete(regmap);
2753 	release_firmware(firmware);
2754 	wm_adsp_buf_free(&buf_list);
2755 out:
2756 	kfree(file);
2757 	return ret;
2758 }
2759 
2760 static int wm_adsp_create_name(struct wm_adsp *dsp)
2761 {
2762 	char *p;
2763 
2764 	if (!dsp->name) {
2765 		dsp->name = devm_kasprintf(dsp->dev, GFP_KERNEL, "DSP%d",
2766 					   dsp->num);
2767 		if (!dsp->name)
2768 			return -ENOMEM;
2769 	}
2770 
2771 	if (!dsp->fwf_name) {
2772 		p = devm_kstrdup(dsp->dev, dsp->name, GFP_KERNEL);
2773 		if (!p)
2774 			return -ENOMEM;
2775 
2776 		dsp->fwf_name = p;
2777 		for (; *p != 0; ++p)
2778 			*p = tolower(*p);
2779 	}
2780 
2781 	return 0;
2782 }
2783 
2784 static int wm_adsp_common_init(struct wm_adsp *dsp)
2785 {
2786 	int ret;
2787 
2788 	ret = wm_adsp_create_name(dsp);
2789 	if (ret)
2790 		return ret;
2791 
2792 	INIT_LIST_HEAD(&dsp->alg_regions);
2793 	INIT_LIST_HEAD(&dsp->ctl_list);
2794 	INIT_LIST_HEAD(&dsp->compr_list);
2795 	INIT_LIST_HEAD(&dsp->buffer_list);
2796 
2797 	mutex_init(&dsp->pwr_lock);
2798 
2799 	return 0;
2800 }
2801 
2802 int wm_adsp1_init(struct wm_adsp *dsp)
2803 {
2804 	dsp->ops = &wm_adsp1_ops;
2805 
2806 	return wm_adsp_common_init(dsp);
2807 }
2808 EXPORT_SYMBOL_GPL(wm_adsp1_init);
2809 
2810 int wm_adsp1_event(struct snd_soc_dapm_widget *w,
2811 		   struct snd_kcontrol *kcontrol,
2812 		   int event)
2813 {
2814 	struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
2815 	struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
2816 	struct wm_adsp *dsp = &dsps[w->shift];
2817 	struct wm_coeff_ctl *ctl;
2818 	int ret;
2819 	unsigned int val;
2820 
2821 	dsp->component = component;
2822 
2823 	mutex_lock(&dsp->pwr_lock);
2824 
2825 	switch (event) {
2826 	case SND_SOC_DAPM_POST_PMU:
2827 		regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2828 				   ADSP1_SYS_ENA, ADSP1_SYS_ENA);
2829 
2830 		/*
2831 		 * For simplicity set the DSP clock rate to be the
2832 		 * SYSCLK rate rather than making it configurable.
2833 		 */
2834 		if (dsp->sysclk_reg) {
2835 			ret = regmap_read(dsp->regmap, dsp->sysclk_reg, &val);
2836 			if (ret != 0) {
2837 				adsp_err(dsp, "Failed to read SYSCLK state: %d\n",
2838 				ret);
2839 				goto err_mutex;
2840 			}
2841 
2842 			val = (val & dsp->sysclk_mask) >> dsp->sysclk_shift;
2843 
2844 			ret = regmap_update_bits(dsp->regmap,
2845 						 dsp->base + ADSP1_CONTROL_31,
2846 						 ADSP1_CLK_SEL_MASK, val);
2847 			if (ret != 0) {
2848 				adsp_err(dsp, "Failed to set clock rate: %d\n",
2849 					 ret);
2850 				goto err_mutex;
2851 			}
2852 		}
2853 
2854 		ret = wm_adsp_load(dsp);
2855 		if (ret != 0)
2856 			goto err_ena;
2857 
2858 		ret = wm_adsp1_setup_algs(dsp);
2859 		if (ret != 0)
2860 			goto err_ena;
2861 
2862 		ret = wm_adsp_load_coeff(dsp);
2863 		if (ret != 0)
2864 			goto err_ena;
2865 
2866 		/* Initialize caches for enabled and unset controls */
2867 		ret = wm_coeff_init_control_caches(dsp);
2868 		if (ret != 0)
2869 			goto err_ena;
2870 
2871 		/* Sync set controls */
2872 		ret = wm_coeff_sync_controls(dsp);
2873 		if (ret != 0)
2874 			goto err_ena;
2875 
2876 		dsp->booted = true;
2877 
2878 		/* Start the core running */
2879 		regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2880 				   ADSP1_CORE_ENA | ADSP1_START,
2881 				   ADSP1_CORE_ENA | ADSP1_START);
2882 
2883 		dsp->running = true;
2884 		break;
2885 
2886 	case SND_SOC_DAPM_PRE_PMD:
2887 		dsp->running = false;
2888 		dsp->booted = false;
2889 
2890 		/* Halt the core */
2891 		regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2892 				   ADSP1_CORE_ENA | ADSP1_START, 0);
2893 
2894 		regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_19,
2895 				   ADSP1_WDMA_BUFFER_LENGTH_MASK, 0);
2896 
2897 		regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2898 				   ADSP1_SYS_ENA, 0);
2899 
2900 		list_for_each_entry(ctl, &dsp->ctl_list, list)
2901 			ctl->enabled = 0;
2902 
2903 
2904 		wm_adsp_free_alg_regions(dsp);
2905 		break;
2906 
2907 	default:
2908 		break;
2909 	}
2910 
2911 	mutex_unlock(&dsp->pwr_lock);
2912 
2913 	return 0;
2914 
2915 err_ena:
2916 	regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2917 			   ADSP1_SYS_ENA, 0);
2918 err_mutex:
2919 	mutex_unlock(&dsp->pwr_lock);
2920 
2921 	return ret;
2922 }
2923 EXPORT_SYMBOL_GPL(wm_adsp1_event);
2924 
2925 static int wm_adsp2v2_enable_core(struct wm_adsp *dsp)
2926 {
2927 	unsigned int val;
2928 	int ret, count;
2929 
2930 	/* Wait for the RAM to start, should be near instantaneous */
2931 	for (count = 0; count < 10; ++count) {
2932 		ret = regmap_read(dsp->regmap, dsp->base + ADSP2_STATUS1, &val);
2933 		if (ret != 0)
2934 			return ret;
2935 
2936 		if (val & ADSP2_RAM_RDY)
2937 			break;
2938 
2939 		usleep_range(250, 500);
2940 	}
2941 
2942 	if (!(val & ADSP2_RAM_RDY)) {
2943 		adsp_err(dsp, "Failed to start DSP RAM\n");
2944 		return -EBUSY;
2945 	}
2946 
2947 	adsp_dbg(dsp, "RAM ready after %d polls\n", count);
2948 
2949 	return 0;
2950 }
2951 
2952 static int wm_adsp2_enable_core(struct wm_adsp *dsp)
2953 {
2954 	int ret;
2955 
2956 	ret = regmap_update_bits_async(dsp->regmap, dsp->base + ADSP2_CONTROL,
2957 				       ADSP2_SYS_ENA, ADSP2_SYS_ENA);
2958 	if (ret != 0)
2959 		return ret;
2960 
2961 	return wm_adsp2v2_enable_core(dsp);
2962 }
2963 
2964 static int wm_adsp2_lock(struct wm_adsp *dsp, unsigned int lock_regions)
2965 {
2966 	struct regmap *regmap = dsp->regmap;
2967 	unsigned int code0, code1, lock_reg;
2968 
2969 	if (!(lock_regions & WM_ADSP2_REGION_ALL))
2970 		return 0;
2971 
2972 	lock_regions &= WM_ADSP2_REGION_ALL;
2973 	lock_reg = dsp->base + ADSP2_LOCK_REGION_1_LOCK_REGION_0;
2974 
2975 	while (lock_regions) {
2976 		code0 = code1 = 0;
2977 		if (lock_regions & BIT(0)) {
2978 			code0 = ADSP2_LOCK_CODE_0;
2979 			code1 = ADSP2_LOCK_CODE_1;
2980 		}
2981 		if (lock_regions & BIT(1)) {
2982 			code0 |= ADSP2_LOCK_CODE_0 << ADSP2_LOCK_REGION_SHIFT;
2983 			code1 |= ADSP2_LOCK_CODE_1 << ADSP2_LOCK_REGION_SHIFT;
2984 		}
2985 		regmap_write(regmap, lock_reg, code0);
2986 		regmap_write(regmap, lock_reg, code1);
2987 		lock_regions >>= 2;
2988 		lock_reg += 2;
2989 	}
2990 
2991 	return 0;
2992 }
2993 
2994 static int wm_adsp2_enable_memory(struct wm_adsp *dsp)
2995 {
2996 	return regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
2997 				  ADSP2_MEM_ENA, ADSP2_MEM_ENA);
2998 }
2999 
3000 static void wm_adsp2_disable_memory(struct wm_adsp *dsp)
3001 {
3002 	regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
3003 			   ADSP2_MEM_ENA, 0);
3004 }
3005 
3006 static void wm_adsp2_disable_core(struct wm_adsp *dsp)
3007 {
3008 	regmap_write(dsp->regmap, dsp->base + ADSP2_RDMA_CONFIG_1, 0);
3009 	regmap_write(dsp->regmap, dsp->base + ADSP2_WDMA_CONFIG_1, 0);
3010 	regmap_write(dsp->regmap, dsp->base + ADSP2_WDMA_CONFIG_2, 0);
3011 
3012 	regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
3013 			   ADSP2_SYS_ENA, 0);
3014 }
3015 
3016 static void wm_adsp2v2_disable_core(struct wm_adsp *dsp)
3017 {
3018 	regmap_write(dsp->regmap, dsp->base + ADSP2_RDMA_CONFIG_1, 0);
3019 	regmap_write(dsp->regmap, dsp->base + ADSP2_WDMA_CONFIG_1, 0);
3020 	regmap_write(dsp->regmap, dsp->base + ADSP2V2_WDMA_CONFIG_2, 0);
3021 }
3022 
3023 static void wm_adsp_boot_work(struct work_struct *work)
3024 {
3025 	struct wm_adsp *dsp = container_of(work,
3026 					   struct wm_adsp,
3027 					   boot_work);
3028 	int ret;
3029 
3030 	mutex_lock(&dsp->pwr_lock);
3031 
3032 	if (dsp->ops->enable_memory) {
3033 		ret = dsp->ops->enable_memory(dsp);
3034 		if (ret != 0)
3035 			goto err_mutex;
3036 	}
3037 
3038 	if (dsp->ops->enable_core) {
3039 		ret = dsp->ops->enable_core(dsp);
3040 		if (ret != 0)
3041 			goto err_mem;
3042 	}
3043 
3044 	ret = wm_adsp_load(dsp);
3045 	if (ret != 0)
3046 		goto err_ena;
3047 
3048 	ret = dsp->ops->setup_algs(dsp);
3049 	if (ret != 0)
3050 		goto err_ena;
3051 
3052 	ret = wm_adsp_load_coeff(dsp);
3053 	if (ret != 0)
3054 		goto err_ena;
3055 
3056 	/* Initialize caches for enabled and unset controls */
3057 	ret = wm_coeff_init_control_caches(dsp);
3058 	if (ret != 0)
3059 		goto err_ena;
3060 
3061 	if (dsp->ops->disable_core)
3062 		dsp->ops->disable_core(dsp);
3063 
3064 	dsp->booted = true;
3065 
3066 	mutex_unlock(&dsp->pwr_lock);
3067 
3068 	return;
3069 
3070 err_ena:
3071 	if (dsp->ops->disable_core)
3072 		dsp->ops->disable_core(dsp);
3073 err_mem:
3074 	if (dsp->ops->disable_memory)
3075 		dsp->ops->disable_memory(dsp);
3076 err_mutex:
3077 	mutex_unlock(&dsp->pwr_lock);
3078 }
3079 
3080 static int wm_halo_configure_mpu(struct wm_adsp *dsp, unsigned int lock_regions)
3081 {
3082 	struct reg_sequence config[] = {
3083 		{ dsp->base + HALO_MPU_LOCK_CONFIG,     0x5555 },
3084 		{ dsp->base + HALO_MPU_LOCK_CONFIG,     0xAAAA },
3085 		{ dsp->base + HALO_MPU_XMEM_ACCESS_0,   0xFFFFFFFF },
3086 		{ dsp->base + HALO_MPU_YMEM_ACCESS_0,   0xFFFFFFFF },
3087 		{ dsp->base + HALO_MPU_WINDOW_ACCESS_0, lock_regions },
3088 		{ dsp->base + HALO_MPU_XREG_ACCESS_0,   lock_regions },
3089 		{ dsp->base + HALO_MPU_YREG_ACCESS_0,   lock_regions },
3090 		{ dsp->base + HALO_MPU_XMEM_ACCESS_1,   0xFFFFFFFF },
3091 		{ dsp->base + HALO_MPU_YMEM_ACCESS_1,   0xFFFFFFFF },
3092 		{ dsp->base + HALO_MPU_WINDOW_ACCESS_1, lock_regions },
3093 		{ dsp->base + HALO_MPU_XREG_ACCESS_1,   lock_regions },
3094 		{ dsp->base + HALO_MPU_YREG_ACCESS_1,   lock_regions },
3095 		{ dsp->base + HALO_MPU_XMEM_ACCESS_2,   0xFFFFFFFF },
3096 		{ dsp->base + HALO_MPU_YMEM_ACCESS_2,   0xFFFFFFFF },
3097 		{ dsp->base + HALO_MPU_WINDOW_ACCESS_2, lock_regions },
3098 		{ dsp->base + HALO_MPU_XREG_ACCESS_2,   lock_regions },
3099 		{ dsp->base + HALO_MPU_YREG_ACCESS_2,   lock_regions },
3100 		{ dsp->base + HALO_MPU_XMEM_ACCESS_3,   0xFFFFFFFF },
3101 		{ dsp->base + HALO_MPU_YMEM_ACCESS_3,   0xFFFFFFFF },
3102 		{ dsp->base + HALO_MPU_WINDOW_ACCESS_3, lock_regions },
3103 		{ dsp->base + HALO_MPU_XREG_ACCESS_3,   lock_regions },
3104 		{ dsp->base + HALO_MPU_YREG_ACCESS_3,   lock_regions },
3105 		{ dsp->base + HALO_MPU_LOCK_CONFIG,     0 },
3106 	};
3107 
3108 	return regmap_multi_reg_write(dsp->regmap, config, ARRAY_SIZE(config));
3109 }
3110 
3111 int wm_adsp2_set_dspclk(struct snd_soc_dapm_widget *w, unsigned int freq)
3112 {
3113 	struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
3114 	struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
3115 	struct wm_adsp *dsp = &dsps[w->shift];
3116 	int ret;
3117 
3118 	ret = regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CLOCKING,
3119 				 ADSP2_CLK_SEL_MASK,
3120 				 freq << ADSP2_CLK_SEL_SHIFT);
3121 	if (ret)
3122 		adsp_err(dsp, "Failed to set clock rate: %d\n", ret);
3123 
3124 	return ret;
3125 }
3126 EXPORT_SYMBOL_GPL(wm_adsp2_set_dspclk);
3127 
3128 int wm_adsp2_preloader_get(struct snd_kcontrol *kcontrol,
3129 			   struct snd_ctl_elem_value *ucontrol)
3130 {
3131 	struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
3132 	struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
3133 	struct soc_mixer_control *mc =
3134 		(struct soc_mixer_control *)kcontrol->private_value;
3135 	struct wm_adsp *dsp = &dsps[mc->shift - 1];
3136 
3137 	ucontrol->value.integer.value[0] = dsp->preloaded;
3138 
3139 	return 0;
3140 }
3141 EXPORT_SYMBOL_GPL(wm_adsp2_preloader_get);
3142 
3143 int wm_adsp2_preloader_put(struct snd_kcontrol *kcontrol,
3144 			   struct snd_ctl_elem_value *ucontrol)
3145 {
3146 	struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
3147 	struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
3148 	struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(component);
3149 	struct soc_mixer_control *mc =
3150 		(struct soc_mixer_control *)kcontrol->private_value;
3151 	struct wm_adsp *dsp = &dsps[mc->shift - 1];
3152 	char preload[32];
3153 
3154 	snprintf(preload, ARRAY_SIZE(preload), "%s Preload", dsp->name);
3155 
3156 	dsp->preloaded = ucontrol->value.integer.value[0];
3157 
3158 	if (ucontrol->value.integer.value[0])
3159 		snd_soc_component_force_enable_pin(component, preload);
3160 	else
3161 		snd_soc_component_disable_pin(component, preload);
3162 
3163 	snd_soc_dapm_sync(dapm);
3164 
3165 	flush_work(&dsp->boot_work);
3166 
3167 	return 0;
3168 }
3169 EXPORT_SYMBOL_GPL(wm_adsp2_preloader_put);
3170 
3171 static void wm_adsp_stop_watchdog(struct wm_adsp *dsp)
3172 {
3173 	regmap_update_bits(dsp->regmap, dsp->base + ADSP2_WATCHDOG,
3174 			   ADSP2_WDT_ENA_MASK, 0);
3175 }
3176 
3177 static void wm_halo_stop_watchdog(struct wm_adsp *dsp)
3178 {
3179 	regmap_update_bits(dsp->regmap, dsp->base + HALO_WDT_CONTROL,
3180 			   HALO_WDT_EN_MASK, 0);
3181 }
3182 
3183 int wm_adsp_early_event(struct snd_soc_dapm_widget *w,
3184 			struct snd_kcontrol *kcontrol, int event)
3185 {
3186 	struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
3187 	struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
3188 	struct wm_adsp *dsp = &dsps[w->shift];
3189 	struct wm_coeff_ctl *ctl;
3190 
3191 	switch (event) {
3192 	case SND_SOC_DAPM_PRE_PMU:
3193 		queue_work(system_unbound_wq, &dsp->boot_work);
3194 		break;
3195 	case SND_SOC_DAPM_PRE_PMD:
3196 		mutex_lock(&dsp->pwr_lock);
3197 
3198 		wm_adsp_debugfs_clear(dsp);
3199 
3200 		dsp->fw_id = 0;
3201 		dsp->fw_id_version = 0;
3202 
3203 		dsp->booted = false;
3204 
3205 		if (dsp->ops->disable_memory)
3206 			dsp->ops->disable_memory(dsp);
3207 
3208 		list_for_each_entry(ctl, &dsp->ctl_list, list)
3209 			ctl->enabled = 0;
3210 
3211 		wm_adsp_free_alg_regions(dsp);
3212 
3213 		mutex_unlock(&dsp->pwr_lock);
3214 
3215 		adsp_dbg(dsp, "Shutdown complete\n");
3216 		break;
3217 	default:
3218 		break;
3219 	}
3220 
3221 	return 0;
3222 }
3223 EXPORT_SYMBOL_GPL(wm_adsp_early_event);
3224 
3225 static int wm_adsp2_start_core(struct wm_adsp *dsp)
3226 {
3227 	return regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
3228 				 ADSP2_CORE_ENA | ADSP2_START,
3229 				 ADSP2_CORE_ENA | ADSP2_START);
3230 }
3231 
3232 static void wm_adsp2_stop_core(struct wm_adsp *dsp)
3233 {
3234 	regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
3235 			   ADSP2_CORE_ENA | ADSP2_START, 0);
3236 }
3237 
3238 int wm_adsp_event(struct snd_soc_dapm_widget *w,
3239 		  struct snd_kcontrol *kcontrol, int event)
3240 {
3241 	struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
3242 	struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
3243 	struct wm_adsp *dsp = &dsps[w->shift];
3244 	int ret;
3245 
3246 	switch (event) {
3247 	case SND_SOC_DAPM_POST_PMU:
3248 		flush_work(&dsp->boot_work);
3249 
3250 		mutex_lock(&dsp->pwr_lock);
3251 
3252 		if (!dsp->booted) {
3253 			ret = -EIO;
3254 			goto err;
3255 		}
3256 
3257 		if (dsp->ops->enable_core) {
3258 			ret = dsp->ops->enable_core(dsp);
3259 			if (ret != 0)
3260 				goto err;
3261 		}
3262 
3263 		/* Sync set controls */
3264 		ret = wm_coeff_sync_controls(dsp);
3265 		if (ret != 0)
3266 			goto err;
3267 
3268 		if (dsp->ops->lock_memory) {
3269 			ret = dsp->ops->lock_memory(dsp, dsp->lock_regions);
3270 			if (ret != 0) {
3271 				adsp_err(dsp, "Error configuring MPU: %d\n",
3272 					 ret);
3273 				goto err;
3274 			}
3275 		}
3276 
3277 		if (dsp->ops->start_core) {
3278 			ret = dsp->ops->start_core(dsp);
3279 			if (ret != 0)
3280 				goto err;
3281 		}
3282 
3283 		if (wm_adsp_fw[dsp->fw].num_caps != 0) {
3284 			ret = wm_adsp_buffer_init(dsp);
3285 			if (ret < 0)
3286 				goto err;
3287 		}
3288 
3289 		dsp->running = true;
3290 
3291 		mutex_unlock(&dsp->pwr_lock);
3292 		break;
3293 
3294 	case SND_SOC_DAPM_PRE_PMD:
3295 		/* Tell the firmware to cleanup */
3296 		wm_adsp_signal_event_controls(dsp, WM_ADSP_FW_EVENT_SHUTDOWN);
3297 
3298 		if (dsp->ops->stop_watchdog)
3299 			dsp->ops->stop_watchdog(dsp);
3300 
3301 		/* Log firmware state, it can be useful for analysis */
3302 		if (dsp->ops->show_fw_status)
3303 			dsp->ops->show_fw_status(dsp);
3304 
3305 		mutex_lock(&dsp->pwr_lock);
3306 
3307 		dsp->running = false;
3308 
3309 		if (dsp->ops->stop_core)
3310 			dsp->ops->stop_core(dsp);
3311 		if (dsp->ops->disable_core)
3312 			dsp->ops->disable_core(dsp);
3313 
3314 		if (wm_adsp_fw[dsp->fw].num_caps != 0)
3315 			wm_adsp_buffer_free(dsp);
3316 
3317 		dsp->fatal_error = false;
3318 
3319 		mutex_unlock(&dsp->pwr_lock);
3320 
3321 		adsp_dbg(dsp, "Execution stopped\n");
3322 		break;
3323 
3324 	default:
3325 		break;
3326 	}
3327 
3328 	return 0;
3329 err:
3330 	if (dsp->ops->stop_core)
3331 		dsp->ops->stop_core(dsp);
3332 	if (dsp->ops->disable_core)
3333 		dsp->ops->disable_core(dsp);
3334 	mutex_unlock(&dsp->pwr_lock);
3335 	return ret;
3336 }
3337 EXPORT_SYMBOL_GPL(wm_adsp_event);
3338 
3339 static int wm_halo_start_core(struct wm_adsp *dsp)
3340 {
3341 	return regmap_update_bits(dsp->regmap,
3342 				  dsp->base + HALO_CCM_CORE_CONTROL,
3343 				  HALO_CORE_EN, HALO_CORE_EN);
3344 }
3345 
3346 static void wm_halo_stop_core(struct wm_adsp *dsp)
3347 {
3348 	regmap_update_bits(dsp->regmap, dsp->base + HALO_CCM_CORE_CONTROL,
3349 			   HALO_CORE_EN, 0);
3350 
3351 	/* reset halo core with CORE_SOFT_RESET */
3352 	regmap_update_bits(dsp->regmap, dsp->base + HALO_CORE_SOFT_RESET,
3353 			   HALO_CORE_SOFT_RESET_MASK, 1);
3354 }
3355 
3356 int wm_adsp2_component_probe(struct wm_adsp *dsp, struct snd_soc_component *component)
3357 {
3358 	char preload[32];
3359 
3360 	snprintf(preload, ARRAY_SIZE(preload), "%s Preload", dsp->name);
3361 	snd_soc_component_disable_pin(component, preload);
3362 
3363 	wm_adsp2_init_debugfs(dsp, component);
3364 
3365 	dsp->component = component;
3366 
3367 	return 0;
3368 }
3369 EXPORT_SYMBOL_GPL(wm_adsp2_component_probe);
3370 
3371 int wm_adsp2_component_remove(struct wm_adsp *dsp, struct snd_soc_component *component)
3372 {
3373 	wm_adsp2_cleanup_debugfs(dsp);
3374 
3375 	return 0;
3376 }
3377 EXPORT_SYMBOL_GPL(wm_adsp2_component_remove);
3378 
3379 int wm_adsp2_init(struct wm_adsp *dsp)
3380 {
3381 	int ret;
3382 
3383 	ret = wm_adsp_common_init(dsp);
3384 	if (ret)
3385 		return ret;
3386 
3387 	switch (dsp->rev) {
3388 	case 0:
3389 		/*
3390 		 * Disable the DSP memory by default when in reset for a small
3391 		 * power saving.
3392 		 */
3393 		ret = regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
3394 					 ADSP2_MEM_ENA, 0);
3395 		if (ret) {
3396 			adsp_err(dsp,
3397 				 "Failed to clear memory retention: %d\n", ret);
3398 			return ret;
3399 		}
3400 
3401 		dsp->ops = &wm_adsp2_ops[0];
3402 		break;
3403 	case 1:
3404 		dsp->ops = &wm_adsp2_ops[1];
3405 		break;
3406 	default:
3407 		dsp->ops = &wm_adsp2_ops[2];
3408 		break;
3409 	}
3410 
3411 	INIT_WORK(&dsp->boot_work, wm_adsp_boot_work);
3412 
3413 	return 0;
3414 }
3415 EXPORT_SYMBOL_GPL(wm_adsp2_init);
3416 
3417 int wm_halo_init(struct wm_adsp *dsp)
3418 {
3419 	int ret;
3420 
3421 	ret = wm_adsp_common_init(dsp);
3422 	if (ret)
3423 		return ret;
3424 
3425 	dsp->ops = &wm_halo_ops;
3426 
3427 	INIT_WORK(&dsp->boot_work, wm_adsp_boot_work);
3428 
3429 	return 0;
3430 }
3431 EXPORT_SYMBOL_GPL(wm_halo_init);
3432 
3433 void wm_adsp2_remove(struct wm_adsp *dsp)
3434 {
3435 	struct wm_coeff_ctl *ctl;
3436 
3437 	while (!list_empty(&dsp->ctl_list)) {
3438 		ctl = list_first_entry(&dsp->ctl_list, struct wm_coeff_ctl,
3439 					list);
3440 		list_del(&ctl->list);
3441 		wm_adsp_free_ctl_blk(ctl);
3442 	}
3443 }
3444 EXPORT_SYMBOL_GPL(wm_adsp2_remove);
3445 
3446 static inline int wm_adsp_compr_attached(struct wm_adsp_compr *compr)
3447 {
3448 	return compr->buf != NULL;
3449 }
3450 
3451 static int wm_adsp_compr_attach(struct wm_adsp_compr *compr)
3452 {
3453 	struct wm_adsp_compr_buf *buf = NULL, *tmp;
3454 
3455 	if (compr->dsp->fatal_error)
3456 		return -EINVAL;
3457 
3458 	list_for_each_entry(tmp, &compr->dsp->buffer_list, list) {
3459 		if (!tmp->name || !strcmp(compr->name, tmp->name)) {
3460 			buf = tmp;
3461 			break;
3462 		}
3463 	}
3464 
3465 	if (!buf)
3466 		return -EINVAL;
3467 
3468 	compr->buf = buf;
3469 	buf->compr = compr;
3470 
3471 	return 0;
3472 }
3473 
3474 static void wm_adsp_compr_detach(struct wm_adsp_compr *compr)
3475 {
3476 	if (!compr)
3477 		return;
3478 
3479 	/* Wake the poll so it can see buffer is no longer attached */
3480 	if (compr->stream)
3481 		snd_compr_fragment_elapsed(compr->stream);
3482 
3483 	if (wm_adsp_compr_attached(compr)) {
3484 		compr->buf->compr = NULL;
3485 		compr->buf = NULL;
3486 	}
3487 }
3488 
3489 int wm_adsp_compr_open(struct wm_adsp *dsp, struct snd_compr_stream *stream)
3490 {
3491 	struct wm_adsp_compr *compr, *tmp;
3492 	struct snd_soc_pcm_runtime *rtd = stream->private_data;
3493 	int ret = 0;
3494 
3495 	mutex_lock(&dsp->pwr_lock);
3496 
3497 	if (wm_adsp_fw[dsp->fw].num_caps == 0) {
3498 		adsp_err(dsp, "%s: Firmware does not support compressed API\n",
3499 			 asoc_rtd_to_codec(rtd, 0)->name);
3500 		ret = -ENXIO;
3501 		goto out;
3502 	}
3503 
3504 	if (wm_adsp_fw[dsp->fw].compr_direction != stream->direction) {
3505 		adsp_err(dsp, "%s: Firmware does not support stream direction\n",
3506 			 asoc_rtd_to_codec(rtd, 0)->name);
3507 		ret = -EINVAL;
3508 		goto out;
3509 	}
3510 
3511 	list_for_each_entry(tmp, &dsp->compr_list, list) {
3512 		if (!strcmp(tmp->name, asoc_rtd_to_codec(rtd, 0)->name)) {
3513 			adsp_err(dsp, "%s: Only a single stream supported per dai\n",
3514 				 asoc_rtd_to_codec(rtd, 0)->name);
3515 			ret = -EBUSY;
3516 			goto out;
3517 		}
3518 	}
3519 
3520 	compr = kzalloc(sizeof(*compr), GFP_KERNEL);
3521 	if (!compr) {
3522 		ret = -ENOMEM;
3523 		goto out;
3524 	}
3525 
3526 	compr->dsp = dsp;
3527 	compr->stream = stream;
3528 	compr->name = asoc_rtd_to_codec(rtd, 0)->name;
3529 
3530 	list_add_tail(&compr->list, &dsp->compr_list);
3531 
3532 	stream->runtime->private_data = compr;
3533 
3534 out:
3535 	mutex_unlock(&dsp->pwr_lock);
3536 
3537 	return ret;
3538 }
3539 EXPORT_SYMBOL_GPL(wm_adsp_compr_open);
3540 
3541 int wm_adsp_compr_free(struct snd_soc_component *component,
3542 		       struct snd_compr_stream *stream)
3543 {
3544 	struct wm_adsp_compr *compr = stream->runtime->private_data;
3545 	struct wm_adsp *dsp = compr->dsp;
3546 
3547 	mutex_lock(&dsp->pwr_lock);
3548 
3549 	wm_adsp_compr_detach(compr);
3550 	list_del(&compr->list);
3551 
3552 	kfree(compr->raw_buf);
3553 	kfree(compr);
3554 
3555 	mutex_unlock(&dsp->pwr_lock);
3556 
3557 	return 0;
3558 }
3559 EXPORT_SYMBOL_GPL(wm_adsp_compr_free);
3560 
3561 static int wm_adsp_compr_check_params(struct snd_compr_stream *stream,
3562 				      struct snd_compr_params *params)
3563 {
3564 	struct wm_adsp_compr *compr = stream->runtime->private_data;
3565 	struct wm_adsp *dsp = compr->dsp;
3566 	const struct wm_adsp_fw_caps *caps;
3567 	const struct snd_codec_desc *desc;
3568 	int i, j;
3569 
3570 	if (params->buffer.fragment_size < WM_ADSP_MIN_FRAGMENT_SIZE ||
3571 	    params->buffer.fragment_size > WM_ADSP_MAX_FRAGMENT_SIZE ||
3572 	    params->buffer.fragments < WM_ADSP_MIN_FRAGMENTS ||
3573 	    params->buffer.fragments > WM_ADSP_MAX_FRAGMENTS ||
3574 	    params->buffer.fragment_size % WM_ADSP_DATA_WORD_SIZE) {
3575 		compr_err(compr, "Invalid buffer fragsize=%d fragments=%d\n",
3576 			  params->buffer.fragment_size,
3577 			  params->buffer.fragments);
3578 
3579 		return -EINVAL;
3580 	}
3581 
3582 	for (i = 0; i < wm_adsp_fw[dsp->fw].num_caps; i++) {
3583 		caps = &wm_adsp_fw[dsp->fw].caps[i];
3584 		desc = &caps->desc;
3585 
3586 		if (caps->id != params->codec.id)
3587 			continue;
3588 
3589 		if (stream->direction == SND_COMPRESS_PLAYBACK) {
3590 			if (desc->max_ch < params->codec.ch_out)
3591 				continue;
3592 		} else {
3593 			if (desc->max_ch < params->codec.ch_in)
3594 				continue;
3595 		}
3596 
3597 		if (!(desc->formats & (1 << params->codec.format)))
3598 			continue;
3599 
3600 		for (j = 0; j < desc->num_sample_rates; ++j)
3601 			if (desc->sample_rates[j] == params->codec.sample_rate)
3602 				return 0;
3603 	}
3604 
3605 	compr_err(compr, "Invalid params id=%u ch=%u,%u rate=%u fmt=%u\n",
3606 		  params->codec.id, params->codec.ch_in, params->codec.ch_out,
3607 		  params->codec.sample_rate, params->codec.format);
3608 	return -EINVAL;
3609 }
3610 
3611 static inline unsigned int wm_adsp_compr_frag_words(struct wm_adsp_compr *compr)
3612 {
3613 	return compr->size.fragment_size / WM_ADSP_DATA_WORD_SIZE;
3614 }
3615 
3616 int wm_adsp_compr_set_params(struct snd_soc_component *component,
3617 			     struct snd_compr_stream *stream,
3618 			     struct snd_compr_params *params)
3619 {
3620 	struct wm_adsp_compr *compr = stream->runtime->private_data;
3621 	unsigned int size;
3622 	int ret;
3623 
3624 	ret = wm_adsp_compr_check_params(stream, params);
3625 	if (ret)
3626 		return ret;
3627 
3628 	compr->size = params->buffer;
3629 
3630 	compr_dbg(compr, "fragment_size=%d fragments=%d\n",
3631 		  compr->size.fragment_size, compr->size.fragments);
3632 
3633 	size = wm_adsp_compr_frag_words(compr) * sizeof(*compr->raw_buf);
3634 	compr->raw_buf = kmalloc(size, GFP_DMA | GFP_KERNEL);
3635 	if (!compr->raw_buf)
3636 		return -ENOMEM;
3637 
3638 	compr->sample_rate = params->codec.sample_rate;
3639 
3640 	return 0;
3641 }
3642 EXPORT_SYMBOL_GPL(wm_adsp_compr_set_params);
3643 
3644 int wm_adsp_compr_get_caps(struct snd_soc_component *component,
3645 			   struct snd_compr_stream *stream,
3646 			   struct snd_compr_caps *caps)
3647 {
3648 	struct wm_adsp_compr *compr = stream->runtime->private_data;
3649 	int fw = compr->dsp->fw;
3650 	int i;
3651 
3652 	if (wm_adsp_fw[fw].caps) {
3653 		for (i = 0; i < wm_adsp_fw[fw].num_caps; i++)
3654 			caps->codecs[i] = wm_adsp_fw[fw].caps[i].id;
3655 
3656 		caps->num_codecs = i;
3657 		caps->direction = wm_adsp_fw[fw].compr_direction;
3658 
3659 		caps->min_fragment_size = WM_ADSP_MIN_FRAGMENT_SIZE;
3660 		caps->max_fragment_size = WM_ADSP_MAX_FRAGMENT_SIZE;
3661 		caps->min_fragments = WM_ADSP_MIN_FRAGMENTS;
3662 		caps->max_fragments = WM_ADSP_MAX_FRAGMENTS;
3663 	}
3664 
3665 	return 0;
3666 }
3667 EXPORT_SYMBOL_GPL(wm_adsp_compr_get_caps);
3668 
3669 static int wm_adsp_read_raw_data_block(struct wm_adsp *dsp, int mem_type,
3670 				       unsigned int mem_addr,
3671 				       unsigned int num_words, __be32 *data)
3672 {
3673 	struct wm_adsp_region const *mem = wm_adsp_find_region(dsp, mem_type);
3674 	unsigned int reg;
3675 	int ret;
3676 
3677 	if (!mem)
3678 		return -EINVAL;
3679 
3680 	reg = dsp->ops->region_to_reg(mem, mem_addr);
3681 
3682 	ret = regmap_raw_read(dsp->regmap, reg, data,
3683 			      sizeof(*data) * num_words);
3684 	if (ret < 0)
3685 		return ret;
3686 
3687 	return 0;
3688 }
3689 
3690 static inline int wm_adsp_read_data_word(struct wm_adsp *dsp, int mem_type,
3691 					 unsigned int mem_addr, u32 *data)
3692 {
3693 	__be32 raw;
3694 	int ret;
3695 
3696 	ret = wm_adsp_read_raw_data_block(dsp, mem_type, mem_addr, 1, &raw);
3697 	if (ret < 0)
3698 		return ret;
3699 
3700 	*data = be32_to_cpu(raw) & 0x00ffffffu;
3701 
3702 	return 0;
3703 }
3704 
3705 static int wm_adsp_write_data_word(struct wm_adsp *dsp, int mem_type,
3706 				   unsigned int mem_addr, u32 data)
3707 {
3708 	struct wm_adsp_region const *mem = wm_adsp_find_region(dsp, mem_type);
3709 	__be32 val = cpu_to_be32(data & 0x00ffffffu);
3710 	unsigned int reg;
3711 
3712 	if (!mem)
3713 		return -EINVAL;
3714 
3715 	reg = dsp->ops->region_to_reg(mem, mem_addr);
3716 
3717 	return regmap_raw_write(dsp->regmap, reg, &val, sizeof(val));
3718 }
3719 
3720 static inline int wm_adsp_buffer_read(struct wm_adsp_compr_buf *buf,
3721 				      unsigned int field_offset, u32 *data)
3722 {
3723 	return wm_adsp_read_data_word(buf->dsp, buf->host_buf_mem_type,
3724 				      buf->host_buf_ptr + field_offset, data);
3725 }
3726 
3727 static inline int wm_adsp_buffer_write(struct wm_adsp_compr_buf *buf,
3728 				       unsigned int field_offset, u32 data)
3729 {
3730 	return wm_adsp_write_data_word(buf->dsp, buf->host_buf_mem_type,
3731 				       buf->host_buf_ptr + field_offset, data);
3732 }
3733 
3734 static void wm_adsp_remove_padding(u32 *buf, int nwords)
3735 {
3736 	const __be32 *pack_in = (__be32 *)buf;
3737 	u8 *pack_out = (u8 *)buf;
3738 	int i;
3739 
3740 	/*
3741 	 * DSP words from the register map have pad bytes and the data bytes
3742 	 * are in swapped order. This swaps back to the original little-endian
3743 	 * order and strips the pad bytes.
3744 	 */
3745 	for (i = 0; i < nwords; i++) {
3746 		u32 word = be32_to_cpu(*pack_in++);
3747 		*pack_out++ = (u8)word;
3748 		*pack_out++ = (u8)(word >> 8);
3749 		*pack_out++ = (u8)(word >> 16);
3750 	}
3751 }
3752 
3753 static int wm_adsp_buffer_populate(struct wm_adsp_compr_buf *buf)
3754 {
3755 	const struct wm_adsp_fw_caps *caps = wm_adsp_fw[buf->dsp->fw].caps;
3756 	struct wm_adsp_buffer_region *region;
3757 	u32 offset = 0;
3758 	int i, ret;
3759 
3760 	buf->regions = kcalloc(caps->num_regions, sizeof(*buf->regions),
3761 			       GFP_KERNEL);
3762 	if (!buf->regions)
3763 		return -ENOMEM;
3764 
3765 	for (i = 0; i < caps->num_regions; ++i) {
3766 		region = &buf->regions[i];
3767 
3768 		region->offset = offset;
3769 		region->mem_type = caps->region_defs[i].mem_type;
3770 
3771 		ret = wm_adsp_buffer_read(buf, caps->region_defs[i].base_offset,
3772 					  &region->base_addr);
3773 		if (ret < 0)
3774 			return ret;
3775 
3776 		ret = wm_adsp_buffer_read(buf, caps->region_defs[i].size_offset,
3777 					  &offset);
3778 		if (ret < 0)
3779 			return ret;
3780 
3781 		region->cumulative_size = offset;
3782 
3783 		compr_dbg(buf,
3784 			  "region=%d type=%d base=%08x off=%08x size=%08x\n",
3785 			  i, region->mem_type, region->base_addr,
3786 			  region->offset, region->cumulative_size);
3787 	}
3788 
3789 	return 0;
3790 }
3791 
3792 static void wm_adsp_buffer_clear(struct wm_adsp_compr_buf *buf)
3793 {
3794 	buf->irq_count = 0xFFFFFFFF;
3795 	buf->read_index = -1;
3796 	buf->avail = 0;
3797 }
3798 
3799 static struct wm_adsp_compr_buf *wm_adsp_buffer_alloc(struct wm_adsp *dsp)
3800 {
3801 	struct wm_adsp_compr_buf *buf;
3802 
3803 	buf = kzalloc(sizeof(*buf), GFP_KERNEL);
3804 	if (!buf)
3805 		return NULL;
3806 
3807 	buf->dsp = dsp;
3808 
3809 	wm_adsp_buffer_clear(buf);
3810 
3811 	list_add_tail(&buf->list, &dsp->buffer_list);
3812 
3813 	return buf;
3814 }
3815 
3816 static int wm_adsp_buffer_parse_legacy(struct wm_adsp *dsp)
3817 {
3818 	struct wm_adsp_alg_region *alg_region;
3819 	struct wm_adsp_compr_buf *buf;
3820 	u32 xmalg, addr, magic;
3821 	int i, ret;
3822 
3823 	alg_region = wm_adsp_find_alg_region(dsp, WMFW_ADSP2_XM, dsp->fw_id);
3824 	if (!alg_region) {
3825 		adsp_err(dsp, "No algorithm region found\n");
3826 		return -EINVAL;
3827 	}
3828 
3829 	buf = wm_adsp_buffer_alloc(dsp);
3830 	if (!buf)
3831 		return -ENOMEM;
3832 
3833 	xmalg = dsp->ops->sys_config_size / sizeof(__be32);
3834 
3835 	addr = alg_region->base + xmalg + ALG_XM_FIELD(magic);
3836 	ret = wm_adsp_read_data_word(dsp, WMFW_ADSP2_XM, addr, &magic);
3837 	if (ret < 0)
3838 		return ret;
3839 
3840 	if (magic != WM_ADSP_ALG_XM_STRUCT_MAGIC)
3841 		return -ENODEV;
3842 
3843 	addr = alg_region->base + xmalg + ALG_XM_FIELD(host_buf_ptr);
3844 	for (i = 0; i < 5; ++i) {
3845 		ret = wm_adsp_read_data_word(dsp, WMFW_ADSP2_XM, addr,
3846 					     &buf->host_buf_ptr);
3847 		if (ret < 0)
3848 			return ret;
3849 
3850 		if (buf->host_buf_ptr)
3851 			break;
3852 
3853 		usleep_range(1000, 2000);
3854 	}
3855 
3856 	if (!buf->host_buf_ptr)
3857 		return -EIO;
3858 
3859 	buf->host_buf_mem_type = WMFW_ADSP2_XM;
3860 
3861 	ret = wm_adsp_buffer_populate(buf);
3862 	if (ret < 0)
3863 		return ret;
3864 
3865 	compr_dbg(buf, "legacy host_buf_ptr=%x\n", buf->host_buf_ptr);
3866 
3867 	return 0;
3868 }
3869 
3870 static int wm_adsp_buffer_parse_coeff(struct wm_coeff_ctl *ctl)
3871 {
3872 	struct wm_adsp_host_buf_coeff_v1 coeff_v1;
3873 	struct wm_adsp_compr_buf *buf;
3874 	unsigned int reg, version;
3875 	__be32 bufp;
3876 	int ret, i;
3877 
3878 	ret = wm_coeff_base_reg(ctl, &reg);
3879 	if (ret)
3880 		return ret;
3881 
3882 	for (i = 0; i < 5; ++i) {
3883 		ret = regmap_raw_read(ctl->dsp->regmap, reg, &bufp, sizeof(bufp));
3884 		if (ret < 0)
3885 			return ret;
3886 
3887 		if (bufp)
3888 			break;
3889 
3890 		usleep_range(1000, 2000);
3891 	}
3892 
3893 	if (!bufp) {
3894 		adsp_err(ctl->dsp, "Failed to acquire host buffer\n");
3895 		return -EIO;
3896 	}
3897 
3898 	buf = wm_adsp_buffer_alloc(ctl->dsp);
3899 	if (!buf)
3900 		return -ENOMEM;
3901 
3902 	buf->host_buf_mem_type = ctl->alg_region.type;
3903 	buf->host_buf_ptr = be32_to_cpu(bufp);
3904 
3905 	ret = wm_adsp_buffer_populate(buf);
3906 	if (ret < 0)
3907 		return ret;
3908 
3909 	/*
3910 	 * v0 host_buffer coefficients didn't have versioning, so if the
3911 	 * control is one word, assume version 0.
3912 	 */
3913 	if (ctl->len == 4) {
3914 		compr_dbg(buf, "host_buf_ptr=%x\n", buf->host_buf_ptr);
3915 		return 0;
3916 	}
3917 
3918 	ret = regmap_raw_read(ctl->dsp->regmap, reg, &coeff_v1,
3919 			      sizeof(coeff_v1));
3920 	if (ret < 0)
3921 		return ret;
3922 
3923 	version = be32_to_cpu(coeff_v1.versions) & HOST_BUF_COEFF_COMPAT_VER_MASK;
3924 	version >>= HOST_BUF_COEFF_COMPAT_VER_SHIFT;
3925 
3926 	if (version > HOST_BUF_COEFF_SUPPORTED_COMPAT_VER) {
3927 		adsp_err(ctl->dsp,
3928 			 "Host buffer coeff ver %u > supported version %u\n",
3929 			 version, HOST_BUF_COEFF_SUPPORTED_COMPAT_VER);
3930 		return -EINVAL;
3931 	}
3932 
3933 	wm_adsp_remove_padding((u32 *)&coeff_v1.name, ARRAY_SIZE(coeff_v1.name));
3934 
3935 	buf->name = kasprintf(GFP_KERNEL, "%s-dsp-%s", ctl->dsp->part,
3936 			      (char *)&coeff_v1.name);
3937 
3938 	compr_dbg(buf, "host_buf_ptr=%x coeff version %u\n",
3939 		  buf->host_buf_ptr, version);
3940 
3941 	return version;
3942 }
3943 
3944 static int wm_adsp_buffer_init(struct wm_adsp *dsp)
3945 {
3946 	struct wm_coeff_ctl *ctl;
3947 	int ret;
3948 
3949 	list_for_each_entry(ctl, &dsp->ctl_list, list) {
3950 		if (ctl->type != WMFW_CTL_TYPE_HOST_BUFFER)
3951 			continue;
3952 
3953 		if (!ctl->enabled)
3954 			continue;
3955 
3956 		ret = wm_adsp_buffer_parse_coeff(ctl);
3957 		if (ret < 0) {
3958 			adsp_err(dsp, "Failed to parse coeff: %d\n", ret);
3959 			goto error;
3960 		} else if (ret == 0) {
3961 			/* Only one buffer supported for version 0 */
3962 			return 0;
3963 		}
3964 	}
3965 
3966 	if (list_empty(&dsp->buffer_list)) {
3967 		/* Fall back to legacy support */
3968 		ret = wm_adsp_buffer_parse_legacy(dsp);
3969 		if (ret) {
3970 			adsp_err(dsp, "Failed to parse legacy: %d\n", ret);
3971 			goto error;
3972 		}
3973 	}
3974 
3975 	return 0;
3976 
3977 error:
3978 	wm_adsp_buffer_free(dsp);
3979 	return ret;
3980 }
3981 
3982 static int wm_adsp_buffer_free(struct wm_adsp *dsp)
3983 {
3984 	struct wm_adsp_compr_buf *buf, *tmp;
3985 
3986 	list_for_each_entry_safe(buf, tmp, &dsp->buffer_list, list) {
3987 		wm_adsp_compr_detach(buf->compr);
3988 
3989 		kfree(buf->name);
3990 		kfree(buf->regions);
3991 		list_del(&buf->list);
3992 		kfree(buf);
3993 	}
3994 
3995 	return 0;
3996 }
3997 
3998 static int wm_adsp_buffer_get_error(struct wm_adsp_compr_buf *buf)
3999 {
4000 	int ret;
4001 
4002 	ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(error), &buf->error);
4003 	if (ret < 0) {
4004 		compr_err(buf, "Failed to check buffer error: %d\n", ret);
4005 		return ret;
4006 	}
4007 	if (buf->error != 0) {
4008 		compr_err(buf, "Buffer error occurred: %d\n", buf->error);
4009 		return -EIO;
4010 	}
4011 
4012 	return 0;
4013 }
4014 
4015 int wm_adsp_compr_trigger(struct snd_soc_component *component,
4016 			  struct snd_compr_stream *stream, int cmd)
4017 {
4018 	struct wm_adsp_compr *compr = stream->runtime->private_data;
4019 	struct wm_adsp *dsp = compr->dsp;
4020 	int ret = 0;
4021 
4022 	compr_dbg(compr, "Trigger: %d\n", cmd);
4023 
4024 	mutex_lock(&dsp->pwr_lock);
4025 
4026 	switch (cmd) {
4027 	case SNDRV_PCM_TRIGGER_START:
4028 		if (!wm_adsp_compr_attached(compr)) {
4029 			ret = wm_adsp_compr_attach(compr);
4030 			if (ret < 0) {
4031 				compr_err(compr, "Failed to link buffer and stream: %d\n",
4032 					  ret);
4033 				break;
4034 			}
4035 		}
4036 
4037 		ret = wm_adsp_buffer_get_error(compr->buf);
4038 		if (ret < 0)
4039 			break;
4040 
4041 		/* Trigger the IRQ at one fragment of data */
4042 		ret = wm_adsp_buffer_write(compr->buf,
4043 					   HOST_BUFFER_FIELD(high_water_mark),
4044 					   wm_adsp_compr_frag_words(compr));
4045 		if (ret < 0) {
4046 			compr_err(compr, "Failed to set high water mark: %d\n",
4047 				  ret);
4048 			break;
4049 		}
4050 		break;
4051 	case SNDRV_PCM_TRIGGER_STOP:
4052 		if (wm_adsp_compr_attached(compr))
4053 			wm_adsp_buffer_clear(compr->buf);
4054 		break;
4055 	default:
4056 		ret = -EINVAL;
4057 		break;
4058 	}
4059 
4060 	mutex_unlock(&dsp->pwr_lock);
4061 
4062 	return ret;
4063 }
4064 EXPORT_SYMBOL_GPL(wm_adsp_compr_trigger);
4065 
4066 static inline int wm_adsp_buffer_size(struct wm_adsp_compr_buf *buf)
4067 {
4068 	int last_region = wm_adsp_fw[buf->dsp->fw].caps->num_regions - 1;
4069 
4070 	return buf->regions[last_region].cumulative_size;
4071 }
4072 
4073 static int wm_adsp_buffer_update_avail(struct wm_adsp_compr_buf *buf)
4074 {
4075 	u32 next_read_index, next_write_index;
4076 	int write_index, read_index, avail;
4077 	int ret;
4078 
4079 	/* Only sync read index if we haven't already read a valid index */
4080 	if (buf->read_index < 0) {
4081 		ret = wm_adsp_buffer_read(buf,
4082 				HOST_BUFFER_FIELD(next_read_index),
4083 				&next_read_index);
4084 		if (ret < 0)
4085 			return ret;
4086 
4087 		read_index = sign_extend32(next_read_index, 23);
4088 
4089 		if (read_index < 0) {
4090 			compr_dbg(buf, "Avail check on unstarted stream\n");
4091 			return 0;
4092 		}
4093 
4094 		buf->read_index = read_index;
4095 	}
4096 
4097 	ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(next_write_index),
4098 			&next_write_index);
4099 	if (ret < 0)
4100 		return ret;
4101 
4102 	write_index = sign_extend32(next_write_index, 23);
4103 
4104 	avail = write_index - buf->read_index;
4105 	if (avail < 0)
4106 		avail += wm_adsp_buffer_size(buf);
4107 
4108 	compr_dbg(buf, "readindex=0x%x, writeindex=0x%x, avail=%d\n",
4109 		  buf->read_index, write_index, avail * WM_ADSP_DATA_WORD_SIZE);
4110 
4111 	buf->avail = avail;
4112 
4113 	return 0;
4114 }
4115 
4116 int wm_adsp_compr_handle_irq(struct wm_adsp *dsp)
4117 {
4118 	struct wm_adsp_compr_buf *buf;
4119 	struct wm_adsp_compr *compr;
4120 	int ret = 0;
4121 
4122 	mutex_lock(&dsp->pwr_lock);
4123 
4124 	if (list_empty(&dsp->buffer_list)) {
4125 		ret = -ENODEV;
4126 		goto out;
4127 	}
4128 
4129 	adsp_dbg(dsp, "Handling buffer IRQ\n");
4130 
4131 	list_for_each_entry(buf, &dsp->buffer_list, list) {
4132 		compr = buf->compr;
4133 
4134 		ret = wm_adsp_buffer_get_error(buf);
4135 		if (ret < 0)
4136 			goto out_notify; /* Wake poll to report error */
4137 
4138 		ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(irq_count),
4139 					  &buf->irq_count);
4140 		if (ret < 0) {
4141 			compr_err(buf, "Failed to get irq_count: %d\n", ret);
4142 			goto out;
4143 		}
4144 
4145 		ret = wm_adsp_buffer_update_avail(buf);
4146 		if (ret < 0) {
4147 			compr_err(buf, "Error reading avail: %d\n", ret);
4148 			goto out;
4149 		}
4150 
4151 		if (wm_adsp_fw[dsp->fw].voice_trigger && buf->irq_count == 2)
4152 			ret = WM_ADSP_COMPR_VOICE_TRIGGER;
4153 
4154 out_notify:
4155 		if (compr && compr->stream)
4156 			snd_compr_fragment_elapsed(compr->stream);
4157 	}
4158 
4159 out:
4160 	mutex_unlock(&dsp->pwr_lock);
4161 
4162 	return ret;
4163 }
4164 EXPORT_SYMBOL_GPL(wm_adsp_compr_handle_irq);
4165 
4166 static int wm_adsp_buffer_reenable_irq(struct wm_adsp_compr_buf *buf)
4167 {
4168 	if (buf->irq_count & 0x01)
4169 		return 0;
4170 
4171 	compr_dbg(buf, "Enable IRQ(0x%x) for next fragment\n", buf->irq_count);
4172 
4173 	buf->irq_count |= 0x01;
4174 
4175 	return wm_adsp_buffer_write(buf, HOST_BUFFER_FIELD(irq_ack),
4176 				    buf->irq_count);
4177 }
4178 
4179 int wm_adsp_compr_pointer(struct snd_soc_component *component,
4180 			  struct snd_compr_stream *stream,
4181 			  struct snd_compr_tstamp *tstamp)
4182 {
4183 	struct wm_adsp_compr *compr = stream->runtime->private_data;
4184 	struct wm_adsp *dsp = compr->dsp;
4185 	struct wm_adsp_compr_buf *buf;
4186 	int ret = 0;
4187 
4188 	compr_dbg(compr, "Pointer request\n");
4189 
4190 	mutex_lock(&dsp->pwr_lock);
4191 
4192 	buf = compr->buf;
4193 
4194 	if (dsp->fatal_error || !buf || buf->error) {
4195 		snd_compr_stop_error(stream, SNDRV_PCM_STATE_XRUN);
4196 		ret = -EIO;
4197 		goto out;
4198 	}
4199 
4200 	if (buf->avail < wm_adsp_compr_frag_words(compr)) {
4201 		ret = wm_adsp_buffer_update_avail(buf);
4202 		if (ret < 0) {
4203 			compr_err(compr, "Error reading avail: %d\n", ret);
4204 			goto out;
4205 		}
4206 
4207 		/*
4208 		 * If we really have less than 1 fragment available tell the
4209 		 * DSP to inform us once a whole fragment is available.
4210 		 */
4211 		if (buf->avail < wm_adsp_compr_frag_words(compr)) {
4212 			ret = wm_adsp_buffer_get_error(buf);
4213 			if (ret < 0) {
4214 				if (buf->error)
4215 					snd_compr_stop_error(stream,
4216 							SNDRV_PCM_STATE_XRUN);
4217 				goto out;
4218 			}
4219 
4220 			ret = wm_adsp_buffer_reenable_irq(buf);
4221 			if (ret < 0) {
4222 				compr_err(compr, "Failed to re-enable buffer IRQ: %d\n",
4223 					  ret);
4224 				goto out;
4225 			}
4226 		}
4227 	}
4228 
4229 	tstamp->copied_total = compr->copied_total;
4230 	tstamp->copied_total += buf->avail * WM_ADSP_DATA_WORD_SIZE;
4231 	tstamp->sampling_rate = compr->sample_rate;
4232 
4233 out:
4234 	mutex_unlock(&dsp->pwr_lock);
4235 
4236 	return ret;
4237 }
4238 EXPORT_SYMBOL_GPL(wm_adsp_compr_pointer);
4239 
4240 static int wm_adsp_buffer_capture_block(struct wm_adsp_compr *compr, int target)
4241 {
4242 	struct wm_adsp_compr_buf *buf = compr->buf;
4243 	unsigned int adsp_addr;
4244 	int mem_type, nwords, max_read;
4245 	int i, ret;
4246 
4247 	/* Calculate read parameters */
4248 	for (i = 0; i < wm_adsp_fw[buf->dsp->fw].caps->num_regions; ++i)
4249 		if (buf->read_index < buf->regions[i].cumulative_size)
4250 			break;
4251 
4252 	if (i == wm_adsp_fw[buf->dsp->fw].caps->num_regions)
4253 		return -EINVAL;
4254 
4255 	mem_type = buf->regions[i].mem_type;
4256 	adsp_addr = buf->regions[i].base_addr +
4257 		    (buf->read_index - buf->regions[i].offset);
4258 
4259 	max_read = wm_adsp_compr_frag_words(compr);
4260 	nwords = buf->regions[i].cumulative_size - buf->read_index;
4261 
4262 	if (nwords > target)
4263 		nwords = target;
4264 	if (nwords > buf->avail)
4265 		nwords = buf->avail;
4266 	if (nwords > max_read)
4267 		nwords = max_read;
4268 	if (!nwords)
4269 		return 0;
4270 
4271 	/* Read data from DSP */
4272 	ret = wm_adsp_read_raw_data_block(buf->dsp, mem_type, adsp_addr,
4273 					  nwords, (__be32 *)compr->raw_buf);
4274 	if (ret < 0)
4275 		return ret;
4276 
4277 	wm_adsp_remove_padding(compr->raw_buf, nwords);
4278 
4279 	/* update read index to account for words read */
4280 	buf->read_index += nwords;
4281 	if (buf->read_index == wm_adsp_buffer_size(buf))
4282 		buf->read_index = 0;
4283 
4284 	ret = wm_adsp_buffer_write(buf, HOST_BUFFER_FIELD(next_read_index),
4285 				   buf->read_index);
4286 	if (ret < 0)
4287 		return ret;
4288 
4289 	/* update avail to account for words read */
4290 	buf->avail -= nwords;
4291 
4292 	return nwords;
4293 }
4294 
4295 static int wm_adsp_compr_read(struct wm_adsp_compr *compr,
4296 			      char __user *buf, size_t count)
4297 {
4298 	struct wm_adsp *dsp = compr->dsp;
4299 	int ntotal = 0;
4300 	int nwords, nbytes;
4301 
4302 	compr_dbg(compr, "Requested read of %zu bytes\n", count);
4303 
4304 	if (dsp->fatal_error || !compr->buf || compr->buf->error) {
4305 		snd_compr_stop_error(compr->stream, SNDRV_PCM_STATE_XRUN);
4306 		return -EIO;
4307 	}
4308 
4309 	count /= WM_ADSP_DATA_WORD_SIZE;
4310 
4311 	do {
4312 		nwords = wm_adsp_buffer_capture_block(compr, count);
4313 		if (nwords < 0) {
4314 			compr_err(compr, "Failed to capture block: %d\n",
4315 				  nwords);
4316 			return nwords;
4317 		}
4318 
4319 		nbytes = nwords * WM_ADSP_DATA_WORD_SIZE;
4320 
4321 		compr_dbg(compr, "Read %d bytes\n", nbytes);
4322 
4323 		if (copy_to_user(buf + ntotal, compr->raw_buf, nbytes)) {
4324 			compr_err(compr, "Failed to copy data to user: %d, %d\n",
4325 				  ntotal, nbytes);
4326 			return -EFAULT;
4327 		}
4328 
4329 		count -= nwords;
4330 		ntotal += nbytes;
4331 	} while (nwords > 0 && count > 0);
4332 
4333 	compr->copied_total += ntotal;
4334 
4335 	return ntotal;
4336 }
4337 
4338 int wm_adsp_compr_copy(struct snd_soc_component *component,
4339 		       struct snd_compr_stream *stream, char __user *buf,
4340 		       size_t count)
4341 {
4342 	struct wm_adsp_compr *compr = stream->runtime->private_data;
4343 	struct wm_adsp *dsp = compr->dsp;
4344 	int ret;
4345 
4346 	mutex_lock(&dsp->pwr_lock);
4347 
4348 	if (stream->direction == SND_COMPRESS_CAPTURE)
4349 		ret = wm_adsp_compr_read(compr, buf, count);
4350 	else
4351 		ret = -ENOTSUPP;
4352 
4353 	mutex_unlock(&dsp->pwr_lock);
4354 
4355 	return ret;
4356 }
4357 EXPORT_SYMBOL_GPL(wm_adsp_compr_copy);
4358 
4359 static void wm_adsp_fatal_error(struct wm_adsp *dsp)
4360 {
4361 	struct wm_adsp_compr *compr;
4362 
4363 	dsp->fatal_error = true;
4364 
4365 	list_for_each_entry(compr, &dsp->compr_list, list) {
4366 		if (compr->stream)
4367 			snd_compr_fragment_elapsed(compr->stream);
4368 	}
4369 }
4370 
4371 irqreturn_t wm_adsp2_bus_error(int irq, void *data)
4372 {
4373 	struct wm_adsp *dsp = (struct wm_adsp *)data;
4374 	unsigned int val;
4375 	struct regmap *regmap = dsp->regmap;
4376 	int ret = 0;
4377 
4378 	mutex_lock(&dsp->pwr_lock);
4379 
4380 	ret = regmap_read(regmap, dsp->base + ADSP2_LOCK_REGION_CTRL, &val);
4381 	if (ret) {
4382 		adsp_err(dsp,
4383 			"Failed to read Region Lock Ctrl register: %d\n", ret);
4384 		goto error;
4385 	}
4386 
4387 	if (val & ADSP2_WDT_TIMEOUT_STS_MASK) {
4388 		adsp_err(dsp, "watchdog timeout error\n");
4389 		dsp->ops->stop_watchdog(dsp);
4390 		wm_adsp_fatal_error(dsp);
4391 	}
4392 
4393 	if (val & (ADSP2_ADDR_ERR_MASK | ADSP2_REGION_LOCK_ERR_MASK)) {
4394 		if (val & ADSP2_ADDR_ERR_MASK)
4395 			adsp_err(dsp, "bus error: address error\n");
4396 		else
4397 			adsp_err(dsp, "bus error: region lock error\n");
4398 
4399 		ret = regmap_read(regmap, dsp->base + ADSP2_BUS_ERR_ADDR, &val);
4400 		if (ret) {
4401 			adsp_err(dsp,
4402 				 "Failed to read Bus Err Addr register: %d\n",
4403 				 ret);
4404 			goto error;
4405 		}
4406 
4407 		adsp_err(dsp, "bus error address = 0x%x\n",
4408 			 val & ADSP2_BUS_ERR_ADDR_MASK);
4409 
4410 		ret = regmap_read(regmap,
4411 				  dsp->base + ADSP2_PMEM_ERR_ADDR_XMEM_ERR_ADDR,
4412 				  &val);
4413 		if (ret) {
4414 			adsp_err(dsp,
4415 				 "Failed to read Pmem Xmem Err Addr register: %d\n",
4416 				 ret);
4417 			goto error;
4418 		}
4419 
4420 		adsp_err(dsp, "xmem error address = 0x%x\n",
4421 			 val & ADSP2_XMEM_ERR_ADDR_MASK);
4422 		adsp_err(dsp, "pmem error address = 0x%x\n",
4423 			 (val & ADSP2_PMEM_ERR_ADDR_MASK) >>
4424 			 ADSP2_PMEM_ERR_ADDR_SHIFT);
4425 	}
4426 
4427 	regmap_update_bits(regmap, dsp->base + ADSP2_LOCK_REGION_CTRL,
4428 			   ADSP2_CTRL_ERR_EINT, ADSP2_CTRL_ERR_EINT);
4429 
4430 error:
4431 	mutex_unlock(&dsp->pwr_lock);
4432 
4433 	return IRQ_HANDLED;
4434 }
4435 EXPORT_SYMBOL_GPL(wm_adsp2_bus_error);
4436 
4437 irqreturn_t wm_halo_bus_error(int irq, void *data)
4438 {
4439 	struct wm_adsp *dsp = (struct wm_adsp *)data;
4440 	struct regmap *regmap = dsp->regmap;
4441 	unsigned int fault[6];
4442 	struct reg_sequence clear[] = {
4443 		{ dsp->base + HALO_MPU_XM_VIO_STATUS,     0x0 },
4444 		{ dsp->base + HALO_MPU_YM_VIO_STATUS,     0x0 },
4445 		{ dsp->base + HALO_MPU_PM_VIO_STATUS,     0x0 },
4446 	};
4447 	int ret;
4448 
4449 	mutex_lock(&dsp->pwr_lock);
4450 
4451 	ret = regmap_read(regmap, dsp->base_sysinfo + HALO_AHBM_WINDOW_DEBUG_1,
4452 			  fault);
4453 	if (ret) {
4454 		adsp_warn(dsp, "Failed to read AHB DEBUG_1: %d\n", ret);
4455 		goto exit_unlock;
4456 	}
4457 
4458 	adsp_warn(dsp, "AHB: STATUS: 0x%x ADDR: 0x%x\n",
4459 		  *fault & HALO_AHBM_FLAGS_ERR_MASK,
4460 		  (*fault & HALO_AHBM_CORE_ERR_ADDR_MASK) >>
4461 		  HALO_AHBM_CORE_ERR_ADDR_SHIFT);
4462 
4463 	ret = regmap_read(regmap, dsp->base_sysinfo + HALO_AHBM_WINDOW_DEBUG_0,
4464 			  fault);
4465 	if (ret) {
4466 		adsp_warn(dsp, "Failed to read AHB DEBUG_0: %d\n", ret);
4467 		goto exit_unlock;
4468 	}
4469 
4470 	adsp_warn(dsp, "AHB: SYS_ADDR: 0x%x\n", *fault);
4471 
4472 	ret = regmap_bulk_read(regmap, dsp->base + HALO_MPU_XM_VIO_ADDR,
4473 			       fault, ARRAY_SIZE(fault));
4474 	if (ret) {
4475 		adsp_warn(dsp, "Failed to read MPU fault info: %d\n", ret);
4476 		goto exit_unlock;
4477 	}
4478 
4479 	adsp_warn(dsp, "XM: STATUS:0x%x ADDR:0x%x\n", fault[1], fault[0]);
4480 	adsp_warn(dsp, "YM: STATUS:0x%x ADDR:0x%x\n", fault[3], fault[2]);
4481 	adsp_warn(dsp, "PM: STATUS:0x%x ADDR:0x%x\n", fault[5], fault[4]);
4482 
4483 	ret = regmap_multi_reg_write(dsp->regmap, clear, ARRAY_SIZE(clear));
4484 	if (ret)
4485 		adsp_warn(dsp, "Failed to clear MPU status: %d\n", ret);
4486 
4487 exit_unlock:
4488 	mutex_unlock(&dsp->pwr_lock);
4489 
4490 	return IRQ_HANDLED;
4491 }
4492 EXPORT_SYMBOL_GPL(wm_halo_bus_error);
4493 
4494 irqreturn_t wm_halo_wdt_expire(int irq, void *data)
4495 {
4496 	struct wm_adsp *dsp = data;
4497 
4498 	mutex_lock(&dsp->pwr_lock);
4499 
4500 	adsp_warn(dsp, "WDT Expiry Fault\n");
4501 	dsp->ops->stop_watchdog(dsp);
4502 	wm_adsp_fatal_error(dsp);
4503 
4504 	mutex_unlock(&dsp->pwr_lock);
4505 
4506 	return IRQ_HANDLED;
4507 }
4508 EXPORT_SYMBOL_GPL(wm_halo_wdt_expire);
4509 
4510 static struct wm_adsp_ops wm_adsp1_ops = {
4511 	.validate_version = wm_adsp_validate_version,
4512 	.parse_sizes = wm_adsp1_parse_sizes,
4513 	.region_to_reg = wm_adsp_region_to_reg,
4514 };
4515 
4516 static struct wm_adsp_ops wm_adsp2_ops[] = {
4517 	{
4518 		.sys_config_size = sizeof(struct wm_adsp_system_config_xm_hdr),
4519 		.parse_sizes = wm_adsp2_parse_sizes,
4520 		.validate_version = wm_adsp_validate_version,
4521 		.setup_algs = wm_adsp2_setup_algs,
4522 		.region_to_reg = wm_adsp_region_to_reg,
4523 
4524 		.show_fw_status = wm_adsp2_show_fw_status,
4525 
4526 		.enable_memory = wm_adsp2_enable_memory,
4527 		.disable_memory = wm_adsp2_disable_memory,
4528 
4529 		.enable_core = wm_adsp2_enable_core,
4530 		.disable_core = wm_adsp2_disable_core,
4531 
4532 		.start_core = wm_adsp2_start_core,
4533 		.stop_core = wm_adsp2_stop_core,
4534 
4535 	},
4536 	{
4537 		.sys_config_size = sizeof(struct wm_adsp_system_config_xm_hdr),
4538 		.parse_sizes = wm_adsp2_parse_sizes,
4539 		.validate_version = wm_adsp_validate_version,
4540 		.setup_algs = wm_adsp2_setup_algs,
4541 		.region_to_reg = wm_adsp_region_to_reg,
4542 
4543 		.show_fw_status = wm_adsp2v2_show_fw_status,
4544 
4545 		.enable_memory = wm_adsp2_enable_memory,
4546 		.disable_memory = wm_adsp2_disable_memory,
4547 		.lock_memory = wm_adsp2_lock,
4548 
4549 		.enable_core = wm_adsp2v2_enable_core,
4550 		.disable_core = wm_adsp2v2_disable_core,
4551 
4552 		.start_core = wm_adsp2_start_core,
4553 		.stop_core = wm_adsp2_stop_core,
4554 	},
4555 	{
4556 		.sys_config_size = sizeof(struct wm_adsp_system_config_xm_hdr),
4557 		.parse_sizes = wm_adsp2_parse_sizes,
4558 		.validate_version = wm_adsp_validate_version,
4559 		.setup_algs = wm_adsp2_setup_algs,
4560 		.region_to_reg = wm_adsp_region_to_reg,
4561 
4562 		.show_fw_status = wm_adsp2v2_show_fw_status,
4563 		.stop_watchdog = wm_adsp_stop_watchdog,
4564 
4565 		.enable_memory = wm_adsp2_enable_memory,
4566 		.disable_memory = wm_adsp2_disable_memory,
4567 		.lock_memory = wm_adsp2_lock,
4568 
4569 		.enable_core = wm_adsp2v2_enable_core,
4570 		.disable_core = wm_adsp2v2_disable_core,
4571 
4572 		.start_core = wm_adsp2_start_core,
4573 		.stop_core = wm_adsp2_stop_core,
4574 	},
4575 };
4576 
4577 static struct wm_adsp_ops wm_halo_ops = {
4578 	.sys_config_size = sizeof(struct wm_halo_system_config_xm_hdr),
4579 	.parse_sizes = wm_adsp2_parse_sizes,
4580 	.validate_version = wm_halo_validate_version,
4581 	.setup_algs = wm_halo_setup_algs,
4582 	.region_to_reg = wm_halo_region_to_reg,
4583 
4584 	.show_fw_status = wm_halo_show_fw_status,
4585 	.stop_watchdog = wm_halo_stop_watchdog,
4586 
4587 	.lock_memory = wm_halo_configure_mpu,
4588 
4589 	.start_core = wm_halo_start_core,
4590 	.stop_core = wm_halo_stop_core,
4591 };
4592 
4593 MODULE_LICENSE("GPL v2");
4594