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 char root_path_buf[512];
78 const char *root_path;
82 root_path = dentry_path(bpmp->debugfs_mirror, root_path_buf,
83 sizeof(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);
93 if (strlen(filename) < root_len ||
94 strncmp(filename, root_path, root_len))
102 static int mrq_debug_open(struct tegra_bpmp *bpmp, const char *name,
103 uint32_t *fd, uint32_t *len, bool write)
105 struct mrq_debug_request req = {
106 .cmd = cpu_to_le32(write ? CMD_DEBUG_OPEN_WO : CMD_DEBUG_OPEN_RO),
108 struct mrq_debug_response resp;
109 struct tegra_bpmp_message msg = {
117 .size = sizeof(resp),
123 sz_name = strscpy(req.fop.name, name, sizeof(req.fop.name));
125 pr_err("File name too large: %s\n", name);
129 err = tegra_bpmp_transfer(bpmp, &msg);
132 else if (msg.rx.ret < 0)
135 *len = resp.fop.datalen;
141 static int mrq_debug_close(struct tegra_bpmp *bpmp, uint32_t fd)
143 struct mrq_debug_request req = {
144 .cmd = cpu_to_le32(CMD_DEBUG_CLOSE),
149 struct mrq_debug_response resp;
150 struct tegra_bpmp_message msg = {
158 .size = sizeof(resp),
163 err = tegra_bpmp_transfer(bpmp, &msg);
166 else if (msg.rx.ret < 0)
172 static int mrq_debug_read(struct tegra_bpmp *bpmp, const char *name,
173 char *data, size_t sz_data, uint32_t *nbytes)
175 struct mrq_debug_request req = {
176 .cmd = cpu_to_le32(CMD_DEBUG_READ),
178 struct mrq_debug_response resp;
179 struct tegra_bpmp_message msg = {
187 .size = sizeof(resp),
190 uint32_t fd = 0, len = 0;
193 mutex_lock(&bpmp_debug_lock);
194 err = mrq_debug_open(bpmp, name, &fd, &len, 0);
206 while (remaining > 0) {
207 err = tegra_bpmp_transfer(bpmp, &msg);
210 } else if (msg.rx.ret < 0) {
215 if (resp.frd.readlen > remaining) {
216 pr_err("%s: read data length invalid\n", __func__);
221 memcpy(data, resp.frd.data, resp.frd.readlen);
222 data += resp.frd.readlen;
223 remaining -= resp.frd.readlen;
229 err = mrq_debug_close(bpmp, fd);
231 mutex_unlock(&bpmp_debug_lock);
235 static int mrq_debug_write(struct tegra_bpmp *bpmp, const char *name,
236 uint8_t *data, size_t sz_data)
238 struct mrq_debug_request req = {
239 .cmd = cpu_to_le32(CMD_DEBUG_WRITE)
241 struct mrq_debug_response resp;
242 struct tegra_bpmp_message msg = {
250 .size = sizeof(resp),
253 uint32_t fd = 0, len = 0;
257 mutex_lock(&bpmp_debug_lock);
258 err = mrq_debug_open(bpmp, name, &fd, &len, 1);
270 while (remaining > 0) {
271 len = min(remaining, sizeof(req.fwr.data));
272 memcpy(req.fwr.data, data, len);
273 req.fwr.datalen = len;
275 err = tegra_bpmp_transfer(bpmp, &msg);
278 } else if (msg.rx.ret < 0) {
283 data += req.fwr.datalen;
284 remaining -= req.fwr.datalen;
288 err = mrq_debug_close(bpmp, fd);
290 mutex_unlock(&bpmp_debug_lock);
294 static int bpmp_debug_show(struct seq_file *m, void *p)
296 struct file *file = m->private;
297 struct inode *inode = file_inode(file);
298 struct tegra_bpmp *bpmp = inode->i_private;
299 char *databuf = NULL;
301 const char *filename;
306 len = seq_get_buf(m, &databuf);
310 filename = get_filename(bpmp, file, fnamebuf, sizeof(fnamebuf));
314 err = mrq_debug_read(bpmp, filename, databuf, len, &nbytes);
316 seq_commit(m, nbytes);
321 static ssize_t bpmp_debug_store(struct file *file, const char __user *buf,
322 size_t count, loff_t *f_pos)
324 struct inode *inode = file_inode(file);
325 struct tegra_bpmp *bpmp = inode->i_private;
326 char *databuf = NULL;
328 const char *filename;
331 filename = get_filename(bpmp, file, fnamebuf, sizeof(fnamebuf));
335 databuf = kmalloc(count, GFP_KERNEL);
339 if (copy_from_user(databuf, buf, count)) {
344 err = mrq_debug_write(bpmp, filename, databuf, count);
352 static int bpmp_debug_open(struct inode *inode, struct file *file)
354 return single_open_size(file, bpmp_debug_show, file, SZ_256K);
357 static const struct file_operations bpmp_debug_fops = {
358 .open = bpmp_debug_open,
361 .write = bpmp_debug_store,
362 .release = single_release,
365 static int bpmp_populate_debugfs_inband(struct tegra_bpmp *bpmp,
366 struct dentry *parent,
369 const size_t pathlen = SZ_256;
370 const size_t bufsize = SZ_16K;
371 uint32_t dsize, attrs = 0;
372 struct dentry *dentry;
373 struct seqbuf seqbuf;
378 if (!bpmp || !parent || !ppath)
381 buf = kmalloc(bufsize, GFP_KERNEL);
385 pathbuf = kzalloc(pathlen, GFP_KERNEL);
391 err = mrq_debug_read(bpmp, ppath, buf, bufsize, &dsize);
395 seqbuf_init(&seqbuf, buf, dsize);
397 while (!seqbuf_eof(&seqbuf)) {
398 err = seqbuf_read_u32(&seqbuf, &attrs);
402 err = seqbuf_read_str(&seqbuf, &name);
406 if (attrs & DEBUGFS_S_ISDIR) {
409 dentry = debugfs_create_dir(name, parent);
410 if (IS_ERR(dentry)) {
411 err = PTR_ERR(dentry);
415 len = snprintf(pathbuf, pathlen, "%s%s/", ppath, name);
416 if (len >= pathlen) {
421 err = bpmp_populate_debugfs_inband(bpmp, dentry,
428 mode = attrs & DEBUGFS_S_IRUSR ? 0400 : 0;
429 mode |= attrs & DEBUGFS_S_IWUSR ? 0200 : 0;
430 dentry = debugfs_create_file(name, mode, parent, bpmp,
432 if (IS_ERR(dentry)) {
446 static int mrq_debugfs_read(struct tegra_bpmp *bpmp,
447 dma_addr_t name, size_t sz_name,
448 dma_addr_t data, size_t sz_data,
451 struct mrq_debugfs_request req = {
452 .cmd = cpu_to_le32(CMD_DEBUGFS_READ),
454 .fnameaddr = cpu_to_le32((uint32_t)name),
455 .fnamelen = cpu_to_le32((uint32_t)sz_name),
456 .dataaddr = cpu_to_le32((uint32_t)data),
457 .datalen = cpu_to_le32((uint32_t)sz_data),
460 struct mrq_debugfs_response resp;
461 struct tegra_bpmp_message msg = {
469 .size = sizeof(resp),
474 err = tegra_bpmp_transfer(bpmp, &msg);
477 else if (msg.rx.ret < 0)
480 *nbytes = (size_t)resp.fop.nbytes;
485 static int mrq_debugfs_write(struct tegra_bpmp *bpmp,
486 dma_addr_t name, size_t sz_name,
487 dma_addr_t data, size_t sz_data)
489 const struct mrq_debugfs_request req = {
490 .cmd = cpu_to_le32(CMD_DEBUGFS_WRITE),
492 .fnameaddr = cpu_to_le32((uint32_t)name),
493 .fnamelen = cpu_to_le32((uint32_t)sz_name),
494 .dataaddr = cpu_to_le32((uint32_t)data),
495 .datalen = cpu_to_le32((uint32_t)sz_data),
498 struct tegra_bpmp_message msg = {
506 return tegra_bpmp_transfer(bpmp, &msg);
509 static int mrq_debugfs_dumpdir(struct tegra_bpmp *bpmp, dma_addr_t addr,
510 size_t size, size_t *nbytes)
512 const struct mrq_debugfs_request req = {
513 .cmd = cpu_to_le32(CMD_DEBUGFS_DUMPDIR),
515 .dataaddr = cpu_to_le32((uint32_t)addr),
516 .datalen = cpu_to_le32((uint32_t)size),
519 struct mrq_debugfs_response resp;
520 struct tegra_bpmp_message msg = {
528 .size = sizeof(resp),
533 err = tegra_bpmp_transfer(bpmp, &msg);
536 else if (msg.rx.ret < 0)
539 *nbytes = (size_t)resp.dumpdir.nbytes;
544 static int debugfs_show(struct seq_file *m, void *p)
546 struct file *file = m->private;
547 struct inode *inode = file_inode(file);
548 struct tegra_bpmp *bpmp = inode->i_private;
549 const size_t datasize = m->size;
550 const size_t namesize = SZ_256;
551 void *datavirt, *namevirt;
552 dma_addr_t dataphys, namephys;
554 const char *filename;
558 filename = get_filename(bpmp, file, buf, sizeof(buf));
562 namevirt = dma_alloc_coherent(bpmp->dev, namesize, &namephys,
563 GFP_KERNEL | GFP_DMA32);
567 datavirt = dma_alloc_coherent(bpmp->dev, datasize, &dataphys,
568 GFP_KERNEL | GFP_DMA32);
574 len = strlen(filename);
575 strncpy(namevirt, filename, namesize);
577 err = mrq_debugfs_read(bpmp, namephys, len, dataphys, datasize,
581 seq_write(m, datavirt, nbytes);
583 dma_free_coherent(bpmp->dev, datasize, datavirt, dataphys);
585 dma_free_coherent(bpmp->dev, namesize, namevirt, namephys);
590 static int debugfs_open(struct inode *inode, struct file *file)
592 return single_open_size(file, debugfs_show, file, SZ_128K);
595 static ssize_t debugfs_store(struct file *file, const char __user *buf,
596 size_t count, loff_t *f_pos)
598 struct inode *inode = file_inode(file);
599 struct tegra_bpmp *bpmp = inode->i_private;
600 const size_t datasize = count;
601 const size_t namesize = SZ_256;
602 void *datavirt, *namevirt;
603 dma_addr_t dataphys, namephys;
605 const char *filename;
609 filename = get_filename(bpmp, file, fnamebuf, sizeof(fnamebuf));
613 namevirt = dma_alloc_coherent(bpmp->dev, namesize, &namephys,
614 GFP_KERNEL | GFP_DMA32);
618 datavirt = dma_alloc_coherent(bpmp->dev, datasize, &dataphys,
619 GFP_KERNEL | GFP_DMA32);
625 len = strlen(filename);
626 strncpy(namevirt, filename, namesize);
628 if (copy_from_user(datavirt, buf, count)) {
633 err = mrq_debugfs_write(bpmp, namephys, len, dataphys,
637 dma_free_coherent(bpmp->dev, datasize, datavirt, dataphys);
639 dma_free_coherent(bpmp->dev, namesize, namevirt, namephys);
644 static const struct file_operations debugfs_fops = {
645 .open = debugfs_open,
648 .write = debugfs_store,
649 .release = single_release,
652 static int bpmp_populate_dir(struct tegra_bpmp *bpmp, struct seqbuf *seqbuf,
653 struct dentry *parent, uint32_t depth)
658 struct dentry *dentry;
660 while (!seqbuf_eof(seqbuf)) {
661 err = seqbuf_read_u32(seqbuf, &d);
666 seqbuf_seek(seqbuf, -4);
669 } else if (d != depth) {
670 /* malformed data received from BPMP */
674 err = seqbuf_read_u32(seqbuf, &t);
677 err = seqbuf_read_str(seqbuf, &name);
681 if (t & DEBUGFS_S_ISDIR) {
682 dentry = debugfs_create_dir(name, parent);
685 err = bpmp_populate_dir(bpmp, seqbuf, dentry, depth+1);
691 mode = t & DEBUGFS_S_IRUSR ? S_IRUSR : 0;
692 mode |= t & DEBUGFS_S_IWUSR ? S_IWUSR : 0;
693 dentry = debugfs_create_file(name, mode,
704 static int bpmp_populate_debugfs_shmem(struct tegra_bpmp *bpmp)
706 struct seqbuf seqbuf;
707 const size_t sz = SZ_512K;
713 virt = dma_alloc_coherent(bpmp->dev, sz, &phys,
714 GFP_KERNEL | GFP_DMA32);
718 err = mrq_debugfs_dumpdir(bpmp, phys, sz, &nbytes);
721 } else if (nbytes > sz) {
726 seqbuf_init(&seqbuf, virt, nbytes);
727 err = bpmp_populate_dir(bpmp, &seqbuf, bpmp->debugfs_mirror, 0);
729 dma_free_coherent(bpmp->dev, sz, virt, phys);
734 int tegra_bpmp_init_debugfs(struct tegra_bpmp *bpmp)
740 inband = tegra_bpmp_mrq_is_supported(bpmp, MRQ_DEBUG);
742 if (!inband && !tegra_bpmp_mrq_is_supported(bpmp, MRQ_DEBUGFS))
745 root = debugfs_create_dir("bpmp", NULL);
749 bpmp->debugfs_mirror = debugfs_create_dir("debug", root);
750 if (IS_ERR(bpmp->debugfs_mirror)) {
756 err = bpmp_populate_debugfs_inband(bpmp, bpmp->debugfs_mirror,
759 err = bpmp_populate_debugfs_shmem(bpmp);
763 debugfs_remove_recursive(root);