Commit af20724c authored by Sumera Priyadarsini's avatar Sumera Priyadarsini Committed by Melissa Wen
Browse files

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: default avatarSumera Priyadarsini <sylphrenadin@gmail.com>
Reviewed-by: default avatarMelissa Wen <melissa.srw@gmail.com>
Signed-off-by: default avatarMelissa Wen <melissa.srw@gmail.com>
Link: https://patchwork.freedesktop.org/patch/msgid/4fbc6459377c1dcbe8e6648718453d5693f6451c.1610391685.git.sylphrenadin@gmail.com
parent 1e85b7d4

Documentation/gpu/vkms.rst

+12 −0
Original line number Diff line number Diff line
@@ -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