Peter Fang
f5a66e8e20
doc: update OVMF usage for acrn-dm
...
Tracked-On: #1832
Signed-off-by: Peter Fang <peter.fang@intel.com>
2018-12-13 09:56:09 +08:00
Geoffroy Van Cutsem
21a5b30865
Update add acrn-dm parameter descriptions
...
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
Geoffroy Van Cutsem
c45300fb54
Update doc/developer-guides/hld/hld-devicemodel.rst
...
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
Geoffroy Van Cutsem
6d5b769d67
Update doc/developer-guides/hld/hld-devicemodel.rst
...
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
Geoffroy Van Cutsem
5998f434bc
Update doc/developer-guides/hld/hld-devicemodel.rst
...
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
Geoffroy Van Cutsem
c607aedff4
Update doc/developer-guides/hld/hld-devicemodel.rst
...
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
Geoffroy Van Cutsem
ba79b21860
Update doc/developer-guides/hld/hld-devicemodel.rst
...
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
Geoffroy Van Cutsem
4ab193cf6c
Update doc/developer-guides/hld/hld-devicemodel.rst
...
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
Geoffroy Van Cutsem
1c70f812a0
Update doc/developer-guides/hld/hld-devicemodel.rst
...
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
Geoffroy Van Cutsem
341bf84ced
Update doc/developer-guides/hld/hld-devicemodel.rst
...
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
Geoffroy Van Cutsem
a0708339bc
Update doc/developer-guides/hld/hld-devicemodel.rst
...
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
Geoffroy Van Cutsem
a7be8f731d
Update doc/developer-guides/hld/hld-devicemodel.rst
...
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
Geoffroy Van Cutsem
5aedc8f4aa
Update doc/developer-guides/hld/hld-devicemodel.rst
...
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
Geoffroy Van Cutsem
e7e8ce63f2
Update doc/developer-guides/hld/hld-devicemodel.rst
...
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
Geoffroy Van Cutsem
2454289400
Update doc/developer-guides/hld/hld-devicemodel.rst
...
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
Geoffroy Van Cutsem
edd06fe928
Update doc/developer-guides/hld/hld-devicemodel.rst
...
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
Geoffroy Van Cutsem
1ef6b657fd
Update doc/developer-guides/hld/hld-devicemodel.rst
...
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
Geoffroy Van Cutsem
8b13bf3f7c
Update doc/developer-guides/hld/hld-devicemodel.rst
...
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
Geoffroy Van Cutsem
7446089d80
Update doc/developer-guides/hld/hld-devicemodel.rst
...
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
Geoffroy Van Cutsem
666c97b0d7
Update doc/developer-guides/hld/hld-devicemodel.rst
...
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
Geoffroy Van Cutsem
a21c3ca3eb
Update doc/developer-guides/hld/hld-devicemodel.rst
...
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
David B. Kinder
7bcd7054e5
doc: additional DM parameter documentation
...
Update the device model HLD with additional parameter documentation
Tracked-On: #2021
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-12-12 08:57:16 -08:00
David B. Kinder
fe1ace4f56
doc: fix doc misspellings
...
Fix documentation misspellings missed during the regular review.
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-12-05 17:07:39 -08:00
Li, Fei1
5fd6021dee
doc: hv: add comments to timer APIs for documentation
...
This patch adds more comment to describe functions that are
interfaces to the other modules in the hypervisor. The comments
are in doxygen-style for document generation.
Tracked-On: #1595
Signed-off-by: Li, Fei1 <fei1.li@intel.com>
2018-12-04 15:09:47 +08:00
Li, Fei1
a0582c99cf
hv: trusty: refine trusty memory region mapping
...
Now it's using the memory reserve by hypervisor. So there's not
necessaty to map or ummap this region from SOS.
Tracked-On: #1942
Signed-off-by: Li, Fei1 <fei1.li@intel.com>
2018-11-30 16:49:27 +08:00
Mingqiang Chi
5dcfc1336b
hv:Rename ptdev to ptirq for some APIs
...
-- Rename the fowllowing APIs:
ptdev_intx_pin_remap --> ptirq_intx_pin_remap
ptdev_msix_remap --> ptirq_msix_remap
ptdev_add_intx_remapping --> ptirq_add_intx_remapping
ptdev_remove_intx_remapping --> ptirq_remove_intx_remapping
ptdev_add_msix_remapping --> ptirq_add_msix_remapping
ptdev_remove_msix_remapping --> ptirq_remove_msix_remapping
ptdev_intx_ack --> ptirq_intx_ack
ptdev_lookup_entry_by_sid --> ptirq_lookup_entry_by_sid
ptdev_lookup_entry_by_vpin --> ptirq_lookup_entry_by_vpin
ptdev_build_physical_msi --> ptirq_build_physical_msi
ptdev_build_physical_rte --> ptirq_build_physical_rte
alloc_entry --> ptirq_alloc_entry
release_entry --> ptirq_release_one_entry
ptdev_activate_entry --> ptirq_activate_entry
ptdev_deactivate_entry --> ptirq_deactivate_entry
ptdev_intr_handle_irq --> ptirq_handle_intx
ptdev_softirq --> ptirq_softirq
ptdev_enqueue_softirq --> ptirq_enqueue_softirq
ptdev_dequeue_softirq --> ptirq_dequeue_softirq
get_vm_ptdev_intr_data --> ptirq_get_intr_data
alloc_ptdev_entry_id --> ptirq_alloc_entry_id
ptdev_intr_delay_callback --> ptirq_intr_delay_callback
ptdev_dequeue_softirq --> ptirq_dequeue_softirq
ptdev_interrupt_handler --> ptirq_interrupt_handler
-- Merge 'ptdev_release_all_entries' and 'release_all_entries'
to 'ptirq_release_all_entries'
v2-->v3:
Rename ptirq_release_one_entry to ptirq_release_entry
v1-->v2:
still use ptdev_init instead of ptirq_init
Tracked-On: #861
Signed-off-by: Mingqiang Chi <mingqiang.chi@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
2018-11-30 13:27:49 +08:00
Binbin Wu
fe08a44e83
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>
2018-11-21 09:27:51 +08:00
Mingqiang Chi
9a009bcef2
hv:Replace dynamic memory with static for mmio
...
-- Config MAX_EMULATED_MMIO_REGIONS 16 in Kconfig
-- Add emulated mmio array and emulated mmio regions
in vm structure
-- Remove mmio list in vm structure
-- Remove unregister_mmio_emulation_handler and
vioapic_cleanup APIs
Tracked-On: #861
Signed-off-by: Mingqiang Chi <mingqiang.chi@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
2018-11-13 11:52:48 +08:00
Mingqiang Chi
73530055b6
hv:Replace dynamic memory with static for port io
...
-- Add emulated port io index
-- Add emulated pio array in vm structure
-- Remove port list in vm structure
-- Remove free_io_emulation_resource/register_io_handler/
create_io_handler APIs
v2-->v3:
-- not add 'is_emulated', check len == 0U
-- Check if io_read/io_write handler is NULL before calling
-- Replace ENUM with MACRO for emulated pio index to avoid
MISRA-C violations
v1-->v2:
-- Remove EMUL_PIO_NUM in Kconfig, add emulated pio index
for PIC/PCI/UART/RTC/PM
Tracked-On: #861
Signed-off-by: Mingqiang Chi <mingqiang.chi@intel.com>
Reviewed-by: Jason Chen CJ <jason.cj.chen@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
2018-11-09 13:05:04 +08:00
Minggui Cao
ab5572bdb6
doc: explain intr storm monitor params in acrn-dm
...
add the introduction of interrupt storm monitor params in acrn-dm
commond lines.
Signed-off-by: Minggui Cao <minggui.cao@intel.com>
2018-11-08 16:50:15 -08:00
David B. Kinder
44ce3a664f
doc: update HLD Trace/Log
...
Transcode, edit, and upload HLD 0.7 section 9 (Trace/Log)
Tracked-on: #1738
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-11-06 16:14:49 -08:00
David B. Kinder
27fffb96b9
doc: update HLD Power Management
...
Transcode, edit, and upload HLD 0.7 section 8 (Power Management)
Tracked-on: #1736
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-11-06 13:51:35 -08:00
David B. Kinder
b3d21683de
doc: update HLD VM Management
...
Transcode, edit, and upload HLD 0.7 section 7 (VM Management)
Tracked-on: #1734
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-11-06 12:23:25 -08:00
David B. Kinder
dfcc06df30
doc: update HLD Virtio Devices
...
Transcode, edit, and upload HLD 0.7 section 6.5 (Supported Virtio
Devices), merging with existing reviewed content.
Tracked-on: #1732
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-11-06 11:37:29 -08:00
Shuo Liu
d261b4bce2
doc: update virtio related functions doc comments
...
Update some virtio, VBS-K, vhost APIs documents.
Tracked-On: #1595
Signed-off-by: Shuo Liu <shuo.a.liu@intel.com>
2018-11-04 20:32:50 -08:00
Junjie Mao
4e540e5494
HV: doc: use doxygen-generated API docs in HLD
...
This patch adds ioreq.h to the input of doxygen and replaces hard-coded API docs
with doxygen-generated ones.
Tracked-On: #1595
Signed-off-by: Junjie Mao <junjie.mao@intel.com>
2018-11-04 20:30:38 -08:00
Yonghua Huang
d2d0cbc661
hv:doc:use doxyen-generated API docs in HDL for vIRQ
...
Adds below header files to the input of doxygen
and replaces hard-coded API docs with doxyen-generated ones:
- vlapic.h
- vioapic.h
- vpic.h
- irq.h
Tracked-On: #1595
Signed-off-by: Yonghua Huang <yonghua.huang@intel.com>
2018-11-03 08:40:14 -07:00
Binbin Wu
4b3b11552d
hv: doc: use doxygen-generated API docs in HLD for vtd
...
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>
2018-11-02 15:36:14 -07:00
Yan, Like
7dc3e609be
doc: hv: add comments to irq APIs for documentation
...
Tracked-On: #1595
Signed-off-by: Yan, Like <like.yan@intel.com>
2018-11-02 15:34:36 -07:00
Xiangyang Wu
f69dd1c6ea
HV:doc:use doxygen-generated API docs in HLD
...
The patch adds related head files to the input of doxygen and
replaces hard-code API docs with doxygen-generated ones.
v1-->v2:
Put the 'kerneldoc' back.
V2-->V3:
Rebase
Tracked-On: #1595
Signed-off-by: Xiangyang Wu <xiangyang.wu@linux.intel.com>
2018-11-02 15:30:36 -07:00
David B. Kinder
17d43fe5cb
doc: doc: update HLD Emulated Devices
...
Transcode, edit, and upload HLD 0.7 section 5 (Emulated Devices), including
- 5.1 USB Virtualization (merge with previously edited doc),
- 5.2 UART virtualization (merge with previous edited doc),
- NOT INCLUDING 5.3 (Automotive) I/O controller virtualization
- 5.4 Watchdog virtualization (merge with previously edited doc)
- 5.5 GVT-g GPU Virtualization (merge previously edited doc)
Tracked-on: #1687
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-11-02 15:27:08 -07:00
Minggui Cao
bf88e24168
DOC: add main vcpu API & data structure into HLD.
...
add main vcpu API and data structure for doc auto-generated
info into HLD.
Tracked-On: #1595
Signed-off-by: Minggui Cao <minggui.cao@intel.com>
2018-11-02 15:20:11 -07:00
David B. Kinder
9ae79496be
doc: fix section heading in device model hld
...
Fix incorrect section heading level.
Tracked-on: #1668
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-31 13:55:50 -07:00
David B. Kinder
7df70e0c64
doc: update HLD Device Model
...
Transcode, edit, and upload HLD 0.7 section 4 (Device Model)
Incorporate changes from previously edited acpi-virt.rst and delete
separate doc.
Tracked-on: #1668
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-31 13:48:43 -07:00
David B. Kinder
ac5b46eba5
doc: update rest of hypervisor HLD sections
...
Transcode, edit, and upload HLD 0.7 section 3.10 (PM in hypervisor),
3.11 (Console, shell, vUART), 3.12 (Hypercall/VHM upcall), and
3.13 (Compile-time config)
Also scan/replace UTF-8 punctuation missed in previous PRs.
Add anchor targets in referenced docs.
Tracked-on: #1648
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-30 11:20:09 -07:00
David B. Kinder
97c8c16f6a
doc: fix misspellings in hld docs
...
can and fix misspellings missed during normal review
Tracked-on: #1648
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-30 08:58:01 -07:00
David B. Kinder
bf7b1cf744
doc: update HLD Device passthrough
...
transcode, edit, and upload HLD 0.7 section 3.9 (Device passthrough)
Tracked-on: #1645
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-29 16:32:32 -07:00
David B. Kinder
7c192db1ba
doc: update HLD VT-d
...
transcode, edit, and upload HLD 0.7 section 3.8 (VT-d)
Tracked-on: #1643
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-29 13:34:01 -07:00
David B. Kinder
dc7df1cd0f
doc: update HLD Virtual Interrupt
...
transcode, edit, and upload HLD 0.7 section 3.7 (Virtual Interrupt)
Add target references in other docs as needed.
Tracked-on: #1623
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-26 16:46:49 -07:00
David B. Kinder
1c54734f8b
doc: update HLD Timer section
...
transcode, edit, and upload HLD 0.7 section 3.6 (Timer)
Also, fix the hv sections file names to be consistent.
Tracked-on: #1623
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-10-26 15:12:45 -07:00