Commit Graph

373 Commits

Author SHA1 Message Date
Xie, nanlin
1f4eb7b431 Revert "doc: rename register_io_emulation_handler"
This reverts commit 7e0204fa5d.
2019-01-17 14:09:17 +08:00
wenlingz
4f91896961 Doc: Update GSG for v0.5 version and launch and acrn.conf sample script
modify sbl_up2 version and scripts
2019-01-16 16:29:30 +08:00
Xie, nanlin
24ddd49cb4 Doc: Add one new known issue into v0.5 release note
Signed-off-by: Xie, nanlin <nanlin.xie@intel.com>
2019-01-15 07:04:19 +08:00
Geoffroy Van Cutsem
d98a5fd593 Update doc/developer-guides/GVT-g-kernel-options.rst
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2019-01-14 23:40:34 +08:00
Geoffroy Van Cutsem
d6bc3fe51d Update doc/developer-guides/GVT-g-kernel-options.rst
Co-Authored-By: dbkinder <david.b.kinder@intel.com>
2019-01-14 23:40:24 +08:00
David B. Kinder
8dd6094457 doc: add GVT-g kernel options doc
Update developer docs with a new GVT-g kernel options document. Update
existing docs with referenced labels.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-14 23:39:24 +08:00
Xie, nanlin
aba971a201 Doc: Add release note for v0.5 release.
Signed-off-by: Xie, nanlin <nanlin.xie@intel.com>
2019-01-13 06:58:40 +08:00
Xie Zhengtian
295cee2216 doc: update some statements 2019-01-13 06:58:31 +08:00
root
e6c7c14742 doc: supported KBL NUC added 2019-01-13 06:58:08 +08:00
Shiqing Gao
3da6ba5f84 doc: add more rules in coding guidelines
This patch adds more rules in coding guidelines.

Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-01-13 06:58:00 +08:00
David B. Kinder
339fa49d2e doc: add menu option for 0.5 docs
Add option in side-bar menu for 0.5 doc version

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-13 06:57:51 +08:00
Xie Zhengtian
b61061c67b doc: update the statement of "tag" 2019-01-13 06:57:42 +08:00
root
0df4049f18 doc: add 'checkout to release v0.5' 2019-01-13 06:57:32 +08:00
Xie Zhengtian
9d696be0c6 doc: modify the directories of files needed 2019-01-13 06:57:08 +08:00
root
215580080a doc: Update the steps for generating 'partition_desc.bin' 2019-01-13 06:49:06 +08:00
David B. Kinder
97f1f86cc0 doc: tweak dm-parameter doc
Remove trailing blanks, and change one last reviewer comment.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-12 16:46:21 +08:00
Shuang Zheng
381c78a5fa Update and complete acrn-dm parameters description
Update and complete `acrn-dm` parameters description in the user guide and HLD

Tracked-On: #2036
Signed-off-by: Shuang Zheng shuang.zheng@intel.com
2019-01-12 16:46:09 +08:00
David B. Kinder
94ad111dc7 doc: update SKL NUC patch download instructions
Include a line of script that download and untars the patch files

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-12 16:45:53 +08:00
Geoffroy Van Cutsem
1c9a5e7d3f Documentation: fix highlights in launch_uos.sh script
The couple of lines highlighted in the launch_uos.sh script are off
since the latest modifications made to that script. Fix them both
to highlight the correct script lines that require attention.

Tracked-On: #2270
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2019-01-12 16:45:40 +08:00
David B. Kinder
4eb36bf18f doc: add skylake NUC w/GPU passthrough doc
Document a community reference release for the Skylake NUC with GPU
passthrough as a one-time snapshot release, not supported or
maintained.  Includes a tar patch file.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-12 16:45:17 +08:00
Shiqing Gao
7e0204fa5d doc: rename register_io_emulation_handler
This is a follow-up patch in doc corresponding to the
changes in source code.

Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2019-01-12 16:44:23 +08:00
David B. Kinder
e50cd15304 doc: spell check and formatting
Fix misspellings missed during regular reviews, and remove trailing
white space and Windows \r at end of lines.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-01-12 16:44:00 +08:00
root
cc95fdba76 doc: Descriptions about Dupont Wire used added 2019-01-12 16:43:47 +08:00
root
2dfc56b87d doc: license header updated 2019-01-12 16:43:34 +08:00
root
a90ad77f37 doc: update the statement 2019-01-12 16:43:22 +08:00
root
ed5d79e959 doc: update launch_uos.sh 2019-01-12 16:43:09 +08:00
root
e692efbd86 doc: update the doc 2019-01-12 16:42:51 +08:00
Minggui Cao
ef545f7a82 DOC: add vuart setting guide to avoid conflict
different serial devices could be used on different boards.
"vuart=ttySn@irqN" is used to avoid vuart's irq conflict
with SOS passthrough devices.

