summaryrefslogtreecommitdiffstats
path: root/wiki/RPC-Message-Format.md
diff options
context:
space:
mode:
Diffstat (limited to 'wiki/RPC-Message-Format.md')
-rw-r--r--wiki/RPC-Message-Format.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/wiki/RPC-Message-Format.md b/wiki/RPC-Message-Format.md
index e627871..baec760 100644
--- a/wiki/RPC-Message-Format.md
+++ b/wiki/RPC-Message-Format.md
@@ -1,5 +1,16 @@
# GSP RPC Message Format Specification
+> **Historical document — superseded.** This page describes the legacy BAR0
+> mailbox RPC model: the 64-byte `GSPR` magic header and the 12-type model
+> below are **not** the path the guest driver uses. The live GSP-RM path is a
+> message queue in guest system memory with 4 KB queue elements and a 32-byte
+> RPC header (signature `0x43505256`, header version `0x03000000`); functions
+> are a flat enum (`SET_GUEST_SYSTEM_INFO` 1, `FREE` 10,
+> `GET_GSP_STATIC_INFO` 65, `GSP_RM_CONTROL` 76, `GSP_RM_ALLOC` 103, ...).
+> Canonical documentation:
+> [`../docs/03-architecture/03-gsp-and-gsp-rm.md`](../docs/03-architecture/03-gsp-and-gsp-rm.md)
+> and [`../docs/03-architecture/06-host-module-and-hybrid-model.md`](../docs/03-architecture/06-host-module-and-hybrid-model.md).
+
## Overview
The GSP firmware uses a dispatcher-based RPC system with two dispatchers:
- **Primary** (0x057A1AC0): ALLOC, FREE, MAP, UNMAP, PIN, UNPIN, SCHEDULE, YIELD, NOTIFY, BAR_TRAP, MIGRATE, DEBUG
@@ -191,6 +202,9 @@ typedef struct {
## Wire Format (Host → GSP)
+> **Legacy BAR0 mailbox format — not used by the guest driver.** The current
+> msgq header/element facts are in the note at the top of this page.
+
### Message Header (64 bytes)
```c
typedef struct {