1 // SPDX-License-Identifier: GPL-2.0-only
3 * wm_adsp.c -- Wolfson ADSP support
5 * Copyright 2012 Wolfson Microelectronics plc
7 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
10 #include <linux/ctype.h>
11 #include <linux/module.h>
12 #include <linux/moduleparam.h>
13 #include <linux/init.h>
14 #include <linux/delay.h>
15 #include <linux/firmware.h>
16 #include <linux/list.h>
18 #include <linux/regmap.h>
19 #include <linux/regulator/consumer.h>
20 #include <linux/slab.h>
21 #include <linux/vmalloc.h>
22 #include <linux/workqueue.h>
23 #include <linux/debugfs.h>
24 #include <sound/core.h>
25 #include <sound/pcm.h>
26 #include <sound/pcm_params.h>
27 #include <sound/soc.h>
28 #include <sound/jack.h>
29 #include <sound/initval.h>
30 #include <sound/tlv.h>
34 #define adsp_crit(_dsp, fmt, ...) \
35 dev_crit(_dsp->cs_dsp.dev, "%s: " fmt, _dsp->cs_dsp.name, ##__VA_ARGS__)
36 #define adsp_err(_dsp, fmt, ...) \
37 dev_err(_dsp->cs_dsp.dev, "%s: " fmt, _dsp->cs_dsp.name, ##__VA_ARGS__)
38 #define adsp_warn(_dsp, fmt, ...) \
39 dev_warn(_dsp->cs_dsp.dev, "%s: " fmt, _dsp->cs_dsp.name, ##__VA_ARGS__)
40 #define adsp_info(_dsp, fmt, ...) \
41 dev_info(_dsp->cs_dsp.dev, "%s: " fmt, _dsp->cs_dsp.name, ##__VA_ARGS__)
42 #define adsp_dbg(_dsp, fmt, ...) \
43 dev_dbg(_dsp->cs_dsp.dev, "%s: " fmt, _dsp->cs_dsp.name, ##__VA_ARGS__)
45 #define compr_err(_obj, fmt, ...) \
46 adsp_err(_obj->dsp, "%s: " fmt, _obj->name ? _obj->name : "legacy", \
48 #define compr_dbg(_obj, fmt, ...) \
49 adsp_dbg(_obj->dsp, "%s: " fmt, _obj->name ? _obj->name : "legacy", \
52 #define ADSP_MAX_STD_CTRL_SIZE 512
54 static const struct cs_dsp_client_ops wm_adsp1_client_ops;
55 static const struct cs_dsp_client_ops wm_adsp2_client_ops;
57 #define WM_ADSP_FW_MBC_VSS 0
58 #define WM_ADSP_FW_HIFI 1
59 #define WM_ADSP_FW_TX 2
60 #define WM_ADSP_FW_TX_SPK 3
61 #define WM_ADSP_FW_RX 4
62 #define WM_ADSP_FW_RX_ANC 5
63 #define WM_ADSP_FW_CTRL 6
64 #define WM_ADSP_FW_ASR 7
65 #define WM_ADSP_FW_TRACE 8
66 #define WM_ADSP_FW_SPK_PROT 9
67 #define WM_ADSP_FW_SPK_CALI 10
68 #define WM_ADSP_FW_SPK_DIAG 11
69 #define WM_ADSP_FW_MISC 12
71 #define WM_ADSP_NUM_FW 13
73 static const char *wm_adsp_fw_text[WM_ADSP_NUM_FW] = {
74 [WM_ADSP_FW_MBC_VSS] = "MBC/VSS",
75 [WM_ADSP_FW_HIFI] = "MasterHiFi",
76 [WM_ADSP_FW_TX] = "Tx",
77 [WM_ADSP_FW_TX_SPK] = "Tx Speaker",
78 [WM_ADSP_FW_RX] = "Rx",
79 [WM_ADSP_FW_RX_ANC] = "Rx ANC",
80 [WM_ADSP_FW_CTRL] = "Voice Ctrl",
81 [WM_ADSP_FW_ASR] = "ASR Assist",
82 [WM_ADSP_FW_TRACE] = "Dbg Trace",
83 [WM_ADSP_FW_SPK_PROT] = "Protection",
84 [WM_ADSP_FW_SPK_CALI] = "Calibration",
85 [WM_ADSP_FW_SPK_DIAG] = "Diagnostic",
86 [WM_ADSP_FW_MISC] = "Misc",
89 struct wm_adsp_system_config_xm_hdr {
95 __be32 dma_buffer_size;
98 __be32 build_job_name[3];
99 __be32 build_job_number;
102 struct wm_halo_system_config_xm_hdr {
103 __be32 halo_heartbeat;
104 __be32 build_job_name[3];
105 __be32 build_job_number;
108 struct wm_adsp_alg_xm_struct {
114 __be32 high_water_mark;
115 __be32 low_water_mark;
116 __be64 smoothed_power;
119 struct wm_adsp_host_buf_coeff_v1 {
120 __be32 host_buf_ptr; /* Host buffer pointer */
121 __be32 versions; /* Version numbers */
122 __be32 name[4]; /* The buffer name */
125 struct wm_adsp_buffer {
126 __be32 buf1_base; /* Base addr of first buffer area */
127 __be32 buf1_size; /* Size of buf1 area in DSP words */
128 __be32 buf2_base; /* Base addr of 2nd buffer area */
129 __be32 buf1_buf2_size; /* Size of buf1+buf2 in DSP words */
130 __be32 buf3_base; /* Base addr of buf3 area */
131 __be32 buf_total_size; /* Size of buf1+buf2+buf3 in DSP words */
132 __be32 high_water_mark; /* Point at which IRQ is asserted */
133 __be32 irq_count; /* bits 1-31 count IRQ assertions */
134 __be32 irq_ack; /* acked IRQ count, bit 0 enables IRQ */
135 __be32 next_write_index; /* word index of next write */
136 __be32 next_read_index; /* word index of next read */
137 __be32 error; /* error if any */
138 __be32 oldest_block_index; /* word index of oldest surviving */
139 __be32 requested_rewind; /* how many blocks rewind was done */
140 __be32 reserved_space; /* internal */
141 __be32 min_free; /* min free space since stream start */
142 __be32 blocks_written[2]; /* total blocks written (64 bit) */
143 __be32 words_written[2]; /* total words written (64 bit) */
146 struct wm_adsp_compr;
148 struct wm_adsp_compr_buf {
149 struct list_head list;
151 struct wm_adsp_compr *compr;
153 struct wm_adsp_buffer_region *regions;
160 int host_buf_mem_type;
165 struct wm_adsp_compr {
166 struct list_head list;
168 struct wm_adsp_compr_buf *buf;
170 struct snd_compr_stream *stream;
171 struct snd_compressed_buffer size;
174 unsigned int copied_total;
176 unsigned int sample_rate;
181 #define WM_ADSP_MIN_FRAGMENTS 1
182 #define WM_ADSP_MAX_FRAGMENTS 256
183 #define WM_ADSP_MIN_FRAGMENT_SIZE (16 * CS_DSP_DATA_WORD_SIZE)
184 #define WM_ADSP_MAX_FRAGMENT_SIZE (4096 * CS_DSP_DATA_WORD_SIZE)
186 #define WM_ADSP_ALG_XM_STRUCT_MAGIC 0x49aec7
188 #define HOST_BUFFER_FIELD(field) \
189 (offsetof(struct wm_adsp_buffer, field) / sizeof(__be32))
191 #define ALG_XM_FIELD(field) \
192 (offsetof(struct wm_adsp_alg_xm_struct, field) / sizeof(__be32))
194 #define HOST_BUF_COEFF_SUPPORTED_COMPAT_VER 1
196 #define HOST_BUF_COEFF_COMPAT_VER_MASK 0xFF00
197 #define HOST_BUF_COEFF_COMPAT_VER_SHIFT 8
199 static int wm_adsp_buffer_init(struct wm_adsp *dsp);
200 static int wm_adsp_buffer_free(struct wm_adsp *dsp);
202 struct wm_adsp_buffer_region {
204 unsigned int cumulative_size;
205 unsigned int mem_type;
206 unsigned int base_addr;
209 struct wm_adsp_buffer_region_def {
210 unsigned int mem_type;
211 unsigned int base_offset;
212 unsigned int size_offset;
215 static const struct wm_adsp_buffer_region_def default_regions[] = {
217 .mem_type = WMFW_ADSP2_XM,
218 .base_offset = HOST_BUFFER_FIELD(buf1_base),
219 .size_offset = HOST_BUFFER_FIELD(buf1_size),
222 .mem_type = WMFW_ADSP2_XM,
223 .base_offset = HOST_BUFFER_FIELD(buf2_base),
224 .size_offset = HOST_BUFFER_FIELD(buf1_buf2_size),
227 .mem_type = WMFW_ADSP2_YM,
228 .base_offset = HOST_BUFFER_FIELD(buf3_base),
229 .size_offset = HOST_BUFFER_FIELD(buf_total_size),
233 struct wm_adsp_fw_caps {
235 struct snd_codec_desc desc;
237 const struct wm_adsp_buffer_region_def *region_defs;
240 static const struct wm_adsp_fw_caps ctrl_caps[] = {
242 .id = SND_AUDIOCODEC_BESPOKE,
245 .sample_rates = { 16000 },
246 .num_sample_rates = 1,
247 .formats = SNDRV_PCM_FMTBIT_S16_LE,
249 .num_regions = ARRAY_SIZE(default_regions),
250 .region_defs = default_regions,
254 static const struct wm_adsp_fw_caps trace_caps[] = {
256 .id = SND_AUDIOCODEC_BESPOKE,
260 4000, 8000, 11025, 12000, 16000, 22050,
261 24000, 32000, 44100, 48000, 64000, 88200,
262 96000, 176400, 192000
264 .num_sample_rates = 15,
265 .formats = SNDRV_PCM_FMTBIT_S16_LE,
267 .num_regions = ARRAY_SIZE(default_regions),
268 .region_defs = default_regions,
272 static const struct {
276 const struct wm_adsp_fw_caps *caps;
278 } wm_adsp_fw[WM_ADSP_NUM_FW] = {
279 [WM_ADSP_FW_MBC_VSS] = { .file = "mbc-vss" },
280 [WM_ADSP_FW_HIFI] = { .file = "hifi" },
281 [WM_ADSP_FW_TX] = { .file = "tx" },
282 [WM_ADSP_FW_TX_SPK] = { .file = "tx-spk" },
283 [WM_ADSP_FW_RX] = { .file = "rx" },
284 [WM_ADSP_FW_RX_ANC] = { .file = "rx-anc" },
285 [WM_ADSP_FW_CTRL] = {
287 .compr_direction = SND_COMPRESS_CAPTURE,
288 .num_caps = ARRAY_SIZE(ctrl_caps),
290 .voice_trigger = true,
292 [WM_ADSP_FW_ASR] = { .file = "asr" },
293 [WM_ADSP_FW_TRACE] = {
295 .compr_direction = SND_COMPRESS_CAPTURE,
296 .num_caps = ARRAY_SIZE(trace_caps),
299 [WM_ADSP_FW_SPK_PROT] = {
301 .compr_direction = SND_COMPRESS_CAPTURE,
302 .num_caps = ARRAY_SIZE(trace_caps),
305 [WM_ADSP_FW_SPK_CALI] = { .file = "spk-cali" },
306 [WM_ADSP_FW_SPK_DIAG] = { .file = "spk-diag" },
307 [WM_ADSP_FW_MISC] = { .file = "misc" },
310 struct wm_coeff_ctl {
312 struct cs_dsp_coeff_ctl *cs_ctl;
313 struct soc_bytes_ext bytes_ext;
314 struct work_struct work;
317 int wm_adsp_fw_get(struct snd_kcontrol *kcontrol,
318 struct snd_ctl_elem_value *ucontrol)
320 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
321 struct soc_enum *e = (struct soc_enum *)kcontrol->private_value;
322 struct wm_adsp *dsp = snd_soc_component_get_drvdata(component);
324 ucontrol->value.enumerated.item[0] = dsp[e->shift_l].fw;
328 EXPORT_SYMBOL_GPL(wm_adsp_fw_get);
330 int wm_adsp_fw_put(struct snd_kcontrol *kcontrol,
331 struct snd_ctl_elem_value *ucontrol)
333 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
334 struct soc_enum *e = (struct soc_enum *)kcontrol->private_value;
335 struct wm_adsp *dsp = snd_soc_component_get_drvdata(component);
338 if (ucontrol->value.enumerated.item[0] == dsp[e->shift_l].fw)
341 if (ucontrol->value.enumerated.item[0] >= WM_ADSP_NUM_FW)
344 mutex_lock(&dsp[e->shift_l].cs_dsp.pwr_lock);
346 if (dsp[e->shift_l].cs_dsp.booted || !list_empty(&dsp[e->shift_l].compr_list))
349 dsp[e->shift_l].fw = ucontrol->value.enumerated.item[0];
351 mutex_unlock(&dsp[e->shift_l].cs_dsp.pwr_lock);
355 EXPORT_SYMBOL_GPL(wm_adsp_fw_put);
357 const struct soc_enum wm_adsp_fw_enum[] = {
358 SOC_ENUM_SINGLE(0, 0, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
359 SOC_ENUM_SINGLE(0, 1, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
360 SOC_ENUM_SINGLE(0, 2, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
361 SOC_ENUM_SINGLE(0, 3, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
362 SOC_ENUM_SINGLE(0, 4, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
363 SOC_ENUM_SINGLE(0, 5, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
364 SOC_ENUM_SINGLE(0, 6, ARRAY_SIZE(wm_adsp_fw_text), wm_adsp_fw_text),
366 EXPORT_SYMBOL_GPL(wm_adsp_fw_enum);
368 static inline struct wm_coeff_ctl *bytes_ext_to_ctl(struct soc_bytes_ext *ext)
370 return container_of(ext, struct wm_coeff_ctl, bytes_ext);
373 static int wm_coeff_info(struct snd_kcontrol *kctl,
374 struct snd_ctl_elem_info *uinfo)
376 struct soc_bytes_ext *bytes_ext =
377 (struct soc_bytes_ext *)kctl->private_value;
378 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
379 struct cs_dsp_coeff_ctl *cs_ctl = ctl->cs_ctl;
381 switch (cs_ctl->type) {
382 case WMFW_CTL_TYPE_ACKED:
383 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
384 uinfo->value.integer.min = CS_DSP_ACKED_CTL_MIN_VALUE;
385 uinfo->value.integer.max = CS_DSP_ACKED_CTL_MAX_VALUE;
386 uinfo->value.integer.step = 1;
390 uinfo->type = SNDRV_CTL_ELEM_TYPE_BYTES;
391 uinfo->count = cs_ctl->len;
398 static int wm_coeff_put(struct snd_kcontrol *kctl,
399 struct snd_ctl_elem_value *ucontrol)
401 struct soc_bytes_ext *bytes_ext =
402 (struct soc_bytes_ext *)kctl->private_value;
403 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
404 struct cs_dsp_coeff_ctl *cs_ctl = ctl->cs_ctl;
405 char *p = ucontrol->value.bytes.data;
408 mutex_lock(&cs_ctl->dsp->pwr_lock);
409 ret = cs_dsp_coeff_write_ctrl(cs_ctl, 0, p, cs_ctl->len);
410 mutex_unlock(&cs_ctl->dsp->pwr_lock);
415 static int wm_coeff_tlv_put(struct snd_kcontrol *kctl,
416 const unsigned int __user *bytes, unsigned int size)
418 struct soc_bytes_ext *bytes_ext =
419 (struct soc_bytes_ext *)kctl->private_value;
420 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
421 struct cs_dsp_coeff_ctl *cs_ctl = ctl->cs_ctl;
425 scratch = vmalloc(size);
429 if (copy_from_user(scratch, bytes, size)) {
432 mutex_lock(&cs_ctl->dsp->pwr_lock);
433 ret = cs_dsp_coeff_write_ctrl(cs_ctl, 0, scratch, size);
434 mutex_unlock(&cs_ctl->dsp->pwr_lock);
441 static int wm_coeff_put_acked(struct snd_kcontrol *kctl,
442 struct snd_ctl_elem_value *ucontrol)
444 struct soc_bytes_ext *bytes_ext =
445 (struct soc_bytes_ext *)kctl->private_value;
446 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
447 struct cs_dsp_coeff_ctl *cs_ctl = ctl->cs_ctl;
448 unsigned int val = ucontrol->value.integer.value[0];
452 return 0; /* 0 means no event */
454 mutex_lock(&cs_ctl->dsp->pwr_lock);
457 ret = cs_dsp_coeff_write_acked_control(cs_ctl, val);
461 mutex_unlock(&cs_ctl->dsp->pwr_lock);
469 static int wm_coeff_get(struct snd_kcontrol *kctl,
470 struct snd_ctl_elem_value *ucontrol)
472 struct soc_bytes_ext *bytes_ext =
473 (struct soc_bytes_ext *)kctl->private_value;
474 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
475 struct cs_dsp_coeff_ctl *cs_ctl = ctl->cs_ctl;
476 char *p = ucontrol->value.bytes.data;
479 mutex_lock(&cs_ctl->dsp->pwr_lock);
480 ret = cs_dsp_coeff_read_ctrl(cs_ctl, 0, p, cs_ctl->len);
481 mutex_unlock(&cs_ctl->dsp->pwr_lock);
486 static int wm_coeff_tlv_get(struct snd_kcontrol *kctl,
487 unsigned int __user *bytes, unsigned int size)
489 struct soc_bytes_ext *bytes_ext =
490 (struct soc_bytes_ext *)kctl->private_value;
491 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
492 struct cs_dsp_coeff_ctl *cs_ctl = ctl->cs_ctl;
495 mutex_lock(&cs_ctl->dsp->pwr_lock);
497 ret = cs_dsp_coeff_read_ctrl(cs_ctl, 0, cs_ctl->cache, size);
499 if (!ret && copy_to_user(bytes, cs_ctl->cache, size))
502 mutex_unlock(&cs_ctl->dsp->pwr_lock);
507 static int wm_coeff_get_acked(struct snd_kcontrol *kcontrol,
508 struct snd_ctl_elem_value *ucontrol)
511 * Although it's not useful to read an acked control, we must satisfy
512 * user-side assumptions that all controls are readable and that a
513 * write of the same value should be filtered out (it's valid to send
514 * the same event number again to the firmware). We therefore return 0,
515 * meaning "no event" so valid event numbers will always be a change
517 ucontrol->value.integer.value[0] = 0;
522 static unsigned int wmfw_convert_flags(unsigned int in, unsigned int len)
524 unsigned int out, rd, wr, vol;
526 if (len > ADSP_MAX_STD_CTRL_SIZE) {
527 rd = SNDRV_CTL_ELEM_ACCESS_TLV_READ;
528 wr = SNDRV_CTL_ELEM_ACCESS_TLV_WRITE;
529 vol = SNDRV_CTL_ELEM_ACCESS_VOLATILE;
531 out = SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
533 rd = SNDRV_CTL_ELEM_ACCESS_READ;
534 wr = SNDRV_CTL_ELEM_ACCESS_WRITE;
535 vol = SNDRV_CTL_ELEM_ACCESS_VOLATILE;
542 if (in & WMFW_CTL_FLAG_WRITEABLE)
544 if (in & WMFW_CTL_FLAG_VOLATILE)
547 out |= rd | wr | vol;
553 static void wm_adsp_ctl_work(struct work_struct *work)
555 struct wm_coeff_ctl *ctl = container_of(work,
558 struct cs_dsp_coeff_ctl *cs_ctl = ctl->cs_ctl;
559 struct wm_adsp *dsp = container_of(cs_ctl->dsp,
562 struct snd_kcontrol_new *kcontrol;
564 kcontrol = kzalloc(sizeof(*kcontrol), GFP_KERNEL);
568 kcontrol->name = ctl->name;
569 kcontrol->info = wm_coeff_info;
570 kcontrol->iface = SNDRV_CTL_ELEM_IFACE_MIXER;
571 kcontrol->tlv.c = snd_soc_bytes_tlv_callback;
572 kcontrol->private_value = (unsigned long)&ctl->bytes_ext;
573 kcontrol->access = wmfw_convert_flags(cs_ctl->flags, cs_ctl->len);
575 switch (cs_ctl->type) {
576 case WMFW_CTL_TYPE_ACKED:
577 kcontrol->get = wm_coeff_get_acked;
578 kcontrol->put = wm_coeff_put_acked;
581 if (kcontrol->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
582 ctl->bytes_ext.max = cs_ctl->len;
583 ctl->bytes_ext.get = wm_coeff_tlv_get;
584 ctl->bytes_ext.put = wm_coeff_tlv_put;
586 kcontrol->get = wm_coeff_get;
587 kcontrol->put = wm_coeff_put;
592 snd_soc_add_component_controls(dsp->component, kcontrol, 1);
597 static int wm_adsp_control_add(struct cs_dsp_coeff_ctl *cs_ctl)
599 struct wm_adsp *dsp = container_of(cs_ctl->dsp, struct wm_adsp, cs_dsp);
600 struct cs_dsp *cs_dsp = &dsp->cs_dsp;
601 struct wm_coeff_ctl *ctl;
602 char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
603 const char *region_name;
606 if (cs_ctl->flags & WMFW_CTL_FLAG_SYS)
609 region_name = cs_dsp_mem_region_name(cs_ctl->alg_region.type);
611 adsp_err(dsp, "Unknown region type: %d\n", cs_ctl->alg_region.type);
615 switch (cs_dsp->fw_ver) {
618 ret = scnprintf(name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN,
619 "%s %s %x", cs_dsp->name, region_name,
620 cs_ctl->alg_region.alg);
623 ret = scnprintf(name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN,
624 "%s%c %.12s %x", cs_dsp->name, *region_name,
625 wm_adsp_fw_text[dsp->fw], cs_ctl->alg_region.alg);
628 ret = scnprintf(name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN,
629 "%s %.12s %x", cs_dsp->name,
630 wm_adsp_fw_text[dsp->fw], cs_ctl->alg_region.alg);
634 if (cs_ctl->subname) {
635 int avail = SNDRV_CTL_ELEM_ID_NAME_MAXLEN - ret - 2;
638 if (dsp->component->name_prefix)
639 avail -= strlen(dsp->component->name_prefix) + 1;
641 /* Truncate the subname from the start if it is too long */
642 if (cs_ctl->subname_len > avail)
643 skip = cs_ctl->subname_len - avail;
645 snprintf(name + ret, SNDRV_CTL_ELEM_ID_NAME_MAXLEN - ret,
646 " %.*s", cs_ctl->subname_len - skip, cs_ctl->subname + skip);
649 ctl = kzalloc(sizeof(*ctl), GFP_KERNEL);
652 ctl->cs_ctl = cs_ctl;
654 ctl->name = kmemdup(name, strlen(name) + 1, GFP_KERNEL);
662 INIT_WORK(&ctl->work, wm_adsp_ctl_work);
663 schedule_work(&ctl->work);
673 static void wm_adsp_control_remove(struct cs_dsp_coeff_ctl *cs_ctl)
675 struct wm_coeff_ctl *ctl = cs_ctl->priv;
677 cancel_work_sync(&ctl->work);
683 int wm_adsp_write_ctl(struct wm_adsp *dsp, const char *name, int type,
684 unsigned int alg, void *buf, size_t len)
686 struct cs_dsp_coeff_ctl *cs_ctl;
687 struct wm_coeff_ctl *ctl;
690 mutex_lock(&dsp->cs_dsp.pwr_lock);
691 cs_ctl = cs_dsp_get_ctl(&dsp->cs_dsp, name, type, alg);
692 ret = cs_dsp_coeff_write_ctrl(cs_ctl, 0, buf, len);
693 mutex_unlock(&dsp->cs_dsp.pwr_lock);
698 if (ret == 0 || (cs_ctl->flags & WMFW_CTL_FLAG_SYS))
703 return snd_soc_component_notify_control(dsp->component, ctl->name);
705 EXPORT_SYMBOL_GPL(wm_adsp_write_ctl);
707 int wm_adsp_read_ctl(struct wm_adsp *dsp, const char *name, int type,
708 unsigned int alg, void *buf, size_t len)
712 mutex_lock(&dsp->cs_dsp.pwr_lock);
713 ret = cs_dsp_coeff_read_ctrl(cs_dsp_get_ctl(&dsp->cs_dsp, name, type, alg),
715 mutex_unlock(&dsp->cs_dsp.pwr_lock);
719 EXPORT_SYMBOL_GPL(wm_adsp_read_ctl);
721 static void wm_adsp_release_firmware_files(struct wm_adsp *dsp,
722 const struct firmware *wmfw_firmware,
724 const struct firmware *coeff_firmware,
725 char *coeff_filename)
728 release_firmware(wmfw_firmware);
729 kfree(wmfw_filename);
732 release_firmware(coeff_firmware);
733 kfree(coeff_filename);
736 static int wm_adsp_request_firmware_file(struct wm_adsp *dsp,
737 const struct firmware **firmware, char **filename,
738 const char *dir, const char *system_name,
739 const char *asoc_component_prefix,
740 const char *filetype)
742 struct cs_dsp *cs_dsp = &dsp->cs_dsp;
750 fwf = dsp->cs_dsp.name;
752 if (system_name && asoc_component_prefix)
753 *filename = kasprintf(GFP_KERNEL, "/*(DEBLOBBED)*/", dir, dsp->part,
754 fwf, wm_adsp_fw[dsp->fw].file, system_name,
755 asoc_component_prefix, filetype);
756 else if (system_name)
757 *filename = kasprintf(GFP_KERNEL, "/*(DEBLOBBED)*/", dir, dsp->part,
758 fwf, wm_adsp_fw[dsp->fw].file, system_name,
761 *filename = kasprintf(GFP_KERNEL, "/*(DEBLOBBED)*/", dir, dsp->part, fwf,
762 wm_adsp_fw[dsp->fw].file, filetype);
764 if (*filename == NULL)
768 * Make sure that filename is lower-case and any non alpha-numeric
769 * characters except full stop and forward slash are replaced with
777 else if ((c != '.') && (c != '/'))
782 ret = firmware_reject_nowarn(firmware, *filename, cs_dsp->dev);
784 adsp_dbg(dsp, "Failed to request '%s'\n", *filename);
788 adsp_dbg(dsp, "Found '%s'\n", *filename);
794 static const char *cirrus_dir = "cirrus/";
795 static int wm_adsp_request_firmware_files(struct wm_adsp *dsp,
796 const struct firmware **wmfw_firmware,
797 char **wmfw_filename,
798 const struct firmware **coeff_firmware,
799 char **coeff_filename)
801 const char *system_name = dsp->system_name;
802 const char *asoc_component_prefix = dsp->component->name_prefix;
805 if (system_name && asoc_component_prefix) {
806 if (!wm_adsp_request_firmware_file(dsp, wmfw_firmware, wmfw_filename,
807 cirrus_dir, system_name,
808 asoc_component_prefix, "wmfw")) {
809 wm_adsp_request_firmware_file(dsp, coeff_firmware, coeff_filename,
810 cirrus_dir, system_name,
811 asoc_component_prefix, "bin");
817 if (!wm_adsp_request_firmware_file(dsp, wmfw_firmware, wmfw_filename,
818 cirrus_dir, system_name,
820 if (asoc_component_prefix)
821 wm_adsp_request_firmware_file(dsp, coeff_firmware, coeff_filename,
822 cirrus_dir, system_name,
823 asoc_component_prefix, "bin");
825 if (!*coeff_firmware)
826 wm_adsp_request_firmware_file(dsp, coeff_firmware, coeff_filename,
827 cirrus_dir, system_name,
833 /* Check system-specific bin without wmfw before falling back to generic */
834 if (dsp->wmfw_optional && system_name) {
835 if (asoc_component_prefix)
836 wm_adsp_request_firmware_file(dsp, coeff_firmware, coeff_filename,
837 cirrus_dir, system_name,
838 asoc_component_prefix, "bin");
840 if (!*coeff_firmware)
841 wm_adsp_request_firmware_file(dsp, coeff_firmware, coeff_filename,
842 cirrus_dir, system_name,
849 /* Check legacy location */
850 if (!wm_adsp_request_firmware_file(dsp, wmfw_firmware, wmfw_filename,
851 "", NULL, NULL, "wmfw")) {
852 wm_adsp_request_firmware_file(dsp, coeff_firmware, coeff_filename,
853 "", NULL, NULL, "bin");
857 /* Fall back to generic wmfw and optional matching bin */
858 ret = wm_adsp_request_firmware_file(dsp, wmfw_firmware, wmfw_filename,
859 cirrus_dir, NULL, NULL, "wmfw");
860 if (!ret || dsp->wmfw_optional) {
861 wm_adsp_request_firmware_file(dsp, coeff_firmware, coeff_filename,
862 cirrus_dir, NULL, NULL, "bin");
866 adsp_err(dsp, "Failed to request firmware <%s>%s-%s-%s<-%s<%s>>.wmfw\n",
867 cirrus_dir, dsp->part,
868 dsp->fwf_name ? dsp->fwf_name : dsp->cs_dsp.name,
869 wm_adsp_fw[dsp->fw].file, system_name, asoc_component_prefix);
874 static int wm_adsp_common_init(struct wm_adsp *dsp)
876 INIT_LIST_HEAD(&dsp->compr_list);
877 INIT_LIST_HEAD(&dsp->buffer_list);
882 int wm_adsp1_init(struct wm_adsp *dsp)
886 dsp->cs_dsp.client_ops = &wm_adsp1_client_ops;
888 ret = cs_dsp_adsp1_init(&dsp->cs_dsp);
892 return wm_adsp_common_init(dsp);
894 EXPORT_SYMBOL_GPL(wm_adsp1_init);
896 int wm_adsp1_event(struct snd_soc_dapm_widget *w,
897 struct snd_kcontrol *kcontrol,
900 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
901 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
902 struct wm_adsp *dsp = &dsps[w->shift];
904 char *wmfw_filename = NULL;
905 const struct firmware *wmfw_firmware = NULL;
906 char *coeff_filename = NULL;
907 const struct firmware *coeff_firmware = NULL;
909 dsp->component = component;
912 case SND_SOC_DAPM_POST_PMU:
913 ret = wm_adsp_request_firmware_files(dsp,
914 &wmfw_firmware, &wmfw_filename,
915 &coeff_firmware, &coeff_filename);
919 ret = cs_dsp_adsp1_power_up(&dsp->cs_dsp,
920 wmfw_firmware, wmfw_filename,
921 coeff_firmware, coeff_filename,
922 wm_adsp_fw_text[dsp->fw]);
924 wm_adsp_release_firmware_files(dsp,
925 wmfw_firmware, wmfw_filename,
926 coeff_firmware, coeff_filename);
928 case SND_SOC_DAPM_PRE_PMD:
929 cs_dsp_adsp1_power_down(&dsp->cs_dsp);
937 EXPORT_SYMBOL_GPL(wm_adsp1_event);
939 int wm_adsp2_set_dspclk(struct snd_soc_dapm_widget *w, unsigned int freq)
941 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
942 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
943 struct wm_adsp *dsp = &dsps[w->shift];
945 return cs_dsp_set_dspclk(&dsp->cs_dsp, freq);
947 EXPORT_SYMBOL_GPL(wm_adsp2_set_dspclk);
949 int wm_adsp2_preloader_get(struct snd_kcontrol *kcontrol,
950 struct snd_ctl_elem_value *ucontrol)
952 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
953 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
954 struct soc_mixer_control *mc =
955 (struct soc_mixer_control *)kcontrol->private_value;
956 struct wm_adsp *dsp = &dsps[mc->shift - 1];
958 ucontrol->value.integer.value[0] = dsp->preloaded;
962 EXPORT_SYMBOL_GPL(wm_adsp2_preloader_get);
964 int wm_adsp2_preloader_put(struct snd_kcontrol *kcontrol,
965 struct snd_ctl_elem_value *ucontrol)
967 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
968 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
969 struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(component);
970 struct soc_mixer_control *mc =
971 (struct soc_mixer_control *)kcontrol->private_value;
972 struct wm_adsp *dsp = &dsps[mc->shift - 1];
975 if (dsp->preloaded == ucontrol->value.integer.value[0])
978 snprintf(preload, ARRAY_SIZE(preload), "%s Preload", dsp->cs_dsp.name);
980 if (ucontrol->value.integer.value[0] || dsp->toggle_preload)
981 snd_soc_component_force_enable_pin(component, preload);
983 snd_soc_component_disable_pin(component, preload);
985 snd_soc_dapm_sync(dapm);
987 flush_work(&dsp->boot_work);
989 dsp->preloaded = ucontrol->value.integer.value[0];
991 if (dsp->toggle_preload) {
992 snd_soc_component_disable_pin(component, preload);
993 snd_soc_dapm_sync(dapm);
998 EXPORT_SYMBOL_GPL(wm_adsp2_preloader_put);
1000 int wm_adsp_power_up(struct wm_adsp *dsp, bool load_firmware)
1003 char *wmfw_filename = NULL;
1004 const struct firmware *wmfw_firmware = NULL;
1005 char *coeff_filename = NULL;
1006 const struct firmware *coeff_firmware = NULL;
1008 if (load_firmware) {
1009 ret = wm_adsp_request_firmware_files(dsp,
1010 &wmfw_firmware, &wmfw_filename,
1011 &coeff_firmware, &coeff_filename);
1016 ret = cs_dsp_power_up(&dsp->cs_dsp,
1017 wmfw_firmware, wmfw_filename,
1018 coeff_firmware, coeff_filename,
1019 wm_adsp_fw_text[dsp->fw]);
1021 wm_adsp_release_firmware_files(dsp,
1022 wmfw_firmware, wmfw_filename,
1023 coeff_firmware, coeff_filename);
1027 EXPORT_SYMBOL_GPL(wm_adsp_power_up);
1029 void wm_adsp_power_down(struct wm_adsp *dsp)
1031 cs_dsp_power_down(&dsp->cs_dsp);
1033 EXPORT_SYMBOL_GPL(wm_adsp_power_down);
1035 static void wm_adsp_boot_work(struct work_struct *work)
1037 struct wm_adsp *dsp = container_of(work,
1041 wm_adsp_power_up(dsp, true);
1044 int wm_adsp_early_event(struct snd_soc_dapm_widget *w,
1045 struct snd_kcontrol *kcontrol, int event)
1047 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
1048 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
1049 struct wm_adsp *dsp = &dsps[w->shift];
1052 case SND_SOC_DAPM_PRE_PMU:
1053 queue_work(system_unbound_wq, &dsp->boot_work);
1055 case SND_SOC_DAPM_PRE_PMD:
1056 wm_adsp_power_down(dsp);
1064 EXPORT_SYMBOL_GPL(wm_adsp_early_event);
1066 static int wm_adsp_pre_run(struct cs_dsp *cs_dsp)
1068 struct wm_adsp *dsp = container_of(cs_dsp, struct wm_adsp, cs_dsp);
1073 return (*dsp->pre_run)(dsp);
1076 static int wm_adsp_event_post_run(struct cs_dsp *cs_dsp)
1078 struct wm_adsp *dsp = container_of(cs_dsp, struct wm_adsp, cs_dsp);
1080 if (wm_adsp_fw[dsp->fw].num_caps != 0)
1081 return wm_adsp_buffer_init(dsp);
1086 static void wm_adsp_event_post_stop(struct cs_dsp *cs_dsp)
1088 struct wm_adsp *dsp = container_of(cs_dsp, struct wm_adsp, cs_dsp);
1090 if (wm_adsp_fw[dsp->fw].num_caps != 0)
1091 wm_adsp_buffer_free(dsp);
1093 dsp->fatal_error = false;
1096 int wm_adsp_run(struct wm_adsp *dsp)
1098 flush_work(&dsp->boot_work);
1100 return cs_dsp_run(&dsp->cs_dsp);
1102 EXPORT_SYMBOL_GPL(wm_adsp_run);
1104 void wm_adsp_stop(struct wm_adsp *dsp)
1106 cs_dsp_stop(&dsp->cs_dsp);
1108 EXPORT_SYMBOL_GPL(wm_adsp_stop);
1110 int wm_adsp_event(struct snd_soc_dapm_widget *w,
1111 struct snd_kcontrol *kcontrol, int event)
1113 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
1114 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
1115 struct wm_adsp *dsp = &dsps[w->shift];
1118 case SND_SOC_DAPM_POST_PMU:
1119 return wm_adsp_run(dsp);
1120 case SND_SOC_DAPM_PRE_PMD:
1127 EXPORT_SYMBOL_GPL(wm_adsp_event);
1129 int wm_adsp2_component_probe(struct wm_adsp *dsp, struct snd_soc_component *component)
1133 if (!dsp->cs_dsp.no_core_startstop) {
1134 snprintf(preload, ARRAY_SIZE(preload), "%s Preload", dsp->cs_dsp.name);
1135 snd_soc_component_disable_pin(component, preload);
1138 cs_dsp_init_debugfs(&dsp->cs_dsp, component->debugfs_root);
1140 dsp->component = component;
1144 EXPORT_SYMBOL_GPL(wm_adsp2_component_probe);
1146 int wm_adsp2_component_remove(struct wm_adsp *dsp, struct snd_soc_component *component)
1148 cs_dsp_cleanup_debugfs(&dsp->cs_dsp);
1152 EXPORT_SYMBOL_GPL(wm_adsp2_component_remove);
1154 int wm_adsp2_init(struct wm_adsp *dsp)
1158 INIT_WORK(&dsp->boot_work, wm_adsp_boot_work);
1160 dsp->sys_config_size = sizeof(struct wm_adsp_system_config_xm_hdr);
1161 dsp->cs_dsp.client_ops = &wm_adsp2_client_ops;
1163 ret = cs_dsp_adsp2_init(&dsp->cs_dsp);
1167 return wm_adsp_common_init(dsp);
1169 EXPORT_SYMBOL_GPL(wm_adsp2_init);
1171 int wm_halo_init(struct wm_adsp *dsp)
1175 INIT_WORK(&dsp->boot_work, wm_adsp_boot_work);
1177 dsp->sys_config_size = sizeof(struct wm_halo_system_config_xm_hdr);
1178 dsp->cs_dsp.client_ops = &wm_adsp2_client_ops;
1180 ret = cs_dsp_halo_init(&dsp->cs_dsp);
1184 return wm_adsp_common_init(dsp);
1186 EXPORT_SYMBOL_GPL(wm_halo_init);
1188 void wm_adsp2_remove(struct wm_adsp *dsp)
1190 cs_dsp_remove(&dsp->cs_dsp);
1192 EXPORT_SYMBOL_GPL(wm_adsp2_remove);
1194 static inline int wm_adsp_compr_attached(struct wm_adsp_compr *compr)
1196 return compr->buf != NULL;
1199 static int wm_adsp_compr_attach(struct wm_adsp_compr *compr)
1201 struct wm_adsp_compr_buf *buf = NULL, *tmp;
1203 if (compr->dsp->fatal_error)
1206 list_for_each_entry(tmp, &compr->dsp->buffer_list, list) {
1207 if (!tmp->name || !strcmp(compr->name, tmp->name)) {
1222 static void wm_adsp_compr_detach(struct wm_adsp_compr *compr)
1227 /* Wake the poll so it can see buffer is no longer attached */
1229 snd_compr_fragment_elapsed(compr->stream);
1231 if (wm_adsp_compr_attached(compr)) {
1232 compr->buf->compr = NULL;
1237 int wm_adsp_compr_open(struct wm_adsp *dsp, struct snd_compr_stream *stream)
1239 struct wm_adsp_compr *compr, *tmp;
1240 struct snd_soc_pcm_runtime *rtd = stream->private_data;
1243 mutex_lock(&dsp->cs_dsp.pwr_lock);
1245 if (wm_adsp_fw[dsp->fw].num_caps == 0) {
1246 adsp_err(dsp, "%s: Firmware does not support compressed API\n",
1247 snd_soc_rtd_to_codec(rtd, 0)->name);
1252 if (wm_adsp_fw[dsp->fw].compr_direction != stream->direction) {
1253 adsp_err(dsp, "%s: Firmware does not support stream direction\n",
1254 snd_soc_rtd_to_codec(rtd, 0)->name);
1259 list_for_each_entry(tmp, &dsp->compr_list, list) {
1260 if (!strcmp(tmp->name, snd_soc_rtd_to_codec(rtd, 0)->name)) {
1261 adsp_err(dsp, "%s: Only a single stream supported per dai\n",
1262 snd_soc_rtd_to_codec(rtd, 0)->name);
1268 compr = kzalloc(sizeof(*compr), GFP_KERNEL);
1275 compr->stream = stream;
1276 compr->name = snd_soc_rtd_to_codec(rtd, 0)->name;
1278 list_add_tail(&compr->list, &dsp->compr_list);
1280 stream->runtime->private_data = compr;
1283 mutex_unlock(&dsp->cs_dsp.pwr_lock);
1287 EXPORT_SYMBOL_GPL(wm_adsp_compr_open);
1289 int wm_adsp_compr_free(struct snd_soc_component *component,
1290 struct snd_compr_stream *stream)
1292 struct wm_adsp_compr *compr = stream->runtime->private_data;
1293 struct wm_adsp *dsp = compr->dsp;
1295 mutex_lock(&dsp->cs_dsp.pwr_lock);
1297 wm_adsp_compr_detach(compr);
1298 list_del(&compr->list);
1300 kfree(compr->raw_buf);
1303 mutex_unlock(&dsp->cs_dsp.pwr_lock);
1307 EXPORT_SYMBOL_GPL(wm_adsp_compr_free);
1309 static int wm_adsp_compr_check_params(struct snd_compr_stream *stream,
1310 struct snd_compr_params *params)
1312 struct wm_adsp_compr *compr = stream->runtime->private_data;
1313 struct wm_adsp *dsp = compr->dsp;
1314 const struct wm_adsp_fw_caps *caps;
1315 const struct snd_codec_desc *desc;
1318 if (params->buffer.fragment_size < WM_ADSP_MIN_FRAGMENT_SIZE ||
1319 params->buffer.fragment_size > WM_ADSP_MAX_FRAGMENT_SIZE ||
1320 params->buffer.fragments < WM_ADSP_MIN_FRAGMENTS ||
1321 params->buffer.fragments > WM_ADSP_MAX_FRAGMENTS ||
1322 params->buffer.fragment_size % CS_DSP_DATA_WORD_SIZE) {
1323 compr_err(compr, "Invalid buffer fragsize=%d fragments=%d\n",
1324 params->buffer.fragment_size,
1325 params->buffer.fragments);
1330 for (i = 0; i < wm_adsp_fw[dsp->fw].num_caps; i++) {
1331 caps = &wm_adsp_fw[dsp->fw].caps[i];
1334 if (caps->id != params->codec.id)
1337 if (stream->direction == SND_COMPRESS_PLAYBACK) {
1338 if (desc->max_ch < params->codec.ch_out)
1341 if (desc->max_ch < params->codec.ch_in)
1345 if (!(desc->formats & (1 << params->codec.format)))
1348 for (j = 0; j < desc->num_sample_rates; ++j)
1349 if (desc->sample_rates[j] == params->codec.sample_rate)
1353 compr_err(compr, "Invalid params id=%u ch=%u,%u rate=%u fmt=%u\n",
1354 params->codec.id, params->codec.ch_in, params->codec.ch_out,
1355 params->codec.sample_rate, params->codec.format);
1359 static inline unsigned int wm_adsp_compr_frag_words(struct wm_adsp_compr *compr)
1361 return compr->size.fragment_size / CS_DSP_DATA_WORD_SIZE;
1364 int wm_adsp_compr_set_params(struct snd_soc_component *component,
1365 struct snd_compr_stream *stream,
1366 struct snd_compr_params *params)
1368 struct wm_adsp_compr *compr = stream->runtime->private_data;
1372 ret = wm_adsp_compr_check_params(stream, params);
1376 compr->size = params->buffer;
1378 compr_dbg(compr, "fragment_size=%d fragments=%d\n",
1379 compr->size.fragment_size, compr->size.fragments);
1381 size = wm_adsp_compr_frag_words(compr) * sizeof(*compr->raw_buf);
1382 compr->raw_buf = kmalloc(size, GFP_DMA | GFP_KERNEL);
1383 if (!compr->raw_buf)
1386 compr->sample_rate = params->codec.sample_rate;
1390 EXPORT_SYMBOL_GPL(wm_adsp_compr_set_params);
1392 int wm_adsp_compr_get_caps(struct snd_soc_component *component,
1393 struct snd_compr_stream *stream,
1394 struct snd_compr_caps *caps)
1396 struct wm_adsp_compr *compr = stream->runtime->private_data;
1397 int fw = compr->dsp->fw;
1400 if (wm_adsp_fw[fw].caps) {
1401 for (i = 0; i < wm_adsp_fw[fw].num_caps; i++)
1402 caps->codecs[i] = wm_adsp_fw[fw].caps[i].id;
1404 caps->num_codecs = i;
1405 caps->direction = wm_adsp_fw[fw].compr_direction;
1407 caps->min_fragment_size = WM_ADSP_MIN_FRAGMENT_SIZE;
1408 caps->max_fragment_size = WM_ADSP_MAX_FRAGMENT_SIZE;
1409 caps->min_fragments = WM_ADSP_MIN_FRAGMENTS;
1410 caps->max_fragments = WM_ADSP_MAX_FRAGMENTS;
1415 EXPORT_SYMBOL_GPL(wm_adsp_compr_get_caps);
1417 static inline int wm_adsp_buffer_read(struct wm_adsp_compr_buf *buf,
1418 unsigned int field_offset, u32 *data)
1420 return cs_dsp_read_data_word(&buf->dsp->cs_dsp, buf->host_buf_mem_type,
1421 buf->host_buf_ptr + field_offset, data);
1424 static inline int wm_adsp_buffer_write(struct wm_adsp_compr_buf *buf,
1425 unsigned int field_offset, u32 data)
1427 return cs_dsp_write_data_word(&buf->dsp->cs_dsp, buf->host_buf_mem_type,
1428 buf->host_buf_ptr + field_offset,
1432 static int wm_adsp_buffer_populate(struct wm_adsp_compr_buf *buf)
1434 const struct wm_adsp_fw_caps *caps = wm_adsp_fw[buf->dsp->fw].caps;
1435 struct wm_adsp_buffer_region *region;
1439 buf->regions = kcalloc(caps->num_regions, sizeof(*buf->regions),
1444 for (i = 0; i < caps->num_regions; ++i) {
1445 region = &buf->regions[i];
1447 region->offset = offset;
1448 region->mem_type = caps->region_defs[i].mem_type;
1450 ret = wm_adsp_buffer_read(buf, caps->region_defs[i].base_offset,
1451 ®ion->base_addr);
1455 ret = wm_adsp_buffer_read(buf, caps->region_defs[i].size_offset,
1460 region->cumulative_size = offset;
1463 "region=%d type=%d base=%08x off=%08x size=%08x\n",
1464 i, region->mem_type, region->base_addr,
1465 region->offset, region->cumulative_size);
1471 kfree(buf->regions);
1475 static void wm_adsp_buffer_clear(struct wm_adsp_compr_buf *buf)
1477 buf->irq_count = 0xFFFFFFFF;
1478 buf->read_index = -1;
1482 static struct wm_adsp_compr_buf *wm_adsp_buffer_alloc(struct wm_adsp *dsp)
1484 struct wm_adsp_compr_buf *buf;
1486 buf = kzalloc(sizeof(*buf), GFP_KERNEL);
1492 wm_adsp_buffer_clear(buf);
1497 static int wm_adsp_buffer_parse_legacy(struct wm_adsp *dsp)
1499 struct cs_dsp_alg_region *alg_region;
1500 struct wm_adsp_compr_buf *buf;
1501 u32 xmalg, addr, magic;
1504 alg_region = cs_dsp_find_alg_region(&dsp->cs_dsp, WMFW_ADSP2_XM, dsp->cs_dsp.fw_id);
1506 adsp_err(dsp, "No algorithm region found\n");
1510 xmalg = dsp->sys_config_size / sizeof(__be32);
1512 addr = alg_region->base + xmalg + ALG_XM_FIELD(magic);
1513 ret = cs_dsp_read_data_word(&dsp->cs_dsp, WMFW_ADSP2_XM, addr, &magic);
1517 if (magic != WM_ADSP_ALG_XM_STRUCT_MAGIC)
1520 buf = wm_adsp_buffer_alloc(dsp);
1524 addr = alg_region->base + xmalg + ALG_XM_FIELD(host_buf_ptr);
1525 for (i = 0; i < 5; ++i) {
1526 ret = cs_dsp_read_data_word(&dsp->cs_dsp, WMFW_ADSP2_XM, addr,
1527 &buf->host_buf_ptr);
1531 if (buf->host_buf_ptr)
1534 usleep_range(1000, 2000);
1537 if (!buf->host_buf_ptr) {
1542 buf->host_buf_mem_type = WMFW_ADSP2_XM;
1544 ret = wm_adsp_buffer_populate(buf);
1548 list_add_tail(&buf->list, &dsp->buffer_list);
1550 compr_dbg(buf, "legacy host_buf_ptr=%x\n", buf->host_buf_ptr);
1560 static int wm_adsp_buffer_parse_coeff(struct cs_dsp_coeff_ctl *cs_ctl)
1562 struct wm_adsp_host_buf_coeff_v1 coeff_v1;
1563 struct wm_adsp_compr_buf *buf;
1564 struct wm_adsp *dsp = container_of(cs_ctl->dsp, struct wm_adsp, cs_dsp);
1565 unsigned int version = 0;
1568 for (i = 0; i < 5; ++i) {
1569 ret = cs_dsp_coeff_read_ctrl(cs_ctl, 0, &coeff_v1,
1570 min(cs_ctl->len, sizeof(coeff_v1)));
1574 if (coeff_v1.host_buf_ptr)
1577 usleep_range(1000, 2000);
1580 if (!coeff_v1.host_buf_ptr) {
1581 adsp_err(dsp, "Failed to acquire host buffer\n");
1585 buf = wm_adsp_buffer_alloc(dsp);
1589 buf->host_buf_mem_type = cs_ctl->alg_region.type;
1590 buf->host_buf_ptr = be32_to_cpu(coeff_v1.host_buf_ptr);
1592 ret = wm_adsp_buffer_populate(buf);
1597 * v0 host_buffer coefficients didn't have versioning, so if the
1598 * control is one word, assume version 0.
1600 if (cs_ctl->len == 4)
1603 version = be32_to_cpu(coeff_v1.versions) & HOST_BUF_COEFF_COMPAT_VER_MASK;
1604 version >>= HOST_BUF_COEFF_COMPAT_VER_SHIFT;
1606 if (version > HOST_BUF_COEFF_SUPPORTED_COMPAT_VER) {
1608 "Host buffer coeff ver %u > supported version %u\n",
1609 version, HOST_BUF_COEFF_SUPPORTED_COMPAT_VER);
1614 cs_dsp_remove_padding((u32 *)&coeff_v1.name, ARRAY_SIZE(coeff_v1.name));
1616 buf->name = kasprintf(GFP_KERNEL, "%s-dsp-%s", dsp->part,
1617 (char *)&coeff_v1.name);
1620 list_add_tail(&buf->list, &dsp->buffer_list);
1622 compr_dbg(buf, "host_buf_ptr=%x coeff version %u\n",
1623 buf->host_buf_ptr, version);
1633 static int wm_adsp_buffer_init(struct wm_adsp *dsp)
1635 struct cs_dsp_coeff_ctl *cs_ctl;
1638 list_for_each_entry(cs_ctl, &dsp->cs_dsp.ctl_list, list) {
1639 if (cs_ctl->type != WMFW_CTL_TYPE_HOST_BUFFER)
1642 if (!cs_ctl->enabled)
1645 ret = wm_adsp_buffer_parse_coeff(cs_ctl);
1647 adsp_err(dsp, "Failed to parse coeff: %d\n", ret);
1649 } else if (ret == 0) {
1650 /* Only one buffer supported for version 0 */
1655 if (list_empty(&dsp->buffer_list)) {
1656 /* Fall back to legacy support */
1657 ret = wm_adsp_buffer_parse_legacy(dsp);
1659 adsp_info(dsp, "Legacy support not available\n");
1661 adsp_warn(dsp, "Failed to parse legacy: %d\n", ret);
1667 wm_adsp_buffer_free(dsp);
1671 static int wm_adsp_buffer_free(struct wm_adsp *dsp)
1673 struct wm_adsp_compr_buf *buf, *tmp;
1675 list_for_each_entry_safe(buf, tmp, &dsp->buffer_list, list) {
1676 wm_adsp_compr_detach(buf->compr);
1679 kfree(buf->regions);
1680 list_del(&buf->list);
1687 static int wm_adsp_buffer_get_error(struct wm_adsp_compr_buf *buf)
1691 ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(error), &buf->error);
1693 compr_err(buf, "Failed to check buffer error: %d\n", ret);
1696 if (buf->error != 0) {
1697 compr_err(buf, "Buffer error occurred: %d\n", buf->error);
1704 int wm_adsp_compr_trigger(struct snd_soc_component *component,
1705 struct snd_compr_stream *stream, int cmd)
1707 struct wm_adsp_compr *compr = stream->runtime->private_data;
1708 struct wm_adsp *dsp = compr->dsp;
1711 compr_dbg(compr, "Trigger: %d\n", cmd);
1713 mutex_lock(&dsp->cs_dsp.pwr_lock);
1716 case SNDRV_PCM_TRIGGER_START:
1717 if (!wm_adsp_compr_attached(compr)) {
1718 ret = wm_adsp_compr_attach(compr);
1720 compr_err(compr, "Failed to link buffer and stream: %d\n",
1726 ret = wm_adsp_buffer_get_error(compr->buf);
1730 /* Trigger the IRQ at one fragment of data */
1731 ret = wm_adsp_buffer_write(compr->buf,
1732 HOST_BUFFER_FIELD(high_water_mark),
1733 wm_adsp_compr_frag_words(compr));
1735 compr_err(compr, "Failed to set high water mark: %d\n",
1740 case SNDRV_PCM_TRIGGER_STOP:
1741 if (wm_adsp_compr_attached(compr))
1742 wm_adsp_buffer_clear(compr->buf);
1749 mutex_unlock(&dsp->cs_dsp.pwr_lock);
1753 EXPORT_SYMBOL_GPL(wm_adsp_compr_trigger);
1755 static inline int wm_adsp_buffer_size(struct wm_adsp_compr_buf *buf)
1757 int last_region = wm_adsp_fw[buf->dsp->fw].caps->num_regions - 1;
1759 return buf->regions[last_region].cumulative_size;
1762 static int wm_adsp_buffer_update_avail(struct wm_adsp_compr_buf *buf)
1764 u32 next_read_index, next_write_index;
1765 int write_index, read_index, avail;
1768 /* Only sync read index if we haven't already read a valid index */
1769 if (buf->read_index < 0) {
1770 ret = wm_adsp_buffer_read(buf,
1771 HOST_BUFFER_FIELD(next_read_index),
1776 read_index = sign_extend32(next_read_index, 23);
1778 if (read_index < 0) {
1779 compr_dbg(buf, "Avail check on unstarted stream\n");
1783 buf->read_index = read_index;
1786 ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(next_write_index),
1791 write_index = sign_extend32(next_write_index, 23);
1793 avail = write_index - buf->read_index;
1795 avail += wm_adsp_buffer_size(buf);
1797 compr_dbg(buf, "readindex=0x%x, writeindex=0x%x, avail=%d\n",
1798 buf->read_index, write_index, avail * CS_DSP_DATA_WORD_SIZE);
1805 int wm_adsp_compr_handle_irq(struct wm_adsp *dsp)
1807 struct wm_adsp_compr_buf *buf;
1808 struct wm_adsp_compr *compr;
1811 mutex_lock(&dsp->cs_dsp.pwr_lock);
1813 if (list_empty(&dsp->buffer_list)) {
1818 adsp_dbg(dsp, "Handling buffer IRQ\n");
1820 list_for_each_entry(buf, &dsp->buffer_list, list) {
1823 ret = wm_adsp_buffer_get_error(buf);
1825 goto out_notify; /* Wake poll to report error */
1827 ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(irq_count),
1830 compr_err(buf, "Failed to get irq_count: %d\n", ret);
1834 ret = wm_adsp_buffer_update_avail(buf);
1836 compr_err(buf, "Error reading avail: %d\n", ret);
1840 if (wm_adsp_fw[dsp->fw].voice_trigger && buf->irq_count == 2)
1841 ret = WM_ADSP_COMPR_VOICE_TRIGGER;
1844 if (compr && compr->stream)
1845 snd_compr_fragment_elapsed(compr->stream);
1849 mutex_unlock(&dsp->cs_dsp.pwr_lock);
1853 EXPORT_SYMBOL_GPL(wm_adsp_compr_handle_irq);
1855 static int wm_adsp_buffer_reenable_irq(struct wm_adsp_compr_buf *buf)
1857 if (buf->irq_count & 0x01)
1860 compr_dbg(buf, "Enable IRQ(0x%x) for next fragment\n", buf->irq_count);
1862 buf->irq_count |= 0x01;
1864 return wm_adsp_buffer_write(buf, HOST_BUFFER_FIELD(irq_ack),
1868 int wm_adsp_compr_pointer(struct snd_soc_component *component,
1869 struct snd_compr_stream *stream,
1870 struct snd_compr_tstamp *tstamp)
1872 struct wm_adsp_compr *compr = stream->runtime->private_data;
1873 struct wm_adsp *dsp = compr->dsp;
1874 struct wm_adsp_compr_buf *buf;
1877 compr_dbg(compr, "Pointer request\n");
1879 mutex_lock(&dsp->cs_dsp.pwr_lock);
1883 if (dsp->fatal_error || !buf || buf->error) {
1884 snd_compr_stop_error(stream, SNDRV_PCM_STATE_XRUN);
1889 if (buf->avail < wm_adsp_compr_frag_words(compr)) {
1890 ret = wm_adsp_buffer_update_avail(buf);
1892 compr_err(compr, "Error reading avail: %d\n", ret);
1897 * If we really have less than 1 fragment available tell the
1898 * DSP to inform us once a whole fragment is available.
1900 if (buf->avail < wm_adsp_compr_frag_words(compr)) {
1901 ret = wm_adsp_buffer_get_error(buf);
1904 snd_compr_stop_error(stream,
1905 SNDRV_PCM_STATE_XRUN);
1909 ret = wm_adsp_buffer_reenable_irq(buf);
1911 compr_err(compr, "Failed to re-enable buffer IRQ: %d\n",
1918 tstamp->copied_total = compr->copied_total;
1919 tstamp->copied_total += buf->avail * CS_DSP_DATA_WORD_SIZE;
1920 tstamp->sampling_rate = compr->sample_rate;
1923 mutex_unlock(&dsp->cs_dsp.pwr_lock);
1927 EXPORT_SYMBOL_GPL(wm_adsp_compr_pointer);
1929 static int wm_adsp_buffer_capture_block(struct wm_adsp_compr *compr, int target)
1931 struct wm_adsp_compr_buf *buf = compr->buf;
1932 unsigned int adsp_addr;
1933 int mem_type, nwords, max_read;
1936 /* Calculate read parameters */
1937 for (i = 0; i < wm_adsp_fw[buf->dsp->fw].caps->num_regions; ++i)
1938 if (buf->read_index < buf->regions[i].cumulative_size)
1941 if (i == wm_adsp_fw[buf->dsp->fw].caps->num_regions)
1944 mem_type = buf->regions[i].mem_type;
1945 adsp_addr = buf->regions[i].base_addr +
1946 (buf->read_index - buf->regions[i].offset);
1948 max_read = wm_adsp_compr_frag_words(compr);
1949 nwords = buf->regions[i].cumulative_size - buf->read_index;
1951 if (nwords > target)
1953 if (nwords > buf->avail)
1954 nwords = buf->avail;
1955 if (nwords > max_read)
1960 /* Read data from DSP */
1961 ret = cs_dsp_read_raw_data_block(&buf->dsp->cs_dsp, mem_type, adsp_addr,
1962 nwords, (__be32 *)compr->raw_buf);
1966 cs_dsp_remove_padding(compr->raw_buf, nwords);
1968 /* update read index to account for words read */
1969 buf->read_index += nwords;
1970 if (buf->read_index == wm_adsp_buffer_size(buf))
1971 buf->read_index = 0;
1973 ret = wm_adsp_buffer_write(buf, HOST_BUFFER_FIELD(next_read_index),
1978 /* update avail to account for words read */
1979 buf->avail -= nwords;
1984 static int wm_adsp_compr_read(struct wm_adsp_compr *compr,
1985 char __user *buf, size_t count)
1987 struct wm_adsp *dsp = compr->dsp;
1991 compr_dbg(compr, "Requested read of %zu bytes\n", count);
1993 if (dsp->fatal_error || !compr->buf || compr->buf->error) {
1994 snd_compr_stop_error(compr->stream, SNDRV_PCM_STATE_XRUN);
1998 count /= CS_DSP_DATA_WORD_SIZE;
2001 nwords = wm_adsp_buffer_capture_block(compr, count);
2003 compr_err(compr, "Failed to capture block: %d\n",
2008 nbytes = nwords * CS_DSP_DATA_WORD_SIZE;
2010 compr_dbg(compr, "Read %d bytes\n", nbytes);
2012 if (copy_to_user(buf + ntotal, compr->raw_buf, nbytes)) {
2013 compr_err(compr, "Failed to copy data to user: %d, %d\n",
2020 } while (nwords > 0 && count > 0);
2022 compr->copied_total += ntotal;
2027 int wm_adsp_compr_copy(struct snd_soc_component *component,
2028 struct snd_compr_stream *stream, char __user *buf,
2031 struct wm_adsp_compr *compr = stream->runtime->private_data;
2032 struct wm_adsp *dsp = compr->dsp;
2035 mutex_lock(&dsp->cs_dsp.pwr_lock);
2037 if (stream->direction == SND_COMPRESS_CAPTURE)
2038 ret = wm_adsp_compr_read(compr, buf, count);
2042 mutex_unlock(&dsp->cs_dsp.pwr_lock);
2046 EXPORT_SYMBOL_GPL(wm_adsp_compr_copy);
2048 static void wm_adsp_fatal_error(struct cs_dsp *cs_dsp)
2050 struct wm_adsp *dsp = container_of(cs_dsp, struct wm_adsp, cs_dsp);
2051 struct wm_adsp_compr *compr;
2053 dsp->fatal_error = true;
2055 list_for_each_entry(compr, &dsp->compr_list, list) {
2057 snd_compr_fragment_elapsed(compr->stream);
2061 irqreturn_t wm_adsp2_bus_error(int irq, void *data)
2063 struct wm_adsp *dsp = (struct wm_adsp *)data;
2065 cs_dsp_adsp2_bus_error(&dsp->cs_dsp);
2069 EXPORT_SYMBOL_GPL(wm_adsp2_bus_error);
2071 irqreturn_t wm_halo_bus_error(int irq, void *data)
2073 struct wm_adsp *dsp = (struct wm_adsp *)data;
2075 cs_dsp_halo_bus_error(&dsp->cs_dsp);
2079 EXPORT_SYMBOL_GPL(wm_halo_bus_error);
2081 irqreturn_t wm_halo_wdt_expire(int irq, void *data)
2083 struct wm_adsp *dsp = data;
2085 cs_dsp_halo_wdt_expire(&dsp->cs_dsp);
2089 EXPORT_SYMBOL_GPL(wm_halo_wdt_expire);
2091 static const struct cs_dsp_client_ops wm_adsp1_client_ops = {
2092 .control_add = wm_adsp_control_add,
2093 .control_remove = wm_adsp_control_remove,
2096 static const struct cs_dsp_client_ops wm_adsp2_client_ops = {
2097 .control_add = wm_adsp_control_add,
2098 .control_remove = wm_adsp_control_remove,
2099 .pre_run = wm_adsp_pre_run,
2100 .post_run = wm_adsp_event_post_run,
2101 .post_stop = wm_adsp_event_post_stop,
2102 .watchdog_expired = wm_adsp_fatal_error,
2105 MODULE_LICENSE("GPL v2");
2106 MODULE_IMPORT_NS(FW_CS_DSP);