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 <binbin.wu@intel.com> Reviewed-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
This commit is contained in:
parent
973c616ab3
commit
fe08a44e83
|
@ -803,6 +803,7 @@ INPUT = custom-doxygen/mainpage.md \
|
||||||
../hypervisor/include/arch/x86/guest/vioapic.h \
|
../hypervisor/include/arch/x86/guest/vioapic.h \
|
||||||
../hypervisor/include/arch/x86/guest/vpic.h \
|
../hypervisor/include/arch/x86/guest/vpic.h \
|
||||||
../hypervisor/include/arch/x86/ioreq.h \
|
../hypervisor/include/arch/x86/ioreq.h \
|
||||||
|
../hypervisor/include/arch/x86/assign.h \
|
||||||
../hypervisor/include/common/hypercall.h \
|
../hypervisor/include/common/hypercall.h \
|
||||||
../hypervisor/include/public/acrn_common.h \
|
../hypervisor/include/public/acrn_common.h \
|
||||||
../hypervisor/include/public/acrn_hv_defs.h \
|
../hypervisor/include/public/acrn_hv_defs.h \
|
||||||
|
|
|
@ -231,45 +231,31 @@ in scope of hypervisor.
|
||||||
Data structures and interfaces
|
Data structures and interfaces
|
||||||
******************************
|
******************************
|
||||||
|
|
||||||
.. note:: replace with reference to API docs
|
|
||||||
|
|
||||||
The following APIs are provided to initialize interrupt remapping for
|
The following APIs are provided to initialize interrupt remapping for
|
||||||
SOS:
|
SOS:
|
||||||
|
|
||||||
- int ptdev_intx_pin_remap(struct vm \*vm, uint8_t virt_pin, enum
|
.. doxygenfunction:: ptdev_intx_pin_remap
|
||||||
ptdev_vpin_source vpin_src);
|
:project: Project ACRN
|
||||||
|
|
||||||
Set up the remapping of the given virtual pin for the given vm.
|
.. doxygenfunction:: ptdev_msix_remap
|
||||||
|
:project: Project ACRN
|
||||||
- int ptdev_msix_remap(struct vm \*vm, uint16_t virt_bdf, uint16_t
|
|
||||||
entry_nr, struct ptdev_msi_info \*info);
|
|
||||||
|
|
||||||
The following APIs are provided to manipulate the interrupt remapping
|
The following APIs are provided to manipulate the interrupt remapping
|
||||||
for UOS.
|
for UOS.
|
||||||
|
|
||||||
- int ptdev_add_intx_remapping(struct vm \*vm, uint16_t virt_bdf,
|
.. doxygenfunction:: ptdev_add_intx_remapping
|
||||||
uint16_t phys_bdf, uint8_t virt_pin, uint8_t phys_pin, bool
|
:project: Project ACRN
|
||||||
pic_pin);
|
|
||||||
|
|
||||||
Add mapping between the given virtual and physical pin for the
|
.. doxygenfunction:: ptdev_remove_intx_remapping
|
||||||
given vm.
|
:project: Project ACRN
|
||||||
|
|
||||||
- void ptdev_remove_intx_remapping(struct vm \*vm, uint8_t
|
.. doxygenfunction:: ptdev_add_msix_remapping
|
||||||
virt_pin, bool pic_pin);
|
:project: Project ACRN
|
||||||
|
|
||||||
Remove mapping of the given virtual pin for the given vm.
|
.. doxygenfunction:: ptdev_remove_msix_remapping
|
||||||
|
:project: Project ACRN
|
||||||
- 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.
|
|
||||||
|
|
||||||
The following APIs are provided to acknowledge a virtual interrupt.
|
The following APIs are provided to acknowledge a virtual interrupt.
|
||||||
|
|
||||||
|
.. doxygenfunction:: ptdev_intx_ack
|
||||||
|
:project: Project ACRN
|
||||||
|
|
Loading…
Reference in New Issue