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>,
        Daniil Lunev <dlunev@chromium.org>,
        Jinyoung Choi <j-young.choi@samsung.com>,
        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 v4] scsi: ufs: wb: Add explicit flush_threshold sysfs attribute
Date:   Fri,  9 Jun 2023 17:11:10 +0800
Message-Id: <20230609091113.22531-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?b1JboQzd8i12JUUQXmiGVPK7/4CFhYZJMFAomEurtP5+WLGgpbvHpobREFHi?=
 =?us-ascii?Q?vAZS0trA0u06riPfQarhSMZ1QQhVfJNEr9PsXHVVXO+INSHMxtt6oUUzpEKP?=
 =?us-ascii?Q?nrkwqx9kvEWntF6e1TRTXgoFDPpOnS+fAoV5eH2FM4VcKY9Hgyey04iz1RK9?=
 =?us-ascii?Q?U4+gGFsgbgdaPcTDh2tfmn65+F8LoCoZZ/sK3aEjgjl/H3vNMkAsu1X56qB9?=
 =?us-ascii?Q?7qUwfwSiJNk/531HTz0PjxfBgCsv9jrOO8GoeWyu1/Be7be6Tqhpdm/VoJeH?=
 =?us-ascii?Q?7yhjIykOpBPA+ppjEKsVO1nYLHsk80NM+IL3dCHpPkf5AD0dyysY+mmQbjUQ?=
 =?us-ascii?Q?eUrXtQVN6lI0bZciiQn5c8A2beLpgB300q5iveQZ85V2Ba3ePpA9Rx8Vh7fy?=
 =?us-ascii?Q?jN2FkJg68hgPstVI1gzOHSlqRtJOLN/yxu1YzpOofeYzM8RzqcB13NGZjwWO?=
 =?us-ascii?Q?vu584ganGcaQ+UtV4zu+naEsrMIz9MIh86LmCNh5Bx9c7Cl6xWHHsXNXq/gj?=
 =?us-ascii?Q?l7jbnlDbGDJcViOZAq3nXLVcSz73SIMCXkXetXMABE2x8Uhk8/46h0ag2Aiy?=
 =?us-ascii?Q?bThPp8R0IH2qMuyrD2UEPeLX6uCyg4ib7y/YpTkrQYh9Y5Bb0B6QDd7evt70?=
 =?us-ascii?Q?bjrGMNczTy6xxDWPgDBBppD3mkNgcH2vMJGyydgP63CKL/k7JgTQAyDx2Y3O?=
 =?us-ascii?Q?6jYghzlelIOEI4UbH/0FMtXcnR16n/j41/dot23ewSBx6NY6sV+JWPhu3Fxg?=
 =?us-ascii?Q?DNzETnASm9hBwZs04MF5qQmcxKg3+DTaEeIrfLmxrsPNPJUeOyPemkcNVB14?=
 =?us-ascii?Q?42BBt8NeqNwY7K9i9/QoqguB17NdmMcvAoUGCHLY6bUt59e3vu039oyTuoLC?=
 =?us-ascii?Q?5zeTBg7dIAu7r2+kwlbxO9l34ed/O6Nhv6VcxjND64R05vM+97it6gJaQ6Xt?=
 =?us-ascii?Q?HupuRp7TiHwLmV6VN1RahLIUFpQkAWaoJ916I0gobBgSCN4ObASG/EQK3LEu?=
 =?us-ascii?Q?fxn6kW/5BMxSqbzkFg/ibk5V46Wg0W/nFSzNreKs73g/SdaXG4twuIWLRFzh?=
 =?us-ascii?Q?RNdRptQWeItPCJaVg+OuOUzkgTsuRTSCbuGPyCKBNuAyhU6PGv+gaE1pHzO4?=
 =?us-ascii?Q?kdtNuzqrHFl1tBS+6G7r/287bYy+MViQzJJdfA7WbAmKpyn8V8F02mFUu44B?=
 =?us-ascii?Q?ifZ/Sbe+/mE3eqBVaXXQJz4RLIa2J9FwKfR776kBVWZ6e1z7921tci4Nf7HI?=
 =?us-ascii?Q?Gxnh4F+tdIuzAX9MJr52Des0yrIW6zFFqf+wn3RahOwJOn6toCaUeLd4/XMl?=
 =?us-ascii?Q?1SvxwiGab2xgnz26BWqxmP4WqboMBXj+1OfhpQtERDvG+TZpGF8s8ITqwQk7?=
 =?us-ascii?Q?we8msuz7f9r9d62ssgtUdtsVOSeAqBPVbTQZh84pswKZs8xGZGgtnE3Bf/Tn?=
 =?us-ascii?Q?MNjkQma8PFB2wZ7gWXPReR7VILLNllg+zNr0kGAcgts+AhshvJgXrSGvRRN2?=
 =?us-ascii?Q?Pn20H7i9wK2X5+KQpQb4EaGtumFLYrd41MngoF8f+b3tK5GgFCZtUV5/GIv0?=
 =?us-ascii?Q?0JpCNd6PVBfxME5le6Kbt29qNYV/4oqwb891I4z9?=
X-OriginatorOrg: vivo.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 31ed1f55-46ce-4ed7-30e7-08db68c97efc
X-MS-Exchange-CrossTenant-AuthSource: TYZPR06MB6697.apcprd06.prod.outlook.com
X-MS-Exchange-CrossTenant-AuthAs: Internal
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Jun 2023 09:11:23.3753
 (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: 3GtEqduFzLiklMzyuuNQLTFRTAK2goy460IVTqHnpgY9AEgScWv5bUhlUx9wjBmsFaL7Gk9E5CJnkDaR4JuJPw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: TYZPR06MB6786
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. Add wb_flush_threshold related information to sysfs documentation.

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

diff --git a/Documentation/ABI/testing/sysfs-driver-ufs b/Documentation/ABI/testing/sysfs-driver-ufs
index 228aa43e14ed..25bc2db78ff5
--- a/Documentation/ABI/testing/sysfs-driver-ufs
+++ b/Documentation/ABI/testing/sysfs-driver-ufs
@@ -1426,6 +1426,14 @@ 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 is a percentage that represents the threshold for flush WB.
+		When avail_wb_buff < wb_flush_threshold, the dev will flush WB when entered H8.
+		When avail_wb_buff >= wb_flush_threshold, 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