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, uint32_t *v)
55 err = seqbuf_read(seqbuf, v, 4);
60 static int seqbuf_read_str(struct seqbuf *seqbuf, const char **str)
62 *str = seqbuf->buf + seqbuf->pos;
63 seqbuf->pos += strnlen(*str, seqbuf_avail(seqbuf));
65 return seqbuf_status(seqbuf);
68 static void seqbuf_seek(struct seqbuf *seqbuf, ssize_t offset)
70 seqbuf->pos += offset;
73 /* map filename in Linux debugfs to corresponding entry in BPMP */
74 static const char *get_filename(struct tegra_bpmp *bpmp,
75 const struct file *file, char *buf, int size)
77 const char *root_path, *filename = NULL;
81 root_path_buf = kzalloc(512, GFP_KERNEL);
85 root_path = dentry_path(bpmp->debugfs_mirror, root_path_buf,
86 sizeof(root_path_buf));
87 if (IS_ERR(root_path))
90 root_len = strlen(root_path);
92 filename = dentry_path(file->f_path.dentry, buf, size);
93 if (IS_ERR(filename)) {
98 if (strlen(filename) < root_len || strncmp(filename, root_path, root_len)) {
103 filename += root_len;
106 kfree(root_path_buf);
110 static int mrq_debug_open(struct tegra_bpmp *bpmp, const char *name,
111 uint32_t *fd, uint32_t *len, bool write)
113 struct mrq_debug_request req = {
114 .cmd = cpu_to_le32(write ? CMD_DEBUG_OPEN_WO : CMD_DEBUG_OPEN_RO),
116 struct mrq_debug_response resp;
117 struct tegra_bpmp_message msg = {
125 .size = sizeof(resp),
131 sz_name = strscpy(req.fop.name, name, sizeof(req.fop.name));
133 pr_err("File name too large: %s\n", name);
137 err = tegra_bpmp_transfer(bpmp, &msg);
140 else if (msg.rx.ret < 0)
143 *len = resp.fop.datalen;
149 static int mrq_debug_close(struct tegra_bpmp *bpmp, uint32_t fd)
151 struct mrq_debug_request req = {
152 .cmd = cpu_to_le32(CMD_DEBUG_CLOSE),
157 struct mrq_debug_response resp;
158 struct tegra_bpmp_message msg = {
166 .size = sizeof(resp),
171 err = tegra_bpmp_transfer(bpmp, &msg);
174 else if (msg.rx.ret < 0)
180 static int mrq_debug_read(struct tegra_bpmp *bpmp, const char *name,
181 char *data, size_t sz_data, uint32_t *nbytes)
183 struct mrq_debug_request req = {
184 .cmd = cpu_to_le32(CMD_DEBUG_READ),
186 struct mrq_debug_response resp;
187 struct tegra_bpmp_message msg = {
195 .size = sizeof(resp),
198 uint32_t fd = 0, len = 0;
201 mutex_lock(&bpmp_debug_lock);
202 err = mrq_debug_open(bpmp, name, &fd, &len, 0);
214 while (remaining > 0) {
215 err = tegra_bpmp_transfer(bpmp, &msg);
218 } else if (msg.rx.ret < 0) {
223 if (resp.frd.readlen > remaining) {
224 pr_err("%s: read data length invalid\n", __func__);
229 memcpy(data, resp.frd.data, resp.frd.readlen);
230 data += resp.frd.readlen;
231 remaining -= resp.frd.readlen;
237 err = mrq_debug_close(bpmp, fd);
239 mutex_unlock(&bpmp_debug_lock);
243 static int mrq_debug_write(struct tegra_bpmp *bpmp, const char *name,
244 uint8_t *data, size_t sz_data)
246 struct mrq_debug_request req = {
247 .cmd = cpu_to_le32(CMD_DEBUG_WRITE)
249 struct mrq_debug_response resp;
250 struct tegra_bpmp_message msg = {
258 .size = sizeof(resp),
261 uint32_t fd = 0, len = 0;
265 mutex_lock(&bpmp_debug_lock);
266 err = mrq_debug_open(bpmp, name, &fd, &len, 1);
278 while (remaining > 0) {
279 len = min(remaining, sizeof(req.fwr.data));
280 memcpy(req.fwr.data, data, len);
281 req.fwr.datalen = len;
283 err = tegra_bpmp_transfer(bpmp, &msg);
286 } else if (msg.rx.ret < 0) {
291 data += req.fwr.datalen;
292 remaining -= req.fwr.datalen;
296 err = mrq_debug_close(bpmp, fd);
298 mutex_unlock(&bpmp_debug_lock);
302 static int bpmp_debug_show(struct seq_file *m, void *p)
304 struct file *file = m->private;
305 struct inode *inode = file_inode(file);
306 struct tegra_bpmp *bpmp = inode->i_private;
308 const char *filename;
309 struct mrq_debug_request req = {
310 .cmd = cpu_to_le32(CMD_DEBUG_READ),
312 struct mrq_debug_response resp;
313 struct tegra_bpmp_message msg = {
321 .size = sizeof(resp),
324 uint32_t fd = 0, len = 0;
327 filename = get_filename(bpmp, file, fnamebuf, sizeof(fnamebuf));
331 mutex_lock(&bpmp_debug_lock);
332 err = mrq_debug_open(bpmp, filename, &fd, &len, 0);
339 while (remaining > 0) {
340 err = tegra_bpmp_transfer(bpmp, &msg);
343 } else if (msg.rx.ret < 0) {
348 if (resp.frd.readlen > remaining) {
349 pr_err("%s: read data length invalid\n", __func__);
354 seq_write(m, resp.frd.data, resp.frd.readlen);
355 remaining -= resp.frd.readlen;
359 err = mrq_debug_close(bpmp, fd);
361 mutex_unlock(&bpmp_debug_lock);
365 static ssize_t bpmp_debug_store(struct file *file, const char __user *buf,
366 size_t count, loff_t *f_pos)
368 struct inode *inode = file_inode(file);
369 struct tegra_bpmp *bpmp = inode->i_private;
370 char *databuf = NULL;
372 const char *filename;
375 filename = get_filename(bpmp, file, fnamebuf, sizeof(fnamebuf));
379 databuf = kmalloc(count, GFP_KERNEL);
383 if (copy_from_user(databuf, buf, count)) {
388 err = mrq_debug_write(bpmp, filename, databuf, count);
396 static int bpmp_debug_open(struct inode *inode, struct file *file)
398 return single_open_size(file, bpmp_debug_show, file, SZ_256K);
401 static const struct file_operations bpmp_debug_fops = {
402 .open = bpmp_debug_open,
405 .write = bpmp_debug_store,
406 .release = single_release,
409 static int bpmp_populate_debugfs_inband(struct tegra_bpmp *bpmp,
410 struct dentry *parent,
413 const size_t pathlen = SZ_256;
414 const size_t bufsize = SZ_16K;
415 uint32_t dsize, attrs = 0;
416 struct dentry *dentry;
417 struct seqbuf seqbuf;
422 if (!bpmp || !parent || !ppath)
425 buf = kmalloc(bufsize, GFP_KERNEL);
429 pathbuf = kzalloc(pathlen, GFP_KERNEL);
435 err = mrq_debug_read(bpmp, ppath, buf, bufsize, &dsize);
439 seqbuf_init(&seqbuf, buf, dsize);
441 while (!seqbuf_eof(&seqbuf)) {
442 err = seqbuf_read_u32(&seqbuf, &attrs);
446 err = seqbuf_read_str(&seqbuf, &name);
450 if (attrs & DEBUGFS_S_ISDIR) {
453 dentry = debugfs_create_dir(name, parent);
454 if (IS_ERR(dentry)) {
455 err = PTR_ERR(dentry);
459 len = snprintf(pathbuf, pathlen, "%s%s/", ppath, name);
460 if (len >= pathlen) {
465 err = bpmp_populate_debugfs_inband(bpmp, dentry,
472 mode = attrs & DEBUGFS_S_IRUSR ? 0400 : 0;
473 mode |= attrs & DEBUGFS_S_IWUSR ? 0200 : 0;
474 dentry = debugfs_create_file(name, mode, parent, bpmp,
490 static int mrq_debugfs_read(struct tegra_bpmp *bpmp,
491 dma_addr_t name, size_t sz_name,
492 dma_addr_t data, size_t sz_data,
495 struct mrq_debugfs_request req = {
496 .cmd = cpu_to_le32(CMD_DEBUGFS_READ),
498 .fnameaddr = cpu_to_le32((uint32_t)name),
499 .fnamelen = cpu_to_le32((uint32_t)sz_name),
500 .dataaddr = cpu_to_le32((uint32_t)data),
501 .datalen = cpu_to_le32((uint32_t)sz_data),
504 struct mrq_debugfs_response resp;
505 struct tegra_bpmp_message msg = {
513 .size = sizeof(resp),
518 err = tegra_bpmp_transfer(bpmp, &msg);
521 else if (msg.rx.ret < 0)
524 *nbytes = (size_t)resp.fop.nbytes;
529 static int mrq_debugfs_write(struct tegra_bpmp *bpmp,
530 dma_addr_t name, size_t sz_name,
531 dma_addr_t data, size_t sz_data)
533 const struct mrq_debugfs_request req = {
534 .cmd = cpu_to_le32(CMD_DEBUGFS_WRITE),
536 .fnameaddr = cpu_to_le32((uint32_t)name),
537 .fnamelen = cpu_to_le32((uint32_t)sz_name),
538 .dataaddr = cpu_to_le32((uint32_t)data),
539 .datalen = cpu_to_le32((uint32_t)sz_data),
542 struct tegra_bpmp_message msg = {
550 return tegra_bpmp_transfer(bpmp, &msg);
553 static int mrq_debugfs_dumpdir(struct tegra_bpmp *bpmp, dma_addr_t addr,
554 size_t size, size_t *nbytes)
556 const struct mrq_debugfs_request req = {
557 .cmd = cpu_to_le32(CMD_DEBUGFS_DUMPDIR),
559 .dataaddr = cpu_to_le32((uint32_t)addr),
560 .datalen = cpu_to_le32((uint32_t)size),
563 struct mrq_debugfs_response resp;
564 struct tegra_bpmp_message msg = {
572 .size = sizeof(resp),
577 err = tegra_bpmp_transfer(bpmp, &msg);
580 else if (msg.rx.ret < 0)
583 *nbytes = (size_t)resp.dumpdir.nbytes;
588 static int debugfs_show(struct seq_file *m, void *p)
590 struct file *file = m->private;
591 struct inode *inode = file_inode(file);
592 struct tegra_bpmp *bpmp = inode->i_private;
593 const size_t datasize = m->size;
594 const size_t namesize = SZ_256;
595 void *datavirt, *namevirt;
596 dma_addr_t dataphys, namephys;
598 const char *filename;
602 filename = get_filename(bpmp, file, buf, sizeof(buf));
606 namevirt = dma_alloc_coherent(bpmp->dev, namesize, &namephys,
607 GFP_KERNEL | GFP_DMA32);
611 datavirt = dma_alloc_coherent(bpmp->dev, datasize, &dataphys,
612 GFP_KERNEL | GFP_DMA32);
618 len = strlen(filename);
619 strncpy(namevirt, filename, namesize);
621 err = mrq_debugfs_read(bpmp, namephys, len, dataphys, datasize,
625 seq_write(m, datavirt, nbytes);
627 dma_free_coherent(bpmp->dev, datasize, datavirt, dataphys);
629 dma_free_coherent(bpmp->dev, namesize, namevirt, namephys);
634 static int debugfs_open(struct inode *inode, struct file *file)
636 return single_open_size(file, debugfs_show, file, SZ_128K);
639 static ssize_t debugfs_store(struct file *file, const char __user *buf,
640 size_t count, loff_t *f_pos)
642 struct inode *inode = file_inode(file);
643 struct tegra_bpmp *bpmp = inode->i_private;
644 const size_t datasize = count;
645 const size_t namesize = SZ_256;
646 void *datavirt, *namevirt;
647 dma_addr_t dataphys, namephys;
649 const char *filename;
653 filename = get_filename(bpmp, file, fnamebuf, sizeof(fnamebuf));
657 namevirt = dma_alloc_coherent(bpmp->dev, namesize, &namephys,
658 GFP_KERNEL | GFP_DMA32);
662 datavirt = dma_alloc_coherent(bpmp->dev, datasize, &dataphys,
663 GFP_KERNEL | GFP_DMA32);
669 len = strlen(filename);
670 strncpy(namevirt, filename, namesize);
672 if (copy_from_user(datavirt, buf, count)) {
677 err = mrq_debugfs_write(bpmp, namephys, len, dataphys,
681 dma_free_coherent(bpmp->dev, datasize, datavirt, dataphys);
683 dma_free_coherent(bpmp->dev, namesize, namevirt, namephys);
688 static const struct file_operations debugfs_fops = {
689 .open = debugfs_open,
692 .write = debugfs_store,
693 .release = single_release,
696 static int bpmp_populate_dir(struct tegra_bpmp *bpmp, struct seqbuf *seqbuf,
697 struct dentry *parent, uint32_t depth)
702 struct dentry *dentry;
704 while (!seqbuf_eof(seqbuf)) {
705 err = seqbuf_read_u32(seqbuf, &d);
710 seqbuf_seek(seqbuf, -4);
713 } else if (d != depth) {
714 /* malformed data received from BPMP */
718 err = seqbuf_read_u32(seqbuf, &t);
721 err = seqbuf_read_str(seqbuf, &name);
725 if (t & DEBUGFS_S_ISDIR) {
726 dentry = debugfs_create_dir(name, parent);
729 err = bpmp_populate_dir(bpmp, seqbuf, dentry, depth+1);
735 mode = t & DEBUGFS_S_IRUSR ? S_IRUSR : 0;
736 mode |= t & DEBUGFS_S_IWUSR ? S_IWUSR : 0;
737 dentry = debugfs_create_file(name, mode,
748 static int bpmp_populate_debugfs_shmem(struct tegra_bpmp *bpmp)
750 struct seqbuf seqbuf;
751 const size_t sz = SZ_512K;
757 virt = dma_alloc_coherent(bpmp->dev, sz, &phys,
758 GFP_KERNEL | GFP_DMA32);
762 err = mrq_debugfs_dumpdir(bpmp, phys, sz, &nbytes);
765 } else if (nbytes > sz) {
770 seqbuf_init(&seqbuf, virt, nbytes);
771 err = bpmp_populate_dir(bpmp, &seqbuf, bpmp->debugfs_mirror, 0);
773 dma_free_coherent(bpmp->dev, sz, virt, phys);
778 int tegra_bpmp_init_debugfs(struct tegra_bpmp *bpmp)
784 inband = tegra_bpmp_mrq_is_supported(bpmp, MRQ_DEBUG);
786 if (!inband && !tegra_bpmp_mrq_is_supported(bpmp, MRQ_DEBUGFS))
789 root = debugfs_create_dir("bpmp", NULL);
793 bpmp->debugfs_mirror = debugfs_create_dir("debug", root);
794 if (!bpmp->debugfs_mirror) {
800 err = bpmp_populate_debugfs_inband(bpmp, bpmp->debugfs_mirror,
803 err = bpmp_populate_debugfs_shmem(bpmp);
807 debugfs_remove_recursive(root);