From fe08a44e835882cba76dbe935b15e3f9b51bc4d3 Mon Sep 17 00:00:00 2001 From: Binbin Wu Date: Thu, 15 Nov 2018 11:44:59 +0800 Subject: [PATCH] hv: doc: use doxygen-generated API docs in HLD for passthru This patch adds vtd.h to the input of doxygen and replaces hard-coded API docs with doxygen-generated ones. Tracked-On: #1595 Signed-off-by: Binbin Wu Reviewed-by: Geoffroy Van Cutsem --- doc/acrn.doxyfile | 1 + .../hld/hv-dev-passthrough.rst | 42 +++++++------------ 2 files changed, 15 insertions(+), 28 deletions(-) diff --git a/doc/acrn.doxyfile b/doc/acrn.doxyfile index a8b1afc2b..0d0748603 100644 --- a/doc/acrn.doxyfile +++ b/doc/acrn.doxyfile @@ -803,6 +803,7 @@ INPUT = custom-doxygen/mainpage.md \ ../hypervisor/include/arch/x86/guest/vioapic.h \ ../hypervisor/include/arch/x86/guest/vpic.h \ ../hypervisor/include/arch/x86/ioreq.h \ + ../hypervisor/include/arch/x86/assign.h \ ../hypervisor/include/common/hypercall.h \ ../hypervisor/include/public/acrn_common.h \ ../hypervisor/include/public/acrn_hv_defs.h \ diff --git a/doc/developer-guides/hld/hv-dev-passthrough.rst b/doc/developer-guides/hld/hv-dev-passthrough.rst index 3f8f6dc39..447949a70 100644 --- a/doc/developer-guides/hld/hv-dev-passthrough.rst +++ b/doc/developer-guides/hld/hv-dev-passthrough.rst @@ -231,45 +231,31 @@ in scope of hypervisor. Data structures and interfaces ****************************** -.. note:: replace with reference to API docs - The following APIs are provided to initialize interrupt remapping for SOS: -- int ptdev_intx_pin_remap(struct vm \*vm, uint8_t virt_pin, enum - ptdev_vpin_source vpin_src); +.. doxygenfunction:: ptdev_intx_pin_remap + :project: Project ACRN - Set up the remapping of the given virtual pin for the given vm. - -- int ptdev_msix_remap(struct vm \*vm, uint16_t virt_bdf, uint16_t - entry_nr, struct ptdev_msi_info \*info); +.. doxygenfunction:: ptdev_msix_remap + :project: Project ACRN The following APIs are provided to manipulate the interrupt remapping for UOS. -- int ptdev_add_intx_remapping(struct vm \*vm, uint16_t virt_bdf, - uint16_t phys_bdf, uint8_t virt_pin, uint8_t phys_pin, bool - pic_pin); +.. doxygenfunction:: ptdev_add_intx_remapping + :project: Project ACRN - Add mapping between the given virtual and physical pin for the - given vm. +.. doxygenfunction:: ptdev_remove_intx_remapping + :project: Project ACRN -- void ptdev_remove_intx_remapping(struct vm \*vm, uint8_t - virt_pin, bool pic_pin); +.. doxygenfunction:: ptdev_add_msix_remapping + :project: Project ACRN - Remove mapping of the given virtual pin for the given vm. - -- int ptdev_add_msix_remapping(struct vm \*vm, uint16_t virt_bdf, - uint16_t phys_bdf, uint32_t vector_count); - - Add mapping of the given number of vectors between the given - physical and virtual BDF for the given vm. - -- void ptdev_remove_msix_remapping(struct vm \*vm, uint16_t - virt_bdf, uint32_t vector_count); - - Remove the mapping of given number of vectors of the given virtual - BDF for the given vm. +.. doxygenfunction:: ptdev_remove_msix_remapping + :project: Project ACRN The following APIs are provided to acknowledge a virtual interrupt. +.. doxygenfunction:: ptdev_intx_ack + :project: Project ACRN