Commit fd0fb612 authored by David S. Miller's avatar David S. Miller
Browse files

Merge branch 'hns3-debugfs' 

Salil Mehta says:

====================
net: hns3: Adds support of debugfs to HNS3 driver

This patchset adds support of debugfs to the HNS3 driver.

Support has been added to query info related to below items:
1. Queue related ("echo queue info [queue no] > cmd")
2. Flow Director ("echo dump fd tcam > cmd")
3. TC config ("echo dump tc > cmd")
4. Transmit Module/Scheduler ("echo dump tm > cmd")
5. QoS pause ("echo dump qos pause cfg > cmd")
6. QoS buffer ("echo dump qos pri map > cmd")
7. QoS prio map ("echo dump qos buf cfg > cmd")

NOTE: Above commands are *read-only* and are only intended to
query the information from the SoC(and dump inside the kernel,
for now) and in no way tries to perform write operations for
the purpose of configuration etc.

Change Log
----------
V1-->V2:
   * Addressed the comments provided by Jakub Kicinski.
     1. Removed the .rej files mistakenly made part of Flow Director patch.
        Link: https://lkml.org/lkml/2018/11/20/249
     2. Added command summary in the cover letter
        Link: https://lkml.org/lkml/2018/11/22/1


====================

Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parents 53b44cb9 7d9d7f88

drivers/net/ethernet/hisilicon/hns3/Makefile

+1 −1
Original line number Diff line number Diff line
@@ -9,6 +9,6 @@ obj-$(CONFIG_HNS3) += hns3vf/ 
obj-$(CONFIG_HNS3) += hnae3.o



obj-$(CONFIG_HNS3_ENET) += hns3.o

hns3-objs = hns3_enet.o hns3_ethtool.o

hns3-objs = hns3_enet.o hns3_ethtool.o hns3_debugfs.o



hns3-$(CONFIG_HNS3_DCB) += hns3_dcbnl.o

drivers/net/ethernet/hisilicon/hns3/hnae3.h

+2 −0
Original line number Diff line number Diff line
@@ -453,6 +453,7 @@ struct hnae3_ae_ops { 
				struct ethtool_rxnfc *cmd, u32 *rule_locs);

	int (*restore_fd_rules)(struct hnae3_handle *handle);

	void (*enable_fd)(struct hnae3_handle *handle, bool enable);

	int (*dbg_run_cmd)(struct hnae3_handle *handle, char *cmd_buf);

	pci_ers_result_t (*process_hw_error)(struct hnae3_ae_dev *ae_dev);

	bool (*get_hw_reset_stat)(struct hnae3_handle *handle);

	bool (*ae_dev_resetting)(struct hnae3_handle *handle);
@@ -566,6 +567,7 @@ struct hnae3_handle { 
	u32 numa_node_mask;	/* for multi-chip support */



	u8 netdev_flags;

	struct dentry *hnae3_dbgfs;

};



#define hnae3_set_field(origin, mask, shift, val) \

drivers/net/ethernet/hisilicon/hns3/hns3_debugfs.c

0 → 100644
+265 −0
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0+

/* Copyright (c) 2018-2019 Hisilicon Limited. */



#include <linux/debugfs.h>

#include <linux/device.h>



#include "hnae3.h"

#include "hns3_enet.h"



#define HNS3_DBG_READ_LEN 256



static struct dentry *hns3_dbgfs_root;



static int hns3_dbg_queue_info(struct hnae3_handle *h, char *cmd_buf)

