1 // SPDX-License-Identifier: GPL-2.0-only 2 // 3 // Copyright(c) 2021-2022 Intel Corporation 4 // 5 // Authors: Cezary Rojewski <cezary.rojewski@intel.com> 6 // Amadeusz Slawinski <amadeuszx.slawinski@linux.intel.com> 7 // 8 9 #include <linux/debugfs.h> 10 #include <linux/kfifo.h> 11 #include <linux/wait.h> 12 #include <linux/sched/signal.h> 13 #include <linux/string_helpers.h> 14 #include <sound/soc.h> 15 #include "avs.h" 16 #include "debug.h" 17 #include "messages.h" 18 19 static unsigned int __kfifo_fromio(struct kfifo *fifo, const void __iomem *src, unsigned int len) 20 { 21 struct __kfifo *__fifo = &fifo->kfifo; 22 unsigned int l, off; 23 24 len = min(len, kfifo_avail(fifo)); 25 off = __fifo->in & __fifo->mask; 26 l = min(len, kfifo_size(fifo) - off); 27 28 memcpy_fromio(__fifo->data + off, src, l); 29 memcpy_fromio(__fifo->data, src + l, len - l); 30 /* Make sure data copied from SRAM is visible to all CPUs. */ 31 smp_mb(); 32 __fifo->in += len; 33 34 return len; 35 } 36 37 bool avs_logging_fw(struct avs_dev *adev) 38 { 39 return kfifo_initialized(&adev->trace_fifo); 40 } 41 42 void avs_dump_fw_log(struct avs_dev *adev, const void __iomem *src, unsigned int len) 43 { 44 __kfifo_fromio(&adev->trace_fifo, src, len); 45 } 46 47 void avs_dump_fw_log_wakeup(struct avs_dev *adev, const void __iomem *src, unsigned int len) 48 { 49 avs_dump_fw_log(adev, src, len); 50 wake_up(&adev->trace_waitq); 51 } 52 53 static ssize_t fw_regs_read(struct file *file, char __user *to, size_t count, loff_t *ppos) 54 { 55 struct avs_dev *adev = file->private_data; 56 char *buf; 57 int ret; 58 59 buf = kzalloc(AVS_FW_REGS_SIZE, GFP_KERNEL); 60 if (!buf) 61 return -ENOMEM; 62 63 memcpy_fromio(buf, avs_sram_addr(adev, AVS_FW_REGS_WINDOW), AVS_FW_REGS_SIZE); 64 65 ret = simple_read_from_buffer(to, count, ppos, buf, AVS_FW_REGS_SIZE); 66 kfree(buf); 67 return ret; 68 } 69 70 static const struct file_operations fw_regs_fops = { 71 .open = simple_open, 72 .read = fw_regs_read, 73 }; 74 75 static ssize_t debug_window_read(struct file *file, char __user *to, size_t count, loff_t *ppos) 76 { 77 struct avs_dev *adev = file->private_data; 78 size_t size; 79 char *buf; 80 int ret; 81 82 size = adev->hw_cfg.dsp_cores * AVS_WINDOW_CHUNK_SIZE; 83 buf = kzalloc(size, GFP_KERNEL); 84 if (!buf) 85 return -ENOMEM; 86 87 memcpy_fromio(buf, avs_sram_addr(adev, AVS_DEBUG_WINDOW), size); 88 89 ret = simple_read_from_buffer(to, count, ppos, buf, size); 90 kfree(buf); 91 return ret; 92 } 93 94 static const struct file_operations debug_window_fops = { 95 .open = simple_open, 96 .read = debug_window_read, 97 }; 98 99 static ssize_t probe_points_read(struct file *file, char __user *to, size_t count, loff_t *ppos) 100 { 101 struct avs_dev *adev = file->private_data; 102 struct avs_probe_point_desc *desc; 103 size_t num_desc, len = 0; 104 char *buf; 105 int i, ret; 106 107 /* Prevent chaining, send and dump IPC value just once. */ 108 if (*ppos) 109 return 0; 110 111 buf = kzalloc(PAGE_SIZE, GFP_KERNEL); 112 if (!buf) 113 return -ENOMEM; 114 115 ret = avs_ipc_probe_get_points(adev, &desc, &num_desc); 116 if (ret) { 117 ret = AVS_IPC_RET(ret); 118 goto exit; 119 } 120 121 for (i = 0; i < num_desc; i++) { 122 ret = snprintf(buf + len, PAGE_SIZE - len, 123 "Id: %#010x Purpose: %d Node id: %#x\n", 124 desc[i].id.value, desc[i].purpose, desc[i].node_id.val); 125 if (ret < 0) 126 goto free_desc; 127 len += ret; 128 } 129 130 ret = simple_read_from_buffer(to, count, ppos, buf, len); 131 free_desc: 132 kfree(desc); 133 exit: 134 kfree(buf); 135 return ret; 136 } 137 138 static ssize_t probe_points_write(struct file *file, const char __user *from, size_t count, 139 loff_t *ppos) 140 { 141 struct avs_dev *adev = file->private_data; 142 struct avs_probe_point_desc *desc; 143 u32 *array, num_elems; 144 size_t bytes; 145 int ret; 146 147 ret = parse_int_array_user(from, count, (int **)&array); 148 if (ret) 149 return ret; 150 151 num_elems = *array; 152 bytes = sizeof(*array) * num_elems; 153 if (bytes % sizeof(*desc)) { 154 ret = -EINVAL; 155 goto exit; 156 } 157 158 desc = (struct avs_probe_point_desc *)&array[1]; 159 ret = avs_ipc_probe_connect_points(adev, desc, bytes / sizeof(*desc)); 160 if (ret) 161 ret = AVS_IPC_RET(ret); 162 else 163 ret = count; 164 exit: 165 kfree(array); 166 return ret; 167 } 168 169 static const struct file_operations probe_points_fops = { 170 .open = simple_open, 171 .read = probe_points_read, 172 .write = probe_points_write, 173 }; 174 175 static ssize_t probe_points_disconnect_write(struct file *file, const char __user *from, 176 size_t count, loff_t *ppos) 177 { 178 struct avs_dev *adev = file->private_data; 179 union avs_probe_point_id *id; 180 u32 *array, num_elems; 181 size_t bytes; 182 int ret; 183 184 ret = parse_int_array_user(from, count, (int **)&array); 185 if (ret) 186 return ret; 187 188 num_elems = *array; 189 bytes = sizeof(*array) * num_elems; 190 if (bytes % sizeof(*id)) { 191 ret = -EINVAL; 192 goto exit; 193 } 194 195 id = (union avs_probe_point_id *)&array[1]; 196 ret = avs_ipc_probe_disconnect_points(adev, id, bytes / sizeof(*id)); 197 if (ret) 198 ret = AVS_IPC_RET(ret); 199 else 200 ret = count; 201 exit: 202 kfree(array); 203 return ret; 204 } 205 206 static const struct file_operations probe_points_disconnect_fops = { 207 .open = simple_open, 208 .write = probe_points_disconnect_write, 209 .llseek = default_llseek, 210 }; 211 212 static ssize_t strace_read(struct file *file, char __user *to, size_t count, loff_t *ppos) 213 { 214 struct avs_dev *adev = file->private_data; 215 struct kfifo *fifo = &adev->trace_fifo; 216 unsigned int copied; 217 218 if (kfifo_is_empty(fifo)) { 219 DEFINE_WAIT(wait); 220 221 prepare_to_wait(&adev->trace_waitq, &wait, TASK_INTERRUPTIBLE); 222 if (!signal_pending(current)) 223 schedule(); 224 finish_wait(&adev->trace_waitq, &wait); 225 } 226 227 if (kfifo_to_user(fifo, to, count, &copied)) 228 return -EFAULT; 229 *ppos += copied; 230 return copied; 231 } 232 233 static int strace_open(struct inode *inode, struct file *file) 234 { 235 struct avs_dev *adev = inode->i_private; 236 int ret; 237 238 if (!try_module_get(adev->dev->driver->owner)) 239 return -ENODEV; 240 241 if (kfifo_initialized(&adev->trace_fifo)) 242 return -EBUSY; 243 244 ret = kfifo_alloc(&adev->trace_fifo, PAGE_SIZE, GFP_KERNEL); 245 if (ret < 0) 246 return ret; 247 248 file->private_data = adev; 249 return 0; 250 } 251 252 static int strace_release(struct inode *inode, struct file *file) 253 { 254 union avs_notify_msg msg = AVS_NOTIFICATION(LOG_BUFFER_STATUS); 255 struct avs_dev *adev = file->private_data; 256 unsigned long resource_mask; 257 unsigned long flags, i; 258 u32 num_cores; 259 260 resource_mask = adev->logged_resources; 261 num_cores = adev->hw_cfg.dsp_cores; 262 263 spin_lock_irqsave(&adev->trace_lock, flags); 264 265 /* Gather any remaining logs. */ 266 for_each_set_bit(i, &resource_mask, num_cores) { 267 msg.log.core = i; 268 avs_dsp_op(adev, log_buffer_status, &msg); 269 } 270 271 kfifo_free(&adev->trace_fifo); 272 273 spin_unlock_irqrestore(&adev->trace_lock, flags); 274 275 module_put(adev->dev->driver->owner); 276 return 0; 277 } 278 279 static const struct file_operations strace_fops = { 280 .llseek = default_llseek, 281 .read = strace_read, 282 .open = strace_open, 283 .release = strace_release, 284 }; 285 286 #define DISABLE_TIMERS UINT_MAX 287 288 static int enable_logs(struct avs_dev *adev, u32 resource_mask, u32 *priorities) 289 { 290 int ret; 291 292 /* Logging demands D0i0 state from DSP. */ 293 if (!adev->logged_resources) { 294 pm_runtime_get_sync(adev->dev); 295 296 ret = avs_dsp_disable_d0ix(adev); 297 if (ret) 298 goto err_d0ix; 299 } 300 301 ret = avs_ipc_set_system_time(adev); 302 if (ret && ret != AVS_IPC_NOT_SUPPORTED) { 303 ret = AVS_IPC_RET(ret); 304 goto err_ipc; 305 } 306 307 ret = avs_dsp_op(adev, enable_logs, AVS_LOG_ENABLE, adev->aging_timer_period, 308 adev->fifo_full_timer_period, resource_mask, priorities); 309 if (ret) 310 goto err_ipc; 311 312 adev->logged_resources |= resource_mask; 313 return 0; 314 315 err_ipc: 316 if (!adev->logged_resources) { 317 avs_dsp_enable_d0ix(adev); 318 err_d0ix: 319 pm_runtime_put_autosuspend(adev->dev); 320 } 321 322 return ret; 323 } 324 325 static int disable_logs(struct avs_dev *adev, u32 resource_mask) 326 { 327 int ret; 328 329 /* Check if there's anything to do. */ 330 if (!adev->logged_resources) 331 return 0; 332 333 ret = avs_dsp_op(adev, enable_logs, AVS_LOG_DISABLE, DISABLE_TIMERS, DISABLE_TIMERS, 334 resource_mask, NULL); 335 336 /* 337 * If IPC fails causing recovery, logged_resources is already zero 338 * so unsetting bits is still safe. 339 */ 340 adev->logged_resources &= ~resource_mask; 341 342 /* If that's the last resource, allow for D3. */ 343 if (!adev->logged_resources) { 344 avs_dsp_enable_d0ix(adev); 345 pm_runtime_put_autosuspend(adev->dev); 346 } 347 348 return ret; 349 } 350 351 static ssize_t trace_control_read(struct file *file, char __user *to, size_t count, loff_t *ppos) 352 { 353 struct avs_dev *adev = file->private_data; 354 char buf[64]; 355 int len; 356 357 len = snprintf(buf, sizeof(buf), "0x%08x\n", adev->logged_resources); 358 359 return simple_read_from_buffer(to, count, ppos, buf, len); 360 } 361 362 static ssize_t trace_control_write(struct file *file, const char __user *from, size_t count, 363 loff_t *ppos) 364 { 365 struct avs_dev *adev = file->private_data; 366 u32 *array, num_elems; 367 u32 resource_mask; 368 int ret; 369 370 ret = parse_int_array_user(from, count, (int **)&array); 371 if (ret) 372 return ret; 373 374 num_elems = *array; 375 if (!num_elems) { 376 ret = -EINVAL; 377 goto free_array; 378 } 379 380 /* 381 * Disable if just resource mask is provided - no log priority flags. 382 * 383 * Enable input format: mask, prio1, .., prioN 384 * Where 'N' equals number of bits set in the 'mask'. 385 */ 386 resource_mask = array[1]; 387 if (num_elems == 1) { 388 ret = disable_logs(adev, resource_mask); 389 } else { 390 if (num_elems != (hweight_long(resource_mask) + 1)) { 391 ret = -EINVAL; 392 goto free_array; 393 } 394 395 ret = enable_logs(adev, resource_mask, &array[2]); 396 } 397 398 if (!ret) 399 ret = count; 400 free_array: 401 kfree(array); 402 return ret; 403 } 404 405 static const struct file_operations trace_control_fops = { 406 .llseek = default_llseek, 407 .read = trace_control_read, 408 .write = trace_control_write, 409 .open = simple_open, 410 }; 411 412 void avs_debugfs_init(struct avs_dev *adev) 413 { 414 init_waitqueue_head(&adev->trace_waitq); 415 spin_lock_init(&adev->trace_lock); 416 417 adev->debugfs_root = debugfs_create_dir("avs", snd_soc_debugfs_root); 418 419 /* Initialize timer periods with recommended defaults. */ 420 adev->aging_timer_period = 10; 421 adev->fifo_full_timer_period = 10; 422 423 debugfs_create_file("strace", 0444, adev->debugfs_root, adev, &strace_fops); 424 debugfs_create_file("trace_control", 0644, adev->debugfs_root, adev, &trace_control_fops); 425 debugfs_create_file("fw_regs", 0444, adev->debugfs_root, adev, &fw_regs_fops); 426 debugfs_create_file("debug_window", 0444, adev->debugfs_root, adev, &debug_window_fops); 427 428 debugfs_create_u32("trace_aging_period", 0644, adev->debugfs_root, 429 &adev->aging_timer_period); 430 debugfs_create_u32("trace_fifo_full_period", 0644, adev->debugfs_root, 431 &adev->fifo_full_timer_period); 432 433 debugfs_create_file("probe_points", 0644, adev->debugfs_root, adev, &probe_points_fops); 434 debugfs_create_file("probe_points_disconnect", 0200, adev->debugfs_root, adev, 435 &probe_points_disconnect_fops); 436 } 437 438 void avs_debugfs_exit(struct avs_dev *adev) 439 { 440 debugfs_remove_recursive(adev->debugfs_root); 441 } 442