Commit 2133acdd authored by Jithu Joseph's avatar Jithu Joseph Committed by Aichun Shi
Browse files

Documentation/ABI: Update IFS ABI doc 

mainline inclusion
from mainline-v6.2-rc1
commit 72a0f445
category: feature
feature: Backport Intel In Field Scan(IFS) multi-blob images support
bugzilla: https://gitee.com/openeuler/intel-kernel/issues/I6L337
CVE: N/A
Reference: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/


commit/?id=72a0f445

Intel-SIG: commit 72a0f445 ("Documentation/ABI: Update IFS ABI doc")

-------------------------------------

Documentation/ABI: Update IFS ABI doc

Remove reload documentation and add current_batch documentation.
Update the kernel version and date for all the entries.

Signed-off-by: default avatarJithu Joseph <jithu.joseph@intel.com>
Signed-off-by: default avatarBorislav Petkov <bp@suse.de>
Reviewed-by: default avatarTony Luck <tony.luck@intel.com>
Reviewed-by: default avatarSohil Mehta <sohil.mehta@intel.com>
Reviewed-by: default avatarHans de Goede <hdegoede@redhat.com>
Link: https://lore.kernel.org/r/20221117035935.4136738-16-jithu.joseph@intel.com


Signed-off-by: default avatarAichun Shi <aichun.shi@intel.com>
parent 34fe7b67

Documentation/ABI/testing/sysfs-platform-intel-ifs

+16 −14
Original line number Diff line number Diff line 
What:		/sys/devices/virtual/misc/intel_ifs_<N>/run_test

Date:		April 21 2022

KernelVersion:	5.19

Date:		Nov 16 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:		Nov 16 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:		Nov 16 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:		Nov 16 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:		Nov 16 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.