{

	struct hns3_nic_priv *priv = h->priv;

	struct hns3_nic_ring_data *ring_data;

	struct hns3_enet_ring *ring;

	u32 base_add_l, base_add_h;

	u32 queue_num, queue_max;

	u32 value, i = 0;

	int cnt;



	if (!priv->ring_data) {

		dev_err(&h->pdev->dev, "ring_data is NULL\n");

		return -EFAULT;

	}



	queue_max = h->kinfo.num_tqps;

	cnt = kstrtouint(&cmd_buf[11], 0, &queue_num);

	if (cnt)

		queue_num = 0;

	else

		queue_max = queue_num + 1;



	dev_info(&h->pdev->dev, "queue info\n");



	if (queue_num >= h->kinfo.num_tqps) {

		dev_err(&h->pdev->dev,

			"Queue number(%u) is out of range(%u)\n", queue_num,

			h->kinfo.num_tqps - 1);

		return -EINVAL;

	}



	ring_data = priv->ring_data;

	for (i = queue_num; i < queue_max; i++) {

		/* Each cycle needs to determine whether the instance is reset,

		 * to prevent reference to invalid memory. And need to ensure

		 * that the following code is executed within 100ms.

		 */

		if (test_bit(HNS3_NIC_STATE_INITED, &priv->state) ||

		    test_bit(HNS3_NIC_STATE_RESETTING, &priv->state))

			return -EPERM;



		ring = ring_data[i + h->kinfo.num_tqps].ring;

		base_add_h = readl_relaxed(ring->tqp->io_base +

					   HNS3_RING_RX_RING_BASEADDR_H_REG);

		base_add_l = readl_relaxed(ring->tqp->io_base +

					   HNS3_RING_RX_RING_BASEADDR_L_REG);

		dev_info(&h->pdev->dev, "RX(%d) BASE ADD: 0x%08x%08x\n", i,

			 base_add_h, base_add_l);



		value = readl_relaxed(ring->tqp->io_base +

				      HNS3_RING_RX_RING_BD_NUM_REG);

		dev_info(&h->pdev->dev, "RX(%d) RING BD NUM: %u\n", i, value);



		value = readl_relaxed(ring->tqp->io_base +

				      HNS3_RING_RX_RING_BD_LEN_REG);

		dev_info(&h->pdev->dev, "RX(%d) RING BD LEN: %u\n", i, value);



		value = readl_relaxed(ring->tqp->io_base +

				      HNS3_RING_RX_RING_TAIL_REG);

		dev_info(&h->pdev->dev, "RX(%d) RING TAIL: %u\n", i, value);



		value = readl_relaxed(ring->tqp->io_base +

				      HNS3_RING_RX_RING_HEAD_REG);

		dev_info(&h->pdev->dev, "RX(%d) RING HEAD: %u\n", i, value);



		value = readl_relaxed(ring->tqp->io_base +

				      HNS3_RING_RX_RING_FBDNUM_REG);

		dev_info(&h->pdev->dev, "RX(%d) RING FBDNUM: %u\n", i, value);



		value = readl_relaxed(ring->tqp->io_base +

				      HNS3_RING_RX_RING_PKTNUM_RECORD_REG);

		dev_info(&h->pdev->dev, "RX(%d) RING PKTNUM: %u\n", i, value);



		ring = ring_data[i].ring;

		base_add_h = readl_relaxed(ring->tqp->io_base +

					   HNS3_RING_TX_RING_BASEADDR_H_REG);

		base_add_l = readl_relaxed(ring->tqp->io_base +

					   HNS3_RING_TX_RING_BASEADDR_L_REG);

		dev_info(&h->pdev->dev, "TX(%d) BASE ADD: 0x%08x%08x\n", i,

			 base_add_h, base_add_l);



		value = readl_relaxed(ring->tqp->io_base +

				      HNS3_RING_TX_RING_BD_NUM_REG);

		dev_info(&h->pdev->dev, "TX(%d) RING BD NUM: %u\n", i, value);



		value = readl_relaxed(ring->tqp->io_base +

				      HNS3_RING_TX_RING_TC_REG);

		dev_info(&h->pdev->dev, "TX(%d) RING TC: %u\n", i, value);



		value = readl_relaxed(ring->tqp->io_base +

				      HNS3_RING_TX_RING_TAIL_REG);

		dev_info(&h->pdev->dev, "TX(%d) RING TAIL: %u\n", i, value);



		value = readl_relaxed(ring->tqp->io_base +

				      HNS3_RING_TX_RING_HEAD_REG);

		dev_info(&h->pdev->dev, "TX(%d) RING HEAD: %u\n", i, value);



		value = readl_relaxed(ring->tqp->io_base +

				      HNS3_RING_TX_RING_FBDNUM_REG);

		dev_info(&h->pdev->dev, "TX(%d) RING FBDNUM: %u\n", i, value);



		value = readl_relaxed(ring->tqp->io_base +

				      HNS3_RING_TX_RING_OFFSET_REG);

		dev_info(&h->pdev->dev, "TX(%d) RING OFFSET: %u\n", i, value);



		value = readl_relaxed(ring->tqp->io_base +

				      HNS3_RING_TX_RING_PKTNUM_RECORD_REG);

		dev_info(&h->pdev->dev, "TX(%d) RING PKTNUM: %u\n\n", i,

			 value);

	}



	return 0;

}



