From patchwork Fri Sep 15 17:28:11 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Shiju Jose X-Patchwork-Id: 723999 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id F4055EED61A for ; Fri, 15 Sep 2023 17:30:07 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S235863AbjIOR3k (ORCPT ); Fri, 15 Sep 2023 13:29:40 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:44254 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S235957AbjIOR3L (ORCPT ); Fri, 15 Sep 2023 13:29:11 -0400 Received: from frasgout.his.huawei.com (frasgout.his.huawei.com [185.176.79.56]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 750162120; Fri, 15 Sep 2023 10:29:06 -0700 (PDT) Received: from lhrpeml500006.china.huawei.com (unknown [172.18.147.200]) by frasgout.his.huawei.com (SkyGuard) with ESMTP id 4RnLkc2nYbz6K6LG; Sat, 16 Sep 2023 01:28:24 +0800 (CST) Received: from SecurePC30232.china.huawei.com (10.122.247.234) by lhrpeml500006.china.huawei.com (7.191.161.198) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.31; Fri, 15 Sep 2023 18:29:04 +0100 From: To: , , CC: , , , , , , , , , , , , , , , , , , , , , Subject: [RFC PATCH 2/9] memory: scrub: sysfs: Add Documentation entries for set of scrub attributes Date: Sat, 16 Sep 2023 01:28:11 +0800 Message-ID: <20230915172818.761-3-shiju.jose@huawei.com> X-Mailer: git-send-email 2.35.1.windows.2 In-Reply-To: <20230915172818.761-1-shiju.jose@huawei.com> References: <20230915172818.761-1-shiju.jose@huawei.com> MIME-Version: 1.0 X-Originating-IP: [10.122.247.234] X-ClientProxiedBy: lhrpeml500001.china.huawei.com (7.191.163.213) To lhrpeml500006.china.huawei.com (7.191.161.198) X-CFilter-Loop: Reflected Precedence: bulk List-ID: X-Mailing-List: linux-acpi@vger.kernel.org From: Shiju Jose Add sysfs documentation entries for the set of attributes those are exposed in /sys/class/scrub/ by the scrub driver. These attributes support configuring parameters of a scrub device. Signed-off-by: Shiju Jose --- .../ABI/testing/sysfs-class-scrub-configure | 82 +++++++++++++++++++ 1 file changed, 82 insertions(+) create mode 100644 Documentation/ABI/testing/sysfs-class-scrub-configure diff --git a/Documentation/ABI/testing/sysfs-class-scrub-configure b/Documentation/ABI/testing/sysfs-class-scrub-configure new file mode 100644 index 000000000000..347e2167dc62 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-class-scrub-configure @@ -0,0 +1,82 @@ +What: /sys/class/scrub/ +Date: September 2023 +KernelVersion: 6.7 +Contact: linux-kernel@vger.kernel.org +Description: + The scrub/ class subdirectory belongs to the + scrubber subsystem. + +What: /sys/class/scrub/scrubX/ +Date: September 2023 +KernelVersion: 6.7 +Contact: linux-kernel@vger.kernel.org +Description: + The /sys/class/scrub/scrub{0,1,2,3,...} directories + correspond to each scrub device. + +What: /sys/class/scrub/scrubX/name +Date: September 2023 +KernelVersion: 6.7 +Contact: linux-kernel@vger.kernel.org +Description: + (RO) name of the memory scrub device + +What: /sys/class/scrub/scrubX/regionY/ +Date: September 2023 +KernelVersion: 6.7 +Contact: linux-kernel@vger.kernel.org +Description: + The /sys/class/scrub/scrubX/region{0,1,2,3,...} + directories correspond to each scrub region under a scrub device. + Scrub region is a physical address range for which scrub may be + separately controlled. Regions may overlap in which case the + scrubbing rate of the overlapped memory will be at least that + expected due to each overlapping region. + +What: /sys/class/scrub/scrubX/regionY/addr_base +Date: September 2023 +KernelVersion: 6.7 +Contact: linux-kernel@vger.kernel.org +Description: + (RW) The base of the address range of the memory region + to be patrol scrubbed. + On reading, returns the base of the memory region for + the actual address range(The platform calculates + the nearest patrol scrub boundary address from where + it can start scrubbing). + +What: /sys/class/scrub/scrubX/regionY/addr_size +Date: September 2023 +KernelVersion: 6.7 +Contact: linux-kernel@vger.kernel.org +Description: + (RW) The size of the address range to be patrol scrubbed. + On reading, returns the size of the memory region for + the actual address range. + +What: /sys/class/scrub/scrubX/regionY/enable +Date: September 2023 +KernelVersion: 6.7 +Contact: linux-kernel@vger.kernel.org +Description: + (WO) Start/Stop scrubbing the memory region. + 1 - enable the memory scrubbing. + 0 - disable the memory scrubbing.. + +What: /sys/class/scrub/scrubX/regionY/speed_available +Date: September 2023 +KernelVersion: 6.7 +Contact: linux-kernel@vger.kernel.org +Description: + (RO) Supported range for the partol speed(scrub rate) + by the scrubber for a memory region. + The unit of the scrub rate vary depends on the scrubber. + +What: /sys/class/scrub/scrubX/regionY/speed +Date: September 2023 +KernelVersion: 6.7 +Contact: linux-kernel@vger.kernel.org +Description: + (RW) The partol speed(scrub rate) on the memory region specified and + it must be with in the supported range by the scrubber. + The unit of the scrub rate vary depends on the scrubber.