From: Longfang Liu <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 v9 4/5] Documentation: add debugfs description for vfio
Date: Mon, 20 Mar 2023 17:23:37 +0800 [thread overview]
Message-ID: <20230320092338.2889-5-liulongfang@huawei.com> (raw)
In-Reply-To: <20230320092338.2889-1-liulongfang@huawei.com>
Add two 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 | 28 +++++++++++++++++++
Documentation/ABI/testing/debugfs-vfio | 25 +++++++++++++++++
2 files changed, 53 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..ffcf4b5ecd51
--- /dev/null
+++ b/Documentation/ABI/testing/debugfs-hisi-migration
@@ -0,0 +1,28 @@
+What: /sys/kernel/debug/vfio/<device>/migration/hisi_acc/data
+Date: Mar 2023
+KernelVersion: 6.2
+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: Mar 2023
+KernelVersion: 6.2
+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/debug
+Date: Mar 2023
+KernelVersion: 6.2
+Contact: Longfang Liu <liulongfang@huawei.com>
+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
diff --git a/Documentation/ABI/testing/debugfs-vfio b/Documentation/ABI/testing/debugfs-vfio
new file mode 100644
index 000000000000..81a66cf60553
--- /dev/null
+++ b/Documentation/ABI/testing/debugfs-vfio
@@ -0,0 +1,25 @@
+What: /sys/kernel/debug/vfio
+Date: Mar 2023
+KernelVersion: 6.2
+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: Mar 2023
+KernelVersion: 6.2
+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: Mar 2023
+KernelVersion: 6.2
+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.
--
2.24.0
next prev parent reply other threads:[~2023-03-20 9:27 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-03-20 9:23 [PATCH v9 0/5] add debugfs to migration driver Longfang Liu
2023-03-20 9:23 ` [PATCH v9 1/5] vfio/migration: Add debugfs to live " Longfang Liu
2023-03-20 21:33 ` Alex Williamson
2023-03-20 21:42 ` Jason Gunthorpe
2023-03-21 2:21 ` liulongfang
2023-03-21 2:40 ` liulongfang
2023-03-20 9:23 ` [PATCH v9 2/5] hisi_acc_vfio_pci: extract public functions for container_of Longfang Liu
2023-03-20 9:23 ` [PATCH v9 3/5] hisi_acc_vfio_pci: register debugfs for hisilicon migration driver Longfang Liu
2023-03-20 22:09 ` Alex Williamson
2023-03-25 9:39 ` liulongfang
2023-03-20 9:23 ` Longfang Liu [this message]
2023-03-20 9:23 ` [PATCH v9 5/5] vfio: update live migration device status Longfang Liu
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=20230320092338.2889-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
all inboxes | Powered by JetHome®