Skip to contentSkip to conversation

rsxx: Adding in debugfs entries.

PATCH In review Philip J. Kelleher 2 participants 5 messages May 2, 2013 Block layer

lore
Share & tools
lore
#0 lore raw

PATCH 1/8 rsxx: Adding in debugfs entries.

From: Philip J Kelleher <[email protected]>

Adding in some debugfs entries to help with debugging and testing code.

-------------------------------------------------------------------------------

drivers/block/rsxx/core.c +195 -0
diff -uprN -X linux-block-vanilla/Documentation/dontdiff linux-block-vanilla/drivers/block/rsxx/core.c linux-block/drivers/block/rsxx/core.c
@@ -31,6 +31,8 @@
 #include <linux/slab.h>
 #include <linux/bitops.h>
 #include <linux/delay.h>
+#include <linux/debugfs.h>
+#include <linux/seq_file.h>
 
 #include <linux/genhd.h>
 #include <linux/idr.h>
@@ -39,6 +41,7 @@
 #include "rsxx_cfg.h"
 
 #define NO_LEGACY 0
+#define DEBUGFS_NULL NULL
 
 MODULE_DESCRIPTION("IBM FlashSystem 70/80 PCIe SSD Device Driver");
 MODULE_AUTHOR("Joshua Morris/Philip Kelleher, IBM");
