linux-kernel - [RFC PATCH 3/9] Documentation/scrub-configure.rst: Add documentation for scrub driver

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20230915172818.761-4-shiju.jose@huawei.com>
Date:   Sat, 16 Sep 2023 01:28:12 +0800
From:   <shiju.jose@...wei.com>
To:     <linux-acpi@...r.kernel.org>, <linux-mm@...ck.org>,
        <linux-kernel@...r.kernel.org>
CC:     <rafael@...nel.org>, <lenb@...nel.org>, <naoya.horiguchi@....com>,
        <tony.luck@...el.com>, <james.morse@....com>,
        <dave.hansen@...ux.intel.com>, <david@...hat.com>,
        <jiaqiyan@...gle.com>, <jthoughton@...gle.com>,
        <somasundaram.a@....com>, <erdemaktas@...gle.com>,
        <pgonda@...gle.com>, <rientjes@...gle.com>, <duenwen@...gle.com>,
        <Vilas.Sridharan@....com>, <mike.malvestuto@...el.com>,
        <gthelen@...gle.com>, <linuxarm@...wei.com>,
        <jonathan.cameron@...wei.com>, <tanxiaofei@...wei.com>,
        <prime.zeng@...ilicon.com>, <shiju.jose@...wei.com>
Subject: [RFC PATCH 3/9] Documentation/scrub-configure.rst: Add documentation for scrub driver

From: Shiju Jose <shiju.jose@...wei.com>

Add documentation for scrub driver, supports configure scrub parameters,
in Documentation/scrub-configure.rst

Signed-off-by: Shiju Jose <shiju.jose@...wei.com>
---
 Documentation/scrub-configure.rst | 55 +++++++++++++++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 Documentation/scrub-configure.rst

diff --git a/Documentation/scrub-configure.rst b/Documentation/scrub-configure.rst
new file mode 100644
index 000000000000..9f8581b88788
--- /dev/null
+++ b/Documentation/scrub-configure.rst
@@ -0,0 +1,55 @@
+==========================
+Scrub subsystem driver
+==========================
+
+Copyright (c) 2023 HiSilicon Limited.
+
+:Author:   Shiju Jose <shiju.jose@...wei.com>
+:License:  The GNU Free Documentation License, Version 1.2
+          (dual licensed under the GPL v2)
+:Original Reviewers:
+
+- Written for: 6.7
+- Updated for:
+
+Introduction
+------------
+The scrub subsystem driver provides the interface for configure the
+parameters of memory scrubbers in the system. The scrub device drivers
+in the system register with the scrub configure subsystem.
+
+The scrub configure driver exposes the scrub controls to the user
+via sysfs.
+
+The File System
+---------------
+
+The configuration parameters of the registered scrubbers could be
+accessed via the /sys/class/scrub/scrubX/regionN/
+
+sysfs
+-----
+
+Sysfs files are documented in
+`Documentation/ABI/testing/sysfs-class-scrub-configure`.
+
+Example
+-------
+
+  The usage takes the form shown in this example::
+
+    # echo 0x300000 > /sys/class/scrub/scrub0/region0/addr_base
+    # echo 0x100000 > /sys/class/scrub/scrub0/region0/addr_size
+    # cat /sys/class/scrub/scrub0/region0/speed_available
+    # 1-60
+    # echo 25 > /sys/class/scrub/scrub0/region0/speed
+    # echo 1 > /sys/class/scrub/scrub0/region0/enable
+
+    # cat /sys/class/scrub/scrub0/region0/speed
+    # 0x19
+    # cat /sys/class/scrub/scrub0/region0/addr_base
+    # 0x100000
+    # cat /sys/class/scrub/scrub0/region0/addr_size
+    # 0x200000
+
+    # echo 0 > /sys/class/scrub/scrub0/region0/enable
-- 
2.34.1