diff mbox series

[2/2] scsi: fc: Update documentation of sysfs nodes for FPIN stats

Message ID 20200730061116.20111-3-njavali@marvell.com (mailing list archive)
State Deferred
Headers show
Series SAN Congestion Management (SCM) statistics | expand

Commit Message

Nilesh Javali July 30, 2020, 6:11 a.m. UTC
From: Shyam Sundar <ssundar@marvell.com>

Update documentation for sysfs nodes within,
       /sys/class/fc_host
       /sys/class/fc_remote_ports

Signed-off-by: Shyam Sundar <ssundar@marvell.com>
Signed-off-by: Nilesh Javali <njavali@marvell.com>
---
 Documentation/ABI/testing/sysfs-class-fc_host | 23 +++++++++++++++++++
 .../ABI/testing/sysfs-class-fc_remote_ports   | 23 +++++++++++++++++++
 2 files changed, 46 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-class-fc_host
 create mode 100644 Documentation/ABI/testing/sysfs-class-fc_remote_ports

Comments

Himanshu Madhani Sept. 9, 2020, 1:51 p.m. UTC | #1
> On Jul 30, 2020, at 1:11 AM, Nilesh Javali <njavali@marvell.com> wrote:
> 
> From: Shyam Sundar <ssundar@marvell.com>
> 
> Update documentation for sysfs nodes within,
>       /sys/class/fc_host
>       /sys/class/fc_remote_ports
> 
> Signed-off-by: Shyam Sundar <ssundar@marvell.com>
> Signed-off-by: Nilesh Javali <njavali@marvell.com>
> ---
> Documentation/ABI/testing/sysfs-class-fc_host | 23 +++++++++++++++++++
> .../ABI/testing/sysfs-class-fc_remote_ports   | 23 +++++++++++++++++++
> 2 files changed, 46 insertions(+)
> create mode 100644 Documentation/ABI/testing/sysfs-class-fc_host
> create mode 100644 Documentation/ABI/testing/sysfs-class-fc_remote_ports
> 
> diff --git a/Documentation/ABI/testing/sysfs-class-fc_host b/Documentation/ABI/testing/sysfs-class-fc_host
> new file mode 100644
> index 000000000000..a1e6ab89b86f
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-class-fc_host
> @@ -0,0 +1,23 @@
> +What:		/sys/class/fc_host/hostX/statistics/fpin_cn_yyy
> +Date:		July 2020
> +Contact:	Shyam Sundar <ssundar@marvell.com>
> +Description:
> +		These files contain the number of Fabric Performance Impact
> +		Notification (FPIN) events generated by the fabric, to indicate
> +		congestion detected on this host.
> +
> +What:		/sys/class/fc_host/hostX/statistics/fpin_li_yyy
> +Date:		July 2020
> +Contact:	Shyam Sundar <ssundar@marvell.com>
> +Description:
> +		These files contain the number of Fabric Performance Impact
> +		Notification (FPIN) events generated by the fabric, to indicate
> +		Link Integrity errors between the fabric and this host.
> +
> +What:		/sys/class/fc_host/hostX/statistics/fpin_dn_yyy
> +Date:		July 2020
> +Contact:	Shyam Sundar <ssundar@marvell.com>
> +Description:
> +		These files contain the number of Fabric Performance Impact
> +		Notification (FPIN) events generated by the fabric, to indicate
> +		Delivery related errors between the fabric and this host.
> diff --git a/Documentation/ABI/testing/sysfs-class-fc_remote_ports b/Documentation/ABI/testing/sysfs-class-fc_remote_ports
> new file mode 100644
> index 000000000000..185db8ec6c05
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-class-fc_remote_ports
> @@ -0,0 +1,23 @@
> +What:		/sys/class/fc_remote_ports/rport-X:Y-Z/statistics/fpin_cn_yyy
> +Date:		July 2020
> +Contact:	Shyam Sundar <ssundar@marvell.com>
> +Description:
> +		These files contain the number of Fabric Performance Impact
> +		Notification (FPIN) events generated by the fabric, to indicate
> +		congestion detected on this rport.
> +
> +What:		/sys/class/fc_remote_ports/rport-X:Y-Z/statistics/fpin_li_yyy
> +Date:		July 2020
> +Contact:	Shyam Sundar <ssundar@marvell.com>
> +Description:
> +		These files contain the number of Fabric Performance Impact
> +		Notification (FPIN) events generated by the fabric, to indicate
> +		Link Integrity errors between the fabric and this rport.
> +
> +What:		/sys/class/fc_remote_ports/rport-X:Y-Z/statistics/fpin_dn_yyy
> +Date:		July 2020
> +Contact:	Shyam Sundar <ssundar@marvell.com>
> +Description:
> +		These files contain the number of Fabric Performance Impact
> +		Notification (FPIN) events generated by the fabric, to indicate
> +		Delivery related errors between the fabric and this rport.
> -- 
> 2.19.0.rc0
> 

