mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
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 v8 4/5] Documentation: add debugfs description for vfio
Date: Fri, 17 Feb 2023 16:48:30 +0800	[thread overview]
Message-ID: <20230217084831.35783-5-liulongfang@huawei.com> (raw)
In-Reply-To: <20230217084831.35783-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        | 17 +++++++++++
 2 files changed, 45 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..0f45f30ff6d4
--- /dev/null
+++ b/Documentation/ABI/testing/debugfs-hisi-migration
@@ -0,0 +1,28 @@
+What:		/sys/kernel/debug/vfio/<bdf>/migration_data
+Date:		Feb 2023
+KernelVersion:  6.2
+Contact:	linux-kernel@vger.kernel.org
+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/<bdf>/migration_attr
+Date:		Feb 2023
+KernelVersion:  6.2
+Contact:	linux-kernel@vger.kernel.org
+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/<bdf>/migration_debug
+Date:		Feb 2023
+KernelVersion:  6.2
+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
diff --git a/Documentation/ABI/testing/debugfs-vfio b/Documentation/ABI/testing/debugfs-vfio
new file mode 100644
index 000000000000..e22531d16674
--- /dev/null
+++ b/Documentation/ABI/testing/debugfs-vfio
@@ -0,0 +1,17 @@
+What:		/sys/kernel/debug/vfio
+Date:		Feb 2023
+KernelVersion:  6.2
+Contact:	linux-kernel@vger.kernel.org
+Description:	This debugfs file directory is used for debugging
+		of vfio devices that support live migration.
+		Each device that supports live migration can create a device
+		subdirectory under this directory by referencing the public
+		registration interface.
+
+What:		/sys/kernel/debug/vfio/<bdf>/migration_state
+Date:		Feb 2023
+KernelVersion:  6.2
+Contact:	linux-kernel@vger.kernel.org
+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


  parent reply	other threads:[~2023-02-17  8:51 UTC|newest]

Thread overview: 25+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-02-17  8:48 [PATCH v8 0/5] add debugfs to migration driver Longfang Liu
2023-02-17  8:48 ` [PATCH v8 1/5] vfio/migration: Add debugfs to live " Longfang Liu
2023-03-10 17:12   ` Jason Gunthorpe
2023-03-14  9:32     ` liulongfang
2023-03-14 11:31       ` liulongfang
2023-03-10 23:40   ` Alex Williamson
2023-03-14  9:42     ` liulongfang
2023-02-17  8:48 ` [PATCH v8 2/5] hisi_acc_vfio_pci: extract public functions for container_of Longfang Liu
2023-03-10 17:18   ` Jason Gunthorpe
2023-03-10 23:40   ` Alex Williamson
2023-03-14 10:34     ` liulongfang
2023-02-17  8:48 ` [PATCH v8 3/5] hisi_acc_vfio_pci: register debugfs for hisilicon migration driver Longfang Liu
2023-03-10 17:22   ` Jason Gunthorpe
2023-03-14 10:35     ` liulongfang
2023-03-10 23:40   ` Alex Williamson
2023-03-14 11:04     ` liulongfang
2023-03-14 11:21       ` liulongfang
2023-03-14 15:17         ` Alex Williamson
2023-03-18  9:07           ` liulongfang
2023-03-18 14:38             ` Alex Williamson
2023-02-17  8:48 ` Longfang Liu [this message]
2023-03-10 23:39   ` [PATCH v8 4/5] Documentation: add debugfs description for vfio Alex Williamson
2023-03-14 10:56     ` liulongfang
2023-02-17  8:48 ` [PATCH v8 5/5] vfio: update live migration device status Longfang Liu
2023-03-10  8:27 ` [PATCH v8 0/5] 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=20230217084831.35783-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®