1 // SPDX-License-Identifier: GPL-2.0-only
3 // Copyright(c) 2022 Intel Corporation. All rights reserved.
5 // Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
7 #include <linux/debugfs.h>
8 #include <linux/sched/signal.h>
10 #include "sof-audio.h"
12 #include "sof-utils.h"
13 #include "ipc3-priv.h"
15 #define TRACE_FILTER_ELEMENTS_PER_ENTRY 4
16 #define TRACE_FILTER_MAX_CONFIG_STRING_LENGTH 1024
18 enum sof_dtrace_state {
24 struct sof_dtrace_priv {
25 struct snd_dma_buffer dmatb;
26 struct snd_dma_buffer dmatp;
28 wait_queue_head_t trace_sleep;
32 enum sof_dtrace_state dtrace_state;
35 static int trace_filter_append_elem(struct snd_sof_dev *sdev, u32 key, u32 value,
36 struct sof_ipc_trace_filter_elem *elem_list,
37 int capacity, int *counter)
39 if (*counter >= capacity)
42 elem_list[*counter].key = key;
43 elem_list[*counter].value = value;
49 static int trace_filter_parse_entry(struct snd_sof_dev *sdev, const char *line,
50 struct sof_ipc_trace_filter_elem *elem,
51 int capacity, int *counter)
53 int log_level, pipe_id, comp_id, read, ret;
54 int len = strlen(line);
58 /* ignore empty content */
59 ret = sscanf(line, " %n", &read);
60 if (!ret && read == len)
63 ret = sscanf(line, " %d %x %d %d %n", &log_level, &uuid_id, &pipe_id, &comp_id, &read);
64 if (ret != TRACE_FILTER_ELEMENTS_PER_ENTRY || read != len) {
65 dev_err(sdev->dev, "Invalid trace filter entry '%s'\n", line);
70 ret = trace_filter_append_elem(sdev, SOF_IPC_TRACE_FILTER_ELEM_BY_UUID,
71 uuid_id, elem, capacity, &cnt);
76 ret = trace_filter_append_elem(sdev, SOF_IPC_TRACE_FILTER_ELEM_BY_PIPE,
77 pipe_id, elem, capacity, &cnt);
82 ret = trace_filter_append_elem(sdev, SOF_IPC_TRACE_FILTER_ELEM_BY_COMP,
83 comp_id, elem, capacity, &cnt);
88 ret = trace_filter_append_elem(sdev, SOF_IPC_TRACE_FILTER_ELEM_SET_LEVEL |
89 SOF_IPC_TRACE_FILTER_ELEM_FIN,
90 log_level, elem, capacity, &cnt);
94 /* update counter only when parsing whole entry passed */
100 static int trace_filter_parse(struct snd_sof_dev *sdev, char *string,
102 struct sof_ipc_trace_filter_elem **out)
104 static const char entry_delimiter[] = ";";
105 char *entry = string;
111 * Each entry contains at least 1, up to TRACE_FILTER_ELEMENTS_PER_ENTRY
112 * IPC elements, depending on content. Calculate IPC elements capacity
113 * for the input string where each element is set.
116 capacity += TRACE_FILTER_ELEMENTS_PER_ENTRY;
117 entry = strchr(entry + 1, entry_delimiter[0]);
119 *out = kmalloc(capacity * sizeof(**out), GFP_KERNEL);
123 /* split input string by ';', and parse each entry separately in trace_filter_parse_entry */
124 while ((entry = strsep(&string, entry_delimiter))) {
125 entry_len = trace_filter_parse_entry(sdev, entry, *out, capacity, &cnt);
128 "Parsing filter entry '%s' failed with %d\n",
139 static int ipc3_trace_update_filter(struct snd_sof_dev *sdev, int num_elems,
140 struct sof_ipc_trace_filter_elem *elems)
142 struct sof_ipc_trace_filter *msg;
143 struct sof_ipc_reply reply;
147 size = struct_size(msg, elems, num_elems);
148 if (size > SOF_IPC_MSG_MAX_SIZE)
151 msg = kmalloc(size, GFP_KERNEL);
155 msg->hdr.size = size;
156 msg->hdr.cmd = SOF_IPC_GLB_TRACE_MSG | SOF_IPC_TRACE_FILTER_UPDATE;
157 msg->elem_cnt = num_elems;
158 memcpy(&msg->elems[0], elems, num_elems * sizeof(*elems));
160 ret = pm_runtime_get_sync(sdev->dev);
161 if (ret < 0 && ret != -EACCES) {
162 pm_runtime_put_noidle(sdev->dev);
163 dev_err(sdev->dev, "enabling device failed: %d\n", ret);
166 ret = sof_ipc_tx_message(sdev->ipc, msg, msg->hdr.size, &reply, sizeof(reply));
167 pm_runtime_mark_last_busy(sdev->dev);
168 pm_runtime_put_autosuspend(sdev->dev);
172 return ret ? ret : reply.error;
175 static ssize_t dfsentry_trace_filter_write(struct file *file, const char __user *from,
176 size_t count, loff_t *ppos)
178 struct snd_sof_dfsentry *dfse = file->private_data;
179 struct sof_ipc_trace_filter_elem *elems = NULL;
180 struct snd_sof_dev *sdev = dfse->sdev;
186 if (count > TRACE_FILTER_MAX_CONFIG_STRING_LENGTH) {
187 dev_err(sdev->dev, "%s too long input, %zu > %d\n", __func__, count,
188 TRACE_FILTER_MAX_CONFIG_STRING_LENGTH);
192 string = kmalloc(count + 1, GFP_KERNEL);
196 /* assert null termination */
198 ret = simple_write_to_buffer(string, count, &pos, from, count);
202 ret = trace_filter_parse(sdev, string, &num_elems, &elems);
207 ret = ipc3_trace_update_filter(sdev, num_elems, elems);
209 dev_err(sdev->dev, "Filter update failed: %d\n", ret);
220 static const struct file_operations sof_dfs_trace_filter_fops = {
222 .write = dfsentry_trace_filter_write,
223 .llseek = default_llseek,
226 static int debugfs_create_trace_filter(struct snd_sof_dev *sdev)
228 struct snd_sof_dfsentry *dfse;
230 dfse = devm_kzalloc(sdev->dev, sizeof(*dfse), GFP_KERNEL);
235 dfse->type = SOF_DFSENTRY_TYPE_BUF;
237 debugfs_create_file("filter", 0200, sdev->debugfs_root, dfse,
238 &sof_dfs_trace_filter_fops);
239 /* add to dfsentry list */
240 list_add(&dfse->list, &sdev->dfsentry_list);
245 static size_t sof_dtrace_avail(struct snd_sof_dev *sdev,
246 loff_t pos, size_t buffer_size)
248 struct sof_dtrace_priv *priv = sdev->fw_trace_data;
249 loff_t host_offset = READ_ONCE(priv->host_offset);
252 * If host offset is less than local pos, it means write pointer of
253 * host DMA buffer has been wrapped. We should output the trace data
254 * at the end of host DMA buffer at first.
256 if (host_offset < pos)
257 return buffer_size - pos;
259 /* If there is available trace data now, it is unnecessary to wait. */
260 if (host_offset > pos)
261 return host_offset - pos;
266 static size_t sof_wait_dtrace_avail(struct snd_sof_dev *sdev, loff_t pos,
269 size_t ret = sof_dtrace_avail(sdev, pos, buffer_size);
270 struct sof_dtrace_priv *priv = sdev->fw_trace_data;
271 wait_queue_entry_t wait;
273 /* data immediately available */
277 if (priv->dtrace_state != SOF_DTRACE_ENABLED && priv->dtrace_draining) {
279 * tracing has ended and all traces have been
280 * read by client, return EOF
282 priv->dtrace_draining = false;
286 /* wait for available trace data from FW */
287 init_waitqueue_entry(&wait, current);
288 set_current_state(TASK_INTERRUPTIBLE);
289 add_wait_queue(&priv->trace_sleep, &wait);
291 if (!signal_pending(current)) {
292 /* set timeout to max value, no error code */
293 schedule_timeout(MAX_SCHEDULE_TIMEOUT);
295 remove_wait_queue(&priv->trace_sleep, &wait);
297 return sof_dtrace_avail(sdev, pos, buffer_size);
300 static ssize_t dfsentry_dtrace_read(struct file *file, char __user *buffer,
301 size_t count, loff_t *ppos)
303 struct snd_sof_dfsentry *dfse = file->private_data;
304 struct snd_sof_dev *sdev = dfse->sdev;
305 struct sof_dtrace_priv *priv = sdev->fw_trace_data;
308 size_t avail, buffer_size = dfse->size;
311 /* make sure we know about any failures on the DSP side */
312 priv->dtrace_error = false;
314 /* check pos and count */
320 /* check for buffer wrap and count overflow */
322 lpos = do_div(lpos_64, buffer_size);
324 /* get available count based on current host offset */
325 avail = sof_wait_dtrace_avail(sdev, lpos, buffer_size);
326 if (priv->dtrace_error) {
327 dev_err(sdev->dev, "trace IO error\n");
331 /* make sure count is <= avail */
336 * make sure that all trace data is available for the CPU as the trace
337 * data buffer might be allocated from non consistent memory.
338 * Note: snd_dma_buffer_sync() is called for normal audio playback and
339 * capture streams also.
341 snd_dma_buffer_sync(&priv->dmatb, SNDRV_DMA_SYNC_CPU);
342 /* copy available trace data to debugfs */
343 rem = copy_to_user(buffer, ((u8 *)(dfse->buf) + lpos), count);
349 /* move debugfs reading position */
353 static int dfsentry_dtrace_release(struct inode *inode, struct file *file)
355 struct snd_sof_dfsentry *dfse = inode->i_private;
356 struct snd_sof_dev *sdev = dfse->sdev;
357 struct sof_dtrace_priv *priv = sdev->fw_trace_data;
359 /* avoid duplicate traces at next open */
360 if (priv->dtrace_state != SOF_DTRACE_ENABLED)
361 priv->host_offset = 0;
366 static const struct file_operations sof_dfs_dtrace_fops = {
368 .read = dfsentry_dtrace_read,
369 .llseek = default_llseek,
370 .release = dfsentry_dtrace_release,
373 static int debugfs_create_dtrace(struct snd_sof_dev *sdev)
375 struct sof_dtrace_priv *priv;
376 struct snd_sof_dfsentry *dfse;
382 priv = sdev->fw_trace_data;
384 ret = debugfs_create_trace_filter(sdev);
386 dev_warn(sdev->dev, "failed to create filter debugfs file: %d", ret);
388 dfse = devm_kzalloc(sdev->dev, sizeof(*dfse), GFP_KERNEL);
392 dfse->type = SOF_DFSENTRY_TYPE_BUF;
393 dfse->buf = priv->dmatb.area;
394 dfse->size = priv->dmatb.bytes;
397 debugfs_create_file("trace", 0444, sdev->debugfs_root, dfse,
398 &sof_dfs_dtrace_fops);
403 static int ipc3_dtrace_enable(struct snd_sof_dev *sdev)
405 struct sof_dtrace_priv *priv = sdev->fw_trace_data;
406 struct sof_ipc_fw_ready *ready = &sdev->fw_ready;
407 struct sof_ipc_fw_version *v = &ready->version;
408 struct sof_ipc_dma_trace_params_ext params;
409 struct sof_ipc_reply ipc_reply;
412 if (!sdev->fw_trace_is_supported)
415 if (priv->dtrace_state == SOF_DTRACE_ENABLED || !priv->dma_trace_pages)
418 if (priv->dtrace_state == SOF_DTRACE_STOPPED)
421 /* set IPC parameters */
422 params.hdr.cmd = SOF_IPC_GLB_TRACE_MSG;
423 /* PARAMS_EXT is only supported from ABI 3.7.0 onwards */
424 if (v->abi_version >= SOF_ABI_VER(3, 7, 0)) {
425 params.hdr.size = sizeof(struct sof_ipc_dma_trace_params_ext);
426 params.hdr.cmd |= SOF_IPC_TRACE_DMA_PARAMS_EXT;
427 params.timestamp_ns = ktime_get(); /* in nanosecond */
429 params.hdr.size = sizeof(struct sof_ipc_dma_trace_params);
430 params.hdr.cmd |= SOF_IPC_TRACE_DMA_PARAMS;
432 params.buffer.phy_addr = priv->dmatp.addr;
433 params.buffer.size = priv->dmatb.bytes;
434 params.buffer.pages = priv->dma_trace_pages;
435 params.stream_tag = 0;
437 priv->host_offset = 0;
438 priv->dtrace_draining = false;
440 ret = sof_dtrace_host_init(sdev, &priv->dmatb, ¶ms);
442 dev_err(sdev->dev, "Host dtrace init failed: %d\n", ret);
445 dev_dbg(sdev->dev, "%s: stream_tag: %d\n", __func__, params.stream_tag);
447 /* send IPC to the DSP */
448 ret = sof_ipc_tx_message(sdev->ipc, ¶ms, sizeof(params), &ipc_reply, sizeof(ipc_reply));
450 dev_err(sdev->dev, "can't set params for DMA for trace %d\n", ret);
455 ret = sof_dtrace_host_trigger(sdev, SNDRV_PCM_TRIGGER_START);
457 dev_err(sdev->dev, "Host dtrace trigger start failed: %d\n", ret);
461 priv->dtrace_state = SOF_DTRACE_ENABLED;
466 sof_dtrace_host_release(sdev);
470 static int ipc3_dtrace_init(struct snd_sof_dev *sdev)
472 struct sof_dtrace_priv *priv;
475 /* dtrace is only supported with SOF_IPC */
476 if (sdev->pdata->ipc_type != SOF_IPC)
479 if (sdev->fw_trace_data) {
480 dev_err(sdev->dev, "fw_trace_data has been already allocated\n");
484 priv = devm_kzalloc(sdev->dev, sizeof(*priv), GFP_KERNEL);
488 sdev->fw_trace_data = priv;
490 /* set false before start initialization */
491 priv->dtrace_state = SOF_DTRACE_DISABLED;
493 /* allocate trace page table buffer */
494 ret = snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, sdev->dev,
495 PAGE_SIZE, &priv->dmatp);
497 dev_err(sdev->dev, "can't alloc page table for trace %d\n", ret);
501 /* allocate trace data buffer */
502 ret = snd_dma_alloc_dir_pages(SNDRV_DMA_TYPE_DEV_SG, sdev->dev,
503 DMA_FROM_DEVICE, DMA_BUF_SIZE_FOR_TRACE,
506 dev_err(sdev->dev, "can't alloc buffer for trace %d\n", ret);
510 /* create compressed page table for audio firmware */
511 ret = snd_sof_create_page_table(sdev->dev, &priv->dmatb,
512 priv->dmatp.area, priv->dmatb.bytes);
516 priv->dma_trace_pages = ret;
517 dev_dbg(sdev->dev, "%s: dma_trace_pages: %d\n", __func__,
518 priv->dma_trace_pages);
520 if (sdev->first_boot) {
521 ret = debugfs_create_dtrace(sdev);
526 init_waitqueue_head(&priv->trace_sleep);
528 ret = ipc3_dtrace_enable(sdev);
534 priv->dma_trace_pages = 0;
535 snd_dma_free_pages(&priv->dmatb);
537 snd_dma_free_pages(&priv->dmatp);
541 int ipc3_dtrace_posn_update(struct snd_sof_dev *sdev,
542 struct sof_ipc_dma_trace_posn *posn)
544 struct sof_dtrace_priv *priv = sdev->fw_trace_data;
546 if (!sdev->fw_trace_is_supported)
549 if (priv->dtrace_state == SOF_DTRACE_ENABLED &&
550 priv->host_offset != posn->host_offset) {
551 priv->host_offset = posn->host_offset;
552 wake_up(&priv->trace_sleep);
555 if (posn->overflow != 0)
557 "DSP trace buffer overflow %u bytes. Total messages %d\n",
558 posn->overflow, posn->messages);
563 /* an error has occurred within the DSP that prevents further trace */
564 static void ipc3_dtrace_fw_crashed(struct snd_sof_dev *sdev)
566 struct sof_dtrace_priv *priv = sdev->fw_trace_data;
568 if (priv->dtrace_state == SOF_DTRACE_ENABLED) {
569 priv->dtrace_error = true;
570 wake_up(&priv->trace_sleep);
574 static void ipc3_dtrace_release(struct snd_sof_dev *sdev, bool only_stop)
576 struct sof_dtrace_priv *priv = sdev->fw_trace_data;
577 struct sof_ipc_fw_ready *ready = &sdev->fw_ready;
578 struct sof_ipc_fw_version *v = &ready->version;
579 struct sof_ipc_cmd_hdr hdr;
580 struct sof_ipc_reply ipc_reply;
583 if (!sdev->fw_trace_is_supported || priv->dtrace_state == SOF_DTRACE_DISABLED)
586 ret = sof_dtrace_host_trigger(sdev, SNDRV_PCM_TRIGGER_STOP);
588 dev_err(sdev->dev, "Host dtrace trigger stop failed: %d\n", ret);
589 priv->dtrace_state = SOF_DTRACE_STOPPED;
592 * stop and free trace DMA in the DSP. TRACE_DMA_FREE is only supported from
595 if (v->abi_version >= SOF_ABI_VER(3, 20, 0)) {
596 hdr.size = sizeof(hdr);
597 hdr.cmd = SOF_IPC_GLB_TRACE_MSG | SOF_IPC_TRACE_DMA_FREE;
599 ret = sof_ipc_tx_message(sdev->ipc, &hdr, hdr.size,
600 &ipc_reply, sizeof(ipc_reply));
602 dev_err(sdev->dev, "DMA_TRACE_FREE failed with error: %d\n", ret);
608 ret = sof_dtrace_host_release(sdev);
610 dev_err(sdev->dev, "Host dtrace release failed %d\n", ret);
612 priv->dtrace_state = SOF_DTRACE_DISABLED;
615 priv->dtrace_draining = true;
616 wake_up(&priv->trace_sleep);
619 static void ipc3_dtrace_suspend(struct snd_sof_dev *sdev, pm_message_t pm_state)
621 ipc3_dtrace_release(sdev, pm_state.event == SOF_DSP_PM_D0);
624 static int ipc3_dtrace_resume(struct snd_sof_dev *sdev)
626 return ipc3_dtrace_enable(sdev);
629 static void ipc3_dtrace_free(struct snd_sof_dev *sdev)
631 struct sof_dtrace_priv *priv = sdev->fw_trace_data;
634 ipc3_dtrace_release(sdev, false);
636 if (priv->dma_trace_pages) {
637 snd_dma_free_pages(&priv->dmatb);
638 snd_dma_free_pages(&priv->dmatp);
639 priv->dma_trace_pages = 0;
643 const struct sof_ipc_fw_tracing_ops ipc3_dtrace_ops = {
644 .init = ipc3_dtrace_init,
645 .free = ipc3_dtrace_free,
646 .fw_crashed = ipc3_dtrace_fw_crashed,
647 .suspend = ipc3_dtrace_suspend,
648 .resume = ipc3_dtrace_resume,