1 // SPDX-License-Identifier: GPL-2.0-only
3 * wm_adsp.c -- Wolfson ADSP support
5 * Copyright 2012 Wolfson Microelectronics plc
7 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
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>
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>
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__)
46 #define cs_dsp_err(_dsp, fmt, ...) \
47 dev_err(_dsp->dev, "%s: " fmt, _dsp->name, ##__VA_ARGS__)
48 #define cs_dsp_warn(_dsp, fmt, ...) \
49 dev_warn(_dsp->dev, "%s: " fmt, _dsp->name, ##__VA_ARGS__)
50 #define cs_dsp_info(_dsp, fmt, ...) \
51 dev_info(_dsp->dev, "%s: " fmt, _dsp->name, ##__VA_ARGS__)
52 #define cs_dsp_dbg(_dsp, fmt, ...) \
53 dev_dbg(_dsp->dev, "%s: " fmt, _dsp->name, ##__VA_ARGS__)
55 #define compr_err(_obj, fmt, ...) \
56 adsp_err(_obj->dsp, "%s: " fmt, _obj->name ? _obj->name : "legacy", \
58 #define compr_dbg(_obj, fmt, ...) \
59 adsp_dbg(_obj->dsp, "%s: " fmt, _obj->name ? _obj->name : "legacy", \
62 #define ADSP1_CONTROL_1 0x00
63 #define ADSP1_CONTROL_2 0x02
64 #define ADSP1_CONTROL_3 0x03
65 #define ADSP1_CONTROL_4 0x04
66 #define ADSP1_CONTROL_5 0x06
67 #define ADSP1_CONTROL_6 0x07
68 #define ADSP1_CONTROL_7 0x08
69 #define ADSP1_CONTROL_8 0x09
70 #define ADSP1_CONTROL_9 0x0A
71 #define ADSP1_CONTROL_10 0x0B
72 #define ADSP1_CONTROL_11 0x0C
73 #define ADSP1_CONTROL_12 0x0D
74 #define ADSP1_CONTROL_13 0x0F
75 #define ADSP1_CONTROL_14 0x10
76 #define ADSP1_CONTROL_15 0x11
77 #define ADSP1_CONTROL_16 0x12
78 #define ADSP1_CONTROL_17 0x13
79 #define ADSP1_CONTROL_18 0x14
80 #define ADSP1_CONTROL_19 0x16
81 #define ADSP1_CONTROL_20 0x17
82 #define ADSP1_CONTROL_21 0x18
83 #define ADSP1_CONTROL_22 0x1A
84 #define ADSP1_CONTROL_23 0x1B
85 #define ADSP1_CONTROL_24 0x1C
86 #define ADSP1_CONTROL_25 0x1E
87 #define ADSP1_CONTROL_26 0x20
88 #define ADSP1_CONTROL_27 0x21
89 #define ADSP1_CONTROL_28 0x22
90 #define ADSP1_CONTROL_29 0x23
91 #define ADSP1_CONTROL_30 0x24
92 #define ADSP1_CONTROL_31 0x26
97 #define ADSP1_WDMA_BUFFER_LENGTH_MASK 0x00FF /* DSP1_WDMA_BUFFER_LENGTH - [7:0] */
98 #define ADSP1_WDMA_BUFFER_LENGTH_SHIFT 0 /* DSP1_WDMA_BUFFER_LENGTH - [7:0] */
99 #define ADSP1_WDMA_BUFFER_LENGTH_WIDTH 8 /* DSP1_WDMA_BUFFER_LENGTH - [7:0] */
105 #define ADSP1_DBG_CLK_ENA 0x0008 /* DSP1_DBG_CLK_ENA */
106 #define ADSP1_DBG_CLK_ENA_MASK 0x0008 /* DSP1_DBG_CLK_ENA */
107 #define ADSP1_DBG_CLK_ENA_SHIFT 3 /* DSP1_DBG_CLK_ENA */
108 #define ADSP1_DBG_CLK_ENA_WIDTH 1 /* DSP1_DBG_CLK_ENA */
109 #define ADSP1_SYS_ENA 0x0004 /* DSP1_SYS_ENA */
110 #define ADSP1_SYS_ENA_MASK 0x0004 /* DSP1_SYS_ENA */
111 #define ADSP1_SYS_ENA_SHIFT 2 /* DSP1_SYS_ENA */
112 #define ADSP1_SYS_ENA_WIDTH 1 /* DSP1_SYS_ENA */
113 #define ADSP1_CORE_ENA 0x0002 /* DSP1_CORE_ENA */
114 #define ADSP1_CORE_ENA_MASK 0x0002 /* DSP1_CORE_ENA */
115 #define ADSP1_CORE_ENA_SHIFT 1 /* DSP1_CORE_ENA */
116 #define ADSP1_CORE_ENA_WIDTH 1 /* DSP1_CORE_ENA */
117 #define ADSP1_START 0x0001 /* DSP1_START */
118 #define ADSP1_START_MASK 0x0001 /* DSP1_START */
119 #define ADSP1_START_SHIFT 0 /* DSP1_START */
120 #define ADSP1_START_WIDTH 1 /* DSP1_START */
125 #define ADSP1_CLK_SEL_MASK 0x0007 /* CLK_SEL_ENA */
126 #define ADSP1_CLK_SEL_SHIFT 0 /* CLK_SEL_ENA */
127 #define ADSP1_CLK_SEL_WIDTH 3 /* CLK_SEL_ENA */
129 #define ADSP2_CONTROL 0x0
130 #define ADSP2_CLOCKING 0x1
131 #define ADSP2V2_CLOCKING 0x2
132 #define ADSP2_STATUS1 0x4
133 #define ADSP2_WDMA_CONFIG_1 0x30
134 #define ADSP2_WDMA_CONFIG_2 0x31
135 #define ADSP2V2_WDMA_CONFIG_2 0x32
136 #define ADSP2_RDMA_CONFIG_1 0x34
138 #define ADSP2_SCRATCH0 0x40
139 #define ADSP2_SCRATCH1 0x41
140 #define ADSP2_SCRATCH2 0x42
141 #define ADSP2_SCRATCH3 0x43
143 #define ADSP2V2_SCRATCH0_1 0x40
144 #define ADSP2V2_SCRATCH2_3 0x42
150 #define ADSP2_MEM_ENA 0x0010 /* DSP1_MEM_ENA */
151 #define ADSP2_MEM_ENA_MASK 0x0010 /* DSP1_MEM_ENA */
152 #define ADSP2_MEM_ENA_SHIFT 4 /* DSP1_MEM_ENA */
153 #define ADSP2_MEM_ENA_WIDTH 1 /* DSP1_MEM_ENA */
154 #define ADSP2_SYS_ENA 0x0004 /* DSP1_SYS_ENA */
155 #define ADSP2_SYS_ENA_MASK 0x0004 /* DSP1_SYS_ENA */
156 #define ADSP2_SYS_ENA_SHIFT 2 /* DSP1_SYS_ENA */
157 #define ADSP2_SYS_ENA_WIDTH 1 /* DSP1_SYS_ENA */
158 #define ADSP2_CORE_ENA 0x0002 /* DSP1_CORE_ENA */
159 #define ADSP2_CORE_ENA_MASK 0x0002 /* DSP1_CORE_ENA */
160 #define ADSP2_CORE_ENA_SHIFT 1 /* DSP1_CORE_ENA */
161 #define ADSP2_CORE_ENA_WIDTH 1 /* DSP1_CORE_ENA */
162 #define ADSP2_START 0x0001 /* DSP1_START */
163 #define ADSP2_START_MASK 0x0001 /* DSP1_START */
164 #define ADSP2_START_SHIFT 0 /* DSP1_START */
165 #define ADSP2_START_WIDTH 1 /* DSP1_START */
170 #define ADSP2_CLK_SEL_MASK 0x0007 /* CLK_SEL_ENA */
171 #define ADSP2_CLK_SEL_SHIFT 0 /* CLK_SEL_ENA */
172 #define ADSP2_CLK_SEL_WIDTH 3 /* CLK_SEL_ENA */
177 #define ADSP2V2_CLK_SEL_MASK 0x70000 /* CLK_SEL_ENA */
178 #define ADSP2V2_CLK_SEL_SHIFT 16 /* CLK_SEL_ENA */
179 #define ADSP2V2_CLK_SEL_WIDTH 3 /* CLK_SEL_ENA */
181 #define ADSP2V2_RATE_MASK 0x7800 /* DSP_RATE */
182 #define ADSP2V2_RATE_SHIFT 11 /* DSP_RATE */
183 #define ADSP2V2_RATE_WIDTH 4 /* DSP_RATE */
188 #define ADSP2_RAM_RDY 0x0001
189 #define ADSP2_RAM_RDY_MASK 0x0001
190 #define ADSP2_RAM_RDY_SHIFT 0
191 #define ADSP2_RAM_RDY_WIDTH 1
196 #define ADSP2_LOCK_CODE_0 0x5555
197 #define ADSP2_LOCK_CODE_1 0xAAAA
199 #define ADSP2_WATCHDOG 0x0A
200 #define ADSP2_BUS_ERR_ADDR 0x52
201 #define ADSP2_REGION_LOCK_STATUS 0x64
202 #define ADSP2_LOCK_REGION_1_LOCK_REGION_0 0x66
203 #define ADSP2_LOCK_REGION_3_LOCK_REGION_2 0x68
204 #define ADSP2_LOCK_REGION_5_LOCK_REGION_4 0x6A
205 #define ADSP2_LOCK_REGION_7_LOCK_REGION_6 0x6C
206 #define ADSP2_LOCK_REGION_9_LOCK_REGION_8 0x6E
207 #define ADSP2_LOCK_REGION_CTRL 0x7A
208 #define ADSP2_PMEM_ERR_ADDR_XMEM_ERR_ADDR 0x7C
210 #define ADSP2_REGION_LOCK_ERR_MASK 0x8000
211 #define ADSP2_ADDR_ERR_MASK 0x4000
212 #define ADSP2_WDT_TIMEOUT_STS_MASK 0x2000
213 #define ADSP2_CTRL_ERR_PAUSE_ENA 0x0002
214 #define ADSP2_CTRL_ERR_EINT 0x0001
216 #define ADSP2_BUS_ERR_ADDR_MASK 0x00FFFFFF
217 #define ADSP2_XMEM_ERR_ADDR_MASK 0x0000FFFF
218 #define ADSP2_PMEM_ERR_ADDR_MASK 0x7FFF0000
219 #define ADSP2_PMEM_ERR_ADDR_SHIFT 16
220 #define ADSP2_WDT_ENA_MASK 0xFFFFFFFD
222 #define ADSP2_LOCK_REGION_SHIFT 16
224 #define ADSP_MAX_STD_CTRL_SIZE 512
226 #define CS_DSP_ACKED_CTL_TIMEOUT_MS 100
227 #define CS_DSP_ACKED_CTL_N_QUICKPOLLS 10
228 #define CS_DSP_ACKED_CTL_MIN_VALUE 0
229 #define CS_DSP_ACKED_CTL_MAX_VALUE 0xFFFFFF
232 * Event control messages
234 #define CS_DSP_FW_EVENT_SHUTDOWN 0x000001
239 #define HALO_AHBM_WINDOW_DEBUG_0 0x02040
240 #define HALO_AHBM_WINDOW_DEBUG_1 0x02044
245 #define HALO_SCRATCH1 0x005c0
246 #define HALO_SCRATCH2 0x005c8
247 #define HALO_SCRATCH3 0x005d0
248 #define HALO_SCRATCH4 0x005d8
249 #define HALO_CCM_CORE_CONTROL 0x41000
250 #define HALO_CORE_SOFT_RESET 0x00010
251 #define HALO_WDT_CONTROL 0x47000
256 #define HALO_MPU_XMEM_ACCESS_0 0x43000
257 #define HALO_MPU_YMEM_ACCESS_0 0x43004
258 #define HALO_MPU_WINDOW_ACCESS_0 0x43008
259 #define HALO_MPU_XREG_ACCESS_0 0x4300C
260 #define HALO_MPU_YREG_ACCESS_0 0x43014
261 #define HALO_MPU_XMEM_ACCESS_1 0x43018
262 #define HALO_MPU_YMEM_ACCESS_1 0x4301C
263 #define HALO_MPU_WINDOW_ACCESS_1 0x43020
264 #define HALO_MPU_XREG_ACCESS_1 0x43024
265 #define HALO_MPU_YREG_ACCESS_1 0x4302C
266 #define HALO_MPU_XMEM_ACCESS_2 0x43030
267 #define HALO_MPU_YMEM_ACCESS_2 0x43034
268 #define HALO_MPU_WINDOW_ACCESS_2 0x43038
269 #define HALO_MPU_XREG_ACCESS_2 0x4303C
270 #define HALO_MPU_YREG_ACCESS_2 0x43044
271 #define HALO_MPU_XMEM_ACCESS_3 0x43048
272 #define HALO_MPU_YMEM_ACCESS_3 0x4304C
273 #define HALO_MPU_WINDOW_ACCESS_3 0x43050
274 #define HALO_MPU_XREG_ACCESS_3 0x43054
275 #define HALO_MPU_YREG_ACCESS_3 0x4305C
276 #define HALO_MPU_XM_VIO_ADDR 0x43100
277 #define HALO_MPU_XM_VIO_STATUS 0x43104
278 #define HALO_MPU_YM_VIO_ADDR 0x43108
279 #define HALO_MPU_YM_VIO_STATUS 0x4310C
280 #define HALO_MPU_PM_VIO_ADDR 0x43110
281 #define HALO_MPU_PM_VIO_STATUS 0x43114
282 #define HALO_MPU_LOCK_CONFIG 0x43140
285 * HALO_AHBM_WINDOW_DEBUG_1
287 #define HALO_AHBM_CORE_ERR_ADDR_MASK 0x0fffff00
288 #define HALO_AHBM_CORE_ERR_ADDR_SHIFT 8
289 #define HALO_AHBM_FLAGS_ERR_MASK 0x000000ff
292 * HALO_CCM_CORE_CONTROL
294 #define HALO_CORE_RESET 0x00000200
295 #define HALO_CORE_EN 0x00000001
298 * HALO_CORE_SOFT_RESET
300 #define HALO_CORE_SOFT_RESET_MASK 0x00000001
305 #define HALO_WDT_EN_MASK 0x00000001
308 * HALO_MPU_?M_VIO_STATUS
310 #define HALO_MPU_VIO_STS_MASK 0x007e0000
311 #define HALO_MPU_VIO_STS_SHIFT 17
312 #define HALO_MPU_VIO_ERR_WR_MASK 0x00008000
313 #define HALO_MPU_VIO_ERR_SRC_MASK 0x00007fff
314 #define HALO_MPU_VIO_ERR_SRC_SHIFT 0
316 static const struct cs_dsp_ops cs_dsp_adsp1_ops;
317 static const struct cs_dsp_ops cs_dsp_adsp2_ops[];
318 static const struct cs_dsp_ops cs_dsp_halo_ops;
321 struct list_head list;
325 static struct cs_dsp_buf *cs_dsp_buf_alloc(const void *src, size_t len,
326 struct list_head *list)
328 struct cs_dsp_buf *buf = kzalloc(sizeof(*buf), GFP_KERNEL);
333 buf->buf = vmalloc(len);
338 memcpy(buf->buf, src, len);
341 list_add_tail(&buf->list, list);
346 static void cs_dsp_buf_free(struct list_head *list)
348 while (!list_empty(list)) {
349 struct cs_dsp_buf *buf = list_first_entry(list,
352 list_del(&buf->list);
358 #define WM_ADSP_FW_MBC_VSS 0
359 #define WM_ADSP_FW_HIFI 1
360 #define WM_ADSP_FW_TX 2
361 #define WM_ADSP_FW_TX_SPK 3
362 #define WM_ADSP_FW_RX 4
363 #define WM_ADSP_FW_RX_ANC 5
364 #define WM_ADSP_FW_CTRL 6
365 #define WM_ADSP_FW_ASR 7
366 #define WM_ADSP_FW_TRACE 8
367 #define WM_ADSP_FW_SPK_PROT 9
368 #define WM_ADSP_FW_SPK_CALI 10
369 #define WM_ADSP_FW_SPK_DIAG 11
370 #define WM_ADSP_FW_MISC 12
372 #define WM_ADSP_NUM_FW 13
374 static const char *wm_adsp_fw_text[WM_ADSP_NUM_FW] = {
375 [WM_ADSP_FW_MBC_VSS] = "MBC/VSS",
376 [WM_ADSP_FW_HIFI] = "MasterHiFi",
377 [WM_ADSP_FW_TX] = "Tx",
378 [WM_ADSP_FW_TX_SPK] = "Tx Speaker",
379 [WM_ADSP_FW_RX] = "Rx",
380 [WM_ADSP_FW_RX_ANC] = "Rx ANC",
381 [WM_ADSP_FW_CTRL] = "Voice Ctrl",
382 [WM_ADSP_FW_ASR] = "ASR Assist",
383 [WM_ADSP_FW_TRACE] = "Dbg Trace",
384 [WM_ADSP_FW_SPK_PROT] = "Protection",
385 [WM_ADSP_FW_SPK_CALI] = "Calibration",
386 [WM_ADSP_FW_SPK_DIAG] = "Diagnostic",
387 [WM_ADSP_FW_MISC] = "Misc",
390 struct wm_adsp_system_config_xm_hdr {
396 __be32 dma_buffer_size;
399 __be32 build_job_name[3];
400 __be32 build_job_number;
403 struct wm_halo_system_config_xm_hdr {
404 __be32 halo_heartbeat;
405 __be32 build_job_name[3];
406 __be32 build_job_number;
409 struct wm_adsp_alg_xm_struct {
415 __be32 high_water_mark;
416 __be32 low_water_mark;
417 __be64 smoothed_power;
420 struct wm_adsp_host_buf_coeff_v1 {
421 __be32 host_buf_ptr; /* Host buffer pointer */
422 __be32 versions; /* Version numbers */
423 __be32 name[4]; /* The buffer name */
426 struct wm_adsp_buffer {
427 __be32 buf1_base; /* Base addr of first buffer area */
428 __be32 buf1_size; /* Size of buf1 area in DSP words */
429 __be32 buf2_base; /* Base addr of 2nd buffer area */
430 __be32 buf1_buf2_size; /* Size of buf1+buf2 in DSP words */
431 __be32 buf3_base; /* Base addr of buf3 area */
432 __be32 buf_total_size; /* Size of buf1+buf2+buf3 in DSP words */
433 __be32 high_water_mark; /* Point at which IRQ is asserted */
434 __be32 irq_count; /* bits 1-31 count IRQ assertions */
435 __be32 irq_ack; /* acked IRQ count, bit 0 enables IRQ */
436 __be32 next_write_index; /* word index of next write */
437 __be32 next_read_index; /* word index of next read */
438 __be32 error; /* error if any */
439 __be32 oldest_block_index; /* word index of oldest surviving */
440 __be32 requested_rewind; /* how many blocks rewind was done */
441 __be32 reserved_space; /* internal */
442 __be32 min_free; /* min free space since stream start */
443 __be32 blocks_written[2]; /* total blocks written (64 bit) */
444 __be32 words_written[2]; /* total words written (64 bit) */
447 struct wm_adsp_compr;
449 struct wm_adsp_compr_buf {
450 struct list_head list;
452 struct wm_adsp_compr *compr;
454 struct wm_adsp_buffer_region *regions;
461 int host_buf_mem_type;
466 struct wm_adsp_compr {
467 struct list_head list;
469 struct wm_adsp_compr_buf *buf;
471 struct snd_compr_stream *stream;
472 struct snd_compressed_buffer size;
475 unsigned int copied_total;
477 unsigned int sample_rate;
482 #define CS_DSP_DATA_WORD_SIZE 3
484 #define WM_ADSP_MIN_FRAGMENTS 1
485 #define WM_ADSP_MAX_FRAGMENTS 256
486 #define WM_ADSP_MIN_FRAGMENT_SIZE (64 * CS_DSP_DATA_WORD_SIZE)
487 #define WM_ADSP_MAX_FRAGMENT_SIZE (4096 * CS_DSP_DATA_WORD_SIZE)
489 #define WM_ADSP_ALG_XM_STRUCT_MAGIC 0x49aec7
491 #define HOST_BUFFER_FIELD(field) \
492 (offsetof(struct wm_adsp_buffer, field) / sizeof(__be32))
494 #define ALG_XM_FIELD(field) \
495 (offsetof(struct wm_adsp_alg_xm_struct, field) / sizeof(__be32))
497 #define HOST_BUF_COEFF_SUPPORTED_COMPAT_VER 1
499 #define HOST_BUF_COEFF_COMPAT_VER_MASK 0xFF00
500 #define HOST_BUF_COEFF_COMPAT_VER_SHIFT 8
502 static int wm_adsp_buffer_init(struct wm_adsp *dsp);
503 static int wm_adsp_buffer_free(struct wm_adsp *dsp);
505 struct wm_adsp_buffer_region {
507 unsigned int cumulative_size;
508 unsigned int mem_type;
509 unsigned int base_addr;
512 struct wm_adsp_buffer_region_def {
513 unsigned int mem_type;
514 unsigned int base_offset;
515 unsigned int size_offset;
518 static const struct wm_adsp_buffer_region_def default_regions[] = {
520 .mem_type = WMFW_ADSP2_XM,
521 .base_offset = HOST_BUFFER_FIELD(buf1_base),
522 .size_offset = HOST_BUFFER_FIELD(buf1_size),
525 .mem_type = WMFW_ADSP2_XM,
526 .base_offset = HOST_BUFFER_FIELD(buf2_base),
527 .size_offset = HOST_BUFFER_FIELD(buf1_buf2_size),
530 .mem_type = WMFW_ADSP2_YM,
531 .base_offset = HOST_BUFFER_FIELD(buf3_base),
532 .size_offset = HOST_BUFFER_FIELD(buf_total_size),
536 struct wm_adsp_fw_caps {
538 struct snd_codec_desc desc;
540 const struct wm_adsp_buffer_region_def *region_defs;
543 static const struct wm_adsp_fw_caps ctrl_caps[] = {
545 .id = SND_AUDIOCODEC_BESPOKE,
548 .sample_rates = { 16000 },
549 .num_sample_rates = 1,
550 .formats = SNDRV_PCM_FMTBIT_S16_LE,
552 .num_regions = ARRAY_SIZE(default_regions),
553 .region_defs = default_regions,
557 static const struct wm_adsp_fw_caps trace_caps[] = {
559 .id = SND_AUDIOCODEC_BESPOKE,
563 4000, 8000, 11025, 12000, 16000, 22050,
564 24000, 32000, 44100, 48000, 64000, 88200,
565 96000, 176400, 192000
567 .num_sample_rates = 15,
568 .formats = SNDRV_PCM_FMTBIT_S16_LE,
570 .num_regions = ARRAY_SIZE(default_regions),
571 .region_defs = default_regions,
575 static const struct {
579 const struct wm_adsp_fw_caps *caps;
581 } wm_adsp_fw[WM_ADSP_NUM_FW] = {
582 [WM_ADSP_FW_MBC_VSS] = { .file = "mbc-vss" },
583 [WM_ADSP_FW_HIFI] = { .file = "hifi" },
584 [WM_ADSP_FW_TX] = { .file = "tx" },
585 [WM_ADSP_FW_TX_SPK] = { .file = "tx-spk" },
586 [WM_ADSP_FW_RX] = { .file = "rx" },
587 [WM_ADSP_FW_RX_ANC] = { .file = "rx-anc" },
588 [WM_ADSP_FW_CTRL] = {
590 .compr_direction = SND_COMPRESS_CAPTURE,
591 .num_caps = ARRAY_SIZE(ctrl_caps),
593 .voice_trigger = true,
595 [WM_ADSP_FW_ASR] = { .file = "asr" },
596 [WM_ADSP_FW_TRACE] = {
598 .compr_direction = SND_COMPRESS_CAPTURE,
599 .num_caps = ARRAY_SIZE(trace_caps),
602 [WM_ADSP_FW_SPK_PROT] = { .file = "spk-prot" },
603 [WM_ADSP_FW_SPK_CALI] = { .file = "spk-cali" },
604 [WM_ADSP_FW_SPK_DIAG] = { .file = "spk-diag" },
605 [WM_ADSP_FW_MISC] = { .file = "misc" },
608 struct wm_coeff_ctl {
611 /* Subname is needed to match with firmware */
613 unsigned int subname_len;
614 struct cs_dsp_alg_region alg_region;
616 unsigned int enabled:1;
617 struct list_head list;
622 struct soc_bytes_ext bytes_ext;
625 struct work_struct work;
628 static const char *cs_dsp_mem_region_name(unsigned int type)
633 case WMFW_HALO_PM_PACKED:
639 case WMFW_HALO_XM_PACKED:
643 case WMFW_HALO_YM_PACKED:
652 #ifdef CONFIG_DEBUG_FS
653 static void cs_dsp_debugfs_save_wmfwname(struct wm_adsp *dsp, const char *s)
655 char *tmp = kasprintf(GFP_KERNEL, "%s\n", s);
657 kfree(dsp->wmfw_file_name);
658 dsp->wmfw_file_name = tmp;
661 static void cs_dsp_debugfs_save_binname(struct wm_adsp *dsp, const char *s)
663 char *tmp = kasprintf(GFP_KERNEL, "%s\n", s);
665 kfree(dsp->bin_file_name);
666 dsp->bin_file_name = tmp;
669 static void cs_dsp_debugfs_clear(struct wm_adsp *dsp)
671 kfree(dsp->wmfw_file_name);
672 kfree(dsp->bin_file_name);
673 dsp->wmfw_file_name = NULL;
674 dsp->bin_file_name = NULL;
677 static ssize_t cs_dsp_debugfs_wmfw_read(struct file *file,
678 char __user *user_buf,
679 size_t count, loff_t *ppos)
681 struct wm_adsp *dsp = file->private_data;
684 mutex_lock(&dsp->pwr_lock);
686 if (!dsp->wmfw_file_name || !dsp->booted)
689 ret = simple_read_from_buffer(user_buf, count, ppos,
691 strlen(dsp->wmfw_file_name));
693 mutex_unlock(&dsp->pwr_lock);
697 static ssize_t cs_dsp_debugfs_bin_read(struct file *file,
698 char __user *user_buf,
699 size_t count, loff_t *ppos)
701 struct wm_adsp *dsp = file->private_data;
704 mutex_lock(&dsp->pwr_lock);
706 if (!dsp->bin_file_name || !dsp->booted)
709 ret = simple_read_from_buffer(user_buf, count, ppos,
711 strlen(dsp->bin_file_name));
713 mutex_unlock(&dsp->pwr_lock);
717 static const struct {
719 const struct file_operations fops;
720 } cs_dsp_debugfs_fops[] = {
722 .name = "wmfw_file_name",
725 .read = cs_dsp_debugfs_wmfw_read,
729 .name = "bin_file_name",
732 .read = cs_dsp_debugfs_bin_read,
737 static void cs_dsp_init_debugfs(struct wm_adsp *dsp,
738 struct snd_soc_component *component)
740 struct dentry *root = NULL;
743 root = debugfs_create_dir(dsp->name, component->debugfs_root);
745 debugfs_create_bool("booted", 0444, root, &dsp->booted);
746 debugfs_create_bool("running", 0444, root, &dsp->running);
747 debugfs_create_x32("fw_id", 0444, root, &dsp->fw_id);
748 debugfs_create_x32("fw_version", 0444, root, &dsp->fw_id_version);
750 for (i = 0; i < ARRAY_SIZE(cs_dsp_debugfs_fops); ++i)
751 debugfs_create_file(cs_dsp_debugfs_fops[i].name, 0444, root,
752 dsp, &cs_dsp_debugfs_fops[i].fops);
754 dsp->debugfs_root = root;
757 static void cs_dsp_cleanup_debugfs(struct wm_adsp *dsp)
759 cs_dsp_debugfs_clear(dsp);
760 debugfs_remove_recursive(dsp->debugfs_root);
761 dsp->debugfs_root = NULL;
764 static inline void cs_dsp_init_debugfs(struct wm_adsp *dsp,
765 struct snd_soc_component *component)
769 static inline void cs_dsp_cleanup_debugfs(struct wm_adsp *dsp)
773 static inline void cs_dsp_debugfs_save_wmfwname(struct wm_adsp *dsp,
778 static inline void cs_dsp_debugfs_save_binname(struct wm_adsp *dsp,
783 static inline void cs_dsp_debugfs_clear(struct wm_adsp *dsp)
788 int wm_adsp_fw_get(struct snd_kcontrol *kcontrol,
789 struct snd_ctl_elem_value *ucontrol)
791 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
792 struct soc_enum *e = (struct soc_enum *)kcontrol->private_value;
793 struct wm_adsp *dsp = snd_soc_component_get_drvdata(component);
795 ucontrol->value.enumerated.item[0] = dsp[e->shift_l].fw;
799 EXPORT_SYMBOL_GPL(wm_adsp_fw_get);
801 int wm_adsp_fw_put(struct snd_kcontrol *kcontrol,
802 struct snd_ctl_elem_value *ucontrol)
804 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
805 struct soc_enum *e = (struct soc_enum *)kcontrol->private_value;
806 struct wm_adsp *dsp = snd_soc_component_get_drvdata(component);
809 if (ucontrol->value.enumerated.item[0] == dsp[e->shift_l].fw)
812 if (ucontrol->value.enumerated.item[0] >= WM_ADSP_NUM_FW)
815 mutex_lock(&dsp[e->shift_l].pwr_lock);
817 if (dsp[e->shift_l].booted || !list_empty(&dsp[e->shift_l].compr_list))
820 dsp[e->shift_l].fw = ucontrol->value.enumerated.item[0];
822 mutex_unlock(&dsp[e->shift_l].pwr_lock);
826 EXPORT_SYMBOL_GPL(wm_adsp_fw_put);
828 const struct soc_enum wm_adsp_fw_enum[] = {
829 SOC_ENUM_SINGLE(0, 0, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
830 SOC_ENUM_SINGLE(0, 1, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
831 SOC_ENUM_SINGLE(0, 2, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
832 SOC_ENUM_SINGLE(0, 3, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
833 SOC_ENUM_SINGLE(0, 4, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
834 SOC_ENUM_SINGLE(0, 5, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
835 SOC_ENUM_SINGLE(0, 6, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
837 EXPORT_SYMBOL_GPL(wm_adsp_fw_enum);
839 static const struct cs_dsp_region *cs_dsp_find_region(struct wm_adsp *dsp,
844 for (i = 0; i < dsp->num_mems; i++)
845 if (dsp->mem[i].type == type)
851 static unsigned int cs_dsp_region_to_reg(struct cs_dsp_region const *mem,
856 return mem->base + (offset * 3);
861 return mem->base + (offset * 2);
863 WARN(1, "Unknown memory region type");
868 static unsigned int cs_dsp_halo_region_to_reg(struct cs_dsp_region const *mem,
874 return mem->base + (offset * 4);
875 case WMFW_HALO_XM_PACKED:
876 case WMFW_HALO_YM_PACKED:
877 return (mem->base + (offset * 3)) & ~0x3;
878 case WMFW_HALO_PM_PACKED:
879 return mem->base + (offset * 5);
881 WARN(1, "Unknown memory region type");
886 static void cs_dsp_read_fw_status(struct wm_adsp *dsp,
887 int noffs, unsigned int *offs)
892 for (i = 0; i < noffs; ++i) {
893 ret = regmap_read(dsp->regmap, dsp->base + offs[i], &offs[i]);
895 cs_dsp_err(dsp, "Failed to read SCRATCH%u: %d\n", i, ret);
901 static void cs_dsp_adsp2_show_fw_status(struct wm_adsp *dsp)
903 unsigned int offs[] = {
904 ADSP2_SCRATCH0, ADSP2_SCRATCH1, ADSP2_SCRATCH2, ADSP2_SCRATCH3,
907 cs_dsp_read_fw_status(dsp, ARRAY_SIZE(offs), offs);
909 cs_dsp_dbg(dsp, "FW SCRATCH 0:0x%x 1:0x%x 2:0x%x 3:0x%x\n",
910 offs[0], offs[1], offs[2], offs[3]);
913 static void cs_dsp_adsp2v2_show_fw_status(struct wm_adsp *dsp)
915 unsigned int offs[] = { ADSP2V2_SCRATCH0_1, ADSP2V2_SCRATCH2_3 };
917 cs_dsp_read_fw_status(dsp, ARRAY_SIZE(offs), offs);
919 cs_dsp_dbg(dsp, "FW SCRATCH 0:0x%x 1:0x%x 2:0x%x 3:0x%x\n",
920 offs[0] & 0xFFFF, offs[0] >> 16,
921 offs[1] & 0xFFFF, offs[1] >> 16);
924 static void cs_dsp_halo_show_fw_status(struct wm_adsp *dsp)
926 unsigned int offs[] = {
927 HALO_SCRATCH1, HALO_SCRATCH2, HALO_SCRATCH3, HALO_SCRATCH4,
930 cs_dsp_read_fw_status(dsp, ARRAY_SIZE(offs), offs);
932 cs_dsp_dbg(dsp, "FW SCRATCH 0:0x%x 1:0x%x 2:0x%x 3:0x%x\n",
933 offs[0], offs[1], offs[2], offs[3]);
936 static inline struct wm_coeff_ctl *bytes_ext_to_ctl(struct soc_bytes_ext *ext)
938 return container_of(ext, struct wm_coeff_ctl, bytes_ext);
941 static int cs_dsp_coeff_base_reg(struct wm_coeff_ctl *ctl, unsigned int *reg)
943 const struct cs_dsp_alg_region *alg_region = &ctl->alg_region;
944 struct wm_adsp *dsp = ctl->dsp;
945 const struct cs_dsp_region *mem;
947 mem = cs_dsp_find_region(dsp, alg_region->type);
949 cs_dsp_err(dsp, "No base for region %x\n",
954 *reg = dsp->ops->region_to_reg(mem, ctl->alg_region.base + ctl->offset);
959 static int wm_coeff_info(struct snd_kcontrol *kctl,
960 struct snd_ctl_elem_info *uinfo)
962 struct soc_bytes_ext *bytes_ext =
963 (struct soc_bytes_ext *)kctl->private_value;
964 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
967 case WMFW_CTL_TYPE_ACKED:
968 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
969 uinfo->value.integer.min = CS_DSP_ACKED_CTL_MIN_VALUE;
970 uinfo->value.integer.max = CS_DSP_ACKED_CTL_MAX_VALUE;
971 uinfo->value.integer.step = 1;
975 uinfo->type = SNDRV_CTL_ELEM_TYPE_BYTES;
976 uinfo->count = ctl->len;
983 static int cs_dsp_coeff_write_acked_control(struct wm_coeff_ctl *ctl,
984 unsigned int event_id)
986 struct wm_adsp *dsp = ctl->dsp;
987 __be32 val = cpu_to_be32(event_id);
991 ret = cs_dsp_coeff_base_reg(ctl, ®);
995 cs_dsp_dbg(dsp, "Sending 0x%x to acked control alg 0x%x %s:0x%x\n",
996 event_id, ctl->alg_region.alg,
997 cs_dsp_mem_region_name(ctl->alg_region.type), ctl->offset);
999 ret = regmap_raw_write(dsp->regmap, reg, &val, sizeof(val));
1001 cs_dsp_err(dsp, "Failed to write %x: %d\n", reg, ret);
1006 * Poll for ack, we initially poll at ~1ms intervals for firmwares
1007 * that respond quickly, then go to ~10ms polls. A firmware is unlikely
1008 * to ack instantly so we do the first 1ms delay before reading the
1009 * control to avoid a pointless bus transaction
1011 for (i = 0; i < CS_DSP_ACKED_CTL_TIMEOUT_MS;) {
1013 case 0 ... CS_DSP_ACKED_CTL_N_QUICKPOLLS - 1:
1014 usleep_range(1000, 2000);
1018 usleep_range(10000, 20000);
1023 ret = regmap_raw_read(dsp->regmap, reg, &val, sizeof(val));
1025 cs_dsp_err(dsp, "Failed to read %x: %d\n", reg, ret);
1030 cs_dsp_dbg(dsp, "Acked control ACKED at poll %u\n", i);
1035 cs_dsp_warn(dsp, "Acked control @0x%x alg:0x%x %s:0x%x timed out\n",
1036 reg, ctl->alg_region.alg,
1037 cs_dsp_mem_region_name(ctl->alg_region.type),
1043 static int cs_dsp_coeff_write_ctrl_raw(struct wm_coeff_ctl *ctl,
1044 const void *buf, size_t len)
1046 struct wm_adsp *dsp = ctl->dsp;
1051 ret = cs_dsp_coeff_base_reg(ctl, ®);
1055 scratch = kmemdup(buf, len, GFP_KERNEL | GFP_DMA);
1059 ret = regmap_raw_write(dsp->regmap, reg, scratch,
1062 cs_dsp_err(dsp, "Failed to write %zu bytes to %x: %d\n",
1067 cs_dsp_dbg(dsp, "Wrote %zu bytes to %x\n", len, reg);
1074 static int cs_dsp_coeff_write_ctrl(struct wm_coeff_ctl *ctl,
1075 const void *buf, size_t len)
1079 if (ctl->flags & WMFW_CTL_FLAG_VOLATILE)
1081 else if (buf != ctl->cache)
1082 memcpy(ctl->cache, buf, len);
1085 if (ctl->enabled && ctl->dsp->running)
1086 ret = cs_dsp_coeff_write_ctrl_raw(ctl, buf, len);
1091 static int wm_coeff_put(struct snd_kcontrol *kctl,
1092 struct snd_ctl_elem_value *ucontrol)
1094 struct soc_bytes_ext *bytes_ext =
1095 (struct soc_bytes_ext *)kctl->private_value;
1096 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
1097 char *p = ucontrol->value.bytes.data;
1100 mutex_lock(&ctl->dsp->pwr_lock);
1101 ret = cs_dsp_coeff_write_ctrl(ctl, p, ctl->len);
1102 mutex_unlock(&ctl->dsp->pwr_lock);
1107 static int wm_coeff_tlv_put(struct snd_kcontrol *kctl,
1108 const unsigned int __user *bytes, unsigned int size)
1110 struct soc_bytes_ext *bytes_ext =
1111 (struct soc_bytes_ext *)kctl->private_value;
1112 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
1115 mutex_lock(&ctl->dsp->pwr_lock);
1117 if (copy_from_user(ctl->cache, bytes, size))
1120 ret = cs_dsp_coeff_write_ctrl(ctl, ctl->cache, size);
1122 mutex_unlock(&ctl->dsp->pwr_lock);
1127 static int wm_coeff_put_acked(struct snd_kcontrol *kctl,
1128 struct snd_ctl_elem_value *ucontrol)
1130 struct soc_bytes_ext *bytes_ext =
1131 (struct soc_bytes_ext *)kctl->private_value;
1132 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
1133 unsigned int val = ucontrol->value.integer.value[0];
1137 return 0; /* 0 means no event */
1139 mutex_lock(&ctl->dsp->pwr_lock);
1141 if (ctl->enabled && ctl->dsp->running)
1142 ret = cs_dsp_coeff_write_acked_control(ctl, val);
1146 mutex_unlock(&ctl->dsp->pwr_lock);
1151 static int cs_dsp_coeff_read_ctrl_raw(struct wm_coeff_ctl *ctl,
1152 void *buf, size_t len)
1154 struct wm_adsp *dsp = ctl->dsp;
1159 ret = cs_dsp_coeff_base_reg(ctl, ®);
1163 scratch = kmalloc(len, GFP_KERNEL | GFP_DMA);
1167 ret = regmap_raw_read(dsp->regmap, reg, scratch, len);
1169 cs_dsp_err(dsp, "Failed to read %zu bytes from %x: %d\n",
1174 cs_dsp_dbg(dsp, "Read %zu bytes from %x\n", len, reg);
1176 memcpy(buf, scratch, len);
1182 static int cs_dsp_coeff_read_ctrl(struct wm_coeff_ctl *ctl, void *buf, size_t len)
1186 if (ctl->flags & WMFW_CTL_FLAG_VOLATILE) {
1187 if (ctl->enabled && ctl->dsp->running)
1188 return cs_dsp_coeff_read_ctrl_raw(ctl, buf, len);
1192 if (!ctl->flags && ctl->enabled && ctl->dsp->running)
1193 ret = cs_dsp_coeff_read_ctrl_raw(ctl, ctl->cache, ctl->len);
1195 if (buf != ctl->cache)
1196 memcpy(buf, ctl->cache, len);
1202 static int wm_coeff_get(struct snd_kcontrol *kctl,
1203 struct snd_ctl_elem_value *ucontrol)
1205 struct soc_bytes_ext *bytes_ext =
1206 (struct soc_bytes_ext *)kctl->private_value;
1207 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
1208 char *p = ucontrol->value.bytes.data;
1211 mutex_lock(&ctl->dsp->pwr_lock);
1212 ret = cs_dsp_coeff_read_ctrl(ctl, p, ctl->len);
1213 mutex_unlock(&ctl->dsp->pwr_lock);
1218 static int wm_coeff_tlv_get(struct snd_kcontrol *kctl,
1219 unsigned int __user *bytes, unsigned int size)
1221 struct soc_bytes_ext *bytes_ext =
1222 (struct soc_bytes_ext *)kctl->private_value;
1223 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
1226 mutex_lock(&ctl->dsp->pwr_lock);
1228 ret = cs_dsp_coeff_read_ctrl(ctl, ctl->cache, size);
1230 if (!ret && copy_to_user(bytes, ctl->cache, size))
1233 mutex_unlock(&ctl->dsp->pwr_lock);
1238 static int wm_coeff_get_acked(struct snd_kcontrol *kcontrol,
1239 struct snd_ctl_elem_value *ucontrol)
1242 * Although it's not useful to read an acked control, we must satisfy
1243 * user-side assumptions that all controls are readable and that a
1244 * write of the same value should be filtered out (it's valid to send
1245 * the same event number again to the firmware). We therefore return 0,
1246 * meaning "no event" so valid event numbers will always be a change
1248 ucontrol->value.integer.value[0] = 0;
1253 static unsigned int wmfw_convert_flags(unsigned int in, unsigned int len)
1255 unsigned int out, rd, wr, vol;
1257 if (len > ADSP_MAX_STD_CTRL_SIZE) {
1258 rd = SNDRV_CTL_ELEM_ACCESS_TLV_READ;
1259 wr = SNDRV_CTL_ELEM_ACCESS_TLV_WRITE;
1260 vol = SNDRV_CTL_ELEM_ACCESS_VOLATILE;
1262 out = SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1264 rd = SNDRV_CTL_ELEM_ACCESS_READ;
1265 wr = SNDRV_CTL_ELEM_ACCESS_WRITE;
1266 vol = SNDRV_CTL_ELEM_ACCESS_VOLATILE;
1273 if (in & WMFW_CTL_FLAG_WRITEABLE)
1275 if (in & WMFW_CTL_FLAG_VOLATILE)
1278 out |= rd | wr | vol;
1284 static int wmfw_add_ctl(struct wm_adsp *dsp, struct wm_coeff_ctl *ctl)
1286 struct snd_kcontrol_new *kcontrol;
1289 if (!ctl || !ctl->name)
1292 kcontrol = kzalloc(sizeof(*kcontrol), GFP_KERNEL);
1296 kcontrol->name = ctl->name;
1297 kcontrol->info = wm_coeff_info;
1298 kcontrol->iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1299 kcontrol->tlv.c = snd_soc_bytes_tlv_callback;
1300 kcontrol->private_value = (unsigned long)&ctl->bytes_ext;
1301 kcontrol->access = wmfw_convert_flags(ctl->flags, ctl->len);
1303 switch (ctl->type) {
1304 case WMFW_CTL_TYPE_ACKED:
1305 kcontrol->get = wm_coeff_get_acked;
1306 kcontrol->put = wm_coeff_put_acked;
1309 if (kcontrol->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
1310 ctl->bytes_ext.max = ctl->len;
1311 ctl->bytes_ext.get = wm_coeff_tlv_get;
1312 ctl->bytes_ext.put = wm_coeff_tlv_put;
1314 kcontrol->get = wm_coeff_get;
1315 kcontrol->put = wm_coeff_put;
1320 ret = snd_soc_add_component_controls(dsp->component, kcontrol, 1);
1333 static int cs_dsp_coeff_init_control_caches(struct wm_adsp *dsp)
1335 struct wm_coeff_ctl *ctl;
1338 list_for_each_entry(ctl, &dsp->ctl_list, list) {
1339 if (!ctl->enabled || ctl->set)
1341 if (ctl->flags & WMFW_CTL_FLAG_VOLATILE)
1345 * For readable controls populate the cache from the DSP memory.
1346 * For non-readable controls the cache was zero-filled when
1347 * created so we don't need to do anything.
1349 if (!ctl->flags || (ctl->flags & WMFW_CTL_FLAG_READABLE)) {
1350 ret = cs_dsp_coeff_read_ctrl_raw(ctl, ctl->cache, ctl->len);
1359 static int cs_dsp_coeff_sync_controls(struct wm_adsp *dsp)
1361 struct wm_coeff_ctl *ctl;
1364 list_for_each_entry(ctl, &dsp->ctl_list, list) {
1367 if (ctl->set && !(ctl->flags & WMFW_CTL_FLAG_VOLATILE)) {
1368 ret = cs_dsp_coeff_write_ctrl_raw(ctl, ctl->cache,
1378 static void cs_dsp_signal_event_controls(struct wm_adsp *dsp,
1381 struct wm_coeff_ctl *ctl;
1384 list_for_each_entry(ctl, &dsp->ctl_list, list) {
1385 if (ctl->type != WMFW_CTL_TYPE_HOSTEVENT)
1391 ret = cs_dsp_coeff_write_acked_control(ctl, event);
1394 "Failed to send 0x%x event to alg 0x%x (%d)\n",
1395 event, ctl->alg_region.alg, ret);
1399 static void wm_adsp_ctl_work(struct work_struct *work)
1401 struct wm_coeff_ctl *ctl = container_of(work,
1402 struct wm_coeff_ctl,
1405 wmfw_add_ctl(ctl->dsp, ctl);
1408 static void cs_dsp_free_ctl_blk(struct wm_coeff_ctl *ctl)
1410 cancel_work_sync(&ctl->work);
1414 kfree(ctl->subname);
1418 static int cs_dsp_create_control(struct wm_adsp *dsp,
1419 const struct cs_dsp_alg_region *alg_region,
1420 unsigned int offset, unsigned int len,
1421 const char *subname, unsigned int subname_len,
1422 unsigned int flags, unsigned int type)
1424 struct wm_coeff_ctl *ctl;
1425 char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
1426 const char *region_name;
1429 list_for_each_entry(ctl, &dsp->ctl_list, list) {
1430 if (ctl->fw_name == wm_adsp_fw_text[dsp->fw] &&
1431 ctl->alg_region.alg == alg_region->alg &&
1432 ctl->alg_region.type == alg_region->type) {
1433 if ((!subname && !ctl->subname) ||
1434 (subname && !strncmp(ctl->subname, subname, ctl->subname_len))) {
1442 region_name = cs_dsp_mem_region_name(alg_region->type);
1444 cs_dsp_err(dsp, "Unknown region type: %d\n", alg_region->type);
1448 switch (dsp->fw_ver) {
1451 snprintf(name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN, "%s %s %x",
1452 dsp->name, region_name, alg_region->alg);
1453 subname = NULL; /* don't append subname */
1456 ret = scnprintf(name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN,
1457 "%s%c %.12s %x", dsp->name, *region_name,
1458 wm_adsp_fw_text[dsp->fw], alg_region->alg);
1461 ret = scnprintf(name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN,
1462 "%s %.12s %x", dsp->name,
1463 wm_adsp_fw_text[dsp->fw], alg_region->alg);
1468 int avail = SNDRV_CTL_ELEM_ID_NAME_MAXLEN - ret - 2;
1471 if (dsp->component->name_prefix)
1472 avail -= strlen(dsp->component->name_prefix) + 1;
1474 /* Truncate the subname from the start if it is too long */
1475 if (subname_len > avail)
1476 skip = subname_len - avail;
1478 snprintf(name + ret, SNDRV_CTL_ELEM_ID_NAME_MAXLEN - ret,
1479 " %.*s", subname_len - skip, subname + skip);
1482 ctl = kzalloc(sizeof(*ctl), GFP_KERNEL);
1485 ctl->fw_name = wm_adsp_fw_text[dsp->fw];
1486 ctl->alg_region = *alg_region;
1487 ctl->name = kmemdup(name, strlen(name) + 1, GFP_KERNEL);
1493 ctl->subname_len = subname_len;
1494 ctl->subname = kmemdup(subname,
1495 strlen(subname) + 1, GFP_KERNEL);
1496 if (!ctl->subname) {
1507 ctl->offset = offset;
1509 ctl->cache = kzalloc(ctl->len, GFP_KERNEL);
1512 goto err_ctl_subname;
1515 list_add(&ctl->list, &dsp->ctl_list);
1517 if (flags & WMFW_CTL_FLAG_SYS)
1520 INIT_WORK(&ctl->work, wm_adsp_ctl_work);
1521 schedule_work(&ctl->work);
1526 kfree(ctl->subname);
1535 struct cs_dsp_coeff_parsed_alg {
1542 struct cs_dsp_coeff_parsed_coeff {
1547 unsigned int ctl_type;
1552 static int cs_dsp_coeff_parse_string(int bytes, const u8 **pos, const u8 **str)
1561 length = le16_to_cpu(*((__le16 *)*pos));
1568 *str = *pos + bytes;
1570 *pos += ((length + bytes) + 3) & ~0x03;
1575 static int cs_dsp_coeff_parse_int(int bytes, const u8 **pos)
1581 val = le16_to_cpu(*((__le16 *)*pos));
1584 val = le32_to_cpu(*((__le32 *)*pos));
1595 static inline void cs_dsp_coeff_parse_alg(struct wm_adsp *dsp, const u8 **data,
1596 struct cs_dsp_coeff_parsed_alg *blk)
1598 const struct wmfw_adsp_alg_data *raw;
1600 switch (dsp->fw_ver) {
1603 raw = (const struct wmfw_adsp_alg_data *)*data;
1606 blk->id = le32_to_cpu(raw->id);
1607 blk->name = raw->name;
1608 blk->name_len = strlen(raw->name);
1609 blk->ncoeff = le32_to_cpu(raw->ncoeff);
1612 blk->id = cs_dsp_coeff_parse_int(sizeof(raw->id), data);
1613 blk->name_len = cs_dsp_coeff_parse_string(sizeof(u8), data,
1615 cs_dsp_coeff_parse_string(sizeof(u16), data, NULL);
1616 blk->ncoeff = cs_dsp_coeff_parse_int(sizeof(raw->ncoeff), data);
1620 cs_dsp_dbg(dsp, "Algorithm ID: %#x\n", blk->id);
1621 cs_dsp_dbg(dsp, "Algorithm name: %.*s\n", blk->name_len, blk->name);
1622 cs_dsp_dbg(dsp, "# of coefficient descriptors: %#x\n", blk->ncoeff);
1625 static inline void cs_dsp_coeff_parse_coeff(struct wm_adsp *dsp, const u8 **data,
1626 struct cs_dsp_coeff_parsed_coeff *blk)
1628 const struct wmfw_adsp_coeff_data *raw;
1632 switch (dsp->fw_ver) {
1635 raw = (const struct wmfw_adsp_coeff_data *)*data;
1636 *data = *data + sizeof(raw->hdr) + le32_to_cpu(raw->hdr.size);
1638 blk->offset = le16_to_cpu(raw->hdr.offset);
1639 blk->mem_type = le16_to_cpu(raw->hdr.type);
1640 blk->name = raw->name;
1641 blk->name_len = strlen(raw->name);
1642 blk->ctl_type = le16_to_cpu(raw->ctl_type);
1643 blk->flags = le16_to_cpu(raw->flags);
1644 blk->len = le32_to_cpu(raw->len);
1648 blk->offset = cs_dsp_coeff_parse_int(sizeof(raw->hdr.offset), &tmp);
1649 blk->mem_type = cs_dsp_coeff_parse_int(sizeof(raw->hdr.type), &tmp);
1650 length = cs_dsp_coeff_parse_int(sizeof(raw->hdr.size), &tmp);
1651 blk->name_len = cs_dsp_coeff_parse_string(sizeof(u8), &tmp,
1653 cs_dsp_coeff_parse_string(sizeof(u8), &tmp, NULL);
1654 cs_dsp_coeff_parse_string(sizeof(u16), &tmp, NULL);
1655 blk->ctl_type = cs_dsp_coeff_parse_int(sizeof(raw->ctl_type), &tmp);
1656 blk->flags = cs_dsp_coeff_parse_int(sizeof(raw->flags), &tmp);
1657 blk->len = cs_dsp_coeff_parse_int(sizeof(raw->len), &tmp);
1659 *data = *data + sizeof(raw->hdr) + length;
1663 cs_dsp_dbg(dsp, "\tCoefficient type: %#x\n", blk->mem_type);
1664 cs_dsp_dbg(dsp, "\tCoefficient offset: %#x\n", blk->offset);
1665 cs_dsp_dbg(dsp, "\tCoefficient name: %.*s\n", blk->name_len, blk->name);
1666 cs_dsp_dbg(dsp, "\tCoefficient flags: %#x\n", blk->flags);
1667 cs_dsp_dbg(dsp, "\tALSA control type: %#x\n", blk->ctl_type);
1668 cs_dsp_dbg(dsp, "\tALSA control len: %#x\n", blk->len);
1671 static int cs_dsp_check_coeff_flags(struct wm_adsp *dsp,
1672 const struct cs_dsp_coeff_parsed_coeff *coeff_blk,
1673 unsigned int f_required,
1674 unsigned int f_illegal)
1676 if ((coeff_blk->flags & f_illegal) ||
1677 ((coeff_blk->flags & f_required) != f_required)) {
1678 cs_dsp_err(dsp, "Illegal flags 0x%x for control type 0x%x\n",
1679 coeff_blk->flags, coeff_blk->ctl_type);
1686 static int cs_dsp_parse_coeff(struct wm_adsp *dsp,
1687 const struct wmfw_region *region)
1689 struct cs_dsp_alg_region alg_region = {};
1690 struct cs_dsp_coeff_parsed_alg alg_blk;
1691 struct cs_dsp_coeff_parsed_coeff coeff_blk;
1692 const u8 *data = region->data;
1695 cs_dsp_coeff_parse_alg(dsp, &data, &alg_blk);
1696 for (i = 0; i < alg_blk.ncoeff; i++) {
1697 cs_dsp_coeff_parse_coeff(dsp, &data, &coeff_blk);
1699 switch (coeff_blk.ctl_type) {
1700 case WMFW_CTL_TYPE_BYTES:
1702 case WMFW_CTL_TYPE_ACKED:
1703 if (coeff_blk.flags & WMFW_CTL_FLAG_SYS)
1704 continue; /* ignore */
1706 ret = cs_dsp_check_coeff_flags(dsp, &coeff_blk,
1707 WMFW_CTL_FLAG_VOLATILE |
1708 WMFW_CTL_FLAG_WRITEABLE |
1709 WMFW_CTL_FLAG_READABLE,
1714 case WMFW_CTL_TYPE_HOSTEVENT:
1715 ret = cs_dsp_check_coeff_flags(dsp, &coeff_blk,
1717 WMFW_CTL_FLAG_VOLATILE |
1718 WMFW_CTL_FLAG_WRITEABLE |
1719 WMFW_CTL_FLAG_READABLE,
1724 case WMFW_CTL_TYPE_HOST_BUFFER:
1725 ret = cs_dsp_check_coeff_flags(dsp, &coeff_blk,
1727 WMFW_CTL_FLAG_VOLATILE |
1728 WMFW_CTL_FLAG_READABLE,
1734 cs_dsp_err(dsp, "Unknown control type: %d\n",
1735 coeff_blk.ctl_type);
1739 alg_region.type = coeff_blk.mem_type;
1740 alg_region.alg = alg_blk.id;
1742 ret = cs_dsp_create_control(dsp, &alg_region,
1748 coeff_blk.ctl_type);
1750 cs_dsp_err(dsp, "Failed to create control: %.*s, %d\n",
1751 coeff_blk.name_len, coeff_blk.name, ret);
1757 static unsigned int cs_dsp_adsp1_parse_sizes(struct wm_adsp *dsp,
1758 const char * const file,
1760 const struct firmware *firmware)
1762 const struct wmfw_adsp1_sizes *adsp1_sizes;
1764 adsp1_sizes = (void *)&firmware->data[pos];
1766 cs_dsp_dbg(dsp, "%s: %d DM, %d PM, %d ZM\n", file,
1767 le32_to_cpu(adsp1_sizes->dm), le32_to_cpu(adsp1_sizes->pm),
1768 le32_to_cpu(adsp1_sizes->zm));
1770 return pos + sizeof(*adsp1_sizes);
1773 static unsigned int cs_dsp_adsp2_parse_sizes(struct wm_adsp *dsp,
1774 const char * const file,
1776 const struct firmware *firmware)
1778 const struct wmfw_adsp2_sizes *adsp2_sizes;
1780 adsp2_sizes = (void *)&firmware->data[pos];
1782 cs_dsp_dbg(dsp, "%s: %d XM, %d YM %d PM, %d ZM\n", file,
1783 le32_to_cpu(adsp2_sizes->xm), le32_to_cpu(adsp2_sizes->ym),
1784 le32_to_cpu(adsp2_sizes->pm), le32_to_cpu(adsp2_sizes->zm));
1786 return pos + sizeof(*adsp2_sizes);
1789 static bool cs_dsp_validate_version(struct wm_adsp *dsp, unsigned int version)
1793 cs_dsp_warn(dsp, "Deprecated file format %d\n", version);
1803 static bool cs_dsp_halo_validate_version(struct wm_adsp *dsp, unsigned int version)
1813 static int cs_dsp_load(struct wm_adsp *dsp)
1815 LIST_HEAD(buf_list);
1816 const struct firmware *firmware;
1817 struct regmap *regmap = dsp->regmap;
1818 unsigned int pos = 0;
1819 const struct wmfw_header *header;
1820 const struct wmfw_adsp1_sizes *adsp1_sizes;
1821 const struct wmfw_footer *footer;
1822 const struct wmfw_region *region;
1823 const struct cs_dsp_region *mem;
1824 const char *region_name;
1825 char *file, *text = NULL;
1826 struct cs_dsp_buf *buf;
1829 int ret, offset, type;
1831 file = kzalloc(PAGE_SIZE, GFP_KERNEL);
1835 snprintf(file, PAGE_SIZE, "%s-%s-%s.wmfw", dsp->part, dsp->fwf_name,
1836 wm_adsp_fw[dsp->fw].file);
1837 file[PAGE_SIZE - 1] = '\0';
1839 ret = request_firmware(&firmware, file, dsp->dev);
1841 cs_dsp_err(dsp, "Failed to request '%s'\n", file);
1846 pos = sizeof(*header) + sizeof(*adsp1_sizes) + sizeof(*footer);
1847 if (pos >= firmware->size) {
1848 cs_dsp_err(dsp, "%s: file too short, %zu bytes\n",
1849 file, firmware->size);
1853 header = (void *)&firmware->data[0];
1855 if (memcmp(&header->magic[0], "WMFW", 4) != 0) {
1856 cs_dsp_err(dsp, "%s: invalid magic\n", file);
1860 if (!dsp->ops->validate_version(dsp, header->ver)) {
1861 cs_dsp_err(dsp, "%s: unknown file format %d\n",
1866 cs_dsp_info(dsp, "Firmware version: %d\n", header->ver);
1867 dsp->fw_ver = header->ver;
1869 if (header->core != dsp->type) {
1870 cs_dsp_err(dsp, "%s: invalid core %d != %d\n",
1871 file, header->core, dsp->type);
1875 pos = sizeof(*header);
1876 pos = dsp->ops->parse_sizes(dsp, file, pos, firmware);
1878 footer = (void *)&firmware->data[pos];
1879 pos += sizeof(*footer);
1881 if (le32_to_cpu(header->len) != pos) {
1882 cs_dsp_err(dsp, "%s: unexpected header length %d\n",
1883 file, le32_to_cpu(header->len));
1887 cs_dsp_dbg(dsp, "%s: timestamp %llu\n", file,
1888 le64_to_cpu(footer->timestamp));
1890 while (pos < firmware->size &&
1891 sizeof(*region) < firmware->size - pos) {
1892 region = (void *)&(firmware->data[pos]);
1893 region_name = "Unknown";
1896 offset = le32_to_cpu(region->offset) & 0xffffff;
1897 type = be32_to_cpu(region->type) & 0xff;
1900 case WMFW_NAME_TEXT:
1901 region_name = "Firmware name";
1902 text = kzalloc(le32_to_cpu(region->len) + 1,
1905 case WMFW_ALGORITHM_DATA:
1906 region_name = "Algorithm";
1907 ret = cs_dsp_parse_coeff(dsp, region);
1911 case WMFW_INFO_TEXT:
1912 region_name = "Information";
1913 text = kzalloc(le32_to_cpu(region->len) + 1,
1917 region_name = "Absolute";
1925 case WMFW_HALO_PM_PACKED:
1926 case WMFW_HALO_XM_PACKED:
1927 case WMFW_HALO_YM_PACKED:
1928 mem = cs_dsp_find_region(dsp, type);
1930 cs_dsp_err(dsp, "No region of type: %x\n", type);
1935 region_name = cs_dsp_mem_region_name(type);
1936 reg = dsp->ops->region_to_reg(mem, offset);
1940 "%s.%d: Unknown region type %x at %d(%x)\n",
1941 file, regions, type, pos, pos);
1945 cs_dsp_dbg(dsp, "%s.%d: %d bytes at %d in %s\n", file,
1946 regions, le32_to_cpu(region->len), offset,
1949 if (le32_to_cpu(region->len) >
1950 firmware->size - pos - sizeof(*region)) {
1952 "%s.%d: %s region len %d bytes exceeds file length %zu\n",
1953 file, regions, region_name,
1954 le32_to_cpu(region->len), firmware->size);
1960 memcpy(text, region->data, le32_to_cpu(region->len));
1961 cs_dsp_info(dsp, "%s: %s\n", file, text);
1967 buf = cs_dsp_buf_alloc(region->data,
1968 le32_to_cpu(region->len),
1971 cs_dsp_err(dsp, "Out of memory\n");
1976 ret = regmap_raw_write_async(regmap, reg, buf->buf,
1977 le32_to_cpu(region->len));
1980 "%s.%d: Failed to write %d bytes at %d in %s: %d\n",
1982 le32_to_cpu(region->len), offset,
1988 pos += le32_to_cpu(region->len) + sizeof(*region);
1992 ret = regmap_async_complete(regmap);
1994 cs_dsp_err(dsp, "Failed to complete async write: %d\n", ret);
1998 if (pos > firmware->size)
1999 cs_dsp_warn(dsp, "%s.%d: %zu bytes at end of file\n",
2000 file, regions, pos - firmware->size);
2002 cs_dsp_debugfs_save_wmfwname(dsp, file);
2005 regmap_async_complete(regmap);
2006 cs_dsp_buf_free(&buf_list);
2007 release_firmware(firmware);
2016 * Find wm_coeff_ctl with input name as its subname
2017 * If not found, return NULL
2019 static struct wm_coeff_ctl *cs_dsp_get_ctl(struct wm_adsp *dsp,
2020 const char *name, int type,
2023 struct wm_coeff_ctl *pos, *rslt = NULL;
2024 const char *fw_txt = wm_adsp_fw_text[dsp->fw];
2026 list_for_each_entry(pos, &dsp->ctl_list, list) {
2029 if (strncmp(pos->subname, name, pos->subname_len) == 0 &&
2030 pos->fw_name == fw_txt &&
2031 pos->alg_region.alg == alg &&
2032 pos->alg_region.type == type) {
2041 int wm_adsp_write_ctl(struct wm_adsp *dsp, const char *name, int type,
2042 unsigned int alg, void *buf, size_t len)
2044 struct wm_coeff_ctl *ctl;
2045 struct snd_kcontrol *kcontrol;
2046 char ctl_name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
2049 ctl = cs_dsp_get_ctl(dsp, name, type, alg);
2056 ret = cs_dsp_coeff_write_ctrl(ctl, buf, len);
2060 if (ctl->flags & WMFW_CTL_FLAG_SYS)
2063 if (dsp->component->name_prefix)
2064 snprintf(ctl_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN, "%s %s",
2065 dsp->component->name_prefix, ctl->name);
2067 snprintf(ctl_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN, "%s",
2070 kcontrol = snd_soc_card_get_kcontrol(dsp->component->card, ctl_name);
2072 adsp_err(dsp, "Can't find kcontrol %s\n", ctl_name);
2076 snd_ctl_notify(dsp->component->card->snd_card,
2077 SNDRV_CTL_EVENT_MASK_VALUE, &kcontrol->id);
2081 EXPORT_SYMBOL_GPL(wm_adsp_write_ctl);
2083 int wm_adsp_read_ctl(struct wm_adsp *dsp, const char *name, int type,
2084 unsigned int alg, void *buf, size_t len)
2086 struct wm_coeff_ctl *ctl;
2088 ctl = cs_dsp_get_ctl(dsp, name, type, alg);
2095 return cs_dsp_coeff_read_ctrl(ctl, buf, len);
2097 EXPORT_SYMBOL_GPL(wm_adsp_read_ctl);
2099 static void cs_dsp_ctl_fixup_base(struct wm_adsp *dsp,
2100 const struct cs_dsp_alg_region *alg_region)
2102 struct wm_coeff_ctl *ctl;
2104 list_for_each_entry(ctl, &dsp->ctl_list, list) {
2105 if (ctl->fw_name == wm_adsp_fw_text[dsp->fw] &&
2106 alg_region->alg == ctl->alg_region.alg &&
2107 alg_region->type == ctl->alg_region.type) {
2108 ctl->alg_region.base = alg_region->base;
2113 static void *cs_dsp_read_algs(struct wm_adsp *dsp, size_t n_algs,
2114 const struct cs_dsp_region *mem,
2115 unsigned int pos, unsigned int len)
2123 cs_dsp_err(dsp, "No algorithms\n");
2124 return ERR_PTR(-EINVAL);
2127 if (n_algs > 1024) {
2128 cs_dsp_err(dsp, "Algorithm count %zx excessive\n", n_algs);
2129 return ERR_PTR(-EINVAL);
2132 /* Read the terminator first to validate the length */
2133 reg = dsp->ops->region_to_reg(mem, pos + len);
2135 ret = regmap_raw_read(dsp->regmap, reg, &val, sizeof(val));
2137 cs_dsp_err(dsp, "Failed to read algorithm list end: %d\n",
2139 return ERR_PTR(ret);
2142 if (be32_to_cpu(val) != 0xbedead)
2143 cs_dsp_warn(dsp, "Algorithm list end %x 0x%x != 0xbedead\n",
2144 reg, be32_to_cpu(val));
2146 /* Convert length from DSP words to bytes */
2149 alg = kzalloc(len, GFP_KERNEL | GFP_DMA);
2151 return ERR_PTR(-ENOMEM);
2153 reg = dsp->ops->region_to_reg(mem, pos);
2155 ret = regmap_raw_read(dsp->regmap, reg, alg, len);
2157 cs_dsp_err(dsp, "Failed to read algorithm list: %d\n", ret);
2159 return ERR_PTR(ret);
2165 static struct cs_dsp_alg_region *
2166 cs_dsp_find_alg_region(struct wm_adsp *dsp, int type, unsigned int id)
2168 struct cs_dsp_alg_region *alg_region;
2170 list_for_each_entry(alg_region, &dsp->alg_regions, list) {
2171 if (id == alg_region->alg && type == alg_region->type)
2178 static struct cs_dsp_alg_region *cs_dsp_create_region(struct wm_adsp *dsp,
2179 int type, __be32 id,
2182 struct cs_dsp_alg_region *alg_region;
2184 alg_region = kzalloc(sizeof(*alg_region), GFP_KERNEL);
2186 return ERR_PTR(-ENOMEM);
2188 alg_region->type = type;
2189 alg_region->alg = be32_to_cpu(id);
2190 alg_region->base = be32_to_cpu(base);
2192 list_add_tail(&alg_region->list, &dsp->alg_regions);
2194 if (dsp->fw_ver > 0)
2195 cs_dsp_ctl_fixup_base(dsp, alg_region);
2200 static void cs_dsp_free_alg_regions(struct wm_adsp *dsp)
2202 struct cs_dsp_alg_region *alg_region;
2204 while (!list_empty(&dsp->alg_regions)) {
2205 alg_region = list_first_entry(&dsp->alg_regions,
2206 struct cs_dsp_alg_region,
2208 list_del(&alg_region->list);
2213 static void cs_dsp_parse_wmfw_id_header(struct wm_adsp *dsp,
2214 struct wmfw_id_hdr *fw, int nalgs)
2216 dsp->fw_id = be32_to_cpu(fw->id);
2217 dsp->fw_id_version = be32_to_cpu(fw->ver);
2219 cs_dsp_info(dsp, "Firmware: %x v%d.%d.%d, %d algorithms\n",
2220 dsp->fw_id, (dsp->fw_id_version & 0xff0000) >> 16,
2221 (dsp->fw_id_version & 0xff00) >> 8, dsp->fw_id_version & 0xff,
2225 static void cs_dsp_parse_wmfw_v3_id_header(struct wm_adsp *dsp,
2226 struct wmfw_v3_id_hdr *fw, int nalgs)
2228 dsp->fw_id = be32_to_cpu(fw->id);
2229 dsp->fw_id_version = be32_to_cpu(fw->ver);
2230 dsp->fw_vendor_id = be32_to_cpu(fw->vendor_id);
2232 cs_dsp_info(dsp, "Firmware: %x vendor: 0x%x v%d.%d.%d, %d algorithms\n",
2233 dsp->fw_id, dsp->fw_vendor_id,
2234 (dsp->fw_id_version & 0xff0000) >> 16,
2235 (dsp->fw_id_version & 0xff00) >> 8, dsp->fw_id_version & 0xff,
2239 static int cs_dsp_create_regions(struct wm_adsp *dsp, __be32 id, int nregions,
2240 const int *type, __be32 *base)
2242 struct cs_dsp_alg_region *alg_region;
2245 for (i = 0; i < nregions; i++) {
2246 alg_region = cs_dsp_create_region(dsp, type[i], id, base[i]);
2247 if (IS_ERR(alg_region))
2248 return PTR_ERR(alg_region);
2254 static int cs_dsp_adsp1_setup_algs(struct wm_adsp *dsp)
2256 struct wmfw_adsp1_id_hdr adsp1_id;
2257 struct wmfw_adsp1_alg_hdr *adsp1_alg;
2258 struct cs_dsp_alg_region *alg_region;
2259 const struct cs_dsp_region *mem;
2260 unsigned int pos, len;
2264 mem = cs_dsp_find_region(dsp, WMFW_ADSP1_DM);
2268 ret = regmap_raw_read(dsp->regmap, mem->base, &adsp1_id,
2271 cs_dsp_err(dsp, "Failed to read algorithm info: %d\n",
2276 n_algs = be32_to_cpu(adsp1_id.n_algs);
2278 cs_dsp_parse_wmfw_id_header(dsp, &adsp1_id.fw, n_algs);
2280 alg_region = cs_dsp_create_region(dsp, WMFW_ADSP1_ZM,
2281 adsp1_id.fw.id, adsp1_id.zm);
2282 if (IS_ERR(alg_region))
2283 return PTR_ERR(alg_region);
2285 alg_region = cs_dsp_create_region(dsp, WMFW_ADSP1_DM,
2286 adsp1_id.fw.id, adsp1_id.dm);
2287 if (IS_ERR(alg_region))
2288 return PTR_ERR(alg_region);
2290 /* Calculate offset and length in DSP words */
2291 pos = sizeof(adsp1_id) / sizeof(u32);
2292 len = (sizeof(*adsp1_alg) * n_algs) / sizeof(u32);
2294 adsp1_alg = cs_dsp_read_algs(dsp, n_algs, mem, pos, len);
2295 if (IS_ERR(adsp1_alg))
2296 return PTR_ERR(adsp1_alg);
2298 for (i = 0; i < n_algs; i++) {
2299 cs_dsp_info(dsp, "%d: ID %x v%d.%d.%d DM@%x ZM@%x\n",
2300 i, be32_to_cpu(adsp1_alg[i].alg.id),
2301 (be32_to_cpu(adsp1_alg[i].alg.ver) & 0xff0000) >> 16,
2302 (be32_to_cpu(adsp1_alg[i].alg.ver) & 0xff00) >> 8,
2303 be32_to_cpu(adsp1_alg[i].alg.ver) & 0xff,
2304 be32_to_cpu(adsp1_alg[i].dm),
2305 be32_to_cpu(adsp1_alg[i].zm));
2307 alg_region = cs_dsp_create_region(dsp, WMFW_ADSP1_DM,
2308 adsp1_alg[i].alg.id,
2310 if (IS_ERR(alg_region)) {
2311 ret = PTR_ERR(alg_region);
2314 if (dsp->fw_ver == 0) {
2315 if (i + 1 < n_algs) {
2316 len = be32_to_cpu(adsp1_alg[i + 1].dm);
2317 len -= be32_to_cpu(adsp1_alg[i].dm);
2319 cs_dsp_create_control(dsp, alg_region, 0,
2321 WMFW_CTL_TYPE_BYTES);
2323 cs_dsp_warn(dsp, "Missing length info for region DM with ID %x\n",
2324 be32_to_cpu(adsp1_alg[i].alg.id));
2328 alg_region = cs_dsp_create_region(dsp, WMFW_ADSP1_ZM,
2329 adsp1_alg[i].alg.id,
2331 if (IS_ERR(alg_region)) {
2332 ret = PTR_ERR(alg_region);
2335 if (dsp->fw_ver == 0) {
2336 if (i + 1 < n_algs) {
2337 len = be32_to_cpu(adsp1_alg[i + 1].zm);
2338 len -= be32_to_cpu(adsp1_alg[i].zm);
2340 cs_dsp_create_control(dsp, alg_region, 0,
2342 WMFW_CTL_TYPE_BYTES);
2344 cs_dsp_warn(dsp, "Missing length info for region ZM with ID %x\n",
2345 be32_to_cpu(adsp1_alg[i].alg.id));
2355 static int cs_dsp_adsp2_setup_algs(struct wm_adsp *dsp)
2357 struct wmfw_adsp2_id_hdr adsp2_id;
2358 struct wmfw_adsp2_alg_hdr *adsp2_alg;
2359 struct cs_dsp_alg_region *alg_region;
2360 const struct cs_dsp_region *mem;
2361 unsigned int pos, len;
2365 mem = cs_dsp_find_region(dsp, WMFW_ADSP2_XM);
2369 ret = regmap_raw_read(dsp->regmap, mem->base, &adsp2_id,
2372 cs_dsp_err(dsp, "Failed to read algorithm info: %d\n",
2377 n_algs = be32_to_cpu(adsp2_id.n_algs);
2379 cs_dsp_parse_wmfw_id_header(dsp, &adsp2_id.fw, n_algs);
2381 alg_region = cs_dsp_create_region(dsp, WMFW_ADSP2_XM,
2382 adsp2_id.fw.id, adsp2_id.xm);
2383 if (IS_ERR(alg_region))
2384 return PTR_ERR(alg_region);
2386 alg_region = cs_dsp_create_region(dsp, WMFW_ADSP2_YM,
2387 adsp2_id.fw.id, adsp2_id.ym);
2388 if (IS_ERR(alg_region))
2389 return PTR_ERR(alg_region);
2391 alg_region = cs_dsp_create_region(dsp, WMFW_ADSP2_ZM,
2392 adsp2_id.fw.id, adsp2_id.zm);
2393 if (IS_ERR(alg_region))
2394 return PTR_ERR(alg_region);
2396 /* Calculate offset and length in DSP words */
2397 pos = sizeof(adsp2_id) / sizeof(u32);
2398 len = (sizeof(*adsp2_alg) * n_algs) / sizeof(u32);
2400 adsp2_alg = cs_dsp_read_algs(dsp, n_algs, mem, pos, len);
2401 if (IS_ERR(adsp2_alg))
2402 return PTR_ERR(adsp2_alg);
2404 for (i = 0; i < n_algs; i++) {
2406 "%d: ID %x v%d.%d.%d XM@%x YM@%x ZM@%x\n",
2407 i, be32_to_cpu(adsp2_alg[i].alg.id),
2408 (be32_to_cpu(adsp2_alg[i].alg.ver) & 0xff0000) >> 16,
2409 (be32_to_cpu(adsp2_alg[i].alg.ver) & 0xff00) >> 8,
2410 be32_to_cpu(adsp2_alg[i].alg.ver) & 0xff,
2411 be32_to_cpu(adsp2_alg[i].xm),
2412 be32_to_cpu(adsp2_alg[i].ym),
2413 be32_to_cpu(adsp2_alg[i].zm));
2415 alg_region = cs_dsp_create_region(dsp, WMFW_ADSP2_XM,
2416 adsp2_alg[i].alg.id,
2418 if (IS_ERR(alg_region)) {
2419 ret = PTR_ERR(alg_region);
2422 if (dsp->fw_ver == 0) {
2423 if (i + 1 < n_algs) {
2424 len = be32_to_cpu(adsp2_alg[i + 1].xm);
2425 len -= be32_to_cpu(adsp2_alg[i].xm);
2427 cs_dsp_create_control(dsp, alg_region, 0,
2429 WMFW_CTL_TYPE_BYTES);
2431 cs_dsp_warn(dsp, "Missing length info for region XM with ID %x\n",
2432 be32_to_cpu(adsp2_alg[i].alg.id));
2436 alg_region = cs_dsp_create_region(dsp, WMFW_ADSP2_YM,
2437 adsp2_alg[i].alg.id,
2439 if (IS_ERR(alg_region)) {
2440 ret = PTR_ERR(alg_region);
2443 if (dsp->fw_ver == 0) {
2444 if (i + 1 < n_algs) {
2445 len = be32_to_cpu(adsp2_alg[i + 1].ym);
2446 len -= be32_to_cpu(adsp2_alg[i].ym);
2448 cs_dsp_create_control(dsp, alg_region, 0,
2450 WMFW_CTL_TYPE_BYTES);
2452 cs_dsp_warn(dsp, "Missing length info for region YM with ID %x\n",
2453 be32_to_cpu(adsp2_alg[i].alg.id));
2457 alg_region = cs_dsp_create_region(dsp, WMFW_ADSP2_ZM,
2458 adsp2_alg[i].alg.id,
2460 if (IS_ERR(alg_region)) {
2461 ret = PTR_ERR(alg_region);
2464 if (dsp->fw_ver == 0) {
2465 if (i + 1 < n_algs) {
2466 len = be32_to_cpu(adsp2_alg[i + 1].zm);
2467 len -= be32_to_cpu(adsp2_alg[i].zm);
2469 cs_dsp_create_control(dsp, alg_region, 0,
2471 WMFW_CTL_TYPE_BYTES);
2473 cs_dsp_warn(dsp, "Missing length info for region ZM with ID %x\n",
2474 be32_to_cpu(adsp2_alg[i].alg.id));
2484 static int cs_dsp_halo_create_regions(struct wm_adsp *dsp, __be32 id,
2485 __be32 xm_base, __be32 ym_base)
2487 static const int types[] = {
2488 WMFW_ADSP2_XM, WMFW_HALO_XM_PACKED,
2489 WMFW_ADSP2_YM, WMFW_HALO_YM_PACKED
2491 __be32 bases[] = { xm_base, xm_base, ym_base, ym_base };
2493 return cs_dsp_create_regions(dsp, id, ARRAY_SIZE(types), types, bases);
2496 static int cs_dsp_halo_setup_algs(struct wm_adsp *dsp)
2498 struct wmfw_halo_id_hdr halo_id;
2499 struct wmfw_halo_alg_hdr *halo_alg;
2500 const struct cs_dsp_region *mem;
2501 unsigned int pos, len;
2505 mem = cs_dsp_find_region(dsp, WMFW_ADSP2_XM);
2509 ret = regmap_raw_read(dsp->regmap, mem->base, &halo_id,
2512 cs_dsp_err(dsp, "Failed to read algorithm info: %d\n",
2517 n_algs = be32_to_cpu(halo_id.n_algs);
2519 cs_dsp_parse_wmfw_v3_id_header(dsp, &halo_id.fw, n_algs);
2521 ret = cs_dsp_halo_create_regions(dsp, halo_id.fw.id,
2522 halo_id.xm_base, halo_id.ym_base);
2526 /* Calculate offset and length in DSP words */
2527 pos = sizeof(halo_id) / sizeof(u32);
2528 len = (sizeof(*halo_alg) * n_algs) / sizeof(u32);
2530 halo_alg = cs_dsp_read_algs(dsp, n_algs, mem, pos, len);
2531 if (IS_ERR(halo_alg))
2532 return PTR_ERR(halo_alg);
2534 for (i = 0; i < n_algs; i++) {
2536 "%d: ID %x v%d.%d.%d XM@%x YM@%x\n",
2537 i, be32_to_cpu(halo_alg[i].alg.id),
2538 (be32_to_cpu(halo_alg[i].alg.ver) & 0xff0000) >> 16,
2539 (be32_to_cpu(halo_alg[i].alg.ver) & 0xff00) >> 8,
2540 be32_to_cpu(halo_alg[i].alg.ver) & 0xff,
2541 be32_to_cpu(halo_alg[i].xm_base),
2542 be32_to_cpu(halo_alg[i].ym_base));
2544 ret = cs_dsp_halo_create_regions(dsp, halo_alg[i].alg.id,
2545 halo_alg[i].xm_base,
2546 halo_alg[i].ym_base);
2556 static int cs_dsp_load_coeff(struct wm_adsp *dsp)
2558 LIST_HEAD(buf_list);
2559 struct regmap *regmap = dsp->regmap;
2560 struct wmfw_coeff_hdr *hdr;
2561 struct wmfw_coeff_item *blk;
2562 const struct firmware *firmware;
2563 const struct cs_dsp_region *mem;
2564 struct cs_dsp_alg_region *alg_region;
2565 const char *region_name;
2566 int ret, pos, blocks, type, offset, reg;
2568 struct cs_dsp_buf *buf;
2570 file = kzalloc(PAGE_SIZE, GFP_KERNEL);
2574 snprintf(file, PAGE_SIZE, "%s-%s-%s.bin", dsp->part, dsp->fwf_name,
2575 wm_adsp_fw[dsp->fw].file);
2576 file[PAGE_SIZE - 1] = '\0';
2578 ret = request_firmware(&firmware, file, dsp->dev);
2580 cs_dsp_warn(dsp, "Failed to request '%s'\n", file);
2586 if (sizeof(*hdr) >= firmware->size) {
2587 cs_dsp_err(dsp, "%s: file too short, %zu bytes\n",
2588 file, firmware->size);
2592 hdr = (void *)&firmware->data[0];
2593 if (memcmp(hdr->magic, "WMDR", 4) != 0) {
2594 cs_dsp_err(dsp, "%s: invalid magic\n", file);
2598 switch (be32_to_cpu(hdr->rev) & 0xff) {
2602 cs_dsp_err(dsp, "%s: Unsupported coefficient file format %d\n",
2603 file, be32_to_cpu(hdr->rev) & 0xff);
2608 cs_dsp_dbg(dsp, "%s: v%d.%d.%d\n", file,
2609 (le32_to_cpu(hdr->ver) >> 16) & 0xff,
2610 (le32_to_cpu(hdr->ver) >> 8) & 0xff,
2611 le32_to_cpu(hdr->ver) & 0xff);
2613 pos = le32_to_cpu(hdr->len);
2616 while (pos < firmware->size &&
2617 sizeof(*blk) < firmware->size - pos) {
2618 blk = (void *)(&firmware->data[pos]);
2620 type = le16_to_cpu(blk->type);
2621 offset = le16_to_cpu(blk->offset);
2623 cs_dsp_dbg(dsp, "%s.%d: %x v%d.%d.%d\n",
2624 file, blocks, le32_to_cpu(blk->id),
2625 (le32_to_cpu(blk->ver) >> 16) & 0xff,
2626 (le32_to_cpu(blk->ver) >> 8) & 0xff,
2627 le32_to_cpu(blk->ver) & 0xff);
2628 cs_dsp_dbg(dsp, "%s.%d: %d bytes at 0x%x in %x\n",
2629 file, blocks, le32_to_cpu(blk->len), offset, type);
2632 region_name = "Unknown";
2634 case (WMFW_NAME_TEXT << 8):
2635 case (WMFW_INFO_TEXT << 8):
2636 case (WMFW_METADATA << 8):
2638 case (WMFW_ABSOLUTE << 8):
2640 * Old files may use this for global
2643 if (le32_to_cpu(blk->id) == dsp->fw_id &&
2645 region_name = "global coefficients";
2646 mem = cs_dsp_find_region(dsp, type);
2648 cs_dsp_err(dsp, "No ZM\n");
2651 reg = dsp->ops->region_to_reg(mem, 0);
2654 region_name = "register";
2663 case WMFW_HALO_XM_PACKED:
2664 case WMFW_HALO_YM_PACKED:
2665 case WMFW_HALO_PM_PACKED:
2666 cs_dsp_dbg(dsp, "%s.%d: %d bytes in %x for %x\n",
2667 file, blocks, le32_to_cpu(blk->len),
2668 type, le32_to_cpu(blk->id));
2670 mem = cs_dsp_find_region(dsp, type);
2672 cs_dsp_err(dsp, "No base for region %x\n", type);
2676 alg_region = cs_dsp_find_alg_region(dsp, type,
2677 le32_to_cpu(blk->id));
2679 reg = alg_region->base;
2680 reg = dsp->ops->region_to_reg(mem, reg);
2683 cs_dsp_err(dsp, "No %x for algorithm %x\n",
2684 type, le32_to_cpu(blk->id));
2689 cs_dsp_err(dsp, "%s.%d: Unknown region type %x at %d\n",
2690 file, blocks, type, pos);
2695 if (le32_to_cpu(blk->len) >
2696 firmware->size - pos - sizeof(*blk)) {
2698 "%s.%d: %s region len %d bytes exceeds file length %zu\n",
2699 file, blocks, region_name,
2700 le32_to_cpu(blk->len),
2706 buf = cs_dsp_buf_alloc(blk->data,
2707 le32_to_cpu(blk->len),
2710 cs_dsp_err(dsp, "Out of memory\n");
2715 cs_dsp_dbg(dsp, "%s.%d: Writing %d bytes at %x\n",
2716 file, blocks, le32_to_cpu(blk->len),
2718 ret = regmap_raw_write_async(regmap, reg, buf->buf,
2719 le32_to_cpu(blk->len));
2722 "%s.%d: Failed to write to %x in %s: %d\n",
2723 file, blocks, reg, region_name, ret);
2727 pos += (le32_to_cpu(blk->len) + sizeof(*blk) + 3) & ~0x03;
2731 ret = regmap_async_complete(regmap);
2733 cs_dsp_err(dsp, "Failed to complete async write: %d\n", ret);
2735 if (pos > firmware->size)
2736 cs_dsp_warn(dsp, "%s.%d: %zu bytes at end of file\n",
2737 file, blocks, pos - firmware->size);
2739 cs_dsp_debugfs_save_binname(dsp, file);
2742 regmap_async_complete(regmap);
2743 release_firmware(firmware);
2744 cs_dsp_buf_free(&buf_list);
2750 static int cs_dsp_create_name(struct wm_adsp *dsp)
2755 dsp->name = devm_kasprintf(dsp->dev, GFP_KERNEL, "DSP%d",
2761 if (!dsp->fwf_name) {
2762 p = devm_kstrdup(dsp->dev, dsp->name, GFP_KERNEL);
2767 for (; *p != 0; ++p)
2774 static int wm_adsp_common_init(struct wm_adsp *dsp)
2778 ret = cs_dsp_create_name(dsp);
2782 INIT_LIST_HEAD(&dsp->alg_regions);
2783 INIT_LIST_HEAD(&dsp->ctl_list);
2784 INIT_LIST_HEAD(&dsp->compr_list);
2785 INIT_LIST_HEAD(&dsp->buffer_list);
2787 mutex_init(&dsp->pwr_lock);
2792 int wm_adsp1_init(struct wm_adsp *dsp)
2794 dsp->ops = &cs_dsp_adsp1_ops;
2796 return wm_adsp_common_init(dsp);
2798 EXPORT_SYMBOL_GPL(wm_adsp1_init);
2800 int wm_adsp1_event(struct snd_soc_dapm_widget *w,
2801 struct snd_kcontrol *kcontrol,
2804 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
2805 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
2806 struct wm_adsp *dsp = &dsps[w->shift];
2807 struct wm_coeff_ctl *ctl;
2811 dsp->component = component;
2813 mutex_lock(&dsp->pwr_lock);
2816 case SND_SOC_DAPM_POST_PMU:
2817 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2818 ADSP1_SYS_ENA, ADSP1_SYS_ENA);
2821 * For simplicity set the DSP clock rate to be the
2822 * SYSCLK rate rather than making it configurable.
2824 if (dsp->sysclk_reg) {
2825 ret = regmap_read(dsp->regmap, dsp->sysclk_reg, &val);
2827 cs_dsp_err(dsp, "Failed to read SYSCLK state: %d\n", ret);
2831 val = (val & dsp->sysclk_mask) >> dsp->sysclk_shift;
2833 ret = regmap_update_bits(dsp->regmap,
2834 dsp->base + ADSP1_CONTROL_31,
2835 ADSP1_CLK_SEL_MASK, val);
2837 cs_dsp_err(dsp, "Failed to set clock rate: %d\n", ret);
2842 ret = cs_dsp_load(dsp);
2846 ret = cs_dsp_adsp1_setup_algs(dsp);
2850 ret = cs_dsp_load_coeff(dsp);
2854 /* Initialize caches for enabled and unset controls */
2855 ret = cs_dsp_coeff_init_control_caches(dsp);
2859 /* Sync set controls */
2860 ret = cs_dsp_coeff_sync_controls(dsp);
2866 /* Start the core running */
2867 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2868 ADSP1_CORE_ENA | ADSP1_START,
2869 ADSP1_CORE_ENA | ADSP1_START);
2871 dsp->running = true;
2874 case SND_SOC_DAPM_PRE_PMD:
2875 dsp->running = false;
2876 dsp->booted = false;
2879 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2880 ADSP1_CORE_ENA | ADSP1_START, 0);
2882 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_19,
2883 ADSP1_WDMA_BUFFER_LENGTH_MASK, 0);
2885 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2888 list_for_each_entry(ctl, &dsp->ctl_list, list)
2892 cs_dsp_free_alg_regions(dsp);
2899 mutex_unlock(&dsp->pwr_lock);
2904 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2907 mutex_unlock(&dsp->pwr_lock);
2911 EXPORT_SYMBOL_GPL(wm_adsp1_event);
2913 static int cs_dsp_adsp2v2_enable_core(struct wm_adsp *dsp)
2918 /* Wait for the RAM to start, should be near instantaneous */
2919 for (count = 0; count < 10; ++count) {
2920 ret = regmap_read(dsp->regmap, dsp->base + ADSP2_STATUS1, &val);
2924 if (val & ADSP2_RAM_RDY)
2927 usleep_range(250, 500);
2930 if (!(val & ADSP2_RAM_RDY)) {
2931 cs_dsp_err(dsp, "Failed to start DSP RAM\n");
2935 cs_dsp_dbg(dsp, "RAM ready after %d polls\n", count);
2940 static int cs_dsp_adsp2_enable_core(struct wm_adsp *dsp)
2944 ret = regmap_update_bits_async(dsp->regmap, dsp->base + ADSP2_CONTROL,
2945 ADSP2_SYS_ENA, ADSP2_SYS_ENA);
2949 return cs_dsp_adsp2v2_enable_core(dsp);
2952 static int cs_dsp_adsp2_lock(struct wm_adsp *dsp, unsigned int lock_regions)
2954 struct regmap *regmap = dsp->regmap;
2955 unsigned int code0, code1, lock_reg;
2957 if (!(lock_regions & CS_ADSP2_REGION_ALL))
2960 lock_regions &= CS_ADSP2_REGION_ALL;
2961 lock_reg = dsp->base + ADSP2_LOCK_REGION_1_LOCK_REGION_0;
2963 while (lock_regions) {
2965 if (lock_regions & BIT(0)) {
2966 code0 = ADSP2_LOCK_CODE_0;
2967 code1 = ADSP2_LOCK_CODE_1;
2969 if (lock_regions & BIT(1)) {
2970 code0 |= ADSP2_LOCK_CODE_0 << ADSP2_LOCK_REGION_SHIFT;
2971 code1 |= ADSP2_LOCK_CODE_1 << ADSP2_LOCK_REGION_SHIFT;
2973 regmap_write(regmap, lock_reg, code0);
2974 regmap_write(regmap, lock_reg, code1);
2982 static int cs_dsp_adsp2_enable_memory(struct wm_adsp *dsp)
2984 return regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
2985 ADSP2_MEM_ENA, ADSP2_MEM_ENA);
2988 static void cs_dsp_adsp2_disable_memory(struct wm_adsp *dsp)
2990 regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
2994 static void cs_dsp_adsp2_disable_core(struct wm_adsp *dsp)
2996 regmap_write(dsp->regmap, dsp->base + ADSP2_RDMA_CONFIG_1, 0);
2997 regmap_write(dsp->regmap, dsp->base + ADSP2_WDMA_CONFIG_1, 0);
2998 regmap_write(dsp->regmap, dsp->base + ADSP2_WDMA_CONFIG_2, 0);
3000 regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
3004 static void cs_dsp_adsp2v2_disable_core(struct wm_adsp *dsp)
3006 regmap_write(dsp->regmap, dsp->base + ADSP2_RDMA_CONFIG_1, 0);
3007 regmap_write(dsp->regmap, dsp->base + ADSP2_WDMA_CONFIG_1, 0);
3008 regmap_write(dsp->regmap, dsp->base + ADSP2V2_WDMA_CONFIG_2, 0);
3011 static void wm_adsp_boot_work(struct work_struct *work)
3013 struct wm_adsp *dsp = container_of(work,
3018 mutex_lock(&dsp->pwr_lock);
3020 if (dsp->ops->enable_memory) {
3021 ret = dsp->ops->enable_memory(dsp);
3026 if (dsp->ops->enable_core) {
3027 ret = dsp->ops->enable_core(dsp);
3032 ret = cs_dsp_load(dsp);
3036 ret = dsp->ops->setup_algs(dsp);
3040 ret = cs_dsp_load_coeff(dsp);
3044 /* Initialize caches for enabled and unset controls */
3045 ret = cs_dsp_coeff_init_control_caches(dsp);
3049 if (dsp->ops->disable_core)
3050 dsp->ops->disable_core(dsp);
3054 mutex_unlock(&dsp->pwr_lock);
3059 if (dsp->ops->disable_core)
3060 dsp->ops->disable_core(dsp);
3062 if (dsp->ops->disable_memory)
3063 dsp->ops->disable_memory(dsp);
3065 mutex_unlock(&dsp->pwr_lock);
3068 static int cs_dsp_halo_configure_mpu(struct wm_adsp *dsp, unsigned int lock_regions)
3070 struct reg_sequence config[] = {
3071 { dsp->base + HALO_MPU_LOCK_CONFIG, 0x5555 },
3072 { dsp->base + HALO_MPU_LOCK_CONFIG, 0xAAAA },
3073 { dsp->base + HALO_MPU_XMEM_ACCESS_0, 0xFFFFFFFF },
3074 { dsp->base + HALO_MPU_YMEM_ACCESS_0, 0xFFFFFFFF },
3075 { dsp->base + HALO_MPU_WINDOW_ACCESS_0, lock_regions },
3076 { dsp->base + HALO_MPU_XREG_ACCESS_0, lock_regions },
3077 { dsp->base + HALO_MPU_YREG_ACCESS_0, lock_regions },
3078 { dsp->base + HALO_MPU_XMEM_ACCESS_1, 0xFFFFFFFF },
3079 { dsp->base + HALO_MPU_YMEM_ACCESS_1, 0xFFFFFFFF },
3080 { dsp->base + HALO_MPU_WINDOW_ACCESS_1, lock_regions },
3081 { dsp->base + HALO_MPU_XREG_ACCESS_1, lock_regions },
3082 { dsp->base + HALO_MPU_YREG_ACCESS_1, lock_regions },
3083 { dsp->base + HALO_MPU_XMEM_ACCESS_2, 0xFFFFFFFF },
3084 { dsp->base + HALO_MPU_YMEM_ACCESS_2, 0xFFFFFFFF },
3085 { dsp->base + HALO_MPU_WINDOW_ACCESS_2, lock_regions },
3086 { dsp->base + HALO_MPU_XREG_ACCESS_2, lock_regions },
3087 { dsp->base + HALO_MPU_YREG_ACCESS_2, lock_regions },
3088 { dsp->base + HALO_MPU_XMEM_ACCESS_3, 0xFFFFFFFF },
3089 { dsp->base + HALO_MPU_YMEM_ACCESS_3, 0xFFFFFFFF },
3090 { dsp->base + HALO_MPU_WINDOW_ACCESS_3, lock_regions },
3091 { dsp->base + HALO_MPU_XREG_ACCESS_3, lock_regions },
3092 { dsp->base + HALO_MPU_YREG_ACCESS_3, lock_regions },
3093 { dsp->base + HALO_MPU_LOCK_CONFIG, 0 },
3096 return regmap_multi_reg_write(dsp->regmap, config, ARRAY_SIZE(config));
3099 int wm_adsp2_set_dspclk(struct snd_soc_dapm_widget *w, unsigned int freq)
3101 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
3102 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
3103 struct wm_adsp *dsp = &dsps[w->shift];
3106 ret = regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CLOCKING,
3108 freq << ADSP2_CLK_SEL_SHIFT);
3110 cs_dsp_err(dsp, "Failed to set clock rate: %d\n", ret);
3114 EXPORT_SYMBOL_GPL(wm_adsp2_set_dspclk);
3116 int wm_adsp2_preloader_get(struct snd_kcontrol *kcontrol,
3117 struct snd_ctl_elem_value *ucontrol)
3119 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
3120 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
3121 struct soc_mixer_control *mc =
3122 (struct soc_mixer_control *)kcontrol->private_value;
3123 struct wm_adsp *dsp = &dsps[mc->shift - 1];
3125 ucontrol->value.integer.value[0] = dsp->preloaded;
3129 EXPORT_SYMBOL_GPL(wm_adsp2_preloader_get);
3131 int wm_adsp2_preloader_put(struct snd_kcontrol *kcontrol,
3132 struct snd_ctl_elem_value *ucontrol)
3134 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
3135 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
3136 struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(component);
3137 struct soc_mixer_control *mc =
3138 (struct soc_mixer_control *)kcontrol->private_value;
3139 struct wm_adsp *dsp = &dsps[mc->shift - 1];
3142 snprintf(preload, ARRAY_SIZE(preload), "%s Preload", dsp->name);
3144 dsp->preloaded = ucontrol->value.integer.value[0];
3146 if (ucontrol->value.integer.value[0])
3147 snd_soc_component_force_enable_pin(component, preload);
3149 snd_soc_component_disable_pin(component, preload);
3151 snd_soc_dapm_sync(dapm);
3153 flush_work(&dsp->boot_work);
3157 EXPORT_SYMBOL_GPL(wm_adsp2_preloader_put);
3159 static void cs_dsp_stop_watchdog(struct wm_adsp *dsp)
3161 regmap_update_bits(dsp->regmap, dsp->base + ADSP2_WATCHDOG,
3162 ADSP2_WDT_ENA_MASK, 0);
3165 static void cs_dsp_halo_stop_watchdog(struct wm_adsp *dsp)
3167 regmap_update_bits(dsp->regmap, dsp->base + HALO_WDT_CONTROL,
3168 HALO_WDT_EN_MASK, 0);
3171 int wm_adsp_early_event(struct snd_soc_dapm_widget *w,
3172 struct snd_kcontrol *kcontrol, int event)
3174 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
3175 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
3176 struct wm_adsp *dsp = &dsps[w->shift];
3177 struct wm_coeff_ctl *ctl;
3180 case SND_SOC_DAPM_PRE_PMU:
3181 queue_work(system_unbound_wq, &dsp->boot_work);
3183 case SND_SOC_DAPM_PRE_PMD:
3184 mutex_lock(&dsp->pwr_lock);
3186 cs_dsp_debugfs_clear(dsp);
3189 dsp->fw_id_version = 0;
3191 dsp->booted = false;
3193 if (dsp->ops->disable_memory)
3194 dsp->ops->disable_memory(dsp);
3196 list_for_each_entry(ctl, &dsp->ctl_list, list)
3199 cs_dsp_free_alg_regions(dsp);
3201 mutex_unlock(&dsp->pwr_lock);
3203 cs_dsp_dbg(dsp, "Shutdown complete\n");
3211 EXPORT_SYMBOL_GPL(wm_adsp_early_event);
3213 static int cs_dsp_adsp2_start_core(struct wm_adsp *dsp)
3215 return regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
3216 ADSP2_CORE_ENA | ADSP2_START,
3217 ADSP2_CORE_ENA | ADSP2_START);
3220 static void cs_dsp_adsp2_stop_core(struct wm_adsp *dsp)
3222 regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
3223 ADSP2_CORE_ENA | ADSP2_START, 0);
3226 int wm_adsp_event(struct snd_soc_dapm_widget *w,
3227 struct snd_kcontrol *kcontrol, int event)
3229 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
3230 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
3231 struct wm_adsp *dsp = &dsps[w->shift];
3235 case SND_SOC_DAPM_POST_PMU:
3236 flush_work(&dsp->boot_work);
3238 mutex_lock(&dsp->pwr_lock);
3245 if (dsp->ops->enable_core) {
3246 ret = dsp->ops->enable_core(dsp);
3251 /* Sync set controls */
3252 ret = cs_dsp_coeff_sync_controls(dsp);
3256 if (dsp->ops->lock_memory) {
3257 ret = dsp->ops->lock_memory(dsp, dsp->lock_regions);
3259 cs_dsp_err(dsp, "Error configuring MPU: %d\n", ret);
3264 if (dsp->ops->start_core) {
3265 ret = dsp->ops->start_core(dsp);
3270 dsp->running = true;
3272 if (wm_adsp_fw[dsp->fw].num_caps != 0) {
3273 ret = wm_adsp_buffer_init(dsp);
3278 mutex_unlock(&dsp->pwr_lock);
3281 case SND_SOC_DAPM_PRE_PMD:
3282 /* Tell the firmware to cleanup */
3283 cs_dsp_signal_event_controls(dsp, CS_DSP_FW_EVENT_SHUTDOWN);
3285 if (dsp->ops->stop_watchdog)
3286 dsp->ops->stop_watchdog(dsp);
3288 /* Log firmware state, it can be useful for analysis */
3289 if (dsp->ops->show_fw_status)
3290 dsp->ops->show_fw_status(dsp);
3292 mutex_lock(&dsp->pwr_lock);
3294 dsp->running = false;
3296 if (dsp->ops->stop_core)
3297 dsp->ops->stop_core(dsp);
3298 if (dsp->ops->disable_core)
3299 dsp->ops->disable_core(dsp);
3301 if (wm_adsp_fw[dsp->fw].num_caps != 0)
3302 wm_adsp_buffer_free(dsp);
3304 dsp->fatal_error = false;
3306 mutex_unlock(&dsp->pwr_lock);
3308 cs_dsp_dbg(dsp, "Execution stopped\n");
3317 if (dsp->ops->stop_core)
3318 dsp->ops->stop_core(dsp);
3319 if (dsp->ops->disable_core)
3320 dsp->ops->disable_core(dsp);
3321 mutex_unlock(&dsp->pwr_lock);
3324 EXPORT_SYMBOL_GPL(wm_adsp_event);
3326 static int cs_dsp_halo_start_core(struct wm_adsp *dsp)
3328 return regmap_update_bits(dsp->regmap,
3329 dsp->base + HALO_CCM_CORE_CONTROL,
3330 HALO_CORE_RESET | HALO_CORE_EN,
3331 HALO_CORE_RESET | HALO_CORE_EN);
3334 static void cs_dsp_halo_stop_core(struct wm_adsp *dsp)
3336 regmap_update_bits(dsp->regmap, dsp->base + HALO_CCM_CORE_CONTROL,
3339 /* reset halo core with CORE_SOFT_RESET */
3340 regmap_update_bits(dsp->regmap, dsp->base + HALO_CORE_SOFT_RESET,
3341 HALO_CORE_SOFT_RESET_MASK, 1);
3344 int wm_adsp2_component_probe(struct wm_adsp *dsp, struct snd_soc_component *component)
3348 snprintf(preload, ARRAY_SIZE(preload), "%s Preload", dsp->name);
3349 snd_soc_component_disable_pin(component, preload);
3351 cs_dsp_init_debugfs(dsp, component);
3353 dsp->component = component;
3357 EXPORT_SYMBOL_GPL(wm_adsp2_component_probe);
3359 int wm_adsp2_component_remove(struct wm_adsp *dsp, struct snd_soc_component *component)
3361 cs_dsp_cleanup_debugfs(dsp);
3365 EXPORT_SYMBOL_GPL(wm_adsp2_component_remove);
3367 int wm_adsp2_init(struct wm_adsp *dsp)
3371 ret = wm_adsp_common_init(dsp);
3378 * Disable the DSP memory by default when in reset for a small
3381 ret = regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
3385 "Failed to clear memory retention: %d\n", ret);
3389 dsp->ops = &cs_dsp_adsp2_ops[0];
3392 dsp->ops = &cs_dsp_adsp2_ops[1];
3395 dsp->ops = &cs_dsp_adsp2_ops[2];
3399 INIT_WORK(&dsp->boot_work, wm_adsp_boot_work);
3403 EXPORT_SYMBOL_GPL(wm_adsp2_init);
3405 int wm_halo_init(struct wm_adsp *dsp)
3409 ret = wm_adsp_common_init(dsp);
3413 dsp->ops = &cs_dsp_halo_ops;
3415 INIT_WORK(&dsp->boot_work, wm_adsp_boot_work);
3419 EXPORT_SYMBOL_GPL(wm_halo_init);
3421 void wm_adsp2_remove(struct wm_adsp *dsp)
3423 struct wm_coeff_ctl *ctl;
3425 while (!list_empty(&dsp->ctl_list)) {
3426 ctl = list_first_entry(&dsp->ctl_list, struct wm_coeff_ctl,
3428 list_del(&ctl->list);
3429 cs_dsp_free_ctl_blk(ctl);
3432 EXPORT_SYMBOL_GPL(wm_adsp2_remove);
3434 static inline int wm_adsp_compr_attached(struct wm_adsp_compr *compr)
3436 return compr->buf != NULL;
3439 static int wm_adsp_compr_attach(struct wm_adsp_compr *compr)
3441 struct wm_adsp_compr_buf *buf = NULL, *tmp;
3443 if (compr->dsp->fatal_error)
3446 list_for_each_entry(tmp, &compr->dsp->buffer_list, list) {
3447 if (!tmp->name || !strcmp(compr->name, tmp->name)) {
3462 static void wm_adsp_compr_detach(struct wm_adsp_compr *compr)
3467 /* Wake the poll so it can see buffer is no longer attached */
3469 snd_compr_fragment_elapsed(compr->stream);
3471 if (wm_adsp_compr_attached(compr)) {
3472 compr->buf->compr = NULL;
3477 int wm_adsp_compr_open(struct wm_adsp *dsp, struct snd_compr_stream *stream)
3479 struct wm_adsp_compr *compr, *tmp;
3480 struct snd_soc_pcm_runtime *rtd = stream->private_data;
3483 mutex_lock(&dsp->pwr_lock);
3485 if (wm_adsp_fw[dsp->fw].num_caps == 0) {
3486 adsp_err(dsp, "%s: Firmware does not support compressed API\n",
3487 asoc_rtd_to_codec(rtd, 0)->name);
3492 if (wm_adsp_fw[dsp->fw].compr_direction != stream->direction) {
3493 adsp_err(dsp, "%s: Firmware does not support stream direction\n",
3494 asoc_rtd_to_codec(rtd, 0)->name);
3499 list_for_each_entry(tmp, &dsp->compr_list, list) {
3500 if (!strcmp(tmp->name, asoc_rtd_to_codec(rtd, 0)->name)) {
3501 adsp_err(dsp, "%s: Only a single stream supported per dai\n",
3502 asoc_rtd_to_codec(rtd, 0)->name);
3508 compr = kzalloc(sizeof(*compr), GFP_KERNEL);
3515 compr->stream = stream;
3516 compr->name = asoc_rtd_to_codec(rtd, 0)->name;
3518 list_add_tail(&compr->list, &dsp->compr_list);
3520 stream->runtime->private_data = compr;
3523 mutex_unlock(&dsp->pwr_lock);
3527 EXPORT_SYMBOL_GPL(wm_adsp_compr_open);
3529 int wm_adsp_compr_free(struct snd_soc_component *component,
3530 struct snd_compr_stream *stream)
3532 struct wm_adsp_compr *compr = stream->runtime->private_data;
3533 struct wm_adsp *dsp = compr->dsp;
3535 mutex_lock(&dsp->pwr_lock);
3537 wm_adsp_compr_detach(compr);
3538 list_del(&compr->list);
3540 kfree(compr->raw_buf);
3543 mutex_unlock(&dsp->pwr_lock);
3547 EXPORT_SYMBOL_GPL(wm_adsp_compr_free);
3549 static int wm_adsp_compr_check_params(struct snd_compr_stream *stream,
3550 struct snd_compr_params *params)
3552 struct wm_adsp_compr *compr = stream->runtime->private_data;
3553 struct wm_adsp *dsp = compr->dsp;
3554 const struct wm_adsp_fw_caps *caps;
3555 const struct snd_codec_desc *desc;
3558 if (params->buffer.fragment_size < WM_ADSP_MIN_FRAGMENT_SIZE ||
3559 params->buffer.fragment_size > WM_ADSP_MAX_FRAGMENT_SIZE ||
3560 params->buffer.fragments < WM_ADSP_MIN_FRAGMENTS ||
3561 params->buffer.fragments > WM_ADSP_MAX_FRAGMENTS ||
3562 params->buffer.fragment_size % CS_DSP_DATA_WORD_SIZE) {
3563 compr_err(compr, "Invalid buffer fragsize=%d fragments=%d\n",
3564 params->buffer.fragment_size,
3565 params->buffer.fragments);
3570 for (i = 0; i < wm_adsp_fw[dsp->fw].num_caps; i++) {
3571 caps = &wm_adsp_fw[dsp->fw].caps[i];
3574 if (caps->id != params->codec.id)
3577 if (stream->direction == SND_COMPRESS_PLAYBACK) {
3578 if (desc->max_ch < params->codec.ch_out)
3581 if (desc->max_ch < params->codec.ch_in)
3585 if (!(desc->formats & (1 << params->codec.format)))
3588 for (j = 0; j < desc->num_sample_rates; ++j)
3589 if (desc->sample_rates[j] == params->codec.sample_rate)
3593 compr_err(compr, "Invalid params id=%u ch=%u,%u rate=%u fmt=%u\n",
3594 params->codec.id, params->codec.ch_in, params->codec.ch_out,
3595 params->codec.sample_rate, params->codec.format);
3599 static inline unsigned int wm_adsp_compr_frag_words(struct wm_adsp_compr *compr)
3601 return compr->size.fragment_size / CS_DSP_DATA_WORD_SIZE;
3604 int wm_adsp_compr_set_params(struct snd_soc_component *component,
3605 struct snd_compr_stream *stream,
3606 struct snd_compr_params *params)
3608 struct wm_adsp_compr *compr = stream->runtime->private_data;
3612 ret = wm_adsp_compr_check_params(stream, params);
3616 compr->size = params->buffer;
3618 compr_dbg(compr, "fragment_size=%d fragments=%d\n",
3619 compr->size.fragment_size, compr->size.fragments);
3621 size = wm_adsp_compr_frag_words(compr) * sizeof(*compr->raw_buf);
3622 compr->raw_buf = kmalloc(size, GFP_DMA | GFP_KERNEL);
3623 if (!compr->raw_buf)
3626 compr->sample_rate = params->codec.sample_rate;
3630 EXPORT_SYMBOL_GPL(wm_adsp_compr_set_params);
3632 int wm_adsp_compr_get_caps(struct snd_soc_component *component,
3633 struct snd_compr_stream *stream,
3634 struct snd_compr_caps *caps)
3636 struct wm_adsp_compr *compr = stream->runtime->private_data;
3637 int fw = compr->dsp->fw;
3640 if (wm_adsp_fw[fw].caps) {
3641 for (i = 0; i < wm_adsp_fw[fw].num_caps; i++)
3642 caps->codecs[i] = wm_adsp_fw[fw].caps[i].id;
3644 caps->num_codecs = i;
3645 caps->direction = wm_adsp_fw[fw].compr_direction;
3647 caps->min_fragment_size = WM_ADSP_MIN_FRAGMENT_SIZE;
3648 caps->max_fragment_size = WM_ADSP_MAX_FRAGMENT_SIZE;
3649 caps->min_fragments = WM_ADSP_MIN_FRAGMENTS;
3650 caps->max_fragments = WM_ADSP_MAX_FRAGMENTS;
3655 EXPORT_SYMBOL_GPL(wm_adsp_compr_get_caps);
3657 static int cs_dsp_read_raw_data_block(struct wm_adsp *dsp, int mem_type,
3658 unsigned int mem_addr,
3659 unsigned int num_words, __be32 *data)
3661 struct cs_dsp_region const *mem = cs_dsp_find_region(dsp, mem_type);
3668 reg = dsp->ops->region_to_reg(mem, mem_addr);
3670 ret = regmap_raw_read(dsp->regmap, reg, data,
3671 sizeof(*data) * num_words);
3678 static inline int cs_dsp_read_data_word(struct wm_adsp *dsp, int mem_type,
3679 unsigned int mem_addr, u32 *data)
3684 ret = cs_dsp_read_raw_data_block(dsp, mem_type, mem_addr, 1, &raw);
3688 *data = be32_to_cpu(raw) & 0x00ffffffu;
3693 static int cs_dsp_write_data_word(struct wm_adsp *dsp, int mem_type,
3694 unsigned int mem_addr, u32 data)
3696 struct cs_dsp_region const *mem = cs_dsp_find_region(dsp, mem_type);
3697 __be32 val = cpu_to_be32(data & 0x00ffffffu);
3703 reg = dsp->ops->region_to_reg(mem, mem_addr);
3705 return regmap_raw_write(dsp->regmap, reg, &val, sizeof(val));
3708 static inline int wm_adsp_buffer_read(struct wm_adsp_compr_buf *buf,
3709 unsigned int field_offset, u32 *data)
3711 return cs_dsp_read_data_word(buf->dsp, buf->host_buf_mem_type,
3712 buf->host_buf_ptr + field_offset, data);
3715 static inline int wm_adsp_buffer_write(struct wm_adsp_compr_buf *buf,
3716 unsigned int field_offset, u32 data)
3718 return cs_dsp_write_data_word(buf->dsp, buf->host_buf_mem_type,
3719 buf->host_buf_ptr + field_offset, data);
3722 static void cs_dsp_remove_padding(u32 *buf, int nwords)
3724 const __be32 *pack_in = (__be32 *)buf;
3725 u8 *pack_out = (u8 *)buf;
3729 * DSP words from the register map have pad bytes and the data bytes
3730 * are in swapped order. This swaps back to the original little-endian
3731 * order and strips the pad bytes.
3733 for (i = 0; i < nwords; i++) {
3734 u32 word = be32_to_cpu(*pack_in++);
3735 *pack_out++ = (u8)word;
3736 *pack_out++ = (u8)(word >> 8);
3737 *pack_out++ = (u8)(word >> 16);
3741 static int wm_adsp_buffer_populate(struct wm_adsp_compr_buf *buf)
3743 const struct wm_adsp_fw_caps *caps = wm_adsp_fw[buf->dsp->fw].caps;
3744 struct wm_adsp_buffer_region *region;
3748 buf->regions = kcalloc(caps->num_regions, sizeof(*buf->regions),
3753 for (i = 0; i < caps->num_regions; ++i) {
3754 region = &buf->regions[i];
3756 region->offset = offset;
3757 region->mem_type = caps->region_defs[i].mem_type;
3759 ret = wm_adsp_buffer_read(buf, caps->region_defs[i].base_offset,
3760 ®ion->base_addr);
3764 ret = wm_adsp_buffer_read(buf, caps->region_defs[i].size_offset,
3769 region->cumulative_size = offset;
3772 "region=%d type=%d base=%08x off=%08x size=%08x\n",
3773 i, region->mem_type, region->base_addr,
3774 region->offset, region->cumulative_size);
3780 static void wm_adsp_buffer_clear(struct wm_adsp_compr_buf *buf)
3782 buf->irq_count = 0xFFFFFFFF;
3783 buf->read_index = -1;
3787 static struct wm_adsp_compr_buf *wm_adsp_buffer_alloc(struct wm_adsp *dsp)
3789 struct wm_adsp_compr_buf *buf;
3791 buf = kzalloc(sizeof(*buf), GFP_KERNEL);
3797 wm_adsp_buffer_clear(buf);
3799 list_add_tail(&buf->list, &dsp->buffer_list);
3804 static int wm_adsp_buffer_parse_legacy(struct wm_adsp *dsp)
3806 struct cs_dsp_alg_region *alg_region;
3807 struct wm_adsp_compr_buf *buf;
3808 u32 xmalg, addr, magic;
3811 alg_region = cs_dsp_find_alg_region(dsp, WMFW_ADSP2_XM, dsp->fw_id);
3813 adsp_err(dsp, "No algorithm region found\n");
3817 buf = wm_adsp_buffer_alloc(dsp);
3821 xmalg = dsp->ops->sys_config_size / sizeof(__be32);
3823 addr = alg_region->base + xmalg + ALG_XM_FIELD(magic);
3824 ret = cs_dsp_read_data_word(dsp, WMFW_ADSP2_XM, addr, &magic);
3828 if (magic != WM_ADSP_ALG_XM_STRUCT_MAGIC)
3831 addr = alg_region->base + xmalg + ALG_XM_FIELD(host_buf_ptr);
3832 for (i = 0; i < 5; ++i) {
3833 ret = cs_dsp_read_data_word(dsp, WMFW_ADSP2_XM, addr,
3834 &buf->host_buf_ptr);
3838 if (buf->host_buf_ptr)
3841 usleep_range(1000, 2000);
3844 if (!buf->host_buf_ptr)
3847 buf->host_buf_mem_type = WMFW_ADSP2_XM;
3849 ret = wm_adsp_buffer_populate(buf);
3853 compr_dbg(buf, "legacy host_buf_ptr=%x\n", buf->host_buf_ptr);
3858 static int wm_adsp_buffer_parse_coeff(struct wm_coeff_ctl *ctl)
3860 struct wm_adsp_host_buf_coeff_v1 coeff_v1;
3861 struct wm_adsp_compr_buf *buf;
3862 unsigned int version;
3865 for (i = 0; i < 5; ++i) {
3866 ret = cs_dsp_coeff_read_ctrl(ctl, &coeff_v1, sizeof(coeff_v1));
3870 if (coeff_v1.host_buf_ptr)
3873 usleep_range(1000, 2000);
3876 if (!coeff_v1.host_buf_ptr) {
3877 adsp_err(ctl->dsp, "Failed to acquire host buffer\n");
3881 buf = wm_adsp_buffer_alloc(ctl->dsp);
3885 buf->host_buf_mem_type = ctl->alg_region.type;
3886 buf->host_buf_ptr = be32_to_cpu(coeff_v1.host_buf_ptr);
3888 ret = wm_adsp_buffer_populate(buf);
3893 * v0 host_buffer coefficients didn't have versioning, so if the
3894 * control is one word, assume version 0.
3896 if (ctl->len == 4) {
3897 compr_dbg(buf, "host_buf_ptr=%x\n", buf->host_buf_ptr);
3901 version = be32_to_cpu(coeff_v1.versions) & HOST_BUF_COEFF_COMPAT_VER_MASK;
3902 version >>= HOST_BUF_COEFF_COMPAT_VER_SHIFT;
3904 if (version > HOST_BUF_COEFF_SUPPORTED_COMPAT_VER) {
3906 "Host buffer coeff ver %u > supported version %u\n",
3907 version, HOST_BUF_COEFF_SUPPORTED_COMPAT_VER);
3911 cs_dsp_remove_padding((u32 *)&coeff_v1.name, ARRAY_SIZE(coeff_v1.name));
3913 buf->name = kasprintf(GFP_KERNEL, "%s-dsp-%s", ctl->dsp->part,
3914 (char *)&coeff_v1.name);
3916 compr_dbg(buf, "host_buf_ptr=%x coeff version %u\n",
3917 buf->host_buf_ptr, version);
3922 static int wm_adsp_buffer_init(struct wm_adsp *dsp)
3924 struct wm_coeff_ctl *ctl;
3927 list_for_each_entry(ctl, &dsp->ctl_list, list) {
3928 if (ctl->type != WMFW_CTL_TYPE_HOST_BUFFER)
3934 ret = wm_adsp_buffer_parse_coeff(ctl);
3936 adsp_err(dsp, "Failed to parse coeff: %d\n", ret);
3938 } else if (ret == 0) {
3939 /* Only one buffer supported for version 0 */
3944 if (list_empty(&dsp->buffer_list)) {
3945 /* Fall back to legacy support */
3946 ret = wm_adsp_buffer_parse_legacy(dsp);
3948 adsp_err(dsp, "Failed to parse legacy: %d\n", ret);
3956 wm_adsp_buffer_free(dsp);
3960 static int wm_adsp_buffer_free(struct wm_adsp *dsp)
3962 struct wm_adsp_compr_buf *buf, *tmp;
3964 list_for_each_entry_safe(buf, tmp, &dsp->buffer_list, list) {
3965 wm_adsp_compr_detach(buf->compr);
3968 kfree(buf->regions);
3969 list_del(&buf->list);
3976 static int wm_adsp_buffer_get_error(struct wm_adsp_compr_buf *buf)
3980 ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(error), &buf->error);
3982 compr_err(buf, "Failed to check buffer error: %d\n", ret);
3985 if (buf->error != 0) {
3986 compr_err(buf, "Buffer error occurred: %d\n", buf->error);
3993 int wm_adsp_compr_trigger(struct snd_soc_component *component,
3994 struct snd_compr_stream *stream, int cmd)
3996 struct wm_adsp_compr *compr = stream->runtime->private_data;
3997 struct wm_adsp *dsp = compr->dsp;
4000 compr_dbg(compr, "Trigger: %d\n", cmd);
4002 mutex_lock(&dsp->pwr_lock);
4005 case SNDRV_PCM_TRIGGER_START:
4006 if (!wm_adsp_compr_attached(compr)) {
4007 ret = wm_adsp_compr_attach(compr);
4009 compr_err(compr, "Failed to link buffer and stream: %d\n",
4015 ret = wm_adsp_buffer_get_error(compr->buf);
4019 /* Trigger the IRQ at one fragment of data */
4020 ret = wm_adsp_buffer_write(compr->buf,
4021 HOST_BUFFER_FIELD(high_water_mark),
4022 wm_adsp_compr_frag_words(compr));
4024 compr_err(compr, "Failed to set high water mark: %d\n",
4029 case SNDRV_PCM_TRIGGER_STOP:
4030 if (wm_adsp_compr_attached(compr))
4031 wm_adsp_buffer_clear(compr->buf);
4038 mutex_unlock(&dsp->pwr_lock);
4042 EXPORT_SYMBOL_GPL(wm_adsp_compr_trigger);
4044 static inline int wm_adsp_buffer_size(struct wm_adsp_compr_buf *buf)
4046 int last_region = wm_adsp_fw[buf->dsp->fw].caps->num_regions - 1;
4048 return buf->regions[last_region].cumulative_size;
4051 static int wm_adsp_buffer_update_avail(struct wm_adsp_compr_buf *buf)
4053 u32 next_read_index, next_write_index;
4054 int write_index, read_index, avail;
4057 /* Only sync read index if we haven't already read a valid index */
4058 if (buf->read_index < 0) {
4059 ret = wm_adsp_buffer_read(buf,
4060 HOST_BUFFER_FIELD(next_read_index),
4065 read_index = sign_extend32(next_read_index, 23);
4067 if (read_index < 0) {
4068 compr_dbg(buf, "Avail check on unstarted stream\n");
4072 buf->read_index = read_index;
4075 ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(next_write_index),
4080 write_index = sign_extend32(next_write_index, 23);
4082 avail = write_index - buf->read_index;
4084 avail += wm_adsp_buffer_size(buf);
4086 compr_dbg(buf, "readindex=0x%x, writeindex=0x%x, avail=%d\n",
4087 buf->read_index, write_index, avail * CS_DSP_DATA_WORD_SIZE);
4094 int wm_adsp_compr_handle_irq(struct wm_adsp *dsp)
4096 struct wm_adsp_compr_buf *buf;
4097 struct wm_adsp_compr *compr;
4100 mutex_lock(&dsp->pwr_lock);
4102 if (list_empty(&dsp->buffer_list)) {
4107 adsp_dbg(dsp, "Handling buffer IRQ\n");
4109 list_for_each_entry(buf, &dsp->buffer_list, list) {
4112 ret = wm_adsp_buffer_get_error(buf);
4114 goto out_notify; /* Wake poll to report error */
4116 ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(irq_count),
4119 compr_err(buf, "Failed to get irq_count: %d\n", ret);
4123 ret = wm_adsp_buffer_update_avail(buf);
4125 compr_err(buf, "Error reading avail: %d\n", ret);
4129 if (wm_adsp_fw[dsp->fw].voice_trigger && buf->irq_count == 2)
4130 ret = WM_ADSP_COMPR_VOICE_TRIGGER;
4133 if (compr && compr->stream)
4134 snd_compr_fragment_elapsed(compr->stream);
4138 mutex_unlock(&dsp->pwr_lock);
4142 EXPORT_SYMBOL_GPL(wm_adsp_compr_handle_irq);
4144 static int wm_adsp_buffer_reenable_irq(struct wm_adsp_compr_buf *buf)
4146 if (buf->irq_count & 0x01)
4149 compr_dbg(buf, "Enable IRQ(0x%x) for next fragment\n", buf->irq_count);
4151 buf->irq_count |= 0x01;
4153 return wm_adsp_buffer_write(buf, HOST_BUFFER_FIELD(irq_ack),
4157 int wm_adsp_compr_pointer(struct snd_soc_component *component,
4158 struct snd_compr_stream *stream,
4159 struct snd_compr_tstamp *tstamp)
4161 struct wm_adsp_compr *compr = stream->runtime->private_data;
4162 struct wm_adsp *dsp = compr->dsp;
4163 struct wm_adsp_compr_buf *buf;
4166 compr_dbg(compr, "Pointer request\n");
4168 mutex_lock(&dsp->pwr_lock);
4172 if (dsp->fatal_error || !buf || buf->error) {
4173 snd_compr_stop_error(stream, SNDRV_PCM_STATE_XRUN);
4178 if (buf->avail < wm_adsp_compr_frag_words(compr)) {
4179 ret = wm_adsp_buffer_update_avail(buf);
4181 compr_err(compr, "Error reading avail: %d\n", ret);
4186 * If we really have less than 1 fragment available tell the
4187 * DSP to inform us once a whole fragment is available.
4189 if (buf->avail < wm_adsp_compr_frag_words(compr)) {
4190 ret = wm_adsp_buffer_get_error(buf);
4193 snd_compr_stop_error(stream,
4194 SNDRV_PCM_STATE_XRUN);
4198 ret = wm_adsp_buffer_reenable_irq(buf);
4200 compr_err(compr, "Failed to re-enable buffer IRQ: %d\n",
4207 tstamp->copied_total = compr->copied_total;
4208 tstamp->copied_total += buf->avail * CS_DSP_DATA_WORD_SIZE;
4209 tstamp->sampling_rate = compr->sample_rate;
4212 mutex_unlock(&dsp->pwr_lock);
4216 EXPORT_SYMBOL_GPL(wm_adsp_compr_pointer);
4218 static int wm_adsp_buffer_capture_block(struct wm_adsp_compr *compr, int target)
4220 struct wm_adsp_compr_buf *buf = compr->buf;
4221 unsigned int adsp_addr;
4222 int mem_type, nwords, max_read;
4225 /* Calculate read parameters */
4226 for (i = 0; i < wm_adsp_fw[buf->dsp->fw].caps->num_regions; ++i)
4227 if (buf->read_index < buf->regions[i].cumulative_size)
4230 if (i == wm_adsp_fw[buf->dsp->fw].caps->num_regions)
4233 mem_type = buf->regions[i].mem_type;
4234 adsp_addr = buf->regions[i].base_addr +
4235 (buf->read_index - buf->regions[i].offset);
4237 max_read = wm_adsp_compr_frag_words(compr);
4238 nwords = buf->regions[i].cumulative_size - buf->read_index;
4240 if (nwords > target)
4242 if (nwords > buf->avail)
4243 nwords = buf->avail;
4244 if (nwords > max_read)
4249 /* Read data from DSP */
4250 ret = cs_dsp_read_raw_data_block(buf->dsp, mem_type, adsp_addr,
4251 nwords, (__be32 *)compr->raw_buf);
4255 cs_dsp_remove_padding(compr->raw_buf, nwords);
4257 /* update read index to account for words read */
4258 buf->read_index += nwords;
4259 if (buf->read_index == wm_adsp_buffer_size(buf))
4260 buf->read_index = 0;
4262 ret = wm_adsp_buffer_write(buf, HOST_BUFFER_FIELD(next_read_index),
4267 /* update avail to account for words read */
4268 buf->avail -= nwords;
4273 static int wm_adsp_compr_read(struct wm_adsp_compr *compr,
4274 char __user *buf, size_t count)
4276 struct wm_adsp *dsp = compr->dsp;
4280 compr_dbg(compr, "Requested read of %zu bytes\n", count);
4282 if (dsp->fatal_error || !compr->buf || compr->buf->error) {
4283 snd_compr_stop_error(compr->stream, SNDRV_PCM_STATE_XRUN);
4287 count /= CS_DSP_DATA_WORD_SIZE;
4290 nwords = wm_adsp_buffer_capture_block(compr, count);
4292 compr_err(compr, "Failed to capture block: %d\n",
4297 nbytes = nwords * CS_DSP_DATA_WORD_SIZE;
4299 compr_dbg(compr, "Read %d bytes\n", nbytes);
4301 if (copy_to_user(buf + ntotal, compr->raw_buf, nbytes)) {
4302 compr_err(compr, "Failed to copy data to user: %d, %d\n",
4309 } while (nwords > 0 && count > 0);
4311 compr->copied_total += ntotal;
4316 int wm_adsp_compr_copy(struct snd_soc_component *component,
4317 struct snd_compr_stream *stream, char __user *buf,
4320 struct wm_adsp_compr *compr = stream->runtime->private_data;
4321 struct wm_adsp *dsp = compr->dsp;
4324 mutex_lock(&dsp->pwr_lock);
4326 if (stream->direction == SND_COMPRESS_CAPTURE)
4327 ret = wm_adsp_compr_read(compr, buf, count);
4331 mutex_unlock(&dsp->pwr_lock);
4335 EXPORT_SYMBOL_GPL(wm_adsp_compr_copy);
4337 static void wm_adsp_fatal_error(struct wm_adsp *dsp)
4339 struct wm_adsp_compr *compr;
4341 dsp->fatal_error = true;
4343 list_for_each_entry(compr, &dsp->compr_list, list) {
4345 snd_compr_fragment_elapsed(compr->stream);
4349 irqreturn_t wm_adsp2_bus_error(int irq, void *data)
4351 struct wm_adsp *dsp = (struct wm_adsp *)data;
4353 struct regmap *regmap = dsp->regmap;
4356 mutex_lock(&dsp->pwr_lock);
4358 ret = regmap_read(regmap, dsp->base + ADSP2_LOCK_REGION_CTRL, &val);
4361 "Failed to read Region Lock Ctrl register: %d\n", ret);
4365 if (val & ADSP2_WDT_TIMEOUT_STS_MASK) {
4366 cs_dsp_err(dsp, "watchdog timeout error\n");
4367 dsp->ops->stop_watchdog(dsp);
4368 wm_adsp_fatal_error(dsp);
4371 if (val & (ADSP2_ADDR_ERR_MASK | ADSP2_REGION_LOCK_ERR_MASK)) {
4372 if (val & ADSP2_ADDR_ERR_MASK)
4373 cs_dsp_err(dsp, "bus error: address error\n");
4375 cs_dsp_err(dsp, "bus error: region lock error\n");
4377 ret = regmap_read(regmap, dsp->base + ADSP2_BUS_ERR_ADDR, &val);
4380 "Failed to read Bus Err Addr register: %d\n",
4385 cs_dsp_err(dsp, "bus error address = 0x%x\n",
4386 val & ADSP2_BUS_ERR_ADDR_MASK);
4388 ret = regmap_read(regmap,
4389 dsp->base + ADSP2_PMEM_ERR_ADDR_XMEM_ERR_ADDR,
4393 "Failed to read Pmem Xmem Err Addr register: %d\n",
4398 cs_dsp_err(dsp, "xmem error address = 0x%x\n",
4399 val & ADSP2_XMEM_ERR_ADDR_MASK);
4400 cs_dsp_err(dsp, "pmem error address = 0x%x\n",
4401 (val & ADSP2_PMEM_ERR_ADDR_MASK) >>
4402 ADSP2_PMEM_ERR_ADDR_SHIFT);
4405 regmap_update_bits(regmap, dsp->base + ADSP2_LOCK_REGION_CTRL,
4406 ADSP2_CTRL_ERR_EINT, ADSP2_CTRL_ERR_EINT);
4409 mutex_unlock(&dsp->pwr_lock);
4413 EXPORT_SYMBOL_GPL(wm_adsp2_bus_error);
4415 irqreturn_t wm_halo_bus_error(int irq, void *data)
4417 struct wm_adsp *dsp = (struct wm_adsp *)data;
4418 struct regmap *regmap = dsp->regmap;
4419 unsigned int fault[6];
4420 struct reg_sequence clear[] = {
4421 { dsp->base + HALO_MPU_XM_VIO_STATUS, 0x0 },
4422 { dsp->base + HALO_MPU_YM_VIO_STATUS, 0x0 },
4423 { dsp->base + HALO_MPU_PM_VIO_STATUS, 0x0 },
4427 mutex_lock(&dsp->pwr_lock);
4429 ret = regmap_read(regmap, dsp->base_sysinfo + HALO_AHBM_WINDOW_DEBUG_1,
4432 cs_dsp_warn(dsp, "Failed to read AHB DEBUG_1: %d\n", ret);
4436 cs_dsp_warn(dsp, "AHB: STATUS: 0x%x ADDR: 0x%x\n",
4437 *fault & HALO_AHBM_FLAGS_ERR_MASK,
4438 (*fault & HALO_AHBM_CORE_ERR_ADDR_MASK) >>
4439 HALO_AHBM_CORE_ERR_ADDR_SHIFT);
4441 ret = regmap_read(regmap, dsp->base_sysinfo + HALO_AHBM_WINDOW_DEBUG_0,
4444 cs_dsp_warn(dsp, "Failed to read AHB DEBUG_0: %d\n", ret);
4448 cs_dsp_warn(dsp, "AHB: SYS_ADDR: 0x%x\n", *fault);
4450 ret = regmap_bulk_read(regmap, dsp->base + HALO_MPU_XM_VIO_ADDR,
4451 fault, ARRAY_SIZE(fault));
4453 cs_dsp_warn(dsp, "Failed to read MPU fault info: %d\n", ret);
4457 cs_dsp_warn(dsp, "XM: STATUS:0x%x ADDR:0x%x\n", fault[1], fault[0]);
4458 cs_dsp_warn(dsp, "YM: STATUS:0x%x ADDR:0x%x\n", fault[3], fault[2]);
4459 cs_dsp_warn(dsp, "PM: STATUS:0x%x ADDR:0x%x\n", fault[5], fault[4]);
4461 ret = regmap_multi_reg_write(dsp->regmap, clear, ARRAY_SIZE(clear));
4463 cs_dsp_warn(dsp, "Failed to clear MPU status: %d\n", ret);
4466 mutex_unlock(&dsp->pwr_lock);
4470 EXPORT_SYMBOL_GPL(wm_halo_bus_error);
4472 irqreturn_t wm_halo_wdt_expire(int irq, void *data)
4474 struct wm_adsp *dsp = data;
4476 mutex_lock(&dsp->pwr_lock);
4478 cs_dsp_warn(dsp, "WDT Expiry Fault\n");
4480 dsp->ops->stop_watchdog(dsp);
4481 wm_adsp_fatal_error(dsp);
4483 mutex_unlock(&dsp->pwr_lock);
4487 EXPORT_SYMBOL_GPL(wm_halo_wdt_expire);
4489 static const struct cs_dsp_ops cs_dsp_adsp1_ops = {
4490 .validate_version = cs_dsp_validate_version,
4491 .parse_sizes = cs_dsp_adsp1_parse_sizes,
4492 .region_to_reg = cs_dsp_region_to_reg,
4495 static const struct cs_dsp_ops cs_dsp_adsp2_ops[] = {
4497 .sys_config_size = sizeof(struct wm_adsp_system_config_xm_hdr),
4498 .parse_sizes = cs_dsp_adsp2_parse_sizes,
4499 .validate_version = cs_dsp_validate_version,
4500 .setup_algs = cs_dsp_adsp2_setup_algs,
4501 .region_to_reg = cs_dsp_region_to_reg,
4503 .show_fw_status = cs_dsp_adsp2_show_fw_status,
4505 .enable_memory = cs_dsp_adsp2_enable_memory,
4506 .disable_memory = cs_dsp_adsp2_disable_memory,
4508 .enable_core = cs_dsp_adsp2_enable_core,
4509 .disable_core = cs_dsp_adsp2_disable_core,
4511 .start_core = cs_dsp_adsp2_start_core,
4512 .stop_core = cs_dsp_adsp2_stop_core,
4516 .sys_config_size = sizeof(struct wm_adsp_system_config_xm_hdr),
4517 .parse_sizes = cs_dsp_adsp2_parse_sizes,
4518 .validate_version = cs_dsp_validate_version,
4519 .setup_algs = cs_dsp_adsp2_setup_algs,
4520 .region_to_reg = cs_dsp_region_to_reg,
4522 .show_fw_status = cs_dsp_adsp2v2_show_fw_status,
4524 .enable_memory = cs_dsp_adsp2_enable_memory,
4525 .disable_memory = cs_dsp_adsp2_disable_memory,
4526 .lock_memory = cs_dsp_adsp2_lock,
4528 .enable_core = cs_dsp_adsp2v2_enable_core,
4529 .disable_core = cs_dsp_adsp2v2_disable_core,
4531 .start_core = cs_dsp_adsp2_start_core,
4532 .stop_core = cs_dsp_adsp2_stop_core,
4535 .sys_config_size = sizeof(struct wm_adsp_system_config_xm_hdr),
4536 .parse_sizes = cs_dsp_adsp2_parse_sizes,
4537 .validate_version = cs_dsp_validate_version,
4538 .setup_algs = cs_dsp_adsp2_setup_algs,
4539 .region_to_reg = cs_dsp_region_to_reg,
4541 .show_fw_status = cs_dsp_adsp2v2_show_fw_status,
4542 .stop_watchdog = cs_dsp_stop_watchdog,
4544 .enable_memory = cs_dsp_adsp2_enable_memory,
4545 .disable_memory = cs_dsp_adsp2_disable_memory,
4546 .lock_memory = cs_dsp_adsp2_lock,
4548 .enable_core = cs_dsp_adsp2v2_enable_core,
4549 .disable_core = cs_dsp_adsp2v2_disable_core,
4551 .start_core = cs_dsp_adsp2_start_core,
4552 .stop_core = cs_dsp_adsp2_stop_core,
4556 static const struct cs_dsp_ops cs_dsp_halo_ops = {
4557 .sys_config_size = sizeof(struct wm_halo_system_config_xm_hdr),
4558 .parse_sizes = cs_dsp_adsp2_parse_sizes,
4559 .validate_version = cs_dsp_halo_validate_version,
4560 .setup_algs = cs_dsp_halo_setup_algs,
4561 .region_to_reg = cs_dsp_halo_region_to_reg,
4563 .show_fw_status = cs_dsp_halo_show_fw_status,
4564 .stop_watchdog = cs_dsp_halo_stop_watchdog,
4566 .lock_memory = cs_dsp_halo_configure_mpu,
4568 .start_core = cs_dsp_halo_start_core,
4569 .stop_core = cs_dsp_halo_stop_core,
4572 MODULE_LICENSE("GPL v2");