[PATCH v19 2/3] Documentation: add debugfs description for vfio

From: Longfang Liu
Date: Mon Nov 06 2023 - 02:38:22 EST


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

Signed-off-by: Longfang Liu <liulongfang@xxxxxxxxxx>
Reviewed-by: Cedric Le Goater <clg@xxxxxxxxxx>
---
Documentation/ABI/testing/debugfs-vfio | 25 +++++++++++++++++++++++++
1 file changed, 25 insertions(+)
create mode 100644 Documentation/ABI/testing/debugfs-vfio

diff --git a/Documentation/ABI/testing/debugfs-vfio b/Documentation/ABI/testing/debugfs-vfio
new file mode 100644
index 000000000000..210eca135979
--- /dev/null
+++ b/Documentation/ABI/testing/debugfs-vfio
@@ -0,0 +1,25 @@
+What: /sys/kernel/debug/vfio
+Date: Nov 2023
+KernelVersion: 6.7
+Contact: Longfang Liu <liulongfang@xxxxxxxxxx>
+Description: This debugfs file directory is used for debugging
+ of vfio devices, it's a common directory for all vfio devices.
+ Vfio core will create a device subdirectory under this
+ directory.
+
+What: /sys/kernel/debug/vfio/<device>/migration
+Date: Nov 2023
+KernelVersion: 6.7
+Contact: Longfang Liu <liulongfang@xxxxxxxxxx>
+Description: This debugfs file directory is used for debugging
+ of vfio devices that support live migration.
+ The debugfs of each vfio device that supports live migration
+ could be created under this directory.
+
+What: /sys/kernel/debug/vfio/<device>/migration/state
+Date: Nov 2023
+KernelVersion: 6.7
+Contact: Longfang Liu <liulongfang@xxxxxxxxxx>
+Description: Read the live migration status of the vfio device.
+ The contents of the state file reflects the migration state
+ relative to those defined in the vfio_device_mig_state enum
--
2.24.0