diff options
Diffstat (limited to 'docs/02-getting-started/01-install-and-first-run.md')
| -rw-r--r-- | docs/02-getting-started/01-install-and-first-run.md | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/docs/02-getting-started/01-install-and-first-run.md b/docs/02-getting-started/01-install-and-first-run.md index f323dbb..d1c57c3 100644 --- a/docs/02-getting-started/01-install-and-first-run.md +++ b/docs/02-getting-started/01-install-and-first-run.md @@ -30,7 +30,7 @@ git clone https://git.vgpu.io/open-iov.git cd open-iov ./install.sh deps # build/runtime dependencies -./install.sh nvidia # NVIDIA open kernel modules (submodule) + patches +./install.sh nvidia # optional: NVIDIA open kernel modules (submodule) + patches ./install.sh firmware # GSP firmware image (verified) ./install.sh build # kernel module + userspace ``` @@ -45,7 +45,8 @@ short and comments the order. # 1. Kernel module first: it generates Module.symvers used by the next step. make kernel -# 2. NVIDIA OpenRM modules (must see our symbols): +# 2. Optional: NVIDIA OpenRM modules (needed only for native vGPU-management +# workflows; see section 3). They must see our symbols: # KBUILD_EXTRA_SYMBOLS=<repo>/kernel/Module.symvers ./scripts/build_nvidia_openrm.sh @@ -62,11 +63,22 @@ make userspace ```bash ./scripts/stack_manager.sh status # check what is currently loaded -./scripts/stack_manager.sh load-stack # vfio/mdev prereqs -> open-iov -> nvidia (if used) +./scripts/stack_manager.sh load-stack # vfio/mdev prereqs -> open-iov -> nvidia (optional) ./scripts/stack_manager.sh mdev-create # create a vGPU mediated device ./scripts/stack_manager.sh mdev-list # inspect /sys/bus/mdev/devices/ ``` +**The `nvidia` (OpenRM) stage is optional.** It is needed only when the host +must run NVIDIA's OpenRM modules built against the symbols `open-iov-vfio.ko` +exports — that is, the native vGPU-management/RM-callback workflows. The +QEMU/emulated path uses the distribution driver that already manages the +physical GPU; `load-stack` skips the OpenRM submodule when a distribution +driver is present, and the build steps for it (`./install.sh nvidia`, +`./scripts/build_nvidia_openrm.sh`) can be skipped. When the OpenRM path *is* +used, the build and load order in +[`../03-architecture/06-host-module-and-hybrid-model.md`](../03-architecture/06-host-module-and-hybrid-model.md) +§7 applies. + The mdev device is the virtual GPU. Everything after this point treats it like any other VFIO device. |