2 * wm_adsp.c -- Wolfson ADSP support
4 * Copyright 2012 Wolfson Microelectronics plc
6 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/init.h>
16 #include <linux/delay.h>
17 #include <linux/firmware.h>
18 #include <linux/list.h>
20 #include <linux/pm_runtime.h>
21 #include <linux/regmap.h>
22 #include <linux/regulator/consumer.h>
23 #include <linux/slab.h>
24 #include <linux/vmalloc.h>
25 #include <linux/workqueue.h>
26 #include <linux/debugfs.h>
27 #include <sound/core.h>
28 #include <sound/pcm.h>
29 #include <sound/pcm_params.h>
30 #include <sound/soc.h>
31 #include <sound/jack.h>
32 #include <sound/initval.h>
33 #include <sound/tlv.h>
35 #include <linux/mfd/arizona/registers.h>
40 #define adsp_crit(_dsp, fmt, ...) \
41 dev_crit(_dsp->dev, "DSP%d: " fmt, _dsp->num, ##__VA_ARGS__)
42 #define adsp_err(_dsp, fmt, ...) \
43 dev_err(_dsp->dev, "DSP%d: " fmt, _dsp->num, ##__VA_ARGS__)
44 #define adsp_warn(_dsp, fmt, ...) \
45 dev_warn(_dsp->dev, "DSP%d: " fmt, _dsp->num, ##__VA_ARGS__)
46 #define adsp_info(_dsp, fmt, ...) \
47 dev_info(_dsp->dev, "DSP%d: " fmt, _dsp->num, ##__VA_ARGS__)
48 #define adsp_dbg(_dsp, fmt, ...) \
49 dev_dbg(_dsp->dev, "DSP%d: " fmt, _dsp->num, ##__VA_ARGS__)
51 #define ADSP1_CONTROL_1 0x00
52 #define ADSP1_CONTROL_2 0x02
53 #define ADSP1_CONTROL_3 0x03
54 #define ADSP1_CONTROL_4 0x04
55 #define ADSP1_CONTROL_5 0x06
56 #define ADSP1_CONTROL_6 0x07
57 #define ADSP1_CONTROL_7 0x08
58 #define ADSP1_CONTROL_8 0x09
59 #define ADSP1_CONTROL_9 0x0A
60 #define ADSP1_CONTROL_10 0x0B
61 #define ADSP1_CONTROL_11 0x0C
62 #define ADSP1_CONTROL_12 0x0D
63 #define ADSP1_CONTROL_13 0x0F
64 #define ADSP1_CONTROL_14 0x10
65 #define ADSP1_CONTROL_15 0x11
66 #define ADSP1_CONTROL_16 0x12
67 #define ADSP1_CONTROL_17 0x13
68 #define ADSP1_CONTROL_18 0x14
69 #define ADSP1_CONTROL_19 0x16
70 #define ADSP1_CONTROL_20 0x17
71 #define ADSP1_CONTROL_21 0x18
72 #define ADSP1_CONTROL_22 0x1A
73 #define ADSP1_CONTROL_23 0x1B
74 #define ADSP1_CONTROL_24 0x1C
75 #define ADSP1_CONTROL_25 0x1E
76 #define ADSP1_CONTROL_26 0x20
77 #define ADSP1_CONTROL_27 0x21
78 #define ADSP1_CONTROL_28 0x22
79 #define ADSP1_CONTROL_29 0x23
80 #define ADSP1_CONTROL_30 0x24
81 #define ADSP1_CONTROL_31 0x26
86 #define ADSP1_WDMA_BUFFER_LENGTH_MASK 0x00FF /* DSP1_WDMA_BUFFER_LENGTH - [7:0] */
87 #define ADSP1_WDMA_BUFFER_LENGTH_SHIFT 0 /* DSP1_WDMA_BUFFER_LENGTH - [7:0] */
88 #define ADSP1_WDMA_BUFFER_LENGTH_WIDTH 8 /* DSP1_WDMA_BUFFER_LENGTH - [7:0] */
94 #define ADSP1_DBG_CLK_ENA 0x0008 /* DSP1_DBG_CLK_ENA */
95 #define ADSP1_DBG_CLK_ENA_MASK 0x0008 /* DSP1_DBG_CLK_ENA */
96 #define ADSP1_DBG_CLK_ENA_SHIFT 3 /* DSP1_DBG_CLK_ENA */
97 #define ADSP1_DBG_CLK_ENA_WIDTH 1 /* DSP1_DBG_CLK_ENA */
98 #define ADSP1_SYS_ENA 0x0004 /* DSP1_SYS_ENA */
99 #define ADSP1_SYS_ENA_MASK 0x0004 /* DSP1_SYS_ENA */
100 #define ADSP1_SYS_ENA_SHIFT 2 /* DSP1_SYS_ENA */
101 #define ADSP1_SYS_ENA_WIDTH 1 /* DSP1_SYS_ENA */
102 #define ADSP1_CORE_ENA 0x0002 /* DSP1_CORE_ENA */
103 #define ADSP1_CORE_ENA_MASK 0x0002 /* DSP1_CORE_ENA */
104 #define ADSP1_CORE_ENA_SHIFT 1 /* DSP1_CORE_ENA */
105 #define ADSP1_CORE_ENA_WIDTH 1 /* DSP1_CORE_ENA */
106 #define ADSP1_START 0x0001 /* DSP1_START */
107 #define ADSP1_START_MASK 0x0001 /* DSP1_START */
108 #define ADSP1_START_SHIFT 0 /* DSP1_START */
109 #define ADSP1_START_WIDTH 1 /* DSP1_START */
114 #define ADSP1_CLK_SEL_MASK 0x0007 /* CLK_SEL_ENA */
115 #define ADSP1_CLK_SEL_SHIFT 0 /* CLK_SEL_ENA */
116 #define ADSP1_CLK_SEL_WIDTH 3 /* CLK_SEL_ENA */
118 #define ADSP2_CONTROL 0x0
119 #define ADSP2_CLOCKING 0x1
120 #define ADSP2_STATUS1 0x4
121 #define ADSP2_WDMA_CONFIG_1 0x30
122 #define ADSP2_WDMA_CONFIG_2 0x31
123 #define ADSP2_RDMA_CONFIG_1 0x34
125 #define ADSP2_SCRATCH0 0x40
126 #define ADSP2_SCRATCH1 0x41
127 #define ADSP2_SCRATCH2 0x42
128 #define ADSP2_SCRATCH3 0x43
134 #define ADSP2_MEM_ENA 0x0010 /* DSP1_MEM_ENA */
135 #define ADSP2_MEM_ENA_MASK 0x0010 /* DSP1_MEM_ENA */
136 #define ADSP2_MEM_ENA_SHIFT 4 /* DSP1_MEM_ENA */
137 #define ADSP2_MEM_ENA_WIDTH 1 /* DSP1_MEM_ENA */
138 #define ADSP2_SYS_ENA 0x0004 /* DSP1_SYS_ENA */
139 #define ADSP2_SYS_ENA_MASK 0x0004 /* DSP1_SYS_ENA */
140 #define ADSP2_SYS_ENA_SHIFT 2 /* DSP1_SYS_ENA */
141 #define ADSP2_SYS_ENA_WIDTH 1 /* DSP1_SYS_ENA */
142 #define ADSP2_CORE_ENA 0x0002 /* DSP1_CORE_ENA */
143 #define ADSP2_CORE_ENA_MASK 0x0002 /* DSP1_CORE_ENA */
144 #define ADSP2_CORE_ENA_SHIFT 1 /* DSP1_CORE_ENA */
145 #define ADSP2_CORE_ENA_WIDTH 1 /* DSP1_CORE_ENA */
146 #define ADSP2_START 0x0001 /* DSP1_START */
147 #define ADSP2_START_MASK 0x0001 /* DSP1_START */
148 #define ADSP2_START_SHIFT 0 /* DSP1_START */
149 #define ADSP2_START_WIDTH 1 /* DSP1_START */
154 #define ADSP2_CLK_SEL_MASK 0x0007 /* CLK_SEL_ENA */
155 #define ADSP2_CLK_SEL_SHIFT 0 /* CLK_SEL_ENA */
156 #define ADSP2_CLK_SEL_WIDTH 3 /* CLK_SEL_ENA */
161 #define ADSP2_RAM_RDY 0x0001
162 #define ADSP2_RAM_RDY_MASK 0x0001
163 #define ADSP2_RAM_RDY_SHIFT 0
164 #define ADSP2_RAM_RDY_WIDTH 1
167 struct list_head list;
171 static struct wm_adsp_buf *wm_adsp_buf_alloc(const void *src, size_t len,
172 struct list_head *list)
174 struct wm_adsp_buf *buf = kzalloc(sizeof(*buf), GFP_KERNEL);
179 buf->buf = vmalloc(len);
184 memcpy(buf->buf, src, len);
187 list_add_tail(&buf->list, list);
192 static void wm_adsp_buf_free(struct list_head *list)
194 while (!list_empty(list)) {
195 struct wm_adsp_buf *buf = list_first_entry(list,
198 list_del(&buf->list);
204 #define WM_ADSP_FW_MBC_VSS 0
205 #define WM_ADSP_FW_HIFI 1
206 #define WM_ADSP_FW_TX 2
207 #define WM_ADSP_FW_TX_SPK 3
208 #define WM_ADSP_FW_RX 4
209 #define WM_ADSP_FW_RX_ANC 5
210 #define WM_ADSP_FW_CTRL 6
211 #define WM_ADSP_FW_ASR 7
212 #define WM_ADSP_FW_TRACE 8
213 #define WM_ADSP_FW_SPK_PROT 9
214 #define WM_ADSP_FW_MISC 10
216 #define WM_ADSP_NUM_FW 11
218 static const char *wm_adsp_fw_text[WM_ADSP_NUM_FW] = {
219 [WM_ADSP_FW_MBC_VSS] = "MBC/VSS",
220 [WM_ADSP_FW_HIFI] = "MasterHiFi",
221 [WM_ADSP_FW_TX] = "Tx",
222 [WM_ADSP_FW_TX_SPK] = "Tx Speaker",
223 [WM_ADSP_FW_RX] = "Rx",
224 [WM_ADSP_FW_RX_ANC] = "Rx ANC",
225 [WM_ADSP_FW_CTRL] = "Voice Ctrl",
226 [WM_ADSP_FW_ASR] = "ASR Assist",
227 [WM_ADSP_FW_TRACE] = "Dbg Trace",
228 [WM_ADSP_FW_SPK_PROT] = "Protection",
229 [WM_ADSP_FW_MISC] = "Misc",
232 struct wm_adsp_system_config_xm_hdr {
238 __be32 dma_buffer_size;
241 __be32 build_job_name[3];
242 __be32 build_job_number;
245 struct wm_adsp_alg_xm_struct {
251 __be32 high_water_mark;
252 __be32 low_water_mark;
253 __be64 smoothed_power;
256 struct wm_adsp_buffer {
257 __be32 X_buf_base; /* XM base addr of first X area */
258 __be32 X_buf_size; /* Size of 1st X area in words */
259 __be32 X_buf_base2; /* XM base addr of 2nd X area */
260 __be32 X_buf_brk; /* Total X size in words */
261 __be32 Y_buf_base; /* YM base addr of Y area */
262 __be32 wrap; /* Total size X and Y in words */
263 __be32 high_water_mark; /* Point at which IRQ is asserted */
264 __be32 irq_count; /* bits 1-31 count IRQ assertions */
265 __be32 irq_ack; /* acked IRQ count, bit 0 enables IRQ */
266 __be32 next_write_index; /* word index of next write */
267 __be32 next_read_index; /* word index of next read */
268 __be32 error; /* error if any */
269 __be32 oldest_block_index; /* word index of oldest surviving */
270 __be32 requested_rewind; /* how many blocks rewind was done */
271 __be32 reserved_space; /* internal */
272 __be32 min_free; /* min free space since stream start */
273 __be32 blocks_written[2]; /* total blocks written (64 bit) */
274 __be32 words_written[2]; /* total words written (64 bit) */
277 struct wm_adsp_compr_buf {
280 struct wm_adsp_buffer_region *regions;
289 struct wm_adsp_compr {
291 struct wm_adsp_compr_buf *buf;
293 struct snd_compr_stream *stream;
294 struct snd_compressed_buffer size;
296 unsigned int copied_total;
299 #define WM_ADSP_DATA_WORD_SIZE 3
301 #define WM_ADSP_MIN_FRAGMENTS 1
302 #define WM_ADSP_MAX_FRAGMENTS 256
303 #define WM_ADSP_MIN_FRAGMENT_SIZE (64 * WM_ADSP_DATA_WORD_SIZE)
304 #define WM_ADSP_MAX_FRAGMENT_SIZE (4096 * WM_ADSP_DATA_WORD_SIZE)
306 #define WM_ADSP_ALG_XM_STRUCT_MAGIC 0x49aec7
308 #define HOST_BUFFER_FIELD(field) \
309 (offsetof(struct wm_adsp_buffer, field) / sizeof(__be32))
311 #define ALG_XM_FIELD(field) \
312 (offsetof(struct wm_adsp_alg_xm_struct, field) / sizeof(__be32))
314 static int wm_adsp_buffer_init(struct wm_adsp *dsp);
315 static int wm_adsp_buffer_free(struct wm_adsp *dsp);
317 struct wm_adsp_buffer_region {
319 unsigned int cumulative_size;
320 unsigned int mem_type;
321 unsigned int base_addr;
324 struct wm_adsp_buffer_region_def {
325 unsigned int mem_type;
326 unsigned int base_offset;
327 unsigned int size_offset;
330 static struct wm_adsp_buffer_region_def ez2control_regions[] = {
332 .mem_type = WMFW_ADSP2_XM,
333 .base_offset = HOST_BUFFER_FIELD(X_buf_base),
334 .size_offset = HOST_BUFFER_FIELD(X_buf_size),
337 .mem_type = WMFW_ADSP2_XM,
338 .base_offset = HOST_BUFFER_FIELD(X_buf_base2),
339 .size_offset = HOST_BUFFER_FIELD(X_buf_brk),
342 .mem_type = WMFW_ADSP2_YM,
343 .base_offset = HOST_BUFFER_FIELD(Y_buf_base),
344 .size_offset = HOST_BUFFER_FIELD(wrap),
348 struct wm_adsp_fw_caps {
350 struct snd_codec_desc desc;
352 struct wm_adsp_buffer_region_def *region_defs;
355 static const struct wm_adsp_fw_caps ez2control_caps[] = {
357 .id = SND_AUDIOCODEC_BESPOKE,
360 .sample_rates = { 16000 },
361 .num_sample_rates = 1,
362 .formats = SNDRV_PCM_FMTBIT_S16_LE,
364 .num_regions = ARRAY_SIZE(ez2control_regions),
365 .region_defs = ez2control_regions,
369 static const struct {
373 const struct wm_adsp_fw_caps *caps;
374 } wm_adsp_fw[WM_ADSP_NUM_FW] = {
375 [WM_ADSP_FW_MBC_VSS] = { .file = "mbc-vss" },
376 [WM_ADSP_FW_HIFI] = { .file = "hifi" },
377 [WM_ADSP_FW_TX] = { .file = "tx" },
378 [WM_ADSP_FW_TX_SPK] = { .file = "tx-spk" },
379 [WM_ADSP_FW_RX] = { .file = "rx" },
380 [WM_ADSP_FW_RX_ANC] = { .file = "rx-anc" },
381 [WM_ADSP_FW_CTRL] = {
383 .compr_direction = SND_COMPRESS_CAPTURE,
384 .num_caps = ARRAY_SIZE(ez2control_caps),
385 .caps = ez2control_caps,
387 [WM_ADSP_FW_ASR] = { .file = "asr" },
388 [WM_ADSP_FW_TRACE] = { .file = "trace" },
389 [WM_ADSP_FW_SPK_PROT] = { .file = "spk-prot" },
390 [WM_ADSP_FW_MISC] = { .file = "misc" },
393 struct wm_coeff_ctl_ops {
394 int (*xget)(struct snd_kcontrol *kcontrol,
395 struct snd_ctl_elem_value *ucontrol);
396 int (*xput)(struct snd_kcontrol *kcontrol,
397 struct snd_ctl_elem_value *ucontrol);
398 int (*xinfo)(struct snd_kcontrol *kcontrol,
399 struct snd_ctl_elem_info *uinfo);
402 struct wm_coeff_ctl {
405 struct wm_adsp_alg_region alg_region;
406 struct wm_coeff_ctl_ops ops;
408 unsigned int enabled:1;
409 struct list_head list;
414 struct snd_kcontrol *kcontrol;
418 #ifdef CONFIG_DEBUG_FS
419 static void wm_adsp_debugfs_save_wmfwname(struct wm_adsp *dsp, const char *s)
421 char *tmp = kasprintf(GFP_KERNEL, "%s\n", s);
423 kfree(dsp->wmfw_file_name);
424 dsp->wmfw_file_name = tmp;
427 static void wm_adsp_debugfs_save_binname(struct wm_adsp *dsp, const char *s)
429 char *tmp = kasprintf(GFP_KERNEL, "%s\n", s);
431 kfree(dsp->bin_file_name);
432 dsp->bin_file_name = tmp;
435 static void wm_adsp_debugfs_clear(struct wm_adsp *dsp)
437 kfree(dsp->wmfw_file_name);
438 kfree(dsp->bin_file_name);
439 dsp->wmfw_file_name = NULL;
440 dsp->bin_file_name = NULL;
443 static ssize_t wm_adsp_debugfs_wmfw_read(struct file *file,
444 char __user *user_buf,
445 size_t count, loff_t *ppos)
447 struct wm_adsp *dsp = file->private_data;
450 mutex_lock(&dsp->pwr_lock);
452 if (!dsp->wmfw_file_name || !dsp->running)
455 ret = simple_read_from_buffer(user_buf, count, ppos,
457 strlen(dsp->wmfw_file_name));
459 mutex_unlock(&dsp->pwr_lock);
463 static ssize_t wm_adsp_debugfs_bin_read(struct file *file,
464 char __user *user_buf,
465 size_t count, loff_t *ppos)
467 struct wm_adsp *dsp = file->private_data;
470 mutex_lock(&dsp->pwr_lock);
472 if (!dsp->bin_file_name || !dsp->running)
475 ret = simple_read_from_buffer(user_buf, count, ppos,
477 strlen(dsp->bin_file_name));
479 mutex_unlock(&dsp->pwr_lock);
483 static const struct {
485 const struct file_operations fops;
486 } wm_adsp_debugfs_fops[] = {
488 .name = "wmfw_file_name",
491 .read = wm_adsp_debugfs_wmfw_read,
495 .name = "bin_file_name",
498 .read = wm_adsp_debugfs_bin_read,
503 static void wm_adsp2_init_debugfs(struct wm_adsp *dsp,
504 struct snd_soc_codec *codec)
506 struct dentry *root = NULL;
510 if (!codec->component.debugfs_root) {
511 adsp_err(dsp, "No codec debugfs root\n");
515 root_name = kmalloc(PAGE_SIZE, GFP_KERNEL);
519 snprintf(root_name, PAGE_SIZE, "dsp%d", dsp->num);
520 root = debugfs_create_dir(root_name, codec->component.debugfs_root);
526 if (!debugfs_create_bool("running", S_IRUGO, root, &dsp->running))
529 if (!debugfs_create_x32("fw_id", S_IRUGO, root, &dsp->fw_id))
532 if (!debugfs_create_x32("fw_version", S_IRUGO, root,
533 &dsp->fw_id_version))
536 for (i = 0; i < ARRAY_SIZE(wm_adsp_debugfs_fops); ++i) {
537 if (!debugfs_create_file(wm_adsp_debugfs_fops[i].name,
539 &wm_adsp_debugfs_fops[i].fops))
543 dsp->debugfs_root = root;
547 debugfs_remove_recursive(root);
548 adsp_err(dsp, "Failed to create debugfs\n");
551 static void wm_adsp2_cleanup_debugfs(struct wm_adsp *dsp)
553 wm_adsp_debugfs_clear(dsp);
554 debugfs_remove_recursive(dsp->debugfs_root);
557 static inline void wm_adsp2_init_debugfs(struct wm_adsp *dsp,
558 struct snd_soc_codec *codec)
562 static inline void wm_adsp2_cleanup_debugfs(struct wm_adsp *dsp)
566 static inline void wm_adsp_debugfs_save_wmfwname(struct wm_adsp *dsp,
571 static inline void wm_adsp_debugfs_save_binname(struct wm_adsp *dsp,
576 static inline void wm_adsp_debugfs_clear(struct wm_adsp *dsp)
581 static int wm_adsp_fw_get(struct snd_kcontrol *kcontrol,
582 struct snd_ctl_elem_value *ucontrol)
584 struct snd_soc_codec *codec = snd_soc_kcontrol_codec(kcontrol);
585 struct soc_enum *e = (struct soc_enum *)kcontrol->private_value;
586 struct wm_adsp *dsp = snd_soc_codec_get_drvdata(codec);
588 ucontrol->value.integer.value[0] = dsp[e->shift_l].fw;
593 static int wm_adsp_fw_put(struct snd_kcontrol *kcontrol,
594 struct snd_ctl_elem_value *ucontrol)
596 struct snd_soc_codec *codec = snd_soc_kcontrol_codec(kcontrol);
597 struct soc_enum *e = (struct soc_enum *)kcontrol->private_value;
598 struct wm_adsp *dsp = snd_soc_codec_get_drvdata(codec);
601 if (ucontrol->value.integer.value[0] == dsp[e->shift_l].fw)
604 if (ucontrol->value.integer.value[0] >= WM_ADSP_NUM_FW)
607 mutex_lock(&dsp[e->shift_l].pwr_lock);
609 if (dsp[e->shift_l].running || dsp[e->shift_l].compr)
612 dsp[e->shift_l].fw = ucontrol->value.integer.value[0];
614 mutex_unlock(&dsp[e->shift_l].pwr_lock);
619 static const struct soc_enum wm_adsp_fw_enum[] = {
620 SOC_ENUM_SINGLE(0, 0, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
621 SOC_ENUM_SINGLE(0, 1, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
622 SOC_ENUM_SINGLE(0, 2, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
623 SOC_ENUM_SINGLE(0, 3, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
626 const struct snd_kcontrol_new wm_adsp_fw_controls[] = {
627 SOC_ENUM_EXT("DSP1 Firmware", wm_adsp_fw_enum[0],
628 wm_adsp_fw_get, wm_adsp_fw_put),
629 SOC_ENUM_EXT("DSP2 Firmware", wm_adsp_fw_enum[1],
630 wm_adsp_fw_get, wm_adsp_fw_put),
631 SOC_ENUM_EXT("DSP3 Firmware", wm_adsp_fw_enum[2],
632 wm_adsp_fw_get, wm_adsp_fw_put),
633 SOC_ENUM_EXT("DSP4 Firmware", wm_adsp_fw_enum[3],
634 wm_adsp_fw_get, wm_adsp_fw_put),
636 EXPORT_SYMBOL_GPL(wm_adsp_fw_controls);
638 static struct wm_adsp_region const *wm_adsp_find_region(struct wm_adsp *dsp,
643 for (i = 0; i < dsp->num_mems; i++)
644 if (dsp->mem[i].type == type)
650 static unsigned int wm_adsp_region_to_reg(struct wm_adsp_region const *mem,
657 return mem->base + (offset * 3);
659 return mem->base + (offset * 2);
661 return mem->base + (offset * 2);
663 return mem->base + (offset * 2);
665 return mem->base + (offset * 2);
667 WARN(1, "Unknown memory region type");
672 static void wm_adsp2_show_fw_status(struct wm_adsp *dsp)
677 ret = regmap_raw_read(dsp->regmap, dsp->base + ADSP2_SCRATCH0,
678 scratch, sizeof(scratch));
680 adsp_err(dsp, "Failed to read SCRATCH regs: %d\n", ret);
684 adsp_dbg(dsp, "FW SCRATCH 0:0x%x 1:0x%x 2:0x%x 3:0x%x\n",
685 be16_to_cpu(scratch[0]),
686 be16_to_cpu(scratch[1]),
687 be16_to_cpu(scratch[2]),
688 be16_to_cpu(scratch[3]));
691 static int wm_coeff_info(struct snd_kcontrol *kctl,
692 struct snd_ctl_elem_info *uinfo)
694 struct wm_coeff_ctl *ctl = (struct wm_coeff_ctl *)kctl->private_value;
696 uinfo->type = SNDRV_CTL_ELEM_TYPE_BYTES;
697 uinfo->count = ctl->len;
701 static int wm_coeff_write_control(struct wm_coeff_ctl *ctl,
702 const void *buf, size_t len)
704 struct wm_adsp_alg_region *alg_region = &ctl->alg_region;
705 const struct wm_adsp_region *mem;
706 struct wm_adsp *dsp = ctl->dsp;
711 mem = wm_adsp_find_region(dsp, alg_region->type);
713 adsp_err(dsp, "No base for region %x\n",
718 reg = ctl->alg_region.base + ctl->offset;
719 reg = wm_adsp_region_to_reg(mem, reg);
721 scratch = kmemdup(buf, ctl->len, GFP_KERNEL | GFP_DMA);
725 ret = regmap_raw_write(dsp->regmap, reg, scratch,
728 adsp_err(dsp, "Failed to write %zu bytes to %x: %d\n",
733 adsp_dbg(dsp, "Wrote %zu bytes to %x\n", ctl->len, reg);
740 static int wm_coeff_put(struct snd_kcontrol *kctl,
741 struct snd_ctl_elem_value *ucontrol)
743 struct wm_coeff_ctl *ctl = (struct wm_coeff_ctl *)kctl->private_value;
744 char *p = ucontrol->value.bytes.data;
747 mutex_lock(&ctl->dsp->pwr_lock);
749 memcpy(ctl->cache, p, ctl->len);
753 ret = wm_coeff_write_control(ctl, p, ctl->len);
755 mutex_unlock(&ctl->dsp->pwr_lock);
760 static int wm_coeff_read_control(struct wm_coeff_ctl *ctl,
761 void *buf, size_t len)
763 struct wm_adsp_alg_region *alg_region = &ctl->alg_region;
764 const struct wm_adsp_region *mem;
765 struct wm_adsp *dsp = ctl->dsp;
770 mem = wm_adsp_find_region(dsp, alg_region->type);
772 adsp_err(dsp, "No base for region %x\n",
777 reg = ctl->alg_region.base + ctl->offset;
778 reg = wm_adsp_region_to_reg(mem, reg);
780 scratch = kmalloc(ctl->len, GFP_KERNEL | GFP_DMA);
784 ret = regmap_raw_read(dsp->regmap, reg, scratch, ctl->len);
786 adsp_err(dsp, "Failed to read %zu bytes from %x: %d\n",
791 adsp_dbg(dsp, "Read %zu bytes from %x\n", ctl->len, reg);
793 memcpy(buf, scratch, ctl->len);
799 static int wm_coeff_get(struct snd_kcontrol *kctl,
800 struct snd_ctl_elem_value *ucontrol)
802 struct wm_coeff_ctl *ctl = (struct wm_coeff_ctl *)kctl->private_value;
803 char *p = ucontrol->value.bytes.data;
806 mutex_lock(&ctl->dsp->pwr_lock);
808 if (ctl->flags & WMFW_CTL_FLAG_VOLATILE) {
810 ret = wm_coeff_read_control(ctl, p, ctl->len);
814 if (!ctl->flags && ctl->enabled)
815 ret = wm_coeff_read_control(ctl, ctl->cache, ctl->len);
817 memcpy(p, ctl->cache, ctl->len);
820 mutex_unlock(&ctl->dsp->pwr_lock);
825 struct wmfw_ctl_work {
827 struct wm_coeff_ctl *ctl;
828 struct work_struct work;
831 static int wmfw_add_ctl(struct wm_adsp *dsp, struct wm_coeff_ctl *ctl)
833 struct snd_kcontrol_new *kcontrol;
836 if (!ctl || !ctl->name)
839 kcontrol = kzalloc(sizeof(*kcontrol), GFP_KERNEL);
842 kcontrol->iface = SNDRV_CTL_ELEM_IFACE_MIXER;
844 kcontrol->name = ctl->name;
845 kcontrol->info = wm_coeff_info;
846 kcontrol->get = wm_coeff_get;
847 kcontrol->put = wm_coeff_put;
848 kcontrol->private_value = (unsigned long)ctl;
851 if (ctl->flags & WMFW_CTL_FLAG_WRITEABLE)
852 kcontrol->access |= SNDRV_CTL_ELEM_ACCESS_WRITE;
853 if (ctl->flags & WMFW_CTL_FLAG_READABLE)
854 kcontrol->access |= SNDRV_CTL_ELEM_ACCESS_READ;
855 if (ctl->flags & WMFW_CTL_FLAG_VOLATILE)
856 kcontrol->access |= SNDRV_CTL_ELEM_ACCESS_VOLATILE;
859 ret = snd_soc_add_card_controls(dsp->card,
866 ctl->kcontrol = snd_soc_card_get_kcontrol(dsp->card,
876 static int wm_coeff_init_control_caches(struct wm_adsp *dsp)
878 struct wm_coeff_ctl *ctl;
881 list_for_each_entry(ctl, &dsp->ctl_list, list) {
882 if (!ctl->enabled || ctl->set)
884 if (ctl->flags & WMFW_CTL_FLAG_VOLATILE)
887 ret = wm_coeff_read_control(ctl,
897 static int wm_coeff_sync_controls(struct wm_adsp *dsp)
899 struct wm_coeff_ctl *ctl;
902 list_for_each_entry(ctl, &dsp->ctl_list, list) {
905 if (ctl->set && !(ctl->flags & WMFW_CTL_FLAG_VOLATILE)) {
906 ret = wm_coeff_write_control(ctl,
917 static void wm_adsp_ctl_work(struct work_struct *work)
919 struct wmfw_ctl_work *ctl_work = container_of(work,
920 struct wmfw_ctl_work,
923 wmfw_add_ctl(ctl_work->dsp, ctl_work->ctl);
927 static int wm_adsp_create_control(struct wm_adsp *dsp,
928 const struct wm_adsp_alg_region *alg_region,
929 unsigned int offset, unsigned int len,
930 const char *subname, unsigned int subname_len,
933 struct wm_coeff_ctl *ctl;
934 struct wmfw_ctl_work *ctl_work;
935 char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
939 if (flags & WMFW_CTL_FLAG_SYS)
942 switch (alg_region->type) {
959 adsp_err(dsp, "Unknown region type: %d\n", alg_region->type);
963 switch (dsp->fw_ver) {
966 snprintf(name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN, "DSP%d %s %x",
967 dsp->num, region_name, alg_region->alg);
970 ret = snprintf(name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN,
971 "DSP%d%c %.12s %x", dsp->num, *region_name,
972 wm_adsp_fw_text[dsp->fw], alg_region->alg);
974 /* Truncate the subname from the start if it is too long */
976 int avail = SNDRV_CTL_ELEM_ID_NAME_MAXLEN - ret - 2;
979 if (subname_len > avail)
980 skip = subname_len - avail;
983 SNDRV_CTL_ELEM_ID_NAME_MAXLEN - ret, " %.*s",
984 subname_len - skip, subname + skip);
989 list_for_each_entry(ctl, &dsp->ctl_list, list) {
990 if (!strcmp(ctl->name, name)) {
997 ctl = kzalloc(sizeof(*ctl), GFP_KERNEL);
1000 ctl->fw_name = wm_adsp_fw_text[dsp->fw];
1001 ctl->alg_region = *alg_region;
1002 ctl->name = kmemdup(name, strlen(name) + 1, GFP_KERNEL);
1009 ctl->ops.xget = wm_coeff_get;
1010 ctl->ops.xput = wm_coeff_put;
1014 ctl->offset = offset;
1016 adsp_warn(dsp, "Truncating control %s from %d\n",
1021 ctl->cache = kzalloc(ctl->len, GFP_KERNEL);
1027 list_add(&ctl->list, &dsp->ctl_list);
1029 ctl_work = kzalloc(sizeof(*ctl_work), GFP_KERNEL);
1035 ctl_work->dsp = dsp;
1036 ctl_work->ctl = ctl;
1037 INIT_WORK(&ctl_work->work, wm_adsp_ctl_work);
1038 schedule_work(&ctl_work->work);
1052 struct wm_coeff_parsed_alg {
1059 struct wm_coeff_parsed_coeff {
1069 static int wm_coeff_parse_string(int bytes, const u8 **pos, const u8 **str)
1078 length = le16_to_cpu(*((__le16 *)*pos));
1085 *str = *pos + bytes;
1087 *pos += ((length + bytes) + 3) & ~0x03;
1092 static int wm_coeff_parse_int(int bytes, const u8 **pos)
1098 val = le16_to_cpu(*((__le16 *)*pos));
1101 val = le32_to_cpu(*((__le32 *)*pos));
1112 static inline void wm_coeff_parse_alg(struct wm_adsp *dsp, const u8 **data,
1113 struct wm_coeff_parsed_alg *blk)
1115 const struct wmfw_adsp_alg_data *raw;
1117 switch (dsp->fw_ver) {
1120 raw = (const struct wmfw_adsp_alg_data *)*data;
1123 blk->id = le32_to_cpu(raw->id);
1124 blk->name = raw->name;
1125 blk->name_len = strlen(raw->name);
1126 blk->ncoeff = le32_to_cpu(raw->ncoeff);
1129 blk->id = wm_coeff_parse_int(sizeof(raw->id), data);
1130 blk->name_len = wm_coeff_parse_string(sizeof(u8), data,
1132 wm_coeff_parse_string(sizeof(u16), data, NULL);
1133 blk->ncoeff = wm_coeff_parse_int(sizeof(raw->ncoeff), data);
1137 adsp_dbg(dsp, "Algorithm ID: %#x\n", blk->id);
1138 adsp_dbg(dsp, "Algorithm name: %.*s\n", blk->name_len, blk->name);
1139 adsp_dbg(dsp, "# of coefficient descriptors: %#x\n", blk->ncoeff);
1142 static inline void wm_coeff_parse_coeff(struct wm_adsp *dsp, const u8 **data,
1143 struct wm_coeff_parsed_coeff *blk)
1145 const struct wmfw_adsp_coeff_data *raw;
1149 switch (dsp->fw_ver) {
1152 raw = (const struct wmfw_adsp_coeff_data *)*data;
1153 *data = *data + sizeof(raw->hdr) + le32_to_cpu(raw->hdr.size);
1155 blk->offset = le16_to_cpu(raw->hdr.offset);
1156 blk->mem_type = le16_to_cpu(raw->hdr.type);
1157 blk->name = raw->name;
1158 blk->name_len = strlen(raw->name);
1159 blk->ctl_type = le16_to_cpu(raw->ctl_type);
1160 blk->flags = le16_to_cpu(raw->flags);
1161 blk->len = le32_to_cpu(raw->len);
1165 blk->offset = wm_coeff_parse_int(sizeof(raw->hdr.offset), &tmp);
1166 blk->mem_type = wm_coeff_parse_int(sizeof(raw->hdr.type), &tmp);
1167 length = wm_coeff_parse_int(sizeof(raw->hdr.size), &tmp);
1168 blk->name_len = wm_coeff_parse_string(sizeof(u8), &tmp,
1170 wm_coeff_parse_string(sizeof(u8), &tmp, NULL);
1171 wm_coeff_parse_string(sizeof(u16), &tmp, NULL);
1172 blk->ctl_type = wm_coeff_parse_int(sizeof(raw->ctl_type), &tmp);
1173 blk->flags = wm_coeff_parse_int(sizeof(raw->flags), &tmp);
1174 blk->len = wm_coeff_parse_int(sizeof(raw->len), &tmp);
1176 *data = *data + sizeof(raw->hdr) + length;
1180 adsp_dbg(dsp, "\tCoefficient type: %#x\n", blk->mem_type);
1181 adsp_dbg(dsp, "\tCoefficient offset: %#x\n", blk->offset);
1182 adsp_dbg(dsp, "\tCoefficient name: %.*s\n", blk->name_len, blk->name);
1183 adsp_dbg(dsp, "\tCoefficient flags: %#x\n", blk->flags);
1184 adsp_dbg(dsp, "\tALSA control type: %#x\n", blk->ctl_type);
1185 adsp_dbg(dsp, "\tALSA control len: %#x\n", blk->len);
1188 static int wm_adsp_parse_coeff(struct wm_adsp *dsp,
1189 const struct wmfw_region *region)
1191 struct wm_adsp_alg_region alg_region = {};
1192 struct wm_coeff_parsed_alg alg_blk;
1193 struct wm_coeff_parsed_coeff coeff_blk;
1194 const u8 *data = region->data;
1197 wm_coeff_parse_alg(dsp, &data, &alg_blk);
1198 for (i = 0; i < alg_blk.ncoeff; i++) {
1199 wm_coeff_parse_coeff(dsp, &data, &coeff_blk);
1201 switch (coeff_blk.ctl_type) {
1202 case SNDRV_CTL_ELEM_TYPE_BYTES:
1205 adsp_err(dsp, "Unknown control type: %d\n",
1206 coeff_blk.ctl_type);
1210 alg_region.type = coeff_blk.mem_type;
1211 alg_region.alg = alg_blk.id;
1213 ret = wm_adsp_create_control(dsp, &alg_region,
1220 adsp_err(dsp, "Failed to create control: %.*s, %d\n",
1221 coeff_blk.name_len, coeff_blk.name, ret);
1227 static int wm_adsp_load(struct wm_adsp *dsp)
1229 LIST_HEAD(buf_list);
1230 const struct firmware *firmware;
1231 struct regmap *regmap = dsp->regmap;
1232 unsigned int pos = 0;
1233 const struct wmfw_header *header;
1234 const struct wmfw_adsp1_sizes *adsp1_sizes;
1235 const struct wmfw_adsp2_sizes *adsp2_sizes;
1236 const struct wmfw_footer *footer;
1237 const struct wmfw_region *region;
1238 const struct wm_adsp_region *mem;
1239 const char *region_name;
1241 struct wm_adsp_buf *buf;
1244 int ret, offset, type, sizes;
1246 file = kzalloc(PAGE_SIZE, GFP_KERNEL);
1250 snprintf(file, PAGE_SIZE, "%s-dsp%d-%s.wmfw", dsp->part, dsp->num,
1251 wm_adsp_fw[dsp->fw].file);
1252 file[PAGE_SIZE - 1] = '\0';
1254 ret = request_firmware(&firmware, file, dsp->dev);
1256 adsp_err(dsp, "Failed to request '%s'\n", file);
1261 pos = sizeof(*header) + sizeof(*adsp1_sizes) + sizeof(*footer);
1262 if (pos >= firmware->size) {
1263 adsp_err(dsp, "%s: file too short, %zu bytes\n",
1264 file, firmware->size);
1268 header = (void *)&firmware->data[0];
1270 if (memcmp(&header->magic[0], "WMFW", 4) != 0) {
1271 adsp_err(dsp, "%s: invalid magic\n", file);
1275 switch (header->ver) {
1277 adsp_warn(dsp, "%s: Depreciated file format %d\n",
1284 adsp_err(dsp, "%s: unknown file format %d\n",
1289 adsp_info(dsp, "Firmware version: %d\n", header->ver);
1290 dsp->fw_ver = header->ver;
1292 if (header->core != dsp->type) {
1293 adsp_err(dsp, "%s: invalid core %d != %d\n",
1294 file, header->core, dsp->type);
1298 switch (dsp->type) {
1300 pos = sizeof(*header) + sizeof(*adsp1_sizes) + sizeof(*footer);
1301 adsp1_sizes = (void *)&(header[1]);
1302 footer = (void *)&(adsp1_sizes[1]);
1303 sizes = sizeof(*adsp1_sizes);
1305 adsp_dbg(dsp, "%s: %d DM, %d PM, %d ZM\n",
1306 file, le32_to_cpu(adsp1_sizes->dm),
1307 le32_to_cpu(adsp1_sizes->pm),
1308 le32_to_cpu(adsp1_sizes->zm));
1312 pos = sizeof(*header) + sizeof(*adsp2_sizes) + sizeof(*footer);
1313 adsp2_sizes = (void *)&(header[1]);
1314 footer = (void *)&(adsp2_sizes[1]);
1315 sizes = sizeof(*adsp2_sizes);
1317 adsp_dbg(dsp, "%s: %d XM, %d YM %d PM, %d ZM\n",
1318 file, le32_to_cpu(adsp2_sizes->xm),
1319 le32_to_cpu(adsp2_sizes->ym),
1320 le32_to_cpu(adsp2_sizes->pm),
1321 le32_to_cpu(adsp2_sizes->zm));
1325 WARN(1, "Unknown DSP type");
1329 if (le32_to_cpu(header->len) != sizeof(*header) +
1330 sizes + sizeof(*footer)) {
1331 adsp_err(dsp, "%s: unexpected header length %d\n",
1332 file, le32_to_cpu(header->len));
1336 adsp_dbg(dsp, "%s: timestamp %llu\n", file,
1337 le64_to_cpu(footer->timestamp));
1339 while (pos < firmware->size &&
1340 pos - firmware->size > sizeof(*region)) {
1341 region = (void *)&(firmware->data[pos]);
1342 region_name = "Unknown";
1345 offset = le32_to_cpu(region->offset) & 0xffffff;
1346 type = be32_to_cpu(region->type) & 0xff;
1347 mem = wm_adsp_find_region(dsp, type);
1350 case WMFW_NAME_TEXT:
1351 region_name = "Firmware name";
1352 text = kzalloc(le32_to_cpu(region->len) + 1,
1355 case WMFW_ALGORITHM_DATA:
1356 region_name = "Algorithm";
1357 ret = wm_adsp_parse_coeff(dsp, region);
1361 case WMFW_INFO_TEXT:
1362 region_name = "Information";
1363 text = kzalloc(le32_to_cpu(region->len) + 1,
1367 region_name = "Absolute";
1372 reg = wm_adsp_region_to_reg(mem, offset);
1376 reg = wm_adsp_region_to_reg(mem, offset);
1380 reg = wm_adsp_region_to_reg(mem, offset);
1384 reg = wm_adsp_region_to_reg(mem, offset);
1388 reg = wm_adsp_region_to_reg(mem, offset);
1392 "%s.%d: Unknown region type %x at %d(%x)\n",
1393 file, regions, type, pos, pos);
1397 adsp_dbg(dsp, "%s.%d: %d bytes at %d in %s\n", file,
1398 regions, le32_to_cpu(region->len), offset,
1402 memcpy(text, region->data, le32_to_cpu(region->len));
1403 adsp_info(dsp, "%s: %s\n", file, text);
1408 buf = wm_adsp_buf_alloc(region->data,
1409 le32_to_cpu(region->len),
1412 adsp_err(dsp, "Out of memory\n");
1417 ret = regmap_raw_write_async(regmap, reg, buf->buf,
1418 le32_to_cpu(region->len));
1421 "%s.%d: Failed to write %d bytes at %d in %s: %d\n",
1423 le32_to_cpu(region->len), offset,
1429 pos += le32_to_cpu(region->len) + sizeof(*region);
1433 ret = regmap_async_complete(regmap);
1435 adsp_err(dsp, "Failed to complete async write: %d\n", ret);
1439 if (pos > firmware->size)
1440 adsp_warn(dsp, "%s.%d: %zu bytes at end of file\n",
1441 file, regions, pos - firmware->size);
1443 wm_adsp_debugfs_save_wmfwname(dsp, file);
1446 regmap_async_complete(regmap);
1447 wm_adsp_buf_free(&buf_list);
1448 release_firmware(firmware);
1455 static void wm_adsp_ctl_fixup_base(struct wm_adsp *dsp,
1456 const struct wm_adsp_alg_region *alg_region)
1458 struct wm_coeff_ctl *ctl;
1460 list_for_each_entry(ctl, &dsp->ctl_list, list) {
1461 if (ctl->fw_name == wm_adsp_fw_text[dsp->fw] &&
1462 alg_region->alg == ctl->alg_region.alg &&
1463 alg_region->type == ctl->alg_region.type) {
1464 ctl->alg_region.base = alg_region->base;
1469 static void *wm_adsp_read_algs(struct wm_adsp *dsp, size_t n_algs,
1470 unsigned int pos, unsigned int len)
1477 adsp_err(dsp, "No algorithms\n");
1478 return ERR_PTR(-EINVAL);
1481 if (n_algs > 1024) {
1482 adsp_err(dsp, "Algorithm count %zx excessive\n", n_algs);
1483 return ERR_PTR(-EINVAL);
1486 /* Read the terminator first to validate the length */
1487 ret = regmap_raw_read(dsp->regmap, pos + len, &val, sizeof(val));
1489 adsp_err(dsp, "Failed to read algorithm list end: %d\n",
1491 return ERR_PTR(ret);
1494 if (be32_to_cpu(val) != 0xbedead)
1495 adsp_warn(dsp, "Algorithm list end %x 0x%x != 0xbeadead\n",
1496 pos + len, be32_to_cpu(val));
1498 alg = kzalloc(len * 2, GFP_KERNEL | GFP_DMA);
1500 return ERR_PTR(-ENOMEM);
1502 ret = regmap_raw_read(dsp->regmap, pos, alg, len * 2);
1504 adsp_err(dsp, "Failed to read algorithm list: %d\n",
1507 return ERR_PTR(ret);
1513 static struct wm_adsp_alg_region *
1514 wm_adsp_find_alg_region(struct wm_adsp *dsp, int type, unsigned int id)
1516 struct wm_adsp_alg_region *alg_region;
1518 list_for_each_entry(alg_region, &dsp->alg_regions, list) {
1519 if (id == alg_region->alg && type == alg_region->type)
1526 static struct wm_adsp_alg_region *wm_adsp_create_region(struct wm_adsp *dsp,
1527 int type, __be32 id,
1530 struct wm_adsp_alg_region *alg_region;
1532 alg_region = kzalloc(sizeof(*alg_region), GFP_KERNEL);
1534 return ERR_PTR(-ENOMEM);
1536 alg_region->type = type;
1537 alg_region->alg = be32_to_cpu(id);
1538 alg_region->base = be32_to_cpu(base);
1540 list_add_tail(&alg_region->list, &dsp->alg_regions);
1542 if (dsp->fw_ver > 0)
1543 wm_adsp_ctl_fixup_base(dsp, alg_region);
1548 static int wm_adsp1_setup_algs(struct wm_adsp *dsp)
1550 struct wmfw_adsp1_id_hdr adsp1_id;
1551 struct wmfw_adsp1_alg_hdr *adsp1_alg;
1552 struct wm_adsp_alg_region *alg_region;
1553 const struct wm_adsp_region *mem;
1554 unsigned int pos, len;
1558 mem = wm_adsp_find_region(dsp, WMFW_ADSP1_DM);
1562 ret = regmap_raw_read(dsp->regmap, mem->base, &adsp1_id,
1565 adsp_err(dsp, "Failed to read algorithm info: %d\n",
1570 n_algs = be32_to_cpu(adsp1_id.n_algs);
1571 dsp->fw_id = be32_to_cpu(adsp1_id.fw.id);
1572 adsp_info(dsp, "Firmware: %x v%d.%d.%d, %zu algorithms\n",
1574 (be32_to_cpu(adsp1_id.fw.ver) & 0xff0000) >> 16,
1575 (be32_to_cpu(adsp1_id.fw.ver) & 0xff00) >> 8,
1576 be32_to_cpu(adsp1_id.fw.ver) & 0xff,
1579 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP1_ZM,
1580 adsp1_id.fw.id, adsp1_id.zm);
1581 if (IS_ERR(alg_region))
1582 return PTR_ERR(alg_region);
1584 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP1_DM,
1585 adsp1_id.fw.id, adsp1_id.dm);
1586 if (IS_ERR(alg_region))
1587 return PTR_ERR(alg_region);
1589 pos = sizeof(adsp1_id) / 2;
1590 len = (sizeof(*adsp1_alg) * n_algs) / 2;
1592 adsp1_alg = wm_adsp_read_algs(dsp, n_algs, mem->base + pos, len);
1593 if (IS_ERR(adsp1_alg))
1594 return PTR_ERR(adsp1_alg);
1596 for (i = 0; i < n_algs; i++) {
1597 adsp_info(dsp, "%d: ID %x v%d.%d.%d DM@%x ZM@%x\n",
1598 i, be32_to_cpu(adsp1_alg[i].alg.id),
1599 (be32_to_cpu(adsp1_alg[i].alg.ver) & 0xff0000) >> 16,
1600 (be32_to_cpu(adsp1_alg[i].alg.ver) & 0xff00) >> 8,
1601 be32_to_cpu(adsp1_alg[i].alg.ver) & 0xff,
1602 be32_to_cpu(adsp1_alg[i].dm),
1603 be32_to_cpu(adsp1_alg[i].zm));
1605 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP1_DM,
1606 adsp1_alg[i].alg.id,
1608 if (IS_ERR(alg_region)) {
1609 ret = PTR_ERR(alg_region);
1612 if (dsp->fw_ver == 0) {
1613 if (i + 1 < n_algs) {
1614 len = be32_to_cpu(adsp1_alg[i + 1].dm);
1615 len -= be32_to_cpu(adsp1_alg[i].dm);
1617 wm_adsp_create_control(dsp, alg_region, 0,
1620 adsp_warn(dsp, "Missing length info for region DM with ID %x\n",
1621 be32_to_cpu(adsp1_alg[i].alg.id));
1625 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP1_ZM,
1626 adsp1_alg[i].alg.id,
1628 if (IS_ERR(alg_region)) {
1629 ret = PTR_ERR(alg_region);
1632 if (dsp->fw_ver == 0) {
1633 if (i + 1 < n_algs) {
1634 len = be32_to_cpu(adsp1_alg[i + 1].zm);
1635 len -= be32_to_cpu(adsp1_alg[i].zm);
1637 wm_adsp_create_control(dsp, alg_region, 0,
1640 adsp_warn(dsp, "Missing length info for region ZM with ID %x\n",
1641 be32_to_cpu(adsp1_alg[i].alg.id));
1651 static int wm_adsp2_setup_algs(struct wm_adsp *dsp)
1653 struct wmfw_adsp2_id_hdr adsp2_id;
1654 struct wmfw_adsp2_alg_hdr *adsp2_alg;
1655 struct wm_adsp_alg_region *alg_region;
1656 const struct wm_adsp_region *mem;
1657 unsigned int pos, len;
1661 mem = wm_adsp_find_region(dsp, WMFW_ADSP2_XM);
1665 ret = regmap_raw_read(dsp->regmap, mem->base, &adsp2_id,
1668 adsp_err(dsp, "Failed to read algorithm info: %d\n",
1673 n_algs = be32_to_cpu(adsp2_id.n_algs);
1674 dsp->fw_id = be32_to_cpu(adsp2_id.fw.id);
1675 dsp->fw_id_version = be32_to_cpu(adsp2_id.fw.ver);
1676 adsp_info(dsp, "Firmware: %x v%d.%d.%d, %zu algorithms\n",
1678 (dsp->fw_id_version & 0xff0000) >> 16,
1679 (dsp->fw_id_version & 0xff00) >> 8,
1680 dsp->fw_id_version & 0xff,
1683 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_XM,
1684 adsp2_id.fw.id, adsp2_id.xm);
1685 if (IS_ERR(alg_region))
1686 return PTR_ERR(alg_region);
1688 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_YM,
1689 adsp2_id.fw.id, adsp2_id.ym);
1690 if (IS_ERR(alg_region))
1691 return PTR_ERR(alg_region);
1693 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_ZM,
1694 adsp2_id.fw.id, adsp2_id.zm);
1695 if (IS_ERR(alg_region))
1696 return PTR_ERR(alg_region);
1698 pos = sizeof(adsp2_id) / 2;
1699 len = (sizeof(*adsp2_alg) * n_algs) / 2;
1701 adsp2_alg = wm_adsp_read_algs(dsp, n_algs, mem->base + pos, len);
1702 if (IS_ERR(adsp2_alg))
1703 return PTR_ERR(adsp2_alg);
1705 for (i = 0; i < n_algs; i++) {
1707 "%d: ID %x v%d.%d.%d XM@%x YM@%x ZM@%x\n",
1708 i, be32_to_cpu(adsp2_alg[i].alg.id),
1709 (be32_to_cpu(adsp2_alg[i].alg.ver) & 0xff0000) >> 16,
1710 (be32_to_cpu(adsp2_alg[i].alg.ver) & 0xff00) >> 8,
1711 be32_to_cpu(adsp2_alg[i].alg.ver) & 0xff,
1712 be32_to_cpu(adsp2_alg[i].xm),
1713 be32_to_cpu(adsp2_alg[i].ym),
1714 be32_to_cpu(adsp2_alg[i].zm));
1716 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_XM,
1717 adsp2_alg[i].alg.id,
1719 if (IS_ERR(alg_region)) {
1720 ret = PTR_ERR(alg_region);
1723 if (dsp->fw_ver == 0) {
1724 if (i + 1 < n_algs) {
1725 len = be32_to_cpu(adsp2_alg[i + 1].xm);
1726 len -= be32_to_cpu(adsp2_alg[i].xm);
1728 wm_adsp_create_control(dsp, alg_region, 0,
1731 adsp_warn(dsp, "Missing length info for region XM with ID %x\n",
1732 be32_to_cpu(adsp2_alg[i].alg.id));
1736 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_YM,
1737 adsp2_alg[i].alg.id,
1739 if (IS_ERR(alg_region)) {
1740 ret = PTR_ERR(alg_region);
1743 if (dsp->fw_ver == 0) {
1744 if (i + 1 < n_algs) {
1745 len = be32_to_cpu(adsp2_alg[i + 1].ym);
1746 len -= be32_to_cpu(adsp2_alg[i].ym);
1748 wm_adsp_create_control(dsp, alg_region, 0,
1751 adsp_warn(dsp, "Missing length info for region YM with ID %x\n",
1752 be32_to_cpu(adsp2_alg[i].alg.id));
1756 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_ZM,
1757 adsp2_alg[i].alg.id,
1759 if (IS_ERR(alg_region)) {
1760 ret = PTR_ERR(alg_region);
1763 if (dsp->fw_ver == 0) {
1764 if (i + 1 < n_algs) {
1765 len = be32_to_cpu(adsp2_alg[i + 1].zm);
1766 len -= be32_to_cpu(adsp2_alg[i].zm);
1768 wm_adsp_create_control(dsp, alg_region, 0,
1771 adsp_warn(dsp, "Missing length info for region ZM with ID %x\n",
1772 be32_to_cpu(adsp2_alg[i].alg.id));
1782 static int wm_adsp_load_coeff(struct wm_adsp *dsp)
1784 LIST_HEAD(buf_list);
1785 struct regmap *regmap = dsp->regmap;
1786 struct wmfw_coeff_hdr *hdr;
1787 struct wmfw_coeff_item *blk;
1788 const struct firmware *firmware;
1789 const struct wm_adsp_region *mem;
1790 struct wm_adsp_alg_region *alg_region;
1791 const char *region_name;
1792 int ret, pos, blocks, type, offset, reg;
1794 struct wm_adsp_buf *buf;
1796 file = kzalloc(PAGE_SIZE, GFP_KERNEL);
1800 snprintf(file, PAGE_SIZE, "%s-dsp%d-%s.bin", dsp->part, dsp->num,
1801 wm_adsp_fw[dsp->fw].file);
1802 file[PAGE_SIZE - 1] = '\0';
1804 ret = request_firmware(&firmware, file, dsp->dev);
1806 adsp_warn(dsp, "Failed to request '%s'\n", file);
1812 if (sizeof(*hdr) >= firmware->size) {
1813 adsp_err(dsp, "%s: file too short, %zu bytes\n",
1814 file, firmware->size);
1818 hdr = (void *)&firmware->data[0];
1819 if (memcmp(hdr->magic, "WMDR", 4) != 0) {
1820 adsp_err(dsp, "%s: invalid magic\n", file);
1824 switch (be32_to_cpu(hdr->rev) & 0xff) {
1828 adsp_err(dsp, "%s: Unsupported coefficient file format %d\n",
1829 file, be32_to_cpu(hdr->rev) & 0xff);
1834 adsp_dbg(dsp, "%s: v%d.%d.%d\n", file,
1835 (le32_to_cpu(hdr->ver) >> 16) & 0xff,
1836 (le32_to_cpu(hdr->ver) >> 8) & 0xff,
1837 le32_to_cpu(hdr->ver) & 0xff);
1839 pos = le32_to_cpu(hdr->len);
1842 while (pos < firmware->size &&
1843 pos - firmware->size > sizeof(*blk)) {
1844 blk = (void *)(&firmware->data[pos]);
1846 type = le16_to_cpu(blk->type);
1847 offset = le16_to_cpu(blk->offset);
1849 adsp_dbg(dsp, "%s.%d: %x v%d.%d.%d\n",
1850 file, blocks, le32_to_cpu(blk->id),
1851 (le32_to_cpu(blk->ver) >> 16) & 0xff,
1852 (le32_to_cpu(blk->ver) >> 8) & 0xff,
1853 le32_to_cpu(blk->ver) & 0xff);
1854 adsp_dbg(dsp, "%s.%d: %d bytes at 0x%x in %x\n",
1855 file, blocks, le32_to_cpu(blk->len), offset, type);
1858 region_name = "Unknown";
1860 case (WMFW_NAME_TEXT << 8):
1861 case (WMFW_INFO_TEXT << 8):
1863 case (WMFW_ABSOLUTE << 8):
1865 * Old files may use this for global
1868 if (le32_to_cpu(blk->id) == dsp->fw_id &&
1870 region_name = "global coefficients";
1871 mem = wm_adsp_find_region(dsp, type);
1873 adsp_err(dsp, "No ZM\n");
1876 reg = wm_adsp_region_to_reg(mem, 0);
1879 region_name = "register";
1888 adsp_dbg(dsp, "%s.%d: %d bytes in %x for %x\n",
1889 file, blocks, le32_to_cpu(blk->len),
1890 type, le32_to_cpu(blk->id));
1892 mem = wm_adsp_find_region(dsp, type);
1894 adsp_err(dsp, "No base for region %x\n", type);
1898 alg_region = wm_adsp_find_alg_region(dsp, type,
1899 le32_to_cpu(blk->id));
1901 reg = alg_region->base;
1902 reg = wm_adsp_region_to_reg(mem, reg);
1905 adsp_err(dsp, "No %x for algorithm %x\n",
1906 type, le32_to_cpu(blk->id));
1911 adsp_err(dsp, "%s.%d: Unknown region type %x at %d\n",
1912 file, blocks, type, pos);
1917 buf = wm_adsp_buf_alloc(blk->data,
1918 le32_to_cpu(blk->len),
1921 adsp_err(dsp, "Out of memory\n");
1926 adsp_dbg(dsp, "%s.%d: Writing %d bytes at %x\n",
1927 file, blocks, le32_to_cpu(blk->len),
1929 ret = regmap_raw_write_async(regmap, reg, buf->buf,
1930 le32_to_cpu(blk->len));
1933 "%s.%d: Failed to write to %x in %s: %d\n",
1934 file, blocks, reg, region_name, ret);
1938 pos += (le32_to_cpu(blk->len) + sizeof(*blk) + 3) & ~0x03;
1942 ret = regmap_async_complete(regmap);
1944 adsp_err(dsp, "Failed to complete async write: %d\n", ret);
1946 if (pos > firmware->size)
1947 adsp_warn(dsp, "%s.%d: %zu bytes at end of file\n",
1948 file, blocks, pos - firmware->size);
1950 wm_adsp_debugfs_save_binname(dsp, file);
1953 regmap_async_complete(regmap);
1954 release_firmware(firmware);
1955 wm_adsp_buf_free(&buf_list);
1961 int wm_adsp1_init(struct wm_adsp *dsp)
1963 INIT_LIST_HEAD(&dsp->alg_regions);
1965 mutex_init(&dsp->pwr_lock);
1969 EXPORT_SYMBOL_GPL(wm_adsp1_init);
1971 int wm_adsp1_event(struct snd_soc_dapm_widget *w,
1972 struct snd_kcontrol *kcontrol,
1975 struct snd_soc_codec *codec = snd_soc_dapm_to_codec(w->dapm);
1976 struct wm_adsp *dsps = snd_soc_codec_get_drvdata(codec);
1977 struct wm_adsp *dsp = &dsps[w->shift];
1978 struct wm_adsp_alg_region *alg_region;
1979 struct wm_coeff_ctl *ctl;
1983 dsp->card = codec->component.card;
1985 mutex_lock(&dsp->pwr_lock);
1988 case SND_SOC_DAPM_POST_PMU:
1989 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
1990 ADSP1_SYS_ENA, ADSP1_SYS_ENA);
1993 * For simplicity set the DSP clock rate to be the
1994 * SYSCLK rate rather than making it configurable.
1996 if (dsp->sysclk_reg) {
1997 ret = regmap_read(dsp->regmap, dsp->sysclk_reg, &val);
1999 adsp_err(dsp, "Failed to read SYSCLK state: %d\n",
2004 val = (val & dsp->sysclk_mask)
2005 >> dsp->sysclk_shift;
2007 ret = regmap_update_bits(dsp->regmap,
2008 dsp->base + ADSP1_CONTROL_31,
2009 ADSP1_CLK_SEL_MASK, val);
2011 adsp_err(dsp, "Failed to set clock rate: %d\n",
2017 ret = wm_adsp_load(dsp);
2021 ret = wm_adsp1_setup_algs(dsp);
2025 ret = wm_adsp_load_coeff(dsp);
2029 /* Initialize caches for enabled and unset controls */
2030 ret = wm_coeff_init_control_caches(dsp);
2034 /* Sync set controls */
2035 ret = wm_coeff_sync_controls(dsp);
2039 /* Start the core running */
2040 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2041 ADSP1_CORE_ENA | ADSP1_START,
2042 ADSP1_CORE_ENA | ADSP1_START);
2045 case SND_SOC_DAPM_PRE_PMD:
2047 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2048 ADSP1_CORE_ENA | ADSP1_START, 0);
2050 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_19,
2051 ADSP1_WDMA_BUFFER_LENGTH_MASK, 0);
2053 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2056 list_for_each_entry(ctl, &dsp->ctl_list, list)
2059 while (!list_empty(&dsp->alg_regions)) {
2060 alg_region = list_first_entry(&dsp->alg_regions,
2061 struct wm_adsp_alg_region,
2063 list_del(&alg_region->list);
2072 mutex_unlock(&dsp->pwr_lock);
2077 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2080 mutex_unlock(&dsp->pwr_lock);
2084 EXPORT_SYMBOL_GPL(wm_adsp1_event);
2086 static int wm_adsp2_ena(struct wm_adsp *dsp)
2091 ret = regmap_update_bits_async(dsp->regmap, dsp->base + ADSP2_CONTROL,
2092 ADSP2_SYS_ENA, ADSP2_SYS_ENA);
2096 /* Wait for the RAM to start, should be near instantaneous */
2097 for (count = 0; count < 10; ++count) {
2098 ret = regmap_read(dsp->regmap, dsp->base + ADSP2_STATUS1,
2103 if (val & ADSP2_RAM_RDY)
2109 if (!(val & ADSP2_RAM_RDY)) {
2110 adsp_err(dsp, "Failed to start DSP RAM\n");
2114 adsp_dbg(dsp, "RAM ready after %d polls\n", count);
2119 static void wm_adsp2_boot_work(struct work_struct *work)
2121 struct wm_adsp *dsp = container_of(work,
2127 mutex_lock(&dsp->pwr_lock);
2130 * For simplicity set the DSP clock rate to be the
2131 * SYSCLK rate rather than making it configurable.
2133 ret = regmap_read(dsp->regmap, ARIZONA_SYSTEM_CLOCK_1, &val);
2135 adsp_err(dsp, "Failed to read SYSCLK state: %d\n", ret);
2138 val = (val & ARIZONA_SYSCLK_FREQ_MASK)
2139 >> ARIZONA_SYSCLK_FREQ_SHIFT;
2141 ret = regmap_update_bits_async(dsp->regmap,
2142 dsp->base + ADSP2_CLOCKING,
2143 ADSP2_CLK_SEL_MASK, val);
2145 adsp_err(dsp, "Failed to set clock rate: %d\n", ret);
2149 ret = wm_adsp2_ena(dsp);
2153 ret = wm_adsp_load(dsp);
2157 ret = wm_adsp2_setup_algs(dsp);
2161 ret = wm_adsp_load_coeff(dsp);
2165 /* Initialize caches for enabled and unset controls */
2166 ret = wm_coeff_init_control_caches(dsp);
2170 /* Sync set controls */
2171 ret = wm_coeff_sync_controls(dsp);
2175 dsp->running = true;
2177 mutex_unlock(&dsp->pwr_lock);
2182 regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
2183 ADSP2_SYS_ENA | ADSP2_CORE_ENA | ADSP2_START, 0);
2185 mutex_unlock(&dsp->pwr_lock);
2188 int wm_adsp2_early_event(struct snd_soc_dapm_widget *w,
2189 struct snd_kcontrol *kcontrol, int event)
2191 struct snd_soc_codec *codec = snd_soc_dapm_to_codec(w->dapm);
2192 struct wm_adsp *dsps = snd_soc_codec_get_drvdata(codec);
2193 struct wm_adsp *dsp = &dsps[w->shift];
2195 dsp->card = codec->component.card;
2198 case SND_SOC_DAPM_PRE_PMU:
2199 queue_work(system_unbound_wq, &dsp->boot_work);
2207 EXPORT_SYMBOL_GPL(wm_adsp2_early_event);
2209 int wm_adsp2_event(struct snd_soc_dapm_widget *w,
2210 struct snd_kcontrol *kcontrol, int event)
2212 struct snd_soc_codec *codec = snd_soc_dapm_to_codec(w->dapm);
2213 struct wm_adsp *dsps = snd_soc_codec_get_drvdata(codec);
2214 struct wm_adsp *dsp = &dsps[w->shift];
2215 struct wm_adsp_alg_region *alg_region;
2216 struct wm_coeff_ctl *ctl;
2220 case SND_SOC_DAPM_POST_PMU:
2221 flush_work(&dsp->boot_work);
2226 ret = regmap_update_bits(dsp->regmap,
2227 dsp->base + ADSP2_CONTROL,
2228 ADSP2_CORE_ENA | ADSP2_START,
2229 ADSP2_CORE_ENA | ADSP2_START);
2233 if (wm_adsp_fw[dsp->fw].num_caps != 0)
2234 ret = wm_adsp_buffer_init(dsp);
2238 case SND_SOC_DAPM_PRE_PMD:
2239 /* Log firmware state, it can be useful for analysis */
2240 wm_adsp2_show_fw_status(dsp);
2242 mutex_lock(&dsp->pwr_lock);
2244 wm_adsp_debugfs_clear(dsp);
2247 dsp->fw_id_version = 0;
2248 dsp->running = false;
2250 regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
2251 ADSP2_SYS_ENA | ADSP2_CORE_ENA |
2254 /* Make sure DMAs are quiesced */
2255 regmap_write(dsp->regmap, dsp->base + ADSP2_WDMA_CONFIG_1, 0);
2256 regmap_write(dsp->regmap, dsp->base + ADSP2_WDMA_CONFIG_2, 0);
2257 regmap_write(dsp->regmap, dsp->base + ADSP2_RDMA_CONFIG_1, 0);
2259 list_for_each_entry(ctl, &dsp->ctl_list, list)
2262 while (!list_empty(&dsp->alg_regions)) {
2263 alg_region = list_first_entry(&dsp->alg_regions,
2264 struct wm_adsp_alg_region,
2266 list_del(&alg_region->list);
2270 if (wm_adsp_fw[dsp->fw].num_caps != 0)
2271 wm_adsp_buffer_free(dsp);
2273 mutex_unlock(&dsp->pwr_lock);
2275 adsp_dbg(dsp, "Shutdown complete\n");
2284 regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
2285 ADSP2_SYS_ENA | ADSP2_CORE_ENA | ADSP2_START, 0);
2288 EXPORT_SYMBOL_GPL(wm_adsp2_event);
2290 int wm_adsp2_codec_probe(struct wm_adsp *dsp, struct snd_soc_codec *codec)
2292 wm_adsp2_init_debugfs(dsp, codec);
2294 return snd_soc_add_codec_controls(codec,
2295 &wm_adsp_fw_controls[dsp->num - 1],
2298 EXPORT_SYMBOL_GPL(wm_adsp2_codec_probe);
2300 int wm_adsp2_codec_remove(struct wm_adsp *dsp, struct snd_soc_codec *codec)
2302 wm_adsp2_cleanup_debugfs(dsp);
2306 EXPORT_SYMBOL_GPL(wm_adsp2_codec_remove);
2308 int wm_adsp2_init(struct wm_adsp *dsp)
2313 * Disable the DSP memory by default when in reset for a small
2316 ret = regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
2319 adsp_err(dsp, "Failed to clear memory retention: %d\n", ret);
2323 INIT_LIST_HEAD(&dsp->alg_regions);
2324 INIT_LIST_HEAD(&dsp->ctl_list);
2325 INIT_WORK(&dsp->boot_work, wm_adsp2_boot_work);
2327 mutex_init(&dsp->pwr_lock);
2331 EXPORT_SYMBOL_GPL(wm_adsp2_init);
2333 int wm_adsp_compr_open(struct wm_adsp *dsp, struct snd_compr_stream *stream)
2335 struct wm_adsp_compr *compr;
2338 mutex_lock(&dsp->pwr_lock);
2340 if (wm_adsp_fw[dsp->fw].num_caps == 0) {
2341 adsp_err(dsp, "Firmware does not support compressed API\n");
2346 if (wm_adsp_fw[dsp->fw].compr_direction != stream->direction) {
2347 adsp_err(dsp, "Firmware does not support stream direction\n");
2353 /* It is expect this limitation will be removed in future */
2354 adsp_err(dsp, "Only a single stream supported per DSP\n");
2359 compr = kzalloc(sizeof(*compr), GFP_KERNEL);
2366 compr->stream = stream;
2370 stream->runtime->private_data = compr;
2373 mutex_unlock(&dsp->pwr_lock);
2377 EXPORT_SYMBOL_GPL(wm_adsp_compr_open);
2379 int wm_adsp_compr_free(struct snd_compr_stream *stream)
2381 struct wm_adsp_compr *compr = stream->runtime->private_data;
2382 struct wm_adsp *dsp = compr->dsp;
2384 mutex_lock(&dsp->pwr_lock);
2390 mutex_unlock(&dsp->pwr_lock);
2394 EXPORT_SYMBOL_GPL(wm_adsp_compr_free);
2396 static int wm_adsp_compr_check_params(struct snd_compr_stream *stream,
2397 struct snd_compr_params *params)
2399 struct wm_adsp_compr *compr = stream->runtime->private_data;
2400 struct wm_adsp *dsp = compr->dsp;
2401 const struct wm_adsp_fw_caps *caps;
2402 const struct snd_codec_desc *desc;
2405 if (params->buffer.fragment_size < WM_ADSP_MIN_FRAGMENT_SIZE ||
2406 params->buffer.fragment_size > WM_ADSP_MAX_FRAGMENT_SIZE ||
2407 params->buffer.fragments < WM_ADSP_MIN_FRAGMENTS ||
2408 params->buffer.fragments > WM_ADSP_MAX_FRAGMENTS ||
2409 params->buffer.fragment_size % WM_ADSP_DATA_WORD_SIZE) {
2410 adsp_err(dsp, "Invalid buffer fragsize=%d fragments=%d\n",
2411 params->buffer.fragment_size,
2412 params->buffer.fragments);
2417 for (i = 0; i < wm_adsp_fw[dsp->fw].num_caps; i++) {
2418 caps = &wm_adsp_fw[dsp->fw].caps[i];
2421 if (caps->id != params->codec.id)
2424 if (stream->direction == SND_COMPRESS_PLAYBACK) {
2425 if (desc->max_ch < params->codec.ch_out)
2428 if (desc->max_ch < params->codec.ch_in)
2432 if (!(desc->formats & (1 << params->codec.format)))
2435 for (j = 0; j < desc->num_sample_rates; ++j)
2436 if (desc->sample_rates[j] == params->codec.sample_rate)
2440 adsp_err(dsp, "Invalid params id=%u ch=%u,%u rate=%u fmt=%u\n",
2441 params->codec.id, params->codec.ch_in, params->codec.ch_out,
2442 params->codec.sample_rate, params->codec.format);
2446 static inline unsigned int wm_adsp_compr_frag_words(struct wm_adsp_compr *compr)
2448 return compr->size.fragment_size / WM_ADSP_DATA_WORD_SIZE;
2451 int wm_adsp_compr_set_params(struct snd_compr_stream *stream,
2452 struct snd_compr_params *params)
2454 struct wm_adsp_compr *compr = stream->runtime->private_data;
2457 ret = wm_adsp_compr_check_params(stream, params);
2461 compr->size = params->buffer;
2463 adsp_dbg(compr->dsp, "fragment_size=%d fragments=%d\n",
2464 compr->size.fragment_size, compr->size.fragments);
2468 EXPORT_SYMBOL_GPL(wm_adsp_compr_set_params);
2470 int wm_adsp_compr_get_caps(struct snd_compr_stream *stream,
2471 struct snd_compr_caps *caps)
2473 struct wm_adsp_compr *compr = stream->runtime->private_data;
2474 int fw = compr->dsp->fw;
2477 if (wm_adsp_fw[fw].caps) {
2478 for (i = 0; i < wm_adsp_fw[fw].num_caps; i++)
2479 caps->codecs[i] = wm_adsp_fw[fw].caps[i].id;
2481 caps->num_codecs = i;
2482 caps->direction = wm_adsp_fw[fw].compr_direction;
2484 caps->min_fragment_size = WM_ADSP_MIN_FRAGMENT_SIZE;
2485 caps->max_fragment_size = WM_ADSP_MAX_FRAGMENT_SIZE;
2486 caps->min_fragments = WM_ADSP_MIN_FRAGMENTS;
2487 caps->max_fragments = WM_ADSP_MAX_FRAGMENTS;
2492 EXPORT_SYMBOL_GPL(wm_adsp_compr_get_caps);
2494 static int wm_adsp_read_data_block(struct wm_adsp *dsp, int mem_type,
2495 unsigned int mem_addr,
2496 unsigned int num_words, u32 *data)
2498 struct wm_adsp_region const *mem = wm_adsp_find_region(dsp, mem_type);
2499 unsigned int i, reg;
2505 reg = wm_adsp_region_to_reg(mem, mem_addr);
2507 ret = regmap_raw_read(dsp->regmap, reg, data,
2508 sizeof(*data) * num_words);
2512 for (i = 0; i < num_words; ++i)
2513 data[i] = be32_to_cpu(data[i]) & 0x00ffffffu;
2518 static inline int wm_adsp_read_data_word(struct wm_adsp *dsp, int mem_type,
2519 unsigned int mem_addr, u32 *data)
2521 return wm_adsp_read_data_block(dsp, mem_type, mem_addr, 1, data);
2524 static int wm_adsp_write_data_word(struct wm_adsp *dsp, int mem_type,
2525 unsigned int mem_addr, u32 data)
2527 struct wm_adsp_region const *mem = wm_adsp_find_region(dsp, mem_type);
2533 reg = wm_adsp_region_to_reg(mem, mem_addr);
2535 data = cpu_to_be32(data & 0x00ffffffu);
2537 return regmap_raw_write(dsp->regmap, reg, &data, sizeof(data));
2540 static inline int wm_adsp_buffer_read(struct wm_adsp_compr_buf *buf,
2541 unsigned int field_offset, u32 *data)
2543 return wm_adsp_read_data_word(buf->dsp, WMFW_ADSP2_XM,
2544 buf->host_buf_ptr + field_offset, data);
2547 static inline int wm_adsp_buffer_write(struct wm_adsp_compr_buf *buf,
2548 unsigned int field_offset, u32 data)
2550 return wm_adsp_write_data_word(buf->dsp, WMFW_ADSP2_XM,
2551 buf->host_buf_ptr + field_offset, data);
2554 static int wm_adsp_buffer_locate(struct wm_adsp_compr_buf *buf)
2556 struct wm_adsp_alg_region *alg_region;
2557 struct wm_adsp *dsp = buf->dsp;
2558 u32 xmalg, addr, magic;
2561 alg_region = wm_adsp_find_alg_region(dsp, WMFW_ADSP2_XM, dsp->fw_id);
2562 xmalg = sizeof(struct wm_adsp_system_config_xm_hdr) / sizeof(__be32);
2564 addr = alg_region->base + xmalg + ALG_XM_FIELD(magic);
2565 ret = wm_adsp_read_data_word(dsp, WMFW_ADSP2_XM, addr, &magic);
2569 if (magic != WM_ADSP_ALG_XM_STRUCT_MAGIC)
2572 addr = alg_region->base + xmalg + ALG_XM_FIELD(host_buf_ptr);
2573 for (i = 0; i < 5; ++i) {
2574 ret = wm_adsp_read_data_word(dsp, WMFW_ADSP2_XM, addr,
2575 &buf->host_buf_ptr);
2579 if (buf->host_buf_ptr)
2582 usleep_range(1000, 2000);
2585 if (!buf->host_buf_ptr)
2588 adsp_dbg(dsp, "host_buf_ptr=%x\n", buf->host_buf_ptr);
2593 static int wm_adsp_buffer_populate(struct wm_adsp_compr_buf *buf)
2595 const struct wm_adsp_fw_caps *caps = wm_adsp_fw[buf->dsp->fw].caps;
2596 struct wm_adsp_buffer_region *region;
2600 for (i = 0; i < caps->num_regions; ++i) {
2601 region = &buf->regions[i];
2603 region->offset = offset;
2604 region->mem_type = caps->region_defs[i].mem_type;
2606 ret = wm_adsp_buffer_read(buf, caps->region_defs[i].base_offset,
2607 ®ion->base_addr);
2611 ret = wm_adsp_buffer_read(buf, caps->region_defs[i].size_offset,
2616 region->cumulative_size = offset;
2619 "region=%d type=%d base=%04x off=%04x size=%04x\n",
2620 i, region->mem_type, region->base_addr,
2621 region->offset, region->cumulative_size);
2627 static int wm_adsp_buffer_init(struct wm_adsp *dsp)
2629 struct wm_adsp_compr_buf *buf;
2632 buf = kzalloc(sizeof(*buf), GFP_KERNEL);
2637 buf->read_index = -1;
2638 buf->irq_count = 0xFFFFFFFF;
2640 ret = wm_adsp_buffer_locate(buf);
2642 adsp_err(dsp, "Failed to acquire host buffer: %d\n", ret);
2646 buf->regions = kcalloc(wm_adsp_fw[dsp->fw].caps->num_regions,
2647 sizeof(*buf->regions), GFP_KERNEL);
2648 if (!buf->regions) {
2653 ret = wm_adsp_buffer_populate(buf);
2655 adsp_err(dsp, "Failed to populate host buffer: %d\n", ret);
2664 kfree(buf->regions);
2670 static int wm_adsp_buffer_free(struct wm_adsp *dsp)
2673 kfree(dsp->buffer->regions);
2682 static inline int wm_adsp_compr_attached(struct wm_adsp_compr *compr)
2684 return compr->buf != NULL;
2687 static int wm_adsp_compr_attach(struct wm_adsp_compr *compr)
2690 * Note this will be more complex once each DSP can support multiple
2693 if (!compr->dsp->buffer)
2696 compr->buf = compr->dsp->buffer;
2701 int wm_adsp_compr_trigger(struct snd_compr_stream *stream, int cmd)
2703 struct wm_adsp_compr *compr = stream->runtime->private_data;
2704 struct wm_adsp *dsp = compr->dsp;
2707 adsp_dbg(dsp, "Trigger: %d\n", cmd);
2709 mutex_lock(&dsp->pwr_lock);
2712 case SNDRV_PCM_TRIGGER_START:
2713 if (wm_adsp_compr_attached(compr))
2716 ret = wm_adsp_compr_attach(compr);
2718 adsp_err(dsp, "Failed to link buffer and stream: %d\n",
2723 /* Trigger the IRQ at one fragment of data */
2724 ret = wm_adsp_buffer_write(compr->buf,
2725 HOST_BUFFER_FIELD(high_water_mark),
2726 wm_adsp_compr_frag_words(compr));
2728 adsp_err(dsp, "Failed to set high water mark: %d\n",
2733 case SNDRV_PCM_TRIGGER_STOP:
2740 mutex_unlock(&dsp->pwr_lock);
2744 EXPORT_SYMBOL_GPL(wm_adsp_compr_trigger);
2746 static inline int wm_adsp_buffer_size(struct wm_adsp_compr_buf *buf)
2748 int last_region = wm_adsp_fw[buf->dsp->fw].caps->num_regions - 1;
2750 return buf->regions[last_region].cumulative_size;
2753 static int wm_adsp_buffer_update_avail(struct wm_adsp_compr_buf *buf)
2755 u32 next_read_index, next_write_index;
2756 int write_index, read_index, avail;
2759 /* Only sync read index if we haven't already read a valid index */
2760 if (buf->read_index < 0) {
2761 ret = wm_adsp_buffer_read(buf,
2762 HOST_BUFFER_FIELD(next_read_index),
2767 read_index = sign_extend32(next_read_index, 23);
2769 if (read_index < 0) {
2770 adsp_dbg(buf->dsp, "Avail check on unstarted stream\n");
2774 buf->read_index = read_index;
2777 ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(next_write_index),
2782 write_index = sign_extend32(next_write_index, 23);
2784 avail = write_index - buf->read_index;
2786 avail += wm_adsp_buffer_size(buf);
2788 adsp_dbg(buf->dsp, "readindex=0x%x, writeindex=0x%x, avail=%d\n",
2789 buf->read_index, write_index, avail);
2796 int wm_adsp_compr_handle_irq(struct wm_adsp *dsp)
2798 struct wm_adsp_compr_buf *buf = dsp->buffer;
2801 mutex_lock(&dsp->pwr_lock);
2804 adsp_err(dsp, "Spurious buffer IRQ\n");
2809 adsp_dbg(dsp, "Handling buffer IRQ\n");
2811 ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(error), &buf->error);
2813 adsp_err(dsp, "Failed to check buffer error: %d\n", ret);
2816 if (buf->error != 0) {
2817 adsp_err(dsp, "Buffer error occurred: %d\n", buf->error);
2822 ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(irq_count),
2825 adsp_err(dsp, "Failed to get irq_count: %d\n", ret);
2829 ret = wm_adsp_buffer_update_avail(buf);
2831 adsp_err(dsp, "Error reading avail: %d\n", ret);
2836 mutex_unlock(&dsp->pwr_lock);
2840 EXPORT_SYMBOL_GPL(wm_adsp_compr_handle_irq);
2842 static int wm_adsp_buffer_reenable_irq(struct wm_adsp_compr_buf *buf)
2844 if (buf->irq_count & 0x01)
2847 adsp_dbg(buf->dsp, "Enable IRQ(0x%x) for next fragment\n",
2850 buf->irq_count |= 0x01;
2852 return wm_adsp_buffer_write(buf, HOST_BUFFER_FIELD(irq_ack),
2856 int wm_adsp_compr_pointer(struct snd_compr_stream *stream,
2857 struct snd_compr_tstamp *tstamp)
2859 struct wm_adsp_compr *compr = stream->runtime->private_data;
2860 struct wm_adsp_compr_buf *buf = compr->buf;
2861 struct wm_adsp *dsp = compr->dsp;
2864 adsp_dbg(dsp, "Pointer request\n");
2866 mutex_lock(&dsp->pwr_lock);
2873 if (compr->buf->error) {
2878 if (buf->avail < wm_adsp_compr_frag_words(compr)) {
2879 ret = wm_adsp_buffer_update_avail(buf);
2881 adsp_err(dsp, "Error reading avail: %d\n", ret);
2886 * If we really have less than 1 fragment available tell the
2887 * DSP to inform us once a whole fragment is available.
2889 if (buf->avail < wm_adsp_compr_frag_words(compr)) {
2890 ret = wm_adsp_buffer_reenable_irq(buf);
2893 "Failed to re-enable buffer IRQ: %d\n",
2900 tstamp->copied_total = compr->copied_total;
2901 tstamp->copied_total += buf->avail * WM_ADSP_DATA_WORD_SIZE;
2904 mutex_unlock(&dsp->pwr_lock);
2908 EXPORT_SYMBOL_GPL(wm_adsp_compr_pointer);
2910 MODULE_LICENSE("GPL v2");