Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit b2292360 authored by liuzhongzhu's avatar liuzhongzhu Committed by David S. Miller
Browse files

net: hns3: Add debugfs framework registration 



Add the debugfs framework to the driver and create a debugfs
command interface for each device.

example command:
"echo queue info > cmd" Query the packet forwarding queue information.

Signed-off-by: default avatarliuzhongzhu <liuzhongzhu@huawei.com>
Signed-off-by: default avatarSalil Mehta <salil.mehta@huawei.com>
Signed-off-by: default avatarDavid S. Miller <davem@davemloft.net>
parent 53b44cb9

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

+1 −0
Original line number Diff line number Diff line
@@ -566,6 +566,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
+136 −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 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");

}



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;

	char *cmd_buf, *cmd_buf_tmp;

	int uncopied_bytes;

	int ret = 0;



	if (*ppos != 0)

		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);



	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