Re: [PATCH v3 8/8] ABI: sysfs-driver-ufs: Add missing UFS sysfs attributes

[Ziqi Chen <quic_ziqichen@quicinc.com>]

On 2/6/2025 2:12 AM, Bart Van Assche wrote:
> On 2/3/25 12:11 AM, Ziqi Chen wrote:
> 
> Please change the patch title from "Add missing UFS sysfs attributes" 
> into "Add missing UFS sysfs attribute documentation". This patch does 
> not add any sysfs attributes - it adds missing documentation.
> 
>> +What:        /sys/bus/platform/drivers/ufshcd/*/clkscale_enable
>> +What:        /sys/bus/platform/devices/*.ufs/clkscale_enable
>> +Date:        January 2025
>> +Contact:    Ziqi Chen <quic_ziqichen@quicinc.com>
>> +Description:
>> +        This file shows whether the UFS clock scaling is enabled or not.
>> +        And it can be used to enable/disable the clock scaling by 
>> writing
>> +        1 or 0 to this file.
>> +
>> +        The file is read/write.
>> +
>> +What:        /sys/bus/platform/drivers/ufshcd/*/clkgate_enable
>> +What:        /sys/bus/platform/devices/*.ufs/clkgate_enable
>> +Date:        January 2025
>> +Contact:    Ziqi Chen <quic_ziqichen@quicinc.com>
>> +Description:
>> +        This file shows whether the UFS clock gating is enabled or not.
>> +        And it can be used to enable/disable the clock gating by writing
>> +        1 or 0 to this file.
>> +
>> +        The file is read/write.
>> +
>> +What:        /sys/bus/platform/drivers/ufshcd/*/clkgate_delay_ms
>> +What:        /sys/bus/platform/devices/*.ufs/clkgate_delay_ms
>> +Date:        January 2025
>> +Contact:    Ziqi Chen <quic_ziqichen@quicinc.com>
>> +Description:
>> +        This file shows and sets the number of milliseconds of idle time
>> +        before the UFS driver start to perform clock gating. This can
>                                        ^^^^^
>                                        starts
>> +        prevent the UFS from frequently performing clock gate/ungate.
>                                                                   ^^^^^^^
>                                                           gating/ungating
>> +
>> +        The file is read/write.
> 
> 
> Please change the word "file" into "attribute" to make the sysfs 
> attribute documentation consistent with the sysfs documentation for
> other kernel drivers.
> 
> Thanks,
> 
> Bart.

OK , Thanks Bart~

-Ziqi