[v2,13/14] Documentation/ABI: Update IFS ABI doc
Commit Message
Remove reload documentation and add current_batch documentation.
Update the kernel version and date for all the entries.
Reviewed-by: Tony Luck <tony.luck@intel.com>
Signed-off-by: Jithu Joseph <jithu.joseph@intel.com>
---
.../ABI/testing/sysfs-platform-intel-ifs | 30 ++++++++++---------
1 file changed, 16 insertions(+), 14 deletions(-)
Comments
On 11/7/2022 2:53 PM, Jithu Joseph wrote:
> Remove reload documentation and add current_batch documentation.
> Update the kernel version and date for all the entries.
>
> Reviewed-by: Tony Luck <tony.luck@intel.com>
> Signed-off-by: Jithu Joseph <jithu.joseph@intel.com>
Reviewed-by: Sohil Mehta <sohil.mehta@intel.com>
A clarification below.
>
> -What: /sys/devices/virtual/misc/intel_ifs_<N>/reload
> -Date: April 21 2022
> -KernelVersion: 5.19
> +What: /sys/devices/virtual/misc/intel_ifs_<N>/current_batch
> +Date: Sept 30 2022
> +KernelVersion: 6.2
> Contact: "Jithu Joseph" <jithu.joseph@intel.com>
> -Description: Write "1" (or "y" or "Y") to reload the IFS image from
> - /lib/firmware/intel/ifs/ff-mm-ss.scan.
> +Description: Write a number less than or equal to 0xff to load an IFS test image.
Can the number start from 0 or is it expected to start from 1? It might
be useful to mention that if there is a constraint.
> + The number written treated as the 2 digit suffix in the following file name:
> + /lib/firmware/intel/ifs_<N>/ff-mm-ss-02x.scan
> + Reading the file will provide the suffix of the currently loaded IFS test image.
Sohil
On 11/9/2022 3:55 PM, Sohil Mehta wrote:
>
> A clarification below.
>
>> -What: /sys/devices/virtual/misc/intel_ifs_<N>/reload
>> -Date: April 21 2022
>> -KernelVersion: 5.19
>> +What: /sys/devices/virtual/misc/intel_ifs_<N>/current_batch
>> +Date: Sept 30 2022
>> +KernelVersion: 6.2
>> Contact: "Jithu Joseph" <jithu.joseph@intel.com>
>> -Description: Write "1" (or "y" or "Y") to reload the IFS image from
>> - /lib/firmware/intel/ifs/ff-mm-ss.scan.
>> +Description: Write a number less than or equal to 0xff to load an IFS test image.
>
> Can the number start from 0 or is it expected to start from 1? It might be useful to mention that if there is a constraint.
The driver currently doesn't do any enforcement on if the input starts at 0 / 1. If user writes 0 and if
the corresponding file it looks for (ff-mm-ss-00.<test_type>) is present, it would load it otherwise it would
return error-code ENOENT (returned by request_firmware_direct())
>
>> + The number written treated as the 2 digit suffix in the following file name:
>> + /lib/firmware/intel/ifs_<N>/ff-mm-ss-02x.scan
>> + Reading the file will provide the suffix of the currently loaded IFS test image.
Jithu
Hi,
On 11/7/22 23:53, Jithu Joseph wrote:
> Remove reload documentation and add current_batch documentation.
> Update the kernel version and date for all the entries.
>
> Reviewed-by: Tony Luck <tony.luck@intel.com>
> Signed-off-by: Jithu Joseph <jithu.joseph@intel.com>
Thanks, patch looks good to me:
Reviewed-by: Hans de Goede <hdegoede@redhat.com>
Regards,
Hans
> ---
> .../ABI/testing/sysfs-platform-intel-ifs | 30 ++++++++++---------
> 1 file changed, 16 insertions(+), 14 deletions(-)
>
> diff --git a/Documentation/ABI/testing/sysfs-platform-intel-ifs b/Documentation/ABI/testing/sysfs-platform-intel-ifs
> index 486d6d2ff8a0..f74df3abee57 100644
> --- a/Documentation/ABI/testing/sysfs-platform-intel-ifs
> +++ b/Documentation/ABI/testing/sysfs-platform-intel-ifs
> @@ -1,39 +1,41 @@
> What: /sys/devices/virtual/misc/intel_ifs_<N>/run_test
> -Date: April 21 2022
> -KernelVersion: 5.19
> +Date: Sept 30 2022
> +KernelVersion: 6.2
> Contact: "Jithu Joseph" <jithu.joseph@intel.com>
> Description: Write <cpu#> to trigger IFS test for one online core.
> Note that the test is per core. The cpu# can be
> for any thread on the core. Running on one thread
> completes the test for the core containing that thread.
> Example: to test the core containing cpu5: echo 5 >
> - /sys/devices/platform/intel_ifs.<N>/run_test
> + /sys/devices/virtual/misc/intel_ifs_<N>/run_test
>
> What: /sys/devices/virtual/misc/intel_ifs_<N>/status
> -Date: April 21 2022
> -KernelVersion: 5.19
> +Date: Sept 30 2022
> +KernelVersion: 6.2
> 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/virtual/misc/intel_ifs_<N>/details
> -Date: April 21 2022
> -KernelVersion: 5.19
> +Date: Sept 30 2022
> +KernelVersion: 6.2
> 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/virtual/misc/intel_ifs_<N>/image_version
> -Date: April 21 2022
> -KernelVersion: 5.19
> +Date: Sept 30 2022
> +KernelVersion: 6.2
> Contact: "Jithu Joseph" <jithu.joseph@intel.com>
> Description: Version (hexadecimal) of loaded IFS binary image. If no scan image
> is loaded reports "none".
>
> -What: /sys/devices/virtual/misc/intel_ifs_<N>/reload
> -Date: April 21 2022
> -KernelVersion: 5.19
> +What: /sys/devices/virtual/misc/intel_ifs_<N>/current_batch
> +Date: Sept 30 2022
> +KernelVersion: 6.2
> Contact: "Jithu Joseph" <jithu.joseph@intel.com>
> -Description: Write "1" (or "y" or "Y") to reload the IFS image from
> - /lib/firmware/intel/ifs/ff-mm-ss.scan.
> +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:
> + /lib/firmware/intel/ifs_<N>/ff-mm-ss-02x.scan
> + Reading the file will provide the suffix of the currently loaded IFS test image.
@@ -1,39 +1,41 @@
What: /sys/devices/virtual/misc/intel_ifs_<N>/run_test
-Date: April 21 2022
-KernelVersion: 5.19
+Date: Sept 30 2022
+KernelVersion: 6.2
Contact: "Jithu Joseph" <jithu.joseph@intel.com>
Description: Write <cpu#> to trigger IFS test for one online core.
Note that the test is per core. The cpu# can be
for any thread on the core. Running on one thread
completes the test for the core containing that thread.
Example: to test the core containing cpu5: echo 5 >
- /sys/devices/platform/intel_ifs.<N>/run_test
+ /sys/devices/virtual/misc/intel_ifs_<N>/run_test
What: /sys/devices/virtual/misc/intel_ifs_<N>/status
-Date: April 21 2022
-KernelVersion: 5.19
+Date: Sept 30 2022
+KernelVersion: 6.2
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/virtual/misc/intel_ifs_<N>/details
-Date: April 21 2022
-KernelVersion: 5.19
+Date: Sept 30 2022
+KernelVersion: 6.2
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/virtual/misc/intel_ifs_<N>/image_version
-Date: April 21 2022
-KernelVersion: 5.19
+Date: Sept 30 2022
+KernelVersion: 6.2
Contact: "Jithu Joseph" <jithu.joseph@intel.com>
Description: Version (hexadecimal) of loaded IFS binary image. If no scan image
is loaded reports "none".
-What: /sys/devices/virtual/misc/intel_ifs_<N>/reload
-Date: April 21 2022
-KernelVersion: 5.19
+What: /sys/devices/virtual/misc/intel_ifs_<N>/current_batch
+Date: Sept 30 2022
+KernelVersion: 6.2
Contact: "Jithu Joseph" <jithu.joseph@intel.com>
-Description: Write "1" (or "y" or "Y") to reload the IFS image from
- /lib/firmware/intel/ifs/ff-mm-ss.scan.
+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:
+ /lib/firmware/intel/ifs_<N>/ff-mm-ss-02x.scan
+ Reading the file will provide the suffix of the currently loaded IFS test image.