From: "Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>
To: Ehab Ababneh <ehab.ababneh@intel.com>
Cc: Hans de Goede <hansg@kernel.org>,
tony.luck@intel.com, ashok.raj.linux@gmail.com,
platform-driver-x86@vger.kernel.org,
LKML <linux-kernel@vger.kernel.org>,
tglx@kernel.org, mingo@redhat.com, bp@alien8.de,
dave.hansen@linux.intel.com, x86@kernel.org, hpa@zytor.com,
rostedt@goodmis.org, mhiramat@kernel.org,
mathieu.desnoyers@efficios.com,
linux-trace-kernel@vger.kernel.org, peterz@infradead.org,
sathyanarayanan.kuppuswamy@linux.intel.com,
pengfei.xu@intel.com, ravi.v.shankar@intel.com
Subject: Re: [PATCH v2 16/17] platform/x86/intel/ifs: Update IFS documentation
Date: Thu, 19 Nov 2026 14:12:09 +0200 (EET) [thread overview]
Message-ID: <28f3b7a5-aea5-3298-63a3-cf1e7290e5de@linux.intel.com> (raw)
In-Reply-To: <20261118193259.519568-17-ehab.ababneh@intel.com>
On Wed, 18 Nov 2026, Ehab Ababneh wrote:
> From: Qiuxu Zhuo <qiuxu.zhuo@intel.com>
>
> Update the simultaneous IFS testing domain in the IFS documentation from
> a core to a group that shares the same SCAN engine, which works for both
> the traditional Hyper-Threading (HT) systems and the Dual-Core Module (DCM)
> based systems (e.g., Diamond Rapids).
>
> Add documentation for the new sysfs interfaces {status, details,
> addnl_details, cpus_ran}_list.
>
> Signed-off-by: Qiuxu Zhuo <qiuxu.zhuo@intel.com>
> Signed-off-by: Ehab Ababneh <ehab.ababneh@intel.com>
> Tested-by: Yi Lai <yi1.lai@intel.com>
> ---
> drivers/platform/x86/intel/ifs/ifs.h | 66 ++++++++++++++++++----------
> 1 file changed, 44 insertions(+), 22 deletions(-)
>
> diff --git a/drivers/platform/x86/intel/ifs/ifs.h b/drivers/platform/x86/intel/ifs/ifs.h
> index 10eea2c6b871..46461cc69f94 100644
> --- a/drivers/platform/x86/intel/ifs/ifs.h
> +++ b/drivers/platform/x86/intel/ifs/ifs.h
> @@ -14,11 +14,11 @@
> * Introduction
> * ------------
> *
> - * In Field Scan (IFS) is a hardware feature to run circuit level tests on
> - * a CPU core to detect problems that are not caught by parity or ECC checks.
> - * Future CPUs will support more than one type of test which will show up
> - * with a new platform-device instance-id.
> - *
> + * In-Field Scan (IFS) is a hardware feature that runs circuit-level tests on
> + * all CPUs in a group, where all CPUs share the same SCAN test engine to
> + * detect problems that are not caught by parity or ECC checks. Future CPUs
> + * will support more than one type of test, which will show up with a new
> + * platform-device instance-id.
> *
> * IFS Image
> * ---------
> @@ -59,19 +59,19 @@
> * Running tests
> * -------------
> *
> - * Tests are run by the driver synchronizing execution of all threads on a
> - * core and then writing to the ACTIVATE_SCAN MSR on all threads. Instruction
> - * execution continues when:
> + * Tests are run by the driver synchronizing execution of all CPUs in a group
> + * that share the same SCAN test engine, then writing to the ACTIVATE_SCAN MSR
> + * on all CPUs. Instruction execution continues when:
> *
> * 1) All tests have completed.
> * 2) Execution was interrupted.
> * 3) A test detected a problem.
> *
> - * Note that ALL THREADS ON THE CORE ARE EFFECTIVELY OFFLINE FOR THE
> + * Note that ALL CPUs IN THE GROUP ARE EFFECTIVELY OFFLINE FOR THE
> * DURATION OF THE TEST. This can be up to 200 milliseconds. If the system
> - * is running latency sensitive applications that cannot tolerate an
> + * is running latency-sensitive applications that cannot tolerate an
> * interruption of this magnitude, the system administrator must arrange
> - * to migrate those applications to other cores before running a core test.
> + * to migrate those applications to other CPUs before running a group test.
> * It may also be necessary to redirect interrupts to other CPUs.
> *
> * In all cases reading the corresponding test's STATUS MSR provides details on what
> @@ -81,30 +81,52 @@
> * The IFS driver provides sysfs interfaces via /sys/devices/virtual/misc/intel_ifs_<n>/
> * to control execution:
> *
> - * Test a specific core::
> + * Test a specific group::
> *
> * # echo <CPU#> > /sys/devices/virtual/misc/intel_ifs_<n>/run_test
> *
> - * when HT is enabled any of the sibling CPU# can be specified to test
> - * its corresponding physical core. Since the tests are per physical core,
> - * the result of testing any thread is same. All siblings must be online
> - * to run a core test. It is only necessary to test one thread.
> + * Any CPU in the same group that shares the same SCAN test engine can be
> + * specified to test its corresponding group. Offline CPUs in the group do
> + * not take part in the test; if the test then does not pass, the driver
> + * warns. It is only necessary to test one CPU in the group.
> *
> - * For e.g. to test core corresponding to CPU5
> + * For e.g. to test a group corresponding to CPU5
> *
> * # echo 5 > /sys/devices/virtual/misc/intel_ifs_<n>/run_test
> *
> - * Results of the last test is provided in /sys::
> + * The result of the last test for the primary CPU in the group is provided in /sys::
> *
> * $ cat /sys/devices/virtual/misc/intel_ifs_<n>/status
> * pass
> *
> - * Status can be one of pass, fail, untested
> + * Status can be one of pass, fail, untested.
> *
> - * Additional details of the last test is provided by the details file::
> + * Additional details of the last test for the primary CPU in the group are provided in /sys::
Does kerneldoc require long lines for :: ? If not, please reflow to 80
chars (and all similar cases you touch in this patch).
> *
> * $ cat /sys/devices/virtual/misc/intel_ifs_<n>/details
> - * 0x8081
> + * 0x7f0080
> + *
> + * For intel_ifs_0, there are following additional sysfs files:
> + *
> + * All CPUs in the same group that ran the test are provided in /sys::
> + *
> + * $ cat /sys/devices/virtual/misc/intel_ifs_0/cpus_ran_list
> + * 5,149
> + *
> + * The results of the last test for all CPUs in the same group are provided in /sys::
> + *
> + * $ cat /sys/devices/virtual/misc/intel_ifs_0/status_list
> + * pass pass
> + *
> + * Additional details of the last test for all CPUs in the same group are provided in /sys::
> + *
> + * $ cat /sys/devices/virtual/misc/intel_ifs_0/details_list
> + * 0x7f0080 0x7f0080
> + *
> + * More additional details of the last test for all CPUs in the same group are provided in /sys::
> + *
> + * $ cat /sys/devices/virtual/misc/intel_ifs_0/addnl_details_list
> + * 0xc44191a 0xc44191a
> *
> * The details file reports the hex value of the test specific status MSR.
> * Hardware defined error codes are documented in volume 4 of the Intel
> @@ -125,7 +147,7 @@
> * uses the subrange feature to restart an interrupted test.
> *
> * 2) Hardware allows for some number of cores to be tested in parallel.
> - * The driver does not make use of this, it only tests one core at a time.
> + * The driver does not make use of this, it only tests one group at a time.
> *
> */
> #include <linux/device.h>
>
--
i.
next prev parent reply other threads:[~2026-11-19 12:12 UTC|newest]
Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-11-18 19:32 [PATCH v2 00/17] platform/x86/intel/ifs: Support group-based In-Field Scan and Diamond Rapids Ehab Ababneh
2026-11-18 19:32 ` [PATCH v2 01/17] platform/x86/intel/ifs: Revert SBAF feature Ehab Ababneh
2026-11-18 19:32 ` [PATCH v2 02/17] platform/x86/intel/ifs: Fix IFS sysfs interfaces in the comments Ehab Ababneh
2026-11-18 19:32 ` [PATCH v2 03/17] platform/x86/intel/ifs: Clarify In-Field Scan MSR bit macro definitions Ehab Ababneh
2026-11-18 19:32 ` [PATCH v2 04/17] platform/x86/intel/ifs: Use u64 to define the bits of IFS MSR registers Ehab Ababneh
2026-11-18 19:32 ` [PATCH v2 05/17] platform/x86/intel/ifs: Early return on the IFS image hash/chunk error Ehab Ababneh
2026-11-18 19:32 ` [PATCH v2 06/17] platform/x86/intel/ifs: Refactor Array BIST function interface Ehab Ababneh
2026-11-18 19:32 ` [PATCH v2 07/17] stop_machine: Add stop_cluster_cpuslocked() for per-cluster operations Ehab Ababneh
2026-11-19 11:28 ` Ilpo Järvinen
2026-11-18 19:32 ` [PATCH v2 08/17] platform/x86/intel/ifs: Enumerate the bit to determine if CPUs need to join for IFS tests Ehab Ababneh
2026-11-18 19:32 ` [PATCH v2 09/17] platform/x86/intel/ifs: Select CPUs from topology_cluster_cpumask() for simultaneous " Ehab Ababneh
2026-11-19 11:38 ` Ilpo Järvinen
2026-11-18 19:32 ` [PATCH v2 10/17] platform/x86/intel/ifs: Warn if a group test fails with CPUs missing Ehab Ababneh
2026-11-19 11:42 ` Ilpo Järvinen
2026-11-18 19:32 ` [PATCH v2 11/17] platform/x86/intel/ifs: Track and report scan results on a per-CPU basis Ehab Ababneh
2026-11-18 19:47 ` sashiko-bot
2026-11-19 12:00 ` Ilpo Järvinen
2026-11-18 19:32 ` [PATCH v2 12/17] platform/x86/intel/ifs: Add new sysfs interfaces {status, details, cpus_ran}_list Ehab Ababneh
2026-11-19 12:06 ` Ilpo Järvinen
2026-11-18 19:32 ` [PATCH v2 13/17] platform/x86/intel/ifs: Add additional details sysfs interface Ehab Ababneh
2026-11-18 19:32 ` [PATCH v2 14/17] platform/x86/intel/ifs: Add Intel Diamond Rapids server support Ehab Ababneh
2026-11-18 19:32 ` [PATCH v2 15/17] platform/x86/intel/ifs: Remove limit on number of batch files Ehab Ababneh
2026-11-19 12:09 ` Ilpo Järvinen
2026-11-18 19:32 ` [PATCH v2 16/17] platform/x86/intel/ifs: Update IFS documentation Ehab Ababneh
2026-11-19 12:12 ` Ilpo Järvinen [this message]
2026-11-18 19:32 ` [PATCH v2 17/17] Documentation/ABI: Update IFS ABI doc Ehab Ababneh
2026-11-19 12:13 ` Ilpo Järvinen
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=28f3b7a5-aea5-3298-63a3-cf1e7290e5de@linux.intel.com \
--to=ilpo.jarvinen@linux.intel.com \
--cc=ashok.raj.linux@gmail.com \
--cc=bp@alien8.de \
--cc=dave.hansen@linux.intel.com \
--cc=ehab.ababneh@intel.com \
--cc=hansg@kernel.org \
--cc=hpa@zytor.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-trace-kernel@vger.kernel.org \
--cc=mathieu.desnoyers@efficios.com \
--cc=mhiramat@kernel.org \
--cc=mingo@redhat.com \
--cc=pengfei.xu@intel.com \
--cc=peterz@infradead.org \
--cc=platform-driver-x86@vger.kernel.org \
--cc=ravi.v.shankar@intel.com \
--cc=rostedt@goodmis.org \
--cc=sathyanarayanan.kuppuswamy@linux.intel.com \
--cc=tglx@kernel.org \
--cc=tony.luck@intel.com \
--cc=x86@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.