static void hns3_dbg_help(struct hnae3_handle *h)

{

	dev_info(&h->pdev->dev, "available commands\n");

	dev_info(&h->pdev->dev, "queue info [number]\n");

	dev_info(&h->pdev->dev, "dump fd tcam\n");

	dev_info(&h->pdev->dev, "dump tc\n");

	dev_info(&h->pdev->dev, "dump tm\n");

	dev_info(&h->pdev->dev, "dump qos pause cfg\n");

	dev_info(&h->pdev->dev, "dump qos pri map\n");

	dev_info(&h->pdev->dev, "dump qos buf cfg\n");

}



static ssize_t hns3_dbg_cmd_read(struct file *filp, char __user *buffer,

				 size_t count, loff_t *ppos)

{

	int uncopy_bytes;

	char *buf;

	int len;



	if (*ppos != 0)

		return 0;



	if (count < HNS3_DBG_READ_LEN)

		return -ENOSPC;



	buf = kzalloc(HNS3_DBG_READ_LEN, GFP_KERNEL);

	if (!buf)

		return -ENOMEM;



	len = snprintf(buf, HNS3_DBG_READ_LEN, "%s\n",

		       "Please echo help to cmd to get help information");

	uncopy_bytes = copy_to_user(buffer, buf, len);



	kfree(buf);



	if (uncopy_bytes)

		return -EFAULT;



	return (*ppos = len);

}



static ssize_t hns3_dbg_cmd_write(struct file *filp, const char __user *buffer,

				  size_t count, loff_t *ppos)

{

	struct hnae3_handle *handle = filp->private_data;

	struct hns3_nic_priv *priv  = handle->priv;

	char *cmd_buf, *cmd_buf_tmp;

	int uncopied_bytes;

	int ret = 0;



	if (*ppos != 0)

		return 0;



	/* Judge if the instance is being reset. */

	if (test_bit(HNS3_NIC_STATE_INITED, &priv->state) ||

	    test_bit(HNS3_NIC_STATE_RESETTING, &priv->state))

		return 0;



	cmd_buf = kzalloc(count + 1, GFP_KERNEL);

	if (!cmd_buf)

		return count;



	uncopied_bytes = copy_from_user(cmd_buf, buffer, count);

	if (uncopied_bytes) {

		kfree(cmd_buf);

		return -EFAULT;

	}



	cmd_buf[count] = '\0';



	cmd_buf_tmp = strchr(cmd_buf, '\n');

	if (cmd_buf_tmp) {

		*cmd_buf_tmp = '\0';

		count = cmd_buf_tmp - cmd_buf + 1;

	}



	if (strncmp(cmd_buf, "help", 4) == 0)

		hns3_dbg_help(handle);

	else if (strncmp(cmd_buf, "queue info", 10) == 0)

		ret = hns3_dbg_queue_info(handle, cmd_buf);

	else if (handle->ae_algo->ops->dbg_run_cmd)

		ret = handle->ae_algo->ops->dbg_run_cmd(handle, cmd_buf);



	if (ret)

		hns3_dbg_help(handle);



	kfree(cmd_buf);

	cmd_buf = NULL;



	return count;

}



