Skip to content

Commit

Permalink
publish latest
Browse files Browse the repository at this point in the history
Signed-off-by: wenlingz <[email protected]>
  • Loading branch information
wenlingz committed Aug 5, 2024
1 parent 727e6ae commit 58f97e8
Show file tree
Hide file tree
Showing 158 changed files with 6,863 additions and 1,741 deletions.
25 changes: 22 additions & 3 deletions 404.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Page Not Found &mdash; Project ACRN™ 3.2-unstable documentation</title>
<title>Page Not Found &mdash; Project ACRN™ 3.4-unstable documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -60,6 +60,8 @@

<dd><a href="/latest/">latest</a></dd>

<dd><a href="/3.3/">3.3</a></dd>

<dd><a href="/3.2/">3.2</a></dd>

<dd><a href="/3.1/">3.1</a></dd>
Expand Down Expand Up @@ -225,6 +227,11 @@
<li class="toctree-l4"><a class="reference internal" href="tutorials/using_zephyr_as_user_vm.html#steps-for-using-zephyr-as-user-vm">Steps for Using Zephyr as User VM</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="tutorials/using_celadon_as_user_vm.html">Run Celadon as the User VM OS</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tutorials/using_celadon_as_user_vm.html#introduction-to-celadon">Introduction to Celadon</a></li>
<li class="toctree-l4"><a class="reference internal" href="tutorials/using_celadon_as_user_vm.html#build-celadon-image-from-source">Build Celadon Image from Source</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="develop.html#configuration-tutorials">Configuration Tutorials</a><ul>
Expand Down Expand Up @@ -615,6 +622,18 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="release_notes/index.html">Release Notes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="release_notes/release_notes_3.3.html">ACRN v3.3 (Aug 2024)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="release_notes/release_notes_3.3.html#what-s-new-in-v3-3">What’s New in v3.3</a></li>
<li class="toctree-l3"><a class="reference internal" href="release_notes/release_notes_3.3.html#upgrading-to-v3-3-from-previous-releases">Upgrading to v3.3 from Previous Releases</a><ul>
<li class="toctree-l4"><a class="reference internal" href="release_notes/release_notes_3.3.html#generate-new-board-xml">Generate New Board XML</a></li>
<li class="toctree-l4"><a class="reference internal" href="release_notes/release_notes_3.3.html#update-configuration-options">Update Configuration Options</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="release_notes/release_notes_3.3.html#document-updates">Document Updates</a></li>
<li class="toctree-l3"><a class="reference internal" href="release_notes/release_notes_3.3.html#fixed-issues-details">Fixed Issues Details</a></li>
<li class="toctree-l3"><a class="reference internal" href="release_notes/release_notes_3.3.html#known-issues">Known Issues</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="release_notes/release_notes_3.2.html">ACRN v3.2 (Aug 2023)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="release_notes/release_notes_3.2.html#what-s-new-in-v3-2">What’s New in v3.2</a></li>
<li class="toctree-l3"><a class="reference internal" href="release_notes/release_notes_3.2.html#upgrading-to-v3-2-from-previous-releases">Upgrading to v3.2 from Previous Releases</a><ul>
Expand Down Expand Up @@ -752,9 +771,9 @@
<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2018-2023 Project ACRN™, a Series of LF Projects, LLC.
<p>&#169; Copyright 2018-2024 Project ACRN™, a Series of LF Projects, LLC.

<span class="lastupdated">Last updated on Jun 05, 2020. Published on Aug 10, 2023</span>
<span class="lastupdated">Last updated on 6月 05, 2020. Published on 8月 05, 2024</span>

</div>

Expand Down
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# projectacrn.github.io

This is the Project ACRN Documentation Publishing site for GitHub pages.
This is the Project ACRN Documentation Publishing site for GitHub Pages.
Content changes are not made directly in this repo. Instead, edit content
in the acrn-hypervisor repo's /doc folder, re-generate the HTML with
Sphinx (make html), and push the updated content here for publishing
(make publish).
(make publish)..
25 changes: 22 additions & 3 deletions latest/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Page Not Found &mdash; Project ACRN™ 3.2-unstable documentation</title>
<title>Page Not Found &mdash; Project ACRN™ 3.4-unstable documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -59,6 +59,8 @@

<dd><a href="/latest/">latest</a></dd>

<dd><a href="/3.3/">3.3</a></dd>

<dd><a href="/3.2/">3.2</a></dd>

<dd><a href="/3.1/">3.1</a></dd>
Expand Down Expand Up @@ -224,6 +226,11 @@
<li class="toctree-l4"><a class="reference internal" href="tutorials/using_zephyr_as_user_vm.html#steps-for-using-zephyr-as-user-vm">Steps for Using Zephyr as User VM</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="tutorials/using_celadon_as_user_vm.html">Run Celadon as the User VM OS</a><ul>
<li class="toctree-l4"><a class="reference internal" href="tutorials/using_celadon_as_user_vm.html#introduction-to-celadon">Introduction to Celadon</a></li>
<li class="toctree-l4"><a class="reference internal" href="tutorials/using_celadon_as_user_vm.html#build-celadon-image-from-source">Build Celadon Image from Source</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="develop.html#configuration-tutorials">Configuration Tutorials</a><ul>
Expand Down Expand Up @@ -614,6 +621,18 @@
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="release_notes/index.html">Release Notes</a><ul>
<li class="toctree-l2"><a class="reference internal" href="release_notes/release_notes_3.3.html">ACRN v3.3 (Aug 2024)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="release_notes/release_notes_3.3.html#what-s-new-in-v3-3">What’s New in v3.3</a></li>
<li class="toctree-l3"><a class="reference internal" href="release_notes/release_notes_3.3.html#upgrading-to-v3-3-from-previous-releases">Upgrading to v3.3 from Previous Releases</a><ul>
<li class="toctree-l4"><a class="reference internal" href="release_notes/release_notes_3.3.html#generate-new-board-xml">Generate New Board XML</a></li>
<li class="toctree-l4"><a class="reference internal" href="release_notes/release_notes_3.3.html#update-configuration-options">Update Configuration Options</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="release_notes/release_notes_3.3.html#document-updates">Document Updates</a></li>
<li class="toctree-l3"><a class="reference internal" href="release_notes/release_notes_3.3.html#fixed-issues-details">Fixed Issues Details</a></li>
<li class="toctree-l3"><a class="reference internal" href="release_notes/release_notes_3.3.html#known-issues">Known Issues</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="release_notes/release_notes_3.2.html">ACRN v3.2 (Aug 2023)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="release_notes/release_notes_3.2.html#what-s-new-in-v3-2">What’s New in v3.2</a></li>
<li class="toctree-l3"><a class="reference internal" href="release_notes/release_notes_3.2.html#upgrading-to-v3-2-from-previous-releases">Upgrading to v3.2 from Previous Releases</a><ul>
Expand Down Expand Up @@ -751,9 +770,9 @@
<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2018-2023 Project ACRN™, a Series of LF Projects, LLC.
<p>&#169; Copyright 2018-2024 Project ACRN™, a Series of LF Projects, LLC.

<span class="lastupdated">Last updated on Jun 05, 2020. Published on Aug 10, 2023</span>
<span class="lastupdated">Last updated on 6月 05, 2020. Published on 8月 05, 2024</span>

</div>

Expand Down
Binary file added latest/_images/celadon_uservm_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added latest/_images/celadon_uservm_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed latest/_images/configurator-postvm02.png
Binary file not shown.
Binary file added latest/_images/configurator_postvm02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added latest/_images/gsg_asus_minipc64.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed latest/_images/gsg_vecow.png
Binary file not shown.
1 change: 1 addition & 0 deletions latest/_sources/develop.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ User VM Tutorials
tutorials/using_xenomai_as_user_vm
tutorials/using_vxworks_as_user_vm
tutorials/using_zephyr_as_user_vm
tutorials/using_celadon_as_user_vm

Configuration Tutorials
***********************
Expand Down
22 changes: 18 additions & 4 deletions latest/_sources/developer-guides/hld/hv-console.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,24 @@ Specifically:
the hypervisor shell. Inputs to the physical UART will be
redirected to the vUART starting from the next timer event.

- The vUART is deactivated after a :kbd:`Ctrl` + :kbd:`Space` hotkey is received
from the physical UART. Inputs to the physical UART will be
handled by the hypervisor shell starting from the next timer
event.
- The vUART enters escaping mode after a BREAK character is received from
the physical UART. When in escaping mode, next received character will
be a command. After processing this command, the vUART exits the escaping
mode. So far, following escaping commands are supported:

- BREAK charater. If user sends break charater again in escaping mode,
one break charater will be sent to vUART.

- Character "e". This will deactive vUART. Inputs to the physical UART will
be handled by the hypervisor shell starting from the next timer event.

Other characters are not supported. The physical UART will prompt out an
"Unknown escaping key" message and the active vUART exits escaping mode.

Note that the BREAK character is a control character and different serial
terminals have different ways to send it, for example, `<Ctrl-A> + F`
in minicom, `<Ctrl-a> + <Ctrl-\>` in picocom, right click -> special
command -> break in putty serial terminal.

The workflows are described as follows:

Expand Down
4 changes: 2 additions & 2 deletions latest/_sources/developer-guides/hld/ivshmem-hld.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -106,12 +106,12 @@ MMIO Registers Definition
* - IVSHMEM\_IRQ\_MASK\_REG
- 0x0
- R/W
- Interrupt Status register is used for legacy interrupt.
- Interrupt Mask register is used for legacy interrupt.
ivshmem doesn't support interrupts, so this register is reserved.
* - IVSHMEM\_IRQ\_STA\_REG
- 0x4
- R/W
- Interrupt Mask register is used for legacy interrupt.
- Interrupt Status register is used for legacy interrupt.
ivshmem doesn't support interrupts, so this register is reserved.
* - IVSHMEM\_IV\_POS\_REG
- 0x8
Expand Down
Loading

0 comments on commit 58f97e8

Please sign in to comment.