summaryrefslogtreecommitdiffstats
path: root/wiki/README.md
blob: a8ecec113e4def8ec8e56cfa335fab84768f2ac0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
# vGPU-IO Wiki Sources

> **The authoritative entry point is [`../docs/README.md`](../docs/README.md).**
> The Markdown files in this directory are the tracked sources for the public
> wiki at https://open-iov.org — they are converted to MediaWiki wikitext by
> [`../tools/site/md2wiki.py`](../tools/site/md2wiki.py) and published by
> [`../tools/site/publish.py`](../tools/site/publish.py) (see
> [`../tools/site/README.md`](../tools/site/README.md)).
> `open-iov.org/` is an archived 2023 copy of the previous project wiki, kept
> for historical reference only.

## Wiki sources (published)

### Start here
- [Project Status](Project-Status.md) — the dated, honest state of the project
- [Install and First Run](Install-and-First-Run.md) — build, load, stock guest driver
- [FAQ](FAQ.md) — common questions

### Architecture
- [System Overview](System-Overview.md) — the one-page mental model
- [GSP and GSP-RM](GSP-and-GSP-RM.md) — the firmware interface the project emulates
- [The Host Module (vgsp.ko)](Host-Module.md) — virtual device, emulation core, memory model, forwarding
- [The Guest Stack and CUDASW](Guest-Stack-and-CUDASW.md) — what runs unmodified in the guest
- [The vGSP Execution Plane (vEP)](Execution-Plane.md) — execution and completion layer
- [Introduction to the GMMU](Introduction-to-GMMU.md) — GPU address translation from first principles
- [UVM in the Guest](UVM-in-the-Guest.md) — unified memory as a correctness oracle
- [GMMU Multi-Tenant Protection](GMMU-Multi-Tenant-Protection.md) — isolation design (design stage)
- [Physical GPU Backend and Guest Wiring](Physical-GPU-Backend.md) — how work reaches real hardware
- [Guest Driver Lifecycle: A Field Guide](Driver-Lifecycle-Field-Guide.md) — boot to CUDA with real IDs

### CUDA
- [CUDA Userspace Driver](CUDA-Userspace-Driver.md) — the `libcuda.so` deep dive
- [The Execution Frontier](Execution-Frontier.md) — the GR compute-launch chain and its wall

### Firmware and reverse engineering
- [GSP 570.144W Firmware Analysis](GSP-570.144W-Firmware-Analysis.md)
- [Address Reference](Address-Reference.md)
- [risc-v-gsp-rm-debugger](Riscv-GSP-RM-Debugger.md) — the firmware runtime workbench
- Historical protocol analyses (superseded, kept for the record):
  [RPC Message Format](RPC-Message-Format.md),
  [BAR Emulation Specification](BAR-Emulation-Specification.md),
  [WPR Management](WPR-Management.md), [Migration Protocol](Migration-Protocol.md),
  [GSP RPC Emulation](GSP-RPC-Emulation.md), [Error Codes](Error-Codes.md),
  [vGPU-IO Integration Guide](vGPU-IO-Integration-Guide.md)

### Portability, ecosystem, reference
- [Hardware and Software Matrix](Hardware-Software-Matrix.md)
- [HAAEEP and Collaboration](HAAEEP-and-Collaboration.md)
- [Glossary](Reference-Glossary.md)

## Historical imports (not published from here)
`GPU_Driver_Internals.md`, `GPU_Firmware.md`, `GPU_SBOM.md`,
`Virtual_IO_Internals.md` and `Glossary.md` are 2023-era imports of the
previous wiki; the live pages carry historical banners and are not re-published
from these sources.

## Publishing
Sources here are converted and published with the tooling in
[`../tools/site/`](../tools/site/README.md). Site-only pages (Main Page, About,
Community, sidebar, templates) live in
[`../tools/site/pages/`](../tools/site/pages/). Every publish is recorded in
[`.publish-manifest.json`](.publish-manifest.json) (source hash → revision ids)
and audited by `tools/site/check_site.py`.