[PATCH v4 4/5] Documentation: add debugfs description for hisi_acc_vfio_pci

Longfang Liu
2022-12-02T09:29:40Z

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

Signed-off-by: Longfang Liu <liulongfang@huawei.com>
---
.../ABI/testing/debugfs-hisi-migration | 32 +++++++++++++++++++
1 file changed, 32 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..a8cfc7688b88
--- /dev/null
+++ b/Documentation/ABI/testing/debugfs-hisi-migration
@@ -0,0 +1,32 @@
+What: /sys/kernel/debug/vfio_mig/<bdf>/state
+Date: Nov 2022
+Contact: linux-kernel@vger.kernel.org
+Description: Read the live migration status of the VF device.
+ The status of these live migrations includes:
+ ERROR, RUNNING, STOP, STOP_COPY, RESUMING.
+
+What: /sys/kernel/debug/vfio_mig/<bdf>/mig_data
+Date: Nov 2022
+Contact: linux-kernel@vger.kernel.org
+Description: Read the live migration data of the VF device.
+ The output format of the data is defined by the live
+ migration driver.
+
+What: /sys/kernel/debug/vfio_mig/<bdf>/mig_attr
+Date: Nov 2022
+Contact: linux-kernel@vger.kernel.org
+Description: Read the live migration attributes of the VF device.
+ The output format of the attributes is defined by the live
+ migration driver.
+
+What: /sys/kernel/debug/vfio_mig/<bdf>/debug
+Date: Nov 2022
+Contact: linux-kernel@vger.kernel.org
+Description: This debug file supports "echo" command write operations.
+ The command is actually represented by an integer number, and the
+ specific meaning is defined by the corresponding device driver.
+ For example, three commands are defined in the HiSilicon accelerator
+ live migration driver:
+ 0: State save
+ 1: State resume
+ 2: IO test
--
2.24.0