linux-kernel - [RFC 09/10] platform/x86/intel/ifs: add ABI documentation for IFS

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: <20220301195457.21152-10-jithu.joseph@intel.com>
Date:   Tue,  1 Mar 2022 11:54:56 -0800
From:   Jithu Joseph <jithu.joseph@...el.com>
To:     hdegoede@...hat.com, markgross@...nel.org
Cc:     tglx@...utronix.de, mingo@...hat.com, bp@...en8.de,
        dave.hansen@...ux.intel.com, x86@...nel.org, hpa@...or.com,
        corbet@....net, gregkh@...uxfoundation.org,
        andriy.shevchenko@...ux.intel.com, jithu.joseph@...el.com,
        ashok.raj@...el.com, tony.luck@...el.com, rostedt@...dmis.org,
        linux-kernel@...r.kernel.org, linux-doc@...r.kernel.org,
        platform-driver-x86@...r.kernel.org, patches@...ts.linux.dev,
        ravi.v.shankar@...el.com
Subject: [RFC 09/10] platform/x86/intel/ifs: add ABI documentation for IFS

Add the sysfs attributes in ABI/stable for In-Field Scan.

Originally-by: Kyung Min Park <kyung.min.park@...el.com>
Signed-off-by: Jithu Joseph <jithu.joseph@...el.com>
Reviewed-by: Ashok Raj <ashok.raj@...el.com>
Reviewed-by: Tony Luck <tony.luck@...el.com>
---
 Documentation/ABI/stable/sysfs-driver-ifs | 85 +++++++++++++++++++++++
 1 file changed, 85 insertions(+)
 create mode 100644 Documentation/ABI/stable/sysfs-driver-ifs

diff --git a/Documentation/ABI/stable/sysfs-driver-ifs b/Documentation/ABI/stable/sysfs-driver-ifs
new file mode 100644
index 000000000000..8b6b9472f57e
--- /dev/null
+++ b/Documentation/ABI/stable/sysfs-driver-ifs
@@ -0,0 +1,85 @@
+What:		/sys/devices/system/cpu/ifs/run_test
+Date:		Feb 28, 2022
+KernelVersion:	5.18.0
+Contact:	linux-kernel@...r.kernel.org
+Description:	echo 1 to trigger ifs test for all online cores.
+
+What:		/sys/devices/system/cpu/ifs/status
+Date:		Feb 28, 2022
+KernelVersion:	5.18.0
+Contact:	linux-kernel@...r.kernel.org
+Description:	Global status. Shows the most serious status across
+		all cores (fail > untested > pass)
+
+What:		/sys/devices/system/cpu/ifs/image_version
+Date:		Feb 28, 2022
+KernelVersion:	5.18.0
+Contact:	linux-kernel@...r.kernel.org
+Description:	Version of loaded IFS binary image.
+
+What:		/sys/devices/system/cpu/ifs/reload
+Date:		Feb 28, 2022
+KernelVersion:	5.18.0
+Contact:	linux-kernel@...r.kernel.org
+Description:	echo 1 to reload IFS image.
+
+What:		/sys/devices/system/cpu/ifs/cpu_pass_list
+Date:		Feb 28, 2022
+KernelVersion:	5.18.0
+Contact:	linux-kernel@...r.kernel.org
+Description:	List of cpus which passed the IFS test.
+
+What:		/sys/devices/system/cpu/ifs/cpu_fail_list
+Date:		Feb 28, 2022
+KernelVersion:	5.18.0
+Contact:	linux-kernel@...r.kernel.org
+Description:	List of cpus which failed the IFS test.
+
+What:		/sys/devices/system/cpu/ifs/cpu_untested_list
+Date:		Feb 28, 2022
+KernelVersion:	5.18.0
+Contact:	linux-kernel@...r.kernel.org
+Description:	List of cpus which could not be tested.
+
+What:		/sys/module/intel_ifs/parameters/noint
+Date:		Feb 28, 2022
+KernelVersion:	5.18.0
+Contact:	linux-kernel@...r.kernel.org
+Description:	SAF tunable parameter that user can modify before
+		the scan run if they wish to override default value.
+
+		When set, system interrupts are not allowed to interrupt an IFS. The
+		default state for this parameter is set.
+
+What:		/sys/module/intel_ifs/parameters/retry
+Date:		Feb 28, 2022
+KernelVersion:	5.18.0
+Contact:	linux-kernel@...r.kernel.org
+Description:	SAF tunable parameter that user can modify at
+		load time if they wish to override default value.
+
+		Maximum retry counter when the test is not executed due to an
+		event such as interrupt. The default value is 5, it can be set to any
+		value from 1 to 20.
+
+What:		/sys/devices/system/cpu/cpu#/ifs/run_test
+Date:		Feb 28, 2022
+KernelVersion:	5.18.0
+Contact:	linux-kernel@...r.kernel.org
+Description:	IFS target core testing. echo 1 to trigger scan test on cpu#.
+
+What:		/sys/devices/system/cpu/cpu#/ifs/status
+Date:		Feb 28, 2022
+KernelVersion:	5.18.0
+Contact:	linux-kernel@...r.kernel.org
+Description:	The status of IFS test on a specific cpu#. It can be one of "pass", "fail"
+		or "untested".
+
+What:		/sys/devices/system/cpu/cpu#/ifs/details
+Date:		Feb 28, 2022
+KernelVersion:	5.18.0
+Contact:	linux-kernel@...r.kernel.org
+Description:	The details file reports the hex value of the SCAN_STATUS MSR. Note that
+		the error_code field may contain driver defined software code not defined
+		in the Intel SDM.
+
-- 
2.17.1