diff mbox series

[scsi:fc] Update documentation of sysfs nodes for appid

Message ID 20210913015853.2086512-1-muneendra.kumar@broadcom.com (mailing list archive)
State Accepted
Headers show
Series [scsi:fc] Update documentation of sysfs nodes for appid | expand

Commit Message

Muneendra Kumar M Sept. 13, 2021, 1:58 a.m. UTC
From: Muneendra <muneendra.kumar@broadcom.com>

Update documentation for sysfs node within
/sys/class/fc/fc_udev_device/

Signed-off-by: Muneendra <muneendra.kumar@broadcom.com>
---
 Documentation/ABI/testing/sysfs-class-fc | 27 ++++++++++++++++++++++++
 1 file changed, 27 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-class-fc

Comments

Himanshu Madhani Sept. 13, 2021, 2:57 p.m. UTC | #1
> On Sep 12, 2021, at 8:58 PM, Muneendra Kumar <muneendra.kumar@broadcom.com> wrote:
> 
> From: Muneendra <muneendra.kumar@broadcom.com>
> 
> Update documentation for sysfs node within
> /sys/class/fc/fc_udev_device/
> 
> Signed-off-by: Muneendra <muneendra.kumar@broadcom.com>
> ---
> Documentation/ABI/testing/sysfs-class-fc | 27 ++++++++++++++++++++++++
> 1 file changed, 27 insertions(+)
> create mode 100644 Documentation/ABI/testing/sysfs-class-fc
> 
> diff --git a/Documentation/ABI/testing/sysfs-class-fc b/Documentation/ABI/testing/sysfs-class-fc
> new file mode 100644
> index 000000000000..3057a6d3b8cf
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-class-fc
> @@ -0,0 +1,27 @@
> +What:		/sys/class/fc/fc_udev_device/appid_store
> +Date:		Aug 2021
> +Contact:	Muneendra Kumar <muneendra.kumar@broadconm.com>
> +Description:
> +		This interface allows an admin to set an FC application
> +		identifier in the blkcg associated with a cgroup id. The
> +		identifier is typically a UUID that is associated with
> +		an application or logical entity such as a virtual
> +		machine or container group. The application or logical
> +		entity utilizes a block device via the cgroup id.
> +		FC adapter drivers may query the identifier and tag FC
> +		traffic based on the identifier. FC host and FC fabric
> +		entities can utilize the application id and FC traffic
> +		tag to identify traffic sources.
> +
> +		The interface expects a string "<cgroupid>:<appid>" where:
> +		<cgroupid> is inode of the cgroup in hexadecimal
> +		<appid> is user provided string upto 128 characters
> +		in length.
> +
> +		If an appid_store is done for a cgroup id that already
> +		has an appid set, the new value will override the
> +		previous value.
> +
> +		If an admin wants to remove an FC application identifier
> +		from a cgroup, an appid_store should be done with the
> +		following string: "<cgroupid>:"
> -- 
> 2.26.2
> 

Looks Good.

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

--
Himanshu Madhani	 Oracle Linux Engineering
Martin K. Petersen Sept. 15, 2021, 3:39 a.m. UTC | #2
Muneendra,

> Update documentation for sysfs node within
> /sys/class/fc/fc_udev_device/

Applied to 5.16/scsi-staging, thanks!
Martin K. Petersen Sept. 22, 2021, 4:45 a.m. UTC | #3
On Sun, 12 Sep 2021 18:58:53 -0700, Muneendra Kumar wrote:

> From: Muneendra <muneendra.kumar@broadcom.com>
> 
> Update documentation for sysfs node within
> /sys/class/fc/fc_udev_device/
> 
> 

Applied to 5.16/scsi-queue, thanks!

[1/1] Update documentation of sysfs nodes for appid
      https://git.kernel.org/mkp/scsi/c/e9d73bfa8e04
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-class-fc b/Documentation/ABI/testing/sysfs-class-fc
new file mode 100644
index 000000000000..3057a6d3b8cf
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-class-fc
@@ -0,0 +1,27 @@ 
+What:		/sys/class/fc/fc_udev_device/appid_store
+Date:		Aug 2021
+Contact:	Muneendra Kumar <muneendra.kumar@broadconm.com>
+Description:
+		This interface allows an admin to set an FC application
+		identifier in the blkcg associated with a cgroup id. The
+		identifier is typically a UUID that is associated with
+		an application or logical entity such as a virtual
+		machine or container group. The application or logical
+		entity utilizes a block device via the cgroup id.
+		FC adapter drivers may query the identifier and tag FC
+		traffic based on the identifier. FC host and FC fabric
+		entities can utilize the application id and FC traffic
+		tag to identify traffic sources.
+
+		The interface expects a string "<cgroupid>:<appid>" where:
+		<cgroupid> is inode of the cgroup in hexadecimal
+		<appid> is user provided string upto 128 characters
+		in length.
+
+		If an appid_store is done for a cgroup id that already
+		has an appid set, the new value will override the
+		previous value.
+
+		If an admin wants to remove an FC application identifier
+		from a cgroup, an appid_store should be done with the
+		following string: "<cgroupid>:"