diff mbox series

[v7,2/3] Documentation: add a isolation strategy sysfs node for uacce

Message ID 20220806022943.47292-3-yekai13@huawei.com (mailing list archive)
State Deferred
Delegated to: Herbert Xu
Headers show
Series crypto: hisilicon - supports device isolation feature | expand

Commit Message

yekai (A) Aug. 6, 2022, 2:29 a.m. UTC
Update documentation describing sysfs node that could help to
configure isolation strategy for users in the user space. And
describing sysfs node that could read the device isolated state.

Signed-off-by: Kai Ye <yekai13@huawei.com>
---
 Documentation/ABI/testing/sysfs-driver-uacce | 26 ++++++++++++++++++++
 1 file changed, 26 insertions(+)

Comments

Greg Kroah-Hartman Sept. 1, 2022, 3:04 p.m. UTC | #1
On Sat, Aug 06, 2022 at 10:29:42AM +0800, Kai Ye wrote:
> Update documentation describing sysfs node that could help to
> configure isolation strategy for users in the user space. And
> describing sysfs node that could read the device isolated state.
> 
> Signed-off-by: Kai Ye <yekai13@huawei.com>
> ---
>  Documentation/ABI/testing/sysfs-driver-uacce | 26 ++++++++++++++++++++
>  1 file changed, 26 insertions(+)
> 
> diff --git a/Documentation/ABI/testing/sysfs-driver-uacce b/Documentation/ABI/testing/sysfs-driver-uacce
> index 08f2591138af..e09fd160d3fa 100644
> --- a/Documentation/ABI/testing/sysfs-driver-uacce
> +++ b/Documentation/ABI/testing/sysfs-driver-uacce
> @@ -19,6 +19,32 @@ 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:           Jul 2022

