github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-12-09 22:27:04 +00:00
Code Issues Projects Releases Wiki Activity

HV: io: add structure and API docs

Browse Source 
This patch adds more comments to describe the structures and functions that are
public to the other components in the hypervisor. The comments are in
doxygen-style for document generation.

v2 -> v3:

* Reformat the flow in the doc for vhm_io_request.

v1 -> v2:

* Fix typos and inconsistencies in the comments.
* Wrap the text-based diagram in the doc for vhm_request in @verbatim

Tracked-On: #1595
Signed-off-by: Junjie Mao <junjie.mao@intel.com>
This commit is contained in:
Junjie Mao
2018-10-30 19:44:02 +08:00
committed by David Kinder
parent a4be10f375
commit e0fcb70daa
4 changed files with 417 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
hypervisor/common/io_request.c
View File

@@ -55,11 +55,15 @@ static void acrn_print_request(uint16_t vcpu_id, const struct vhm_request *req)
}
}
/*
/**
* @brief Deliver \p io_req to SOS and suspend \p vcpu till its completion
*
* @param vcpu The virtual CPU that triggers the MMIO access
* @param io_req The I/O request holding the details of the MMIO access
*
* @pre vcpu != NULL && io_req != NULL
*/
int32_t
acrn_insert_request_wait(struct vcpu *vcpu, const struct io_request *io_req)
int32_t acrn_insert_request_wait(struct vcpu *vcpu, const struct io_request *io_req)
{
union vhm_request_buffer *req_buf = NULL;
struct vhm_request *vhm_req;