Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Lu Hongfei <luhongfei@vivo.com>
To:     Alim Akhtar <alim.akhtar@samsung.com>,
        Avri Altman <avri.altman@wdc.com>,
        Bart Van Assche <bvanassche@acm.org>,
        "James E.J. Bottomley" <jejb@linux.ibm.com>,
        "Martin K. Petersen" <martin.petersen@oracle.com>,
        Bean Huo <beanhuo@micron.com>,
        Jinyoung Choi <j-young.choi@samsung.com>,
        Peter Wang <peter.wang@mediatek.com>,
        Daniil Lunev <dlunev@chromium.org>,
        Lu Hongfei <luhongfei@vivo.com>,
        linux-scsi@vger.kernel.org (open list:UNIVERSAL FLASH STORAGE HOST
        CONTROLLER DRIVER), linux-kernel@vger.kernel.org (open list)
Cc:     opensource.kernel@vivo.com
Subject: [PATCH] scsi: ufs: wb: Add explicit flush_threshold sysfs attribute
Date:   Thu,  8 Jun 2023 18:16:40 +0800
Message-Id: <20230608101642.40086-1-luhongfei@vivo.com>
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
MIME-Version: 1.0
X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1
X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?UA6b+RWyBsEkYOwh5EzuZF+tw/Okogcq9cL5PcLQPnG8ecuy6XlP0WnJlLmk?=
 =?us-ascii?Q?vfT8SbEhhZVJjfgrvCXiw32MBAcM5fjFbJtYPpxj6VOnqRbS7chgwSHkdc3J?=
 =?us-ascii?Q?13gB3c7PIBXafQg/QFV4ZFmSEs+y//RRHLYIL+FELsDjfsZPXMLW47rmZkOI?=
 =?us-ascii?Q?KGMgTrOrPlGWZo9nYyYQIIpNBkmgb/EjEXtfklVqqosAIAPDcDslNfB34C3Z?=
 =?us-ascii?Q?frZW5shKgHfmlUiKbwUE3/GVgm0/5tSSxBiAV3Vh0tkNrDXexa8ndv2PIIW7?=
 =?us-ascii?Q?KWNO1Vi6iYuTd7Cs8TZkUVKXrSJk75BPKcAI8Zt2t+4bvVdZzfxhptrC2MM9?=
 =?us-ascii?Q?FphRenyRngiMWFCbJkd3G24isc6GjH9n9UgEc/RqSnppZUpIwAVLnrpY7BUS?=
 =?us-ascii?Q?VmPTgLcjg8O2Lve16xCyhEfZh/h6aiiBooWfPB979+YwMtFgZnWv5FrBwjiN?=
 =?us-ascii?Q?0OE3zNNDgpQsOx7jJ0BFO2rY9q/zBESAB7IA4I0QqGAFrLTlAgWsERA/r6ol?=
 =?us-ascii?Q?XxmC7lXFKtzxW7B/nRxtFULYgX1+W4UDfBNeWDmB/GCXjqvFXV5kfF7S//4I?=
 =?us-ascii?Q?Iv8CRn3hlJVbjuasnbo6OxtxKk0j7VA8lLLUH1xh2FGBfXW35lO+2/S1PCCB?=
 =?us-ascii?Q?CG8Zp94lmSLshWx8XnNCRhFq7a2gKcx83BMIgJ3UsXgixM97F3i8deP4+aZ5?=
 =?us-ascii?Q?cx5A6gnPJ+e8Sa3inGMJhoSJulz2EHJfatrzFK/kgIUDpslDPT19CuaEtsiI?=
 =?us-ascii?Q?MTzmNrE09+nJzA5dB6DNjDZjQ9wNKbc8A8UXikBZG/73ptw3v1qGjo5QB5Zh?=
 =?us-ascii?Q?TQL6q4rh8osDwfFYEMh0o7hukPBpDtbwt4Nz6SqtHixbNFW+CusxNnPYRhYW?=
 =?us-ascii?Q?b59HzUaWxSTEA8rtbctNtO6ckj3yomXRILoLuHmwVI05oAtYAdscwaQYgwgc?=
 =?us-ascii?Q?OG5+BAIpn+oJVmIWhi51xe55vYrSWOtyUf/Q1gPUjRyDTv2xwKf2w4MccI71?=
 =?us-ascii?Q?w8sG96PWx1jKnEn4xg+EzG3irHunMPYj2kft5Cn4EDKTo8WEKJLhU6+RKKHT?=
 =?us-ascii?Q?dCptdKi91Rfpy5ZMV5FDj9fBgFIR/aQoWTj7+RP3/t0NcIy6x1lsqozizDBo?=
 =?us-ascii?Q?6IELYa6UV9dP1T3Hzrhf6/uSj50IrGDNA435s0nicnIfKhyMbeS1xumYAokX?=
 =?us-ascii?Q?CBeuD1hPNSkgdvKYClaFmAojGWEVPU5L2ABZ5R/NAebFcPjNWdVVCvn6P5U1?=
 =?us-ascii?Q?wVR0TtrKVp1AFgmcTI08ww0pN+CNa7F7QoVyCghb3nYLHp0IyzTAeDoQVXhY?=
 =?us-ascii?Q?5OzbMTON6XLRHXa4J53iZnrQlkfDf+ogo5tyU++s8kiW76YleQPcFDyJg2Y2?=
 =?us-ascii?Q?3uTM/mr6+K3A72f3ySwf2IJLMYLrio3VrZqpz72wLHUZIZ061TTU6TvlfnZp?=
 =?us-ascii?Q?SRfSslbAeuNGEIjgKWw2FZPctESbn4HyK+zOssCsRzxZjV49fgYqhAkBXNWf?=
 =?us-ascii?Q?10ZSousl/vF0ft4oKgi++EnXlfQrvq8H5yLaxLVtD09o2zy9BxXOR2b7hs+w?=
 =?us-ascii?Q?GzULS8gezDEz7rDWfSKkjmmVBS48RDUAnxs5Vtgw?=
