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 compr_err(_obj, fmt, ...) \
47 adsp_err(_obj->dsp, "%s: " fmt, _obj->name ? _obj->name : "legacy", \
49 #define compr_dbg(_obj, fmt, ...) \
50 adsp_dbg(_obj->dsp, "%s: " fmt, _obj->name ? _obj->name : "legacy", \
53 #define ADSP1_CONTROL_1 0x00
54 #define ADSP1_CONTROL_2 0x02
55 #define ADSP1_CONTROL_3 0x03
56 #define ADSP1_CONTROL_4 0x04
57 #define ADSP1_CONTROL_5 0x06
58 #define ADSP1_CONTROL_6 0x07
59 #define ADSP1_CONTROL_7 0x08
60 #define ADSP1_CONTROL_8 0x09
61 #define ADSP1_CONTROL_9 0x0A
62 #define ADSP1_CONTROL_10 0x0B
63 #define ADSP1_CONTROL_11 0x0C
64 #define ADSP1_CONTROL_12 0x0D
65 #define ADSP1_CONTROL_13 0x0F
66 #define ADSP1_CONTROL_14 0x10
67 #define ADSP1_CONTROL_15 0x11
68 #define ADSP1_CONTROL_16 0x12
69 #define ADSP1_CONTROL_17 0x13
70 #define ADSP1_CONTROL_18 0x14
71 #define ADSP1_CONTROL_19 0x16
72 #define ADSP1_CONTROL_20 0x17
73 #define ADSP1_CONTROL_21 0x18
74 #define ADSP1_CONTROL_22 0x1A
75 #define ADSP1_CONTROL_23 0x1B
76 #define ADSP1_CONTROL_24 0x1C
77 #define ADSP1_CONTROL_25 0x1E
78 #define ADSP1_CONTROL_26 0x20
79 #define ADSP1_CONTROL_27 0x21
80 #define ADSP1_CONTROL_28 0x22
81 #define ADSP1_CONTROL_29 0x23
82 #define ADSP1_CONTROL_30 0x24
83 #define ADSP1_CONTROL_31 0x26
88 #define ADSP1_WDMA_BUFFER_LENGTH_MASK 0x00FF /* DSP1_WDMA_BUFFER_LENGTH - [7:0] */
89 #define ADSP1_WDMA_BUFFER_LENGTH_SHIFT 0 /* DSP1_WDMA_BUFFER_LENGTH - [7:0] */
90 #define ADSP1_WDMA_BUFFER_LENGTH_WIDTH 8 /* DSP1_WDMA_BUFFER_LENGTH - [7:0] */
96 #define ADSP1_DBG_CLK_ENA 0x0008 /* DSP1_DBG_CLK_ENA */
97 #define ADSP1_DBG_CLK_ENA_MASK 0x0008 /* DSP1_DBG_CLK_ENA */
98 #define ADSP1_DBG_CLK_ENA_SHIFT 3 /* DSP1_DBG_CLK_ENA */
99 #define ADSP1_DBG_CLK_ENA_WIDTH 1 /* DSP1_DBG_CLK_ENA */
100 #define ADSP1_SYS_ENA 0x0004 /* DSP1_SYS_ENA */
101 #define ADSP1_SYS_ENA_MASK 0x0004 /* DSP1_SYS_ENA */
102 #define ADSP1_SYS_ENA_SHIFT 2 /* DSP1_SYS_ENA */
103 #define ADSP1_SYS_ENA_WIDTH 1 /* DSP1_SYS_ENA */
104 #define ADSP1_CORE_ENA 0x0002 /* DSP1_CORE_ENA */
105 #define ADSP1_CORE_ENA_MASK 0x0002 /* DSP1_CORE_ENA */
106 #define ADSP1_CORE_ENA_SHIFT 1 /* DSP1_CORE_ENA */
107 #define ADSP1_CORE_ENA_WIDTH 1 /* DSP1_CORE_ENA */
108 #define ADSP1_START 0x0001 /* DSP1_START */
109 #define ADSP1_START_MASK 0x0001 /* DSP1_START */
110 #define ADSP1_START_SHIFT 0 /* DSP1_START */
111 #define ADSP1_START_WIDTH 1 /* DSP1_START */
116 #define ADSP1_CLK_SEL_MASK 0x0007 /* CLK_SEL_ENA */
117 #define ADSP1_CLK_SEL_SHIFT 0 /* CLK_SEL_ENA */
118 #define ADSP1_CLK_SEL_WIDTH 3 /* CLK_SEL_ENA */
120 #define ADSP2_CONTROL 0x0
121 #define ADSP2_CLOCKING 0x1
122 #define ADSP2V2_CLOCKING 0x2
123 #define ADSP2_STATUS1 0x4
124 #define ADSP2_WDMA_CONFIG_1 0x30
125 #define ADSP2_WDMA_CONFIG_2 0x31
126 #define ADSP2V2_WDMA_CONFIG_2 0x32
127 #define ADSP2_RDMA_CONFIG_1 0x34
129 #define ADSP2_SCRATCH0 0x40
130 #define ADSP2_SCRATCH1 0x41
131 #define ADSP2_SCRATCH2 0x42
132 #define ADSP2_SCRATCH3 0x43
134 #define ADSP2V2_SCRATCH0_1 0x40
135 #define ADSP2V2_SCRATCH2_3 0x42
141 #define ADSP2_MEM_ENA 0x0010 /* DSP1_MEM_ENA */
142 #define ADSP2_MEM_ENA_MASK 0x0010 /* DSP1_MEM_ENA */
143 #define ADSP2_MEM_ENA_SHIFT 4 /* DSP1_MEM_ENA */
144 #define ADSP2_MEM_ENA_WIDTH 1 /* DSP1_MEM_ENA */
145 #define ADSP2_SYS_ENA 0x0004 /* DSP1_SYS_ENA */
146 #define ADSP2_SYS_ENA_MASK 0x0004 /* DSP1_SYS_ENA */
147 #define ADSP2_SYS_ENA_SHIFT 2 /* DSP1_SYS_ENA */
148 #define ADSP2_SYS_ENA_WIDTH 1 /* DSP1_SYS_ENA */
149 #define ADSP2_CORE_ENA 0x0002 /* DSP1_CORE_ENA */
150 #define ADSP2_CORE_ENA_MASK 0x0002 /* DSP1_CORE_ENA */
151 #define ADSP2_CORE_ENA_SHIFT 1 /* DSP1_CORE_ENA */
152 #define ADSP2_CORE_ENA_WIDTH 1 /* DSP1_CORE_ENA */
153 #define ADSP2_START 0x0001 /* DSP1_START */
154 #define ADSP2_START_MASK 0x0001 /* DSP1_START */
155 #define ADSP2_START_SHIFT 0 /* DSP1_START */
156 #define ADSP2_START_WIDTH 1 /* DSP1_START */
161 #define ADSP2_CLK_SEL_MASK 0x0007 /* CLK_SEL_ENA */
162 #define ADSP2_CLK_SEL_SHIFT 0 /* CLK_SEL_ENA */
163 #define ADSP2_CLK_SEL_WIDTH 3 /* CLK_SEL_ENA */
168 #define ADSP2V2_CLK_SEL_MASK 0x70000 /* CLK_SEL_ENA */
169 #define ADSP2V2_CLK_SEL_SHIFT 16 /* CLK_SEL_ENA */
170 #define ADSP2V2_CLK_SEL_WIDTH 3 /* CLK_SEL_ENA */
172 #define ADSP2V2_RATE_MASK 0x7800 /* DSP_RATE */
173 #define ADSP2V2_RATE_SHIFT 11 /* DSP_RATE */
174 #define ADSP2V2_RATE_WIDTH 4 /* DSP_RATE */
179 #define ADSP2_RAM_RDY 0x0001
180 #define ADSP2_RAM_RDY_MASK 0x0001
181 #define ADSP2_RAM_RDY_SHIFT 0
182 #define ADSP2_RAM_RDY_WIDTH 1
187 #define ADSP2_LOCK_CODE_0 0x5555
188 #define ADSP2_LOCK_CODE_1 0xAAAA
190 #define ADSP2_WATCHDOG 0x0A
191 #define ADSP2_BUS_ERR_ADDR 0x52
192 #define ADSP2_REGION_LOCK_STATUS 0x64
193 #define ADSP2_LOCK_REGION_1_LOCK_REGION_0 0x66
194 #define ADSP2_LOCK_REGION_3_LOCK_REGION_2 0x68
195 #define ADSP2_LOCK_REGION_5_LOCK_REGION_4 0x6A
196 #define ADSP2_LOCK_REGION_7_LOCK_REGION_6 0x6C
197 #define ADSP2_LOCK_REGION_9_LOCK_REGION_8 0x6E
198 #define ADSP2_LOCK_REGION_CTRL 0x7A
199 #define ADSP2_PMEM_ERR_ADDR_XMEM_ERR_ADDR 0x7C
201 #define ADSP2_REGION_LOCK_ERR_MASK 0x8000
202 #define ADSP2_ADDR_ERR_MASK 0x4000
203 #define ADSP2_WDT_TIMEOUT_STS_MASK 0x2000
204 #define ADSP2_CTRL_ERR_PAUSE_ENA 0x0002
205 #define ADSP2_CTRL_ERR_EINT 0x0001
207 #define ADSP2_BUS_ERR_ADDR_MASK 0x00FFFFFF
208 #define ADSP2_XMEM_ERR_ADDR_MASK 0x0000FFFF
209 #define ADSP2_PMEM_ERR_ADDR_MASK 0x7FFF0000
210 #define ADSP2_PMEM_ERR_ADDR_SHIFT 16
211 #define ADSP2_WDT_ENA_MASK 0xFFFFFFFD
213 #define ADSP2_LOCK_REGION_SHIFT 16
215 #define ADSP_MAX_STD_CTRL_SIZE 512
217 #define WM_ADSP_ACKED_CTL_TIMEOUT_MS 100
218 #define WM_ADSP_ACKED_CTL_N_QUICKPOLLS 10
219 #define WM_ADSP_ACKED_CTL_MIN_VALUE 0
220 #define WM_ADSP_ACKED_CTL_MAX_VALUE 0xFFFFFF
223 * Event control messages
225 #define WM_ADSP_FW_EVENT_SHUTDOWN 0x000001
230 #define HALO_AHBM_WINDOW_DEBUG_0 0x02040
231 #define HALO_AHBM_WINDOW_DEBUG_1 0x02044
236 #define HALO_SCRATCH1 0x005c0
237 #define HALO_SCRATCH2 0x005c8
238 #define HALO_SCRATCH3 0x005d0
239 #define HALO_SCRATCH4 0x005d8
240 #define HALO_CCM_CORE_CONTROL 0x41000
241 #define HALO_CORE_SOFT_RESET 0x00010
242 #define HALO_WDT_CONTROL 0x47000
247 #define HALO_MPU_XMEM_ACCESS_0 0x43000
248 #define HALO_MPU_YMEM_ACCESS_0 0x43004
249 #define HALO_MPU_WINDOW_ACCESS_0 0x43008
250 #define HALO_MPU_XREG_ACCESS_0 0x4300C
251 #define HALO_MPU_YREG_ACCESS_0 0x43014
252 #define HALO_MPU_XMEM_ACCESS_1 0x43018
253 #define HALO_MPU_YMEM_ACCESS_1 0x4301C
254 #define HALO_MPU_WINDOW_ACCESS_1 0x43020
255 #define HALO_MPU_XREG_ACCESS_1 0x43024
256 #define HALO_MPU_YREG_ACCESS_1 0x4302C
257 #define HALO_MPU_XMEM_ACCESS_2 0x43030
258 #define HALO_MPU_YMEM_ACCESS_2 0x43034
259 #define HALO_MPU_WINDOW_ACCESS_2 0x43038
260 #define HALO_MPU_XREG_ACCESS_2 0x4303C
261 #define HALO_MPU_YREG_ACCESS_2 0x43044
262 #define HALO_MPU_XMEM_ACCESS_3 0x43048
263 #define HALO_MPU_YMEM_ACCESS_3 0x4304C
264 #define HALO_MPU_WINDOW_ACCESS_3 0x43050
265 #define HALO_MPU_XREG_ACCESS_3 0x43054
266 #define HALO_MPU_YREG_ACCESS_3 0x4305C
267 #define HALO_MPU_XM_VIO_ADDR 0x43100
268 #define HALO_MPU_XM_VIO_STATUS 0x43104
269 #define HALO_MPU_YM_VIO_ADDR 0x43108
270 #define HALO_MPU_YM_VIO_STATUS 0x4310C
271 #define HALO_MPU_PM_VIO_ADDR 0x43110
272 #define HALO_MPU_PM_VIO_STATUS 0x43114
273 #define HALO_MPU_LOCK_CONFIG 0x43140
276 * HALO_AHBM_WINDOW_DEBUG_1
278 #define HALO_AHBM_CORE_ERR_ADDR_MASK 0x0fffff00
279 #define HALO_AHBM_CORE_ERR_ADDR_SHIFT 8
280 #define HALO_AHBM_FLAGS_ERR_MASK 0x000000ff
283 * HALO_CCM_CORE_CONTROL
285 #define HALO_CORE_RESET 0x00000200
286 #define HALO_CORE_EN 0x00000001
289 * HALO_CORE_SOFT_RESET
291 #define HALO_CORE_SOFT_RESET_MASK 0x00000001
296 #define HALO_WDT_EN_MASK 0x00000001
299 * HALO_MPU_?M_VIO_STATUS
301 #define HALO_MPU_VIO_STS_MASK 0x007e0000
302 #define HALO_MPU_VIO_STS_SHIFT 17
303 #define HALO_MPU_VIO_ERR_WR_MASK 0x00008000
304 #define HALO_MPU_VIO_ERR_SRC_MASK 0x00007fff
305 #define HALO_MPU_VIO_ERR_SRC_SHIFT 0
307 static const struct wm_adsp_ops wm_adsp1_ops;
308 static const struct wm_adsp_ops wm_adsp2_ops[];
309 static const struct wm_adsp_ops wm_halo_ops;
312 struct list_head list;
316 static struct wm_adsp_buf *wm_adsp_buf_alloc(const void *src, size_t len,
317 struct list_head *list)
319 struct wm_adsp_buf *buf = kzalloc(sizeof(*buf), GFP_KERNEL);
324 buf->buf = vmalloc(len);
329 memcpy(buf->buf, src, len);
332 list_add_tail(&buf->list, list);
337 static void wm_adsp_buf_free(struct list_head *list)
339 while (!list_empty(list)) {
340 struct wm_adsp_buf *buf = list_first_entry(list,
343 list_del(&buf->list);
349 #define WM_ADSP_FW_MBC_VSS 0
350 #define WM_ADSP_FW_HIFI 1
351 #define WM_ADSP_FW_TX 2
352 #define WM_ADSP_FW_TX_SPK 3
353 #define WM_ADSP_FW_RX 4
354 #define WM_ADSP_FW_RX_ANC 5
355 #define WM_ADSP_FW_CTRL 6
356 #define WM_ADSP_FW_ASR 7
357 #define WM_ADSP_FW_TRACE 8
358 #define WM_ADSP_FW_SPK_PROT 9
359 #define WM_ADSP_FW_SPK_CALI 10
360 #define WM_ADSP_FW_SPK_DIAG 11
361 #define WM_ADSP_FW_MISC 12
363 #define WM_ADSP_NUM_FW 13
365 static const char *wm_adsp_fw_text[WM_ADSP_NUM_FW] = {
366 [WM_ADSP_FW_MBC_VSS] = "MBC/VSS",
367 [WM_ADSP_FW_HIFI] = "MasterHiFi",
368 [WM_ADSP_FW_TX] = "Tx",
369 [WM_ADSP_FW_TX_SPK] = "Tx Speaker",
370 [WM_ADSP_FW_RX] = "Rx",
371 [WM_ADSP_FW_RX_ANC] = "Rx ANC",
372 [WM_ADSP_FW_CTRL] = "Voice Ctrl",
373 [WM_ADSP_FW_ASR] = "ASR Assist",
374 [WM_ADSP_FW_TRACE] = "Dbg Trace",
375 [WM_ADSP_FW_SPK_PROT] = "Protection",
376 [WM_ADSP_FW_SPK_CALI] = "Calibration",
377 [WM_ADSP_FW_SPK_DIAG] = "Diagnostic",
378 [WM_ADSP_FW_MISC] = "Misc",
381 struct wm_adsp_system_config_xm_hdr {
387 __be32 dma_buffer_size;
390 __be32 build_job_name[3];
391 __be32 build_job_number;
394 struct wm_halo_system_config_xm_hdr {
395 __be32 halo_heartbeat;
396 __be32 build_job_name[3];
397 __be32 build_job_number;
400 struct wm_adsp_alg_xm_struct {
406 __be32 high_water_mark;
407 __be32 low_water_mark;
408 __be64 smoothed_power;
411 struct wm_adsp_host_buf_coeff_v1 {
412 __be32 host_buf_ptr; /* Host buffer pointer */
413 __be32 versions; /* Version numbers */
414 __be32 name[4]; /* The buffer name */
417 struct wm_adsp_buffer {
418 __be32 buf1_base; /* Base addr of first buffer area */
419 __be32 buf1_size; /* Size of buf1 area in DSP words */
420 __be32 buf2_base; /* Base addr of 2nd buffer area */
421 __be32 buf1_buf2_size; /* Size of buf1+buf2 in DSP words */
422 __be32 buf3_base; /* Base addr of buf3 area */
423 __be32 buf_total_size; /* Size of buf1+buf2+buf3 in DSP words */
424 __be32 high_water_mark; /* Point at which IRQ is asserted */
425 __be32 irq_count; /* bits 1-31 count IRQ assertions */
426 __be32 irq_ack; /* acked IRQ count, bit 0 enables IRQ */
427 __be32 next_write_index; /* word index of next write */
428 __be32 next_read_index; /* word index of next read */
429 __be32 error; /* error if any */
430 __be32 oldest_block_index; /* word index of oldest surviving */
431 __be32 requested_rewind; /* how many blocks rewind was done */
432 __be32 reserved_space; /* internal */
433 __be32 min_free; /* min free space since stream start */
434 __be32 blocks_written[2]; /* total blocks written (64 bit) */
435 __be32 words_written[2]; /* total words written (64 bit) */
438 struct wm_adsp_compr;
440 struct wm_adsp_compr_buf {
441 struct list_head list;
443 struct wm_adsp_compr *compr;
445 struct wm_adsp_buffer_region *regions;
452 int host_buf_mem_type;
457 struct wm_adsp_compr {
458 struct list_head list;
460 struct wm_adsp_compr_buf *buf;
462 struct snd_compr_stream *stream;
463 struct snd_compressed_buffer size;
466 unsigned int copied_total;
468 unsigned int sample_rate;
473 #define WM_ADSP_DATA_WORD_SIZE 3
475 #define WM_ADSP_MIN_FRAGMENTS 1
476 #define WM_ADSP_MAX_FRAGMENTS 256
477 #define WM_ADSP_MIN_FRAGMENT_SIZE (64 * WM_ADSP_DATA_WORD_SIZE)
478 #define WM_ADSP_MAX_FRAGMENT_SIZE (4096 * WM_ADSP_DATA_WORD_SIZE)
480 #define WM_ADSP_ALG_XM_STRUCT_MAGIC 0x49aec7
482 #define HOST_BUFFER_FIELD(field) \
483 (offsetof(struct wm_adsp_buffer, field) / sizeof(__be32))
485 #define ALG_XM_FIELD(field) \
486 (offsetof(struct wm_adsp_alg_xm_struct, field) / sizeof(__be32))
488 #define HOST_BUF_COEFF_SUPPORTED_COMPAT_VER 1
490 #define HOST_BUF_COEFF_COMPAT_VER_MASK 0xFF00
491 #define HOST_BUF_COEFF_COMPAT_VER_SHIFT 8
493 static int wm_adsp_buffer_init(struct wm_adsp *dsp);
494 static int wm_adsp_buffer_free(struct wm_adsp *dsp);
496 struct wm_adsp_buffer_region {
498 unsigned int cumulative_size;
499 unsigned int mem_type;
500 unsigned int base_addr;
503 struct wm_adsp_buffer_region_def {
504 unsigned int mem_type;
505 unsigned int base_offset;
506 unsigned int size_offset;
509 static const struct wm_adsp_buffer_region_def default_regions[] = {
511 .mem_type = WMFW_ADSP2_XM,
512 .base_offset = HOST_BUFFER_FIELD(buf1_base),
513 .size_offset = HOST_BUFFER_FIELD(buf1_size),
516 .mem_type = WMFW_ADSP2_XM,
517 .base_offset = HOST_BUFFER_FIELD(buf2_base),
518 .size_offset = HOST_BUFFER_FIELD(buf1_buf2_size),
521 .mem_type = WMFW_ADSP2_YM,
522 .base_offset = HOST_BUFFER_FIELD(buf3_base),
523 .size_offset = HOST_BUFFER_FIELD(buf_total_size),
527 struct wm_adsp_fw_caps {
529 struct snd_codec_desc desc;
531 const struct wm_adsp_buffer_region_def *region_defs;
534 static const struct wm_adsp_fw_caps ctrl_caps[] = {
536 .id = SND_AUDIOCODEC_BESPOKE,
539 .sample_rates = { 16000 },
540 .num_sample_rates = 1,
541 .formats = SNDRV_PCM_FMTBIT_S16_LE,
543 .num_regions = ARRAY_SIZE(default_regions),
544 .region_defs = default_regions,
548 static const struct wm_adsp_fw_caps trace_caps[] = {
550 .id = SND_AUDIOCODEC_BESPOKE,
554 4000, 8000, 11025, 12000, 16000, 22050,
555 24000, 32000, 44100, 48000, 64000, 88200,
556 96000, 176400, 192000
558 .num_sample_rates = 15,
559 .formats = SNDRV_PCM_FMTBIT_S16_LE,
561 .num_regions = ARRAY_SIZE(default_regions),
562 .region_defs = default_regions,
566 static const struct {
570 const struct wm_adsp_fw_caps *caps;
572 } wm_adsp_fw[WM_ADSP_NUM_FW] = {
573 [WM_ADSP_FW_MBC_VSS] = { .file = "mbc-vss" },
574 [WM_ADSP_FW_HIFI] = { .file = "hifi" },
575 [WM_ADSP_FW_TX] = { .file = "tx" },
576 [WM_ADSP_FW_TX_SPK] = { .file = "tx-spk" },
577 [WM_ADSP_FW_RX] = { .file = "rx" },
578 [WM_ADSP_FW_RX_ANC] = { .file = "rx-anc" },
579 [WM_ADSP_FW_CTRL] = {
581 .compr_direction = SND_COMPRESS_CAPTURE,
582 .num_caps = ARRAY_SIZE(ctrl_caps),
584 .voice_trigger = true,
586 [WM_ADSP_FW_ASR] = { .file = "asr" },
587 [WM_ADSP_FW_TRACE] = {
589 .compr_direction = SND_COMPRESS_CAPTURE,
590 .num_caps = ARRAY_SIZE(trace_caps),
593 [WM_ADSP_FW_SPK_PROT] = { .file = "spk-prot" },
594 [WM_ADSP_FW_SPK_CALI] = { .file = "spk-cali" },
595 [WM_ADSP_FW_SPK_DIAG] = { .file = "spk-diag" },
596 [WM_ADSP_FW_MISC] = { .file = "misc" },
599 struct wm_coeff_ctl {
602 /* Subname is needed to match with firmware */
604 unsigned int subname_len;
605 struct wm_adsp_alg_region alg_region;
607 unsigned int enabled:1;
608 struct list_head list;
613 struct soc_bytes_ext bytes_ext;
616 struct work_struct work;
619 static const char *wm_adsp_mem_region_name(unsigned int type)
624 case WMFW_HALO_PM_PACKED:
630 case WMFW_HALO_XM_PACKED:
634 case WMFW_HALO_YM_PACKED:
643 #ifdef CONFIG_DEBUG_FS
644 static void wm_adsp_debugfs_save_wmfwname(struct wm_adsp *dsp, const char *s)
646 char *tmp = kasprintf(GFP_KERNEL, "%s\n", s);
648 kfree(dsp->wmfw_file_name);
649 dsp->wmfw_file_name = tmp;
652 static void wm_adsp_debugfs_save_binname(struct wm_adsp *dsp, const char *s)
654 char *tmp = kasprintf(GFP_KERNEL, "%s\n", s);
656 kfree(dsp->bin_file_name);
657 dsp->bin_file_name = tmp;
660 static void wm_adsp_debugfs_clear(struct wm_adsp *dsp)
662 kfree(dsp->wmfw_file_name);
663 kfree(dsp->bin_file_name);
664 dsp->wmfw_file_name = NULL;
665 dsp->bin_file_name = NULL;
668 static ssize_t wm_adsp_debugfs_wmfw_read(struct file *file,
669 char __user *user_buf,
670 size_t count, loff_t *ppos)
672 struct wm_adsp *dsp = file->private_data;
675 mutex_lock(&dsp->pwr_lock);
677 if (!dsp->wmfw_file_name || !dsp->booted)
680 ret = simple_read_from_buffer(user_buf, count, ppos,
682 strlen(dsp->wmfw_file_name));
684 mutex_unlock(&dsp->pwr_lock);
688 static ssize_t wm_adsp_debugfs_bin_read(struct file *file,
689 char __user *user_buf,
690 size_t count, loff_t *ppos)
692 struct wm_adsp *dsp = file->private_data;
695 mutex_lock(&dsp->pwr_lock);
697 if (!dsp->bin_file_name || !dsp->booted)
700 ret = simple_read_from_buffer(user_buf, count, ppos,
702 strlen(dsp->bin_file_name));
704 mutex_unlock(&dsp->pwr_lock);
708 static const struct {
710 const struct file_operations fops;
711 } wm_adsp_debugfs_fops[] = {
713 .name = "wmfw_file_name",
716 .read = wm_adsp_debugfs_wmfw_read,
720 .name = "bin_file_name",
723 .read = wm_adsp_debugfs_bin_read,
728 static void wm_adsp2_init_debugfs(struct wm_adsp *dsp,
729 struct snd_soc_component *component)
731 struct dentry *root = NULL;
734 root = debugfs_create_dir(dsp->name, component->debugfs_root);
736 debugfs_create_bool("booted", 0444, root, &dsp->booted);
737 debugfs_create_bool("running", 0444, root, &dsp->running);
738 debugfs_create_x32("fw_id", 0444, root, &dsp->fw_id);
739 debugfs_create_x32("fw_version", 0444, root, &dsp->fw_id_version);
741 for (i = 0; i < ARRAY_SIZE(wm_adsp_debugfs_fops); ++i)
742 debugfs_create_file(wm_adsp_debugfs_fops[i].name, 0444, root,
743 dsp, &wm_adsp_debugfs_fops[i].fops);
745 dsp->debugfs_root = root;
748 static void wm_adsp2_cleanup_debugfs(struct wm_adsp *dsp)
750 wm_adsp_debugfs_clear(dsp);
751 debugfs_remove_recursive(dsp->debugfs_root);
752 dsp->debugfs_root = NULL;
755 static inline void wm_adsp2_init_debugfs(struct wm_adsp *dsp,
756 struct snd_soc_component *component)
760 static inline void wm_adsp2_cleanup_debugfs(struct wm_adsp *dsp)
764 static inline void wm_adsp_debugfs_save_wmfwname(struct wm_adsp *dsp,
769 static inline void wm_adsp_debugfs_save_binname(struct wm_adsp *dsp,
774 static inline void wm_adsp_debugfs_clear(struct wm_adsp *dsp)
779 int wm_adsp_fw_get(struct snd_kcontrol *kcontrol,
780 struct snd_ctl_elem_value *ucontrol)
782 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
783 struct soc_enum *e = (struct soc_enum *)kcontrol->private_value;
784 struct wm_adsp *dsp = snd_soc_component_get_drvdata(component);
786 ucontrol->value.enumerated.item[0] = dsp[e->shift_l].fw;
790 EXPORT_SYMBOL_GPL(wm_adsp_fw_get);
792 int wm_adsp_fw_put(struct snd_kcontrol *kcontrol,
793 struct snd_ctl_elem_value *ucontrol)
795 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
796 struct soc_enum *e = (struct soc_enum *)kcontrol->private_value;
797 struct wm_adsp *dsp = snd_soc_component_get_drvdata(component);
800 if (ucontrol->value.enumerated.item[0] == dsp[e->shift_l].fw)
803 if (ucontrol->value.enumerated.item[0] >= WM_ADSP_NUM_FW)
806 mutex_lock(&dsp[e->shift_l].pwr_lock);
808 if (dsp[e->shift_l].booted || !list_empty(&dsp[e->shift_l].compr_list))
811 dsp[e->shift_l].fw = ucontrol->value.enumerated.item[0];
813 mutex_unlock(&dsp[e->shift_l].pwr_lock);
817 EXPORT_SYMBOL_GPL(wm_adsp_fw_put);
819 const struct soc_enum wm_adsp_fw_enum[] = {
820 SOC_ENUM_SINGLE(0, 0, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
821 SOC_ENUM_SINGLE(0, 1, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
822 SOC_ENUM_SINGLE(0, 2, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
823 SOC_ENUM_SINGLE(0, 3, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
824 SOC_ENUM_SINGLE(0, 4, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
825 SOC_ENUM_SINGLE(0, 5, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
826 SOC_ENUM_SINGLE(0, 6, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
828 EXPORT_SYMBOL_GPL(wm_adsp_fw_enum);
830 static const struct wm_adsp_region *wm_adsp_find_region(struct wm_adsp *dsp,
835 for (i = 0; i < dsp->num_mems; i++)
836 if (dsp->mem[i].type == type)
842 static unsigned int wm_adsp_region_to_reg(struct wm_adsp_region const *mem,
847 return mem->base + (offset * 3);
852 return mem->base + (offset * 2);
854 WARN(1, "Unknown memory region type");
859 static unsigned int wm_halo_region_to_reg(struct wm_adsp_region const *mem,
865 return mem->base + (offset * 4);
866 case WMFW_HALO_XM_PACKED:
867 case WMFW_HALO_YM_PACKED:
868 return (mem->base + (offset * 3)) & ~0x3;
869 case WMFW_HALO_PM_PACKED:
870 return mem->base + (offset * 5);
872 WARN(1, "Unknown memory region type");
877 static void wm_adsp_read_fw_status(struct wm_adsp *dsp,
878 int noffs, unsigned int *offs)
883 for (i = 0; i < noffs; ++i) {
884 ret = regmap_read(dsp->regmap, dsp->base + offs[i], &offs[i]);
886 adsp_err(dsp, "Failed to read SCRATCH%u: %d\n", i, ret);
892 static void wm_adsp2_show_fw_status(struct wm_adsp *dsp)
894 unsigned int offs[] = {
895 ADSP2_SCRATCH0, ADSP2_SCRATCH1, ADSP2_SCRATCH2, ADSP2_SCRATCH3,
898 wm_adsp_read_fw_status(dsp, ARRAY_SIZE(offs), offs);
900 adsp_dbg(dsp, "FW SCRATCH 0:0x%x 1:0x%x 2:0x%x 3:0x%x\n",
901 offs[0], offs[1], offs[2], offs[3]);
904 static void wm_adsp2v2_show_fw_status(struct wm_adsp *dsp)
906 unsigned int offs[] = { ADSP2V2_SCRATCH0_1, ADSP2V2_SCRATCH2_3 };
908 wm_adsp_read_fw_status(dsp, ARRAY_SIZE(offs), offs);
910 adsp_dbg(dsp, "FW SCRATCH 0:0x%x 1:0x%x 2:0x%x 3:0x%x\n",
911 offs[0] & 0xFFFF, offs[0] >> 16,
912 offs[1] & 0xFFFF, offs[1] >> 16);
915 static void wm_halo_show_fw_status(struct wm_adsp *dsp)
917 unsigned int offs[] = {
918 HALO_SCRATCH1, HALO_SCRATCH2, HALO_SCRATCH3, HALO_SCRATCH4,
921 wm_adsp_read_fw_status(dsp, ARRAY_SIZE(offs), offs);
923 adsp_dbg(dsp, "FW SCRATCH 0:0x%x 1:0x%x 2:0x%x 3:0x%x\n",
924 offs[0], offs[1], offs[2], offs[3]);
927 static inline struct wm_coeff_ctl *bytes_ext_to_ctl(struct soc_bytes_ext *ext)
929 return container_of(ext, struct wm_coeff_ctl, bytes_ext);
932 static int wm_coeff_base_reg(struct wm_coeff_ctl *ctl, unsigned int *reg)
934 const struct wm_adsp_alg_region *alg_region = &ctl->alg_region;
935 struct wm_adsp *dsp = ctl->dsp;
936 const struct wm_adsp_region *mem;
938 mem = wm_adsp_find_region(dsp, alg_region->type);
940 adsp_err(dsp, "No base for region %x\n",
945 *reg = dsp->ops->region_to_reg(mem, ctl->alg_region.base + ctl->offset);
950 static int wm_coeff_info(struct snd_kcontrol *kctl,
951 struct snd_ctl_elem_info *uinfo)
953 struct soc_bytes_ext *bytes_ext =
954 (struct soc_bytes_ext *)kctl->private_value;
955 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
958 case WMFW_CTL_TYPE_ACKED:
959 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
960 uinfo->value.integer.min = WM_ADSP_ACKED_CTL_MIN_VALUE;
961 uinfo->value.integer.max = WM_ADSP_ACKED_CTL_MAX_VALUE;
962 uinfo->value.integer.step = 1;
966 uinfo->type = SNDRV_CTL_ELEM_TYPE_BYTES;
967 uinfo->count = ctl->len;
974 static int wm_coeff_write_acked_control(struct wm_coeff_ctl *ctl,
975 unsigned int event_id)
977 struct wm_adsp *dsp = ctl->dsp;
978 __be32 val = cpu_to_be32(event_id);
982 ret = wm_coeff_base_reg(ctl, ®);
986 adsp_dbg(dsp, "Sending 0x%x to acked control alg 0x%x %s:0x%x\n",
987 event_id, ctl->alg_region.alg,
988 wm_adsp_mem_region_name(ctl->alg_region.type), ctl->offset);
990 ret = regmap_raw_write(dsp->regmap, reg, &val, sizeof(val));
992 adsp_err(dsp, "Failed to write %x: %d\n", reg, ret);
997 * Poll for ack, we initially poll at ~1ms intervals for firmwares
998 * that respond quickly, then go to ~10ms polls. A firmware is unlikely
999 * to ack instantly so we do the first 1ms delay before reading the
1000 * control to avoid a pointless bus transaction
1002 for (i = 0; i < WM_ADSP_ACKED_CTL_TIMEOUT_MS;) {
1004 case 0 ... WM_ADSP_ACKED_CTL_N_QUICKPOLLS - 1:
1005 usleep_range(1000, 2000);
1009 usleep_range(10000, 20000);
1014 ret = regmap_raw_read(dsp->regmap, reg, &val, sizeof(val));
1016 adsp_err(dsp, "Failed to read %x: %d\n", reg, ret);
1021 adsp_dbg(dsp, "Acked control ACKED at poll %u\n", i);
1026 adsp_warn(dsp, "Acked control @0x%x alg:0x%x %s:0x%x timed out\n",
1027 reg, ctl->alg_region.alg,
1028 wm_adsp_mem_region_name(ctl->alg_region.type),
1034 static int wm_coeff_write_ctrl_raw(struct wm_coeff_ctl *ctl,
1035 const void *buf, size_t len)
1037 struct wm_adsp *dsp = ctl->dsp;
1042 ret = wm_coeff_base_reg(ctl, ®);
1046 scratch = kmemdup(buf, len, GFP_KERNEL | GFP_DMA);
1050 ret = regmap_raw_write(dsp->regmap, reg, scratch,
1053 adsp_err(dsp, "Failed to write %zu bytes to %x: %d\n",
1058 adsp_dbg(dsp, "Wrote %zu bytes to %x\n", len, reg);
1065 static int wm_coeff_write_ctrl(struct wm_coeff_ctl *ctl,
1066 const void *buf, size_t len)
1070 if (ctl->flags & WMFW_CTL_FLAG_VOLATILE)
1072 else if (buf != ctl->cache)
1073 memcpy(ctl->cache, buf, len);
1076 if (ctl->enabled && ctl->dsp->running)
1077 ret = wm_coeff_write_ctrl_raw(ctl, buf, len);
1082 static int wm_coeff_put(struct snd_kcontrol *kctl,
1083 struct snd_ctl_elem_value *ucontrol)
1085 struct soc_bytes_ext *bytes_ext =
1086 (struct soc_bytes_ext *)kctl->private_value;
1087 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
1088 char *p = ucontrol->value.bytes.data;
1091 mutex_lock(&ctl->dsp->pwr_lock);
1092 ret = wm_coeff_write_ctrl(ctl, p, ctl->len);
1093 mutex_unlock(&ctl->dsp->pwr_lock);
1098 static int wm_coeff_tlv_put(struct snd_kcontrol *kctl,
1099 const unsigned int __user *bytes, unsigned int size)
1101 struct soc_bytes_ext *bytes_ext =
1102 (struct soc_bytes_ext *)kctl->private_value;
1103 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
1106 mutex_lock(&ctl->dsp->pwr_lock);
1108 if (copy_from_user(ctl->cache, bytes, size))
1111 ret = wm_coeff_write_ctrl(ctl, ctl->cache, size);
1113 mutex_unlock(&ctl->dsp->pwr_lock);
1118 static int wm_coeff_put_acked(struct snd_kcontrol *kctl,
1119 struct snd_ctl_elem_value *ucontrol)
1121 struct soc_bytes_ext *bytes_ext =
1122 (struct soc_bytes_ext *)kctl->private_value;
1123 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
1124 unsigned int val = ucontrol->value.integer.value[0];
1128 return 0; /* 0 means no event */
1130 mutex_lock(&ctl->dsp->pwr_lock);
1132 if (ctl->enabled && ctl->dsp->running)
1133 ret = wm_coeff_write_acked_control(ctl, val);
1137 mutex_unlock(&ctl->dsp->pwr_lock);
1142 static int wm_coeff_read_ctrl_raw(struct wm_coeff_ctl *ctl,
1143 void *buf, size_t len)
1145 struct wm_adsp *dsp = ctl->dsp;
1150 ret = wm_coeff_base_reg(ctl, ®);
1154 scratch = kmalloc(len, GFP_KERNEL | GFP_DMA);
1158 ret = regmap_raw_read(dsp->regmap, reg, scratch, len);
1160 adsp_err(dsp, "Failed to read %zu bytes from %x: %d\n",
1165 adsp_dbg(dsp, "Read %zu bytes from %x\n", len, reg);
1167 memcpy(buf, scratch, len);
1173 static int wm_coeff_read_ctrl(struct wm_coeff_ctl *ctl, void *buf, size_t len)
1177 if (ctl->flags & WMFW_CTL_FLAG_VOLATILE) {
1178 if (ctl->enabled && ctl->dsp->running)
1179 return wm_coeff_read_ctrl_raw(ctl, buf, len);
1183 if (!ctl->flags && ctl->enabled && ctl->dsp->running)
1184 ret = wm_coeff_read_ctrl_raw(ctl, ctl->cache, ctl->len);
1186 if (buf != ctl->cache)
1187 memcpy(buf, ctl->cache, len);
1193 static int wm_coeff_get(struct snd_kcontrol *kctl,
1194 struct snd_ctl_elem_value *ucontrol)
1196 struct soc_bytes_ext *bytes_ext =
1197 (struct soc_bytes_ext *)kctl->private_value;
1198 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
1199 char *p = ucontrol->value.bytes.data;
1202 mutex_lock(&ctl->dsp->pwr_lock);
1203 ret = wm_coeff_read_ctrl(ctl, p, ctl->len);
1204 mutex_unlock(&ctl->dsp->pwr_lock);
1209 static int wm_coeff_tlv_get(struct snd_kcontrol *kctl,
1210 unsigned int __user *bytes, unsigned int size)
1212 struct soc_bytes_ext *bytes_ext =
1213 (struct soc_bytes_ext *)kctl->private_value;
1214 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
1217 mutex_lock(&ctl->dsp->pwr_lock);
1219 ret = wm_coeff_read_ctrl(ctl, ctl->cache, size);
1221 if (!ret && copy_to_user(bytes, ctl->cache, size))
1224 mutex_unlock(&ctl->dsp->pwr_lock);
1229 static int wm_coeff_get_acked(struct snd_kcontrol *kcontrol,
1230 struct snd_ctl_elem_value *ucontrol)
1233 * Although it's not useful to read an acked control, we must satisfy
1234 * user-side assumptions that all controls are readable and that a
1235 * write of the same value should be filtered out (it's valid to send
1236 * the same event number again to the firmware). We therefore return 0,
1237 * meaning "no event" so valid event numbers will always be a change
1239 ucontrol->value.integer.value[0] = 0;
1244 static unsigned int wmfw_convert_flags(unsigned int in, unsigned int len)
1246 unsigned int out, rd, wr, vol;
1248 if (len > ADSP_MAX_STD_CTRL_SIZE) {
1249 rd = SNDRV_CTL_ELEM_ACCESS_TLV_READ;
1250 wr = SNDRV_CTL_ELEM_ACCESS_TLV_WRITE;
1251 vol = SNDRV_CTL_ELEM_ACCESS_VOLATILE;
1253 out = SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1255 rd = SNDRV_CTL_ELEM_ACCESS_READ;
1256 wr = SNDRV_CTL_ELEM_ACCESS_WRITE;
1257 vol = SNDRV_CTL_ELEM_ACCESS_VOLATILE;
1264 if (in & WMFW_CTL_FLAG_WRITEABLE)
1266 if (in & WMFW_CTL_FLAG_VOLATILE)
1269 out |= rd | wr | vol;
1275 static int wmfw_add_ctl(struct wm_adsp *dsp, struct wm_coeff_ctl *ctl)
1277 struct snd_kcontrol_new *kcontrol;
1280 if (!ctl || !ctl->name)
1283 kcontrol = kzalloc(sizeof(*kcontrol), GFP_KERNEL);
1287 kcontrol->name = ctl->name;
1288 kcontrol->info = wm_coeff_info;
1289 kcontrol->iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1290 kcontrol->tlv.c = snd_soc_bytes_tlv_callback;
1291 kcontrol->private_value = (unsigned long)&ctl->bytes_ext;
1292 kcontrol->access = wmfw_convert_flags(ctl->flags, ctl->len);
1294 switch (ctl->type) {
1295 case WMFW_CTL_TYPE_ACKED:
1296 kcontrol->get = wm_coeff_get_acked;
1297 kcontrol->put = wm_coeff_put_acked;
1300 if (kcontrol->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
1301 ctl->bytes_ext.max = ctl->len;
1302 ctl->bytes_ext.get = wm_coeff_tlv_get;
1303 ctl->bytes_ext.put = wm_coeff_tlv_put;
1305 kcontrol->get = wm_coeff_get;
1306 kcontrol->put = wm_coeff_put;
1311 ret = snd_soc_add_component_controls(dsp->component, kcontrol, 1);
1324 static int wm_coeff_init_control_caches(struct wm_adsp *dsp)
1326 struct wm_coeff_ctl *ctl;
1329 list_for_each_entry(ctl, &dsp->ctl_list, list) {
1330 if (!ctl->enabled || ctl->set)
1332 if (ctl->flags & WMFW_CTL_FLAG_VOLATILE)
1336 * For readable controls populate the cache from the DSP memory.
1337 * For non-readable controls the cache was zero-filled when
1338 * created so we don't need to do anything.
1340 if (!ctl->flags || (ctl->flags & WMFW_CTL_FLAG_READABLE)) {
1341 ret = wm_coeff_read_ctrl_raw(ctl, ctl->cache, ctl->len);
1350 static int wm_coeff_sync_controls(struct wm_adsp *dsp)
1352 struct wm_coeff_ctl *ctl;
1355 list_for_each_entry(ctl, &dsp->ctl_list, list) {
1358 if (ctl->set && !(ctl->flags & WMFW_CTL_FLAG_VOLATILE)) {
1359 ret = wm_coeff_write_ctrl_raw(ctl, ctl->cache,
1369 static void wm_adsp_signal_event_controls(struct wm_adsp *dsp,
1372 struct wm_coeff_ctl *ctl;
1375 list_for_each_entry(ctl, &dsp->ctl_list, list) {
1376 if (ctl->type != WMFW_CTL_TYPE_HOSTEVENT)
1382 ret = wm_coeff_write_acked_control(ctl, event);
1385 "Failed to send 0x%x event to alg 0x%x (%d)\n",
1386 event, ctl->alg_region.alg, ret);
1390 static void wm_adsp_ctl_work(struct work_struct *work)
1392 struct wm_coeff_ctl *ctl = container_of(work,
1393 struct wm_coeff_ctl,
1396 wmfw_add_ctl(ctl->dsp, ctl);
1399 static void wm_adsp_free_ctl_blk(struct wm_coeff_ctl *ctl)
1401 cancel_work_sync(&ctl->work);
1405 kfree(ctl->subname);
1409 static int wm_adsp_create_control(struct wm_adsp *dsp,
1410 const struct wm_adsp_alg_region *alg_region,
1411 unsigned int offset, unsigned int len,
1412 const char *subname, unsigned int subname_len,
1413 unsigned int flags, unsigned int type)
1415 struct wm_coeff_ctl *ctl;
1416 char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
1417 const char *region_name;
1420 list_for_each_entry(ctl, &dsp->ctl_list, list) {
1421 if (ctl->fw_name == wm_adsp_fw_text[dsp->fw] &&
1422 ctl->alg_region.alg == alg_region->alg &&
1423 ctl->alg_region.type == alg_region->type) {
1424 if ((!subname && !ctl->subname) ||
1425 (subname && !strncmp(ctl->subname, subname, ctl->subname_len))) {
1433 region_name = wm_adsp_mem_region_name(alg_region->type);
1435 adsp_err(dsp, "Unknown region type: %d\n", alg_region->type);
1439 switch (dsp->fw_ver) {
1442 snprintf(name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN, "%s %s %x",
1443 dsp->name, region_name, alg_region->alg);
1444 subname = NULL; /* don't append subname */
1447 ret = scnprintf(name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN,
1448 "%s%c %.12s %x", dsp->name, *region_name,
1449 wm_adsp_fw_text[dsp->fw], alg_region->alg);
1452 ret = scnprintf(name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN,
1453 "%s %.12s %x", dsp->name,
1454 wm_adsp_fw_text[dsp->fw], alg_region->alg);
1459 int avail = SNDRV_CTL_ELEM_ID_NAME_MAXLEN - ret - 2;
1462 if (dsp->component->name_prefix)
1463 avail -= strlen(dsp->component->name_prefix) + 1;
1465 /* Truncate the subname from the start if it is too long */
1466 if (subname_len > avail)
1467 skip = subname_len - avail;
1469 snprintf(name + ret, SNDRV_CTL_ELEM_ID_NAME_MAXLEN - ret,
1470 " %.*s", subname_len - skip, subname + skip);
1473 ctl = kzalloc(sizeof(*ctl), GFP_KERNEL);
1476 ctl->fw_name = wm_adsp_fw_text[dsp->fw];
1477 ctl->alg_region = *alg_region;
1478 ctl->name = kmemdup(name, strlen(name) + 1, GFP_KERNEL);
1484 ctl->subname_len = subname_len;
1485 ctl->subname = kmemdup(subname,
1486 strlen(subname) + 1, GFP_KERNEL);
1487 if (!ctl->subname) {
1498 ctl->offset = offset;
1500 ctl->cache = kzalloc(ctl->len, GFP_KERNEL);
1503 goto err_ctl_subname;
1506 list_add(&ctl->list, &dsp->ctl_list);
1508 if (flags & WMFW_CTL_FLAG_SYS)
1511 INIT_WORK(&ctl->work, wm_adsp_ctl_work);
1512 schedule_work(&ctl->work);
1517 kfree(ctl->subname);
1526 struct wm_coeff_parsed_alg {
1533 struct wm_coeff_parsed_coeff {
1538 unsigned int ctl_type;
1543 static int wm_coeff_parse_string(int bytes, const u8 **pos, const u8 **str)
1552 length = le16_to_cpu(*((__le16 *)*pos));
1559 *str = *pos + bytes;
1561 *pos += ((length + bytes) + 3) & ~0x03;
1566 static int wm_coeff_parse_int(int bytes, const u8 **pos)
1572 val = le16_to_cpu(*((__le16 *)*pos));
1575 val = le32_to_cpu(*((__le32 *)*pos));
1586 static inline void wm_coeff_parse_alg(struct wm_adsp *dsp, const u8 **data,
1587 struct wm_coeff_parsed_alg *blk)
1589 const struct wmfw_adsp_alg_data *raw;
1591 switch (dsp->fw_ver) {
1594 raw = (const struct wmfw_adsp_alg_data *)*data;
1597 blk->id = le32_to_cpu(raw->id);
1598 blk->name = raw->name;
1599 blk->name_len = strlen(raw->name);
1600 blk->ncoeff = le32_to_cpu(raw->ncoeff);
1603 blk->id = wm_coeff_parse_int(sizeof(raw->id), data);
1604 blk->name_len = wm_coeff_parse_string(sizeof(u8), data,
1606 wm_coeff_parse_string(sizeof(u16), data, NULL);
1607 blk->ncoeff = wm_coeff_parse_int(sizeof(raw->ncoeff), data);
1611 adsp_dbg(dsp, "Algorithm ID: %#x\n", blk->id);
1612 adsp_dbg(dsp, "Algorithm name: %.*s\n", blk->name_len, blk->name);
1613 adsp_dbg(dsp, "# of coefficient descriptors: %#x\n", blk->ncoeff);
1616 static inline void wm_coeff_parse_coeff(struct wm_adsp *dsp, const u8 **data,
1617 struct wm_coeff_parsed_coeff *blk)
1619 const struct wmfw_adsp_coeff_data *raw;
1623 switch (dsp->fw_ver) {
1626 raw = (const struct wmfw_adsp_coeff_data *)*data;
1627 *data = *data + sizeof(raw->hdr) + le32_to_cpu(raw->hdr.size);
1629 blk->offset = le16_to_cpu(raw->hdr.offset);
1630 blk->mem_type = le16_to_cpu(raw->hdr.type);
1631 blk->name = raw->name;
1632 blk->name_len = strlen(raw->name);
1633 blk->ctl_type = le16_to_cpu(raw->ctl_type);
1634 blk->flags = le16_to_cpu(raw->flags);
1635 blk->len = le32_to_cpu(raw->len);
1639 blk->offset = wm_coeff_parse_int(sizeof(raw->hdr.offset), &tmp);
1640 blk->mem_type = wm_coeff_parse_int(sizeof(raw->hdr.type), &tmp);
1641 length = wm_coeff_parse_int(sizeof(raw->hdr.size), &tmp);
1642 blk->name_len = wm_coeff_parse_string(sizeof(u8), &tmp,
1644 wm_coeff_parse_string(sizeof(u8), &tmp, NULL);
1645 wm_coeff_parse_string(sizeof(u16), &tmp, NULL);
1646 blk->ctl_type = wm_coeff_parse_int(sizeof(raw->ctl_type), &tmp);
1647 blk->flags = wm_coeff_parse_int(sizeof(raw->flags), &tmp);
1648 blk->len = wm_coeff_parse_int(sizeof(raw->len), &tmp);
1650 *data = *data + sizeof(raw->hdr) + length;
1654 adsp_dbg(dsp, "\tCoefficient type: %#x\n", blk->mem_type);
1655 adsp_dbg(dsp, "\tCoefficient offset: %#x\n", blk->offset);
1656 adsp_dbg(dsp, "\tCoefficient name: %.*s\n", blk->name_len, blk->name);
1657 adsp_dbg(dsp, "\tCoefficient flags: %#x\n", blk->flags);
1658 adsp_dbg(dsp, "\tALSA control type: %#x\n", blk->ctl_type);
1659 adsp_dbg(dsp, "\tALSA control len: %#x\n", blk->len);
1662 static int wm_adsp_check_coeff_flags(struct wm_adsp *dsp,
1663 const struct wm_coeff_parsed_coeff *coeff_blk,
1664 unsigned int f_required,
1665 unsigned int f_illegal)
1667 if ((coeff_blk->flags & f_illegal) ||
1668 ((coeff_blk->flags & f_required) != f_required)) {
1669 adsp_err(dsp, "Illegal flags 0x%x for control type 0x%x\n",
1670 coeff_blk->flags, coeff_blk->ctl_type);
1677 static int wm_adsp_parse_coeff(struct wm_adsp *dsp,
1678 const struct wmfw_region *region)
1680 struct wm_adsp_alg_region alg_region = {};
1681 struct wm_coeff_parsed_alg alg_blk;
1682 struct wm_coeff_parsed_coeff coeff_blk;
1683 const u8 *data = region->data;
1686 wm_coeff_parse_alg(dsp, &data, &alg_blk);
1687 for (i = 0; i < alg_blk.ncoeff; i++) {
1688 wm_coeff_parse_coeff(dsp, &data, &coeff_blk);
1690 switch (coeff_blk.ctl_type) {
1691 case WMFW_CTL_TYPE_BYTES:
1693 case WMFW_CTL_TYPE_ACKED:
1694 if (coeff_blk.flags & WMFW_CTL_FLAG_SYS)
1695 continue; /* ignore */
1697 ret = wm_adsp_check_coeff_flags(dsp, &coeff_blk,
1698 WMFW_CTL_FLAG_VOLATILE |
1699 WMFW_CTL_FLAG_WRITEABLE |
1700 WMFW_CTL_FLAG_READABLE,
1705 case WMFW_CTL_TYPE_HOSTEVENT:
1706 ret = wm_adsp_check_coeff_flags(dsp, &coeff_blk,
1708 WMFW_CTL_FLAG_VOLATILE |
1709 WMFW_CTL_FLAG_WRITEABLE |
1710 WMFW_CTL_FLAG_READABLE,
1715 case WMFW_CTL_TYPE_HOST_BUFFER:
1716 ret = wm_adsp_check_coeff_flags(dsp, &coeff_blk,
1718 WMFW_CTL_FLAG_VOLATILE |
1719 WMFW_CTL_FLAG_READABLE,
1725 adsp_err(dsp, "Unknown control type: %d\n",
1726 coeff_blk.ctl_type);
1730 alg_region.type = coeff_blk.mem_type;
1731 alg_region.alg = alg_blk.id;
1733 ret = wm_adsp_create_control(dsp, &alg_region,
1739 coeff_blk.ctl_type);
1741 adsp_err(dsp, "Failed to create control: %.*s, %d\n",
1742 coeff_blk.name_len, coeff_blk.name, ret);
1748 static unsigned int wm_adsp1_parse_sizes(struct wm_adsp *dsp,
1749 const char * const file,
1751 const struct firmware *firmware)
1753 const struct wmfw_adsp1_sizes *adsp1_sizes;
1755 adsp1_sizes = (void *)&firmware->data[pos];
1757 adsp_dbg(dsp, "%s: %d DM, %d PM, %d ZM\n", file,
1758 le32_to_cpu(adsp1_sizes->dm), le32_to_cpu(adsp1_sizes->pm),
1759 le32_to_cpu(adsp1_sizes->zm));
1761 return pos + sizeof(*adsp1_sizes);
1764 static unsigned int wm_adsp2_parse_sizes(struct wm_adsp *dsp,
1765 const char * const file,
1767 const struct firmware *firmware)
1769 const struct wmfw_adsp2_sizes *adsp2_sizes;
1771 adsp2_sizes = (void *)&firmware->data[pos];
1773 adsp_dbg(dsp, "%s: %d XM, %d YM %d PM, %d ZM\n", file,
1774 le32_to_cpu(adsp2_sizes->xm), le32_to_cpu(adsp2_sizes->ym),
1775 le32_to_cpu(adsp2_sizes->pm), le32_to_cpu(adsp2_sizes->zm));
1777 return pos + sizeof(*adsp2_sizes);
1780 static bool wm_adsp_validate_version(struct wm_adsp *dsp, unsigned int version)
1784 adsp_warn(dsp, "Deprecated file format %d\n", version);
1794 static bool wm_halo_validate_version(struct wm_adsp *dsp, unsigned int version)
1804 static int wm_adsp_load(struct wm_adsp *dsp)
1806 LIST_HEAD(buf_list);
1807 const struct firmware *firmware;
1808 struct regmap *regmap = dsp->regmap;
1809 unsigned int pos = 0;
1810 const struct wmfw_header *header;
1811 const struct wmfw_adsp1_sizes *adsp1_sizes;
1812 const struct wmfw_footer *footer;
1813 const struct wmfw_region *region;
1814 const struct wm_adsp_region *mem;
1815 const char *region_name;
1816 char *file, *text = NULL;
1817 struct wm_adsp_buf *buf;
1820 int ret, offset, type;
1822 file = kzalloc(PAGE_SIZE, GFP_KERNEL);
1826 snprintf(file, PAGE_SIZE, "%s-%s-%s.wmfw", dsp->part, dsp->fwf_name,
1827 wm_adsp_fw[dsp->fw].file);
1828 file[PAGE_SIZE - 1] = '\0';
1830 ret = request_firmware(&firmware, file, dsp->dev);
1832 adsp_err(dsp, "Failed to request '%s'\n", file);
1837 pos = sizeof(*header) + sizeof(*adsp1_sizes) + sizeof(*footer);
1838 if (pos >= firmware->size) {
1839 adsp_err(dsp, "%s: file too short, %zu bytes\n",
1840 file, firmware->size);
1844 header = (void *)&firmware->data[0];
1846 if (memcmp(&header->magic[0], "WMFW", 4) != 0) {
1847 adsp_err(dsp, "%s: invalid magic\n", file);
1851 if (!dsp->ops->validate_version(dsp, header->ver)) {
1852 adsp_err(dsp, "%s: unknown file format %d\n",
1857 adsp_info(dsp, "Firmware version: %d\n", header->ver);
1858 dsp->fw_ver = header->ver;
1860 if (header->core != dsp->type) {
1861 adsp_err(dsp, "%s: invalid core %d != %d\n",
1862 file, header->core, dsp->type);
1866 pos = sizeof(*header);
1867 pos = dsp->ops->parse_sizes(dsp, file, pos, firmware);
1869 footer = (void *)&firmware->data[pos];
1870 pos += sizeof(*footer);
1872 if (le32_to_cpu(header->len) != pos) {
1873 adsp_err(dsp, "%s: unexpected header length %d\n",
1874 file, le32_to_cpu(header->len));
1878 adsp_dbg(dsp, "%s: timestamp %llu\n", file,
1879 le64_to_cpu(footer->timestamp));
1881 while (pos < firmware->size &&
1882 sizeof(*region) < firmware->size - pos) {
1883 region = (void *)&(firmware->data[pos]);
1884 region_name = "Unknown";
1887 offset = le32_to_cpu(region->offset) & 0xffffff;
1888 type = be32_to_cpu(region->type) & 0xff;
1891 case WMFW_NAME_TEXT:
1892 region_name = "Firmware name";
1893 text = kzalloc(le32_to_cpu(region->len) + 1,
1896 case WMFW_ALGORITHM_DATA:
1897 region_name = "Algorithm";
1898 ret = wm_adsp_parse_coeff(dsp, region);
1902 case WMFW_INFO_TEXT:
1903 region_name = "Information";
1904 text = kzalloc(le32_to_cpu(region->len) + 1,
1908 region_name = "Absolute";
1916 case WMFW_HALO_PM_PACKED:
1917 case WMFW_HALO_XM_PACKED:
1918 case WMFW_HALO_YM_PACKED:
1919 mem = wm_adsp_find_region(dsp, type);
1921 adsp_err(dsp, "No region of type: %x\n", type);
1926 region_name = wm_adsp_mem_region_name(type);
1927 reg = dsp->ops->region_to_reg(mem, offset);
1931 "%s.%d: Unknown region type %x at %d(%x)\n",
1932 file, regions, type, pos, pos);
1936 adsp_dbg(dsp, "%s.%d: %d bytes at %d in %s\n", file,
1937 regions, le32_to_cpu(region->len), offset,
1940 if (le32_to_cpu(region->len) >
1941 firmware->size - pos - sizeof(*region)) {
1943 "%s.%d: %s region len %d bytes exceeds file length %zu\n",
1944 file, regions, region_name,
1945 le32_to_cpu(region->len), firmware->size);
1951 memcpy(text, region->data, le32_to_cpu(region->len));
1952 adsp_info(dsp, "%s: %s\n", file, text);
1958 buf = wm_adsp_buf_alloc(region->data,
1959 le32_to_cpu(region->len),
1962 adsp_err(dsp, "Out of memory\n");
1967 ret = regmap_raw_write_async(regmap, reg, buf->buf,
1968 le32_to_cpu(region->len));
1971 "%s.%d: Failed to write %d bytes at %d in %s: %d\n",
1973 le32_to_cpu(region->len), offset,
1979 pos += le32_to_cpu(region->len) + sizeof(*region);
1983 ret = regmap_async_complete(regmap);
1985 adsp_err(dsp, "Failed to complete async write: %d\n", ret);
1989 if (pos > firmware->size)
1990 adsp_warn(dsp, "%s.%d: %zu bytes at end of file\n",
1991 file, regions, pos - firmware->size);
1993 wm_adsp_debugfs_save_wmfwname(dsp, file);
1996 regmap_async_complete(regmap);
1997 wm_adsp_buf_free(&buf_list);
1998 release_firmware(firmware);
2007 * Find wm_coeff_ctl with input name as its subname
2008 * If not found, return NULL
2010 static struct wm_coeff_ctl *wm_adsp_get_ctl(struct wm_adsp *dsp,
2011 const char *name, int type,
2014 struct wm_coeff_ctl *pos, *rslt = NULL;
2015 const char *fw_txt = wm_adsp_fw_text[dsp->fw];
2017 list_for_each_entry(pos, &dsp->ctl_list, list) {
2020 if (strncmp(pos->subname, name, pos->subname_len) == 0 &&
2021 pos->fw_name == fw_txt &&
2022 pos->alg_region.alg == alg &&
2023 pos->alg_region.type == type) {
2032 int wm_adsp_write_ctl(struct wm_adsp *dsp, const char *name, int type,
2033 unsigned int alg, void *buf, size_t len)
2035 struct wm_coeff_ctl *ctl;
2036 struct snd_kcontrol *kcontrol;
2037 char ctl_name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
2040 ctl = wm_adsp_get_ctl(dsp, name, type, alg);
2047 ret = wm_coeff_write_ctrl(ctl, buf, len);
2051 if (ctl->flags & WMFW_CTL_FLAG_SYS)
2054 if (dsp->component->name_prefix)
2055 snprintf(ctl_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN, "%s %s",
2056 dsp->component->name_prefix, ctl->name);
2058 snprintf(ctl_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN, "%s",
2061 kcontrol = snd_soc_card_get_kcontrol(dsp->component->card, ctl_name);
2063 adsp_err(dsp, "Can't find kcontrol %s\n", ctl_name);
2067 snd_ctl_notify(dsp->component->card->snd_card,
2068 SNDRV_CTL_EVENT_MASK_VALUE, &kcontrol->id);
2072 EXPORT_SYMBOL_GPL(wm_adsp_write_ctl);
2074 int wm_adsp_read_ctl(struct wm_adsp *dsp, const char *name, int type,
2075 unsigned int alg, void *buf, size_t len)
2077 struct wm_coeff_ctl *ctl;
2079 ctl = wm_adsp_get_ctl(dsp, name, type, alg);
2086 return wm_coeff_read_ctrl(ctl, buf, len);
2088 EXPORT_SYMBOL_GPL(wm_adsp_read_ctl);
2090 static void wm_adsp_ctl_fixup_base(struct wm_adsp *dsp,
2091 const struct wm_adsp_alg_region *alg_region)
2093 struct wm_coeff_ctl *ctl;
2095 list_for_each_entry(ctl, &dsp->ctl_list, list) {
2096 if (ctl->fw_name == wm_adsp_fw_text[dsp->fw] &&
2097 alg_region->alg == ctl->alg_region.alg &&
2098 alg_region->type == ctl->alg_region.type) {
2099 ctl->alg_region.base = alg_region->base;
2104 static void *wm_adsp_read_algs(struct wm_adsp *dsp, size_t n_algs,
2105 const struct wm_adsp_region *mem,
2106 unsigned int pos, unsigned int len)
2114 adsp_err(dsp, "No algorithms\n");
2115 return ERR_PTR(-EINVAL);
2118 if (n_algs > 1024) {
2119 adsp_err(dsp, "Algorithm count %zx excessive\n", n_algs);
2120 return ERR_PTR(-EINVAL);
2123 /* Read the terminator first to validate the length */
2124 reg = dsp->ops->region_to_reg(mem, pos + len);
2126 ret = regmap_raw_read(dsp->regmap, reg, &val, sizeof(val));
2128 adsp_err(dsp, "Failed to read algorithm list end: %d\n",
2130 return ERR_PTR(ret);
2133 if (be32_to_cpu(val) != 0xbedead)
2134 adsp_warn(dsp, "Algorithm list end %x 0x%x != 0xbedead\n",
2135 reg, be32_to_cpu(val));
2137 /* Convert length from DSP words to bytes */
2140 alg = kzalloc(len, GFP_KERNEL | GFP_DMA);
2142 return ERR_PTR(-ENOMEM);
2144 reg = dsp->ops->region_to_reg(mem, pos);
2146 ret = regmap_raw_read(dsp->regmap, reg, alg, len);
2148 adsp_err(dsp, "Failed to read algorithm list: %d\n", ret);
2150 return ERR_PTR(ret);
2156 static struct wm_adsp_alg_region *
2157 wm_adsp_find_alg_region(struct wm_adsp *dsp, int type, unsigned int id)
2159 struct wm_adsp_alg_region *alg_region;
2161 list_for_each_entry(alg_region, &dsp->alg_regions, list) {
2162 if (id == alg_region->alg && type == alg_region->type)
2169 static struct wm_adsp_alg_region *wm_adsp_create_region(struct wm_adsp *dsp,
2170 int type, __be32 id,
2173 struct wm_adsp_alg_region *alg_region;
2175 alg_region = kzalloc(sizeof(*alg_region), GFP_KERNEL);
2177 return ERR_PTR(-ENOMEM);
2179 alg_region->type = type;
2180 alg_region->alg = be32_to_cpu(id);
2181 alg_region->base = be32_to_cpu(base);
2183 list_add_tail(&alg_region->list, &dsp->alg_regions);
2185 if (dsp->fw_ver > 0)
2186 wm_adsp_ctl_fixup_base(dsp, alg_region);
2191 static void wm_adsp_free_alg_regions(struct wm_adsp *dsp)
2193 struct wm_adsp_alg_region *alg_region;
2195 while (!list_empty(&dsp->alg_regions)) {
2196 alg_region = list_first_entry(&dsp->alg_regions,
2197 struct wm_adsp_alg_region,
2199 list_del(&alg_region->list);
2204 static void wmfw_parse_id_header(struct wm_adsp *dsp,
2205 struct wmfw_id_hdr *fw, int nalgs)
2207 dsp->fw_id = be32_to_cpu(fw->id);
2208 dsp->fw_id_version = be32_to_cpu(fw->ver);
2210 adsp_info(dsp, "Firmware: %x v%d.%d.%d, %d algorithms\n",
2211 dsp->fw_id, (dsp->fw_id_version & 0xff0000) >> 16,
2212 (dsp->fw_id_version & 0xff00) >> 8, dsp->fw_id_version & 0xff,
2216 static void wmfw_v3_parse_id_header(struct wm_adsp *dsp,
2217 struct wmfw_v3_id_hdr *fw, int nalgs)
2219 dsp->fw_id = be32_to_cpu(fw->id);
2220 dsp->fw_id_version = be32_to_cpu(fw->ver);
2221 dsp->fw_vendor_id = be32_to_cpu(fw->vendor_id);
2223 adsp_info(dsp, "Firmware: %x vendor: 0x%x v%d.%d.%d, %d algorithms\n",
2224 dsp->fw_id, dsp->fw_vendor_id,
2225 (dsp->fw_id_version & 0xff0000) >> 16,
2226 (dsp->fw_id_version & 0xff00) >> 8, dsp->fw_id_version & 0xff,
2230 static int wm_adsp_create_regions(struct wm_adsp *dsp, __be32 id, int nregions,
2231 const int *type, __be32 *base)
2233 struct wm_adsp_alg_region *alg_region;
2236 for (i = 0; i < nregions; i++) {
2237 alg_region = wm_adsp_create_region(dsp, type[i], id, base[i]);
2238 if (IS_ERR(alg_region))
2239 return PTR_ERR(alg_region);
2245 static int wm_adsp1_setup_algs(struct wm_adsp *dsp)
2247 struct wmfw_adsp1_id_hdr adsp1_id;
2248 struct wmfw_adsp1_alg_hdr *adsp1_alg;
2249 struct wm_adsp_alg_region *alg_region;
2250 const struct wm_adsp_region *mem;
2251 unsigned int pos, len;
2255 mem = wm_adsp_find_region(dsp, WMFW_ADSP1_DM);
2259 ret = regmap_raw_read(dsp->regmap, mem->base, &adsp1_id,
2262 adsp_err(dsp, "Failed to read algorithm info: %d\n",
2267 n_algs = be32_to_cpu(adsp1_id.n_algs);
2269 wmfw_parse_id_header(dsp, &adsp1_id.fw, n_algs);
2271 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP1_ZM,
2272 adsp1_id.fw.id, adsp1_id.zm);
2273 if (IS_ERR(alg_region))
2274 return PTR_ERR(alg_region);
2276 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP1_DM,
2277 adsp1_id.fw.id, adsp1_id.dm);
2278 if (IS_ERR(alg_region))
2279 return PTR_ERR(alg_region);
2281 /* Calculate offset and length in DSP words */
2282 pos = sizeof(adsp1_id) / sizeof(u32);
2283 len = (sizeof(*adsp1_alg) * n_algs) / sizeof(u32);
2285 adsp1_alg = wm_adsp_read_algs(dsp, n_algs, mem, pos, len);
2286 if (IS_ERR(adsp1_alg))
2287 return PTR_ERR(adsp1_alg);
2289 for (i = 0; i < n_algs; i++) {
2290 adsp_info(dsp, "%d: ID %x v%d.%d.%d DM@%x ZM@%x\n",
2291 i, be32_to_cpu(adsp1_alg[i].alg.id),
2292 (be32_to_cpu(adsp1_alg[i].alg.ver) & 0xff0000) >> 16,
2293 (be32_to_cpu(adsp1_alg[i].alg.ver) & 0xff00) >> 8,
2294 be32_to_cpu(adsp1_alg[i].alg.ver) & 0xff,
2295 be32_to_cpu(adsp1_alg[i].dm),
2296 be32_to_cpu(adsp1_alg[i].zm));
2298 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP1_DM,
2299 adsp1_alg[i].alg.id,
2301 if (IS_ERR(alg_region)) {
2302 ret = PTR_ERR(alg_region);
2305 if (dsp->fw_ver == 0) {
2306 if (i + 1 < n_algs) {
2307 len = be32_to_cpu(adsp1_alg[i + 1].dm);
2308 len -= be32_to_cpu(adsp1_alg[i].dm);
2310 wm_adsp_create_control(dsp, alg_region, 0,
2312 WMFW_CTL_TYPE_BYTES);
2314 adsp_warn(dsp, "Missing length info for region DM with ID %x\n",
2315 be32_to_cpu(adsp1_alg[i].alg.id));
2319 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP1_ZM,
2320 adsp1_alg[i].alg.id,
2322 if (IS_ERR(alg_region)) {
2323 ret = PTR_ERR(alg_region);
2326 if (dsp->fw_ver == 0) {
2327 if (i + 1 < n_algs) {
2328 len = be32_to_cpu(adsp1_alg[i + 1].zm);
2329 len -= be32_to_cpu(adsp1_alg[i].zm);
2331 wm_adsp_create_control(dsp, alg_region, 0,
2333 WMFW_CTL_TYPE_BYTES);
2335 adsp_warn(dsp, "Missing length info for region ZM with ID %x\n",
2336 be32_to_cpu(adsp1_alg[i].alg.id));
2346 static int wm_adsp2_setup_algs(struct wm_adsp *dsp)
2348 struct wmfw_adsp2_id_hdr adsp2_id;
2349 struct wmfw_adsp2_alg_hdr *adsp2_alg;
2350 struct wm_adsp_alg_region *alg_region;
2351 const struct wm_adsp_region *mem;
2352 unsigned int pos, len;
2356 mem = wm_adsp_find_region(dsp, WMFW_ADSP2_XM);
2360 ret = regmap_raw_read(dsp->regmap, mem->base, &adsp2_id,
2363 adsp_err(dsp, "Failed to read algorithm info: %d\n",
2368 n_algs = be32_to_cpu(adsp2_id.n_algs);
2370 wmfw_parse_id_header(dsp, &adsp2_id.fw, n_algs);
2372 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_XM,
2373 adsp2_id.fw.id, adsp2_id.xm);
2374 if (IS_ERR(alg_region))
2375 return PTR_ERR(alg_region);
2377 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_YM,
2378 adsp2_id.fw.id, adsp2_id.ym);
2379 if (IS_ERR(alg_region))
2380 return PTR_ERR(alg_region);
2382 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_ZM,
2383 adsp2_id.fw.id, adsp2_id.zm);
2384 if (IS_ERR(alg_region))
2385 return PTR_ERR(alg_region);
2387 /* Calculate offset and length in DSP words */
2388 pos = sizeof(adsp2_id) / sizeof(u32);
2389 len = (sizeof(*adsp2_alg) * n_algs) / sizeof(u32);
2391 adsp2_alg = wm_adsp_read_algs(dsp, n_algs, mem, pos, len);
2392 if (IS_ERR(adsp2_alg))
2393 return PTR_ERR(adsp2_alg);
2395 for (i = 0; i < n_algs; i++) {
2397 "%d: ID %x v%d.%d.%d XM@%x YM@%x ZM@%x\n",
2398 i, be32_to_cpu(adsp2_alg[i].alg.id),
2399 (be32_to_cpu(adsp2_alg[i].alg.ver) & 0xff0000) >> 16,
2400 (be32_to_cpu(adsp2_alg[i].alg.ver) & 0xff00) >> 8,
2401 be32_to_cpu(adsp2_alg[i].alg.ver) & 0xff,
2402 be32_to_cpu(adsp2_alg[i].xm),
2403 be32_to_cpu(adsp2_alg[i].ym),
2404 be32_to_cpu(adsp2_alg[i].zm));
2406 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_XM,
2407 adsp2_alg[i].alg.id,
2409 if (IS_ERR(alg_region)) {
2410 ret = PTR_ERR(alg_region);
2413 if (dsp->fw_ver == 0) {
2414 if (i + 1 < n_algs) {
2415 len = be32_to_cpu(adsp2_alg[i + 1].xm);
2416 len -= be32_to_cpu(adsp2_alg[i].xm);
2418 wm_adsp_create_control(dsp, alg_region, 0,
2420 WMFW_CTL_TYPE_BYTES);
2422 adsp_warn(dsp, "Missing length info for region XM with ID %x\n",
2423 be32_to_cpu(adsp2_alg[i].alg.id));
2427 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_YM,
2428 adsp2_alg[i].alg.id,
2430 if (IS_ERR(alg_region)) {
2431 ret = PTR_ERR(alg_region);
2434 if (dsp->fw_ver == 0) {
2435 if (i + 1 < n_algs) {
2436 len = be32_to_cpu(adsp2_alg[i + 1].ym);
2437 len -= be32_to_cpu(adsp2_alg[i].ym);
2439 wm_adsp_create_control(dsp, alg_region, 0,
2441 WMFW_CTL_TYPE_BYTES);
2443 adsp_warn(dsp, "Missing length info for region YM with ID %x\n",
2444 be32_to_cpu(adsp2_alg[i].alg.id));
2448 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_ZM,
2449 adsp2_alg[i].alg.id,
2451 if (IS_ERR(alg_region)) {
2452 ret = PTR_ERR(alg_region);
2455 if (dsp->fw_ver == 0) {
2456 if (i + 1 < n_algs) {
2457 len = be32_to_cpu(adsp2_alg[i + 1].zm);
2458 len -= be32_to_cpu(adsp2_alg[i].zm);
2460 wm_adsp_create_control(dsp, alg_region, 0,
2462 WMFW_CTL_TYPE_BYTES);
2464 adsp_warn(dsp, "Missing length info for region ZM with ID %x\n",
2465 be32_to_cpu(adsp2_alg[i].alg.id));
2475 static int wm_halo_create_regions(struct wm_adsp *dsp, __be32 id,
2476 __be32 xm_base, __be32 ym_base)
2478 static const int types[] = {
2479 WMFW_ADSP2_XM, WMFW_HALO_XM_PACKED,
2480 WMFW_ADSP2_YM, WMFW_HALO_YM_PACKED
2482 __be32 bases[] = { xm_base, xm_base, ym_base, ym_base };
2484 return wm_adsp_create_regions(dsp, id, ARRAY_SIZE(types), types, bases);
2487 static int wm_halo_setup_algs(struct wm_adsp *dsp)
2489 struct wmfw_halo_id_hdr halo_id;
2490 struct wmfw_halo_alg_hdr *halo_alg;
2491 const struct wm_adsp_region *mem;
2492 unsigned int pos, len;
2496 mem = wm_adsp_find_region(dsp, WMFW_ADSP2_XM);
2500 ret = regmap_raw_read(dsp->regmap, mem->base, &halo_id,
2503 adsp_err(dsp, "Failed to read algorithm info: %d\n",
2508 n_algs = be32_to_cpu(halo_id.n_algs);
2510 wmfw_v3_parse_id_header(dsp, &halo_id.fw, n_algs);
2512 ret = wm_halo_create_regions(dsp, halo_id.fw.id,
2513 halo_id.xm_base, halo_id.ym_base);
2517 /* Calculate offset and length in DSP words */
2518 pos = sizeof(halo_id) / sizeof(u32);
2519 len = (sizeof(*halo_alg) * n_algs) / sizeof(u32);
2521 halo_alg = wm_adsp_read_algs(dsp, n_algs, mem, pos, len);
2522 if (IS_ERR(halo_alg))
2523 return PTR_ERR(halo_alg);
2525 for (i = 0; i < n_algs; i++) {
2527 "%d: ID %x v%d.%d.%d XM@%x YM@%x\n",
2528 i, be32_to_cpu(halo_alg[i].alg.id),
2529 (be32_to_cpu(halo_alg[i].alg.ver) & 0xff0000) >> 16,
2530 (be32_to_cpu(halo_alg[i].alg.ver) & 0xff00) >> 8,
2531 be32_to_cpu(halo_alg[i].alg.ver) & 0xff,
2532 be32_to_cpu(halo_alg[i].xm_base),
2533 be32_to_cpu(halo_alg[i].ym_base));
2535 ret = wm_halo_create_regions(dsp, halo_alg[i].alg.id,
2536 halo_alg[i].xm_base,
2537 halo_alg[i].ym_base);
2547 static int wm_adsp_load_coeff(struct wm_adsp *dsp)
2549 LIST_HEAD(buf_list);
2550 struct regmap *regmap = dsp->regmap;
2551 struct wmfw_coeff_hdr *hdr;
2552 struct wmfw_coeff_item *blk;
2553 const struct firmware *firmware;
2554 const struct wm_adsp_region *mem;
2555 struct wm_adsp_alg_region *alg_region;
2556 const char *region_name;
2557 int ret, pos, blocks, type, offset, reg;
2559 struct wm_adsp_buf *buf;
2561 file = kzalloc(PAGE_SIZE, GFP_KERNEL);
2565 snprintf(file, PAGE_SIZE, "%s-%s-%s.bin", dsp->part, dsp->fwf_name,
2566 wm_adsp_fw[dsp->fw].file);
2567 file[PAGE_SIZE - 1] = '\0';
2569 ret = request_firmware(&firmware, file, dsp->dev);
2571 adsp_warn(dsp, "Failed to request '%s'\n", file);
2577 if (sizeof(*hdr) >= firmware->size) {
2578 adsp_err(dsp, "%s: file too short, %zu bytes\n",
2579 file, firmware->size);
2583 hdr = (void *)&firmware->data[0];
2584 if (memcmp(hdr->magic, "WMDR", 4) != 0) {
2585 adsp_err(dsp, "%s: invalid magic\n", file);
2589 switch (be32_to_cpu(hdr->rev) & 0xff) {
2593 adsp_err(dsp, "%s: Unsupported coefficient file format %d\n",
2594 file, be32_to_cpu(hdr->rev) & 0xff);
2599 adsp_dbg(dsp, "%s: v%d.%d.%d\n", file,
2600 (le32_to_cpu(hdr->ver) >> 16) & 0xff,
2601 (le32_to_cpu(hdr->ver) >> 8) & 0xff,
2602 le32_to_cpu(hdr->ver) & 0xff);
2604 pos = le32_to_cpu(hdr->len);
2607 while (pos < firmware->size &&
2608 sizeof(*blk) < firmware->size - pos) {
2609 blk = (void *)(&firmware->data[pos]);
2611 type = le16_to_cpu(blk->type);
2612 offset = le16_to_cpu(blk->offset);
2614 adsp_dbg(dsp, "%s.%d: %x v%d.%d.%d\n",
2615 file, blocks, le32_to_cpu(blk->id),
2616 (le32_to_cpu(blk->ver) >> 16) & 0xff,
2617 (le32_to_cpu(blk->ver) >> 8) & 0xff,
2618 le32_to_cpu(blk->ver) & 0xff);
2619 adsp_dbg(dsp, "%s.%d: %d bytes at 0x%x in %x\n",
2620 file, blocks, le32_to_cpu(blk->len), offset, type);
2623 region_name = "Unknown";
2625 case (WMFW_NAME_TEXT << 8):
2626 case (WMFW_INFO_TEXT << 8):
2627 case (WMFW_METADATA << 8):
2629 case (WMFW_ABSOLUTE << 8):
2631 * Old files may use this for global
2634 if (le32_to_cpu(blk->id) == dsp->fw_id &&
2636 region_name = "global coefficients";
2637 mem = wm_adsp_find_region(dsp, type);
2639 adsp_err(dsp, "No ZM\n");
2642 reg = dsp->ops->region_to_reg(mem, 0);
2645 region_name = "register";
2654 case WMFW_HALO_XM_PACKED:
2655 case WMFW_HALO_YM_PACKED:
2656 case WMFW_HALO_PM_PACKED:
2657 adsp_dbg(dsp, "%s.%d: %d bytes in %x for %x\n",
2658 file, blocks, le32_to_cpu(blk->len),
2659 type, le32_to_cpu(blk->id));
2661 mem = wm_adsp_find_region(dsp, type);
2663 adsp_err(dsp, "No base for region %x\n", type);
2667 alg_region = wm_adsp_find_alg_region(dsp, type,
2668 le32_to_cpu(blk->id));
2670 reg = alg_region->base;
2671 reg = dsp->ops->region_to_reg(mem, reg);
2674 adsp_err(dsp, "No %x for algorithm %x\n",
2675 type, le32_to_cpu(blk->id));
2680 adsp_err(dsp, "%s.%d: Unknown region type %x at %d\n",
2681 file, blocks, type, pos);
2686 if (le32_to_cpu(blk->len) >
2687 firmware->size - pos - sizeof(*blk)) {
2689 "%s.%d: %s region len %d bytes exceeds file length %zu\n",
2690 file, blocks, region_name,
2691 le32_to_cpu(blk->len),
2697 buf = wm_adsp_buf_alloc(blk->data,
2698 le32_to_cpu(blk->len),
2701 adsp_err(dsp, "Out of memory\n");
2706 adsp_dbg(dsp, "%s.%d: Writing %d bytes at %x\n",
2707 file, blocks, le32_to_cpu(blk->len),
2709 ret = regmap_raw_write_async(regmap, reg, buf->buf,
2710 le32_to_cpu(blk->len));
2713 "%s.%d: Failed to write to %x in %s: %d\n",
2714 file, blocks, reg, region_name, ret);
2718 pos += (le32_to_cpu(blk->len) + sizeof(*blk) + 3) & ~0x03;
2722 ret = regmap_async_complete(regmap);
2724 adsp_err(dsp, "Failed to complete async write: %d\n", ret);
2726 if (pos > firmware->size)
2727 adsp_warn(dsp, "%s.%d: %zu bytes at end of file\n",
2728 file, blocks, pos - firmware->size);
2730 wm_adsp_debugfs_save_binname(dsp, file);
2733 regmap_async_complete(regmap);
2734 release_firmware(firmware);
2735 wm_adsp_buf_free(&buf_list);
2741 static int wm_adsp_create_name(struct wm_adsp *dsp)
2746 dsp->name = devm_kasprintf(dsp->dev, GFP_KERNEL, "DSP%d",
2752 if (!dsp->fwf_name) {
2753 p = devm_kstrdup(dsp->dev, dsp->name, GFP_KERNEL);
2758 for (; *p != 0; ++p)
2765 static int wm_adsp_common_init(struct wm_adsp *dsp)
2769 ret = wm_adsp_create_name(dsp);
2773 INIT_LIST_HEAD(&dsp->alg_regions);
2774 INIT_LIST_HEAD(&dsp->ctl_list);
2775 INIT_LIST_HEAD(&dsp->compr_list);
2776 INIT_LIST_HEAD(&dsp->buffer_list);
2778 mutex_init(&dsp->pwr_lock);
2783 int wm_adsp1_init(struct wm_adsp *dsp)
2785 dsp->ops = &wm_adsp1_ops;
2787 return wm_adsp_common_init(dsp);
2789 EXPORT_SYMBOL_GPL(wm_adsp1_init);
2791 int wm_adsp1_event(struct snd_soc_dapm_widget *w,
2792 struct snd_kcontrol *kcontrol,
2795 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
2796 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
2797 struct wm_adsp *dsp = &dsps[w->shift];
2798 struct wm_coeff_ctl *ctl;
2802 dsp->component = component;
2804 mutex_lock(&dsp->pwr_lock);
2807 case SND_SOC_DAPM_POST_PMU:
2808 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2809 ADSP1_SYS_ENA, ADSP1_SYS_ENA);
2812 * For simplicity set the DSP clock rate to be the
2813 * SYSCLK rate rather than making it configurable.
2815 if (dsp->sysclk_reg) {
2816 ret = regmap_read(dsp->regmap, dsp->sysclk_reg, &val);
2818 adsp_err(dsp, "Failed to read SYSCLK state: %d\n",
2823 val = (val & dsp->sysclk_mask) >> dsp->sysclk_shift;
2825 ret = regmap_update_bits(dsp->regmap,
2826 dsp->base + ADSP1_CONTROL_31,
2827 ADSP1_CLK_SEL_MASK, val);
2829 adsp_err(dsp, "Failed to set clock rate: %d\n",
2835 ret = wm_adsp_load(dsp);
2839 ret = wm_adsp1_setup_algs(dsp);
2843 ret = wm_adsp_load_coeff(dsp);
2847 /* Initialize caches for enabled and unset controls */
2848 ret = wm_coeff_init_control_caches(dsp);
2852 /* Sync set controls */
2853 ret = wm_coeff_sync_controls(dsp);
2859 /* Start the core running */
2860 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2861 ADSP1_CORE_ENA | ADSP1_START,
2862 ADSP1_CORE_ENA | ADSP1_START);
2864 dsp->running = true;
2867 case SND_SOC_DAPM_PRE_PMD:
2868 dsp->running = false;
2869 dsp->booted = false;
2872 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2873 ADSP1_CORE_ENA | ADSP1_START, 0);
2875 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_19,
2876 ADSP1_WDMA_BUFFER_LENGTH_MASK, 0);
2878 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2881 list_for_each_entry(ctl, &dsp->ctl_list, list)
2885 wm_adsp_free_alg_regions(dsp);
2892 mutex_unlock(&dsp->pwr_lock);
2897 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2900 mutex_unlock(&dsp->pwr_lock);
2904 EXPORT_SYMBOL_GPL(wm_adsp1_event);
2906 static int wm_adsp2v2_enable_core(struct wm_adsp *dsp)
2911 /* Wait for the RAM to start, should be near instantaneous */
2912 for (count = 0; count < 10; ++count) {
2913 ret = regmap_read(dsp->regmap, dsp->base + ADSP2_STATUS1, &val);
2917 if (val & ADSP2_RAM_RDY)
2920 usleep_range(250, 500);
2923 if (!(val & ADSP2_RAM_RDY)) {
2924 adsp_err(dsp, "Failed to start DSP RAM\n");
2928 adsp_dbg(dsp, "RAM ready after %d polls\n", count);
2933 static int wm_adsp2_enable_core(struct wm_adsp *dsp)
2937 ret = regmap_update_bits_async(dsp->regmap, dsp->base + ADSP2_CONTROL,
2938 ADSP2_SYS_ENA, ADSP2_SYS_ENA);
2942 return wm_adsp2v2_enable_core(dsp);
2945 static int wm_adsp2_lock(struct wm_adsp *dsp, unsigned int lock_regions)
2947 struct regmap *regmap = dsp->regmap;
2948 unsigned int code0, code1, lock_reg;
2950 if (!(lock_regions & WM_ADSP2_REGION_ALL))
2953 lock_regions &= WM_ADSP2_REGION_ALL;
2954 lock_reg = dsp->base + ADSP2_LOCK_REGION_1_LOCK_REGION_0;
2956 while (lock_regions) {
2958 if (lock_regions & BIT(0)) {
2959 code0 = ADSP2_LOCK_CODE_0;
2960 code1 = ADSP2_LOCK_CODE_1;
2962 if (lock_regions & BIT(1)) {
2963 code0 |= ADSP2_LOCK_CODE_0 << ADSP2_LOCK_REGION_SHIFT;
2964 code1 |= ADSP2_LOCK_CODE_1 << ADSP2_LOCK_REGION_SHIFT;
2966 regmap_write(regmap, lock_reg, code0);
2967 regmap_write(regmap, lock_reg, code1);
2975 static int wm_adsp2_enable_memory(struct wm_adsp *dsp)
2977 return regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
2978 ADSP2_MEM_ENA, ADSP2_MEM_ENA);
2981 static void wm_adsp2_disable_memory(struct wm_adsp *dsp)
2983 regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
2987 static void wm_adsp2_disable_core(struct wm_adsp *dsp)
2989 regmap_write(dsp->regmap, dsp->base + ADSP2_RDMA_CONFIG_1, 0);
2990 regmap_write(dsp->regmap, dsp->base + ADSP2_WDMA_CONFIG_1, 0);
2991 regmap_write(dsp->regmap, dsp->base + ADSP2_WDMA_CONFIG_2, 0);
2993 regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
2997 static void wm_adsp2v2_disable_core(struct wm_adsp *dsp)
2999 regmap_write(dsp->regmap, dsp->base + ADSP2_RDMA_CONFIG_1, 0);
3000 regmap_write(dsp->regmap, dsp->base + ADSP2_WDMA_CONFIG_1, 0);
3001 regmap_write(dsp->regmap, dsp->base + ADSP2V2_WDMA_CONFIG_2, 0);
3004 static void wm_adsp_boot_work(struct work_struct *work)
3006 struct wm_adsp *dsp = container_of(work,
3011 mutex_lock(&dsp->pwr_lock);
3013 if (dsp->ops->enable_memory) {
3014 ret = dsp->ops->enable_memory(dsp);
3019 if (dsp->ops->enable_core) {
3020 ret = dsp->ops->enable_core(dsp);
3025 ret = wm_adsp_load(dsp);
3029 ret = dsp->ops->setup_algs(dsp);
3033 ret = wm_adsp_load_coeff(dsp);
3037 /* Initialize caches for enabled and unset controls */
3038 ret = wm_coeff_init_control_caches(dsp);
3042 if (dsp->ops->disable_core)
3043 dsp->ops->disable_core(dsp);
3047 mutex_unlock(&dsp->pwr_lock);
3052 if (dsp->ops->disable_core)
3053 dsp->ops->disable_core(dsp);
3055 if (dsp->ops->disable_memory)
3056 dsp->ops->disable_memory(dsp);
3058 mutex_unlock(&dsp->pwr_lock);
3061 static int wm_halo_configure_mpu(struct wm_adsp *dsp, unsigned int lock_regions)
3063 struct reg_sequence config[] = {
3064 { dsp->base + HALO_MPU_LOCK_CONFIG, 0x5555 },
3065 { dsp->base + HALO_MPU_LOCK_CONFIG, 0xAAAA },
3066 { dsp->base + HALO_MPU_XMEM_ACCESS_0, 0xFFFFFFFF },
3067 { dsp->base + HALO_MPU_YMEM_ACCESS_0, 0xFFFFFFFF },
3068 { dsp->base + HALO_MPU_WINDOW_ACCESS_0, lock_regions },
3069 { dsp->base + HALO_MPU_XREG_ACCESS_0, lock_regions },
3070 { dsp->base + HALO_MPU_YREG_ACCESS_0, lock_regions },
3071 { dsp->base + HALO_MPU_XMEM_ACCESS_1, 0xFFFFFFFF },
3072 { dsp->base + HALO_MPU_YMEM_ACCESS_1, 0xFFFFFFFF },
3073 { dsp->base + HALO_MPU_WINDOW_ACCESS_1, lock_regions },
3074 { dsp->base + HALO_MPU_XREG_ACCESS_1, lock_regions },
3075 { dsp->base + HALO_MPU_YREG_ACCESS_1, lock_regions },
3076 { dsp->base + HALO_MPU_XMEM_ACCESS_2, 0xFFFFFFFF },
3077 { dsp->base + HALO_MPU_YMEM_ACCESS_2, 0xFFFFFFFF },
3078 { dsp->base + HALO_MPU_WINDOW_ACCESS_2, lock_regions },
3079 { dsp->base + HALO_MPU_XREG_ACCESS_2, lock_regions },
3080 { dsp->base + HALO_MPU_YREG_ACCESS_2, lock_regions },
3081 { dsp->base + HALO_MPU_XMEM_ACCESS_3, 0xFFFFFFFF },
3082 { dsp->base + HALO_MPU_YMEM_ACCESS_3, 0xFFFFFFFF },
3083 { dsp->base + HALO_MPU_WINDOW_ACCESS_3, lock_regions },
3084 { dsp->base + HALO_MPU_XREG_ACCESS_3, lock_regions },
3085 { dsp->base + HALO_MPU_YREG_ACCESS_3, lock_regions },
3086 { dsp->base + HALO_MPU_LOCK_CONFIG, 0 },
3089 return regmap_multi_reg_write(dsp->regmap, config, ARRAY_SIZE(config));
3092 int wm_adsp2_set_dspclk(struct snd_soc_dapm_widget *w, unsigned int freq)
3094 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
3095 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
3096 struct wm_adsp *dsp = &dsps[w->shift];
3099 ret = regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CLOCKING,
3101 freq << ADSP2_CLK_SEL_SHIFT);
3103 adsp_err(dsp, "Failed to set clock rate: %d\n", ret);
3107 EXPORT_SYMBOL_GPL(wm_adsp2_set_dspclk);
3109 int wm_adsp2_preloader_get(struct snd_kcontrol *kcontrol,
3110 struct snd_ctl_elem_value *ucontrol)
3112 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
3113 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
3114 struct soc_mixer_control *mc =
3115 (struct soc_mixer_control *)kcontrol->private_value;
3116 struct wm_adsp *dsp = &dsps[mc->shift - 1];
3118 ucontrol->value.integer.value[0] = dsp->preloaded;
3122 EXPORT_SYMBOL_GPL(wm_adsp2_preloader_get);
3124 int wm_adsp2_preloader_put(struct snd_kcontrol *kcontrol,
3125 struct snd_ctl_elem_value *ucontrol)
3127 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
3128 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
3129 struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(component);
3130 struct soc_mixer_control *mc =
3131 (struct soc_mixer_control *)kcontrol->private_value;
3132 struct wm_adsp *dsp = &dsps[mc->shift - 1];
3135 snprintf(preload, ARRAY_SIZE(preload), "%s Preload", dsp->name);
3137 dsp->preloaded = ucontrol->value.integer.value[0];
3139 if (ucontrol->value.integer.value[0])
3140 snd_soc_component_force_enable_pin(component, preload);
3142 snd_soc_component_disable_pin(component, preload);
3144 snd_soc_dapm_sync(dapm);
3146 flush_work(&dsp->boot_work);
3150 EXPORT_SYMBOL_GPL(wm_adsp2_preloader_put);
3152 static void wm_adsp_stop_watchdog(struct wm_adsp *dsp)
3154 regmap_update_bits(dsp->regmap, dsp->base + ADSP2_WATCHDOG,
3155 ADSP2_WDT_ENA_MASK, 0);
3158 static void wm_halo_stop_watchdog(struct wm_adsp *dsp)
3160 regmap_update_bits(dsp->regmap, dsp->base + HALO_WDT_CONTROL,
3161 HALO_WDT_EN_MASK, 0);
3164 int wm_adsp_early_event(struct snd_soc_dapm_widget *w,
3165 struct snd_kcontrol *kcontrol, int event)
3167 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
3168 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
3169 struct wm_adsp *dsp = &dsps[w->shift];
3170 struct wm_coeff_ctl *ctl;
3173 case SND_SOC_DAPM_PRE_PMU:
3174 queue_work(system_unbound_wq, &dsp->boot_work);
3176 case SND_SOC_DAPM_PRE_PMD:
3177 mutex_lock(&dsp->pwr_lock);
3179 wm_adsp_debugfs_clear(dsp);
3182 dsp->fw_id_version = 0;
3184 dsp->booted = false;
3186 if (dsp->ops->disable_memory)
3187 dsp->ops->disable_memory(dsp);
3189 list_for_each_entry(ctl, &dsp->ctl_list, list)
3192 wm_adsp_free_alg_regions(dsp);
3194 mutex_unlock(&dsp->pwr_lock);
3196 adsp_dbg(dsp, "Shutdown complete\n");
3204 EXPORT_SYMBOL_GPL(wm_adsp_early_event);
3206 static int wm_adsp2_start_core(struct wm_adsp *dsp)
3208 return regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
3209 ADSP2_CORE_ENA | ADSP2_START,
3210 ADSP2_CORE_ENA | ADSP2_START);
3213 static void wm_adsp2_stop_core(struct wm_adsp *dsp)
3215 regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
3216 ADSP2_CORE_ENA | ADSP2_START, 0);
3219 int wm_adsp_event(struct snd_soc_dapm_widget *w,
3220 struct snd_kcontrol *kcontrol, int event)
3222 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
3223 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
3224 struct wm_adsp *dsp = &dsps[w->shift];
3228 case SND_SOC_DAPM_POST_PMU:
3229 flush_work(&dsp->boot_work);
3231 mutex_lock(&dsp->pwr_lock);
3238 if (dsp->ops->enable_core) {
3239 ret = dsp->ops->enable_core(dsp);
3244 /* Sync set controls */
3245 ret = wm_coeff_sync_controls(dsp);
3249 if (dsp->ops->lock_memory) {
3250 ret = dsp->ops->lock_memory(dsp, dsp->lock_regions);
3252 adsp_err(dsp, "Error configuring MPU: %d\n",
3258 if (dsp->ops->start_core) {
3259 ret = dsp->ops->start_core(dsp);
3264 dsp->running = true;
3266 if (wm_adsp_fw[dsp->fw].num_caps != 0) {
3267 ret = wm_adsp_buffer_init(dsp);
3272 mutex_unlock(&dsp->pwr_lock);
3275 case SND_SOC_DAPM_PRE_PMD:
3276 /* Tell the firmware to cleanup */
3277 wm_adsp_signal_event_controls(dsp, WM_ADSP_FW_EVENT_SHUTDOWN);
3279 if (dsp->ops->stop_watchdog)
3280 dsp->ops->stop_watchdog(dsp);
3282 /* Log firmware state, it can be useful for analysis */
3283 if (dsp->ops->show_fw_status)
3284 dsp->ops->show_fw_status(dsp);
3286 mutex_lock(&dsp->pwr_lock);
3288 dsp->running = false;
3290 if (dsp->ops->stop_core)
3291 dsp->ops->stop_core(dsp);
3292 if (dsp->ops->disable_core)
3293 dsp->ops->disable_core(dsp);
3295 if (wm_adsp_fw[dsp->fw].num_caps != 0)
3296 wm_adsp_buffer_free(dsp);
3298 dsp->fatal_error = false;
3300 mutex_unlock(&dsp->pwr_lock);
3302 adsp_dbg(dsp, "Execution stopped\n");
3311 if (dsp->ops->stop_core)
3312 dsp->ops->stop_core(dsp);
3313 if (dsp->ops->disable_core)
3314 dsp->ops->disable_core(dsp);
3315 mutex_unlock(&dsp->pwr_lock);
3318 EXPORT_SYMBOL_GPL(wm_adsp_event);
3320 static int wm_halo_start_core(struct wm_adsp *dsp)
3322 return regmap_update_bits(dsp->regmap,
3323 dsp->base + HALO_CCM_CORE_CONTROL,
3324 HALO_CORE_RESET | HALO_CORE_EN,
3325 HALO_CORE_RESET | HALO_CORE_EN);
3328 static void wm_halo_stop_core(struct wm_adsp *dsp)
3330 regmap_update_bits(dsp->regmap, dsp->base + HALO_CCM_CORE_CONTROL,
3333 /* reset halo core with CORE_SOFT_RESET */
3334 regmap_update_bits(dsp->regmap, dsp->base + HALO_CORE_SOFT_RESET,
3335 HALO_CORE_SOFT_RESET_MASK, 1);
3338 int wm_adsp2_component_probe(struct wm_adsp *dsp, struct snd_soc_component *component)
3342 snprintf(preload, ARRAY_SIZE(preload), "%s Preload", dsp->name);
3343 snd_soc_component_disable_pin(component, preload);
3345 wm_adsp2_init_debugfs(dsp, component);
3347 dsp->component = component;
3351 EXPORT_SYMBOL_GPL(wm_adsp2_component_probe);
3353 int wm_adsp2_component_remove(struct wm_adsp *dsp, struct snd_soc_component *component)
3355 wm_adsp2_cleanup_debugfs(dsp);
3359 EXPORT_SYMBOL_GPL(wm_adsp2_component_remove);
3361 int wm_adsp2_init(struct wm_adsp *dsp)
3365 ret = wm_adsp_common_init(dsp);
3372 * Disable the DSP memory by default when in reset for a small
3375 ret = regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
3379 "Failed to clear memory retention: %d\n", ret);
3383 dsp->ops = &wm_adsp2_ops[0];
3386 dsp->ops = &wm_adsp2_ops[1];
3389 dsp->ops = &wm_adsp2_ops[2];
3393 INIT_WORK(&dsp->boot_work, wm_adsp_boot_work);
3397 EXPORT_SYMBOL_GPL(wm_adsp2_init);
3399 int wm_halo_init(struct wm_adsp *dsp)
3403 ret = wm_adsp_common_init(dsp);
3407 dsp->ops = &wm_halo_ops;
3409 INIT_WORK(&dsp->boot_work, wm_adsp_boot_work);
3413 EXPORT_SYMBOL_GPL(wm_halo_init);
3415 void wm_adsp2_remove(struct wm_adsp *dsp)
3417 struct wm_coeff_ctl *ctl;
3419 while (!list_empty(&dsp->ctl_list)) {
3420 ctl = list_first_entry(&dsp->ctl_list, struct wm_coeff_ctl,
3422 list_del(&ctl->list);
3423 wm_adsp_free_ctl_blk(ctl);
3426 EXPORT_SYMBOL_GPL(wm_adsp2_remove);
3428 static inline int wm_adsp_compr_attached(struct wm_adsp_compr *compr)
3430 return compr->buf != NULL;
3433 static int wm_adsp_compr_attach(struct wm_adsp_compr *compr)
3435 struct wm_adsp_compr_buf *buf = NULL, *tmp;
3437 if (compr->dsp->fatal_error)
3440 list_for_each_entry(tmp, &compr->dsp->buffer_list, list) {
3441 if (!tmp->name || !strcmp(compr->name, tmp->name)) {
3456 static void wm_adsp_compr_detach(struct wm_adsp_compr *compr)
3461 /* Wake the poll so it can see buffer is no longer attached */
3463 snd_compr_fragment_elapsed(compr->stream);
3465 if (wm_adsp_compr_attached(compr)) {
3466 compr->buf->compr = NULL;
3471 int wm_adsp_compr_open(struct wm_adsp *dsp, struct snd_compr_stream *stream)
3473 struct wm_adsp_compr *compr, *tmp;
3474 struct snd_soc_pcm_runtime *rtd = stream->private_data;
3477 mutex_lock(&dsp->pwr_lock);
3479 if (wm_adsp_fw[dsp->fw].num_caps == 0) {
3480 adsp_err(dsp, "%s: Firmware does not support compressed API\n",
3481 asoc_rtd_to_codec(rtd, 0)->name);
3486 if (wm_adsp_fw[dsp->fw].compr_direction != stream->direction) {
3487 adsp_err(dsp, "%s: Firmware does not support stream direction\n",
3488 asoc_rtd_to_codec(rtd, 0)->name);
3493 list_for_each_entry(tmp, &dsp->compr_list, list) {
3494 if (!strcmp(tmp->name, asoc_rtd_to_codec(rtd, 0)->name)) {
3495 adsp_err(dsp, "%s: Only a single stream supported per dai\n",
3496 asoc_rtd_to_codec(rtd, 0)->name);
3502 compr = kzalloc(sizeof(*compr), GFP_KERNEL);
3509 compr->stream = stream;
3510 compr->name = asoc_rtd_to_codec(rtd, 0)->name;
3512 list_add_tail(&compr->list, &dsp->compr_list);
3514 stream->runtime->private_data = compr;
3517 mutex_unlock(&dsp->pwr_lock);
3521 EXPORT_SYMBOL_GPL(wm_adsp_compr_open);
3523 int wm_adsp_compr_free(struct snd_soc_component *component,
3524 struct snd_compr_stream *stream)
3526 struct wm_adsp_compr *compr = stream->runtime->private_data;
3527 struct wm_adsp *dsp = compr->dsp;
3529 mutex_lock(&dsp->pwr_lock);
3531 wm_adsp_compr_detach(compr);
3532 list_del(&compr->list);
3534 kfree(compr->raw_buf);
3537 mutex_unlock(&dsp->pwr_lock);
3541 EXPORT_SYMBOL_GPL(wm_adsp_compr_free);
3543 static int wm_adsp_compr_check_params(struct snd_compr_stream *stream,
3544 struct snd_compr_params *params)
3546 struct wm_adsp_compr *compr = stream->runtime->private_data;
3547 struct wm_adsp *dsp = compr->dsp;
3548 const struct wm_adsp_fw_caps *caps;
3549 const struct snd_codec_desc *desc;
3552 if (params->buffer.fragment_size < WM_ADSP_MIN_FRAGMENT_SIZE ||
3553 params->buffer.fragment_size > WM_ADSP_MAX_FRAGMENT_SIZE ||
3554 params->buffer.fragments < WM_ADSP_MIN_FRAGMENTS ||
3555 params->buffer.fragments > WM_ADSP_MAX_FRAGMENTS ||
3556 params->buffer.fragment_size % WM_ADSP_DATA_WORD_SIZE) {
3557 compr_err(compr, "Invalid buffer fragsize=%d fragments=%d\n",
3558 params->buffer.fragment_size,
3559 params->buffer.fragments);
3564 for (i = 0; i < wm_adsp_fw[dsp->fw].num_caps; i++) {
3565 caps = &wm_adsp_fw[dsp->fw].caps[i];
3568 if (caps->id != params->codec.id)
3571 if (stream->direction == SND_COMPRESS_PLAYBACK) {
3572 if (desc->max_ch < params->codec.ch_out)
3575 if (desc->max_ch < params->codec.ch_in)
3579 if (!(desc->formats & (1 << params->codec.format)))
3582 for (j = 0; j < desc->num_sample_rates; ++j)
3583 if (desc->sample_rates[j] == params->codec.sample_rate)
3587 compr_err(compr, "Invalid params id=%u ch=%u,%u rate=%u fmt=%u\n",
3588 params->codec.id, params->codec.ch_in, params->codec.ch_out,
3589 params->codec.sample_rate, params->codec.format);
3593 static inline unsigned int wm_adsp_compr_frag_words(struct wm_adsp_compr *compr)
3595 return compr->size.fragment_size / WM_ADSP_DATA_WORD_SIZE;
3598 int wm_adsp_compr_set_params(struct snd_soc_component *component,
3599 struct snd_compr_stream *stream,
3600 struct snd_compr_params *params)
3602 struct wm_adsp_compr *compr = stream->runtime->private_data;
3606 ret = wm_adsp_compr_check_params(stream, params);
3610 compr->size = params->buffer;
3612 compr_dbg(compr, "fragment_size=%d fragments=%d\n",
3613 compr->size.fragment_size, compr->size.fragments);
3615 size = wm_adsp_compr_frag_words(compr) * sizeof(*compr->raw_buf);
3616 compr->raw_buf = kmalloc(size, GFP_DMA | GFP_KERNEL);
3617 if (!compr->raw_buf)
3620 compr->sample_rate = params->codec.sample_rate;
3624 EXPORT_SYMBOL_GPL(wm_adsp_compr_set_params);
3626 int wm_adsp_compr_get_caps(struct snd_soc_component *component,
3627 struct snd_compr_stream *stream,
3628 struct snd_compr_caps *caps)
3630 struct wm_adsp_compr *compr = stream->runtime->private_data;
3631 int fw = compr->dsp->fw;
3634 if (wm_adsp_fw[fw].caps) {
3635 for (i = 0; i < wm_adsp_fw[fw].num_caps; i++)
3636 caps->codecs[i] = wm_adsp_fw[fw].caps[i].id;
3638 caps->num_codecs = i;
3639 caps->direction = wm_adsp_fw[fw].compr_direction;
3641 caps->min_fragment_size = WM_ADSP_MIN_FRAGMENT_SIZE;
3642 caps->max_fragment_size = WM_ADSP_MAX_FRAGMENT_SIZE;
3643 caps->min_fragments = WM_ADSP_MIN_FRAGMENTS;
3644 caps->max_fragments = WM_ADSP_MAX_FRAGMENTS;
3649 EXPORT_SYMBOL_GPL(wm_adsp_compr_get_caps);
3651 static int wm_adsp_read_raw_data_block(struct wm_adsp *dsp, int mem_type,
3652 unsigned int mem_addr,
3653 unsigned int num_words, __be32 *data)
3655 struct wm_adsp_region const *mem = wm_adsp_find_region(dsp, mem_type);
3662 reg = dsp->ops->region_to_reg(mem, mem_addr);
3664 ret = regmap_raw_read(dsp->regmap, reg, data,
3665 sizeof(*data) * num_words);
3672 static inline int wm_adsp_read_data_word(struct wm_adsp *dsp, int mem_type,
3673 unsigned int mem_addr, u32 *data)
3678 ret = wm_adsp_read_raw_data_block(dsp, mem_type, mem_addr, 1, &raw);
3682 *data = be32_to_cpu(raw) & 0x00ffffffu;
3687 static int wm_adsp_write_data_word(struct wm_adsp *dsp, int mem_type,
3688 unsigned int mem_addr, u32 data)
3690 struct wm_adsp_region const *mem = wm_adsp_find_region(dsp, mem_type);
3691 __be32 val = cpu_to_be32(data & 0x00ffffffu);
3697 reg = dsp->ops->region_to_reg(mem, mem_addr);
3699 return regmap_raw_write(dsp->regmap, reg, &val, sizeof(val));
3702 static inline int wm_adsp_buffer_read(struct wm_adsp_compr_buf *buf,
3703 unsigned int field_offset, u32 *data)
3705 return wm_adsp_read_data_word(buf->dsp, buf->host_buf_mem_type,
3706 buf->host_buf_ptr + field_offset, data);
3709 static inline int wm_adsp_buffer_write(struct wm_adsp_compr_buf *buf,
3710 unsigned int field_offset, u32 data)
3712 return wm_adsp_write_data_word(buf->dsp, buf->host_buf_mem_type,
3713 buf->host_buf_ptr + field_offset, data);
3716 static void wm_adsp_remove_padding(u32 *buf, int nwords)
3718 const __be32 *pack_in = (__be32 *)buf;
3719 u8 *pack_out = (u8 *)buf;
3723 * DSP words from the register map have pad bytes and the data bytes
3724 * are in swapped order. This swaps back to the original little-endian
3725 * order and strips the pad bytes.
3727 for (i = 0; i < nwords; i++) {
3728 u32 word = be32_to_cpu(*pack_in++);
3729 *pack_out++ = (u8)word;
3730 *pack_out++ = (u8)(word >> 8);
3731 *pack_out++ = (u8)(word >> 16);
3735 static int wm_adsp_buffer_populate(struct wm_adsp_compr_buf *buf)
3737 const struct wm_adsp_fw_caps *caps = wm_adsp_fw[buf->dsp->fw].caps;
3738 struct wm_adsp_buffer_region *region;
3742 buf->regions = kcalloc(caps->num_regions, sizeof(*buf->regions),
3747 for (i = 0; i < caps->num_regions; ++i) {
3748 region = &buf->regions[i];
3750 region->offset = offset;
3751 region->mem_type = caps->region_defs[i].mem_type;
3753 ret = wm_adsp_buffer_read(buf, caps->region_defs[i].base_offset,
3754 ®ion->base_addr);
3758 ret = wm_adsp_buffer_read(buf, caps->region_defs[i].size_offset,
3763 region->cumulative_size = offset;
3766 "region=%d type=%d base=%08x off=%08x size=%08x\n",
3767 i, region->mem_type, region->base_addr,
3768 region->offset, region->cumulative_size);
3774 static void wm_adsp_buffer_clear(struct wm_adsp_compr_buf *buf)
3776 buf->irq_count = 0xFFFFFFFF;
3777 buf->read_index = -1;
3781 static struct wm_adsp_compr_buf *wm_adsp_buffer_alloc(struct wm_adsp *dsp)
3783 struct wm_adsp_compr_buf *buf;
3785 buf = kzalloc(sizeof(*buf), GFP_KERNEL);
3791 wm_adsp_buffer_clear(buf);
3793 list_add_tail(&buf->list, &dsp->buffer_list);
3798 static int wm_adsp_buffer_parse_legacy(struct wm_adsp *dsp)
3800 struct wm_adsp_alg_region *alg_region;
3801 struct wm_adsp_compr_buf *buf;
3802 u32 xmalg, addr, magic;
3805 alg_region = wm_adsp_find_alg_region(dsp, WMFW_ADSP2_XM, dsp->fw_id);
3807 adsp_err(dsp, "No algorithm region found\n");
3811 buf = wm_adsp_buffer_alloc(dsp);
3815 xmalg = dsp->ops->sys_config_size / sizeof(__be32);
3817 addr = alg_region->base + xmalg + ALG_XM_FIELD(magic);
3818 ret = wm_adsp_read_data_word(dsp, WMFW_ADSP2_XM, addr, &magic);
3822 if (magic != WM_ADSP_ALG_XM_STRUCT_MAGIC)
3825 addr = alg_region->base + xmalg + ALG_XM_FIELD(host_buf_ptr);
3826 for (i = 0; i < 5; ++i) {
3827 ret = wm_adsp_read_data_word(dsp, WMFW_ADSP2_XM, addr,
3828 &buf->host_buf_ptr);
3832 if (buf->host_buf_ptr)
3835 usleep_range(1000, 2000);
3838 if (!buf->host_buf_ptr)
3841 buf->host_buf_mem_type = WMFW_ADSP2_XM;
3843 ret = wm_adsp_buffer_populate(buf);
3847 compr_dbg(buf, "legacy host_buf_ptr=%x\n", buf->host_buf_ptr);
3852 static int wm_adsp_buffer_parse_coeff(struct wm_coeff_ctl *ctl)
3854 struct wm_adsp_host_buf_coeff_v1 coeff_v1;
3855 struct wm_adsp_compr_buf *buf;
3856 unsigned int version;
3859 for (i = 0; i < 5; ++i) {
3860 ret = wm_coeff_read_ctrl(ctl, &coeff_v1, sizeof(coeff_v1));
3864 if (coeff_v1.host_buf_ptr)
3867 usleep_range(1000, 2000);
3870 if (!coeff_v1.host_buf_ptr) {
3871 adsp_err(ctl->dsp, "Failed to acquire host buffer\n");
3875 buf = wm_adsp_buffer_alloc(ctl->dsp);
3879 buf->host_buf_mem_type = ctl->alg_region.type;
3880 buf->host_buf_ptr = be32_to_cpu(coeff_v1.host_buf_ptr);
3882 ret = wm_adsp_buffer_populate(buf);
3887 * v0 host_buffer coefficients didn't have versioning, so if the
3888 * control is one word, assume version 0.
3890 if (ctl->len == 4) {
3891 compr_dbg(buf, "host_buf_ptr=%x\n", buf->host_buf_ptr);
3895 version = be32_to_cpu(coeff_v1.versions) & HOST_BUF_COEFF_COMPAT_VER_MASK;
3896 version >>= HOST_BUF_COEFF_COMPAT_VER_SHIFT;
3898 if (version > HOST_BUF_COEFF_SUPPORTED_COMPAT_VER) {
3900 "Host buffer coeff ver %u > supported version %u\n",
3901 version, HOST_BUF_COEFF_SUPPORTED_COMPAT_VER);
3905 wm_adsp_remove_padding((u32 *)&coeff_v1.name, ARRAY_SIZE(coeff_v1.name));
3907 buf->name = kasprintf(GFP_KERNEL, "%s-dsp-%s", ctl->dsp->part,
3908 (char *)&coeff_v1.name);
3910 compr_dbg(buf, "host_buf_ptr=%x coeff version %u\n",
3911 buf->host_buf_ptr, version);
3916 static int wm_adsp_buffer_init(struct wm_adsp *dsp)
3918 struct wm_coeff_ctl *ctl;
3921 list_for_each_entry(ctl, &dsp->ctl_list, list) {
3922 if (ctl->type != WMFW_CTL_TYPE_HOST_BUFFER)
3928 ret = wm_adsp_buffer_parse_coeff(ctl);
3930 adsp_err(dsp, "Failed to parse coeff: %d\n", ret);
3932 } else if (ret == 0) {
3933 /* Only one buffer supported for version 0 */
3938 if (list_empty(&dsp->buffer_list)) {
3939 /* Fall back to legacy support */
3940 ret = wm_adsp_buffer_parse_legacy(dsp);
3942 adsp_err(dsp, "Failed to parse legacy: %d\n", ret);
3950 wm_adsp_buffer_free(dsp);
3954 static int wm_adsp_buffer_free(struct wm_adsp *dsp)
3956 struct wm_adsp_compr_buf *buf, *tmp;
3958 list_for_each_entry_safe(buf, tmp, &dsp->buffer_list, list) {
3959 wm_adsp_compr_detach(buf->compr);
3962 kfree(buf->regions);
3963 list_del(&buf->list);
3970 static int wm_adsp_buffer_get_error(struct wm_adsp_compr_buf *buf)
3974 ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(error), &buf->error);
3976 compr_err(buf, "Failed to check buffer error: %d\n", ret);
3979 if (buf->error != 0) {
3980 compr_err(buf, "Buffer error occurred: %d\n", buf->error);
3987 int wm_adsp_compr_trigger(struct snd_soc_component *component,
3988 struct snd_compr_stream *stream, int cmd)
3990 struct wm_adsp_compr *compr = stream->runtime->private_data;
3991 struct wm_adsp *dsp = compr->dsp;
3994 compr_dbg(compr, "Trigger: %d\n", cmd);
3996 mutex_lock(&dsp->pwr_lock);
3999 case SNDRV_PCM_TRIGGER_START:
4000 if (!wm_adsp_compr_attached(compr)) {
4001 ret = wm_adsp_compr_attach(compr);
4003 compr_err(compr, "Failed to link buffer and stream: %d\n",
4009 ret = wm_adsp_buffer_get_error(compr->buf);
4013 /* Trigger the IRQ at one fragment of data */
4014 ret = wm_adsp_buffer_write(compr->buf,
4015 HOST_BUFFER_FIELD(high_water_mark),
4016 wm_adsp_compr_frag_words(compr));
4018 compr_err(compr, "Failed to set high water mark: %d\n",
4023 case SNDRV_PCM_TRIGGER_STOP:
4024 if (wm_adsp_compr_attached(compr))
4025 wm_adsp_buffer_clear(compr->buf);
4032 mutex_unlock(&dsp->pwr_lock);
4036 EXPORT_SYMBOL_GPL(wm_adsp_compr_trigger);
4038 static inline int wm_adsp_buffer_size(struct wm_adsp_compr_buf *buf)
4040 int last_region = wm_adsp_fw[buf->dsp->fw].caps->num_regions - 1;
4042 return buf->regions[last_region].cumulative_size;
4045 static int wm_adsp_buffer_update_avail(struct wm_adsp_compr_buf *buf)
4047 u32 next_read_index, next_write_index;
4048 int write_index, read_index, avail;
4051 /* Only sync read index if we haven't already read a valid index */
4052 if (buf->read_index < 0) {
4053 ret = wm_adsp_buffer_read(buf,
4054 HOST_BUFFER_FIELD(next_read_index),
4059 read_index = sign_extend32(next_read_index, 23);
4061 if (read_index < 0) {
4062 compr_dbg(buf, "Avail check on unstarted stream\n");
4066 buf->read_index = read_index;
4069 ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(next_write_index),
4074 write_index = sign_extend32(next_write_index, 23);
4076 avail = write_index - buf->read_index;
4078 avail += wm_adsp_buffer_size(buf);
4080 compr_dbg(buf, "readindex=0x%x, writeindex=0x%x, avail=%d\n",
4081 buf->read_index, write_index, avail * WM_ADSP_DATA_WORD_SIZE);
4088 int wm_adsp_compr_handle_irq(struct wm_adsp *dsp)
4090 struct wm_adsp_compr_buf *buf;
4091 struct wm_adsp_compr *compr;
4094 mutex_lock(&dsp->pwr_lock);
4096 if (list_empty(&dsp->buffer_list)) {
4101 adsp_dbg(dsp, "Handling buffer IRQ\n");
4103 list_for_each_entry(buf, &dsp->buffer_list, list) {
4106 ret = wm_adsp_buffer_get_error(buf);
4108 goto out_notify; /* Wake poll to report error */
4110 ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(irq_count),
4113 compr_err(buf, "Failed to get irq_count: %d\n", ret);
4117 ret = wm_adsp_buffer_update_avail(buf);
4119 compr_err(buf, "Error reading avail: %d\n", ret);
4123 if (wm_adsp_fw[dsp->fw].voice_trigger && buf->irq_count == 2)
4124 ret = WM_ADSP_COMPR_VOICE_TRIGGER;
4127 if (compr && compr->stream)
4128 snd_compr_fragment_elapsed(compr->stream);
4132 mutex_unlock(&dsp->pwr_lock);
4136 EXPORT_SYMBOL_GPL(wm_adsp_compr_handle_irq);
4138 static int wm_adsp_buffer_reenable_irq(struct wm_adsp_compr_buf *buf)
4140 if (buf->irq_count & 0x01)
4143 compr_dbg(buf, "Enable IRQ(0x%x) for next fragment\n", buf->irq_count);
4145 buf->irq_count |= 0x01;
4147 return wm_adsp_buffer_write(buf, HOST_BUFFER_FIELD(irq_ack),
4151 int wm_adsp_compr_pointer(struct snd_soc_component *component,
4152 struct snd_compr_stream *stream,
4153 struct snd_compr_tstamp *tstamp)
4155 struct wm_adsp_compr *compr = stream->runtime->private_data;
4156 struct wm_adsp *dsp = compr->dsp;
4157 struct wm_adsp_compr_buf *buf;
4160 compr_dbg(compr, "Pointer request\n");
4162 mutex_lock(&dsp->pwr_lock);
4166 if (dsp->fatal_error || !buf || buf->error) {
4167 snd_compr_stop_error(stream, SNDRV_PCM_STATE_XRUN);
4172 if (buf->avail < wm_adsp_compr_frag_words(compr)) {
4173 ret = wm_adsp_buffer_update_avail(buf);
4175 compr_err(compr, "Error reading avail: %d\n", ret);
4180 * If we really have less than 1 fragment available tell the
4181 * DSP to inform us once a whole fragment is available.
4183 if (buf->avail < wm_adsp_compr_frag_words(compr)) {
4184 ret = wm_adsp_buffer_get_error(buf);
4187 snd_compr_stop_error(stream,
4188 SNDRV_PCM_STATE_XRUN);
4192 ret = wm_adsp_buffer_reenable_irq(buf);
4194 compr_err(compr, "Failed to re-enable buffer IRQ: %d\n",
4201 tstamp->copied_total = compr->copied_total;
4202 tstamp->copied_total += buf->avail * WM_ADSP_DATA_WORD_SIZE;
4203 tstamp->sampling_rate = compr->sample_rate;
4206 mutex_unlock(&dsp->pwr_lock);
4210 EXPORT_SYMBOL_GPL(wm_adsp_compr_pointer);
4212 static int wm_adsp_buffer_capture_block(struct wm_adsp_compr *compr, int target)
4214 struct wm_adsp_compr_buf *buf = compr->buf;
4215 unsigned int adsp_addr;
4216 int mem_type, nwords, max_read;
4219 /* Calculate read parameters */
4220 for (i = 0; i < wm_adsp_fw[buf->dsp->fw].caps->num_regions; ++i)
4221 if (buf->read_index < buf->regions[i].cumulative_size)
4224 if (i == wm_adsp_fw[buf->dsp->fw].caps->num_regions)
4227 mem_type = buf->regions[i].mem_type;
4228 adsp_addr = buf->regions[i].base_addr +
4229 (buf->read_index - buf->regions[i].offset);
4231 max_read = wm_adsp_compr_frag_words(compr);
4232 nwords = buf->regions[i].cumulative_size - buf->read_index;
4234 if (nwords > target)
4236 if (nwords > buf->avail)
4237 nwords = buf->avail;
4238 if (nwords > max_read)
4243 /* Read data from DSP */
4244 ret = wm_adsp_read_raw_data_block(buf->dsp, mem_type, adsp_addr,
4245 nwords, (__be32 *)compr->raw_buf);
4249 wm_adsp_remove_padding(compr->raw_buf, nwords);
4251 /* update read index to account for words read */
4252 buf->read_index += nwords;
4253 if (buf->read_index == wm_adsp_buffer_size(buf))
4254 buf->read_index = 0;
4256 ret = wm_adsp_buffer_write(buf, HOST_BUFFER_FIELD(next_read_index),
4261 /* update avail to account for words read */
4262 buf->avail -= nwords;
4267 static int wm_adsp_compr_read(struct wm_adsp_compr *compr,
4268 char __user *buf, size_t count)
4270 struct wm_adsp *dsp = compr->dsp;
4274 compr_dbg(compr, "Requested read of %zu bytes\n", count);
4276 if (dsp->fatal_error || !compr->buf || compr->buf->error) {
4277 snd_compr_stop_error(compr->stream, SNDRV_PCM_STATE_XRUN);
4281 count /= WM_ADSP_DATA_WORD_SIZE;
4284 nwords = wm_adsp_buffer_capture_block(compr, count);
4286 compr_err(compr, "Failed to capture block: %d\n",
4291 nbytes = nwords * WM_ADSP_DATA_WORD_SIZE;
4293 compr_dbg(compr, "Read %d bytes\n", nbytes);
4295 if (copy_to_user(buf + ntotal, compr->raw_buf, nbytes)) {
4296 compr_err(compr, "Failed to copy data to user: %d, %d\n",
4303 } while (nwords > 0 && count > 0);
4305 compr->copied_total += ntotal;
4310 int wm_adsp_compr_copy(struct snd_soc_component *component,
4311 struct snd_compr_stream *stream, char __user *buf,
4314 struct wm_adsp_compr *compr = stream->runtime->private_data;
4315 struct wm_adsp *dsp = compr->dsp;
4318 mutex_lock(&dsp->pwr_lock);
4320 if (stream->direction == SND_COMPRESS_CAPTURE)
4321 ret = wm_adsp_compr_read(compr, buf, count);
4325 mutex_unlock(&dsp->pwr_lock);
4329 EXPORT_SYMBOL_GPL(wm_adsp_compr_copy);
4331 static void wm_adsp_fatal_error(struct wm_adsp *dsp)
4333 struct wm_adsp_compr *compr;
4335 dsp->fatal_error = true;
4337 list_for_each_entry(compr, &dsp->compr_list, list) {
4339 snd_compr_fragment_elapsed(compr->stream);
4343 irqreturn_t wm_adsp2_bus_error(int irq, void *data)
4345 struct wm_adsp *dsp = (struct wm_adsp *)data;
4347 struct regmap *regmap = dsp->regmap;
4350 mutex_lock(&dsp->pwr_lock);
4352 ret = regmap_read(regmap, dsp->base + ADSP2_LOCK_REGION_CTRL, &val);
4355 "Failed to read Region Lock Ctrl register: %d\n", ret);
4359 if (val & ADSP2_WDT_TIMEOUT_STS_MASK) {
4360 adsp_err(dsp, "watchdog timeout error\n");
4361 dsp->ops->stop_watchdog(dsp);
4362 wm_adsp_fatal_error(dsp);
4365 if (val & (ADSP2_ADDR_ERR_MASK | ADSP2_REGION_LOCK_ERR_MASK)) {
4366 if (val & ADSP2_ADDR_ERR_MASK)
4367 adsp_err(dsp, "bus error: address error\n");
4369 adsp_err(dsp, "bus error: region lock error\n");
4371 ret = regmap_read(regmap, dsp->base + ADSP2_BUS_ERR_ADDR, &val);
4374 "Failed to read Bus Err Addr register: %d\n",
4379 adsp_err(dsp, "bus error address = 0x%x\n",
4380 val & ADSP2_BUS_ERR_ADDR_MASK);
4382 ret = regmap_read(regmap,
4383 dsp->base + ADSP2_PMEM_ERR_ADDR_XMEM_ERR_ADDR,
4387 "Failed to read Pmem Xmem Err Addr register: %d\n",
4392 adsp_err(dsp, "xmem error address = 0x%x\n",
4393 val & ADSP2_XMEM_ERR_ADDR_MASK);
4394 adsp_err(dsp, "pmem error address = 0x%x\n",
4395 (val & ADSP2_PMEM_ERR_ADDR_MASK) >>
4396 ADSP2_PMEM_ERR_ADDR_SHIFT);
4399 regmap_update_bits(regmap, dsp->base + ADSP2_LOCK_REGION_CTRL,
4400 ADSP2_CTRL_ERR_EINT, ADSP2_CTRL_ERR_EINT);
4403 mutex_unlock(&dsp->pwr_lock);
4407 EXPORT_SYMBOL_GPL(wm_adsp2_bus_error);
4409 irqreturn_t wm_halo_bus_error(int irq, void *data)
4411 struct wm_adsp *dsp = (struct wm_adsp *)data;
4412 struct regmap *regmap = dsp->regmap;
4413 unsigned int fault[6];
4414 struct reg_sequence clear[] = {
4415 { dsp->base + HALO_MPU_XM_VIO_STATUS, 0x0 },
4416 { dsp->base + HALO_MPU_YM_VIO_STATUS, 0x0 },
4417 { dsp->base + HALO_MPU_PM_VIO_STATUS, 0x0 },
4421 mutex_lock(&dsp->pwr_lock);
4423 ret = regmap_read(regmap, dsp->base_sysinfo + HALO_AHBM_WINDOW_DEBUG_1,
4426 adsp_warn(dsp, "Failed to read AHB DEBUG_1: %d\n", ret);
4430 adsp_warn(dsp, "AHB: STATUS: 0x%x ADDR: 0x%x\n",
4431 *fault & HALO_AHBM_FLAGS_ERR_MASK,
4432 (*fault & HALO_AHBM_CORE_ERR_ADDR_MASK) >>
4433 HALO_AHBM_CORE_ERR_ADDR_SHIFT);
4435 ret = regmap_read(regmap, dsp->base_sysinfo + HALO_AHBM_WINDOW_DEBUG_0,
4438 adsp_warn(dsp, "Failed to read AHB DEBUG_0: %d\n", ret);
4442 adsp_warn(dsp, "AHB: SYS_ADDR: 0x%x\n", *fault);
4444 ret = regmap_bulk_read(regmap, dsp->base + HALO_MPU_XM_VIO_ADDR,
4445 fault, ARRAY_SIZE(fault));
4447 adsp_warn(dsp, "Failed to read MPU fault info: %d\n", ret);
4451 adsp_warn(dsp, "XM: STATUS:0x%x ADDR:0x%x\n", fault[1], fault[0]);
4452 adsp_warn(dsp, "YM: STATUS:0x%x ADDR:0x%x\n", fault[3], fault[2]);
4453 adsp_warn(dsp, "PM: STATUS:0x%x ADDR:0x%x\n", fault[5], fault[4]);
4455 ret = regmap_multi_reg_write(dsp->regmap, clear, ARRAY_SIZE(clear));
4457 adsp_warn(dsp, "Failed to clear MPU status: %d\n", ret);
4460 mutex_unlock(&dsp->pwr_lock);
4464 EXPORT_SYMBOL_GPL(wm_halo_bus_error);
4466 irqreturn_t wm_halo_wdt_expire(int irq, void *data)
4468 struct wm_adsp *dsp = data;
4470 mutex_lock(&dsp->pwr_lock);
4472 adsp_warn(dsp, "WDT Expiry Fault\n");
4473 dsp->ops->stop_watchdog(dsp);
4474 wm_adsp_fatal_error(dsp);
4476 mutex_unlock(&dsp->pwr_lock);
4480 EXPORT_SYMBOL_GPL(wm_halo_wdt_expire);
4482 static const struct wm_adsp_ops wm_adsp1_ops = {
4483 .validate_version = wm_adsp_validate_version,
4484 .parse_sizes = wm_adsp1_parse_sizes,
4485 .region_to_reg = wm_adsp_region_to_reg,
4488 static const struct wm_adsp_ops wm_adsp2_ops[] = {
4490 .sys_config_size = sizeof(struct wm_adsp_system_config_xm_hdr),
4491 .parse_sizes = wm_adsp2_parse_sizes,
4492 .validate_version = wm_adsp_validate_version,
4493 .setup_algs = wm_adsp2_setup_algs,
4494 .region_to_reg = wm_adsp_region_to_reg,
4496 .show_fw_status = wm_adsp2_show_fw_status,
4498 .enable_memory = wm_adsp2_enable_memory,
4499 .disable_memory = wm_adsp2_disable_memory,
4501 .enable_core = wm_adsp2_enable_core,
4502 .disable_core = wm_adsp2_disable_core,
4504 .start_core = wm_adsp2_start_core,
4505 .stop_core = wm_adsp2_stop_core,
4509 .sys_config_size = sizeof(struct wm_adsp_system_config_xm_hdr),
4510 .parse_sizes = wm_adsp2_parse_sizes,
4511 .validate_version = wm_adsp_validate_version,
4512 .setup_algs = wm_adsp2_setup_algs,
4513 .region_to_reg = wm_adsp_region_to_reg,
4515 .show_fw_status = wm_adsp2v2_show_fw_status,
4517 .enable_memory = wm_adsp2_enable_memory,
4518 .disable_memory = wm_adsp2_disable_memory,
4519 .lock_memory = wm_adsp2_lock,
4521 .enable_core = wm_adsp2v2_enable_core,
4522 .disable_core = wm_adsp2v2_disable_core,
4524 .start_core = wm_adsp2_start_core,
4525 .stop_core = wm_adsp2_stop_core,
4528 .sys_config_size = sizeof(struct wm_adsp_system_config_xm_hdr),
4529 .parse_sizes = wm_adsp2_parse_sizes,
4530 .validate_version = wm_adsp_validate_version,
4531 .setup_algs = wm_adsp2_setup_algs,
4532 .region_to_reg = wm_adsp_region_to_reg,
4534 .show_fw_status = wm_adsp2v2_show_fw_status,
4535 .stop_watchdog = wm_adsp_stop_watchdog,
4537 .enable_memory = wm_adsp2_enable_memory,
4538 .disable_memory = wm_adsp2_disable_memory,
4539 .lock_memory = wm_adsp2_lock,
4541 .enable_core = wm_adsp2v2_enable_core,
4542 .disable_core = wm_adsp2v2_disable_core,
4544 .start_core = wm_adsp2_start_core,
4545 .stop_core = wm_adsp2_stop_core,
4549 static const struct wm_adsp_ops wm_halo_ops = {
4550 .sys_config_size = sizeof(struct wm_halo_system_config_xm_hdr),
4551 .parse_sizes = wm_adsp2_parse_sizes,
4552 .validate_version = wm_halo_validate_version,
4553 .setup_algs = wm_halo_setup_algs,
4554 .region_to_reg = wm_halo_region_to_reg,
4556 .show_fw_status = wm_halo_show_fw_status,
4557 .stop_watchdog = wm_halo_stop_watchdog,
4559 .lock_memory = wm_halo_configure_mpu,
4561 .start_core = wm_halo_start_core,
4562 .stop_core = wm_halo_stop_core,
4565 MODULE_LICENSE("GPL v2");