[PATCH v4 3/3] x86/sgx: Document SGX_MemTotal to Documentation/x86/meminfo.rst

From: Jarkko Sakkinen
Date: Thu Sep 09 2021 - 20:45:24 EST


Document SGX_MemTotal field of /proc/meminfo to
Documentation/x86/meminfo.rst. This is a new file for x86 specific
meminfo fields.

Suggested-by: Dave Hansen <dave.hansen@xxxxxxxxx>
Signed-off-by: Jarkko Sakkinen <jarkko@xxxxxxxxxx>
---
v4:
* A new patch.
Documentation/x86/meminfo.rst | 11 +++++++++++
1 file changed, 11 insertions(+)
create mode 100644 Documentation/x86/meminfo.rst

diff --git a/Documentation/x86/meminfo.rst b/Documentation/x86/meminfo.rst
new file mode 100644
index 000000000000..999b676a04a8
--- /dev/null
+++ b/Documentation/x86/meminfo.rst
@@ -0,0 +1,11 @@
+This document describes x86 specific fields of /proc/meminfo.
+
+Supplemental fields for /proc/meminfo
+=====================================
+
+SGX_MemTotal
+ Total usable physical SGX memory, also known as Enclave
+ Page Cache (EPC), in kB's. This is the physical memory
+ used for enclave pages. It is below the amount set in
+ the BIOS: a portion of that memory is required for
+ the state of the enclave pages.
--
2.25.1