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

Update documentation describing sysfs node that could help to
configure isolation method command for users in th user space.

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

On 2022/6/23 17:01, Greg KH wrote:
> On Thu, Jun 23, 2022 at 02:14:51PM +0800, Kai Ye wrote:
>> Update documentation describing sysfs node that could help to
>> configure isolation method command for users in th user space.
>>
>> Signed-off-by: Kai Ye <yekai13@huawei.com>
>> ---
>>  Documentation/ABI/testing/sysfs-driver-uacce | 18 ++++++++++++++++++
>>  1 file changed, 18 insertions(+)
>>
>> diff --git a/Documentation/ABI/testing/sysfs-driver-uacce b/Documentation/ABI/testing/sysfs-driver-uacce
>> index 08f2591138af..8784efa96e01 100644
>> --- a/Documentation/ABI/testing/sysfs-driver-uacce
>> +++ b/Documentation/ABI/testing/sysfs-driver-uacce
>> @@ -19,6 +19,24 @@ 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.20
>> +Contact:        linux-accelerators@lists.ozlabs.org
>> +Description:    A sysfs node that used to configures the hardware error
>> +                isolation method command. The command can be parsed
>> +                in correct driver. e.g. If the device slot reset frequency
>> +                exceeds the preset value in a time window, the device will be
>> +                isolated.
>
> What is the "command"?  What is being parsed?  This needs to be
> documented a lot more here, this is very vague and not obvious at all.
>
>

This command is a string command issued by the user. After the command 
is configured, the acc driver parses the command.
>> +
>> +What:           /sys/class/uacce/<dev_name>/isolate
>> +Date:           Jun 2022
>> +KernelVersion:  5.20
>> +Contact:        linux-accelerators@lists.ozlabs.org
>> +Description:    A sysfs 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.
>
> Are these read-only?  Write only?  read/write?

this node is read-only
>
> thanks,
>
> greg k-h
> .
>

Thanks
Kai

On Fri, Jun 24, 2022 at 11:25:10AM +0800, yekai(A) wrote:
> 
> 
> On 2022/6/23 17:01, Greg KH wrote:
> > On Thu, Jun 23, 2022 at 02:14:51PM +0800, Kai Ye wrote:
> > > Update documentation describing sysfs node that could help to
> > > configure isolation method command for users in th user space.
> > > 
> > > Signed-off-by: Kai Ye <yekai13@huawei.com>
> > > ---
> > >  Documentation/ABI/testing/sysfs-driver-uacce | 18 ++++++++++++++++++
> > >  1 file changed, 18 insertions(+)
> > > 
> > > diff --git a/Documentation/ABI/testing/sysfs-driver-uacce b/Documentation/ABI/testing/sysfs-driver-uacce
> > > index 08f2591138af..8784efa96e01 100644
> > > --- a/Documentation/ABI/testing/sysfs-driver-uacce
> > > +++ b/Documentation/ABI/testing/sysfs-driver-uacce
> > > @@ -19,6 +19,24 @@ 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.20
> > > +Contact:        linux-accelerators@lists.ozlabs.org
> > > +Description:    A sysfs node that used to configures the hardware error
> > > +                isolation method command. The command can be parsed
> > > +                in correct driver. e.g. If the device slot reset frequency
> > > +                exceeds the preset value in a time window, the device will be
> > > +                isolated.
> > 
> > What is the "command"?  What is being parsed?  This needs to be
> > documented a lot more here, this is very vague and not obvious at all.
> > 
> > 
> 
> This command is a string command issued by the user. After the command is
> configured, the acc driver parses the command.

I am sorry, but I do not understand what you mean here.  What exactly is
a "command"?  What format is it in?  What are valid commands?  What are
invalid commands?  Are these commands different for different devices?
What do the commands do?  What are the return values for the commands?
And so on.

You are creating a new user/kernel API here and so you must define it
very specifically.  You have not speficied anything for us to know how
this works at all and so we can not accept this for that reason alone
(nor should you want us to.)

thanks,

greg k-h