Re: [PATCH v11 4/4] Documentation: add debugfs description for hisi migration

[Alex Williamson]

On Fri, 25 Oct 2024 17:01:43 +0800
Longfang Liu <liulongfang@xxxxxxxxxx> wrote:

> 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@xxxxxxxxxx>
> Reviewed-by: Shameer Kolothum <shameerali.kolothum.thodi@xxxxxxxxxx>
> ---
>  .../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..89e4fde5ec6a
> --- /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:		Oct 2024
> +KernelVersion:  6.12

We're currently targeting v6.13, which is likely Jan 2025.  Thanks,

Alex

> +Contact:	Longfang Liu <liulongfang@xxxxxxxxxx>
> +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:		Oct 2024
> +KernelVersion:  6.12
> +Contact:	Longfang Liu <liulongfang@xxxxxxxxxx>
> +Description:	Read the data from the last completed live migration.
> +		This data includes the same device status data as in "dev_data".
> +		The migf_data is the dev_data that is migrated.
> +
> +What:		/sys/kernel/debug/vfio/<device>/migration/hisi_acc/cmd_state
> +Date:		Oct 2024
> +KernelVersion:  6.12
> +Contact:	Longfang Liu <liulongfang@xxxxxxxxxx>
> +Description:	Used to obtain the device command sending and receiving
> +		channel status. Returns failure or success logs based on the
> +		results.