From f596b6df13223ecf1d8519a6fbec231d6f80fa78 Mon Sep 17 00:00:00 2001 From: "David B. Kinder" Date: Wed, 21 Apr 2021 14:00:59 -0700 Subject: [PATCH] doc: tweaks for latexpdf build Update missing captions on figures to remove remaining broken references during latexpdf building. Also, require doing a "make html" before doing a "make latexpdf" to build all the artifacts needed for running the latexpdf build. (We might change that later if needed.) Signed-off-by: David B. Kinder --- doc/Makefile | 2 +- doc/developer-guides/hld/hv-partitionmode.rst | 2 ++ doc/developer-guides/hld/virtio-blk.rst | 2 ++ doc/tutorials/trustyACRN.rst | 10 ++++++++++ 4 files changed, 15 insertions(+), 1 deletion(-) diff --git a/doc/Makefile b/doc/Makefile index c69851bab..743c325d6 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -90,5 +90,5 @@ endif # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(OPTS) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile doxy +%: Makefile @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(OPTS) diff --git a/doc/developer-guides/hld/hv-partitionmode.rst b/doc/developer-guides/hld/hv-partitionmode.rst index cc4c8b4a8..26a6014e1 100644 --- a/doc/developer-guides/hld/hv-partitionmode.rst +++ b/doc/developer-guides/hld/hv-partitionmode.rst @@ -78,6 +78,8 @@ events in chronological order. :align: center :name: partBSPsetup + Event Order for Processor Set Up + Memory ====== diff --git a/doc/developer-guides/hld/virtio-blk.rst b/doc/developer-guides/hld/virtio-blk.rst index 9bf18fed4..09419c70e 100644 --- a/doc/developer-guides/hld/virtio-blk.rst +++ b/doc/developer-guides/hld/virtio-blk.rst @@ -43,6 +43,8 @@ Virtio-BLK BE Design :width: 900px :name: virtio-blk-be + Virtio-BLK BE Design + The virtio-blk BE device is implemented as a legacy virtio device. Its backend media could be a file or a partition. The virtio-blk device supports writeback and writethrough cache mode. In writeback mode, diff --git a/doc/tutorials/trustyACRN.rst b/doc/tutorials/trustyACRN.rst index 539054fcb..8de8faf1a 100644 --- a/doc/tutorials/trustyACRN.rst +++ b/doc/tutorials/trustyACRN.rst @@ -140,6 +140,7 @@ details in this `Android keymaster functions document :width: 600px :name: keymaster-app + Keystore service and Keymaster HAL As shown in :numref:`keymaster-app` above, the Keymaster HAL is a dynamically-loadable library used by the Keystore service to provide @@ -191,6 +192,8 @@ forwards RPMB data frame to physical RPMB partition in eMMC. :width: 600px :name: trusty-ss-ta + Trusty Secure Storage Trusted App + As shown in :numref:`trusty-ss-ta` above, Trusty SS TA provides two different services simultaneously: @@ -227,6 +230,8 @@ open/creation/deletion/read/write operations. :width: 600px :name: trusty-ss-ta-storage + Trusty Secure Storage Trusted App Storage + Here is a simple example showing data signing: #. An OEM Client App sends the message that needs signing to the OEM @@ -268,6 +273,8 @@ secure monitor to schedule in/out Trusty secure world. :width: 600px :name: trusty-isolated + Trusty Secure World Isolated User VM + As shown in :numref:`trusty-isolated` above, the hypervisor creates an isolated secure world User VM to support a Trusty OS running in a User VM on ACRN. @@ -282,6 +289,8 @@ Linux-based system (e.g. Android) runs. :width: 600px :name: trusty-lhs-rhs + Trusty Secure World Isolation Details + The secure world is configured by the hypervisor so it has read/write access to a non-secure world's memory space. But non-secure worlds do not have access to a secure world's memory. This is guaranteed by @@ -325,6 +334,7 @@ high-level architecture. :width: 600px :name: trusty-rpmb + Virtualized Secure Storage Architecture In :numref:`trusty-rpmb`, the rKey (RPMB AuthKey) is the physical RPMB authentication key used for data authenticated read/write access between