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;
297 unsigned int copied_total;
299 unsigned int sample_rate;
302 #define WM_ADSP_DATA_WORD_SIZE 3
304 #define WM_ADSP_MIN_FRAGMENTS 1
305 #define WM_ADSP_MAX_FRAGMENTS 256
306 #define WM_ADSP_MIN_FRAGMENT_SIZE (64 * WM_ADSP_DATA_WORD_SIZE)
307 #define WM_ADSP_MAX_FRAGMENT_SIZE (4096 * WM_ADSP_DATA_WORD_SIZE)
309 #define WM_ADSP_ALG_XM_STRUCT_MAGIC 0x49aec7
311 #define HOST_BUFFER_FIELD(field) \
312 (offsetof(struct wm_adsp_buffer, field) / sizeof(__be32))
314 #define ALG_XM_FIELD(field) \
315 (offsetof(struct wm_adsp_alg_xm_struct, field) / sizeof(__be32))
317 static int wm_adsp_buffer_init(struct wm_adsp *dsp);
318 static int wm_adsp_buffer_free(struct wm_adsp *dsp);
320 struct wm_adsp_buffer_region {
322 unsigned int cumulative_size;
323 unsigned int mem_type;
324 unsigned int base_addr;
327 struct wm_adsp_buffer_region_def {
328 unsigned int mem_type;
329 unsigned int base_offset;
330 unsigned int size_offset;
333 static struct wm_adsp_buffer_region_def ez2control_regions[] = {
335 .mem_type = WMFW_ADSP2_XM,
336 .base_offset = HOST_BUFFER_FIELD(X_buf_base),
337 .size_offset = HOST_BUFFER_FIELD(X_buf_size),
340 .mem_type = WMFW_ADSP2_XM,
341 .base_offset = HOST_BUFFER_FIELD(X_buf_base2),
342 .size_offset = HOST_BUFFER_FIELD(X_buf_brk),
345 .mem_type = WMFW_ADSP2_YM,
346 .base_offset = HOST_BUFFER_FIELD(Y_buf_base),
347 .size_offset = HOST_BUFFER_FIELD(wrap),
351 struct wm_adsp_fw_caps {
353 struct snd_codec_desc desc;
355 struct wm_adsp_buffer_region_def *region_defs;
358 static const struct wm_adsp_fw_caps ez2control_caps[] = {
360 .id = SND_AUDIOCODEC_BESPOKE,
363 .sample_rates = { 16000 },
364 .num_sample_rates = 1,
365 .formats = SNDRV_PCM_FMTBIT_S16_LE,
367 .num_regions = ARRAY_SIZE(ez2control_regions),
368 .region_defs = ez2control_regions,
372 static const struct {
376 const struct wm_adsp_fw_caps *caps;
377 } wm_adsp_fw[WM_ADSP_NUM_FW] = {
378 [WM_ADSP_FW_MBC_VSS] = { .file = "mbc-vss" },
379 [WM_ADSP_FW_HIFI] = { .file = "hifi" },
380 [WM_ADSP_FW_TX] = { .file = "tx" },
381 [WM_ADSP_FW_TX_SPK] = { .file = "tx-spk" },
382 [WM_ADSP_FW_RX] = { .file = "rx" },
383 [WM_ADSP_FW_RX_ANC] = { .file = "rx-anc" },
384 [WM_ADSP_FW_CTRL] = {
386 .compr_direction = SND_COMPRESS_CAPTURE,
387 .num_caps = ARRAY_SIZE(ez2control_caps),
388 .caps = ez2control_caps,
390 [WM_ADSP_FW_ASR] = { .file = "asr" },
391 [WM_ADSP_FW_TRACE] = { .file = "trace" },
392 [WM_ADSP_FW_SPK_PROT] = { .file = "spk-prot" },
393 [WM_ADSP_FW_MISC] = { .file = "misc" },
396 struct wm_coeff_ctl_ops {
397 int (*xget)(struct snd_kcontrol *kcontrol,
398 struct snd_ctl_elem_value *ucontrol);
399 int (*xput)(struct snd_kcontrol *kcontrol,
400 struct snd_ctl_elem_value *ucontrol);
401 int (*xinfo)(struct snd_kcontrol *kcontrol,
402 struct snd_ctl_elem_info *uinfo);
405 struct wm_coeff_ctl {
408 struct wm_adsp_alg_region alg_region;
409 struct wm_coeff_ctl_ops ops;
411 unsigned int enabled:1;
412 struct list_head list;
417 struct snd_kcontrol *kcontrol;
421 #ifdef CONFIG_DEBUG_FS
422 static void wm_adsp_debugfs_save_wmfwname(struct wm_adsp *dsp, const char *s)
424 char *tmp = kasprintf(GFP_KERNEL, "%s\n", s);
426 kfree(dsp->wmfw_file_name);
427 dsp->wmfw_file_name = tmp;
430 static void wm_adsp_debugfs_save_binname(struct wm_adsp *dsp, const char *s)
432 char *tmp = kasprintf(GFP_KERNEL, "%s\n", s);
434 kfree(dsp->bin_file_name);
435 dsp->bin_file_name = tmp;
438 static void wm_adsp_debugfs_clear(struct wm_adsp *dsp)
440 kfree(dsp->wmfw_file_name);
441 kfree(dsp->bin_file_name);
442 dsp->wmfw_file_name = NULL;
443 dsp->bin_file_name = NULL;
446 static ssize_t wm_adsp_debugfs_wmfw_read(struct file *file,
447 char __user *user_buf,
448 size_t count, loff_t *ppos)
450 struct wm_adsp *dsp = file->private_data;
453 mutex_lock(&dsp->pwr_lock);
455 if (!dsp->wmfw_file_name || !dsp->running)
458 ret = simple_read_from_buffer(user_buf, count, ppos,
460 strlen(dsp->wmfw_file_name));
462 mutex_unlock(&dsp->pwr_lock);
466 static ssize_t wm_adsp_debugfs_bin_read(struct file *file,
467 char __user *user_buf,
468 size_t count, loff_t *ppos)
470 struct wm_adsp *dsp = file->private_data;
473 mutex_lock(&dsp->pwr_lock);
475 if (!dsp->bin_file_name || !dsp->running)
478 ret = simple_read_from_buffer(user_buf, count, ppos,
480 strlen(dsp->bin_file_name));
482 mutex_unlock(&dsp->pwr_lock);
486 static const struct {
488 const struct file_operations fops;
489 } wm_adsp_debugfs_fops[] = {
491 .name = "wmfw_file_name",
494 .read = wm_adsp_debugfs_wmfw_read,
498 .name = "bin_file_name",
501 .read = wm_adsp_debugfs_bin_read,
506 static void wm_adsp2_init_debugfs(struct wm_adsp *dsp,
507 struct snd_soc_codec *codec)
509 struct dentry *root = NULL;
513 if (!codec->component.debugfs_root) {
514 adsp_err(dsp, "No codec debugfs root\n");
518 root_name = kmalloc(PAGE_SIZE, GFP_KERNEL);
522 snprintf(root_name, PAGE_SIZE, "dsp%d", dsp->num);
523 root = debugfs_create_dir(root_name, codec->component.debugfs_root);
529 if (!debugfs_create_bool("running", S_IRUGO, root, &dsp->running))
532 if (!debugfs_create_x32("fw_id", S_IRUGO, root, &dsp->fw_id))
535 if (!debugfs_create_x32("fw_version", S_IRUGO, root,
536 &dsp->fw_id_version))
539 for (i = 0; i < ARRAY_SIZE(wm_adsp_debugfs_fops); ++i) {
540 if (!debugfs_create_file(wm_adsp_debugfs_fops[i].name,
542 &wm_adsp_debugfs_fops[i].fops))
546 dsp->debugfs_root = root;
550 debugfs_remove_recursive(root);
551 adsp_err(dsp, "Failed to create debugfs\n");
554 static void wm_adsp2_cleanup_debugfs(struct wm_adsp *dsp)
556 wm_adsp_debugfs_clear(dsp);
557 debugfs_remove_recursive(dsp->debugfs_root);
560 static inline void wm_adsp2_init_debugfs(struct wm_adsp *dsp,
561 struct snd_soc_codec *codec)
565 static inline void wm_adsp2_cleanup_debugfs(struct wm_adsp *dsp)
569 static inline void wm_adsp_debugfs_save_wmfwname(struct wm_adsp *dsp,
574 static inline void wm_adsp_debugfs_save_binname(struct wm_adsp *dsp,
579 static inline void wm_adsp_debugfs_clear(struct wm_adsp *dsp)
584 static int wm_adsp_fw_get(struct snd_kcontrol *kcontrol,
585 struct snd_ctl_elem_value *ucontrol)
587 struct snd_soc_codec *codec = snd_soc_kcontrol_codec(kcontrol);
588 struct soc_enum *e = (struct soc_enum *)kcontrol->private_value;
589 struct wm_adsp *dsp = snd_soc_codec_get_drvdata(codec);
591 ucontrol->value.integer.value[0] = dsp[e->shift_l].fw;
596 static int wm_adsp_fw_put(struct snd_kcontrol *kcontrol,
597 struct snd_ctl_elem_value *ucontrol)
599 struct snd_soc_codec *codec = snd_soc_kcontrol_codec(kcontrol);
600 struct soc_enum *e = (struct soc_enum *)kcontrol->private_value;
601 struct wm_adsp *dsp = snd_soc_codec_get_drvdata(codec);
604 if (ucontrol->value.integer.value[0] == dsp[e->shift_l].fw)
607 if (ucontrol->value.integer.value[0] >= WM_ADSP_NUM_FW)
610 mutex_lock(&dsp[e->shift_l].pwr_lock);
612 if (dsp[e->shift_l].running || dsp[e->shift_l].compr)
615 dsp[e->shift_l].fw = ucontrol->value.integer.value[0];
617 mutex_unlock(&dsp[e->shift_l].pwr_lock);
622 static const struct soc_enum wm_adsp_fw_enum[] = {
623 SOC_ENUM_SINGLE(0, 0, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
624 SOC_ENUM_SINGLE(0, 1, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
625 SOC_ENUM_SINGLE(0, 2, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
626 SOC_ENUM_SINGLE(0, 3, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
629 const struct snd_kcontrol_new wm_adsp_fw_controls[] = {
630 SOC_ENUM_EXT("DSP1 Firmware", wm_adsp_fw_enum[0],
631 wm_adsp_fw_get, wm_adsp_fw_put),
632 SOC_ENUM_EXT("DSP2 Firmware", wm_adsp_fw_enum[1],
633 wm_adsp_fw_get, wm_adsp_fw_put),
634 SOC_ENUM_EXT("DSP3 Firmware", wm_adsp_fw_enum[2],
635 wm_adsp_fw_get, wm_adsp_fw_put),
636 SOC_ENUM_EXT("DSP4 Firmware", wm_adsp_fw_enum[3],
637 wm_adsp_fw_get, wm_adsp_fw_put),
639 EXPORT_SYMBOL_GPL(wm_adsp_fw_controls);
641 static struct wm_adsp_region const *wm_adsp_find_region(struct wm_adsp *dsp,
646 for (i = 0; i < dsp->num_mems; i++)
647 if (dsp->mem[i].type == type)
653 static unsigned int wm_adsp_region_to_reg(struct wm_adsp_region const *mem,
660 return mem->base + (offset * 3);
662 return mem->base + (offset * 2);
664 return mem->base + (offset * 2);
666 return mem->base + (offset * 2);
668 return mem->base + (offset * 2);
670 WARN(1, "Unknown memory region type");
675 static void wm_adsp2_show_fw_status(struct wm_adsp *dsp)
680 ret = regmap_raw_read(dsp->regmap, dsp->base + ADSP2_SCRATCH0,
681 scratch, sizeof(scratch));
683 adsp_err(dsp, "Failed to read SCRATCH regs: %d\n", ret);
687 adsp_dbg(dsp, "FW SCRATCH 0:0x%x 1:0x%x 2:0x%x 3:0x%x\n",
688 be16_to_cpu(scratch[0]),
689 be16_to_cpu(scratch[1]),
690 be16_to_cpu(scratch[2]),
691 be16_to_cpu(scratch[3]));
694 static int wm_coeff_info(struct snd_kcontrol *kctl,
695 struct snd_ctl_elem_info *uinfo)
697 struct wm_coeff_ctl *ctl = (struct wm_coeff_ctl *)kctl->private_value;
699 uinfo->type = SNDRV_CTL_ELEM_TYPE_BYTES;
700 uinfo->count = ctl->len;
704 static int wm_coeff_write_control(struct wm_coeff_ctl *ctl,
705 const void *buf, size_t len)
707 struct wm_adsp_alg_region *alg_region = &ctl->alg_region;
708 const struct wm_adsp_region *mem;
709 struct wm_adsp *dsp = ctl->dsp;
714 mem = wm_adsp_find_region(dsp, alg_region->type);
716 adsp_err(dsp, "No base for region %x\n",
721 reg = ctl->alg_region.base + ctl->offset;
722 reg = wm_adsp_region_to_reg(mem, reg);
724 scratch = kmemdup(buf, len, GFP_KERNEL | GFP_DMA);
728 ret = regmap_raw_write(dsp->regmap, reg, scratch,
731 adsp_err(dsp, "Failed to write %zu bytes to %x: %d\n",
736 adsp_dbg(dsp, "Wrote %zu bytes to %x\n", len, reg);
743 static int wm_coeff_put(struct snd_kcontrol *kctl,
744 struct snd_ctl_elem_value *ucontrol)
746 struct wm_coeff_ctl *ctl = (struct wm_coeff_ctl *)kctl->private_value;
747 char *p = ucontrol->value.bytes.data;
750 mutex_lock(&ctl->dsp->pwr_lock);
752 memcpy(ctl->cache, p, ctl->len);
756 ret = wm_coeff_write_control(ctl, p, ctl->len);
758 mutex_unlock(&ctl->dsp->pwr_lock);
763 static int wm_coeff_read_control(struct wm_coeff_ctl *ctl,
764 void *buf, size_t len)
766 struct wm_adsp_alg_region *alg_region = &ctl->alg_region;
767 const struct wm_adsp_region *mem;
768 struct wm_adsp *dsp = ctl->dsp;
773 mem = wm_adsp_find_region(dsp, alg_region->type);
775 adsp_err(dsp, "No base for region %x\n",
780 reg = ctl->alg_region.base + ctl->offset;
781 reg = wm_adsp_region_to_reg(mem, reg);
783 scratch = kmalloc(len, GFP_KERNEL | GFP_DMA);
787 ret = regmap_raw_read(dsp->regmap, reg, scratch, len);
789 adsp_err(dsp, "Failed to read %zu bytes from %x: %d\n",
794 adsp_dbg(dsp, "Read %zu bytes from %x\n", len, reg);
796 memcpy(buf, scratch, len);
802 static int wm_coeff_get(struct snd_kcontrol *kctl,
803 struct snd_ctl_elem_value *ucontrol)
805 struct wm_coeff_ctl *ctl = (struct wm_coeff_ctl *)kctl->private_value;
806 char *p = ucontrol->value.bytes.data;
809 mutex_lock(&ctl->dsp->pwr_lock);
811 if (ctl->flags & WMFW_CTL_FLAG_VOLATILE) {
813 ret = wm_coeff_read_control(ctl, p, ctl->len);
817 if (!ctl->flags && ctl->enabled)
818 ret = wm_coeff_read_control(ctl, ctl->cache, ctl->len);
820 memcpy(p, ctl->cache, ctl->len);
823 mutex_unlock(&ctl->dsp->pwr_lock);
828 struct wmfw_ctl_work {
830 struct wm_coeff_ctl *ctl;
831 struct work_struct work;
834 static int wmfw_add_ctl(struct wm_adsp *dsp, struct wm_coeff_ctl *ctl)
836 struct snd_kcontrol_new *kcontrol;
839 if (!ctl || !ctl->name)
842 kcontrol = kzalloc(sizeof(*kcontrol), GFP_KERNEL);
845 kcontrol->iface = SNDRV_CTL_ELEM_IFACE_MIXER;
847 kcontrol->name = ctl->name;
848 kcontrol->info = wm_coeff_info;
849 kcontrol->get = wm_coeff_get;
850 kcontrol->put = wm_coeff_put;
851 kcontrol->private_value = (unsigned long)ctl;
854 if (ctl->flags & WMFW_CTL_FLAG_WRITEABLE)
855 kcontrol->access |= SNDRV_CTL_ELEM_ACCESS_WRITE;
856 if (ctl->flags & WMFW_CTL_FLAG_READABLE)
857 kcontrol->access |= SNDRV_CTL_ELEM_ACCESS_READ;
858 if (ctl->flags & WMFW_CTL_FLAG_VOLATILE)
859 kcontrol->access |= SNDRV_CTL_ELEM_ACCESS_VOLATILE;
861 kcontrol->access = SNDRV_CTL_ELEM_ACCESS_READWRITE;
862 kcontrol->access |= SNDRV_CTL_ELEM_ACCESS_VOLATILE;
865 ret = snd_soc_add_card_controls(dsp->card, kcontrol, 1);
871 ctl->kcontrol = snd_soc_card_get_kcontrol(dsp->card, ctl->name);
880 static int wm_coeff_init_control_caches(struct wm_adsp *dsp)
882 struct wm_coeff_ctl *ctl;
885 list_for_each_entry(ctl, &dsp->ctl_list, list) {
886 if (!ctl->enabled || ctl->set)
888 if (ctl->flags & WMFW_CTL_FLAG_VOLATILE)
891 ret = wm_coeff_read_control(ctl, ctl->cache, ctl->len);
899 static int wm_coeff_sync_controls(struct wm_adsp *dsp)
901 struct wm_coeff_ctl *ctl;
904 list_for_each_entry(ctl, &dsp->ctl_list, list) {
907 if (ctl->set && !(ctl->flags & WMFW_CTL_FLAG_VOLATILE)) {
908 ret = wm_coeff_write_control(ctl, ctl->cache, ctl->len);
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", ret);
1506 return ERR_PTR(ret);
1512 static struct wm_adsp_alg_region *
1513 wm_adsp_find_alg_region(struct wm_adsp *dsp, int type, unsigned int id)
1515 struct wm_adsp_alg_region *alg_region;
1517 list_for_each_entry(alg_region, &dsp->alg_regions, list) {
1518 if (id == alg_region->alg && type == alg_region->type)
1525 static struct wm_adsp_alg_region *wm_adsp_create_region(struct wm_adsp *dsp,
1526 int type, __be32 id,
1529 struct wm_adsp_alg_region *alg_region;
1531 alg_region = kzalloc(sizeof(*alg_region), GFP_KERNEL);
1533 return ERR_PTR(-ENOMEM);
1535 alg_region->type = type;
1536 alg_region->alg = be32_to_cpu(id);
1537 alg_region->base = be32_to_cpu(base);
1539 list_add_tail(&alg_region->list, &dsp->alg_regions);
1541 if (dsp->fw_ver > 0)
1542 wm_adsp_ctl_fixup_base(dsp, alg_region);
1547 static int wm_adsp1_setup_algs(struct wm_adsp *dsp)
1549 struct wmfw_adsp1_id_hdr adsp1_id;
1550 struct wmfw_adsp1_alg_hdr *adsp1_alg;
1551 struct wm_adsp_alg_region *alg_region;
1552 const struct wm_adsp_region *mem;
1553 unsigned int pos, len;
1557 mem = wm_adsp_find_region(dsp, WMFW_ADSP1_DM);
1561 ret = regmap_raw_read(dsp->regmap, mem->base, &adsp1_id,
1564 adsp_err(dsp, "Failed to read algorithm info: %d\n",
1569 n_algs = be32_to_cpu(adsp1_id.n_algs);
1570 dsp->fw_id = be32_to_cpu(adsp1_id.fw.id);
1571 adsp_info(dsp, "Firmware: %x v%d.%d.%d, %zu algorithms\n",
1573 (be32_to_cpu(adsp1_id.fw.ver) & 0xff0000) >> 16,
1574 (be32_to_cpu(adsp1_id.fw.ver) & 0xff00) >> 8,
1575 be32_to_cpu(adsp1_id.fw.ver) & 0xff,
1578 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP1_ZM,
1579 adsp1_id.fw.id, adsp1_id.zm);
1580 if (IS_ERR(alg_region))
1581 return PTR_ERR(alg_region);
1583 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP1_DM,
1584 adsp1_id.fw.id, adsp1_id.dm);
1585 if (IS_ERR(alg_region))
1586 return PTR_ERR(alg_region);
1588 pos = sizeof(adsp1_id) / 2;
1589 len = (sizeof(*adsp1_alg) * n_algs) / 2;
1591 adsp1_alg = wm_adsp_read_algs(dsp, n_algs, mem->base + pos, len);
1592 if (IS_ERR(adsp1_alg))
1593 return PTR_ERR(adsp1_alg);
1595 for (i = 0; i < n_algs; i++) {
1596 adsp_info(dsp, "%d: ID %x v%d.%d.%d DM@%x ZM@%x\n",
1597 i, be32_to_cpu(adsp1_alg[i].alg.id),
1598 (be32_to_cpu(adsp1_alg[i].alg.ver) & 0xff0000) >> 16,
1599 (be32_to_cpu(adsp1_alg[i].alg.ver) & 0xff00) >> 8,
1600 be32_to_cpu(adsp1_alg[i].alg.ver) & 0xff,
1601 be32_to_cpu(adsp1_alg[i].dm),
1602 be32_to_cpu(adsp1_alg[i].zm));
1604 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP1_DM,
1605 adsp1_alg[i].alg.id,
1607 if (IS_ERR(alg_region)) {
1608 ret = PTR_ERR(alg_region);
1611 if (dsp->fw_ver == 0) {
1612 if (i + 1 < n_algs) {
1613 len = be32_to_cpu(adsp1_alg[i + 1].dm);
1614 len -= be32_to_cpu(adsp1_alg[i].dm);
1616 wm_adsp_create_control(dsp, alg_region, 0,
1619 adsp_warn(dsp, "Missing length info for region DM with ID %x\n",
1620 be32_to_cpu(adsp1_alg[i].alg.id));
1624 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP1_ZM,
1625 adsp1_alg[i].alg.id,
1627 if (IS_ERR(alg_region)) {
1628 ret = PTR_ERR(alg_region);
1631 if (dsp->fw_ver == 0) {
1632 if (i + 1 < n_algs) {
1633 len = be32_to_cpu(adsp1_alg[i + 1].zm);
1634 len -= be32_to_cpu(adsp1_alg[i].zm);
1636 wm_adsp_create_control(dsp, alg_region, 0,
1639 adsp_warn(dsp, "Missing length info for region ZM with ID %x\n",
1640 be32_to_cpu(adsp1_alg[i].alg.id));
1650 static int wm_adsp2_setup_algs(struct wm_adsp *dsp)
1652 struct wmfw_adsp2_id_hdr adsp2_id;
1653 struct wmfw_adsp2_alg_hdr *adsp2_alg;
1654 struct wm_adsp_alg_region *alg_region;
1655 const struct wm_adsp_region *mem;
1656 unsigned int pos, len;
1660 mem = wm_adsp_find_region(dsp, WMFW_ADSP2_XM);
1664 ret = regmap_raw_read(dsp->regmap, mem->base, &adsp2_id,
1667 adsp_err(dsp, "Failed to read algorithm info: %d\n",
1672 n_algs = be32_to_cpu(adsp2_id.n_algs);
1673 dsp->fw_id = be32_to_cpu(adsp2_id.fw.id);
1674 dsp->fw_id_version = be32_to_cpu(adsp2_id.fw.ver);
1675 adsp_info(dsp, "Firmware: %x v%d.%d.%d, %zu algorithms\n",
1677 (dsp->fw_id_version & 0xff0000) >> 16,
1678 (dsp->fw_id_version & 0xff00) >> 8,
1679 dsp->fw_id_version & 0xff,
1682 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_XM,
1683 adsp2_id.fw.id, adsp2_id.xm);
1684 if (IS_ERR(alg_region))
1685 return PTR_ERR(alg_region);
1687 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_YM,
1688 adsp2_id.fw.id, adsp2_id.ym);
1689 if (IS_ERR(alg_region))
1690 return PTR_ERR(alg_region);
1692 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_ZM,
1693 adsp2_id.fw.id, adsp2_id.zm);
1694 if (IS_ERR(alg_region))
1695 return PTR_ERR(alg_region);
1697 pos = sizeof(adsp2_id) / 2;
1698 len = (sizeof(*adsp2_alg) * n_algs) / 2;
1700 adsp2_alg = wm_adsp_read_algs(dsp, n_algs, mem->base + pos, len);
1701 if (IS_ERR(adsp2_alg))
1702 return PTR_ERR(adsp2_alg);
1704 for (i = 0; i < n_algs; i++) {
1706 "%d: ID %x v%d.%d.%d XM@%x YM@%x ZM@%x\n",
1707 i, be32_to_cpu(adsp2_alg[i].alg.id),
1708 (be32_to_cpu(adsp2_alg[i].alg.ver) & 0xff0000) >> 16,
1709 (be32_to_cpu(adsp2_alg[i].alg.ver) & 0xff00) >> 8,
1710 be32_to_cpu(adsp2_alg[i].alg.ver) & 0xff,
1711 be32_to_cpu(adsp2_alg[i].xm),
1712 be32_to_cpu(adsp2_alg[i].ym),
1713 be32_to_cpu(adsp2_alg[i].zm));
1715 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_XM,
1716 adsp2_alg[i].alg.id,
1718 if (IS_ERR(alg_region)) {
1719 ret = PTR_ERR(alg_region);
1722 if (dsp->fw_ver == 0) {
1723 if (i + 1 < n_algs) {
1724 len = be32_to_cpu(adsp2_alg[i + 1].xm);
1725 len -= be32_to_cpu(adsp2_alg[i].xm);
1727 wm_adsp_create_control(dsp, alg_region, 0,
1730 adsp_warn(dsp, "Missing length info for region XM with ID %x\n",
1731 be32_to_cpu(adsp2_alg[i].alg.id));
1735 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_YM,
1736 adsp2_alg[i].alg.id,
1738 if (IS_ERR(alg_region)) {
1739 ret = PTR_ERR(alg_region);
1742 if (dsp->fw_ver == 0) {
1743 if (i + 1 < n_algs) {
1744 len = be32_to_cpu(adsp2_alg[i + 1].ym);
1745 len -= be32_to_cpu(adsp2_alg[i].ym);
1747 wm_adsp_create_control(dsp, alg_region, 0,
1750 adsp_warn(dsp, "Missing length info for region YM with ID %x\n",
1751 be32_to_cpu(adsp2_alg[i].alg.id));
1755 alg_region = wm_adsp_create_region(dsp, WMFW_ADSP2_ZM,
1756 adsp2_alg[i].alg.id,
1758 if (IS_ERR(alg_region)) {
1759 ret = PTR_ERR(alg_region);
1762 if (dsp->fw_ver == 0) {
1763 if (i + 1 < n_algs) {
1764 len = be32_to_cpu(adsp2_alg[i + 1].zm);
1765 len -= be32_to_cpu(adsp2_alg[i].zm);
1767 wm_adsp_create_control(dsp, alg_region, 0,
1770 adsp_warn(dsp, "Missing length info for region ZM with ID %x\n",
1771 be32_to_cpu(adsp2_alg[i].alg.id));
1781 static int wm_adsp_load_coeff(struct wm_adsp *dsp)
1783 LIST_HEAD(buf_list);
1784 struct regmap *regmap = dsp->regmap;
1785 struct wmfw_coeff_hdr *hdr;
1786 struct wmfw_coeff_item *blk;
1787 const struct firmware *firmware;
1788 const struct wm_adsp_region *mem;
1789 struct wm_adsp_alg_region *alg_region;
1790 const char *region_name;
1791 int ret, pos, blocks, type, offset, reg;
1793 struct wm_adsp_buf *buf;
1795 file = kzalloc(PAGE_SIZE, GFP_KERNEL);
1799 snprintf(file, PAGE_SIZE, "%s-dsp%d-%s.bin", dsp->part, dsp->num,
1800 wm_adsp_fw[dsp->fw].file);
1801 file[PAGE_SIZE - 1] = '\0';
1803 ret = request_firmware(&firmware, file, dsp->dev);
1805 adsp_warn(dsp, "Failed to request '%s'\n", file);
1811 if (sizeof(*hdr) >= firmware->size) {
1812 adsp_err(dsp, "%s: file too short, %zu bytes\n",
1813 file, firmware->size);
1817 hdr = (void *)&firmware->data[0];
1818 if (memcmp(hdr->magic, "WMDR", 4) != 0) {
1819 adsp_err(dsp, "%s: invalid magic\n", file);
1823 switch (be32_to_cpu(hdr->rev) & 0xff) {
1827 adsp_err(dsp, "%s: Unsupported coefficient file format %d\n",
1828 file, be32_to_cpu(hdr->rev) & 0xff);
1833 adsp_dbg(dsp, "%s: v%d.%d.%d\n", file,
1834 (le32_to_cpu(hdr->ver) >> 16) & 0xff,
1835 (le32_to_cpu(hdr->ver) >> 8) & 0xff,
1836 le32_to_cpu(hdr->ver) & 0xff);
1838 pos = le32_to_cpu(hdr->len);
1841 while (pos < firmware->size &&
1842 pos - firmware->size > sizeof(*blk)) {
1843 blk = (void *)(&firmware->data[pos]);
1845 type = le16_to_cpu(blk->type);
1846 offset = le16_to_cpu(blk->offset);
1848 adsp_dbg(dsp, "%s.%d: %x v%d.%d.%d\n",
1849 file, blocks, le32_to_cpu(blk->id),
1850 (le32_to_cpu(blk->ver) >> 16) & 0xff,
1851 (le32_to_cpu(blk->ver) >> 8) & 0xff,
1852 le32_to_cpu(blk->ver) & 0xff);
1853 adsp_dbg(dsp, "%s.%d: %d bytes at 0x%x in %x\n",
1854 file, blocks, le32_to_cpu(blk->len), offset, type);
1857 region_name = "Unknown";
1859 case (WMFW_NAME_TEXT << 8):
1860 case (WMFW_INFO_TEXT << 8):
1862 case (WMFW_ABSOLUTE << 8):
1864 * Old files may use this for global
1867 if (le32_to_cpu(blk->id) == dsp->fw_id &&
1869 region_name = "global coefficients";
1870 mem = wm_adsp_find_region(dsp, type);
1872 adsp_err(dsp, "No ZM\n");
1875 reg = wm_adsp_region_to_reg(mem, 0);
1878 region_name = "register";
1887 adsp_dbg(dsp, "%s.%d: %d bytes in %x for %x\n",
1888 file, blocks, le32_to_cpu(blk->len),
1889 type, le32_to_cpu(blk->id));
1891 mem = wm_adsp_find_region(dsp, type);
1893 adsp_err(dsp, "No base for region %x\n", type);
1897 alg_region = wm_adsp_find_alg_region(dsp, type,
1898 le32_to_cpu(blk->id));
1900 reg = alg_region->base;
1901 reg = wm_adsp_region_to_reg(mem, reg);
1904 adsp_err(dsp, "No %x for algorithm %x\n",
1905 type, le32_to_cpu(blk->id));
1910 adsp_err(dsp, "%s.%d: Unknown region type %x at %d\n",
1911 file, blocks, type, pos);
1916 buf = wm_adsp_buf_alloc(blk->data,
1917 le32_to_cpu(blk->len),
1920 adsp_err(dsp, "Out of memory\n");
1925 adsp_dbg(dsp, "%s.%d: Writing %d bytes at %x\n",
1926 file, blocks, le32_to_cpu(blk->len),
1928 ret = regmap_raw_write_async(regmap, reg, buf->buf,
1929 le32_to_cpu(blk->len));
1932 "%s.%d: Failed to write to %x in %s: %d\n",
1933 file, blocks, reg, region_name, ret);
1937 pos += (le32_to_cpu(blk->len) + sizeof(*blk) + 3) & ~0x03;
1941 ret = regmap_async_complete(regmap);
1943 adsp_err(dsp, "Failed to complete async write: %d\n", ret);
1945 if (pos > firmware->size)
1946 adsp_warn(dsp, "%s.%d: %zu bytes at end of file\n",
1947 file, blocks, pos - firmware->size);
1949 wm_adsp_debugfs_save_binname(dsp, file);
1952 regmap_async_complete(regmap);
1953 release_firmware(firmware);
1954 wm_adsp_buf_free(&buf_list);
1960 int wm_adsp1_init(struct wm_adsp *dsp)
1962 INIT_LIST_HEAD(&dsp->alg_regions);
1964 mutex_init(&dsp->pwr_lock);
1968 EXPORT_SYMBOL_GPL(wm_adsp1_init);
1970 int wm_adsp1_event(struct snd_soc_dapm_widget *w,
1971 struct snd_kcontrol *kcontrol,
1974 struct snd_soc_codec *codec = snd_soc_dapm_to_codec(w->dapm);
1975 struct wm_adsp *dsps = snd_soc_codec_get_drvdata(codec);
1976 struct wm_adsp *dsp = &dsps[w->shift];
1977 struct wm_adsp_alg_region *alg_region;
1978 struct wm_coeff_ctl *ctl;
1982 dsp->card = codec->component.card;
1984 mutex_lock(&dsp->pwr_lock);
1987 case SND_SOC_DAPM_POST_PMU:
1988 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
1989 ADSP1_SYS_ENA, ADSP1_SYS_ENA);
1992 * For simplicity set the DSP clock rate to be the
1993 * SYSCLK rate rather than making it configurable.
1995 if (dsp->sysclk_reg) {
1996 ret = regmap_read(dsp->regmap, dsp->sysclk_reg, &val);
1998 adsp_err(dsp, "Failed to read SYSCLK state: %d\n",
2003 val = (val & dsp->sysclk_mask) >> dsp->sysclk_shift;
2005 ret = regmap_update_bits(dsp->regmap,
2006 dsp->base + ADSP1_CONTROL_31,
2007 ADSP1_CLK_SEL_MASK, val);
2009 adsp_err(dsp, "Failed to set clock rate: %d\n",
2015 ret = wm_adsp_load(dsp);
2019 ret = wm_adsp1_setup_algs(dsp);
2023 ret = wm_adsp_load_coeff(dsp);
2027 /* Initialize caches for enabled and unset controls */
2028 ret = wm_coeff_init_control_caches(dsp);
2032 /* Sync set controls */
2033 ret = wm_coeff_sync_controls(dsp);
2037 /* Start the core running */
2038 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2039 ADSP1_CORE_ENA | ADSP1_START,
2040 ADSP1_CORE_ENA | ADSP1_START);
2043 case SND_SOC_DAPM_PRE_PMD:
2045 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2046 ADSP1_CORE_ENA | ADSP1_START, 0);
2048 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_19,
2049 ADSP1_WDMA_BUFFER_LENGTH_MASK, 0);
2051 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2054 list_for_each_entry(ctl, &dsp->ctl_list, list)
2057 while (!list_empty(&dsp->alg_regions)) {
2058 alg_region = list_first_entry(&dsp->alg_regions,
2059 struct wm_adsp_alg_region,
2061 list_del(&alg_region->list);
2070 mutex_unlock(&dsp->pwr_lock);
2075 regmap_update_bits(dsp->regmap, dsp->base + ADSP1_CONTROL_30,
2078 mutex_unlock(&dsp->pwr_lock);
2082 EXPORT_SYMBOL_GPL(wm_adsp1_event);
2084 static int wm_adsp2_ena(struct wm_adsp *dsp)
2089 ret = regmap_update_bits_async(dsp->regmap, dsp->base + ADSP2_CONTROL,
2090 ADSP2_SYS_ENA, ADSP2_SYS_ENA);
2094 /* Wait for the RAM to start, should be near instantaneous */
2095 for (count = 0; count < 10; ++count) {
2096 ret = regmap_read(dsp->regmap, dsp->base + ADSP2_STATUS1, &val);
2100 if (val & ADSP2_RAM_RDY)
2106 if (!(val & ADSP2_RAM_RDY)) {
2107 adsp_err(dsp, "Failed to start DSP RAM\n");
2111 adsp_dbg(dsp, "RAM ready after %d polls\n", count);
2116 static void wm_adsp2_boot_work(struct work_struct *work)
2118 struct wm_adsp *dsp = container_of(work,
2124 mutex_lock(&dsp->pwr_lock);
2127 * For simplicity set the DSP clock rate to be the
2128 * SYSCLK rate rather than making it configurable.
2130 ret = regmap_read(dsp->regmap, ARIZONA_SYSTEM_CLOCK_1, &val);
2132 adsp_err(dsp, "Failed to read SYSCLK state: %d\n", ret);
2135 val = (val & ARIZONA_SYSCLK_FREQ_MASK)
2136 >> ARIZONA_SYSCLK_FREQ_SHIFT;
2138 ret = regmap_update_bits_async(dsp->regmap,
2139 dsp->base + ADSP2_CLOCKING,
2140 ADSP2_CLK_SEL_MASK, val);
2142 adsp_err(dsp, "Failed to set clock rate: %d\n", ret);
2146 ret = wm_adsp2_ena(dsp);
2150 ret = wm_adsp_load(dsp);
2154 ret = wm_adsp2_setup_algs(dsp);
2158 ret = wm_adsp_load_coeff(dsp);
2162 /* Initialize caches for enabled and unset controls */
2163 ret = wm_coeff_init_control_caches(dsp);
2167 /* Sync set controls */
2168 ret = wm_coeff_sync_controls(dsp);
2172 dsp->running = true;
2174 mutex_unlock(&dsp->pwr_lock);
2179 regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
2180 ADSP2_SYS_ENA | ADSP2_CORE_ENA | ADSP2_START, 0);
2182 mutex_unlock(&dsp->pwr_lock);
2185 int wm_adsp2_early_event(struct snd_soc_dapm_widget *w,
2186 struct snd_kcontrol *kcontrol, int event)
2188 struct snd_soc_codec *codec = snd_soc_dapm_to_codec(w->dapm);
2189 struct wm_adsp *dsps = snd_soc_codec_get_drvdata(codec);
2190 struct wm_adsp *dsp = &dsps[w->shift];
2192 dsp->card = codec->component.card;
2195 case SND_SOC_DAPM_PRE_PMU:
2196 queue_work(system_unbound_wq, &dsp->boot_work);
2204 EXPORT_SYMBOL_GPL(wm_adsp2_early_event);
2206 int wm_adsp2_event(struct snd_soc_dapm_widget *w,
2207 struct snd_kcontrol *kcontrol, int event)
2209 struct snd_soc_codec *codec = snd_soc_dapm_to_codec(w->dapm);
2210 struct wm_adsp *dsps = snd_soc_codec_get_drvdata(codec);
2211 struct wm_adsp *dsp = &dsps[w->shift];
2212 struct wm_adsp_alg_region *alg_region;
2213 struct wm_coeff_ctl *ctl;
2217 case SND_SOC_DAPM_POST_PMU:
2218 flush_work(&dsp->boot_work);
2223 ret = regmap_update_bits(dsp->regmap,
2224 dsp->base + ADSP2_CONTROL,
2225 ADSP2_CORE_ENA | ADSP2_START,
2226 ADSP2_CORE_ENA | ADSP2_START);
2230 if (wm_adsp_fw[dsp->fw].num_caps != 0)
2231 ret = wm_adsp_buffer_init(dsp);
2235 case SND_SOC_DAPM_PRE_PMD:
2236 /* Log firmware state, it can be useful for analysis */
2237 wm_adsp2_show_fw_status(dsp);
2239 mutex_lock(&dsp->pwr_lock);
2241 wm_adsp_debugfs_clear(dsp);
2244 dsp->fw_id_version = 0;
2245 dsp->running = false;
2247 regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
2248 ADSP2_SYS_ENA | ADSP2_CORE_ENA |
2251 /* Make sure DMAs are quiesced */
2252 regmap_write(dsp->regmap, dsp->base + ADSP2_WDMA_CONFIG_1, 0);
2253 regmap_write(dsp->regmap, dsp->base + ADSP2_WDMA_CONFIG_2, 0);
2254 regmap_write(dsp->regmap, dsp->base + ADSP2_RDMA_CONFIG_1, 0);
2256 list_for_each_entry(ctl, &dsp->ctl_list, list)
2259 while (!list_empty(&dsp->alg_regions)) {
2260 alg_region = list_first_entry(&dsp->alg_regions,
2261 struct wm_adsp_alg_region,
2263 list_del(&alg_region->list);
2267 if (wm_adsp_fw[dsp->fw].num_caps != 0)
2268 wm_adsp_buffer_free(dsp);
2270 mutex_unlock(&dsp->pwr_lock);
2272 adsp_dbg(dsp, "Shutdown complete\n");
2281 regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
2282 ADSP2_SYS_ENA | ADSP2_CORE_ENA | ADSP2_START, 0);
2285 EXPORT_SYMBOL_GPL(wm_adsp2_event);
2287 int wm_adsp2_codec_probe(struct wm_adsp *dsp, struct snd_soc_codec *codec)
2289 wm_adsp2_init_debugfs(dsp, codec);
2291 return snd_soc_add_codec_controls(codec,
2292 &wm_adsp_fw_controls[dsp->num - 1],
2295 EXPORT_SYMBOL_GPL(wm_adsp2_codec_probe);
2297 int wm_adsp2_codec_remove(struct wm_adsp *dsp, struct snd_soc_codec *codec)
2299 wm_adsp2_cleanup_debugfs(dsp);
2303 EXPORT_SYMBOL_GPL(wm_adsp2_codec_remove);
2305 int wm_adsp2_init(struct wm_adsp *dsp)
2310 * Disable the DSP memory by default when in reset for a small
2313 ret = regmap_update_bits(dsp->regmap, dsp->base + ADSP2_CONTROL,
2316 adsp_err(dsp, "Failed to clear memory retention: %d\n", ret);
2320 INIT_LIST_HEAD(&dsp->alg_regions);
2321 INIT_LIST_HEAD(&dsp->ctl_list);
2322 INIT_WORK(&dsp->boot_work, wm_adsp2_boot_work);
2324 mutex_init(&dsp->pwr_lock);
2328 EXPORT_SYMBOL_GPL(wm_adsp2_init);
2330 int wm_adsp_compr_open(struct wm_adsp *dsp, struct snd_compr_stream *stream)
2332 struct wm_adsp_compr *compr;
2335 mutex_lock(&dsp->pwr_lock);
2337 if (wm_adsp_fw[dsp->fw].num_caps == 0) {
2338 adsp_err(dsp, "Firmware does not support compressed API\n");
2343 if (wm_adsp_fw[dsp->fw].compr_direction != stream->direction) {
2344 adsp_err(dsp, "Firmware does not support stream direction\n");
2350 /* It is expect this limitation will be removed in future */
2351 adsp_err(dsp, "Only a single stream supported per DSP\n");
2356 compr = kzalloc(sizeof(*compr), GFP_KERNEL);
2363 compr->stream = stream;
2367 stream->runtime->private_data = compr;
2370 mutex_unlock(&dsp->pwr_lock);
2374 EXPORT_SYMBOL_GPL(wm_adsp_compr_open);
2376 int wm_adsp_compr_free(struct snd_compr_stream *stream)
2378 struct wm_adsp_compr *compr = stream->runtime->private_data;
2379 struct wm_adsp *dsp = compr->dsp;
2381 mutex_lock(&dsp->pwr_lock);
2385 kfree(compr->raw_buf);
2388 mutex_unlock(&dsp->pwr_lock);
2392 EXPORT_SYMBOL_GPL(wm_adsp_compr_free);
2394 static int wm_adsp_compr_check_params(struct snd_compr_stream *stream,
2395 struct snd_compr_params *params)
2397 struct wm_adsp_compr *compr = stream->runtime->private_data;
2398 struct wm_adsp *dsp = compr->dsp;
2399 const struct wm_adsp_fw_caps *caps;
2400 const struct snd_codec_desc *desc;
2403 if (params->buffer.fragment_size < WM_ADSP_MIN_FRAGMENT_SIZE ||
2404 params->buffer.fragment_size > WM_ADSP_MAX_FRAGMENT_SIZE ||
2405 params->buffer.fragments < WM_ADSP_MIN_FRAGMENTS ||
2406 params->buffer.fragments > WM_ADSP_MAX_FRAGMENTS ||
2407 params->buffer.fragment_size % WM_ADSP_DATA_WORD_SIZE) {
2408 adsp_err(dsp, "Invalid buffer fragsize=%d fragments=%d\n",
2409 params->buffer.fragment_size,
2410 params->buffer.fragments);
2415 for (i = 0; i < wm_adsp_fw[dsp->fw].num_caps; i++) {
2416 caps = &wm_adsp_fw[dsp->fw].caps[i];
2419 if (caps->id != params->codec.id)
2422 if (stream->direction == SND_COMPRESS_PLAYBACK) {
2423 if (desc->max_ch < params->codec.ch_out)
2426 if (desc->max_ch < params->codec.ch_in)
2430 if (!(desc->formats & (1 << params->codec.format)))
2433 for (j = 0; j < desc->num_sample_rates; ++j)
2434 if (desc->sample_rates[j] == params->codec.sample_rate)
2438 adsp_err(dsp, "Invalid params id=%u ch=%u,%u rate=%u fmt=%u\n",
2439 params->codec.id, params->codec.ch_in, params->codec.ch_out,
2440 params->codec.sample_rate, params->codec.format);
2444 static inline unsigned int wm_adsp_compr_frag_words(struct wm_adsp_compr *compr)
2446 return compr->size.fragment_size / WM_ADSP_DATA_WORD_SIZE;
2449 int wm_adsp_compr_set_params(struct snd_compr_stream *stream,
2450 struct snd_compr_params *params)
2452 struct wm_adsp_compr *compr = stream->runtime->private_data;
2456 ret = wm_adsp_compr_check_params(stream, params);
2460 compr->size = params->buffer;
2462 adsp_dbg(compr->dsp, "fragment_size=%d fragments=%d\n",
2463 compr->size.fragment_size, compr->size.fragments);
2465 size = wm_adsp_compr_frag_words(compr) * sizeof(*compr->raw_buf);
2466 compr->raw_buf = kmalloc(size, GFP_DMA | GFP_KERNEL);
2467 if (!compr->raw_buf)
2470 compr->sample_rate = params->codec.sample_rate;
2474 EXPORT_SYMBOL_GPL(wm_adsp_compr_set_params);
2476 int wm_adsp_compr_get_caps(struct snd_compr_stream *stream,
2477 struct snd_compr_caps *caps)
2479 struct wm_adsp_compr *compr = stream->runtime->private_data;
2480 int fw = compr->dsp->fw;
2483 if (wm_adsp_fw[fw].caps) {
2484 for (i = 0; i < wm_adsp_fw[fw].num_caps; i++)
2485 caps->codecs[i] = wm_adsp_fw[fw].caps[i].id;
2487 caps->num_codecs = i;
2488 caps->direction = wm_adsp_fw[fw].compr_direction;
2490 caps->min_fragment_size = WM_ADSP_MIN_FRAGMENT_SIZE;
2491 caps->max_fragment_size = WM_ADSP_MAX_FRAGMENT_SIZE;
2492 caps->min_fragments = WM_ADSP_MIN_FRAGMENTS;
2493 caps->max_fragments = WM_ADSP_MAX_FRAGMENTS;
2498 EXPORT_SYMBOL_GPL(wm_adsp_compr_get_caps);
2500 static int wm_adsp_read_data_block(struct wm_adsp *dsp, int mem_type,
2501 unsigned int mem_addr,
2502 unsigned int num_words, u32 *data)
2504 struct wm_adsp_region const *mem = wm_adsp_find_region(dsp, mem_type);
2505 unsigned int i, reg;
2511 reg = wm_adsp_region_to_reg(mem, mem_addr);
2513 ret = regmap_raw_read(dsp->regmap, reg, data,
2514 sizeof(*data) * num_words);
2518 for (i = 0; i < num_words; ++i)
2519 data[i] = be32_to_cpu(data[i]) & 0x00ffffffu;
2524 static inline int wm_adsp_read_data_word(struct wm_adsp *dsp, int mem_type,
2525 unsigned int mem_addr, u32 *data)
2527 return wm_adsp_read_data_block(dsp, mem_type, mem_addr, 1, data);
2530 static int wm_adsp_write_data_word(struct wm_adsp *dsp, int mem_type,
2531 unsigned int mem_addr, u32 data)
2533 struct wm_adsp_region const *mem = wm_adsp_find_region(dsp, mem_type);
2539 reg = wm_adsp_region_to_reg(mem, mem_addr);
2541 data = cpu_to_be32(data & 0x00ffffffu);
2543 return regmap_raw_write(dsp->regmap, reg, &data, sizeof(data));
2546 static inline int wm_adsp_buffer_read(struct wm_adsp_compr_buf *buf,
2547 unsigned int field_offset, u32 *data)
2549 return wm_adsp_read_data_word(buf->dsp, WMFW_ADSP2_XM,
2550 buf->host_buf_ptr + field_offset, data);
2553 static inline int wm_adsp_buffer_write(struct wm_adsp_compr_buf *buf,
2554 unsigned int field_offset, u32 data)
2556 return wm_adsp_write_data_word(buf->dsp, WMFW_ADSP2_XM,
2557 buf->host_buf_ptr + field_offset, data);
2560 static int wm_adsp_buffer_locate(struct wm_adsp_compr_buf *buf)
2562 struct wm_adsp_alg_region *alg_region;
2563 struct wm_adsp *dsp = buf->dsp;
2564 u32 xmalg, addr, magic;
2567 alg_region = wm_adsp_find_alg_region(dsp, WMFW_ADSP2_XM, dsp->fw_id);
2568 xmalg = sizeof(struct wm_adsp_system_config_xm_hdr) / sizeof(__be32);
2570 addr = alg_region->base + xmalg + ALG_XM_FIELD(magic);
2571 ret = wm_adsp_read_data_word(dsp, WMFW_ADSP2_XM, addr, &magic);
2575 if (magic != WM_ADSP_ALG_XM_STRUCT_MAGIC)
2578 addr = alg_region->base + xmalg + ALG_XM_FIELD(host_buf_ptr);
2579 for (i = 0; i < 5; ++i) {
2580 ret = wm_adsp_read_data_word(dsp, WMFW_ADSP2_XM, addr,
2581 &buf->host_buf_ptr);
2585 if (buf->host_buf_ptr)
2588 usleep_range(1000, 2000);
2591 if (!buf->host_buf_ptr)
2594 adsp_dbg(dsp, "host_buf_ptr=%x\n", buf->host_buf_ptr);
2599 static int wm_adsp_buffer_populate(struct wm_adsp_compr_buf *buf)
2601 const struct wm_adsp_fw_caps *caps = wm_adsp_fw[buf->dsp->fw].caps;
2602 struct wm_adsp_buffer_region *region;
2606 for (i = 0; i < caps->num_regions; ++i) {
2607 region = &buf->regions[i];
2609 region->offset = offset;
2610 region->mem_type = caps->region_defs[i].mem_type;
2612 ret = wm_adsp_buffer_read(buf, caps->region_defs[i].base_offset,
2613 ®ion->base_addr);
2617 ret = wm_adsp_buffer_read(buf, caps->region_defs[i].size_offset,
2622 region->cumulative_size = offset;
2625 "region=%d type=%d base=%04x off=%04x size=%04x\n",
2626 i, region->mem_type, region->base_addr,
2627 region->offset, region->cumulative_size);
2633 static int wm_adsp_buffer_init(struct wm_adsp *dsp)
2635 struct wm_adsp_compr_buf *buf;
2638 buf = kzalloc(sizeof(*buf), GFP_KERNEL);
2643 buf->read_index = -1;
2644 buf->irq_count = 0xFFFFFFFF;
2646 ret = wm_adsp_buffer_locate(buf);
2648 adsp_err(dsp, "Failed to acquire host buffer: %d\n", ret);
2652 buf->regions = kcalloc(wm_adsp_fw[dsp->fw].caps->num_regions,
2653 sizeof(*buf->regions), GFP_KERNEL);
2654 if (!buf->regions) {
2659 ret = wm_adsp_buffer_populate(buf);
2661 adsp_err(dsp, "Failed to populate host buffer: %d\n", ret);
2670 kfree(buf->regions);
2676 static int wm_adsp_buffer_free(struct wm_adsp *dsp)
2679 kfree(dsp->buffer->regions);
2688 static inline int wm_adsp_compr_attached(struct wm_adsp_compr *compr)
2690 return compr->buf != NULL;
2693 static int wm_adsp_compr_attach(struct wm_adsp_compr *compr)
2696 * Note this will be more complex once each DSP can support multiple
2699 if (!compr->dsp->buffer)
2702 compr->buf = compr->dsp->buffer;
2707 int wm_adsp_compr_trigger(struct snd_compr_stream *stream, int cmd)
2709 struct wm_adsp_compr *compr = stream->runtime->private_data;
2710 struct wm_adsp *dsp = compr->dsp;
2713 adsp_dbg(dsp, "Trigger: %d\n", cmd);
2715 mutex_lock(&dsp->pwr_lock);
2718 case SNDRV_PCM_TRIGGER_START:
2719 if (wm_adsp_compr_attached(compr))
2722 ret = wm_adsp_compr_attach(compr);
2724 adsp_err(dsp, "Failed to link buffer and stream: %d\n",
2729 /* Trigger the IRQ at one fragment of data */
2730 ret = wm_adsp_buffer_write(compr->buf,
2731 HOST_BUFFER_FIELD(high_water_mark),
2732 wm_adsp_compr_frag_words(compr));
2734 adsp_err(dsp, "Failed to set high water mark: %d\n",
2739 case SNDRV_PCM_TRIGGER_STOP:
2746 mutex_unlock(&dsp->pwr_lock);
2750 EXPORT_SYMBOL_GPL(wm_adsp_compr_trigger);
2752 static inline int wm_adsp_buffer_size(struct wm_adsp_compr_buf *buf)
2754 int last_region = wm_adsp_fw[buf->dsp->fw].caps->num_regions - 1;
2756 return buf->regions[last_region].cumulative_size;
2759 static int wm_adsp_buffer_update_avail(struct wm_adsp_compr_buf *buf)
2761 u32 next_read_index, next_write_index;
2762 int write_index, read_index, avail;
2765 /* Only sync read index if we haven't already read a valid index */
2766 if (buf->read_index < 0) {
2767 ret = wm_adsp_buffer_read(buf,
2768 HOST_BUFFER_FIELD(next_read_index),
2773 read_index = sign_extend32(next_read_index, 23);
2775 if (read_index < 0) {
2776 adsp_dbg(buf->dsp, "Avail check on unstarted stream\n");
2780 buf->read_index = read_index;
2783 ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(next_write_index),
2788 write_index = sign_extend32(next_write_index, 23);
2790 avail = write_index - buf->read_index;
2792 avail += wm_adsp_buffer_size(buf);
2794 adsp_dbg(buf->dsp, "readindex=0x%x, writeindex=0x%x, avail=%d\n",
2795 buf->read_index, write_index, avail);
2802 int wm_adsp_compr_handle_irq(struct wm_adsp *dsp)
2804 struct wm_adsp_compr_buf *buf = dsp->buffer;
2805 struct wm_adsp_compr *compr = dsp->compr;
2808 mutex_lock(&dsp->pwr_lock);
2811 adsp_err(dsp, "Spurious buffer IRQ\n");
2816 adsp_dbg(dsp, "Handling buffer IRQ\n");
2818 ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(error), &buf->error);
2820 adsp_err(dsp, "Failed to check buffer error: %d\n", ret);
2823 if (buf->error != 0) {
2824 adsp_err(dsp, "Buffer error occurred: %d\n", buf->error);
2829 ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(irq_count),
2832 adsp_err(dsp, "Failed to get irq_count: %d\n", ret);
2836 ret = wm_adsp_buffer_update_avail(buf);
2838 adsp_err(dsp, "Error reading avail: %d\n", ret);
2842 if (compr && compr->stream)
2843 snd_compr_fragment_elapsed(compr->stream);
2846 mutex_unlock(&dsp->pwr_lock);
2850 EXPORT_SYMBOL_GPL(wm_adsp_compr_handle_irq);
2852 static int wm_adsp_buffer_reenable_irq(struct wm_adsp_compr_buf *buf)
2854 if (buf->irq_count & 0x01)
2857 adsp_dbg(buf->dsp, "Enable IRQ(0x%x) for next fragment\n",
2860 buf->irq_count |= 0x01;
2862 return wm_adsp_buffer_write(buf, HOST_BUFFER_FIELD(irq_ack),
2866 int wm_adsp_compr_pointer(struct snd_compr_stream *stream,
2867 struct snd_compr_tstamp *tstamp)
2869 struct wm_adsp_compr *compr = stream->runtime->private_data;
2870 struct wm_adsp_compr_buf *buf = compr->buf;
2871 struct wm_adsp *dsp = compr->dsp;
2874 adsp_dbg(dsp, "Pointer request\n");
2876 mutex_lock(&dsp->pwr_lock);
2883 if (compr->buf->error) {
2888 if (buf->avail < wm_adsp_compr_frag_words(compr)) {
2889 ret = wm_adsp_buffer_update_avail(buf);
2891 adsp_err(dsp, "Error reading avail: %d\n", ret);
2896 * If we really have less than 1 fragment available tell the
2897 * DSP to inform us once a whole fragment is available.
2899 if (buf->avail < wm_adsp_compr_frag_words(compr)) {
2900 ret = wm_adsp_buffer_reenable_irq(buf);
2903 "Failed to re-enable buffer IRQ: %d\n",
2910 tstamp->copied_total = compr->copied_total;
2911 tstamp->copied_total += buf->avail * WM_ADSP_DATA_WORD_SIZE;
2912 tstamp->sampling_rate = compr->sample_rate;
2915 mutex_unlock(&dsp->pwr_lock);
2919 EXPORT_SYMBOL_GPL(wm_adsp_compr_pointer);
2921 static int wm_adsp_buffer_capture_block(struct wm_adsp_compr *compr, int target)
2923 struct wm_adsp_compr_buf *buf = compr->buf;
2924 u8 *pack_in = (u8 *)compr->raw_buf;
2925 u8 *pack_out = (u8 *)compr->raw_buf;
2926 unsigned int adsp_addr;
2927 int mem_type, nwords, max_read;
2930 /* Calculate read parameters */
2931 for (i = 0; i < wm_adsp_fw[buf->dsp->fw].caps->num_regions; ++i)
2932 if (buf->read_index < buf->regions[i].cumulative_size)
2935 if (i == wm_adsp_fw[buf->dsp->fw].caps->num_regions)
2938 mem_type = buf->regions[i].mem_type;
2939 adsp_addr = buf->regions[i].base_addr +
2940 (buf->read_index - buf->regions[i].offset);
2942 max_read = wm_adsp_compr_frag_words(compr);
2943 nwords = buf->regions[i].cumulative_size - buf->read_index;
2945 if (nwords > target)
2947 if (nwords > buf->avail)
2948 nwords = buf->avail;
2949 if (nwords > max_read)
2954 /* Read data from DSP */
2955 ret = wm_adsp_read_data_block(buf->dsp, mem_type, adsp_addr,
2956 nwords, compr->raw_buf);
2960 /* Remove the padding bytes from the data read from the DSP */
2961 for (i = 0; i < nwords; i++) {
2962 for (j = 0; j < WM_ADSP_DATA_WORD_SIZE; j++)
2963 *pack_out++ = *pack_in++;
2965 pack_in += sizeof(*(compr->raw_buf)) - WM_ADSP_DATA_WORD_SIZE;
2968 /* update read index to account for words read */
2969 buf->read_index += nwords;
2970 if (buf->read_index == wm_adsp_buffer_size(buf))
2971 buf->read_index = 0;
2973 ret = wm_adsp_buffer_write(buf, HOST_BUFFER_FIELD(next_read_index),
2978 /* update avail to account for words read */
2979 buf->avail -= nwords;
2984 static int wm_adsp_compr_read(struct wm_adsp_compr *compr,
2985 char __user *buf, size_t count)
2987 struct wm_adsp *dsp = compr->dsp;
2991 adsp_dbg(dsp, "Requested read of %zu bytes\n", count);
2996 if (compr->buf->error)
2999 count /= WM_ADSP_DATA_WORD_SIZE;
3002 nwords = wm_adsp_buffer_capture_block(compr, count);
3004 adsp_err(dsp, "Failed to capture block: %d\n", nwords);
3008 nbytes = nwords * WM_ADSP_DATA_WORD_SIZE;
3010 adsp_dbg(dsp, "Read %d bytes\n", nbytes);
3012 if (copy_to_user(buf + ntotal, compr->raw_buf, nbytes)) {
3013 adsp_err(dsp, "Failed to copy data to user: %d, %d\n",
3020 } while (nwords > 0 && count > 0);
3022 compr->copied_total += ntotal;
3027 int wm_adsp_compr_copy(struct snd_compr_stream *stream, char __user *buf,
3030 struct wm_adsp_compr *compr = stream->runtime->private_data;
3031 struct wm_adsp *dsp = compr->dsp;
3034 mutex_lock(&dsp->pwr_lock);
3036 if (stream->direction == SND_COMPRESS_CAPTURE)
3037 ret = wm_adsp_compr_read(compr, buf, count);
3041 mutex_unlock(&dsp->pwr_lock);
3045 EXPORT_SYMBOL_GPL(wm_adsp_compr_copy);
3047 MODULE_LICENSE("GPL v2");