2024-03-07 06:41:37

by liulongfang

Subject: [PATCH v3 4/4] Documentation: add debugfs description for hisi migration

Add a debugfs document description file to help users understand
how to use the hisilicon accelerator live migration driver's
debugfs.

Update the file paths that need to be maintained in MAINTAINERS

Signed-off-by: Longfang Liu <[email protected]>
---
.../ABI/testing/debugfs-hisi-migration | 34 +++++++++++++++++++
MAINTAINERS | 1 +
2 files changed, 35 insertions(+)
create mode 100644 Documentation/ABI/testing/debugfs-hisi-migration

diff --git a/Documentation/ABI/testing/debugfs-hisi-migration b/Documentation/ABI/testing/debugfs-hisi-migration
new file mode 100644
index 000000000000..7111af41ed05
--- /dev/null
+++ b/Documentation/ABI/testing/debugfs-hisi-migration
@@ -0,0 +1,34 @@
+What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/data
+Date: Mar 2024
+KernelVersion: 6.8
+Contact: Longfang Liu <[email protected]>
+Description: Read the live migration data of the vfio device.
+ These data include device status data, queue configuration
+ data and some task configuration data.
+ The output format of the data is defined by the live
+ migration driver.
+
+What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/attr
+Date: Mar 2024
+KernelVersion: 6.8
+Contact: Longfang Liu <[email protected]>
+Description: Read the live migration attributes of the vfio device.
+ it include device status attributes and data length attributes
+ The output format of the attributes is defined by the live
+ migration driver.
+
+What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/cmd_state
+Date: Mar 2024
+KernelVersion: 6.8
+Contact: Longfang Liu <[email protected]>
+Description: Used to obtain the device command sending and receiving
+ channel status. If successful, returns the command value.
+ If failed, return error log.
+
+What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/save
+Date: Mar 2024
+KernelVersion: 6.8
+Contact: Longfang Liu <[email protected]>
+Description: Trigger the Hisilicon accelerator device to perform
+ the state saving operation of live migration through the read
+ operation, and output the operation log results.
diff --git a/MAINTAINERS b/MAINTAINERS
index 7625911ec2f1..8c2d13b13273 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -23072,6 +23072,7 @@ M: Longfang Liu <[email protected]>
M: Shameer Kolothum <[email protected]>
L: [email protected]
S: Maintained
+F: Documentation/ABI/testing/debugfs-hisi-migration
F: drivers/vfio/pci/hisilicon/

VFIO MEDIATED DEVICE DRIVERS
--
2.24.0

2024-03-30 07:54:18

by liulongfang

Subject: Re: [PATCH v3 4/4] Documentation: add debugfs description for hisi migration

On 2024/3/7 14:36, Longfang Liu wrote:
> Add a debugfs document description file to help users understand
> how to use the hisilicon accelerator live migration driver's
> debugfs.
>
> Update the file paths that need to be maintained in MAINTAINERS
>
> Signed-off-by: Longfang Liu <[email protected]>
> ---
> .../ABI/testing/debugfs-hisi-migration | 34 +++++++++++++++++++
> MAINTAINERS | 1 +
> 2 files changed, 35 insertions(+)
> create mode 100644 Documentation/ABI/testing/debugfs-hisi-migration
>
> diff --git a/Documentation/ABI/testing/debugfs-hisi-migration b/Documentation/ABI/testing/debugfs-hisi-migration
> new file mode 100644
> index 000000000000..7111af41ed05
> --- /dev/null
> +++ b/Documentation/ABI/testing/debugfs-hisi-migration
> @@ -0,0 +1,34 @@
> +What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/data
> +Date: Mar 2024
> +KernelVersion: 6.8
> +Contact: Longfang Liu <[email protected]>
> +Description: Read the live migration data of the vfio device.
> + These data include device status data, queue configuration
> + data and some task configuration data.
> + The output format of the data is defined by the live
> + migration driver.
> +
> +What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/attr
> +Date: Mar 2024
> +KernelVersion: 6.8
> +Contact: Longfang Liu <[email protected]>
> +Description: Read the live migration attributes of the vfio device.
> + it include device status attributes and data length attributes
> + The output format of the attributes is defined by the live
> + migration driver.
> +
> +What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/cmd_state
> +Date: Mar 2024
> +KernelVersion: 6.8
> +Contact: Longfang Liu <[email protected]>
> +Description: Used to obtain the device command sending and receiving
> + channel status. If successful, returns the command value.
> + If failed, return error log.
> +
> +What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/save
> +Date: Mar 2024
> +KernelVersion: 6.8
> +Contact: Longfang Liu <[email protected]>
> +Description: Trigger the Hisilicon accelerator device to perform
> + the state saving operation of live migration through the read
> + operation, and output the operation log results.
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 7625911ec2f1..8c2d13b13273 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -23072,6 +23072,7 @@ M: Longfang Liu <[email protected]>
> M: Shameer Kolothum <[email protected]>
> L: [email protected]
> S: Maintained
> +F: Documentation/ABI/testing/debugfs-hisi-migration
> F: drivers/vfio/pci/hisilicon/
>
> VFIO MEDIATED DEVICE DRIVERS
>

Hi, Alex:
Are there any issues with this patchset that need to be modified?

Thanks,

Longfang.