Add UFS driver sysfs addributes clkscale_enable, clkgate_enable and
clkgate_delay_ms to this doucment.

Signed-off-by: Ziqi Chen <quic_ziqichen@quicinc.com>
---
v1 -> v2:
It is a new patch be added to this series since v2.
---
 Documentation/ABI/testing/sysfs-driver-ufs | 31 ++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/Documentation/ABI/testing/sysfs-driver-ufs b/Documentation/ABI/testing/sysfs-driver-ufs
index 5fa6655aee84..7f60821c29ca 100644
--- a/Documentation/ABI/testing/sysfs-driver-ufs
+++ b/Documentation/ABI/testing/sysfs-driver-ufs
@@ -1559,3 +1559,34 @@ Description:
 		Symbol - HCMID. This file shows the UFSHCD manufacturer id.
 		The Manufacturer ID is defined by JEDEC in JEDEC-JEP106.
 		The file is read only.
+
+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 the status of UFS clock scaling enablement
+		and it can be used to enable/disable clock scaling.
+
+		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 the status of UFS clock gating enablement
+		and it can be used to enable/disable clock gating.
+
+		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 do clock gating. This can
+		prevent the UFS from frequently performing clock gate/ungate.
+
+		The file is read write.
-- 
2.34.1

On 22/01/2025 10:02, Ziqi Chen wrote:
> Add UFS driver sysfs addributes clkscale_enable, clkgate_enable and
> clkgate_delay_ms to this doucment.

I'm 99% sure you mean "attributes" not "addributes"

---
bod

On 1/23/2025 7:36 PM, Bryan O'Donoghue wrote:
> On 22/01/2025 10:02, Ziqi Chen wrote:
>> Add UFS driver sysfs addributes clkscale_enable, clkgate_enable and
>> clkgate_delay_ms to this doucment.
> 
> I'm 99% sure you mean "attributes" not "addributes"
> 
> ---
> bod

Yes , thanks for point it out, bod.

-Ziqi

On 1/22/25 2:02 AM, Ziqi Chen wrote:
> +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 the status of UFS clock scaling enablement
> +		and it can be used to enable/disable clock scaling.
> +
> +		The file is read write.

Please improve the grammar of this and other descriptions, e.g. by 
changing the above description into the following: "Whether or not
clock scaling is enabled. This attribute is read/write."

Thanks,

Bart.

On 1/23/2025 2:35 AM, Bart Van Assche wrote:
> On 1/22/25 2:02 AM, Ziqi Chen wrote:
>> +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 the status of UFS clock scaling enablement
>> +        and it can be used to enable/disable clock scaling.
>> +
>> +        The file is read write.
> 
> Please improve the grammar of this and other descriptions, e.g. by 
> changing the above description into the following: "Whether or not
> clock scaling is enabled. This attribute is read/write."
> 
> Thanks,
> 
> Bart.

Hi Bart,

Thanks , I will improve it.

-Ziqi