Documentation/ABI: Update IFS ABI doc
commit3a2f2756c5
upstream. 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. Intel-SIG: commit3a2f2756c5
Documentation/ABI: Update IFS ABI doc Backport Intel In Field Scan(IFS) Array BIST support. 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> [ Aichun Shi: amend commit log ] Signed-off-by: Aichun Shi <aichun.shi@intel.com>
This commit is contained in:
parent
a733fe99c6
commit
e59808c931
|
@ -1,3 +1,7 @@
|
||||||
|
Device instance to test mapping
|
||||||
|
intel_ifs_0 -> Scan Test
|
||||||
|
intel_ifs_1 -> Array BIST test
|
||||||
|
|
||||||
What: /sys/devices/virtual/misc/intel_ifs_<N>/run_test
|
What: /sys/devices/virtual/misc/intel_ifs_<N>/run_test
|
||||||
Date: Nov 16 2022
|
Date: Nov 16 2022
|
||||||
KernelVersion: 6.2
|
KernelVersion: 6.2
|
||||||
|
@ -8,6 +12,7 @@ Description: Write <cpu#> to trigger IFS test for one online core.
|
||||||
completes the test for the core containing that thread.
|
completes the test for the core containing that thread.
|
||||||
Example: to test the core containing cpu5: echo 5 >
|
Example: to test the core containing cpu5: echo 5 >
|
||||||
/sys/devices/virtual/misc/intel_ifs_<N>/run_test
|
/sys/devices/virtual/misc/intel_ifs_<N>/run_test
|
||||||
|
Devices: all
|
||||||
|
|
||||||
What: /sys/devices/virtual/misc/intel_ifs_<N>/status
|
What: /sys/devices/virtual/misc/intel_ifs_<N>/status
|
||||||
Date: Nov 16 2022
|
Date: Nov 16 2022
|
||||||
|
@ -15,21 +20,25 @@ KernelVersion: 6.2
|
||||||
Contact: "Jithu Joseph" <jithu.joseph@intel.com>
|
Contact: "Jithu Joseph" <jithu.joseph@intel.com>
|
||||||
Description: The status of the last test. It can be one of "pass", "fail"
|
Description: The status of the last test. It can be one of "pass", "fail"
|
||||||
or "untested".
|
or "untested".
|
||||||
|
Devices: all
|
||||||
|
|
||||||
What: /sys/devices/virtual/misc/intel_ifs_<N>/details
|
What: /sys/devices/virtual/misc/intel_ifs_<N>/details
|
||||||
Date: Nov 16 2022
|
Date: Nov 16 2022
|
||||||
KernelVersion: 6.2
|
KernelVersion: 6.2
|
||||||
Contact: "Jithu Joseph" <jithu.joseph@intel.com>
|
Contact: "Jithu Joseph" <jithu.joseph@intel.com>
|
||||||
Description: Additional information regarding the last test. The details file reports
|
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
|
the hex value of the STATUS MSR for this test. Note that the error_code field
|
||||||
may contain driver defined software code not defined in the Intel SDM.
|
may contain driver defined software code not defined in the Intel SDM.
|
||||||
|
Devices: all
|
||||||
|
|
||||||
What: /sys/devices/virtual/misc/intel_ifs_<N>/image_version
|
What: /sys/devices/virtual/misc/intel_ifs_<N>/image_version
|
||||||
Date: Nov 16 2022
|
Date: Nov 16 2022
|
||||||
KernelVersion: 6.2
|
KernelVersion: 6.2
|
||||||
Contact: "Jithu Joseph" <jithu.joseph@intel.com>
|
Contact: "Jithu Joseph" <jithu.joseph@intel.com>
|
||||||
Description: Version (hexadecimal) of loaded IFS binary image. If no scan image
|
Description: Version (hexadecimal) of loaded IFS test image. If no test image
|
||||||
is loaded reports "none".
|
is loaded reports "none". Only present for device instances where a test image
|
||||||
|
is applicable.
|
||||||
|
Devices: intel_ifs_0
|
||||||
|
|
||||||
What: /sys/devices/virtual/misc/intel_ifs_<N>/current_batch
|
What: /sys/devices/virtual/misc/intel_ifs_<N>/current_batch
|
||||||
Date: Nov 16 2022
|
Date: Nov 16 2022
|
||||||
|
@ -39,3 +48,5 @@ Description: Write a number less than or equal to 0xff to load an IFS test image
|
||||||
The number written treated as the 2 digit suffix in the following file name:
|
The number written treated as the 2 digit suffix in the following file name:
|
||||||
/lib/firmware/intel/ifs_<N>/ff-mm-ss-02x.scan
|
/lib/firmware/intel/ifs_<N>/ff-mm-ss-02x.scan
|
||||||
Reading the file will provide the suffix of the currently loaded IFS test image.
|
Reading the file will provide the suffix of the currently loaded IFS test image.
|
||||||
|
This file is present only for device instances where a test image is applicable.
|
||||||
|
Devices: intel_ifs_0
|
||||||
|
|
Loading…
Reference in New Issue