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>,
        Jinyoung Choi <j-young.choi@samsung.com>,
        Daniil Lunev <dlunev@chromium.org>,
        Lu Hongfei <luhongfei@vivo.com>, Bean Huo <beanhuo@micron.com>,
        Peter Wang <peter.wang@mediatek.com>,
        linux-kernel@vger.kernel.org (open list),
        linux-scsi@vger.kernel.org (open list:UNIVERSAL FLASH STORAGE HOST
        CONTROLLER DRIVER)
Cc:     opensource.kernel@vivo.com
Subject: [PATCH v5] scsi: ufs: wb: Add explicit flush_threshold sysfs attribute
Date:   Tue, 13 Jun 2023 10:22:34 +0800
Message-Id: <20230613022240.16595-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?U3MUCIAoC6FdzKWeAMHt5pENr3P+hTOwV+RPsDA5wAFRJT2JilRwYksjcuhG?=
 =?us-ascii?Q?gPMRYQ+g4Bxl7dOMU5699f2BW01BMIc8rmQ4hT6T7CuTZPyMYSTbkyyekdn8?=
 =?us-ascii?Q?sfssGcznoLO3iJFR3ze5eGd4kPBYo5bN+uoHDddySzj5iC1aD3C0Pwo+Bgs9?=
 =?us-ascii?Q?8g8GvFmzyOXw4qseK56kRvVzY2dXGHVoFLgffXBl3To+97NXrlJM4Iy+N77z?=
 =?us-ascii?Q?ZhMsTVqkLpTd4Nz6BY33SgOB1Hbl8zKwUbRBfvDnVML0w6wyAwT5T6EMwygs?=
 =?us-ascii?Q?LdRevJyHKQ1WJanapPYQWR0K+vog1FqcSpU8LH4NQxZ3Oa4eA+psxtv5wqVx?=
 =?us-ascii?Q?B8wxYz405urLJ927H1lhLZDe4NAE+buAD2I77lbosBHKNK0GZzszy6agg400?=
 =?us-ascii?Q?nW5V1CYlrlMH9ACvijGfLCxmGv6V9ycDvUBCWTZFZS+Hd8ol5VdsF4qUoqcQ?=
 =?us-ascii?Q?FS9xSuZZdiLXmta1c1LeGeeAHrptkaSbDnXAXf16aWqLK8VKafdc3GpTDONm?=
 =?us-ascii?Q?EOrklyx6oQgfEd022ptLuDRxfYa2UM8sIlfNY9R1obEzYQnLaR5aIJTSSWgW?=
 =?us-ascii?Q?RMTZqGfu/9XV6SIdPct7sYtIhGlYnG8lPmI0uviVyQoKh/Ufat30cTuAHCrS?=
 =?us-ascii?Q?6hB4uttoydoaHcna+55g/P8JxWNx8+u3LoxGWt82j4+J4obWeISC51s71c5N?=
 =?us-ascii?Q?eh9ZVJjzBZYr9JRZJpeb3VHMlWjgVWYc7ou7R2zffNbpkHNeG+jh13Xn0fIH?=
 =?us-ascii?Q?utMIn2VBmOHPaRl+ISuzhAOIzDEByQyBoF5zvnAaQWax+fJ6MSc669WKZcf6?=
 =?us-ascii?Q?ONm6WZik4S4AZKJAQN99wrmaD4VD6TDV/zaPAJrzhCUK03QrUG8JQPf7rlzH?=
 =?us-ascii?Q?CYzx2v80FTqFidIKmCcdgWZe9FPwAYAk8ojgrTXj+PBlx5B27V4Elblm1LJe?=
 =?us-ascii?Q?4qSQ6+MZhloI9rVFcbCa0zsAPLioe3i1/LWa3r2mcLehN5GmpG51MT83DfnW?=
 =?us-ascii?Q?i4R6xfmvDmFjMo4b/BTX8Gr4Z49sSpD8ZYsfAwCMtXPiBxwVV95uEsNxGZbv?=
 =?us-ascii?Q?oAYz7SWkEYXTuZJwcvMForUHemeRinAHq1kU7xnOLqwXXRAqiuxVbh7E7oPa?=
 =?us-ascii?Q?S4eiEz91FGDwrL8nRlUigEj9lxWSh2hIJrjC5lzvvwUjIQRVKhbfIO3XQonv?=
 =?us-ascii?Q?EpfZujgkZR9vLpBlTpwVoayQnDvCeZcpX/I7GhxisfdWlrXmYfDL5UAQX6LR?=
 =?us-ascii?Q?krCA7eXBAWZHSOYFKd20U4BjZyJ83h6ygSDsRRxM/kSWT6c5KQ6kFG+jN34e?=
 =?us-ascii?Q?Dzee84iBtOwunOnXfsVdBhbPf8FtYv1n3FB1hLVZzGL1Ocz9aQzqlvPVs+kc?=
 =?us-ascii?Q?zFgHaSMurIY35YRdJSRLmDMtnlRmw4oqGv1UkVwULcZqvrF8NVknGst6HuME?=
 =?us-ascii?Q?n2Q8fBTD6R9V4zzjneOsjMtGsmFWjaDJM9vhH8R0MtcufrP4bHx8y6YCg8Kd?=
 =?us-ascii?Q?DfvAM61YkaxAPPQQli0FcUgLtxCHklKlU5HtxCbbU56XTBG2wV89Jj1QmwnL?=
 =?us-ascii?Q?2g1V8sVE+Xmn3qwMfj8VhlI8ZbzpbuR/cCTnRdoI?=