Looks Good to me. 

Reviewed-by: Himanshu Madhani <himanshu.madhani@oracle.com>

--
Himanshu Madhani	 Oracle Linux Engineering
James Smart Sept. 23, 2020, 12:15 a.m. UTC | #2
On 7/29/2020 11:11 PM, Nilesh Javali wrote:
> From: Shyam Sundar <ssundar@marvell.com>
>
> Update documentation for sysfs nodes within,
>         /sys/class/fc_host
>         /sys/class/fc_remote_ports
>
> Signed-off-by: Shyam Sundar <ssundar@marvell.com>
> Signed-off-by: Nilesh Javali <njavali@marvell.com>
> ---
>   Documentation/ABI/testing/sysfs-class-fc_host | 23 +++++++++++++++++++
>   .../ABI/testing/sysfs-class-fc_remote_ports   | 23 +++++++++++++++++++
>   2 files changed, 46 insertions(+)
>   create mode 100644 Documentation/ABI/testing/sysfs-class-fc_host
>   create mode 100644 Documentation/ABI/testing/sysfs-class-fc_remote_ports
>
> diff --git a/Documentation/ABI/testing/sysfs-class-fc_host b/Documentation/ABI/testing/sysfs-class-fc_host
> new file mode 100644
> index 000000000000..a1e6ab89b86f
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-class-fc_host
> @@ -0,0 +1,23 @@
> +What:		/sys/class/fc_host/hostX/statistics/fpin_cn_yyy
> +Date:		July 2020
> +Contact:	Shyam Sundar <ssundar@marvell.com>
> +Description:
> +		These files contain the number of Fabric Performance Impact
> +		Notification (FPIN) events generated by the fabric, to indicate
> +		congestion detected on this host.
> +
> +What:		/sys/class/fc_host/hostX/statistics/fpin_li_yyy
> +Date:		July 2020
> +Contact:	Shyam Sundar <ssundar@marvell.com>
> +Description:
> +		These files contain the number of Fabric Performance Impact
> +		Notification (FPIN) events generated by the fabric, to indicate
> +		Link Integrity errors between the fabric and this host.
> +
> +What:		/sys/class/fc_host/hostX/statistics/fpin_dn_yyy
> +Date:		July 2020
> +Contact:	Shyam Sundar <ssundar@marvell.com>
> +Description:
> +		These files contain the number of Fabric Performance Impact
> +		Notification (FPIN) events generated by the fabric, to indicate
> +		Delivery related errors between the fabric and this host.
> diff --git a/Documentation/ABI/testing/sysfs-class-fc_remote_ports b/Documentation/ABI/testing/sysfs-class-fc_remote_ports
> new file mode 100644
> index 000000000000..185db8ec6c05
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-class-fc_remote_ports
> @@ -0,0 +1,23 @@
> +What:		/sys/class/fc_remote_ports/rport-X:Y-Z/statistics/fpin_cn_yyy
> +Date:		July 2020
> +Contact:	Shyam Sundar <ssundar@marvell.com>
> +Description:
> +		These files contain the number of Fabric Performance Impact
> +		Notification (FPIN) events generated by the fabric, to indicate
> +		congestion detected on this rport.
> +
> +What:		/sys/class/fc_remote_ports/rport-X:Y-Z/statistics/fpin_li_yyy
> +Date:		July 2020
> +Contact:	Shyam Sundar <ssundar@marvell.com>
> +Description:
> +		These files contain the number of Fabric Performance Impact
> +		Notification (FPIN) events generated by the fabric, to indicate
> +		Link Integrity errors between the fabric and this rport.
> +
> +What:		/sys/class/fc_remote_ports/rport-X:Y-Z/statistics/fpin_dn_yyy
> +Date:		July 2020
> +Contact:	Shyam Sundar <ssundar@marvell.com>
> +Description:
> +		These files contain the number of Fabric Performance Impact
> +		Notification (FPIN) events generated by the fabric, to indicate
> +		Delivery related errors between the fabric and this rport.

