| Message ID | 20250203081109.1614395-9-quic_ziqichen@quicinc.com |
|---|---|
| State | New |
| Headers | show |
| Series | Support Multi-frequency scale for UFS | expand |
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.
diff --git a/Documentation/ABI/testing/sysfs-driver-ufs b/Documentation/ABI/testing/sysfs-driver-ufs index 5fa6655aee84..9b1e22416346 100644 --- a/Documentation/ABI/testing/sysfs-driver-ufs +++ b/Documentation/ABI/testing/sysfs-driver-ufs @@ -1559,3 +1559,36 @@ 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 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 + prevent the UFS from frequently performing clock gate/ungate. + + The file is read/write.
Add UFS driver sysfs attributes 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. v2 -> v3: 1. Typo fixed for commit message. 2. Improve the grammar of attributes' descriptions. --- Documentation/ABI/testing/sysfs-driver-ufs | 33 ++++++++++++++++++++++ 1 file changed, 33 insertions(+)