1 // SPDX-License-Identifier: GPL-2.0+
2 /* Copyright (c) 2018-2019 Hisilicon Limited. */
3 
4 #include <linux/debugfs.h>
5 #include <linux/device.h>
6 
7 #include "hnae3.h"
8 #include "hns3_enet.h"
9 
10 #define HNS3_DBG_READ_LEN 256
11 
12 static struct dentry *hns3_dbgfs_root;
13 
14 static int hns3_dbg_queue_info(struct hnae3_handle *h, char *cmd_buf)
15 {
16 	struct hns3_nic_priv *priv = h->priv;
17 	struct hns3_nic_ring_data *ring_data;
18 	struct hns3_enet_ring *ring;
19 	u32 base_add_l, base_add_h;
20 	u32 queue_num, queue_max;
21 	u32 value, i = 0;
22 	int cnt;
23 
24 	if (!priv->ring_data) {
25 		dev_err(&h->pdev->dev, "ring_data is NULL\n");
26 		return -EFAULT;
27 	}
28 
29 	queue_max = h->kinfo.num_tqps;
30 	cnt = kstrtouint(&cmd_buf[11], 0, &queue_num);
31 	if (cnt)
32 		queue_num = 0;
33 	else
34 		queue_max = queue_num + 1;
35 
36 	dev_info(&h->pdev->dev, "queue info\n");
37 
38 	if (queue_num >= h->kinfo.num_tqps) {
39 		dev_err(&h->pdev->dev,
40 			"Queue number(%u) is out of range(%u)\n", queue_num,
41 			h->kinfo.num_tqps - 1);
42 		return -EINVAL;
43 	}
44 
45 	ring_data = priv->ring_data;
46 	for (i = queue_num; i < queue_max; i++) {
47 		/* Each cycle needs to determine whether the instance is reset,
48 		 * to prevent reference to invalid memory. And need to ensure
49 		 * that the following code is executed within 100ms.
50 		 */
51 		if (!test_bit(HNS3_NIC_STATE_INITED, &priv->state) ||
52 		    test_bit(HNS3_NIC_STATE_RESETTING, &priv->state))
53 			return -EPERM;
54 
55 		ring = ring_data[(u32)(i + h->kinfo.num_tqps)].ring;
56 		base_add_h = readl_relaxed(ring->tqp->io_base +
57 					   HNS3_RING_RX_RING_BASEADDR_H_REG);
58 		base_add_l = readl_relaxed(ring->tqp->io_base +
59 					   HNS3_RING_RX_RING_BASEADDR_L_REG);
60 		dev_info(&h->pdev->dev, "RX(%d) BASE ADD: 0x%08x%08x\n", i,
61 			 base_add_h, base_add_l);
62 
63 		value = readl_relaxed(ring->tqp->io_base +
64 				      HNS3_RING_RX_RING_BD_NUM_REG);
65 		dev_info(&h->pdev->dev, "RX(%d) RING BD NUM: %u\n", i, value);
66 
67 		value = readl_relaxed(ring->tqp->io_base +
68 				      HNS3_RING_RX_RING_BD_LEN_REG);
69 		dev_info(&h->pdev->dev, "RX(%d) RING BD LEN: %u\n", i, value);
70 
71 		value = readl_relaxed(ring->tqp->io_base +
72 				      HNS3_RING_RX_RING_TAIL_REG);
73 		dev_info(&h->pdev->dev, "RX(%d) RING TAIL: %u\n", i, value);
74 
75 		value = readl_relaxed(ring->tqp->io_base +
76 				      HNS3_RING_RX_RING_HEAD_REG);
77 		dev_info(&h->pdev->dev, "RX(%d) RING HEAD: %u\n", i, value);
78 
79 		value = readl_relaxed(ring->tqp->io_base +
80 				      HNS3_RING_RX_RING_FBDNUM_REG);
81 		dev_info(&h->pdev->dev, "RX(%d) RING FBDNUM: %u\n", i, value);
82 
83 		value = readl_relaxed(ring->tqp->io_base +
84 				      HNS3_RING_RX_RING_PKTNUM_RECORD_REG);
85 		dev_info(&h->pdev->dev, "RX(%d) RING PKTNUM: %u\n", i, value);
86 
87 		ring = ring_data[i].ring;
88 		base_add_h = readl_relaxed(ring->tqp->io_base +
89 					   HNS3_RING_TX_RING_BASEADDR_H_REG);
90 		base_add_l = readl_relaxed(ring->tqp->io_base +
91 					   HNS3_RING_TX_RING_BASEADDR_L_REG);
92 		dev_info(&h->pdev->dev, "TX(%d) BASE ADD: 0x%08x%08x\n", i,
93 			 base_add_h, base_add_l);
94 
95 		value = readl_relaxed(ring->tqp->io_base +
96 				      HNS3_RING_TX_RING_BD_NUM_REG);
97 		dev_info(&h->pdev->dev, "TX(%d) RING BD NUM: %u\n", i, value);
98 
99 		value = readl_relaxed(ring->tqp->io_base +
100 				      HNS3_RING_TX_RING_TC_REG);
101 		dev_info(&h->pdev->dev, "TX(%d) RING TC: %u\n", i, value);
102 
103 		value = readl_relaxed(ring->tqp->io_base +
104 				      HNS3_RING_TX_RING_TAIL_REG);
105 		dev_info(&h->pdev->dev, "TX(%d) RING TAIL: %u\n", i, value);
106 
107 		value = readl_relaxed(ring->tqp->io_base +
108 				      HNS3_RING_TX_RING_HEAD_REG);
109 		dev_info(&h->pdev->dev, "TX(%d) RING HEAD: %u\n", i, value);
110 
111 		value = readl_relaxed(ring->tqp->io_base +
112 				      HNS3_RING_TX_RING_FBDNUM_REG);
113 		dev_info(&h->pdev->dev, "TX(%d) RING FBDNUM: %u\n", i, value);
114 
115 		value = readl_relaxed(ring->tqp->io_base +
116 				      HNS3_RING_TX_RING_OFFSET_REG);
117 		dev_info(&h->pdev->dev, "TX(%d) RING OFFSET: %u\n", i, value);
118 
119 		value = readl_relaxed(ring->tqp->io_base +
120 				      HNS3_RING_TX_RING_PKTNUM_RECORD_REG);
121 		dev_info(&h->pdev->dev, "TX(%d) RING PKTNUM: %u\n\n", i,
122 			 value);
123 	}
124 
125 	return 0;
126 }
127 
128 static int hns3_dbg_queue_map(struct hnae3_handle *h)
129 {
130 	struct hns3_nic_priv *priv = h->priv;
131 	struct hns3_nic_ring_data *ring_data;
132 	int i;
133 
134 	if (!h->ae_algo->ops->get_global_queue_id)
135 		return -EOPNOTSUPP;
136 
137 	dev_info(&h->pdev->dev, "map info for queue id and vector id\n");
138 	dev_info(&h->pdev->dev,
139 		 "local queue id | global queue id | vector id\n");
140 	for (i = 0; i < h->kinfo.num_tqps; i++) {
141 		u16 global_qid;
142 
143 		global_qid = h->ae_algo->ops->get_global_queue_id(h, i);
144 		ring_data = &priv->ring_data[i];
145 		if (!ring_data || !ring_data->ring ||
146 		    !ring_data->ring->tqp_vector)
147 			continue;
148 
149 		dev_info(&h->pdev->dev,
150 			 "      %4d            %4d            %4d\n",
151 			 i, global_qid,
152 			 ring_data->ring->tqp_vector->vector_irq);
153 	}
154 
155 	return 0;
156 }
157 
158 static int hns3_dbg_bd_info(struct hnae3_handle *h, char *cmd_buf)
159 {
160 	struct hns3_nic_priv *priv = h->priv;
161 	struct hns3_nic_ring_data *ring_data;
162 	struct hns3_desc *rx_desc, *tx_desc;
163 	struct device *dev = &h->pdev->dev;
164 	struct hns3_enet_ring *ring;
165 	u32 tx_index, rx_index;
166 	u32 q_num, value;
167 	int cnt;
168 
169 	cnt = sscanf(&cmd_buf[8], "%u %u", &q_num, &tx_index);
170 	if (cnt == 2) {
171 		rx_index = tx_index;
172 	} else if (cnt != 1) {
173 		dev_err(dev, "bd info: bad command string, cnt=%d\n", cnt);
174 		return -EINVAL;
175 	}
176 
177 	if (q_num >= h->kinfo.num_tqps) {
178 		dev_err(dev, "Queue number(%u) is out of range(%u)\n", q_num,
179 			h->kinfo.num_tqps - 1);
180 		return -EINVAL;
181 	}
182 
183 	ring_data = priv->ring_data;
184 	ring  = ring_data[q_num].ring;
185 	value = readl_relaxed(ring->tqp->io_base + HNS3_RING_TX_RING_TAIL_REG);
186 	tx_index = (cnt == 1) ? value : tx_index;
187 
188 	if (tx_index >= ring->desc_num) {
189 		dev_err(dev, "bd index (%u) is out of range(%u)\n", tx_index,
190 			ring->desc_num - 1);
191 		return -EINVAL;
192 	}
193 
194 	tx_desc = &ring->desc[tx_index];
195 	dev_info(dev, "TX Queue Num: %u, BD Index: %u\n", q_num, tx_index);
196 	dev_info(dev, "(TX) addr: 0x%llx\n", tx_desc->addr);
197 	dev_info(dev, "(TX)vlan_tag: %u\n", tx_desc->tx.vlan_tag);
198 	dev_info(dev, "(TX)send_size: %u\n", tx_desc->tx.send_size);
199 	dev_info(dev, "(TX)vlan_tso: %u\n", tx_desc->tx.type_cs_vlan_tso);
200 	dev_info(dev, "(TX)l2_len: %u\n", tx_desc->tx.l2_len);
201 	dev_info(dev, "(TX)l3_len: %u\n", tx_desc->tx.l3_len);
202 	dev_info(dev, "(TX)l4_len: %u\n", tx_desc->tx.l4_len);
203 	dev_info(dev, "(TX)vlan_tag: %u\n", tx_desc->tx.outer_vlan_tag);
204 	dev_info(dev, "(TX)tv: %u\n", tx_desc->tx.tv);
205 	dev_info(dev, "(TX)vlan_msec: %u\n", tx_desc->tx.ol_type_vlan_msec);
206 	dev_info(dev, "(TX)ol2_len: %u\n", tx_desc->tx.ol2_len);
207 	dev_info(dev, "(TX)ol3_len: %u\n", tx_desc->tx.ol3_len);
208 	dev_info(dev, "(TX)ol4_len: %u\n", tx_desc->tx.ol4_len);
209 	dev_info(dev, "(TX)paylen: %u\n", tx_desc->tx.paylen);
210 	dev_info(dev, "(TX)vld_ra_ri: %u\n", tx_desc->tx.bdtp_fe_sc_vld_ra_ri);
211 	dev_info(dev, "(TX)mss: %u\n", tx_desc->tx.mss);
212 
213 	ring  = ring_data[q_num + h->kinfo.num_tqps].ring;
214 	value = readl_relaxed(ring->tqp->io_base + HNS3_RING_RX_RING_TAIL_REG);
215 	rx_index = (cnt == 1) ? value : tx_index;
216 	rx_desc	 = &ring->desc[rx_index];
217 
218 	dev_info(dev, "RX Queue Num: %u, BD Index: %u\n", q_num, rx_index);
219 	dev_info(dev, "(RX)addr: 0x%llx\n", rx_desc->addr);
220 	dev_info(dev, "(RX)pkt_len: %u\n", rx_desc->rx.pkt_len);
221 	dev_info(dev, "(RX)size: %u\n", rx_desc->rx.size);
222 	dev_info(dev, "(RX)rss_hash: %u\n", rx_desc->rx.rss_hash);
223 	dev_info(dev, "(RX)fd_id: %u\n", rx_desc->rx.fd_id);
224 	dev_info(dev, "(RX)vlan_tag: %u\n", rx_desc->rx.vlan_tag);
225 	dev_info(dev, "(RX)o_dm_vlan_id_fb: %u\n", rx_desc->rx.o_dm_vlan_id_fb);
226 	dev_info(dev, "(RX)ot_vlan_tag: %u\n", rx_desc->rx.ot_vlan_tag);
227 	dev_info(dev, "(RX)bd_base_info: %u\n", rx_desc->rx.bd_base_info);
228 
229 	return 0;
230 }
231 
232 static void hns3_dbg_help(struct hnae3_handle *h)
233 {
234 #define HNS3_DBG_BUF_LEN 256
235 
236 	char printf_buf[HNS3_DBG_BUF_LEN];
237 
238 	dev_info(&h->pdev->dev, "available commands\n");
239 	dev_info(&h->pdev->dev, "queue info [number]\n");
240 	dev_info(&h->pdev->dev, "queue map\n");
241 	dev_info(&h->pdev->dev, "bd info [q_num] <bd index>\n");
242 
243 	if (!hns3_is_phys_func(h->pdev))
244 		return;
245 
246 	dev_info(&h->pdev->dev, "dump fd tcam\n");
247 	dev_info(&h->pdev->dev, "dump tc\n");
248 	dev_info(&h->pdev->dev, "dump tm map [q_num]\n");
249 	dev_info(&h->pdev->dev, "dump tm\n");
250 	dev_info(&h->pdev->dev, "dump qos pause cfg\n");
251 	dev_info(&h->pdev->dev, "dump qos pri map\n");
252 	dev_info(&h->pdev->dev, "dump qos buf cfg\n");
253 	dev_info(&h->pdev->dev, "dump mng tbl\n");
254 	dev_info(&h->pdev->dev, "dump reset info\n");
255 	dev_info(&h->pdev->dev, "dump ncl_config <offset> <length>(in hex)\n");
256 	dev_info(&h->pdev->dev, "dump mac tnl status\n");
257 
258 	memset(printf_buf, 0, HNS3_DBG_BUF_LEN);
259 	strncat(printf_buf, "dump reg [[bios common] [ssu <prt_id>]",
260 		HNS3_DBG_BUF_LEN - 1);
261 	strncat(printf_buf + strlen(printf_buf),
262 		" [igu egu <prt_id>] [rpu <tc_queue_num>]",
263 		HNS3_DBG_BUF_LEN - strlen(printf_buf) - 1);
264 	strncat(printf_buf + strlen(printf_buf),
265 		" [rtc] [ppp] [rcb] [tqp <q_num>]]\n",
266 		HNS3_DBG_BUF_LEN - strlen(printf_buf) - 1);
267 	dev_info(&h->pdev->dev, "%s", printf_buf);
268 
269 	memset(printf_buf, 0, HNS3_DBG_BUF_LEN);
270 	strncat(printf_buf, "dump reg dcb [port_id] [pri_id] [pg_id]",
271 		HNS3_DBG_BUF_LEN - 1);
272 	strncat(printf_buf + strlen(printf_buf), " [rq_id] [nq_id] [qset_id]\n",
273 		HNS3_DBG_BUF_LEN - strlen(printf_buf) - 1);
274 	dev_info(&h->pdev->dev, "%s", printf_buf);
275 }
276 
277 static ssize_t hns3_dbg_cmd_read(struct file *filp, char __user *buffer,
278 				 size_t count, loff_t *ppos)
279 {
280 	int uncopy_bytes;
281 	char *buf;
282 	int len;
283 
284 	if (*ppos != 0)
285 		return 0;
286 
287 	if (count < HNS3_DBG_READ_LEN)
288 		return -ENOSPC;
289 
290 	buf = kzalloc(HNS3_DBG_READ_LEN, GFP_KERNEL);
291 	if (!buf)
292 		return -ENOMEM;
293 
294 	len = snprintf(buf, HNS3_DBG_READ_LEN, "%s\n",
295 		       "Please echo help to cmd to get help information");
296 	uncopy_bytes = copy_to_user(buffer, buf, len);
297 
298 	kfree(buf);
299 
300 	if (uncopy_bytes)
301 		return -EFAULT;
302 
303 	return (*ppos = len);
304 }
305 
306 static ssize_t hns3_dbg_cmd_write(struct file *filp, const char __user *buffer,
307 				  size_t count, loff_t *ppos)
308 {
309 	struct hnae3_handle *handle = filp->private_data;
310 	struct hns3_nic_priv *priv  = handle->priv;
311 	char *cmd_buf, *cmd_buf_tmp;
312 	int uncopied_bytes;
313 	int ret = 0;
314 
315 	if (*ppos != 0)
316 		return 0;
317 
318 	/* Judge if the instance is being reset. */
319 	if (!test_bit(HNS3_NIC_STATE_INITED, &priv->state) ||
320 	    test_bit(HNS3_NIC_STATE_RESETTING, &priv->state))
321 		return 0;
322 
323 	cmd_buf = kzalloc(count + 1, GFP_KERNEL);
324 	if (!cmd_buf)
325 		return count;
326 
327 	uncopied_bytes = copy_from_user(cmd_buf, buffer, count);
328 	if (uncopied_bytes) {
329 		kfree(cmd_buf);
330 		return -EFAULT;
331 	}
332 
333 	cmd_buf[count] = '\0';
334 
335 	cmd_buf_tmp = strchr(cmd_buf, '\n');
336 	if (cmd_buf_tmp) {
337 		*cmd_buf_tmp = '\0';
338 		count = cmd_buf_tmp - cmd_buf + 1;
339 	}
340 
341 	if (strncmp(cmd_buf, "help", 4) == 0)
342 		hns3_dbg_help(handle);
343 	else if (strncmp(cmd_buf, "queue info", 10) == 0)
344 		ret = hns3_dbg_queue_info(handle, cmd_buf);
345 	else if (strncmp(cmd_buf, "queue map", 9) == 0)
346 		ret = hns3_dbg_queue_map(handle);
347 	else if (strncmp(cmd_buf, "bd info", 7) == 0)
348 		ret = hns3_dbg_bd_info(handle, cmd_buf);
349 	else if (handle->ae_algo->ops->dbg_run_cmd)
350 		ret = handle->ae_algo->ops->dbg_run_cmd(handle, cmd_buf);
351 	else
352 		ret = -EOPNOTSUPP;
353 
354 	if (ret)
355 		hns3_dbg_help(handle);
356 
357 	kfree(cmd_buf);
358 	cmd_buf = NULL;
359 
360 	return count;
361 }
362 
363 static const struct file_operations hns3_dbg_cmd_fops = {
364 	.owner = THIS_MODULE,
365 	.open  = simple_open,
366 	.read  = hns3_dbg_cmd_read,
367 	.write = hns3_dbg_cmd_write,
368 };
369 
370 void hns3_dbg_init(struct hnae3_handle *handle)
371 {
372 	const char *name = pci_name(handle->pdev);
373 	struct dentry *pfile;
374 
375 	handle->hnae3_dbgfs = debugfs_create_dir(name, hns3_dbgfs_root);
376 	if (!handle->hnae3_dbgfs)
377 		return;
378 
379 	pfile = debugfs_create_file("cmd", 0600, handle->hnae3_dbgfs, handle,
380 				    &hns3_dbg_cmd_fops);
381 	if (!pfile) {
382 		debugfs_remove_recursive(handle->hnae3_dbgfs);
383 		handle->hnae3_dbgfs = NULL;
384 		dev_warn(&handle->pdev->dev, "create file for %s fail\n",
385 			 name);
386 	}
387 }
388 
389 void hns3_dbg_uninit(struct hnae3_handle *handle)
390 {
391 	debugfs_remove_recursive(handle->hnae3_dbgfs);
392 	handle->hnae3_dbgfs = NULL;
393 }
394 
395 void hns3_dbg_register_debugfs(const char *debugfs_dir_name)
396 {
397 	hns3_dbgfs_root = debugfs_create_dir(debugfs_dir_name, NULL);
398 	if (!hns3_dbgfs_root) {
399 		pr_warn("Register debugfs for %s fail\n", debugfs_dir_name);
400 		return;
401 	}
402 }
403 
404 void hns3_dbg_unregister_debugfs(void)
405 {
406 	debugfs_remove_recursive(hns3_dbgfs_root);
407 	hns3_dbgfs_root = NULL;
408 }
409