Skip to content

Commit fe08a44

Browse files
binbinwu1lijinxia
authored andcommitted
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>
1 parent 973c616 commit fe08a44

File tree

2 files changed

+15
-28
lines changed

2 files changed

+15
-28
lines changed

doc/acrn.doxyfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -803,6 +803,7 @@ INPUT = custom-doxygen/mainpage.md \
803803
../hypervisor/include/arch/x86/guest/vioapic.h \
804804
../hypervisor/include/arch/x86/guest/vpic.h \
805805
../hypervisor/include/arch/x86/ioreq.h \
806+
../hypervisor/include/arch/x86/assign.h \
806807
../hypervisor/include/common/hypercall.h \
807808
../hypervisor/include/public/acrn_common.h \
808809
../hypervisor/include/public/acrn_hv_defs.h \

doc/developer-guides/hld/hv-dev-passthrough.rst

Lines changed: 14 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -231,45 +231,31 @@ in scope of hypervisor.
231231
Data structures and interfaces
232232
******************************
233233

234-
.. note:: replace with reference to API docs
235-
236234
The following APIs are provided to initialize interrupt remapping for
237235
SOS:
238236

239-
- int ptdev_intx_pin_remap(struct vm \*vm, uint8_t virt_pin, enum
240-
ptdev_vpin_source vpin_src);
241-
242-
Set up the remapping of the given virtual pin for the given vm.
237+
.. doxygenfunction:: ptdev_intx_pin_remap
238+
:project: Project ACRN
243239

244-
- int ptdev_msix_remap(struct vm \*vm, uint16_t virt_bdf, uint16_t
245-
entry_nr, struct ptdev_msi_info \*info);
240+
.. doxygenfunction:: ptdev_msix_remap
241+
:project: Project ACRN
246242

247243
The following APIs are provided to manipulate the interrupt remapping
248244
for UOS.
249245

250-
- int ptdev_add_intx_remapping(struct vm \*vm, uint16_t virt_bdf,
251-
uint16_t phys_bdf, uint8_t virt_pin, uint8_t phys_pin, bool
252-
pic_pin);
253-
254-
Add mapping between the given virtual and physical pin for the
255-
given vm.
256-
257-
- void ptdev_remove_intx_remapping(struct vm \*vm, uint8_t
258-
virt_pin, bool pic_pin);
259-
260-
Remove mapping of the given virtual pin for the given vm.
261-
262-
- int ptdev_add_msix_remapping(struct vm \*vm, uint16_t virt_bdf,
263-
uint16_t phys_bdf, uint32_t vector_count);
246+
.. doxygenfunction:: ptdev_add_intx_remapping
247+
:project: Project ACRN
264248

265-
Add mapping of the given number of vectors between the given
266-
physical and virtual BDF for the given vm.
249+
.. doxygenfunction:: ptdev_remove_intx_remapping
250+
:project: Project ACRN
267251

268-
- void ptdev_remove_msix_remapping(struct vm \*vm, uint16_t
269-
virt_bdf, uint32_t vector_count);
252+
.. doxygenfunction:: ptdev_add_msix_remapping
253+
:project: Project ACRN
270254

271-
Remove the mapping of given number of vectors of the given virtual
272-
BDF for the given vm.
255+
.. doxygenfunction:: ptdev_remove_msix_remapping
256+
:project: Project ACRN
273257

274258
The following APIs are provided to acknowledge a virtual interrupt.
275259

260+
.. doxygenfunction:: ptdev_intx_ack
261+
:project: Project ACRN

0 commit comments

Comments
 (0)