From: liulongfang <liulongfang@huawei.com>
To: Alex Williamson <alex.williamson@redhat.com>
Cc: <jgg@nvidia.com>, <shameerali.kolothum.thodi@huawei.com>,
<jonathan.cameron@huawei.com>, <cohuck@redhat.com>,
<linux-kernel@vger.kernel.org>, <linuxarm@openeuler.org>
Subject: Re: [PATCH v7 4/5] Documentation: add debugfs description for hisi_acc_vfio_pci
Date: Wed, 1 Feb 2023 11:26:51 +0800 [thread overview]
Message-ID: <4df2026a-51b4-f9a9-463b-0ad9e38d054a@huawei.com> (raw)
In-Reply-To: <20230126122805.1e17d08b.alex.williamson@redhat.com>
On 2023/1/27 3:28, Alex Williamson wrote:
> On Fri, 20 Jan 2023 11:29:29 +0800
> Longfang Liu <liulongfang@huawei.com> wrote:
>
>> 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>
>> ---
>> .../ABI/testing/debugfs-hisi-migration | 32 +++++++++++++++++++
>> 1 file changed, 32 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..d644a497c464
>> --- /dev/null
>> +++ b/Documentation/ABI/testing/debugfs-hisi-migration
>> @@ -0,0 +1,32 @@
>> +What: /sys/kernel/debug/vfio_mig/<bdf>/state
>> +Date: Jan 2023
>> +Contact: linux-kernel@vger.kernel.org
>> +Description: Read the live migration status of the VF device.
>> + The status of these live migrations includes:
>> + ERROR, RUNNING, STOP, STOP_COPY, RESUMING.
>
> state is added by vfio-pci-core in this series, so the documentation
> can't be limited to hisi_acc.
>
>> +
>> +What: /sys/kernel/debug/vfio_mig/<bdf>/mig_data
>> +Date: Jan 2023
>> +Contact: linux-kernel@vger.kernel.org
>> +Description: Read the live migration data of the VF device.
>> + The output format of the data is defined by the live
>> + migration driver.
>> +
>> +What: /sys/kernel/debug/vfio_mig/<bdf>/mig_attr
>> +Date: Jan 2023
>> +Contact: linux-kernel@vger.kernel.org
>> +Description: Read the live migration attributes of the VF device.
>> + The output format of the attributes is defined by the live
>> + migration driver.
>> +
>> +What: /sys/kernel/debug/vfio_mig/<bdf>/debug
>> +Date: Jan 2023
>> +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
>
> I think the goal here is to create some sort of standard interface for
> migration, so these should also be documented for all devices, and any
> device specific behavior noted. Otherwise these should all be prefixed
> hisi_acc_ to denote them as device specific implementations. Thanks,
>
Ok, the ABI file name needs to be changed, and the internal description needs
to be updated, not limited to hisi_acc.
> Alex
>
Thansk,
Longfang.
> .
>
next prev parent reply other threads:[~2023-02-01 3:27 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-01-20 3:29 [PATCH v7 0/5] add debugfs to migration driver Longfang Liu
2023-01-20 3:29 ` [PATCH v7 1/5] vfio/migration: Add debugfs to live " Longfang Liu
2023-01-26 19:27 ` Alex Williamson
2023-02-01 3:20 ` liulongfang
2023-02-01 16:36 ` Alex Williamson
2023-01-20 3:29 ` [PATCH v7 2/5] hisi_acc_vfio_pci: extract public functions for container_of Longfang Liu
2023-01-20 3:29 ` [PATCH v7 3/5] hisi_acc_vfio_pci: register debugfs for hisilicon migration driver Longfang Liu
2023-01-26 19:28 ` Alex Williamson
2023-02-01 3:24 ` liulongfang
2023-01-20 3:29 ` [PATCH v7 4/5] Documentation: add debugfs description for hisi_acc_vfio_pci Longfang Liu
2023-01-26 19:28 ` Alex Williamson
2023-02-01 3:26 ` liulongfang [this message]
2023-01-20 3:29 ` [PATCH v7 5/5] vfio: update live migration device status Longfang Liu
2023-01-26 19:28 ` Alex Williamson
2023-02-01 3:36 ` 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=4df2026a-51b4-f9a9-463b-0ad9e38d054a@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;
as well as URLs for NNTP newsgroup(s).