diff mbox series

[v7,4/4] Documentation: add debugfs description for hisi migration

Message ID 20240730121438.58455-5-liulongfang@huawei.com (mailing list archive)
State New, archived
Headers show
Series debugfs to hisilicon migration driver | expand

Commit Message

liulongfang July 30, 2024, 12:14 p.m. UTC
Add a debugfs document description file to help users understand
how to use the hisilicon accelerator live migration driver's
debugfs.

Update the file paths that need to be maintained in MAINTAINERS

Signed-off-by: Longfang Liu <liulongfang@huawei.com>
---
 .../ABI/testing/debugfs-hisi-migration        | 25 +++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 Documentation/ABI/testing/debugfs-hisi-migration

Comments

Shameerali Kolothum Thodi Aug. 5, 2024, 9:09 a.m. UTC | #1
> -----Original Message-----
> From: liulongfang <liulongfang@huawei.com>
> Sent: Tuesday, July 30, 2024 1:15 PM
> To: alex.williamson@redhat.com; jgg@nvidia.com; Shameerali Kolothum
> Thodi <shameerali.kolothum.thodi@huawei.com>; Jonathan Cameron
> <jonathan.cameron@huawei.com>
> Cc: kvm@vger.kernel.org; linux-kernel@vger.kernel.org;
> linuxarm@openeuler.org; liulongfang <liulongfang@huawei.com>
> Subject: [PATCH v7 4/4] Documentation: add debugfs description for hisi
> migration
> 
> Add a debugfs document description file to help users understand
> how to use the hisilicon accelerator live migration driver's
> debugfs.
> 
> Update the file paths that need to be maintained in MAINTAINERS
> 
> Signed-off-by: Longfang Liu <liulongfang@huawei.com>
> ---
>  .../ABI/testing/debugfs-hisi-migration        | 25 +++++++++++++++++++
>  1 file changed, 25 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..053f3ebba9b1
> --- /dev/null
> +++ b/Documentation/ABI/testing/debugfs-hisi-migration
> @@ -0,0 +1,25 @@
> +What:
> 	/sys/kernel/debug/vfio/<device>/migration/hisi_acc/dev_data
> +Date:		Jul 2024
> +KernelVersion:  6.11
> +Contact:	Longfang Liu <liulongfang@huawei.com>
> +Description:	Read the configuration data and some status data
> +		required for device live migration. These data include device
> +		status data, queue configuration data, some task
> configuration
> +		data and device attribute data. The output format of the data
> +		is defined by the live migration driver.
> +
> +What:
> 	/sys/kernel/debug/vfio/<device>/migration/hisi_acc/migf_data
> +Date:		Jul 2024
> +KernelVersion:  6.11
> +Contact:	Longfang Liu <liulongfang@huawei.com>
> +Description:	Read the data from the last completed live migration.
> +		This data includes the same device status data as in
> "dev_data".
> +		And some device status data after the migration is
> completed.

Actually what info is different from dev_data here? Only that it is the
dev_data after a migration is attempted/completed, right?

Thanks,
Shameer

