2022-06-14 12:35:30

by yekai (A)

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

Update documentation describing DebugFS that could help to
configure hard error frequency for users in th user space.

Signed-off-by: Kai Ye <[email protected]>
---
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: [email protected]
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: [email protected]
+Description: A vfs node that used to configures the hardware
+ 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.
+
+What: /sys/class/uacce/<dev_name>/isolate
+Date: Jun 2022
+KernelVersion: 5.19
+Contact: [email protected]
+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: /sys/class/uacce/<dev_name>/algorithms
Date: Feb 2020
KernelVersion: 5.7
--
2.33.0


2022-06-14 12:45:33

by Greg KH

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

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 <[email protected]>
> ---
> 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: [email protected]
> 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: [email protected]
> +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 :(

> +
> +What: /sys/class/uacce/<dev_name>/isolate
> +Date: Jun 2022
> +KernelVersion: 5.19

5.19 will not have this change.

> +Contact: [email protected]
> +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

2022-06-15 08:49:31

by Jonathan Cameron

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

On Tue, 14 Jun 2022 14:41:52 +0200
Greg KH <[email protected]> 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 <[email protected]>
> > ---
> > 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: [email protected]
> > 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: [email protected]
> > +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.

>
> > +
> > +What: /sys/class/uacce/<dev_name>/isolate
> > +Date: Jun 2022
> > +KernelVersion: 5.19
>
> 5.19 will not have this change.
>
> > +Contact: [email protected]
> > +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

2022-06-15 09:28:40

by yekai (A)

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



On 2022/6/15 16:48, Jonathan Cameron wrote:
> On Tue, 14 Jun 2022 14:41:52 +0200
> Greg KH <[email protected]> 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 <[email protected]>
>>> ---
>>> 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: [email protected]
>>> 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: [email protected]
>>> +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: [email protected]
>>> +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
>
> .
>