summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSumera Priyadarsini <sylphrenadin@gmail.com>2021-01-12 00:38:22 +0530
committerMelissa Wen <melissa.srw@gmail.com>2021-01-12 17:16:25 -0300
commitaf20724c68633f2343506f17e0308b2e07d0a71c (patch)
treeadeec18ec52b25d75e1f85dd03c274db9dd047f3
parent1e85b7d4279b3e222d64924251eaec3deabc18d6 (diff)
drm/vkms: Add information about module options
Update vkms documentation to contain usage of `modinfo` command and steps to load vkms with module options enabled. Signed-off-by: Sumera Priyadarsini <sylphrenadin@gmail.com> Reviewed-by: Melissa Wen <melissa.srw@gmail.com> Signed-off-by: Melissa Wen <melissa.srw@gmail.com> Link: https://patchwork.freedesktop.org/patch/msgid/4fbc6459377c1dcbe8e6648718453d5693f6451c.1610391685.git.sylphrenadin@gmail.com
-rw-r--r--Documentation/gpu/vkms.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/Documentation/gpu/vkms.rst b/Documentation/gpu/vkms.rst
index 9e030c74a82e..2c9b376da5ca 100644
--- a/Documentation/gpu/vkms.rst
+++ b/Documentation/gpu/vkms.rst
@@ -35,6 +35,18 @@ Now, to load the driver, use::
On running the lsmod command now, the VKMS driver will appear listed.
You can also observe the driver being loaded in the dmesg logs.
+The VKMS driver has optional features to simulate different kinds of hardware,
+which are exposed as module options. You can use the `modinfo` command
+to see the module options for vkms::
+
+ modinfo vkms
+
+Module options are helpful when testing, and enabling modules
+can be done while loading vkms. For example, to load vkms with cursor enabled,
+use::
+
+ sudo modprobe vkms enable_cursor=1
+
To disable the driver, use ::
sudo modprobe -r vkms