github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-06-29 16:58:10 +00:00
Code Issues Projects Releases Wiki Activity

hv: doc: use doxygen-generated API docs in HLD for vtd

Browse Source 
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>
This commit is contained in:
Binbin Wu 2018-10-31 13:24:49 +08:00 committed by David Kinder
parent 1776d7e7fc
commit 4b3b11552d
2 changed files with 20 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/acrn.doxyfile
View File

@ -795,6 +795,7 @@ INPUT = custom-doxygen/mainpage.md \
../hypervisor/include/arch/x86/mmu.h \
../hypervisor/include/arch/x86/mtrr.h \
../hypervisor/include/arch/x86/pgtable.h \
../hypervisor/include/arch/x86/vtd.h \
../hypervisor/include/common/hypercall.h \
../hypervisor/include/public/acrn_common.h \
../hypervisor/include/public/acrn_hv_defs.h \

76
doc/developer-guides/hld/hv-vt-d.rst
View File

@ -35,7 +35,7 @@ For generic platforms, ACRN hypervisor retrieves DMAR information from
the ACPI table, and parses the DMAR reporting structure to discover the
number of DMA-remapping hardware units present in the platform as well as
the devices under the scope of a remapping hardware unit, as shown in
:numref:`dma-remap-report`:
:numref:`dma-remap-report`:
.. figure:: images/vt-d-image90.png
:align: center
@ -297,76 +297,38 @@ handler will be called to report error event.
Data structures and interfaces
******************************
.. note:: Needs API reference to include/arch/x86/vtd.h
initialization and deinitialization
===================================
The following APIs are provided during initialization and
deinitialization:
- void init_iommu(void)
.. doxygenfunction:: init_iommu
:project: Project ACRN
Register DMAR units on the platform according to the reparsed
information or DMAR table.
.. doxygenfunction:: init_iommu_vm0_domain
:project: Project ACRN
- void init_iommu_vm0_domain(struct vm \*vm0)
Create VM0 domain using the Normal World's EPT table of VM0 as address
translation table. Add all PCI devices on the platform to VM0 domain. Then enable
DMAR translation.
- void destroy_iommu_domain(struct iommu_domain \*domain)
Destroy the iommu domain.
VT-d
====
runtime
=======
The following API are provided during runtime:
- void suspend_iommu(void)
.. doxygenfunction:: create_iommu_domain
:project: Project ACRN
Suspend IOMMU.
.. doxygenfunction:: destroy_iommu_domain
:project: Project ACRN
- void resume_iommu(void)
.. doxygenfunction:: suspend_iommu
:project: Project ACRN
Resume IOMMU.
.. doxygenfunction:: resume_iommu
:project: Project ACRN
- struct iommu_domain \*create_iommu_domain(uint16_t vm_id,
uint64_t translation_table, uint32_t addr_width)
.. doxygenfunction:: assign_iommu_device
:project: Project ACRN
Create a iommu domain for a VM specified by vm_id.
translation_table should be the physical address of EPT table of the VM
specified by the vm_id, the value cannot be NULL.
Return the iommu_domain created for the VM if not NULL.
Error if the return NULL.
- int assign_iommu_device(struct iommu_domain \*domain, uint8_t
bus, uint8_t devfun)
Assign a device specified by bus & devfun to a iommu domain. The device
is removed from VM0 domain and added to the domain specified.
domain: specified the domain the device should be assigned to.
bus: the 8-bit bus value of the pass-through device.
devfun: the 8-bit device function value of the pass-through device.
return: return 0 if success, other if error.
- int unassign_iommu_device(struct iommu_domain \*domain,
uint8_t bus, uint8_t devfun);
Unassign a device specified by bus & devfun from a iommu domain.
domain: specified the domain the device should be removed from.
bus: the 8-bit bus value of the pass-through device.
devfun: the 8-bit device function value of the pass-through device.
return: return 0 if success, other if error.
.. doxygenfunction:: unassign_iommu_device
:project: Project ACRN