KW-DRM(1)

💅 kw-drm — DRM subsystem tools

okay so bestie, this is kw-drm, one of the subsystem tools that ships inside kw. It's the DRM corner of the kworkflow universe and honestly it's giving main character energy for anyone who lives in graphics drivers all day. 🦋

---

✨ SYNOPSIS ✨

kw drm [--local | --remote [<remote>:<port>]]
  [--load-module=<module>[:<param1>,...][;<module>:...] |
  --unload-module=<module>[;<module>;...] |
  --gui-on | --gui-off | --conn-available | --modes | --verbose]

---

🌸 DESCRIPTION 🌸

so the Linux kernel has a whole bunch of subsystems that put their operations out there via sysfs, or that give userspace some way to talk to the driver directly. because of that, kw has a set of options aimed at specific subsystems, so you get actual facilities for poking at the one you care about. right now? the only one we support is drm. periodt.

This feature is the one responsible for dealing with DRM features. 💖

---

👑 OPTIONS 👑

• --local, --remote [<remote>:<port>] — this one tells the drm action which device it's targeting, and it can be a remote machine or your local one. If you don't explicitly pass these on the command line, kw goes and grabs the target set in the variable default_deploy_target (that's in deploy.config) to work out which one you mean. and like, important heads up: the drm feature does not support VM. no cap. 🙈
• --load-module=<module>[:<param1>,...][;<module>:...] — lets you name one or more modules to load, with or without parameters. want more than one module? separate them with ;. and if you wanna hand specific parameters to a module, use : and then separate each parameter with ,. oh and you can totally combine this with --gui-on — kw will make sure the target module gets loaded first, and after that it triggers the GUI. iconic combo. ✨
• --unload-module=<module>[;<module>;...] — this one lets you unload one or more DRM drivers. you can give a single module, or a list separated by ;. and the order matters, bestie: this command first disables the user interface, and only after that does it unload the module. 🫶
• --gui-on — a whole mechanism for turning the GUI on. by default it uses the systemctl operation, but you're free to drop in any specific command for activating your preferred GUI in the variable gui_on over in the kworkflow.config file. your setup, your rules. 💅
• --gui-off — turns off the target GUI on the specified target. default is the systemctl operation, but you can change that behavior by setting gui_off to a specific command in the kworkflow.config file — with the specific command. yeah. that command. 🌈
• --gui-on-after-reboot — sets the GUI to turn on automatically after the next reboot. by default it uses systemctl, but again, you're free to add any specific command for activating your preferred GUI in the variable gui_on_after_reboot in the kworkflow.config file. Note: this change only takes effect after the system is rebooted. want the GUI immediately instead? use the --gui-on option. ⏳
• --gui-off-after-reboot — sets the GUI to turn off automatically after the next reboot. by default it uses systemctl, but you're free to add any specific command for deactivating your GUI in the variable gui_off_after_reboot in the kworkflow.config file. Note: this change only takes effect after the system is rebooted. want to disable the GUI immediately? use the --gui-off option instead. ⏳
• --conn-available — shows all connectors available on the target machine. the ones marked with '*' are the enabled ones. 👀
• --modes — shows all available modes per card. all of them. every single one. 🖥️
• --verbose — verbose mode makes kw spit out debug messages so you can track its progress. genuinely so useful while you're debugging, because it lets you spot possible errors way more easily. your little detective era. 🔍

---

🎀 EXAMPLES 🎀

for these examples we're assuming the relevant fields in your configuration files (which live by default in .kw/) are already set up. we recommend using kw config for managing your local and global configurations. do it. it's the moment. 💜

If you're working with DRM drivers, you can take advantage of the load and unload commands combined with GUI control commands. like so:

kw drm --load-module='amdgpu' --gui-on # Load a driver and trigger the user GUI
kw drm --unload-module='amdgpu' # Turn off user GUI and unload the driver

Note:

You have to wait for the sshd to become ready. 😭

---

and that's the whole page, bestie — this is the kw-drm - DRM subsystem tools manual, straight from the kworkflow crew, dated whenever this page was dated (the footer's the same title line as the header, cute of them). now go forth and load some modules. 🧚⭐