1 // SPDX-License-Identifier: GPL-2.0-only
3 * wm_adsp.c -- Wolfson ADSP support
5 * Copyright 2012 Wolfson Microelectronics plc
7 * Author: Mark Brown <broonie@opensource.wolfsonmicro.com>
10 #include <linux/ctype.h>
11 #include <linux/module.h>
12 #include <linux/moduleparam.h>
13 #include <linux/init.h>
14 #include <linux/delay.h>
15 #include <linux/firmware.h>
16 #include <linux/list.h>
18 #include <linux/pm_runtime.h>
19 #include <linux/regmap.h>
20 #include <linux/regulator/consumer.h>
21 #include <linux/slab.h>
22 #include <linux/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;
424 mutex_lock(&cs_ctl->dsp->pwr_lock);
426 if (copy_from_user(cs_ctl->cache, bytes, size))
429 ret = cs_dsp_coeff_write_ctrl(cs_ctl, 0, cs_ctl->cache, size);
431 mutex_unlock(&cs_ctl->dsp->pwr_lock);
436 static int wm_coeff_put_acked(struct snd_kcontrol *kctl,
437 struct snd_ctl_elem_value *ucontrol)
439 struct soc_bytes_ext *bytes_ext =
440 (struct soc_bytes_ext *)kctl->private_value;
441 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
442 struct cs_dsp_coeff_ctl *cs_ctl = ctl->cs_ctl;
443 unsigned int val = ucontrol->value.integer.value[0];
447 return 0; /* 0 means no event */
449 mutex_lock(&cs_ctl->dsp->pwr_lock);
452 ret = cs_dsp_coeff_write_acked_control(cs_ctl, val);
456 mutex_unlock(&cs_ctl->dsp->pwr_lock);
461 static int wm_coeff_get(struct snd_kcontrol *kctl,
462 struct snd_ctl_elem_value *ucontrol)
464 struct soc_bytes_ext *bytes_ext =
465 (struct soc_bytes_ext *)kctl->private_value;
466 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
467 struct cs_dsp_coeff_ctl *cs_ctl = ctl->cs_ctl;
468 char *p = ucontrol->value.bytes.data;
471 mutex_lock(&cs_ctl->dsp->pwr_lock);
472 ret = cs_dsp_coeff_read_ctrl(cs_ctl, 0, p, cs_ctl->len);
473 mutex_unlock(&cs_ctl->dsp->pwr_lock);
478 static int wm_coeff_tlv_get(struct snd_kcontrol *kctl,
479 unsigned int __user *bytes, unsigned int size)
481 struct soc_bytes_ext *bytes_ext =
482 (struct soc_bytes_ext *)kctl->private_value;
483 struct wm_coeff_ctl *ctl = bytes_ext_to_ctl(bytes_ext);
484 struct cs_dsp_coeff_ctl *cs_ctl = ctl->cs_ctl;
487 mutex_lock(&cs_ctl->dsp->pwr_lock);
489 ret = cs_dsp_coeff_read_ctrl(cs_ctl, 0, cs_ctl->cache, size);
491 if (!ret && copy_to_user(bytes, cs_ctl->cache, size))
494 mutex_unlock(&cs_ctl->dsp->pwr_lock);
499 static int wm_coeff_get_acked(struct snd_kcontrol *kcontrol,
500 struct snd_ctl_elem_value *ucontrol)
503 * Although it's not useful to read an acked control, we must satisfy
504 * user-side assumptions that all controls are readable and that a
505 * write of the same value should be filtered out (it's valid to send
506 * the same event number again to the firmware). We therefore return 0,
507 * meaning "no event" so valid event numbers will always be a change
509 ucontrol->value.integer.value[0] = 0;
514 static unsigned int wmfw_convert_flags(unsigned int in, unsigned int len)
516 unsigned int out, rd, wr, vol;
518 if (len > ADSP_MAX_STD_CTRL_SIZE) {
519 rd = SNDRV_CTL_ELEM_ACCESS_TLV_READ;
520 wr = SNDRV_CTL_ELEM_ACCESS_TLV_WRITE;
521 vol = SNDRV_CTL_ELEM_ACCESS_VOLATILE;
523 out = SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
525 rd = SNDRV_CTL_ELEM_ACCESS_READ;
526 wr = SNDRV_CTL_ELEM_ACCESS_WRITE;
527 vol = SNDRV_CTL_ELEM_ACCESS_VOLATILE;
534 if (in & WMFW_CTL_FLAG_WRITEABLE)
536 if (in & WMFW_CTL_FLAG_VOLATILE)
539 out |= rd | wr | vol;
545 static void wm_adsp_ctl_work(struct work_struct *work)
547 struct wm_coeff_ctl *ctl = container_of(work,
550 struct cs_dsp_coeff_ctl *cs_ctl = ctl->cs_ctl;
551 struct wm_adsp *dsp = container_of(cs_ctl->dsp,
554 struct snd_kcontrol_new *kcontrol;
556 kcontrol = kzalloc(sizeof(*kcontrol), GFP_KERNEL);
560 kcontrol->name = ctl->name;
561 kcontrol->info = wm_coeff_info;
562 kcontrol->iface = SNDRV_CTL_ELEM_IFACE_MIXER;
563 kcontrol->tlv.c = snd_soc_bytes_tlv_callback;
564 kcontrol->private_value = (unsigned long)&ctl->bytes_ext;
565 kcontrol->access = wmfw_convert_flags(cs_ctl->flags, cs_ctl->len);
567 switch (cs_ctl->type) {
568 case WMFW_CTL_TYPE_ACKED:
569 kcontrol->get = wm_coeff_get_acked;
570 kcontrol->put = wm_coeff_put_acked;
573 if (kcontrol->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
574 ctl->bytes_ext.max = cs_ctl->len;
575 ctl->bytes_ext.get = wm_coeff_tlv_get;
576 ctl->bytes_ext.put = wm_coeff_tlv_put;
578 kcontrol->get = wm_coeff_get;
579 kcontrol->put = wm_coeff_put;
584 snd_soc_add_component_controls(dsp->component, kcontrol, 1);
589 static int wm_adsp_control_add(struct cs_dsp_coeff_ctl *cs_ctl)
591 struct wm_adsp *dsp = container_of(cs_ctl->dsp, struct wm_adsp, cs_dsp);
592 struct cs_dsp *cs_dsp = &dsp->cs_dsp;
593 struct wm_coeff_ctl *ctl;
594 char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
595 const char *region_name;
598 if (cs_ctl->flags & WMFW_CTL_FLAG_SYS)
601 region_name = cs_dsp_mem_region_name(cs_ctl->alg_region.type);
603 adsp_err(dsp, "Unknown region type: %d\n", cs_ctl->alg_region.type);
607 switch (cs_dsp->fw_ver) {
610 ret = scnprintf(name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN,
611 "%s %s %x", cs_dsp->name, region_name,
612 cs_ctl->alg_region.alg);
615 ret = scnprintf(name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN,
616 "%s%c %.12s %x", cs_dsp->name, *region_name,
617 wm_adsp_fw_text[dsp->fw], cs_ctl->alg_region.alg);
620 ret = scnprintf(name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN,
621 "%s %.12s %x", cs_dsp->name,
622 wm_adsp_fw_text[dsp->fw], cs_ctl->alg_region.alg);
626 if (cs_ctl->subname) {
627 int avail = SNDRV_CTL_ELEM_ID_NAME_MAXLEN - ret - 2;
630 if (dsp->component->name_prefix)
631 avail -= strlen(dsp->component->name_prefix) + 1;
633 /* Truncate the subname from the start if it is too long */
634 if (cs_ctl->subname_len > avail)
635 skip = cs_ctl->subname_len - avail;
637 snprintf(name + ret, SNDRV_CTL_ELEM_ID_NAME_MAXLEN - ret,
638 " %.*s", cs_ctl->subname_len - skip, cs_ctl->subname + skip);
641 ctl = kzalloc(sizeof(*ctl), GFP_KERNEL);
644 ctl->cs_ctl = cs_ctl;
646 ctl->name = kmemdup(name, strlen(name) + 1, GFP_KERNEL);
654 INIT_WORK(&ctl->work, wm_adsp_ctl_work);
655 schedule_work(&ctl->work);
665 static void wm_adsp_control_remove(struct cs_dsp_coeff_ctl *cs_ctl)
667 struct wm_coeff_ctl *ctl = cs_ctl->priv;
669 cancel_work_sync(&ctl->work);
675 int wm_adsp_write_ctl(struct wm_adsp *dsp, const char *name, int type,
676 unsigned int alg, void *buf, size_t len)
678 struct cs_dsp_coeff_ctl *cs_ctl = cs_dsp_get_ctl(&dsp->cs_dsp, name, type, alg);
679 struct wm_coeff_ctl *ctl;
680 struct snd_kcontrol *kcontrol;
681 char ctl_name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
684 ret = cs_dsp_coeff_write_ctrl(cs_ctl, 0, buf, len);
688 if (cs_ctl->flags & WMFW_CTL_FLAG_SYS)
693 if (dsp->component->name_prefix)
694 snprintf(ctl_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN, "%s %s",
695 dsp->component->name_prefix, ctl->name);
697 snprintf(ctl_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN, "%s",
700 kcontrol = snd_soc_card_get_kcontrol(dsp->component->card, ctl_name);
702 adsp_err(dsp, "Can't find kcontrol %s\n", ctl_name);
706 snd_ctl_notify(dsp->component->card->snd_card,
707 SNDRV_CTL_EVENT_MASK_VALUE, &kcontrol->id);
711 EXPORT_SYMBOL_GPL(wm_adsp_write_ctl);
713 int wm_adsp_read_ctl(struct wm_adsp *dsp, const char *name, int type,
714 unsigned int alg, void *buf, size_t len)
716 return cs_dsp_coeff_read_ctrl(cs_dsp_get_ctl(&dsp->cs_dsp, name, type, alg),
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);
792 static const char *cirrus_dir = "cirrus/";
793 static int wm_adsp_request_firmware_files(struct wm_adsp *dsp,
794 const struct firmware **wmfw_firmware,
795 char **wmfw_filename,
796 const struct firmware **coeff_firmware,
797 char **coeff_filename)
799 const char *system_name = dsp->system_name;
800 const char *asoc_component_prefix = dsp->component->name_prefix;
803 if (system_name && asoc_component_prefix) {
804 if (!wm_adsp_request_firmware_file(dsp, wmfw_firmware, wmfw_filename,
805 cirrus_dir, system_name,
806 asoc_component_prefix, "wmfw")) {
807 adsp_dbg(dsp, "Found '%s'\n", *wmfw_filename);
808 wm_adsp_request_firmware_file(dsp, coeff_firmware, coeff_filename,
809 cirrus_dir, system_name,
810 asoc_component_prefix, "bin");
816 if (!wm_adsp_request_firmware_file(dsp, wmfw_firmware, wmfw_filename,
817 cirrus_dir, system_name,
819 adsp_dbg(dsp, "Found '%s'\n", *wmfw_filename);
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 if (!wm_adsp_request_firmware_file(dsp, wmfw_firmware, wmfw_filename,
834 "", NULL, NULL, "wmfw")) {
835 adsp_dbg(dsp, "Found '%s'\n", *wmfw_filename);
836 wm_adsp_request_firmware_file(dsp, coeff_firmware, coeff_filename,
837 "", NULL, NULL, "bin");
841 ret = wm_adsp_request_firmware_file(dsp, wmfw_firmware, wmfw_filename,
842 cirrus_dir, NULL, NULL, "wmfw");
844 adsp_dbg(dsp, "Found '%s'\n", *wmfw_filename);
845 wm_adsp_request_firmware_file(dsp, coeff_firmware, coeff_filename,
846 cirrus_dir, NULL, NULL, "bin");
850 adsp_err(dsp, "Failed to request firmware <%s>%s-%s-%s<-%s<%s>>.wmfw\n",
851 cirrus_dir, dsp->part,
852 dsp->fwf_name ? dsp->fwf_name : dsp->cs_dsp.name,
853 wm_adsp_fw[dsp->fw].file, system_name, asoc_component_prefix);
858 static int wm_adsp_common_init(struct wm_adsp *dsp)
860 INIT_LIST_HEAD(&dsp->compr_list);
861 INIT_LIST_HEAD(&dsp->buffer_list);
866 int wm_adsp1_init(struct wm_adsp *dsp)
870 dsp->cs_dsp.client_ops = &wm_adsp1_client_ops;
872 ret = cs_dsp_adsp1_init(&dsp->cs_dsp);
876 return wm_adsp_common_init(dsp);
878 EXPORT_SYMBOL_GPL(wm_adsp1_init);
880 int wm_adsp1_event(struct snd_soc_dapm_widget *w,
881 struct snd_kcontrol *kcontrol,
884 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
885 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
886 struct wm_adsp *dsp = &dsps[w->shift];
888 char *wmfw_filename = NULL;
889 const struct firmware *wmfw_firmware = NULL;
890 char *coeff_filename = NULL;
891 const struct firmware *coeff_firmware = NULL;
893 dsp->component = component;
896 case SND_SOC_DAPM_POST_PMU:
897 ret = wm_adsp_request_firmware_files(dsp,
898 &wmfw_firmware, &wmfw_filename,
899 &coeff_firmware, &coeff_filename);
903 ret = cs_dsp_adsp1_power_up(&dsp->cs_dsp,
904 wmfw_firmware, wmfw_filename,
905 coeff_firmware, coeff_filename,
906 wm_adsp_fw_text[dsp->fw]);
908 wm_adsp_release_firmware_files(dsp,
909 wmfw_firmware, wmfw_filename,
910 coeff_firmware, coeff_filename);
912 case SND_SOC_DAPM_PRE_PMD:
913 cs_dsp_adsp1_power_down(&dsp->cs_dsp);
921 EXPORT_SYMBOL_GPL(wm_adsp1_event);
923 int wm_adsp2_set_dspclk(struct snd_soc_dapm_widget *w, unsigned int freq)
925 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
926 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
927 struct wm_adsp *dsp = &dsps[w->shift];
929 return cs_dsp_set_dspclk(&dsp->cs_dsp, freq);
931 EXPORT_SYMBOL_GPL(wm_adsp2_set_dspclk);
933 int wm_adsp2_preloader_get(struct snd_kcontrol *kcontrol,
934 struct snd_ctl_elem_value *ucontrol)
936 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
937 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
938 struct soc_mixer_control *mc =
939 (struct soc_mixer_control *)kcontrol->private_value;
940 struct wm_adsp *dsp = &dsps[mc->shift - 1];
942 ucontrol->value.integer.value[0] = dsp->preloaded;
946 EXPORT_SYMBOL_GPL(wm_adsp2_preloader_get);
948 int wm_adsp2_preloader_put(struct snd_kcontrol *kcontrol,
949 struct snd_ctl_elem_value *ucontrol)
951 struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
952 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
953 struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(component);
954 struct soc_mixer_control *mc =
955 (struct soc_mixer_control *)kcontrol->private_value;
956 struct wm_adsp *dsp = &dsps[mc->shift - 1];
959 if (dsp->preloaded == ucontrol->value.integer.value[0])
962 snprintf(preload, ARRAY_SIZE(preload), "%s Preload", dsp->cs_dsp.name);
964 if (ucontrol->value.integer.value[0] || dsp->toggle_preload)
965 snd_soc_component_force_enable_pin(component, preload);
967 snd_soc_component_disable_pin(component, preload);
969 snd_soc_dapm_sync(dapm);
971 flush_work(&dsp->boot_work);
973 dsp->preloaded = ucontrol->value.integer.value[0];
975 if (dsp->toggle_preload) {
976 snd_soc_component_disable_pin(component, preload);
977 snd_soc_dapm_sync(dapm);
982 EXPORT_SYMBOL_GPL(wm_adsp2_preloader_put);
984 static void wm_adsp_boot_work(struct work_struct *work)
986 struct wm_adsp *dsp = container_of(work,
990 char *wmfw_filename = NULL;
991 const struct firmware *wmfw_firmware = NULL;
992 char *coeff_filename = NULL;
993 const struct firmware *coeff_firmware = NULL;
995 ret = wm_adsp_request_firmware_files(dsp,
996 &wmfw_firmware, &wmfw_filename,
997 &coeff_firmware, &coeff_filename);
1001 cs_dsp_power_up(&dsp->cs_dsp,
1002 wmfw_firmware, wmfw_filename,
1003 coeff_firmware, coeff_filename,
1004 wm_adsp_fw_text[dsp->fw]);
1006 wm_adsp_release_firmware_files(dsp,
1007 wmfw_firmware, wmfw_filename,
1008 coeff_firmware, coeff_filename);
1011 int wm_adsp_early_event(struct snd_soc_dapm_widget *w,
1012 struct snd_kcontrol *kcontrol, int event)
1014 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
1015 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
1016 struct wm_adsp *dsp = &dsps[w->shift];
1019 case SND_SOC_DAPM_PRE_PMU:
1020 queue_work(system_unbound_wq, &dsp->boot_work);
1022 case SND_SOC_DAPM_PRE_PMD:
1023 cs_dsp_power_down(&dsp->cs_dsp);
1031 EXPORT_SYMBOL_GPL(wm_adsp_early_event);
1033 static int wm_adsp_event_post_run(struct cs_dsp *cs_dsp)
1035 struct wm_adsp *dsp = container_of(cs_dsp, struct wm_adsp, cs_dsp);
1037 if (wm_adsp_fw[dsp->fw].num_caps != 0)
1038 return wm_adsp_buffer_init(dsp);
1043 static void wm_adsp_event_post_stop(struct cs_dsp *cs_dsp)
1045 struct wm_adsp *dsp = container_of(cs_dsp, struct wm_adsp, cs_dsp);
1047 if (wm_adsp_fw[dsp->fw].num_caps != 0)
1048 wm_adsp_buffer_free(dsp);
1050 dsp->fatal_error = false;
1053 int wm_adsp_event(struct snd_soc_dapm_widget *w,
1054 struct snd_kcontrol *kcontrol, int event)
1056 struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
1057 struct wm_adsp *dsps = snd_soc_component_get_drvdata(component);
1058 struct wm_adsp *dsp = &dsps[w->shift];
1062 case SND_SOC_DAPM_POST_PMU:
1063 flush_work(&dsp->boot_work);
1064 ret = cs_dsp_run(&dsp->cs_dsp);
1066 case SND_SOC_DAPM_PRE_PMD:
1067 cs_dsp_stop(&dsp->cs_dsp);
1075 EXPORT_SYMBOL_GPL(wm_adsp_event);
1077 int wm_adsp2_component_probe(struct wm_adsp *dsp, struct snd_soc_component *component)
1081 snprintf(preload, ARRAY_SIZE(preload), "%s Preload", dsp->cs_dsp.name);
1082 snd_soc_component_disable_pin(component, preload);
1084 cs_dsp_init_debugfs(&dsp->cs_dsp, component->debugfs_root);
1086 dsp->component = component;
1090 EXPORT_SYMBOL_GPL(wm_adsp2_component_probe);
1092 int wm_adsp2_component_remove(struct wm_adsp *dsp, struct snd_soc_component *component)
1094 cs_dsp_cleanup_debugfs(&dsp->cs_dsp);
1098 EXPORT_SYMBOL_GPL(wm_adsp2_component_remove);
1100 int wm_adsp2_init(struct wm_adsp *dsp)
1104 INIT_WORK(&dsp->boot_work, wm_adsp_boot_work);
1106 dsp->sys_config_size = sizeof(struct wm_adsp_system_config_xm_hdr);
1107 dsp->cs_dsp.client_ops = &wm_adsp2_client_ops;
1109 ret = cs_dsp_adsp2_init(&dsp->cs_dsp);
1113 return wm_adsp_common_init(dsp);
1115 EXPORT_SYMBOL_GPL(wm_adsp2_init);
1117 int wm_halo_init(struct wm_adsp *dsp)
1121 INIT_WORK(&dsp->boot_work, wm_adsp_boot_work);
1123 dsp->sys_config_size = sizeof(struct wm_halo_system_config_xm_hdr);
1124 dsp->cs_dsp.client_ops = &wm_adsp2_client_ops;
1126 ret = cs_dsp_halo_init(&dsp->cs_dsp);
1130 return wm_adsp_common_init(dsp);
1132 EXPORT_SYMBOL_GPL(wm_halo_init);
1134 void wm_adsp2_remove(struct wm_adsp *dsp)
1136 cs_dsp_remove(&dsp->cs_dsp);
1138 EXPORT_SYMBOL_GPL(wm_adsp2_remove);
1140 static inline int wm_adsp_compr_attached(struct wm_adsp_compr *compr)
1142 return compr->buf != NULL;
1145 static int wm_adsp_compr_attach(struct wm_adsp_compr *compr)
1147 struct wm_adsp_compr_buf *buf = NULL, *tmp;
1149 if (compr->dsp->fatal_error)
1152 list_for_each_entry(tmp, &compr->dsp->buffer_list, list) {
1153 if (!tmp->name || !strcmp(compr->name, tmp->name)) {
1168 static void wm_adsp_compr_detach(struct wm_adsp_compr *compr)
1173 /* Wake the poll so it can see buffer is no longer attached */
1175 snd_compr_fragment_elapsed(compr->stream);
1177 if (wm_adsp_compr_attached(compr)) {
1178 compr->buf->compr = NULL;
1183 int wm_adsp_compr_open(struct wm_adsp *dsp, struct snd_compr_stream *stream)
1185 struct wm_adsp_compr *compr, *tmp;
1186 struct snd_soc_pcm_runtime *rtd = stream->private_data;
1189 mutex_lock(&dsp->cs_dsp.pwr_lock);
1191 if (wm_adsp_fw[dsp->fw].num_caps == 0) {
1192 adsp_err(dsp, "%s: Firmware does not support compressed API\n",
1193 asoc_rtd_to_codec(rtd, 0)->name);
1198 if (wm_adsp_fw[dsp->fw].compr_direction != stream->direction) {
1199 adsp_err(dsp, "%s: Firmware does not support stream direction\n",
1200 asoc_rtd_to_codec(rtd, 0)->name);
1205 list_for_each_entry(tmp, &dsp->compr_list, list) {
1206 if (!strcmp(tmp->name, asoc_rtd_to_codec(rtd, 0)->name)) {
1207 adsp_err(dsp, "%s: Only a single stream supported per dai\n",
1208 asoc_rtd_to_codec(rtd, 0)->name);
1214 compr = kzalloc(sizeof(*compr), GFP_KERNEL);
1221 compr->stream = stream;
1222 compr->name = asoc_rtd_to_codec(rtd, 0)->name;
1224 list_add_tail(&compr->list, &dsp->compr_list);
1226 stream->runtime->private_data = compr;
1229 mutex_unlock(&dsp->cs_dsp.pwr_lock);
1233 EXPORT_SYMBOL_GPL(wm_adsp_compr_open);
1235 int wm_adsp_compr_free(struct snd_soc_component *component,
1236 struct snd_compr_stream *stream)
1238 struct wm_adsp_compr *compr = stream->runtime->private_data;
1239 struct wm_adsp *dsp = compr->dsp;
1241 mutex_lock(&dsp->cs_dsp.pwr_lock);
1243 wm_adsp_compr_detach(compr);
1244 list_del(&compr->list);
1246 kfree(compr->raw_buf);
1249 mutex_unlock(&dsp->cs_dsp.pwr_lock);
1253 EXPORT_SYMBOL_GPL(wm_adsp_compr_free);
1255 static int wm_adsp_compr_check_params(struct snd_compr_stream *stream,
1256 struct snd_compr_params *params)
1258 struct wm_adsp_compr *compr = stream->runtime->private_data;
1259 struct wm_adsp *dsp = compr->dsp;
1260 const struct wm_adsp_fw_caps *caps;
1261 const struct snd_codec_desc *desc;
1264 if (params->buffer.fragment_size < WM_ADSP_MIN_FRAGMENT_SIZE ||
1265 params->buffer.fragment_size > WM_ADSP_MAX_FRAGMENT_SIZE ||
1266 params->buffer.fragments < WM_ADSP_MIN_FRAGMENTS ||
1267 params->buffer.fragments > WM_ADSP_MAX_FRAGMENTS ||
1268 params->buffer.fragment_size % CS_DSP_DATA_WORD_SIZE) {
1269 compr_err(compr, "Invalid buffer fragsize=%d fragments=%d\n",
1270 params->buffer.fragment_size,
1271 params->buffer.fragments);
1276 for (i = 0; i < wm_adsp_fw[dsp->fw].num_caps; i++) {
1277 caps = &wm_adsp_fw[dsp->fw].caps[i];
1280 if (caps->id != params->codec.id)
1283 if (stream->direction == SND_COMPRESS_PLAYBACK) {
1284 if (desc->max_ch < params->codec.ch_out)
1287 if (desc->max_ch < params->codec.ch_in)
1291 if (!(desc->formats & (1 << params->codec.format)))
1294 for (j = 0; j < desc->num_sample_rates; ++j)
1295 if (desc->sample_rates[j] == params->codec.sample_rate)
1299 compr_err(compr, "Invalid params id=%u ch=%u,%u rate=%u fmt=%u\n",
1300 params->codec.id, params->codec.ch_in, params->codec.ch_out,
1301 params->codec.sample_rate, params->codec.format);
1305 static inline unsigned int wm_adsp_compr_frag_words(struct wm_adsp_compr *compr)
1307 return compr->size.fragment_size / CS_DSP_DATA_WORD_SIZE;
1310 int wm_adsp_compr_set_params(struct snd_soc_component *component,
1311 struct snd_compr_stream *stream,
1312 struct snd_compr_params *params)
1314 struct wm_adsp_compr *compr = stream->runtime->private_data;
1318 ret = wm_adsp_compr_check_params(stream, params);
1322 compr->size = params->buffer;
1324 compr_dbg(compr, "fragment_size=%d fragments=%d\n",
1325 compr->size.fragment_size, compr->size.fragments);
1327 size = wm_adsp_compr_frag_words(compr) * sizeof(*compr->raw_buf);
1328 compr->raw_buf = kmalloc(size, GFP_DMA | GFP_KERNEL);
1329 if (!compr->raw_buf)
1332 compr->sample_rate = params->codec.sample_rate;
1336 EXPORT_SYMBOL_GPL(wm_adsp_compr_set_params);
1338 int wm_adsp_compr_get_caps(struct snd_soc_component *component,
1339 struct snd_compr_stream *stream,
1340 struct snd_compr_caps *caps)
1342 struct wm_adsp_compr *compr = stream->runtime->private_data;
1343 int fw = compr->dsp->fw;
1346 if (wm_adsp_fw[fw].caps) {
1347 for (i = 0; i < wm_adsp_fw[fw].num_caps; i++)
1348 caps->codecs[i] = wm_adsp_fw[fw].caps[i].id;
1350 caps->num_codecs = i;
1351 caps->direction = wm_adsp_fw[fw].compr_direction;
1353 caps->min_fragment_size = WM_ADSP_MIN_FRAGMENT_SIZE;
1354 caps->max_fragment_size = WM_ADSP_MAX_FRAGMENT_SIZE;
1355 caps->min_fragments = WM_ADSP_MIN_FRAGMENTS;
1356 caps->max_fragments = WM_ADSP_MAX_FRAGMENTS;
1361 EXPORT_SYMBOL_GPL(wm_adsp_compr_get_caps);
1363 static inline int wm_adsp_buffer_read(struct wm_adsp_compr_buf *buf,
1364 unsigned int field_offset, u32 *data)
1366 return cs_dsp_read_data_word(&buf->dsp->cs_dsp, buf->host_buf_mem_type,
1367 buf->host_buf_ptr + field_offset, data);
1370 static inline int wm_adsp_buffer_write(struct wm_adsp_compr_buf *buf,
1371 unsigned int field_offset, u32 data)
1373 return cs_dsp_write_data_word(&buf->dsp->cs_dsp, buf->host_buf_mem_type,
1374 buf->host_buf_ptr + field_offset,
1378 static int wm_adsp_buffer_populate(struct wm_adsp_compr_buf *buf)
1380 const struct wm_adsp_fw_caps *caps = wm_adsp_fw[buf->dsp->fw].caps;
1381 struct wm_adsp_buffer_region *region;
1385 buf->regions = kcalloc(caps->num_regions, sizeof(*buf->regions),
1390 for (i = 0; i < caps->num_regions; ++i) {
1391 region = &buf->regions[i];
1393 region->offset = offset;
1394 region->mem_type = caps->region_defs[i].mem_type;
1396 ret = wm_adsp_buffer_read(buf, caps->region_defs[i].base_offset,
1397 ®ion->base_addr);
1401 ret = wm_adsp_buffer_read(buf, caps->region_defs[i].size_offset,
1406 region->cumulative_size = offset;
1409 "region=%d type=%d base=%08x off=%08x size=%08x\n",
1410 i, region->mem_type, region->base_addr,
1411 region->offset, region->cumulative_size);
1417 kfree(buf->regions);
1421 static void wm_adsp_buffer_clear(struct wm_adsp_compr_buf *buf)
1423 buf->irq_count = 0xFFFFFFFF;
1424 buf->read_index = -1;
1428 static struct wm_adsp_compr_buf *wm_adsp_buffer_alloc(struct wm_adsp *dsp)
1430 struct wm_adsp_compr_buf *buf;
1432 buf = kzalloc(sizeof(*buf), GFP_KERNEL);
1438 wm_adsp_buffer_clear(buf);
1443 static int wm_adsp_buffer_parse_legacy(struct wm_adsp *dsp)
1445 struct cs_dsp_alg_region *alg_region;
1446 struct wm_adsp_compr_buf *buf;
1447 u32 xmalg, addr, magic;
1450 alg_region = cs_dsp_find_alg_region(&dsp->cs_dsp, WMFW_ADSP2_XM, dsp->cs_dsp.fw_id);
1452 adsp_err(dsp, "No algorithm region found\n");
1456 xmalg = dsp->sys_config_size / sizeof(__be32);
1458 addr = alg_region->base + xmalg + ALG_XM_FIELD(magic);
1459 ret = cs_dsp_read_data_word(&dsp->cs_dsp, WMFW_ADSP2_XM, addr, &magic);
1463 if (magic != WM_ADSP_ALG_XM_STRUCT_MAGIC)
1466 buf = wm_adsp_buffer_alloc(dsp);
1470 addr = alg_region->base + xmalg + ALG_XM_FIELD(host_buf_ptr);
1471 for (i = 0; i < 5; ++i) {
1472 ret = cs_dsp_read_data_word(&dsp->cs_dsp, WMFW_ADSP2_XM, addr,
1473 &buf->host_buf_ptr);
1477 if (buf->host_buf_ptr)
1480 usleep_range(1000, 2000);
1483 if (!buf->host_buf_ptr) {
1488 buf->host_buf_mem_type = WMFW_ADSP2_XM;
1490 ret = wm_adsp_buffer_populate(buf);
1494 list_add_tail(&buf->list, &dsp->buffer_list);
1496 compr_dbg(buf, "legacy host_buf_ptr=%x\n", buf->host_buf_ptr);
1506 static int wm_adsp_buffer_parse_coeff(struct cs_dsp_coeff_ctl *cs_ctl)
1508 struct wm_adsp_host_buf_coeff_v1 coeff_v1;
1509 struct wm_adsp_compr_buf *buf;
1510 struct wm_adsp *dsp = container_of(cs_ctl->dsp, struct wm_adsp, cs_dsp);
1511 unsigned int version = 0;
1514 for (i = 0; i < 5; ++i) {
1515 ret = cs_dsp_coeff_read_ctrl(cs_ctl, 0, &coeff_v1,
1516 min(cs_ctl->len, sizeof(coeff_v1)));
1520 if (coeff_v1.host_buf_ptr)
1523 usleep_range(1000, 2000);
1526 if (!coeff_v1.host_buf_ptr) {
1527 adsp_err(dsp, "Failed to acquire host buffer\n");
1531 buf = wm_adsp_buffer_alloc(dsp);
1535 buf->host_buf_mem_type = cs_ctl->alg_region.type;
1536 buf->host_buf_ptr = be32_to_cpu(coeff_v1.host_buf_ptr);
1538 ret = wm_adsp_buffer_populate(buf);
1543 * v0 host_buffer coefficients didn't have versioning, so if the
1544 * control is one word, assume version 0.
1546 if (cs_ctl->len == 4)
1549 version = be32_to_cpu(coeff_v1.versions) & HOST_BUF_COEFF_COMPAT_VER_MASK;
1550 version >>= HOST_BUF_COEFF_COMPAT_VER_SHIFT;
1552 if (version > HOST_BUF_COEFF_SUPPORTED_COMPAT_VER) {
1554 "Host buffer coeff ver %u > supported version %u\n",
1555 version, HOST_BUF_COEFF_SUPPORTED_COMPAT_VER);
1560 cs_dsp_remove_padding((u32 *)&coeff_v1.name, ARRAY_SIZE(coeff_v1.name));
1562 buf->name = kasprintf(GFP_KERNEL, "%s-dsp-%s", dsp->part,
1563 (char *)&coeff_v1.name);
1566 list_add_tail(&buf->list, &dsp->buffer_list);
1568 compr_dbg(buf, "host_buf_ptr=%x coeff version %u\n",
1569 buf->host_buf_ptr, version);
1579 static int wm_adsp_buffer_init(struct wm_adsp *dsp)
1581 struct cs_dsp_coeff_ctl *cs_ctl;
1584 list_for_each_entry(cs_ctl, &dsp->cs_dsp.ctl_list, list) {
1585 if (cs_ctl->type != WMFW_CTL_TYPE_HOST_BUFFER)
1588 if (!cs_ctl->enabled)
1591 ret = wm_adsp_buffer_parse_coeff(cs_ctl);
1593 adsp_err(dsp, "Failed to parse coeff: %d\n", ret);
1595 } else if (ret == 0) {
1596 /* Only one buffer supported for version 0 */
1601 if (list_empty(&dsp->buffer_list)) {
1602 /* Fall back to legacy support */
1603 ret = wm_adsp_buffer_parse_legacy(dsp);
1605 adsp_info(dsp, "Legacy support not available\n");
1607 adsp_warn(dsp, "Failed to parse legacy: %d\n", ret);
1613 wm_adsp_buffer_free(dsp);
1617 static int wm_adsp_buffer_free(struct wm_adsp *dsp)
1619 struct wm_adsp_compr_buf *buf, *tmp;
1621 list_for_each_entry_safe(buf, tmp, &dsp->buffer_list, list) {
1622 wm_adsp_compr_detach(buf->compr);
1625 kfree(buf->regions);
1626 list_del(&buf->list);
1633 static int wm_adsp_buffer_get_error(struct wm_adsp_compr_buf *buf)
1637 ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(error), &buf->error);
1639 compr_err(buf, "Failed to check buffer error: %d\n", ret);
1642 if (buf->error != 0) {
1643 compr_err(buf, "Buffer error occurred: %d\n", buf->error);
1650 int wm_adsp_compr_trigger(struct snd_soc_component *component,
1651 struct snd_compr_stream *stream, int cmd)
1653 struct wm_adsp_compr *compr = stream->runtime->private_data;
1654 struct wm_adsp *dsp = compr->dsp;
1657 compr_dbg(compr, "Trigger: %d\n", cmd);
1659 mutex_lock(&dsp->cs_dsp.pwr_lock);
1662 case SNDRV_PCM_TRIGGER_START:
1663 if (!wm_adsp_compr_attached(compr)) {
1664 ret = wm_adsp_compr_attach(compr);
1666 compr_err(compr, "Failed to link buffer and stream: %d\n",
1672 ret = wm_adsp_buffer_get_error(compr->buf);
1676 /* Trigger the IRQ at one fragment of data */
1677 ret = wm_adsp_buffer_write(compr->buf,
1678 HOST_BUFFER_FIELD(high_water_mark),
1679 wm_adsp_compr_frag_words(compr));
1681 compr_err(compr, "Failed to set high water mark: %d\n",
1686 case SNDRV_PCM_TRIGGER_STOP:
1687 if (wm_adsp_compr_attached(compr))
1688 wm_adsp_buffer_clear(compr->buf);
1695 mutex_unlock(&dsp->cs_dsp.pwr_lock);
1699 EXPORT_SYMBOL_GPL(wm_adsp_compr_trigger);
1701 static inline int wm_adsp_buffer_size(struct wm_adsp_compr_buf *buf)
1703 int last_region = wm_adsp_fw[buf->dsp->fw].caps->num_regions - 1;
1705 return buf->regions[last_region].cumulative_size;
1708 static int wm_adsp_buffer_update_avail(struct wm_adsp_compr_buf *buf)
1710 u32 next_read_index, next_write_index;
1711 int write_index, read_index, avail;
1714 /* Only sync read index if we haven't already read a valid index */
1715 if (buf->read_index < 0) {
1716 ret = wm_adsp_buffer_read(buf,
1717 HOST_BUFFER_FIELD(next_read_index),
1722 read_index = sign_extend32(next_read_index, 23);
1724 if (read_index < 0) {
1725 compr_dbg(buf, "Avail check on unstarted stream\n");
1729 buf->read_index = read_index;
1732 ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(next_write_index),
1737 write_index = sign_extend32(next_write_index, 23);
1739 avail = write_index - buf->read_index;
1741 avail += wm_adsp_buffer_size(buf);
1743 compr_dbg(buf, "readindex=0x%x, writeindex=0x%x, avail=%d\n",
1744 buf->read_index, write_index, avail * CS_DSP_DATA_WORD_SIZE);
1751 int wm_adsp_compr_handle_irq(struct wm_adsp *dsp)
1753 struct wm_adsp_compr_buf *buf;
1754 struct wm_adsp_compr *compr;
1757 mutex_lock(&dsp->cs_dsp.pwr_lock);
1759 if (list_empty(&dsp->buffer_list)) {
1764 adsp_dbg(dsp, "Handling buffer IRQ\n");
1766 list_for_each_entry(buf, &dsp->buffer_list, list) {
1769 ret = wm_adsp_buffer_get_error(buf);
1771 goto out_notify; /* Wake poll to report error */
1773 ret = wm_adsp_buffer_read(buf, HOST_BUFFER_FIELD(irq_count),
1776 compr_err(buf, "Failed to get irq_count: %d\n", ret);
1780 ret = wm_adsp_buffer_update_avail(buf);
1782 compr_err(buf, "Error reading avail: %d\n", ret);
1786 if (wm_adsp_fw[dsp->fw].voice_trigger && buf->irq_count == 2)
1787 ret = WM_ADSP_COMPR_VOICE_TRIGGER;
1790 if (compr && compr->stream)
1791 snd_compr_fragment_elapsed(compr->stream);
1795 mutex_unlock(&dsp->cs_dsp.pwr_lock);
1799 EXPORT_SYMBOL_GPL(wm_adsp_compr_handle_irq);
1801 static int wm_adsp_buffer_reenable_irq(struct wm_adsp_compr_buf *buf)
1803 if (buf->irq_count & 0x01)
1806 compr_dbg(buf, "Enable IRQ(0x%x) for next fragment\n", buf->irq_count);
1808 buf->irq_count |= 0x01;
1810 return wm_adsp_buffer_write(buf, HOST_BUFFER_FIELD(irq_ack),
1814 int wm_adsp_compr_pointer(struct snd_soc_component *component,
1815 struct snd_compr_stream *stream,
1816 struct snd_compr_tstamp *tstamp)
1818 struct wm_adsp_compr *compr = stream->runtime->private_data;
1819 struct wm_adsp *dsp = compr->dsp;
1820 struct wm_adsp_compr_buf *buf;
1823 compr_dbg(compr, "Pointer request\n");
1825 mutex_lock(&dsp->cs_dsp.pwr_lock);
1829 if (dsp->fatal_error || !buf || buf->error) {
1830 snd_compr_stop_error(stream, SNDRV_PCM_STATE_XRUN);
1835 if (buf->avail < wm_adsp_compr_frag_words(compr)) {
1836 ret = wm_adsp_buffer_update_avail(buf);
1838 compr_err(compr, "Error reading avail: %d\n", ret);
1843 * If we really have less than 1 fragment available tell the
1844 * DSP to inform us once a whole fragment is available.
1846 if (buf->avail < wm_adsp_compr_frag_words(compr)) {
1847 ret = wm_adsp_buffer_get_error(buf);
1850 snd_compr_stop_error(stream,
1851 SNDRV_PCM_STATE_XRUN);
1855 ret = wm_adsp_buffer_reenable_irq(buf);
1857 compr_err(compr, "Failed to re-enable buffer IRQ: %d\n",
1864 tstamp->copied_total = compr->copied_total;
1865 tstamp->copied_total += buf->avail * CS_DSP_DATA_WORD_SIZE;
1866 tstamp->sampling_rate = compr->sample_rate;
1869 mutex_unlock(&dsp->cs_dsp.pwr_lock);
1873 EXPORT_SYMBOL_GPL(wm_adsp_compr_pointer);
1875 static int wm_adsp_buffer_capture_block(struct wm_adsp_compr *compr, int target)
1877 struct wm_adsp_compr_buf *buf = compr->buf;
1878 unsigned int adsp_addr;
1879 int mem_type, nwords, max_read;
1882 /* Calculate read parameters */
1883 for (i = 0; i < wm_adsp_fw[buf->dsp->fw].caps->num_regions; ++i)
1884 if (buf->read_index < buf->regions[i].cumulative_size)
1887 if (i == wm_adsp_fw[buf->dsp->fw].caps->num_regions)
1890 mem_type = buf->regions[i].mem_type;
1891 adsp_addr = buf->regions[i].base_addr +
1892 (buf->read_index - buf->regions[i].offset);
1894 max_read = wm_adsp_compr_frag_words(compr);
1895 nwords = buf->regions[i].cumulative_size - buf->read_index;
1897 if (nwords > target)
1899 if (nwords > buf->avail)
1900 nwords = buf->avail;
1901 if (nwords > max_read)
1906 /* Read data from DSP */
1907 ret = cs_dsp_read_raw_data_block(&buf->dsp->cs_dsp, mem_type, adsp_addr,
1908 nwords, (__be32 *)compr->raw_buf);
1912 cs_dsp_remove_padding(compr->raw_buf, nwords);
1914 /* update read index to account for words read */
1915 buf->read_index += nwords;
1916 if (buf->read_index == wm_adsp_buffer_size(buf))
1917 buf->read_index = 0;
1919 ret = wm_adsp_buffer_write(buf, HOST_BUFFER_FIELD(next_read_index),
1924 /* update avail to account for words read */
1925 buf->avail -= nwords;
1930 static int wm_adsp_compr_read(struct wm_adsp_compr *compr,
1931 char __user *buf, size_t count)
1933 struct wm_adsp *dsp = compr->dsp;
1937 compr_dbg(compr, "Requested read of %zu bytes\n", count);
1939 if (dsp->fatal_error || !compr->buf || compr->buf->error) {
1940 snd_compr_stop_error(compr->stream, SNDRV_PCM_STATE_XRUN);
1944 count /= CS_DSP_DATA_WORD_SIZE;
1947 nwords = wm_adsp_buffer_capture_block(compr, count);
1949 compr_err(compr, "Failed to capture block: %d\n",
1954 nbytes = nwords * CS_DSP_DATA_WORD_SIZE;
1956 compr_dbg(compr, "Read %d bytes\n", nbytes);
1958 if (copy_to_user(buf + ntotal, compr->raw_buf, nbytes)) {
1959 compr_err(compr, "Failed to copy data to user: %d, %d\n",
1966 } while (nwords > 0 && count > 0);
1968 compr->copied_total += ntotal;
1973 int wm_adsp_compr_copy(struct snd_soc_component *component,
1974 struct snd_compr_stream *stream, char __user *buf,
1977 struct wm_adsp_compr *compr = stream->runtime->private_data;
1978 struct wm_adsp *dsp = compr->dsp;
1981 mutex_lock(&dsp->cs_dsp.pwr_lock);
1983 if (stream->direction == SND_COMPRESS_CAPTURE)
1984 ret = wm_adsp_compr_read(compr, buf, count);
1988 mutex_unlock(&dsp->cs_dsp.pwr_lock);
1992 EXPORT_SYMBOL_GPL(wm_adsp_compr_copy);
1994 static void wm_adsp_fatal_error(struct cs_dsp *cs_dsp)
1996 struct wm_adsp *dsp = container_of(cs_dsp, struct wm_adsp, cs_dsp);
1997 struct wm_adsp_compr *compr;
1999 dsp->fatal_error = true;
2001 list_for_each_entry(compr, &dsp->compr_list, list) {
2003 snd_compr_fragment_elapsed(compr->stream);
2007 irqreturn_t wm_adsp2_bus_error(int irq, void *data)
2009 struct wm_adsp *dsp = (struct wm_adsp *)data;
2011 cs_dsp_adsp2_bus_error(&dsp->cs_dsp);
2015 EXPORT_SYMBOL_GPL(wm_adsp2_bus_error);
2017 irqreturn_t wm_halo_bus_error(int irq, void *data)
2019 struct wm_adsp *dsp = (struct wm_adsp *)data;
2021 cs_dsp_halo_bus_error(&dsp->cs_dsp);
2025 EXPORT_SYMBOL_GPL(wm_halo_bus_error);
2027 irqreturn_t wm_halo_wdt_expire(int irq, void *data)
2029 struct wm_adsp *dsp = data;
2031 cs_dsp_halo_wdt_expire(&dsp->cs_dsp);
2035 EXPORT_SYMBOL_GPL(wm_halo_wdt_expire);
2037 static const struct cs_dsp_client_ops wm_adsp1_client_ops = {
2038 .control_add = wm_adsp_control_add,
2039 .control_remove = wm_adsp_control_remove,
2042 static const struct cs_dsp_client_ops wm_adsp2_client_ops = {
2043 .control_add = wm_adsp_control_add,
2044 .control_remove = wm_adsp_control_remove,
2045 .post_run = wm_adsp_event_post_run,
2046 .post_stop = wm_adsp_event_post_stop,
2047 .watchdog_expired = wm_adsp_fatal_error,
2050 MODULE_LICENSE("GPL v2");