static const struct file_operations hns3_dbg_cmd_fops = {

	.owner = THIS_MODULE,

	.open  = simple_open,

	.read  = hns3_dbg_cmd_read,

	.write = hns3_dbg_cmd_write,

};



void hns3_dbg_init(struct hnae3_handle *handle)

{

	const char *name = pci_name(handle->pdev);

	struct dentry *pfile;



	handle->hnae3_dbgfs = debugfs_create_dir(name, hns3_dbgfs_root);

	if (!handle->hnae3_dbgfs)

		return;



	pfile = debugfs_create_file("cmd", 0600, handle->hnae3_dbgfs, handle,

				    &hns3_dbg_cmd_fops);

	if (!pfile) {

		debugfs_remove_recursive(handle->hnae3_dbgfs);

		handle->hnae3_dbgfs = NULL;

		dev_warn(&handle->pdev->dev, "create file for %s fail\n",

			 name);

	}

}



void hns3_dbg_uninit(struct hnae3_handle *handle)

{

	debugfs_remove_recursive(handle->hnae3_dbgfs);

	handle->hnae3_dbgfs = NULL;

}



void hns3_dbg_register_debugfs(const char *debugfs_dir_name)

{

	hns3_dbgfs_root = debugfs_create_dir(debugfs_dir_name, NULL);

	if (!hns3_dbgfs_root) {

		pr_warn("Register debugfs for %s fail\n", debugfs_dir_name);

		return;

	}

}



void hns3_dbg_unregister_debugfs(void)

{

	debugfs_remove_recursive(hns3_dbgfs_root);

	hns3_dbgfs_root = NULL;

}

drivers/net/ethernet/hisilicon/hns3/hns3_enet.c

+15 −2
Original line number Diff line number Diff line
@@ -3620,6 +3620,8 @@ static int hns3_client_init(struct hnae3_handle *handle) 


	hns3_dcbnl_setup(handle);



	hns3_dbg_init(handle);



	/* MTU range: (ETH_MIN_MTU(kernel default) - 9702) */

	netdev->max_mtu = HNS3_MAX_MTU;
@@ -3676,6 +3678,8 @@ static void hns3_client_uninit(struct hnae3_handle *handle, bool reset) 


	hns3_put_ring_config(priv);



	hns3_dbg_uninit(handle);



	priv->ring_data = NULL;



out_netdev_free:
@@ -4245,14 +4249,22 @@ static int __init hns3_init_module(void) 


	INIT_LIST_HEAD(&client.node);



	hns3_dbg_register_debugfs(hns3_driver_name);



	ret = hnae3_register_client(&client);

	if (ret)

		return ret;

		goto err_reg_client;



	ret = pci_register_driver(&hns3_driver);

	if (ret)

		hnae3_unregister_client(&client);

		goto err_reg_driver;



	return ret;



err_reg_driver:

	hnae3_unregister_client(&client);

err_reg_client:

	hns3_dbg_unregister_debugfs();

	return ret;

}

module_init(hns3_init_module);
@@ -4265,6 +4277,7 @@ static void __exit hns3_exit_module(void) 
{

	pci_unregister_driver(&hns3_driver);

	hnae3_unregister_client(&client);

	hns3_dbg_unregister_debugfs();

}

module_exit(hns3_exit_module);

drivers/net/ethernet/hisilicon/hns3/hns3_enet.h

+4 −0
Original line number Diff line number Diff line
@@ -683,4 +683,8 @@ void hns3_dcbnl_setup(struct hnae3_handle *handle); 
static inline void hns3_dcbnl_setup(struct hnae3_handle *handle) {}

#endif



void hns3_dbg_init(struct hnae3_handle *handle);

void hns3_dbg_uninit(struct hnae3_handle *handle);

void hns3_dbg_register_debugfs(const char *debugfs_dir_name);

void hns3_dbg_unregister_debugfs(void);

#endif

CRA Git | Maintained and supported by SUSTech CRA and CCSE