platform-driver-x86.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jithu Joseph <jithu.joseph@intel.com>
To: hdegoede@redhat.com, markgross@kernel.org
Cc: tglx@linutronix.de, mingo@redhat.com, bp@alien8.de,
	dave.hansen@linux.intel.com, x86@kernel.org, hpa@zytor.com,
	gregkh@linuxfoundation.org, rostedt@goodmis.org,
	jithu.joseph@intel.com, ashok.raj@intel.com, tony.luck@intel.com,
	linux-kernel@vger.kernel.org,
	platform-driver-x86@vger.kernel.org, patches@lists.linux.dev,
	ravi.v.shankar@intel.com, thiago.macieira@intel.com,
	athenas.jimenez.gonzalez@intel.com, sohil.mehta@intel.com
Subject: [PATCH v3 8/8] Documentation/ABI: Update IFS ABI doc
Date: Tue, 28 Feb 2023 17:59:42 -0800	[thread overview]
Message-ID: <20230301015942.462799-9-jithu.joseph@intel.com> (raw)
In-Reply-To: <20230301015942.462799-1-jithu.joseph@intel.com>

Array BIST test doesn't need an IFS test image to operate unlike
the SCAN test. Consequently current_batch and image_version
files are not applicable for Array BIST IFS device instance,
clarify this in the ABI doc.

Also given that multiple tests are supported, take the opportunity
to generalize descriptions wherever applicable.

Signed-off-by: Jithu Joseph <jithu.joseph@intel.com>
Reviewed-by: Tony Luck <tony.luck@intel.com>
---
 Documentation/ABI/testing/sysfs-platform-intel-ifs | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-platform-intel-ifs b/Documentation/ABI/testing/sysfs-platform-intel-ifs
index 55991983d0d0..c0cc5ef0739a 100644
--- a/Documentation/ABI/testing/sysfs-platform-intel-ifs
+++ b/Documentation/ABI/testing/sysfs-platform-intel-ifs
@@ -21,15 +21,16 @@ 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
+		the hex value of the STATUS MSR for this test. 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:		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".
+Description:	Version (hexadecimal) of loaded IFS test image. If no test image
+		is loaded reports "none". Only present for device instances where a test image
+		is applicable.
 
 What:		/sys/devices/virtual/misc/intel_ifs_<N>/current_batch
 Date:		Nov 16 2022
@@ -39,3 +40,4 @@ 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.
+		This file is present only for device instances where a test image is applicable.
-- 
2.25.1


  parent reply	other threads:[~2023-03-01  2:01 UTC|newest]