> +
> +What:
> 	/sys/kernel/debug/vfio/<device>/migration/hisi_acc/cmd_state
> +Date:		Jul 2024
> +KernelVersion:  6.11
> +Contact:	Longfang Liu <liulongfang@huawei.com>
> +Description:	Used to obtain the device command sending and receiving
> +		channel status. Returns failure or success logs based on the
> +		results.
> --
> 2.24.0
liulongfang Aug. 6, 2024, 8:37 a.m. UTC | #2
On 2024/8/5 17:09, Shameerali Kolothum Thodi wrote:
> 
> 
>> -----Original Message-----
>> From: liulongfang <liulongfang@huawei.com>
>> Sent: Tuesday, July 30, 2024 1:15 PM
>> To: alex.williamson@redhat.com; jgg@nvidia.com; Shameerali Kolothum
>> Thodi <shameerali.kolothum.thodi@huawei.com>; Jonathan Cameron
>> <jonathan.cameron@huawei.com>
>> Cc: kvm@vger.kernel.org; linux-kernel@vger.kernel.org;
>> linuxarm@openeuler.org; liulongfang <liulongfang@huawei.com>
>> Subject: [PATCH v7 4/4] Documentation: add debugfs description for hisi
>> migration
>>
>> Add a debugfs document description file to help users understand
>> how to use the hisilicon accelerator live migration driver's
>> debugfs.
>>
>> Update the file paths that need to be maintained in MAINTAINERS
>>
>> Signed-off-by: Longfang Liu <liulongfang@huawei.com>
>> ---
>>  .../ABI/testing/debugfs-hisi-migration        | 25 +++++++++++++++++++
>>  1 file changed, 25 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..053f3ebba9b1
>> --- /dev/null
>> +++ b/Documentation/ABI/testing/debugfs-hisi-migration
>> @@ -0,0 +1,25 @@
>> +What:
>> 	/sys/kernel/debug/vfio/<device>/migration/hisi_acc/dev_data
>> +Date:		Jul 2024
>> +KernelVersion:  6.11
>> +Contact:	Longfang Liu <liulongfang@huawei.com>
>> +Description:	Read the configuration data and some status data
>> +		required for device live migration. These data include device
>> +		status data, queue configuration data, some task
>> configuration
>> +		data and device attribute data. The output format of the data
>> +		is defined by the live migration driver.
>> +
>> +What:
>> 	/sys/kernel/debug/vfio/<device>/migration/hisi_acc/migf_data
>> +Date:		Jul 2024
>> +KernelVersion:  6.11
>> +Contact:	Longfang Liu <liulongfang@huawei.com>
>> +Description:	Read the data from the last completed live migration.
>> +		This data includes the same device status data as in
>> "dev_data".
>> +		And some device status data after the migration is
>> completed.
> 
> Actually what info is different from dev_data here? Only that it is the
> dev_data after a migration is attempted/completed, right?
>

Yes, the only difference is: The mig_data is the dev_data that is migrated.

Thanks.
Longfang.

> Thanks,
> Shameer
> 
>> +
>> +What:
>> 	/sys/kernel/debug/vfio/<device>/migration/hisi_acc/cmd_state
>> +Date:		Jul 2024
>> +KernelVersion:  6.11
>> +Contact:	Longfang Liu <liulongfang@huawei.com>
>> +Description:	Used to obtain the device command sending and receiving
>> +		channel status. Returns failure or success logs based on the
>> +		results.
>> --
>> 2.24.0
> 
> .
>
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/debugfs-hisi-migration b/Documentation/ABI/testing/debugfs-hisi-migration
new file mode 100644
index 000000000000..053f3ebba9b1
--- /dev/null
+++ b/Documentation/ABI/testing/debugfs-hisi-migration
@@ -0,0 +1,25 @@ 
+What:		/sys/kernel/debug/vfio/<device>/migration/hisi_acc/dev_data
+Date:		Jul 2024
+KernelVersion:  6.11
+Contact:	Longfang Liu <liulongfang@huawei.com>
+Description:	Read the configuration data and some status data
+		required for device live migration. These data include device
+		status data, queue configuration data, some task configuration
+		data and device attribute data. The output format of the data
+		is defined by the live migration driver.
+
+What:		/sys/kernel/debug/vfio/<device>/migration/hisi_acc/migf_data
+Date:		Jul 2024
+KernelVersion:  6.11
+Contact:	Longfang Liu <liulongfang@huawei.com>
+Description:	Read the data from the last completed live migration.
+		This data includes the same device status data as in "dev_data".
+		And some device status data after the migration is completed.
+
+What:		/sys/kernel/debug/vfio/<device>/migration/hisi_acc/cmd_state
+Date:		Jul 2024
+KernelVersion:  6.11
+Contact:	Longfang Liu <liulongfang@huawei.com>
+Description:	Used to obtain the device command sending and receiving
+		channel status. Returns failure or success logs based on the
+		results.