xref: /linux/net/hsr/hsr_debugfs.c (revision 37744feebc086908fd89760650f458ab19071750)
1 /*
2  * hsr_debugfs code
3  * Copyright (C) 2019 Texas Instruments Incorporated
4  *
5  * Author(s):
6  *	Murali Karicheri <m-karicheri2@ti.com>
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License as
10  * published by the Free Software Foundation version 2.
11  *
12  * This program is distributed "as is" WITHOUT ANY WARRANTY of any
13  * kind, whether express or implied; without even the implied warranty
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  */
17 #include <linux/module.h>
18 #include <linux/errno.h>
19 #include <linux/debugfs.h>
20 #include "hsr_main.h"
21 #include "hsr_framereg.h"
22 
23 static struct dentry *hsr_debugfs_root_dir;
24 
25 static void print_mac_address(struct seq_file *sfp, unsigned char *mac)
26 {
27 	seq_printf(sfp, "%02x:%02x:%02x:%02x:%02x:%02x:",
28 		   mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
29 }
30 
31 /* hsr_node_table_show - Formats and prints node_table entries */
32 static int
33 hsr_node_table_show(struct seq_file *sfp, void *data)
34 {
35 	struct hsr_priv *priv = (struct hsr_priv *)sfp->private;
36 	struct hsr_node *node;
37 
38 	seq_puts(sfp, "Node Table entries\n");
39 	seq_puts(sfp, "MAC-Address-A,   MAC-Address-B, time_in[A], ");
40 	seq_puts(sfp, "time_in[B], Address-B port\n");
41 	rcu_read_lock();
42 	list_for_each_entry_rcu(node, &priv->node_db, mac_list) {
43 		/* skip self node */
44 		if (hsr_addr_is_self(priv, node->macaddress_A))
45 			continue;
46 		print_mac_address(sfp, &node->macaddress_A[0]);
47 		seq_puts(sfp, " ");
48 		print_mac_address(sfp, &node->macaddress_B[0]);
49 		seq_printf(sfp, "0x%lx, ", node->time_in[HSR_PT_SLAVE_A]);
50 		seq_printf(sfp, "0x%lx ", node->time_in[HSR_PT_SLAVE_B]);
51 		seq_printf(sfp, "0x%x\n", node->addr_B_port);
52 	}
53 	rcu_read_unlock();
54 	return 0;
55 }
56 
57 /* hsr_node_table_open - Open the node_table file
58  *
59  * Description:
60  * This routine opens a debugfs file node_table of specific hsr device
61  */
62 static int
63 hsr_node_table_open(struct inode *inode, struct file *filp)
64 {
65 	return single_open(filp, hsr_node_table_show, inode->i_private);
66 }
67 
68 void hsr_debugfs_rename(struct net_device *dev)
69 {
70 	struct hsr_priv *priv = netdev_priv(dev);
71 	struct dentry *d;
72 
73 	d = debugfs_rename(hsr_debugfs_root_dir, priv->node_tbl_root,
74 			   hsr_debugfs_root_dir, dev->name);
75 	if (IS_ERR(d))
76 		netdev_warn(dev, "failed to rename\n");
77 	else
78 		priv->node_tbl_root = d;
79 }
80 
81 static const struct file_operations hsr_fops = {
82 	.open	= hsr_node_table_open,
83 	.read	= seq_read,
84 	.llseek = seq_lseek,
85 	.release = single_release,
86 };
87 
88 /* hsr_debugfs_init - create hsr node_table file for dumping
89  * the node table
90  *
91  * Description:
92  * When debugfs is configured this routine sets up the node_table file per
93  * hsr device for dumping the node_table entries
94  */
95 void hsr_debugfs_init(struct hsr_priv *priv, struct net_device *hsr_dev)
96 {
97 	struct dentry *de = NULL;
98 
99 	de = debugfs_create_dir(hsr_dev->name, hsr_debugfs_root_dir);
100 	if (IS_ERR(de)) {
101 		pr_err("Cannot create hsr debugfs directory\n");
102 		return;
103 	}
104 
105 	priv->node_tbl_root = de;
106 
107 	de = debugfs_create_file("node_table", S_IFREG | 0444,
108 				 priv->node_tbl_root, priv,
109 				 &hsr_fops);
110 	if (IS_ERR(de)) {
111 		pr_err("Cannot create hsr node_table file\n");
112 		debugfs_remove(priv->node_tbl_root);
113 		priv->node_tbl_root = NULL;
114 		return;
115 	}
116 }
117 
118 /* hsr_debugfs_term - Tear down debugfs intrastructure
119  *
120  * Description:
121  * When Debufs is configured this routine removes debugfs file system
122  * elements that are specific to hsr
123  */
124 void
125 hsr_debugfs_term(struct hsr_priv *priv)
126 {
127 	debugfs_remove_recursive(priv->node_tbl_root);
128 	priv->node_tbl_root = NULL;
129 }
130 
131 void hsr_debugfs_create_root(void)
132 {
133 	hsr_debugfs_root_dir = debugfs_create_dir("hsr", NULL);
134 	if (IS_ERR(hsr_debugfs_root_dir)) {
135 		pr_err("Cannot create hsr debugfs root directory\n");
136 		hsr_debugfs_root_dir = NULL;
137 	}
138 }
139 
140 void hsr_debugfs_remove_root(void)
141 {
142 	/* debugfs_remove() internally checks NULL and ERROR */
143 	debugfs_remove(hsr_debugfs_root_dir);
144 }
145