on UEFI platform, if ttyS1 used for debug uart, and its IRQ
on native OS is 5, you'd better set "vuart=ttyS1@irq5"; also
for its SOS bootargs in acrn.conf, you need set "console=ttyS1"
to match its vuart setting.

Tracked-On: #2170
Signed-off-by: Minggui Cao <minggui.cao@intel.com>
2019-01-12 16:42:12 +08:00
David B. Kinder
9680009365 doc: update footer copyright year
Happy 2019!

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-12-27 17:06:51 -08:00
Shiqing Gao
a177d75ed3 doc: initial draft of ACRN coding guidelines
This patch introduces an initial draft of ACRN coding guidelines.

We will update this document gradually to support ACRN achieve
MISRA-C compliance.

Tracked-On: #861
Signed-off-by: Shiqing Gao <shiqing.gao@intel.com>
2018-12-26 22:46:46 -08:00
David B. Kinder
5ebaaaf973 doc: add CSS for non-compliant code examples
Coding guidelines have examples for compliant and non-compliant code,
but they look the same when rendered as HTML.  Add a CSS style for
non-compliant-code examples with a red-tinted background.

Usage is:
```
.. rst-class:: non-compliant-code

   .. code-block:: c

      a=b=c=0;
```
or, for example:

```
.. rst-class:: non-compliant-code

   Here's an example of non-compliant code::

      a=b=c=0;
```

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-12-26 11:09:46 -08:00
Geoffroy Van Cutsem
9c97f6bec5 Documentation: split the build instructions into its own guide
Split the build instructions, and the hypervisor configuration instructions
into its own separate document.

Tracked-On: #2154
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-12-21 10:01:13 -08:00
Geoffroy Van Cutsem
01bc8e56f2 Documentation: fix formatting in partition mode tutorial
Fix the indentation to make a line part of the correct
paragraph (instead of having it erroneously displayed as
part of the previous code-block)

Tracked-On: #2031
Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
2018-12-21 08:46:27 -08:00
David B. Kinder
af9b747629 doc: fix formatting in NUC GSG
A stray empty code block is removed, along with trailing spaces

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-12-20 12:08:56 -08:00
Minggui Cao
61f03dae81 DOC: change PCI uart description from mmio to bdf
HV code changed to configure PCI uart mmio@ to bdf@,
so change its description to match it.

Tracked-On: #2031
Signed-off-by: Minggui Cao <minggui.cao@intel.com>
2018-12-20 11:53:13 -08:00
Jason Chen CJ
746fbe147d modulization: move functions related with cpu caps into cpu_caps.c
move cpu caps related functions like capability init/detect/check
in cpu.c & mmu.c into a new file cpu_caps.c

Changes to be committed:
	modified:   developer-guides/hld/hv-memmgt.rst
	modified:   ../hypervisor/Makefile
	modified:   ../hypervisor/arch/x86/cpu.c
	new file:   ../hypervisor/arch/x86/cpu_caps.c
	modified:   ../hypervisor/arch/x86/mmu.c
	modified:   ../hypervisor/arch/x86/vmx_asm.S
	modified:   ../hypervisor/include/arch/x86/cpu.h
	new file:   ../hypervisor/include/arch/x86/cpu_caps.h
	modified:   ../hypervisor/include/arch/x86/guest/vm.h
	modified:   ../hypervisor/include/arch/x86/mmu.h
	modified:   ../hypervisor/include/arch/x86/vmcs.h

Tracked-On: #1842
Signed-off-by: Jason Chen CJ <jason.cj.chen@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
2018-12-19 09:07:14 +08:00
Mingqiang Chi
74849cd983 modulization:move out efi dir from hypervisor
move acrn-hypervisor/hypervisor/bsp/uefi/efi
to   arcn-hypervisor/efi-stub
move acrn-hypervisor/hypervisor/bsp/uefi/clearlinux
to   acrn-hypervisor/efi-stub/clearlinux

