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 {
21 SOF_DTRACE_INITIALIZING,
25 struct sof_dtrace_priv {
26 struct snd_dma_buffer dmatb;
27 struct snd_dma_buffer dmatp;
29 wait_queue_head_t trace_sleep;
33 enum sof_dtrace_state dtrace_state;
36 static bool trace_pos_update_expected(struct sof_dtrace_priv *priv)
38 if (priv->dtrace_state == SOF_DTRACE_ENABLED ||
39 priv->dtrace_state == SOF_DTRACE_INITIALIZING)
45 static int trace_filter_append_elem(struct snd_sof_dev *sdev, u32 key, u32 value,
46 struct sof_ipc_trace_filter_elem *elem_list,
47 int capacity, int *counter)
49 if (*counter >= capacity)
52 elem_list[*counter].key = key;
53 elem_list[*counter].value = value;
59 static int trace_filter_parse_entry(struct snd_sof_dev *sdev, const char *line,
60 struct sof_ipc_trace_filter_elem *elem,
61 int capacity, int *counter)
63 int log_level, pipe_id, comp_id, read, ret;
64 int len = strlen(line);
68 /* ignore empty content */
69 ret = sscanf(line, " %n", &read);
70 if (!ret && read == len)
73 ret = sscanf(line, " %d %x %d %d %n", &log_level, &uuid_id, &pipe_id, &comp_id, &read);
74 if (ret != TRACE_FILTER_ELEMENTS_PER_ENTRY || read != len) {
75 dev_err(sdev->dev, "Invalid trace filter entry '%s'\n", line);
80 ret = trace_filter_append_elem(sdev, SOF_IPC_TRACE_FILTER_ELEM_BY_UUID,
81 uuid_id, elem, capacity, &cnt);
86 ret = trace_filter_append_elem(sdev, SOF_IPC_TRACE_FILTER_ELEM_BY_PIPE,
87 pipe_id, elem, capacity, &cnt);
92 ret = trace_filter_append_elem(sdev, SOF_IPC_TRACE_FILTER_ELEM_BY_COMP,
93 comp_id, elem, capacity, &cnt);
98 ret = trace_filter_append_elem(sdev, SOF_IPC_TRACE_FILTER_ELEM_SET_LEVEL |
99 SOF_IPC_TRACE_FILTER_ELEM_FIN,
100 log_level, elem, capacity, &cnt);
104 /* update counter only when parsing whole entry passed */
110 static int trace_filter_parse(struct snd_sof_dev *sdev, char *string,
112 struct sof_ipc_trace_filter_elem **out)
114 static const char entry_delimiter[] = ";";
115 char *entry = string;
121 * Each entry contains at least 1, up to TRACE_FILTER_ELEMENTS_PER_ENTRY
122 * IPC elements, depending on content. Calculate IPC elements capacity
123 * for the input string where each element is set.
126 capacity += TRACE_FILTER_ELEMENTS_PER_ENTRY;
127 entry = strchr(entry + 1, entry_delimiter[0]);
129 *out = kmalloc(capacity * sizeof(**out), GFP_KERNEL);
133 /* split input string by ';', and parse each entry separately in trace_filter_parse_entry */
134 while ((entry = strsep(&string, entry_delimiter))) {
135 entry_len = trace_filter_parse_entry(sdev, entry, *out, capacity, &cnt);
138 "Parsing filter entry '%s' failed with %d\n",
149 static int ipc3_trace_update_filter(struct snd_sof_dev *sdev, int num_elems,
150 struct sof_ipc_trace_filter_elem *elems)
152 struct sof_ipc_trace_filter *msg;
156 size = struct_size(msg, elems, num_elems);
157 if (size > SOF_IPC_MSG_MAX_SIZE)
160 msg = kmalloc(size, GFP_KERNEL);
164 msg->hdr.size = size;
165 msg->hdr.cmd = SOF_IPC_GLB_TRACE_MSG | SOF_IPC_TRACE_FILTER_UPDATE;
166 msg->elem_cnt = num_elems;
167 memcpy(&msg->elems[0], elems, num_elems * sizeof(*elems));
169 ret = pm_runtime_resume_and_get(sdev->dev);
170 if (ret < 0 && ret != -EACCES) {
171 dev_err(sdev->dev, "enabling device failed: %d\n", ret);
174 ret = sof_ipc_tx_message_no_reply(sdev->ipc, msg, msg->hdr.size);
175 pm_runtime_mark_last_busy(sdev->dev);
176 pm_runtime_put_autosuspend(sdev->dev);
183 static ssize_t dfsentry_trace_filter_write(struct file *file, const char __user *from,
184 size_t count, loff_t *ppos)
186 struct snd_sof_dfsentry *dfse = file->private_data;
187 struct sof_ipc_trace_filter_elem *elems = NULL;
188 struct snd_sof_dev *sdev = dfse->sdev;
193 if (count > TRACE_FILTER_MAX_CONFIG_STRING_LENGTH) {
194 dev_err(sdev->dev, "%s too long input, %zu > %d\n", __func__, count,
195 TRACE_FILTER_MAX_CONFIG_STRING_LENGTH);
199 string = memdup_user_nul(from, count);
201 return PTR_ERR(string);
203 ret = trace_filter_parse(sdev, string, &num_elems, &elems);
208 ret = ipc3_trace_update_filter(sdev, num_elems, elems);
210 dev_err(sdev->dev, "Filter update failed: %d\n", ret);
221 static const struct file_operations sof_dfs_trace_filter_fops = {
223 .write = dfsentry_trace_filter_write,
224 .llseek = default_llseek,
227 static int debugfs_create_trace_filter(struct snd_sof_dev *sdev)
229 struct snd_sof_dfsentry *dfse;
231 dfse = devm_kzalloc(sdev->dev, sizeof(*dfse), GFP_KERNEL);
236 dfse->type = SOF_DFSENTRY_TYPE_BUF;
238 debugfs_create_file("filter", 0200, sdev->debugfs_root, dfse,
239 &sof_dfs_trace_filter_fops);
240 /* add to dfsentry list */
241 list_add(&dfse->list, &sdev->dfsentry_list);
246 static bool sof_dtrace_set_host_offset(struct sof_dtrace_priv *priv, u32 new_offset)
248 u32 host_offset = READ_ONCE(priv->host_offset);
250 if (host_offset != new_offset) {
251 /* This is a bit paranoid and unlikely that it is needed */
252 u32 ret = cmpxchg(&priv->host_offset, host_offset, new_offset);
254 if (ret == host_offset)
261 static size_t sof_dtrace_avail(struct snd_sof_dev *sdev,
262 loff_t pos, size_t buffer_size)
264 struct sof_dtrace_priv *priv = sdev->fw_trace_data;
265 loff_t host_offset = READ_ONCE(priv->host_offset);
268 * If host offset is less than local pos, it means write pointer of
269 * host DMA buffer has been wrapped. We should output the trace data
270 * at the end of host DMA buffer at first.
272 if (host_offset < pos)
273 return buffer_size - pos;
275 /* If there is available trace data now, it is unnecessary to wait. */
276 if (host_offset > pos)
277 return host_offset - pos;
282 static size_t sof_wait_dtrace_avail(struct snd_sof_dev *sdev, loff_t pos,
285 size_t ret = sof_dtrace_avail(sdev, pos, buffer_size);
286 struct sof_dtrace_priv *priv = sdev->fw_trace_data;
287 wait_queue_entry_t wait;
289 /* data immediately available */
293 if (priv->dtrace_draining && !trace_pos_update_expected(priv)) {
295 * tracing has ended and all traces have been
296 * read by client, return EOF
298 priv->dtrace_draining = false;
302 /* wait for available trace data from FW */
303 init_waitqueue_entry(&wait, current);
304 set_current_state(TASK_INTERRUPTIBLE);
305 add_wait_queue(&priv->trace_sleep, &wait);
307 if (!signal_pending(current)) {
308 /* set timeout to max value, no error code */
309 schedule_timeout(MAX_SCHEDULE_TIMEOUT);
311 remove_wait_queue(&priv->trace_sleep, &wait);
313 return sof_dtrace_avail(sdev, pos, buffer_size);
316 static ssize_t dfsentry_dtrace_read(struct file *file, char __user *buffer,
317 size_t count, loff_t *ppos)
319 struct snd_sof_dfsentry *dfse = file->private_data;
320 struct snd_sof_dev *sdev = dfse->sdev;
321 struct sof_dtrace_priv *priv = sdev->fw_trace_data;
324 size_t avail, buffer_size = dfse->size;
327 /* make sure we know about any failures on the DSP side */
328 priv->dtrace_error = false;
330 /* check pos and count */
336 /* check for buffer wrap and count overflow */
338 lpos = do_div(lpos_64, buffer_size);
340 /* get available count based on current host offset */
341 avail = sof_wait_dtrace_avail(sdev, lpos, buffer_size);
342 if (priv->dtrace_error) {
343 dev_err(sdev->dev, "trace IO error\n");
347 /* no new trace data */
351 /* make sure count is <= avail */
356 * make sure that all trace data is available for the CPU as the trace
357 * data buffer might be allocated from non consistent memory.
358 * Note: snd_dma_buffer_sync() is called for normal audio playback and
359 * capture streams also.
361 snd_dma_buffer_sync(&priv->dmatb, SNDRV_DMA_SYNC_CPU);
362 /* copy available trace data to debugfs */
363 rem = copy_to_user(buffer, ((u8 *)(dfse->buf) + lpos), count);
369 /* move debugfs reading position */
373 static int dfsentry_dtrace_release(struct inode *inode, struct file *file)
375 struct snd_sof_dfsentry *dfse = inode->i_private;
376 struct snd_sof_dev *sdev = dfse->sdev;
377 struct sof_dtrace_priv *priv = sdev->fw_trace_data;
379 /* avoid duplicate traces at next open */
380 if (priv->dtrace_state != SOF_DTRACE_ENABLED)
381 sof_dtrace_set_host_offset(priv, 0);
386 static const struct file_operations sof_dfs_dtrace_fops = {
388 .read = dfsentry_dtrace_read,
389 .llseek = default_llseek,
390 .release = dfsentry_dtrace_release,
393 static int debugfs_create_dtrace(struct snd_sof_dev *sdev)
395 struct sof_dtrace_priv *priv;
396 struct snd_sof_dfsentry *dfse;
402 priv = sdev->fw_trace_data;
404 ret = debugfs_create_trace_filter(sdev);
406 dev_warn(sdev->dev, "failed to create filter debugfs file: %d", ret);
408 dfse = devm_kzalloc(sdev->dev, sizeof(*dfse), GFP_KERNEL);
412 dfse->type = SOF_DFSENTRY_TYPE_BUF;
413 dfse->buf = priv->dmatb.area;
414 dfse->size = priv->dmatb.bytes;
417 debugfs_create_file("trace", 0444, sdev->debugfs_root, dfse,
418 &sof_dfs_dtrace_fops);
423 static int ipc3_dtrace_enable(struct snd_sof_dev *sdev)
425 struct sof_dtrace_priv *priv = sdev->fw_trace_data;
426 struct sof_ipc_fw_ready *ready = &sdev->fw_ready;
427 struct sof_ipc_fw_version *v = &ready->version;
428 struct sof_ipc_dma_trace_params_ext params;
431 if (!sdev->fw_trace_is_supported)
434 if (priv->dtrace_state == SOF_DTRACE_ENABLED || !priv->dma_trace_pages)
437 if (priv->dtrace_state == SOF_DTRACE_STOPPED)
440 /* set IPC parameters */
441 params.hdr.cmd = SOF_IPC_GLB_TRACE_MSG;
442 /* PARAMS_EXT is only supported from ABI 3.7.0 onwards */
443 if (v->abi_version >= SOF_ABI_VER(3, 7, 0)) {
444 params.hdr.size = sizeof(struct sof_ipc_dma_trace_params_ext);
445 params.hdr.cmd |= SOF_IPC_TRACE_DMA_PARAMS_EXT;
446 params.timestamp_ns = ktime_get(); /* in nanosecond */
448 params.hdr.size = sizeof(struct sof_ipc_dma_trace_params);
449 params.hdr.cmd |= SOF_IPC_TRACE_DMA_PARAMS;
451 params.buffer.phy_addr = priv->dmatp.addr;
452 params.buffer.size = priv->dmatb.bytes;
453 params.buffer.pages = priv->dma_trace_pages;
454 params.stream_tag = 0;
456 sof_dtrace_set_host_offset(priv, 0);
457 priv->dtrace_draining = false;
459 ret = sof_dtrace_host_init(sdev, &priv->dmatb, ¶ms);
461 dev_err(sdev->dev, "Host dtrace init failed: %d\n", ret);
464 dev_dbg(sdev->dev, "stream_tag: %d\n", params.stream_tag);
466 /* send IPC to the DSP */
467 priv->dtrace_state = SOF_DTRACE_INITIALIZING;
468 ret = sof_ipc_tx_message_no_reply(sdev->ipc, ¶ms, sizeof(params));
470 dev_err(sdev->dev, "can't set params for DMA for trace %d\n", ret);
475 priv->dtrace_state = SOF_DTRACE_ENABLED;
477 ret = sof_dtrace_host_trigger(sdev, SNDRV_PCM_TRIGGER_START);
479 dev_err(sdev->dev, "Host dtrace trigger start failed: %d\n", ret);
486 priv->dtrace_state = SOF_DTRACE_DISABLED;
487 sof_dtrace_host_release(sdev);
491 static int ipc3_dtrace_init(struct snd_sof_dev *sdev)
493 struct sof_dtrace_priv *priv;
496 /* dtrace is only supported with SOF_IPC */
497 if (sdev->pdata->ipc_type != SOF_IPC_TYPE_3)
500 if (sdev->fw_trace_data) {
501 dev_err(sdev->dev, "fw_trace_data has been already allocated\n");
505 priv = devm_kzalloc(sdev->dev, sizeof(*priv), GFP_KERNEL);
509 sdev->fw_trace_data = priv;
511 /* set false before start initialization */
512 priv->dtrace_state = SOF_DTRACE_DISABLED;
514 /* allocate trace page table buffer */
515 ret = snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, sdev->dev,
516 PAGE_SIZE, &priv->dmatp);
518 dev_err(sdev->dev, "can't alloc page table for trace %d\n", ret);
522 /* allocate trace data buffer */
523 ret = snd_dma_alloc_dir_pages(SNDRV_DMA_TYPE_DEV_SG, sdev->dev,
524 DMA_FROM_DEVICE, DMA_BUF_SIZE_FOR_TRACE,
527 dev_err(sdev->dev, "can't alloc buffer for trace %d\n", ret);
531 /* create compressed page table for audio firmware */
532 ret = snd_sof_create_page_table(sdev->dev, &priv->dmatb,
533 priv->dmatp.area, priv->dmatb.bytes);
537 priv->dma_trace_pages = ret;
538 dev_dbg(sdev->dev, "dma_trace_pages: %d\n", priv->dma_trace_pages);
540 if (sdev->first_boot) {
541 ret = debugfs_create_dtrace(sdev);
546 init_waitqueue_head(&priv->trace_sleep);
548 ret = ipc3_dtrace_enable(sdev);
554 priv->dma_trace_pages = 0;
555 snd_dma_free_pages(&priv->dmatb);
557 snd_dma_free_pages(&priv->dmatp);
561 int ipc3_dtrace_posn_update(struct snd_sof_dev *sdev,
562 struct sof_ipc_dma_trace_posn *posn)
564 struct sof_dtrace_priv *priv = sdev->fw_trace_data;
566 if (!sdev->fw_trace_is_supported)
569 if (trace_pos_update_expected(priv) &&
570 sof_dtrace_set_host_offset(priv, posn->host_offset))
571 wake_up(&priv->trace_sleep);
573 if (posn->overflow != 0)
575 "DSP trace buffer overflow %u bytes. Total messages %d\n",
576 posn->overflow, posn->messages);
581 /* an error has occurred within the DSP that prevents further trace */
582 static void ipc3_dtrace_fw_crashed(struct snd_sof_dev *sdev)
584 struct sof_dtrace_priv *priv = sdev->fw_trace_data;
586 if (priv->dtrace_state == SOF_DTRACE_ENABLED) {
587 priv->dtrace_error = true;
588 wake_up(&priv->trace_sleep);
592 static void ipc3_dtrace_release(struct snd_sof_dev *sdev, bool only_stop)
594 struct sof_dtrace_priv *priv = sdev->fw_trace_data;
595 struct sof_ipc_fw_ready *ready = &sdev->fw_ready;
596 struct sof_ipc_fw_version *v = &ready->version;
597 struct sof_ipc_cmd_hdr hdr;
600 if (!sdev->fw_trace_is_supported || priv->dtrace_state == SOF_DTRACE_DISABLED)
603 ret = sof_dtrace_host_trigger(sdev, SNDRV_PCM_TRIGGER_STOP);
605 dev_err(sdev->dev, "Host dtrace trigger stop failed: %d\n", ret);
606 priv->dtrace_state = SOF_DTRACE_STOPPED;
609 * stop and free trace DMA in the DSP. TRACE_DMA_FREE is only supported from
612 if (v->abi_version >= SOF_ABI_VER(3, 20, 0)) {
613 hdr.size = sizeof(hdr);
614 hdr.cmd = SOF_IPC_GLB_TRACE_MSG | SOF_IPC_TRACE_DMA_FREE;
616 ret = sof_ipc_tx_message_no_reply(sdev->ipc, &hdr, hdr.size);
618 dev_err(sdev->dev, "DMA_TRACE_FREE failed with error: %d\n", ret);
624 ret = sof_dtrace_host_release(sdev);
626 dev_err(sdev->dev, "Host dtrace release failed %d\n", ret);
628 priv->dtrace_state = SOF_DTRACE_DISABLED;
631 priv->dtrace_draining = true;
632 wake_up(&priv->trace_sleep);
635 static void ipc3_dtrace_suspend(struct snd_sof_dev *sdev, pm_message_t pm_state)
637 ipc3_dtrace_release(sdev, pm_state.event == SOF_DSP_PM_D0);
640 static int ipc3_dtrace_resume(struct snd_sof_dev *sdev)
642 return ipc3_dtrace_enable(sdev);
645 static void ipc3_dtrace_free(struct snd_sof_dev *sdev)
647 struct sof_dtrace_priv *priv = sdev->fw_trace_data;
650 ipc3_dtrace_release(sdev, false);
652 if (priv->dma_trace_pages) {
653 snd_dma_free_pages(&priv->dmatb);
654 snd_dma_free_pages(&priv->dmatp);
655 priv->dma_trace_pages = 0;
659 const struct sof_ipc_fw_tracing_ops ipc3_dtrace_ops = {
660 .init = ipc3_dtrace_init,
661 .free = ipc3_dtrace_free,
662 .fw_crashed = ipc3_dtrace_fw_crashed,
663 .suspend = ipc3_dtrace_suspend,
664 .resume = ipc3_dtrace_resume,