* [PATCH 0/3] Documentation fixes for kvm-upstream-workaround
@ 2022-08-17 9:54 Bagas Sanjaya
2022-08-17 9:54 ` [PATCH 1/3] Documentation: ABI: tdx: fix formatting in ABI documentation Bagas Sanjaya
` (2 more replies)
0 siblings, 3 replies; 4+ messages in thread
From: Bagas Sanjaya @ 2022-08-17 9:54 UTC (permalink / raw)
To: linux-doc
Cc: linux-kernel, kvm, Paolo Bonzini, Jonathan Corbet,
Isaku Yamahata, Xiaoyao Li, Yu Zhang, Chao Peng, Bagas Sanjaya
Here is documentation fixes for kvm-upstream-workaround branch of TDX
tree [1]. The fixes below should be self-explanatory.
[1]: https://github.com/intel/tdx.git
Bagas Sanjaya (3):
Documentation: ABI: tdx: fix formatting in ABI documentation
Documentation: ABI: tdx: grammar improv
Documentation: kvm: enclose the final closing brace in code block
Documentation/ABI/testing/sysfs-firmware-tdx | 61 ++++++++++----------
Documentation/virt/kvm/api.rst | 2 +-
2 files changed, 32 insertions(+), 31 deletions(-)
base-commit: 85c097fdd1667a842a9e75d8f658fc16bd72981a
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply [flat|nested] 4+ messages in thread
* [PATCH 1/3] Documentation: ABI: tdx: fix formatting in ABI documentation
2022-08-17 9:54 [PATCH 0/3] Documentation fixes for kvm-upstream-workaround Bagas Sanjaya
@ 2022-08-17 9:54 ` Bagas Sanjaya
2022-08-17 9:54 ` [PATCH 2/3] Documentation: ABI: tdx: grammar improv Bagas Sanjaya
2022-08-17 9:54 ` [PATCH 3/3] Documentation: kvm: enclose the final closing brace in code block Bagas Sanjaya
2 siblings, 0 replies; 4+ messages in thread
From: Bagas Sanjaya @ 2022-08-17 9:54 UTC (permalink / raw)
To: linux-doc
Cc: linux-kernel, kvm, Paolo Bonzini, Jonathan Corbet,
Isaku Yamahata, Xiaoyao Li, Yu Zhang, Chao Peng, Bagas Sanjaya
Sphinx reported many warnings on ABI testing symbols doc entry:
Documentation/ABI/testing/sysfs-firmware-tdx:2: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-firmware-tdx:2: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/ABI/testing/sysfs-firmware-tdx:2: WARNING: Malformed table.
Bottom/header table border does not match top border.
=============== ================================================
<snipped>
================== ============================================
Documentation/ABI/testing/sysfs-firmware-tdx:22: WARNING: Blank line required after table.
Documentation/ABI/testing/sysfs-firmware-tdx:22: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-firmware-tdx:22: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/ABI/testing/sysfs-firmware-tdx:22: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-firmware-tdx:22: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/ABI/testing/sysfs-firmware-tdx:22: WARNING: Definition list ends without a blank line; unexpected unindent.
Documentation/ABI/testing/sysfs-firmware-tdx:22: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-firmware-tdx:22: WARNING: Block quote ends without a blank line; unexpected unindent.
Documentation/ABI/testing/sysfs-firmware-tdx:22: WARNING: Definition list ends without a blank line; unexpected unindent.
Documentation/ABI/testing/sysfs-firmware-tdx:22: WARNING: Malformed table.
No bottom table border found.
================== ============================================
<snipped>
Fix the table and lists formatting.
Fixes: 12cafff9983dad ("x86/virt/tdx: Export TDX keyid number and status of TDX module via sysfs")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/ABI/testing/sysfs-firmware-tdx | 31 ++++++++++++--------
1 file changed, 18 insertions(+), 13 deletions(-)
diff --git a/Documentation/ABI/testing/sysfs-firmware-tdx b/Documentation/ABI/testing/sysfs-firmware-tdx
index eba50870ba0e95..8bf2079b83dd9f 100644
--- a/Documentation/ABI/testing/sysfs-firmware-tdx
+++ b/Documentation/ABI/testing/sysfs-firmware-tdx
@@ -2,6 +2,7 @@ What: /sys/firmware/tdx/
Date: March 2022
KernelVersion: 5.17
Contact: Isaku Yamahata <isaku.yamahata@intel.com>, kvm@vger.kernel.org
+Users: libvirt
Description:
Intel's Trust Domain Extensions (TDX) protect guest VMs from
malicious hosts and some physical attacks. This directory
@@ -12,16 +13,17 @@ Description:
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").
+
=============== ================================================
keyid_num the number of SEAM keyid as an hexadecimal
number with the "0x" prefix.
=============== ================================================
-Users: libvirt
What: /sys/firmware/tdx/tdx_module/
Date: March 2022
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,
@@ -36,19 +38,22 @@ Description:
================== ============================================
status string of the TDX module status.
- "unknown"
- "none": the TDX module is not loaded
- "loaded": The TDX module is loaded, but not
- initialized
- "initialized": the TDX module is fully
- initialized
- "shutdown": the TDX module is shutdown due to
- error during initialization.
+
+ * "unknown", "none": the TDX module is not
+ loaded
+ * "loaded": The TDX module is loaded, but
+ not initialized
+ * "initialized": the TDX module is fully
+ initialized
+ * "shutdown": the TDX module is shutdown due to error during initialization.
+
attributes 32bit 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 31 - a production module(0) or
+ a debug module(1).
+ * Bits 30:0 Reserved - set to 0.
+
vendor_id vendor ID as a hexadecimal number with the
"0x" prefix.
build_date build date in yyyymmdd BCD format.
@@ -59,4 +64,4 @@ Description:
major_version major versionas a hexadecimal number with
the "0x" prefix.
================== ============================================
-Users: libvirt
\ No newline at end of file
+
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply related [flat|nested] 4+ messages in thread
* [PATCH 2/3] Documentation: ABI: tdx: grammar improv
2022-08-17 9:54 [PATCH 0/3] Documentation fixes for kvm-upstream-workaround Bagas Sanjaya
2022-08-17 9:54 ` [PATCH 1/3] Documentation: ABI: tdx: fix formatting in ABI documentation Bagas Sanjaya
@ 2022-08-17 9:54 ` Bagas Sanjaya
2022-08-17 9:54 ` [PATCH 3/3] Documentation: kvm: enclose the final closing brace in code block Bagas Sanjaya
2 siblings, 0 replies; 4+ messages in thread
From: Bagas Sanjaya @ 2022-08-17 9:54 UTC (permalink / raw)
To: linux-doc
Cc: linux-kernel, kvm, Paolo Bonzini, Jonathan Corbet,
Isaku Yamahata, Xiaoyao Li, Yu Zhang, Chao Peng, Bagas Sanjaya
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 8bf2079b83dd9f..08c477c1d00e15 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.
@@ -47,12 +43,12 @@ Description:
initialized
* "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.
@@ -61,7 +57,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
^ permalink raw reply related [flat|nested] 4+ messages in thread
* [PATCH 3/3] Documentation: kvm: enclose the final closing brace in code block
2022-08-17 9:54 [PATCH 0/3] Documentation fixes for kvm-upstream-workaround Bagas Sanjaya
2022-08-17 9:54 ` [PATCH 1/3] Documentation: ABI: tdx: fix formatting in ABI documentation Bagas Sanjaya
2022-08-17 9:54 ` [PATCH 2/3] Documentation: ABI: tdx: grammar improv Bagas Sanjaya
@ 2022-08-17 9:54 ` Bagas Sanjaya
2 siblings, 0 replies; 4+ messages in thread
From: Bagas Sanjaya @ 2022-08-17 9:54 UTC (permalink / raw)
To: linux-doc
Cc: linux-kernel, kvm, Paolo Bonzini, Jonathan Corbet,
Isaku Yamahata, Xiaoyao Li, Yu Zhang, Chao Peng, Bagas Sanjaya,
kernel test robot
Sphinx reported literal block warning:
Documentation/virt/kvm/api.rst:1362: WARNING: Literal block ends without a blank line; unexpected unindent.
The warning is caused by the final closing brace in KVM_SET_USER_MEMORY_REGION
struct definition is not indented as literal code block.
Indent the closing brace to fix the warning.
Link: https://lore.kernel.org/linux-doc/202208171109.lCfseeP6-lkp@intel.com/
Fixes: bb90daae9d7551 ("KVM: Extend the memslot to support fd-based private memory")
Reported-by: kernel test robot <lkp@intel.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/virt/kvm/api.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index d9d43078080030..4acf4d1c95c099 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -1359,7 +1359,7 @@ yet and must be cleared on entry.
__u32 private_fd;
__u32 pad1;
__u64 pad2[14];
-};
+ };
/\* for kvm_memory_region::flags \*/
#define KVM_MEM_LOG_DIRTY_PAGES (1UL << 0)
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply related [flat|nested] 4+ messages in thread
end of thread, other threads:[~2022-08-17 9:54 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-08-17 9:54 [PATCH 0/3] Documentation fixes for kvm-upstream-workaround Bagas Sanjaya
2022-08-17 9:54 ` [PATCH 1/3] Documentation: ABI: tdx: fix formatting in ABI documentation Bagas Sanjaya
2022-08-17 9:54 ` [PATCH 2/3] Documentation: ABI: tdx: grammar improv Bagas Sanjaya
2022-08-17 9:54 ` [PATCH 3/3] Documentation: kvm: enclose the final closing brace in code block Bagas Sanjaya
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.