Thread overview: 87+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-31 23:42 [PATCH 0/5] Add Array BIST test support to IFS Jithu Joseph
2023-01-31 23:42 ` [PATCH 1/5] x86/include/asm/msr-index.h: Add IFS Array test bits Jithu Joseph
2023-01-31 23:42 ` [PATCH 2/5] platform/x86/intel/ifs: Introduce Array Scan test to IFS Jithu Joseph
2023-01-31 23:43 ` [PATCH 3/5] platform/x86/intel/ifs: Sysfs interface for Array BIST Jithu Joseph
2023-02-01  5:04   ` Greg KH
2023-02-01 20:55     ` Joseph, Jithu
2023-01-31 23:43 ` [PATCH 4/5] platform/x86/intel/ifs: Implement Array BIST test Jithu Joseph
2023-02-01  5:02   ` Greg KH
2023-02-01 17:22     ` Luck, Tony
2023-02-01 18:19       ` Greg KH
2023-02-01 19:22         ` Tony Luck
2023-02-01 19:35   ` Dave Hansen
2023-02-01 19:43     ` Luck, Tony
2023-02-01 19:53       ` Dave Hansen
2023-02-01 19:45   ` Dave Hansen
2023-02-01 19:56     ` Joseph, Jithu
2023-02-01 20:49       ` Dave Hansen
2023-02-01 21:34         ` Luck, Tony
2023-01-31 23:43 ` [PATCH 5/5] platform/x86/intel/ifs: Trace support for array test Jithu Joseph
2023-02-06 16:40   ` Steven Rostedt
2023-02-06 19:50     ` Joseph, Jithu
2023-02-14 23:44 ` [PATCH v2 0/7] Add Array BIST test support to IFS Jithu Joseph
2023-02-14 23:44   ` [PATCH v2 1/7] x86/include/asm/msr-index.h: Add IFS Array test bits Jithu Joseph
2023-02-14 23:44   ` [PATCH v2 2/7] platform/x86/intel/ifs: Introduce Array Scan test to IFS Jithu Joseph
2023-02-16 12:40     ` Greg KH
2023-02-16 18:46       ` Luck, Tony
2023-02-16 22:57       ` Joseph, Jithu
2023-02-17  9:25         ` Greg KH
2023-02-14 23:44   ` [PATCH v2 3/7] platform/x86/intel/ifs: Sysfs interface for Array BIST Jithu Joseph
2023-02-14 23:44   ` [PATCH v2 4/7] platform/x86/intel/ifs: Implement Array BIST test Jithu Joseph
2023-02-15 16:58     ` Dave Hansen
2023-02-15 17:11       ` Dave Hansen
2023-02-15 20:22         ` Joseph, Jithu
2023-02-15 20:26           ` Dave Hansen
2023-02-15 21:13             ` Joseph, Jithu
2023-02-15 21:18               ` Dave Hansen
2023-02-22 20:12               ` Dave Hansen
2023-02-22 22:07                 ` Joseph, Jithu
2023-02-22 22:28                   ` Dave Hansen
2023-02-22 22:36                     ` Steven Rostedt
2023-02-22 23:32                     ` Joseph, Jithu
2023-02-22 23:59                       ` Dave Hansen
2023-02-15 17:44       ` Joseph, Jithu
2023-02-14 23:44   ` [PATCH v2 5/7] platform/x86/intel/ifs: Trace support for array test Jithu Joseph
2023-02-16  0:56     ` Steven Rostedt
2023-02-14 23:44   ` [PATCH v2 6/7] platform/x86/intel/ifs: Update IFS doc Jithu Joseph
2023-02-14 23:44   ` [PATCH v2 7/7] Documentation/ABI: Update IFS ABI doc Jithu Joseph
2023-03-01  1:59   ` [PATCH v3 0/8] Add Array BIST test support to IFS Jithu Joseph
2023-03-01  1:59     ` [PATCH v3 1/8] platform/x86/intel/ifs: Reorganize driver data Jithu Joseph
2023-03-13 14:46       ` Hans de Goede
2023-03-13 21:34         ` Joseph, Jithu
2023-03-16  9:43           ` Hans de Goede
2023-03-01  1:59     ` [PATCH v3 2/8] platform/x86/intel/ifs: IFS cleanup Jithu Joseph
2023-03-13 15:02       ` Hans de Goede
2023-03-01  1:59     ` [PATCH v3 3/8] x86/include/asm/msr-index.h: Add IFS Array test bits Jithu Joseph
2023-03-13 15:03       ` Hans de Goede
2023-03-01  1:59     ` [PATCH v3 4/8] platform/x86/intel/ifs: Introduce Array Scan test to IFS Jithu Joseph
2023-03-13 16:10       ` Hans de Goede
2023-03-13 16:29         ` Hans de Goede
2023-03-13 17:21           ` Luck, Tony
2023-03-15 19:29             ` Joseph, Jithu
2023-03-16  9:50               ` Hans de Goede
2023-03-16 19:44                 ` Joseph, Jithu
2023-03-01  1:59     ` [PATCH v3 5/8] platform/x86/intel/ifs: Sysfs interface for Array BIST Jithu Joseph
2023-03-13 16:14       ` Hans de Goede
2023-03-01  1:59     ` [PATCH v3 6/8] platform/x86/intel/ifs: Implement Array BIST test Jithu Joseph
2023-03-13 16:24       ` Hans de Goede
2023-03-13 16:37         ` Joseph, Jithu
2023-03-16  9:59           ` Hans de Goede
2023-03-16 17:40             ` Joseph, Jithu
2023-03-16 18:11             ` Joseph, Jithu
2023-03-16 19:38               ` Hans de Goede
2023-03-01  1:59     ` [PATCH v3 7/8] platform/x86/intel/ifs: Update IFS doc Jithu Joseph
2023-03-01  1:59     ` Jithu Joseph [this message]
2023-03-07 11:02     ` [PATCH v3 0/8] Add Array BIST test support to IFS Hans de Goede
2023-03-22  0:33     ` [PATCH v4 0/9] " Jithu Joseph
2023-03-22  0:33       ` [PATCH v4 1/9] platform/x86/intel/ifs: Separate ifs_pkg_auth from ifs_data Jithu Joseph
2023-03-22  0:33       ` [PATCH v4 2/9] platform/x86/intel/ifs: Reorganize driver data Jithu Joseph
2023-03-22  0:33       ` [PATCH v4 3/9] platform/x86/intel/ifs: IFS cleanup Jithu Joseph
2023-03-22  0:33       ` [PATCH v4 4/9] x86/include/asm/msr-index.h: Add IFS Array test bits Jithu Joseph
2023-03-22  0:33       ` [PATCH v4 5/9] platform/x86/intel/ifs: Introduce Array Scan test to IFS Jithu Joseph
2023-03-22  0:33       ` [PATCH v4 6/9] platform/x86/intel/ifs: Sysfs interface for Array BIST Jithu Joseph
2023-03-22  0:33       ` [PATCH v4 7/9] platform/x86/intel/ifs: Implement Array BIST test Jithu Joseph
2023-03-22  0:33       ` [PATCH v4 8/9] platform/x86/intel/ifs: Update IFS doc Jithu Joseph
2023-03-22  0:33       ` [PATCH v4 9/9] Documentation/ABI: Update IFS ABI doc Jithu Joseph
2023-03-27 13:10       ` [PATCH v4 0/9] Add Array BIST test support to IFS Hans de Goede
2023-04-07  1:49         ` Pengfei Xu

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=20230301015942.462799-9-jithu.joseph@intel.com \
    --to=jithu.joseph@intel.com \
    --cc=ashok.raj@intel.com \
    --cc=athenas.jimenez.gonzalez@intel.com \
    --cc=bp@alien8.de \
    --cc=dave.hansen@linux.intel.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=hdegoede@redhat.com \
    --cc=hpa@zytor.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=markgross@kernel.org \
    --cc=mingo@redhat.com \
    --cc=patches@lists.linux.dev \
    --cc=platform-driver-x86@vger.kernel.org \
    --cc=ravi.v.shankar@intel.com \
    --cc=rostedt@goodmis.org \
    --cc=sohil.mehta@intel.com \
    --cc=tglx@linutronix.de \
    --cc=thiago.macieira@intel.com \
    --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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).