1 // SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
3 // This file is provided under a dual BSD/GPLv2 license. When using or
4 // redistributing this file, you may do so under either license.
6 // Copyright(c) 2018 Intel Corporation. All rights reserved.
8 // Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
11 #include <linux/debugfs.h>
12 #include <linux/sched/signal.h>
16 static size_t sof_trace_avail(struct snd_sof_dev *sdev,
17 loff_t pos, size_t buffer_size)
19 loff_t host_offset = READ_ONCE(sdev->host_offset);
22 * If host offset is less than local pos, it means write pointer of
23 * host DMA buffer has been wrapped. We should output the trace data
24 * at the end of host DMA buffer at first.
26 if (host_offset < pos)
27 return buffer_size - pos;
29 /* If there is available trace data now, it is unnecessary to wait. */
30 if (host_offset > pos)
31 return host_offset - pos;
36 static size_t sof_wait_trace_avail(struct snd_sof_dev *sdev,
37 loff_t pos, size_t buffer_size)
39 wait_queue_entry_t wait;
40 size_t ret = sof_trace_avail(sdev, pos, buffer_size);
42 /* data immediately available */
46 if (!sdev->dtrace_is_enabled && sdev->dtrace_draining) {
48 * tracing has ended and all traces have been
49 * read by client, return EOF
51 sdev->dtrace_draining = false;
55 /* wait for available trace data from FW */
56 init_waitqueue_entry(&wait, current);
57 set_current_state(TASK_INTERRUPTIBLE);
58 add_wait_queue(&sdev->trace_sleep, &wait);
60 if (!signal_pending(current)) {
61 /* set timeout to max value, no error code */
62 schedule_timeout(MAX_SCHEDULE_TIMEOUT);
64 remove_wait_queue(&sdev->trace_sleep, &wait);
66 return sof_trace_avail(sdev, pos, buffer_size);
69 static ssize_t sof_dfsentry_trace_read(struct file *file, char __user *buffer,
70 size_t count, loff_t *ppos)
72 struct snd_sof_dfsentry *dfse = file->private_data;
73 struct snd_sof_dev *sdev = dfse->sdev;
76 size_t avail, buffer_size = dfse->size;
79 /* make sure we know about any failures on the DSP side */
80 sdev->dtrace_error = false;
82 /* check pos and count */
88 /* check for buffer wrap and count overflow */
90 lpos = do_div(lpos_64, buffer_size);
92 if (count > buffer_size - lpos) /* min() not used to avoid sparse warnings */
93 count = buffer_size - lpos;
95 /* get available count based on current host offset */
96 avail = sof_wait_trace_avail(sdev, lpos, buffer_size);
97 if (sdev->dtrace_error) {
98 dev_err(sdev->dev, "error: trace IO error\n");
102 /* make sure count is <= avail */
103 count = avail > count ? count : avail;
105 /* copy available trace data to debugfs */
106 rem = copy_to_user(buffer, ((u8 *)(dfse->buf) + lpos), count);
112 /* move debugfs reading position */
116 static int sof_dfsentry_trace_release(struct inode *inode, struct file *file)
118 struct snd_sof_dfsentry *dfse = inode->i_private;
119 struct snd_sof_dev *sdev = dfse->sdev;
121 /* avoid duplicate traces at next open */
122 if (!sdev->dtrace_is_enabled)
123 sdev->host_offset = 0;
128 static const struct file_operations sof_dfs_trace_fops = {
130 .read = sof_dfsentry_trace_read,
131 .llseek = default_llseek,
132 .release = sof_dfsentry_trace_release,
135 static int trace_debugfs_create(struct snd_sof_dev *sdev)
137 struct snd_sof_dfsentry *dfse;
142 dfse = devm_kzalloc(sdev->dev, sizeof(*dfse), GFP_KERNEL);
146 dfse->type = SOF_DFSENTRY_TYPE_BUF;
147 dfse->buf = sdev->dmatb.area;
148 dfse->size = sdev->dmatb.bytes;
151 debugfs_create_file("trace", 0444, sdev->debugfs_root, dfse,
152 &sof_dfs_trace_fops);
157 int snd_sof_init_trace_ipc(struct snd_sof_dev *sdev)
159 struct sof_ipc_fw_ready *ready = &sdev->fw_ready;
160 struct sof_ipc_fw_version *v = &ready->version;
161 struct sof_ipc_dma_trace_params_ext params;
162 struct sof_ipc_reply ipc_reply;
165 if (!sdev->dtrace_is_supported)
168 if (sdev->dtrace_is_enabled || !sdev->dma_trace_pages)
171 /* set IPC parameters */
172 params.hdr.cmd = SOF_IPC_GLB_TRACE_MSG;
173 /* PARAMS_EXT is only supported from ABI 3.7.0 onwards */
174 if (v->abi_version >= SOF_ABI_VER(3, 7, 0)) {
175 params.hdr.size = sizeof(struct sof_ipc_dma_trace_params_ext);
176 params.hdr.cmd |= SOF_IPC_TRACE_DMA_PARAMS_EXT;
177 params.timestamp_ns = ktime_get(); /* in nanosecond */
179 params.hdr.size = sizeof(struct sof_ipc_dma_trace_params);
180 params.hdr.cmd |= SOF_IPC_TRACE_DMA_PARAMS;
182 params.buffer.phy_addr = sdev->dmatp.addr;
183 params.buffer.size = sdev->dmatb.bytes;
184 params.buffer.pages = sdev->dma_trace_pages;
185 params.stream_tag = 0;
187 sdev->host_offset = 0;
188 sdev->dtrace_draining = false;
190 ret = snd_sof_dma_trace_init(sdev, ¶ms.stream_tag);
193 "error: fail in snd_sof_dma_trace_init %d\n", ret);
196 dev_dbg(sdev->dev, "stream_tag: %d\n", params.stream_tag);
198 /* send IPC to the DSP */
199 ret = sof_ipc_tx_message(sdev->ipc,
200 params.hdr.cmd, ¶ms, sizeof(params),
201 &ipc_reply, sizeof(ipc_reply));
204 "error: can't set params for DMA for trace %d\n", ret);
208 ret = snd_sof_dma_trace_trigger(sdev, SNDRV_PCM_TRIGGER_START);
211 "error: snd_sof_dma_trace_trigger: start: %d\n", ret);
215 sdev->dtrace_is_enabled = true;
220 snd_sof_dma_trace_release(sdev);
224 int snd_sof_init_trace(struct snd_sof_dev *sdev)
228 if (!sdev->dtrace_is_supported)
231 /* set false before start initialization */
232 sdev->dtrace_is_enabled = false;
234 /* allocate trace page table buffer */
235 ret = snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, sdev->dev,
236 PAGE_SIZE, &sdev->dmatp);
239 "error: can't alloc page table for trace %d\n", ret);
243 /* allocate trace data buffer */
244 ret = snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV_SG, sdev->dev,
245 DMA_BUF_SIZE_FOR_TRACE, &sdev->dmatb);
248 "error: can't alloc buffer for trace %d\n", ret);
252 /* create compressed page table for audio firmware */
253 ret = snd_sof_create_page_table(sdev->dev, &sdev->dmatb,
254 sdev->dmatp.area, sdev->dmatb.bytes);
258 sdev->dma_trace_pages = ret;
259 dev_dbg(sdev->dev, "dma_trace_pages: %d\n", sdev->dma_trace_pages);
261 if (sdev->first_boot) {
262 ret = trace_debugfs_create(sdev);
267 init_waitqueue_head(&sdev->trace_sleep);
269 ret = snd_sof_init_trace_ipc(sdev);
275 sdev->dma_trace_pages = 0;
276 snd_dma_free_pages(&sdev->dmatb);
278 snd_dma_free_pages(&sdev->dmatp);
281 EXPORT_SYMBOL(snd_sof_init_trace);
283 int snd_sof_trace_update_pos(struct snd_sof_dev *sdev,
284 struct sof_ipc_dma_trace_posn *posn)
286 if (!sdev->dtrace_is_supported)
289 if (sdev->dtrace_is_enabled && sdev->host_offset != posn->host_offset) {
290 sdev->host_offset = posn->host_offset;
291 wake_up(&sdev->trace_sleep);
294 if (posn->overflow != 0)
296 "error: DSP trace buffer overflow %u bytes. Total messages %d\n",
297 posn->overflow, posn->messages);
302 /* an error has occurred within the DSP that prevents further trace */
303 void snd_sof_trace_notify_for_error(struct snd_sof_dev *sdev)
305 if (!sdev->dtrace_is_supported)
308 if (sdev->dtrace_is_enabled) {
309 dev_err(sdev->dev, "error: waking up any trace sleepers\n");
310 sdev->dtrace_error = true;
311 wake_up(&sdev->trace_sleep);
314 EXPORT_SYMBOL(snd_sof_trace_notify_for_error);
316 void snd_sof_release_trace(struct snd_sof_dev *sdev)
320 if (!sdev->dtrace_is_supported || !sdev->dtrace_is_enabled)
323 ret = snd_sof_dma_trace_trigger(sdev, SNDRV_PCM_TRIGGER_STOP);
326 "error: snd_sof_dma_trace_trigger: stop: %d\n", ret);
328 ret = snd_sof_dma_trace_release(sdev);
331 "error: fail in snd_sof_dma_trace_release %d\n", ret);
333 sdev->dtrace_is_enabled = false;
334 sdev->dtrace_draining = true;
335 wake_up(&sdev->trace_sleep);
337 EXPORT_SYMBOL(snd_sof_release_trace);
339 void snd_sof_free_trace(struct snd_sof_dev *sdev)
341 if (!sdev->dtrace_is_supported)
344 snd_sof_release_trace(sdev);
346 if (sdev->dma_trace_pages) {
347 snd_dma_free_pages(&sdev->dmatb);
348 snd_dma_free_pages(&sdev->dmatp);
349 sdev->dma_trace_pages = 0;
352 EXPORT_SYMBOL(snd_sof_free_trace);