Changes to be committed:
  modified:   Makefile
  modified:   doc/getting-started/apl-nuc.rst
  renamed:    hypervisor/bsp/uefi/efi/Makefile -> efi-stub/Makefile
  renamed:    hypervisor/bsp/uefi/efi/boot.c -> efi-stub/boot.c
  renamed:    hypervisor/bsp/uefi/efi/boot.h -> efi-stub/boot.h
  renamed:    hypervisor/bsp/uefi/clearlinux/acrn.conf ->
	      efi-stub/clearlinux/acrn.conf
  renamed:    hypervisor/bsp/uefi/efi/efilinux.h -> efi-stub/efilinux.h
  renamed:    hypervisor/bsp/uefi/efi/malloc.c -> efi-stub/malloc.c
  renamed:    hypervisor/bsp/uefi/efi/multiboot.h -> efi-stub/multiboot.h
  renamed:    hypervisor/bsp/uefi/efi/pe.c -> efi-stub/pe.c
  renamed:    hypervisor/bsp/uefi/efi/stdlib.h -> efi-stub/stdlib.h
  modified:   hypervisor/Makefile

Tracked-On: #1842
Signed-off-by: Mingqiang Chi <mingqiang.chi@intel.com>
Acked-by: Anthony Xu <anthony.xu@intel.com>
2018-12-17 15:46:23 +08:00
Jason Chen CJ
59e3f562b8 remove check_tsc
there is no need to clear CR4.TSD as there is no user mode
in ACRN hypervisor.

Tracked-On: #1842
Signed-off-by: Jason Chen CJ <jason.cj.chen@intel.com>
2018-12-17 14:31:52 +08:00
David B. Kinder
117b71e6af doc: add partition mode hld
Partition mode HLD content added to hypervisor hld.
Add target links in referenced docs.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2018-12-15 10:35:38 -08:00
Xie, nanlin
ed5e210d91 Doc: Update GSG for v0.4 version and launch and acrn.conf sample script
Signed-off-by: Xie, nanlin <nanlin.xie@intel.com>
2018-12-15 10:12:44 -08:00
Zide Chen
c89d6e6526 modularization: clean up namings in vMTRR module
- rename 3 module interface APIs
  init_mtrr() -> init_vmtrr()
  mtrr_rdmsr -> read_vmtrr()
  mtrr_wrmsr() -> write_vmtrr()

- follow naming convention for other modules, rename struct mtrr_state
  to struct acrn_vmtrr. And add acrn_vcpu to it.

- because MTRR is x86 architecture specific, move struct acrn_vmtrr to
  struct acrn_vcpu_arch.

Tracked-on: #1842
Signed-off-by: Zide Chen <zide.chen@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
2018-12-14 09:43:06 +08:00
Zide Chen
6bbd0129c3 modularization: move vMTRR code to guest directory
MTRR emulation belongs to virtual CPU component.

- rename mtrr.c to vmtrr.c and move it to arch/x86/guest
- rename mtrr.h to vmtrr.h and move it to include/arch/x86/guest

Tracked-On: #1842
Signed-off-by: Zide Chen <zide.chen@intel.com>
Acked-by: Eddie Dong <eddie.dong@intel.com>
2018-12-14 09:43:06 +08:00
Xie Zhengtian
302494cb80 doc: update some statements 2018-12-13 08:52:56 -08:00
Xie Zhengtian
07309fdc55 doc: update some statements 2018-12-13 08:52:56 -08:00
Xie Zhengtian
40f375b421 Doc: modify the note of UOS kernel modules 2018-12-13 08:52:56 -08:00
Xie Zhengtian
2d9e478c91 Doc: delete the step of downloading UOS's kernel 2018-12-13 08:52:56 -08:00
Xie Zhengtian
c3a4a5d44d Doc: add "$" for code 2018-12-13 08:52:56 -08:00
Xie Zhengtian
d56e2c29e0 Doc: update the steps 2018-12-13 08:52:56 -08:00
Xie Zhengtian
2be939f3d1 Doc: add "Deploy the UOS kernel modules for AGL" 2018-12-13 08:52:56 -08:00
Xie Zhengtian
73161f910f Update using_agl_as_uos.rst 2018-12-13 08:52:56 -08:00