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>,
        Daniil Lunev <dlunev@chromium.org>,
        Lu Hongfei <luhongfei@vivo.com>,
        Peter Wang <peter.wang@mediatek.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 v2] scsi: ufs: wb: Add explicit flush_threshold sysfs attribute
Date:   Fri,  9 Jun 2023 09:41:44 +0800
Message-Id: <20230609014146.45934-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?8gaAalSkeAA0vnHhkCZh5F0lcxhx6Wvc5RsaKmhATUeSxvhAfngm3ZNVUce9?=
 =?us-ascii?Q?g1WPp4b69kVnPa/iqsIC1FEou4tTYF3/B20v6q3Xww2nyWlZFwXHShZSnA8l?=
 =?us-ascii?Q?5NMKJgP6v7Pod6Z5qGCNOtyT9TGZaaJM1iFErBAki9tFM2Qs9EQqvCuOOkXR?=
 =?us-ascii?Q?k5DZpan5uI3FarxgBRyakZMYRMOK4lieUJSjRPXOt6BSOyzHrjVcGgCrGAyI?=
 =?us-ascii?Q?cSU2KpB3Sx5bdVe4JBbb4e8K7Xbw+GpSewKA5LXly8XrZUWfWmP+OdDtI9dm?=
 =?us-ascii?Q?0pFkpe/jQeyB0kqek5Yh8KmjnLIR2D9EXYckXGpwK0gW0k4eg00B6KDvCBKK?=
 =?us-ascii?Q?vx31Ze15a4bjewOO9rfnQOdPCoBSMTSUUBSzB1Ic4sW6/xwVAvc3LXKqMN7x?=
 =?us-ascii?Q?fOWbxe0G7VjO9vUQOo1wwQpAnssQ9IdR/ScPgKrf1uq8x1PWKLv7FUQSgwIy?=
 =?us-ascii?Q?Z/Q6E7zM0DTWDPHTujaybTS8S0oHDpEykC9HRnJtZsBs++5kzwbHHpgBTZAm?=
 =?us-ascii?Q?ACqFoQasMyWowJHowPa+WXespN6SizWBLEIn4+vIn9DIERFr4PrrMD9wKsZd?=
 =?us-ascii?Q?tQqdEdbVABJB0fwP5GAHLUje3fEq7FVQFEYGscq5xfNcOVS/3yUb/1700Jv2?=
 =?us-ascii?Q?A9SkMtfcGarynyQaJtshoSShbMmPuF5VymUGx2VgipNAHSkPmZfmEEshi54G?=
 =?us-ascii?Q?0DgllR3OshYqhtKmMThPGIvtsF38o6g2UoKCY712Ya63AIGvmBR8sxGtpyny?=
 =?us-ascii?Q?pBHOG2rvou+wJNQT4opwX2pDvK6oTuw7DE2D2E2MgK2cmmHzyWCQMDIMYzrL?=
 =?us-ascii?Q?1GqFJZcvICutSRWLi7kh+mqWfza64wE4Lf7Y0MuVvH+tHIgiBA5L5WHctV82?=
 =?us-ascii?Q?quTVWA7jCljMF2EKOqObxhFnSV6w8+YnkH0g7IfsdvqqZmOO6w1sh8jVv17V?=
 =?us-ascii?Q?b7Wcsdvzox9ilMbAznSB0u9NwzB/EZnFYGtfqZUr5aFUO5EWC5qNRmaZItUW?=
 =?us-ascii?Q?NO6+6fsadH9BQDvnDjB199bjjJ+Ua55VhRSfZTnCHIn+LQjanTx2vSUw24Go?=
 =?us-ascii?Q?LVNf3pqKN6nhJXzyPkGi1jnQD6c+POwcvlgp6/xLdJdl1n61v1zcBGSe0Op8?=
 =?us-ascii?Q?QwcVJjOv7pVDCaSzLE6xizjY+mf3YgxdM5wgB/51ZVBc5I7SPaTKDytGeBX0?=
 =?us-ascii?Q?qt5Ju5LUnGF8MgwgF69q99/gXHh3hFwGWJEKXOi80bOO46CY5wZAb3cUlwJP?=
 =?us-ascii?Q?sfyJJ2KxjXuR96HWCjwfAfrVGM44imyTlSJEeqgwAUjunVQZcpkBlfuwZhP1?=
 =?us-ascii?Q?fOjc/+NJGhUzmpBhmWUTvvVdcFFLJqhmNREJTCSO3cCGYCbXLtGwLYFkbfvs?=
 =?us-ascii?Q?5tCiZpXydb80+GYkMLIQ1Ws+xrpP76o1bZGGz1XasWNsPMKOca8vLQh4bD73?=
 =?us-ascii?Q?V6xFXMd/YIyNTUjOcl/nB4IVi0UqKDPNQjyFA6M6wxh4S7fJ23qTgn1W1uEI?=
 =?us-ascii?Q?0JK3azEvKhnwGh7U1CL1mo6vIbUxO5lA1VQBx8eMShpGcsuiSQjlioscBAxW?=
 =?us-ascii?Q?w2UXw50LxgI2YihDqTQYDbgCT35d7lxoPDnUS6YV?=
X-OriginatorOrg: vivo.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 4e2c2681-91e0-4016-7195-08db688ab70d
X-MS-Exchange-CrossTenant-AuthSource: TYZPR06MB6697.apcprd06.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Jun 2023 01:41:59.1061
 (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: no5OqXQxCdn4SD0R0FMUzgJSmLPq4eQeQCzY8Nh16Nosz9dWVhOGAsRbP3yIFff+QMCN8liIztrZPX36wdRLfQ==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: SEYPR06MB6277
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.

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>
---
The modifications made compared to the previous version are as follows:
1. Changed %d into %u since the wb_flush_threshold is unsigned.
2. Removed the check for enabling WB in wb_flush_threshold_store.
3. Using UFS_WB_BUF_REMAIN_PERCENT(100) instead of '10', which made it easier to read.

 drivers/ufs/core/ufs-sysfs.c | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/drivers/ufs/core/ufs-sysfs.c b/drivers/ufs/core/ufs-sysfs.c
index cdf3d5f2b77b..258afee2f958
--- 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