Can you rework these a little. As it's written, it's implying that it's 
counting the FPINs, when it's really summing the number of integrity 
events reported by FPINs.  The number of events may not be the total 
number as it may have had to reach a threshold within a time window in 
order to have an FPIN generated.

-- james
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-class-fc_host b/Documentation/ABI/testing/sysfs-class-fc_host
new file mode 100644
index 000000000000..a1e6ab89b86f
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-class-fc_host
@@ -0,0 +1,23 @@ 
+What:		/sys/class/fc_host/hostX/statistics/fpin_cn_yyy
+Date:		July 2020
+Contact:	Shyam Sundar <ssundar@marvell.com>
+Description:
+		These files contain the number of Fabric Performance Impact
+		Notification (FPIN) events generated by the fabric, to indicate
+		congestion detected on this host.
+
+What:		/sys/class/fc_host/hostX/statistics/fpin_li_yyy
+Date:		July 2020
+Contact:	Shyam Sundar <ssundar@marvell.com>
+Description:
+		These files contain the number of Fabric Performance Impact
+		Notification (FPIN) events generated by the fabric, to indicate
+		Link Integrity errors between the fabric and this host.
+
+What:		/sys/class/fc_host/hostX/statistics/fpin_dn_yyy
+Date:		July 2020
+Contact:	Shyam Sundar <ssundar@marvell.com>
+Description:
+		These files contain the number of Fabric Performance Impact
+		Notification (FPIN) events generated by the fabric, to indicate
+		Delivery related errors between the fabric and this host.
diff --git a/Documentation/ABI/testing/sysfs-class-fc_remote_ports b/Documentation/ABI/testing/sysfs-class-fc_remote_ports
new file mode 100644
index 000000000000..185db8ec6c05
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-class-fc_remote_ports
@@ -0,0 +1,23 @@ 
+What:		/sys/class/fc_remote_ports/rport-X:Y-Z/statistics/fpin_cn_yyy
+Date:		July 2020
+Contact:	Shyam Sundar <ssundar@marvell.com>
+Description:
+		These files contain the number of Fabric Performance Impact
+		Notification (FPIN) events generated by the fabric, to indicate
+		congestion detected on this rport.
+
+What:		/sys/class/fc_remote_ports/rport-X:Y-Z/statistics/fpin_li_yyy
+Date:		July 2020
+Contact:	Shyam Sundar <ssundar@marvell.com>
+Description:
+		These files contain the number of Fabric Performance Impact
+		Notification (FPIN) events generated by the fabric, to indicate
+		Link Integrity errors between the fabric and this rport.
+
+What:		/sys/class/fc_remote_ports/rport-X:Y-Z/statistics/fpin_dn_yyy
+Date:		July 2020
+Contact:	Shyam Sundar <ssundar@marvell.com>
+Description:
+		These files contain the number of Fabric Performance Impact
+		Notification (FPIN) events generated by the fabric, to indicate
+		Delivery related errors between the fabric and this rport.