Skip to content

Commit

Permalink
Minor corrections to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dkohlbre committed Jul 17, 2019
1 parent 9e8bd3c commit 8f1e951
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 13 deletions.
3 changes: 2 additions & 1 deletion docs/source/Keystone-Applications/Compiling-Applications.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ Compiling Applications
======================

Building a host and enclave application using the SDK is
straight-forward. See Keystone-Demo as an example.
straight-forward. See Keystone-Demo and the
:doc:`Tutorials</Getting-Started/Tutorials/index>` as examples.


Toolchain
Expand Down
10 changes: 5 additions & 5 deletions docs/source/Keystone-Applications/SDK-Basics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ SDK Overview
The Keystone SDK provides the tools required to build basic enclave
hosting applications (`hosts`) and enclave applications (`eapps`).

The SDK consists of 4 main components, and the tests and examples.
The SDK consists of 4 main components, and examples.

- Host libraries (`lib/host`)
- Enclave Application libraries (`lib/app`)
- Edge libraries (`lib/edge`)
- Runtime (`runtime/`)
- Runtimes (`rts/`)



Expand Down Expand Up @@ -63,9 +63,9 @@ writing 3 things:
- Runtime (system level, inside enclave, trusted) - most users will not modify this
- Enclave app (userspace, inside enclave, trusted)

Most users will only need to write a simple Host, and use the default
Keystone runtime. The bulk of the work is done in the enclave
application, and in the glue that holds the components together.
Most users will only need to write a simple Host, and use the Eyrie
runtime. The bulk of the work is done in the enclave application, and
in the glue that holds the components together.

NOTE: Right now all "edge" components (that is, anything that handles
data and calls between enclave code and non-enclave code) is
Expand Down
3 changes: 2 additions & 1 deletion docs/source/Security-Monitor/FU540.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ Building with the FU540 module
You can re-configure and re-build the ``bbl`` in the build directory:

::
--with-target-platform=fu540

--with-target-platform=fu540


Waymasking internals
Expand Down
6 changes: 1 addition & 5 deletions docs/source/Security-Monitor/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ See `SBI Documentation <#>`_ for details.

Specific platforms
------------------

.. toctree::
:maxdepth: 1

Expand Down Expand Up @@ -73,9 +72,6 @@ To understand how the SM utilizes PMP, we need to know several properties of RIS
TOR consumes adjacent PMP entry's address register for the bound address to allow shared boundaries efficiently.
Ex: Two ranges of 0-2048 and 2048-4096 uses 3 entries, 0, 2048, 4096.

.. note::

The current Keystone SM uses NAPOT (> 4KB), because it relies on Linux memory allocation for contiguous physical memory regions, and these regions are not guaranteed to be contiguous with each other.

At the very beginning of the boot process, physical memory is not accessible by U- or S-modes
because of property 2 as shown in the diagram below.
Expand Down Expand Up @@ -191,4 +187,4 @@ System PMP Synchronization
Side-Channel Defense
-------------------------------------

The FU540 module supports cache side-channel defenses.
The :doc:`FU540<FU540>` module supports cache side-channel defenses.
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Welcome to Keystone Enclave's documentation!
:caption: Keystone Security Monitor:
:numbered:

Security-Monitor/index.rst
Security-Monitor/index


.. toctree::
Expand Down

0 comments on commit 8f1e951

Please sign in to comment.