Documentation: move Trusty documentation to doc/

Move the existing Trusty document to the doc/ folder (where
it belongs) and convert the text to ReST.

The Documentation/ folder under hypervisor/ is removed as all
documents should be put under doc/.

All technical information has been preserved or was already
available in other documents.

Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
This commit is contained in:
Geoffroy Van Cutsem
2018-06-29 18:01:59 +02:00
committed by David Kinder
parent 666430a3d4
commit d24179550e
8 changed files with 228 additions and 175 deletions

View File

@@ -322,9 +322,23 @@ int64_t hcall_setup_sbuf(struct vm *vm, uint64_t param);
int64_t hcall_get_cpu_pm_state(struct vm *vm, uint64_t cmd, uint64_t param);
/**
* @defgroup trusty_hypercall Trusty Hypercalls
*
* This is a special group that includes all hypercalls
* related to Trusty
*
* @{
*/
/**
* @brief Switch VCPU state between Normal/Secure World.
* @brief Switch vCPU state between Normal/Secure World.
*
* * Hypervisor uses the Secure Monitor Code (SMC) instruction to do
* the world switch
* * The hypervisor needs to save current world vCPU contexts, and load
* the next world vCPU contexts
* * Updates ``rdi``, ``rsi``, ``rdx``, ``rbx`` to next world vCPU contexts
*
* @param vcpu Pointer to VCPU data structure
*
@@ -334,11 +348,16 @@ int64_t hcall_get_cpu_pm_state(struct vm *vm, uint64_t cmd, uint64_t param);
int64_t hcall_world_switch(struct vcpu *vcpu);
/**
* @brief Initialize environment for Trusty-OS on a VCPU.
* @brief Initialize environment for Trusty-OS on a vCPU.
*
* @param vcpu Pointer to VCPU data structure
* * It is used by the User OS bootloader (``UOS_Loader``) to request ACRN
* to initialize Trusty
* * The Trusty memory region range, entry point must be specified
* * The hypervisor needs to save current vCPU contexts (Normal World)
*
* @param vcpu Pointer to vCPU data structure
* @param param guest physical address. This gpa points to
* struct trusty_boot_param
* trusty_boot_param structure
*
* @return 0 on success, non-zero on error.
*/
@@ -346,6 +365,10 @@ int64_t hcall_initialize_trusty(struct vcpu *vcpu, uint64_t param);
/**
* @}
*/
*/ // End of trusty_hypercall
/**
* @}
*/ // End of acrn_hypercall
#endif /* HYPERCALL_H*/