ufs: core: Add WB buffer resize support
Subsystems (2)
PATCH v6 1/1 ufs: core: Add WB buffer resize support
Support WB buffer resize function through sysfs, the host can obtain resize hint and resize status and enable the resize operation. To achieve this goals, three sysfs nodes have been added:
1. wb_resize_enable
2. wb_resize_hint
3. wb_resize_status
The detailed definition of the three nodes can be found in the sysfs documentation.
Changelog
===
v5 - > v6:
1.Fix mistake: obtain the return value of "sysfs_emit"
v4 - > v5:
1.For the three new attributes: use words in sysfs instead of numbers
v3 - > v4:
1.modify three attributes name and description in document 2.add enum wb_resize_en in ufs.h
3.modify function name and parameters in ufs-sysfs.c, ufshcd.h, ufshcd.c
v2 - > v3:
remove needless code:
drivers/ufs/core/ufs-sysfs.c:441:2:
index = ufshcd_wb_get_query_index(hba)
v1 - > v2:
remove unused variable "u8 index", drivers/ufs/core/ufs-sysfs.c:419:12: warning: variable 'index' set but not used.
v1
https://lore.kernel.org/all/[email protected]/ v2 https://lore.kernel.org/all/[email protected]/ v3 https://lore.kernel.org/all/[email protected]/ v4 https://lore.kernel.org/all/[email protected]/ v5 https://lore.kernel.org/all/[email protected]/
--- Documentation/ABI/testing/sysfs-driver-ufs | 51 ++++++++ drivers/ufs/core/ufs-sysfs.c | 131 +++++++++++++++++++++ drivers/ufs/core/ufshcd.c | 15 +++ include/ufs/ufs.h | 27 ++++- include/ufs/ufshcd.h | 1 + 5 files changed, 224 insertions(+), 1 deletion(-)
Documentation/ABI/testing/sysfs-driver-ufs +51 -0
@@ -1559,3 +1559,54 @@ 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/*/wb_resize_enable +What: /sys/bus/platform/devices/*.ufs/wb_resize_enable +Date: Nov 2024 +Contact: Huan Tang <[email protected]> +Description: + The host can decrease or increase the WriteBooster Buffer size by setting + this attribute. + + ======== ====================================== + decrease Decrease WriteBooster Buffer Size + increase Increase WriteBooster Buffer Size + Others Reserved + ======== ====================================== + + The attribute is write only. + +What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_resize_hint +What: /sys/bus/platform/devices/*.ufs/attributes/wb_resize_hint +Date: Nov 2024 +Contact: Huan Tang <[email protected]> +Description: + wb_resize_hint indicates hint information about which type of resize for + WriteBooster Buffer is recommended by the device. + + ========= ====================================== + keep Recommend keep the buffer size + decrease Recommend to decrease the buffer size + increase Recommend to increase the buffer size + Others Reserved + ========= ====================================== + + The attribute is read only. + +What: /sys/bus/platform/drivers/ufshcd/*/attributes/wb_resize_status +What: /sys/bus/platform/devices/*.ufs/attributes/wb_resize_status +Date: Nov 2024 +Contact: Huan Tang <[email protected]> +Description: + The host can check the Resize operation status of the WriteBooster Buffer + by reading this attribute. + + ================ ======================================== + idle Idle (resize operation is not issued) + in-progress Resize operation in progress + complete-success Resize operation completed successfully + general-fail Resize operation general failure + Others Reserved + ================ ======================================== + + The attribute is read only.
drivers/ufs/core/ufs-sysfs.c +131 -0
161 lines not on this page · raw message
drivers/ufs/core/ufshcd.c +15 -0
@@ -6167,6 +6167,21 @@ static bool ufshcd_wb_need_flush(struct ufs_hba *hba)return ufshcd_wb_presrv_usrspc_keep_vcc_on (hba, avail_buf); } +int ufshcd_wb_set_resize_en (struct ufs_hba *hba,u32 en_mode) +{ +int ret; +u8 index; + + index =ufshcd_wb_get_query_index (hba); + ret =ufshcd_query_attr_retry (hba,UPIU_QUERY_OPCODE_WRITE_ATTR , +QUERY_ATTR_IDN_WB_BUF_RESIZE_EN , index,0 , &en_mode); +if (ret) +dev_err (hba->dev,"%s: Enable WB buf resize operation failed %d\n" , + __func__, ret); + +return ret; +} +static void ufshcd_rpm_dev_flush_recheck_work (struct work_struct *work) { struct ufs_hba *hba = container_of(to_delayed_work(work),
include/ufs/ufs.h +26 -1
@@ -181,7 +181,10 @@ enum attr_idn {QUERY_ATTR_IDN_WB_BUFF_LIFE_TIME_EST =0x1E ,QUERY_ATTR_IDN_CURR_WB_BUFF_SIZE =0x1F ,QUERY_ATTR_IDN_EXT_IID_EN =0x2A , - QUERY_ATTR_IDN_TIMESTAMP = 0x30 +QUERY_ATTR_IDN_TIMESTAMP =0x30 , +QUERY_ATTR_IDN_WB_BUF_RESIZE_HINT =0x3C , +QUERY_ATTR_IDN_WB_BUF_RESIZE_EN =0x3D , + QUERY_ATTR_IDN_WB_BUF_RESIZE_STATUS = 0x3E, };/* Descriptor idn for Query requests */
@@ -455,6 +458,28 @@ enum ufs_ref_clk_freq { REF_CLK_FREQ_INVAL = -1, }; +/* bWriteBoosterBufferResizeEn attribute */ +enum wb_resize_en { +WB_RESIZE_EN_IDLE =0 , +WB_RESIZE_EN_DECREASE =1 , +WB_RESIZE_EN_INCREASE =2 , +}; + +/* bWriteBoosterBufferResizeHint attribute */ +enum wb_resize_hint { +WB_RESIZE_HINT_KEEP =0 , +WB_RESIZE_HINT_DECREASE =1 , +WB_RESIZE_HINT_INCREASE =2 , +}; + +/* bWriteBoosterBufferResizeStatus attribute */ +enum wb_resize_status { +WB_RESIZE_STATUS_IDLE =0 , +WB_RESIZE_STATUS_IN_PROGRESS =1 , +WB_RESIZE_STATUS_COMPLETE_SUCCESS =2 , +WB_RESIZE_STATUS_GENERAL_FAIL =3 , +}; +/* Query response result code */ enum {QUERY_RESULT_SUCCESS =0x00 ,
include/ufs/ufshcd.h +1 -0
@@ -1454,6 +1454,7 @@ int ufshcd_advanced_rpmb_req_handler(struct ufs_hba *hba, struct utp_upiu_req *r struct scatterlist *sg_list, enum dma_data_direction dir);int ufshcd_wb_toggle (struct ufs_hba *hba,bool enable);int ufshcd_wb_toggle_buf_flush (struct ufs_hba *hba,bool enable); +int ufshcd_wb_set_resize_en (struct ufs_hba *hba,u32 en_mode);int ufshcd_suspend_prepare (struct device *dev);int __ufshcd_suspend_prepare (struct device *dev,bool rpm_ok_for_spm);void ufshcd_resume_complete (struct device *dev);
Signature · 1 line
2.39.0