scsi: ufs-debugfs: Add error counters
PATCH v2 1/1 scsi: ufs-debugfs: Add error counters
People testing have a need to know how many errors might be occurring over time. Add error counters and expose them via debugfs.
---
Changes in V2:
Add missing '#include "ufs-debugfs.h"' in ufs-debugfs.c
drivers/scsi/ufs/Makefile | 1 + drivers/scsi/ufs/ufs-debugfs.c | 56 ++++++++++++++++++++++++++++++++++ drivers/scsi/ufs/ufs-debugfs.h | 22 +++++++++++++ drivers/scsi/ufs/ufshcd.c | 19 ++++++++++++ drivers/scsi/ufs/ufshcd.h | 5 +++ 5 files changed, 103 insertions(+) create mode 100644 drivers/scsi/ufs/ufs-debugfs.c create mode 100644 drivers/scsi/ufs/ufs-debugfs.h
drivers/scsi/ufs/Makefile +1 -0
@@ -9,6 +9,7 @@ ufs_qcom-$(CONFIG_SCSI_UFS_CRYPTO) += ufs-qcom-ice.o obj-$(CONFIG_SCSI_UFS_EXYNOS) += ufs-exynos.o obj-$(CONFIG_SCSI_UFSHCD) += ufshcd-core.o ufshcd-core-y += ufshcd.o ufs-sysfs.o +ufshcd-core-$(CONFIG_DEBUG_FS) += ufs-debugfs.o ufshcd-core-$(CONFIG_SCSI_UFS_BSG) += ufs_bsg.o ufshcd-core-$(CONFIG_SCSI_UFS_CRYPTO) += ufshcd-crypto.o obj-$(CONFIG_SCSI_UFSHCD_PCI) += ufshcd-pci.o
drivers/scsi/ufs/ufs-debugfs.c new file +56 -0
56 lines not on this page · raw message
drivers/scsi/ufs/ufs-debugfs.h new file +22 -0
@@ -0,0 +1,22 @@ +/* SPDX-License-Identifier: GPL-2.0 */ +/* Copyright (C) 2020 Intel Corporation +*/ + +#ifndef __UFS_DEBUGFS_H__ +#define __UFS_DEBUGFS_H__ + +struct ufs_hba ; + +#ifdef CONFIG_DEBUG_FS +void ufs_debugfs_init (void ); +void ufs_debugfs_exit (void ); +void ufs_debugfs_hba_init (struct ufs_hba *hba); +void ufs_debugfs_hba_exit (struct ufs_hba *hba); +#else +static inline void ufs_debugfs_init (void ) {} +static inline void ufs_debugfs_exit (void ) {} +static inline void ufs_debugfs_hba_init (struct ufs_hba *hba) {} +static inline void ufs_debugfs_hba_exit (struct ufs_hba *hba) {} +#endif + +#endif
drivers/scsi/ufs/ufshcd.c +19 -0
@@ -20,6 +20,7 @@#include "ufs_quirks.h" #include "unipro.h" #include "ufs-sysfs.h" +#include "ufs-debugfs.h" #include "ufs_bsg.h" #include "ufshcd-crypto.h" #include <asm/unaligned.h>
@@ -4540,6 +4541,7 @@ void ufshcd_update_evt_hist(struct ufs_hba *hba, u32 id, u32 val) e = &hba->ufs_stats.event[id]; e->val[e->pos] = val; e->tstamp[e->pos] =ktime_get (); + e->cnt +=1 ; e->pos = (e->pos +1 ) %UFS_EVENT_HIST_LENGTH ;ufshcd_vops_event_notify (hba, id, &val);
@@ -8334,6 +8336,8 @@ static int ufshcd_hba_init(struct ufs_hba *hba)if (err) goto out_disable_vreg; +ufs_debugfs_hba_init (hba); + hba->is_powered = true; goto out;
@@ -8350,6 +8354,7 @@ static int ufshcd_hba_init(struct ufs_hba *hba)static void ufshcd_hba_exit (struct ufs_hba *hba) {if (hba->is_powered) { +ufs_debugfs_hba_exit (hba);ufshcd_variant_hba_exit (hba);ufshcd_setup_vreg (hba, false);ufshcd_suspend_clkscaling (hba);
@@ -9436,6 +9441,20 @@ int ufshcd_init(struct ufs_hba *hba, void __iomem *mmio_base, unsigned int irq) }EXPORT_SYMBOL_GPL (ufshcd_init); +static int __init ufshcd_core_init (void ) +{ +ufs_debugfs_init (); +return 0 ; +} + +static void __exit ufshcd_core_exit(void) +{ +ufs_debugfs_exit (); +} + +module_init (ufshcd_core_init); +module_exit (ufshcd_core_exit); +MODULE_AUTHOR ("Santosh Yaragnavi <[email protected]>" );MODULE_AUTHOR ("Vinayak Holikatti <[email protected]>" );MODULE_DESCRIPTION ("Generic UFS host controller driver Core" );
drivers/scsi/ufs/ufshcd.h +5 -0
@@ -445,11 +445,13 @@ struct ufs_clk_scaling {* @pos: index to indicate cyclic buffer position * @reg: cyclic buffer for registers value * @tstamp: cyclic buffer for time stamp +* @cnt: error counter */ struct ufs_event_hist {int pos;u32 val[UFS_EVENT_HIST_LENGTH ];ktime_t tstamp[UFS_EVENT_HIST_LENGTH ]; +unsigned long long cnt; };/**
@@ -817,6 +819,9 @@ struct ufs_hba {u32 crypto_cfg_register;struct blk_keyslot_manager ksm;#endif +#ifdef CONFIG_DEBUG_FS +struct dentry *debugfs_root; +#endif };/* Returns true if clocks can be gated. Otherwise false */
Signature · 1 line
2.17.1
Quoted 8 lines · Adrian Hunter
ufshcd_variant_hba_exit(hba); ufshcd_setup_vreg(hba, false); ufshcd_suspend_clkscaling(hba);drivers/scsi/ufs/ufshcd.c +0
-0@@ -9436,6 +9441,20 @@ int ufshcd_init(struct ufs_hba *hba, void __iomem *mmio_base, unsigned int irq) }EXPORT_SYMBOL_GPL (ufshcd_init);
drivers/scsi/ufs/ufshcd.c int ufshcd_init(struct ufs_hba *hba, void · line 9454
Quoted 10 lines
drivers/scsi/ufs/ufshcd.c +10
-0+static int __init ufshcd_core_init (void ) +{ +ufs_debugfs_init (); +return 0 ; +} + +static void __exit ufshcd_core_exit(void) +{ +ufs_debugfs_exit (); +}
Hi, Adrian
The purpose of patch is acceptable, but I don't know why you choose using ufshcd_core_* here.
Also. I don't know if module_init() is a proper way here.
thanks,
Bean
Quoted 5 lines
n
drivers/scsi/ufs/ufshcd.c +3
-0+ +module_init (ufshcd_core_init); +module_exit (ufshcd_core_exit)
Quoted 9 lines · Bean Huo
Quoted 8 lines · Adrian Hunter
ufshcd_variant_hba_exit(hba); ufshcd_setup_vreg(hba, false); ufshcd_suspend_clkscaling(hba);drivers/scsi/ufs/ufshcd.c +0
-0@@ -9436,6 +9441,20 @@ int ufshcd_init(struct ufs_hba *hba, void __iomem *mmio_base, unsigned int irq) }EXPORT_SYMBOL_GPL (ufshcd_init);
Quoted 12 lines
drivers/scsi/ufs/ufshcd.c int ufshcd_init(struct ufs_hba *hba, void __iomem *mmio_base, unsigned int irq) · line 9453
Quoted 10 lines
drivers/scsi/ufs/ufshcd.c +10
-0+static int __init ufshcd_core_init (void ) +{ +ufs_debugfs_init (); +return 0 ; +} + +static void __exit ufshcd_core_exit(void) +{ +ufs_debugfs_exit (); +}Hi, Adrian
Thanks for looking at the patch.
Quoted 3 lines
The purpose of patch is acceptable, but I don't know why you choose using ufshcd_core_* here.
Do you mean you would like a different function name? 'ufshcd_init' is used already. The module is called ufshcd-core, so ufshcd_core_* seems appropriate.
Quoted 1 line
Also. I don't know if
module_init()is a proper way here.
Can you be more specific? It is normal to do module initialization in module_init().
However I do see a problem. When builtin, initcalls are ordered according to link order, but the Makefile does not have ufshcd-core at the top i.e.
$ cat drivers/scsi/ufs/Makefile # SPDX-License-Identifier: GPL-2.0 # UFSHCD makefile obj-$(CONFIG_SCSI_UFS_DWC_TC_PCI) += tc-dwc-g210-pci.o ufshcd-dwc.o tc-dwc-g210.o obj-$(CONFIG_SCSI_UFS_DWC_TC_PLATFORM) += tc-dwc-g210-pltfrm.o ufshcd-dwc.o tc-dwc-g210.o obj-$(CONFIG_SCSI_UFS_CDNS_PLATFORM) += cdns-pltfrm.o obj-$(CONFIG_SCSI_UFS_QCOM) += ufs_qcom.o ufs_qcom-y += ufs-qcom.o ufs_qcom-$(CONFIG_SCSI_UFS_CRYPTO) += ufs-qcom-ice.o obj-$(CONFIG_SCSI_UFS_EXYNOS) += ufs-exynos.o obj-$(CONFIG_SCSI_UFSHCD) += ufshcd-core.o ufshcd-core-y += ufshcd.o ufs-sysfs.o ufshcd-core-$(CONFIG_DEBUG_FS) += ufs-debugfs.o ufshcd-core-$(CONFIG_SCSI_UFS_BSG) += ufs_bsg.o ufshcd-core-$(CONFIG_SCSI_UFS_CRYPTO) += ufshcd-crypto.o obj-$(CONFIG_SCSI_UFSHCD_PCI) += ufshcd-pci.o obj-$(CONFIG_SCSI_UFSHCD_PLATFORM) += ufshcd-pltfrm.o obj-$(CONFIG_SCSI_UFS_HISI) += ufs-hisi.o obj-$(CONFIG_SCSI_UFS_MEDIATEK) += ufs-mediatek.o obj-$(CONFIG_SCSI_UFS_TI_J721E) += ti-j721e-ufs.o
Should be:
# SPDX-License-Identifier: GPL-2.0
# UFSHCD makefile
# Order here is important. ufshcd-core must initialize first.
ufshcd-core-y += ufshcd.o ufs-sysfs.o ufshcd-core-$(CONFIG_DEBUG_FS) += ufs-debugfs.o ufshcd-core-$(CONFIG_SCSI_UFS_BSG) += ufs_bsg.o
ufshcd-core-$(CONFIG_SCSI_UFS_CRYPTO) += ufshcd-crypto.o obj-$(CONFIG_SCSI_UFS_DWC_TC_PCI) += tc-dwc-g210-pci.o ufshcd-dwc.o tc-dwc-g210.o
obj-$(CONFIG_SCSI_UFS_DWC_TC_PLATFORM) += tc-dwc-g210-pltfrm.o ufshcd-dwc.o tc-dwc-g210.o
obj-$(CONFIG_SCSI_UFS_CDNS_PLATFORM) += cdns-pltfrm.o obj-$(CONFIG_SCSI_UFS_QCOM) += ufs_qcom.o
ufs_qcom-y += ufs-qcom.o
ufs_qcom-$(CONFIG_SCSI_UFS_CRYPTO) += ufs-qcom-ice.o obj-$(CONFIG_SCSI_UFS_EXYNOS) += ufs-exynos.o obj-$(CONFIG_SCSI_UFSHCD) += ufshcd-core.o obj-$(CONFIG_SCSI_UFSHCD_PCI) += ufshcd-pci.o obj-$(CONFIG_SCSI_UFSHCD_PLATFORM) += ufshcd-pltfrm.o obj-$(CONFIG_SCSI_UFS_HISI) += ufs-hisi.o obj-$(CONFIG_SCSI_UFS_MEDIATEK) += ufs-mediatek.o obj-$(CONFIG_SCSI_UFS_TI_J721E) += ti-j721e-ufs.o
What do you think?
Quoted 10 lines
thanks,
BeanQuoted 5 lines
n
drivers/scsi/ufs/ufshcd.c +3
-0+ +module_init (ufshcd_core_init); +module_exit (ufshcd_core_exit)
Please add my reviewed-by once you fix that.
Thanks,
Avri
Quoted 65 lines
However I do see a problem. When builtin, initcalls are ordered according to link order, but the
Makefiledoes not have ufshcd-core at the top i.e.$ cat drivers/scsi/ufs/Makefile # SPDX-License-Identifier: GPL-2.0 # UFSHCD makefile obj-$(CONFIG_SCSI_UFS_DWC_TC_PCI) += tc-dwc-g210-pci.o ufshcd-dwc.o tc-dwc-g210.o obj-$(CONFIG_SCSI_UFS_DWC_TC_PLATFORM) += tc-dwc-g210-pltfrm.o ufshcd-dwc.o tc-dwc-g210.o obj-$(CONFIG_SCSI_UFS_CDNS_PLATFORM) += cdns-pltfrm.o obj-$(CONFIG_SCSI_UFS_QCOM) += ufs_qcom.o ufs_qcom-y += ufs-qcom.o ufs_qcom-$(CONFIG_SCSI_UFS_CRYPTO) += ufs-qcom-ice.o obj-$(CONFIG_SCSI_UFS_EXYNOS) += ufs-exynos.o obj-$(CONFIG_SCSI_UFSHCD) += ufshcd-core.o ufshcd-core-y += ufshcd.o ufs-sysfs.o ufshcd-core-$(CONFIG_DEBUG_FS) += ufs-debugfs.o ufshcd-core-$(CONFIG_SCSI_UFS_BSG) += ufs_bsg.o ufshcd-core-$(CONFIG_SCSI_UFS_CRYPTO) += ufshcd-crypto.o obj-$(CONFIG_SCSI_UFSHCD_PCI) += ufshcd-pci.o obj-$(CONFIG_SCSI_UFSHCD_PLATFORM) += ufshcd-pltfrm.o obj-$(CONFIG_SCSI_UFS_HISI) += ufs-hisi.o obj-$(CONFIG_SCSI_UFS_MEDIATEK) += ufs-mediatek.o obj-$(CONFIG_SCSI_UFS_TI_J721E) += ti-j721e-ufs.oShould be:
# SPDX-License-Identifier: GPL-2.0
# UFSHCD makefile
# Order here is important. ufshcd-core must initialize first.ufshcd-core-y += ufshcd.o ufs-sysfs.o ufshcd-core-$(CONFIG_DEBUG_FS) += ufs-debugfs.o ufshcd-core-$(CONFIG_SCSI_UFS_BSG) += ufs_bsg.oufshcd-core-$(CONFIG_SCSI_UFS_CRYPTO) += ufshcd-crypto.o obj-$(CONFIG_SCSI_UFS_DWC_TC_PCI) += tc-dwc-g210-pci.o ufshcd-dwc.o tc-dwc-g210.o
obj-$(CONFIG_SCSI_UFS_DWC_TC_PLATFORM) += tc-dwc-g210-pltfrm.o ufshcd-dwc.o
tc-dwc-g210.o
obj-$(CONFIG_SCSI_UFS_CDNS_PLATFORM) += cdns-pltfrm.o obj-$(CONFIG_SCSI_UFS_QCOM) += ufs_qcom.o
ufs_qcom-y += ufs-qcom.o ufs_qcom-$(CONFIG_SCSI_UFS_CRYPTO) += ufs-qcom-ice.o obj-$(CONFIG_SCSI_UFS_EXYNOS) += ufs-exynos.o obj-$(CONFIG_SCSI_UFSHCD) += ufshcd-core.o obj-$(CONFIG_SCSI_UFSHCD_PCI) += ufshcd-pci.o obj-$(CONFIG_SCSI_UFSHCD_PLATFORM) += ufshcd-pltfrm.o obj-$(CONFIG_SCSI_UFS_HISI) += ufs-hisi.o obj-$(CONFIG_SCSI_UFS_MEDIATEK) += ufs-mediatek.o obj-$(CONFIG_SCSI_UFS_TI_J721E) += ti-j721e-ufs.oWhat do you think?
Quoted 10 lines
thanks,
BeanQuoted 5 lines
n
drivers/scsi/ufs/ufshcd.c +3
-0+ +module_init (ufshcd_core_init); +module_exit (ufshcd_core_exit)
Quoted 9 lines · Adrian Hunter
Quoted 3 lines
The purpose of patch is acceptable, but I don't know why you choose using ufshcd_core_* here.
Do you mean you would like a different function name? '
ufshcd_init' is used
already. The module is called ufshcd-core, so ufshcd_core_* seems appropriate.
Quoted 5 lines
Quoted 1 line
Also. I don't know if
module_init()is a proper way here.Can you be more specific? It is normal to do module initialization in
module_init().
Hi Adrian
My concern that ufs_debugfs_init() is called in module_init(), but your another debugfs initialization function ufs_debugfs_hba_init(hba) called in the UFS host probe path.
If these two (module_init() and module_platform_driver()) initializaiton sequence always as your expectation: ufs_debugfs_init()- ->ufs_debugfs_hba_init(), that is fine, otherwise, it is better just group them, make it simpler.
Thanks,
Bean
Quoted 12 lines · Bean Huo
Quoted 11 lines · Adrian Hunter
Quoted 3 lines
The purpose of patch is acceptable, but I don't know why you choose using ufshcd_core_* here.
Do you mean you would like a different function name? '
ufshcd_init' is used
already. The module is called ufshcd-core, so ufshcd_core_* seems appropriate.Quoted 1 line
Also. I don't know if
module_init()is a proper way here.
Quoted 8 lines
Quoted 3 lines
Can you be more specific? It is normal to do module initialization in
module_init().Hi Adrian
My concern thatufs_debugfs_init()is called inmodule_init(), but your another debugfs initialization functionufs_debugfs_hba_init(hba)called in the UFS host probe path.
It is a good question, but module dependencies and initcall ordering means that won't happen. It is not unusual for modules to do initialization in this way, that is completed before dependent modules initialize.
Quoted 5 lines
If these two (
module_init()andmodule_platform_driver()) initializaiton sequence always as your expectation: ufs_debugfs_init()- ->ufs_debugfs_hba_init(), that is fine, otherwise, it is better just group them, make it simpler.
Unfortunately, doing it that way, calls to debugsfs_create_dir("ufshcd", NULL) could race. Losers of the race will get an error, and will not get the dentry they need to proceed. Preventing the race would require adding a mutex. So the other way is simpler.