summaryrefslogtreecommitdiffstats
path: root/debug/risc-v-gsp-rm-vm/docs/00-OVERVIEW.md
diff options
context:
space:
mode:
authorArthur Hanson Rasmusson <arthur@vgpu.io>2026-10-02 11:44:31 -0400
committerArthur Hanson Rasmusson <arthur@vgpu.io>2026-10-02 11:44:31 -0400
commit1c99bfbeffff04529f6f669601fdf835a73778da (patch)
tree5867bab46e5848541df36c703f6fd8d6d0256e54 /debug/risc-v-gsp-rm-vm/docs/00-OVERVIEW.md
parent2fd653044127a665e4677a2cdfb58120d7b3e16b (diff)
downloadopen-iov-1c99bfbeffff04529f6f669601fdf835a73778da.tar.gz
open-iov-1c99bfbeffff04529f6f669601fdf835a73778da.zip
rename (cosmetic): green-eye -> risc-v-gsp-rm-debugger in user-facing names, docs, CLI, launcher and CI workflow; internal greeneye package/module identifiers unchanged (includes in-flight greeneye module edits present in the tree)
Diffstat (limited to 'debug/risc-v-gsp-rm-vm/docs/00-OVERVIEW.md')
-rw-r--r--debug/risc-v-gsp-rm-vm/docs/00-OVERVIEW.md30
1 files changed, 15 insertions, 15 deletions
diff --git a/debug/risc-v-gsp-rm-vm/docs/00-OVERVIEW.md b/debug/risc-v-gsp-rm-vm/docs/00-OVERVIEW.md
index e4906cc..f09d576 100644
--- a/debug/risc-v-gsp-rm-vm/docs/00-OVERVIEW.md
+++ b/debug/risc-v-gsp-rm-vm/docs/00-OVERVIEW.md
@@ -1,4 +1,4 @@
-# 00 — green-eye overview
+# 00 — risc-v-gsp-rm-debugger overview
> **# TOOL IN DEVELOPMENT - NOT READY YET!**
> Experimental tooling for simulating and inspecting the GSP firmware's
@@ -15,7 +15,7 @@ the firmware do things* — which handler runs, what it reads and writes, what
it returns, how its state machine evolves — without a physical GPU, without
WPR2/hazard exposure, and repeatably.
-green-eye runs uproc/GSP firmware in `qemu-system-riscv64` and gives the
+risc-v-gsp-rm-debugger runs uproc/GSP firmware in `qemu-system-riscv64` and gives the
developer Frida-like instrumentation over its memory and execution:
* breakpoints and enter/leave **hooks** (RV64 ABI aware),
@@ -60,16 +60,16 @@ whole stack scriptable, and QEMU is just the first execution backend.
```bash
cd open-iov/debug/risc-v-gsp-rm-vm
make demo # build the bundled RV64 uproc demo
-./greeneye.sh demo # canned instrumentation pass, records a session
-./greeneye.sh info # environment check
-./greeneye.sh probe # run the real GSP fwimage and report first divergence
+./risc-v-gsp-rm-debugger.sh demo # canned instrumentation pass, records a session
+./risc-v-gsp-rm-debugger.sh info # environment check
+./risc-v-gsp-rm-debugger.sh probe # run the real GSP fwimage and report first divergence
```
Interactively:
```bash
-./greeneye.sh demo --no-build --duration 0 # launches; prints the gdbstub port
-./greeneye.sh attach --port <port> --kernel firmware/uproc_demo/build/uproc_demo.elf
+./risc-v-gsp-rm-debugger.sh demo --no-build --duration 0 # launches; prints the gdbstub port
+./risc-v-gsp-rm-debugger.sh attach --port <port> --kernel firmware/uproc_demo/build/uproc_demo.elf
```
## Document map
@@ -79,7 +79,7 @@ Interactively:
| [01-DESIGN](01-DESIGN.md) | how the pieces fit, transport, data model, limits |
| [02-USAGE](02-USAGE.md) | CLI and REPL recipes |
| [03-SCRIPTING](03-SCRIPTING.md) | writing programs against the API |
-| [04-PLUGINS](04-PLUGINS.md) | extending green-eye |
+| [04-PLUGINS](04-PLUGINS.md) | extending risc-v-gsp-rm-debugger |
| [05-GHIDRA-BRIDGE](05-GHIDRA-BRIDGE.md) | static/dynamic address join |
| [06-ACCURACY](06-ACCURACY.md) | what the simulation does and does not prove |
| [07-PORTABILITY-PLAYBOOKS](07-PORTABILITY-PLAYBOOKS.md) | new GSP / device / architecture |
@@ -88,7 +88,7 @@ Interactively:
| [10-RELATED-WORK](10-RELATED-WORK.md) | Frida/GDB/QEMU-plugin comparison |
| [11-GSP-RM-SERVICE-DEVELOPER-GUIDE](11-GSP-RM-SERVICE-DEVELOPER-GUIDE.md) | writing/injecting/debugging RM services |
| [12-INJECTION-SDK](12-INJECTION-SDK.md) | injection blob/ABI specification |
-| [13-GHIDRA-CONTROL](13-GHIDRA-CONTROL.md) | driving green-eye from Ghidra |
+| [13-GHIDRA-CONTROL](13-GHIDRA-CONTROL.md) | driving risc-v-gsp-rm-debugger from Ghidra |
| [14-ADVERSARIAL-INTEROP-GUIDE](14-ADVERSARIAL-INTEROP-GUIDE.md) | adversarial firmware navigation |
| [15-AGENTIC-GSP-IDE](15-AGENTIC-GSP-IDE.md) | agentic workflows and runbooks |
| [16-CUSTOM-SIMULATOR](16-CUSTOM-SIMULATOR.md) | native simulator (M1/M1.5 implemented; M2+ design) |
@@ -105,23 +105,23 @@ Interactively:
| [27-TOOL-AUDIT](27-TOOL-AUDIT.md) | tool audit: purpose, tests, usage, status |
| [28-PORTING-AUTOMATION](28-PORTING-AUTOMATION.md) | driver-version sweep and new-device scaffolds (pilot) |
| [29-PACKAGING-AND-TRIALING](29-PACKAGING-AND-TRIALING.md) | trial simulation packages (pilot) |
-| [GREEN-EYE-ROADMAP](../GREEN-EYE-ROADMAP.md) | long-term program H1–H7 |
+| [RISC-V-GSP-RM-DEBUGGER-ROADMAP](../RISC-V-GSP-RM-DEBUGGER-ROADMAP.md) | long-term program H1–H7 |
## Where this fits in the Open-IOV workflow
-green-eye is a **development and research** tool, alongside the Ghidra corpus
+risc-v-gsp-rm-debugger is a **development and research** tool, alongside the Ghidra corpus
and the guest diagnostics. It does not replace either:
-* **Ghidra** answers *what is the code*; green-eye answers *what did it do*.
+* **Ghidra** answers *what is the code*; risc-v-gsp-rm-debugger answers *what did it do*.
* **Guest diagnostics** (`tools/guest-diag`) answer *what did the guest
- driver do*; green-eye answers *what did the firmware server do*.
+ driver do*; risc-v-gsp-rm-debugger answers *what did the firmware server do*.
* **The physical backend** (PLAN B) answers *what does real silicon do*;
- green-eye provides a safe place to repeat, mutate and single-step the same
+ risc-v-gsp-rm-debugger provides a safe place to repeat, mutate and single-step the same
firmware when the hardware path is hazardous or unavailable.
The intended accuracy loop is: run the same workload against the real
GSP-RM (hardware or mdev), record its RPC/state behaviour, then run the
-firmware in green-eye, record the same events, and compare with `compare`
+firmware in risc-v-gsp-rm-debugger, record the same events, and compare with `compare`
(see 06 and 07).
<!-- change (2026-10-02): add docs 28/29 to the status table and document map