@@ -52,6 +55,191 @@ MODULE_PARM_DESC(force_legacy, "Force th
 static DEFINE_IDA(rsxx_disk_ida);
 static DEFINE_SPINLOCK(rsxx_ida_lock);
 
+/* --------------------Debugfs Setup ------------------- */
+
+static struct dentry *rsxx_debugfs_root = DEBUGFS_NULL;
+
+static int rsxx_attr_pci_regs_show(struct seq_file *m, void *p)
+{
+	struct rsxx_cardinfo *card = m->private;
+
+	seq_printf(m, "HWID		0x%08x\n",
+					ioread32(card->regmap + HWID));
+	seq_printf(m, "SCRATCH		0x%08x\n",
+					ioread32(card->regmap + SCRATCH));
+	seq_printf(m, "ISR		0x%08x\n",
+					ioread32(card->regmap + ISR));
+	seq_printf(m, "IER		0x%08x\n",
+					ioread32(card->regmap + IER));
+	seq_printf(m, "IPR		0x%08x\n",
+					ioread32(card->regmap + IPR));
+	seq_printf(m, "CREG_CMD		0x%08x\n",
+					ioread32(card->regmap + CREG_CMD));
+	seq_printf(m, "CREG_ADD		0x%08x\n",
+					ioread32(card->regmap + CREG_ADD));
+	seq_printf(m, "CREG_CNT		0x%08x\n",
+					ioread32(card->regmap + CREG_CNT));
+	seq_printf(m, "CREG_STAT	0x%08x\n",
+					ioread32(card->regmap + CREG_STAT));
+	seq_printf(m, "CREG_DATA0	0x%08x\n",
+					ioread32(card->regmap + CREG_DATA0));
+	seq_printf(m, "CREG_DATA1	0x%08x\n",
+					ioread32(card->regmap + CREG_DATA1));
+	seq_printf(m, "CREG_DATA2	0x%08x\n",
+					ioread32(card->regmap + CREG_DATA2));
+	seq_printf(m, "CREG_DATA3	0x%08x\n",
+					ioread32(card->regmap + CREG_DATA3));
+	seq_printf(m, "CREG_DATA4	0x%08x\n",
+					ioread32(card->regmap + CREG_DATA4));
+	seq_printf(m, "CREG_DATA5	0x%08x\n",
+					ioread32(card->regmap + CREG_DATA5));
+	seq_printf(m, "CREG_DATA6	0x%08x\n",
+					ioread32(card->regmap + CREG_DATA6));
+	seq_printf(m, "CREG_DATA7	0x%08x\n",
+					ioread32(card->regmap + CREG_DATA7));
+	seq_printf(m, "INTR_COAL	0x%08x\n",
+					ioread32(card->regmap + INTR_COAL));
+	seq_printf(m, "HW_ERROR		0x%08x\n",
+					ioread32(card->regmap + HW_ERROR));
+	seq_printf(m, "DEBUG0		0x%08x\n",
+					ioread32(card->regmap + PCI_DEBUG0));
+	seq_printf(m, "DEBUG1		0x%08x\n",
+					ioread32(card->regmap + PCI_DEBUG1));
+	seq_printf(m, "DEBUG2		0x%08x\n",
+					ioread32(card->regmap + PCI_DEBUG2));
+	seq_printf(m, "DEBUG3		0x%08x\n",
+					ioread32(card->regmap + PCI_DEBUG3));
+	seq_printf(m, "DEBUG4		0x%08x\n",
+					ioread32(card->regmap + PCI_DEBUG4));
+	seq_printf(m, "DEBUG5		0x%08x\n",
+					ioread32(card->regmap + PCI_DEBUG5));
+	seq_printf(m, "DEBUG6		0x%08x\n",
+					ioread32(card->regmap + PCI_DEBUG6));
+	seq_printf(m, "DEBUG7		0x%08x\n",
+					ioread32(card->regmap + PCI_DEBUG7));
+	seq_printf(m, "RECONFIG		0x%08x\n",
+					ioread32(card->regmap + PCI_RECONFIG));
+
+	return 0;
+}
+
+static int rsxx_attr_stats_show(struct seq_file *m, void *p)
+{
+	struct rsxx_cardinfo *card = m->private;
+	int i;
+
+	for (i = 0; i < card->n_targets; i++) {
+		seq_printf(m, "Ctrl %d CRC Errors	= %d\n",
+				i, card->ctrl[i].stats.crc_errors);
+		seq_printf(m, "Ctrl %d Hard Errors	= %d\n",
+				i, card->ctrl[i].stats.crc_errors);
+		seq_printf(m, "Ctrl %d Soft Errors	= %d\n",
+				i, card->ctrl[i].stats.crc_errors);
+		seq_printf(m, "Ctrl %d Writes Issued	= %d\n",
+				i, card->ctrl[i].stats.crc_errors);
+		seq_printf(m, "Ctrl %d Writes Failed	= %d\n",
+				i, card->ctrl[i].stats.crc_errors);
+		seq_printf(m, "Ctrl %d Reads Issued	= %d\n",
+				i, card->ctrl[i].stats.crc_errors);
+		seq_printf(m, "Ctrl %d Reads Failed	= %d\n",
+				i, card->ctrl[i].stats.crc_errors);
+		seq_printf(m, "Ctrl %d Reads Retried	= %d\n",
+				i, card->ctrl[i].stats.crc_errors);
+		seq_printf(m, "Ctrl %d Discards Issued	= %d\n",
+				i, card->ctrl[i].stats.crc_errors);
+		seq_printf(m, "Ctrl %d Discards Failed	= %d\n",
+				i, card->ctrl[i].stats.crc_errors);
+		seq_printf(m, "Ctrl %d DMA SW Errors	= %d\n",
+				i, card->ctrl[i].stats.crc_errors);
+		seq_printf(m, "Ctrl %d DMA HW Faults	= %d\n",
+				i, card->ctrl[i].stats.crc_errors);
+		seq_printf(m, "Ctrl %d DMAs Cancelled	= %d\n",
+				i, card->ctrl[i].stats.crc_errors);
+		seq_printf(m, "Ctrl %d SW Queue Depth	= %d\n",
+				i, card->ctrl[i].stats.crc_errors);
+		seq_printf(m, "Ctrl %d HW Queue Depth	= %d\n",
+				i, card->ctrl[i].stats.crc_errors);
+	}
+
+	return 0;
+}
+
+static int rsxx_attr_stats_open(struct inode *inode, struct file *file)
+{
+	return single_open(file, rsxx_attr_stats_show, inode->i_private);
+}
+
+static int rsxx_attr_pci_regs_open(struct inode *inode, struct file *file)
+{
+	return single_open(file, rsxx_attr_pci_regs_show, inode->i_private);
+}
+
+static const struct file_operations debugfs_stats_fops = {
+	.owner		= THIS_MODULE,
+	.open		= rsxx_attr_stats_open,
+	.read		= seq_read,
+	.llseek		= seq_lseek,
+	.release	= single_release,
+};
+
+static const struct file_operations debugfs_pci_regs_fops = {
+	.owner		= THIS_MODULE,
+	.open		= rsxx_attr_pci_regs_open,
+	.read		= seq_read,
+	.llseek		= seq_lseek,
+	.release	= single_release,
+};
+
+static void rsxx_debugfs_dev_new(struct rsxx_cardinfo *card)
+{
+	if (!rsxx_debugfs_root)
+		return;
+
+	card->debugfs_dir = debugfs_create_dir(card->gendisk->disk_name,
+					       rsxx_debugfs_root);
+	if (!card->debugfs_dir)
+		return;
+
+	card->debugfs_stats = debugfs_create_file("stats", S_IRUGO,
+						card->debugfs_dir, card,
+						&debugfs_stats_fops);
+	if (!card->debugfs_stats)
+		return;
+
+	card->debugfs_pci_regs = debugfs_create_file("pci_regs", S_IRUGO,
+						card->debugfs_dir, card,
+						&debugfs_pci_regs_fops);
+	if (!card->debugfs_pci_regs)
+		return;
+}
+
+static void rsxx_debugfs_dev_remove(struct rsxx_cardinfo *card)
+{
+	debugfs_remove(card->debugfs_stats);
+	card->debugfs_stats = NULL;
+
+	debugfs_remove(card->debugfs_pci_regs);
+	card->debugfs_pci_regs = NULL;
+
+	debugfs_remove(card->debugfs_dir);
+	card->debugfs_dir = NULL;
+}
+
+static void rsxx_debugfs_init(void)
+{
+	rsxx_debugfs_root = debugfs_create_dir(DRIVER_NAME, NULL);
+	if (!rsxx_debugfs_root)
+		return;
+}
+
+static void rsxx_debugfs_destroy(void)
+{
+	if (!rsxx_debugfs_root)
+		return;
+	debugfs_remove(rsxx_debugfs_root);
+	rsxx_debugfs_root = NULL;
+}
+
 /*----------------- Interrupt Control & Handling -------------------*/
 
 static void rsxx_mask_interrupts(struct rsxx_cardinfo *card)
@@ -685,6 +873,10 @@ static int rsxx_pci_probe(struct pci_dev
 
 	rsxx_attach_dev(card);
 
+	/************* Setup Debugfs *************/
+	rsxx_debugfs_init();
+	rsxx_debugfs_dev_new(card);
+
 	return 0;
 
 failed_create_dev:
@@ -756,6 +948,9 @@ static void rsxx_pci_remove(struct pci_d
 	/* Prevent work_structs from re-queuing themselves. */
 	card->halt = 1;
 
+	rsxx_debugfs_dev_remove(card);
+	rsxx_debugfs_destroy();
+
 	free_irq(dev->irq, card);
 
 	if (!force_legacy)
drivers/block/rsxx/rsxx_priv.h +5 -0
diff -uprN -X linux-block-vanilla/Documentation/dontdiff linux-block-vanilla/drivers/block/rsxx/rsxx_priv.h linux-block/drivers/block/rsxx/rsxx_priv.h
@@ -181,6 +181,11 @@ struct rsxx_cardinfo {
 
 	int			n_targets;
 	struct rsxx_dma_ctrl	*ctrl;
+
+	/* Debugfs Variables */
+	struct dentry		*debugfs_dir;
+	struct dentry		*debugfs_stats;
+	struct dentry		*debugfs_pci_regs;
 };
 
 enum rsxx_pci_regmap {
maintainer
#1 lore raw

drivers/block/rsxx/core.c

Quoted 4 lines · Philip J. Kelleher

#define NO_LEGACY 0

drivers/block/rsxx/core.c +2 -0
+#define DEBUGFS_NULL NULL
 
+static struct dentry *rsxx_debugfs_root = DEBUGFS_NULL;

What's the point of DEBUGFS_NULL?

Signature · 1 line
Jens Axboe
#2 lore raw
Quoted 7 lines · Jens Axboe

drivers/block/rsxx/core.c

Quoted 4 lines · Philip J. Kelleher

#define NO_LEGACY 0

drivers/block/rsxx/core.c +2 -0
+#define DEBUGFS_NULL NULL
 
+static struct dentry *rsxx_debugfs_root = DEBUGFS_NULL;

What's the point of DEBUGFS_NULL?

Well, orginally, I had rsxx_debugfs_root initialized to NULL but the checkpatch script told me not to initialize directly with 0 or NULL. So my solution is the #define macro.

Quoted 4 lines
Signature · 2 lines
-- 
Jens Axboe

Thanks
-Philip Kelleher

maintainer
#3 lore raw
Quoted 5 lines · Philip J. Kelleher
Quoted 4 lines · Jens Axboe
Quoted 3 lines · Philip J. Kelleher

#define NO_LEGACY 0
+#define DEBUGFS_NULL NULL

Quoted 7 lines
Quoted 3 lines
Quoted 1 line

+static struct dentry *rsxx_debugfs_root = DEBUGFS_NULL;

What's the point of DEBUGFS_NULL?

Well, orginally, I had rsxx_debugfs_root initialized to NULL but the checkpatch script told me not to initialize directly with 0 or NULL. So my solution is the #define macro.

Well, it's a static variable. The reason checkpatch tells you not to initialize it to NULL/0 is because the bss is automatically zeroed.

Signature · 1 line
Jens Axboe
#4 lore raw
Quoted 10 lines · Jens Axboe
Quoted 9 lines · Philip J. Kelleher
Quoted 7 lines · Jens Axboe

drivers/block/rsxx/core.c

Quoted 4 lines · Philip J. Kelleher

#define NO_LEGACY 0

drivers/block/rsxx/core.c +2 -0
+#define DEBUGFS_NULL NULL
 
+static struct dentry *rsxx_debugfs_root = DEBUGFS_NULL;

What's the point of DEBUGFS_NULL?

Quoted 7 lines
Quoted 3 lines

Well, orginally, I had rsxx_debugfs_root initialized to NULL but the checkpatch script told me not to initialize directly with 0 or NULL. So my solution is the #define macro.

Well, it's a static variable. The reason checkpatch tells you not to initialize it to NULL/0 is because the bss is automatically zeroed.

Alright sounds good, I'll remove it.

Has the patch series been applied and a new patch with the proper change need to sent or does the entire patch series need to be resubmitted?

Quoted 3 lines
Signature · 1 line
Jens Axboe

Thanks,
-Philip Kelleher