X-OriginatorOrg: vivo.com
X-MS-Exchange-CrossTenant-Network-Message-Id: c6d203a8-2ae0-4f74-c7fe-08db68097c81
X-MS-Exchange-CrossTenant-AuthSource: TYZPR06MB6697.apcprd06.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 08 Jun 2023 10:16:55.9324
 (UTC)
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 923e42dc-48d5-4cbe-b582-1a797a6412ed
X-MS-Exchange-CrossTenant-MailboxType: HOSTED
X-MS-Exchange-CrossTenant-UserPrincipalName: JlX1WCgkgRF0uEyENakPCS/Pyqs+mFBgIG8yGypSOVeZEj9wA/jcqwezsqe6F8295y6h2ldRRLQN+2jGF1+tdg==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: PSAPR06MB4456
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
        DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE,
        RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,SPF_PASS,T_SCC_BODY_TEXT_LINE
        autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
        lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

There are three flags that control Write Booster Feature:

    1. WB ON/OFF
    2. WB Hibern Flush ON/OFF (implicitly)
    3. WB Flush ON/OFF (explicit)

In the case of "Hibern Flush", one of the conditions for flush WB buffer is
that avail_wb_buff < wb_flush_threshold.

As we know, different users have different requirements for power
consumption and performance. Therefore, we need the ability to manually
set wb_flush_threshold, so that users can easily and flexibly adjust
the wb_flush_threshold value, thereby achieving a balance between power
consumption and performance.

So the sysfs attribute that controls this is necessary.

The meaning of wb_flush_threshold is the percentage of WB's total size,
such as 1 representing 10%, 2 representing 20%, and so on.

Signed-off-by: Lu Hongfei <luhongfei@vivo.com>
---
 drivers/ufs/core/ufs-sysfs.c | 37 ++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)

diff --git a/drivers/ufs/core/ufs-sysfs.c b/drivers/ufs/core/ufs-sysfs.c
index cdf3d5f2b77b..679f65dc4cab
--- a/drivers/ufs/core/ufs-sysfs.c
+++ b/drivers/ufs/core/ufs-sysfs.c
@@ -298,6 +298,41 @@ static ssize_t enable_wb_buf_flush_store(struct device *dev,
 	return res < 0 ? res : count;
 }
 
+static ssize_t wb_flush_threshold_show(struct device *dev,
+					 struct device_attribute *attr,
+					 char *buf)
+{
+	struct ufs_hba *hba = dev_get_drvdata(dev);
+
+	return sysfs_emit(buf, "%d\n", hba->vps->wb_flush_threshold);
+}
+
+static ssize_t wb_flush_threshold_store(struct device *dev,
+					  struct device_attribute *attr,
+					  const char *buf, size_t count)
+{
+	struct ufs_hba *hba = dev_get_drvdata(dev);
+	unsigned int wb_flush_threshold;
+
+	if (!ufshcd_is_wb_allowed(hba)) {
+		dev_warn(dev, "It is not allowed to configure WB buf flush threshold!\n");
+		return -EOPNOTSUPP;
+	}
+
+	if (kstrtouint(buf, 0, &wb_flush_threshold))
+		return -EINVAL;
+
+	/* The range of values for wb_flush_threshold is (0,10] */
+	if (wb_flush_threshold <= 0 || wb_flush_threshold > 10) {
+		dev_err(dev, "The value of wb_flush_threshold is invalid!\n");
+		return -EINVAL;
+	}
+
+	hba->vps->wb_flush_threshold = wb_flush_threshold;
+
+	return count;
+}
+
 static DEVICE_ATTR_RW(rpm_lvl);
 static DEVICE_ATTR_RO(rpm_target_dev_state);
 static DEVICE_ATTR_RO(rpm_target_link_state);
@@ -307,6 +342,7 @@ static DEVICE_ATTR_RO(spm_target_link_state);
 static DEVICE_ATTR_RW(auto_hibern8);
 static DEVICE_ATTR_RW(wb_on);
 static DEVICE_ATTR_RW(enable_wb_buf_flush);
+static DEVICE_ATTR_RW(wb_flush_threshold);
 
 static struct attribute *ufs_sysfs_ufshcd_attrs[] = {
 	&dev_attr_rpm_lvl.attr,
@@ -318,6 +354,7 @@ static struct attribute *ufs_sysfs_ufshcd_attrs[] = {
 	&dev_attr_auto_hibern8.attr,
 	&dev_attr_wb_on.attr,
 	&dev_attr_enable_wb_buf_flush.attr,
+	&dev_attr_wb_flush_threshold.attr,
 	NULL
 };
 
-- 
2.39.0