1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2017, NVIDIA CORPORATION. All rights reserved.
5 #include <linux/debugfs.h>
6 #include <linux/dma-mapping.h>
7 #include <linux/slab.h>
8 #include <linux/uaccess.h>
10 #include <soc/tegra/bpmp.h>
11 #include <soc/tegra/bpmp-abi.h>
13 static DEFINE_MUTEX(bpmp_debug_lock);
21 static void seqbuf_init(struct seqbuf *seqbuf, void *buf, size_t size)
28 static size_t seqbuf_avail(struct seqbuf *seqbuf)
30 return seqbuf->pos < seqbuf->size ? seqbuf->size - seqbuf->pos : 0;
33 static size_t seqbuf_status(struct seqbuf *seqbuf)
35 return seqbuf->pos <= seqbuf->size ? 0 : -EOVERFLOW;
38 static int seqbuf_eof(struct seqbuf *seqbuf)
40 return seqbuf->pos >= seqbuf->size;
43 static int seqbuf_read(struct seqbuf *seqbuf, void *buf, size_t nbyte)
45 nbyte = min(nbyte, seqbuf_avail(seqbuf));
46 memcpy(buf, seqbuf->buf + seqbuf->pos, nbyte);
48 return seqbuf_status(seqbuf);
51 static int seqbuf_read_u32(struct seqbuf *seqbuf, u32 *v)
53 return seqbuf_read(seqbuf, v, 4);
56 static int seqbuf_read_str(struct seqbuf *seqbuf, const char **str)
58 *str = seqbuf->buf + seqbuf->pos;
59 seqbuf->pos += strnlen(*str, seqbuf_avail(seqbuf));
61 return seqbuf_status(seqbuf);
64 static void seqbuf_seek(struct seqbuf *seqbuf, ssize_t offset)
66 seqbuf->pos += offset;
69 /* map filename in Linux debugfs to corresponding entry in BPMP */
70 static const char *get_filename(struct tegra_bpmp *bpmp,
71 const struct file *file, char *buf, int size)
73 const char *root_path, *filename = NULL;
76 size_t root_path_buf_len = 512;
78 root_path_buf = kzalloc(root_path_buf_len, GFP_KERNEL);
82 root_path = dentry_path(bpmp->debugfs_mirror, root_path_buf,
84 if (IS_ERR(root_path))
87 root_len = strlen(root_path);
89 filename = dentry_path(file->f_path.dentry, buf, size);
90 if (IS_ERR(filename)) {
95 if (strlen(filename) < root_len || strncmp(filename, root_path, root_len)) {
100 filename += root_len;
103 kfree(root_path_buf);
107 static int mrq_debug_open(struct tegra_bpmp *bpmp, const char *name,
108 u32 *fd, u32 *len, bool write)
110 struct mrq_debug_request req = {
111 .cmd = write ? CMD_DEBUG_OPEN_WO : CMD_DEBUG_OPEN_RO,
113 struct mrq_debug_response resp;
114 struct tegra_bpmp_message msg = {
122 .size = sizeof(resp),
128 sz_name = strscpy(req.fop.name, name, sizeof(req.fop.name));
130 pr_err("File name too large: %s\n", name);
134 err = tegra_bpmp_transfer(bpmp, &msg);
137 else if (msg.rx.ret < 0)
140 *len = resp.fop.datalen;
146 static int mrq_debug_close(struct tegra_bpmp *bpmp, u32 fd)
148 struct mrq_debug_request req = {
149 .cmd = CMD_DEBUG_CLOSE,
154 struct mrq_debug_response resp;
155 struct tegra_bpmp_message msg = {
163 .size = sizeof(resp),
168 err = tegra_bpmp_transfer(bpmp, &msg);
171 else if (msg.rx.ret < 0)
177 static int mrq_debug_read(struct tegra_bpmp *bpmp, const char *name,
178 char *data, size_t sz_data, u32 *nbytes)
180 struct mrq_debug_request req = {
181 .cmd = CMD_DEBUG_READ,
183 struct mrq_debug_response resp;
184 struct tegra_bpmp_message msg = {
192 .size = sizeof(resp),
198 mutex_lock(&bpmp_debug_lock);
199 err = mrq_debug_open(bpmp, name, &fd, &len, 0);
211 while (remaining > 0) {
212 err = tegra_bpmp_transfer(bpmp, &msg);
215 } else if (msg.rx.ret < 0) {
220 if (resp.frd.readlen > remaining) {
221 pr_err("%s: read data length invalid\n", __func__);
226 memcpy(data, resp.frd.data, resp.frd.readlen);
227 data += resp.frd.readlen;
228 remaining -= resp.frd.readlen;
234 err = mrq_debug_close(bpmp, fd);
236 mutex_unlock(&bpmp_debug_lock);
240 static int mrq_debug_write(struct tegra_bpmp *bpmp, const char *name,
241 uint8_t *data, size_t sz_data)
243 struct mrq_debug_request req = {
244 .cmd = CMD_DEBUG_WRITE
246 struct mrq_debug_response resp;
247 struct tegra_bpmp_message msg = {
255 .size = sizeof(resp),
262 mutex_lock(&bpmp_debug_lock);
263 err = mrq_debug_open(bpmp, name, &fd, &len, 1);
275 while (remaining > 0) {
276 len = min(remaining, sizeof(req.fwr.data));
277 memcpy(req.fwr.data, data, len);
278 req.fwr.datalen = len;
280 err = tegra_bpmp_transfer(bpmp, &msg);
283 } else if (msg.rx.ret < 0) {
288 data += req.fwr.datalen;
289 remaining -= req.fwr.datalen;
293 err = mrq_debug_close(bpmp, fd);
295 mutex_unlock(&bpmp_debug_lock);
299 static int bpmp_debug_show(struct seq_file *m, void *p)
301 struct file *file = m->private;
302 struct inode *inode = file_inode(file);
303 struct tegra_bpmp *bpmp = inode->i_private;
305 const char *filename;
306 struct mrq_debug_request req = {
307 .cmd = CMD_DEBUG_READ,
309 struct mrq_debug_response resp;
310 struct tegra_bpmp_message msg = {
318 .size = sizeof(resp),
324 filename = get_filename(bpmp, file, fnamebuf, sizeof(fnamebuf));
328 mutex_lock(&bpmp_debug_lock);
329 err = mrq_debug_open(bpmp, filename, &fd, &len, 0);
336 while (remaining > 0) {
337 err = tegra_bpmp_transfer(bpmp, &msg);
340 } else if (msg.rx.ret < 0) {
345 if (resp.frd.readlen > remaining) {
346 pr_err("%s: read data length invalid\n", __func__);
351 seq_write(m, resp.frd.data, resp.frd.readlen);
352 remaining -= resp.frd.readlen;
356 err = mrq_debug_close(bpmp, fd);
358 mutex_unlock(&bpmp_debug_lock);
362 static ssize_t bpmp_debug_store(struct file *file, const char __user *buf,
363 size_t count, loff_t *f_pos)
365 struct inode *inode = file_inode(file);
366 struct tegra_bpmp *bpmp = inode->i_private;
367 char *databuf = NULL;
369 const char *filename;
372 filename = get_filename(bpmp, file, fnamebuf, sizeof(fnamebuf));
376 databuf = memdup_user(buf, count);
378 return PTR_ERR(databuf);
380 err = mrq_debug_write(bpmp, filename, databuf, count);
386 static int bpmp_debug_open(struct inode *inode, struct file *file)
388 return single_open_size(file, bpmp_debug_show, file, SZ_256K);
391 static const struct file_operations bpmp_debug_fops = {
392 .open = bpmp_debug_open,
395 .write = bpmp_debug_store,
396 .release = single_release,
399 static int bpmp_populate_debugfs_inband(struct tegra_bpmp *bpmp,
400 struct dentry *parent,
403 const size_t pathlen = SZ_256;
404 const size_t bufsize = SZ_16K;
405 struct dentry *dentry;
406 u32 dsize, attrs = 0;
407 struct seqbuf seqbuf;
412 if (!bpmp || !parent || !ppath)
415 buf = kmalloc(bufsize, GFP_KERNEL);
419 pathbuf = kzalloc(pathlen, GFP_KERNEL);
425 err = mrq_debug_read(bpmp, ppath, buf, bufsize, &dsize);
429 seqbuf_init(&seqbuf, buf, dsize);
431 while (!seqbuf_eof(&seqbuf)) {
432 err = seqbuf_read_u32(&seqbuf, &attrs);
436 err = seqbuf_read_str(&seqbuf, &name);
440 if (attrs & DEBUGFS_S_ISDIR) {
443 dentry = debugfs_create_dir(name, parent);
444 if (IS_ERR(dentry)) {
445 err = PTR_ERR(dentry);
449 len = snprintf(pathbuf, pathlen, "%s%s/", ppath, name);
450 if (len >= pathlen) {
455 err = bpmp_populate_debugfs_inband(bpmp, dentry,
462 mode = attrs & DEBUGFS_S_IRUSR ? 0400 : 0;
463 mode |= attrs & DEBUGFS_S_IWUSR ? 0200 : 0;
464 dentry = debugfs_create_file(name, mode, parent, bpmp,
466 if (IS_ERR(dentry)) {
480 static int mrq_debugfs_read(struct tegra_bpmp *bpmp,
481 dma_addr_t name, size_t sz_name,
482 dma_addr_t data, size_t sz_data,
485 struct mrq_debugfs_request req = {
486 .cmd = CMD_DEBUGFS_READ,
488 .fnameaddr = (u32)name,
489 .fnamelen = (u32)sz_name,
490 .dataaddr = (u32)data,
491 .datalen = (u32)sz_data,
494 struct mrq_debugfs_response resp;
495 struct tegra_bpmp_message msg = {
503 .size = sizeof(resp),
508 err = tegra_bpmp_transfer(bpmp, &msg);
511 else if (msg.rx.ret < 0)
514 *nbytes = (size_t)resp.fop.nbytes;
519 static int mrq_debugfs_write(struct tegra_bpmp *bpmp,
520 dma_addr_t name, size_t sz_name,
521 dma_addr_t data, size_t sz_data)
523 const struct mrq_debugfs_request req = {
524 .cmd = CMD_DEBUGFS_WRITE,
526 .fnameaddr = (u32)name,
527 .fnamelen = (u32)sz_name,
528 .dataaddr = (u32)data,
529 .datalen = (u32)sz_data,
532 struct tegra_bpmp_message msg = {
540 return tegra_bpmp_transfer(bpmp, &msg);
543 static int mrq_debugfs_dumpdir(struct tegra_bpmp *bpmp, dma_addr_t addr,
544 size_t size, size_t *nbytes)
546 const struct mrq_debugfs_request req = {
547 .cmd = CMD_DEBUGFS_DUMPDIR,
549 .dataaddr = (u32)addr,
550 .datalen = (u32)size,
553 struct mrq_debugfs_response resp;
554 struct tegra_bpmp_message msg = {
562 .size = sizeof(resp),
567 err = tegra_bpmp_transfer(bpmp, &msg);
570 else if (msg.rx.ret < 0)
573 *nbytes = (size_t)resp.dumpdir.nbytes;
578 static int debugfs_show(struct seq_file *m, void *p)
580 struct file *file = m->private;
581 struct inode *inode = file_inode(file);
582 struct tegra_bpmp *bpmp = inode->i_private;
583 const size_t datasize = m->size;
584 const size_t namesize = SZ_256;
585 void *datavirt, *namevirt;
586 dma_addr_t dataphys, namephys;
588 const char *filename;
592 filename = get_filename(bpmp, file, buf, sizeof(buf));
596 namevirt = dma_alloc_coherent(bpmp->dev, namesize, &namephys,
597 GFP_KERNEL | GFP_DMA32);
601 datavirt = dma_alloc_coherent(bpmp->dev, datasize, &dataphys,
602 GFP_KERNEL | GFP_DMA32);
608 len = strlen(filename);
609 strncpy(namevirt, filename, namesize);
611 err = mrq_debugfs_read(bpmp, namephys, len, dataphys, datasize,
615 seq_write(m, datavirt, nbytes);
617 dma_free_coherent(bpmp->dev, datasize, datavirt, dataphys);
619 dma_free_coherent(bpmp->dev, namesize, namevirt, namephys);
624 static int debugfs_open(struct inode *inode, struct file *file)
626 return single_open_size(file, debugfs_show, file, SZ_128K);
629 static ssize_t debugfs_store(struct file *file, const char __user *buf,
630 size_t count, loff_t *f_pos)
632 struct inode *inode = file_inode(file);
633 struct tegra_bpmp *bpmp = inode->i_private;
634 const size_t datasize = count;
635 const size_t namesize = SZ_256;
636 void *datavirt, *namevirt;
637 dma_addr_t dataphys, namephys;
639 const char *filename;
643 filename = get_filename(bpmp, file, fnamebuf, sizeof(fnamebuf));
647 namevirt = dma_alloc_coherent(bpmp->dev, namesize, &namephys,
648 GFP_KERNEL | GFP_DMA32);
652 datavirt = dma_alloc_coherent(bpmp->dev, datasize, &dataphys,
653 GFP_KERNEL | GFP_DMA32);
659 len = strlen(filename);
660 strncpy(namevirt, filename, namesize);
662 if (copy_from_user(datavirt, buf, count)) {
667 err = mrq_debugfs_write(bpmp, namephys, len, dataphys,
671 dma_free_coherent(bpmp->dev, datasize, datavirt, dataphys);
673 dma_free_coherent(bpmp->dev, namesize, namevirt, namephys);
678 static const struct file_operations debugfs_fops = {
679 .open = debugfs_open,
682 .write = debugfs_store,
683 .release = single_release,
686 static int bpmp_populate_dir(struct tegra_bpmp *bpmp, struct seqbuf *seqbuf,
687 struct dentry *parent, u32 depth)
692 struct dentry *dentry;
694 while (!seqbuf_eof(seqbuf)) {
695 err = seqbuf_read_u32(seqbuf, &d);
700 seqbuf_seek(seqbuf, -4);
703 } else if (d != depth) {
704 /* malformed data received from BPMP */
708 err = seqbuf_read_u32(seqbuf, &t);
711 err = seqbuf_read_str(seqbuf, &name);
715 if (t & DEBUGFS_S_ISDIR) {
716 dentry = debugfs_create_dir(name, parent);
719 err = bpmp_populate_dir(bpmp, seqbuf, dentry, depth+1);
725 mode = t & DEBUGFS_S_IRUSR ? S_IRUSR : 0;
726 mode |= t & DEBUGFS_S_IWUSR ? S_IWUSR : 0;
727 dentry = debugfs_create_file(name, mode,
738 static int bpmp_populate_debugfs_shmem(struct tegra_bpmp *bpmp)
740 struct seqbuf seqbuf;
741 const size_t sz = SZ_512K;
747 virt = dma_alloc_coherent(bpmp->dev, sz, &phys,
748 GFP_KERNEL | GFP_DMA32);
752 err = mrq_debugfs_dumpdir(bpmp, phys, sz, &nbytes);
755 } else if (nbytes > sz) {
760 seqbuf_init(&seqbuf, virt, nbytes);
761 err = bpmp_populate_dir(bpmp, &seqbuf, bpmp->debugfs_mirror, 0);
763 dma_free_coherent(bpmp->dev, sz, virt, phys);
768 int tegra_bpmp_init_debugfs(struct tegra_bpmp *bpmp)
774 inband = tegra_bpmp_mrq_is_supported(bpmp, MRQ_DEBUG);
776 if (!inband && !tegra_bpmp_mrq_is_supported(bpmp, MRQ_DEBUGFS))
779 root = debugfs_create_dir("bpmp", NULL);
783 bpmp->debugfs_mirror = debugfs_create_dir("debug", root);
784 if (IS_ERR(bpmp->debugfs_mirror)) {
790 err = bpmp_populate_debugfs_inband(bpmp, bpmp->debugfs_mirror,
793 err = bpmp_populate_debugfs_shmem(bpmp);
797 debugfs_remove_recursive(root);