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

platform/x86/intel/ifs: Update IFS doc

Array BIST is the second test supported by IFS. Modify IFS doc
entry to be more general.

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-9-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
2b965dc0 fed696ce

+14 -11
+14 -11
drivers/platform/x86/intel/ifs/ifs.h
··· 17 17 * In Field Scan (IFS) is a hardware feature to run circuit level tests on 18 18 * a CPU core to detect problems that are not caught by parity or ECC checks. 19 19 * Future CPUs will support more than one type of test which will show up 20 - * with a new platform-device instance-id, for now only .0 is exposed. 20 + * with a new platform-device instance-id. 21 21 * 22 22 * 23 23 * IFS Image ··· 25 25 * 26 26 * Intel provides a firmware file containing the scan tests via 27 27 * github [#f1]_. Similar to microcode there is a separate file for each 28 - * family-model-stepping. 28 + * family-model-stepping. IFS Images are not applicable for some test types. 29 + * Wherever applicable the sysfs directory would provide a "current_batch" file 30 + * (see below) for loading the image. 31 + * 29 32 * 30 33 * IFS Image Loading 31 34 * ----------------- ··· 38 35 * SHA hashes for the test. Then the tests themselves. Status MSRs provide 39 36 * feedback on the success/failure of these steps. 40 37 * 41 - * The test files are kept in a fixed location: /lib/firmware/intel/ifs_0/ 38 + * The test files are kept in a fixed location: /lib/firmware/intel/ifs_<n>/ 42 39 * For e.g if there are 3 test files, they would be named in the following 43 40 * fashion: 44 41 * ff-mm-ss-01.scan ··· 50 47 * (e.g 1, 2 or 3 in the above scenario) into the curent_batch file. 51 48 * To load ff-mm-ss-02.scan, the following command can be used:: 52 49 * 53 - * # echo 2 > /sys/devices/virtual/misc/intel_ifs_0/current_batch 50 + * # echo 2 > /sys/devices/virtual/misc/intel_ifs_<n>/current_batch 54 51 * 55 52 * The above file can also be read to know the currently loaded image. 56 53 * ··· 72 69 * to migrate those applications to other cores before running a core test. 73 70 * It may also be necessary to redirect interrupts to other CPUs. 74 71 * 75 - * In all cases reading the SCAN_STATUS MSR provides details on what 72 + * In all cases reading the corresponding test's STATUS MSR provides details on what 76 73 * happened. The driver makes the value of this MSR visible to applications 77 74 * via the "details" file (see below). Interrupted tests may be restarted. 78 75 * 79 - * The IFS driver provides sysfs interfaces via /sys/devices/virtual/misc/intel_ifs_0/ 76 + * The IFS driver provides sysfs interfaces via /sys/devices/virtual/misc/intel_ifs_<n>/ 80 77 * to control execution: 81 78 * 82 79 * Test a specific core:: 83 80 * 84 - * # echo <cpu#> > /sys/devices/virtual/misc/intel_ifs_0/run_test 81 + * # echo <cpu#> > /sys/devices/virtual/misc/intel_ifs_<n>/run_test 85 82 * 86 83 * when HT is enabled any of the sibling cpu# can be specified to test 87 84 * its corresponding physical core. Since the tests are per physical core, ··· 90 87 * 91 88 * For e.g. to test core corresponding to cpu5 92 89 * 93 - * # echo 5 > /sys/devices/virtual/misc/intel_ifs_0/run_test 90 + * # echo 5 > /sys/devices/virtual/misc/intel_ifs_<n>/run_test 94 91 * 95 92 * Results of the last test is provided in /sys:: 96 93 * 97 - * $ cat /sys/devices/virtual/misc/intel_ifs_0/status 94 + * $ cat /sys/devices/virtual/misc/intel_ifs_<n>/status 98 95 * pass 99 96 * 100 97 * Status can be one of pass, fail, untested 101 98 * 102 99 * Additional details of the last test is provided by the details file:: 103 100 * 104 - * $ cat /sys/devices/virtual/misc/intel_ifs_0/details 101 + * $ cat /sys/devices/virtual/misc/intel_ifs_<n>/details 105 102 * 0x8081 106 103 * 107 - * The details file reports the hex value of the SCAN_STATUS MSR. 104 + * The details file reports the hex value of the test specific status MSR. 108 105 * Hardware defined error codes are documented in volume 4 of the Intel 109 106 * Software Developer's Manual but the error_code field may contain one of 110 107 * the following driver defined software codes: