[RFC PATCH 2/9] memory: scrub: sysfs: Add Documentation entries for set of scrub attributes

shiju.jose
2023-09-15T17:30:09Z

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