summaryrefslogtreecommitdiffstats
path: root/docs/BUILD_NVIDIA_OPENRM.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/BUILD_NVIDIA_OPENRM.md')
-rw-r--r--docs/BUILD_NVIDIA_OPENRM.md19
1 files changed, 13 insertions, 6 deletions
diff --git a/docs/BUILD_NVIDIA_OPENRM.md b/docs/BUILD_NVIDIA_OPENRM.md
index 5699036..309a64f 100644
--- a/docs/BUILD_NVIDIA_OPENRM.md
+++ b/docs/BUILD_NVIDIA_OPENRM.md
@@ -1,5 +1,10 @@
# Building NVIDIA OpenRM with Open-IOV vGPU VFIO Symbols
+> **Status: historical build notes.** These notes predate the current workflow.
+> For the current build/load model see
+> [03-architecture/06-host-module-and-hybrid-model.md](03-architecture/06-host-module-and-hybrid-model.md)
+> and [02-getting-started/01-install-and-first-run.md](02-getting-started/01-install-and-first-run.md).
+
## Overview
The NVIDIA OpenRM `nvidia.ko` kernel module requires the vGPU VFIO interface symbols exported by `open-iov-vfio.ko`:
@@ -18,8 +23,8 @@ These symbols must be resolved at build time via `KBUILD_EXTRA_SYMBOLS` pointing
```
1. Build open-iov-vfio.ko → Generates kernel/Module.symvers
2. Build NVIDIA OpenRM with KBUILD_EXTRA_SYMBOLS=kernel/Module.symvers
-3. Load nvidia.ko first
-4. Load open-iov-vfio.ko
+3. Load open-iov-vfio.ko first (exports the vGPU VFIO symbols)
+4. Optionally load nvidia.ko (imports those symbols)
```
## Automated Build (Recommended)
@@ -76,12 +81,14 @@ modinfo nvidia-open-gpu-kernel-modules/kernel-open/nvidia.ko | grep -i vgpu
## Module Loading Order
```bash
-# 1. Load NVIDIA OpenRM (provides vGPU VFIO symbols)
-sudo insmod nvidia-open-gpu-kernel-modules/kernel-open/nvidia.ko
-
-# 2. Load Open-IOV VFIO driver (registers mdev parent with nvidia.ko)
+# 1. Load Open-IOV VFIO driver FIRST (exports the vGPU VFIO symbols and
+# registers the mdev parent on the physical GPU)
sudo insmod kernel/open-iov-vfio.ko
+# 2. Load the optional NVIDIA OpenRM (imports the vGPU VFIO symbols; build it
+# with KBUILD_EXTRA_SYMBOLS as above)
+sudo insmod nvidia-open-gpu-kernel-modules/kernel-open/nvidia.ko
+
# 3. Copy firmware
sudo cp firmware/57X-GSP/570.144/gsp-570.144.fwimage.bin /lib/firmware/