Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Longfang Liu <liulongfang@huawei.com>
To:     <alex.williamson@redhat.com>, <jgg@nvidia.com>,
        <shameerali.kolothum.thodi@huawei.com>, <john.garry@huawei.com>
CC:     <cohuck@redhat.com>, <linux-kernel@vger.kernel.org>,
        <linuxarm@openeuler.org>, <liulongfang@huawei.com>
Subject: [PATCH v2 2/2] Documentation: Add debugfs for hisi_acc_vfio_pci
Date:   Wed, 19 Oct 2022 16:10:33 +0800
Message-ID: <20221019081033.3169-3-liulongfang@huawei.com>
In-Reply-To: <20221019081033.3169-1-liulongfang@huawei.com>
References: <20221019081033.3169-1-liulongfang@huawei.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 7BIT
Content-Type:   text/plain; charset=US-ASCII
Precedence: bulk

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>
---
 Documentation/ABI/testing/debugfs-hisi-migration | 16 ++++++++++++++++
 1 file changed, 16 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..36f0882c3a52
--- /dev/null
+++ b/Documentation/ABI/testing/debugfs-hisi-migration
@@ -0,0 +1,16 @@
+What:		/sys/kernel/debug/hisi_vfio_acc/<bdf>/state
+Date:		Sep 2022
+Contact:	linux-kernel@vger.kernel.org
+Description:	Cat the status of the live migration of the current VF device.
+		The status of these live migrations includes:
+		Error, RUNNING, STOP, STOP and COPYING, RESUMING.
+
+What:		/sys/kernel/debug/hisi_vfio_acc/<bdf>/debug
+Date:		Sep 2022
+Contact:	linux-kernel@vger.kernel.org
+Description:	This debug file supports "cat" read operations and "echo"
+		write operations. The read debug file operation will return the
+		command description of the write operation. By writing different
+		commands, different test functions can be performed.
+		The specific operation method can be obtained through the
+		"cat debug" command.
-- 
2.24.0