From mboxrd@z Thu Jan 1 00:00:00 1970 Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.remote-ip=192.198.163.16 ARC-Seal: i=1; d=subspace.kernel.org; s=arc20261015; a=rsa-sha256; cv=none; t=1795197282; b=jcV5xQKPwmvcirhJK2BhiJ+w3OojNCG1op+M5Hvh63QSP3iE2FJdoiEMYwbb6RQBLYh5 DCw9KvAnkSRjbHq/KnnCdoqxn5evAMC0qlIdMc38j2vCDG6zbAaKwLRqNDIjjsDyW3oib xOmglPbYNGhzqQ8WH5Kxn7FEvkeudJcL+/FZkkA9W34HY9Aba51W1tREDgVtKvgJ0FJer Gq8SmD+Aw6Z2DneOdExyklfmusQR/j9qN3G7rs2nXp9XdD4cmHII3ZQh0mWjtDDv1deTW DYhJvv3lzlAPEwmGWgpbSUQ2uhCG4kyJIyDqzeYWqWJiDRHhdJoRT/V51B2KW9Eg8gA== ARC-Message-Signature: i=1; d=subspace.kernel.org; s=arc20261015; a=rsa-sha256; c=relaxed/relaxed; t=1795197282; h=DMARC-Filter:DKIM-Signature:X-CSE-ConnectionGUID:X-CSE-MsgGUID: X-IronPort-AV:X-IronPort-AV:Received:X-CSE-ConnectionGUID: X-CSE-MsgGUID:X-ExtLoop1:X-IronPort-AV:Received:From:To:Cc:Subject: Date:Message-ID:X-Mailer:In-Reply-To:References:MIME-Version: Content-Transfer-Encoding; bh=4+ViecCr0BZN4kwVSf/cbWYIsKiog4QaWQhI3cXTa70=; b=ygOnqwRbFAb0ZzmYmB5vbjvoFt/G1brhXzJDL6CIBhJL7Gi/IkKw1ETPDf/lZxnDuUBt Zmjna6hTDzAkn7X28VZwfu/QVOaiXi/iRTHBPGYKpr38Klj750ZTZFaPXqJQG7JBpMttf ZmRvlL4ZOrKHNw3Hns4svcigUTETD4Nd8dF486jw1cB9iSasM34Cyl4QRdC4E4zpTwCCY QuJAf0Uaw0qgAkxJqBwaf4aqHAdbx8K2L9VqWfsYqJOc/jluCWNwbnTa5ytPS3JnSYIWX ml6JDvGUjBRa9s238zbuubZn+wl+gNbobVUoEq/rz57f7V7lV1idV3R+iAFZkoTL75A== ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass header.from=intel.com; spf=pass smtp.mailfrom=intel.com; dkim=pass header.d=intel.com header.i=@intel.com header.a=rsa-sha256 header.s=Intel header.b=dqRp9W9E; arc=none smtp.remote-ip=192.198.163.16 Received: from mgamail.intel.com (mgamail.intel.com [192.198.163.16]) (using TLSv1.2 with cipher ECDHE-ECDSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 34D43606E74B; Fri, 20 Nov 2026 17:54:40 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.2 smtp.subspace.kernel.org 34D43606E74B Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=intel.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=intel.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=intel.com header.i=@intel.com header.a=rsa-sha256 header.s=Intel header.b=dqRp9W9E DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1795197281; x=1826733281; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=2tP/ddf8opwzT7UQWRaT/fMQ/OSraAm/RRUajzwY3TQ=; b=dqRp9W9EnPkn9PJzqq8p7U4N/XAoPKkZhaC480YH9IaENgaBiQg7LFi0 tVHE2BLG1yREUR/RNMbcnVEIxIAtUwcdgpJPpOMLZQSo6r2G0fG6glm76 Nv5K7KnBVnbn0c4Z+LoQWZS1Qrg/U3jzM+l8JgAc4XaRCOaQbTDBPjq+9 zq9VuDuRHE062hnxq0M1FBf4tvP7l79RRDymrr/3twJFoEaAYmMW6AMER LlZds3Ew4c6/xmPsh/z0qUkPKr4/nFLTiLUX15Fka/PkB3IMP/7rUt25r +uJbh9QSG1OLJD/YwlP7rjWgK7cIaomUI2XvjA9nk/uZEzzBXg2l5zPhm A==; X-CSE-ConnectionGUID: jTBNwrkSTkK5mR5PR0maHg== X-CSE-MsgGUID: BSjT3FtJS2Wg5pLwZV/wXA== X-IronPort-AV: E=McAfee;i="6800,10657,11972"; a="4109032" X-IronPort-AV: E=Sophos;i="6.27,223,1787036400"; d="scan'208";a="4109032" Received: from fmviesa001.fm.intel.com ([10.60.135.141]) by fmvoesa110.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 20 Nov 2026 09:54:29 -0800 X-CSE-ConnectionGUID: 1JwgsZ2ASBCh+yb/Nfqngw== X-CSE-MsgGUID: 0Y47xFUnTU6+d//IEBh8Iw== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="6.27,223,1787036400"; d="scan'208";a="11171097" Received: from jf.intel.com (HELO jf.intel.com.jf.intel.com) ([10.165.154.102]) by fmviesa001.fm.intel.com with ESMTP; 20 Nov 2026 09:54:28 -0800 From: Ehab Ababneh To: ilpo.jarvinen@linux.intel.com, hansg@kernel.org, tony.luck@intel.com Cc: ashok.raj.linux@gmail.com, platform-driver-x86@vger.kernel.org, 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 Subject: [PATCH v3 16/17] platform/x86/intel/ifs: Update IFS documentation Date: Fri, 20 Nov 2026 10:56:57 -0700 Message-ID: <20261120175658.1147030-17-ehab.ababneh@intel.com> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20261120175658.1147030-1-ehab.ababneh@intel.com> References: <20261120175658.1147030-1-ehab.ababneh@intel.com> X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Post: List-Help: List-Subscribe: List-Unsubscribe: List-Owner: Precedence: list MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: Qiuxu Zhuo 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 Signed-off-by: Ehab Ababneh Tested-by: Yi Lai --- drivers/platform/x86/intel/ifs/ifs.h | 73 +++++++++++++++++++--------- 1 file changed, 51 insertions(+), 22 deletions(-) diff --git a/drivers/platform/x86/intel/ifs/ifs.h b/drivers/platform/x86/intel/ifs/ifs.h index 10eea2c6b871..f735f9c6bcf0 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,59 @@ * The IFS driver provides sysfs interfaces via /sys/devices/virtual/misc/intel_ifs_/ * to control execution: * - * Test a specific core:: + * Test a specific group:: * * # echo > /sys/devices/virtual/misc/intel_ifs_/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_/run_test * - * Results of the last test is provided in /sys:: + * The result of the last test for the whole group is provided in /sys:: * * $ cat /sys/devices/virtual/misc/intel_ifs_/status * pass * - * Status can be one of pass, fail, untested + * Status can be one of pass, fail, untested. It is pass only if all CPUs in + * the group passed. Otherwise it is fail if any CPU failed, or untested if + * any CPU was not fully tested. The per-CPU files below show which CPU did + * not pass. * - * Additional details of the last test is provided by the details file:: + * Additional details of the last test are provided in /sys. If the group + * did not pass, they are for the first CPU with the reported status:: * * $ cat /sys/devices/virtual/misc/intel_ifs_/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 +154,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 -- 2.43.0