Skip to content

Commit 379e4de

Browse files
rchatrehansendc
authored andcommitted
x86/sgx: Fix minor documentation issues
The SGX documentation has a few repeated or one-off issues: * Remove capitalization from regular words in the middle of a sentence. * Remove punctuation found in the middle of a sentence. * Fix name of SGX daemon to consistently be ksgxd. * Fix typo of SGX instruction: ENIT -> EINIT [ dhansen: tweaked subject and changelog ] Signed-off-by: Reinette Chatre <[email protected]> Signed-off-by: Dave Hansen <[email protected]> Reviewed-by: Jarkko Sakkinen <[email protected]> Link: https://lkml.kernel.org/r/ab99a87368eef69e3fb96f073368becff3eff874.1635529506.git.reinette.chatre@intel.com
1 parent 688542e commit 379e4de

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

Documentation/x86/sgx.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Overview
1010
Software Guard eXtensions (SGX) hardware enables for user space applications
1111
to set aside private memory regions of code and data:
1212

13-
* Privileged (ring-0) ENCLS functions orchestrate the construction of the.
13+
* Privileged (ring-0) ENCLS functions orchestrate the construction of the
1414
regions.
1515
* Unprivileged (ring-3) ENCLU functions allow an application to enter and
1616
execute inside the regions.
@@ -91,7 +91,7 @@ In addition to the traditional compiler and linker build process, SGX has a
9191
separate enclave “build” process. Enclaves must be built before they can be
9292
executed (entered). The first step in building an enclave is opening the
9393
**/dev/sgx_enclave** device. Since enclave memory is protected from direct
94-
access, special privileged instructions are Then used to copy data into enclave
94+
access, special privileged instructions are then used to copy data into enclave
9595
pages and establish enclave page permissions.
9696

9797
.. kernel-doc:: arch/x86/kernel/cpu/sgx/ioctl.c
@@ -126,13 +126,13 @@ the need to juggle signal handlers.
126126
ksgxd
127127
=====
128128

129-
SGX support includes a kernel thread called *ksgxwapd*.
129+
SGX support includes a kernel thread called *ksgxd*.
130130

131131
EPC sanitization
132132
----------------
133133

134134
ksgxd is started when SGX initializes. Enclave memory is typically ready
135-
For use when the processor powers on or resets. However, if SGX has been in
135+
for use when the processor powers on or resets. However, if SGX has been in
136136
use since the reset, enclave pages may be in an inconsistent state. This might
137137
occur after a crash and kexec() cycle, for instance. At boot, ksgxd
138138
reinitializes all enclave pages so that they can be allocated and re-used.
@@ -147,7 +147,7 @@ Page reclaimer
147147

148148
Similar to the core kswapd, ksgxd, is responsible for managing the
149149
overcommitment of enclave memory. If the system runs out of enclave memory,
150-
*ksgxwapd* “swaps” enclave memory to normal memory.
150+
*ksgxd* “swaps” enclave memory to normal memory.
151151

152152
Launch Control
153153
==============
@@ -156,7 +156,7 @@ SGX provides a launch control mechanism. After all enclave pages have been
156156
copied, kernel executes EINIT function, which initializes the enclave. Only after
157157
this the CPU can execute inside the enclave.
158158

159-
ENIT function takes an RSA-3072 signature of the enclave measurement. The function
159+
EINIT function takes an RSA-3072 signature of the enclave measurement. The function
160160
checks that the measurement is correct and signature is signed with the key
161161
hashed to the four **IA32_SGXLEPUBKEYHASH{0, 1, 2, 3}** MSRs representing the
162162
SHA256 of a public key.
@@ -184,7 +184,7 @@ CPUs starting from Icelake use Total Memory Encryption (TME) in the place of
184184
MEE. TME-based SGX implementations do not have an integrity Merkle tree, which
185185
means integrity and replay-attacks are not mitigated. B, it includes
186186
additional changes to prevent cipher text from being returned and SW memory
187-
aliases from being Created.
187+
aliases from being created.
188188

189189
DMA to enclave memory is blocked by range registers on both MEE and TME systems
190190
(SDM section 41.10).

0 commit comments

Comments
 (0)