[PATCH v2 09/10] platform/x86/intel/ifs: add ABI documentation for IFS

Jithu Joseph
2022-04-07T19:15:04Z

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

Reviewed-by: Tony Luck <tony.luck@intel.com>
Signed-off-by: Jithu Joseph <jithu.joseph@intel.com>
---
.../ABI/testing/sysfs-platform-intel-ifs | 54 +++++++++++++++++++
1 file changed, 54 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-platform-intel-ifs

diff --git a/Documentation/ABI/testing/sysfs-platform-intel-ifs b/Documentation/ABI/testing/sysfs-platform-intel-ifs
new file mode 100644
index 000000000000..54dc6cd75484
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-platform-intel-ifs
@@ -0,0 +1,54 @@
+What: /sys/devices/platform/intel_ifs/run_test
+Date: April 07, 2022
+KernelVersion: 5.19.0
+Contact: "Jithu Joseph" <jithu.joseph@intel.com>
+Description: echo <cpu#> to trigger ifs test for all online cores.
+ For e.g to test cpu5 do echo 5 > /sys/devices/platform/intel_ifs/run_test
+
+What: /sys/devices/platform/intel_ifs/status
+Date: April 07, 2022
+KernelVersion: 5.19.0
+Contact: "Jithu Joseph" <jithu.joseph@intel.com>
+Description: The status of the last test. It can be one of "pass", "fail"
+ or "untested".
+
+What: /sys/devices/system/cpu/cpu#/ifs/details
+Date: April 07, 2022
+KernelVersion: 5.19.0
+Contact: "Jithu Joseph" <jithu.joseph@intel.com>
+Description: Additional information regarding the last test. 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.
+
+What: /sys/devices/platform/intel_ifs/image_version
+Date: April 07, 2022
+KernelVersion: 5.19.0
+Contact: "Jithu Joseph" <jithu.joseph@intel.com>
+Description: Version of loaded IFS binary image.
+
+What: /sys/bus/platform/drivers/intel_ifs/bind
+Date: April 07, 2022
+KernelVersion: 5.19.0
+Contact: "Jithu Joseph" <jithu.joseph@intel.com>
+Description: echo "intel_ifs" to reload IFS image.
+
+What: /sys/module/intel_ifs/parameters/noirq
+Date: April 07, 2022
+KernelVersion: 5.19.0
+Contact: "Jithu Joseph" <jithu.joseph@intel.com>
+Description: IFS 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: April 07, 2022
+KernelVersion: 5.19.0
+Contact: "Jithu Joseph" <jithu.joseph@intel.com>
+Description: IFS tunable parameter that user can modify before scan run
+ 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.
--
2.17.1