From: liulongfang <liulongfang@huawei.com>
To: <alex.williamson@redhat.com>, <jgg@nvidia.com>,
<shameerali.kolothum.thodi@huawei.com>,
<jonathan.cameron@huawei.com>
Cc: <cohuck@redhat.com>, <linux-kernel@vger.kernel.org>,
<linuxarm@openeuler.org>, <liulongfang@huawei.com>
Subject: [PATCH v11 4/4] Documentation: add debugfs description for vfio
Date: Fri, 30 Jun 2023 17:24:57 +0800 [thread overview]
Message-ID: <20230630092457.54902-5-liulongfang@huawei.com> (raw)
In-Reply-To: <20230630092457.54902-1-liulongfang@huawei.com>
From: Longfang Liu <liulongfang@huawei.com>
1.Add two debugfs document description file to help users understand
how to use the accelerator live migration driver's debugfs.
2.Update the file paths that need to be maintained in MAINTAINERS
Signed-off-by: Longfang Liu <liulongfang@huawei.com>
---
.../ABI/testing/debugfs-hisi-migration | 32 +++++++++++++++++++
Documentation/ABI/testing/debugfs-vfio | 25 +++++++++++++++
MAINTAINERS | 2 ++
3 files changed, 59 insertions(+)
create mode 100644 Documentation/ABI/testing/debugfs-hisi-migration
create mode 100644 Documentation/ABI/testing/debugfs-vfio
diff --git a/Documentation/ABI/testing/debugfs-hisi-migration b/Documentation/ABI/testing/debugfs-hisi-migration
new file mode 100644
index 000000000000..0dfc7008a3e1
--- /dev/null
+++ b/Documentation/ABI/testing/debugfs-hisi-migration
@@ -0,0 +1,32 @@
+What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/data
+Date: June 2023
+KernelVersion: 6.4
+Contact: Longfang Liu <liulongfang@huawei.com>
+Description: Read the live migration data of the vfio device.
+ The output format of the data is defined by the live
+ migration driver.
+
+What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/attr
+Date: June 2023
+KernelVersion: 6.4
+Contact: Longfang Liu <liulongfang@huawei.com>
+Description: Read the live migration attributes of the vfio device.
+ The output format of the attributes is defined by the live
+ migration driver.
+
+What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/io_test
+Date: June 2023
+KernelVersion: 6.4
+Contact: Longfang Liu <liulongfang@huawei.com>
+Description: Trigger the HiSilicon accelerator device to perform
+ the io test through the read operation, and directly output
+ the test result.
+
+What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/save
+Date: June 2023
+KernelVersion: 6.4
+Contact: Longfang Liu <liulongfang@huawei.com>
+Description: Trigger the Hisilicon accelerator device to perform
+ the state saving operation of live migration through the read
+ operation, and directly output the operation result.
+
diff --git a/Documentation/ABI/testing/debugfs-vfio b/Documentation/ABI/testing/debugfs-vfio
new file mode 100644
index 000000000000..e2132a2f602b
--- /dev/null
+++ b/Documentation/ABI/testing/debugfs-vfio
@@ -0,0 +1,25 @@
+What: /sys/kernel/debug/vfio
+Date: June 2023
+KernelVersion: 6.4
+Contact: Longfang Liu <liulongfang@huawei.com>
+Description: This debugfs file directory is used for debugging
+ of vfio devices.
+ Each device can create a device subdirectory under this
+ directory by referencing the public registration interface.
+
+What: /sys/kernel/debug/vfio/<device>/migration
+Date: June 2023
+KernelVersion: 6.4
+Contact: Longfang Liu <liulongfang@huawei.com>
+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: June 2023
+KernelVersion: 6.4
+Contact: Longfang Liu <liulongfang@huawei.com>
+Description: Read the live migration status of the vfio device.
+ The status of these live migrations includes:
+ ERROR, RUNNING, STOP, STOP_COPY, RESUMING.
diff --git a/MAINTAINERS b/MAINTAINERS
index ce6ac552d8f6..bdd6a5e7350f 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -22098,6 +22098,7 @@ L: kvm@vger.kernel.org
S: Maintained
T: git https://github.com/awilliam/linux-vfio.git
F: Documentation/ABI/testing/sysfs-devices-vfio-dev
+F: Documentation/ABI/testing/debugfs-vfio
F: Documentation/driver-api/vfio.rst
F: drivers/vfio/
F: include/linux/vfio.h
@@ -22115,6 +22116,7 @@ M: Longfang Liu <liulongfang@huawei.com>
M: Shameer Kolothum <shameerali.kolothum.thodi@huawei.com>
L: kvm@vger.kernel.org
S: Maintained
+F: Documentation/ABI/testing/debugfs-hisi-migration
F: drivers/vfio/pci/hisilicon/
VFIO MEDIATED DEVICE DRIVERS
--
2.24.0
next prev parent reply other threads:[~2023-06-30 9:28 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-06-30 9:24 [PATCH v11 0/4] add debugfs to migration driver liulongfang
2023-06-30 9:24 ` [PATCH v11 1/4] vfio/migration: Add debugfs to live " liulongfang
2023-07-18 17:45 ` Cédric Le Goater
2023-07-24 2:42 ` liulongfang
2023-06-30 9:24 ` [PATCH v11 2/4] hisi_acc_vfio_pci: extract public functions for container_of liulongfang
2023-06-30 9:24 ` [PATCH v11 3/4] hisi_acc_vfio_pci: register debugfs for hisilicon migration driver liulongfang
2023-07-14 22:07 ` Alex Williamson
2023-07-24 3:14 ` liulongfang
2023-06-30 9:24 ` liulongfang [this message]
2023-07-14 22:07 ` [PATCH v11 4/4] Documentation: add debugfs description for vfio Alex Williamson
2023-07-24 4:00 ` liulongfang
2023-07-10 12:12 ` [PATCH v11 0/4] add debugfs to migration driver liulongfang
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230630092457.54902-5-liulongfang@huawei.com \
--to=liulongfang@huawei.com \
--cc=alex.williamson@redhat.com \
--cc=cohuck@redhat.com \
--cc=jgg@nvidia.com \
--cc=jonathan.cameron@huawei.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linuxarm@openeuler.org \
--cc=shameerali.kolothum.thodi@huawei.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox