Skip to content

Commit

Permalink
Docs: minor changes
Browse files Browse the repository at this point in the history
Signed-off-by: Jenni Nikolaenko <[email protected]>
  • Loading branch information
jenninikko authored and brianmcgillion committed Jan 11, 2024
1 parent dddcedb commit e5d7458
Show file tree
Hide file tree
Showing 9 changed files with 35 additions and 26 deletions.
8 changes: 4 additions & 4 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,10 @@
- [Public Key Infrastructure](scs/pki.md)
- [Security Fix Automation](scs/ghaf-security-fix-automation.md)
- [Release Notes](release_notes/release_notes.md)
- [Release ghaf-23.12](release_notes/ghaf-23.12.23.md)
- [Release ghaf-23.09](release_notes/ghaf-23.09.23.md)
- [Release ghaf-23.06](release_notes/ghaf-23.06.23.md)
- [Release ghaf-23.05](release_notes/ghaf-23.05.23.md)
- [Release ghaf-23.12](release_notes/ghaf-23.12.md)
- [Release ghaf-23.09](release_notes/ghaf-23.09.md)
- [Release ghaf-23.06](release_notes/ghaf-23.06.md)
- [Release ghaf-23.05](release_notes/ghaf-23.05.md)

# Ghaf Usage Scenarios

Expand Down
4 changes: 4 additions & 0 deletions docs/src/appendices/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,10 @@ _embedded MultiMediaCard_

_end-user license agreement_

### GALA

_The Google Android Look Alike application. Mobile client application for connecting to a Cloud Android device in Secured Google Cloud Platform VMs. Users see a remotely rendered Android phone desktop on their own device screen and interact with the Cloud Android device like the real mobile device. All application processing runs in the cloud._

### GUI

_graphical user interface_
Expand Down
34 changes: 20 additions & 14 deletions docs/src/features/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,23 +9,27 @@ The vision for the Ghaf platform is to create a virtualized, scalable reference

Ghaf demo desktop and applications are illustrated in the screen capture below:
![Ghaf demo desktop and application](../img/ghaf_demo_desktop.png)


## Status

* &#x2705; - integrated and tested in the `main` branch. No known regression.
* &#x1f6A7; - prototyped or work in progress in the development branch.
* &#x274C; - the feature has known regression or bugs.
* &#x2705;—integrated and tested in the `main` branch. No known regression.
* &#x1f6A7;—prototyped or work in progress in the development branch.
* &#x274C;—the feature has known regression or bugs.


### Reference Devices

- `Orin`—NVIDIA Jetson AGX Orin as the main reference device.
- `x86`—generic x86_64; tested on Intel NUC (Next Unit of Computing) or laptop.
- `Lenovo X1`—Lenovo X1 Carbon Gen11 laptop.
- `aarch64`—generic AArch64; tested on an ARM server, laptop (e.g. Apple M's), or NVIDIA Jetson AGX Orin.
- `Lenovo X1`—Lenovo X1 Carbon Gen 11 laptop.
- `aarch64`—generic AArch64; tested on an ARM server, laptop (e.g. Apple MacBook's), or NVIDIA Jetson AGX Orin.
- `All variants`—supported devices from [Architectural Variants](https://tiiuae.github.io/ghaf/architecture/variants.html).

The following tables show the status of Ghaf Platform features:

## Release builds and HW architecture support

## Release Builds and Hardware Architecture Support

| Feature | Status | Reference Device | Details |
|-------------------|-------------|------------------|-------------------------------------|
Expand All @@ -51,15 +55,16 @@ The following tables show the status of Ghaf Platform features:
| Debug: Serial | &#x2705; | `all` | Host access only in `-debug`-target - e.g. `screen /dev/ttyACM0 115200` |
| Compartmentalized environment | &#x1f6A7; | `Lenovo X1` | NetVM, GUI VM (with GPU passthrough) plus some Application VMs |

## Target architecture

## Target Architecture

| Feature | Status | Reference Device | Details |
|-------------------|-------------|------------------|----------------------------------------------|
| `minimal host` | &#x1f6A7; | [`all`](https://tiiuae.github.io/ghaf/architecture/variants.html) | See [Minimal Host](https://tiiuae.github.io/ghaf/architecture/adr/minimal-host.html) and [PR #140](https://github.com/tiiuae/ghaf/pull/140). |
| `netvm` | &#x2705; | `Orin` | See [netvm](https://tiiuae.github.io/ghaf/architecture/adr/netvm.html). Passthrough with Wifi works but requires SSID/password configuration |
| `idsvm` | &#x2705; | `Orin` | [Defensive security VM placeholder PR open](https://github.com/tiiuae/ghaf/pull/146) |
| `guivm` | &#x1f6A7; | `All`, `Lenovo-X1`| Implemented for Lenovo X1 reference device, other devices have Wayland compositor running on the host.|
| `appvm` | &#x1f6A7; | `All`, `Lenovo-X1`| Implemented for Lenovo X1 reference device: chromium, GALA and zathura VMs. Requires `guivm` in place |
| `guivm` | &#x1f6A7; | `All`, `Lenovo X1`| Implemented for Lenovo X1 reference device, other devices have Wayland compositor running on the host.|
| `appvm` | &#x1f6A7; | `All`, `Lenovo X1`| Implemented for Lenovo X1 reference device: chromium, GALA and zathura VMs. Requires `guivm` in place |
| `adminvm` | &#x2705; | `All` | Not started |
| Inter VM comms - IP-based | &#x1f6A7; | `All` |`-debug`-targets have network bridges to access VMs from host |
| Inter VM comms - shared memory | &#x1f6A7; | `All` | |
Expand All @@ -70,17 +75,18 @@ The following tables show the status of Ghaf Platform features:
| UART passthrough | &#x1f6A7; | `Orin` | See [NVIDIA Jetson AGX Orin: UART Passthrough](https://tiiuae.github.io/ghaf/build_config/passthrough/nvidia_agx_pt_uart.html). Not integrated to any VM. |
| ARM platform bus devices passthrough | &#x1f6A7; | `Orin` | NVIDIA BPMP virtualization being developed |

## Applications and VM control

## Applications and VM Control

| Feature | Status | Reference Device | Details |
|-------------------|-------------|------------------|----------------------------------------------|
| Wayland-compositor | &#x1f6A7; | `Orin`, `x86` | Implemented for `Lenovo-X1` |
| Chromium | &#x1f6A7; | `Orin`, `x86` | Implemented for `Lenovo-X1` |
| Wayland-compositor | &#x1f6A7; | `Orin`, `x86` | Implemented for `Lenovo X1` |
| Chromium | &#x1f6A7; | `Orin`, `x86` | Implemented for `Lenovo X1` |
| Element | &#x1f6A7; | `Orin`, `x86` | On host |
| Cloud Android (CVD) client app (GALA )| &#x1f6A7; | `Orin`, `x86` | Implemented for `Lenovo-X1` |
| Cloud Android (CVD) client application (GALA)| &#x1f6A7; | `Orin`, `x86` | Implemented for `Lenovo X1` |
| Virtualization control | &#x1f6A7; | [`All`](https://tiiuae.github.io/ghaf/architecture/variants.html) | See [vmd design](https://github.com/tiiuae/vmd/blob/main/doc/design.md). |

## Next steps
## Next Steps

[See discussion for the outline of next steps](https://github.com/tiiuae/ghaf/issues/150#issuecomment-1564061850)

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -89,4 +89,4 @@ Download the required image and use the following instructions:
| ghaf-23.12_Nvidia_Orin_NX_cross-compiled-no-demoapps[^note].tar.xz, ghaf-23.12_Nvidia_Orin_NX_cross-compiled.tar.xz, ghaf-23.12_Nvidia_Orin_NX_native-build.tar.xz | [Ghaf Image for NVIDIA Jetson Orin AGX](../ref_impl/build_and_run.md#ghaf-image-for-nvidia-jetson-orin-agx) |
| ghaf-23.12_PolarFire_RISC-V.tar.xz | [Building Ghaf Image for Microchip Icicle Kit](../ref_impl/build_and_run.md#building-ghaf-image-for-microchip-icicle-kit) |

[^note] no-demoapps images do not include Chromium, Zathura, GALA (Google Android Look Alike) applications.
[^note] no-demoapps images do not include Chromium, Zathura, and GALA applications.
11 changes: 5 additions & 6 deletions docs/src/release_notes/release_notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,12 @@

Ghaf is released 4 times per year at the end of each quarter. Additional releases may be made as per request.

Release numbering scheme: *ghaf-dd.mm*.
Release numbering scheme: *ghaf-yy.mm*.


## In This Chapter

- 2023
- [Release ghaf-23.12](../release_notes/ghaf-23.12.23.md)
- [Release ghaf-23.09](../release_notes/ghaf-23.09.23.md)
- [Release ghaf-23.06](../release_notes/ghaf-23.06.23.md)
- [Release ghaf-23.05](../release_notes/ghaf-23.05.23.md)
- [Release ghaf-23.12](../release_notes/ghaf-23.12.md)
- [Release ghaf-23.09](../release_notes/ghaf-23.09.md)
- [Release ghaf-23.06](../release_notes/ghaf-23.06.md)
- [Release ghaf-23.05](../release_notes/ghaf-23.05.md)
2 changes: 1 addition & 1 deletion docs/src/research/research.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@
Our experience in research, studies and lessons learned activities:

* [i.MX 8QM platform bus ethernet passthrough](passthrough/ethernet.md)
* [System installation](research/installation.md)
* [System installation](installation.md)

0 comments on commit e5d7458

Please sign in to comment.