Re: [PATCH v2 2/3] Documentation: add a isolation strategy vfs node for uacce

["yekai(A)" <yekai13@huawei.com>]

On 2022/6/15 16:48, Jonathan Cameron wrote:
> On Tue, 14 Jun 2022 14:41:52 +0200
> Greg KH <gregkh@linuxfoundation.org> wrote:
>
>> On Tue, Jun 14, 2022 at 08:29:39PM +0800, Kai Ye wrote:
>>> Update documentation describing DebugFS that could help to
>>> configure hard error frequency for users in th user space.
>>>
>>> Signed-off-by: Kai Ye <yekai13@huawei.com>
>>> ---
>>>  Documentation/ABI/testing/sysfs-driver-uacce | 17 +++++++++++++++++
>>>  1 file changed, 17 insertions(+)
>>>
>>> diff --git a/Documentation/ABI/testing/sysfs-driver-uacce b/Documentation/ABI/testing/sysfs-driver-uacce
>>> index 08f2591138af..0c4226364182 100644
>>> --- a/Documentation/ABI/testing/sysfs-driver-uacce
>>> +++ b/Documentation/ABI/testing/sysfs-driver-uacce
>>> @@ -19,6 +19,23 @@ Contact:        linux-accelerators@lists.ozlabs.org
>>>  Description:    Available instances left of the device
>>>                  Return -ENODEV if uacce_ops get_available_instances is not provided
>>>
>>> +What:           /sys/class/uacce/<dev_name>/isolate_strategy
>>> +Date:           Jun 2022
>>> +KernelVersion:  5.19
>>> +Contact:        linux-accelerators@lists.ozlabs.org
>>> +Description:    A vfs node that used to configures the hardware
>>
>> What is a "vfs node"?
>>
>>> +                error frequency. This frequency is abstract. Like once an hour
>>> +                or once a day. The specific isolation strategy can be defined in
>>> +                each driver module.
>>
>> No, you need to be specific here and describe the units and the format.
>> Otherwise it is no description at all :(
>
> Also, rename it.   A frequency isn't a strategy.  Strategy would be something
> like:
>
> * First fault
> * Faults in moving time window.
> * Faults in fixed time window.
>
> some of which would then need separate controls for the threshold and the
> time window - those should be in separate sysfs attributes.
>

I will describe the units and the format in here.

Thanks

Kai
>>
>>> +
>>> +What:           /sys/class/uacce/<dev_name>/isolate
>>> +Date:           Jun 2022
>>> +KernelVersion:  5.19
>>
>> 5.19 will not have this change.
>>
>>> +Contact:        linux-accelerators@lists.ozlabs.org
>>> +Description:    A vfs node that show the device isolated state. The value 0
>>> +                means that the device is working. The value 1 means that the
>>> +                device has been isolated.
>>
>> What does "working" or "isolated" mean?
>>
>> thanks,
>>
>> greg k-h
>
> .
>