Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

Documentation/ABI: Update IFS ABI doc

Array BIST test doesn't need an IFS test image to operate unlike
the SCAN test. Consequently current_batch and image_version
files are not applicable for Array BIST IFS device instance,
clarify this in the ABI doc.

Also given that multiple tests are supported, take the opportunity
to generalize descriptions wherever applicable.

Signed-off-by: Jithu Joseph <jithu.joseph@intel.com>
Reviewed-by: Tony Luck <tony.luck@intel.com>
Link: https://lore.kernel.org/r/20230322003359.213046-10-jithu.joseph@intel.com
Reviewed-by: Hans de Goede <hdegoede@redhat.com>
Signed-off-by: Hans de Goede <hdegoede@redhat.com>

authored by

Jithu Joseph and committed by
Hans de Goede
3a2f2756 2b965dc0

+14 -3
+14 -3
Documentation/ABI/testing/sysfs-platform-intel-ifs
··· 1 + Device instance to test mapping 2 + intel_ifs_0 -> Scan Test 3 + intel_ifs_1 -> Array BIST test 4 + 1 5 What: /sys/devices/virtual/misc/intel_ifs_<N>/run_test 2 6 Date: Nov 16 2022 3 7 KernelVersion: 6.2 ··· 12 8 completes the test for the core containing that thread. 13 9 Example: to test the core containing cpu5: echo 5 > 14 10 /sys/devices/virtual/misc/intel_ifs_<N>/run_test 11 + Devices: all 15 12 16 13 What: /sys/devices/virtual/misc/intel_ifs_<N>/status 17 14 Date: Nov 16 2022 ··· 20 15 Contact: "Jithu Joseph" <jithu.joseph@intel.com> 21 16 Description: The status of the last test. It can be one of "pass", "fail" 22 17 or "untested". 18 + Devices: all 23 19 24 20 What: /sys/devices/virtual/misc/intel_ifs_<N>/details 25 21 Date: Nov 16 2022 26 22 KernelVersion: 6.2 27 23 Contact: "Jithu Joseph" <jithu.joseph@intel.com> 28 24 Description: Additional information regarding the last test. The details file reports 29 - the hex value of the SCAN_STATUS MSR. Note that the error_code field 25 + the hex value of the STATUS MSR for this test. Note that the error_code field 30 26 may contain driver defined software code not defined in the Intel SDM. 27 + Devices: all 31 28 32 29 What: /sys/devices/virtual/misc/intel_ifs_<N>/image_version 33 30 Date: Nov 16 2022 34 31 KernelVersion: 6.2 35 32 Contact: "Jithu Joseph" <jithu.joseph@intel.com> 36 - Description: Version (hexadecimal) of loaded IFS binary image. If no scan image 37 - is loaded reports "none". 33 + Description: Version (hexadecimal) of loaded IFS test image. If no test image 34 + is loaded reports "none". Only present for device instances where a test image 35 + is applicable. 36 + Devices: intel_ifs_0 38 37 39 38 What: /sys/devices/virtual/misc/intel_ifs_<N>/current_batch 40 39 Date: Nov 16 2022 ··· 48 39 The number written treated as the 2 digit suffix in the following file name: 49 40 /lib/firmware/intel/ifs_<N>/ff-mm-ss-02x.scan 50 41 Reading the file will provide the suffix of the currently loaded IFS test image. 42 + This file is present only for device instances where a test image is applicable. 43 + Devices: intel_ifs_0