From: Bagas Sanjaya <bagasdotme@gmail.com>
To: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, kvm@vger.kernel.org,
Paolo Bonzini <pbonzini@redhat.com>,
Jonathan Corbet <corbet@lwn.net>,
Isaku Yamahata <isaku.yamahata@intel.com>,
Xiaoyao Li <xiaoyao.li@intel.com>,
Yu Zhang <yu.c.zhang@linux.intel.com>,
Chao Peng <chao.p.peng@linux.intel.com>,
Bagas Sanjaya <bagasdotme@gmail.com>
Subject: [PATCH v2 2/3] Documentation: ABI: tdx: grammar improv
Date: Wed, 17 Aug 2022 19:48:36 +0700 [thread overview]
Message-ID: <20220817124837.422695-3-bagasdotme@gmail.com> (raw)
In-Reply-To: <20220817124837.422695-1-bagasdotme@gmail.com>
Improve the grammar used in TDX ABI documentation.
Fixes: 12cafff9983dad ("x86/virt/tdx: Export TDX keyid number and status of TDX module via sysfs")
Fixes: 5318e72c20e45a ("x86/virt/tdx: Export information about the TDX
module via sysfs")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/ABI/testing/sysfs-firmware-tdx | 32 +++++++++-----------
1 file changed, 14 insertions(+), 18 deletions(-)
diff --git a/Documentation/ABI/testing/sysfs-firmware-tdx b/Documentation/ABI/testing/sysfs-firmware-tdx
index bd743d758d7d49..0f2feff311f047 100644
--- a/Documentation/ABI/testing/sysfs-firmware-tdx
+++ b/Documentation/ABI/testing/sysfs-firmware-tdx
@@ -8,11 +8,11 @@ Description:
malicious hosts and some physical attacks. This directory
represents the entry point directory for the TDX.
- the TDX requires the TDX firmware to load into an isolated
- memory region. It requires a two-step loading process. It uses
- the first phase firmware loader (a.k.a NP-SEAMLDR) that loads
- the next loader and the second phase firmware loader(a.k.a
- P-SEAMLDR) that loads the TDX firmware(a.k.a the "TDX module").
+ This feature requires the TDX firmware to load into an isolated
+ memory region. It uses two-step loading process; the first
+ phase is NP-SEAMLDR loader that loads the next one and the
+ second phase is P-SEAMLDR loader that loads the TDX firmware
+ (a.k.a the "TDX module").
=============== ================================================
keyid_num the number of SEAM keyid as an hexadecimal
@@ -25,16 +25,12 @@ KernelVersion: 5.17
Contact: Isaku Yamahata <isaku.yamahata@intel.com>, kvm@vger.kernel.org
Users: libvirt
Description:
- The TDX requires a firmware as known as the TDX module. It comes
- with its attributes, vendor_id, build_data, build_num,
- minor_version, major_version, etc.
-
- Provides the information about the TDX module loaded on the
- platform. It contains the following read-only files. The
- information corresponds to the data structure, TDSYSINFO_STRUCT.
- The admins or VMM management software like libvirt can refer to
- that information, determine if TDX is supported, and identify
- the loaded the TDX module.
+ The TDX feature requires a firmware that is known as the TDX
+ module. The module exposes its information in the following
+ read-only files. The information corresponds to the data
+ structure named TDSYSINFO_STRUCT. Administrators or VMM
+ managers like libvirt can refer to it to determine if TDX is
+ supported and identify the loaded module.
================== ============================================
status string of the TDX module status.
@@ -48,12 +44,12 @@ Description:
* "shutdown": the TDX module is shutdown due
to error during initialization.
- attributes 32bit flags of the TDX module attributes as
+ attributes 32-bit flags of the TDX module attributes as
a hexadecimal number with the "0x" prefix.
* Bits 31 - a production module(0) or
a debug module(1).
- * Bits 30:0 Reserved - set to 0.
+ * Bits 0-30 - Reserved - set to 0.
vendor_id vendor ID as a hexadecimal number with the
"0x" prefix.
@@ -62,7 +58,7 @@ Description:
the "0x" prefix.
minor_version minor version as a hexadecimal number with
the "0x" prefix.
- major_version major versionas a hexadecimal number with
+ major_version major version as a hexadecimal number with
the "0x" prefix.
================== ============================================
--
An old man doll... just what I always wanted! - Clara
next prev parent reply other threads:[~2022-08-17 12:49 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-17 12:48 [PATCH v2 0/3] Documentation fixes for kvm-upstream-workaround Bagas Sanjaya
2022-08-17 12:48 ` [PATCH v2 1/3] Documentation: ABI: tdx: fix formatting in ABI documentation Bagas Sanjaya
2022-08-17 12:48 ` Bagas Sanjaya [this message]
2022-08-17 12:48 ` [PATCH v2 3/3] Documentation: kvm: enclose the final closing brace in code block Bagas Sanjaya
2022-08-23 5:57 ` [PATCH v2 0/3] Documentation fixes for kvm-upstream-workaround Isaku Yamahata
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=20220817124837.422695-3-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=chao.p.peng@linux.intel.com \
--cc=corbet@lwn.net \
--cc=isaku.yamahata@intel.com \
--cc=kvm@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=pbonzini@redhat.com \
--cc=xiaoyao.li@intel.com \
--cc=yu.c.zhang@linux.intel.com \
/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