From patchwork Thu Nov 30 19:23:12 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Shiju Jose X-Patchwork-Id: 13474893 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 kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by smtp.lore.kernel.org (Postfix) with ESMTP id CA2ABC4167B for ; Thu, 30 Nov 2023 19:23:55 +0000 (UTC) Received: by kanga.kvack.org (Postfix) id 1B6A06B0487; Thu, 30 Nov 2023 14:23:40 -0500 (EST) Received: by kanga.kvack.org (Postfix, from userid 40) id 0EFF86B0488; Thu, 30 Nov 2023 14:23:40 -0500 (EST) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id EF97D6B048A; Thu, 30 Nov 2023 14:23:39 -0500 (EST) X-Delivered-To: linux-mm@kvack.org Received: from relay.hostedemail.com (smtprelay0011.hostedemail.com [216.40.44.11]) by kanga.kvack.org (Postfix) with ESMTP id DF7E36B0487 for ; Thu, 30 Nov 2023 14:23:39 -0500 (EST) Received: from smtpin12.hostedemail.com (a10.router.float.18 [10.200.18.1]) by unirelay03.hostedemail.com (Postfix) with ESMTP id A83D2A029D for ; Thu, 30 Nov 2023 19:23:39 +0000 (UTC) X-FDA: 81515594958.12.C93C23F Received: from frasgout.his.huawei.com (frasgout.his.huawei.com [185.176.79.56]) by imf25.hostedemail.com (Postfix) with ESMTP id 8C75DA001B for ; Thu, 30 Nov 2023 19:23:37 +0000 (UTC) Authentication-Results: imf25.hostedemail.com; dkim=none; dmarc=pass (policy=quarantine) header.from=huawei.com; spf=pass (imf25.hostedemail.com: domain of shiju.jose@huawei.com designates 185.176.79.56 as permitted sender) smtp.mailfrom=shiju.jose@huawei.com ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=hostedemail.com; s=arc-20220608; t=1701372217; h=from:from:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=JKUF9IcADAMJQiVs2ROSM7VATeZNKbIi5ZRlD7UBNYM=; b=mw9gWxkcuSb+hQvulHgKR+nRy1nz4x/1uHKSIvGZcZnYupYrbO9w42kIWk8lFW3sMcjixS rLxT37GwazB7Fs1r0nze8jANLSws8ZACyPFq1hZchg1LnnrH5BiXVEyMgQufoACpi4GTK+ BcPKf5G1+923xhBi3LxH+M+n03Xw9Pg= ARC-Authentication-Results: i=1; imf25.hostedemail.com; dkim=none; dmarc=pass (policy=quarantine) header.from=huawei.com; spf=pass (imf25.hostedemail.com: domain of shiju.jose@huawei.com designates 185.176.79.56 as permitted sender) smtp.mailfrom=shiju.jose@huawei.com ARC-Seal: i=1; s=arc-20220608; d=hostedemail.com; t=1701372217; a=rsa-sha256; cv=none; b=6iSB5ZOQAk2WB5cgk2u/8U6K06Ru2aGktywYATyXEU8tXNscT9UPksMDKAa/YVHsFHWBKw oR08OiJksoVlO/6TGJy6Lv+SIOV8Kj9LA7yhhJ28RW5jKH4IgsvKLXS8e3aDWTon2UTzSL 08zno7uqYgWHUB4Mjc74ElBOn/Egs7c= Received: from mail.maildlp.com (unknown [172.18.186.31]) by frasgout.his.huawei.com (SkyGuard) with ESMTP id 4Sh5b43lgRz67lQZ; Fri, 1 Dec 2023 03:18:56 +0800 (CST) Received: from lhrpeml500006.china.huawei.com (unknown [7.191.161.198]) by mail.maildlp.com (Postfix) with ESMTPS id A29DB1402CD; Fri, 1 Dec 2023 03:23:35 +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.35; Thu, 30 Nov 2023 19:23:34 +0000 From: To: , , , , , , , , CC: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , Subject: [PATCH v4 10/11] memory: scrub: sysfs: Add Documentation for set of common scrub attributes Date: Fri, 1 Dec 2023 03:23:12 +0800 Message-ID: <20231130192314.1220-11-shiju.jose@huawei.com> X-Mailer: git-send-email 2.35.1.windows.2 In-Reply-To: <20231130192314.1220-1-shiju.jose@huawei.com> References: <20231130192314.1220-1-shiju.jose@huawei.com> MIME-Version: 1.0 X-Originating-IP: [10.122.247.234] X-ClientProxiedBy: lhrpeml500004.china.huawei.com (7.191.163.9) To lhrpeml500006.china.huawei.com (7.191.161.198) X-Rspamd-Queue-Id: 8C75DA001B X-Rspam-User: X-Rspamd-Server: rspam05 X-Stat-Signature: r1r4uw3zshfwdhufszusxmtd3enizjwr X-HE-Tag: 1701372217-915360 X-HE-Meta: U2FsdGVkX18nXuFecilnAofyKTOEXaytXISHdb9q8GrzHIrd+uJXfzxiy+LLXj93A1XxoQNGcN3dOWiYHpNIR+YNAAr/QB5N4+3dwHGm+caPtm97NZmJ7NkxELMcj0mglSVwftN4FkIZfp7i/OedOElcuEaprOuB9N2C8bAdFr3ddCzOBkDWOH40c2BHgkWHWBbBIpcETX11HAf6oIEvsXtVsBHFE3620oGnHvL8WS4bOczbTzaC30g2/vShHt59bQl1v8QhcHReuVEw6pw9Gr1tDLSe73JhM6yCtNnN/5R4MCfPbirJD4lwhj8K+75qXHZtHjAEzuFvp8UNDZkN4n14VEMzbIfeJt5zWaAhj6WWqLWVTWODInqDnYuUFI/vYXwHYdPfg23fP4+zjHn49NH5Fsrf8A1GcYmQpX7q677qTF7GToPOiND2m15+PWNOl8mwKw7u6otJ2XGRbdZbY2UySG0+En/Fq36EWhdry3k/BMXmzJG+BiEXUlalnBgCtrE8ZziUWHoLmXtqsT46yOCwbKFq2P9UziIFQU7hN81sM32p/euw7UrmPN5g6rx/ws4CnBqSBz0sUQ0h0U6OPlKcU5Nzt2mCkNmMLZtZhngThlhRECSMvVQTXD5l1jj9RUfuDsiq1GdrlN7+gHJ5TSgVWNLnuTKr1b5YIAPnbd8cak4LksjieZjPKPOFVGoetmhOX2MEs4Ivw7/Z6PyL4qVQRhfgJWbRBlxf2t8SmRzSaFzrzYQ2Av5/L24RSnxphekYO+AbLlP6lUt5olrfC05Yhta0M35fTgc7JAag7RvMPdoGfYOuAMq1Gm7Ssx51mM9JPnNeXZTJCWfg39+fjez06Sfnu5w5+30JzFY429rnroGQFbTnI/9ze8yr3bezx5uBat0QWG1aa2D2wLaDuvBwA4GsS6aXf+fXvlsU2OOHQax5S8e9M1lw2Ty6mKLyJxjihw4qd3ZoV/UQ34e FHqSOxHn ut3CnbzO26s/8G346e4O7zLmUlzJZoVIpy8fMIuJegzy1lXc/ij0vp+CezXZZaWaYLyBEdJ0cPx9UHrLLXTFHveTscc/N4j03F5TpvRU9ELXRbpBq0E82NsFdP5z64DAfEcdutn1yIjMEZyPzry9qO05rsnNsI6x/cN9HaPMDmOmLasagLHrQKypbF5/87hJ+ygbCi7hPUZwQSpRc19YyT/KTFp5Nd6ZIW8/3 X-Bogosity: Ham, tests=bogofilter, spamicity=0.000001, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: List-Subscribe: List-Unsubscribe: From: Shiju Jose Add sysfs documentation for the set of common scrub attributes those are exposed in /sys/class/scrub/ by the scrub configure driver and support user to configuring attributes 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..5e965b3ad088 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-class-scrub-configure @@ -0,0 +1,82 @@ +What: /sys/class/scrub/ +Date: November 2023 +KernelVersion: 6.8 +Contact: linux-kernel@vger.kernel.org +Description: + The scrub/ class subdirectory belongs to the + scrubber subsystem. + +What: /sys/class/scrub/scrubX/ +Date: November 2023 +KernelVersion: 6.8 +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: November 2023 +KernelVersion: 6.8 +Contact: linux-kernel@vger.kernel.org +Description: + (RO) name of the memory scrub device + +What: /sys/class/scrub/scrubX/regionY/ +Date: November 2023 +KernelVersion: 6.8 +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: November 2023 +KernelVersion: 6.8 +Contact: linux-kernel@vger.kernel.org +Description: + (RW) The base of the address range of the memory region + to be 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 scrub). + +What: /sys/class/scrub/scrubX/regionY/addr_size +Date: November 2023 +KernelVersion: 6.8 +Contact: linux-kernel@vger.kernel.org +Description: + (RW) The size of the address range to be scrubbed. + On reading, returns the size of the memory region for + the actual address range. + +What: /sys/class/scrub/scrubX/regionY/enable +Date: November 2023 +KernelVersion: 6.8 +Contact: linux-kernel@vger.kernel.org +Description: + (WO) Start/Stop scrub the memory region. + 1 - enable the memory scrub. + 0 - disable the memory scrub.. + +What: /sys/class/scrub/scrubX/regionY/speed_available +Date: November 2023 +KernelVersion: 6.8 +Contact: linux-kernel@vger.kernel.org +Description: + (RO) Supported range for the scrub speed(scrub rate) + by the scrubber for a memory region. + The unit of the scrub rate vary depends on the scrub. + +What: /sys/class/scrub/scrubX/regionY/speed +Date: November 2023 +KernelVersion: 6.8 +Contact: linux-kernel@vger.kernel.org +Description: + (RW) The scrub speed(scrub rate) on the memory region specified + and it must be with in the supported range by the scrub. + The unit of the scrub rate vary depends on the scrub.