From: <shiju.jose@huawei.com>
To: <linux-acpi@vger.kernel.org>, <linux-mm@kvack.org>,
<linux-kernel@vger.kernel.org>
Cc: <rafael@kernel.org>, <lenb@kernel.org>, <naoya.horiguchi@nec.com>,
<tony.luck@intel.com>, <james.morse@arm.com>,
<dave.hansen@linux.intel.com>, <david@redhat.com>,
<jiaqiyan@google.com>, <jthoughton@google.com>,
<somasundaram.a@hpe.com>, <erdemaktas@google.com>,
<pgonda@google.com>, <rientjes@google.com>, <duenwen@google.com>,
<Vilas.Sridharan@amd.com>, <mike.malvestuto@intel.com>,
<gthelen@google.com>, <linuxarm@huawei.com>,
<jonathan.cameron@huawei.com>, <tanxiaofei@huawei.com>,
<prime.zeng@hisilicon.com>, <shiju.jose@huawei.com>
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 [thread overview]
Message-ID: <20230915172818.761-3-shiju.jose@huawei.com> (raw)
In-Reply-To: <20230915172818.761-1-shiju.jose@huawei.com>
From: Shiju Jose <shiju.jose@huawei.com>
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 <shiju.jose@huawei.com>
---
.../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.
--
2.34.1
next prev parent reply other threads:[~2023-09-15 17:30 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-09-15 17:28 [RFC PATCH 0/9] ACPI:RASF: Add support for ACPI RASF, ACPI RAS2 and configure scrubbers shiju.jose
2023-09-15 17:28 ` [RFC PATCH 1/9] memory: scrub: Add scrub driver supports configuring memory scrubbers in the system shiju.jose
2023-09-15 17:28 ` shiju.jose [this message]
2023-09-22 0:07 ` [RFC PATCH 2/9] memory: scrub: sysfs: Add Documentation entries for set of scrub attributes Jiaqi Yan
2023-09-22 10:20 ` Jonathan Cameron
2023-09-28 5:25 ` Jiaqi Yan
2023-09-28 13:14 ` Jonathan Cameron
2023-10-05 3:18 ` David Rientjes
2023-10-06 13:02 ` Jonathan Cameron
2023-10-06 13:06 ` Sridharan, Vilas
2023-10-11 16:35 ` Jonathan Cameron
2023-10-12 13:41 ` Sridharan, Vilas
2023-10-12 15:02 ` Jonathan Cameron
2023-10-12 15:44 ` Sridharan, Vilas
2023-10-13 9:07 ` Jonathan Cameron
2023-09-15 17:28 ` [RFC PATCH 3/9] Documentation/scrub-configure.rst: Add documentation for scrub driver shiju.jose
2023-09-18 7:23 ` David Hildenbrand
2023-09-18 10:25 ` Shiju Jose
2023-09-18 12:15 ` David Hildenbrand
2023-09-18 12:28 ` Jonathan Cameron
2023-09-18 12:34 ` David Hildenbrand
2023-09-18 15:03 ` Shiju Jose
2023-09-15 17:28 ` [RFC PATCH 4/9] ACPI:RASF: Add extract RASF table to register RASF platform devices shiju.jose
2023-09-15 17:28 ` [RFC PATCH 5/9] ACPI:RASF: Add common library for RASF and RAS2 PCC interfaces shiju.jose
2023-09-15 17:28 ` [RFC PATCH 6/9] memory: RASF: Add memory RASF driver shiju.jose
2023-09-15 17:28 ` [RFC PATCH 7/9] ACPICA: ACPI 6.5: Add support for RAS2 table shiju.jose
2023-09-15 17:28 ` [RFC PATCH 8/9] ACPI:RAS2: Add driver for ACPI RAS2 feature table (RAS2) shiju.jose
2023-09-15 17:28 ` [RFC PATCH 9/9] memory: RAS2: Add memory RAS2 driver shiju.jose
2023-09-17 21:14 ` [RFC PATCH 0/9] ACPI:RASF: Add support for ACPI RASF, ACPI RAS2 and configure scrubbers Jiaqi Yan
2023-09-18 10:19 ` Shiju Jose
2023-09-18 17:47 ` Jiaqi Yan
2023-09-19 8:28 ` Shiju Jose
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230915172818.761-3-shiju.jose@huawei.com \
--to=shiju.jose@huawei.com \
--cc=Vilas.Sridharan@amd.com \
--cc=dave.hansen@linux.intel.com \
--cc=david@redhat.com \
--cc=duenwen@google.com \
--cc=erdemaktas@google.com \
--cc=gthelen@google.com \
--cc=james.morse@arm.com \
--cc=jiaqiyan@google.com \
--cc=jonathan.cameron@huawei.com \
--cc=jthoughton@google.com \
--cc=lenb@kernel.org \
--cc=linux-acpi@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mm@kvack.org \
--cc=linuxarm@huawei.com \
--cc=mike.malvestuto@intel.com \
--cc=naoya.horiguchi@nec.com \
--cc=pgonda@google.com \
--cc=prime.zeng@hisilicon.com \
--cc=rafael@kernel.org \
--cc=rientjes@google.com \
--cc=somasundaram.a@hpe.com \
--cc=tanxiaofei@huawei.com \
--cc=tony.luck@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).