X-OriginatorOrg: vivo.com
X-MS-Exchange-CrossTenant-Network-Message-Id: a0f24cc7-8087-43e7-bda3-08db6bb514f5
X-MS-Exchange-CrossTenant-AuthSource: TYZPR06MB6697.apcprd06.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 13 Jun 2023 02:22:48.9922
 (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: bGWh3HcUemfo6D+nYRMmA9z6KhE2t1NxZKFwOMwS5axVpQNSnLVt5sCCIF9NehHa/wHGluniUz3U0+hzbBsluw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SI2PR06MB4426
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,
        URIBL_BLOCKED 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.

wb_flush_threshold represents the threshold for flushing WB buffer,
whose value expressed in unit of 10% granularity, such as '1'
representing 10%, '2' representing 20%, and so on.

Signed-off-by: Lu Hongfei <luhongfei@vivo.com>
---
The modifications made compared to the previous version are as follows:
1. Optimize the description of wb_flush_threshold in sysfs documentation
   to make the meaning clearer and more accurate

 Documentation/ABI/testing/sysfs-driver-ufs | 11 ++++++++
 drivers/ufs/core/ufs-sysfs.c               | 33 ++++++++++++++++++++++
 2 files changed, 44 insertions(+)

diff --git a/Documentation/ABI/testing/sysfs-driver-ufs b/Documentation/ABI/testing/sysfs-driver-ufs
index 228aa43e14ed..d5f44fc5b9dc
--- a/Documentation/ABI/testing/sysfs-driver-ufs
+++ b/Documentation/ABI/testing/sysfs-driver-ufs
@@ -1426,6 +1426,17 @@ Description:	This entry shows the status of WriteBooster buffer flushing
 		If flushing is enabled, the device executes the flush
 		operation when the command queue is empty.
 
+What:		/sys/bus/platform/drivers/ufshcd/*/wb_flush_threshold
+What:		/sys/bus/platform/devices/*.ufs/wb_flush_threshold
+Date:		June 2023
+Contact:	Lu Hongfei <luhongfei@vivo.com>
+Description:
+		wb_flush_threshold represents the threshold for flushing WriteBooster buffer,
+		whose value expressed in unit of 10% granularity, such as '1' representing 10%,
+		'2' representing 20%, and so on.
+		If avail_wb_buff < wb_flush_threshold, it indicates that WriteBooster buffer needs to
+		be flushed, otherwise it is not necessary.
+
 What:		/sys/bus/platform/drivers/ufshcd/*/device_descriptor/hpb_version
 What:		/sys/bus/platform/devices/*.ufs/device_descriptor/hpb_version
 Date:		June 2021
diff --git a/drivers/ufs/core/ufs-sysfs.c b/drivers/ufs/core/ufs-sysfs.c
index cdf3d5f2b77b..347207f4e8ee 100644
--- a/drivers/ufs/core/ufs-sysfs.c
+++ b/drivers/ufs/core/ufs-sysfs.c
@@ -298,6 +298,37 @@ 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, "%u\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 (kstrtouint(buf, 0, &wb_flush_threshold))
+		return -EINVAL;
+
+	/* The range of values for wb_flush_threshold is (0,10] */
+	if (wb_flush_threshold > UFS_WB_BUF_REMAIN_PERCENT(100) ||
+		wb_flush_threshold == 0) {
+		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 +338,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 +350,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