July was a while ago, you sent this patch in August :(
Eric Biggers Sept. 1, 2022, 5 p.m. UTC | #2
On Thu, Sep 01, 2022 at 05:04:08PM +0200, Greg KH wrote:
> On Sat, Aug 06, 2022 at 10:29:42AM +0800, Kai Ye wrote:
> > Update documentation describing sysfs node that could help to
> > configure isolation strategy for users in the user space. And
> > describing sysfs node that could read the device isolated state.
> > 
> > Signed-off-by: Kai Ye <yekai13@huawei.com>
> > ---
> >  Documentation/ABI/testing/sysfs-driver-uacce | 26 ++++++++++++++++++++
> >  1 file changed, 26 insertions(+)
> > 
> > diff --git a/Documentation/ABI/testing/sysfs-driver-uacce b/Documentation/ABI/testing/sysfs-driver-uacce
> > index 08f2591138af..e09fd160d3fa 100644
> > --- a/Documentation/ABI/testing/sysfs-driver-uacce
> > +++ b/Documentation/ABI/testing/sysfs-driver-uacce
> > @@ -19,6 +19,32 @@ 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:           Jul 2022
> 
> July was a while ago, you sent this patch in August :(
> 

Does the date in the sysfs documentation files serve any purpose besides making
people have to update their patchsets every month?

The kernel version number would be more useful to readers of the documentation,
and it wouldn't have to be updated quite as often.

- Eric
Greg Kroah-Hartman Sept. 1, 2022, 6:09 p.m. UTC | #3
On Thu, Sep 01, 2022 at 10:00:40AM -0700, Eric Biggers wrote:
> On Thu, Sep 01, 2022 at 05:04:08PM +0200, Greg KH wrote:
> > On Sat, Aug 06, 2022 at 10:29:42AM +0800, Kai Ye wrote:
> > > Update documentation describing sysfs node that could help to
> > > configure isolation strategy for users in the user space. And
> > > describing sysfs node that could read the device isolated state.
> > > 
> > > Signed-off-by: Kai Ye <yekai13@huawei.com>
> > > ---
> > >  Documentation/ABI/testing/sysfs-driver-uacce | 26 ++++++++++++++++++++
> > >  1 file changed, 26 insertions(+)
> > > 
> > > diff --git a/Documentation/ABI/testing/sysfs-driver-uacce b/Documentation/ABI/testing/sysfs-driver-uacce
> > > index 08f2591138af..e09fd160d3fa 100644
> > > --- a/Documentation/ABI/testing/sysfs-driver-uacce
> > > +++ b/Documentation/ABI/testing/sysfs-driver-uacce
> > > @@ -19,6 +19,32 @@ 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:           Jul 2022
> > 
> > July was a while ago, you sent this patch in August :(
> > 
> 
> Does the date in the sysfs documentation files serve any purpose besides making
> people have to update their patchsets every month?
> 
> The kernel version number would be more useful to readers of the documentation,
> and it wouldn't have to be updated quite as often.

True, I have seen people use that instead, or no date at all, I don't
require it.  But if you do put the field in there, it should at least be
correct :)

thanks,

greg k-h
yekai (A) Sept. 5, 2022, 12:02 p.m. UTC | #4
On 2022/9/2 2:09, Greg KH wrote:
> On Thu, Sep 01, 2022 at 10:00:40AM -0700, Eric Biggers wrote:
>> On Thu, Sep 01, 2022 at 05:04:08PM +0200, Greg KH wrote:
>>> On Sat, Aug 06, 2022 at 10:29:42AM +0800, Kai Ye wrote:
>>>> Update documentation describing sysfs node that could help to
>>>> configure isolation strategy for users in the user space. And
>>>> describing sysfs node that could read the device isolated state.
>>>>
>>>> Signed-off-by: Kai Ye <yekai13@huawei.com>
>>>> ---
>>>>  Documentation/ABI/testing/sysfs-driver-uacce | 26 ++++++++++++++++++++
>>>>  1 file changed, 26 insertions(+)
>>>>
>>>> diff --git a/Documentation/ABI/testing/sysfs-driver-uacce b/Documentation/ABI/testing/sysfs-driver-uacce
>>>> index 08f2591138af..e09fd160d3fa 100644
>>>> --- a/Documentation/ABI/testing/sysfs-driver-uacce
>>>> +++ b/Documentation/ABI/testing/sysfs-driver-uacce
>>>> @@ -19,6 +19,32 @@ 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:           Jul 2022
>>> July was a while ago, you sent this patch in August :(
>>>
>> Does the date in the sysfs documentation files serve any purpose besides making
>> people have to update their patchsets every month?
>>
>> The kernel version number would be more useful to readers of the documentation,
>> and it wouldn't have to be updated quite as often.
> True, I have seen people use that instead, or no date at all, I don't
> require it.  But if you do put the field in there, it should at least be
> correct :)
>
> thanks,
>
> greg k-h
> .
>
I have fixed the date in version v8

thanks
Kai
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-driver-uacce b/Documentation/ABI/testing/sysfs-driver-uacce
index 08f2591138af..e09fd160d3fa 100644
--- a/Documentation/ABI/testing/sysfs-driver-uacce
+++ b/Documentation/ABI/testing/sysfs-driver-uacce
@@ -19,6 +19,32 @@  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:           Jul 2022
+KernelVersion:  6.0
+Contact:        linux-accelerators@lists.ozlabs.org
+Description:    (RW) Configure the frequency size for the hardware error
+                isolation strategy. This size is a configured integer value.
+                The default is 0. The maximum value is 65535. This value is a
+                threshold based on your driver strategies.
+
+                For example, in the hisilicon accelerator engine, first we will
+                time-stamp every slot AER error. Then check the AER error log
+                when the device AER error occurred. if the device slot AER error
+                count exceeds the preset the number of times in one hour, the
+                isolated state will be set to true. So the device will be
+                isolated. And the AER error log that exceed one hour will be
+                cleared. Of course, different strategies can be defined in
+                different drivers.
+
+What:           /sys/class/uacce/<dev_name>/isolate
+Date:           Jul 2022
+KernelVersion:  6.0
+Contact:        linux-accelerators@lists.ozlabs.org
+Description:    (R) A sysfs node that read the device isolated state. The value 1
+                means the device is unavailable. The 0 means the device is
+                available.
+
 What:           /sys/class/uacce/<dev_name>/algorithms
 Date:           Feb 2020
 KernelVersion:  5.7